@alwaysmeticulous/api 2.149.0 → 2.153.0

package/dist/index.d.ts

@@ -9,7 +9,7 @@ export { Cookie, SessionData, UrlHistoryEvent, WindowData, ApplicationSpecificDa
 export { SequenceNumber, WebSocketConnectionData, WebSocketConnectionEvent, WebSocketConnectionCreatedEvent, WebSocketConnectionOpenedEvent, EncodedArrayBuffer, EncodedBlob, WebSocketConnectionMessageEvent, WebSocketConnectionErrorEvent, WebSocketConnectionClosedEvent, } from "./sdk-bundle-api/sdk-to-bundle/websocket-data";
 export { Replay } from "./replay/replay.types";
 export { ScreenshotAssertionsOptions, ScreenshotAssertionsEnabledOptions, ScreenshottingEnabledOptions, StoryboardOptions, ScreenshotDiffOptions, ElementToIgnore, CSSSelectorToIgnore, } 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";
+export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, CustomTransformation, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
 export { ConsoleMessageWithStackTracePointer, VirtualTimeChange, MeticulousConsoleMessage, ApplicationConsoleMessage, ConsoleMessageCoreData, ConsoleMessageType, ConsoleMessageLocation, } from "./sdk-bundle-api/bundle-to-sdk/console-message";
 export { InjectableRequestHeader, StaticHeaderValue, DynamicHeaderValue, AllRequests, AppUrlRequestsOnly, CustomRequests, } from "./sdk-bundle-api/sdk-to-bundle/header-injection";
 export { ConsoleErrorDivergenceIndicator, Divergence, DivergenceConsoleError, DivergenceIndicator, InitialNavigationDivergenceIndicator, NetworkActivityDivergenceIndicator, ScreenshotDivergenceIdentifier, UrlChangeEventDivergenceIndicator, UserEventDivergenceIndicator, } from "./sdk-bundle-api/bundle-to-sdk/replay-divergence";

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

@@ -1,8 +1,15 @@
 export type NetworkStubbingMode = StubAllRequests | StubNonSSRRequests | CustomStubbing;
+interface NetworkStubbingBase {
+    /**
+     * When looking for a request to use as a stub, these transformations will be applied to the request before any other transformations.
+     * They will be applied in the order they are defined.
+     */
+    customRequestTransformations?: CustomTransformation[];
+}
 /**
  * The default mode. Stubs all requests, apart from ones for _next/static/ files.
  */
-export interface StubAllRequests {
+export interface StubAllRequests extends NetworkStubbingBase {
     type: "stub-all-requests";
 }
 /**
@@ -10,10 +17,10 @@ export interface StubAllRequests {
  *
  * Used for NextJs 13 /app directory & server components.
  */
-export interface StubNonSSRRequests {
+export interface StubNonSSRRequests extends NetworkStubbingBase {
     type: "stub-non-ssr-requests";
 }
-export interface CustomStubbing {
+export interface CustomStubbing extends NetworkStubbingBase {
     type: "custom-stubbing";
     requestsToNotStub: RequestFilter[];
 }
@@ -36,3 +43,28 @@ export interface ConnectionTypesFilter {
     xhr: boolean;
     webSockets: boolean;
 }
+type TransformableRequestData = Pick<Request, "body" | "method" | "url">;
+interface CustomTransformationBase {
+    /**
+     * The regex to match against the request component.
+     */
+    matchRegex: string;
+    /**
+     * The replacement for any matches with matchRegex.
+     * This can reference groups in the matchRegex, for example:
+     * - matchRegex = `id_(\w*)=[^&]*`, replacement = `id_$1=<redacted>`
+     * - matchRegex= `id_(?<param_name>\w*)=[^&]*`, replacement = `id_$<param_name>=<redacted>`
+     */
+    replacement: string;
+    requestComponent: keyof TransformableRequestData;
+}
+type TransformableUrlFields = keyof Pick<URL, "hash" | "host" | "hostname" | "href" | "password" | "pathname" | "port" | "protocol" | "search" | "username">;
+interface CustomUrlTransformation extends CustomTransformationBase {
+    requestComponent: keyof Pick<TransformableRequestData, "url">;
+    urlComponent: TransformableUrlFields;
+}
+interface CustomRequestTransformation extends CustomTransformationBase {
+    requestComponent: keyof Omit<TransformableRequestData, "url">;
+}
+export type CustomTransformation = CustomRequestTransformation | CustomUrlTransformation;
+export {};

package/dist/sdk-bundle-api/sdk-to-bundle/test-run-environment.d.ts

@@ -21,6 +21,8 @@ export interface TestRunGitHubPullRequestContext {
     headSha: string;
     /** Head ref (usually /refs/head/<branch>) */
     headRef?: string;
+    /** GitHub Actions run ID that triggered this test run */
+    runId?: number;
 }
 export interface TestRunGitHubPushContext {
     type: "github";
@@ -31,6 +33,8 @@ export interface TestRunGitHubPushContext {
     afterSha: string;
     /** Git ref (usually /refs/head/<branch>) */
     ref: string;
+    /** GitHub Actions run ID that triggered this test run */
+    runId?: number;
 }
 export interface TestRunGitHubWorkflowDispatchContext {
     type: "github";
@@ -43,6 +47,8 @@ export interface TestRunGitHubWorkflowDispatchContext {
     };
     /** Resolved head commit hash */
     headSha: string;
+    /** GitHub Actions run ID that triggered this test run */
+    runId?: number;
 }
 export type TestRunGitLabContext = TestRunGitLabMergeRequestContext | TestRunGitLabPushContext;
 export interface TestRunGitLabMergeRequestContext {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.149.0",
+  "version": "2.153.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": "a4db0d275545f9d58415dcb32da999a4a98f9f65"
+  "gitHead": "97b550636b6c7bef9e68801cb8798e58f0089251"
 }