@alwaysmeticulous/api 2.172.0 → 2.175.0

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCas
 export * 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, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreWithEntries, CustomData, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
+export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, StorageEntry, EarlyRequest, SerializedIDBValidKey, IDBObjectStoreMetadata, IDBObjectStoreWithEntries, CustomData, CustomUserEvent, } 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/bundle-to-sdk/replay-divergence.d.ts

@@ -32,6 +32,11 @@ export interface DivergenceConsoleError {
     numHeadAppearances: number;
     numBaseAppearances: number;
 }
+/**
+ * Initially we only classified divergences with this indicator based on console error timeline
+ * entries, but as of Nov 18, 2024 we also classify divergences with this indicator based on
+ * unhandled-window-error and unhandled-promise-rejection timeline events.
+ */
 export interface ConsoleErrorDivergenceIndicator {
     type: "console-error";
     beforeErrors: DivergenceConsoleError[];

package/dist/sdk-bundle-api/bundle-to-sdk/screenshot-diff-result.d.ts

@@ -76,10 +76,16 @@ export interface ScreenshotDiffResultCompared {
      * The result of comparing the redacted screenshots (i.e. screenshots taken after elements
      * to ignore have been hidden/removed).
      *
-     * Present only if there were redacted screenshots to compare, or if the original normal
-     * screenshots did not differ so there was no need to compare the redacted screenshots.
+     * Present if there were redacted screenshots to compare and either:
+     *  1. the original normal screenshots differed or
+     *  2. this comparison was a retry and the original comparison result was from the redacted screenshots
      */
-    redactedScreenshotsComparisonResult?: RedactedScreenshotsCompared | RedactedScreenshotIncompatible;
+    redactedScreenshotsComparisonResult?: {
+        /**
+         * This field will only be true if we are in situation 2 above and the original comparison was a no diff.
+         */
+        wasOriginalComparisonNoDiff?: boolean;
+    } & (RedactedScreenshotsCompared | RedactedScreenshotIncompatible);
 }
 export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
     outcome: "no-diff";
@@ -133,7 +139,16 @@ export interface ScreenshotDiffResultFlake {
      */
     diffsToHeadScreenshotOnRetries: ScreenshotDiffRetryResult[];
 }
-export type FlakeEvidence = "varied-results-on-retry" | "diff-is-known-flake";
+/**
+ * - **varied-results-on-retry**: The head screenshot was retaken one or more times and at least one of
+ *                                the new head screenshots differed from the first head screenshot.
+ *
+ * - **varied-redacted-results-on-retry**: The comparison between the retry screenshot and the original screenshot did not have
+ *                                         a diff but when we compared the redacted versions of the screenshot we found a diff.
+ *
+ * - **diff-is-known-flake**: The diff screenshot's hash matches the hash of a flake that was previously detected by one of the methods above.
+ */
+export type FlakeEvidence = "varied-results-on-retry" | "varied-redacted-results-on-retry" | "diff-is-known-flake";
 export type ScreenshotDiffRetryResult = SingleTryScreenshotDiffRetryResult | ScreenshotDiffResultMissingBaseAndHead;
 export type SingleTryScreenshotDiffRetryResult = {
     /**

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.172.0",
+  "version": "2.175.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": "24e2059b89347c3f07ea38c9aa32973ac15f9a48"
+  "gitHead": "600b5e17072eea1fb83d54e536dc644a7c95a87f"
 }