skapi-js 1.5.7 → 1.5.9

package/dist/skapi.d.mts

@@ -716,7 +716,7 @@ declare class Skapi {
      * @param params Request parameters.
      * @returns A promise that resolves to Promise<ConnectionInfo>.
      */
-    getConnectionInfo(params: {
+    getConnectionInfo(params?: {
         refresh: Boolean;
     }): Promise<ConnectionInfo>;
     private _updateConnection;
@@ -752,7 +752,7 @@ declare class Skapi {
      * @param callback Callback invoked for events or updates.
      * @returns A promise that resolves to Promise<RTCConnector>.
      */
-    connectRTC(params: RTCConnectorParams, callback?: (e: RTCEvent) => void): Promise<RTCConnector>;
+    connectRTC(params: RTCConnectorParams, callback: (e: RTCEvent) => void): Promise<RTCConnector>;
     /**
      * Opens a realtime WebSocket connection and registers a callback for incoming realtime messages.
      * @param callback Callback invoked for events or updates.
@@ -866,8 +866,9 @@ declare class Skapi {
     clientSecretRequest(params: {
         url: string;
         clientSecretName: string;
-        poll?: boolean | number;
+        poll?: number;
         expires?: number;
+        queue?: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         headers?: {
             [key: string]: string;
@@ -889,6 +890,7 @@ declare class Skapi {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         poll?: number;
+        queue?: string;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<PollingResult[]> & {
         pending: Promise<PollingResult>[];
     }>;
@@ -913,7 +915,7 @@ declare class Skapi {
      */
     getConsumedTickets(params: {
         ticket_id?: string;
-    }, fetchOptions: FetchOptions): Promise<DatabaseResponse<any[]>>;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<any[]>>;
     /**
      * Lists issued tickets with optional filters and pagination.
      * @param params Request parameters.
@@ -922,7 +924,7 @@ declare class Skapi {
      */
     getTickets(params: {
         ticket_id?: string;
-    }, fetchOptions: FetchOptions): Promise<DatabaseResponse<any[]>>;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<any[]>>;
     /**
      * Closes the active realtime WebSocket connection.
      * @returns A promise that resolves to Promise<void>.
@@ -1056,7 +1058,7 @@ declare class Skapi {
      * @returns A promise that resolves to Promise<{ type: 'success', message: string }>.
      */
     joinRealtime(params: {
-        group: string | null;
+        group?: string | null;
     }): Promise<{
         type: 'success';
         message: string;
@@ -1110,7 +1112,9 @@ declare class Skapi {
      * @param fetchOptions Pagination and fetch behavior options.
      * @returns A promise that resolves to Promise<DatabaseResponse<RecordData>>.
      */
-    getRecords(query: GetRecordQuery, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RecordData>>;
+    getRecords(query: GetRecordQuery & {
+        private_key?: string;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RecordData>>;
     /**
      * Lists table metadata with optional table-name filters.
      * @param query Query object used to filter results.
@@ -1164,7 +1168,9 @@ declare class Skapi {
      * @param fetchOptions Pagination and fetch behavior options.
      * @returns A promise that resolves to Promise<string | DatabaseResponse<RecordData>>.
      */
-    deleteRecords(params: DelRecordQuery, fetchOptions?: FetchOptions): Promise<string | DatabaseResponse<RecordData>>;
+    deleteRecords(params: DelRecordQuery & {
+        private_key?: string;
+    }, fetchOptions?: FetchOptions): Promise<string | DatabaseResponse<RecordData>>;
     /**
      * Resends the signup confirmation email for the current pending account.
      * @returns A promise that resolves to Promise<'SUCCESS: Signup confirmation e-mail has been sent.'>.
@@ -1325,7 +1331,7 @@ declare class Skapi {
     listPrivateRecordAccess(params: {
         record_id?: string;
         user_id?: string | string[];
-    }): Promise<DatabaseResponse<{
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<{
         record_id: string;
         user_id: string;
     }>>;

package/dist/skapi.d.ts

@@ -716,7 +716,7 @@ declare class Skapi {
      * @param params Request parameters.
      * @returns A promise that resolves to Promise<ConnectionInfo>.
      */
-    getConnectionInfo(params: {
+    getConnectionInfo(params?: {
         refresh: Boolean;
     }): Promise<ConnectionInfo>;
     private _updateConnection;
@@ -752,7 +752,7 @@ declare class Skapi {
      * @param callback Callback invoked for events or updates.
      * @returns A promise that resolves to Promise<RTCConnector>.
      */
-    connectRTC(params: RTCConnectorParams, callback?: (e: RTCEvent) => void): Promise<RTCConnector>;
+    connectRTC(params: RTCConnectorParams, callback: (e: RTCEvent) => void): Promise<RTCConnector>;
     /**
      * Opens a realtime WebSocket connection and registers a callback for incoming realtime messages.
      * @param callback Callback invoked for events or updates.
@@ -866,8 +866,9 @@ declare class Skapi {
     clientSecretRequest(params: {
         url: string;
         clientSecretName: string;
-        poll?: boolean | number;
+        poll?: number;
         expires?: number;
+        queue?: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         headers?: {
             [key: string]: string;
@@ -889,6 +890,7 @@ declare class Skapi {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         poll?: number;
+        queue?: string;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<PollingResult[]> & {
         pending: Promise<PollingResult>[];
     }>;
@@ -913,7 +915,7 @@ declare class Skapi {
      */
     getConsumedTickets(params: {
         ticket_id?: string;
-    }, fetchOptions: FetchOptions): Promise<DatabaseResponse<any[]>>;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<any[]>>;
     /**
      * Lists issued tickets with optional filters and pagination.
      * @param params Request parameters.
@@ -922,7 +924,7 @@ declare class Skapi {
      */
     getTickets(params: {
         ticket_id?: string;
-    }, fetchOptions: FetchOptions): Promise<DatabaseResponse<any[]>>;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<any[]>>;
     /**
      * Closes the active realtime WebSocket connection.
      * @returns A promise that resolves to Promise<void>.
@@ -1056,7 +1058,7 @@ declare class Skapi {
      * @returns A promise that resolves to Promise<{ type: 'success', message: string }>.
      */
     joinRealtime(params: {
-        group: string | null;
+        group?: string | null;
     }): Promise<{
         type: 'success';
         message: string;
@@ -1110,7 +1112,9 @@ declare class Skapi {
      * @param fetchOptions Pagination and fetch behavior options.
      * @returns A promise that resolves to Promise<DatabaseResponse<RecordData>>.
      */
-    getRecords(query: GetRecordQuery, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RecordData>>;
+    getRecords(query: GetRecordQuery & {
+        private_key?: string;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RecordData>>;
     /**
      * Lists table metadata with optional table-name filters.
      * @param query Query object used to filter results.
@@ -1164,7 +1168,9 @@ declare class Skapi {
      * @param fetchOptions Pagination and fetch behavior options.
      * @returns A promise that resolves to Promise<string | DatabaseResponse<RecordData>>.
      */
-    deleteRecords(params: DelRecordQuery, fetchOptions?: FetchOptions): Promise<string | DatabaseResponse<RecordData>>;
+    deleteRecords(params: DelRecordQuery & {
+        private_key?: string;
+    }, fetchOptions?: FetchOptions): Promise<string | DatabaseResponse<RecordData>>;
     /**
      * Resends the signup confirmation email for the current pending account.
      * @returns A promise that resolves to Promise<'SUCCESS: Signup confirmation e-mail has been sent.'>.
@@ -1325,7 +1331,7 @@ declare class Skapi {
     listPrivateRecordAccess(params: {
         record_id?: string;
         user_id?: string | string[];
-    }): Promise<DatabaseResponse<{
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<{
         record_id: string;
         user_id: string;
     }>>;