@alwaysmeticulous/api 2.39.0 → 2.40.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { Organization } from "./organization.types";
 export { Project, ProjectConfigurationData } from "./project.types";
 export { EndStateScreenshot, ReplayDiff, ReplayDiffData, ScreenshotAfterEvent, ScreenshotAssertionsEnabledOptions, ScreenshotAssertionsOptions, ScreenshotDiffOptions, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, ScreenshotIdentifier, ScreenshottingEnabledOptions, SingleTryScreenshotDiffResult, StoryboardOptions, } from "./replay/replay-diff.types";
-export { TestCase, TestCaseReplayOptions, TestRunArguments, TestRunConfigData, TestRunEnvironment, } from "./replay/test-run.types";
+export { TestCase, TestCaseReplayOptions, TestRunArguments, TestRunConfigData, TestRunEnvironment, TestRun, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
 export { ReplayableEvent } from "./sdk-bundle-api/bidirectional/replayable-event";
 export { SDKReplayTimelineEntry, SDKReplayTimelineData, } from "./sdk-bundle-api/bundle-to-sdk/timeline.types";
 export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk-to-bundle/har-log";

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

@@ -28,7 +28,6 @@ export interface ScreenshotAssertionsEnabledOptions extends ScreenshottingEnable
 }
 export interface ScreenshottingEnabledOptions {
     enabled: true;
-    screenshotSelector: string | null;
     storyboardOptions: StoryboardOptions;
 }
 export declare type StoryboardOptions = {
@@ -46,10 +45,19 @@ export type ScreenshotDiffResult = {
     identifier: ScreenshotIdentifier;
 } & (SingleTryScreenshotDiffResult | ScreenshotDiffResultFlake);
 export type ScreenshotIdentifier = EndStateScreenshot | ScreenshotAfterEvent;
-export interface EndStateScreenshot {
+export interface LogicVersioned {
+    /**
+     * The version of the logic used to generate the screenshot. This should be bumped
+     * whenever the Meticulous code changes such that two screenshots on different logic versions
+     * are incomparable. This field is used to avoid falsely flagging a diff to our users when
+     * the logic to generate a screenshot or execute a replay changes.
+     */
+    logicVersion?: number;
+}
+export interface EndStateScreenshot extends LogicVersioned {
     type: "end-state";
 }
-export interface ScreenshotAfterEvent {
+export interface ScreenshotAfterEvent extends LogicVersioned {
     type: "after-event";
     /** 0 indexed */
     eventNumber: number;

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

@@ -1,3 +1,4 @@
+import { Project } from "../project.types";
 import { ScreenshotDiffOptions } from "./replay-diff.types";
 /** Represents the configuration used for a test run */
 export interface TestRunConfigData {
@@ -18,7 +19,6 @@ export interface TestCaseReplayOptions extends Partial<ScreenshotDiffOptions> {
      * If present will run the session against a local server serving up previously snapshotted assets (HTML, JS, CSS etc.) from the specified prior replay, instead of against a URL.
      */
     simulationIdForAssets?: string | undefined;
-    screenshotSelector?: string;
     moveBeforeClick?: boolean;
 }
 export interface TestRunArguments {
@@ -73,3 +73,24 @@ export interface TestRunGitHubWorkflowDispatchContext {
     /** Resolved head commit hash */
     headSha: string;
 }
+export type TestRunStatus = "Running" | "Success" | "Failure";
+export interface TestRun {
+    id: string;
+    status: TestRunStatus;
+    project: Project;
+    resultData?: {
+        results: TestCaseResult[];
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
+export type TestCaseResultStatus = "pass" | "fail" | "flake";
+export interface TestCaseResult extends TestCase {
+    headReplayId: string;
+    /**
+     * A test case is marked as a flake if there were screenshot comparison failures,
+     * but for every one of those failures regenerating the screenshot on head sometimes gave
+     * a different screenshot to the original screenshot taken on head.
+     */
+    result: TestCaseResultStatus;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.39.0",
+  "version": "2.40.1",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -34,5 +34,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "b6488b15a8233fcd1380b1607ec254d5d3bc0378"
+  "gitHead": "b56c6ec8cf1ac2d0f935e0f2500a3e55463574a8"
 }