added pb.sql.run() and collection meta handlers

Author: ganigeorgiev

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.27.0
+
+- Added `pb.sql.run(query)` handler for the upcoming PocketBase v0.39.0 "SQL console" debug interface ([pocketbase#2236](https://github.com/pocketbase/pocketbase/issues/2236)).
+
+- Added missing PocketBase v0.37+ collection meta endpoint handlers (`pb.collections.dryRunViewQuery(query)` and `pb.collections.getAllOAuth2Providers()`).
+
+
 ## 0.26.9
 
 - Optimized realtime `subscribe`/`unsubscribe` calls to minimize async errors ([pocketbase#7684](https://github.com/pocketbase/pocketbase/issues/7684)).

README.md

@@ -959,6 +959,12 @@ const result = await batch.send()
 
 // Returns type indexed map with scaffolded collection models populated with their default field values.
 🔐 pb.collections.getScaffolds(options = {});
+
+// Returns a list with all configurable OAuth2 providers.
+🔐 pb.collections.getAllOAuth2Providers(options = {});
+
+// Tests the specified view query and returns a sample of the resulting records.
+🔐 pb.collections.dryRunViewQuery(query, options = {});
 ```
 
 ---
@@ -1068,6 +1074,13 @@ pb.realtime.onDisconnect = function(activeSubscriptions)
 🔐 pb.crons.run(jobId, options = {});
 ```
 
+##### SQLService
+
+```js
+// Runs the specified raw SQL query.
+🔐 pb.sql.run(query, options = {});
+```
+
 ---
 
 ##### HealthService

dist/pocketbase.cjs.d.ts

@@ -80,10 +80,16 @@ interface OAuth2Provider {
     tokenURL: string;
     userInfoURL: string;
     displayName: string;
+    logo: string;
     extra?: {
         [key: string]: any;
     };
 }
+interface ConfigurableOAuth2Provider {
+    name: string;
+    displayName: string;
+    logo: string;
+}
 interface OAuth2Config {
     enabled: boolean;
     mappedFields: {
@@ -960,6 +966,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
      * @throws {ClientResponseError}
      */
     import(collections: Array<CollectionModel>, deleteMissing?: boolean, options?: CommonOptions): Promise<true>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
     /**
      * Returns type indexed map with scaffolded collection models
      * populated with their default field values.
@@ -970,11 +982,19 @@ declare class CollectionService extends CrudService<CollectionModel> {
         [key: string]: CollectionModel;
     }>;
     /**
-     * Deletes all records associated with the specified collection.
+     * Returns a list with all configurable OAuth2 providers.
      *
      * @throws {ClientResponseError}
      */
-    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
+    getAllOAuth2Providers(options?: CommonOptions): Promise<Array<ConfigurableOAuth2Provider>>;
+    /**
+     * Executes the specified view query and returns a sample of the resulting records.
+     *
+     * @throws {ClientResponseError}
+     */
+    dryRunViewQuery(query: string, options?: CommonOptions): Promise<Array<{
+        [key: string]: any;
+    }>>;
 }
 interface HourlyStats {
     total: number;
@@ -1113,6 +1133,25 @@ declare class CronService extends BaseService {
      */
     run(jobId: string, options?: CommonOptions): Promise<boolean>;
 }
+interface SQLResult {
+    execTime: number;
+    affectedRows: number;
+    columns: Array<{
+        name: string;
+        type: string;
+        nullable: boolean;
+    }>;
+    rows: Array<Array<string | null>>;
+}
+declare class SQLService extends BaseService {
+    /**
+     * Executes the specified raw SQL query.
+     * This operation is allowed only for superusers.
+     *
+     * @throws {ClientResponseError}
+     */
+    run(query: string, options?: CommonOptions): Promise<SQLResult>;
+}
 interface BatchRequest {
     method: string;
     url: string;
@@ -1290,6 +1329,10 @@ declare class Client {
      * An instance of the service that handles the **Cron APIs**.
      */
     readonly crons: CronService;
+    /**
+     * An instance of the service that handles the **SQL APIs**.
+     */
+    readonly sql: SQLService;
     private cancelControllers;
     private recordServices;
     private enableAutoCancellation;

dist/pocketbase.cjs.js

@@ -101,10 +101,16 @@ interface OAuth2Provider {
     tokenURL: string;
     userInfoURL: string;
     displayName: string;
+    logo: string;
     extra?: {
         [key: string]: any;
     };
 }
+interface ConfigurableOAuth2Provider {
+    name: string;
+    displayName: string;
+    logo: string;
+}
 interface OAuth2Config {
     enabled: boolean;
     mappedFields: {
@@ -1003,6 +1009,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
      * @throws {ClientResponseError}
      */
     import(collections: Array<CollectionModel>, deleteMissing?: boolean, options?: CommonOptions): Promise<true>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
     /**
      * Returns type indexed map with scaffolded collection models
      * populated with their default field values.
@@ -1013,11 +1025,19 @@ declare class CollectionService extends CrudService<CollectionModel> {
         [key: string]: CollectionModel;
     }>;
     /**
-     * Deletes all records associated with the specified collection.
+     * Returns a list with all configurable OAuth2 providers.
      *
      * @throws {ClientResponseError}
      */
-    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
+    getAllOAuth2Providers(options?: CommonOptions): Promise<Array<ConfigurableOAuth2Provider>>;
+    /**
+     * Executes the specified view query and returns a sample of the resulting records.
+     *
+     * @throws {ClientResponseError}
+     */
+    dryRunViewQuery(query: string, options?: CommonOptions): Promise<Array<{
+        [key: string]: any;
+    }>>;
 }
 interface HourlyStats {
     total: number;
@@ -1156,6 +1176,25 @@ declare class CronService extends BaseService {
      */
     run(jobId: string, options?: CommonOptions): Promise<boolean>;
 }
+interface SQLResult {
+    execTime: number;
+    affectedRows: number;
+    columns: Array<{
+        name: string;
+        type: string;
+        nullable: boolean;
+    }>;
+    rows: Array<Array<string | null>>;
+}
+declare class SQLService extends BaseService {
+    /**
+     * Executes the specified raw SQL query.
+     * This operation is allowed only for superusers.
+     *
+     * @throws {ClientResponseError}
+     */
+    run(query: string, options?: CommonOptions): Promise<SQLResult>;
+}
 interface BatchRequest {
     method: string;
     url: string;
@@ -1333,6 +1372,10 @@ declare class Client {
      * An instance of the service that handles the **Cron APIs**.
      */
     readonly crons: CronService;
+    /**
+     * An instance of the service that handles the **SQL APIs**.
+     */
+    readonly sql: SQLService;
     private cancelControllers;
     private recordServices;
     private enableAutoCancellation;
@@ -1584,4 +1627,4 @@ declare function getTokenPayload(token: string): {
  * @param [expirationThreshold] Time in seconds that will be subtracted from the token `exp` property.
  */
 declare function isTokenExpired(token: string, expirationThreshold?: number): boolean;
-export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, CollectionField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, RecordSubscribeOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };
+export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, CollectionField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, ConfigurableOAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, RecordSubscribeOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };

dist/pocketbase.cjs.js.map

@@ -101,10 +101,16 @@ interface OAuth2Provider {
     tokenURL: string;
     userInfoURL: string;
     displayName: string;
+    logo: string;
     extra?: {
         [key: string]: any;
     };
 }
+interface ConfigurableOAuth2Provider {
+    name: string;
+    displayName: string;
+    logo: string;
+}
 interface OAuth2Config {
     enabled: boolean;
     mappedFields: {
@@ -1003,6 +1009,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
      * @throws {ClientResponseError}
      */
     import(collections: Array<CollectionModel>, deleteMissing?: boolean, options?: CommonOptions): Promise<true>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
     /**
      * Returns type indexed map with scaffolded collection models
      * populated with their default field values.
@@ -1013,11 +1025,19 @@ declare class CollectionService extends CrudService<CollectionModel> {
         [key: string]: CollectionModel;
     }>;
     /**
-     * Deletes all records associated with the specified collection.
+     * Returns a list with all configurable OAuth2 providers.
      *
      * @throws {ClientResponseError}
      */
-    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
+    getAllOAuth2Providers(options?: CommonOptions): Promise<Array<ConfigurableOAuth2Provider>>;
+    /**
+     * Executes the specified view query and returns a sample of the resulting records.
+     *
+     * @throws {ClientResponseError}
+     */
+    dryRunViewQuery(query: string, options?: CommonOptions): Promise<Array<{
+        [key: string]: any;
+    }>>;
 }
 interface HourlyStats {
     total: number;
@@ -1156,6 +1176,25 @@ declare class CronService extends BaseService {
      */
     run(jobId: string, options?: CommonOptions): Promise<boolean>;
 }
+interface SQLResult {
+    execTime: number;
+    affectedRows: number;
+    columns: Array<{
+        name: string;
+        type: string;
+        nullable: boolean;
+    }>;
+    rows: Array<Array<string | null>>;
+}
+declare class SQLService extends BaseService {
+    /**
+     * Executes the specified raw SQL query.
+     * This operation is allowed only for superusers.
+     *
+     * @throws {ClientResponseError}
+     */
+    run(query: string, options?: CommonOptions): Promise<SQLResult>;
+}
 interface BatchRequest {
     method: string;
     url: string;
@@ -1333,6 +1372,10 @@ declare class Client {
      * An instance of the service that handles the **Cron APIs**.
      */
     readonly crons: CronService;
+    /**
+     * An instance of the service that handles the **SQL APIs**.
+     */
+    readonly sql: SQLService;
     private cancelControllers;
     private recordServices;
     private enableAutoCancellation;
@@ -1584,4 +1627,4 @@ declare function getTokenPayload(token: string): {
  * @param [expirationThreshold] Time in seconds that will be subtracted from the token `exp` property.
  */
 declare function isTokenExpired(token: string, expirationThreshold?: number): boolean;
-export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, CollectionField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, RecordSubscribeOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };
+export { Client as default, BeforeSendResult, ClientResponseError, CollectionService, HealthCheckResponse, HealthService, HourlyStats, LogService, UnsubscribeFunc, RealtimeService, RecordAuthResponse, AuthProviderInfo, AuthMethodsList, RecordSubscription, OAuth2UrlCallback, OAuth2AuthConfig, OTPResponse, RecordService, CrudService, BatchRequest, BatchRequestResult, BatchService, SubBatchService, AsyncSaveFunc, AsyncClearFunc, AsyncAuthStore, AuthRecord, AuthModel, OnStoreChangeFunc, BaseAuthStore, LocalAuthStore, ListResult, BaseModel, LogModel, RecordModel, CollectionField, TokenConfig, AuthAlertConfig, OTPConfig, MFAConfig, PasswordAuthConfig, OAuth2Provider, ConfigurableOAuth2Provider, OAuth2Config, EmailTemplate, BaseCollectionModel, ViewCollectionModel, AuthCollectionModel, CollectionModel, SendOptions, CommonOptions, ListOptions, FullListOptions, RecordOptions, RecordListOptions, RecordFullListOptions, RecordSubscribeOptions, LogStatsOptions, FileOptions, AuthOptions, normalizeUnknownQueryParams, serializeQueryParams, ParseOptions, cookieParse, SerializeOptions, cookieSerialize, getTokenPayload, isTokenExpired };