@alwaysmeticulous/api 2.214.0 → 2.217.0

package/dist/index.d.ts

@@ -10,7 +10,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, CustomTransformation, } from "./sdk-bundle-api/sdk-to-bundle/network-stubbing";
+export { NetworkStubbingMode, StubAllRequests, StubNonSSRRequests, NoStubbing, CustomStubbing, RequestFilter, CustomTransformation, CustomTransformationWhere, } 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,7 +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.
+     * When looking for a request to use as a stub, these transformations will be applied to the request first.
+     * If not defined, the default identity transformation will be used (i.e., exact matching of the request).
+     * These transformations take precedence over any other transformations.
+     * They will be applied in the order they are defined.
+     */
+    identityRequestTransformations?: CustomTransformation[];
+    /**
+     * When looking for a request to use as a stub, these transformations will be applied after the identity transformations.
+     * These transformations are applied in addition to (and after) any identity transformations.
      * They will be applied in the order they are defined.
      */
     customRequestTransformations?: CustomTransformation[];
@@ -57,6 +65,7 @@ interface CustomTransformationBase {
      */
     replacement: string;
     requestComponent: keyof TransformableRequestData;
+    where?: CustomTransformationWhere;
 }
 type TransformableUrlFields = keyof Pick<URL, "hash" | "host" | "hostname" | "href" | "password" | "pathname" | "port" | "protocol" | "search" | "username">;
 interface CustomUrlTransformation extends CustomTransformationBase {
@@ -67,4 +76,5 @@ interface CustomRequestTransformation extends CustomTransformationBase {
     requestComponent: keyof Omit<TransformableRequestData, "url">;
 }
 export type CustomTransformation = CustomRequestTransformation | CustomUrlTransformation;
+export type CustomTransformationWhere = Omit<CustomRequestTransformation, "replacement"> | Omit<CustomUrlTransformation, "replacement">;
 export {};

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.d.ts

@@ -231,7 +231,12 @@ export declare enum CustomDataSingletonInternalKey {
      * The email address of the logged in user. This must be set by the recording application
      * by calling `window.Meticulous.record.recordUserEmail(email)`.
      */
-    UserEmail = "met-user-email"
+    UserEmail = "met-user-email",
+    /**
+     * The user agent of the browser the session was recorded on. As returned by `navigator.userAgent`.
+     * Present on recordings since ~May 2025.
+     */
+    UserAgent = "met-user-agent"
 }
 export type CustomDataSingletonInternalValues = {
     [CustomDataSingletonInternalKey.SystemThemePreferredColor]: "light" | "dark";
@@ -239,6 +244,7 @@ export type CustomDataSingletonInternalValues = {
     [CustomDataSingletonInternalKey.Languages]: string;
     [CustomDataSingletonInternalKey.UserId]: string;
     [CustomDataSingletonInternalKey.UserEmail]: string;
+    [CustomDataSingletonInternalKey.UserAgent]: string;
 };
 export type CustomData = {
     singletons: Record<string, string> & Partial<CustomDataSingletonInternalValues>;

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.js

@@ -28,5 +28,10 @@ var CustomDataSingletonInternalKey;
      * by calling `window.Meticulous.record.recordUserEmail(email)`.
      */
     CustomDataSingletonInternalKey["UserEmail"] = "met-user-email";
+    /**
+     * The user agent of the browser the session was recorded on. As returned by `navigator.userAgent`.
+     * Present on recordings since ~May 2025.
+     */
+    CustomDataSingletonInternalKey["UserAgent"] = "met-user-agent";
 })(CustomDataSingletonInternalKey = exports.CustomDataSingletonInternalKey || (exports.CustomDataSingletonInternalKey = {}));
 //# sourceMappingURL=session-data.js.map

package/dist/sdk-bundle-api/sdk-to-bundle/session-data.js.map

@@ -1 +1 @@
-{"version":3,"file":"session-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/session-data.ts"],"names":[],"mappings":";;;AA2OA,IAAY,8BA8BX;AA9BD,WAAY,8BAA8B;IACxC,gGAA8D,CAAA;IAE9D;;;;;OAKG;IACH,oEAAkC,CAAA;IAElC;;;;;OAKG;IACH,6DAA2B,CAAA;IAE3B;;;OAGG;IACH,wDAAsB,CAAA;IAEtB;;;OAGG;IACH,8DAA4B,CAAA;AAC9B,CAAC,EA9BW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QA8BzC"}
+{"version":3,"file":"session-data.js","sourceRoot":"","sources":["../../../src/sdk-bundle-api/sdk-to-bundle/session-data.ts"],"names":[],"mappings":";;;AA2OA,IAAY,8BAoCX;AApCD,WAAY,8BAA8B;IACxC,gGAA8D,CAAA;IAE9D;;;;;OAKG;IACH,oEAAkC,CAAA;IAElC;;;;;OAKG;IACH,6DAA2B,CAAA;IAE3B;;;OAGG;IACH,wDAAsB,CAAA;IAEtB;;;OAGG;IACH,8DAA4B,CAAA;IAE5B;;;OAGG;IACH,8DAA4B,CAAA;AAC9B,CAAC,EApCW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QAoCzC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/api",
-  "version": "2.214.0",
+  "version": "2.217.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": "5b1e71ac1f70ef9468b916c96e34a433370e0e3e"
+  "gitHead": "59ed023e008f2ca41ece40339690e775702861b4"
 }