@mparticle/web-rokt-kit 1.6.2 → 1.7.0

package/dist/Rokt-Kit.common.js

@@ -33,6 +33,7 @@ var constructor = function () {
     self.filters = {};
     self.userAttributes = {};
     self.testHelpers = null;
+    self.placementEventMappingLookup = {};
 
     /**
      * Generates the Rokt launcher script URL with optional domain override and extensions
@@ -62,7 +63,7 @@ var constructor = function () {
      * hashed attributes from the launcher, or `null` if the kit is not initialized
      */
     function hashAttributes(attributes) {
-        if (!isInitialized()) {
+        if (!isKitReady()) {
             console.error('Rokt Kit: Not initialized');
             return null;
         }
@@ -78,8 +79,16 @@ var constructor = function () {
     ) {
         var accountId = settings.accountId;
         var roktExtensions = extractRoktExtensions(settings.roktExtensions);
-        self.userAttributes = filteredUserAttributes;
+        self.userAttributes = filteredUserAttributes || {};
         self.onboardingExpProvider = settings.onboardingExpProvider;
+
+        var placementEventMapping = parseSettingsString(
+            settings.placementEventMapping
+        );
+        self.placementEventMappingLookup = generateMappedEventLookup(
+            placementEventMapping
+        );
+
         var domain = window.mParticle.Rokt.domain;
         var launcherOptions = mergeObjects(
             {},
@@ -93,6 +102,9 @@ var constructor = function () {
             self.testHelpers = {
                 generateLauncherScript: generateLauncherScript,
                 extractRoktExtensions: extractRoktExtensions,
+                hashEventMessage: hashEventMessage,
+                parseSettingsString: parseSettingsString,
+                generateMappedEventLookup: generateMappedEventLookup,
             };
             attachLauncher(accountId, launcherOptions);
             return;
@@ -203,10 +215,20 @@ var constructor = function () {
 
         var filteredUserIdentities = returnUserIdentities(filteredUser);
 
+        var localSessionAttributes = {};
+
+        try {
+            localSessionAttributes =
+                window.mParticle.Rokt.getLocalSessionAttributes();
+        } catch (error) {
+            console.error('Error getting local session attributes:', error);
+        }
+
         var selectPlacementsAttributes = mergeObjects(
             filteredUserIdentities,
             replaceOtherWithEmailsha256(filteredAttributes),
             optimizelyAttributes,
+            localSessionAttributes,
             {
                 mpid: mpid,
             }
@@ -227,7 +249,7 @@ var constructor = function () {
      * @returns {void} Nothing is returned
      */
     function setExtensionData(partnerExtensionData) {
-        if (!isInitialized()) {
+        if (!isKitReady()) {
             console.error('Rokt Kit: Not initialized');
             return;
         }
@@ -235,6 +257,26 @@ var constructor = function () {
         window.Rokt.setExtensionData(partnerExtensionData);
     }
 
+    function processEvent(event) {
+        if (
+            !isKitReady() ||
+            typeof window.mParticle.Rokt.setLocalSessionAttribute !== 'function'
+        ) {
+            return;
+        }
+
+        var hashedEvent = hashEventMessage(
+            event.EventDataType,
+            event.EventCategory,
+            event.EventName
+        );
+
+        if (self.placementEventMappingLookup[hashedEvent]) {
+            var mappedValue = self.placementEventMappingLookup[hashedEvent];
+            window.mParticle.Rokt.setLocalSessionAttribute(mappedValue, true);
+        }
+    }
+
     function onUserIdentified(filteredUser) {
         self.filters.filteredUser = filteredUser;
         self.userAttributes = filteredUser.getAllUserAttributes();
@@ -275,10 +317,11 @@ var constructor = function () {
                         );
                     }
                 }
-                // Attaches the kit to the Rokt manager
-                window.mParticle.Rokt.attachKit(self);
 
+                // Kit must be initialized before attaching to the Rokt manager
                 self.isInitialized = true;
+                // Attaches the kit to the Rokt manager
+                window.mParticle.Rokt.attachKit(self);
             })
             .catch(function (err) {
                 console.error('Error creating Rokt launcher:', err);
@@ -333,26 +376,27 @@ var constructor = function () {
 
     // Kit Callback Methods
     this.init = initForwarder;
+    this.process = processEvent;
     this.setExtensionData = setExtensionData;
     this.setUserAttribute = setUserAttribute;
     this.onUserIdentified = onUserIdentified;
     this.removeUserAttribute = removeUserAttribute;
 
     /**
-     * Checks if the kit is properly initialized and ready for use.
+     * Checks if the Rokt kit is ready to 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
+     * @returns {boolean} Whether the kit is ready for use
      */
-    function isInitialized() {
+    function isKitReady() {
         return !!(self.isInitialized && self.launcher);
     }
 };
 
 function generateIntegrationName(customIntegrationName) {
     var coreSdkVersion = window.mParticle.getVersion();
-    var kitVersion = "1.6.2";
+    var kitVersion = "1.6.3";
     var name = 'mParticle_' + 'wsdkv_' + coreSdkVersion + '_kitv_' + kitVersion;
 
     if (customIntegrationName) {
@@ -432,6 +476,25 @@ function extractRoktExtensions(settingsString) {
     return roktExtensions;
 }
 
+function generateMappedEventLookup(placementEventMapping) {
+    if (!placementEventMapping) {
+        return {};
+    }
+
+    var mappedEvents = {};
+    for (var i = 0; i < placementEventMapping.length; i++) {
+        var mapping = placementEventMapping[i];
+        mappedEvents[mapping.jsmap] = mapping.value;
+    }
+    return mappedEvents;
+}
+
+function hashEventMessage(messageType, eventType, eventName) {
+    return window.mParticle.generateHash(
+        [messageType, eventType, eventName].join('')
+    );
+}
+
 if (window && window.mParticle && window.mParticle.addForwarder) {
     window.mParticle.addForwarder({
         name: name,

package/dist/Rokt-Kit.iife.js

@@ -32,6 +32,7 @@ var RoktKit = (function (exports) {
         self.filters = {};
         self.userAttributes = {};
         self.testHelpers = null;
+        self.placementEventMappingLookup = {};
 
         /**
          * Generates the Rokt launcher script URL with optional domain override and extensions
@@ -61,7 +62,7 @@ var RoktKit = (function (exports) {
          * hashed attributes from the launcher, or `null` if the kit is not initialized
          */
         function hashAttributes(attributes) {
-            if (!isInitialized()) {
+            if (!isKitReady()) {
                 console.error('Rokt Kit: Not initialized');
                 return null;
             }
@@ -77,8 +78,16 @@ var RoktKit = (function (exports) {
         ) {
             var accountId = settings.accountId;
             var roktExtensions = extractRoktExtensions(settings.roktExtensions);
-            self.userAttributes = filteredUserAttributes;
+            self.userAttributes = filteredUserAttributes || {};
             self.onboardingExpProvider = settings.onboardingExpProvider;
+
+            var placementEventMapping = parseSettingsString(
+                settings.placementEventMapping
+            );
+            self.placementEventMappingLookup = generateMappedEventLookup(
+                placementEventMapping
+            );
+
             var domain = window.mParticle.Rokt.domain;
             var launcherOptions = mergeObjects(
                 {},
@@ -92,6 +101,9 @@ var RoktKit = (function (exports) {
                 self.testHelpers = {
                     generateLauncherScript: generateLauncherScript,
                     extractRoktExtensions: extractRoktExtensions,
+                    hashEventMessage: hashEventMessage,
+                    parseSettingsString: parseSettingsString,
+                    generateMappedEventLookup: generateMappedEventLookup,
                 };
                 attachLauncher(accountId, launcherOptions);
                 return;
@@ -202,10 +214,20 @@ var RoktKit = (function (exports) {
 
             var filteredUserIdentities = returnUserIdentities(filteredUser);
 
+            var localSessionAttributes = {};
+
+            try {
+                localSessionAttributes =
+                    window.mParticle.Rokt.getLocalSessionAttributes();
+            } catch (error) {
+                console.error('Error getting local session attributes:', error);
+            }
+
             var selectPlacementsAttributes = mergeObjects(
                 filteredUserIdentities,
                 replaceOtherWithEmailsha256(filteredAttributes),
                 optimizelyAttributes,
+                localSessionAttributes,
                 {
                     mpid: mpid,
                 }
@@ -226,7 +248,7 @@ var RoktKit = (function (exports) {
          * @returns {void} Nothing is returned
          */
         function setExtensionData(partnerExtensionData) {
-            if (!isInitialized()) {
+            if (!isKitReady()) {
                 console.error('Rokt Kit: Not initialized');
                 return;
             }
@@ -234,6 +256,26 @@ var RoktKit = (function (exports) {
             window.Rokt.setExtensionData(partnerExtensionData);
         }
 
+        function processEvent(event) {
+            if (
+                !isKitReady() ||
+                typeof window.mParticle.Rokt.setLocalSessionAttribute !== 'function'
+            ) {
+                return;
+            }
+
+            var hashedEvent = hashEventMessage(
+                event.EventDataType,
+                event.EventCategory,
+                event.EventName
+            );
+
+            if (self.placementEventMappingLookup[hashedEvent]) {
+                var mappedValue = self.placementEventMappingLookup[hashedEvent];
+                window.mParticle.Rokt.setLocalSessionAttribute(mappedValue, true);
+            }
+        }
+
         function onUserIdentified(filteredUser) {
             self.filters.filteredUser = filteredUser;
             self.userAttributes = filteredUser.getAllUserAttributes();
@@ -274,10 +316,11 @@ var RoktKit = (function (exports) {
                             );
                         }
                     }
-                    // Attaches the kit to the Rokt manager
-                    window.mParticle.Rokt.attachKit(self);
 
+                    // Kit must be initialized before attaching to the Rokt manager
                     self.isInitialized = true;
+                    // Attaches the kit to the Rokt manager
+                    window.mParticle.Rokt.attachKit(self);
                 })
                 .catch(function (err) {
                     console.error('Error creating Rokt launcher:', err);
@@ -332,26 +375,27 @@ var RoktKit = (function (exports) {
 
         // Kit Callback Methods
         this.init = initForwarder;
+        this.process = processEvent;
         this.setExtensionData = setExtensionData;
         this.setUserAttribute = setUserAttribute;
         this.onUserIdentified = onUserIdentified;
         this.removeUserAttribute = removeUserAttribute;
 
         /**
-         * Checks if the kit is properly initialized and ready for use.
+         * Checks if the Rokt kit is ready to 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
+         * @returns {boolean} Whether the kit is ready for use
          */
-        function isInitialized() {
+        function isKitReady() {
             return !!(self.isInitialized && self.launcher);
         }
     };
 
     function generateIntegrationName(customIntegrationName) {
         var coreSdkVersion = window.mParticle.getVersion();
-        var kitVersion = "1.6.2";
+        var kitVersion = "1.6.3";
         var name = 'mParticle_' + 'wsdkv_' + coreSdkVersion + '_kitv_' + kitVersion;
 
         if (customIntegrationName) {
@@ -431,6 +475,25 @@ var RoktKit = (function (exports) {
         return roktExtensions;
     }
 
+    function generateMappedEventLookup(placementEventMapping) {
+        if (!placementEventMapping) {
+            return {};
+        }
+
+        var mappedEvents = {};
+        for (var i = 0; i < placementEventMapping.length; i++) {
+            var mapping = placementEventMapping[i];
+            mappedEvents[mapping.jsmap] = mapping.value;
+        }
+        return mappedEvents;
+    }
+
+    function hashEventMessage(messageType, eventType, eventName) {
+        return window.mParticle.generateHash(
+            [messageType, eventType, eventName].join('')
+        );
+    }
+
     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.6.2",
+  "version": "1.7.0",
   "description": "mParticle integration kit for Rokt",
   "main": "dist/Rokt-Kit.common.js",
   "files": [