@segment/action-destinations 3.261.0 → 3.261.1-staging.0

package/dist/destinations/tiktok-conversions/index.js

@@ -12,17 +12,11 @@ const productProperties = {
     quantity: {
         '@path': '$.quantity'
     },
-    content_category: {
+    content_type: {
         '@path': '$.category'
     },
     content_id: {
         '@path': '$.product_id'
-    },
-    content_name: {
-        '@path': '$.name'
-    },
-    brand: {
-        '@path': '$.brand'
     }
 };
 const singleProductContents = {
@@ -47,6 +41,78 @@ const multiProductContents = {
         ]
     }
 };
+const presets = [
+    {
+        name: 'View Content',
+        subscribe: 'type="page"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...singleProductContents,
+            event: 'ViewContent'
+        },
+        type: 'automatic'
+    },
+    {
+        name: 'Search',
+        subscribe: 'event = "Products Searched"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...singleProductContents,
+            event: 'Search'
+        },
+        type: 'automatic'
+    },
+    {
+        name: 'Add to Wishlist',
+        subscribe: 'event = "Product Added to Wishlist"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...singleProductContents,
+            event: 'AddToWishlist'
+        },
+        type: 'automatic'
+    },
+    {
+        name: 'Add to Cart',
+        subscribe: 'event = "Product Added"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...singleProductContents,
+            event: 'AddToCart'
+        },
+        type: 'automatic'
+    },
+    {
+        name: 'Initiate Checkout',
+        subscribe: 'event = "Checkout Started"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...multiProductContents,
+            event: 'InitiateCheckout'
+        },
+        type: 'automatic'
+    },
+    {
+        name: 'Add Payment Info',
+        subscribe: 'event = "Payment Info Entered"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...multiProductContents,
+            event: 'AddPaymentInfo'
+        },
+        type: 'automatic'
+    },
+    {
+        name: 'Place an Order',
+        subscribe: 'event = "Order Completed"',
+        partnerAction: 'reportWebEvent',
+        mapping: {
+            ...multiProductContents,
+            event: 'PlaceAnOrder'
+        },
+        type: 'automatic'
+    }
+];
 const destination = {
     name: 'Tiktok Conversions',
     slug: 'tiktok-conversions',
@@ -81,164 +147,10 @@ const destination = {
     },
     extendRequest({ settings }) {
         return {
-            headers: {
-                'Access-Token': settings.accessToken,
-                'Content-Type': 'application/json'
-            }
+            headers: { 'Access-Token': settings.accessToken }
         };
     },
-    presets: [
-        {
-            name: 'Complete Payment',
-            subscribe: 'event = "Order Completed"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...multiProductContents,
-                event: 'CompletePayment'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Contact',
-            subscribe: 'event = "Callback Started"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
-                event: 'Contact'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Subscribe',
-            subscribe: 'event = "Subscription Created"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
-                event: 'Subscribe'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Submit Form',
-            subscribe: 'event = "Form Submitted"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
-                event: 'SubmitForm'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Page View',
-            subscribe: 'type="page"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...multiProductContents,
-                event: 'PageView'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'View Content',
-            subscribe: 'event = "Product Viewed"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...singleProductContents,
-                event: 'ViewContent'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Click Button',
-            subscribe: 'event = "Product Clicked"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...singleProductContents,
-                event: 'ClickButton'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Search',
-            subscribe: 'event = "Products Searched"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...singleProductContents,
-                event: 'Search'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Add to Wishlist',
-            subscribe: 'event = "Product Added to Wishlist"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...singleProductContents,
-                event: 'AddToWishlist'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Add to Cart',
-            subscribe: 'event = "Product Added"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...singleProductContents,
-                event: 'AddToCart'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Initiate Checkout',
-            subscribe: 'event = "Checkout Started"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...multiProductContents,
-                event: 'InitiateCheckout'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Add Payment Info',
-            subscribe: 'event = "Payment Info Entered"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...multiProductContents,
-                event: 'AddPaymentInfo'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Place an Order',
-            subscribe: 'event = "Order Placed"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...multiProductContents,
-                event: 'PlaceAnOrder'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Download',
-            subscribe: 'event = "Download Link Clicked"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
-                event: 'Download'
-            },
-            type: 'automatic'
-        },
-        {
-            name: 'Complete Registration',
-            subscribe: 'event = "Signed Up"',
-            partnerAction: 'reportWebEvent',
-            mapping: {
-                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
-                event: 'CompleteRegistration'
-            },
-            type: 'automatic'
-        }
-    ],
+    presets,
     actions: {
         reportWebEvent: reportWebEvent_1.default
     }

package/dist/destinations/tiktok-conversions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions/index.ts"],"names":[],"mappings":";;;;;AACA,wDAAqD;AAGrD,sEAA6C;AAE7C,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY;KACtB;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,QAAQ;KAClB;IACD,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;CACF,CAAA;AAED,MAAM,qBAAqB,GAAG;IAC5B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,cAAc;YACd;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,oBAAoB,GAAG;IAC3B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,WAAW,GAAoC;IAInD,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,KAAK,EAAE,cAAc;gBACrB,WAAW,EACT,+NAA+N;gBACjO,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,SAAS,EAAE;gBACT,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,gLAAgL;gBAClL,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAG5C,OAAO,OAAO,CAAC,4DAA4D,EAAE;gBAC3E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,UAAU,EAAE,QAAQ,CAAC,SAAS;oBAC9B,KAAK,EAAE,YAAY;oBACnB,SAAS,EAAE,EAAE;oBACb,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC,CAAA;QACJ,CAAC;KACF;IACD,aAAa,CAAC,EAAE,QAAQ,EAAE;QACxB,OAAO;YACL,OAAO,EAAE;gBACP,cAAc,EAAE,QAAQ,CAAC,WAAW;gBACpC,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;IACH,CAAC;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,iBAAiB;aACzB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,SAAS;aACjB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,0BAA0B;YACrC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,YAAY;aACpB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,aAAa;YACxB,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,UAAU;aAClB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,0BAA0B;YACrC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,6BAA6B;YACxC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,QAAQ;aAChB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,SAAS,EAAE,qCAAqC;YAChD,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,eAAe;aACvB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,yBAAyB;YACpC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,kBAAkB;aAC1B;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,gBAAgB;aACxB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,SAAS,EAAE,wBAAwB;YACnC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,cAAc;aACtB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,iCAAiC;YAC5C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,UAAU;aAClB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,uBAAuB;YAC7B,SAAS,EAAE,qBAAqB;YAChC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,sBAAsB;aAC9B;YACD,IAAI,EAAE,WAAW;SAClB;KACF;IACD,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;KACf;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions/index.ts"],"names":[],"mappings":";;;;;AACA,wDAAqD;AAGrD,sEAA6C;AAE7C,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY;KACtB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;CACF,CAAA;AAED,MAAM,qBAAqB,GAAG;IAC5B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,cAAc;YACd;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,oBAAoB,GAAG;IAC3B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAGD,MAAM,OAAO,GAAqC;IAChD;QACE,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE,aAAa;QACxB,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,aAAa;SACrB;QACD,IAAI,EAAE,WAAW;KAClB;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,6BAA6B;QACxC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,QAAQ;SAChB;QACD,IAAI,EAAE,WAAW;KAClB;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,SAAS,EAAE,qCAAqC;QAChD,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,eAAe;SACvB;QACD,IAAI,EAAE,WAAW;KAClB;IACD;QACE,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,yBAAyB;QACpC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,WAAW;SACnB;QACD,IAAI,EAAE,WAAW;KAClB;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,4BAA4B;QACvC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,oBAAoB;YACvB,KAAK,EAAE,kBAAkB;SAC1B;QACD,IAAI,EAAE,WAAW;KAClB;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,gCAAgC;QAC3C,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,oBAAoB;YACvB,KAAK,EAAE,gBAAgB;SACxB;QACD,IAAI,EAAE,WAAW;KAClB;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE,2BAA2B;QACtC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,oBAAoB;YACvB,KAAK,EAAE,cAAc;SACtB;QACD,IAAI,EAAE,WAAW;KAClB;CACF,CAAA;AAED,MAAM,WAAW,GAAoC;IAInD,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,KAAK,EAAE,cAAc;gBACrB,WAAW,EACT,+NAA+N;gBACjO,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,SAAS,EAAE;gBACT,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,gLAAgL;gBAClL,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAG5C,OAAO,OAAO,CAAC,4DAA4D,EAAE;gBAC3E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,UAAU,EAAE,QAAQ,CAAC,SAAS;oBAC9B,KAAK,EAAE,YAAY;oBACnB,SAAS,EAAE,EAAE;oBACb,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC,CAAA;QACJ,CAAC;KACF;IACD,aAAa,CAAC,EAAE,QAAQ,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,WAAW,EAAE;SAClD,CAAA;IACH,CAAC;IACD,OAAO;IACP,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;KACf;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.d.ts

@@ -0,0 +1,3 @@
+export declare function formatEmail(email: string | undefined): string | undefined;
+export declare function formatUserId(userId: string | undefined): string | undefined;
+export declare function formatPhone(phone: string | undefined): string | undefined;

package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPhone = exports.formatUserId = exports.formatEmail = void 0;
+const crypto_1 = require("crypto");
+function formatEmail(email) {
+    if (email) {
+        return hashAndEncode(email.toLowerCase());
+    }
+    return undefined;
+}
+exports.formatEmail = formatEmail;
+function formatUserId(userId) {
+    if (userId) {
+        return hashAndEncode(userId.toLowerCase().trim());
+    }
+    return undefined;
+}
+exports.formatUserId = formatUserId;
+function formatPhone(phone) {
+    if (!phone)
+        return undefined;
+    const validatedPhone = phone.match(/[0-9]{0,14}/g);
+    if (validatedPhone === null) {
+        throw new Error(`${phone} is not a valid E.164 phone number.`);
+    }
+    let formattedPhone = `+${phone.replace(/[^0-9]/g, '')}`;
+    formattedPhone = formattedPhone.substring(0, 15);
+    return hashAndEncode(formattedPhone);
+}
+exports.formatPhone = formatPhone;
+function hashAndEncode(property) {
+    return crypto_1.createHash('sha256').update(property).digest('hex');
+}
+//# sourceMappingURL=formatter.js.map

package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/formatter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAKnC,SAAgB,WAAW,CAAC,KAAyB;IACnD,IAAI,KAAK,EAAE;QACT,OAAO,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;KAC1C;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AALD,kCAKC;AAOD,SAAgB,YAAY,CAAC,MAA0B;IACrD,IAAI,MAAM,EAAE;QACV,OAAO,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;KAClD;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AALD,oCAKC;AAOD,SAAgB,WAAW,CAAC,KAAyB;IACnD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAE5B,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,IAAI,cAAc,KAAK,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;KAC/D;IAED,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;IAEvD,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAChD,OAAO,aAAa,CAAC,cAAc,CAAC,CAAA;AACtC,CAAC;AAZD,kCAYC;AAED,SAAS,aAAa,CAAC,QAAgB;IACrC,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC5D,CAAC"}

package/dist/destinations/tiktok-conversions/reportWebEvent/generated-types.d.ts

@@ -2,15 +2,11 @@ export interface Payload {
     event: string;
     event_id?: string;
     timestamp?: string;
-    phone_number?: string[];
-    email?: string[];
-    order_id?: string;
-    shop_id?: string;
-    external_id?: string[];
+    phone_number?: string;
+    email?: string;
+    external_id?: string;
     ttclid?: string;
-    ttp?: string;
     lead_id?: string;
-    locale?: string;
     url?: string;
     referrer?: string;
     ip?: string;
@@ -18,16 +14,12 @@ export interface Payload {
     contents?: {
         price?: number;
         quantity?: number;
-        content_category?: string;
+        content_type?: string;
         content_id?: string;
-        content_name?: string;
-        brand?: string;
     }[];
-    content_type?: string;
     currency?: string;
     value?: number;
     description?: string;
     query?: string;
-    limited_data_use?: boolean;
     test_event_code?: string;
 }

package/dist/destinations/tiktok-conversions/reportWebEvent/index.d.ts

@@ -1,4 +1,4 @@
-import { ActionDefinition } from '@segment/actions-core';
+import type { ActionDefinition } from '@segment/actions-core';
 import type { Settings } from '../generated-types';
 import type { Payload } from './generated-types';
 declare const action: ActionDefinition<Settings, Payload>;

package/dist/destinations/tiktok-conversions/reportWebEvent/index.js

@@ -1,15 +1,243 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const common_fields_1 = require("../common_fields");
-const utils_1 = require("../utils");
+const formatter_1 = require("./formatter");
 const action = {
     title: 'Report Web Event',
-    description: 'Report Web events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.',
+    description: 'Report events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.',
     fields: {
-        ...common_fields_1.commonFields
+        event: {
+            label: 'Event Name',
+            type: 'string',
+            required: true,
+            description: 'Conversion event name. Please refer to the "Supported Web Events" section on in TikTok’s [Events API documentation](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106) for accepted event names.'
+        },
+        event_id: {
+            label: 'Event ID',
+            type: 'string',
+            description: 'Any hashed ID that can identify a unique user/session.',
+            default: {
+                '@path': '$.messageId'
+            }
+        },
+        timestamp: {
+            label: 'Event Timestamp',
+            type: 'string',
+            description: 'Timestamp that the event took place, in ISO 8601 format.',
+            default: {
+                '@path': '$.timestamp'
+            }
+        },
+        phone_number: {
+            label: 'Phone Number',
+            description: 'Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000. Segment will hash this value before sending to TikTok.',
+            type: 'string',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.phone' },
+                    then: { '@path': '$.properties.phone' },
+                    else: { '@path': '$.traits.phone' }
+                }
+            }
+        },
+        email: {
+            label: 'Email',
+            description: 'Email address of the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
+            type: 'string',
+            format: 'email',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.email' },
+                    then: { '@path': '$.properties.email' },
+                    else: { '@path': '$.traits.email' }
+                }
+            }
+        },
+        external_id: {
+            label: 'External ID',
+            description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
+            type: 'string',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.userId' },
+                    then: { '@path': '$.userId' },
+                    else: { '@path': '$.anonymousId' }
+                }
+            }
+        },
+        ttclid: {
+            label: 'TikTok Click ID',
+            description: 'The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See [Set up ttclid](https://ads.tiktok.com/marketing_api/docs?rid=4eezrhr6lg4&id=1681728034437121) for details.',
+            type: 'string',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.ttclid' },
+                    then: { '@path': '$.properties.ttclid' },
+                    else: { '@path': '$.traits.ttclid' }
+                }
+            }
+        },
+        lead_id: {
+            label: 'TikTok Lead ID',
+            description: 'ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability',
+            type: 'string',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.lead_id' },
+                    then: { '@path': '$.properties.lead_id' },
+                    else: { '@path': '$.traits.lead_id' }
+                }
+            }
+        },
+        url: {
+            label: 'Page URL',
+            type: 'string',
+            description: 'The page URL where the conversion event took place.',
+            default: {
+                '@path': '$.context.page.url'
+            }
+        },
+        referrer: {
+            label: 'Page Referrer',
+            type: 'string',
+            description: 'The page referrer.',
+            default: {
+                '@path': '$.context.page.referrer'
+            }
+        },
+        ip: {
+            label: 'IP Address',
+            type: 'string',
+            description: 'IP address of the browser.',
+            default: {
+                '@path': '$.context.ip'
+            }
+        },
+        user_agent: {
+            label: 'User Agent',
+            type: 'string',
+            description: 'User agent from the user’s device.',
+            default: {
+                '@path': '$.context.userAgent'
+            }
+        },
+        contents: {
+            label: 'Contents',
+            type: 'object',
+            multiple: true,
+            description: 'Related items in a web event.',
+            properties: {
+                price: {
+                    label: 'Price',
+                    description: 'Price of the item.',
+                    type: 'number'
+                },
+                quantity: {
+                    label: 'Quantity',
+                    description: 'Number of items.',
+                    type: 'number'
+                },
+                content_type: {
+                    label: 'Content Type',
+                    description: 'Type of the product item.',
+                    type: 'string'
+                },
+                content_id: {
+                    label: 'Content ID',
+                    description: 'ID of the product item.',
+                    type: 'string'
+                }
+            }
+        },
+        currency: {
+            label: 'Currency',
+            type: 'string',
+            description: 'Currency for the value specified as ISO 4217 code.',
+            default: {
+                '@path': '$.properties.currency'
+            }
+        },
+        value: {
+            label: 'Value',
+            type: 'number',
+            description: 'Value of the order or items sold.',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.value' },
+                    then: { '@path': '$.properties.value' },
+                    else: { '@path': '$.properties.revenue' }
+                }
+            }
+        },
+        description: {
+            label: 'Description',
+            type: 'string',
+            description: 'A string description of the web event.'
+        },
+        query: {
+            label: 'Query',
+            type: 'string',
+            description: 'The text string that was searched for.',
+            default: {
+                '@path': '$.properties.query'
+            }
+        },
+        test_event_code: {
+            label: 'Test Event Code',
+            type: 'string',
+            description: 'Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the "Test Event" tab. You\'ll want to remove your Test Event Code when sending real traffic through this integration.'
+        }
     },
     perform: (request, { payload, settings }) => {
-        return utils_1.performWebEvent(request, settings, payload);
+        const userData = {
+            hashedExternalId: formatter_1.formatUserId(payload.external_id),
+            hashedEmail: formatter_1.formatEmail(payload.email),
+            hashedPhoneNumber: formatter_1.formatPhone(payload.phone_number)
+        };
+        let payloadUrl, urlTtclid;
+        if (payload.url) {
+            try {
+                payloadUrl = new URL(payload.url);
+            }
+            catch (error) {
+            }
+        }
+        if (payloadUrl)
+            urlTtclid = payloadUrl.searchParams.get('ttclid');
+        return request('https://business-api.tiktok.com/open_api/v1.3/pixel/track/', {
+            method: 'post',
+            json: {
+                pixel_code: settings.pixelCode,
+                event: payload.event,
+                event_id: payload.event_id ? `${payload.event_id}` : undefined,
+                timestamp: payload.timestamp,
+                test_event_code: payload.test_event_code,
+                context: {
+                    user: {
+                        external_id: userData.hashedExternalId,
+                        phone_number: userData.hashedPhoneNumber,
+                        email: userData.hashedEmail,
+                        lead_id: payload.lead_id
+                    },
+                    ad: {
+                        callback: payload.ttclid ? payload.ttclid : urlTtclid ? urlTtclid : undefined
+                    },
+                    page: {
+                        url: payload.url,
+                        referrer: payload.referrer
+                    },
+                    ip: payload.ip,
+                    user_agent: payload.user_agent
+                },
+                properties: {
+                    contents: payload.contents,
+                    currency: payload.currency,
+                    value: payload.value,
+                    description: payload.description,
+                    query: payload.query
+                },
+                partner_name: 'Segment'
+            }
+        });
     }
 };
 exports.default = action;

package/dist/destinations/tiktok-conversions/reportWebEvent/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/index.ts"],"names":[],"mappings":";;AAGA,oDAA+C;AAC/C,oCAA0C;AAE1C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,iKAAiK;IACnK,MAAM,EAAE;QACN,GAAG,4BAAY;KAChB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,OAAO,uBAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACpD,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/index.ts"],"names":[],"mappings":";;AAGA,2CAAoE;AAEpE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,6JAA6J;IAC/J,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,8MAA8M;SACjN;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wDAAwD;YACrE,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,0DAA0D;YACvE,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QAED,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EACT,kKAAkK;YACpK,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EACT,sHAAsH;YACxH,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,yHAAyH;YAC3H,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;iBACnC;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,iBAAiB;YACxB,WAAW,EACT,+NAA+N;YACjO,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE;iBACrC;aACF;SACF;QACD,OAAO,EAAE;YACP,KAAK,EAAE,gBAAgB;YACvB,WAAW,EACT,0LAA0L;YAC5L,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;oBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;iBACtC;aACF;SACF;QACD,GAAG,EAAE;YACH,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qDAAqD;YAClE,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oBAAoB;YACjC,OAAO,EAAE;gBACP,OAAO,EAAE,yBAAyB;aACnC;SACF;QACD,EAAE,EAAE;YACF,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,4BAA4B;YACzC,OAAO,EAAE;gBACP,OAAO,EAAE,cAAc;aACxB;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE;gBACP,OAAO,EAAE,qBAAqB;aAC/B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,+BAA+B;YAC5C,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,WAAW,EAAE,oBAAoB;oBACjC,IAAI,EAAE,QAAQ;iBACf;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,WAAW,EAAE,kBAAkB;oBAC/B,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,2BAA2B;oBACxC,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,YAAY;oBACnB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mCAAmC;YAChD,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;iBAC1C;aACF;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;SACtD;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,eAAe,EAAE;YACf,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,qRAAqR;SACxR;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAAG;YACf,gBAAgB,EAAE,wBAAY,CAAC,OAAO,CAAC,WAAW,CAAC;YACnD,WAAW,EAAE,uBAAW,CAAC,OAAO,CAAC,KAAK,CAAC;YACvC,iBAAiB,EAAE,uBAAW,CAAC,OAAO,CAAC,YAAY,CAAC;SACrD,CAAA;QAED,IAAI,UAAU,EAAE,SAAS,CAAA;QACzB,IAAI,OAAO,CAAC,GAAG,EAAE;YACf,IAAI;gBACF,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;aAClC;YAAC,OAAO,KAAK,EAAE;aAEf;SACF;QAED,IAAI,UAAU;YAAE,SAAS,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAGjE,OAAO,OAAO,CAAC,4DAA4D,EAAE;YAC3E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,UAAU,EAAE,QAAQ,CAAC,SAAS;gBAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;gBAC9D,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,OAAO,EAAE;oBACP,IAAI,EAAE;wBACJ,WAAW,EAAE,QAAQ,CAAC,gBAAgB;wBACtC,YAAY,EAAE,QAAQ,CAAC,iBAAiB;wBACxC,KAAK,EAAE,QAAQ,CAAC,WAAW;wBAC3B,OAAO,EAAE,OAAO,CAAC,OAAO;qBACzB;oBACD,EAAE,EAAE;wBACF,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;qBAC9E;oBACD,IAAI,EAAE;wBACJ,GAAG,EAAE,OAAO,CAAC,GAAG;wBAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;qBAC3B;oBACD,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,UAAU,EAAE,OAAO,CAAC,UAAU;iBAC/B;gBACD,UAAU,EAAE;oBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,KAAK,EAAE,OAAO,CAAC,KAAK;iBACrB;gBACD,YAAY,EAAE,SAAS;aACxB;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}