@alwaysmeticulous/sdk-bundles-api 2.339.0 → 2.341.0

package/dist/backend-recorder/sdk-to-bundle/init-backend-recorder.d.ts

@@ -1,8 +1,13 @@
 /**
  * Transforms one redactable string from a completed backend span before that span is saved.
  * Hooks run in array order and must return a string.
+ *
+ * `jsonPath` locates the string within the serialized span, so a hook can tell a database
+ * query's serialized arguments from a URL or a header value and redact each appropriately —
+ * rewriting serialized JSON with text substitutions risks emitting something that no longer
+ * parses, which silently breaks mock matching at replay time.
  */
-export type BackendRecorderSpanRedactionHook = (value: string) => string;
+export type BackendRecorderSpanRedactionHook = (value: string, jsonPath: readonly string[]) => string;
 export interface BackendRecorderConfig {
     /** Enable/disable the recorder. Defaults to `true`. */
     enabled?: boolean;

package/dist/crawler/sdk-to-bundle/run-crawl.d.ts

@@ -1,3 +1,13 @@
+/**
+ * How the crawler spends its time on each page it reaches.
+ *
+ * - `default`: follow links outwards as soon as the page's clickables are
+ *   exhausted, covering as many pages as the time budget allows.
+ * - `depth`: exercise each page before moving on — scroll through it to render
+ *   everything below the fold, and prefer the elements that keep us on the page
+ *   (returning to it when a click does navigate away).
+ */
+export type CrawlExplorationMode = "default" | "depth";
 export interface RunCrawlOptions {
     /**
      * The API token of the project to record sessions into. If not provided
@@ -36,6 +46,12 @@ export interface RunCrawlOptions {
      * The maximum number of sessions to record.
      */
     maxNumSessions: number;
+    /**
+     * How to explore each page reached by the crawl. Defaults to `default`.
+     *
+     * Optional so that a CLI predating this option keeps working.
+     */
+    explorationMode?: CrawlExplorationMode | undefined;
     /**
      * If present the crawler pauses after opening the start URL in the browser,
      * calls this to let the user manually log in, and only starts crawling once

package/dist/index.d.ts

@@ -12,6 +12,6 @@ export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, In
 export { ScreenshotDiffData } from "./replay-orchestrator/bundle-to-sdk/execute-replay";
 export { MeticulousPublicApi, FeatureFlagOverride, MeticulousPressureObserver, MeticulousPressureObserverConstructor, MeticulousPressureRecord, MeticulousPressureSource, MeticulousPressureState, RecordCustomSnapshotOptions, OnBeforeScreenshotListener, OnBeforeScreenshotListenerOptions, OnReplayCompletionListener, OnReplayCompletionListenerOptions, } from "./window-api/public-window-api";
 export { MeticulousPrivateApi } from "./window-api/private-window-api";
-export { RunCrawlOptions, RunCrawlResult, } from "./crawler/sdk-to-bundle/run-crawl";
+export { CrawlExplorationMode, RunCrawlOptions, RunCrawlResult, } from "./crawler/sdk-to-bundle/run-crawl";
 export { BackendRecorderConfig, BackendRecorderSpanRedactionHook, } from "./backend-recorder/sdk-to-bundle/init-backend-recorder";
 export { BackendRecorderHandle, MeticulousCloudflareBindingKind, MeticulousCloudflareEnvOptions, MeticulousCloudflareEnvWrapper, MeticulousPrismaExtension, MeticulousIORedisWrapper, MeticulousPostgresJsWrapper, MeticulousOperationSpec, MeticulousOperationWrapper, MeticulousObservationRecorder, MeticulousReplayCheck, MeticulousStubReader, MeticulousValueRecorder, } from "./backend-recorder/bundle-to-sdk/init-backend-recorder";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.339.0",
+  "version": "2.341.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -9,7 +9,7 @@
     "dist"
   ],
   "dependencies": {
-    "@alwaysmeticulous/api": "2.339.0"
+    "@alwaysmeticulous/api": "2.341.0"
   },
   "author": {
     "name": "The Meticulous Team",