@alwaysmeticulous/api 2.86.0 → 2.87.0

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 export { Organization } from "./organization.types";
 export { Project, ProjectConfigurationData, ProjectSettingsScreenshottingOptions, } from "./project.types";
-export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotDiffResultDifference, ScreenshotDiffResultNoDifference, ScreenshotIdentifier, 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, } 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";
 export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";
 export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificData, LocalStorageEntry, EarlyRequest, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
 export { Replay } from "./replay/replay.types";
-export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
+export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
 export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, } 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/project.types.d.ts

@@ -16,7 +16,7 @@ export interface Project {
         defaultScreenshottingOptions?: ProjectSettingsScreenshottingOptions;
     };
 }
-export type ProjectSettingsScreenshottingOptions = Partial<Pick<ScreenshottingEnabledOptions, "waitBeforeScreenshotsMs" | "captureFullPage">>;
+export type ProjectSettingsScreenshottingOptions = Partial<Pick<ScreenshottingEnabledOptions, "waitBeforeScreenshotsMs" | "captureFullPage" | "elementsToIgnore">>;
 export interface ProjectConfigurationData {
     testCases?: TestCase[];
 }

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

@@ -16,12 +16,21 @@ export interface LogicVersioned {
 }
 export interface EndStateScreenshot extends LogicVersioned {
     type: "end-state";
+    /** If unset is normal variant */
+    variant?: ScreenshotVariant;
 }
 export interface ScreenshotAfterEvent extends LogicVersioned {
     type: "after-event";
     /** 0 indexed */
     eventNumber: number;
+    /** If unset is normal variant */
+    variant?: ScreenshotVariant;
 }
+/**
+ * normal = the original screenshot to be displayed to the user
+ * redacted = after injecting CSS `display: hidden` rules for the CSS selectors to ignore
+ */
+export type ScreenshotVariant = "normal" | "redacted";
 export interface ScreenshotDiffResultMissingBase {
     outcome: "missing-base";
     /** Relative path to the replay archive */
@@ -58,6 +67,17 @@ export interface ScreenshotDiffResultCompared {
 }
 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).
+     *
+     * 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;
+    };
 }
 export interface ScreenshotDiffResultDifference extends ScreenshotDiffResultCompared {
     outcome: "diff";

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

@@ -12,6 +12,7 @@ export interface ScreenshotAssertionsEnabledOptions extends ScreenshottingEnable
 export interface ScreenshottingEnabledOptions {
     enabled: true;
     storyboardOptions: StoryboardOptions;
+    elementsToIgnore?: ElementToIgnore[];
     waitBeforeScreenshotsMs?: number;
     captureFullPage?: boolean;
 }
@@ -24,3 +25,14 @@ export interface ScreenshotDiffOptions {
     diffThreshold: number;
     diffPixelThreshold: number;
 }
+export type ElementToIgnore = CSSSelectorToIgnore;
+/**
+ * Any elements that match this CSS selector will be hidden/removed before taking a screenshot.
+ *
+ * The diff will only be shown to the user if the both the original unredacted screenshots differ,
+ * and the new redacted screenshots also differ.
+ */
+export interface CSSSelectorToIgnore {
+    type: "css-selector";
+    selector: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.86.0",
+  "version": "2.87.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": "ccd3417f7f4764443f13bb7ebb4f916e2d8f589d"
+  "gitHead": "4091ab8ed2425a3e7afd8322c15403ed3fe97be8"
 }