@alwaysmeticulous/sdk-bundles-api 2.53.0 → 2.60.0

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

@@ -1,6 +1,7 @@
 import { ScreenshotDiffOptions } from "@alwaysmeticulous/api";
 import { LogLevelNumbers } from "loglevel";
 import { BeforeUserEventResult } from "../bundle-to-sdk/execute-replay";
+import { NetworkStubbingMode } from "./network-stubbing";
 export interface ReplayAndStoreResultsOptions {
     chromeExecutablePath?: string;
     replayTarget: ReplayTarget;
@@ -36,6 +37,12 @@ export interface ReplayAndStoreResultsOptions {
      * that all clients bump the version number passed when they upgrade to the types.
      */
     maxSemanticVersionSupported: 1;
+    /**
+     * The version of the environment in which a replay is executed. This should be bumped
+     * whenever the environment changes in a way that affects the replay, e.g. the version of
+     * Chromium, or the version of Puppeteer.
+     */
+    logicalEnvironmentVersion?: number;
 }
 export interface BeforeUserEventOptions {
     /**
@@ -109,6 +116,12 @@ export interface ReplayExecutionOptions {
     bypassCSP: boolean;
     shiftTime: boolean;
     networkStubbing: boolean;
+    /**
+     * Defaults to {@link StubAllRequests}
+     *
+     * networkStubbing must be true if networkStubbingMode is set.
+     */
+    networkStubbingMode?: NetworkStubbingMode;
     skipPauses: boolean;
     moveBeforeClick: boolean;
     disableRemoteFonts: boolean;

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

@@ -1,5 +1,5 @@
 import { ExecuteTestRunOptions } from "./execute-test-run";
-export type ExecuteScheduledTestRunOptions = Pick<ExecuteTestRunOptions, "chromeExecutablePath" | "apiToken" | "parallelTasks" | "maxRetriesOnFailure" | "rerunTestsNTimes" | "logLevel"> & {
+export type ExecuteScheduledTestRunOptions = Pick<ExecuteTestRunOptions, "chromeExecutablePath" | "apiToken" | "parallelTasks" | "maxRetriesOnFailure" | "rerunTestsNTimes" | "logLevel" | "logicalEnvironmentVersion"> & {
     /**
      * The ID of the scheduled test run to execute.
      */

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

@@ -58,4 +58,10 @@ export interface ExecuteTestRunOptions {
      * that all clients bump the version number passed when they upgrade to the types.
      */
     maxSemanticVersionSupported: 1;
+    /**
+     * The version of the environment in which a replay is executed. This should be bumped
+     * whenever the environment changes in a way that affects the replay, e.g. the version of
+     * Chromium, or the version of Puppeteer.
+     */
+    logicalEnvironmentVersion?: number;
 }

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

@@ -0,0 +1,31 @@
+export type NetworkStubbingMode = StubAllRequests | StubNonSSRRequests | CustomStubbing;
+/**
+ * The default mode. Stubs all requests, apart from ones for _next/static/ files.
+ */
+export interface StubAllRequests {
+    type: "stub-all-requests";
+}
+/**
+ * Stubs all requests apart from NextJS 13 /app dir requests to render server components, and requests for _next/static/ files.
+ *
+ * Used for NextJs 13 /app directory & server components.
+ */
+export interface StubNonSSRRequests {
+    type: "stub-non-ssr-requests";
+}
+export interface CustomStubbing {
+    type: "custom-stubbing";
+    requestsToNotStub: RequestFilter[];
+}
+export interface RequestFilter {
+    /**
+     * If defined will filter to only match requests to a URL matching the
+     * specified regex.
+     *
+     * Any JS regex that passes https://github.com/tjenkinson/redos-detector is supported.
+     */
+    urlRegex: string;
+}
+export interface NoStubbing {
+    type: "no-stubbing";
+}

package/dist/replay-orchestrator/sdk-to-bundle/network-stubbing.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.53.0",
+  "version": "2.60.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -19,7 +19,7 @@
     "depcheck": "depcheck --ignore-patterns=dist"
   },
   "devDependencies": {
-    "@alwaysmeticulous/api": "^2.53.0"
+    "@alwaysmeticulous/api": "^2.56.0"
   },
   "peerDependencies": {
     "loglevel": "^1.8.0"
@@ -46,5 +46,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "ab27f3ab8a2190402938ac64f0a8847e130bd9f3"
+  "gitHead": "79db2c64a95e1e13360fc94610cd717bbb9baded"
 }