@alwaysmeticulous/api 2.77.0 → 2.79.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { Organization } from "./organization.types";
 export { Project, ProjectConfigurationData, ProjectSettingsScreenshottingOptions, } from "./project.types";
-export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotIdentifier, SingleTryScreenshotDiffResult, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
+export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotDiffResultDifference, ScreenshotDiffResultNoDifference, ScreenshotIdentifier, SingleTryScreenshotDiffResult, } from "./sdk-bundle-api/bundle-to-sdk/screenshot-diff-result";
 export { TestCase, TestCaseReplayOptions, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
 export { TestRunEnvironment, TestRunGitHubContext, TestRunGitHubPullRequestContext, TestRunGitHubPushContext, TestRunGitHubWorkflowDispatchContext, TestRunGitLabContext, TestRunGitLabMergeRequestContext, TestRunGitLabPushContext, } from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
 export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";

package/dist/replay/replay.types.d.ts

@@ -2,4 +2,5 @@ import { Project } from "../project.types";
 export interface Replay {
     id: string;
     project: Project;
+    version: "v1" | "v2" | "v3";
 }

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

@@ -1,4 +1,4 @@
-export type SingleTryScreenshotDiffResult = ScreenshotDiffResultMissingBase | ScreenshotDiffResultMissingHead | ScreenshotDiffResultDifferentSize | ScreenshotDiffResultCompared;
+export type SingleTryScreenshotDiffResult = ScreenshotDiffResultMissingBase | ScreenshotDiffResultMissingHead | ScreenshotDiffResultDifferentSize | ScreenshotDiffResultNoDifference | ScreenshotDiffResultDifference;
 /** Represents the result of comparing two screenshots */
 export type ScreenshotDiffResult = {
     identifier: ScreenshotIdentifier;
@@ -47,7 +47,6 @@ export interface ScreenshotDiffResultDifferentSize {
     headHeight: number;
 }
 export interface ScreenshotDiffResultCompared {
-    outcome: "no-diff" | "diff";
     /** Relative path to the replay archive */
     headScreenshotFile: string;
     /** Relative path to the replay archive */
@@ -57,6 +56,17 @@ export interface ScreenshotDiffResultCompared {
     mismatchPixels: number;
     mismatchFraction: number;
 }
+export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
+    outcome: "no-diff";
+}
+export interface ScreenshotDiffResultDifference extends ScreenshotDiffResultCompared {
+    outcome: "diff";
+    /**
+     * The hash of the set of all class names within the DOM sections that have differences.
+     * This can be useful for grouping together diffs that are caused by the same change.
+     */
+    hashOfChangedSectionsClassNames?: string;
+}
 /**
  * The base screenshot differed from the head screenshot, but when the head
  * screenshot was retaken one or more additional times at least one of those

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.77.0",
+  "version": "2.79.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": "0e434accc42eceb323078977344cb6298dfb5b4e"
+  "gitHead": "1a61e72a72c3f53cd08218ef7e5fcd1ce55dc1b6"
 }