@mparticle/web-sdk 2.14.0 → 2.15.0

package/src/mp-instance.js

@@ -87,6 +87,7 @@ export default function mParticleInstance(instanceName) {
     this.Identity = this._Identity.IdentityAPI;
     this.generateHash = this._Helpers.generateHash;
     this.getDeviceId = this._Persistence.getDeviceId;
+
     if (typeof window !== 'undefined') {
         if (window.mParticle && window.mParticle.config) {
             if (window.mParticle.config.hasOwnProperty('rq')) {
@@ -143,9 +144,13 @@ export default function mParticleInstance(instanceName) {
      * @method reset
      */
     this.reset = function(instance) {
-        instance._Persistence.resetPersistence();
-        if (instance._Store) {
-            delete instance._Store;
+        try {
+            instance._Persistence.resetPersistence();
+            if (instance._Store) {
+                delete instance._Store;
+            }
+        } catch (error) {
+            console.error('Cannot reset mParticle', error);
         }
     };
 
@@ -177,7 +182,7 @@ export default function mParticleInstance(instanceName) {
      * @param {Function} function A function to be called after mParticle is initialized
      */
     this.ready = function(f) {
-        if (self._Store.isInitialized && typeof f === 'function') {
+        if (self.isInitialized() && typeof f === 'function') {
             f();
         } else {
             self._preInit.readyQueue.push(f);
@@ -197,9 +202,36 @@ export default function mParticleInstance(instanceName) {
      * @param {String} version version number
      */
     this.setAppVersion = function(version) {
+        var queued = queueIfNotInitialized(function() {
+            self.setAppVersion(version);
+        }, self);
+
+        if (queued) return;
+
         self._Store.SDKConfig.appVersion = version;
         self._Persistence.update();
     };
+    /**
+     * Sets the device id
+     * @method setDeviceId
+     * @param {String} name device ID (UUIDv4-formatted string)
+     */
+    this.setDeviceId = function(guid) {
+        var queued = queueIfNotInitialized(function() {
+            self.setDeviceId(guid);
+        }, self);
+        if (queued) return;
+        this._Persistence.setDeviceId(guid);
+    };
+    /**
+     * Returns a boolean for whether or not the SDKhas been fully initialized
+     * @method isInitialized
+     * @return {Boolean} a boolean for whether or not the SDK has been fully initialized
+     */
+    this.isInitialized = function() {
+        return self._Store ? self._Store.isInitialized : false;
+    };
+
     /**
      * Gets the app name
      * @method getAppName
@@ -214,6 +246,12 @@ export default function mParticleInstance(instanceName) {
      * @param {String} name App Name
      */
     this.setAppName = function(name) {
+        var queued = queueIfNotInitialized(function() {
+            self.setAppName(name);
+        }, self);
+
+        if (queued) return;
+
         self._Store.SDKConfig.appName = name;
     };
     /**
@@ -254,6 +292,12 @@ export default function mParticleInstance(instanceName) {
      * @param {Number} longitude longitude digit
      */
     this.setPosition = function(lat, lng) {
+        var queued = queueIfNotInitialized(function() {
+            self.setPosition(lat, lng);
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
         if (typeof lat === 'number' && typeof lng === 'number') {
             self._Store.currentPosition = {
@@ -288,12 +332,12 @@ export default function mParticleInstance(instanceName) {
      * @param {Object} [eventOptions] For Event-level Configuration Options
      */
     this.logBaseEvent = function(event, eventOptions) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logBaseEvent(event, eventOptions);
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.logBaseEvent(event, eventOptions);
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
         if (typeof event.name !== 'string') {
             self.Logger.error(Messages.ErrorMessages.EventNameInvalidType);
@@ -327,18 +371,18 @@ export default function mParticleInstance(instanceName) {
         customFlags,
         eventOptions
     ) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logEvent(
-                    eventName,
-                    eventType,
-                    eventInfo,
-                    customFlags,
-                    eventOptions
-                );
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.logEvent(
+                eventName,
+                eventType,
+                eventInfo,
+                customFlags,
+                eventOptions
+            );
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
         if (typeof eventName !== 'string') {
             self.Logger.error(Messages.ErrorMessages.EventNameInvalidType);
@@ -383,12 +427,12 @@ export default function mParticleInstance(instanceName) {
      * @param {Object} [attrs] Custom attrs to be passed along with the error event; values must be string, number, or boolean
      */
     this.logError = function(error, attrs) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logError(error, attrs);
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.logError(error, attrs);
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
         if (!error) {
             return;
@@ -463,12 +507,12 @@ export default function mParticleInstance(instanceName) {
      * @param {Object} [eventOptions] For Event-level Configuration Options
      */
     this.logPageView = function(eventName, attrs, customFlags, eventOptions) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logPageView(eventName, attrs, customFlags, eventOptions);
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.logPageView(eventName, attrs, customFlags, eventOptions);
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
 
         if (self._Helpers.canLog()) {
@@ -640,12 +684,11 @@ export default function mParticleInstance(instanceName) {
          * @param {String} code The currency code
          */
         setCurrencyCode: function(code) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.setCurrencyCode(code);
-                });
-                return;
-            }
+            var queued = queueIfNotInitialized(function() {
+                self.eCommerce.setCurrencyCode(code);
+            }, self);
+
+            if (queued) return;
 
             if (typeof code !== 'string') {
                 self.Logger.error('Code must be a string');
@@ -763,6 +806,7 @@ export default function mParticleInstance(instanceName) {
             self.Logger.warning(
                 'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead'
             );
+
             if (!self._Store.isInitialized) {
                 self.ready(function() {
                     self.eCommerce.logCheckout(
@@ -772,8 +816,10 @@ export default function mParticleInstance(instanceName) {
                         customFlags
                     );
                 });
+
                 return;
             }
+
             self._SessionManager.resetSessionTimer();
             self._Events.logCheckoutEvent(step, option, attrs, customFlags);
         },
@@ -796,19 +842,19 @@ export default function mParticleInstance(instanceName) {
             transactionAttributes,
             eventOptions
         ) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logProductAction(
-                        productActionType,
-                        product,
-                        attrs,
-                        customFlags,
-                        transactionAttributes,
-                        eventOptions
-                    );
-                });
-                return;
-            }
+            var queued = queueIfNotInitialized(function() {
+                self.eCommerce.logProductAction(
+                    productActionType,
+                    product,
+                    attrs,
+                    customFlags,
+                    transactionAttributes,
+                    eventOptions
+                );
+            }, self);
+
+            if (queued) return;
+
             self._SessionManager.resetSessionTimer();
             self._Events.logProductActionEvent(
                 productActionType,
@@ -881,18 +927,18 @@ export default function mParticleInstance(instanceName) {
             customFlags,
             eventOptions
         ) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logPromotion(
-                        type,
-                        promotion,
-                        attrs,
-                        customFlags,
-                        eventOptions
-                    );
-                });
-                return;
-            }
+            var queued = queueIfNotInitialized(function() {
+                self.eCommerce.logPromotion(
+                    type,
+                    promotion,
+                    attrs,
+                    customFlags,
+                    eventOptions
+                );
+            }, self);
+
+            if (queued) return;
+
             self._SessionManager.resetSessionTimer();
             self._Events.logPromotionEvent(
                 type,
@@ -912,17 +958,17 @@ export default function mParticleInstance(instanceName) {
          * @param {Object} [eventOptions] For Event-level Configuration Options
          */
         logImpression: function(impression, attrs, customFlags, eventOptions) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logImpression(
-                        impression,
-                        attrs,
-                        customFlags,
-                        eventOptions
-                    );
-                });
-                return;
-            }
+            var queued = queueIfNotInitialized(function() {
+                self.eCommerce.logImpression(
+                    impression,
+                    attrs,
+                    customFlags,
+                    eventOptions
+                );
+            }, self);
+
+            if (queued) return;
+
             self._SessionManager.resetSessionTimer();
             self._Events.logImpressionEvent(
                 impression,
@@ -983,12 +1029,12 @@ export default function mParticleInstance(instanceName) {
      * @param {String or Number} value value for session attribute
      */
     this.setSessionAttribute = function(key, value) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.setSessionAttribute(key, value);
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.setSessionAttribute(key, value);
+        }, self);
+
+        if (queued) return;
+
         // Logs to cookie
         // And logs to in-memory object
         // Example: mParticle.setSessionAttribute('location', '33431');
@@ -1034,12 +1080,12 @@ export default function mParticleInstance(instanceName) {
      * @param {Boolean} isOptingOut boolean to opt out or not. When set to true, opt out of logging.
      */
     this.setOptOut = function(isOptingOut) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.setOptOut(isOptingOut);
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.setOptOut(isOptingOut);
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
         self._Store.isEnabled = !isOptingOut;
 
@@ -1072,12 +1118,11 @@ export default function mParticleInstance(instanceName) {
      * also pass a null or empty map here to remove all of the attributes.
      */
     this.setIntegrationAttribute = function(integrationId, attrs) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.setIntegrationAttribute(integrationId, attrs);
-            });
-            return;
-        }
+        var queued = queueIfNotInitialized(function() {
+            self.setIntegrationAttribute(integrationId, attrs);
+        }, self);
+
+        if (queued) return;
 
         if (typeof integrationId !== 'number') {
             self.Logger.error('integrationId must be a number');
@@ -1464,3 +1509,13 @@ function processPreloadedItem(readyQueueItem, mpInstance) {
         }
     }
 }
+
+function queueIfNotInitialized(func, self) {
+    if (!self.isInitialized()) {
+        self.ready(function() {
+            func();
+        });
+        return true;
+    }
+    return false;
+}

package/src/mparticle-instance-manager.js

@@ -97,6 +97,12 @@ function mParticle() {
     this.getDeviceId = function() {
         return self.getInstance().getDeviceId();
     };
+    this.setDeviceId = function(guid) {
+        return self.getInstance().setDeviceId(guid);
+    };
+    this.isInitialized = function() {
+        return self.getInstance().isInitialized();
+    };
     this.startNewSession = function() {
         self.getInstance().startNewSession();
     };

package/src/persistence.js

@@ -1148,6 +1148,11 @@ export default function _Persistence(mpInstance) {
         return mpInstance._Store.deviceId;
     };
 
+    this.setDeviceId = function(guid) {
+        mpInstance._Store.deviceId = guid;
+        self.update();
+    };
+
     this.resetPersistence = function() {
         removeLocalStorage(StorageNames.localStorageName);
         removeLocalStorage(StorageNames.localStorageNameV3);

package/src/sdkRuntimeModels.ts

@@ -34,6 +34,7 @@ export interface SDKEvent {
     UserAttributeChanges?: SDKUserAttributeChangeData;
     CurrencyCode: string;
     DataPlan?: SDKDataPlan;
+    LaunchReferral?: string;
 }
 
 export interface SDKGeoLocation {

package/src/sdkToEventsApiConverter.ts

@@ -14,7 +14,6 @@ import {
 import * as EventsApi from '@mparticle/event-models';
 import Types from './types';
 
-
 export function convertEvents(
     mpid: string,
     sdkEvents: SDKEvent[],
@@ -436,6 +435,7 @@ export function convertAST(
                 .applicationInitialized,
         is_first_run: sdkEvent.IsFirstRun,
         is_upgrade: false,
+        launch_referral: sdkEvent.LaunchReferral,
     };
     astEventData = Object.assign(astEventData, commonEventData);
     return {

package/src/serverModel.js

@@ -218,6 +218,7 @@ export default function ServerModel(mpInstance) {
 
             if (eventObject.EventDataType === MessageType.AppStateTransition) {
                 eventObject.IsFirstRun = mpInstance._Store.isFirstRun;
+                eventObject.LaunchReferral = window.location.href || null;
             }
 
             eventObject.CurrencyCode = mpInstance._Store.currencyCode;
@@ -287,7 +288,7 @@ export default function ServerModel(mpInstance) {
             dto.fr = event.IsFirstRun;
             dto.iu = false;
             dto.at = ApplicationTransitionType.AppInit;
-            dto.lr = window.location.href || null;
+            dto.lr = event.LaunchReferral;
             dto.attrs = null;
         }
 

package/src/store.js

@@ -74,6 +74,9 @@ export default function Store(config, mpInstance) {
     this.SDKConfig = createSDKConfig(config);
     // Set configuration to default settings
     if (config) {
+        if (config.deviceId) {
+            this.deviceId = config.deviceId;
+        }
         if (config.hasOwnProperty('isDevelopmentMode')) {
             this.SDKConfig.isDevelopmentMode = mpInstance._Helpers.returnConvertedBoolean(
                 config.isDevelopmentMode