@alwaysmeticulous/api 2.53.0 → 2.61.0

package/dist/index.d.ts

@@ -8,3 +8,4 @@ export { HarEntry, HarLog, HarRequest, HarResponse, } from "./sdk-bundle-api/sdk
 export { Cookie, SessionData, UrlHistoryEvent, WindowData, } from "./sdk-bundle-api/sdk-to-bundle/session-data";
 export { Replay } from "./replay/replay.types";
 export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, } from "./sdk-bundle-api/sdk-to-bundle/screenshotting-options";
+export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";

package/dist/sdk-bundle-api/bundle-to-sdk/screenshot-diff-result.d.ts

@@ -6,10 +6,11 @@ export type ScreenshotDiffResult = {
 export type ScreenshotIdentifier = EndStateScreenshot | ScreenshotAfterEvent;
 export interface LogicVersioned {
     /**
-     * The version of the logic used to generate the screenshot. This should be bumped
+     * The version of the logic and environment used to generate the screenshot. This should be bumped
      * whenever the Meticulous code changes such that two screenshots on different logic versions
-     * are incomparable. This field is used to avoid falsely flagging a diff to our users when
-     * the logic to generate a screenshot or execute a replay changes.
+     * are incomparable or the replay environment differs. This field is used to avoid falsely flagging a
+     * diff to our users when the logic to generate a screenshot or execute a replay changes, or if
+     * the replay environment changes, e.g. the browser or Puppeteer versions changes.
      */
     logicVersion?: number;
 }

package/dist/sdk-bundle-api/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/sdk-bundle-api/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/api",
-  "version": "2.53.0",
+  "version": "2.61.0",
   "description": "Meticulous API types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "ab27f3ab8a2190402938ac64f0a8847e130bd9f3"
+  "gitHead": "84acc1cb7ba0ca700704945d2265dd0ca5f67741"
 }