@alwaysmeticulous/api 2.173.0 → 2.177.0

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { Organization } from "./organization.types";
 export { Project, ProjectSettingsScreenshottingOptions } from "./project.types";
 export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotDiffResultDifference, ScreenshotDiffResultNoDifference, ScreenshotIdentifier, ScreenshotVariant, SingleTryScreenshotDiffResult, ScreenshotDiffRetryResult, SingleTryScreenshotDiffRetryResult, RedactedScreenshotIncompatible, RedactedScreenshotsCompared, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
 export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
+export { TestRunChunkStatus } from "./replay/test-run-chunk.types";
 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";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AA4BA,sFAAoE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AA6BA,sFAAoE"}

package/dist/replay/test-run-chunk.types.d.ts

@@ -0,0 +1,7 @@
+import { TestRunStatus } from "./test-run.types";
+/**
+ * Execution of a chunk of a test run chunk.
+ *
+ * The values and their meanings are the same as for {@link TestRunStatus}.
+ */
+export type TestRunChunkStatus = TestRunStatus;

package/dist/replay/test-run-chunk.types.js

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

package/dist/replay/test-run-chunk.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-run-chunk.types.js","sourceRoot":"","sources":["../../src/replay/test-run-chunk.types.ts"],"names":[],"mappings":""}

package/dist/replay/test-run.types.d.ts

@@ -24,6 +24,12 @@ export interface TestCaseReplayOptions extends Partial<ScreenshotDiffOptions> {
  * into 'Running' in this case, if the worker retries it.
  */
 export type TestRunStatus = "Scheduled" | "Running" | "Success" | "Failure" | "ExecutionError";
+/**
+ * Execution of a chunk of a test run chunk.
+ *
+ * The values and their meanings are the same as for {@link TestRunStatus}.
+ */
+export type TestRunChunkStatus = TestRunStatus;
 export type TestCaseResultStatus = "pass" | "fail" | "flake";
 export interface TestCaseResult extends TestCase {
     headReplayId: string;

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.173.0",
+  "version": "2.177.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": "4aa9b139353dae57284d22afa2b879eebd2487f3"
+  "gitHead": "99b38cab406ba8de7e0fde5fd53cd98a81449ed1"
 }