skapi-js 1.5.9 → 1.6.0

package/dist/skapi.d.mts

@@ -467,14 +467,21 @@ type FetchOptions = {
     /** Callback for database request progress. Useful when building progress bar. */
     progress?: ProgressCallback;
 };
-type PollingResult = {
+type RequestHistory = {
+    id: string;
+    status_code: number;
     response_body: any;
-    error: any;
+    error?: any;
     updated: number;
     request_body: any;
-    status_code: number | null;
-    expires: number | null;
-    status: 'resolved' | 'failed' | 'pending';
+    expires?: number;
+    status: 'pending' | 'running' | 'resolved' | 'failed';
+    queue_name?: string;
+    poll?: (arg?: {
+        latency?: number;
+        onResponse?: (res: any) => void;
+        onError?: (err: any) => void;
+    }) => Promise<any>;
 };
 type DatabaseResponse<T> = {
     list: T[];
@@ -556,7 +563,6 @@ type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
 type Types_Newsletter = Newsletter;
-type Types_PollingResult = PollingResult;
 type Types_PostRecordConfig = PostRecordConfig;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
@@ -566,6 +572,7 @@ type Types_RTCReceiverParams = RTCReceiverParams;
 type Types_RTCResolved = RTCResolved;
 type Types_RealtimeCallback = RealtimeCallback;
 type Types_RecordData = RecordData;
+type Types_RequestHistory = RequestHistory;
 type Types_Subscription = Subscription;
 type Types_Table = Table;
 type Types_Tag = Tag;
@@ -575,7 +582,7 @@ type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PollingResult as PollingResult, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -861,14 +868,11 @@ declare class Skapi {
     /**
      * Sends a secure outbound request using a Skapi client secret key.
      * @param params Request parameters.
-     * @returns A promise that resolves to Promise<any>.
+     * @returns A promise that resolves to the final API response, or to a status object when the request is queued.
      */
     clientSecretRequest(params: {
         url: string;
         clientSecretName: string;
-        poll?: number;
-        expires?: number;
-        queue?: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         headers?: {
             [key: string]: string;
@@ -879,20 +883,58 @@ declare class Skapi {
         params?: {
             [key: string]: string;
         };
-    }): Promise<any>;
+        poll?: number;
+        queue?: string;
+        expires?: number;
+        onResponse?: (res: any) => void;
+        onError?: (err: any) => void;
+    }): Promise<any | {
+        id: string;
+        status: 'running' | 'pending';
+        queue_name: string;
+        in_queue: number;
+        poll?: (arg?: {
+            latency?: number;
+        }) => void;
+    }>;
     /**
      * Retrieves the history of client secret requests for a given URL and method.
      * @param params Request parameters.
      * @param fetchOptions Pagination and fetch behavior options.
-     * @returns A promise that resolves to Promise<any[]>.
+     * @returns A promise that resolves to a paginated list of request history items.
      */
     clientSecretRequestHistory(params: {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
-        poll?: number;
         queue?: string;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<PollingResult[]> & {
-        pending: Promise<PollingResult>[];
+        status?: 'pending' | 'running' | 'resolved' | 'failed';
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RequestHistory[]>>;
+    /**
+     * Cancels a pending client secret request and removes it from the client-side queue if applicable.
+     * @param params Request parameters.
+     * @returns A promise that resolves to a result object with removed status and message.
+     */
+    cancelClientSecretRequest(params: {
+        url: string;
+        method: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        id: string;
+        queue?: string;
+    }): Promise<{
+        removed: boolean;
+        message: string;
+    }>;
+    /**
+     * Returns the number of requests currently waiting in a named client secret request queue.
+     * @param params Request parameters.
+     * @returns A promise that resolves to queue count information.
+     */
+    clientSecretRequestQueueCount(params: {
+        queue: string;
+        service?: string;
+        owner?: string;
+    }): Promise<{
+        queue_name: string;
+        in_queue: number;
     }>;
     /**
      * Consumes a one-time ticket and executes the ticketed request payload.

package/dist/skapi.d.ts

@@ -467,14 +467,21 @@ type FetchOptions = {
     /** Callback for database request progress. Useful when building progress bar. */
     progress?: ProgressCallback;
 };
-type PollingResult = {
+type RequestHistory = {
+    id: string;
+    status_code: number;
     response_body: any;
-    error: any;
+    error?: any;
     updated: number;
     request_body: any;
-    status_code: number | null;
-    expires: number | null;
-    status: 'resolved' | 'failed' | 'pending';
+    expires?: number;
+    status: 'pending' | 'running' | 'resolved' | 'failed';
+    queue_name?: string;
+    poll?: (arg?: {
+        latency?: number;
+        onResponse?: (res: any) => void;
+        onError?: (err: any) => void;
+    }) => Promise<any>;
 };
 type DatabaseResponse<T> = {
     list: T[];
@@ -556,7 +563,6 @@ type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
 type Types_Newsletter = Newsletter;
-type Types_PollingResult = PollingResult;
 type Types_PostRecordConfig = PostRecordConfig;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
@@ -566,6 +572,7 @@ type Types_RTCReceiverParams = RTCReceiverParams;
 type Types_RTCResolved = RTCResolved;
 type Types_RealtimeCallback = RealtimeCallback;
 type Types_RecordData = RecordData;
+type Types_RequestHistory = RequestHistory;
 type Types_Subscription = Subscription;
 type Types_Table = Table;
 type Types_Tag = Tag;
@@ -575,7 +582,7 @@ type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PollingResult as PollingResult, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -861,14 +868,11 @@ declare class Skapi {
     /**
      * Sends a secure outbound request using a Skapi client secret key.
      * @param params Request parameters.
-     * @returns A promise that resolves to Promise<any>.
+     * @returns A promise that resolves to the final API response, or to a status object when the request is queued.
      */
     clientSecretRequest(params: {
         url: string;
         clientSecretName: string;
-        poll?: number;
-        expires?: number;
-        queue?: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         headers?: {
             [key: string]: string;
@@ -879,20 +883,58 @@ declare class Skapi {
         params?: {
             [key: string]: string;
         };
-    }): Promise<any>;
+        poll?: number;
+        queue?: string;
+        expires?: number;
+        onResponse?: (res: any) => void;
+        onError?: (err: any) => void;
+    }): Promise<any | {
+        id: string;
+        status: 'running' | 'pending';
+        queue_name: string;
+        in_queue: number;
+        poll?: (arg?: {
+            latency?: number;
+        }) => void;
+    }>;
     /**
      * Retrieves the history of client secret requests for a given URL and method.
      * @param params Request parameters.
      * @param fetchOptions Pagination and fetch behavior options.
-     * @returns A promise that resolves to Promise<any[]>.
+     * @returns A promise that resolves to a paginated list of request history items.
      */
     clientSecretRequestHistory(params: {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
-        poll?: number;
         queue?: string;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<PollingResult[]> & {
-        pending: Promise<PollingResult>[];
+        status?: 'pending' | 'running' | 'resolved' | 'failed';
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RequestHistory[]>>;
+    /**
+     * Cancels a pending client secret request and removes it from the client-side queue if applicable.
+     * @param params Request parameters.
+     * @returns A promise that resolves to a result object with removed status and message.
+     */
+    cancelClientSecretRequest(params: {
+        url: string;
+        method: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        id: string;
+        queue?: string;
+    }): Promise<{
+        removed: boolean;
+        message: string;
+    }>;
+    /**
+     * Returns the number of requests currently waiting in a named client secret request queue.
+     * @param params Request parameters.
+     * @returns A promise that resolves to queue count information.
+     */
+    clientSecretRequestQueueCount(params: {
+        queue: string;
+        service?: string;
+        owner?: string;
+    }): Promise<{
+        queue_name: string;
+        in_queue: number;
     }>;
     /**
      * Consumes a one-time ticket and executes the ticketed request payload.