@alwaysmeticulous/api 2.185.1 → 2.186.0

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.d.ts

@@ -30,7 +30,11 @@ export interface SessionData {
          * Only present on recordings since ~Aug 2024
          */
         indexedDb?: {
-            state: IDBObjectStoreSnapshot[];
+            /**
+             * createObjectStoreOptions will be omitted when snapshotting an object store entry on the fly.
+             * @see IDBObjectStoreMetadata.snapshotEntriesOnRead for more details.
+             */
+            state: (IDBObjectStoreSnapshot | Omit<IDBObjectStoreSnapshot, "createObjectStoreOptions">)[];
         };
     };
     /**
@@ -106,6 +110,12 @@ export interface EarlyRequest {
 export interface IDBObjectStoreMetadata {
     databaseName: string;
     objectStoreName: string;
+    /**
+     * If true, then we only snapshot the entries as they are read from the object store.
+     * This can be useful if the object store is typically large and we don't want to snapshot
+     * the entire thing.
+     */
+    snapshotEntriesOnRead?: boolean;
     serialize?: (value: any) => string;
     deserialize?: (value: string) => any;
     /**
@@ -132,13 +142,19 @@ interface StringKey {
 export type IDBObjectStoreSnapshot = Pick<IDBObjectStoreMetadata, "databaseName" | "objectStoreName"> & {
     createObjectStoreOptions: IDBObjectStoreParameters;
     /**
-     * Entry values are JSON stringified by default. JSON representable objects, arrays and primitives are supported.
-     * For all other types (e.g. Date, Regex, ArrayBuffer etc.), you can define a custom [de]serialize function on the
-     * object store metadata to dictate how the value should be mapped to/from strings. @see IDBObjectStoreMetadata
+     * Entry values are serialized with SuperJSON by default. JSON representable objects, arrays and primitives are
+     * supported as well as more complex types (e.g. Date, Regex, ArrayBuffer etc.). However, you can add custom
+     * serialization logic to the object store metadata to support object store specific types.
+     * @see IDBObjectStoreMetadata.serialize
      */
     entries: {
         key?: SerializedIDBValidKey;
         value: string;
+        /**
+         * This may be present for snapshots taken since ~Dec 2024 when we started using SuperJSON.
+         * If it's present, this field stores the SuperJSONResult.meta field, with the stringified
+         * text of SuperJSON.json being stored in the value field above.
+         */
         valueMeta?: {
             values?: unknown;
             referentialEqualities?: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.185.1",
+  "version": "2.186.0",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "31fd9518a85bb75e2a5fcb2b108a9d8d177eb087"
+  "gitHead": "e87ff02d6e974358abcd262d74855085fd01b8a8"
 }