@mparticle/web-optimizely-kit 2.1.6 → 3.2.0

package/dist/OptimizelyKit.common.js

@@ -8,11 +8,11 @@ var common = Common;
 
 var optimizelyXDefinedEvents = {
     pages: {},
-    events: {}
+    events: {},
 };
 
 var optimizelyFsDefinedEvents = {
-    events: {}
+    events: {},
 };
 
 var helpers = {
@@ -21,7 +21,7 @@ var helpers = {
             obj[item[keyField]] = item;
             return obj;
         }, {});
-    return newObj;
+        return newObj;
     },
     loadScript: function(src, callback) {
         var script = document.createElement('script');
@@ -34,7 +34,7 @@ var helpers = {
         var identities = window.mParticle.Identity.getCurrentUser().getUserIdentities();
         var userIdentities = identities['userIdentities'];
         var userId;
-        switch(userIdField) {
+        switch (userIdField) {
             // The server returns `customerId` as part of the `userIdField` setting
             // but the API for identity requies it to be cased as `customerid`
             case 'customerId':
@@ -81,24 +81,27 @@ function CommerceHandler(common) {
 
 CommerceHandler.prototype.logCommerceEvent = function(event) {
     var self = this;
-    
+
     var expandedEcommerceEvents = mParticle.eCommerce.expandCommerceEvent(
         event
     );
 
     expandedEcommerceEvents.forEach(function(expandedEvent) {
-        if (!self.common.useFullStack && optimizelyXDefinedEvents.events[expandedEvent.EventName]) {
-
+        if (
+            !self.common.useFullStack &&
+            optimizelyXDefinedEvents.events[expandedEvent.EventName]
+        ) {
             var optimizelyWebXEvent = {
                 type: 'event',
                 eventName: event.EventName,
-                tags: {}
+                tags: {},
             };
             optimizelyWebXEvent.tags = expandedEvent.EventAttributes || {};
             if (
                 event.EventCategory ===
                     mParticle.CommerceEventType.ProductPurchase ||
-                event.EventCategory === mParticle.CommerceEventType.ProductRefund
+                event.EventCategory ===
+                    mParticle.CommerceEventType.ProductRefund
             ) {
                 if (expandedEvent.EventName.indexOf('Total') > -1) {
                     if (
@@ -153,7 +156,12 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
 
         // if optimizely full stack is being used
         if (self.common.useFullStack && window.optimizelyClientInstance) {
-            if (optimizelyFsDefinedEvents.events[expandedEvent.EventName] || optimizelyFsDefinedEvents.events[event.CustomFlags['OptimizelyFullStack.EventName']]) {
+            if (
+                optimizelyFsDefinedEvents.events[expandedEvent.EventName] ||
+                optimizelyFsDefinedEvents.events[
+                    event.CustomFlags['OptimizelyFullStack.EventName']
+                ]
+            ) {
                 var eventKey = expandedEvent.EventName,
                     userId,
                     userAttributes = self.common.userAttributes,
@@ -168,7 +176,8 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
                 if (
                     event.EventCategory ===
                         mParticle.CommerceEventType.ProductPurchase ||
-                    event.EventCategory === mParticle.CommerceEventType.ProductRefund
+                    event.EventCategory ===
+                        mParticle.CommerceEventType.ProductRefund
                 ) {
                     if (expandedEvent.EventName.indexOf('Total') > -1) {
                         if (
@@ -176,7 +185,9 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
                             event.CustomFlags['OptimizelyFullStack.EventName']
                         ) {
                             eventKey =
-                                event.CustomFlags['OptimizelyFullStack.EventName'];
+                                event.CustomFlags[
+                                    'OptimizelyFullStack.EventName'
+                                ];
                         } else {
                             eventKey = expandedEvent.EventName;
                         }
@@ -187,7 +198,8 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
                             expandedEvent.EventAttributes['Total Amount']
                         ) {
                             eventTags.revenue =
-                                expandedEvent.EventAttributes['Total Amount'] * 100;
+                                expandedEvent.EventAttributes['Total Amount'] *
+                                100;
                         }
                         // other individual product events should not have revenue tags
                         // which are added via the expandCommerceEvent method above
@@ -197,7 +209,9 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
                             event.CustomFlags['OptimizelyFullStack.EventName']
                         ) {
                             eventKey =
-                                event.CustomFlags['OptimizelyFullStack.EventName'];
+                                event.CustomFlags[
+                                    'OptimizelyFullStack.EventName'
+                                ];
                         }
                         if (eventTags.revenue) {
                             delete eventTags.revenue;
@@ -213,10 +227,14 @@ CommerceHandler.prototype.logCommerceEvent = function(event) {
                             event.CustomFlags['OptimizelyFullStack.EventName'];
                     }
                 }
-                window['optimizelyClientInstance'].track(eventKey, userId, userAttributes, eventTags);                
+                window['optimizelyClientInstance'].track(
+                    eventKey,
+                    userId,
+                    userAttributes,
+                    eventTags
+                );
             }
         }
-
     });
 };
 
@@ -227,10 +245,13 @@ function EventHandler(common) {
 }
 
 EventHandler.prototype.logEvent = function(event) {
-    if (!this.common.useFullStack && optimizelyXDefinedEvents.events[event.EventName]) {
+    if (
+        !this.common.useFullStack &&
+        optimizelyXDefinedEvents.events[event.EventName]
+    ) {
         var optimizelyWebXEvent = {
             type: 'event',
-            eventName: event.EventName
+            eventName: event.EventName,
         };
 
         if (event.EventAttributes) {
@@ -238,13 +259,18 @@ EventHandler.prototype.logEvent = function(event) {
         }
 
         if (event.CustomFlags && event.CustomFlags['Optimizely.Value']) {
-            optimizelyWebXEvent.tags.value = event.CustomFlags['Optimizely.Value'];
+            optimizelyWebXEvent.tags.value =
+                event.CustomFlags['Optimizely.Value'];
         }
         window['optimizely'].push(optimizelyWebXEvent);
     }
 
     // if optimizely full stack is being used
-    if (this.common.useFullStack && window.optimizelyClientInstance && optimizelyFsDefinedEvents.events[event.EventName]) {
+    if (
+        this.common.useFullStack &&
+        window.optimizelyClientInstance &&
+        optimizelyFsDefinedEvents.events[event.EventName]
+    ) {
         var eventKey = event.EventName,
             userId,
             userAttributes = this.common.userAttributes,
@@ -258,21 +284,32 @@ EventHandler.prototype.logEvent = function(event) {
             eventTags = event.EventAttributes;
         }
 
-        if (event.CustomFlags && event.CustomFlags['OptimizelyFullStack.Value']) {
+        if (
+            event.CustomFlags &&
+            event.CustomFlags['OptimizelyFullStack.Value']
+        ) {
             eventTags.value = event.CustomFlags['OptimizelyFullStack.Value'];
         }
 
-        window['optimizelyClientInstance'].track(eventKey, userId, userAttributes, eventTags);
+        window['optimizelyClientInstance'].track(
+            eventKey,
+            userId,
+            userAttributes,
+            eventTags
+        );
     }
 };
 
 EventHandler.prototype.logPageView = function(event) {
     var self = this;
 
-    if (!self.common.useFullStack && optimizelyXDefinedEvents.pages[event.EventName]) {
+    if (
+        !self.common.useFullStack &&
+        optimizelyXDefinedEvents.pages[event.EventName]
+    ) {
         var optimizelyWebXEvent = {
             type: 'page',
-            pageName: event.EventName
+            pageName: event.EventName,
         };
 
         if (event.EventAttributes) {
@@ -340,14 +377,28 @@ IdentityHandler.prototype.onSetUserIdentity = function(
 
 var identityHandler = IdentityHandler;
 
-var optimizelyFsSdkUrl = 'https://unpkg.com/@optimizely/optimizely-sdk@3.5.0/dist/optimizely.browser.umd.min.js',
+var optimizelyFsSdkUrl =
+        'https://unpkg.com/@optimizely/optimizely-sdk@3.5.0/dist/optimizely.browser.umd.min.js',
     dataFilePrefix = 'https://cdn.optimizely.com/datafiles/',
     dataFileURLending = '.json/tag.js';
 
 var initialization = {
     name: 'Optimizely',
     moduleId: 54,
-    initForwarder: function(settings, testMode, userAttributes, userIdentities, processEvent, eventQueue, isInitialized, common, appVersion, appName, customFlags, clientId) {
+    initForwarder: function(
+        settings,
+        testMode,
+        userAttributes,
+        userIdentities,
+        processEvent,
+        eventQueue,
+        isInitialized,
+        common,
+        appVersion,
+        appName,
+        customFlags,
+        clientId
+    ) {
         common.useFullStack = settings.useFullStack === 'True';
 
         if (!testMode) {
@@ -355,8 +406,14 @@ var initialization = {
                 var optimizelyScript = document.createElement('script');
                 optimizelyScript.type = 'text/javascript';
                 optimizelyScript.async = true;
-                optimizelyScript.src = 'https://cdn.optimizely.com/js/' + settings.projectId + '.js';
-                (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(optimizelyScript);
+                optimizelyScript.src =
+                    'https://cdn.optimizely.com/js/' +
+                    settings.projectId +
+                    '.js';
+                (
+                    document.getElementsByTagName('head')[0] ||
+                    document.getElementsByTagName('body')[0]
+                ).appendChild(optimizelyScript);
                 optimizelyScript.onload = function() {
 
                     loadWebXEventsAndPages();
@@ -377,37 +434,38 @@ var initialization = {
                 common.userAttributes = userAttributes;
                 var errorHandler = function() {};
 
-                if (customFlags && customFlags['OptimizelyFullStack.ErrorHandler']) {
-                    errorHandler = customFlags['OptimizelyFullStack.ErrorHandler'];
+                if (
+                    customFlags &&
+                    customFlags['OptimizelyFullStack.ErrorHandler']
+                ) {
+                    errorHandler =
+                        customFlags['OptimizelyFullStack.ErrorHandler'];
                 }
 
                 var instantiateFSClient = function() {
-                    window.optimizelyClientInstance = window.optimizelySdk.createInstance({
-                        datafile: window.optimizelyDatafile,
-                        errorHandler: {handleError: errorHandler}
-                    });
+                    window.optimizelyClientInstance = window.optimizelySdk.createInstance(
+                        {
+                            datafile: window.optimizelyDatafile,
+                            errorHandler: { handleError: errorHandler },
+                        }
+                    );
 
-                    window.optimizelyClientInstance.onReady().then(function(){
+                    window.optimizelyClientInstance.onReady().then(function() {
                         loadFullStackEvents();
-                    });  
+                    });
                 };
 
-                helpers_1.loadScript(optimizelyFsSdkUrl,
-                    function() {
-                        helpers_1.loadScript(
-                          dataFilePrefix +
-                            settings.projectId +
-                            dataFileURLending,
-                          instantiateFSClient
-                        );
-                    }
-                );
-
+                helpers_1.loadScript(optimizelyFsSdkUrl, function() {
+                    helpers_1.loadScript(
+                        dataFilePrefix + settings.projectId + dataFileURLending,
+                        instantiateFSClient
+                    );
+                });
             } else {
                 common.userIdField = settings.userIdField;
                 common.userAttributes = userAttributes;
                 loadFullStackEvents();
-            }            
+            }
         } else {
             if (!common.useFullStack) {
                 loadWebXEventsAndPages();
@@ -418,7 +476,7 @@ var initialization = {
                 loadFullStackEvents();
             }
         }
-    }
+    },
 };
 
 function loadWebXEventsAndPages() {
@@ -444,11 +502,13 @@ function loadWebXEventsAndPages() {
 
 function loadFullStackEvents() {
     var fullStackData,
-    fullStackEvents = {};
-
+        fullStackEvents = {};
 
     if (window.optimizelyDatafile) {
-        fullStackData = helpers_1.arrayToObject(window.optimizelyDatafile.events, 'id');
+        fullStackData = helpers_1.arrayToObject(
+            window.optimizelyDatafile.events,
+            'id'
+        );
 
         for (var event in fullStackData) {
             fullStackEvents[fullStackData[event].key] = 1;
@@ -461,12 +521,8 @@ function loadFullStackEvents() {
 var initialization_1 = initialization;
 
 var sessionHandler = {
-    onSessionStart: function(event) {
-        
-    },
-    onSessionEnd: function(event) {
-
-    }
+    onSessionStart: function(event) {},
+    onSessionEnd: function(event) {},
 };
 
 var sessionHandler_1 = sessionHandler;
@@ -481,7 +537,7 @@ UserAttributeHandler.prototype.onRemoveUserAttribute = function(key) {
         attribute[key] = null;
         window['optimizely'].push({
             type: 'user',
-            attributes: attribute
+            attributes: attribute,
         });
     }
     if (this.common.useFullStack && window.optimizelyClientInstance) {
@@ -496,13 +552,13 @@ UserAttributeHandler.prototype.onSetUserAttribute = function(key, value) {
         attribute[key] = value;
         window['optimizely'].push({
             type: 'user',
-            attributes: attribute
+            attributes: attribute,
         });
     }
     if (this.common.useFullStack && window.optimizelyClientInstance) {
         var self = this;
         self.common.userAttributes[key] = value;
-    }    
+    }
 };
 
 var userAttributeHandler = UserAttributeHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-optimizely-kit",
-    "version": "2.1.6",
+    "version": "3.2.0",
     "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
     "description": "mParticle integration sdk for Optimizely",
     "main": "dist/OptimizelyKit.common.js",
@@ -8,7 +8,11 @@
     "files": [
         "dist/OptimizelyKit.common.js"
     ],
-    "repository": "https://github.com/mparticle-integrations/mparticle-javascript-integration-optimizely",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/mParticle/mparticle-web-sdk",
+        "directory": "kits/optimizely"
+    },
     "scripts": {
         "test": "npm run testKarma",
         "testKarma": "node test/boilerplate/test-karma.js",
@@ -37,7 +41,7 @@
     },
     "dependencies": {
         "isobject": "^4.0.0",
-        "@mparticle/web-sdk": "^2.11.1"
+        "@mparticle/web-sdk": "^3.0.0"
     },
     "license": "Apache-2.0"
 }