@alwaysmeticulous/api 2.293.0 → 2.295.0

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

@@ -38,14 +38,16 @@ export interface CustomCheckInput {
 /**
  * The outcome of comparing the base and head snapshots:
  * - `pass`: no regression; the check is green and no report is surfaced.
- * - `warn`: the check is green but its report is shown to the user.
- * - `fail`: the check is red.
+ * - `warn-without-requiring-user-ack`: the check surfaces a report to the user,
+ *   but does not require them to acknowledge (review) it.
+ * - `warn-and-require-user-ack`: the check surfaces a report that the user is
+ *   asked to acknowledge (review) before the run is considered actioned.
  *
  * A check failing to *run* is not a verdict: an execution error applies to the
  * custom check results as a whole (every check), not to an individual check, so
  * it is reported at that level rather than as a per-check verdict.
  */
-export type CustomCheckVerdict = "pass" | "warn" | "fail";
+export type CustomCheckVerdict = "pass" | "warn-without-requiring-user-ack" | "warn-and-require-user-ack";
 /**
  * Maximum length of a custom check `summary`. The summary is rendered inline in
  * the UI, so it is truncated to this many characters when displayed rather than

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]="8ef65cd4-8945-57ad-89ea-063f84e905ee")}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]="7935af01-8528-55fe-888c-aff9ac4f33b7")}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=8ef65cd4-8945-57ad-89ea-063f84e905ee
+//# debugId=7935af01-8528-55fe-888c-aff9ac4f33b7

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":";;;;;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"}
+{"version":3,"file":"custom-checks.types.js","sources":["../src/custom-checks.types.ts"],"sourceRoot":"","names":[],"mappings":";;;;;AAiEA;;;;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":"7935af01-8528-55fe-888c-aff9ac4f33b7"}

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, ElementRedactionMode, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
+export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, AuxiliaryViewportScreenshotRange, 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]="6a3818e5-6f74-5ea1-a8aa-358d088295ca")}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]="a59b8181-26f4-539c-8537-22391b00501e")}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=6a3818e5-6f74-5ea1-a8aa-358d088295ca
+//# debugId=a59b8181-26f4-539c-8537-22391b00501e

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAciC;AAb/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAuBrB,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":"6a3818e5-6f74-5ea1-a8aa-358d088295ca"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourceRoot":"","names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAuBA,0DAciC;AAb/B,kHAAA,gBAAgB,OAAA;AAChB,qHAAA,mBAAmB,OAAA;AAuBrB,sFAAoE;AAQpE,4EAsBqD;AATnD,8HAAA,8BAA8B,OAAA;AAsBhC,mFAAiE;AA6DjE,6DAiB+B;AAN7B,qIAAA,8BAA8B,OAAA;AAC9B,sIAAA,+BAA+B,OAAA;AAC/B,oIAAA,6BAA6B,OAAA","debugId":"a59b8181-26f4-539c-8537-22391b00501e"}

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

@@ -32,8 +32,17 @@ export interface ScreenshotAfterEvent extends LogicVersioned {
 }
 export interface ScreenshotAuxiliary extends LogicVersioned {
     type: "auxiliary";
-    /** 0 indexed */
+    /**
+     * 0 indexed. For auxiliaries anchored to the end-state (i.e. {@link endState}
+     * is `true`), this is the final event index and is used only for ordering.
+     */
     eventNumber: number;
+    /**
+     * When `true`, this auxiliary was captured at the end-state of the replay
+     * rather than before a specific event. {@link eventNumber} is then only used
+     * for ordering relative to other screenshots.
+     */
+    endState?: true;
     /** 0-indexed position among auxiliaries sharing the same `eventNumber`. */
     sequenceNumber: number;
     /** Why we took the screenshot, e.g. "exit_animation". Matches /^[a-z_]{1,16}$/. */

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

@@ -15,6 +15,27 @@ export interface ScreenshottingEnabledOptions {
     elementsToIgnore?: ElementToIgnore[];
     waitBeforeScreenshotsMs?: number;
     captureFullPage?: boolean;
+    /**
+     * Configuration for capturing additional ("auxiliary") screenshots at
+     * different viewport sizes during replay. For each configured range, an
+     * auxiliary screenshot is captured at its representative viewport whenever
+     * the current viewport width does not already fall into that range.
+     */
+    auxiliaryViewportScreenshots?: AuxiliaryViewportScreenshotRange[];
+}
+/**
+ * A range of screen widths together with the representative viewport size at
+ * which an auxiliary screenshot should be captured for that range.
+ */
+export interface AuxiliaryViewportScreenshotRange {
+    /** Inclusive lower bound of the screen-width range this entry represents. */
+    minWidth: number;
+    /** Inclusive upper bound of the screen-width range this entry represents. */
+    maxWidth: number;
+    /** Width of the representative viewport to screenshot at for this range. */
+    viewportWidth: number;
+    /** Height of the representative viewport to screenshot at for this range. */
+    viewportHeight: number;
 }
 export declare type StoryboardOptions = {
     enabled: false;

package/package.json

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