@alwaysmeticulous/sdk-bundles-api 2.40.4 → 2.42.0

package/dist/index.d.ts

@@ -2,7 +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 { ReplayAndStoreResultsOptions, ReplayTarget, SnapshottedAssetsReplayTarget, URLReplayTarget, OriginalRecordedURLReplayTarget, ReplayExecutionOptions, ReplayOrchestratorScreenshottingOptions, ScreenshottingEnabledOptions, StoryboardOptions, GeneratedBy, GeneratedByNotebookRun, GeneratedByTestRun, GeneratedByReplayCommand, ScreenshotComparisonOptions, ScreenshotComparisonEnabledOptions, CompareScreenshotsTo, CompareScreenshotsToSpecificReplay, CompareScreenshotsToTestRun, DoNotCompareScreenshots, } 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";
+export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, } from "./replay-orchestrator/bundle-to-sdk/execute-replay";

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

@@ -1,4 +1,19 @@
-import { Replay, ScreenshotDiffResult } from "@alwaysmeticulous/api";
+import { Replay, ReplayableEvent, ScreenshotDiffResult } from "@alwaysmeticulous/api";
+export interface ReplayExecution {
+    /**
+     * Promise resolves when the replay is complete.
+     */
+    finalResult: Promise<ReplayAndStoreResultsResult>;
+    eventsBeingReplayed: ReplayableEvent[];
+    /**
+     * When called will log the target of the given event to the browser console.
+     */
+    logEventTarget: (event: ReplayableEvent) => Promise<void>;
+    /**
+     * Closes the browser window and stops the replay short.
+     */
+    closePage: () => Promise<void>;
+}
 export interface ReplayAndStoreResultsResult {
     replay: Replay;
     /**
@@ -6,3 +21,12 @@ export interface ReplayAndStoreResultsResult {
      */
     screenshotDiffResultsByBaseReplayId: Record<string, ScreenshotDiffResult[]>;
 }
+export interface BeforeUserEventResult {
+    /**
+     * If provided then execution will continue, without calling onBeforeUserEvent, until
+     * the next event with this index is reached.
+     *
+     * If omitted then onBeforeUserEvent will be called again on the immediate next event.
+     */
+    nextEventIndexToPauseBefore?: number;
+}

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

@@ -1,19 +1,59 @@
-import { ScreenshotAssertionsOptions } from "@alwaysmeticulous/api";
-export interface ReplayAndStoreResultsOptions extends AdditionalReplayOptions {
+import { ScreenshotDiffOptions } from "@alwaysmeticulous/api";
+import { BeforeUserEventOptions } from "../../replay/bundle-to-sdk";
+import { BeforeUserEventResult } from "../bundle-to-sdk/execute-replay";
+export interface ReplayAndStoreResultsOptions {
     replayTarget: ReplayTarget;
     executionOptions: ReplayExecutionOptions;
-    screenshottingOptions: ScreenshotAssertionsOptions;
+    screenshottingOptions: ScreenshotComparisonOptions;
     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;
+    /**
+     * Called when the user or runner closes the page or browser window
+     */
+    onClosePage?: () => void;
+    /**
+     * The replay runner will block on the promise returned before replaying the
+     * next event. This allows the caller to pause the replay, or control the playback.
+     */
+    onBeforeUserEvent?: (opts: BeforeUserEventOptions) => Promise<BeforeUserEventResult>;
+}
+/**
+ * Similar to ScreenshotAssertionsOptions, but also specifies the test run or base replay id
+ * to compare to.
+ */
+export type ScreenshotComparisonOptions = {
+    enabled: false;
+} | ScreenshotComparisonEnabledOptions;
+export interface ScreenshotComparisonEnabledOptions extends ScreenshottingEnabledOptions {
+    compareTo: CompareScreenshotsTo;
+}
+export type CompareScreenshotsTo = CompareScreenshotsToSpecificReplay | CompareScreenshotsToTestRun | DoNotCompareScreenshots;
+export interface CompareScreenshotsToSpecificReplay {
+    type: "specific-replay";
+    replayId: string;
+    diffOptions: ScreenshotDiffOptions;
+}
+/**
+ * Compare to the appropiate 'base-screenshots' of the specified test run.
+ *
+ * The 'base-screenshots' of a test run are the screenshots that should be
+ * used when comparing to the test run as a base. By default the screenshots
+ * taken in the replays in that test run are used as the base-screenshots, but if
+ * there is a flake then we "don't update the base screenshot", and so re-use
+ * the base screenshot from the previous test run.
+ */
+export interface CompareScreenshotsToTestRun {
+    type: "base-screenshots-of-test-run";
+    testRunId: string;
+    diffOptions: ScreenshotDiffOptions;
+}
+export interface DoNotCompareScreenshots {
+    type: "do-not-compare";
 }
 export type ReplayTarget = SnapshottedAssetsReplayTarget | URLReplayTarget | OriginalRecordedURLReplayTarget;
 export interface SnapshottedAssetsReplayTarget {

package/package.json

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