@mparticle/web-optimizely-kit 2.1.1 → 2.1.4

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+## Releases
+
+--
+
+#### 2.1.4 - 2022-03-31
+* fix - update datafile loading callback
+
+#### 2.1.3 - 202108-09
+* fix - correct casing for customerid
+
+#### 2.1.2 - 2020-09-02
+* fix - remove other instances of settings.useFullStack
+  
+#### 2.1.1 - 2020-09-01
+* fix - turn useFullStack into a boolean on common module
+
+#### 2.1.0 - 2020-08-26
+* feat - implement Optimizely Full Stack

package/README.md

@@ -1,9 +1,38 @@
-# integration-optimizely-x
-Optimizely X Web Client Javascript integration for mParticle
+# integration-optimizely
+
+## Overview
+
+This integration contains code that maps to both [Optimizely Web](https://docs.developers.optimizely.com/web/docs/introduction/) and [Optimizely Full Stack](https://docs.developers.optimizely.com/full-stack/docs/javascript-sdk). Depending on your use case, the kit is flexible enough so that you can either use 1 of these products in isolation or both at the same time. To use both concurrently, simply add 2 Optimizely connections in the [mParticle UI](https://app.mparticle.com), and check `Use Full Stack` in one of them.
+
+## Documentation
+
+Please view the [Optimizely Integration docs](https://docs.mparticle.com/integrations/optimizely/event/) for full set up instructions.
+
+### Development Notes
+
+Normally, mParticle kit code maps mParticle events to a single product/SDK. However, as mentioned above, this mParticle Optimizely kit enables mapping an mParticle event to 2 Optimizely products/SDKs. As such, all mapping code must follow 2 different code paths. In each module under `src/`, you'll find that code is split between products with code that looks something like the following:
+
+```
+if (window.optimizely && !common.useFullStack`) {
+    // Perform mapping for Optimizely Web
+    // window.optimizely checks for existence of Optimizely Web's API
+    // common.useFullStack is an explicit check for if the connection is for Full Stack
+}
+
+// OR
+
+if (window.optimizelyClientInstance && this.common.useFullStack) {
+    // Perform mapping for Optimizely Full Stack
+    // window.optimizelyClientInstance checks for existence of Optimizely Full Stack's API
+    // common.useFullStack is an explicit check for if the connection is for Full Stack
+}
+```
+
+When updating this kit, be sure to follow the correct code paths where appropriate.
 
 # License
 
-Copyright 2018 mParticle, Inc.
+Copyright 2020 mParticle, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/dist/OptimizelyKit.common.js

@@ -35,8 +35,10 @@ var helpers = {
         var userIdentities = identities['userIdentities'];
         var userId;
         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':
-                userId = userIdentities['customerId'];
+                userId = userIdentities['customerid'];
                 break;
             case 'email':
                 userId = userIdentities['email'];
@@ -338,14 +340,18 @@ IdentityHandler.prototype.onSetUserIdentity = function(
 
 var identityHandler = IdentityHandler;
 
+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) {
-        common.useFullStack = settings.useFullStack;
+        common.useFullStack = settings.useFullStack === 'True';
 
         if (!testMode) {
-            if (!window.optimizely && !settings.useFullStack) {
+            if (!window.optimizely && !common.useFullStack) {
                 var optimizelyScript = document.createElement('script');
                 optimizelyScript.type = 'text/javascript';
                 optimizelyScript.async = true;
@@ -366,7 +372,7 @@ var initialization = {
                 loadWebXEventsAndPages();
             }
 
-            if (!window.optimizelyClientInstance && settings.useFullStack) {
+            if (!window.optimizelyClientInstance && common.useFullStack) {
                 common.userIdField = settings.userIdField;
                 common.userAttributes = userAttributes;
                 var errorHandler = function() {};
@@ -386,17 +392,25 @@ var initialization = {
                     });  
                 };
 
-                helpers_1.loadScript('https://unpkg.com/@optimizely/optimizely-sdk/dist/optimizely.browser.umd.min.js', 
-                helpers_1.loadScript('https://cdn.optimizely.com/datafiles/' + settings.projectId + '.json/tag.js', instantiateFSClient));
+                helpers_1.loadScript(optimizelyFsSdkUrl,
+                    function() {
+                        helpers_1.loadScript(
+                          dataFilePrefix +
+                            settings.projectId +
+                            dataFileURLending,
+                          instantiateFSClient
+                        );
+                    }
+                );
 
             } else {
                 loadFullStackEvents();
             }            
         } else {
-            if (!settings.useFullStack) {
+            if (!common.useFullStack) {
                 loadWebXEventsAndPages();
             }
-            if (settings.useFullStack) {
+            if (common.useFullStack) {
                 common.userIdField = settings.userIdField;
                 common.userAttributes = userAttributes;
                 loadFullStackEvents();
@@ -553,7 +567,10 @@ var constructor = function() {
     ) {
         forwarderSettings = settings;
 
-        if (window.mParticle.isTestEnvironment) {
+        if (
+            typeof window !== 'undefined' &&
+            window.mParticle.isTestEnvironment
+        ) {
             reportingService = function() {};
         } else {
             reportingService = service;
@@ -969,14 +986,14 @@ function isObject(val) {
 
 function register(config) {
     if (!config) {
-        window.console.log(
+        console.log(
             'You must pass a config object to register the kit ' + name
         );
         return;
     }
 
     if (!isObject(config)) {
-        window.console.log(
+        console.log(
             "'config' must be an object. You passed in a " + typeof config
         );
         return;
@@ -992,17 +1009,19 @@ function register(config) {
             constructor: constructor,
         };
     }
-    window.console.log(
+    console.log(
         'Successfully registered ' + name + ' to your mParticle configuration'
     );
 }
 
-if (window && window.mParticle && window.mParticle.addForwarder) {
-    window.mParticle.addForwarder({
-        name: name,
-        constructor: constructor,
-        getId: getId,
-    });
+if (typeof window !== 'undefined') {
+    if (window && window.mParticle && window.mParticle.addForwarder) {
+        window.mParticle.addForwarder({
+            name: name,
+            constructor: constructor,
+            getId: getId,
+        });
+    }
 }
 
 var webKitWrapper = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-optimizely-kit",
-    "version": "2.1.1",
+    "version": "2.1.4",
     "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
     "description": "mParticle integration sdk for Optimizely",
     "main": "dist/OptimizelyKit.common.js",
@@ -16,7 +16,7 @@
         "watch": "ENVIRONMENT=production rollup --config rollup.config.js -w"
     },
     "devDependencies": {
-        "@mparticle/web-kit-wrapper": "^1.0.4",
+        "@mparticle/web-kit-wrapper": "^1.0.5",
         "chai": "^4.2.0",
         "karma": "^3.1.1",
         "karma-chai": "^0.1.0",