@alwaysmeticulous/api 2.42.0 → 2.44.1

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 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, TestRun, TestRunStatus, TestCaseResult, TestCaseResultStatus, } from "./replay/test-run.types";
+export { EndStateScreenshot, ScreenshotAfterEvent, ScreenshotDiffResult, ScreenshotDiffResultCompared, ScreenshotDiffResultDifferentSize, ScreenshotDiffResultMissingBase, ScreenshotDiffResultMissingBaseAndHead, ScreenshotDiffResultMissingHead, 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, } from "./sdk-bundle-api/sdk-to-bundle/test-run-environment";
 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";
 export { Cookie, SessionData, UrlHistoryEvent, WindowData, } 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";

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

@@ -1,12 +1,4 @@
-import { Project } from "../project.types";
-import { ScreenshotDiffOptions } from "./replay-diff.types";
-/** Represents the configuration used for a test run */
-export interface TestRunConfigData {
-    testCases?: TestCase[];
-    arguments?: TestRunArguments;
-    environment?: TestRunEnvironment;
-    [key: string]: unknown;
-}
+import { ScreenshotDiffOptions } from "../sdk-bundle-api/sdk-to-bundle/screenshotting-options";
 export interface TestCase {
     sessionId: string;
     title?: string;
@@ -21,70 +13,7 @@ export interface TestCaseReplayOptions extends Partial<ScreenshotDiffOptions> {
     simulationIdForAssets?: string | undefined;
     moveBeforeClick?: boolean;
 }
-export interface TestRunArguments {
-    executionOptions?: unknown;
-    screenshottingOptions?: unknown;
-    commitSha?: string;
-    baseCommitSha?: string | null;
-    appUrl?: string | null;
-    parallelTasks?: number | null;
-    githubSummary?: boolean;
-    [key: string]: unknown;
-}
-export interface TestRunEnvironment {
-    ci?: boolean;
-    context?: TestRunGitHubContext;
-    [key: string]: unknown;
-}
-export type TestRunGitHubContext = TestRunGitHubPullRequestContext | TestRunGitHubPushContext | TestRunGitHubWorkflowDispatchContext;
-export interface TestRunGitHubPullRequestContext {
-    type: "github";
-    event: "pull-request";
-    /** Pull request title */
-    title: string;
-    /** Pull request number */
-    number: number;
-    /** Pull request URL (web page) */
-    htmlUrl: string;
-    /** Base commit hash */
-    baseSha: string;
-    /** Head commit hash */
-    headSha: string;
-}
-export interface TestRunGitHubPushContext {
-    type: "github";
-    event: "push";
-    /** Commit hash before the push event */
-    beforeSha: string;
-    /** Commit hash after the push event */
-    afterSha: string;
-    /** Git ref (usually /refs/head/<branch>) */
-    ref: string;
-}
-export interface TestRunGitHubWorkflowDispatchContext {
-    type: "github";
-    event: "workflow-dispatch";
-    /** Git ref (usually /refs/head/<branch>) */
-    ref: string;
-    /** Workflow dispatch inputs */
-    inputs: {
-        [key: string]: unknown;
-    };
-    /** Resolved head commit hash */
-    headSha: string;
-}
 export type TestRunStatus = "Running" | "Success" | "Failure";
-export interface TestRun {
-    id: string;
-    status: TestRunStatus;
-    project: Project;
-    configData: TestRunConfigData;
-    resultData?: {
-        results: TestCaseResult[];
-        [key: string]: any;
-    };
-    [key: string]: any;
-}
 export type TestCaseResultStatus = "pass" | "fail" | "flake";
 export interface TestCaseResult extends TestCase {
     headReplayId: string;

package/dist/{replay/replay-diff.types.d.ts → sdk-bundle-api/bundle-to-sdk/screenshot-diff-result.d.ts}

@@ -1,49 +1,3 @@
-export interface ReplayDiff {
-    id: string;
-    project: {
-        [key: string]: any;
-    };
-    headReplay: {
-        [key: string]: any;
-    };
-    baseReplay: {
-        [key: string]: any;
-    };
-    testRun: {
-        [key: string]: any;
-    };
-    data: ReplayDiffData;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface ReplayDiffData {
-    screenshotAssertionsOptions?: ScreenshotAssertionsOptions;
-    screenshotDiffResults?: ScreenshotDiffResult[];
-}
-/**
- * Differs from ScreenshotComparisonOptions in that
- * ScreenshotComparisonOptions specifies the test run or base replay id
- * to compare to, while ScreenshotAssertionsOptions does not.
- */
-export type ScreenshotAssertionsOptions = {
-    enabled: false;
-} | ScreenshotAssertionsEnabledOptions;
-export interface ScreenshotAssertionsEnabledOptions extends ScreenshottingEnabledOptions {
-    diffOptions: ScreenshotDiffOptions;
-}
-export interface ScreenshottingEnabledOptions {
-    enabled: true;
-    storyboardOptions: StoryboardOptions;
-}
-export declare type StoryboardOptions = {
-    enabled: false;
-} | {
-    enabled: true;
-};
-export interface ScreenshotDiffOptions {
-    diffThreshold: number;
-    diffPixelThreshold: number;
-}
 export type SingleTryScreenshotDiffResult = ScreenshotDiffResultMissingBase | ScreenshotDiffResultMissingHead | ScreenshotDiffResultDifferentSize | ScreenshotDiffResultCompared;
 /** Represents the result of comparing two screenshots */
 export type ScreenshotDiffResult = {

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

@@ -0,0 +1,24 @@
+/**
+ * Differs from ScreenshotComparisonOptions in that
+ * ScreenshotComparisonOptions specifies the test run or base replay id
+ * to compare to, while ScreenshotAssertionsOptions does not.
+ */
+export type ScreenshotAssertionsOptions = {
+    enabled: false;
+} | ScreenshotAssertionsEnabledOptions;
+export interface ScreenshotAssertionsEnabledOptions extends ScreenshottingEnabledOptions {
+    diffOptions: ScreenshotDiffOptions;
+}
+export interface ScreenshottingEnabledOptions {
+    enabled: true;
+    storyboardOptions: StoryboardOptions;
+}
+export declare type StoryboardOptions = {
+    enabled: false;
+} | {
+    enabled: true;
+};
+export interface ScreenshotDiffOptions {
+    diffThreshold: number;
+    diffPixelThreshold: number;
+}

package/dist/sdk-bundle-api/sdk-to-bundle/screenshotting-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk-bundle-api/sdk-to-bundle/test-run-environment.d.ts

@@ -0,0 +1,46 @@
+export interface TestRunEnvironment {
+    ci?: boolean;
+    context?: TestRunGitHubContext;
+    [key: string]: unknown;
+}
+export type TestRunGitHubContext = TestRunGitHubPullRequestContext | TestRunGitHubPushContext | TestRunGitHubWorkflowDispatchContext;
+export interface TestRunGitHubPullRequestContext {
+    type: "github";
+    event: "pull-request";
+    /** Pull request title */
+    title: string;
+    /** Pull request number */
+    number: number;
+    /** Pull request URL (web page) */
+    htmlUrl: string;
+    /** Base commit hash */
+    baseSha: string;
+    /** Base ref (usually /refs/head/<branch>) */
+    baseRef?: string;
+    /** Head commit hash */
+    headSha: string;
+    /** Head ref (usually /refs/head/<branch>) */
+    headRef?: string;
+}
+export interface TestRunGitHubPushContext {
+    type: "github";
+    event: "push";
+    /** Commit hash before the push event */
+    beforeSha: string;
+    /** Commit hash after the push event */
+    afterSha: string;
+    /** Git ref (usually /refs/head/<branch>) */
+    ref: string;
+}
+export interface TestRunGitHubWorkflowDispatchContext {
+    type: "github";
+    event: "workflow-dispatch";
+    /** Git ref (usually /refs/head/<branch>) */
+    ref: string;
+    /** Workflow dispatch inputs */
+    inputs: {
+        [key: string]: unknown;
+    };
+    /** Resolved head commit hash */
+    headSha: string;
+}

package/dist/sdk-bundle-api/sdk-to-bundle/test-run-environment.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.42.0",
+  "version": "2.44.1",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "65e2410a784642674ea6c8203d5b9f8a303c33ea"
+  "gitHead": "1fd294cb699681672742e566ccc9ae0f4cb75b02"
 }