@alwaysmeticulous/api 2.137.0 → 2.140.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/bundle-to-sdk/screenshot-diff-result.d.ts

@@ -68,6 +68,10 @@ export interface ScreenshotDiffResultCompared {
     height: number;
     mismatchPixels: number;
     mismatchFraction: number;
+    /**
+     * First 8 characters of the hash of the diff image.
+     */
+    diffHash?: string;
     /**
      * The result of comparing the redacted screenshots (i.e. screenshots taken after elements
      * to ignore have been hidden/removed).
@@ -91,6 +95,10 @@ export interface RedactedScreenshotsCompared {
     type: "no-diff" | "diff" | undefined;
     mismatchPixels: number;
     mismatchFraction: number;
+    /**
+     * First 8 characters of the hash of the diff image.
+     */
+    diffHash?: string;
 }
 export interface RedactedScreenshotIncompatible {
     type: "missing-base" | "missing-head" | "different-size";
@@ -110,6 +118,7 @@ export interface ScreenshotDiffResultDifference extends ScreenshotDiffResultComp
  */
 export interface ScreenshotDiffResultFlake {
     outcome: "flake";
+    evidence?: FlakeEvidence;
     /**
      * The original diff. Can be any outcome.
      */
@@ -124,6 +133,7 @@ export interface ScreenshotDiffResultFlake {
      */
     diffsToHeadScreenshotOnRetries: ScreenshotDiffRetryResult[];
 }
+export type FlakeEvidence = "varied-results-on-retry" | "diff-is-known-flake";
 export type ScreenshotDiffRetryResult = SingleTryScreenshotDiffRetryResult | ScreenshotDiffResultMissingBaseAndHead;
 export type SingleTryScreenshotDiffRetryResult = {
     /**

package/package.json

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