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

package/dist/examples/index.d.mts

@@ -0,0 +1,152 @@
+import { Mapping, Flow } 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.Value;
+    /** User attributes for audience targeting, applied to every event. */
+    attributes?: Mapping.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;
+}
+/**
+ * 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;
+}
+
+/**
+ * Pre-init env -- all methods are no-ops until the test runner wires spies.
+ */
+declare const init: Env | undefined;
+/**
+ * Post-init env -- same shape. The test runner clones this and replaces
+ * individual methods with jest.fn() so it can assert on calls.
+ */
+declare const push: Env;
+/** Simulation tracking paths for CLI --simulate. */
+declare const simulation: string[];
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_init as init, env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type OptimizelyStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- every walkerOS event becomes
+ * userContext.trackEvent(event.name). No mapping, no eventTags.
+ */
+declare const defaultEventForwarding: OptimizelyStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event key for Optimizely.
+ * The eventKey must match an event created in the Optimizely project.
+ */
+declare const mappedEventName: OptimizelyStepExample;
+/**
+ * Revenue tracking -- mapping.settings.revenue resolves to an integer
+ * (cents). Passed as eventTags.revenue. The value is a pass-through;
+ * the user must provide cents (e.g. 55500 = $555.00).
+ */
+declare const orderCompleteRevenue: OptimizelyStepExample;
+/**
+ * Per-event attributes -- mapping.settings.attributes resolves to
+ * key-value pairs that are applied via setAttribute() before trackEvent().
+ */
+declare const signupWithAttributes: OptimizelyStepExample;
+/**
+ * Wildcard ignore -- walkerOS's standard way to drop events. The rule
+ * matches but does nothing. The destination fires zero SDK calls.
+ */
+declare const wildcardIgnored: OptimizelyStepExample;
+/**
+ * Skip track with attributes only -- fires setAttribute calls but no
+ * trackEvent. Useful for enriching user context without a conversion.
+ */
+declare const attributesOnlySkipTrack: OptimizelyStepExample;
+/**
+ * Consent revoked -- the destination closes the Optimizely client,
+ * flushing queued events and stopping datafile polling.
+ */
+declare const consentRevoked: OptimizelyStepExample;
+/**
+ * Consent granted -- no immediate SDK action needed. The destination
+ * re-initializes on the next push (walkerOS queues events until consent
+ * is granted, then re-inits). No calls expected.
+ */
+declare const consentGranted: OptimizelyStepExample;
+
+type step_OptimizelyStepExample = OptimizelyStepExample;
+declare const step_attributesOnlySkipTrack: typeof attributesOnlySkipTrack;
+declare const step_consentGranted: typeof consentGranted;
+declare const step_consentRevoked: typeof consentRevoked;
+declare const step_defaultEventForwarding: typeof defaultEventForwarding;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_orderCompleteRevenue: typeof orderCompleteRevenue;
+declare const step_signupWithAttributes: typeof signupWithAttributes;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_OptimizelyStepExample as OptimizelyStepExample, step_attributesOnlySkipTrack as attributesOnlySkipTrack, step_consentGranted as consentGranted, step_consentRevoked as consentRevoked, step_defaultEventForwarding as defaultEventForwarding, step_mappedEventName as mappedEventName, step_orderCompleteRevenue as orderCompleteRevenue, step_signupWithAttributes as signupWithAttributes, step_wildcardIgnored as wildcardIgnored };
+}
+
+export { env, step };

package/dist/examples/index.d.ts

@@ -0,0 +1,152 @@
+import { Mapping, Flow } 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.Value;
+    /** User attributes for audience targeting, applied to every event. */
+    attributes?: Mapping.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;
+}
+/**
+ * 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;
+}
+
+/**
+ * Pre-init env -- all methods are no-ops until the test runner wires spies.
+ */
+declare const init: Env | undefined;
+/**
+ * Post-init env -- same shape. The test runner clones this and replaces
+ * individual methods with jest.fn() so it can assert on calls.
+ */
+declare const push: Env;
+/** Simulation tracking paths for CLI --simulate. */
+declare const simulation: string[];
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_init as init, env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type OptimizelyStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- every walkerOS event becomes
+ * userContext.trackEvent(event.name). No mapping, no eventTags.
+ */
+declare const defaultEventForwarding: OptimizelyStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event key for Optimizely.
+ * The eventKey must match an event created in the Optimizely project.
+ */
+declare const mappedEventName: OptimizelyStepExample;
+/**
+ * Revenue tracking -- mapping.settings.revenue resolves to an integer
+ * (cents). Passed as eventTags.revenue. The value is a pass-through;
+ * the user must provide cents (e.g. 55500 = $555.00).
+ */
+declare const orderCompleteRevenue: OptimizelyStepExample;
+/**
+ * Per-event attributes -- mapping.settings.attributes resolves to
+ * key-value pairs that are applied via setAttribute() before trackEvent().
+ */
+declare const signupWithAttributes: OptimizelyStepExample;
+/**
+ * Wildcard ignore -- walkerOS's standard way to drop events. The rule
+ * matches but does nothing. The destination fires zero SDK calls.
+ */
+declare const wildcardIgnored: OptimizelyStepExample;
+/**
+ * Skip track with attributes only -- fires setAttribute calls but no
+ * trackEvent. Useful for enriching user context without a conversion.
+ */
+declare const attributesOnlySkipTrack: OptimizelyStepExample;
+/**
+ * Consent revoked -- the destination closes the Optimizely client,
+ * flushing queued events and stopping datafile polling.
+ */
+declare const consentRevoked: OptimizelyStepExample;
+/**
+ * Consent granted -- no immediate SDK action needed. The destination
+ * re-initializes on the next push (walkerOS queues events until consent
+ * is granted, then re-inits). No calls expected.
+ */
+declare const consentGranted: OptimizelyStepExample;
+
+type step_OptimizelyStepExample = OptimizelyStepExample;
+declare const step_attributesOnlySkipTrack: typeof attributesOnlySkipTrack;
+declare const step_consentGranted: typeof consentGranted;
+declare const step_consentRevoked: typeof consentRevoked;
+declare const step_defaultEventForwarding: typeof defaultEventForwarding;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_orderCompleteRevenue: typeof orderCompleteRevenue;
+declare const step_signupWithAttributes: typeof signupWithAttributes;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_OptimizelyStepExample as OptimizelyStepExample, step_attributesOnlySkipTrack as attributesOnlySkipTrack, step_consentGranted as consentGranted, step_consentRevoked as consentRevoked, step_defaultEventForwarding as defaultEventForwarding, step_mappedEventName as mappedEventName, step_orderCompleteRevenue as orderCompleteRevenue, step_signupWithAttributes as signupWithAttributes, step_wildcardIgnored as wildcardIgnored };
+}
+
+export { env, step };

package/dist/examples/index.js

@@ -0,0 +1,228 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  env: () => env_exports,
+  step: () => step_exports
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  init: () => init,
+  push: () => push,
+  simulation: () => simulation
+});
+var noop = () => {
+};
+function createMockUserContext() {
+  return {
+    trackEvent: noop,
+    setAttribute: noop
+  };
+}
+function createMockClient() {
+  return {
+    onReady: (() => Promise.resolve({ success: true })),
+    createUserContext: (() => createMockUserContext()),
+    close: noop
+  };
+}
+function createMockSDK() {
+  return {
+    createInstance: (() => createMockClient()),
+    createPollingProjectConfigManager: (() => ({})),
+    createBatchEventProcessor: (() => ({}))
+  };
+}
+var init = {
+  optimizely: createMockSDK()
+};
+var push = {
+  optimizely: createMockSDK()
+};
+var simulation = [
+  "call:optimizely.createInstance",
+  "call:optimizely.client.onReady",
+  "call:optimizely.client.createUserContext",
+  "call:optimizely.userContext.trackEvent",
+  "call:optimizely.userContext.setAttribute",
+  "call:optimizely.client.close"
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  attributesOnlySkipTrack: () => attributesOnlySkipTrack,
+  consentGranted: () => consentGranted,
+  consentRevoked: () => consentRevoked,
+  defaultEventForwarding: () => defaultEventForwarding,
+  mappedEventName: () => mappedEventName,
+  orderCompleteRevenue: () => orderCompleteRevenue,
+  signupWithAttributes: () => signupWithAttributes,
+  wildcardIgnored: () => wildcardIgnored
+});
+
+// ../../../core/dist/index.mjs
+var e = Object.defineProperty;
+var c = {};
+((t, n) => {
+  for (var o in n) e(t, o, { get: n[o], enumerable: true });
+})(c, { Level: () => u });
+var u = ((e2) => (e2[e2.ERROR = 0] = "ERROR", e2[e2.WARN = 1] = "WARN", e2[e2.INFO = 2] = "INFO", e2[e2.DEBUG = 3] = "DEBUG", e2))(u || {});
+var W = { merge: true, shallow: true, extend: true };
+function L(e2, t = {}, n = {}) {
+  n = { ...W, ...n };
+  const o = Object.entries(t).reduce((t2, [o2, r]) => {
+    const i = e2[o2];
+    return n.merge && Array.isArray(i) && Array.isArray(r) ? t2[o2] = r.reduce((e3, t3) => e3.includes(t3) ? e3 : [...e3, t3], [...i]) : (n.extend || o2 in e2) && (t2[o2] = r), t2;
+  }, {});
+  return n.shallow ? { ...e2, ...o } : (Object.assign(e2, o), e2);
+}
+function fe(e2 = {}) {
+  var _a;
+  const t = e2.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), n = e2.group || "gr0up", o = e2.count || 1, r = L({ name: "entity action", data: { string: "foo", number: 1, boolean: true, array: [0, "text", false], not: void 0 }, context: { dev: ["test", 1] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [{ entity: "child", data: { is: "subordinated" }, nested: [], context: { element: ["child", 0] } }], consent: { functional: true }, id: `${t}-${n}-${o}`, trigger: "test", entity: "entity", action: "action", timestamp: t, timing: 3.14, group: n, count: o, version: { source: "3.4.0-next-1776749829492", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }, e2, { merge: false });
+  if (e2.name) {
+    const [t2, n2] = (_a = e2.name.split(" ")) != null ? _a : [];
+    t2 && n2 && (r.entity = t2, r.action = n2);
+  }
+  return r;
+}
+function le(e2 = "entity action", t = {}) {
+  const n = t.timestamp || (/* @__PURE__ */ new Date()).setHours(0, 13, 37, 0), o = { data: { id: "ers", name: "Everyday Ruck Snack", color: "black", size: "l", price: 420 } }, r = { data: { id: "cc", name: "Cool Cap", size: "one size", price: 42 } };
+  return fe({ ...{ "cart view": { data: { currency: "EUR", value: 2 * o.data.price }, context: { shopping: ["cart", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", data: { ...o.data, quantity: 2 }, context: { shopping: ["cart", 0] }, nested: [] }], trigger: "load" }, "checkout view": { data: { step: "payment", currency: "EUR", value: o.data.price + r.data.price }, context: { shopping: ["checkout", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", ...o, context: { shopping: ["checkout", 0] }, nested: [] }, { entity: "product", ...r, context: { shopping: ["checkout", 0] }, nested: [] }], trigger: "load" }, "order complete": { data: { id: "0rd3r1d", currency: "EUR", shipping: 5.22, taxes: 73.76, total: 555 }, context: { shopping: ["complete", 0] }, globals: { pagegroup: "shop" }, nested: [{ entity: "product", ...o, context: { shopping: ["complete", 0] }, nested: [] }, { entity: "product", ...r, context: { shopping: ["complete", 0] }, nested: [] }, { entity: "gift", data: { name: "Surprise" }, context: { shopping: ["complete", 0] }, nested: [] }], trigger: "load" }, "page view": { data: { domain: "www.example.com", title: "walkerOS documentation", referrer: "https://www.walkeros.io/", search: "?foo=bar", hash: "#hash", id: "/docs/" }, globals: { pagegroup: "docs" }, trigger: "load" }, "product add": { ...o, context: { shopping: ["intent", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "click" }, "product view": { ...o, context: { shopping: ["detail", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "load" }, "product visible": { data: { ...o.data, position: 3, promo: true }, context: { shopping: ["discover", 0] }, globals: { pagegroup: "shop" }, nested: [], trigger: "load" }, "promotion visible": { data: { name: "Setting up tracking easily", position: "hero" }, context: { ab_test: ["engagement", 0] }, globals: { pagegroup: "homepage" }, trigger: "visible" }, "session start": { data: { id: "s3ss10n", start: n, isNew: true, count: 1, runs: 1, isStart: true, storage: true, referrer: "", device: "c00k13" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n", hash: "h4sh", address: "street number", email: "user@example.com", phone: "+49 123 456 789", userAgent: "Mozilla...", browser: "Chrome", browserVersion: "90", deviceType: "desktop", language: "de-DE", country: "DE", region: "HH", city: "Hamburg", zip: "20354", timezone: "Berlin", os: "walkerOS", osVersion: "1.0", screenSize: "1337x420", ip: "127.0.0.0", internal: true, custom: "value" } } }[e2], ...t, name: e2 });
+}
+
+// src/examples/step.ts
+var defaultEventForwarding = {
+  in: le("page view", { timestamp: 1700000100 }),
+  out: [["optimizely.trackEvent", "page view", {}]]
+};
+var mappedEventName = {
+  in: le("product view", { timestamp: 1700000101 }),
+  mapping: {
+    name: "product_viewed"
+  },
+  out: [["optimizely.trackEvent", "product_viewed", {}]]
+};
+var orderCompleteRevenue = {
+  in: le("order complete", {
+    timestamp: 1700000102,
+    data: {
+      revenue_cents: 55500,
+      total: 555,
+      currency: "EUR",
+      item_count: 3
+    }
+  }),
+  mapping: {
+    name: "purchase",
+    settings: {
+      revenue: "data.revenue_cents",
+      value: "data.total",
+      eventTags: {
+        map: {
+          currency: "data.currency",
+          item_count: "data.item_count"
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "optimizely.trackEvent",
+      "purchase",
+      { revenue: 55500, value: 555, currency: "EUR", item_count: 3 }
+    ]
+  ]
+};
+var signupWithAttributes = {
+  in: le("user signup", {
+    timestamp: 1700000103,
+    data: {
+      method: "google",
+      source: "referral"
+    }
+  }),
+  mapping: {
+    name: "signup",
+    settings: {
+      attributes: {
+        map: {
+          signup_method: "data.method",
+          referral_source: "data.source"
+        }
+      }
+    }
+  },
+  out: [
+    ["optimizely.setAttribute", "signup_method", "google"],
+    ["optimizely.setAttribute", "referral_source", "referral"],
+    ["optimizely.trackEvent", "signup", {}]
+  ]
+};
+var wildcardIgnored = {
+  in: le("debug noise", { timestamp: 1700000104 }),
+  mapping: { ignore: true },
+  out: []
+};
+var attributesOnlySkipTrack = {
+  in: le("profile update", {
+    timestamp: 1700000105,
+    data: {
+      plan: "premium",
+      country: "DE"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      attributes: {
+        map: {
+          plan: "data.plan",
+          country: "data.country"
+        }
+      }
+    }
+  },
+  out: [
+    ["optimizely.setAttribute", "plan", "premium"],
+    ["optimizely.setAttribute", "country", "DE"]
+  ]
+};
+var consentRevoked = {
+  command: "consent",
+  in: { analytics: false },
+  settings: {},
+  out: [["optimizely.close"]]
+};
+var consentGranted = {
+  command: "consent",
+  in: { analytics: true },
+  settings: {},
+  out: []
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});