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

package/README.md

@@ -0,0 +1,73 @@
+# @walkeros/server-destination-klaviyo
+
+Server-side Klaviyo destination for
+[walkerOS](https://github.com/elbwalker/walkerOS). Forwards events to Klaviyo
+via the official `klaviyo-api` SDK with event tracking and profile management.
+
+## Installation
+
+```bash
+npm install @walkeros/server-destination-klaviyo
+```
+
+## Quick Start
+
+```json
+{
+  "destinations": {
+    "klaviyo": {
+      "package": "@walkeros/server-destination-klaviyo",
+      "config": {
+        "settings": {
+          "apiKey": "$KLAVIYO_API_KEY",
+          "email": "user.email",
+          "externalId": "user.id"
+        }
+      }
+    }
+  }
+}
+```
+
+## Settings
+
+| Setting       | Type         | Required | Default        | Description                                              |
+| ------------- | ------------ | -------- | -------------- | -------------------------------------------------------- |
+| `apiKey`      | string       | Yes      | --             | Klaviyo private API key (starts with `pk_`)              |
+| `email`       | string       | No       | `'user.email'` | Mapping path to resolve email from events                |
+| `externalId`  | string       | No       | `'user.id'`    | Mapping path to resolve external ID from events          |
+| `phoneNumber` | string       | No       | --             | Mapping path to resolve phone number (E.164) from events |
+| `identify`    | MappingValue | No       | --             | Destination-level profile upsert mapping                 |
+| `currency`    | string       | No       | --             | Default ISO 4217 currency code for revenue events        |
+
+## Mapping Settings
+
+Per-event mapping settings control additional behavior:
+
+| Setting    | Effect                                     | Use with `skip: true`        |
+| ---------- | ------------------------------------------ | ---------------------------- |
+| `identify` | Calls `createOrUpdateProfile()`            | Yes, for login/signup events |
+| `value`    | Sets revenue value + currency on the event | No                           |
+
+## Identity
+
+Klaviyo requires at least one profile identifier per event: `email`,
+`phoneNumber`, or `externalId`. The destination resolves these from each
+walkerOS event using the configured mapping paths. Events without any identifier
+are skipped with a warning.
+
+## Revenue Tracking
+
+Map `settings.value` to a numeric event property. The destination sets the
+Klaviyo `value` property and `valueCurrency` (from `settings.currency`).
+
+## Ecommerce
+
+Use `mapping.name` to map walkerOS event names to Klaviyo's expected metric
+names:
+
+| walkerOS Event   | Klaviyo Metric   | Unlocks                |
+| ---------------- | ---------------- | ---------------------- |
+| `product view`   | `Viewed Product` | Product analytics      |
+| `product add`    | `Added to Cart`  | Cart abandonment flows |
+| `order complete` | `Placed Order`   | Revenue reporting, CLV |

package/dist/dev.d.mts

@@ -0,0 +1,164 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { Mapping as Mapping$1, Flow } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+declare const SettingsSchema: z.ZodObject<{
+    apiKey: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phoneNumber: z.ZodOptional<z.ZodString>;
+    externalId: z.ZodOptional<z.ZodString>;
+    identify: z.ZodOptional<z.ZodUnknown>;
+    currency: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Settings$1 = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    identify: z.ZodOptional<z.ZodUnknown>;
+    value: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+type Mapping = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_mapping: typeof mapping;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, type Settings$1 as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+interface Settings {
+    /** Klaviyo private API key (required). Starts with 'pk_'. */
+    apiKey: string;
+    /** walkerOS mapping value path to resolve email from each event. */
+    email?: string;
+    /** walkerOS mapping value path to resolve phone number (E.164) from each event. */
+    phoneNumber?: string;
+    /** walkerOS mapping value path to resolve external ID from each event. */
+    externalId?: string;
+    /** Destination-level identify mapping. Resolves to profile attributes for upsert. */
+    identify?: Mapping$1.Value;
+    /** Default currency for revenue events (ISO 4217, e.g. 'USD', 'EUR'). */
+    currency?: string;
+    /** Runtime state -- not user-facing. Mutated by init/push. */
+    _eventsApi?: KlaviyoEventsApiMock;
+    _profilesApi?: KlaviyoProfilesApiMock;
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    lastIdentity?: {
+        email?: string;
+        externalId?: string;
+        phoneNumber?: string;
+        traitsHash?: string;
+    };
+}
+/**
+ * Env -- optional SDK override. Production leaves this undefined and the
+ * destination creates real API instances. Tests provide mocks via
+ * env.eventsApi and env.profilesApi.
+ */
+interface Env extends DestinationServer.Env {
+    eventsApi?: KlaviyoEventsApiMock;
+    profilesApi?: KlaviyoProfilesApiMock;
+}
+/**
+ * Mock-friendly interface for EventsApi.createEvent().
+ */
+interface KlaviyoEventsApiMock {
+    createEvent: (body: Record<string, unknown>) => Promise<unknown>;
+}
+/**
+ * Mock-friendly interface for ProfilesApi.createOrUpdateProfile().
+ */
+interface KlaviyoProfilesApiMock {
+    createOrUpdateProfile: (body: Record<string, unknown>) => Promise<unknown>;
+}
+
+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 };
+}
+
+/**
+ * Klaviyo SDK step examples.
+ *
+ * At push time, the destination invokes the `klaviyo-api` SDK. The public
+ * method paths users see on the client are:
+ *
+ *   - `eventsApi.createEvent(body)` — fires a metric event with inline profile
+ *   - `profilesApi.createOrUpdateProfile(body)` — upserts a profile
+ *
+ * Each `out` is therefore `[['method.path', ...args], ...]` matching the
+ * actual SDK call order. `identify` fires before the event. When the rule
+ * uses `skip: true` or `ignore: true`, `out` is `[]` or the identify-only
+ * list.
+ */
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type KlaviyoStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- eventsApi.createEvent() with event name and
+ * inline profile. Email resolved from default settings.email = 'user.email'.
+ */
+declare const defaultEvent: KlaviyoStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event to Klaviyo's expected
+ * metric name for ecommerce reporting.
+ */
+declare const mappedEventName: KlaviyoStepExample;
+/**
+ * Revenue event -- order complete with value mapping. Sets $value and
+ * valueCurrency on the Klaviyo event for revenue tracking.
+ */
+declare const revenueEvent: KlaviyoStepExample;
+/**
+ * Per-event identify with skip -- user login fires
+ * profilesApi.createOrUpdateProfile() only, no event tracked.
+ */
+declare const userLoginIdentify: KlaviyoStepExample;
+/**
+ * Destination-level identify -- fires profilesApi.createOrUpdateProfile()
+ * on first push when settings.identify resolves, then fires createEvent().
+ */
+declare const destinationIdentify: KlaviyoStepExample;
+/**
+ * Email only -- no externalId. Klaviyo accepts email as sole identifier.
+ */
+declare const emailOnly: KlaviyoStepExample;
+/**
+ * Wildcard ignore -- the event matches a mapping rule with ignore: true.
+ * The destination fires zero API calls.
+ */
+declare const wildcardIgnored: KlaviyoStepExample;
+
+type step_KlaviyoStepExample = KlaviyoStepExample;
+declare const step_defaultEvent: typeof defaultEvent;
+declare const step_destinationIdentify: typeof destinationIdentify;
+declare const step_emailOnly: typeof emailOnly;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_revenueEvent: typeof revenueEvent;
+declare const step_userLoginIdentify: typeof userLoginIdentify;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_KlaviyoStepExample as KlaviyoStepExample, step_defaultEvent as defaultEvent, step_destinationIdentify as destinationIdentify, step_emailOnly as emailOnly, step_mappedEventName as mappedEventName, step_revenueEvent as revenueEvent, step_userLoginIdentify as userLoginIdentify, step_wildcardIgnored as wildcardIgnored };
+}
+
+declare const index_env: typeof env;
+declare const index_step: typeof step;
+declare namespace index {
+  export { index_env as env, index_step as step };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.d.ts

@@ -0,0 +1,164 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { Mapping as Mapping$1, Flow } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+declare const SettingsSchema: z.ZodObject<{
+    apiKey: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    phoneNumber: z.ZodOptional<z.ZodString>;
+    externalId: z.ZodOptional<z.ZodString>;
+    identify: z.ZodOptional<z.ZodUnknown>;
+    currency: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Settings$1 = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    identify: z.ZodOptional<z.ZodUnknown>;
+    value: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+type Mapping = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_mapping: typeof mapping;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, type Settings$1 as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+interface Settings {
+    /** Klaviyo private API key (required). Starts with 'pk_'. */
+    apiKey: string;
+    /** walkerOS mapping value path to resolve email from each event. */
+    email?: string;
+    /** walkerOS mapping value path to resolve phone number (E.164) from each event. */
+    phoneNumber?: string;
+    /** walkerOS mapping value path to resolve external ID from each event. */
+    externalId?: string;
+    /** Destination-level identify mapping. Resolves to profile attributes for upsert. */
+    identify?: Mapping$1.Value;
+    /** Default currency for revenue events (ISO 4217, e.g. 'USD', 'EUR'). */
+    currency?: string;
+    /** Runtime state -- not user-facing. Mutated by init/push. */
+    _eventsApi?: KlaviyoEventsApiMock;
+    _profilesApi?: KlaviyoProfilesApiMock;
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    lastIdentity?: {
+        email?: string;
+        externalId?: string;
+        phoneNumber?: string;
+        traitsHash?: string;
+    };
+}
+/**
+ * Env -- optional SDK override. Production leaves this undefined and the
+ * destination creates real API instances. Tests provide mocks via
+ * env.eventsApi and env.profilesApi.
+ */
+interface Env extends DestinationServer.Env {
+    eventsApi?: KlaviyoEventsApiMock;
+    profilesApi?: KlaviyoProfilesApiMock;
+}
+/**
+ * Mock-friendly interface for EventsApi.createEvent().
+ */
+interface KlaviyoEventsApiMock {
+    createEvent: (body: Record<string, unknown>) => Promise<unknown>;
+}
+/**
+ * Mock-friendly interface for ProfilesApi.createOrUpdateProfile().
+ */
+interface KlaviyoProfilesApiMock {
+    createOrUpdateProfile: (body: Record<string, unknown>) => Promise<unknown>;
+}
+
+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 };
+}
+
+/**
+ * Klaviyo SDK step examples.
+ *
+ * At push time, the destination invokes the `klaviyo-api` SDK. The public
+ * method paths users see on the client are:
+ *
+ *   - `eventsApi.createEvent(body)` — fires a metric event with inline profile
+ *   - `profilesApi.createOrUpdateProfile(body)` — upserts a profile
+ *
+ * Each `out` is therefore `[['method.path', ...args], ...]` matching the
+ * actual SDK call order. `identify` fires before the event. When the rule
+ * uses `skip: true` or `ignore: true`, `out` is `[]` or the identify-only
+ * list.
+ */
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type KlaviyoStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- eventsApi.createEvent() with event name and
+ * inline profile. Email resolved from default settings.email = 'user.email'.
+ */
+declare const defaultEvent: KlaviyoStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event to Klaviyo's expected
+ * metric name for ecommerce reporting.
+ */
+declare const mappedEventName: KlaviyoStepExample;
+/**
+ * Revenue event -- order complete with value mapping. Sets $value and
+ * valueCurrency on the Klaviyo event for revenue tracking.
+ */
+declare const revenueEvent: KlaviyoStepExample;
+/**
+ * Per-event identify with skip -- user login fires
+ * profilesApi.createOrUpdateProfile() only, no event tracked.
+ */
+declare const userLoginIdentify: KlaviyoStepExample;
+/**
+ * Destination-level identify -- fires profilesApi.createOrUpdateProfile()
+ * on first push when settings.identify resolves, then fires createEvent().
+ */
+declare const destinationIdentify: KlaviyoStepExample;
+/**
+ * Email only -- no externalId. Klaviyo accepts email as sole identifier.
+ */
+declare const emailOnly: KlaviyoStepExample;
+/**
+ * Wildcard ignore -- the event matches a mapping rule with ignore: true.
+ * The destination fires zero API calls.
+ */
+declare const wildcardIgnored: KlaviyoStepExample;
+
+type step_KlaviyoStepExample = KlaviyoStepExample;
+declare const step_defaultEvent: typeof defaultEvent;
+declare const step_destinationIdentify: typeof destinationIdentify;
+declare const step_emailOnly: typeof emailOnly;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_revenueEvent: typeof revenueEvent;
+declare const step_userLoginIdentify: typeof userLoginIdentify;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_KlaviyoStepExample as KlaviyoStepExample, step_defaultEvent as defaultEvent, step_destinationIdentify as destinationIdentify, step_emailOnly as emailOnly, step_mappedEventName as mappedEventName, step_revenueEvent as revenueEvent, step_userLoginIdentify as userLoginIdentify, step_wildcardIgnored as wildcardIgnored };
+}
+
+declare const index_env: typeof env;
+declare const index_step: typeof step;
+declare namespace index {
+  export { index_env as env, index_step as step };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.js

@@ -0,0 +1 @@
+"use strict";var e,t=Object.defineProperty,a=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.prototype.hasOwnProperty,n=(e,a)=>{for(var r in a)t(e,r,{get:a[r],enumerable:!0})},s={};n(s,{examples:()=>g,schemas:()=>o}),module.exports=(e=s,((e,n,s,o)=>{if(n&&"object"==typeof n||"function"==typeof n)for(let p of r(n))i.call(e,p)||p===s||t(e,p,{get:()=>n[p],enumerable:!(o=a(n,p))||o.enumerable});return e})(t({},"__esModule",{value:!0}),e));var o={};n(o,{MappingSchema:()=>d,SettingsSchema:()=>l,mapping:()=>v,settings:()=>c});var p=require("@walkeros/core/dev"),m=require("@walkeros/core/dev"),l=m.z.object({apiKey:m.z.string().min(1).describe("Klaviyo private API key. Starts with pk_. Find it under Settings > API Keys in your Klaviyo account."),email:m.z.string().describe("walkerOS mapping value path to resolve email from each event (like user.email).").optional(),phoneNumber:m.z.string().describe("walkerOS mapping value path to resolve phone number in E.164 format from each event.").optional(),externalId:m.z.string().describe("walkerOS mapping value path to resolve external ID from each event (like user.id).").optional(),identify:m.z.unknown().describe("Destination-level identity mapping. Resolves to profile attributes { firstName?, lastName?, organization?, properties? }. Fires createOrUpdateProfile() on first push and re-fires when values change.").optional(),currency:m.z.string().length(3).describe("Default ISO 4217 currency code for revenue events (like USD, EUR). Sets valueCurrency on Klaviyo events.").optional()}),u=require("@walkeros/core/dev"),d=u.z.object({identify:u.z.unknown().describe("Per-event identify mapping. Resolves to profile attributes for createOrUpdateProfile(). Use with rule-level skip: true on login/signup events.").optional(),value:u.z.unknown().describe("Revenue value mapping. Resolves to a numeric value for Klaviyo revenue tracking. Sets the value property and valueCurrency on the event.").optional()}),c=(0,p.zodToSchema)(l),v=(0,p.zodToSchema)(d),g={};n(g,{env:()=>f,step:()=>O});var f={};n(f,{push:()=>b,simulation:()=>w});var y=()=>Promise.resolve({});var b={eventsApi:{createEvent:y},profilesApi:{createOrUpdateProfile:y}},w=["call:eventsApi.createEvent","call:profilesApi.createOrUpdateProfile"],O={};n(O,{defaultEvent:()=>P,destinationIdentify:()=>N,emailOnly:()=>E,mappedEventName:()=>S,revenueEvent:()=>h,userLoginIdentify:()=>x,wildcardIgnored:()=>k});var I=require("@walkeros/core"),P={in:(0,I.getEvent)("product view",{timestamp:1700000100,user:{id:"us3r",email:"user@example.com"}}),out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"product view"}}},properties:{},time:new Date(1700000100).toISOString()}}}]]},S={in:(0,I.getEvent)("product view",{timestamp:1700000101,user:{id:"us3r",email:"user@example.com"},data:{name:"USB Cable",id:"PROD-1",price:9.99}}),mapping:{name:"Viewed Product",data:{map:{ProductName:"data.name",ProductID:"data.id",Price:"data.price"}}},out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"Viewed Product"}}},properties:{ProductName:"USB Cable",ProductID:"PROD-1",Price:9.99},time:new Date(1700000101).toISOString()}}}]]},h={in:(0,I.getEvent)("order complete",{timestamp:1700000102,user:{id:"us3r",email:"user@example.com"},data:{id:"ORD-123",total:99.99,itemNames:["Widget A","Widget B"]}}),settings:{currency:"EUR"},mapping:{name:"Placed Order",data:{map:{OrderId:"data.id",value:"data.total",ItemNames:"data.itemNames"}},settings:{value:"data.total"}},out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"Placed Order"}}},properties:{OrderId:"ORD-123",value:99.99,ItemNames:["Widget A","Widget B"]},time:new Date(1700000102).toISOString(),valueCurrency:"EUR"}}}]]},x={in:(0,I.getEvent)("user login",{timestamp:1700000103,user:{id:"us3r",email:"user@acme.com"},data:{firstName:"Jane",lastName:"Doe",company:"Acme Corp",plan:"premium"}}),mapping:{skip:!0,settings:{identify:{map:{firstName:"data.firstName",lastName:"data.lastName",organization:"data.company",properties:{map:{plan:"data.plan"}}}}}},out:[["profilesApi.createOrUpdateProfile",{data:{type:"profile",attributes:{email:"user@acme.com",externalId:"us3r",firstName:"Jane",lastName:"Doe",organization:"Acme Corp",properties:{plan:"premium"}}}}]]},N={in:(0,I.getEvent)("page view",{timestamp:1700000104,user:{id:"us3r",email:"user@example.com",firstName:"Jane"}}),settings:{identify:{map:{firstName:"user.firstName"}}},out:[["profilesApi.createOrUpdateProfile",{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r",firstName:"Jane"}}}],["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"page view"}}},properties:{},time:new Date(1700000104).toISOString()}}}]]},E={in:(0,I.getEvent)("newsletter signup",{timestamp:1700000105,user:{email:"subscriber@example.com"}}),settings:{externalId:void 0},out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"subscriber@example.com"}}},metric:{data:{type:"metric",attributes:{name:"newsletter signup"}}},properties:{},time:new Date(1700000105).toISOString()}}}]]},k={in:(0,I.getEvent)("debug noise",{timestamp:1700000106,user:{id:"us3r",email:"user@example.com"}}),mapping:{ignore:!0},out:[]};//# sourceMappingURL=dev.js.map

package/dist/dev.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dev.ts","../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/mapping.ts","../src/examples/index.ts","../src/examples/env.ts","../src/examples/step.ts"],"sourcesContent":["export * as schemas from './schemas';\nexport * as examples from './examples';\n","import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\nimport { MappingSchema } from './mapping';\n\nexport { SettingsSchema, type Settings } from './settings';\nexport { MappingSchema, type Mapping } from './mapping';\n\n// JSON Schema\nexport const settings = zodToSchema(SettingsSchema);\nexport const mapping = zodToSchema(MappingSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  apiKey: z\n    .string()\n    .min(1)\n    .describe(\n      'Klaviyo private API key. Starts with pk_. Find it under Settings > API Keys in your Klaviyo account.',\n    ),\n  email: z\n    .string()\n    .describe(\n      'walkerOS mapping value path to resolve email from each event (like user.email).',\n    )\n    .optional(),\n  phoneNumber: z\n    .string()\n    .describe(\n      'walkerOS mapping value path to resolve phone number in E.164 format from each event.',\n    )\n    .optional(),\n  externalId: z\n    .string()\n    .describe(\n      'walkerOS mapping value path to resolve external ID from each event (like user.id).',\n    )\n    .optional(),\n  identify: z\n    .unknown()\n    .describe(\n      'Destination-level identity mapping. Resolves to profile attributes { firstName?, lastName?, organization?, properties? }. Fires createOrUpdateProfile() on first push and re-fires when values change.',\n    )\n    .optional(),\n  currency: z\n    .string()\n    .length(3)\n    .describe(\n      'Default ISO 4217 currency code for revenue events (like USD, EUR). Sets valueCurrency on Klaviyo events.',\n    )\n    .optional(),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\nexport const MappingSchema = z.object({\n  identify: z\n    .unknown()\n    .describe(\n      'Per-event identify mapping. Resolves to profile attributes for createOrUpdateProfile(). Use with rule-level skip: true on login/signup events.',\n    )\n    .optional(),\n  value: z\n    .unknown()\n    .describe(\n      'Revenue value mapping. Resolves to a numeric value for Klaviyo revenue tracking. Sets the value property and valueCurrency on the event.',\n    )\n    .optional(),\n});\n\nexport type Mapping = z.infer<typeof MappingSchema>;\n","export * as env from './env';\nexport * as step from './step';\n","import type {\n  Env,\n  KlaviyoEventsApiMock,\n  KlaviyoProfilesApiMock,\n} from '../types';\n\nconst asyncNoop = () => Promise.resolve({});\n\nfunction createMockEventsApi(): KlaviyoEventsApiMock {\n  return {\n    createEvent: asyncNoop,\n  };\n}\n\nfunction createMockProfilesApi(): KlaviyoProfilesApiMock {\n  return {\n    createOrUpdateProfile: asyncNoop,\n  };\n}\n\nexport const push: Env = {\n  eventsApi: createMockEventsApi(),\n  profilesApi: createMockProfilesApi(),\n};\n\nexport const simulation = [\n  'call:eventsApi.createEvent',\n  'call:profilesApi.createOrUpdateProfile',\n];\n","import type { Flow } from '@walkeros/core';\nimport { getEvent } from '@walkeros/core';\nimport type { Settings } from '../types';\n\n/**\n * Klaviyo SDK step examples.\n *\n * At push time, the destination invokes the `klaviyo-api` SDK. The public\n * method paths users see on the client are:\n *\n *   - `eventsApi.createEvent(body)` — fires a metric event with inline profile\n *   - `profilesApi.createOrUpdateProfile(body)` — upserts a profile\n *\n * Each `out` is therefore `[['method.path', ...args], ...]` matching the\n * actual SDK call order. `identify` fires before the event. When the rule\n * uses `skip: true` or `ignore: true`, `out` is `[]` or the identify-only\n * list.\n */\n\n/**\n * Extended step example that may carry destination-level settings overrides.\n */\nexport type KlaviyoStepExample = Flow.StepExample & {\n  settings?: Partial<Settings>;\n};\n\n/**\n * Default event forwarding -- eventsApi.createEvent() with event name and\n * inline profile. Email resolved from default settings.email = 'user.email'.\n */\nexport const defaultEvent: KlaviyoStepExample = {\n  in: getEvent('product view', {\n    timestamp: 1700000100,\n    user: { id: 'us3r', email: 'user@example.com' },\n  }),\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'product view' },\n              },\n            },\n            properties: {},\n            time: new Date(1700000100).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Mapped event name -- mapping.name renames the event to Klaviyo's expected\n * metric name for ecommerce reporting.\n */\nexport const mappedEventName: KlaviyoStepExample = {\n  in: getEvent('product view', {\n    timestamp: 1700000101,\n    user: { id: 'us3r', email: 'user@example.com' },\n    data: {\n      name: 'USB Cable',\n      id: 'PROD-1',\n      price: 9.99,\n    },\n  }),\n  mapping: {\n    name: 'Viewed Product',\n    data: {\n      map: {\n        ProductName: 'data.name',\n        ProductID: 'data.id',\n        Price: 'data.price',\n      },\n    },\n  },\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'Viewed Product' },\n              },\n            },\n            properties: {\n              ProductName: 'USB Cable',\n              ProductID: 'PROD-1',\n              Price: 9.99,\n            },\n            time: new Date(1700000101).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Revenue event -- order complete with value mapping. Sets $value and\n * valueCurrency on the Klaviyo event for revenue tracking.\n */\nexport const revenueEvent: KlaviyoStepExample = {\n  in: getEvent('order complete', {\n    timestamp: 1700000102,\n    user: { id: 'us3r', email: 'user@example.com' },\n    data: {\n      id: 'ORD-123',\n      total: 99.99,\n      itemNames: ['Widget A', 'Widget B'],\n    },\n  }),\n  settings: {\n    currency: 'EUR',\n  },\n  mapping: {\n    name: 'Placed Order',\n    data: {\n      map: {\n        OrderId: 'data.id',\n        value: 'data.total',\n        ItemNames: 'data.itemNames',\n      },\n    },\n    settings: {\n      value: 'data.total',\n    },\n  },\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'Placed Order' },\n              },\n            },\n            properties: {\n              OrderId: 'ORD-123',\n              value: 99.99,\n              ItemNames: ['Widget A', 'Widget B'],\n            },\n            time: new Date(1700000102).toISOString(),\n            valueCurrency: 'EUR',\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Per-event identify with skip -- user login fires\n * profilesApi.createOrUpdateProfile() only, no event tracked.\n */\nexport const userLoginIdentify: KlaviyoStepExample = {\n  in: getEvent('user login', {\n    timestamp: 1700000103,\n    user: { id: 'us3r', email: 'user@acme.com' },\n    data: {\n      firstName: 'Jane',\n      lastName: 'Doe',\n      company: 'Acme Corp',\n      plan: 'premium',\n    },\n  }),\n  mapping: {\n    skip: true,\n    settings: {\n      identify: {\n        map: {\n          firstName: 'data.firstName',\n          lastName: 'data.lastName',\n          organization: 'data.company',\n          properties: {\n            map: {\n              plan: 'data.plan',\n            },\n          },\n        },\n      },\n    },\n  },\n  out: [\n    [\n      'profilesApi.createOrUpdateProfile',\n      {\n        data: {\n          type: 'profile',\n          attributes: {\n            email: 'user@acme.com',\n            externalId: 'us3r',\n            firstName: 'Jane',\n            lastName: 'Doe',\n            organization: 'Acme Corp',\n            properties: {\n              plan: 'premium',\n            },\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Destination-level identify -- fires profilesApi.createOrUpdateProfile()\n * on first push when settings.identify resolves, then fires createEvent().\n */\nexport const destinationIdentify: KlaviyoStepExample = {\n  in: getEvent('page view', {\n    timestamp: 1700000104,\n    user: { id: 'us3r', email: 'user@example.com', firstName: 'Jane' },\n  }),\n  settings: {\n    identify: {\n      map: {\n        firstName: 'user.firstName',\n      },\n    },\n  },\n  out: [\n    [\n      'profilesApi.createOrUpdateProfile',\n      {\n        data: {\n          type: 'profile',\n          attributes: {\n            email: 'user@example.com',\n            externalId: 'us3r',\n            firstName: 'Jane',\n          },\n        },\n      },\n    ],\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'page view' },\n              },\n            },\n            properties: {},\n            time: new Date(1700000104).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Email only -- no externalId. Klaviyo accepts email as sole identifier.\n */\nexport const emailOnly: KlaviyoStepExample = {\n  in: getEvent('newsletter signup', {\n    timestamp: 1700000105,\n    user: { email: 'subscriber@example.com' },\n  }),\n  settings: {\n    externalId: undefined,\n  },\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'subscriber@example.com',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'newsletter signup' },\n              },\n            },\n            properties: {},\n            time: new Date(1700000105).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Wildcard ignore -- the event matches a mapping rule with ignore: true.\n * The destination fires zero API calls.\n */\nexport const wildcardIgnored: KlaviyoStepExample = {\n  in: getEvent('debug noise', {\n    timestamp: 1700000106,\n    user: { id: 'us3r', email: 'user@example.com' },\n  }),\n  mapping: { ignore: true },\n  out: [],\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,cAA4B;;;ACA5B,iBAAkB;AAEX,IAAM,iBAAiB,aAAE,OAAO;AAAA,EACrC,QAAQ,aACL,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AAAA,EACF,OAAO,aACJ,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,aAAa,aACV,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,YAAY,aACT,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,UAAU,aACP,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,UAAU,aACP,OAAO,EACP,OAAO,CAAC,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;;;ACxCD,IAAAC,cAAkB;AAEX,IAAM,gBAAgB,cAAE,OAAO;AAAA,EACpC,UAAU,cACP,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,OAAO,cACJ,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;;;AFPM,IAAM,eAAW,yBAAY,cAAc;AAC3C,IAAM,cAAU,yBAAY,aAAa;;;AGThD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAMA,IAAM,YAAY,MAAM,QAAQ,QAAQ,CAAC,CAAC;AAE1C,SAAS,sBAA4C;AACnD,SAAO;AAAA,IACL,aAAa;AAAA,EACf;AACF;AAEA,SAAS,wBAAgD;AACvD,SAAO;AAAA,IACL,uBAAuB;AAAA,EACzB;AACF;AAEO,IAAM,OAAY;AAAA,EACvB,WAAW,oBAAoB;AAAA,EAC/B,aAAa,sBAAsB;AACrC;AAEO,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AACF;;;AC5BA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,kBAAyB;AA6BlB,IAAM,eAAmC;AAAA,EAC9C,QAAI,sBAAS,gBAAgB;AAAA,IAC3B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,EAChD,CAAC;AAAA,EACD,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,eAAe;AAAA,cACrC;AAAA,YACF;AAAA,YACA,YAAY,CAAC;AAAA,YACb,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,kBAAsC;AAAA,EACjD,QAAI,sBAAS,gBAAgB;AAAA,IAC3B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,IAC9C,MAAM;AAAA,MACJ,MAAM;AAAA,MACN,IAAI;AAAA,MACJ,OAAO;AAAA,IACT;AAAA,EACF,CAAC;AAAA,EACD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,aAAa;AAAA,QACb,WAAW;AAAA,QACX,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,iBAAiB;AAAA,cACvC;AAAA,YACF;AAAA,YACA,YAAY;AAAA,cACV,aAAa;AAAA,cACb,WAAW;AAAA,cACX,OAAO;AAAA,YACT;AAAA,YACA,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,eAAmC;AAAA,EAC9C,QAAI,sBAAS,kBAAkB;AAAA,IAC7B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,IAC9C,MAAM;AAAA,MACJ,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,WAAW,CAAC,YAAY,UAAU;AAAA,IACpC;AAAA,EACF,CAAC;AAAA,EACD,UAAU;AAAA,IACR,UAAU;AAAA,EACZ;AAAA,EACA,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,SAAS;AAAA,QACT,OAAO;AAAA,QACP,WAAW;AAAA,MACb;AAAA,IACF;AAAA,IACA,UAAU;AAAA,MACR,OAAO;AAAA,IACT;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,eAAe;AAAA,cACrC;AAAA,YACF;AAAA,YACA,YAAY;AAAA,cACV,SAAS;AAAA,cACT,OAAO;AAAA,cACP,WAAW,CAAC,YAAY,UAAU;AAAA,YACpC;AAAA,YACA,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,YACvC,eAAe;AAAA,UACjB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,oBAAwC;AAAA,EACnD,QAAI,sBAAS,cAAc;AAAA,IACzB,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,gBAAgB;AAAA,IAC3C,MAAM;AAAA,MACJ,WAAW;AAAA,MACX,UAAU;AAAA,MACV,SAAS;AAAA,MACT,MAAM;AAAA,IACR;AAAA,EACF,CAAC;AAAA,EACD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,MACR,UAAU;AAAA,QACR,KAAK;AAAA,UACH,WAAW;AAAA,UACX,UAAU;AAAA,UACV,cAAc;AAAA,UACd,YAAY;AAAA,YACV,KAAK;AAAA,cACH,MAAM;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,OAAO;AAAA,YACP,YAAY;AAAA,YACZ,WAAW;AAAA,YACX,UAAU;AAAA,YACV,cAAc;AAAA,YACd,YAAY;AAAA,cACV,MAAM;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,sBAA0C;AAAA,EACrD,QAAI,sBAAS,aAAa;AAAA,IACxB,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,oBAAoB,WAAW,OAAO;AAAA,EACnE,CAAC;AAAA,EACD,UAAU;AAAA,IACR,UAAU;AAAA,MACR,KAAK;AAAA,QACH,WAAW;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,OAAO;AAAA,YACP,YAAY;AAAA,YACZ,WAAW;AAAA,UACb;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,IACA;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,YAAY;AAAA,cAClC;AAAA,YACF;AAAA,YACA,YAAY,CAAC;AAAA,YACb,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAKO,IAAM,YAAgC;AAAA,EAC3C,QAAI,sBAAS,qBAAqB;AAAA,IAChC,WAAW;AAAA,IACX,MAAM,EAAE,OAAO,yBAAyB;AAAA,EAC1C,CAAC;AAAA,EACD,UAAU;AAAA,IACR,YAAY;AAAA,EACd;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,gBACT;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,oBAAoB;AAAA,cAC1C;AAAA,YACF;AAAA,YACA,YAAY,CAAC;AAAA,YACb,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,kBAAsC;AAAA,EACjD,QAAI,sBAAS,eAAe;AAAA,IAC1B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,EAChD,CAAC;AAAA,EACD,SAAS,EAAE,QAAQ,KAAK;AAAA,EACxB,KAAK,CAAC;AACR;","names":["import_dev","import_dev"]}

package/dist/dev.mjs

@@ -0,0 +1 @@
+var e=Object.defineProperty,t=(t,a)=>{for(var r in a)e(t,r,{get:a[r],enumerable:!0})},a={};t(a,{MappingSchema:()=>p,SettingsSchema:()=>n,mapping:()=>m,settings:()=>o});import{zodToSchema as r}from"@walkeros/core/dev";import{z as i}from"@walkeros/core/dev";var n=i.object({apiKey:i.string().min(1).describe("Klaviyo private API key. Starts with pk_. Find it under Settings > API Keys in your Klaviyo account."),email:i.string().describe("walkerOS mapping value path to resolve email from each event (like user.email).").optional(),phoneNumber:i.string().describe("walkerOS mapping value path to resolve phone number in E.164 format from each event.").optional(),externalId:i.string().describe("walkerOS mapping value path to resolve external ID from each event (like user.id).").optional(),identify:i.unknown().describe("Destination-level identity mapping. Resolves to profile attributes { firstName?, lastName?, organization?, properties? }. Fires createOrUpdateProfile() on first push and re-fires when values change.").optional(),currency:i.string().length(3).describe("Default ISO 4217 currency code for revenue events (like USD, EUR). Sets valueCurrency on Klaviyo events.").optional()});import{z as s}from"@walkeros/core/dev";var p=s.object({identify:s.unknown().describe("Per-event identify mapping. Resolves to profile attributes for createOrUpdateProfile(). Use with rule-level skip: true on login/signup events.").optional(),value:s.unknown().describe("Revenue value mapping. Resolves to a numeric value for Klaviyo revenue tracking. Sets the value property and valueCurrency on the event.").optional()}),o=r(n),m=r(p),l={};t(l,{env:()=>u,step:()=>f});var u={};t(u,{push:()=>c,simulation:()=>v});var d=()=>Promise.resolve({});var c={eventsApi:{createEvent:d},profilesApi:{createOrUpdateProfile:d}},v=["call:eventsApi.createEvent","call:profilesApi.createOrUpdateProfile"],f={};t(f,{defaultEvent:()=>y,destinationIdentify:()=>O,emailOnly:()=>S,mappedEventName:()=>b,revenueEvent:()=>w,userLoginIdentify:()=>I,wildcardIgnored:()=>x});import{getEvent as g}from"@walkeros/core";var y={in:g("product view",{timestamp:1700000100,user:{id:"us3r",email:"user@example.com"}}),out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"product view"}}},properties:{},time:new Date(1700000100).toISOString()}}}]]},b={in:g("product view",{timestamp:1700000101,user:{id:"us3r",email:"user@example.com"},data:{name:"USB Cable",id:"PROD-1",price:9.99}}),mapping:{name:"Viewed Product",data:{map:{ProductName:"data.name",ProductID:"data.id",Price:"data.price"}}},out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"Viewed Product"}}},properties:{ProductName:"USB Cable",ProductID:"PROD-1",Price:9.99},time:new Date(1700000101).toISOString()}}}]]},w={in:g("order complete",{timestamp:1700000102,user:{id:"us3r",email:"user@example.com"},data:{id:"ORD-123",total:99.99,itemNames:["Widget A","Widget B"]}}),settings:{currency:"EUR"},mapping:{name:"Placed Order",data:{map:{OrderId:"data.id",value:"data.total",ItemNames:"data.itemNames"}},settings:{value:"data.total"}},out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"Placed Order"}}},properties:{OrderId:"ORD-123",value:99.99,ItemNames:["Widget A","Widget B"]},time:new Date(1700000102).toISOString(),valueCurrency:"EUR"}}}]]},I={in:g("user login",{timestamp:1700000103,user:{id:"us3r",email:"user@acme.com"},data:{firstName:"Jane",lastName:"Doe",company:"Acme Corp",plan:"premium"}}),mapping:{skip:!0,settings:{identify:{map:{firstName:"data.firstName",lastName:"data.lastName",organization:"data.company",properties:{map:{plan:"data.plan"}}}}}},out:[["profilesApi.createOrUpdateProfile",{data:{type:"profile",attributes:{email:"user@acme.com",externalId:"us3r",firstName:"Jane",lastName:"Doe",organization:"Acme Corp",properties:{plan:"premium"}}}}]]},O={in:g("page view",{timestamp:1700000104,user:{id:"us3r",email:"user@example.com",firstName:"Jane"}}),settings:{identify:{map:{firstName:"user.firstName"}}},out:[["profilesApi.createOrUpdateProfile",{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r",firstName:"Jane"}}}],["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"user@example.com",externalId:"us3r"}}},metric:{data:{type:"metric",attributes:{name:"page view"}}},properties:{},time:new Date(1700000104).toISOString()}}}]]},S={in:g("newsletter signup",{timestamp:1700000105,user:{email:"subscriber@example.com"}}),settings:{externalId:void 0},out:[["eventsApi.createEvent",{data:{type:"event",attributes:{profile:{data:{type:"profile",attributes:{email:"subscriber@example.com"}}},metric:{data:{type:"metric",attributes:{name:"newsletter signup"}}},properties:{},time:new Date(1700000105).toISOString()}}}]]},x={in:g("debug noise",{timestamp:1700000106,user:{id:"us3r",email:"user@example.com"}}),mapping:{ignore:!0},out:[]};export{l as examples,a as schemas};//# sourceMappingURL=dev.mjs.map

package/dist/dev.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/mapping.ts","../src/examples/index.ts","../src/examples/env.ts","../src/examples/step.ts"],"sourcesContent":["import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\nimport { MappingSchema } from './mapping';\n\nexport { SettingsSchema, type Settings } from './settings';\nexport { MappingSchema, type Mapping } from './mapping';\n\n// JSON Schema\nexport const settings = zodToSchema(SettingsSchema);\nexport const mapping = zodToSchema(MappingSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  apiKey: z\n    .string()\n    .min(1)\n    .describe(\n      'Klaviyo private API key. Starts with pk_. Find it under Settings > API Keys in your Klaviyo account.',\n    ),\n  email: z\n    .string()\n    .describe(\n      'walkerOS mapping value path to resolve email from each event (like user.email).',\n    )\n    .optional(),\n  phoneNumber: z\n    .string()\n    .describe(\n      'walkerOS mapping value path to resolve phone number in E.164 format from each event.',\n    )\n    .optional(),\n  externalId: z\n    .string()\n    .describe(\n      'walkerOS mapping value path to resolve external ID from each event (like user.id).',\n    )\n    .optional(),\n  identify: z\n    .unknown()\n    .describe(\n      'Destination-level identity mapping. Resolves to profile attributes { firstName?, lastName?, organization?, properties? }. Fires createOrUpdateProfile() on first push and re-fires when values change.',\n    )\n    .optional(),\n  currency: z\n    .string()\n    .length(3)\n    .describe(\n      'Default ISO 4217 currency code for revenue events (like USD, EUR). Sets valueCurrency on Klaviyo events.',\n    )\n    .optional(),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\nexport const MappingSchema = z.object({\n  identify: z\n    .unknown()\n    .describe(\n      'Per-event identify mapping. Resolves to profile attributes for createOrUpdateProfile(). Use with rule-level skip: true on login/signup events.',\n    )\n    .optional(),\n  value: z\n    .unknown()\n    .describe(\n      'Revenue value mapping. Resolves to a numeric value for Klaviyo revenue tracking. Sets the value property and valueCurrency on the event.',\n    )\n    .optional(),\n});\n\nexport type Mapping = z.infer<typeof MappingSchema>;\n","export * as env from './env';\nexport * as step from './step';\n","import type {\n  Env,\n  KlaviyoEventsApiMock,\n  KlaviyoProfilesApiMock,\n} from '../types';\n\nconst asyncNoop = () => Promise.resolve({});\n\nfunction createMockEventsApi(): KlaviyoEventsApiMock {\n  return {\n    createEvent: asyncNoop,\n  };\n}\n\nfunction createMockProfilesApi(): KlaviyoProfilesApiMock {\n  return {\n    createOrUpdateProfile: asyncNoop,\n  };\n}\n\nexport const push: Env = {\n  eventsApi: createMockEventsApi(),\n  profilesApi: createMockProfilesApi(),\n};\n\nexport const simulation = [\n  'call:eventsApi.createEvent',\n  'call:profilesApi.createOrUpdateProfile',\n];\n","import type { Flow } from '@walkeros/core';\nimport { getEvent } from '@walkeros/core';\nimport type { Settings } from '../types';\n\n/**\n * Klaviyo SDK step examples.\n *\n * At push time, the destination invokes the `klaviyo-api` SDK. The public\n * method paths users see on the client are:\n *\n *   - `eventsApi.createEvent(body)` — fires a metric event with inline profile\n *   - `profilesApi.createOrUpdateProfile(body)` — upserts a profile\n *\n * Each `out` is therefore `[['method.path', ...args], ...]` matching the\n * actual SDK call order. `identify` fires before the event. When the rule\n * uses `skip: true` or `ignore: true`, `out` is `[]` or the identify-only\n * list.\n */\n\n/**\n * Extended step example that may carry destination-level settings overrides.\n */\nexport type KlaviyoStepExample = Flow.StepExample & {\n  settings?: Partial<Settings>;\n};\n\n/**\n * Default event forwarding -- eventsApi.createEvent() with event name and\n * inline profile. Email resolved from default settings.email = 'user.email'.\n */\nexport const defaultEvent: KlaviyoStepExample = {\n  in: getEvent('product view', {\n    timestamp: 1700000100,\n    user: { id: 'us3r', email: 'user@example.com' },\n  }),\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'product view' },\n              },\n            },\n            properties: {},\n            time: new Date(1700000100).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Mapped event name -- mapping.name renames the event to Klaviyo's expected\n * metric name for ecommerce reporting.\n */\nexport const mappedEventName: KlaviyoStepExample = {\n  in: getEvent('product view', {\n    timestamp: 1700000101,\n    user: { id: 'us3r', email: 'user@example.com' },\n    data: {\n      name: 'USB Cable',\n      id: 'PROD-1',\n      price: 9.99,\n    },\n  }),\n  mapping: {\n    name: 'Viewed Product',\n    data: {\n      map: {\n        ProductName: 'data.name',\n        ProductID: 'data.id',\n        Price: 'data.price',\n      },\n    },\n  },\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'Viewed Product' },\n              },\n            },\n            properties: {\n              ProductName: 'USB Cable',\n              ProductID: 'PROD-1',\n              Price: 9.99,\n            },\n            time: new Date(1700000101).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Revenue event -- order complete with value mapping. Sets $value and\n * valueCurrency on the Klaviyo event for revenue tracking.\n */\nexport const revenueEvent: KlaviyoStepExample = {\n  in: getEvent('order complete', {\n    timestamp: 1700000102,\n    user: { id: 'us3r', email: 'user@example.com' },\n    data: {\n      id: 'ORD-123',\n      total: 99.99,\n      itemNames: ['Widget A', 'Widget B'],\n    },\n  }),\n  settings: {\n    currency: 'EUR',\n  },\n  mapping: {\n    name: 'Placed Order',\n    data: {\n      map: {\n        OrderId: 'data.id',\n        value: 'data.total',\n        ItemNames: 'data.itemNames',\n      },\n    },\n    settings: {\n      value: 'data.total',\n    },\n  },\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'Placed Order' },\n              },\n            },\n            properties: {\n              OrderId: 'ORD-123',\n              value: 99.99,\n              ItemNames: ['Widget A', 'Widget B'],\n            },\n            time: new Date(1700000102).toISOString(),\n            valueCurrency: 'EUR',\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Per-event identify with skip -- user login fires\n * profilesApi.createOrUpdateProfile() only, no event tracked.\n */\nexport const userLoginIdentify: KlaviyoStepExample = {\n  in: getEvent('user login', {\n    timestamp: 1700000103,\n    user: { id: 'us3r', email: 'user@acme.com' },\n    data: {\n      firstName: 'Jane',\n      lastName: 'Doe',\n      company: 'Acme Corp',\n      plan: 'premium',\n    },\n  }),\n  mapping: {\n    skip: true,\n    settings: {\n      identify: {\n        map: {\n          firstName: 'data.firstName',\n          lastName: 'data.lastName',\n          organization: 'data.company',\n          properties: {\n            map: {\n              plan: 'data.plan',\n            },\n          },\n        },\n      },\n    },\n  },\n  out: [\n    [\n      'profilesApi.createOrUpdateProfile',\n      {\n        data: {\n          type: 'profile',\n          attributes: {\n            email: 'user@acme.com',\n            externalId: 'us3r',\n            firstName: 'Jane',\n            lastName: 'Doe',\n            organization: 'Acme Corp',\n            properties: {\n              plan: 'premium',\n            },\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Destination-level identify -- fires profilesApi.createOrUpdateProfile()\n * on first push when settings.identify resolves, then fires createEvent().\n */\nexport const destinationIdentify: KlaviyoStepExample = {\n  in: getEvent('page view', {\n    timestamp: 1700000104,\n    user: { id: 'us3r', email: 'user@example.com', firstName: 'Jane' },\n  }),\n  settings: {\n    identify: {\n      map: {\n        firstName: 'user.firstName',\n      },\n    },\n  },\n  out: [\n    [\n      'profilesApi.createOrUpdateProfile',\n      {\n        data: {\n          type: 'profile',\n          attributes: {\n            email: 'user@example.com',\n            externalId: 'us3r',\n            firstName: 'Jane',\n          },\n        },\n      },\n    ],\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'user@example.com',\n                  externalId: 'us3r',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'page view' },\n              },\n            },\n            properties: {},\n            time: new Date(1700000104).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Email only -- no externalId. Klaviyo accepts email as sole identifier.\n */\nexport const emailOnly: KlaviyoStepExample = {\n  in: getEvent('newsletter signup', {\n    timestamp: 1700000105,\n    user: { email: 'subscriber@example.com' },\n  }),\n  settings: {\n    externalId: undefined,\n  },\n  out: [\n    [\n      'eventsApi.createEvent',\n      {\n        data: {\n          type: 'event',\n          attributes: {\n            profile: {\n              data: {\n                type: 'profile',\n                attributes: {\n                  email: 'subscriber@example.com',\n                },\n              },\n            },\n            metric: {\n              data: {\n                type: 'metric',\n                attributes: { name: 'newsletter signup' },\n              },\n            },\n            properties: {},\n            time: new Date(1700000105).toISOString(),\n          },\n        },\n      },\n    ],\n  ],\n};\n\n/**\n * Wildcard ignore -- the event matches a mapping rule with ignore: true.\n * The destination fires zero API calls.\n */\nexport const wildcardIgnored: KlaviyoStepExample = {\n  in: getEvent('debug noise', {\n    timestamp: 1700000106,\n    user: { id: 'us3r', email: 'user@example.com' },\n  }),\n  mapping: { ignore: true },\n  out: [],\n};\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;;;ACA5B,SAAS,SAAS;AAEX,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,QAAQ,EACL,OAAO,EACP,IAAI,CAAC,EACL;AAAA,IACC;AAAA,EACF;AAAA,EACF,OAAO,EACJ,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,aAAa,EACV,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,YAAY,EACT,OAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,UAAU,EACP,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,UAAU,EACP,OAAO,EACP,OAAO,CAAC,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;;;ACxCD,SAAS,KAAAA,UAAS;AAEX,IAAM,gBAAgBA,GAAE,OAAO;AAAA,EACpC,UAAUA,GACP,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,OAAOA,GACJ,QAAQ,EACR;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;;;AFPM,IAAM,WAAW,YAAY,cAAc;AAC3C,IAAM,UAAU,YAAY,aAAa;;;AGThD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAMA,IAAM,YAAY,MAAM,QAAQ,QAAQ,CAAC,CAAC;AAE1C,SAAS,sBAA4C;AACnD,SAAO;AAAA,IACL,aAAa;AAAA,EACf;AACF;AAEA,SAAS,wBAAgD;AACvD,SAAO;AAAA,IACL,uBAAuB;AAAA,EACzB;AACF;AAEO,IAAM,OAAY;AAAA,EACvB,WAAW,oBAAoB;AAAA,EAC/B,aAAa,sBAAsB;AACrC;AAEO,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AACF;;;AC5BA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,SAAS,gBAAgB;AA6BlB,IAAM,eAAmC;AAAA,EAC9C,IAAI,SAAS,gBAAgB;AAAA,IAC3B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,EAChD,CAAC;AAAA,EACD,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,eAAe;AAAA,cACrC;AAAA,YACF;AAAA,YACA,YAAY,CAAC;AAAA,YACb,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,kBAAsC;AAAA,EACjD,IAAI,SAAS,gBAAgB;AAAA,IAC3B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,IAC9C,MAAM;AAAA,MACJ,MAAM;AAAA,MACN,IAAI;AAAA,MACJ,OAAO;AAAA,IACT;AAAA,EACF,CAAC;AAAA,EACD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,aAAa;AAAA,QACb,WAAW;AAAA,QACX,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,iBAAiB;AAAA,cACvC;AAAA,YACF;AAAA,YACA,YAAY;AAAA,cACV,aAAa;AAAA,cACb,WAAW;AAAA,cACX,OAAO;AAAA,YACT;AAAA,YACA,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,eAAmC;AAAA,EAC9C,IAAI,SAAS,kBAAkB;AAAA,IAC7B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,IAC9C,MAAM;AAAA,MACJ,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,WAAW,CAAC,YAAY,UAAU;AAAA,IACpC;AAAA,EACF,CAAC;AAAA,EACD,UAAU;AAAA,IACR,UAAU;AAAA,EACZ;AAAA,EACA,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,SAAS;AAAA,QACT,OAAO;AAAA,QACP,WAAW;AAAA,MACb;AAAA,IACF;AAAA,IACA,UAAU;AAAA,MACR,OAAO;AAAA,IACT;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,eAAe;AAAA,cACrC;AAAA,YACF;AAAA,YACA,YAAY;AAAA,cACV,SAAS;AAAA,cACT,OAAO;AAAA,cACP,WAAW,CAAC,YAAY,UAAU;AAAA,YACpC;AAAA,YACA,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,YACvC,eAAe;AAAA,UACjB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,oBAAwC;AAAA,EACnD,IAAI,SAAS,cAAc;AAAA,IACzB,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,gBAAgB;AAAA,IAC3C,MAAM;AAAA,MACJ,WAAW;AAAA,MACX,UAAU;AAAA,MACV,SAAS;AAAA,MACT,MAAM;AAAA,IACR;AAAA,EACF,CAAC;AAAA,EACD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,UAAU;AAAA,MACR,UAAU;AAAA,QACR,KAAK;AAAA,UACH,WAAW;AAAA,UACX,UAAU;AAAA,UACV,cAAc;AAAA,UACd,YAAY;AAAA,YACV,KAAK;AAAA,cACH,MAAM;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,OAAO;AAAA,YACP,YAAY;AAAA,YACZ,WAAW;AAAA,YACX,UAAU;AAAA,YACV,cAAc;AAAA,YACd,YAAY;AAAA,cACV,MAAM;AAAA,YACR;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,sBAA0C;AAAA,EACrD,IAAI,SAAS,aAAa;AAAA,IACxB,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,oBAAoB,WAAW,OAAO;AAAA,EACnE,CAAC;AAAA,EACD,UAAU;AAAA,IACR,UAAU;AAAA,MACR,KAAK;AAAA,QACH,WAAW;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,OAAO;AAAA,YACP,YAAY;AAAA,YACZ,WAAW;AAAA,UACb;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,IACA;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,kBACP,YAAY;AAAA,gBACd;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,YAAY;AAAA,cAClC;AAAA,YACF;AAAA,YACA,YAAY,CAAC;AAAA,YACb,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAKO,IAAM,YAAgC;AAAA,EAC3C,IAAI,SAAS,qBAAqB;AAAA,IAChC,WAAW;AAAA,IACX,MAAM,EAAE,OAAO,yBAAyB;AAAA,EAC1C,CAAC;AAAA,EACD,UAAU;AAAA,IACR,YAAY;AAAA,EACd;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,YAAY;AAAA,YACV,SAAS;AAAA,cACP,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,OAAO;AAAA,gBACT;AAAA,cACF;AAAA,YACF;AAAA,YACA,QAAQ;AAAA,cACN,MAAM;AAAA,gBACJ,MAAM;AAAA,gBACN,YAAY,EAAE,MAAM,oBAAoB;AAAA,cAC1C;AAAA,YACF;AAAA,YACA,YAAY,CAAC;AAAA,YACb,OAAM,oBAAI,KAAK,UAAU,GAAE,YAAY;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMO,IAAM,kBAAsC;AAAA,EACjD,IAAI,SAAS,eAAe;AAAA,IAC1B,WAAW;AAAA,IACX,MAAM,EAAE,IAAI,QAAQ,OAAO,mBAAmB;AAAA,EAChD,CAAC;AAAA,EACD,SAAS,EAAE,QAAQ,KAAK;AAAA,EACxB,KAAK,CAAC;AACR;","names":["z"]}

package/dist/examples/index.d.mts

@@ -0,0 +1,128 @@
+import { Mapping, Flow } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+interface Settings {
+    /** Klaviyo private API key (required). Starts with 'pk_'. */
+    apiKey: string;
+    /** walkerOS mapping value path to resolve email from each event. */
+    email?: string;
+    /** walkerOS mapping value path to resolve phone number (E.164) from each event. */
+    phoneNumber?: string;
+    /** walkerOS mapping value path to resolve external ID from each event. */
+    externalId?: string;
+    /** Destination-level identify mapping. Resolves to profile attributes for upsert. */
+    identify?: Mapping.Value;
+    /** Default currency for revenue events (ISO 4217, e.g. 'USD', 'EUR'). */
+    currency?: string;
+    /** Runtime state -- not user-facing. Mutated by init/push. */
+    _eventsApi?: KlaviyoEventsApiMock;
+    _profilesApi?: KlaviyoProfilesApiMock;
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    lastIdentity?: {
+        email?: string;
+        externalId?: string;
+        phoneNumber?: string;
+        traitsHash?: string;
+    };
+}
+/**
+ * Env -- optional SDK override. Production leaves this undefined and the
+ * destination creates real API instances. Tests provide mocks via
+ * env.eventsApi and env.profilesApi.
+ */
+interface Env extends DestinationServer.Env {
+    eventsApi?: KlaviyoEventsApiMock;
+    profilesApi?: KlaviyoProfilesApiMock;
+}
+/**
+ * Mock-friendly interface for EventsApi.createEvent().
+ */
+interface KlaviyoEventsApiMock {
+    createEvent: (body: Record<string, unknown>) => Promise<unknown>;
+}
+/**
+ * Mock-friendly interface for ProfilesApi.createOrUpdateProfile().
+ */
+interface KlaviyoProfilesApiMock {
+    createOrUpdateProfile: (body: Record<string, unknown>) => Promise<unknown>;
+}
+
+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 };
+}
+
+/**
+ * Klaviyo SDK step examples.
+ *
+ * At push time, the destination invokes the `klaviyo-api` SDK. The public
+ * method paths users see on the client are:
+ *
+ *   - `eventsApi.createEvent(body)` — fires a metric event with inline profile
+ *   - `profilesApi.createOrUpdateProfile(body)` — upserts a profile
+ *
+ * Each `out` is therefore `[['method.path', ...args], ...]` matching the
+ * actual SDK call order. `identify` fires before the event. When the rule
+ * uses `skip: true` or `ignore: true`, `out` is `[]` or the identify-only
+ * list.
+ */
+/**
+ * Extended step example that may carry destination-level settings overrides.
+ */
+type KlaviyoStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+};
+/**
+ * Default event forwarding -- eventsApi.createEvent() with event name and
+ * inline profile. Email resolved from default settings.email = 'user.email'.
+ */
+declare const defaultEvent: KlaviyoStepExample;
+/**
+ * Mapped event name -- mapping.name renames the event to Klaviyo's expected
+ * metric name for ecommerce reporting.
+ */
+declare const mappedEventName: KlaviyoStepExample;
+/**
+ * Revenue event -- order complete with value mapping. Sets $value and
+ * valueCurrency on the Klaviyo event for revenue tracking.
+ */
+declare const revenueEvent: KlaviyoStepExample;
+/**
+ * Per-event identify with skip -- user login fires
+ * profilesApi.createOrUpdateProfile() only, no event tracked.
+ */
+declare const userLoginIdentify: KlaviyoStepExample;
+/**
+ * Destination-level identify -- fires profilesApi.createOrUpdateProfile()
+ * on first push when settings.identify resolves, then fires createEvent().
+ */
+declare const destinationIdentify: KlaviyoStepExample;
+/**
+ * Email only -- no externalId. Klaviyo accepts email as sole identifier.
+ */
+declare const emailOnly: KlaviyoStepExample;
+/**
+ * Wildcard ignore -- the event matches a mapping rule with ignore: true.
+ * The destination fires zero API calls.
+ */
+declare const wildcardIgnored: KlaviyoStepExample;
+
+type step_KlaviyoStepExample = KlaviyoStepExample;
+declare const step_defaultEvent: typeof defaultEvent;
+declare const step_destinationIdentify: typeof destinationIdentify;
+declare const step_emailOnly: typeof emailOnly;
+declare const step_mappedEventName: typeof mappedEventName;
+declare const step_revenueEvent: typeof revenueEvent;
+declare const step_userLoginIdentify: typeof userLoginIdentify;
+declare const step_wildcardIgnored: typeof wildcardIgnored;
+declare namespace step {
+  export { type step_KlaviyoStepExample as KlaviyoStepExample, step_defaultEvent as defaultEvent, step_destinationIdentify as destinationIdentify, step_emailOnly as emailOnly, step_mappedEventName as mappedEventName, step_revenueEvent as revenueEvent, step_userLoginIdentify as userLoginIdentify, step_wildcardIgnored as wildcardIgnored };
+}
+
+export { env, step };