@walkeros/web-destination-optimizely 3.4.0-next-1776749829492

package/dist/index.d.mts

@@ -0,0 +1,111 @@
+import { Destination as Destination$1, Mapping as Mapping$1 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+/**
+ * Destination-level settings.
+ */
+interface Settings {
+    /** Optimizely Feature Experimentation SDK key. Required. */
+    sdkKey: string;
+    /** walkerOS mapping value to resolve userId for experiment bucketing. */
+    userId?: Mapping$1.Value;
+    /** User attributes for audience targeting, applied to every event. */
+    attributes?: Mapping$1.Value;
+    /** Polling interval for datafile updates in ms. Default: 60000. */
+    updateInterval?: number;
+    /** Auto-update datafile via polling. Default: true. */
+    autoUpdate?: boolean;
+    /** Batch event processor: events per batch. Default: 10. */
+    batchSize?: number;
+    /** Batch event processor: flush interval in ms. Default: 1000. */
+    flushInterval?: number;
+    /** Skip ODP manager initialization. Default: true. */
+    skipOdp?: boolean;
+    /** Runtime state -- not user-facing. Mutated by init/push. */
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    /** The Optimizely client instance (typed as OptimizelyClient). */
+    client?: OptimizelyClient;
+    /** Cached user context. Recreated when userId changes. */
+    userContext?: OptimizelyUserContext;
+    /** Last resolved userId to detect identity changes. */
+    lastUserId?: string;
+}
+type InitSettings = Partial<Settings>;
+/**
+ * Per-rule mapping settings.
+ */
+interface Mapping {
+    /** Override event key sent to Optimizely. If omitted, event.name is used. */
+    eventKey?: string;
+    /** Revenue mapping. Resolves to integer (cents). Passed as eventTags.revenue. */
+    revenue?: Mapping$1.Value;
+    /** Numeric value mapping. Resolves to float. Passed as eventTags.value. */
+    value?: Mapping$1.Value;
+    /** Additional event tags. Resolves to Record<string, unknown>. */
+    eventTags?: Mapping$1.Value;
+    /** Per-event user attributes override. Merged onto user context for this event. */
+    attributes?: Mapping$1.Value;
+}
+/**
+ * OptimizelyClient -- the subset of the Optimizely SDK client the destination
+ * actually uses. Tests provide a mock via env.optimizely.
+ */
+interface OptimizelyClient {
+    onReady: () => Promise<{
+        success: boolean;
+    }>;
+    createUserContext: (userId: string, attributes?: Record<string, unknown>) => OptimizelyUserContext | null;
+    close: () => void;
+}
+/**
+ * OptimizelyUserContext -- user context methods the destination calls.
+ */
+interface OptimizelyUserContext {
+    trackEvent: (eventKey: string, eventTags?: Record<string, unknown>) => void;
+    setAttribute: (key: string, value: unknown) => void;
+}
+/**
+ * OptimizelySDK -- factory functions the destination imports from the SDK.
+ * Tests provide this via env.optimizely to avoid importing the real SDK.
+ */
+interface OptimizelySDK {
+    createInstance: (config: Record<string, unknown>) => OptimizelyClient;
+    createPollingProjectConfigManager: (config: Record<string, unknown>) => unknown;
+    createBatchEventProcessor: (config: Record<string, unknown>) => unknown;
+}
+/**
+ * Env -- optional SDK override. Production leaves env.optimizely undefined
+ * and the destination falls back to the real @optimizely/optimizely-sdk
+ * import. Tests provide a mock via env.optimizely.
+ */
+interface Env extends DestinationWeb.Env {
+    optimizely?: OptimizelySDK;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+type Destination = DestinationWeb.Destination<Types>;
+type Config = DestinationWeb.Config<Types>;
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+
+type index_Config = Config;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_OptimizelyClient = OptimizelyClient;
+type index_OptimizelySDK = OptimizelySDK;
+type index_OptimizelyUserContext = OptimizelyUserContext;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_RuntimeState = RuntimeState;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_Destination as Destination, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_OptimizelyClient as OptimizelyClient, index_OptimizelySDK as OptimizelySDK, index_OptimizelyUserContext as OptimizelyUserContext, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationOptimizely: Destination;
+
+export { index as DestinationOptimizely, destinationOptimizely as default, destinationOptimizely };

package/dist/index.d.ts

@@ -0,0 +1,111 @@
+import { Destination as Destination$1, Mapping as Mapping$1 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+/**
+ * Destination-level settings.
+ */
+interface Settings {
+    /** Optimizely Feature Experimentation SDK key. Required. */
+    sdkKey: string;
+    /** walkerOS mapping value to resolve userId for experiment bucketing. */
+    userId?: Mapping$1.Value;
+    /** User attributes for audience targeting, applied to every event. */
+    attributes?: Mapping$1.Value;
+    /** Polling interval for datafile updates in ms. Default: 60000. */
+    updateInterval?: number;
+    /** Auto-update datafile via polling. Default: true. */
+    autoUpdate?: boolean;
+    /** Batch event processor: events per batch. Default: 10. */
+    batchSize?: number;
+    /** Batch event processor: flush interval in ms. Default: 1000. */
+    flushInterval?: number;
+    /** Skip ODP manager initialization. Default: true. */
+    skipOdp?: boolean;
+    /** Runtime state -- not user-facing. Mutated by init/push. */
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    /** The Optimizely client instance (typed as OptimizelyClient). */
+    client?: OptimizelyClient;
+    /** Cached user context. Recreated when userId changes. */
+    userContext?: OptimizelyUserContext;
+    /** Last resolved userId to detect identity changes. */
+    lastUserId?: string;
+}
+type InitSettings = Partial<Settings>;
+/**
+ * Per-rule mapping settings.
+ */
+interface Mapping {
+    /** Override event key sent to Optimizely. If omitted, event.name is used. */
+    eventKey?: string;
+    /** Revenue mapping. Resolves to integer (cents). Passed as eventTags.revenue. */
+    revenue?: Mapping$1.Value;
+    /** Numeric value mapping. Resolves to float. Passed as eventTags.value. */
+    value?: Mapping$1.Value;
+    /** Additional event tags. Resolves to Record<string, unknown>. */
+    eventTags?: Mapping$1.Value;
+    /** Per-event user attributes override. Merged onto user context for this event. */
+    attributes?: Mapping$1.Value;
+}
+/**
+ * OptimizelyClient -- the subset of the Optimizely SDK client the destination
+ * actually uses. Tests provide a mock via env.optimizely.
+ */
+interface OptimizelyClient {
+    onReady: () => Promise<{
+        success: boolean;
+    }>;
+    createUserContext: (userId: string, attributes?: Record<string, unknown>) => OptimizelyUserContext | null;
+    close: () => void;
+}
+/**
+ * OptimizelyUserContext -- user context methods the destination calls.
+ */
+interface OptimizelyUserContext {
+    trackEvent: (eventKey: string, eventTags?: Record<string, unknown>) => void;
+    setAttribute: (key: string, value: unknown) => void;
+}
+/**
+ * OptimizelySDK -- factory functions the destination imports from the SDK.
+ * Tests provide this via env.optimizely to avoid importing the real SDK.
+ */
+interface OptimizelySDK {
+    createInstance: (config: Record<string, unknown>) => OptimizelyClient;
+    createPollingProjectConfigManager: (config: Record<string, unknown>) => unknown;
+    createBatchEventProcessor: (config: Record<string, unknown>) => unknown;
+}
+/**
+ * Env -- optional SDK override. Production leaves env.optimizely undefined
+ * and the destination falls back to the real @optimizely/optimizely-sdk
+ * import. Tests provide a mock via env.optimizely.
+ */
+interface Env extends DestinationWeb.Env {
+    optimizely?: OptimizelySDK;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+type Destination = DestinationWeb.Destination<Types>;
+type Config = DestinationWeb.Config<Types>;
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+
+type index_Config = Config;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_OptimizelyClient = OptimizelyClient;
+type index_OptimizelySDK = OptimizelySDK;
+type index_OptimizelyUserContext = OptimizelyUserContext;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_RuntimeState = RuntimeState;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_Destination as Destination, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_OptimizelyClient as OptimizelyClient, index_OptimizelySDK as OptimizelySDK, index_OptimizelyUserContext as OptimizelyUserContext, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationOptimizely: Destination;
+
+export { index as DestinationOptimizely, destinationOptimizely as default, destinationOptimizely };