@alwaysmeticulous/sdk-bundles-api 2.41.0 → 2.42.1

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, 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 { ReplayAndStoreResultsOptions, ReplayTarget, SnapshottedAssetsReplayTarget, URLReplayTarget, OriginalRecordedURLReplayTarget, ReplayExecutionOptions, ReplayOrchestratorScreenshottingOptions, ScreenshottingEnabledOptions, StoryboardOptions, GeneratedBy, GeneratedByNotebookRun, GeneratedByTestRun, GeneratedByReplayCommand, ScreenshotComparisonOptions, ScreenshotComparisonEnabledOptions, CompareScreenshotsTo, CompareScreenshotsToSpecificReplay, CompareScreenshotsToTestRun, DoNotCompareScreenshots, OutOfDateClientError, } 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,4 +1,6 @@
 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;
@@ -10,7 +12,31 @@ export interface ReplayAndStoreResultsOptions {
     commitSha: string | null | undefined;
     sessionId: string;
     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>;
+    /**
+     * The maximum version of the replayAndStoreResults schema (the types in this inferface
+     * and the return type) that the caller is compatible with.
+     *
+     * This version number is bumped on every API change, and allows the replayAndStoreResults
+     * code to detect if it's being called by client that is not compatible with the latest version,
+     * and if so throw an OutOfDateClientError. It is then up to the client to display a message to ask
+     * the user to update to a newer version.
+     */
+    maxSemanticVersionSupported: number;
+}
+/**
+ * See {@link ReplayAndStoreResultsOptions.maxSemanticVersionSupported} for more details.
+ */
+export interface OutOfDateClientError extends Error {
+    name: "OutOfDateClient";
 }
 /**
  * Similar to ScreenshotAssertionsOptions, but also specifies the test run or base replay id

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

@@ -48,4 +48,14 @@ export interface ExecuteTestRunOptions {
     baseTestRunId: string | null;
     onTestRunCreated?: (testRun: RunningTestRunExecution) => void;
     onTestFinished?: (testRun: RunningTestRunExecution) => void;
+    /**
+     * The maximum version of the executeTestRun schema (the types in this inferface
+     * and the return type) that the caller is compatible with.
+     *
+     * This version number is bumped on every API change, and allows the executeTestRun
+     * code to detect if it's being called by client that is not compatible with the latest version,
+     * and if so throw an OutOfDateClientError. It is then up to the client to display a message to ask
+     * the user to update to a newer version.
+     */
+    maxSemanticVersionSupported: number;
 }

package/package.json

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