@segment/analytics-browser-actions-google-analytics-4 1.0.0 → 1.3.0

package/dist/cjs/ga4-properties.js

@@ -0,0 +1,346 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.items_multi_products = exports.items_single_products = exports.minimal_items = exports.location_id = exports.item_list_id = exports.item_list_name = exports.search_term = exports.method = exports.payment_type = exports.coupon = exports.value = exports.currency = exports.client_id = exports.affiliation = exports.transaction_id = exports.shipping = exports.tax = exports.creative_name = exports.creative_slot = exports.promotion_name = exports.promotion_id = exports.user_id = exports.params = exports.user_properties = exports.formatUserProperties = void 0;
+const formatUserProperties = (userProperties) => {
+    if (!userProperties) {
+        return undefined;
+    }
+    let properties = {};
+    Object.entries(userProperties).forEach(([key, value]) => {
+        properties = { ...properties, ...{ [key]: { value: value } } };
+    });
+    return { user_properties: properties };
+};
+exports.formatUserProperties = formatUserProperties;
+exports.user_properties = {
+    label: 'User Properties',
+    description: 'The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties. ',
+    type: 'object',
+    additionalProperties: true,
+    defaultObjectUI: 'keyvalue'
+};
+exports.params = {
+    label: 'Event Parameters',
+    description: 'The event parameters to send to Google Analytics 4.',
+    type: 'object',
+    additionalProperties: true,
+    defaultObjectUI: 'keyvalue'
+};
+exports.user_id = {
+    label: 'User ID',
+    type: 'string',
+    description: "A unique identifier for a user. See Google's [User-ID for cross-platform analysis](https://support.google.com/analytics/answer/9213390) and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en) documentation for more information on this identifier."
+};
+exports.promotion_id = {
+    label: 'Promotion ID',
+    type: 'string',
+    description: 'The ID of the promotion associated with the event.'
+};
+exports.promotion_name = {
+    label: 'Promotion Name',
+    type: 'string',
+    description: 'The name of the promotion associated with the event.'
+};
+exports.creative_slot = {
+    label: 'Creative Slot',
+    type: 'string',
+    description: 'The name of the promotional creative slot associated with the event.'
+};
+exports.creative_name = {
+    label: 'Creative Name',
+    type: 'string',
+    description: 'The name of the promotional creative.'
+};
+exports.tax = {
+    label: 'Tax',
+    type: 'number',
+    description: 'Total tax associated with the transaction.',
+    default: {
+        '@path': '$.properties.tax'
+    }
+};
+exports.shipping = {
+    label: 'Shipping',
+    type: 'number',
+    description: 'Shipping cost associated with the transaction.',
+    default: {
+        '@path': '$.properties.shipping'
+    }
+};
+exports.transaction_id = {
+    label: 'Order Id',
+    type: 'string',
+    description: 'The unique identifier of a transaction.',
+    default: {
+        '@path': '$.properties.order_id'
+    }
+};
+exports.affiliation = {
+    label: 'Affiliation',
+    type: 'string',
+    description: 'Store or affiliation from which this transaction occurred (e.g. Google Store).',
+    default: {
+        '@path': '$.properties.affiliation'
+    }
+};
+exports.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' }
+        }
+    }
+};
+exports.currency = {
+    label: 'Currency',
+    type: 'string',
+    description: 'Currency of the items associated with the event, in 3-letter ISO 4217 format.',
+    default: { '@path': '$.properties.currency' }
+};
+exports.value = {
+    label: 'Value',
+    type: 'number',
+    description: 'The monetary value of the event.',
+    default: {
+        '@path': '$.properties.value'
+    }
+};
+exports.coupon = {
+    label: 'Coupon',
+    type: 'string',
+    description: 'Coupon code used for a purchase.'
+};
+exports.payment_type = {
+    label: 'Payment Type',
+    type: 'string',
+    description: 'The chosen method of payment.',
+    default: {
+        '@path': '$.properties.payment_method'
+    }
+};
+exports.method = {
+    label: 'Method',
+    type: 'string',
+    description: 'The method used to login.',
+    default: {
+        '@path': '$.properties.method'
+    }
+};
+exports.search_term = {
+    label: 'Search Term',
+    type: 'string',
+    description: 'The term that was searched for.',
+    default: {
+        '@path': `$.properties.query`
+    }
+};
+exports.item_list_name = {
+    label: 'Item List Name',
+    description: 'The name of the list in which the item was presented to the user.',
+    type: 'string',
+    default: {
+        '@path': `$.properties.item_list_name`
+    }
+};
+exports.item_list_id = {
+    label: 'Item List Id',
+    description: 'The ID of the list in which the item was presented to the user.',
+    type: 'string',
+    default: {
+        '@path': `$.properties.item_list_id`
+    }
+};
+exports.location_id = {
+    label: 'Location ID',
+    type: 'string',
+    description: 'The ID of the location.',
+    default: {
+        '@path': '$.properties.position'
+    }
+};
+exports.minimal_items = {
+    label: 'Products',
+    description: 'The list of products purchased.',
+    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/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: 'Product category.'
+        },
+        item_category2: {
+            label: 'Category 2',
+            type: 'string',
+            description: 'Product category 2.'
+        },
+        item_category3: {
+            label: 'Category 3',
+            type: 'string',
+            description: 'Product category 3.'
+        },
+        item_category4: {
+            label: 'Category 4',
+            type: 'string',
+            description: 'Product category 4.'
+        },
+        item_category5: {
+            label: 'Category 5',
+            type: 'string',
+            description: 'Product category 5.'
+        },
+        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: 'integer',
+            description: 'Item quantity.'
+        }
+    }
+};
+exports.items_single_products = {
+    ...exports.minimal_items,
+    default: {
+        '@arrayPath': [
+            '$.properties.products',
+            {
+                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'
+                }
+            }
+        ]
+    }
+};
+exports.items_multi_products = {
+    ...exports.minimal_items,
+    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'
+                }
+            }
+        ]
+    }
+};
+//# sourceMappingURL=ga4-properties.js.map

package/dist/cjs/ga4-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ga4-properties.js","sourceRoot":"","sources":["../../src/ga4-properties.ts"],"names":[],"mappings":";;;AAEO,MAAM,oBAAoB,GAAG,CAAC,cAAkC,EAAsB,EAAE;IAC7F,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO,SAAS,CAAA;KACjB;IAED,IAAI,UAAU,GAAG,EAAE,CAAA;IAEnB,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtD,UAAU,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IAChE,CAAC,CAAC,CAAA;IAEF,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,CAAA;AACxC,CAAC,CAAA;AAZY,QAAA,oBAAoB,wBAYhC;AAEY,QAAA,eAAe,GAAe;IACzC,KAAK,EAAE,iBAAiB;IACxB,WAAW,EACT,8RAA8R;IAChS,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,UAAU;CAC5B,CAAA;AAEY,QAAA,MAAM,GAAe;IAChC,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,qDAAqD;IAClE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,eAAe,EAAE,UAAU;CAC5B,CAAA;AACY,QAAA,OAAO,GAAe;IACjC,KAAK,EAAE,SAAS;IAChB,IAAI,EAAE,QAAQ;IACd,WAAW,EACT,oSAAoS;CACvS,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,oDAAoD;CAClE,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,gBAAgB;IACvB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,sDAAsD;CACpE,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,eAAe;IACtB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,sEAAsE;CACpF,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,eAAe;IACtB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,uCAAuC;CACrD,CAAA;AAEY,QAAA,GAAG,GAAe;IAC7B,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,4CAA4C;IACzD,OAAO,EAAE;QACP,OAAO,EAAE,kBAAkB;KAC5B;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,gDAAgD;IAC7D,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,UAAU;IACjB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,yCAAyC;IACtD,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,WAAW,GAAe;IACrC,KAAK,EAAE,aAAa;IACpB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,gFAAgF;IAC7F,OAAO,EAAE;QACP,OAAO,EAAE,0BAA0B;KACpC;CACF,CAAA;AAEY,QAAA,SAAS,GAAe;IACnC,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,sDAAsD;IACnE,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;YAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;YAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;SACnC;KACF;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,+EAA+E;IAC5F,OAAO,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;CAC9C,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,kCAAkC;IAC/C,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,MAAM,GAAe;IAChC,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,kCAAkC;CAChD,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,+BAA+B;IAC5C,OAAO,EAAE;QACP,OAAO,EAAE,6BAA6B;KACvC;CACF,CAAA;AAEY,QAAA,MAAM,GAAe;IAChC,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,2BAA2B;IACxC,OAAO,EAAE;QACP,OAAO,EAAE,qBAAqB;KAC/B;CACF,CAAA;AAEY,QAAA,WAAW,GAAe;IACrC,KAAK,EAAE,aAAa;IACpB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,iCAAiC;IAC9C,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,mEAAmE;IAChF,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,6BAA6B;KACvC;CACF,CAAA;AACY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,iEAAiE;IAC9E,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,2BAA2B;KACrC;CACF,CAAA;AACY,QAAA,WAAW,GAAe;IACrC,KAAK,EAAE,aAAa;IACpB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,yBAAyB;IACtC,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,iCAAiC;IAC9C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE;QACV,OAAO,EAAE;YACP,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6CAA6C;SAC3D;QACD,SAAS,EAAE;YACT,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sCAAsC;SACpD;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,4FAA4F;SAC1G;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;SAChD;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2FAA2F;SACzG;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wDAAwD;SACtE;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2CAA2C;SACzD;QACD,UAAU,EAAE;YACV,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;SAClD;QACD,aAAa,EAAE;YACb,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mBAAmB;SACjC;QACD,cAAc,EAAE;YACd,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qBAAqB;SACnC;QACD,cAAc,EAAE;YACd,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qBAAqB;SACnC;QACD,cAAc,EAAE;YACd,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qBAAqB;SACnC;QACD,cAAc,EAAE;YACd,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qBAAqB;SACnC;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iEAAiE;SAC/E;QACD,cAAc,EAAE;YACd,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mEAAmE;SACjF;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sCAAsC;SACpD;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,qFAAqF;SACnG;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,gBAAgB;SAC9B;KACF;CACF,CAAA;AAEY,QAAA,qBAAqB,GAAe;IAC/C,GAAG,qBAAa;IAChB,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,OAAO,EAAE;oBACP,OAAO,EAAE,cAAc;iBACxB;gBACD,SAAS,EAAE;oBACT,OAAO,EAAE,QAAQ;iBAClB;gBACD,WAAW,EAAE;oBACX,OAAO,EAAE,eAAe;iBACzB;gBACD,MAAM,EAAE;oBACN,OAAO,EAAE,UAAU;iBACpB;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE,SAAS;iBACnB;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,YAAY;iBACtB;gBACD,YAAY,EAAE;oBACZ,OAAO,EAAE,WAAW;iBACrB;gBACD,KAAK,EAAE;oBACL,OAAO,EAAE,SAAS;iBACnB;gBACD,QAAQ,EAAE;oBACR,OAAO,EAAE,YAAY;iBACtB;aACF;SACF;KACF;CACF,CAAA;AACY,QAAA,oBAAoB,GAAe;IAC9C,GAAG,qBAAa;IAChB,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,OAAO,EAAE;oBACP,OAAO,EAAE,cAAc;iBACxB;gBACD,SAAS,EAAE;oBACT,OAAO,EAAE,QAAQ;iBAClB;gBACD,WAAW,EAAE;oBACX,OAAO,EAAE,eAAe;iBACzB;gBACD,MAAM,EAAE;oBACN,OAAO,EAAE,UAAU;iBACpB;gBACD,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;iBACtB;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE,SAAS;iBACnB;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,YAAY;iBACtB;gBACD,YAAY,EAAE;oBACZ,OAAO,EAAE,WAAW;iBACrB;gBACD,KAAK,EAAE;oBACL,OAAO,EAAE,SAAS;iBACnB;gBACD,QAAQ,EAAE;oBACR,OAAO,EAAE,YAAY;iBACtB;aACF;SACF;KACF;CACF,CAAA"}

package/dist/cjs/ga4-types.d.ts

@@ -0,0 +1,27 @@
+export interface ProductItem {
+    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;
+}
+export interface PromotionProductItem extends ProductItem {
+    creative_name?: string;
+    creative_slot?: string;
+    promotion_id?: string;
+    promotion_name?: string;
+}

package/dist/cjs/ga4-types.js

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

package/dist/cjs/ga4-types.js.map

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

package/dist/cjs/generateLead/generated-types.d.ts

@@ -0,0 +1,11 @@
+export interface Payload {
+    user_id?: string;
+    currency?: string;
+    value?: number;
+    user_properties?: {
+        [k: string]: unknown;
+    };
+    params?: {
+        [k: string]: unknown;
+    };
+}

package/dist/cjs/generateLead/generated-types.js

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

package/dist/cjs/generateLead/generated-types.js.map

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

package/dist/cjs/generateLead/index.d.ts

@@ -0,0 +1,5 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: BrowserActionDefinition<Settings, Function, Payload>;
+export default action;

package/dist/cjs/generateLead/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ga4_properties_1 = require("../ga4-properties");
+const ga4_functions_1 = require("../ga4-functions");
+const action = {
+    title: 'Generate Lead',
+    description: 'Log this event when a lead has been generated to understand the efficacy of your re-engagement campaigns.',
+    platform: 'web',
+    defaultSubscription: 'type = "track"',
+    fields: {
+        user_id: ga4_properties_1.user_id,
+        currency: ga4_properties_1.currency,
+        value: ga4_properties_1.value,
+        user_properties: ga4_properties_1.user_properties,
+        params: ga4_properties_1.params
+    },
+    perform: (gtag, { payload }) => {
+        ga4_functions_1.updateUser(payload.user_id, payload.user_properties, gtag);
+        gtag('event', 'generate_lead', {
+            currency: payload.currency,
+            value: payload.value,
+            ...payload.params
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/cjs/generateLead/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generateLead/index.ts"],"names":[],"mappings":";;AAIA,sDAAqF;AACrF,oDAA6C;AAE7C,MAAM,MAAM,GAAyD;IACnE,KAAK,EAAE,eAAe;IACtB,WAAW,EACT,2GAA2G;IAC7G,QAAQ,EAAE,KAAK;IACf,mBAAmB,EAAE,gBAAgB;IACrC,MAAM,EAAE;QACN,OAAO,EAAE,wBAAO;QAChB,QAAQ,EAAE,yBAAQ;QAClB,KAAK,EAAE,sBAAK;QACZ,eAAe,EAAE,gCAAe;QAChC,MAAM,EAAE,uBAAM;KACf;IACD,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAC7B,0BAAU,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;QAE1D,IAAI,CAAC,OAAO,EAAE,eAAe,EAAE;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,GAAG,OAAO,CAAC,MAAM;SAClB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/generated-types.d.ts

@@ -0,0 +1,15 @@
+export interface Settings {
+    measurementID: string;
+    allowGoogleSignals?: boolean;
+    allowAdPersonalizationSignals?: boolean;
+    cookieDomain?: string;
+    cookieExpirationInSeconds?: number;
+    cookieFlags?: string[];
+    cookiePath?: string[];
+    cookiePrefix?: string[];
+    cookieUpdate?: boolean;
+    enableConsentMode?: boolean;
+    defaultAdsStorageConsentState?: string;
+    defaultAnalyticsStorageConsentState?: string;
+    waitTimeToUpdateConsentStage?: number;
+}

package/dist/cjs/generated-types.js

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

package/dist/cjs/generated-types.js.map

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

package/dist/cjs/index.d.ts

@@ -0,0 +1,11 @@
+import type { Settings } from './generated-types';
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types';
+declare global {
+    interface Window {
+        gtag: Function;
+        dataLayer: any;
+    }
+}
+export declare const destination: BrowserDestinationDefinition<Settings, Function>;
+declare const _default: import("@segment/browser-destination-runtime/types").PluginFactory;
+export default _default;

package/dist/cjs/index.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destination = void 0;
+const tslib_1 = require("tslib");
+const shim_1 = require("@segment/browser-destination-runtime/shim");
+const addPaymentInfo_1 = tslib_1.__importDefault(require("./addPaymentInfo"));
+const addToCart_1 = tslib_1.__importDefault(require("./addToCart"));
+const addToWishlist_1 = tslib_1.__importDefault(require("./addToWishlist"));
+const beginCheckout_1 = tslib_1.__importDefault(require("./beginCheckout"));
+const customEvent_1 = tslib_1.__importDefault(require("./customEvent"));
+const login_1 = tslib_1.__importDefault(require("./login"));
+const generateLead_1 = tslib_1.__importDefault(require("./generateLead"));
+const purchase_1 = tslib_1.__importDefault(require("./purchase"));
+const refund_1 = tslib_1.__importDefault(require("./refund"));
+const removeFromCart_1 = tslib_1.__importDefault(require("./removeFromCart"));
+const search_1 = tslib_1.__importDefault(require("./search"));
+const selectItem_1 = tslib_1.__importDefault(require("./selectItem"));
+const selectPromotion_1 = tslib_1.__importDefault(require("./selectPromotion"));
+const signUp_1 = tslib_1.__importDefault(require("./signUp"));
+const viewCart_1 = tslib_1.__importDefault(require("./viewCart"));
+const viewItem_1 = tslib_1.__importDefault(require("./viewItem"));
+const viewItemList_1 = tslib_1.__importDefault(require("./viewItemList"));
+const viewPromotion_1 = tslib_1.__importDefault(require("./viewPromotion"));
+const setConfigurationFields_1 = tslib_1.__importDefault(require("./setConfigurationFields"));
+const actions_core_1 = require("@segment/actions-core");
+const presets = [
+    {
+        name: `Set Configuration Fields`,
+        subscribe: 'type = "page" or type = "identify"',
+        partnerAction: 'setConfigurationFields',
+        mapping: actions_core_1.defaultValues(setConfigurationFields_1.default.fields)
+    }
+];
+exports.destination = {
+    name: 'Google Analytics 4 Web',
+    slug: 'actions-google-analytics-4-web',
+    mode: 'device',
+    settings: {
+        measurementID: {
+            description: 'The measurement ID associated with the web stream. Found in the Google Analytics UI under: Admin > Data Streams > Web > Measurement ID.',
+            label: 'Measurement ID',
+            type: 'string',
+            required: true
+        },
+        allowGoogleSignals: {
+            description: 'Set to false to disable all advertising features. Set to true by default.',
+            label: 'Allow Google Signals',
+            type: 'boolean',
+            default: true
+        },
+        allowAdPersonalizationSignals: {
+            description: 'Set to false to disable all advertising features. Set to true by default.',
+            label: 'Allow Ad Personalization Signals',
+            type: 'boolean',
+            default: true
+        },
+        cookieDomain: {
+            description: 'Specifies the domain used to store the analytics cookie. Set to “auto” by default.',
+            label: 'Cookie Domain',
+            type: 'string',
+            default: 'auto'
+        },
+        cookieExpirationInSeconds: {
+            description: `Every time a hit is sent to GA4, the analytics cookie expiration time is updated to be the current time plus the value of this field. The default value is two years (63072000 seconds). Please input the expiration value in seconds. More information in [Google Documentation](https://developers.google.com/analytics/devguides/collection/ga4/reference/config#)`,
+            label: 'Cookie Expiration In Seconds',
+            type: 'number',
+            default: 63072000
+        },
+        cookieFlags: {
+            description: `Appends additional flags to the analytics cookie.  See [write a new cookie](https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#write_a_new_cookie) for some examples of flags to set.`,
+            label: 'Cookie Flag',
+            type: 'string',
+            multiple: true
+        },
+        cookiePath: {
+            description: `Specifies the subpath used to store the analytics cookie.`,
+            label: 'Cookie Path',
+            type: 'string',
+            multiple: true
+        },
+        cookiePrefix: {
+            description: `Specifies a prefix to prepend to the analytics cookie name.`,
+            label: 'Cookie Prefix',
+            type: 'string',
+            multiple: true
+        },
+        cookieUpdate: {
+            description: `Set to false to not update  cookies on each page load. This has the effect of cookie expiration being relative to the first time a user visited. Set to true by default so update cookies on each page load.`,
+            label: 'Cookie Update',
+            type: 'boolean',
+            default: true
+        },
+        enableConsentMode: {
+            description: `Set to true to enable Google’s [Consent Mode](https://support.google.com/analytics/answer/9976101?hl=en). Set to false by default.`,
+            label: 'Enable Consent Mode',
+            type: 'boolean',
+            default: false
+        },
+        defaultAdsStorageConsentState: {
+            description: 'The default value for ad cookies consent state. This is only used if Enable Consent Mode is on. Set to  “granted” if it is not explicitly set. Consent state can be updated for each user in the Set Configuration Fields action.',
+            label: 'Default Ads Storage Consent State',
+            type: 'string',
+            choices: [
+                { label: 'Granted', value: 'granted' },
+                { label: 'Denied', value: 'denied' }
+            ],
+            default: 'granted'
+        },
+        defaultAnalyticsStorageConsentState: {
+            description: 'The default value for analytics cookies consent state. This is only used if Enable Consent Mode is on. Set to  “granted” if it is not explicitly set. Consent state can be updated for each user in the Set Configuration Fields action.',
+            label: 'Default Analytics Storage Consent State',
+            type: 'string',
+            choices: [
+                { label: 'Granted', value: 'granted' },
+                { label: 'Denied', value: 'denied' }
+            ],
+            default: 'granted'
+        },
+        waitTimeToUpdateConsentStage: {
+            description: 'If your CMP loads asynchronously, it might not always run before the Google tag. To handle such situations, specify a millisecond value to control how long to wait before the consent state update is sent. Please input the wait_for_update in milliseconds.',
+            label: 'Wait Time to Update Consent State',
+            type: 'number'
+        }
+    },
+    initialize: async ({ settings }, deps) => {
+        const config = {
+            send_page_view: false,
+            cookie_update: settings.cookieUpdate,
+            cookie_domain: settings.cookieDomain,
+            cookie_prefix: settings.cookiePrefix,
+            cookie_expires: settings.cookieExpirationInSeconds,
+            cookie_path: settings.cookiePath,
+            allow_ad_personalization_signals: settings.allowAdPersonalizationSignals,
+            allow_google_signals: settings.allowGoogleSignals
+        };
+        window.dataLayer = window.dataLayer || [];
+        window.gtag = function () {
+            window.dataLayer.push(arguments);
+        };
+        window.gtag('js', new Date());
+        window.gtag('config', settings.measurementID, config);
+        if (settings.enableConsentMode) {
+            window.gtag('consent', 'default', {
+                ad_storage: settings.defaultAdsStorageConsentState,
+                analytics_storage: settings.defaultAnalyticsStorageConsentState,
+                wait_for_update: settings.waitTimeToUpdateConsentStage
+            });
+        }
+        const script = `https://www.googletagmanager.com/gtag/js?id=${settings.measurementID}`;
+        await deps.loadScript(script);
+        return window.gtag;
+    },
+    presets,
+    actions: {
+        addPaymentInfo: addPaymentInfo_1.default,
+        login: login_1.default,
+        signUp: signUp_1.default,
+        search: search_1.default,
+        addToCart: addToCart_1.default,
+        addToWishlist: addToWishlist_1.default,
+        removeFromCart: removeFromCart_1.default,
+        selectItem: selectItem_1.default,
+        selectPromotion: selectPromotion_1.default,
+        viewItem: viewItem_1.default,
+        viewPromotion: viewPromotion_1.default,
+        beginCheckout: beginCheckout_1.default,
+        purchase: purchase_1.default,
+        refund: refund_1.default,
+        viewCart: viewCart_1.default,
+        viewItemList: viewItemList_1.default,
+        generateLead: generateLead_1.default,
+        customEvent: customEvent_1.default,
+        setConfigurationFields: setConfigurationFields_1.default
+    }
+};
+exports.default = shim_1.browserDestination(exports.destination);
+//# sourceMappingURL=index.js.map