@mparticle/web-rokt-kit 1.4.1 → 1.6.0

package/dist/Rokt-Kit.common.js

@@ -17,8 +17,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-var roktLauncherScript = 'https://apps.rokt.com/wsdk/integrations/launcher.js';
-
 var name = 'Rokt';
 var moduleId = 181;
 
@@ -31,8 +29,28 @@ var constructor = function () {
 
     self.launcher = null;
     self.filters = {};
-    self.filteredUser = {};
     self.userAttributes = {};
+    self.testHelpers = null;
+
+    /**
+     * Generates the Rokt launcher script URL with optional domain override and extensions
+     * @param {string} domain - The CNAME domain to use for overriding the launcher url
+     * @param {Array<string>} extensions - List of extension query parameters to append
+     * @returns {string} The complete launcher script URL
+     */
+    function generateLauncherScript(_domain, extensions) {
+        // Override domain if a customer is using a CNAME
+        // If a customer is using a CNAME, a domain will be passed. If not, we use the default domain.
+        var domain = typeof _domain !== 'undefined' ? _domain : 'apps.rokt.com';
+        var protocol = 'https://';
+        var launcherPath = '/wsdk/integrations/launcher.js';
+        var baseUrl = [protocol, domain, launcherPath].join('');
+
+        if (!extensions || extensions.length === 0) {
+            return baseUrl;
+        }
+        return baseUrl + '?extensions=' + extensions.join(',');
+    }
 
     /**
      * Passes attributes to the Rokt Web SDK for client-side hashing
@@ -57,15 +75,23 @@ var constructor = function () {
         filteredUserAttributes
     ) {
         var accountId = settings.accountId;
+        var roktExtensions = extractRoktExtensions(settings.roktExtensions);
         self.userAttributes = filteredUserAttributes;
         self.onboardingExpProvider = settings.onboardingExpProvider;
-
-        var launcherOptions = window.mParticle.Rokt.launcherOptions || {};
+        var domain = window.mParticle.Rokt.domain;
+        var launcherOptions = mergeObjects(
+            {},
+            window.mParticle.Rokt.launcherOptions || {}
+        );
         launcherOptions.integrationName = generateIntegrationName(
             launcherOptions.integrationName
         );
 
         if (testMode) {
+            self.testHelpers = {
+                generateLauncherScript: generateLauncherScript,
+                extractRoktExtensions: extractRoktExtensions,
+            };
             attachLauncher(accountId, launcherOptions);
             return;
         }
@@ -74,7 +100,7 @@ var constructor = function () {
             var target = document.head || document.body;
             var script = document.createElement('script');
             script.type = 'text/javascript';
-            script.src = roktLauncherScript;
+            script.src = generateLauncherScript(domain, roktExtensions);
             script.async = true;
             script.crossOrigin = 'anonymous';
             script.fetchPriority = 'high';
@@ -104,6 +130,18 @@ var constructor = function () {
             console.warn('Unable to find Rokt on the page');
         }
     }
+    /**
+     * Returns the user identities from the filtered user, if any
+     * @param {Object} filteredUser - The filtered user object containing identities
+     * @returns {Object} The user identities from the filtered user
+     */
+    function returnUserIdentities(filteredUser) {
+        if (!filteredUser || !filteredUser.getUserIdentities) {
+            return {};
+        }
+
+        return filteredUser.getUserIdentities().userIdentities;
+    }
 
     /**
      * Selects placements for Rokt Web SDK with merged attributes, filters, and experimentation options
@@ -149,8 +187,11 @@ var constructor = function () {
                 ? fetchOptimizely()
                 : {};
 
+        var filteredUserIdentities = returnUserIdentities(filteredUser);
+
         var selectPlacementsAttributes = mergeObjects(
             filteredAttributes,
+            filteredUserIdentities,
             optimizelyAttributes,
             {
                 mpid: mpid,
@@ -164,8 +205,24 @@ var constructor = function () {
         return self.launcher.selectPlacements(selectPlacementsOptions);
     }
 
+    /**
+     * Sets extension data for Rokt Web SDK
+     * @param {Object} partnerExtensionData - The extension data object containing:
+     * - [extensionName] {string}: Name of the extension
+     * - [extensionName].options {Object}: Key-value pairs of options for the extension
+     * @returns {void} Nothing is returned
+     */
+    function setExtensionData(partnerExtensionData) {
+        if (!isInitialized()) {
+            console.error('Rokt Kit: Not initialized');
+            return;
+        }
+
+        window.Rokt.setExtensionData(partnerExtensionData);
+    }
+
     function onUserIdentified(filteredUser) {
-        self.filteredUser = filteredUser;
+        self.filters.filteredUser = filteredUser;
         self.userAttributes = filteredUser.getAllUserAttributes();
     }
 
@@ -189,7 +246,6 @@ var constructor = function () {
             .then(function (launcher) {
                 // Assign the launcher to a global variable for later access
                 window.Rokt.currentLauncher = launcher;
-
                 // Locally cache the launcher and filters
                 self.launcher = launcher;
 
@@ -203,11 +259,8 @@ var constructor = function () {
                         console.warn(
                             'Rokt Kit: No filtered user has been set.'
                         );
-                    } else {
-                        self.filteredUser = roktFilters.filteredUser;
                     }
                 }
-
                 // Attaches the kit to the Rokt manager
                 window.mParticle.Rokt.attachKit(self);
 
@@ -266,6 +319,7 @@ var constructor = function () {
 
     // Kit Callback Methods
     this.init = initForwarder;
+    this.setExtensionData = setExtensionData;
     this.setUserAttribute = setUserAttribute;
     this.onUserIdentified = onUserIdentified;
     this.removeUserAttribute = removeUserAttribute;
@@ -284,7 +338,7 @@ var constructor = function () {
 
 function generateIntegrationName(customIntegrationName) {
     var coreSdkVersion = window.mParticle.getVersion();
-    var kitVersion = "1.4.1";
+    var kitVersion = "1.6.0";
     var name = 'mParticle_' + 'wsdkv_' + coreSdkVersion + '_kitv_' + kitVersion;
 
     if (customIntegrationName) {
@@ -344,6 +398,25 @@ function mergeObjects() {
     return resObj;
 }
 
+function parseSettingsString(settingsString) {
+    try {
+        return JSON.parse(settingsString.replace(/&quot;/g, '"'));
+    } catch (error) {
+        throw new Error('Settings string contains invalid JSON');
+    }
+}
+
+function extractRoktExtensions(settingsString) {
+    var settings = settingsString ? parseSettingsString(settingsString) : [];
+
+    var roktExtensions = [];
+    for (var i = 0; i < settings.length; i++) {
+        roktExtensions.push(settings[i].value);
+    }
+
+    return roktExtensions;
+}
+
 if (window && window.mParticle && window.mParticle.addForwarder) {
     window.mParticle.addForwarder({
         name: name,

package/dist/Rokt-Kit.iife.js

@@ -16,8 +16,6 @@ var RoktKit = (function (exports) {
     //  See the License for the specific language governing permissions and
     //  limitations under the License.
 
-    var roktLauncherScript = 'https://apps.rokt.com/wsdk/integrations/launcher.js';
-
     var name = 'Rokt';
     var moduleId = 181;
 
@@ -30,8 +28,28 @@ var RoktKit = (function (exports) {
 
         self.launcher = null;
         self.filters = {};
-        self.filteredUser = {};
         self.userAttributes = {};
+        self.testHelpers = null;
+
+        /**
+         * Generates the Rokt launcher script URL with optional domain override and extensions
+         * @param {string} domain - The CNAME domain to use for overriding the launcher url
+         * @param {Array<string>} extensions - List of extension query parameters to append
+         * @returns {string} The complete launcher script URL
+         */
+        function generateLauncherScript(_domain, extensions) {
+            // Override domain if a customer is using a CNAME
+            // If a customer is using a CNAME, a domain will be passed. If not, we use the default domain.
+            var domain = typeof _domain !== 'undefined' ? _domain : 'apps.rokt.com';
+            var protocol = 'https://';
+            var launcherPath = '/wsdk/integrations/launcher.js';
+            var baseUrl = [protocol, domain, launcherPath].join('');
+
+            if (!extensions || extensions.length === 0) {
+                return baseUrl;
+            }
+            return baseUrl + '?extensions=' + extensions.join(',');
+        }
 
         /**
          * Passes attributes to the Rokt Web SDK for client-side hashing
@@ -56,15 +74,23 @@ var RoktKit = (function (exports) {
             filteredUserAttributes
         ) {
             var accountId = settings.accountId;
+            var roktExtensions = extractRoktExtensions(settings.roktExtensions);
             self.userAttributes = filteredUserAttributes;
             self.onboardingExpProvider = settings.onboardingExpProvider;
-
-            var launcherOptions = window.mParticle.Rokt.launcherOptions || {};
+            var domain = window.mParticle.Rokt.domain;
+            var launcherOptions = mergeObjects(
+                {},
+                window.mParticle.Rokt.launcherOptions || {}
+            );
             launcherOptions.integrationName = generateIntegrationName(
                 launcherOptions.integrationName
             );
 
             if (testMode) {
+                self.testHelpers = {
+                    generateLauncherScript: generateLauncherScript,
+                    extractRoktExtensions: extractRoktExtensions,
+                };
                 attachLauncher(accountId, launcherOptions);
                 return;
             }
@@ -73,7 +99,7 @@ var RoktKit = (function (exports) {
                 var target = document.head || document.body;
                 var script = document.createElement('script');
                 script.type = 'text/javascript';
-                script.src = roktLauncherScript;
+                script.src = generateLauncherScript(domain, roktExtensions);
                 script.async = true;
                 script.crossOrigin = 'anonymous';
                 script.fetchPriority = 'high';
@@ -103,6 +129,18 @@ var RoktKit = (function (exports) {
                 console.warn('Unable to find Rokt on the page');
             }
         }
+        /**
+         * Returns the user identities from the filtered user, if any
+         * @param {Object} filteredUser - The filtered user object containing identities
+         * @returns {Object} The user identities from the filtered user
+         */
+        function returnUserIdentities(filteredUser) {
+            if (!filteredUser || !filteredUser.getUserIdentities) {
+                return {};
+            }
+
+            return filteredUser.getUserIdentities().userIdentities;
+        }
 
         /**
          * Selects placements for Rokt Web SDK with merged attributes, filters, and experimentation options
@@ -148,8 +186,11 @@ var RoktKit = (function (exports) {
                     ? fetchOptimizely()
                     : {};
 
+            var filteredUserIdentities = returnUserIdentities(filteredUser);
+
             var selectPlacementsAttributes = mergeObjects(
                 filteredAttributes,
+                filteredUserIdentities,
                 optimizelyAttributes,
                 {
                     mpid: mpid,
@@ -163,8 +204,24 @@ var RoktKit = (function (exports) {
             return self.launcher.selectPlacements(selectPlacementsOptions);
         }
 
+        /**
+         * Sets extension data for Rokt Web SDK
+         * @param {Object} partnerExtensionData - The extension data object containing:
+         * - [extensionName] {string}: Name of the extension
+         * - [extensionName].options {Object}: Key-value pairs of options for the extension
+         * @returns {void} Nothing is returned
+         */
+        function setExtensionData(partnerExtensionData) {
+            if (!isInitialized()) {
+                console.error('Rokt Kit: Not initialized');
+                return;
+            }
+
+            window.Rokt.setExtensionData(partnerExtensionData);
+        }
+
         function onUserIdentified(filteredUser) {
-            self.filteredUser = filteredUser;
+            self.filters.filteredUser = filteredUser;
             self.userAttributes = filteredUser.getAllUserAttributes();
         }
 
@@ -188,7 +245,6 @@ var RoktKit = (function (exports) {
                 .then(function (launcher) {
                     // Assign the launcher to a global variable for later access
                     window.Rokt.currentLauncher = launcher;
-
                     // Locally cache the launcher and filters
                     self.launcher = launcher;
 
@@ -202,11 +258,8 @@ var RoktKit = (function (exports) {
                             console.warn(
                                 'Rokt Kit: No filtered user has been set.'
                             );
-                        } else {
-                            self.filteredUser = roktFilters.filteredUser;
                         }
                     }
-
                     // Attaches the kit to the Rokt manager
                     window.mParticle.Rokt.attachKit(self);
 
@@ -265,6 +318,7 @@ var RoktKit = (function (exports) {
 
         // Kit Callback Methods
         this.init = initForwarder;
+        this.setExtensionData = setExtensionData;
         this.setUserAttribute = setUserAttribute;
         this.onUserIdentified = onUserIdentified;
         this.removeUserAttribute = removeUserAttribute;
@@ -283,7 +337,7 @@ var RoktKit = (function (exports) {
 
     function generateIntegrationName(customIntegrationName) {
         var coreSdkVersion = window.mParticle.getVersion();
-        var kitVersion = "1.4.1";
+        var kitVersion = "1.6.0";
         var name = 'mParticle_' + 'wsdkv_' + coreSdkVersion + '_kitv_' + kitVersion;
 
         if (customIntegrationName) {
@@ -343,6 +397,25 @@ var RoktKit = (function (exports) {
         return resObj;
     }
 
+    function parseSettingsString(settingsString) {
+        try {
+            return JSON.parse(settingsString.replace(/&quot;/g, '"'));
+        } catch (error) {
+            throw new Error('Settings string contains invalid JSON');
+        }
+    }
+
+    function extractRoktExtensions(settingsString) {
+        var settings = settingsString ? parseSettingsString(settingsString) : [];
+
+        var roktExtensions = [];
+        for (var i = 0; i < settings.length; i++) {
+            roktExtensions.push(settings[i].value);
+        }
+
+        return roktExtensions;
+    }
+
     if (window && window.mParticle && window.mParticle.addForwarder) {
         window.mParticle.addForwarder({
             name: name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mparticle/web-rokt-kit",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "description": "mParticle integration kit for Rokt",
   "main": "dist/Rokt-Kit.common.js",
   "files": [