@alwaysmeticulous/api 2.290.2 → 2.292.0

package/dist/custom-checks.types.d.ts

@@ -22,6 +22,13 @@ export interface Snapshot<T = unknown> {
      */
     stageDuringSession: string;
     data: T;
+    /**
+     * Version number the snapshot was recorded with (see
+     * `recordCustomSnapshot`). Defaults to 0 for snapshots recorded without one
+     * (including all built-in snapshots). When the version differs between the
+     * base and head snapshots, a failing check can be caveated in the UI.
+     */
+    versionNumber?: number;
 }
 /** The base and head snapshots passed to a custom check. */
 export interface CustomCheckInput {

package/dist/custom-checks.types.js

@@ -1,5 +1,5 @@
 "use strict";
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f")}catch(e){}}();
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="8ef65cd4-8945-57ad-89ea-063f84e905ee")}catch(e){}}();
 
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CUSTOM_CHECK_RESULTS_STATUSES = exports.NETWORK_REQUESTS_SNAPSHOT_TYPE = exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = void 0;
@@ -27,4 +27,4 @@ exports.CUSTOM_CHECK_RESULTS_STATUSES = [
     "execution-error",
 ];
 //# sourceMappingURL=custom-checks.types.js.map
-//# debugId=14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f
+//# debugId=8ef65cd4-8945-57ad-89ea-063f84e905ee

package/dist/custom-checks.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAoDA;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,GAAG,CAAC;AA4DnD;;;GAGG;AACU,QAAA,8BAA8B,GAAG,kBAAkB,CAAC;AAyBjE;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG;IAC3C,UAAU;IACV,iBAAiB;CACT,CAAC","debugId":"14a4ab8a-ebd9-5fd7-ba2b-b93055c8f39f"}
+{"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AA4DA;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,GAAG,CAAC;AA4DnD;;;GAGG;AACU,QAAA,8BAA8B,GAAG,kBAAkB,CAAC;AAyBjE;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG;IAC3C,UAAU;IACV,iBAAiB;CACT,CAAC","debugId":"8ef65cd4-8945-57ad-89ea-063f84e905ee"}

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export { SequenceNumber, WebSocketConnectionData, WebSocketConnectionEvent, WebS
 export * from "./sdk-bundle-api/sdk-to-bundle/event-source-data";
 export { StreamingFetchChunk, StreamingFetchResponseData, } from "./sdk-bundle-api/sdk-to-bundle/streaming-fetch-data";
 export { Replay } from "./replay/replay.types";
-export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
+export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, ElementRedactionMode, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
 export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, PassthroughAppRequests, NoStubbing, CustomStubbing, RequestFilter, CustomTransformation, CustomTransformationWhere, } 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";

package/dist/index.js

@@ -1,5 +1,5 @@
 "use strict";
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="9bf7f317-42bb-584e-a02f-e30f0faf5333")}catch(e){}}();
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="69ded7d0-532e-5001-b315-cf4b7eb00034")}catch(e){}}();
 
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -29,4 +29,4 @@ Object.defineProperty(exports, "NETWORK_REQUESTS_SNAPSHOT_TYPE", { enumerable: t
 Object.defineProperty(exports, "CUSTOM_CHECK_SUMMARY_MAX_LENGTH", { enumerable: true, get: function () { return custom_checks_types_1.CUSTOM_CHECK_SUMMARY_MAX_LENGTH; } });
 Object.defineProperty(exports, "CUSTOM_CHECK_RESULTS_STATUSES", { enumerable: true, get: function () { return custom_checks_types_1.CUSTOM_CHECK_RESULTS_STATUSES; } });
 //# sourceMappingURL=index.js.map
-//# debugId=9bf7f317-42bb-584e-a02f-e30f0faf5333
+//# debugId=69ded7d0-532e-5001-b315-cf4b7eb00034

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA2DjE,6DAiB+B;AAN7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA;AAC/B,oIAAA,6BAA6B,OAAA","debugId":"9bf7f317-42bb-584e-a02f-e30f0faf5333"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAaiC;AAZ/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAsBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA4DjE,6DAiB+B;AAN7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA;AAC/B,oIAAA,6BAA6B,OAAA","debugId":"69ded7d0-532e-5001-b315-cf4b7eb00034"}

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

@@ -28,6 +28,25 @@ export interface ScreenshotDiffOptions {
     shouldUseRedactedScreenshotByScreenshotFilename?: Record<string, boolean>;
 }
 export type ElementToIgnore = CSSSelectorToIgnore;
+/**
+ * Controls in which contexts a matched element is hidden. Named for where it is hidden.
+ * Defaults to "replay-and-diff".
+ *
+ * The element is always hidden for the diff screenshot used in comparison — that is what makes
+ * it "ignored". The mode controls whether it is *additionally* hidden during the replay itself
+ * and in the user-facing screenshot:
+ *
+ * - "diff-only": hidden only for the diff screenshot. The element stays present and interactive
+ *   throughout the replay and is visible in the user-facing screenshot. Use for content that is
+ *   noisy/non-deterministic to diff but whose existence, size and position are stable (so
+ *   interacting with it and letting it hold layout is safe).
+ * - "replay-and-diff": additionally removed throughout the replay, so it can never be interacted
+ *   with and never affects layout, but is still shown in the user-facing screenshot. This is the
+ *   default and avoids "shifted diff" flakes from elements that load at inconsistent sizes.
+ * - "always": additionally hidden in the user-facing screenshot, so the element is never visible
+ *   anywhere.
+ */
+export type ElementRedactionMode = "always" | "replay-and-diff" | "diff-only";
 /**
  * Any elements that match this CSS selector will be hidden/removed before taking a screenshot.
  *
@@ -43,4 +62,9 @@ export interface CSSSelectorToIgnore {
      */
     shadowHostSelector?: string;
     comment?: string;
+    /**
+     * Controls in which contexts the matched element is hidden. Defaults to "replay-and-diff".
+     * See {@link ElementRedactionMode}.
+     */
+    redactionMode?: ElementRedactionMode;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.290.2",
+  "version": "2.292.0",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",