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

package/dist/examples/index.js

@@ -0,0 +1,295 @@
+"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 mockSendServer = async () => ({
+  ok: true,
+  data: {
+    status: "OK",
+    request_id: "mock-123"
+  }
+});
+var push = {
+  sendServer: mockSendServer
+};
+var simulation = ["sendServer"];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  addToCart: () => addToCart,
+  lead: () => lead,
+  pageView: () => pageView,
+  purchase: () => purchase
+});
+var import_core = require("@walkeros/core");
+var ENDPOINT = "https://tr.snapchat.com/v3/p1x3l1d/events?access_token=s3cr3t";
+var purchase = {
+  in: (0, import_core.getEvent)("order complete", {
+    timestamp: 17000009e5,
+    data: { id: "ORD-300", total: 249.99, currency: "EUR" },
+    nested: [
+      {
+        entity: "product",
+        data: { id: "SKU-A1", name: "Widget Pro", price: 124.99, quantity: 2 }
+      }
+    ],
+    user: { id: "user-123", device: "device-456" },
+    source: {
+      type: "server",
+      id: "https://shop.example.com/checkout/complete",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "PURCHASE",
+    data: {
+      map: {
+        custom_data: {
+          map: {
+            value: "data.total",
+            currency: { key: "data.currency", value: "EUR" },
+            transaction_id: "data.id",
+            contents: {
+              loop: [
+                "nested",
+                {
+                  condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+                  map: {
+                    id: "data.id",
+                    item_price: "data.price",
+                    quantity: { key: "data.quantity", value: 1 }
+                  }
+                }
+              ]
+            }
+          }
+        },
+        user_data: {
+          map: {
+            external_id: "user.id"
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "PURCHASE",
+            event_time: 1700000900,
+            action_source: "WEB",
+            event_id: "1700000900000-gr0up-1",
+            user_data: {
+              external_id: "fcdec6df4d44dbc637c7c5b58efface52a7f8a88535423430255be0bb89bedd8"
+            },
+            custom_data: {
+              value: 249.99,
+              currency: "EUR",
+              transaction_id: "ORD-300",
+              contents: [{ id: "SKU-A1", item_price: 124.99, quantity: 2 }]
+            },
+            event_source_url: "https://shop.example.com/checkout/complete"
+          }
+        ]
+      })
+    ]
+  ]
+};
+var addToCart = {
+  in: (0, import_core.getEvent)("product add", {
+    timestamp: 1700000901e3,
+    data: {
+      id: "SKU-B2",
+      name: "Running Shoes",
+      price: 89.99,
+      color: "blue"
+    },
+    nested: [
+      {
+        entity: "product",
+        data: {
+          id: "SKU-B2",
+          name: "Running Shoes",
+          price: 89.99,
+          quantity: 1
+        }
+      }
+    ],
+    source: {
+      type: "server",
+      id: "https://shop.example.com/products/running-shoes",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "ADD_CART",
+    data: {
+      map: {
+        custom_data: {
+          map: {
+            value: "data.price",
+            currency: { value: "EUR" },
+            contents: {
+              loop: [
+                "nested",
+                {
+                  condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+                  map: {
+                    id: "data.id",
+                    item_price: "data.price",
+                    quantity: { key: "data.quantity", value: 1 }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "ADD_CART",
+            event_time: 1700000901,
+            action_source: "WEB",
+            event_id: "1700000901000-gr0up-1",
+            user_data: {},
+            custom_data: {
+              value: 89.99,
+              currency: "EUR",
+              contents: [{ id: "SKU-B2", item_price: 89.99, quantity: 1 }]
+            },
+            event_source_url: "https://shop.example.com/products/running-shoes"
+          }
+        ]
+      })
+    ]
+  ]
+};
+var pageView = {
+  in: (0, import_core.getEvent)("page view", {
+    timestamp: 1700000902e3,
+    source: {
+      type: "server",
+      id: "https://example.com/docs/",
+      previous_id: ""
+    }
+  }),
+  mapping: void 0,
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "page view",
+            event_time: 1700000902,
+            action_source: "WEB",
+            event_id: "1700000902000-gr0up-1",
+            user_data: {},
+            custom_data: {},
+            event_source_url: "https://example.com/docs/"
+          }
+        ]
+      })
+    ]
+  ]
+};
+var lead = {
+  in: (0, import_core.getEvent)("form submit", {
+    timestamp: 1700000903e3,
+    data: { type: "newsletter" },
+    user: { email: "user@example.com" },
+    source: {
+      type: "server",
+      id: "https://example.com/contact",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "SIGN_UP",
+    data: {
+      map: {
+        user_data: {
+          map: {
+            em: "user.email"
+          }
+        },
+        custom_data: {
+          map: {
+            sign_up_method: { value: "newsletter" }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "SIGN_UP",
+            event_time: 1700000903,
+            action_source: "WEB",
+            event_id: "1700000903000-gr0up-1",
+            user_data: {
+              // sha256('user@example.com')
+              em: "b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514"
+            },
+            custom_data: {
+              sign_up_method: "newsletter"
+            },
+            event_source_url: "https://example.com/contact"
+          }
+        ]
+      })
+    ]
+  ]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});

package/dist/examples/index.mjs

@@ -0,0 +1,273 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  push: () => push,
+  simulation: () => simulation
+});
+var mockSendServer = async () => ({
+  ok: true,
+  data: {
+    status: "OK",
+    request_id: "mock-123"
+  }
+});
+var push = {
+  sendServer: mockSendServer
+};
+var simulation = ["sendServer"];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  addToCart: () => addToCart,
+  lead: () => lead,
+  pageView: () => pageView,
+  purchase: () => purchase
+});
+import { getEvent, isObject } from "@walkeros/core";
+var ENDPOINT = "https://tr.snapchat.com/v3/p1x3l1d/events?access_token=s3cr3t";
+var purchase = {
+  in: getEvent("order complete", {
+    timestamp: 17000009e5,
+    data: { id: "ORD-300", total: 249.99, currency: "EUR" },
+    nested: [
+      {
+        entity: "product",
+        data: { id: "SKU-A1", name: "Widget Pro", price: 124.99, quantity: 2 }
+      }
+    ],
+    user: { id: "user-123", device: "device-456" },
+    source: {
+      type: "server",
+      id: "https://shop.example.com/checkout/complete",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "PURCHASE",
+    data: {
+      map: {
+        custom_data: {
+          map: {
+            value: "data.total",
+            currency: { key: "data.currency", value: "EUR" },
+            transaction_id: "data.id",
+            contents: {
+              loop: [
+                "nested",
+                {
+                  condition: (entity) => isObject(entity) && entity.entity === "product",
+                  map: {
+                    id: "data.id",
+                    item_price: "data.price",
+                    quantity: { key: "data.quantity", value: 1 }
+                  }
+                }
+              ]
+            }
+          }
+        },
+        user_data: {
+          map: {
+            external_id: "user.id"
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "PURCHASE",
+            event_time: 1700000900,
+            action_source: "WEB",
+            event_id: "1700000900000-gr0up-1",
+            user_data: {
+              external_id: "fcdec6df4d44dbc637c7c5b58efface52a7f8a88535423430255be0bb89bedd8"
+            },
+            custom_data: {
+              value: 249.99,
+              currency: "EUR",
+              transaction_id: "ORD-300",
+              contents: [{ id: "SKU-A1", item_price: 124.99, quantity: 2 }]
+            },
+            event_source_url: "https://shop.example.com/checkout/complete"
+          }
+        ]
+      })
+    ]
+  ]
+};
+var addToCart = {
+  in: getEvent("product add", {
+    timestamp: 1700000901e3,
+    data: {
+      id: "SKU-B2",
+      name: "Running Shoes",
+      price: 89.99,
+      color: "blue"
+    },
+    nested: [
+      {
+        entity: "product",
+        data: {
+          id: "SKU-B2",
+          name: "Running Shoes",
+          price: 89.99,
+          quantity: 1
+        }
+      }
+    ],
+    source: {
+      type: "server",
+      id: "https://shop.example.com/products/running-shoes",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "ADD_CART",
+    data: {
+      map: {
+        custom_data: {
+          map: {
+            value: "data.price",
+            currency: { value: "EUR" },
+            contents: {
+              loop: [
+                "nested",
+                {
+                  condition: (entity) => isObject(entity) && entity.entity === "product",
+                  map: {
+                    id: "data.id",
+                    item_price: "data.price",
+                    quantity: { key: "data.quantity", value: 1 }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "ADD_CART",
+            event_time: 1700000901,
+            action_source: "WEB",
+            event_id: "1700000901000-gr0up-1",
+            user_data: {},
+            custom_data: {
+              value: 89.99,
+              currency: "EUR",
+              contents: [{ id: "SKU-B2", item_price: 89.99, quantity: 1 }]
+            },
+            event_source_url: "https://shop.example.com/products/running-shoes"
+          }
+        ]
+      })
+    ]
+  ]
+};
+var pageView = {
+  in: getEvent("page view", {
+    timestamp: 1700000902e3,
+    source: {
+      type: "server",
+      id: "https://example.com/docs/",
+      previous_id: ""
+    }
+  }),
+  mapping: void 0,
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "page view",
+            event_time: 1700000902,
+            action_source: "WEB",
+            event_id: "1700000902000-gr0up-1",
+            user_data: {},
+            custom_data: {},
+            event_source_url: "https://example.com/docs/"
+          }
+        ]
+      })
+    ]
+  ]
+};
+var lead = {
+  in: getEvent("form submit", {
+    timestamp: 1700000903e3,
+    data: { type: "newsletter" },
+    user: { email: "user@example.com" },
+    source: {
+      type: "server",
+      id: "https://example.com/contact",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "SIGN_UP",
+    data: {
+      map: {
+        user_data: {
+          map: {
+            em: "user.email"
+          }
+        },
+        custom_data: {
+          map: {
+            sign_up_method: { value: "newsletter" }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        data: [
+          {
+            event_name: "SIGN_UP",
+            event_time: 1700000903,
+            action_source: "WEB",
+            event_id: "1700000903000-gr0up-1",
+            user_data: {
+              // sha256('user@example.com')
+              em: "b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514"
+            },
+            custom_data: {
+              sign_up_method: "newsletter"
+            },
+            event_source_url: "https://example.com/contact"
+          }
+        ]
+      })
+    ]
+  ]
+};
+export {
+  env_exports as env,
+  step_exports as step
+};

package/dist/index.d.mts

@@ -0,0 +1,147 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer, sendServer } from '@walkeros/server-core';
+
+interface Settings {
+    accessToken: string;
+    pixelId: string;
+    url?: string;
+    action_source?: ActionSource;
+    doNotHash?: string[];
+    user_data?: Mapping$1.Map;
+    testMode?: boolean;
+}
+type InitSettings = Partial<Settings>;
+interface Mapping {
+}
+interface Env extends DestinationServer.Env {
+    sendServer?: typeof sendServer;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+interface Destination extends DestinationServer.Destination<Types> {
+    init: DestinationServer.InitFn<Types>;
+}
+type Config = {
+    settings: Settings;
+} & DestinationServer.Config<Types>;
+type InitFn = DestinationServer.InitFn<Types>;
+type PushFn = DestinationServer.PushFn<Types>;
+type PartialConfig = DestinationServer.PartialConfig<Types>;
+type PushEvents = DestinationServer.PushEvents<Mapping>;
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+/**
+ * Snapchat Conversions API v3
+ * https://businesshelp.snapchat.com/s/article/conversions-api
+ */
+type ActionSource = 'WEB' | 'MOBILE_APP' | 'OFFLINE';
+interface RequestBody {
+    data: SnapchatEvent[];
+}
+interface SnapchatEvent {
+    event_name: string;
+    event_time: number;
+    action_source: ActionSource;
+    event_source_url?: string;
+    event_id?: string;
+    user_data: UserData;
+    custom_data?: CustomData;
+}
+interface UserData {
+    /** Email, SHA-256 hashed, lowercase trimmed */
+    em?: string;
+    /** Phone number, SHA-256 hashed, E.164 digits */
+    ph?: string;
+    /** First name, SHA-256 hashed, lowercase */
+    fn?: string;
+    /** Last name, SHA-256 hashed, lowercase */
+    ln?: string;
+    /** Date of birth YYYYMMDD, SHA-256 hashed */
+    db?: string;
+    /** Gender (m/f), SHA-256 hashed */
+    ge?: string;
+    /** City, SHA-256 hashed, lowercase */
+    ct?: string;
+    /** State, SHA-256 hashed, lowercase */
+    st?: string;
+    /** Zip/postal code, SHA-256 hashed */
+    zp?: string;
+    /** Country code ISO 3166-1 alpha-2, SHA-256 hashed */
+    country?: string;
+    /** External/customer ID, SHA-256 hash recommended */
+    external_id?: string;
+    /** Snap cookie. Do NOT hash. */
+    sc_cookie1?: string;
+    /** Client IP address (IPv4 or IPv6). Do NOT hash. */
+    client_ip_address?: string;
+    /** Client user agent. Do NOT hash. */
+    client_user_agent?: string;
+    /** Snap click ID. Do NOT hash. */
+    sc_click_id?: string;
+    /** iOS IDFV. Do NOT hash. */
+    idfv?: string;
+    /** Mobile advertiser ID (IDFA/AAID). Do NOT hash. */
+    madid?: string;
+}
+interface CustomData {
+    value?: number;
+    currency?: string;
+    contents?: ContentItem[];
+    item_ids?: string[];
+    number_items?: number;
+    price?: number;
+    cart_total?: number;
+    search_string?: string;
+    item_category?: string;
+    brands?: string[];
+    description?: string;
+    transaction_id?: string;
+    payment_info_available?: number;
+    delivery_category?: string;
+    sign_up_method?: string;
+    level?: string;
+    [key: string]: unknown;
+}
+interface ContentItem {
+    id?: string;
+    quantity?: number;
+    item_price?: number;
+    brand?: string;
+}
+interface ResponseBody {
+    status: string;
+    request_id?: string;
+}
+/**
+ * Standard Snapchat event names (UPPERCASE).
+ * Custom events via CUSTOM_EVENT_1..5 or arbitrary strings.
+ */
+type StandardEventName = 'PAGE_VIEW' | 'VIEW_CONTENT' | 'ADD_CART' | 'ADD_TO_WISHLIST' | 'START_CHECKOUT' | 'ADD_BILLING' | 'PURCHASE' | 'SIGN_UP' | 'SEARCH' | 'SAVE' | 'SUBSCRIBE' | 'COMPLETE_TUTORIAL' | 'START_TRIAL' | 'AD_CLICK' | 'AD_VIEW' | 'APP_OPEN' | 'LEVEL_COMPLETE' | 'INVITE' | 'LOGIN' | 'SHARE' | 'RESERVE' | 'ACHIEVEMENT_UNLOCKED' | 'SPENT_CREDITS' | 'RATE' | 'LIST_VIEW' | 'CUSTOM_EVENT_1' | 'CUSTOM_EVENT_2' | 'CUSTOM_EVENT_3' | 'CUSTOM_EVENT_4' | 'CUSTOM_EVENT_5' | (string & {});
+
+type index_ActionSource = ActionSource;
+type index_Config = Config;
+type index_ContentItem = ContentItem;
+type index_CustomData = CustomData;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_InitFn = InitFn;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_PartialConfig = PartialConfig;
+type index_PushEvents = PushEvents;
+type index_PushFn = PushFn;
+type index_RequestBody = RequestBody;
+type index_ResponseBody = ResponseBody;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_Settings = Settings;
+type index_SnapchatEvent = SnapchatEvent;
+type index_StandardEventName = StandardEventName;
+type index_Types = Types;
+type index_UserData = UserData;
+declare namespace index {
+  export type { index_ActionSource as ActionSource, index_Config as Config, index_ContentItem as ContentItem, index_CustomData as CustomData, index_Destination as Destination, index_Env as Env, index_InitFn as InitFn, index_InitSettings as InitSettings, index_Mapping as Mapping, index_PartialConfig as PartialConfig, index_PushEvents as PushEvents, index_PushFn as PushFn, index_RequestBody as RequestBody, index_ResponseBody as ResponseBody, index_Rule as Rule, index_Rules as Rules, index_Settings as Settings, index_SnapchatEvent as SnapchatEvent, index_StandardEventName as StandardEventName, index_Types as Types, index_UserData as UserData };
+}
+
+declare const destinationSnapchat: Destination;
+
+export { index as DestinationSnapchat, destinationSnapchat as default, destinationSnapchat };