skapi-js 1.7.3 → 1.8.0

package/dist/skapi.d.mts

@@ -69,6 +69,7 @@ type GetRecordQuery = {
         name: string | '$updated' | '$uploaded' | '$referenced_count' | '$user_id';
         /** String value max 256 chars. Allows punctuation (including / ! * #). Blocks control chars and sentinel 􏿿. */
         value: string | number | boolean;
+        /** For a string value: '>=' = 'starts with', '<=' = 'ends with'. When the name is a compound name ending in '.', '>=' / '<=' match the child name segment (starts / ends with). '>' / '<' are lexicographic; numbers/booleans compare normally. */
         condition?: Condition;
         range?: string | number | boolean;
     };
@@ -476,6 +477,7 @@ type RequestHistory = {
     status_code: number;
     response_body: any;
     error?: any;
+    created: number;
     updated: number;
     request_body: any;
     expires?: number;
@@ -935,6 +937,36 @@ declare class Skapi {
         removed: boolean;
         message: string;
     }>;
+    /**
+     * Stops live polling for client secret requests without cancelling the requests
+     * themselves. The server-side work continues; only this client stops asking about it.
+     *
+     * Use it to drop polling traffic while the user is not looking at the results (a
+     * hidden tab, a closed view), then simply poll again when they return. Polls run
+     * one-at-a-time per queue, so a poll for a request that never settles otherwise
+     * blocks every poll queued behind it.
+     *
+     * Pass `id` (with `url` and `method`) to stop one request, `queue` to stop a queue's
+     * polls, or neither to stop all of them. A stopped poll resolves with
+     * `{ id, status: 'stopped' }` rather than rejecting, and its `onResponse`/`onError`
+     * callbacks are not called.
+     *
+     * @param params Which polls to stop.
+     * @returns The number of polls stopped.
+     */
+    stopClientSecretPolling(params?: {
+        url?: string;
+        method?: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        id?: string;
+        queue?: string;
+        service?: string;
+        owner?: string;
+    }): number;
+    /**
+     * True if a poll result came from stopClientSecretPolling rather than the server.
+     * @param res A resolved poll result.
+     */
+    isPollStopped(res: any): boolean;
     /**
      * Returns the number of requests currently waiting in a named client secret request queue.
      * @param params Request parameters.

package/dist/skapi.d.ts

@@ -69,6 +69,7 @@ type GetRecordQuery = {
         name: string | '$updated' | '$uploaded' | '$referenced_count' | '$user_id';
         /** String value max 256 chars. Allows punctuation (including / ! * #). Blocks control chars and sentinel 􏿿. */
         value: string | number | boolean;
+        /** For a string value: '>=' = 'starts with', '<=' = 'ends with'. When the name is a compound name ending in '.', '>=' / '<=' match the child name segment (starts / ends with). '>' / '<' are lexicographic; numbers/booleans compare normally. */
         condition?: Condition;
         range?: string | number | boolean;
     };
@@ -476,6 +477,7 @@ type RequestHistory = {
     status_code: number;
     response_body: any;
     error?: any;
+    created: number;
     updated: number;
     request_body: any;
     expires?: number;
@@ -935,6 +937,36 @@ declare class Skapi {
         removed: boolean;
         message: string;
     }>;
+    /**
+     * Stops live polling for client secret requests without cancelling the requests
+     * themselves. The server-side work continues; only this client stops asking about it.
+     *
+     * Use it to drop polling traffic while the user is not looking at the results (a
+     * hidden tab, a closed view), then simply poll again when they return. Polls run
+     * one-at-a-time per queue, so a poll for a request that never settles otherwise
+     * blocks every poll queued behind it.
+     *
+     * Pass `id` (with `url` and `method`) to stop one request, `queue` to stop a queue's
+     * polls, or neither to stop all of them. A stopped poll resolves with
+     * `{ id, status: 'stopped' }` rather than rejecting, and its `onResponse`/`onError`
+     * callbacks are not called.
+     *
+     * @param params Which polls to stop.
+     * @returns The number of polls stopped.
+     */
+    stopClientSecretPolling(params?: {
+        url?: string;
+        method?: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        id?: string;
+        queue?: string;
+        service?: string;
+        owner?: string;
+    }): number;
+    /**
+     * True if a poll result came from stopClientSecretPolling rather than the server.
+     * @param res A resolved poll result.
+     */
+    isPollStopped(res: any): boolean;
     /**
      * Returns the number of requests currently waiting in a named client secret request queue.
      * @param params Request parameters.