@alwaysmeticulous/sdk-bundles-api 2.42.1 → 2.44.0

package/README.md

@@ -1 +1,3 @@
-# Meticulous Common Types
+# SDK to Bundles API
+
+Any interface used in the API for communicating between the bundles and the SDK should live in here, unless they are also used in the backend API, or persisted to a database in which case they should live in the 'sdk-bundle-api' sub-folder of the 'api' package.

package/dist/index.d.ts

@@ -1,8 +1,6 @@
 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, OutOfDateClientError, } 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, BeforeUserEventOptions, } 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/bundle-to-sdk/execute-test-run.d.ts

@@ -1,12 +1,15 @@
-import { ScreenshotDiffResult, TestCaseResult, TestRun } from "@alwaysmeticulous/api";
+import { Project, ScreenshotDiffResult, TestCaseResult, TestRunStatus } from "@alwaysmeticulous/api";
 export interface ExecuteTestRunResult {
     testRun: FinishedTestRunExecution;
     testCaseResults: DetailedTestCaseResult[];
 }
-export type TestRunExecution = Pick<TestRun, "id" | "url" | "status" | "project"> & {
+export interface TestRunExecution {
+    id: string;
+    status: TestRunStatus;
+    project: Project;
     progress: TestRunProgress;
     url: string;
-};
+}
 export interface RunningTestRunExecution extends TestRunExecution {
     status: "Running";
 }

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

@@ -1,5 +1,5 @@
 import { ScreenshotDiffOptions } from "@alwaysmeticulous/api";
-import { BeforeUserEventOptions } from "../../replay/bundle-to-sdk";
+import { LogLevelNumbers } from "loglevel";
 import { BeforeUserEventResult } from "../bundle-to-sdk/execute-replay";
 export interface ReplayAndStoreResultsOptions {
     replayTarget: ReplayTarget;
@@ -12,6 +12,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
      */
@@ -29,8 +30,17 @@ export interface ReplayAndStoreResultsOptions {
      * 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;
+}
+export interface BeforeUserEventOptions {
+    /**
+     * The index of the next event in sessionData.userEvents.event_log
      */
-    maxSemanticVersionSupported: number;
+    userEventIndex: number;
 }
 /**
  * See {@link ReplayAndStoreResultsOptions.maxSemanticVersionSupported} for more details.

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,7 @@ export interface ExecuteTestRunOptions {
      */
     environment?: TestRunEnvironment;
     baseTestRunId: string | null;
+    logLevel: LogLevelNumbers;
     onTestRunCreated?: (testRun: RunningTestRunExecution) => void;
     onTestFinished?: (testRun: RunningTestRunExecution) => void;
     /**
@@ -56,6 +58,9 @@ export interface ExecuteTestRunOptions {
      * 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: number;
+    maxSemanticVersionSupported: 1;
 }

package/package.json

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

package/dist/replay/bundle-to-sdk/index.d.ts

@@ -1,17 +0,0 @@
-/** Result of replaying user interactions */
-export type ReplayUserInteractionsResult = ReplayUserInteractionsResultFull | ReplayUserInteractionsResultShort;
-/** Returned when the recorded session has been fully replayed */
-export interface ReplayUserInteractionsResultFull {
-    length: "full";
-}
-/** Returned when the recorded session has been cut short during replay */
-export interface ReplayUserInteractionsResultShort {
-    length: "short";
-    reason: "max events" | "max duration" | "full page navigation" | "error";
-}
-export interface BeforeUserEventOptions {
-    /**
-     * The index of the next event in sessionData.userEvents.event_log
-     */
-    userEventIndex: number;
-}

package/dist/replay/bundle-to-sdk/index.js

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

package/dist/replay/sdk-to-bundle/index.d.ts

@@ -1,73 +0,0 @@
-import { SessionData, SDKReplayTimelineEntry } from "@alwaysmeticulous/api";
-import type { LogLevelDesc } from "loglevel";
-import type { Page } from "puppeteer";
-import { BeforeUserEventOptions, ReplayUserInteractionsResult } from "../bundle-to-sdk";
-export interface ReplayUserInteractionsOptions {
-    /**
-     * A semantic version number for the SDK calling into the replay code.
-     *
-     * This version number is bumped on every API change, and allows the replay
-     * code to detect if it's being called by an old version, and if so throw
-     * and request the user updates to a newer version.
-     */
-    sdkSemanticVersion: number;
-    page: Page;
-    sessionData: unknown;
-    moveBeforeClick: boolean;
-    virtualTime?: VirtualTimeOptions;
-    maxDurationMs?: number;
-    maxEventCount?: number;
-    sessionDurationMs: number;
-    logLevel: LogLevelDesc;
-    screenshots: ScreenshottingOptions;
-    onTimelineEvent: OnReplayTimelineEventFn;
-    /**
-     * If present then will be called before executing each next user event,
-     * and will wait for the completion of the returned promise before continuing.
-     */
-    onBeforeUserEvent?: OnBeforeUserEventFn;
-}
-export interface ScreenshottingOptions {
-    screenshotsDirectory: string;
-    takeIntermediateScreenshots: boolean;
-    takeEndStateScreenshot: boolean;
-}
-/** Replay function for user interaction events */
-export type ReplayUserInteractionsFn = (options: ReplayUserInteractionsOptions) => Promise<ReplayUserInteractionsResult>;
-export interface BootstrapReplayUserInteractionsOptions {
-    page: Page;
-    logLevel: LogLevelDesc;
-}
-export type BootstrapReplayUserInteractionsFn = (options: BootstrapReplayUserInteractionsOptions) => Promise<ReplayUserInteractionsFn>;
-export type VirtualTimeOptions = {
-    enabled: false;
-} | {
-    enabled: true;
-};
-export type OnReplayTimelineEventFn = (entry: SDKReplayTimelineEntry) => void;
-export type OnBeforeUserEventFn = (options: BeforeUserEventOptions) => Promise<void>;
-export interface NetworkStubbingOptions {
-    page: Page;
-    logLevel: LogLevelDesc;
-    sessionData: SessionData;
-    startUrl: string;
-    originalSessionStartUrl: string;
-    onTimelineEvent: OnReplayTimelineEventFn;
-}
-export type SetupReplayNetworkStubbingFn = (options: NetworkStubbingOptions) => Promise<void>;
-export interface BrowserContextSeedingOptions {
-    page: Page;
-    sessionData: SessionData;
-    startUrl: string;
-}
-export type SetupBrowserContextSeedingFn = (options: BrowserContextSeedingOptions) => Promise<void>;
-export interface InstallVirtualEventLoopOpts {
-    /**
-     * The start time of the original session in ms since unix epoch (Date.now()).
-     *
-     * This is used to ensure that the application code thinks it's running at the same
-     * time as the original session during replay, to minimize differences vs the original
-     * session.
-     */
-    sessionStartTime: number;
-}

package/dist/replay/sdk-to-bundle/index.js

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