@revturbine/sdk 0.10.8 → 0.10.10

package/dist/index.d.ts

@@ -13187,8 +13187,8 @@ declare const PlaybookObjectSchema: z.ZodObject<{
 /**
  * The one canonical config schema. Parses BOTH a canonical Playbook and a legacy
  * `export-config.json` (via `normalizeConfigHeaderInput`) into the canonical
- * Playbook shape, so `ExportedConfigSchema` / `RevTurbineConfigSchema` are true
- * aliases of it. `.meta({ id: 'Playbook' })` rides on this preprocess wrapper
+ * Playbook shape, so `RevTurbineConfigSchema` (and its deprecated
+ * `ExportedConfigSchema` alias) are true aliases of it. `.meta({ id: 'Playbook' })` rides on this preprocess wrapper
  * (the underlying object is id-less) so the OpenAPI / JSON-Schema generators emit
  * a single well-formed `Playbook` component. Introspection that needs `.shape`
  * must read `PlaybookObjectSchema`, not this wrapper.
@@ -17164,6 +17164,50 @@ type JsonObject = {
     [key: string]: JsonValue;
 };
 
+/**
+ * BL-0156 — `playbook` is the canonical option name; `exportedConfig` is a
+ * deprecated alias.
+ *
+ * "ExportedConfig" is dead vocabulary. Plan 118 renamed the domain object to
+ * **Playbook** and plan 104 renamed the schema type to `RevTurbineConfig`, but
+ * the *option* and *parameter* names that carry a Playbook around core still
+ * spelled it `exportedConfig`. This module is the single place that reconciles
+ * the two spellings, mirroring the plan-257 `publicKey` mechanism:
+ *
+ *   - the canonical `playbook` wins whenever it is supplied,
+ *   - the deprecated `exportedConfig` is still accepted,
+ *   - supplying only the alias emits ONE warning naming the canonical option,
+ *   - supplying BOTH with *different* Playbooks throws instead of silently
+ *     picking one — that combination is always a caller bug.
+ *
+ * Every read site resolves through `resolvePlaybookOption` /
+ * `requirePlaybookOption`, so the precedence cannot drift per call site.
+ *
+ * **Why the warning is not gated on a development build.** Core's ESLint config
+ * blocks the `process` global outright (`no-restricted-globals`) because core
+ * must run unchanged on edge runtimes and in browsers, so core cannot read
+ * `NODE_ENV` the way `web-sdk/build-mode.ts` does. The warning is therefore
+ * emitted once per runtime in every build — a single line, only for callers
+ * still on the deprecated spelling, and it names the fix.
+ *
+ * Aliases are removed in the minor after the SDK 0.11.0 cascade.
+ */
+
+/**
+ * An options bag that must carry a Playbook, under either the canonical
+ * `playbook` name or the deprecated `exportedConfig` alias.
+ *
+ * Modelled as a union so TypeScript still requires one of the two, exactly as
+ * the single required property did before the rename.
+ */
+type PlaybookOption = {
+    playbook: RevTurbineConfig;
+    exportedConfig?: RevTurbineConfig;
+} | {
+    playbook?: RevTurbineConfig;
+    exportedConfig: RevTurbineConfig;
+};
+
 /**
  * User context lifecycle — pure functions for building, merging,
  * and deriving targeting state from user context + RevTurbineConfig.
@@ -18118,12 +18162,18 @@ interface LocalPlacementDataset {
 type LocalPlacementEntry = NonNullable<RevTurbineConfig['placements']>[number];
 type LocalPlacementPayload = LocalPlacementEntry['payloads'][number];
 type LocalPlacementSurface = LocalPlacementPayload['surfaces'][number];
-/** Backward-compat JSON entry point. */
-interface StaticPlacementResolverOptions {
+/** Backward-compat JSON entry point, minus the Playbook. */
+interface StaticPlacementResolverOptionsBase {
     placements: LocalPlacementDataset;
-    exportedConfig: RevTurbineConfig;
     impressionHistory?: ImpressionHistory;
 }
+/**
+ * Options for {@link createStaticPlacementResolver}.
+ *
+ * The Playbook is supplied as `playbook`; `exportedConfig` is a deprecated
+ * alias removed in the minor after the SDK 0.11.0 cascade (BL-0156).
+ */
+type StaticPlacementResolverOptions = StaticPlacementResolverOptionsBase & PlaybookOption;
 /**
  * Backward-compat JSON entry. Thin wrapper around the unified
  * `createLocalPlacementResolver`. Use the unified factory directly
@@ -18596,8 +18646,8 @@ declare function createHydrationProviders(options: HydrationAdapterOptions): Any
  * const runtime = new LocalRuntime({
  *   tenantId: 'tenant_abc',
  *   userId: 'user_123',
- *   exportedConfig: myConfig,
- *   providers: createStaticProviders({ config: myConfig, planHandle: 'pro' }),
+ *   playbook: myPlaybook,
+ *   providers: createStaticProviders({ config: myPlaybook, planHandle: 'pro' }),
  *   storage: new InMemoryStorage(),
  * });
  *
@@ -18606,18 +18656,21 @@ declare function createHydrationProviders(options: HydrationAdapterOptions): Any
  * ```
  */
 
-interface LocalRuntimeOptions {
+/**
+ * `LocalRuntimeOptions` minus the Playbook, which arrives through
+ * {@link PlaybookOption} so both the canonical `playbook` name and the
+ * deprecated `exportedConfig` alias are accepted.
+ */
+interface LocalRuntimeOptionsBase {
     /** Tenant identifier. */
     tenantId: string;
     /** Current user identifier. */
     userId: string;
-    /** Full RevTurbineConfig for local resolution. */
-    exportedConfig: RevTurbineConfig;
     /** Pre-built domain providers (from createStaticProviders, etc.). */
     providers: AnyDomainProvider[];
     /**
      * Optional pre-built placements dataset. If not provided, derived from
-     * `exportedConfig.placements`.
+     * `playbook.placements`.
      */
     placements?: LocalPlacementDataset;
     /**
@@ -18634,6 +18687,14 @@ interface LocalRuntimeOptions {
     /** Interaction tracker options. */
     interactionOptions?: Partial<Pick<InteractionTrackerOptions, 'defaultDismissCooldownMs' | 'defaultRemindLaterMs'>>;
 }
+/**
+ * Options for {@link LocalRuntime}.
+ *
+ * The Playbook is supplied as `playbook`. The `exportedConfig` spelling is a
+ * deprecated alias kept so consumers can migrate incrementally; it is removed
+ * in the minor after the SDK 0.11.0 cascade (BL-0156).
+ */
+type LocalRuntimeOptions = LocalRuntimeOptionsBase & PlaybookOption;
 declare class LocalRuntime {
     readonly tenantId: string;
     readonly registry: DomainProviderRegistry;
@@ -18641,7 +18702,7 @@ declare class LocalRuntime {
     readonly interactionTracker: InteractionTracker;
     readonly capEnforcer: CapEnforcer;
     readonly impressionHistory: ImpressionHistory;
-    private readonly exportedConfig;
+    private readonly playbook;
     private readonly registeredPlacements;
     private userId;
     constructor(options: LocalRuntimeOptions);
@@ -18713,7 +18774,14 @@ declare class LocalRuntime {
     setUserId(userId: string): void;
     /** Current user ID. */
     getUserId(): string;
-    /** Return the active RevTurbineConfig snapshot. */
+    /** Return the active Playbook snapshot. */
+    getPlaybook(): RevTurbineConfig;
+    /**
+     * Return the active Playbook snapshot.
+     *
+     * @deprecated Use {@link LocalRuntime.getPlaybook}. Removed in the minor
+     * after the SDK 0.11.0 cascade (BL-0156).
+     */
     getExportedConfig(): RevTurbineConfig;
     /**
      * Pre-warm caches (impression history, etc.) for synchronous access.