@alwaysmeticulous/sdk-bundles-api 2.350.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, MeticulousPublicAgentSwarmReplayApi, 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/window-api/public-window-api.d.ts

@@ -433,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.350.0",
+  "version": "3.0.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -9,7 +9,7 @@
     "dist"
   ],
   "dependencies": {
-    "@alwaysmeticulous/api": "2.350.0"
+    "@alwaysmeticulous/api": "3.0.0"
   },
   "author": {
     "name": "The Meticulous Team",