@alwaysmeticulous/api 2.181.0 → 2.184.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 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 { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotDiffResultDifference, ScreenshotDiffResultNoDifference, ScreenshotIdentifier, ScreenshotVariant, SingleTryScreenshotDiffResult, ScreenshotDiffRetryResult, SingleTryScreenshotDiffRetryResult, RedactedScreenshotIncompatible, RedactedScreenshotsCompared, RedactedScreenshotsComparison, } 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";

package/dist/index.js.map

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

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

@@ -85,8 +85,22 @@ export interface ScreenshotDiffResultCompared {
          * This field will only be true if we are in situation 2 above and the original comparison was a no diff.
          */
         wasOriginalComparisonNoDiff?: boolean;
+        /**
+         * Undefined for old screenshots, from before Dec 2024.
+         */
+        comparison?: RedactedScreenshotsComparison;
     } & (RedactedScreenshotsCompared | RedactedScreenshotIncompatible);
 }
+/**
+ * If the redacted screenshots were present for both head and base then we compare these; but if a
+ * redacted screenshot was only present for one of head or base then we compare the redacted screenshot
+ * to the unredacted screenshot. This field indicates which comparison was made.
+ *
+ * The left hand side is the base screenshot, and the right hand side is the head screenshot. For example,
+ * `redacted-vs-unredacted` means it compared the redacted base screenshot to the unredacted head screenshot
+ * (i.e. there was no redacted head screenshot to compare to).
+ */
+export type RedactedScreenshotsComparison = "redacted-vs-redacted" | "redacted-vs-unredacted" | "unredacted-vs-redacted";
 export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
     outcome: "no-diff";
 }
@@ -116,6 +130,17 @@ export interface ScreenshotDiffResultDifference extends ScreenshotDiffResultComp
      * This can be useful for grouping together diffs that are caused by the same change.
      */
     hashOfChangedSectionsClassNames?: string;
+    /**
+     * The set of the first N class names within the DOM sections that have differences.
+     *
+     * Only present on recent replays since Dec 2024.
+     */
+    changedSectionsClassNames?: string[];
+    /**
+     * If there are too many class names we truncate the {@link changedSectionsClassNames} list,
+     * and this field will be true, otherwise this field will not be present.
+     */
+    isChangedSectionsClassNamesListTruncated?: true;
 }
 /**
  * The base screenshot differed from the head screenshot, but when the head

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.181.0",
+  "version": "2.184.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": "545087fa8443d0eb23356c7c716076ebbf498736"
+  "gitHead": "bd151de38526521436e599a40f474b2f0beba59e"
 }