@alwaysmeticulous/api 2.139.0 → 2.141.0

package/dist/index.d.ts

@@ -12,3 +12,4 @@ export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, Screen
 export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
 export { ConsoleMessageWithStackTracePointer, VirtualTimeChange, MeticulousConsoleMessage, ApplicationConsoleMessage, ConsoleMessageCoreData, ConsoleMessageType, ConsoleMessageLocation, } from "./sdk-bundle-api/bundle-to-sdk/console-message";
 export { InjectableRequestHeader, StaticHeaderValue, DynamicHeaderValue, AllRequests, AppUrlRequestsOnly, CustomRequests, } from "./sdk-bundle-api/sdk-to-bundle/header-injection";
+export { Divergence, DivergenceIndicator, NetworkActivityDivergenceIndicator, ScreenshotDivergenceIdentifier, UrlChangeEventDivergenceIndicator, UserEventDivergenceIndicator, } from "./sdk-bundle-api/bundle-to-sdk/replay-divergence";

package/dist/sdk-bundle-api/bundle-to-sdk/replay-divergence.d.ts

@@ -0,0 +1,46 @@
+import { ScreenshotDiffResult } from "./screenshot-diff-result";
+export type DivergenceIndicator = UserEventDivergenceIndicator | UrlChangeEventDivergenceIndicator | NetworkActivityDivergenceIndicator;
+export interface UserEventDivergenceIndicator {
+    type: "user-event";
+    beforeEventIdx: number;
+    afterEventIdx: number;
+}
+export interface UrlChangeEventDivergenceIndicator {
+    type: "url-change";
+    beforeEventIdx?: number;
+    afterEventIdx?: number;
+}
+export interface NetworkActivityDivergenceIndicator {
+    type: "network-activity";
+    beforeEventIndices?: number[] | undefined;
+    afterEventIndices: number[];
+}
+export interface ScreenshotDivergenceIdentifier {
+    filename: string;
+    outcome: ScreenshotDiffResult["outcome"];
+    virtualTime: number;
+}
+export interface Divergence {
+    /**
+     * The type of the first divergence indicator that occurred chronologically.
+     */
+    reason: "none" | DivergenceIndicator["type"];
+    divergenceIndicators: DivergenceIndicator[];
+    /**
+     * The first diff in the divergence (inclusive).
+     */
+    startScreenshotDiffId: ScreenshotDivergenceIdentifier;
+    /**
+     * The last diff in the divergence (inclusive).
+     */
+    endScreenshotDiffId: ScreenshotDivergenceIdentifier;
+    /**
+     * The most recent 'no-diff' prior to startScreenshotDiff, if one exists. Note that there could be some
+     * missing bases or missing heads etc. between lastMatchingScreenshotDiff and startScreenshotDiff.
+     */
+    lastMatchingScreenshotDiffId?: ScreenshotDivergenceIdentifier | undefined;
+    /**
+     * The number of screenshot diffs between startScreenshotDiff and endScreenshotDiff inclusive.
+     */
+    length: number;
+}

package/dist/sdk-bundle-api/bundle-to-sdk/replay-divergence.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=replay-divergence.js.map

package/dist/sdk-bundle-api/bundle-to-sdk/replay-divergence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replay-divergence.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/bundle-to-sdk/replay-divergence.ts"],"names":[],"mappings":""}

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.139.0",
+  "version": "2.141.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": "229466d734551b1a13c242e83a7e0d5782461eb8"
+  "gitHead": "891f9e4bdaf42f2f0ca8eb9e875a0ac43e63c4e7"
 }