@alwaysmeticulous/sdk-bundles-api 2.36.0 → 2.38.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 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, StoryboardOptions, BrowserContextSeedingOptions, SetupBrowserContextSeedingFn, } from "./replay/sdk-to-bundle";
+export { BootstrapReplayUserInteractionsFn, BootstrapReplayUserInteractionsOptions, OnReplayTimelineEventFn, ReplayUserInteractionsFn, ReplayUserInteractionsOptions, VirtualTimeOptions, InstallVirtualEventLoopOpts, SetupReplayNetworkStubbingFn, NetworkStubbingOptions, BrowserContextSeedingOptions, SetupBrowserContextSeedingFn, ScreenshottingOptions, } from "./replay/sdk-to-bundle";

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

@@ -3,15 +3,23 @@ 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;
-    storyboard?: StoryboardOptions;
     maxDurationMs?: number;
     maxEventCount?: number;
-    sessionDurationMs?: number;
+    sessionDurationMs: number;
     logLevel: LogLevelDesc;
+    screenshots: ScreenshottingOptions;
     onTimelineEvent: OnReplayTimelineEventFn;
     /**
      * If present then will be called before executing each next user event,
@@ -19,6 +27,11 @@ export interface ReplayUserInteractionsOptions {
      */
     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 {
@@ -31,13 +44,6 @@ export type VirtualTimeOptions = {
 } | {
     enabled: true;
 };
-/** Options for capturing a storyboard made of screenshots during replay */
-export type StoryboardOptions = {
-    enabled: false;
-} | {
-    enabled: true;
-    screenshotsDir: string;
-};
 export type OnReplayTimelineEventFn = (entry: SDKReplayTimelineEntry) => void;
 export type OnBeforeUserEventFn = (options: BeforeUserEventOptions) => Promise<void>;
 export interface NetworkStubbingOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.36.0",
+  "version": "2.38.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -18,7 +18,7 @@
     "lint:fix": "eslint src --ext=ts,tsx,js --cache --fix"
   },
   "devDependencies": {
-    "@alwaysmeticulous/api": "^2.36.0"
+    "@alwaysmeticulous/api": "^2.37.0"
   },
   "peerDependencies": {
     "loglevel": "^1.8.0",
@@ -49,5 +49,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "fda3a87f90ef42bab4f7e51620494083e95c4b5e"
+  "gitHead": "2c4fbc9225d5e0dc09f14a1e90a67008a5e3f376"
 }