@alwaysmeticulous/sdk-bundles-api 2.244.2 → 2.246.0

package/dist/record/middleware.d.ts

@@ -1,4 +1,4 @@
-import { Cookie, HarRequest, HarResponse, StorageEntry, WebSocketConnectionData } from "@alwaysmeticulous/api";
+import { Cookie, HarRequest, HarResponse, StorageEntry, ExpiringImage, WebSocketConnectionData, EventSourceConnectionData } from "@alwaysmeticulous/api";
 /**
  * Transformations that are applied to a recorder payload before it is sent to Meticulous's servers. This is
  * useful for redacting sensitive information from the payload before it is sent.
@@ -103,6 +103,18 @@ export interface RecorderMiddleware {
      * See JSDoc for {@link RecorderMiddleware} before implementing.
      */
     transformNetworkResponse?: (response: HarResponse, metadata: NetworkResponseMetadata) => HarResponse;
+    /**
+     * Transforms expiring image resources before they are sent to Meticulous's servers.
+     *
+     * Expiring images are images that are not publicly accessible and require authentication to access. eg. an S3 url with a presigned url.
+     *
+     * Meticulous captures a compressed and blurred version of the image at record time, and replaces this image with this placeholder during replay.
+     *
+     * Returning null will cause the image to be dropped from the payload.
+     *
+     * See JSDoc for {@link RecorderMiddleware} before implementing.
+     */
+    transformExpiringImage?: (resource: ExpiringImage) => ExpiringImage | null;
     /**
      * Transforms WebSocket messages before they are sent to Meticulous's servers.
      *
@@ -116,6 +128,19 @@ export interface RecorderMiddleware {
      * See JSDoc for {@link RecorderMiddleware} before implementing.
      */
     transformWebSocketConnectionData?: (entry: Omit<WebSocketConnectionData, "id">) => Omit<WebSocketConnectionData, "id"> | null;
+    /**
+     * Transforms EventSource messages before they are sent to Meticulous's servers.
+     *
+     * Returning null will cause the data to be dropped from the payload.
+     *
+     * Please note that the messages received from a connection to a single URL may be split across multiple payloads.
+     *
+     * Note: we pass the EventSourceConnectionData to your middleware without the id field, and re-add the id field after
+     * you return the transformed data.
+     *
+     * See JSDoc for {@link RecorderMiddleware} before implementing.
+     */
+    transformEventSourceConnectionData?: (entry: Omit<EventSourceConnectionData, "id">) => Omit<EventSourceConnectionData, "id"> | null;
     /**
      * Defaults to true. Set to false if transformNetworkRequest only transforms the headers and not the URL or body of the request,
      * and transformNetworkRequest never returns null. Setting to false when not required improves replay performance.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.244.2",
+  "version": "2.246.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -19,7 +19,7 @@
     "depcheck": "depcheck --ignore-patterns=dist"
   },
   "dependencies": {
-    "@alwaysmeticulous/api": "^2.242.6"
+    "@alwaysmeticulous/api": "^2.246.0"
   },
   "author": {
     "name": "The Meticulous Team",
@@ -38,5 +38,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "fa9d4d6a712fed93f0db6dda38545c9c338f8c68"
+  "gitHead": "43f341e9b61e2d86371de98ef4fb3dbb07c19707"
 }