skapi-js 1.8.2 → 2.0.0-rc.0

package/dist/skapi.d.mts

@@ -51,7 +51,7 @@ type GetRecordQuery = {
     record_id?: string;
     /** Table name not required when "record_id" is given. A bare string is shorthand for { name: <string> }. */
     table?: string | {
-        /** Max 128 chars. Blocks: / ! * #, control chars, and sentinel 􏿿. */
+        /** 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';
@@ -65,9 +65,9 @@ type GetRecordQuery = {
     };
     /** Index condition and range cannot be used simultaneously.*/
     index?: {
-        /** Custom names: max 128 chars, cannot start with "$", blocks / ! * #, control chars, and sentinel 􏿿. Reserved names: $uploaded, $updated, $referenced_count, $user_id. */
+        /** Custom names: max 256 characters, where / ! * # % each count as 3. Cannot start with "$". Blocks control chars and sentinel 􏿿. Reserved names: $uploaded, $updated, $referenced_count, $user_id. */
         name: string | '$updated' | '$uploaded' | '$referenced_count' | '$user_id';
-        /** String value max 256 chars. Allows punctuation (including / ! * #). Blocks control chars and sentinel 􏿿. */
+        /** String value max 256 characters. Any punctuation is allowed and counts as one character, and values compare exactly as written. 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;
@@ -81,7 +81,7 @@ type PostRecordConfig = {
     readonly?: boolean;
     /** Table name not required when "record_id" is given.*/
     table?: {
-        /** Max 128 chars. Blocks: / ! * #, control chars, and sentinel 􏿿. */
+        /** 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';
@@ -114,9 +114,9 @@ type PostRecordConfig = {
     reference?: string | null;
     /** null removes index */
     index?: {
-        /** Max 128 chars, cannot start with "$", blocks / ! * #, control chars, and sentinel 􏿿. */
+        /** Max 256 characters, where / ! * # % each count as 3. Cannot start with "$". Blocks control chars and sentinel 􏿿. */
         name: string;
-        /** String value max 256 chars. Allows punctuation (including / ! * #). Blocks control chars and sentinel 􏿿. */
+        /** String value max 256 characters. Any punctuation is allowed and counts as one character, and values compare exactly as written. Blocks control chars and sentinel 􏿿. */
         value: string | number | boolean;
     } | null;
     tags?: string[] | null;
@@ -519,6 +519,8 @@ type FileInfo = {
     fileKey: string;
 };
 type ConnectionInfo = {
+    /** Public project ID (service + owner composed into the two-segment token). Empty when the service has no uuid owner. */
+    project_id: string;
     user_ip: string;
     user_agent: string;
     user_location: string;
@@ -638,7 +640,7 @@ declare function extractFormData(form: FormData | HTMLFormElement | SubmitEvent
         file: File;
     }[];
 };
-declare function decodeServiceId(service: any): {
+declare function decodeProjectId(service: any): {
     service: any;
     owner: any;
 };
@@ -662,6 +664,13 @@ declare class Skapi {
     private __version;
     service: string;
     owner: string;
+    /**
+     * The public project ID: the single two-segment token composed from service + owner
+     * (the same value formatServiceId returns, and the form external tools accept).
+     * Empty string when the service has no uuid owner (e.g. host-owned), since the
+     * compound form cannot be built without one.
+     */
+    project_id: string;
     session: Record<string, any> | null;
     connection: Connection | null;
     /**
@@ -729,7 +738,7 @@ declare class Skapi {
         generateRandom: typeof generateRandom;
         toBase62: typeof toBase62;
         fromBase62: typeof fromBase62;
-        decodeServiceId: typeof decodeServiceId;
+        decodeProjectId: typeof decodeProjectId;
         formatServiceId: typeof formatServiceId;
         extractFormData: typeof extractFormData;
         terminatePendingRequests: typeof terminatePendingRequests;
@@ -744,6 +753,8 @@ declare class Skapi {
                 accessToken?: boolean | string;
                 idToken?: boolean | string;
             };
+            stableGateway?: boolean;
+            revalidate?: boolean;
         }) => any;
     };
     private __connection;
@@ -1199,6 +1210,8 @@ declare class Skapi {
     config?: {
         dataType?: 'base64' | 'download' | 'endpoint' | 'blob' | 'text' | 'info';
         expires?: number;
+        browserCache?: number;
+        refresh?: boolean;
         progress?: ProgressCallback;
     }): Promise<Blob | string | void | FileInfo>;
     /**

package/dist/skapi.d.ts

@@ -51,7 +51,7 @@ type GetRecordQuery = {
     record_id?: string;
     /** Table name not required when "record_id" is given. A bare string is shorthand for { name: <string> }. */
     table?: string | {
-        /** Max 128 chars. Blocks: / ! * #, control chars, and sentinel 􏿿. */
+        /** 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';
@@ -65,9 +65,9 @@ type GetRecordQuery = {
     };
     /** Index condition and range cannot be used simultaneously.*/
     index?: {
-        /** Custom names: max 128 chars, cannot start with "$", blocks / ! * #, control chars, and sentinel 􏿿. Reserved names: $uploaded, $updated, $referenced_count, $user_id. */
+        /** Custom names: max 256 characters, where / ! * # % each count as 3. Cannot start with "$". Blocks control chars and sentinel 􏿿. Reserved names: $uploaded, $updated, $referenced_count, $user_id. */
         name: string | '$updated' | '$uploaded' | '$referenced_count' | '$user_id';
-        /** String value max 256 chars. Allows punctuation (including / ! * #). Blocks control chars and sentinel 􏿿. */
+        /** String value max 256 characters. Any punctuation is allowed and counts as one character, and values compare exactly as written. 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;
@@ -81,7 +81,7 @@ type PostRecordConfig = {
     readonly?: boolean;
     /** Table name not required when "record_id" is given.*/
     table?: {
-        /** Max 128 chars. Blocks: / ! * #, control chars, and sentinel 􏿿. */
+        /** 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';
@@ -114,9 +114,9 @@ type PostRecordConfig = {
     reference?: string | null;
     /** null removes index */
     index?: {
-        /** Max 128 chars, cannot start with "$", blocks / ! * #, control chars, and sentinel 􏿿. */
+        /** Max 256 characters, where / ! * # % each count as 3. Cannot start with "$". Blocks control chars and sentinel 􏿿. */
         name: string;
-        /** String value max 256 chars. Allows punctuation (including / ! * #). Blocks control chars and sentinel 􏿿. */
+        /** String value max 256 characters. Any punctuation is allowed and counts as one character, and values compare exactly as written. Blocks control chars and sentinel 􏿿. */
         value: string | number | boolean;
     } | null;
     tags?: string[] | null;
@@ -519,6 +519,8 @@ type FileInfo = {
     fileKey: string;
 };
 type ConnectionInfo = {
+    /** Public project ID (service + owner composed into the two-segment token). Empty when the service has no uuid owner. */
+    project_id: string;
     user_ip: string;
     user_agent: string;
     user_location: string;
@@ -638,7 +640,7 @@ declare function extractFormData(form: FormData | HTMLFormElement | SubmitEvent
         file: File;
     }[];
 };
-declare function decodeServiceId(service: any): {
+declare function decodeProjectId(service: any): {
     service: any;
     owner: any;
 };
@@ -662,6 +664,13 @@ declare class Skapi {
     private __version;
     service: string;
     owner: string;
+    /**
+     * The public project ID: the single two-segment token composed from service + owner
+     * (the same value formatServiceId returns, and the form external tools accept).
+     * Empty string when the service has no uuid owner (e.g. host-owned), since the
+     * compound form cannot be built without one.
+     */
+    project_id: string;
     session: Record<string, any> | null;
     connection: Connection | null;
     /**
@@ -729,7 +738,7 @@ declare class Skapi {
         generateRandom: typeof generateRandom;
         toBase62: typeof toBase62;
         fromBase62: typeof fromBase62;
-        decodeServiceId: typeof decodeServiceId;
+        decodeProjectId: typeof decodeProjectId;
         formatServiceId: typeof formatServiceId;
         extractFormData: typeof extractFormData;
         terminatePendingRequests: typeof terminatePendingRequests;
@@ -744,6 +753,8 @@ declare class Skapi {
                 accessToken?: boolean | string;
                 idToken?: boolean | string;
             };
+            stableGateway?: boolean;
+            revalidate?: boolean;
         }) => any;
     };
     private __connection;
@@ -1199,6 +1210,8 @@ declare class Skapi {
     config?: {
         dataType?: 'base64' | 'download' | 'endpoint' | 'blob' | 'text' | 'info';
         expires?: number;
+        browserCache?: number;
+        refresh?: boolean;
         progress?: ProgressCallback;
     }): Promise<Blob | string | void | FileInfo>;
     /**