@walkeros/server-destination-customerio 3.4.0-next-1776749829492

package/dist/examples/index.d.mts

@@ -0,0 +1,156 @@
+import { Mapping, Flow } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+/**
+ * Mock-friendly interface for the TrackClient methods the
+ * destination actually calls. Tests provide this via env.trackClient
+ * instead of the real SDK.
+ */
+interface CustomerIoTrackClientMock {
+    identify: (customerId: string | number, attributes: Record<string, unknown>) => Promise<void>;
+    track: (customerId: string | number, eventData: {
+        name: string;
+        data?: Record<string, unknown>;
+        timestamp?: number;
+    }) => Promise<void>;
+    trackAnonymous: (anonymousId: string, eventData: {
+        name: string;
+        data?: Record<string, unknown>;
+        timestamp?: number;
+    }) => Promise<void>;
+    trackPageView: (customerId: string | number, url: string, data?: Record<string, unknown>) => Promise<void>;
+    destroy: (customerId: string | number) => Promise<void>;
+    suppress: (customerId: string | number) => Promise<void>;
+    unsuppress: (customerId: string | number) => Promise<void>;
+    addDevice: (customerId: string | number, deviceId: string, platform: string, data?: Record<string, unknown>) => Promise<void>;
+    deleteDevice: (customerId: string | number, deviceId: string, platform: string) => Promise<void>;
+    mergeCustomers: (primaryType: string, primaryId: string, secondaryType: string, secondaryId: string) => Promise<void>;
+}
+/**
+ * Mock-friendly interface for the APIClient methods the
+ * destination actually calls. Tests provide this via env.apiClient
+ * instead of the real SDK.
+ */
+interface CustomerIoApiClientMock {
+    sendEmail: (request: unknown) => Promise<void>;
+    sendPush: (request: unknown) => Promise<void>;
+}
+interface Settings {
+    /** Customer.io Site ID (required for Track API). */
+    siteId: string;
+    /** Customer.io API Key (required for Track API). */
+    apiKey: string;
+    /** App API Key for transactional messaging (optional). */
+    appApiKey?: string;
+    /** Region: 'us' or 'eu'. Default: 'us'. */
+    region?: 'us' | 'eu';
+    /** HTTP request timeout in ms. Default: 10000. */
+    timeout?: number;
+    /** walkerOS mapping value path to resolve customerId from each event. */
+    customerId?: string;
+    /** walkerOS mapping value path to resolve anonymousId from each event. */
+    anonymousId?: string;
+    /** Destination-level identify mapping (fires identify() on first push / change). */
+    identify?: Mapping.Value;
+    /** Runtime state -- not user-facing. */
+    _trackClient?: CustomerIoTrackClientMock;
+    _apiClient?: CustomerIoApiClientMock;
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    lastIdentity?: {
+        customerId?: string;
+        attributesHash?: string;
+    };
+}
+/**
+ * Env -- optional SDK override. Production leaves this undefined and the
+ * destination creates real TrackClient/APIClient instances. Tests provide
+ * mocks via env.trackClient and env.apiClient.
+ */
+interface Env extends DestinationServer.Env {
+    trackClient?: CustomerIoTrackClientMock;
+    apiClient?: CustomerIoApiClientMock;
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type CustomerIoStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- trackClient.track() with event name and data.
+ * customerId resolved from default settings.customerId = 'user.id'.
+ */
+declare const defaultTrack: CustomerIoStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event for Customer.io.
+ */
+declare const mappedEventName: CustomerIoStepExample;
+/**
+ * Track with mapped data properties.
+ */
+declare const mappedData: CustomerIoStepExample;
+/**
+ * Anonymous event -- no customerId resolved, falls back to trackAnonymous().
+ */
+declare const anonymousTrack: CustomerIoStepExample;
+/**
+ * Destination-level identify -- fires trackClient.identify() on first push
+ * when settings.identify mapping resolves. Then fires trackClient.track().
+ */
+declare const destinationIdentify: CustomerIoStepExample;
+/**
+ * Per-event identify with skip -- user login fires identify() only.
+ */
+declare const userLoginIdentify: CustomerIoStepExample;
+/**
+ * Page view -- fires trackClient.trackPageView() with url.
+ * skip: true suppresses track(); settings.page fires trackPageView().
+ */
+declare const pageView: CustomerIoStepExample;
+/**
+ * Destroy -- permanently deletes a person from Customer.io.
+ */
+declare const destroyPerson: CustomerIoStepExample;
+/**
+ * Suppress -- stops messaging without deleting data.
+ */
+declare const suppressPerson: CustomerIoStepExample;
+/**
+ * Unsuppress -- resumes messaging for a suppressed person.
+ */
+declare const unsuppressPerson: CustomerIoStepExample;
+/**
+ * Wildcard ignore -- the event matches a mapping rule with ignore: true.
+ * The destination fires zero SDK calls.
+ */
+declare const wildcardIgnored: CustomerIoStepExample;
+
+type step_CustomerIoStepExample = CustomerIoStepExample;
+declare const step_anonymousTrack: typeof anonymousTrack;
+declare const step_defaultTrack: typeof defaultTrack;
+declare const step_destinationIdentify: typeof destinationIdentify;
+declare const step_destroyPerson: typeof destroyPerson;
+declare const step_mappedData: typeof mappedData;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_pageView: typeof pageView;
+declare const step_suppressPerson: typeof suppressPerson;
+declare const step_unsuppressPerson: typeof unsuppressPerson;
+declare const step_userLoginIdentify: typeof userLoginIdentify;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_CustomerIoStepExample as CustomerIoStepExample, step_anonymousTrack as anonymousTrack, step_defaultTrack as defaultTrack, step_destinationIdentify as destinationIdentify, step_destroyPerson as destroyPerson, step_mappedData as mappedData, step_mappedEventName as mappedEventName, step_pageView as pageView, step_suppressPerson as suppressPerson, step_unsuppressPerson as unsuppressPerson, step_userLoginIdentify as userLoginIdentify, step_wildcardIgnored as wildcardIgnored };
+}
+
+export { env, step };

package/dist/examples/index.d.ts

@@ -0,0 +1,156 @@
+import { Mapping, Flow } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+/**
+ * Mock-friendly interface for the TrackClient methods the
+ * destination actually calls. Tests provide this via env.trackClient
+ * instead of the real SDK.
+ */
+interface CustomerIoTrackClientMock {
+    identify: (customerId: string | number, attributes: Record<string, unknown>) => Promise<void>;
+    track: (customerId: string | number, eventData: {
+        name: string;
+        data?: Record<string, unknown>;
+        timestamp?: number;
+    }) => Promise<void>;
+    trackAnonymous: (anonymousId: string, eventData: {
+        name: string;
+        data?: Record<string, unknown>;
+        timestamp?: number;
+    }) => Promise<void>;
+    trackPageView: (customerId: string | number, url: string, data?: Record<string, unknown>) => Promise<void>;
+    destroy: (customerId: string | number) => Promise<void>;
+    suppress: (customerId: string | number) => Promise<void>;
+    unsuppress: (customerId: string | number) => Promise<void>;
+    addDevice: (customerId: string | number, deviceId: string, platform: string, data?: Record<string, unknown>) => Promise<void>;
+    deleteDevice: (customerId: string | number, deviceId: string, platform: string) => Promise<void>;
+    mergeCustomers: (primaryType: string, primaryId: string, secondaryType: string, secondaryId: string) => Promise<void>;
+}
+/**
+ * Mock-friendly interface for the APIClient methods the
+ * destination actually calls. Tests provide this via env.apiClient
+ * instead of the real SDK.
+ */
+interface CustomerIoApiClientMock {
+    sendEmail: (request: unknown) => Promise<void>;
+    sendPush: (request: unknown) => Promise<void>;
+}
+interface Settings {
+    /** Customer.io Site ID (required for Track API). */
+    siteId: string;
+    /** Customer.io API Key (required for Track API). */
+    apiKey: string;
+    /** App API Key for transactional messaging (optional). */
+    appApiKey?: string;
+    /** Region: 'us' or 'eu'. Default: 'us'. */
+    region?: 'us' | 'eu';
+    /** HTTP request timeout in ms. Default: 10000. */
+    timeout?: number;
+    /** walkerOS mapping value path to resolve customerId from each event. */
+    customerId?: string;
+    /** walkerOS mapping value path to resolve anonymousId from each event. */
+    anonymousId?: string;
+    /** Destination-level identify mapping (fires identify() on first push / change). */
+    identify?: Mapping.Value;
+    /** Runtime state -- not user-facing. */
+    _trackClient?: CustomerIoTrackClientMock;
+    _apiClient?: CustomerIoApiClientMock;
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    lastIdentity?: {
+        customerId?: string;
+        attributesHash?: string;
+    };
+}
+/**
+ * Env -- optional SDK override. Production leaves this undefined and the
+ * destination creates real TrackClient/APIClient instances. Tests provide
+ * mocks via env.trackClient and env.apiClient.
+ */
+interface Env extends DestinationServer.Env {
+    trackClient?: CustomerIoTrackClientMock;
+    apiClient?: CustomerIoApiClientMock;
+}
+
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type CustomerIoStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- trackClient.track() with event name and data.
+ * customerId resolved from default settings.customerId = 'user.id'.
+ */
+declare const defaultTrack: CustomerIoStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event for Customer.io.
+ */
+declare const mappedEventName: CustomerIoStepExample;
+/**
+ * Track with mapped data properties.
+ */
+declare const mappedData: CustomerIoStepExample;
+/**
+ * Anonymous event -- no customerId resolved, falls back to trackAnonymous().
+ */
+declare const anonymousTrack: CustomerIoStepExample;
+/**
+ * Destination-level identify -- fires trackClient.identify() on first push
+ * when settings.identify mapping resolves. Then fires trackClient.track().
+ */
+declare const destinationIdentify: CustomerIoStepExample;
+/**
+ * Per-event identify with skip -- user login fires identify() only.
+ */
+declare const userLoginIdentify: CustomerIoStepExample;
+/**
+ * Page view -- fires trackClient.trackPageView() with url.
+ * skip: true suppresses track(); settings.page fires trackPageView().
+ */
+declare const pageView: CustomerIoStepExample;
+/**
+ * Destroy -- permanently deletes a person from Customer.io.
+ */
+declare const destroyPerson: CustomerIoStepExample;
+/**
+ * Suppress -- stops messaging without deleting data.
+ */
+declare const suppressPerson: CustomerIoStepExample;
+/**
+ * Unsuppress -- resumes messaging for a suppressed person.
+ */
+declare const unsuppressPerson: CustomerIoStepExample;
+/**
+ * Wildcard ignore -- the event matches a mapping rule with ignore: true.
+ * The destination fires zero SDK calls.
+ */
+declare const wildcardIgnored: CustomerIoStepExample;
+
+type step_CustomerIoStepExample = CustomerIoStepExample;
+declare const step_anonymousTrack: typeof anonymousTrack;
+declare const step_defaultTrack: typeof defaultTrack;
+declare const step_destinationIdentify: typeof destinationIdentify;
+declare const step_destroyPerson: typeof destroyPerson;
+declare const step_mappedData: typeof mappedData;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_pageView: typeof pageView;
+declare const step_suppressPerson: typeof suppressPerson;
+declare const step_unsuppressPerson: typeof unsuppressPerson;
+declare const step_userLoginIdentify: typeof userLoginIdentify;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_CustomerIoStepExample as CustomerIoStepExample, step_anonymousTrack as anonymousTrack, step_defaultTrack as defaultTrack, step_destinationIdentify as destinationIdentify, step_destroyPerson as destroyPerson, step_mappedData as mappedData, step_mappedEventName as mappedEventName, step_pageView as pageView, step_suppressPerson as suppressPerson, step_unsuppressPerson as unsuppressPerson, step_userLoginIdentify as userLoginIdentify, step_wildcardIgnored as wildcardIgnored };
+}
+
+export { env, step };

package/dist/examples/index.js

@@ -0,0 +1,318 @@
+"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, {
+  push: () => push,
+  simulation: () => simulation
+});
+var asyncIdentify = () => Promise.resolve();
+var asyncEvent = () => Promise.resolve();
+var asyncAnonymous = () => Promise.resolve();
+var asyncPage = () => Promise.resolve();
+var asyncOne = () => Promise.resolve();
+var asyncAddDevice = () => Promise.resolve();
+var asyncDeleteDevice = () => Promise.resolve();
+var asyncMerge = () => Promise.resolve();
+var asyncSend = () => Promise.resolve();
+function createMockTrackClient() {
+  return {
+    identify: asyncIdentify,
+    track: asyncEvent,
+    trackAnonymous: asyncAnonymous,
+    trackPageView: asyncPage,
+    destroy: asyncOne,
+    suppress: asyncOne,
+    unsuppress: asyncOne,
+    addDevice: asyncAddDevice,
+    deleteDevice: asyncDeleteDevice,
+    mergeCustomers: asyncMerge
+  };
+}
+function createMockApiClient() {
+  return {
+    sendEmail: asyncSend,
+    sendPush: asyncSend
+  };
+}
+var push = {
+  trackClient: createMockTrackClient(),
+  apiClient: createMockApiClient()
+};
+var simulation = [
+  "call:trackClient.identify",
+  "call:trackClient.track",
+  "call:trackClient.trackAnonymous",
+  "call:trackClient.trackPageView",
+  "call:trackClient.destroy",
+  "call:trackClient.suppress",
+  "call:trackClient.unsuppress",
+  "call:trackClient.addDevice",
+  "call:trackClient.deleteDevice",
+  "call:trackClient.mergeCustomers",
+  "call:apiClient.sendEmail",
+  "call:apiClient.sendPush"
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  anonymousTrack: () => anonymousTrack,
+  defaultTrack: () => defaultTrack,
+  destinationIdentify: () => destinationIdentify,
+  destroyPerson: () => destroyPerson,
+  mappedData: () => mappedData,
+  mappedEventName: () => mappedEventName,
+  pageView: () => pageView,
+  suppressPerson: () => suppressPerson,
+  unsuppressPerson: () => unsuppressPerson,
+  userLoginIdentify: () => userLoginIdentify,
+  wildcardIgnored: () => wildcardIgnored
+});
+var import_core = require("@walkeros/core");
+var defaultTrack = {
+  in: (0, import_core.getEvent)("product view", {
+    timestamp: 1700000100,
+    user: { id: "us3r", session: "s3ss10n" }
+  }),
+  out: [
+    [
+      "trackClient.track",
+      "us3r",
+      {
+        name: "product view",
+        data: {},
+        timestamp: 17e5
+      }
+    ]
+  ]
+};
+var mappedEventName = {
+  in: (0, import_core.getEvent)("order complete", {
+    timestamp: 1700000101,
+    user: { id: "us3r", session: "s3ss10n" }
+  }),
+  mapping: {
+    name: "purchase"
+  },
+  out: [
+    [
+      "trackClient.track",
+      "us3r",
+      {
+        name: "purchase",
+        data: {},
+        timestamp: 17e5
+      }
+    ]
+  ]
+};
+var mappedData = {
+  in: (0, import_core.getEvent)("order complete", {
+    timestamp: 1700000102,
+    user: { id: "us3r", session: "s3ss10n" },
+    data: { id: "0rd3r1d", total: 555, currency: "EUR" }
+  }),
+  mapping: {
+    name: "purchase",
+    data: {
+      map: {
+        order_id: "data.id",
+        value: "data.total",
+        currency: "data.currency"
+      }
+    }
+  },
+  out: [
+    [
+      "trackClient.track",
+      "us3r",
+      {
+        name: "purchase",
+        data: { order_id: "0rd3r1d", value: 555, currency: "EUR" },
+        timestamp: 17e5
+      }
+    ]
+  ]
+};
+var anonymousTrack = {
+  in: (0, import_core.getEvent)("product view", {
+    timestamp: 1700000103,
+    user: { session: "s3ss10n" }
+  }),
+  settings: {
+    customerId: void 0
+  },
+  out: [
+    [
+      "trackClient.trackAnonymous",
+      "s3ss10n",
+      {
+        name: "product view",
+        data: {},
+        timestamp: 17e5
+      }
+    ]
+  ]
+};
+var destinationIdentify = {
+  in: (0, import_core.getEvent)("page view", {
+    timestamp: 1700000104,
+    user: { id: "us3r", session: "s3ss10n", email: "user@example.com" }
+  }),
+  settings: {
+    identify: {
+      map: {
+        email: "user.email"
+      }
+    }
+  },
+  out: [
+    ["trackClient.identify", "us3r", { email: "user@example.com" }],
+    [
+      "trackClient.track",
+      "us3r",
+      {
+        name: "page view",
+        data: {},
+        timestamp: 17e5
+      }
+    ]
+  ]
+};
+var userLoginIdentify = {
+  in: (0, import_core.getEvent)("user login", {
+    timestamp: 1700000105,
+    user: { id: "us3r", session: "s3ss10n" },
+    data: {
+      email: "user@acme.com",
+      first_name: "Jane",
+      plan: "premium"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      identify: {
+        map: {
+          email: "data.email",
+          first_name: "data.first_name",
+          plan: "data.plan"
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "trackClient.identify",
+      "us3r",
+      { email: "user@acme.com", first_name: "Jane", plan: "premium" }
+    ]
+  ]
+};
+var pageView = {
+  in: (0, import_core.getEvent)("page view", {
+    timestamp: 1700000106,
+    user: { id: "us3r", session: "s3ss10n" },
+    data: {
+      url: "https://example.com/pricing",
+      referrer: "https://google.com"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      page: {
+        map: {
+          url: "data.url",
+          referrer: "data.referrer"
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "trackClient.trackPageView",
+      "us3r",
+      "https://example.com/pricing",
+      { referrer: "https://google.com" }
+    ]
+  ]
+};
+var destroyPerson = {
+  in: (0, import_core.getEvent)("user delete", {
+    timestamp: 1700000107,
+    user: { id: "us3r", session: "s3ss10n" }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      destroy: true
+    }
+  },
+  out: [["trackClient.destroy", "us3r"]]
+};
+var suppressPerson = {
+  in: (0, import_core.getEvent)("user suppress", {
+    timestamp: 1700000108,
+    user: { id: "us3r", session: "s3ss10n" }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      suppress: true
+    }
+  },
+  out: [["trackClient.suppress", "us3r"]]
+};
+var unsuppressPerson = {
+  in: (0, import_core.getEvent)("user unsuppress", {
+    timestamp: 1700000109,
+    user: { id: "us3r", session: "s3ss10n" }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      unsuppress: true
+    }
+  },
+  out: [["trackClient.unsuppress", "us3r"]]
+};
+var wildcardIgnored = {
+  in: (0, import_core.getEvent)("debug noise", {
+    timestamp: 1700000110,
+    user: { id: "us3r", session: "s3ss10n" }
+  }),
+  mapping: { ignore: true },
+  out: []
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});