@mparticle/web-rokt-kit 1.13.0 → 1.14.0

package/dist/Rokt-Kit.common.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var name = 'Rokt';
 var moduleId = 181;
+var EVENT_NAME_SELECT_PLACEMENTS = 'selectPlacements';
 
 var constructor = function () {
     var self = this;
@@ -27,7 +28,6 @@ var constructor = function () {
     };
 
     var EMAIL_SHA256_KEY = 'emailsha256';
-    var EMAIL_KEY = 'email';
 
     // Dynamic identity type for Rokt's emailsha256 identity value which MP doesn't natively support - will be set during initialization
     var mappedEmailSha256Key;
@@ -63,6 +63,14 @@ var constructor = function () {
         return baseUrl + '?extensions=' + extensions.join(',');
     }
 
+    /**
+     * Checks if Rokt launcher is available and ready to attach
+     * @returns {boolean} True if launcher can be attached
+     */
+    function isLauncherReadyToAttach() {
+        return window.Rokt && typeof window.Rokt.createLauncher === 'function';
+    }
+
     /**
      * 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
@@ -125,7 +133,9 @@ var constructor = function () {
             return;
         }
 
-        if (!window.Rokt || !(window.Rokt && window.Rokt.currentLauncher)) {
+        if (isLauncherReadyToAttach()) {
+            attachLauncher(accountId, launcherOptions);
+        } else {
             var target = document.head || document.body;
             var script = document.createElement('script');
             script.type = 'text/javascript';
@@ -136,12 +146,7 @@ var constructor = function () {
             script.id = 'rokt-launcher';
 
             script.onload = function () {
-                // Once the script loads, ensure the Rokt object is available
-                if (
-                    window.Rokt &&
-                    typeof window.Rokt.createLauncher === 'function' &&
-                    window.Rokt.currentLauncher === undefined
-                ) {
+                if (isLauncherReadyToAttach()) {
                     attachLauncher(accountId, launcherOptions);
                 } else {
                     console.error(
@@ -156,8 +161,6 @@ var constructor = function () {
 
             target.appendChild(script);
             captureTiming(PerformanceMarks.RoktScriptAppended);
-        } else {
-            console.warn('Unable to find Rokt on the page');
         }
     }
     /**
@@ -189,24 +192,15 @@ var constructor = function () {
 
     function replaceOtherIdentityWithEmailsha256(userIdentities) {
         var newUserIdentities = mergeObjects({}, userIdentities || {});
-        if (userIdentities.hasOwnProperty(mappedEmailSha256Key)) {
+        if (userIdentities[mappedEmailSha256Key]) {
             newUserIdentities[EMAIL_SHA256_KEY] =
                 userIdentities[mappedEmailSha256Key];
-            delete newUserIdentities[mappedEmailSha256Key];
         }
+        delete newUserIdentities[mappedEmailSha256Key];
 
         return newUserIdentities;
     }
 
-    function sanitizeEmailIdentities(_data) {
-        var data = mergeObjects({}, _data || {});
-        if (_data.hasOwnProperty(EMAIL_SHA256_KEY)) {
-            delete data[EMAIL_KEY];
-        }
-
-        return data;
-    }
-
     /**
      * 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/
@@ -266,12 +260,41 @@ var constructor = function () {
         );
 
         var selectPlacementsOptions = mergeObjects(options, {
-            attributes: sanitizeEmailIdentities(selectPlacementsAttributes),
+            attributes: selectPlacementsAttributes,
         });
 
+        // Log custom event for selectPlacements call
+        logSelectPlacementsEvent(selectPlacementsAttributes);
+
         return self.launcher.selectPlacements(selectPlacementsOptions);
     }
 
+    /**
+     * Logs a custom event when selectPlacements is called
+     * This enables visibility and troubleshooting
+     * @param {Object} attributes - The attributes sent to Rokt
+     */
+    function logSelectPlacementsEvent(attributes) {
+        if (
+            !window.mParticle ||
+            typeof window.mParticle.logEvent !== 'function'
+        ) {
+            return;
+        }
+
+        if (!isObject(attributes)) {
+            return;
+        }
+
+        var EVENT_TYPE_OTHER = window.mParticle.EventType.Other;
+
+        window.mParticle.logEvent(
+            EVENT_NAME_SELECT_PLACEMENTS,
+            EVENT_TYPE_OTHER,
+            attributes
+        );
+    }
+
     /**
      * Enables optional Integration Launcher extensions before selecting placements
      * @param {string} extensionName - Name of the extension to enable
@@ -488,7 +511,7 @@ var constructor = function () {
 
 function generateIntegrationName(customIntegrationName) {
     var coreSdkVersion = window.mParticle.getVersion();
-    var kitVersion = "1.13.0";
+    var kitVersion = "1.14.0";
     var name = 'mParticle_' + 'wsdkv_' + coreSdkVersion + '_kitv_' + kitVersion;
 
     if (customIntegrationName) {

package/dist/Rokt-Kit.iife.js

@@ -18,6 +18,7 @@ var RoktKit = (function (exports) {
 
     var name = 'Rokt';
     var moduleId = 181;
+    var EVENT_NAME_SELECT_PLACEMENTS = 'selectPlacements';
 
     var constructor = function () {
         var self = this;
@@ -26,7 +27,6 @@ var RoktKit = (function (exports) {
         };
 
         var EMAIL_SHA256_KEY = 'emailsha256';
-        var EMAIL_KEY = 'email';
 
         // Dynamic identity type for Rokt's emailsha256 identity value which MP doesn't natively support - will be set during initialization
         var mappedEmailSha256Key;
@@ -62,6 +62,14 @@ var RoktKit = (function (exports) {
             return baseUrl + '?extensions=' + extensions.join(',');
         }
 
+        /**
+         * Checks if Rokt launcher is available and ready to attach
+         * @returns {boolean} True if launcher can be attached
+         */
+        function isLauncherReadyToAttach() {
+            return window.Rokt && typeof window.Rokt.createLauncher === 'function';
+        }
+
         /**
          * 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
@@ -124,7 +132,9 @@ var RoktKit = (function (exports) {
                 return;
             }
 
-            if (!window.Rokt || !(window.Rokt && window.Rokt.currentLauncher)) {
+            if (isLauncherReadyToAttach()) {
+                attachLauncher(accountId, launcherOptions);
+            } else {
                 var target = document.head || document.body;
                 var script = document.createElement('script');
                 script.type = 'text/javascript';
@@ -135,12 +145,7 @@ var RoktKit = (function (exports) {
                 script.id = 'rokt-launcher';
 
                 script.onload = function () {
-                    // Once the script loads, ensure the Rokt object is available
-                    if (
-                        window.Rokt &&
-                        typeof window.Rokt.createLauncher === 'function' &&
-                        window.Rokt.currentLauncher === undefined
-                    ) {
+                    if (isLauncherReadyToAttach()) {
                         attachLauncher(accountId, launcherOptions);
                     } else {
                         console.error(
@@ -155,8 +160,6 @@ var RoktKit = (function (exports) {
 
                 target.appendChild(script);
                 captureTiming(PerformanceMarks.RoktScriptAppended);
-            } else {
-                console.warn('Unable to find Rokt on the page');
             }
         }
         /**
@@ -188,24 +191,15 @@ var RoktKit = (function (exports) {
 
         function replaceOtherIdentityWithEmailsha256(userIdentities) {
             var newUserIdentities = mergeObjects({}, userIdentities || {});
-            if (userIdentities.hasOwnProperty(mappedEmailSha256Key)) {
+            if (userIdentities[mappedEmailSha256Key]) {
                 newUserIdentities[EMAIL_SHA256_KEY] =
                     userIdentities[mappedEmailSha256Key];
-                delete newUserIdentities[mappedEmailSha256Key];
             }
+            delete newUserIdentities[mappedEmailSha256Key];
 
             return newUserIdentities;
         }
 
-        function sanitizeEmailIdentities(_data) {
-            var data = mergeObjects({}, _data || {});
-            if (_data.hasOwnProperty(EMAIL_SHA256_KEY)) {
-                delete data[EMAIL_KEY];
-            }
-
-            return data;
-        }
-
         /**
          * 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/
@@ -265,12 +259,41 @@ var RoktKit = (function (exports) {
             );
 
             var selectPlacementsOptions = mergeObjects(options, {
-                attributes: sanitizeEmailIdentities(selectPlacementsAttributes),
+                attributes: selectPlacementsAttributes,
             });
 
+            // Log custom event for selectPlacements call
+            logSelectPlacementsEvent(selectPlacementsAttributes);
+
             return self.launcher.selectPlacements(selectPlacementsOptions);
         }
 
+        /**
+         * Logs a custom event when selectPlacements is called
+         * This enables visibility and troubleshooting
+         * @param {Object} attributes - The attributes sent to Rokt
+         */
+        function logSelectPlacementsEvent(attributes) {
+            if (
+                !window.mParticle ||
+                typeof window.mParticle.logEvent !== 'function'
+            ) {
+                return;
+            }
+
+            if (!isObject(attributes)) {
+                return;
+            }
+
+            var EVENT_TYPE_OTHER = window.mParticle.EventType.Other;
+
+            window.mParticle.logEvent(
+                EVENT_NAME_SELECT_PLACEMENTS,
+                EVENT_TYPE_OTHER,
+                attributes
+            );
+        }
+
         /**
          * Enables optional Integration Launcher extensions before selecting placements
          * @param {string} extensionName - Name of the extension to enable
@@ -487,7 +510,7 @@ var RoktKit = (function (exports) {
 
     function generateIntegrationName(customIntegrationName) {
         var coreSdkVersion = window.mParticle.getVersion();
-        var kitVersion = "1.13.0";
+        var kitVersion = "1.14.0";
         var name = 'mParticle_' + 'wsdkv_' + coreSdkVersion + '_kitv_' + kitVersion;
 
         if (customIntegrationName) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mparticle/web-rokt-kit",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "mParticle integration kit for Rokt",
   "main": "dist/Rokt-Kit.common.js",
   "files": [
@@ -19,13 +19,17 @@
     "test:debug": "npm run build && npm run build:test && DEBUG=true karma start test/karma.config.js"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org"
   },
   "devDependencies": {
     "@rollup/plugin-json": "^6.1.0",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/exec": "^5.0.0",
-    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^13.1.2",
+    "semantic-release": "^24.2.0",
     "mocha": "^5.2.0",
     "chai": "^4.2.0",
     "eslint": "^7.25.0",
@@ -46,7 +50,7 @@
     "watchify": "^3.11.0"
   },
   "dependencies": {
-    "@mparticle/web-sdk": "^2.36.0"
+    "@mparticle/web-sdk": "^2.56.0"
   },
   "license": "Apache-2.0"
 }