@walkeros/server-destination-criteo 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: "OK"
+});
+var push = {
+  sendServer: mockSendServer
+};
+var simulation = ["sendServer"];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  addToCart: () => addToCart,
+  pageView: () => pageView,
+  purchase: () => purchase,
+  viewItem: () => viewItem
+});
+var import_core = require("@walkeros/core");
+var ENDPOINT = "https://widget.criteo.com/m/event?version=s2s_v0";
+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: "https://shop.example.com/cart"
+    }
+  }),
+  mapping: {
+    name: "trackTransaction",
+    data: {
+      map: {
+        id: "data.id",
+        item: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                id: "data.id",
+                price: "data.price",
+                quantity: { key: "data.quantity", value: 1 }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "trackTransaction",
+            timestamp: "2023-11-14T22:28:20.000Z",
+            id: "ORD-300",
+            item: [
+              {
+                id: "SKU-A1",
+                price: 124.99,
+                quantity: 2
+              }
+            ]
+          }
+        ],
+        full_url: "https://shop.example.com/checkout/complete",
+        previous_url: "https://shop.example.com/cart"
+      })
+    ]
+  ]
+};
+var addToCart = {
+  in: (0, import_core.getEvent)("product add", {
+    timestamp: 1700000901e3,
+    data: {
+      id: "SKU-B2",
+      name: "Running Shoes",
+      price: 89.99
+    },
+    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: "addToCart",
+    data: {
+      map: {
+        item: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                id: "data.id",
+                price: "data.price",
+                quantity: { key: "data.quantity", value: 1 }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "addToCart",
+            timestamp: "2023-11-14T22:28:21.000Z",
+            item: [
+              {
+                id: "SKU-B2",
+                price: 89.99,
+                quantity: 1
+              }
+            ]
+          }
+        ],
+        full_url: "https://shop.example.com/products/running-shoes"
+      })
+    ]
+  ]
+};
+var viewItem = {
+  in: (0, import_core.getEvent)("product view", {
+    timestamp: 1700000902e3,
+    data: { id: "SKU-C3", name: "Coffee Maker" },
+    nested: [
+      {
+        entity: "product",
+        data: { id: "SKU-C3" }
+      }
+    ],
+    source: {
+      type: "server",
+      id: "https://shop.example.com/products/coffee-maker",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "viewItem",
+    data: {
+      map: {
+        item: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                id: "data.id"
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "viewItem",
+            timestamp: "2023-11-14T22:28:22.000Z",
+            item: [
+              {
+                id: "SKU-C3"
+              }
+            ]
+          }
+        ],
+        full_url: "https://shop.example.com/products/coffee-maker"
+      })
+    ]
+  ]
+};
+var pageView = {
+  in: (0, import_core.getEvent)("page view", {
+    timestamp: 1700000903e3,
+    source: {
+      type: "server",
+      id: "https://example.com/",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "viewHome"
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "viewHome",
+            timestamp: "2023-11-14T22:28:23.000Z"
+          }
+        ],
+        full_url: "https://example.com/"
+      })
+    ]
+  ]
+};
+// 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: "OK"
+});
+var push = {
+  sendServer: mockSendServer
+};
+var simulation = ["sendServer"];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  addToCart: () => addToCart,
+  pageView: () => pageView,
+  purchase: () => purchase,
+  viewItem: () => viewItem
+});
+import { getEvent, isObject } from "@walkeros/core";
+var ENDPOINT = "https://widget.criteo.com/m/event?version=s2s_v0";
+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: "https://shop.example.com/cart"
+    }
+  }),
+  mapping: {
+    name: "trackTransaction",
+    data: {
+      map: {
+        id: "data.id",
+        item: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                id: "data.id",
+                price: "data.price",
+                quantity: { key: "data.quantity", value: 1 }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "trackTransaction",
+            timestamp: "2023-11-14T22:28:20.000Z",
+            id: "ORD-300",
+            item: [
+              {
+                id: "SKU-A1",
+                price: 124.99,
+                quantity: 2
+              }
+            ]
+          }
+        ],
+        full_url: "https://shop.example.com/checkout/complete",
+        previous_url: "https://shop.example.com/cart"
+      })
+    ]
+  ]
+};
+var addToCart = {
+  in: getEvent("product add", {
+    timestamp: 1700000901e3,
+    data: {
+      id: "SKU-B2",
+      name: "Running Shoes",
+      price: 89.99
+    },
+    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: "addToCart",
+    data: {
+      map: {
+        item: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                id: "data.id",
+                price: "data.price",
+                quantity: { key: "data.quantity", value: 1 }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "addToCart",
+            timestamp: "2023-11-14T22:28:21.000Z",
+            item: [
+              {
+                id: "SKU-B2",
+                price: 89.99,
+                quantity: 1
+              }
+            ]
+          }
+        ],
+        full_url: "https://shop.example.com/products/running-shoes"
+      })
+    ]
+  ]
+};
+var viewItem = {
+  in: getEvent("product view", {
+    timestamp: 1700000902e3,
+    data: { id: "SKU-C3", name: "Coffee Maker" },
+    nested: [
+      {
+        entity: "product",
+        data: { id: "SKU-C3" }
+      }
+    ],
+    source: {
+      type: "server",
+      id: "https://shop.example.com/products/coffee-maker",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "viewItem",
+    data: {
+      map: {
+        item: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                id: "data.id"
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "viewItem",
+            timestamp: "2023-11-14T22:28:22.000Z",
+            item: [
+              {
+                id: "SKU-C3"
+              }
+            ]
+          }
+        ],
+        full_url: "https://shop.example.com/products/coffee-maker"
+      })
+    ]
+  ]
+};
+var pageView = {
+  in: getEvent("page view", {
+    timestamp: 1700000903e3,
+    source: {
+      type: "server",
+      id: "https://example.com/",
+      previous_id: ""
+    }
+  }),
+  mapping: {
+    name: "viewHome"
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        version: "walkeros_criteo_1.0.0",
+        site_type: "d",
+        account: "PARTNER_ID",
+        id: {
+          mapping_key: "CALLER_ID"
+        },
+        events: [
+          {
+            event: "viewHome",
+            timestamp: "2023-11-14T22:28:23.000Z"
+          }
+        ],
+        full_url: "https://example.com/"
+      })
+    ]
+  ]
+};
+export {
+  env_exports as env,
+  step_exports as step
+};

package/dist/index.d.mts

@@ -0,0 +1,120 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer, sendServer } from '@walkeros/server-core';
+
+interface Settings {
+    /** Criteo Partner ID (numeric string, provided by Criteo) */
+    partnerId: string;
+    /** Caller ID for user mapping (provided by Criteo) */
+    callerId: string;
+    /** Site type: `d` (desktop), `m` (mobile web), `t` (tablet). Default `d`. */
+    siteType?: SiteType;
+    /** ISO 3166-1 alpha-2 country code */
+    country?: string;
+    /** 2-letter language code */
+    language?: string;
+    /** API endpoint override (default: https://widget.criteo.com/m/event?version=s2s_v0) */
+    url?: string;
+    /** Mapping for identity fields (mapped_user_id, email, retailer_visitor_id) */
+    user_data?: Mapping$1.Map;
+}
+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>;
+/** Site type: desktop / mobile web / tablet */
+type SiteType = 'd' | 'm' | 't';
+/**
+ * Criteo Events API (S2S v0)
+ * https://guides.criteotilt.com/events-api/
+ */
+interface CriteoRequestBody {
+    /** Integration version identifier (e.g. `walkeros_criteo_1.0.0`) */
+    version: string;
+    site_type?: SiteType;
+    /** Criteo Partner ID */
+    account: string;
+    id: CriteoIdentity;
+    ip?: string;
+    full_url?: string;
+    previous_url?: string;
+    useragent?: string;
+    retailer_visitor_id?: string;
+    country?: string;
+    language?: string;
+    events: CriteoEvent[];
+}
+interface CriteoIdentity {
+    /** GUM ID */
+    mapped_user_id?: string;
+    /** Caller ID (provided by Criteo) */
+    mapping_key: string;
+    email?: CriteoEmailHashes;
+}
+interface CriteoEmailHashes {
+    raw?: string;
+    md5?: string;
+    sha256?: string;
+    sha256_md5?: string;
+}
+interface CriteoEvent {
+    event: CriteoEventName;
+    /** ISO 8601 timestamp */
+    timestamp?: string;
+    /** Transaction ID or event-level ID */
+    id?: string;
+    item?: CriteoItem[];
+    deduplication_page_view_id?: string;
+}
+interface CriteoItem {
+    id: string;
+    price?: number;
+    quantity?: number;
+}
+/**
+ * Standard Criteo Events API event names.
+ * Custom event names are also accepted as plain strings.
+ */
+type CriteoEventName = 'viewHome' | 'viewPage' | 'viewItem' | 'viewList' | 'addToCart' | 'viewBasket' | 'beginCheckout' | 'trackTransaction' | 'addPaymentInfo' | 'login' | (string & {});
+
+type index_Config = Config;
+type index_CriteoEmailHashes = CriteoEmailHashes;
+type index_CriteoEvent = CriteoEvent;
+type index_CriteoEventName = CriteoEventName;
+type index_CriteoIdentity = CriteoIdentity;
+type index_CriteoItem = CriteoItem;
+type index_CriteoRequestBody = CriteoRequestBody;
+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_Rule = Rule;
+type index_Rules = Rules;
+type index_Settings = Settings;
+type index_SiteType = SiteType;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_CriteoEmailHashes as CriteoEmailHashes, index_CriteoEvent as CriteoEvent, index_CriteoEventName as CriteoEventName, index_CriteoIdentity as CriteoIdentity, index_CriteoItem as CriteoItem, index_CriteoRequestBody as CriteoRequestBody, 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_Rule as Rule, index_Rules as Rules, index_Settings as Settings, index_SiteType as SiteType, index_Types as Types };
+}
+
+declare const destinationCriteo: Destination;
+
+export { index as DestinationCriteo, destinationCriteo as default, destinationCriteo };