@mparticle/web-google-tag-manager-kit 2.2.0 → 3.1.0

package/dist/GoogleTagManager-Kit.common.js

@@ -23,13 +23,16 @@ var googleConsentProperties = [
     'ad_user_data',
     'ad_personalization',
     'analytics_storage',
+    'functionality_storage',
+    'personalization_storage',
+    'security_storage',
 ];
 
 function ConsentHandler(common) {
     this.common = common || {};
 }
 
-ConsentHandler.prototype.getUserConsentState = function () {
+ConsentHandler.prototype.getUserConsentState = function() {
     var userConsentState = {};
 
     if (mParticle.Identity && mParticle.Identity.getCurrentUser) {
@@ -39,8 +42,7 @@ ConsentHandler.prototype.getUserConsentState = function () {
             return {};
         }
 
-        var consentState =
-            mParticle.Identity.getCurrentUser().getConsentState();
+        var consentState = mParticle.Identity.getCurrentUser().getConsentState();
 
         if (consentState && consentState.getGDPRConsentState) {
             userConsentState = consentState.getGDPRConsentState();
@@ -50,7 +52,7 @@ ConsentHandler.prototype.getUserConsentState = function () {
     return userConsentState;
 };
 
-ConsentHandler.prototype.getConsentSettings = function () {
+ConsentHandler.prototype.getConsentSettings = function() {
     var consentSettings = {};
 
     var googleToMpConsentSettingsMapping = {
@@ -58,11 +60,14 @@ ConsentHandler.prototype.getConsentSettings = function () {
         ad_personalization: 'defaultAdPersonalizationConsentWeb',
         ad_storage: 'defaultAdStorageConsentWeb',
         analytics_storage: 'defaultAnalyticsStorageConsentWeb',
+        functionality_storage: 'defaultFunctionalityStorageConsentWeb',
+        personalization_storage: 'defaultPersonalizationStorageConsentWeb',
+        security_storage: 'defaultSecurityStorageConsentWeb',
     };
 
     var settings = this.common.settings;
 
-    Object.keys(googleToMpConsentSettingsMapping).forEach(function (
+    Object.keys(googleToMpConsentSettingsMapping).forEach(function(
         googleConsentKey
     ) {
         var mpConsentSettingKey =
@@ -78,7 +83,7 @@ ConsentHandler.prototype.getConsentSettings = function () {
     return consentSettings;
 };
 
-ConsentHandler.prototype.generateConsentStatePayloadFromMappings = function (
+ConsentHandler.prototype.generateConsentStatePayloadFromMappings = function(
     consentState,
     mappings
 ) {
@@ -185,7 +190,7 @@ Common.prototype.buildConsentObject = function(event) {
     }
 
     return {
-        gdpr: gdpr
+        gdpr: gdpr,
     };
 };
 
@@ -202,13 +207,13 @@ Common.prototype.send = function(_attributes) {
         mpid: this.buildMPID(event, user),
         consent_state: this.buildConsentObject(event),
         attributes: this.buildUserAttributes(event, user),
-        identities: this.buildUserIdentities(event, user)
+        identities: this.buildUserIdentities(event, user),
     };
 
     var mpEvent = {
         name: eventName,
         type: attributes.eventType || 'custom_event',
-        attributes: event.EventAttributes || {}
+        attributes: event.EventAttributes || {},
     };
 
     payload.event = eventName;
@@ -217,7 +222,7 @@ Common.prototype.send = function(_attributes) {
         device_application_stamp:
             event.DeviceId || mParticle.getDeviceId() || '',
         user: mpUser,
-        event: mpEvent
+        event: mpEvent,
     };
 
     payload.mp_data = mpData;
@@ -233,7 +238,7 @@ Common.prototype.send = function(_attributes) {
     window[this.customDataLayerName].push(payload);
 };
 
-Common.prototype.sendConsent = function (type, payload) {
+Common.prototype.sendConsent = function(type, payload) {
     // Google Tag Manager doesn't directly use the gtag function
     // but recommends pushing directly into the dataLayer
     // https://developers.google.com/tag-manager/devguide
@@ -245,26 +250,25 @@ Common.prototype.sendConsent = function (type, payload) {
     customDataLayer('consent', type, payload);
 };
 
-Common.prototype.getEventConsentState = function (eventConsentState) {
+Common.prototype.getEventConsentState = function(eventConsentState) {
     return eventConsentState && eventConsentState.getGDPRConsentState
         ? eventConsentState.getGDPRConsentState()
         : {};
 };
 
-Common.prototype.maybeSendConsentUpdateToGoogle = function (consentState) {
+Common.prototype.maybeSendConsentUpdateToGoogle = function(consentState) {
     // If consent payload is empty,
     // we never sent an initial default consent state
     // so we shouldn't send an update.
     if (
-        this.consentPayloadAsString && 
-        this.consentMappings && 
+        this.consentPayloadAsString &&
+        this.consentMappings &&
         !this.isEmpty(consentState)
     ) {
-        var updatedConsentPayload =
-            this.consentHandler.generateConsentStatePayloadFromMappings(
-                consentState,
-                this.consentMappings
-            );
+        var updatedConsentPayload = this.consentHandler.generateConsentStatePayloadFromMappings(
+            consentState,
+            this.consentMappings
+        );
 
         var eventConsentAsString = JSON.stringify(updatedConsentPayload);
 
@@ -275,15 +279,13 @@ Common.prototype.maybeSendConsentUpdateToGoogle = function (consentState) {
     }
 };
 
-Common.prototype.sendDefaultConsentPayloadToGoogle = function (consentPayload) {
-    this.consentPayloadAsString = JSON.stringify(
-        consentPayload
-    );
+Common.prototype.sendDefaultConsentPayloadToGoogle = function(consentPayload) {
+    this.consentPayloadAsString = JSON.stringify(consentPayload);
 
     this.sendConsent('default', consentPayload);
 };
 
-Common.prototype.cloneObject = function (obj) {
+Common.prototype.cloneObject = function(obj) {
     return JSON.parse(JSON.stringify(obj));
 };
 
@@ -302,12 +304,12 @@ var ProductActionTypes = {
     Purchase: 16,
     Refund: 17,
     RemoveFromCart: 11,
-    ViewDetail: 15
+    ViewDetail: 15,
 };
 
 var PromotionType = {
     PromotionClick: 19,
-    PromotionView: 18
+    PromotionView: 18,
 };
 
 function CommerceHandler(common) {
@@ -321,10 +323,12 @@ CommerceHandler.prototype.buildAddToCart = function(event) {
             ecommerce: {
                 currencyCode: event.CurrencyCode || 'USD',
                 add: {
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildCheckout = function(event) {
@@ -336,12 +340,14 @@ CommerceHandler.prototype.buildCheckout = function(event) {
                 checkout: {
                     actionField: {
                         step: event.ProductAction.CheckoutStep,
-                        option: event.ProductAction.CheckoutOptions
+                        option: event.ProductAction.CheckoutOptions,
                     },
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildCheckoutOption = function(event) {
@@ -353,12 +359,14 @@ CommerceHandler.prototype.buildCheckoutOption = function(event) {
                 checkout_option: {
                     actionField: {
                         step: event.ProductAction.CheckoutStep,
-                        option: event.ProductAction.CheckoutOptions
+                        option: event.ProductAction.CheckoutOptions,
                     },
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildRemoveFromCart = function(event) {
@@ -369,10 +377,12 @@ CommerceHandler.prototype.buildRemoveFromCart = function(event) {
             ecommerce: {
                 currencyCode: event.CurrencyCode || 'USD',
                 remove: {
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildImpression = function(event, impression) {
@@ -382,9 +392,9 @@ CommerceHandler.prototype.buildImpression = function(event, impression) {
         eventPayload: {
             ecommerce: {
                 currencyCode: event.CurrencyCode || 'USD',
-                impressions: buildProductsList(impression.ProductList)
-            }
-        }
+                impressions: buildProductsList(impression.ProductList),
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildProductClick = function(event) {
@@ -401,10 +411,12 @@ CommerceHandler.prototype.buildProductClick = function(event) {
             ecommerce: {
                 click: {
                     actionField: actionField,
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildProductViewDetail = function(event) {
@@ -421,10 +433,12 @@ CommerceHandler.prototype.buildProductViewDetail = function(event) {
             ecommerce: {
                 detail: {
                     actionField: actionField,
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildPromoClick = function(event) {
@@ -436,10 +450,10 @@ CommerceHandler.prototype.buildPromoClick = function(event) {
                 promoClick: {
                     promotions: buildPromoList(
                         event.PromotionAction.PromotionList
-                    )
-                }
-            }
-        }
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildPromoView = function(event) {
@@ -451,10 +465,10 @@ CommerceHandler.prototype.buildPromoView = function(event) {
                 promoView: {
                     promotions: buildPromoList(
                         event.PromotionAction.PromotionList
-                    )
-                }
-            }
-        }
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildPurchase = function(event) {
@@ -471,12 +485,12 @@ CommerceHandler.prototype.buildPurchase = function(event) {
                         revenue: productAction.TotalAmount || '',
                         tax: productAction.TaxAmount || '',
                         shipping: productAction.ShippingAmount || '',
-                        coupon: productAction.CouponCode || ''
+                        coupon: productAction.CouponCode || '',
                     },
-                    products: buildProductsList(productAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(productAction.ProductList),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.buildRefund = function(event) {
@@ -489,12 +503,14 @@ CommerceHandler.prototype.buildRefund = function(event) {
             ecommerce: {
                 refund: {
                     actionField: {
-                        id: event.ProductAction.TransactionId || ''
+                        id: event.ProductAction.TransactionId || '',
                     },
-                    products: buildProductsList(event.ProductAction.ProductList)
-                }
-            }
-        }
+                    products: buildProductsList(
+                        event.ProductAction.ProductList
+                    ),
+                },
+            },
+        },
     };
 };
 CommerceHandler.prototype.logCommerceEvent = function(event) {
@@ -556,12 +572,16 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
 
 // Utility function
 function toUnderscore(string) {
-    return string.split(/(?=[A-Z])/).join('_').toLowerCase();
+    return string
+        .split(/(?=[A-Z])/)
+        .join('_')
+        .toLowerCase();
 }
+
 function parseProduct(_product) {
     var product = {};
 
-    for(var key in _product) {
+    for (var key in _product) {
         if (key === 'Sku') {
             product.id = _product.Sku;
         } else {
@@ -608,7 +628,7 @@ function EventHandler(common) {
     this.common = common || {};
 }
 
-EventHandler.prototype.logEvent = function (event) {
+EventHandler.prototype.logEvent = function(event) {
     var eventConsentState = this.common.getEventConsentState(
         event.ConsentState
     );
@@ -622,14 +642,14 @@ EventHandler.prototype.logEvent = function (event) {
 
 EventHandler.prototype.logError = function() {};
 
-EventHandler.prototype.logPageView = function (event) {
+EventHandler.prototype.logPageView = function(event) {
     var eventConsentState = this.common.getEventConsentState(
         event.ConsentState
     );
     this.common.maybeSendConsentUpdateToGoogle(eventConsentState);
     this.common.send({
         event: event,
-        eventType: 'screen_view'
+        eventType: 'screen_view',
     });
 
     return true;
@@ -663,7 +683,7 @@ function IdentityHandler(common) {
 IdentityHandler.prototype.onUserIdentified = function(mParticleUser) {
     this.common.send({
         event: {
-            EventName: 'User Identified'
+            EventName: 'User Identified',
         },
         user: mParticleUser,
     });
@@ -674,7 +694,7 @@ IdentityHandler.prototype.onIdentifyComplete = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Identify Complete'
+            EventName: 'Identify Complete',
         },
         user: mParticleUser,
     });
@@ -686,7 +706,7 @@ IdentityHandler.prototype.onLoginComplete = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Login Complete'
+            EventName: 'Login Complete',
         },
         user: mParticleUser,
     });
@@ -697,7 +717,7 @@ IdentityHandler.prototype.onLogoutComplete = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Logout Complete'
+            EventName: 'Logout Complete',
         },
         user: mParticleUser,
     });
@@ -708,7 +728,7 @@ IdentityHandler.prototype.onModifyComplete = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Modify Complete'
+            EventName: 'Modify Complete',
         },
         user: mParticleUser,
     });
@@ -796,24 +816,26 @@ var initialization = {
             );
         }
 
-        common.consentPayloadDefaults =
-            common.consentHandler.getConsentSettings();
+        common.consentPayloadDefaults = common.consentHandler.getConsentSettings();
 
-        var defaultConsentPayload = common.cloneObject(common.consentPayloadDefaults);
+        var defaultConsentPayload = common.cloneObject(
+            common.consentPayloadDefaults
+        );
         var updatedConsentState = common.consentHandler.getUserConsentState();
-        var updatedDefaultConsentPayload =
-            common.consentHandler.generateConsentStatePayloadFromMappings(
-                updatedConsentState,
-                common.consentMappings
-            );
+        var updatedDefaultConsentPayload = common.consentHandler.generateConsentStatePayloadFromMappings(
+            updatedConsentState,
+            common.consentMappings
+        );
 
         // If a default consent payload exists (as selected in the mParticle UI), set it as the default
         if (!common.isEmpty(defaultConsentPayload)) {
             common.sendDefaultConsentPayloadToGoogle(defaultConsentPayload);
-        // If a default consent payload does not exist, but the user currently has updated their consent,
-        // send that as the default because a default must be sent
+            // If a default consent payload does not exist, but the user currently has updated their consent,
+            // send that as the default because a default must be sent
         } else if (!common.isEmpty(updatedDefaultConsentPayload)) {
-            common.sendDefaultConsentPayloadToGoogle(updatedDefaultConsentPayload);
+            common.sendDefaultConsentPayloadToGoogle(
+                updatedDefaultConsentPayload
+            );
         }
 
         common.maybeSendConsentUpdateToGoogle(updatedConsentState);
@@ -904,8 +926,7 @@ function sanitizeDataLayerName(_dataLayerName) {
 
 function sanitizePreviewUrl(_previewUrl) {
     var previewUrl = _previewUrl || '';
-    var regex =
-        /^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:/?#[\]@!\$&'\(\)\*\+,;=.]+$/gm;
+    var regex = /^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:/?#[\]@!\$&'\(\)\*\+,;=.]+$/gm;
     return previewUrl.trim().match(regex) ? previewUrl.trim() : '';
 }
 
@@ -917,7 +938,7 @@ var initialization_1 = initialization;
 
 var sessionHandler = {
     onSessionStart: function(event) {},
-    onSessionEnd: function(event) {}
+    onSessionEnd: function(event) {},
 };
 
 var sessionHandler_1 = sessionHandler;
@@ -940,11 +961,11 @@ UserAttributeHandler.prototype.onRemoveUserAttribute = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Remove User Attribute'
+            EventName: 'Remove User Attribute',
         },
         options: {
-            key: key
-        }
+            key: key,
+        },
     });
 };
 UserAttributeHandler.prototype.onSetUserAttribute = function(
@@ -954,12 +975,12 @@ UserAttributeHandler.prototype.onSetUserAttribute = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Set User Attribute'
+            EventName: 'Set User Attribute',
         },
         options: {
             key: key,
-            value: value
-        }
+            value: value,
+        },
     });
 };
 UserAttributeHandler.prototype.onConsentStateUpdated = function(
@@ -969,12 +990,12 @@ UserAttributeHandler.prototype.onConsentStateUpdated = function(
 ) {
     this.common.send({
         event: {
-            EventName: 'Consent State Update'
+            EventName: 'Consent State Update',
         },
         options: {
             old_state: oldState,
-            new_state: newState
-        }
+            new_state: newState,
+        },
     });
 };
 

package/package.json

@@ -1,44 +1,48 @@
 {
-  "name": "@mparticle/web-google-tag-manager-kit",
-  "version": "2.2.0",
-  "repository": "https://github.com/mparticle-integrations/mparticle-javascript-integration-google-tag-manager",
-  "main": "dist/GoogleTagManager-Kit.common.js",
-  "browser": "dist/GoogleTagManager-Kit.common.js",
-  "files": [
-    "dist/GoogleTagManager-Kit.common.js"
-  ],
-  "scripts": {
-    "test": "npm run build && npm run test:karma",
-    "test:karma": "node test/test-karma.js",
-    "build": "ENVIRONMENT=production rollup --config rollup.config.js",
-    "watch": "ENVIRONMENT=production rollup --config rollup.config.js -w",
-    "testEndToEnd": "browserify node_modules/@mparticle/web-kit-wrapper/end-to-end-testapp/index.js -v -o test/end-to-end-testapp/build/compilation.js && open http://localhost:8082/node_modules/@mparticle/web-kit-wrapper/end-to-end-testapp/index.html && node node_modules/@mparticle/web-kit-wrapper/end-to-end-testapp/server"
-  },
-  "dependencies": {
-    "@mparticle/web-sdk": "^2.11.1"
-  },
-  "devDependencies": {
-    "@mparticle/web-kit-wrapper": "^1.0.5",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/exec": "^5.0.0",
-    "@semantic-release/git": "^9.0.0",
-    "chai": "^4.3.4",
-    "karma": "^5.1.0",
-    "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^2.2.0",
-    "karma-edge-launcher": "^0.4.2",
-    "karma-firefox-launcher": "^1.1.0",
-    "karma-ie-launcher": "^1.0.0",
-    "karma-junit-reporter": "^1.2.0",
-    "karma-mocha": "^1.3.0",
-    "karma-safari-launcher": "^1.0.0",
-    "mocha": "^5.2.0",
-    "mparticle-sdk-javascript": "github:mparticle/mparticle-sdk-javascript",
-    "rollup": "^1.15.6",
-    "rollup-plugin-commonjs": "^10.0.0",
-    "rollup-plugin-node-resolve": "^5.0.3",
-    "shelljs": "0.8.3",
-    "should": "13.2.3",
-    "watchify": "^3.11.0"
-  }
+    "name": "@mparticle/web-google-tag-manager-kit",
+    "version": "3.1.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/mParticle/mparticle-web-sdk",
+        "directory": "kits/google-tag-manager"
+    },
+    "main": "dist/GoogleTagManager-Kit.common.js",
+    "browser": "dist/GoogleTagManager-Kit.common.js",
+    "files": [
+        "dist/GoogleTagManager-Kit.common.js"
+    ],
+    "scripts": {
+        "test": "npm run build && npm run test:karma",
+        "test:karma": "node test/test-karma.js",
+        "build": "ENVIRONMENT=production rollup --config rollup.config.js",
+        "watch": "ENVIRONMENT=production rollup --config rollup.config.js -w",
+        "testEndToEnd": "browserify node_modules/@mparticle/web-kit-wrapper/end-to-end-testapp/index.js -v -o test/end-to-end-testapp/build/compilation.js && open http://localhost:8082/node_modules/@mparticle/web-kit-wrapper/end-to-end-testapp/index.html && node node_modules/@mparticle/web-kit-wrapper/end-to-end-testapp/server"
+    },
+    "dependencies": {
+        "@mparticle/web-sdk": "^3.0.0"
+    },
+    "devDependencies": {
+        "@mparticle/web-kit-wrapper": "^1.0.5",
+        "@semantic-release/changelog": "^5.0.1",
+        "@semantic-release/exec": "^5.0.0",
+        "@semantic-release/git": "^9.0.0",
+        "chai": "^4.3.4",
+        "karma": "^5.1.0",
+        "karma-chai": "^0.1.0",
+        "karma-chrome-launcher": "^2.2.0",
+        "karma-edge-launcher": "^0.4.2",
+        "karma-firefox-launcher": "^1.1.0",
+        "karma-ie-launcher": "^1.0.0",
+        "karma-junit-reporter": "^1.2.0",
+        "karma-mocha": "^1.3.0",
+        "karma-safari-launcher": "^1.0.0",
+        "mocha": "^5.2.0",
+        "mparticle-sdk-javascript": "github:mparticle/mparticle-sdk-javascript",
+        "rollup": "^1.15.6",
+        "rollup-plugin-commonjs": "^10.0.0",
+        "rollup-plugin-node-resolve": "^5.0.3",
+        "shelljs": "0.8.3",
+        "should": "13.2.3",
+        "watchify": "^3.11.0"
+    }
 }