@alwaysmeticulous/sdk-bundles-api 2.349.0 → 3.0.0

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export { InProgressTestRun } from "./replay-orchestrator/bundle-to-sdk/execute-s
 export { InProgressTestRunChunk, ExecuteTestRunChunkResult, TestRunChunkExecution, } from "./replay-orchestrator/bundle-to-sdk/execute-scheduled-test-run-chunk";
 export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, IndexedReplayableEvent, } from "./replay-orchestrator/bundle-to-sdk/execute-replay";
 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 { MeticulousPublicApi, MeticulousPublicAgentSwarmReplayApi, FeatureFlagOverride, RecordFeatureFlagOptions, 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 { CrawlExplorationMode, RunCrawlOptions, RunCrawlResult, } from "./crawler/sdk-to-bundle/run-crawl";
 export { BackendRecorderConfig, BackendRecorderSpanRedactionHook, } from "./backend-recorder/sdk-to-bundle/init-backend-recorder";

package/dist/replay-orchestrator/sdk-to-bundle/execute-replay.d.ts

@@ -111,6 +111,17 @@ export interface ReplayAndStoreResultsOptions {
         chunkNumber: number;
         chunkAttempt: number;
     };
+    /**
+     * Customer feature flag values this replay should force, keyed by flag name. Served to the
+     * application through `window.Meticulous.context.getFlagOverride` and `getAllFlagOverrides`.
+     * Absent or empty means no flag is overridden. Distinct from Meticulous's own engine
+     * feature flags.
+     *
+     * In cloud test runs this is only set on flag-variant replays, never on the ordinary
+     * golden-set pair: forcing flags there would churn screenshots against the value the
+     * session recorded.
+     */
+    customerFeatureFlagOverrides?: Record<string, string | boolean>;
 }
 export interface PreNavigationResult {
     cookies: Cookie[];

package/dist/window-api/public-window-api.d.ts

@@ -4,15 +4,37 @@ import type { HarResponse } from "@alwaysmeticulous/api";
  */
 export type MeticulousPublicApi = MeticulousPublicApiCommon & ({
     isRunningAsTest: true;
+    isRunningInAgentSwarm?: false;
     replay: MeticulousPublicReplayApi;
+} | {
+    isRunningAsTest: true;
+    isRunningInAgentSwarm: true;
+    replay: MeticulousPublicAgentSwarmReplayApi;
+    record: MeticulousPublicRecordApi;
 } | {
     isRunningAsTest: false;
+    isRunningInAgentSwarm?: false;
     record: MeticulousPublicRecordApi;
 });
 export interface MeticulousPublicApiCommon {
     isRunningAsTest?: boolean;
+    /**
+     * True when the app is being driven by a Meticulous Agent swarm browser,
+     * which records new sessions against a test deployment. `isRunningAsTest` is
+     * also true there, so apps that relax behaviour for Meticulous tests do the
+     * same for Agent swarm; check this flag only to tell the two apart.
+     */
+    isRunningInAgentSwarm?: boolean;
     context: MeticulousPublicContextApi;
 }
+/**
+ * The replay API exposed in Agent swarm, where no replay is running. Its
+ * methods are no-ops so code written for replays keeps working, and replay-only
+ * data such as the session being replayed is absent.
+ */
+export type MeticulousPublicAgentSwarmReplayApi = Omit<MeticulousPublicReplayApi, "isBenchmarkableReplay" | "native" | "commitUnderTest" | "sessionBeingReplayed" | "browser"> & {
+    isBenchmarkableReplay: false;
+};
 /**
  * Options for {@link MeticulousPublicReplayApi.recordCustomSnapshot}.
  */
@@ -411,15 +433,33 @@ export type FeatureFlagOverride = {
     overridden: true;
     value: string | boolean;
 };
+export interface RecordFeatureFlagOptions {
+    /**
+     * Human-readable name to show for this flag in the Meticulous UI, e.g. `"New checkout flow"`
+     * for the key `"checkout-v3"`. Defaults to the flag's key. Meticulous still identifies the flag
+     * by its key everywhere else, including {@link MeticulousPublicContextApi.getFlagOverride}.
+     *
+     * Must be a non-empty string of at most 1000 characters. Otherwise the call records nothing and
+     * returns `{ success: false }`.
+     */
+    label?: string;
+}
 export interface MeticulousPublicContextApi {
     /**
      * Record the value of a feature flag that your application actually used. If this
-     * method is called multiple times with the same label, the value will be overwritten.
+     * method is called multiple times with the same key, the value (and label, if given) will be
+     * overwritten.
      *
      * If you also call {@link getFlagOverride} in the same resolver, record the value you
      * returned after applying the override — not a later snapshot from your flag SDK.
+     *
+     * ```js
+     * window.Meticulous?.context?.recordFeatureFlag?.("checkout-v3", true, {
+     *   label: "New checkout flow",
+     * });
+     * ```
      */
-    recordFeatureFlag(label: string, value: string | boolean): {
+    recordFeatureFlag(key: string, value: string | boolean, options?: RecordFeatureFlagOptions): {
         success: boolean;
     };
     /**

package/package.json

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