@alwaysmeticulous/api 2.140.0 → 2.144.0

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCas
 export { TestRunEnvironment, TestRunGitHubContext, TestRunGitHubPullRequestContext, TestRunGitHubPushContext, TestRunGitHubWorkflowDispatchContext, TestRunGitLabContext, TestRunGitLabMergeRequestContext, TestRunGitLabPushContext, } from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
 export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
 export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
-export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
+export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreWithEntries, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
 export { SequenceNumber, WebSocketConnectionData, WebSocketConnectionEvent, WebSocketConnectionCreatedEvent, WebSocketConnectionOpenedEvent, EncodedArrayBuffer, EncodedBlob, WebSocketConnectionMessageEvent, WebSocketConnectionErrorEvent, WebSocketConnectionClosedEvent, } from "./sdk-bundle-api/sdk-to-bundle/websocket-data";
 export { Replay } from "./replay/replay.types";
 export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";

package/dist/sdk-bundle-api/sdk-to-bundle/screenshotting-options.d.ts

@@ -25,6 +25,7 @@ export declare type StoryboardOptions = {
 export interface ScreenshotDiffOptions {
     diffThreshold: number;
     diffPixelThreshold: number;
+    diffHashesToIgnoreByScreenshotFilename?: Record<string, string[]>;
 }
 export type ElementToIgnore = CSSSelectorToIgnore;
 /**

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

@@ -26,6 +26,12 @@ export interface SessionData {
         sessionStorage?: {
             state: StorageEntry[];
         };
+        /**
+         * Only present on recordings since ~Aug 2024
+         */
+        indexedDb?: {
+            state: IDBObjectStoreWithEntries[];
+        };
     };
     /**
      * Only present on recordings since ~March 2024
@@ -93,3 +99,35 @@ export interface EarlyRequest {
     startTime: number;
     duration: number;
 }
+export interface IDBObjectStoreMetadata {
+    databaseName: string;
+    objectStoreName: string;
+    serialize?: (value: any) => string;
+    deserialize?: (value: string) => any;
+}
+/**
+ * Currently we only support string keys, but we may support other types in the future.
+ * Keys are:
+ * - Serialized in recorder/src/storage/storage.ts
+ * - Deserialized in puppeteer-utils/src/browser-context/storage.ts
+ *
+ * @see IDBValidKey for all possible types.
+ */
+export type SerializedIDBValidKey = StringKey;
+interface StringKey {
+    type: "string";
+    serializedKey: string;
+}
+export type IDBObjectStoreWithEntries = Omit<IDBObjectStoreMetadata, "serialize" | "deserialize"> & {
+    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
+     */
+    entries: {
+        key?: SerializedIDBValidKey;
+        value: string;
+    }[];
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.140.0",
+  "version": "2.144.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": "63755ec0c02e90e1f8cbea96fd06d3e5e0946ec2"
+  "gitHead": "7e7830ec222145a910b185c229cfb0b2c8a57961"
 }