@segment/action-destinations 3.141.0 → 3.142.0

package/dist/destinations/revend/viewItemList/generated-types.d.ts

@@ -0,0 +1,35 @@
+export interface Payload {
+    client_id: string;
+    user_id?: string;
+    timestamp_micros?: string;
+    item_list_id?: string;
+    item_list_name?: string;
+    items: {
+        item_id?: string;
+        item_name?: string;
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        discount?: number;
+        index?: number;
+        item_brand?: string;
+        item_category?: string;
+        item_category2?: string;
+        item_category3?: string;
+        item_category4?: string;
+        item_category5?: string;
+        item_list_id?: string;
+        item_list_name?: string;
+        item_variant?: string;
+        location_id?: string;
+        price?: number;
+        quantity?: number;
+    }[];
+    user_properties?: {
+        [k: string]: unknown;
+    };
+    engagement_time_msec?: number;
+    params?: {
+        [k: string]: unknown;
+    };
+}

package/dist/destinations/revend/viewItemList/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/revend/viewItemList/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../src/destinations/revend/viewItemList/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/revend/viewItemList/index.d.ts

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

package/dist/destinations/revend/viewItemList/index.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const ga4_functions_1 = require("../ga4-functions");
+const ga4_properties_1 = require("../ga4-properties");
+const action = {
+    title: 'View Item List',
+    description: 'Send event when a user views a list of items or offerings',
+    defaultSubscription: 'type = "track" and event = "Product List Viewed"',
+    fields: {
+        client_id: { ...ga4_properties_1.client_id },
+        user_id: { ...ga4_properties_1.user_id },
+        timestamp_micros: { ...ga4_properties_1.timestamp_micros },
+        item_list_id: {
+            label: 'Item List ID',
+            type: 'string',
+            description: 'The ID of the list in which the item was presented to the user.',
+            default: {
+                '@path': `$.properties.list_id`
+            }
+        },
+        item_list_name: {
+            label: 'Item List Name',
+            type: 'string',
+            description: 'The name of the list in which the item was presented to the user.',
+            default: {
+                '@path': '$.properties.category'
+            }
+        },
+        items: {
+            ...ga4_properties_1.items_multi_products,
+            required: true
+        },
+        user_properties: ga4_properties_1.user_properties,
+        engagement_time_msec: ga4_properties_1.engagement_time_msec,
+        params: ga4_properties_1.params
+    },
+    perform: (request, { payload, features }) => {
+        let googleItems = [];
+        if (payload.items) {
+            googleItems = payload.items.map((product) => {
+                if (product.item_name === undefined && product.item_id === undefined) {
+                    throw new actions_core_1.IntegrationError('One of product name or product id is required for product or impression data.', 'Misconfigured required field', 400);
+                }
+                if (product.currency) {
+                    ga4_functions_1.verifyCurrency(product.currency);
+                }
+                return product;
+            });
+        }
+        if (features && features['actions-google-analytics-4-verify-params-feature']) {
+            ga4_functions_1.verifyParams(payload.params);
+            ga4_functions_1.verifyUserProps(payload.user_properties);
+        }
+        const request_object = {
+            client_id: payload.client_id,
+            user_id: payload.user_id,
+            events: [
+                {
+                    name: 'view_item_list',
+                    params: {
+                        item_list_id: payload.item_list_id,
+                        item_list_name: payload.item_list_name,
+                        items: googleItems,
+                        engagement_time_msec: payload.engagement_time_msec,
+                        ...payload.params
+                    }
+                }
+            ],
+            ...ga4_properties_1.formatUserProperties(payload.user_properties)
+        };
+        if (features && features['actions-google-analytics-4-add-timestamp']) {
+            request_object.timestamp_micros = ga4_functions_1.convertTimestamp(payload.timestamp_micros);
+        }
+        return request('https://gtmadapter-node-cbjg5cz5hq-ew.a.run.app/v2/consolidated-data', {
+            method: 'POST',
+            json: request_object
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/revend/viewItemList/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/revend/viewItemList/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,oDAAkG;AAClG,sDAS0B;AAS1B,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,2DAA2D;IACxE,mBAAmB,EAAE,kDAAkD;IACvE,MAAM,EAAE;QACN,SAAS,EAAE,EAAE,GAAG,0BAAS,EAAE;QAC3B,OAAO,EAAE,EAAE,GAAG,wBAAO,EAAE;QACvB,gBAAgB,EAAE,EAAE,GAAG,iCAAgB,EAAE;QACzC,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iEAAiE;YAC9E,OAAO,EAAE;gBACP,OAAO,EAAE,sBAAsB;aAChC;SACF;QACD,cAAc,EAAE;YACd,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mEAAmE;YAChF,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,GAAG,qCAAoB;YACvB,QAAQ,EAAE,IAAI;SACf;QACD,eAAe,EAAE,gCAAe;QAChC,oBAAoB,EAAE,qCAAoB;QAC1C,MAAM,EAAE,uBAAM;KACf;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,WAAW,GAAkB,EAAE,CAAA;QAEnC,IAAI,OAAO,CAAC,KAAK,EAAE;YACjB,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC1C,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE;oBACpE,MAAM,IAAI,+BAAgB,CACxB,+EAA+E,EAC/E,8BAA8B,EAC9B,GAAG,CACJ,CAAA;iBACF;gBAED,IAAI,OAAO,CAAC,QAAQ,EAAE;oBACpB,8BAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;iBACjC;gBAED,OAAO,OAAsB,CAAA;YAC/B,CAAC,CAAC,CAAA;SACH;QAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,kDAAkD,CAAC,EAAE;YAC5E,4BAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAC5B,+BAAe,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;SACzC;QACD,MAAM,cAAc,GAA2B;YAC7C,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,gBAAgB;oBACtB,MAAM,EAAE;wBACN,YAAY,EAAE,OAAO,CAAC,YAAY;wBAClC,cAAc,EAAE,OAAO,CAAC,cAAc;wBACtC,KAAK,EAAE,WAAW;wBAClB,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;wBAClD,GAAG,OAAO,CAAC,MAAM;qBAClB;iBACF;aACF;YACD,GAAG,qCAAoB,CAAC,OAAO,CAAC,eAAe,CAAC;SACjD,CAAA;QAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,0CAA0C,CAAC,EAAE;YACpE,cAAc,CAAC,gBAAgB,GAAG,gCAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;SAC7E;QAED,OAAO,OAAO,CAAC,sEAAsE,EAAE;YACrF,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;SACrB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/revend/viewPromotion/generated-types.d.ts

@@ -0,0 +1,42 @@
+export interface Payload {
+    client_id: string;
+    user_id?: string;
+    timestamp_micros?: string;
+    creative_name?: string;
+    creative_slot?: string;
+    location_id?: string;
+    promotion_id?: string;
+    promotion_name?: string;
+    items: {
+        item_id?: string;
+        item_name?: string;
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        discount?: number;
+        index?: number;
+        item_brand?: string;
+        item_category?: string;
+        item_category2?: string;
+        item_category3?: string;
+        item_category4?: string;
+        item_category5?: string;
+        item_list_id?: string;
+        item_list_name?: string;
+        item_variant?: string;
+        location_id?: string;
+        price?: number;
+        quantity?: number;
+        creative_name?: string;
+        creative_slot?: string;
+        promotion_name?: string;
+        promotion_id?: string;
+    }[];
+    user_properties?: {
+        [k: string]: unknown;
+    };
+    engagement_time_msec?: number;
+    params?: {
+        [k: string]: unknown;
+    };
+}

package/dist/destinations/revend/viewPromotion/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/revend/viewPromotion/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../src/destinations/revend/viewPromotion/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/revend/viewPromotion/index.d.ts

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

package/dist/destinations/revend/viewPromotion/index.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const ga4_functions_1 = require("../ga4-functions");
+const ga4_properties_1 = require("../ga4-properties");
+const action = {
+    title: 'View Promotion',
+    description: 'Send event when a promotion is shown to a user',
+    defaultSubscription: 'type = "track" and event = "Promotion Viewed"',
+    fields: {
+        client_id: { ...ga4_properties_1.client_id },
+        user_id: { ...ga4_properties_1.user_id },
+        timestamp_micros: { ...ga4_properties_1.timestamp_micros },
+        creative_name: { ...ga4_properties_1.creative_name },
+        creative_slot: { ...ga4_properties_1.creative_slot, default: { '@path': '$.properties.creative' } },
+        location_id: {
+            label: 'Location ID',
+            type: 'string',
+            description: 'The ID of the location.',
+            default: {
+                '@path': '$.properties.position'
+            }
+        },
+        promotion_id: { ...ga4_properties_1.promotion_id, default: { '@path': '$.properties.promotion_id' } },
+        promotion_name: { ...ga4_properties_1.promotion_name, default: { '@path': '$.properties.name' } },
+        items: {
+            ...ga4_properties_1.items_single_products,
+            required: true,
+            properties: {
+                ...ga4_properties_1.minimal_items.properties,
+                creative_name: {
+                    ...ga4_properties_1.creative_name
+                },
+                creative_slot: {
+                    ...ga4_properties_1.creative_slot
+                },
+                promotion_name: {
+                    ...ga4_properties_1.promotion_name
+                },
+                promotion_id: {
+                    ...ga4_properties_1.promotion_id
+                }
+            }
+        },
+        user_properties: ga4_properties_1.user_properties,
+        engagement_time_msec: ga4_properties_1.engagement_time_msec,
+        params: ga4_properties_1.params
+    },
+    perform: (request, { payload, features }) => {
+        let googleItems = [];
+        if (payload.items) {
+            googleItems = payload.items.map((product) => {
+                if (product.item_name === undefined && product.item_id === undefined) {
+                    throw new actions_core_1.IntegrationError('One of item id or item name is required.', 'Misconfigured required field', 400);
+                }
+                if (product.currency) {
+                    ga4_functions_1.verifyCurrency(product.currency);
+                }
+                return product;
+            });
+        }
+        if (features && features['actions-google-analytics-4-verify-params-feature']) {
+            ga4_functions_1.verifyParams(payload.params);
+            ga4_functions_1.verifyUserProps(payload.user_properties);
+        }
+        const request_object = {
+            client_id: payload.client_id,
+            user_id: payload.user_id,
+            events: [
+                {
+                    name: 'view_promotion',
+                    params: {
+                        creative_name: payload.creative_name,
+                        creative_slot: payload.creative_slot,
+                        location_id: payload.location_id,
+                        promotion_id: payload.promotion_id,
+                        promotion_name: payload.promotion_name,
+                        items: googleItems,
+                        engagement_time_msec: payload.engagement_time_msec,
+                        ...payload.params
+                    }
+                }
+            ],
+            ...ga4_properties_1.formatUserProperties(payload.user_properties)
+        };
+        if (features && features['actions-google-analytics-4-add-timestamp']) {
+            request_object.timestamp_micros = ga4_functions_1.convertTimestamp(payload.timestamp_micros);
+        }
+        return request('https://gtmadapter-node-cbjg5cz5hq-ew.a.run.app/v2/consolidated-data', {
+            method: 'POST',
+            json: request_object
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/revend/viewPromotion/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/revend/viewPromotion/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,oDAAkG;AAClG,sDAc0B;AAS1B,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,gDAAgD;IAC7D,mBAAmB,EAAE,+CAA+C;IACpE,MAAM,EAAE;QACN,SAAS,EAAE,EAAE,GAAG,0BAAS,EAAE;QAC3B,OAAO,EAAE,EAAE,GAAG,wBAAO,EAAE;QACvB,gBAAgB,EAAE,EAAE,GAAG,iCAAgB,EAAE;QACzC,aAAa,EAAE,EAAE,GAAG,8BAAa,EAAE;QACnC,aAAa,EAAE,EAAE,GAAG,8BAAa,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE,EAAE;QAClF,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,yBAAyB;YACtC,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,YAAY,EAAE,EAAE,GAAG,6BAAY,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE,EAAE;QACpF,cAAc,EAAE,EAAE,GAAG,+BAAc,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE,EAAE;QAChF,KAAK,EAAE;YACL,GAAG,sCAAqB;YACxB,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE;gBACV,GAAG,8BAAa,CAAC,UAAU;gBAC3B,aAAa,EAAE;oBACb,GAAG,8BAAa;iBACjB;gBACD,aAAa,EAAE;oBACb,GAAG,8BAAa;iBACjB;gBACD,cAAc,EAAE;oBACd,GAAG,+BAAc;iBAClB;gBACD,YAAY,EAAE;oBACZ,GAAG,6BAAY;iBAChB;aACF;SACF;QACD,eAAe,EAAE,gCAAe;QAChC,oBAAoB,EAAE,qCAAoB;QAC1C,MAAM,EAAE,uBAAM;KACf;IAED,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,WAAW,GAA2B,EAAE,CAAA;QAE5C,IAAI,OAAO,CAAC,KAAK,EAAE;YACjB,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC1C,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE;oBACpE,MAAM,IAAI,+BAAgB,CAAC,0CAA0C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;iBAC5G;gBAED,IAAI,OAAO,CAAC,QAAQ,EAAE;oBACpB,8BAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;iBACjC;gBAED,OAAO,OAA+B,CAAA;YACxC,CAAC,CAAC,CAAA;SACH;QAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,kDAAkD,CAAC,EAAE;YAC5E,4BAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAC5B,+BAAe,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;SACzC;QACD,MAAM,cAAc,GAA2B;YAC7C,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,gBAAgB;oBACtB,MAAM,EAAE;wBACN,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,YAAY,EAAE,OAAO,CAAC,YAAY;wBAClC,cAAc,EAAE,OAAO,CAAC,cAAc;wBACtC,KAAK,EAAE,WAAW;wBAClB,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;wBAClD,GAAG,OAAO,CAAC,MAAM;qBAClB;iBACF;aACF;YACD,GAAG,qCAAoB,CAAC,OAAO,CAAC,eAAe,CAAC;SACjD,CAAA;QAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,0CAA0C,CAAC,EAAE;YACpE,cAAc,CAAC,gBAAgB,GAAG,gCAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;SAC7E;QAED,OAAO,OAAO,CAAC,sEAAsE,EAAE;YACrF,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;SACrB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.141.0",
+  "version": "3.142.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -39,8 +39,8 @@
   "dependencies": {
     "@amplitude/ua-parser-js": "^0.7.25",
     "@segment/a1-notation": "^2.1.4",
-    "@segment/actions-core": "^3.56.0",
-    "@segment/actions-shared": "^1.38.0",
+    "@segment/actions-core": "^3.57.0",
+    "@segment/actions-shared": "^1.39.0",
     "@types/node": "^18.11.15",
     "cheerio": "^1.0.0-rc.10",
     "dayjs": "^1.10.7",
@@ -68,5 +68,5 @@
       "lcov"
     ]
   },
-  "gitHead": "0ebaa62b746894b224730ac2e76c9ae1e93b43e8"
+  "gitHead": "4a72049613a83ea7e80e288b0fd4080577c8ad44"
 }