@alwaysmeticulous/sdk-bundles-api 2.40.3 → 2.40.4

package/dist/index.d.ts

@@ -2,3 +2,7 @@ export { RecordConfig, RecordSettings, RecordState } from "./record";
 export { MeticulousWindowConfig, NetworkResponseSanitizer, } from "./record/record-settings";
 export { ReplayUserInteractionsResult, ReplayUserInteractionsResultFull, ReplayUserInteractionsResultShort, BeforeUserEventOptions, } from "./replay/bundle-to-sdk/index";
 export { BootstrapReplayUserInteractionsFn, BootstrapReplayUserInteractionsOptions, OnReplayTimelineEventFn, ReplayUserInteractionsFn, ReplayUserInteractionsOptions, VirtualTimeOptions, InstallVirtualEventLoopOpts, SetupReplayNetworkStubbingFn, NetworkStubbingOptions, BrowserContextSeedingOptions, SetupBrowserContextSeedingFn, ScreenshottingOptions, } from "./replay/sdk-to-bundle";
+export { ReplayAndStoreResultsOptions, AdditionalReplayOptions, ReplayTarget, SnapshottedAssetsReplayTarget, URLReplayTarget, OriginalRecordedURLReplayTarget, ReplayExecutionOptions, ReplayOrchestratorScreenshottingOptions, ScreenshottingEnabledOptions, StoryboardOptions, GeneratedBy, GeneratedByNotebookRun, GeneratedByTestRun, GeneratedByReplayCommand, } from "./replay-orchestrator/sdk-to-bundle/execute-replay";
+export { ExecuteTestRunOptions } from "./replay-orchestrator/sdk-to-bundle/execute-test-run";
+export { ExecuteTestRunResult, TestRunExecution, RunningTestRunExecution, FinishedTestRunExecution, TestRunProgress, DetailedTestCaseResult, } from "./replay-orchestrator/bundle-to-sdk/execute-test-run";
+export { ReplayAndStoreResultsResult } from "./replay-orchestrator/bundle-to-sdk/execute-replay";

package/dist/replay-orchestrator/bundle-to-sdk/execute-replay.d.ts

@@ -0,0 +1,8 @@
+import { Replay, ScreenshotDiffResult } from "@alwaysmeticulous/api";
+export interface ReplayAndStoreResultsResult {
+    replay: Replay;
+    /**
+     * Empty if screenshottingOptions.enabled was false.
+     */
+    screenshotDiffResultsByBaseReplayId: Record<string, ScreenshotDiffResult[]>;
+}

package/dist/replay-orchestrator/bundle-to-sdk/execute-replay.js

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

package/dist/replay-orchestrator/bundle-to-sdk/execute-test-run.d.ts

@@ -0,0 +1,24 @@
+import { ScreenshotDiffResult, TestCaseResult, TestRun } from "@alwaysmeticulous/api";
+export interface ExecuteTestRunResult {
+    testRun: FinishedTestRunExecution;
+    testCaseResults: DetailedTestCaseResult[];
+}
+export type TestRunExecution = Pick<TestRun, "id" | "url" | "status" | "project"> & {
+    progress: TestRunProgress;
+    url: string;
+};
+export interface RunningTestRunExecution extends TestRunExecution {
+    status: "Running";
+}
+export interface FinishedTestRunExecution extends TestRunExecution {
+    status: "Success" | "Failure";
+}
+export interface TestRunProgress {
+    failedTestCases: number;
+    flakedTestCases: number;
+    passedTestCases: number;
+    runningTestCases: number;
+}
+export interface DetailedTestCaseResult extends TestCaseResult {
+    screenshotDiffResultsByBaseReplayId: Record<string, ScreenshotDiffResult[]>;
+}

package/dist/replay-orchestrator/bundle-to-sdk/execute-test-run.js

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

package/dist/replay-orchestrator/sdk-to-bundle/execute-replay.d.ts

@@ -0,0 +1,92 @@
+import { ScreenshotAssertionsOptions } from "@alwaysmeticulous/api";
+export interface ReplayAndStoreResultsOptions extends AdditionalReplayOptions {
+    replayTarget: ReplayTarget;
+    executionOptions: ReplayExecutionOptions;
+    screenshottingOptions: ScreenshotAssertionsOptions;
+    generatedBy: GeneratedBy;
+    testRunId: string | null;
+    suppressScreenshotDiffLogging: boolean;
+}
+export interface AdditionalReplayOptions {
+    apiToken: string | null | undefined;
+    commitSha: string | null | undefined;
+    sessionId: string;
+    baseTestRunId: string | null | undefined;
+    cookiesFile: string | null | undefined;
+    debugger: boolean;
+}
+export type ReplayTarget = SnapshottedAssetsReplayTarget | URLReplayTarget | OriginalRecordedURLReplayTarget;
+export interface SnapshottedAssetsReplayTarget {
+    type: "snapshotted-assets";
+    /**
+     * 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;
+}
+export interface URLReplayTarget {
+    type: "url";
+    /**
+     * If absent, and no URL provided in test case either, then will use the URL the session was recorded against.
+     */
+    appUrl: string;
+}
+export interface OriginalRecordedURLReplayTarget {
+    type: "original-recorded-url";
+}
+/**
+ * Options that control how a replay is executed.
+ */
+export interface ReplayExecutionOptions {
+    headless: boolean;
+    devTools: boolean;
+    bypassCSP: boolean;
+    shiftTime: boolean;
+    networkStubbing: boolean;
+    skipPauses: boolean;
+    moveBeforeClick: boolean;
+    disableRemoteFonts: boolean;
+    noSandbox: boolean;
+    maxDurationMs: number | null;
+    maxEventCount: number | null;
+    /**
+     * If true disables any features that are non-essential for running tests/executing replays.
+     * This includes disabling recording a video of the replay, for playback in the web app.
+     *
+     * This flag is useful to reduce noise when debugging.
+     */
+    essentialFeaturesOnly: boolean;
+}
+export type ReplayOrchestratorScreenshottingOptions = {
+    enabled: false;
+} | ScreenshottingEnabledOptions;
+export interface ScreenshottingEnabledOptions {
+    enabled: true;
+    storyboardOptions: StoryboardOptions;
+}
+export type StoryboardOptions = {
+    enabled: false;
+} | {
+    enabled: true;
+};
+export type NotebookRunId = StringId<"NotebookRunId">;
+export type TestRunId = StringId<"TestRunId">;
+export type GeneratedBy = GeneratedByNotebookRun | GeneratedByTestRun | GeneratedByReplayCommand;
+export interface GeneratedByNotebookRun {
+    type: "notebook";
+    runId: NotebookRunId;
+    runName: string;
+    runDate: Date;
+    machineHostName: string;
+}
+export interface GeneratedByTestRun {
+    type: "testRun";
+    runId: TestRunId;
+}
+export interface GeneratedByReplayCommand {
+    type: "replayCommand";
+}
+type StringId<FlavorT> = Flavor<string, FlavorT>;
+type Flavor<T, FlavorT> = T & {
+    _type?: FlavorT;
+};
+export {};

package/dist/replay-orchestrator/sdk-to-bundle/execute-replay.js

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

package/dist/replay-orchestrator/sdk-to-bundle/execute-test-run.d.ts

@@ -0,0 +1,51 @@
+import { ScreenshotAssertionsEnabledOptions, TestCaseResult, TestRunEnvironment } from "@alwaysmeticulous/api";
+import { RunningTestRunExecution } from "../bundle-to-sdk/execute-test-run";
+import { ReplayExecutionOptions } from "./execute-replay";
+export interface ExecuteTestRunOptions {
+    testsFile: string | null;
+    executionOptions: ReplayExecutionOptions;
+    screenshottingOptions: ScreenshotAssertionsEnabledOptions;
+    apiToken: string | null;
+    commitSha: string;
+    /**
+     * The base commit to compare test results against for test cases that don't have a baseReplayId specified.
+     */
+    baseCommitSha: string | null;
+    appUrl: string | null;
+    /**
+     * If null runs in parralel with a sensible number of parrelel tasks for the given machine.
+     *
+     * Set to 1 to disable parralelism.
+     */
+    parallelTasks: number | null;
+    /**
+     * If set to a value greater than 1 then will re-run any replays that give a screenshot diff
+     * and mark them as a flake if the screenshot generated on one of the retryed replays differs from that
+     * in the first replay.
+     */
+    maxRetriesOnFailure: number;
+    /**
+     * If set to a value greater than 0 then will re-run all replays the specified number of times
+     * and mark them as a flake if the screenshot generated on one of the retryed replays differs from that
+     * in the first replay.
+     *
+     * This is useful for checking flake rates.
+     *
+     * This option is mutually exclusive with maxRetriesOnFailure.
+     */
+    rerunTestsNTimes: number;
+    githubSummary: boolean;
+    /**
+     * If provided it will incorportate the cachedTestRunResults in any calls to store
+     * test run results in the BE, but won't include the cachedTestRunResults in the returned
+     * ExecuteTestRunResult.
+     */
+    cachedTestRunResults?: TestCaseResult[];
+    /**
+     * Captured environment for this run
+     */
+    environment?: TestRunEnvironment;
+    baseTestRunId: string | null;
+    onTestRunCreated?: (testRun: RunningTestRunExecution) => void;
+    onTestFinished?: (testRun: RunningTestRunExecution) => void;
+}

package/dist/replay-orchestrator/sdk-to-bundle/execute-test-run.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.40.3",
+  "version": "2.40.4",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -19,7 +19,7 @@
     "depcheck": "depcheck --ignore-patterns=dist"
   },
   "devDependencies": {
-    "@alwaysmeticulous/api": "^2.40.3"
+    "@alwaysmeticulous/api": "^2.40.4"
   },
   "peerDependencies": {
     "loglevel": "^1.8.0",
@@ -50,5 +50,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "b7055372caa771a9d69856d53933021f134a7388"
+  "gitHead": "11acce96c03e23cbb556779a121710a8136d24db"
 }