skapi-js 2.0.0-rc.9 → 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 = {
@@ -249,12 +249,11 @@ type Connection = {
         prevent_signup: boolean;
         prevent_anonymous: boolean;
         /**
-         * Project-wide default for `table.access_group`, set by the project
-         * owner. Applied by getRecords / postRecord / deleteRecords unless the
-         * `default_access_group` init option overrides it. Absent when the owner
-         * has not set one, in which case the SDK's own default (0) stands.
+         * 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.
          */
-        default_access_group?: DefaultAccessGroup;
+        require_login?: boolean;
     };
     ai_agent?: string;
 };
@@ -551,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> = {
@@ -571,20 +571,6 @@ type FileInfo = {
     uploaded: number;
     fileKey: string;
 };
-/**
- * A project-wide default for `table.access_group`.
- *
- * Accepts everything `table.access_group` itself accepts (a number 0-99, or one
- * of 'public' / 'private' / 'authorized' / 'admin'), plus 'ask'.
- *
- * 'ask' does not pick a group: it makes an OMITTED `access_group` an error, so
- * the caller has to state one on every record it reads, writes or deletes by
- * table. Meant for projects that hold data at more than one visibility and would
- * rather fail loudly than quietly fall back to public. Calls addressed by
- * `record_id` or `unique_id`, and updates to an existing record, are unaffected:
- * they do not carry a table at all.
- */
-type DefaultAccessGroup = number | 'public' | 'private' | 'authorized' | 'admin' | 'ask';
 type ConnectionInfo = {
     /** Public project ID (service + owner composed into the two-segment token). Empty when the service has no uuid owner. */
     project_id: string;
@@ -601,12 +587,11 @@ type ConnectionInfo = {
         prevent_inquiry: boolean;
         prevent_anonymous: boolean;
         /**
-         * Project-wide default for `table.access_group`, set by the project
-         * owner. Applied by getRecords / postRecord / deleteRecords unless the
-         * `default_access_group` init option overrides it. Absent when the owner
-         * has not set one, in which case the SDK's own default (0) stands.
+         * 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.
          */
-        default_access_group?: DefaultAccessGroup;
+        require_login?: boolean;
     };
 };
 type Table = {
@@ -655,7 +640,6 @@ type Types_Condition = Condition;
 type Types_Connection = Connection;
 type Types_ConnectionInfo = ConnectionInfo;
 type Types_DatabaseResponse<T> = DatabaseResponse<T>;
-type Types_DefaultAccessGroup = DefaultAccessGroup;
 type Types_DelRecordQuery = DelRecordQuery;
 type Types_EncryptionOptions = EncryptionOptions;
 type Types_FetchOptions = FetchOptions;
@@ -684,7 +668,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_DefaultAccessGroup as DefaultAccessGroup, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, 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_RecordEncryptionInfo as RecordEncryptionInfo, 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 };
+  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_EncryptionOptions as EncryptionOptions, 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_RecordEncryptionInfo as RecordEncryptionInfo, 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;
@@ -727,19 +711,6 @@ type Options = {
     autoLogin: boolean;
     refetchServiceInfo?: boolean;
     requestBatchSize?: number;
-    /**
-     * Default value for `table.access_group` on getRecords, postRecord and
-     * deleteRecords when the caller omits one. Overrides the project's own
-     * `default_access_group` setting; when neither is set, the SDK's historical
-     * default of 0 (public) stands.
-     *
-     * 'ask' picks no group. It makes an omitted `access_group` an ERROR, for
-     * projects that hold data at more than one visibility and would rather fail
-     * loudly than quietly write to public. Calls addressed by `record_id` or
-     * `unique_id`, and updates to an existing record, carry no table and are
-     * unaffected.
-     */
-    default_access_group?: DefaultAccessGroup;
     /**
      * Enable client-side encryption of `data` on records written to
      * access_group 'private'. Off by default. See EncryptionOptions.
@@ -794,14 +765,6 @@ declare class Skapi {
     private host;
     private hostDomain;
     private target_cdn;
-    /**
-     * The `default_access_group` INIT OPTION, if one was given. Kept separate
-     * from the project's own setting (connection.opt.default_access_group)
-     * because the two have a precedence order and collapsing them would lose it:
-     * an app that pins a value in code must not have it changed under it by a
-     * dashboard edit.
-     */
-    private __default_access_group;
     private customApiDomain;
     private requestBatchSize;
     private __disabledAccount;
@@ -880,25 +843,6 @@ declare class Skapi {
      * @param params Request parameters. When `refresh` is true, the cached connection metadata is re-fetched before returning; otherwise the cached connection is returned.
      * @returns A promise that resolves to Promise<ConnectionInfo>.
      */
-    /**
-     * The effective `default_access_group` for this instance, or null when there
-     * is none and the SDK's historical default (0) stands.
-     *
-     * Precedence: the INIT OPTION wins, then the project's own setting. An app
-     * that pins a value in code is stating an intent the dashboard must not
-     * silently override; a project that has set one is stating a default for
-     * every app that has not.
-     *
-     * Reads `this.connection` rather than awaiting it: every caller
-     * (getRecords / postRecord / deleteRecords) has already awaited
-     * `__connection` before it gets here, so the project value is populated. A
-     * miss degrades to "no default", never to a wrong one.
-     *
-     * A malformed project value is IGNORED rather than thrown: it arrives from
-     * the server, not from the caller, and taking down every record call over it
-     * would be a worse failure than falling back to the SDK default.
-     */
-    private _defaultAccessGroup;
     getConnectionInfo(params?: {
         refresh?: boolean;
     }): Promise<ConnectionInfo>;
@@ -1064,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';
@@ -1071,6 +1017,7 @@ declare class Skapi {
         in_queue: number;
         poll?: (arg?: {
             latency?: number;
+            onStream?: (chunk: string, seq: number) => void;
         }) => Promise<any>;
     }>;
     /**
@@ -1102,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 = {
@@ -249,12 +249,11 @@ type Connection = {
         prevent_signup: boolean;
         prevent_anonymous: boolean;
         /**
-         * Project-wide default for `table.access_group`, set by the project
-         * owner. Applied by getRecords / postRecord / deleteRecords unless the
-         * `default_access_group` init option overrides it. Absent when the owner
-         * has not set one, in which case the SDK's own default (0) stands.
+         * 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.
          */
-        default_access_group?: DefaultAccessGroup;
+        require_login?: boolean;
     };
     ai_agent?: string;
 };
@@ -551,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> = {
@@ -571,20 +571,6 @@ type FileInfo = {
     uploaded: number;
     fileKey: string;
 };
-/**
- * A project-wide default for `table.access_group`.
- *
- * Accepts everything `table.access_group` itself accepts (a number 0-99, or one
- * of 'public' / 'private' / 'authorized' / 'admin'), plus 'ask'.
- *
- * 'ask' does not pick a group: it makes an OMITTED `access_group` an error, so
- * the caller has to state one on every record it reads, writes or deletes by
- * table. Meant for projects that hold data at more than one visibility and would
- * rather fail loudly than quietly fall back to public. Calls addressed by
- * `record_id` or `unique_id`, and updates to an existing record, are unaffected:
- * they do not carry a table at all.
- */
-type DefaultAccessGroup = number | 'public' | 'private' | 'authorized' | 'admin' | 'ask';
 type ConnectionInfo = {
     /** Public project ID (service + owner composed into the two-segment token). Empty when the service has no uuid owner. */
     project_id: string;
@@ -601,12 +587,11 @@ type ConnectionInfo = {
         prevent_inquiry: boolean;
         prevent_anonymous: boolean;
         /**
-         * Project-wide default for `table.access_group`, set by the project
-         * owner. Applied by getRecords / postRecord / deleteRecords unless the
-         * `default_access_group` init option overrides it. Absent when the owner
-         * has not set one, in which case the SDK's own default (0) stands.
+         * 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.
          */
-        default_access_group?: DefaultAccessGroup;
+        require_login?: boolean;
     };
 };
 type Table = {
@@ -655,7 +640,6 @@ type Types_Condition = Condition;
 type Types_Connection = Connection;
 type Types_ConnectionInfo = ConnectionInfo;
 type Types_DatabaseResponse<T> = DatabaseResponse<T>;
-type Types_DefaultAccessGroup = DefaultAccessGroup;
 type Types_DelRecordQuery = DelRecordQuery;
 type Types_EncryptionOptions = EncryptionOptions;
 type Types_FetchOptions = FetchOptions;
@@ -684,7 +668,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_DefaultAccessGroup as DefaultAccessGroup, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, 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_RecordEncryptionInfo as RecordEncryptionInfo, 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 };
+  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_EncryptionOptions as EncryptionOptions, 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_RecordEncryptionInfo as RecordEncryptionInfo, 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;
@@ -727,19 +711,6 @@ type Options = {
     autoLogin: boolean;
     refetchServiceInfo?: boolean;
     requestBatchSize?: number;
-    /**
-     * Default value for `table.access_group` on getRecords, postRecord and
-     * deleteRecords when the caller omits one. Overrides the project's own
-     * `default_access_group` setting; when neither is set, the SDK's historical
-     * default of 0 (public) stands.
-     *
-     * 'ask' picks no group. It makes an omitted `access_group` an ERROR, for
-     * projects that hold data at more than one visibility and would rather fail
-     * loudly than quietly write to public. Calls addressed by `record_id` or
-     * `unique_id`, and updates to an existing record, carry no table and are
-     * unaffected.
-     */
-    default_access_group?: DefaultAccessGroup;
     /**
      * Enable client-side encryption of `data` on records written to
      * access_group 'private'. Off by default. See EncryptionOptions.
@@ -794,14 +765,6 @@ declare class Skapi {
     private host;
     private hostDomain;
     private target_cdn;
-    /**
-     * The `default_access_group` INIT OPTION, if one was given. Kept separate
-     * from the project's own setting (connection.opt.default_access_group)
-     * because the two have a precedence order and collapsing them would lose it:
-     * an app that pins a value in code must not have it changed under it by a
-     * dashboard edit.
-     */
-    private __default_access_group;
     private customApiDomain;
     private requestBatchSize;
     private __disabledAccount;
@@ -880,25 +843,6 @@ declare class Skapi {
      * @param params Request parameters. When `refresh` is true, the cached connection metadata is re-fetched before returning; otherwise the cached connection is returned.
      * @returns A promise that resolves to Promise<ConnectionInfo>.
      */
-    /**
-     * The effective `default_access_group` for this instance, or null when there
-     * is none and the SDK's historical default (0) stands.
-     *
-     * Precedence: the INIT OPTION wins, then the project's own setting. An app
-     * that pins a value in code is stating an intent the dashboard must not
-     * silently override; a project that has set one is stating a default for
-     * every app that has not.
-     *
-     * Reads `this.connection` rather than awaiting it: every caller
-     * (getRecords / postRecord / deleteRecords) has already awaited
-     * `__connection` before it gets here, so the project value is populated. A
-     * miss degrades to "no default", never to a wrong one.
-     *
-     * A malformed project value is IGNORED rather than thrown: it arrives from
-     * the server, not from the caller, and taking down every record call over it
-     * would be a worse failure than falling back to the SDK default.
-     */
-    private _defaultAccessGroup;
     getConnectionInfo(params?: {
         refresh?: boolean;
     }): Promise<ConnectionInfo>;
@@ -1064,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';
@@ -1071,6 +1017,7 @@ declare class Skapi {
         in_queue: number;
         poll?: (arg?: {
             latency?: number;
+            onStream?: (chunk: string, seq: number) => void;
         }) => Promise<any>;
     }>;
     /**
@@ -1102,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';