@mparticle/web-google-analytics-4-server-kit 1.0.1 → 1.0.3

package/README.md

@@ -13,7 +13,7 @@ npm i @mparticle/web-google-analytics-4-server-kit
 
 Full documentation on usage can be found [here](https://docs.mparticle.com/integrations/google-analytics-4/event/).
 
-#License
+# License
 
 Copyright 2022 mParticle, Inc.
 

package/dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js

@@ -22,11 +22,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 // This kit does not have a `processEvent` method because no events should be sent client side.
 
 var name = 'GoogleAnalytics4',
-    GA4MODULENUMBER = 160;
+    GA4MODULENUMBER = 160,
+    suffix = 'Server';
 
 var constructor = function() {
     var self = this;
     self.name = name;
+    self.suffix = suffix;
 
     function initForwarder(forwarderSettings, service, testMode) {
         mParticle._setIntegrationDelay(GA4MODULENUMBER, true);
@@ -38,6 +40,12 @@ var constructor = function() {
             window.dataLayer.push(arguments);
         };
 
+        gtag('js', new Date());
+
+        gtag('get', measurementId, 'client_id', function(clientId) {
+            setClientId(clientId, GA4MODULENUMBER);
+        });
+
         if (!testMode) {
             var clientScript = document.createElement('script');
             clientScript.type = 'text/javascript';
@@ -48,21 +56,12 @@ var constructor = function() {
                 document.getElementsByTagName('head')[0] ||
                 document.getElementsByTagName('body')[0]
             ).appendChild(clientScript);
-
-            clientScript.onload = function() {
-                gtag('js', new Date());
-
-                gtag('get', measurementId, 'client_id', function(clientId) {
-                    setClientId(clientId, GA4MODULENUMBER);
-                });
-                return;
-            };
         }
     }
 
     this.init = initForwarder;
 };
-    
+
 function setClientId(clientId, GA4MODULENUMBER) {
     var GA4CLIENTID = 'client_id';
     var ga4IntegrationAttributes = {};
@@ -83,13 +82,18 @@ if (window && window.mParticle && window.mParticle.addForwarder) {
         name: name,
         constructor: constructor,
         getId: getId,
+        // A suffix is added if there are multiple different versions of
+        // a client kit.  This matches the suffix in the DB.
+        suffix: suffix,
     });
 }
 
 function register(config) {
+    var forwarderNameWithSuffix = [name, suffix].join('-');
     if (!config) {
         window.console.log(
-            'You must pass a config object to register the kit ' + name
+            'You must pass a config object to register the kit ' +
+                forwarderNameWithSuffix
         );
         return;
     }
@@ -102,17 +106,19 @@ function register(config) {
     }
 
     if (isObject(config.kits)) {
-        config.kits[name] = {
+        config.kits[forwarderNameWithSuffix] = {
             constructor: constructor,
         };
     } else {
         config.kits = {};
-        config.kits[name] = {
+        config.kits[forwarderNameWithSuffix] = {
             constructor: constructor,
         };
     }
     window.console.log(
-        'Successfully registered ' + name + ' to your mParticle configuration'
+        'Successfully registered ' +
+            forwarderNameWithSuffix +
+            ' to your mParticle configuration'
     );
 }
 

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "@mparticle/web-google-analytics-4-server-kit",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "mParticle integration sdk for Google Analytics (server side)",
   "main": "dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js",
-  "browser": "dist/GoogleAnalytics4EventForwarderServerSide-Kit.iife.js",
+  "browser": "dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js",
+  "files": ["dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js"],
   "scripts": {
     "build": "rollup --config rollup.config.js",
-    "watch": "rollup --config rollup.config.js -w"
+    "build:test": "ENVIRONMENT=production rollup --config rollup.test.config.js",
+    "watch": "rollup --config rollup.config.js -w",
+    "test": "npm run build && npm run build:test && DEBUG=false karma start test/karma.config.js",
+    "test:debug": "npm run build && npm run build:test && DEBUG=true karma start test/karma.config.js"
+
   },
   "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
   "license": "Apache-2.0",
@@ -15,6 +20,14 @@
   },
   "repository": "https://github.com/mparticle-integrations/mparticle-javascript-integration-google-analytics-4/tree/master/packages/GA4Server",
   "devDependencies": {
-    "rollup": "^1.15.6"
+    "mocha": "^5.2.0",
+    "rollup": "^1.15.6",
+    "rollup-plugin-commonjs": "^10.0.0",
+    "rollup-plugin-node-resolve": "^5.0.3",
+    "should": "13.2.3",
+    "sinon": "^15.1.0"
+  },
+  "dependencies": {
+    "@mparticle/web-sdk": "^2.23.0"
   }
 }

package/dist/GoogleAnalytics4EventForwarderServerSide-Kit.iife.js

@@ -1,132 +0,0 @@
-var mParticleGA4 = (function (exports) {
-    /* eslint-disable no-undef */
-
-    //
-    //  Copyright 2022 mParticle, Inc.
-    //
-    //  Licensed under the Apache License, Version 2.0 (the 'License');
-    //  you may not use this file except in compliance with the License.
-    //  You may obtain a copy of the License at
-    //
-    //      http://www.apache.org/licenses/LICENSE-2.0
-    //
-    //  Unless required by applicable law or agreed to in writing, software
-    //  distributed under the License is distributed on an 'AS IS' BASIS,
-    //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    //  See the License for the specific language governing permissions and
-    //  limitations under the License.
-
-
-    // This GA4 server side kit loads gtag, gets the client id, and sets it as an integration attribute on the core sdk.
-    // This kit does not have a `processEvent` method because no events should be sent client side.
-
-    var name = 'GoogleAnalytics4',
-        GA4MODULENUMBER = 160;
-
-    var constructor = function() {
-        var self = this;
-        self.name = name;
-
-        function initForwarder(forwarderSettings, service, testMode) {
-            mParticle._setIntegrationDelay(GA4MODULENUMBER, true);
-
-            var measurementId = forwarderSettings.measurementId;
-            window.dataLayer = window.dataLayer || [];
-
-            window.gtag = function() {
-                window.dataLayer.push(arguments);
-            };
-
-            if (!testMode) {
-                var clientScript = document.createElement('script');
-                clientScript.type = 'text/javascript';
-                clientScript.async = true;
-                clientScript.src =
-                    'https://www.googletagmanager.com/gtag/js?id=' + measurementId;
-                (
-                    document.getElementsByTagName('head')[0] ||
-                    document.getElementsByTagName('body')[0]
-                ).appendChild(clientScript);
-
-                clientScript.onload = function() {
-                    gtag('js', new Date());
-
-                    gtag('get', measurementId, 'client_id', function(clientId) {
-                        setClientId(clientId, GA4MODULENUMBER);
-                    });
-                    return;
-                };
-            }
-        }
-
-        this.init = initForwarder;
-    };
-        
-    function setClientId(clientId, GA4MODULENUMBER) {
-        var GA4CLIENTID = 'client_id';
-        var ga4IntegrationAttributes = {};
-        ga4IntegrationAttributes[GA4CLIENTID] = clientId;
-        mParticle.setIntegrationAttribute(
-            GA4MODULENUMBER,
-            ga4IntegrationAttributes
-        );
-        mParticle._setIntegrationDelay(GA4MODULENUMBER, false);
-    }
-
-    function getId() {
-        return GA4MODULENUMBER;
-    }
-
-    if (window && window.mParticle && window.mParticle.addForwarder) {
-        window.mParticle.addForwarder({
-            name: name,
-            constructor: constructor,
-            getId: getId,
-        });
-    }
-
-    function register(config) {
-        if (!config) {
-            window.console.log(
-                'You must pass a config object to register the kit ' + name
-            );
-            return;
-        }
-
-        if (!isObject(config)) {
-            window.console.log(
-                "'config' must be an object. You passed in a " + typeof config
-            );
-            return;
-        }
-
-        if (isObject(config.kits)) {
-            config.kits[name] = {
-                constructor: constructor,
-            };
-        } else {
-            config.kits = {};
-            config.kits[name] = {
-                constructor: constructor,
-            };
-        }
-        window.console.log(
-            'Successfully registered ' + name + ' to your mParticle configuration'
-        );
-    }
-
-    function isObject(val) {
-        return (
-            val != null && typeof val === 'object' && Array.isArray(val) === false
-        );
-    }
-
-    var GoogleAnalytics4EventForwarderServerSide = {
-        register: register,
-    };
-
-    exports.default = GoogleAnalytics4EventForwarderServerSide;
-
-    return exports;
-
-}({}));

package/rollup.config.js

@@ -1,31 +0,0 @@
-const input = 'src/GoogleAnalytics4EventForwarderServerSide.js';
-
-const outputOptions = {
-    exports: 'named',
-    strict: false,
-};
-
-const builds = {
-    // for dynamic script tag loading of GA4 server side kit
-    server_iife: {
-        input,
-        output: {
-            ...outputOptions,
-            name: 'mParticleGA4',
-            file: 'dist/GoogleAnalytics4EventForwarderServerSide-Kit.iife.js',
-            format: 'iife',
-        },
-    },
-    // creates npm module for GA4 server side kit
-    server_cjs: {
-        input,
-        output: {
-            ...outputOptions,
-            name: 'mParticleGA4',
-            file: 'dist/GoogleAnalytics4EventForwarderServerSide-Kit.common.js',
-            format: 'cjs',
-        },
-    },
-};
-
-export default [builds.server_iife, builds.server_cjs];

package/src/GoogleAnalytics4EventForwarderServerSide.js

@@ -1,125 +0,0 @@
-/* eslint-disable no-undef */
-
-//
-//  Copyright 2022 mParticle, Inc.
-//
-//  Licensed under the Apache License, Version 2.0 (the 'License');
-//  you may not use this file except in compliance with the License.
-//  You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-//  Unless required by applicable law or agreed to in writing, software
-//  distributed under the License is distributed on an 'AS IS' BASIS,
-//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-//  See the License for the specific language governing permissions and
-//  limitations under the License.
-
-
-// This GA4 server side kit loads gtag, gets the client id, and sets it as an integration attribute on the core sdk.
-// This kit does not have a `processEvent` method because no events should be sent client side.
-
-var name = 'GoogleAnalytics4',
-    GA4MODULENUMBER = 160;
-
-var constructor = function() {
-    var self = this;
-    self.name = name;
-
-    function initForwarder(forwarderSettings, service, testMode) {
-        mParticle._setIntegrationDelay(GA4MODULENUMBER, true);
-
-        var measurementId = forwarderSettings.measurementId;
-        window.dataLayer = window.dataLayer || [];
-
-        window.gtag = function() {
-            window.dataLayer.push(arguments);
-        };
-
-        if (!testMode) {
-            var clientScript = document.createElement('script');
-            clientScript.type = 'text/javascript';
-            clientScript.async = true;
-            clientScript.src =
-                'https://www.googletagmanager.com/gtag/js?id=' + measurementId;
-            (
-                document.getElementsByTagName('head')[0] ||
-                document.getElementsByTagName('body')[0]
-            ).appendChild(clientScript);
-
-            clientScript.onload = function() {
-                gtag('js', new Date());
-
-                gtag('get', measurementId, 'client_id', function(clientId) {
-                    setClientId(clientId, GA4MODULENUMBER);
-                });
-                return;
-            };
-        }
-    }
-
-    this.init = initForwarder;
-};
-    
-function setClientId(clientId, GA4MODULENUMBER) {
-    var GA4CLIENTID = 'client_id';
-    var ga4IntegrationAttributes = {};
-    ga4IntegrationAttributes[GA4CLIENTID] = clientId;
-    mParticle.setIntegrationAttribute(
-        GA4MODULENUMBER,
-        ga4IntegrationAttributes
-    );
-    mParticle._setIntegrationDelay(GA4MODULENUMBER, false);
-}
-
-function getId() {
-    return GA4MODULENUMBER;
-}
-
-if (window && window.mParticle && window.mParticle.addForwarder) {
-    window.mParticle.addForwarder({
-        name: name,
-        constructor: constructor,
-        getId: getId,
-    });
-}
-
-function register(config) {
-    if (!config) {
-        window.console.log(
-            'You must pass a config object to register the kit ' + name
-        );
-        return;
-    }
-
-    if (!isObject(config)) {
-        window.console.log(
-            "'config' must be an object. You passed in a " + typeof config
-        );
-        return;
-    }
-
-    if (isObject(config.kits)) {
-        config.kits[name] = {
-            constructor: constructor,
-        };
-    } else {
-        config.kits = {};
-        config.kits[name] = {
-            constructor: constructor,
-        };
-    }
-    window.console.log(
-        'Successfully registered ' + name + ' to your mParticle configuration'
-    );
-}
-
-function isObject(val) {
-    return (
-        val != null && typeof val === 'object' && Array.isArray(val) === false
-    );
-}
-
-export default {
-    register: register,
-};