@alwaysmeticulous/sdk-bundles-api 2.334.0 → 2.337.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, MeticulousPressureObserver, MeticulousPressureObserverConstructor, MeticulousPressureRecord, MeticulousPressureSource, MeticulousPressureState, RecordCustomSnapshotOptions, OnBeforeScreenshotListener, OnBeforeScreenshotListenerOptions, OnReplayCompletionListener, OnReplayCompletionListenerOptions, } from "./window-api/public-window-api";
+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 { BackendRecorderConfig, BackendRecorderSpanRedactionHook, } from "./backend-recorder/sdk-to-bundle/init-backend-recorder";

package/dist/record/record-settings.d.ts

@@ -3,7 +3,14 @@ export interface MeticulousWindowConfig {
     METICULOUS_RECORDING_TOKEN?: string;
     METICULOUS_UPLOAD_INTERVAL_MS?: number;
     METICULOUS_APP_COMMIT_HASH?: string;
+    METICULOUS_INLINE_IMAGES?: boolean;
     METICULOUS_SNAPSHOT_LINKED_STYLESHEETS?: boolean;
+    /**
+     * Re-capture stylesheet contents that rrweb's own capture missed, so
+     * CSS-in-JS apps replay styled. Adds the recovered CSS to the payload, so
+     * it is off unless a recording asks for it.
+     */
+    METICULOUS_STYLESHEET_RESYNC?: boolean;
     METICULOUS_FORCE_RECORDING?: boolean;
     METICULOUS_IS_PRODUCTION_ENVIRONMENT?: boolean;
     METICULOUS_NETWORK_RESPONSE_SANITIZERS?: NetworkResponseSanitizer[];

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

@@ -399,14 +399,67 @@ export interface MeticulousPublicRecordApi {
      */
     stopRecording(): void;
 }
+/**
+ * Result of {@link MeticulousPublicContextApi.getFlagOverride}.
+ *
+ * `overridden: false` means Meticulous has no opinion on this flag and your
+ * application should fall back to its own evaluation.
+ */
+export type FeatureFlagOverride = {
+    overridden: false;
+} | {
+    overridden: true;
+    value: string | boolean;
+};
 export interface MeticulousPublicContextApi {
     /**
-     * Call this method to record the value of a feature flag. If this method is called multiple times
-     * with the same label, the value will be overwritten.
+     * 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.
+     *
+     * 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.
      */
     recordFeatureFlag(label: string, value: string | boolean): {
         success: boolean;
     };
+    /**
+     * Ask Meticulous whether the current replay should force a particular value for a feature flag,
+     * *before* your application evaluates that flag itself. Unlike
+     * {@link recordFeatureFlag}, which stores a value your application has already computed, this
+     * method returns a value for your application to use.
+     *
+     * Call it at the top of whatever resolves flags in your app — a Statsig `checkGate` wrapper, a
+     * LaunchDarkly `variation` wrapper, or your own flag resolver — and use the returned value in
+     * preference to your normal evaluation when `overridden` is true. Then record that same
+     * resolved value with {@link recordFeatureFlag} before returning it. How you consume `value`
+     * depends on the helper you wrap:
+     *
+     * ```js
+     * const override = window.Meticulous?.context?.getFlagOverride?.(flagKey);
+     * const value = override?.overridden
+     *   ? Boolean(override.value) // on/off gate
+     *   : myOwnFlagEvaluation(flagKey);
+     * window.Meticulous?.context?.recordFeatureFlag?.(flagKey, value);
+     * return value;
+     * ```
+     *
+     * `Boolean()` is right for an on/off gate (`checkGate`). For a value-read
+     * (`getExperimentValue` / `variation`) return and record `override.value` as-is —
+     * `Boolean('control')` is `true` and would turn every variant on. For an equality-check
+     * (`isTreatment(name, expected)` / `editorExperiment(name, expected)`) compare instead
+     * (`override.value === expected`) and record `override.value`, not the comparison boolean;
+     * coercing or returning the string makes every expected value match, or type-mismatches
+     * callers that expect a boolean. Hook the helper your application actually calls.
+     *
+     * This lets Meticulous test code paths behind flags that were off (or did not exist) when the
+     * session was recorded, without you having to re-record sessions.
+     *
+     * Returns `{ overridden: false }` whenever Meticulous has no override for `label`, and always
+     * does so outside of a replay (for real users being recorded), so it is safe to call from
+     * production code. Use optional chaining as above so your app also works when the Meticulous
+     * recorder is not loaded at all.
+     */
+    getFlagOverride(label: string): FeatureFlagOverride;
     /**
      * 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.334.0",
+  "version": "2.337.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -9,7 +9,7 @@
     "dist"
   ],
   "dependencies": {
-    "@alwaysmeticulous/api": "2.334.0"
+    "@alwaysmeticulous/api": "2.337.0"
   },
   "author": {
     "name": "The Meticulous Team",