@alwaysmeticulous/api 2.108.0 → 2.110.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, ScreenshotDiffResultDifference, ScreenshotDiffResultNoDifference, ScreenshotIdentifier, ScreenshotVariant, SingleTryScreenshotDiffResult, ScreenshotDiffRetryResult, SingleTryScreenshotDiffRetryResult, } 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, } 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/sdk-bundle-api/bundle-to-sdk/screenshot-diff-result.d.ts

@@ -68,9 +68,6 @@ export interface ScreenshotDiffResultCompared {
     height: number;
     mismatchPixels: number;
     mismatchFraction: number;
-}
-export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
-    outcome: "no-diff";
     /**
      * The result of comparing the redacted screenshots (i.e. screenshots taken after elements
      * to ignore have been hidden/removed).
@@ -78,10 +75,25 @@ export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCo
      * 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.
      */
-    redactedScreenshotsComparisonResult?: {
-        mismatchPixels: number;
-        mismatchFraction: number;
-    };
+    redactedScreenshotsComparisonResult?: RedactedScreenshotsCompared | RedactedScreenshotIncompatible;
+}
+export interface ScreenshotDiffResultNoDifference extends ScreenshotDiffResultCompared {
+    outcome: "no-diff";
+}
+/**
+ * The result of comparing the redacted screenshots. Note that due to thresholds even
+ * 'no-diff' results may have some differing pixels.
+ */
+export interface RedactedScreenshotsCompared {
+    /**
+     * type may be undefined for old screenshots, from before Feb 2024
+     */
+    type: "no-diff" | "diff" | undefined;
+    mismatchPixels: number;
+    mismatchFraction: number;
+}
+export interface RedactedScreenshotIncompatible {
+    type: "missing-base" | "missing-head" | "different-size";
 }
 export interface ScreenshotDiffResultDifference extends ScreenshotDiffResultCompared {
     outcome: "diff";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.108.0",
+  "version": "2.110.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": "6ebfdd576b48150f0587afb269c3d5c14a0e68bb"
+  "gitHead": "40503f160d772a272af67e2a615c2cea990b8c9d"
 }