fix: Add Rokt Wrapper Methods to snippet.js (#997)

Author: alexs-mparticle

README.md

@@ -46,9 +46,7 @@ window.mParticle = {
 };
 
 //load the SDK
-(
-function(t){window.mParticle=window.mParticle||{};window.mParticle.EventType={Unknown:0,Navigation:1,Location:2,Search:3,Transaction:4,UserContent:5,UserPreference:6,Social:7,Other:8};window.mParticle.eCommerce={Cart:{}};window.mParticle.Identity={};window.mParticle.config=window.mParticle.config||{};window.mParticle.config.rq=[];window.mParticle.config.snippetVersion=2.3;window.mParticle.ready=function(t){window.mParticle.config.rq.push(t)};var e=["endSession","logError","logBaseEvent","logEvent","logForm","logLink","logPageView","setSessionAttribute","setAppName","setAppVersion","setOptOut","setPosition","startNewSession","startTrackingLocation","stopTrackingLocation"];var o=["setCurrencyCode","logCheckout"];var i=["identify","login","logout","modify"];e.forEach(function(t){window.mParticle[t]=n(t)});o.forEach(function(t){window.mParticle.eCommerce[t]=n(t,"eCommerce")});i.forEach(function(t){window.mParticle.Identity[t]=n(t,"Identity")});function n(e,o){return function(){if(o){e=o+"."+e}var t=Array.prototype.slice.call(arguments);t.unshift(e);window.mParticle.config.rq.push(t)}}var dpId,dpV,config=window.mParticle.config,env=config.isDevelopmentMode?1:0,dbUrl="?env="+env,dataPlan=window.mParticle.config.dataPlan;dataPlan&&(dpId=dataPlan.planId,dpV=dataPlan.planVersion,dpId&&(dpV&&(dpV<1||dpV>1e3)&&(dpV=null),dbUrl+="&plan_id="+dpId+(dpV?"&plan_version="+dpV:"")));var mp=document.createElement("script");mp.type="text/javascript";mp.async=true;mp.src=("https:"==document.location.protocol?"https://jssdkcdns":"http://jssdkcdn")+".mparticle.com/js/v2/"+t+"/mparticle.js" + dbUrl;var c=document.getElementsByTagName("script")[0];c.parentNode.insertBefore(mp,c)}
-)("REPLACE WITH API KEY");
+(function(e){window.mParticle=window.mParticle||{};window.mParticle.EventType={Unknown:0,Navigation:1,Location:2,Search:3,Transaction:4,UserContent:5,UserPreference:6,Social:7,Other:8,Media:9};window.mParticle.eCommerce={Cart:{}};window.mParticle.Identity={};window.mParticle.Rokt={};window.mParticle.config=window.mParticle.config||{};window.mParticle.config.rq=[];window.mParticle.config.snippetVersion=2.4;window.mParticle.ready=function(e){window.mParticle.config.rq.push(e)};var t=["endSession","logError","logBaseEvent","logEvent","logForm","logLink","logPageView","setSessionAttribute","setAppName","setAppVersion","setOptOut","setPosition","startNewSession","startTrackingLocation","stopTrackingLocation"];var i=["setCurrencyCode","logCheckout"];var n=["identify","login","logout","modify"];var o=["attachLauncher","selectPlacements"];t.forEach(function(e){window.mParticle[e]=r(e)});i.forEach(function(e){window.mParticle.eCommerce[e]=r(e,"eCommerce")});n.forEach(function(e){window.mParticle.Identity[e]=r(e,"Identity")});o.forEach(function(e){window.mParticle.Rokt[e]=r(e,"Rokt")});function r(t,i){return function(){if(i){t=i+"."+t}var e=Array.prototype.slice.call(arguments);e.unshift(t);window.mParticle.config.rq.push(e)}}var c,a,s=window.mParticle.config,l=s.isDevelopmentMode?1:0,w="?env="+l,d=window.mParticle.config.dataPlan;if(d){c=d.planId;a=d.planVersion;if(c){if(a&&(a<1||a>1e3)){a=null}w+="&plan_id="+c+(a?"&plan_version="+a:"")}}var m=window.mParticle.config.versions;var f=[];if(m){Object.keys(m).forEach(function(e){f.push(e+"="+m[e])})}var p=document.createElement("script");p.type="text/javascript";p.async=true;p.src=("https:"==document.location.protocol?"https://jssdkcdns":"http://jssdkcdn")+".mparticle.com/js/v2/"+e+"/mparticle.js"+w+"&"+f.join("&");var P=document.getElementsByTagName("script")[0];P.parentNode.insertBefore(p,P)})("REPLACE WITH API KEY");
 </script>
 ```
 

snippet.js

@@ -12,12 +12,14 @@
         UserPreference: 6,
         Social: 7,
         Other: 8,
+        Media: 9,
     };
     window.mParticle.eCommerce = { Cart: {} };
     window.mParticle.Identity = {};
+    window.mParticle.Rokt = {};
     window.mParticle.config = window.mParticle.config || {};
     window.mParticle.config.rq = [];
-    window.mParticle.config.snippetVersion = 2.3;
+    window.mParticle.config.snippetVersion = 2.4;
     window.mParticle.ready = function(f) {
         window.mParticle.config.rq.push(f);
     };
@@ -43,6 +45,7 @@
     ];
     var ecommerceMethods = ['setCurrencyCode', 'logCheckout'];
     var identityMethods = ['identify', 'login', 'logout', 'modify'];
+    var roktMethods = ['attachLauncher', 'selectPlacements'];
 
     // iterates through methods above to create stubs
     mainMethods.forEach(function(method) {
@@ -54,6 +57,9 @@
     identityMethods.forEach(function(method) {
         window.mParticle.Identity[method] = preloadMethod(method, 'Identity');
     });
+    roktMethods.forEach(function(method) {
+        window.mParticle.Rokt[method] = preloadMethod(method, 'Rokt');
+    });
 
     // stubbing function
     // pushes an array of 2 arguments into readyQueue: 1. the method, and 2. the arguments passed to the method

snippet.min.js

@@ -121,7 +121,7 @@ describe('snippet', function() {
     });
 
     it('mParticle object should have EventTypes on it', function(done) {
-        Object.keys(mParticle.EventType).length.should.equal(9);
+        Object.keys(mParticle.EventType).length.should.equal(10);
         mParticle.EventType.Unknown.should.equal(0);
         mParticle.EventType.Navigation.should.equal(1);
         mParticle.EventType.Location.should.equal(2);
@@ -131,7 +131,16 @@ describe('snippet', function() {
         mParticle.EventType.UserPreference.should.equal(6);
         mParticle.EventType.Social.should.equal(7);
         mParticle.EventType.Other.should.equal(8);
+        mParticle.EventType.Media.should.equal(9);
 
         done();
     });
+
+    it('mParticle object should proxy Rokt methods', function(done) {
+        mParticle.Rokt.attachLauncher();
+        mParticle.Rokt.selectPlacements();
+        mParticle.config.rq[0][0].should.equal('Rokt.attachLauncher');
+        mParticle.config.rq[1][0].should.equal('Rokt.selectPlacements');
+        done();
+    });
 });