@alwaysmeticulous/sdk-bundles-api 2.42.0 → 2.43.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, 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, ReplayExecution, BeforeUserEventResult, } from "./replay-orchestrator/bundle-to-sdk/execute-replay";

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

@@ -1,4 +1,5 @@
 import { ScreenshotDiffOptions } from "@alwaysmeticulous/api";
+import { LogLevelNumbers } from "loglevel";
 import { BeforeUserEventOptions } from "../../replay/bundle-to-sdk";
 import { BeforeUserEventResult } from "../bundle-to-sdk/execute-replay";
 export interface ReplayAndStoreResultsOptions {
@@ -12,6 +13,7 @@ export interface ReplayAndStoreResultsOptions {
     commitSha: string | null | undefined;
     sessionId: string;
     cookiesFile: string | null | undefined;
+    logLevel: LogLevelNumbers;
     /**
      * Called when the user or runner closes the page or browser window
      */
@@ -21,6 +23,25 @@ export interface ReplayAndStoreResultsOptions {
      * 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.
+     *
+     * Note: this is typed as a const of the latest known version, rather than a number, to ensure
+     * that all clients bump the version number passed when they upgrade to the types.
+     */
+    maxSemanticVersionSupported: 1;
+}
+/**
+ * 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

@@ -1,4 +1,5 @@
 import { ScreenshotAssertionsEnabledOptions, TestCaseResult, TestRunEnvironment } from "@alwaysmeticulous/api";
+import { LogLevelNumbers } from "loglevel";
 import { RunningTestRunExecution } from "../bundle-to-sdk/execute-test-run";
 import { ReplayExecutionOptions } from "./execute-replay";
 export interface ExecuteTestRunOptions {
@@ -46,6 +47,20 @@ export interface ExecuteTestRunOptions {
      */
     environment?: TestRunEnvironment;
     baseTestRunId: string | null;
+    logLevel: LogLevelNumbers;
     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.
+     *
+     * Note: this is typed as a const of the latest known version, rather than a number, to ensure
+     * that all clients bump the version number passed when they upgrade to the types.
+     */
+    maxSemanticVersionSupported: 1;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.42.0",
+  "version": "2.43.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -50,5 +50,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "65e2410a784642674ea6c8203d5b9f8a303c33ea"
+  "gitHead": "7664f4dfeed3b08e5523c0acb4d98d11eee4c9ff"
 }