skapi-js 2.0.0-rc.8 → 2.0.0

package/dist/skapi.d.mts

@@ -53,8 +53,8 @@ type GetRecordQuery = {
     table?: string | {
         /** Max 256 characters, where / ! * # % each count as 3. Blocks control chars and sentinel 􏿿. */
         name: string;
-        /** Number range: 0 ~ 99. Default: 'public' */
-        access_group?: number | 'private' | 'public' | 'authorized' | 'admin';
+        /** Number range: 0 ~ 99. 'public' = 0, 'authorized' = 1, 'admin' = 99. '*' is shorthand for 'private'. Default: 'public' */
+        access_group?: number | 'private' | '*' | 'public' | 'authorized' | 'admin';
         /** User ID of subscription */
         subscription?: string;
     };
@@ -83,8 +83,8 @@ type PostRecordConfig = {
     table?: {
         /** Max 256 characters, where / ! * # % each count as 3. Blocks control chars and sentinel 􏿿. */
         name?: string;
-        /** Number range: 0 ~ 99. Default: 'public' */
-        access_group?: number | 'private' | 'public' | 'authorized' | 'admin';
+        /** Number range: 0 ~ 99. 'public' = 0, 'authorized' = 1, 'admin' = 99. '*' is shorthand for 'private'. Default: 'public' */
+        access_group?: number | 'private' | '*' | 'public' | 'authorized' | 'admin';
         /** When true, Record will be only accessible for subscribed users. */
         subscription?: {
             is_subscription_record?: boolean;
@@ -170,7 +170,7 @@ type EncryptionOptions = boolean | {
      * encrypted records are permanently unreadable.
      */
     recovery?: 'code' | 'none';
-    /** Reserved keyring table name. Default 'skapi__keyring'. */
+    /** Reserved keyring table name. Default '__skapi__keyring'. */
     table?: string;
 };
 type RecordData = {
@@ -248,6 +248,12 @@ type Connection = {
         prevent_inquiry: boolean;
         prevent_signup: boolean;
         prevent_anonymous: boolean;
+        /**
+         * BunnyQuery: whether the embeddable chat requires an account before a
+         * visitor can use it. Unrelated to `prevent_anonymous`, which governs
+         * anonymous record WRITES. Defaults to true.
+         */
+        require_login?: boolean;
     };
     ai_agent?: string;
 };
@@ -544,6 +550,7 @@ type RequestHistory = {
         latency?: number;
         onResponse?: (res: any) => void;
         onError?: (err: any) => void;
+        onStream?: (chunk: string, seq: number) => void;
     }) => Promise<any>;
 };
 type DatabaseResponse<T> = {
@@ -579,6 +586,12 @@ type ConnectionInfo = {
         prevent_signup: boolean;
         prevent_inquiry: boolean;
         prevent_anonymous: boolean;
+        /**
+         * BunnyQuery: whether the embeddable chat requires an account before a
+         * visitor can use it. Unrelated to `prevent_anonymous`, which governs
+         * anonymous record WRITES. Defaults to true.
+         */
+        require_login?: boolean;
     };
 };
 type Table = {
@@ -995,6 +1008,8 @@ declare class Skapi {
         expires?: number;
         onResponse?: (res: any) => void;
         onError?: (err: any) => void;
+        stream?: boolean;
+        onStream?: (chunk: string, seq: number) => void;
     }): Promise<any | {
         id: string;
         status: 'running' | 'pending';
@@ -1002,6 +1017,7 @@ declare class Skapi {
         in_queue: number;
         poll?: (arg?: {
             latency?: number;
+            onStream?: (chunk: string, seq: number) => void;
         }) => Promise<any>;
     }>;
     /**
@@ -1033,6 +1049,63 @@ declare class Skapi {
      * @param params Request parameters.
      * @returns A promise that resolves to a result object with removed status and message.
      */
+    /**
+     * Reads a streamed clientSecretRequest that this call did not start: a page reload,
+     * a second tab, or a turn from history that was never finalized.
+     *
+     * `onStream` receives the relayed text in order, exactly as the destination sent it.
+     * skapi does not parse it; whatever grammar those bytes are in belongs to the caller
+     * and its destination. Pass `since` to resume rather than re-read from the beginning.
+     *
+     * When the request is still running this polls until it settles. When it has already
+     * settled it reads every chunk once and resolves.
+     *
+     * ```js
+     * const parser = createMyParser();
+     * await skapi.clientSecretRequestStream(requestId, {
+     *     url: 'https://api.example.com/v1/chat',
+     *     method: 'POST',
+     *     onStream: (chunk) => parser.feed(chunk)
+     * });
+     * ```
+     */
+    clientSecretRequestStream(requestId: string, options: {
+        url?: string;
+        method?: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        onStream?: (chunk: string, seq: number) => void;
+        since?: number;
+        poll?: number;
+        onResponse?: (res: any) => void;
+        onError?: (err: any) => void;
+        service?: string;
+        owner?: string;
+    }): Promise<any>;
+    /**
+     * Stores the version of a streamed response you want KEPT as history, and releases
+     * the relayed chunks it was assembled from.
+     *
+     * The content is entirely yours. skapi neither validates nor interprets it: it stores
+     * what you tell it to store. Only the caller who made the request may finalize it.
+     *
+     * Until you finalize, the chunks stay indefinitely and every read of that turn has to
+     * fetch and re-parse all of them, so finalize as soon as you have rendered the answer.
+     *
+     * ```js
+     * await skapi.clientSecretRequestFinalize(requestId, parser.result(), {
+     *     url: 'https://api.example.com/v1/chat',
+     *     method: 'POST'
+     * });
+     * ```
+     */
+    clientSecretRequestFinalize(requestId: string, data?: any, options?: {
+        url?: string;
+        method?: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        service?: string;
+        owner?: string;
+    }): Promise<{
+        finalized: boolean;
+        message: string;
+    }>;
     cancelClientSecretRequest(params: {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';

package/dist/skapi.d.ts

@@ -53,8 +53,8 @@ type GetRecordQuery = {
     table?: string | {
         /** Max 256 characters, where / ! * # % each count as 3. Blocks control chars and sentinel 􏿿. */
         name: string;
-        /** Number range: 0 ~ 99. Default: 'public' */
-        access_group?: number | 'private' | 'public' | 'authorized' | 'admin';
+        /** Number range: 0 ~ 99. 'public' = 0, 'authorized' = 1, 'admin' = 99. '*' is shorthand for 'private'. Default: 'public' */
+        access_group?: number | 'private' | '*' | 'public' | 'authorized' | 'admin';
         /** User ID of subscription */
         subscription?: string;
     };
@@ -83,8 +83,8 @@ type PostRecordConfig = {
     table?: {
         /** Max 256 characters, where / ! * # % each count as 3. Blocks control chars and sentinel 􏿿. */
         name?: string;
-        /** Number range: 0 ~ 99. Default: 'public' */
-        access_group?: number | 'private' | 'public' | 'authorized' | 'admin';
+        /** Number range: 0 ~ 99. 'public' = 0, 'authorized' = 1, 'admin' = 99. '*' is shorthand for 'private'. Default: 'public' */
+        access_group?: number | 'private' | '*' | 'public' | 'authorized' | 'admin';
         /** When true, Record will be only accessible for subscribed users. */
         subscription?: {
             is_subscription_record?: boolean;
@@ -170,7 +170,7 @@ type EncryptionOptions = boolean | {
      * encrypted records are permanently unreadable.
      */
     recovery?: 'code' | 'none';
-    /** Reserved keyring table name. Default 'skapi__keyring'. */
+    /** Reserved keyring table name. Default '__skapi__keyring'. */
     table?: string;
 };
 type RecordData = {
@@ -248,6 +248,12 @@ type Connection = {
         prevent_inquiry: boolean;
         prevent_signup: boolean;
         prevent_anonymous: boolean;
+        /**
+         * BunnyQuery: whether the embeddable chat requires an account before a
+         * visitor can use it. Unrelated to `prevent_anonymous`, which governs
+         * anonymous record WRITES. Defaults to true.
+         */
+        require_login?: boolean;
     };
     ai_agent?: string;
 };
@@ -544,6 +550,7 @@ type RequestHistory = {
         latency?: number;
         onResponse?: (res: any) => void;
         onError?: (err: any) => void;
+        onStream?: (chunk: string, seq: number) => void;
     }) => Promise<any>;
 };
 type DatabaseResponse<T> = {
@@ -579,6 +586,12 @@ type ConnectionInfo = {
         prevent_signup: boolean;
         prevent_inquiry: boolean;
         prevent_anonymous: boolean;
+        /**
+         * BunnyQuery: whether the embeddable chat requires an account before a
+         * visitor can use it. Unrelated to `prevent_anonymous`, which governs
+         * anonymous record WRITES. Defaults to true.
+         */
+        require_login?: boolean;
     };
 };
 type Table = {
@@ -995,6 +1008,8 @@ declare class Skapi {
         expires?: number;
         onResponse?: (res: any) => void;
         onError?: (err: any) => void;
+        stream?: boolean;
+        onStream?: (chunk: string, seq: number) => void;
     }): Promise<any | {
         id: string;
         status: 'running' | 'pending';
@@ -1002,6 +1017,7 @@ declare class Skapi {
         in_queue: number;
         poll?: (arg?: {
             latency?: number;
+            onStream?: (chunk: string, seq: number) => void;
         }) => Promise<any>;
     }>;
     /**
@@ -1033,6 +1049,63 @@ declare class Skapi {
      * @param params Request parameters.
      * @returns A promise that resolves to a result object with removed status and message.
      */
+    /**
+     * Reads a streamed clientSecretRequest that this call did not start: a page reload,
+     * a second tab, or a turn from history that was never finalized.
+     *
+     * `onStream` receives the relayed text in order, exactly as the destination sent it.
+     * skapi does not parse it; whatever grammar those bytes are in belongs to the caller
+     * and its destination. Pass `since` to resume rather than re-read from the beginning.
+     *
+     * When the request is still running this polls until it settles. When it has already
+     * settled it reads every chunk once and resolves.
+     *
+     * ```js
+     * const parser = createMyParser();
+     * await skapi.clientSecretRequestStream(requestId, {
+     *     url: 'https://api.example.com/v1/chat',
+     *     method: 'POST',
+     *     onStream: (chunk) => parser.feed(chunk)
+     * });
+     * ```
+     */
+    clientSecretRequestStream(requestId: string, options: {
+        url?: string;
+        method?: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        onStream?: (chunk: string, seq: number) => void;
+        since?: number;
+        poll?: number;
+        onResponse?: (res: any) => void;
+        onError?: (err: any) => void;
+        service?: string;
+        owner?: string;
+    }): Promise<any>;
+    /**
+     * Stores the version of a streamed response you want KEPT as history, and releases
+     * the relayed chunks it was assembled from.
+     *
+     * The content is entirely yours. skapi neither validates nor interprets it: it stores
+     * what you tell it to store. Only the caller who made the request may finalize it.
+     *
+     * Until you finalize, the chunks stay indefinitely and every read of that turn has to
+     * fetch and re-parse all of them, so finalize as soon as you have rendered the answer.
+     *
+     * ```js
+     * await skapi.clientSecretRequestFinalize(requestId, parser.result(), {
+     *     url: 'https://api.example.com/v1/chat',
+     *     method: 'POST'
+     * });
+     * ```
+     */
+    clientSecretRequestFinalize(requestId: string, data?: any, options?: {
+        url?: string;
+        method?: 'GET' | 'POST' | 'DELETE' | 'PUT';
+        service?: string;
+        owner?: string;
+    }): Promise<{
+        finalized: boolean;
+        message: string;
+    }>;
     cancelClientSecretRequest(params: {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';