@alwaysmeticulous/common - npm Package Compare versions

Comparing version 2.3.4 to 2.4.0

dist/index.d.ts

@@ -7,4 +7,4 @@ export { defer, Deferred, DeferredStatus } from "./defer";
 export type { CreateReplayDebuggerFn, ReplayDebuggerDependencies, ReplayDebuggerOptions, } from "./types/replay-debugger.types";
-export type { BaseReplayEventsDependencies, Replay, ReplayEventsDependencies, ReplayEventsDependency, ReplayEventsFn, ReplayEventsOptions, } from "./types/replay.types";
+export type { BaseReplayEventsDependencies, Replay, ReplayEventsDependencies, ReplayEventsDependency, ReplayEventsFn, ReplayEventsOptions, ReplayExecutionOptions, ScreenshottingOptions, ScreenshottingEnabledOptions, ReplayTarget, } from "./types/replay.types";
 export type { RecordedSession, SessionData } from "./types/session.types";
 export { BASE_SNIPPETS_URL } from "./constants";

dist/types/replay.types.d.ts

@@ -17,4 +17,51 @@ import { RecordedSession, SessionData } from "./session.types";
 }
+export declare type ReplayTarget = SnapshottedAssetsReplayTarget | URLReplayTarget | OriginalRecordedURLReplayTarget;
+export interface SnapshottedAssetsReplayTarget {
+    type: "snapshotted-assets";
+    /**
+     * If present will run the session against a local server serving up previously snapshotted assets (HTML, JS, CSS etc.) from the specified prior replay, instead of against a URL.
+     */
+    simulationIdForAssets: string;
+}
+export interface URLReplayTarget {
+    type: "url";
+    /**
+     * If absent, and no URL provided in test case either, then will use the URL the session was recorded against.
+     */
+    appUrl: string;
+}
+export interface OriginalRecordedURLReplayTarget {
+    type: "original-recorded-url";
+}
+/**
+ * Options that control how a replay is executed.
+ */
+export interface ReplayExecutionOptions {
+    headless: boolean;
+    devTools: boolean;
+    bypassCSP: boolean;
+    padTime: boolean;
+    shiftTime: boolean;
+    networkStubbing: boolean;
+    accelerate: boolean;
+    moveBeforeClick: boolean;
+    maxDurationMs: number | undefined;
+    maxEventCount: number | undefined;
+}
+export declare type ScreenshottingOptions = {
+    enabled: false;
+} | ScreenshottingEnabledOptions;
+export interface ScreenshottingEnabledOptions {
+    enabled: true;
+    /**
+     * If undefined will screenshot whole window
+     */
+    screenshotSelector: string | undefined;
+}
 export interface ReplayEventsOptions {
-    appUrl: string;
+    /**
+     * If undefined then will use the URL the session was recorded against.
+     */
+    appUrl: string | undefined;
+    replayExecutionOptions: ReplayExecutionOptions;
     browser: any;
@@ -26,18 +73,6 @@ outputDir: string;
     meticulousSha: string;
-    headless?: boolean;
-    devTools?: boolean;
-    bypassCSP?: boolean;
     verbose?: boolean;
     dependencies: ReplayEventsDependencies;
-    screenshot?: boolean;
-    screenshotSelector?: string;
-    padTime: boolean;
-    shiftTime: boolean;
-    networkStubbing: boolean;
-    moveBeforeClick: boolean;
-    cookies: Record<string, any>[] | null;
-    cookiesFile: string;
-    accelerate: boolean;
-    maxDurationMs?: number;
-    maxEventCount?: number;
+    screenshottingOptions: ScreenshottingOptions;
+    cookiesFile: string | undefined;
 }
@@ -44,0 +79,0 @@ export declare type ReplayEventsFn = (options: ReplayEventsOptions) => Promise<void>;

package.json

 {
   "name": "@alwaysmeticulous/common",
-  "version": "2.3.4",
+  "version": "2.4.0",
   "description": "Meticulous common utilities",
@@ -41,3 +41,3 @@ "license": "ISC",
   },
-  "gitHead": "25652d1739568f3ca0c88587fa55c2bb706f2c50"
+  "gitHead": "530183206cd8ff57b1950fc4c67eeb8672489380"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79944

increased by1.7%

Lines of code

353

increased by11.01%

No dependency changes