skapi-js 2.0.0-rc.7 → 2.0.0-rc.9

package/dist/skapi.d.mts

@@ -248,6 +248,13 @@ type Connection = {
         prevent_inquiry: boolean;
         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.
+         */
+        default_access_group?: DefaultAccessGroup;
     };
     ai_agent?: string;
 };
@@ -564,6 +571,20 @@ 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;
@@ -579,6 +600,13 @@ type ConnectionInfo = {
         prevent_signup: boolean;
         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.
+         */
+        default_access_group?: DefaultAccessGroup;
     };
 };
 type Table = {
@@ -627,6 +655,7 @@ 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;
@@ -655,7 +684,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_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_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 };
 }
 
 declare function terminatePendingRequests(): void;
@@ -698,6 +727,19 @@ 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.
@@ -752,6 +794,14 @@ 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;
@@ -830,6 +880,25 @@ 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>;

package/dist/skapi.d.ts

@@ -248,6 +248,13 @@ type Connection = {
         prevent_inquiry: boolean;
         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.
+         */
+        default_access_group?: DefaultAccessGroup;
     };
     ai_agent?: string;
 };
@@ -564,6 +571,20 @@ 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;
@@ -579,6 +600,13 @@ type ConnectionInfo = {
         prevent_signup: boolean;
         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.
+         */
+        default_access_group?: DefaultAccessGroup;
     };
 };
 type Table = {
@@ -627,6 +655,7 @@ 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;
@@ -655,7 +684,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_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_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 };
 }
 
 declare function terminatePendingRequests(): void;
@@ -698,6 +727,19 @@ 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.
@@ -752,6 +794,14 @@ 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;
@@ -830,6 +880,25 @@ 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>;