@segment/action-destinations 3.31.1-alpha.0 → 3.32.0

package/dist/destinations/google-analytics-4/viewItem/index.js

@@ -2,51 +2,141 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
 const constants_1 = require("../constants");
-const ga4_properties_1 = require("../ga4-properties");
 const action = {
     title: 'View Item',
     description: 'Send event when a user views an item',
     defaultSubscription: 'type = "track" and event =  "Product Viewed"',
     fields: {
-        client_id: { ...ga4_properties_1.client_id, required: true },
-        currency: { ...ga4_properties_1.currency, default: { '@path': '$.properties.currency' } },
-        value: { ...ga4_properties_1.value, default: { '@path': '$.properties.value' } },
-        items: {
-            ...ga4_properties_1.items,
+        client_id: {
+            label: 'Client ID',
+            description: 'Uniquely identifies a user instance of a web client.',
+            type: 'string',
             required: true,
             default: {
-                '@arrayPath': [
-                    '$.properties',
-                    {
-                        item_id: {
-                            '@path': '$.product_id'
-                        },
-                        item_name: {
-                            '@path': '$.name'
-                        },
-                        affiliation: {
-                            '@path': '$.affiliation'
-                        },
-                        coupon: {
-                            '@path': '$.coupon'
-                        },
-                        item_brand: {
-                            '@path': '$.brand'
-                        },
-                        item_category: {
-                            '@path': '$.category'
-                        },
-                        item_variant: {
-                            '@path': '$.variant'
-                        },
-                        price: {
-                            '@path': '$.price'
-                        },
-                        quantity: {
-                            '@path': '$.quantity'
-                        }
-                    }
-                ]
+                '@if': {
+                    exists: { '@path': '$.userId' },
+                    then: { '@path': '$.userId' },
+                    else: { '@path': '$.anonymousId' }
+                }
+            }
+        },
+        currency: {
+            label: 'Currency',
+            type: 'string',
+            description: 'Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.',
+            default: {
+                '@path': '$.properties.currency'
+            }
+        },
+        value: {
+            label: 'Value',
+            type: 'number',
+            description: 'The monetary value of the event, in units of the specified currency parameter.',
+            default: {
+                '@path': '$.properties.value'
+            }
+        },
+        items: {
+            label: 'Products',
+            description: 'The list of products in the event.',
+            type: 'object',
+            multiple: true,
+            properties: {
+                item_id: {
+                    label: 'Product ID',
+                    type: 'string',
+                    description: 'Identifier for the product being purchased.'
+                },
+                item_name: {
+                    label: 'Name',
+                    type: 'string',
+                    description: 'Name of the product being purchased.'
+                },
+                affiliation: {
+                    label: 'Affiliation',
+                    type: 'string',
+                    description: 'A product affiliation to designate a supplying company or brick and mortar store location.'
+                },
+                coupon: {
+                    label: 'Coupon',
+                    type: 'string',
+                    description: 'Coupon code used for a purchase.'
+                },
+                currency: {
+                    label: 'Currency',
+                    type: 'string',
+                    description: 'Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.'
+                },
+                discount: {
+                    label: 'Discount',
+                    type: 'number',
+                    description: 'Monetary value of discount associated with a purchase.'
+                },
+                index: {
+                    label: 'Index',
+                    type: 'number',
+                    description: 'The index of the item in a list.'
+                },
+                item_brand: {
+                    label: 'Brand',
+                    type: 'string',
+                    description: 'Brand associated with the product.'
+                },
+                item_category: {
+                    label: 'Category',
+                    type: 'string',
+                    description: 'Category of the product.'
+                },
+                item_category2: {
+                    label: 'Category2',
+                    type: 'string',
+                    description: 'The second category of the product.'
+                },
+                item_category3: {
+                    label: 'Category3',
+                    type: 'string',
+                    description: 'The third category of the product.'
+                },
+                item_category4: {
+                    label: 'Category4',
+                    type: 'string',
+                    description: 'The fourth category of the product.'
+                },
+                item_category5: {
+                    label: 'Category5',
+                    type: 'string',
+                    description: 'The fifth category of the product.'
+                },
+                item_list_id: {
+                    label: 'Item List Name',
+                    type: 'string',
+                    description: 'The ID of the list in which the item was presented to the user.'
+                },
+                item_list_name: {
+                    label: 'Item List Name',
+                    type: 'string',
+                    description: 'The name of the list in which the item was presented to the user.'
+                },
+                item_variant: {
+                    label: 'Variant',
+                    type: 'string',
+                    description: 'Variant of the product (e.g. Black).'
+                },
+                location_id: {
+                    label: 'Location ID',
+                    type: 'string',
+                    description: 'The location associated with the item.'
+                },
+                price: {
+                    label: 'Price',
+                    type: 'number',
+                    description: 'Price of the product being purchased, in units of the specified currency parameter.'
+                },
+                quantity: {
+                    label: 'Quantity',
+                    type: 'integer',
+                    description: 'Item quantity.'
+                }
             }
         }
     },

package/dist/destinations/google-analytics-4/viewItem/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/google-analytics-4/viewItem/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,4CAAiD;AACjD,sDAAqE;AAKrE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,sCAAsC;IACnD,mBAAmB,EAAE,8CAA8C;IACnE,MAAM,EAAE;QACN,SAAS,EAAE,EAAE,GAAG,0BAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3C,QAAQ,EAAE,EAAE,GAAG,yBAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE,EAAE;QACxE,KAAK,EAAE,EAAE,GAAG,sBAAK,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,EAAE;QAC/D,KAAK,EAAE;YACL,GAAG,sBAAK;YACR,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,cAAc;oBACd;wBACE,OAAO,EAAE;4BACP,OAAO,EAAE,cAAc;yBACxB;wBACD,SAAS,EAAE;4BACT,OAAO,EAAE,QAAQ;yBAClB;wBACD,WAAW,EAAE;4BACX,OAAO,EAAE,eAAe;yBACzB;wBACD,MAAM,EAAE;4BACN,OAAO,EAAE,UAAU;yBACpB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,SAAS;yBACnB;wBACD,aAAa,EAAE;4BACb,OAAO,EAAE,YAAY;yBACtB;wBACD,YAAY,EAAE;4BACZ,OAAO,EAAE,WAAW;yBACrB;wBACD,KAAK,EAAE;4BACL,OAAO,EAAE,SAAS;yBACnB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,YAAY;yBACtB;qBACF;iBACF;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACtE,MAAM,IAAI,+BAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;SAC/G;QAED,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,IAAI,CAAC,8BAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACtE,MAAM,IAAI,+BAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;iBAC/G;gBAED,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,SAAS,EAAE,OAAO,CAAC,SAAS;oBAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,YAAY,EAAE,OAAO,CAAC,YAAY;oBAClC,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBACZ,CAAA;YAClB,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,6CAA6C,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE;4BACN,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,KAAK,EAAE,WAAW;4BAClB,KAAK,EAAE,OAAO,CAAC,KAAK;yBACrB;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/google-analytics-4/viewItem/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,4CAAiD;AAKjD,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,sCAAsC;IACnD,mBAAmB,EAAE,8CAA8C;IACnE,MAAM,EAAE;QACN,SAAS,EAAE;YACT,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,sDAAsD;YACnE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;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,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2FAA2F;YACxG,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gFAAgF;YAC7F,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,oCAAoC;YACjD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,KAAK,EAAE,YAAY;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,6CAA6C;iBAC3D;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sCAAsC;iBACpD;gBACD,WAAW,EAAE;oBACX,KAAK,EAAE,aAAa;oBACpB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,4FAA4F;iBAC1G;gBACD,MAAM,EAAE;oBACN,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,kCAAkC;iBAChD;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2FAA2F;iBACzG;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wDAAwD;iBACtE;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,kCAAkC;iBAChD;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oCAAoC;iBAClD;gBACD,aAAa,EAAE;oBACb,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,0BAA0B;iBACxC;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qCAAqC;iBACnD;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oCAAoC;iBAClD;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qCAAqC;iBACnD;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oCAAoC;iBAClD;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,gBAAgB;oBACvB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iEAAiE;iBAC/E;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,gBAAgB;oBACvB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mEAAmE;iBACjF;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sCAAsC;iBACpD;gBACD,WAAW,EAAE;oBACX,KAAK,EAAE,aAAa;oBACpB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wCAAwC;iBACtD;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qFAAqF;iBACnG;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,gBAAgB;iBAC9B;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACtE,MAAM,IAAI,+BAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;SAC/G;QAED,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,IAAI,CAAC,8BAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACtE,MAAM,IAAI,+BAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;iBAC/G;gBAED,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,SAAS,EAAE,OAAO,CAAC,SAAS;oBAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,YAAY,EAAE,OAAO,CAAC,YAAY;oBAClC,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBACZ,CAAA;YAClB,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,6CAA6C,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE;4BACN,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,KAAK,EAAE,WAAW;4BAClB,KAAK,EAAE,OAAO,CAAC,KAAK;yBACrB;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/google-analytics-4/viewItemList/index.js

@@ -2,13 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
 const constants_1 = require("../constants");
-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, required: true },
+        client_id: {
+            label: 'Client ID',
+            description: 'Uniquely identifies a user instance of a web client.',
+            type: 'string',
+            required: true,
+            default: {
+                '@if': {
+                    exists: { '@path': '$.userId' },
+                    then: { '@path': '$.userId' },
+                    else: { '@path': '$.anonymousId' }
+                }
+            }
+        },
         item_list_id: {
             label: 'Item List ID',
             type: 'string',
@@ -26,44 +37,107 @@ const action = {
             }
         },
         items: {
-            ...ga4_properties_1.items,
+            label: 'Products',
+            description: 'The list of products in the event.',
+            type: 'object',
+            multiple: true,
             required: true,
-            default: {
-                '@arrayPath': [
-                    '$.properties.products',
-                    {
-                        item_id: {
-                            '@path': '$.product_id'
-                        },
-                        item_name: {
-                            '@path': '$.name'
-                        },
-                        affiliation: {
-                            '@path': '$.affiliation'
-                        },
-                        coupon: {
-                            '@path': '$.coupon'
-                        },
-                        index: {
-                            '@path': '$.position'
-                        },
-                        item_brand: {
-                            '@path': '$.brand'
-                        },
-                        item_category: {
-                            '@path': '$.category'
-                        },
-                        item_variant: {
-                            '@path': '$.variant'
-                        },
-                        price: {
-                            '@path': '$.price'
-                        },
-                        quantity: {
-                            '@path': '$.quantity'
-                        }
-                    }
-                ]
+            properties: {
+                item_id: {
+                    label: 'Product ID',
+                    type: 'string',
+                    description: 'Identifier for the product being purchased.'
+                },
+                item_name: {
+                    label: 'Name',
+                    type: 'string',
+                    description: 'Name of the product being purchased.'
+                },
+                affiliation: {
+                    label: 'Affiliation',
+                    type: 'string',
+                    description: 'A product affiliation to designate a supplying company or brick and mortar store location.'
+                },
+                coupon: {
+                    label: 'Coupon',
+                    type: 'string',
+                    description: 'Coupon code used for a purchase.'
+                },
+                currency: {
+                    label: 'Currency',
+                    type: 'string',
+                    description: 'Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.'
+                },
+                discount: {
+                    label: 'Discount',
+                    type: 'number',
+                    description: 'Monetary value of discount associated with a purchase.'
+                },
+                index: {
+                    label: 'Index',
+                    type: 'number',
+                    description: 'The index/position of the item in a list.'
+                },
+                item_brand: {
+                    label: 'Brand',
+                    type: 'string',
+                    description: 'Brand associated with the product.'
+                },
+                item_category: {
+                    label: 'Category',
+                    type: 'string',
+                    description: 'The category of the item.'
+                },
+                item_category2: {
+                    label: 'Category 2',
+                    type: 'string',
+                    description: 'The second category hierarchy or additional taxonomy for the item.'
+                },
+                item_category3: {
+                    label: 'Category 3',
+                    type: 'string',
+                    description: 'The third category hierarchy or additional taxonomy for the item.'
+                },
+                item_category4: {
+                    label: 'Category 4',
+                    type: 'string',
+                    description: 'The fourth category hierarchy or additional taxonomy for the item.'
+                },
+                item_category5: {
+                    label: 'Category 5',
+                    type: 'string',
+                    description: 'The fifth category hierarchy or additional taxonomy for the item.'
+                },
+                item_list_id: {
+                    label: 'Item List ID',
+                    type: 'string',
+                    description: 'The ID of the list in which the item was presented to the user.'
+                },
+                item_list_name: {
+                    label: 'Item List Name',
+                    type: 'string',
+                    description: 'The name of the list in which the item was presented to the user.'
+                },
+                item_variant: {
+                    label: 'Variant',
+                    type: 'string',
+                    description: 'Variant of the product (e.g. Black).'
+                },
+                location_id: {
+                    label: 'Location ID',
+                    type: 'string',
+                    description: 'The location associated with the item.'
+                },
+                price: {
+                    label: 'Price',
+                    type: 'number',
+                    description: 'Price of the product being purchased, in units of the specified currency parameter.'
+                },
+                quantity: {
+                    label: 'Quantity',
+                    type: 'number',
+                    description: 'Item Quantity'
+                }
             }
         }
     },

package/dist/destinations/google-analytics-4/viewItemList/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/google-analytics-4/viewItemList/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,4CAAiD;AACjD,sDAAoD;AASpD,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,QAAQ,EAAE,IAAI,EAAE;QAC3C,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,sBAAK;YACR,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,uBAAuB;oBACvB;wBACE,OAAO,EAAE;4BACP,OAAO,EAAE,cAAc;yBACxB;wBACD,SAAS,EAAE;4BACT,OAAO,EAAE,QAAQ;yBAClB;wBACD,WAAW,EAAE;4BACX,OAAO,EAAE,eAAe;yBACzB;wBACD,MAAM,EAAE;4BACN,OAAO,EAAE,UAAU;yBACpB;wBACD,KAAK,EAAE;4BACL,OAAO,EAAE,YAAY;yBACtB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,SAAS;yBACnB;wBACD,aAAa,EAAE;4BACb,OAAO,EAAE,YAAY;yBACtB;wBACD,YAAY,EAAE;4BACZ,OAAO,EAAE,WAAW;yBACrB;wBACD,KAAK,EAAE;4BACL,OAAO,EAAE,SAAS;yBACnB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,YAAY;yBACtB;qBACF;iBACF;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,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,IAAI,CAAC,8BAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACtE,MAAM,IAAI,+BAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;iBAC/G;gBAED,OAAO,OAAsB,CAAA;YAC/B,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,6CAA6C,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,gBAAgB;wBACtB,MAAM,EAAE;4BACN,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,cAAc,EAAE,OAAO,CAAC,cAAc;4BACtC,KAAK,EAAE,WAAW;yBACnB;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/google-analytics-4/viewItemList/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,4CAAiD;AASjD,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,2DAA2D;IACxE,mBAAmB,EAAE,kDAAkD;IACvE,MAAM,EAAE;QACN,SAAS,EAAE;YACT,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,sDAAsD;YACnE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;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,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,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,oCAAoC;YACjD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,KAAK,EAAE,YAAY;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,6CAA6C;iBAC3D;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sCAAsC;iBACpD;gBACD,WAAW,EAAE;oBACX,KAAK,EAAE,aAAa;oBACpB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,4FAA4F;iBAC1G;gBACD,MAAM,EAAE;oBACN,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,kCAAkC;iBAChD;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2FAA2F;iBACzG;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wDAAwD;iBACtE;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2CAA2C;iBACzD;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oCAAoC;iBAClD;gBACD,aAAa,EAAE;oBACb,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2BAA2B;iBACzC;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,YAAY;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oEAAoE;iBAClF;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,YAAY;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mEAAmE;iBACjF;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,YAAY;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oEAAoE;iBAClF;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,YAAY;oBACnB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mEAAmE;iBACjF;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iEAAiE;iBAC/E;gBACD,cAAc,EAAE;oBACd,KAAK,EAAE,gBAAgB;oBACvB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mEAAmE;iBACjF;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sCAAsC;iBACpD;gBACD,WAAW,EAAE;oBACX,KAAK,EAAE,aAAa;oBACpB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wCAAwC;iBACtD;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qFAAqF;iBACnG;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,eAAe;iBAC7B;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,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,IAAI,CAAC,8BAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACtE,MAAM,IAAI,+BAAgB,CAAC,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;iBAC/G;gBAED,OAAO,OAAsB,CAAA;YAC/B,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,6CAA6C,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,gBAAgB;wBACtB,MAAM,EAAE;4BACN,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,cAAc,EAAE,OAAO,CAAC,cAAc;4BACtC,KAAK,EAAE,WAAW;yBACnB;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/google-analytics-4/viewPromotion/generated-types.d.ts

@@ -11,6 +11,8 @@ export interface Payload {
         affiliation?: string;
         coupon?: string;
         currency?: string;
+        creative_name?: string;
+        creative_slot?: string;
         discount?: number;
         index?: number;
         item_brand?: string;
@@ -24,10 +26,8 @@ export interface Payload {
         item_variant?: string;
         location_id?: string;
         price?: number;
-        quantity?: number;
-        creative_name?: string;
-        creative_slot?: string;
-        promotion_name?: string;
         promotion_id?: string;
+        promotion_name?: string;
+        quantity?: number;
     }[];
 }

package/dist/destinations/google-analytics-4/viewPromotion/index.js

@@ -2,15 +2,37 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
 const constants_1 = require("../constants");
-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, required: true },
-        creative_name: { ...ga4_properties_1.creative_name },
-        creative_slot: { ...ga4_properties_1.creative_slot, default: { '@path': '$.properties.creative' } },
+        client_id: {
+            label: 'Client ID',
+            description: 'Uniquely identifies a user instance of a web client.',
+            type: 'string',
+            required: true,
+            default: {
+                '@if': {
+                    exists: { '@path': '$.userId' },
+                    then: { '@path': '$.userId' },
+                    else: { '@path': '$.anonymousId' }
+                }
+            }
+        },
+        creative_name: {
+            label: 'Creative Name',
+            type: 'string',
+            description: 'The name of the promotional creative.'
+        },
+        creative_slot: {
+            label: 'Creative Slot',
+            type: 'string',
+            description: 'The name of the promotional creative slot associated with the event.',
+            default: {
+                '@path': '$.properties.creative'
+            }
+        },
         location_id: {
             label: 'Location ID',
             type: 'string',
@@ -19,59 +41,144 @@ const action = {
                 '@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' } },
+        promotion_id: {
+            label: 'Promotion ID',
+            type: 'string',
+            description: 'The ID of the promotion associated with the event.',
+            default: {
+                '@path': '$.properties.promotion_id'
+            }
+        },
+        promotion_name: {
+            label: 'Promotion Name',
+            type: 'string',
+            description: 'The name of the promotion associated with the event.',
+            default: {
+                '@path': '$.properties.name'
+            }
+        },
         items: {
-            ...ga4_properties_1.items,
+            label: 'Products',
+            description: 'The list of products in the event.',
+            type: 'object',
+            multiple: true,
             required: true,
             properties: {
-                ...ga4_properties_1.items.properties,
+                item_id: {
+                    label: 'Product ID',
+                    type: 'string',
+                    description: 'Identifier for the product being purchased.'
+                },
+                item_name: {
+                    label: 'Name',
+                    type: 'string',
+                    description: 'Name of the product being purchased.'
+                },
+                affiliation: {
+                    label: 'Affiliation',
+                    type: 'string',
+                    description: 'A product affiliation to designate a supplying company or brick and mortar store location.'
+                },
+                coupon: {
+                    label: 'Coupon',
+                    type: 'string',
+                    description: 'Coupon code used for a purchase.'
+                },
+                currency: {
+                    label: 'Currency',
+                    type: 'string',
+                    description: 'Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.'
+                },
                 creative_name: {
-                    ...ga4_properties_1.creative_name
+                    label: 'Creative Name',
+                    type: 'string',
+                    description: 'The name of the promotional creative.'
                 },
                 creative_slot: {
-                    ...ga4_properties_1.creative_slot
+                    label: 'Creative Slot',
+                    type: 'string',
+                    description: 'The name of the promotional creative slot associated with the item.'
                 },
-                promotion_name: {
-                    ...ga4_properties_1.promotion_name
+                discount: {
+                    label: 'Discount',
+                    type: 'number',
+                    description: 'Monetary value of discount associated with a purchase.'
+                },
+                index: {
+                    label: 'Index',
+                    type: 'number',
+                    description: 'The index/position of the item in a list.'
+                },
+                item_brand: {
+                    label: 'Brand',
+                    type: 'string',
+                    description: 'Brand associated with the product.'
+                },
+                item_category: {
+                    label: 'Category',
+                    type: 'string',
+                    description: 'The category of the item.'
+                },
+                item_category2: {
+                    label: 'Category 2',
+                    type: 'string',
+                    description: 'The second category hierarchy or additional taxonomy for the item.'
+                },
+                item_category3: {
+                    label: 'Category 3',
+                    type: 'string',
+                    description: 'The third category hierarchy or additional taxonomy for the item.'
+                },
+                item_category4: {
+                    label: 'Category 4',
+                    type: 'string',
+                    description: 'The fourth category hierarchy or additional taxonomy for the item.'
+                },
+                item_category5: {
+                    label: 'Category 5',
+                    type: 'string',
+                    description: 'The fifth category hierarchy or additional taxonomy for the item.'
+                },
+                item_list_id: {
+                    label: 'Item List ID',
+                    type: 'string',
+                    description: 'The ID of the list in which the item was presented to the user.'
+                },
+                item_list_name: {
+                    label: 'Item List Name',
+                    type: 'string',
+                    description: 'The name of the list in which the item was presented to the user.'
+                },
+                item_variant: {
+                    label: 'Variant',
+                    type: 'string',
+                    description: 'Variant of the product (e.g. Black).'
+                },
+                location_id: {
+                    label: 'Location ID',
+                    type: 'string',
+                    description: 'The location associated with the item.'
+                },
+                price: {
+                    label: 'Price',
+                    type: 'number',
+                    description: 'Price of the product being purchased, in units of the specified currency parameter.'
                 },
                 promotion_id: {
-                    ...ga4_properties_1.promotion_id
+                    label: 'Promotion ID',
+                    type: 'string',
+                    description: 'The ID of the promotion associated with the item.'
+                },
+                promotion_name: {
+                    label: 'Promotion Name',
+                    type: 'string',
+                    description: 'The name of the promotion associated with the item.'
+                },
+                quantity: {
+                    label: 'Quantity',
+                    type: 'number',
+                    description: 'Item Quantity'
                 }
-            },
-            default: {
-                '@arrayPath': [
-                    '$.properties',
-                    {
-                        item_id: {
-                            '@path': '$.product_id'
-                        },
-                        item_name: {
-                            '@path': '$.name'
-                        },
-                        affiliation: {
-                            '@path': '$.affiliation'
-                        },
-                        coupon: {
-                            '@path': '$.coupon'
-                        },
-                        item_brand: {
-                            '@path': '$.brand'
-                        },
-                        item_category: {
-                            '@path': '$.category'
-                        },
-                        item_variant: {
-                            '@path': '$.variant'
-                        },
-                        price: {
-                            '@path': '$.price'
-                        },
-                        quantity: {
-                            '@path': '$.quantity'
-                        }
-                    }
-                ]
             }
         }
     },