@mparticle/web-rokt-kit 1.2.0 → 1.3.0

package/dist/Rokt-Kit.common.js

@@ -34,20 +34,34 @@ var constructor = function () {
     self.filteredUser = {};
     self.userAttributes = {};
 
+    /**
+     * Passes attributes to the Rokt Web SDK for client-side hashing
+     * @see https://docs.rokt.com/developers/integration-guides/web/library/integration-launcher#hash-attributes
+     * @param {Object} attributes - The attributes to be hashed
+     * @returns {Promise<Object|null>} A Promise resolving to the
+     * hashed attributes from the launcher, or `null` if the kit is not initialized
+     */
+    function hashAttributes(attributes) {
+        if (!isInitialized()) {
+            console.error('Rokt Kit: Not initialized');
+            return null;
+        }
+        return self.launcher.hashAttributes(attributes);
+    }
+
     function initForwarder(
         settings,
-        service,
+        _service,
         testMode,
-        trackerId,
+        _trackerId,
         filteredUserAttributes
     ) {
         var accountId = settings.accountId;
-        var sandboxMode = window.mParticle.getEnvironment() === 'development';
         self.userAttributes = filteredUserAttributes;
         self.onboardingExpProvider = settings.onboardingExpProvider;
 
         if (testMode) {
-            attachLauncher(accountId, sandboxMode);
+            attachLauncher(accountId);
             return;
         }
 
@@ -68,7 +82,7 @@ var constructor = function () {
                     typeof window.Rokt.createLauncher === 'function' &&
                     window.Rokt.currentLauncher === undefined
                 ) {
-                    attachLauncher(accountId, sandboxMode);
+                    attachLauncher(accountId);
                 } else {
                     console.error(
                         'Rokt object is not available after script load.'
@@ -86,12 +100,15 @@ var constructor = function () {
         }
     }
 
+    /**
+     * Selects placements for Rokt Web SDK with merged attributes, filters, and experimentation options
+     * @see https://docs.rokt.com/developers/integration-guides/web/library/select-placements-options/
+     * @param {Object} options - The options object for selecting placements containing:
+     * - identifier {string}: The placement identifier
+     * - attributes {Object}: Optional attributes to merge with existing attributes
+     * @returns {Promise<void>} A Promise resolving to the Rokt launcher's selectPlacements method with processed attributes
+     */
     function selectPlacements(options) {
-        // https://docs.rokt.com/developers/integration-guides/web/library/select-placements-options/
-        // options should contain:
-        // - identifier
-        // - attributes
-
         var attributes = (options && options.attributes) || {};
         var placementAttributes = mergeObjects(self.userAttributes, attributes);
 
@@ -155,16 +172,15 @@ var constructor = function () {
         delete self.userAttributes[key];
     }
 
-    function attachLauncher(accountId, sandboxMode) {
+    function attachLauncher(accountId) {
         window.Rokt.createLauncher({
             accountId: accountId,
-            sandbox: sandboxMode,
             integrationName:
                 'mParticle_' +
                 'wsdkv_' +
                 window.mParticle.getVersion() +
                 '_kitv_' +
-                "1.2.0",
+                "1.3.0",
         })
             .then(function (launcher) {
                 // Assign the launcher to a global variable for later access
@@ -198,9 +214,6 @@ var constructor = function () {
             });
     }
 
-    // Called by the mParticle Rokt Manager
-    this.selectPlacements = selectPlacements;
-
     // mParticle Kit Callback Methods
     function fetchOptimizely() {
         var forwarders = window.mParticle
@@ -242,10 +255,27 @@ var constructor = function () {
         }
         return {};
     }
+
+    // Called by the mParticle Rokt Manager
+    this.selectPlacements = selectPlacements;
+    this.hashAttributes = hashAttributes;
+
+    // Kit Callback Methods
     this.init = initForwarder;
     this.setUserAttribute = setUserAttribute;
     this.onUserIdentified = onUserIdentified;
     this.removeUserAttribute = removeUserAttribute;
+
+    /**
+     * Checks if the kit is properly initialized and ready for use.
+     * Both conditions must be true:
+     * 1. self.isInitialized - Set after successful initialization of the kit
+     * 2. self.launcher - The Rokt launcher instance must be available
+     * @returns {boolean} Whether the kit is fully initialized
+     */
+    function isInitialized() {
+        return !!(self.isInitialized && self.launcher);
+    }
 };
 
 function getId() {

package/dist/Rokt-Kit.iife.js

@@ -33,20 +33,34 @@ var RoktKit = (function (exports) {
         self.filteredUser = {};
         self.userAttributes = {};
 
+        /**
+         * Passes attributes to the Rokt Web SDK for client-side hashing
+         * @see https://docs.rokt.com/developers/integration-guides/web/library/integration-launcher#hash-attributes
+         * @param {Object} attributes - The attributes to be hashed
+         * @returns {Promise<Object|null>} A Promise resolving to the
+         * hashed attributes from the launcher, or `null` if the kit is not initialized
+         */
+        function hashAttributes(attributes) {
+            if (!isInitialized()) {
+                console.error('Rokt Kit: Not initialized');
+                return null;
+            }
+            return self.launcher.hashAttributes(attributes);
+        }
+
         function initForwarder(
             settings,
-            service,
+            _service,
             testMode,
-            trackerId,
+            _trackerId,
             filteredUserAttributes
         ) {
             var accountId = settings.accountId;
-            var sandboxMode = window.mParticle.getEnvironment() === 'development';
             self.userAttributes = filteredUserAttributes;
             self.onboardingExpProvider = settings.onboardingExpProvider;
 
             if (testMode) {
-                attachLauncher(accountId, sandboxMode);
+                attachLauncher(accountId);
                 return;
             }
 
@@ -67,7 +81,7 @@ var RoktKit = (function (exports) {
                         typeof window.Rokt.createLauncher === 'function' &&
                         window.Rokt.currentLauncher === undefined
                     ) {
-                        attachLauncher(accountId, sandboxMode);
+                        attachLauncher(accountId);
                     } else {
                         console.error(
                             'Rokt object is not available after script load.'
@@ -85,12 +99,15 @@ var RoktKit = (function (exports) {
             }
         }
 
+        /**
+         * Selects placements for Rokt Web SDK with merged attributes, filters, and experimentation options
+         * @see https://docs.rokt.com/developers/integration-guides/web/library/select-placements-options/
+         * @param {Object} options - The options object for selecting placements containing:
+         * - identifier {string}: The placement identifier
+         * - attributes {Object}: Optional attributes to merge with existing attributes
+         * @returns {Promise<void>} A Promise resolving to the Rokt launcher's selectPlacements method with processed attributes
+         */
         function selectPlacements(options) {
-            // https://docs.rokt.com/developers/integration-guides/web/library/select-placements-options/
-            // options should contain:
-            // - identifier
-            // - attributes
-
             var attributes = (options && options.attributes) || {};
             var placementAttributes = mergeObjects(self.userAttributes, attributes);
 
@@ -154,16 +171,15 @@ var RoktKit = (function (exports) {
             delete self.userAttributes[key];
         }
 
-        function attachLauncher(accountId, sandboxMode) {
+        function attachLauncher(accountId) {
             window.Rokt.createLauncher({
                 accountId: accountId,
-                sandbox: sandboxMode,
                 integrationName:
                     'mParticle_' +
                     'wsdkv_' +
                     window.mParticle.getVersion() +
                     '_kitv_' +
-                    "1.2.0",
+                    "1.3.0",
             })
                 .then(function (launcher) {
                     // Assign the launcher to a global variable for later access
@@ -197,9 +213,6 @@ var RoktKit = (function (exports) {
                 });
         }
 
-        // Called by the mParticle Rokt Manager
-        this.selectPlacements = selectPlacements;
-
         // mParticle Kit Callback Methods
         function fetchOptimizely() {
             var forwarders = window.mParticle
@@ -241,10 +254,27 @@ var RoktKit = (function (exports) {
             }
             return {};
         }
+
+        // Called by the mParticle Rokt Manager
+        this.selectPlacements = selectPlacements;
+        this.hashAttributes = hashAttributes;
+
+        // Kit Callback Methods
         this.init = initForwarder;
         this.setUserAttribute = setUserAttribute;
         this.onUserIdentified = onUserIdentified;
         this.removeUserAttribute = removeUserAttribute;
+
+        /**
+         * Checks if the kit is properly initialized and ready for use.
+         * Both conditions must be true:
+         * 1. self.isInitialized - Set after successful initialization of the kit
+         * 2. self.launcher - The Rokt launcher instance must be available
+         * @returns {boolean} Whether the kit is fully initialized
+         */
+        function isInitialized() {
+            return !!(self.isInitialized && self.launcher);
+        }
     };
 
     function getId() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mparticle/web-rokt-kit",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "mParticle integration kit for Rokt",
   "main": "dist/Rokt-Kit.common.js",
   "files": [
@@ -14,7 +14,7 @@
     "lint": "eslint src/ test/src/",
     "lint:fix": "eslint src/ test/src/ --fix",
     "watch": "rollup --config rollup.config.js -w",
-    "watch:test": "rollup --config rollup.test.config.js -w",
+    "watch:tests": "rollup --config rollup.test.config.js -w",
     "test": "npm run build && npm run build:test && karma start test/karma.config.js",
     "test:debug": "npm run build && npm run build:test && DEBUG=true karma start test/karma.config.js"
   },