@walkeros/server-destination-tiktok 3.3.0-next-1776098542393

package/dist/examples/index.js

@@ -0,0 +1,294 @@
+"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
+});
+async function mockSendServer(url, data, options) {
+  return {
+    ok: true,
+    data: {
+      code: 0,
+      message: "OK"
+    }
+  };
+}
+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 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: "CompletePayment",
+    data: {
+      map: {
+        value: "data.total",
+        currency: { key: "data.currency", value: "EUR" },
+        order_id: "data.id",
+        content_type: { value: "product" },
+        contents: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                content_id: "data.id",
+                content_name: "data.name",
+                quantity: { key: "data.quantity", value: 1 },
+                price: "data.price"
+              }
+            }
+          ]
+        },
+        user_data: {
+          map: {
+            external_id: "user.id"
+          }
+        }
+      }
+    }
+  },
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "CompletePayment",
+        event_id: "1700000900000-gr0up-1",
+        timestamp: "2023-11-14T22:28:20.000Z",
+        context: {
+          user: {
+            external_id: "user-123"
+          },
+          page: {
+            url: "https://shop.example.com/checkout/complete"
+          }
+        },
+        properties: {
+          value: 249.99,
+          currency: "EUR",
+          order_id: "ORD-300",
+          content_type: "product",
+          contents: [
+            {
+              content_id: "SKU-A1",
+              content_name: "Widget Pro",
+              quantity: 2,
+              price: 124.99
+            }
+          ]
+        }
+      }
+    ]
+  }
+};
+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: "AddToCart",
+    data: {
+      map: {
+        content_type: { value: "product" },
+        value: "data.price",
+        currency: { value: "EUR" },
+        contents: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+              map: {
+                content_id: "data.id",
+                content_name: "data.name",
+                quantity: { key: "data.quantity", value: 1 },
+                price: "data.price"
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "AddToCart",
+        event_id: "1700000901000-gr0up-1",
+        timestamp: "2023-11-14T22:28:21.000Z",
+        context: {
+          page: {
+            url: "https://shop.example.com/products/running-shoes"
+          }
+        },
+        properties: {
+          content_type: "product",
+          value: 89.99,
+          currency: "EUR",
+          contents: [
+            {
+              content_id: "SKU-B2",
+              content_name: "Running Shoes",
+              quantity: 1,
+              price: 89.99
+            }
+          ]
+        }
+      }
+    ]
+  }
+};
+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: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "page view",
+        event_id: "1700000902000-gr0up-1",
+        timestamp: "2023-11-14T22:28:22.000Z",
+        context: {
+          page: {
+            url: "https://example.com/docs/"
+          }
+        },
+        properties: {}
+      }
+    ]
+  }
+};
+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: "SubmitForm",
+    data: {
+      map: {
+        user_data: {
+          map: {
+            email: "user.email"
+          }
+        }
+      }
+    }
+  },
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "SubmitForm",
+        event_id: "1700000903000-gr0up-1",
+        timestamp: "2023-11-14T22:28:23.000Z",
+        context: {
+          user: {
+            email: "user@example.com"
+          },
+          page: {
+            url: "https://example.com/contact"
+          }
+        },
+        properties: {}
+      }
+    ]
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});

package/dist/examples/index.mjs

@@ -0,0 +1,272 @@
+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
+});
+async function mockSendServer(url, data, options) {
+  return {
+    ok: true,
+    data: {
+      code: 0,
+      message: "OK"
+    }
+  };
+}
+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 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: "CompletePayment",
+    data: {
+      map: {
+        value: "data.total",
+        currency: { key: "data.currency", value: "EUR" },
+        order_id: "data.id",
+        content_type: { value: "product" },
+        contents: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                content_id: "data.id",
+                content_name: "data.name",
+                quantity: { key: "data.quantity", value: 1 },
+                price: "data.price"
+              }
+            }
+          ]
+        },
+        user_data: {
+          map: {
+            external_id: "user.id"
+          }
+        }
+      }
+    }
+  },
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "CompletePayment",
+        event_id: "1700000900000-gr0up-1",
+        timestamp: "2023-11-14T22:28:20.000Z",
+        context: {
+          user: {
+            external_id: "user-123"
+          },
+          page: {
+            url: "https://shop.example.com/checkout/complete"
+          }
+        },
+        properties: {
+          value: 249.99,
+          currency: "EUR",
+          order_id: "ORD-300",
+          content_type: "product",
+          contents: [
+            {
+              content_id: "SKU-A1",
+              content_name: "Widget Pro",
+              quantity: 2,
+              price: 124.99
+            }
+          ]
+        }
+      }
+    ]
+  }
+};
+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: "AddToCart",
+    data: {
+      map: {
+        content_type: { value: "product" },
+        value: "data.price",
+        currency: { value: "EUR" },
+        contents: {
+          loop: [
+            "nested",
+            {
+              condition: (entity) => isObject(entity) && entity.entity === "product",
+              map: {
+                content_id: "data.id",
+                content_name: "data.name",
+                quantity: { key: "data.quantity", value: 1 },
+                price: "data.price"
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "AddToCart",
+        event_id: "1700000901000-gr0up-1",
+        timestamp: "2023-11-14T22:28:21.000Z",
+        context: {
+          page: {
+            url: "https://shop.example.com/products/running-shoes"
+          }
+        },
+        properties: {
+          content_type: "product",
+          value: 89.99,
+          currency: "EUR",
+          contents: [
+            {
+              content_id: "SKU-B2",
+              content_name: "Running Shoes",
+              quantity: 1,
+              price: 89.99
+            }
+          ]
+        }
+      }
+    ]
+  }
+};
+var pageView = {
+  in: getEvent("page view", {
+    timestamp: 1700000902e3,
+    source: {
+      type: "server",
+      id: "https://example.com/docs/",
+      previous_id: ""
+    }
+  }),
+  mapping: void 0,
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "page view",
+        event_id: "1700000902000-gr0up-1",
+        timestamp: "2023-11-14T22:28:22.000Z",
+        context: {
+          page: {
+            url: "https://example.com/docs/"
+          }
+        },
+        properties: {}
+      }
+    ]
+  }
+};
+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: "SubmitForm",
+    data: {
+      map: {
+        user_data: {
+          map: {
+            email: "user.email"
+          }
+        }
+      }
+    }
+  },
+  out: {
+    pixel_code: "PIXEL_CODE",
+    partner_name: "walkerOS",
+    data: [
+      {
+        event: "SubmitForm",
+        event_id: "1700000903000-gr0up-1",
+        timestamp: "2023-11-14T22:28:23.000Z",
+        context: {
+          user: {
+            email: "user@example.com"
+          },
+          page: {
+            url: "https://example.com/contact"
+          }
+        },
+        properties: {}
+      }
+    ]
+  }
+};
+export {
+  env_exports as env,
+  step_exports as step
+};

package/dist/index.d.mts

@@ -0,0 +1,101 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer, sendServer } from '@walkeros/server-core';
+
+interface Settings {
+    pixelCode: string;
+    accessToken: string;
+    url?: string;
+    test_event_code?: string;
+    doNotHash?: string[];
+    user_data?: Mapping$1.Map;
+    partner_name?: string;
+}
+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>;
+interface RequestBody {
+    pixel_code: string;
+    partner_name?: string;
+    test_event_code?: string;
+    data: EventData[];
+}
+interface EventData {
+    event: string;
+    event_id: string;
+    timestamp: string;
+    context?: EventContext;
+    properties?: Record<string, unknown>;
+}
+interface EventContext {
+    ip?: string;
+    user_agent?: string;
+    user?: UserData;
+    page?: PageContext;
+    ad?: AdContext;
+}
+interface UserData {
+    email?: string;
+    phone_number?: string;
+    external_id?: string;
+    ttp?: string;
+    ttclid?: string;
+    locale?: string;
+}
+interface PageContext {
+    url?: string;
+    referrer?: string;
+}
+interface AdContext {
+    callback?: string;
+}
+interface ResponseBody {
+    code: number;
+    message: string;
+    data?: Record<string, unknown>;
+}
+type StandardEventName = 'ViewContent' | 'ClickButton' | 'Search' | 'AddToWishlist' | 'AddToCart' | 'InitiateCheckout' | 'AddPaymentInfo' | 'CompletePayment' | 'PlaceAnOrder' | 'Contact' | 'Download' | 'SubmitForm' | 'CompleteRegistration' | 'Subscribe' | (string & {});
+
+type index_AdContext = AdContext;
+type index_Config = Config;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_EventContext = EventContext;
+type index_EventData = EventData;
+type index_InitFn = InitFn;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_PageContext = PageContext;
+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_StandardEventName = StandardEventName;
+type index_Types = Types;
+type index_UserData = UserData;
+declare namespace index {
+  export type { index_AdContext as AdContext, index_Config as Config, index_Destination as Destination, index_Env as Env, index_EventContext as EventContext, index_EventData as EventData, index_InitFn as InitFn, index_InitSettings as InitSettings, index_Mapping as Mapping, index_PageContext as PageContext, 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_StandardEventName as StandardEventName, index_Types as Types, index_UserData as UserData };
+}
+
+declare const destinationTikTok: Destination;
+
+export { index as DestinationTikTok, destinationTikTok as default, destinationTikTok };