@alwaysmeticulous/sdk-bundles-api 2.348.0 → 2.350.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, 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/replay-orchestrator/sdk-to-bundle/execute-scheduled-test-run-chunk.d.ts

@@ -8,4 +8,10 @@ export type ExecuteScheduledTestRunChunkOptions = Pick<ExecuteTestRunOptions, "c
      * The chunk number to execute.
      */
     chunkNumber: number;
+    /**
+     * Epoch milliseconds at which the worker running this chunk will kill it.
+     * When set, flake-check retries that are unlikely to finish before then are
+     * skipped. When absent, retries are scheduled without regard to time.
+     */
+    chunkDeadlineEpochMs?: number;
 };

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}.
  */
@@ -460,6 +482,17 @@ export interface MeticulousPublicContextApi {
      * recorder is not loaded at all.
      */
     getFlagOverride(label: string): FeatureFlagOverride;
+    /**
+     * Every feature flag value the current replay forces, keyed by flag label: the same overrides
+     * {@link getFlagOverride} serves one at a time. Useful when your flag client is initialised
+     * with a full set of values up front (e.g. LaunchDarkly `bootstrap`), rather than resolving
+     * flags one by one.
+     *
+     * The returned object is a copy, so mutating it has no effect on the replay. Flags absent from
+     * it are not overridden, and your application should evaluate them itself. Always returns `{}`
+     * outside of a replay, so it is safe to call from production code.
+     */
+    getAllFlagOverrides(): Record<string, string | boolean>;
     /**
      * Call this method to record some custom context about the session. For instance, you could use
      * this to capture whether a user is opted into beta features, or what colour scheme they have

package/package.json

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