@mparticle/web-sdk 2.12.9 → 2.14.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.12.9",
+    "version": "2.14.2",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [
@@ -74,8 +74,8 @@
         "@semantic-release/exec": "^5.0.0",
         "@semantic-release/git": "^9.0.0",
         "@types/chai": "^4.2.3",
-        "@types/mocha": "^8.2.2",
-        "@types/node": "^15.0.1",
+        "@types/mocha": "^9.0.0",
+        "@types/node": "^16.0.0",
         "babel-eslint": "^10.0.3",
         "babel-preset-minify": "^0.5.1",
         "browser-sync": "^2.26.3",
@@ -84,7 +84,7 @@
         "cross-env": "^7.0.3",
         "eslint": "^7.25.0",
         "eslint-config-prettier": "8.3.0",
-        "eslint-plugin-prettier": "3.4.0",
+        "eslint-plugin-prettier": "3.4.1",
         "fetch-mock": "^7.5.1",
         "gts": "^3.1.0",
         "karma": "^6.3.2",

package/src/apiClient.js

@@ -59,7 +59,12 @@ export default function APIClient(mpInstance, kitBlocker) {
         });
     };
 
-    this.sendEventToServer = function(event) {
+    this.sendEventToServer = function(event, _options) {
+        var defaultOptions = {
+            shouldUploadEvent: true,
+        };
+        var options = mpInstance._Helpers.extend(defaultOptions, _options);
+
         if (mpInstance._Store.webviewBridgeEnabled) {
             mpInstance._NativeSdkHelpers.sendToNative(
                 Constants.NativeSdkPaths.LogEvent,
@@ -94,16 +99,21 @@ export default function APIClient(mpInstance, kitBlocker) {
 
         this.processQueuedEvents();
 
-        if (this.shouldEnableBatching()) {
-            this.queueEventForBatchUpload(event);
-        } else {
-            this.sendSingleEventToServer(event);
+        if (event && options.shouldUploadEvent) {
+            if (this.shouldEnableBatching()) {
+                this.queueEventForBatchUpload(event);
+            } else {
+                this.sendSingleEventToServer(event);
+            }
         }
 
         if (event && event.EventName !== Types.MessageType.AppStateTransition) {
             if (kitBlocker && kitBlocker.kitBlockingEnabled) {
                 event = kitBlocker.createBlockedEvent(event);
             }
+
+            // We need to check event again, because kitblocking
+            // can nullify the event
             if (event) {
                 mpInstance._Forwarders.sendEventToForwarders(event);
             }

package/src/cookieSyncManager.js

@@ -144,13 +144,14 @@ export default function cookieSyncManager(mpInstance) {
             var img = document.createElement('img');
 
             mpInstance.Logger.verbose(Messages.InformationMessages.CookieSync);
-
+            img.onload = function() {
+                cookieSyncDates[moduleId.toString()] = new Date().getTime();
+                mpInstance._Persistence.saveUserCookieSyncDatesToPersistence(
+                    mpid,
+                    cookieSyncDates
+                );
+            };
             img.src = url;
-            cookieSyncDates[moduleId.toString()] = new Date().getTime();
-            mpInstance._Persistence.saveUserCookieSyncDatesToPersistence(
-                mpid,
-                cookieSyncDates
-            );
         }
     };
 }

package/src/events.js

@@ -5,13 +5,13 @@ var Messages = Constants.Messages;
 
 export default function Events(mpInstance) {
     var self = this;
-    this.logEvent = function(event) {
+    this.logEvent = function(event, options) {
         mpInstance.Logger.verbose(
             Messages.InformationMessages.StartingLogEvent + ': ' + event.name
         );
         if (mpInstance._Helpers.canLog()) {
             var uploadObject = mpInstance._ServerModel.createEventObject(event);
-            mpInstance._APIClient.sendEventToServer(uploadObject);
+            mpInstance._APIClient.sendEventToServer(uploadObject, options);
         } else {
             mpInstance.Logger.verbose(
                 Messages.InformationMessages.AbandonLogEvent
@@ -125,7 +125,8 @@ export default function Events(mpInstance) {
         product,
         customAttrs,
         customFlags,
-        transactionAttributes
+        transactionAttributes,
+        options
     ) {
         var event = mpInstance._Ecommerce.createCommerceEventObject(
             customFlags
@@ -179,7 +180,7 @@ export default function Events(mpInstance) {
                 );
             }
 
-            self.logCommerceEvent(event, customAttrs);
+            self.logCommerceEvent(event, customAttrs, options);
         }
     };
 
@@ -256,7 +257,8 @@ export default function Events(mpInstance) {
         promotionType,
         promotion,
         attrs,
-        customFlags
+        customFlags,
+        eventOptions
     ) {
         var event = mpInstance._Ecommerce.createCommerceEventObject(
             customFlags
@@ -271,14 +273,21 @@ export default function Events(mpInstance) {
             );
             event.PromotionAction = {
                 PromotionActionType: promotionType,
-                PromotionList: [promotion],
+                PromotionList: Array.isArray(promotion)
+                    ? promotion
+                    : [promotion],
             };
 
-            self.logCommerceEvent(event, attrs);
+            self.logCommerceEvent(event, attrs, eventOptions);
         }
     };
 
-    this.logImpressionEvent = function(impression, attrs, customFlags) {
+    this.logImpressionEvent = function(
+        impression,
+        attrs,
+        customFlags,
+        options
+    ) {
         var event = mpInstance._Ecommerce.createCommerceEventObject(
             customFlags
         );
@@ -301,11 +310,11 @@ export default function Events(mpInstance) {
                 });
             });
 
-            self.logCommerceEvent(event, attrs);
+            self.logCommerceEvent(event, attrs, options);
         }
     };
 
-    this.logCommerceEvent = function(commerceEvent, attrs) {
+    this.logCommerceEvent = function(commerceEvent, attrs, options) {
         mpInstance.Logger.verbose(
             Messages.InformationMessages.StartingLogCommerceEvent
         );
@@ -325,7 +334,7 @@ export default function Events(mpInstance) {
                 commerceEvent.EventAttributes = attrs;
             }
 
-            mpInstance._APIClient.sendEventToServer(commerceEvent);
+            mpInstance._APIClient.sendEventToServer(commerceEvent, options);
             mpInstance._Persistence.update();
         } else {
             mpInstance.Logger.verbose(

package/src/identity.js

@@ -192,6 +192,7 @@ export default function Identity(mpInstance) {
                     source_mpid: aliasRequest.sourceMpid,
                     start_unixtime_ms: aliasRequest.startTime,
                     end_unixtime_ms: aliasRequest.endTime,
+                    scope: aliasRequest.scope,
                     device_application_stamp: mpInstance._Store.deviceId,
                 },
             };

package/src/mp-instance.js

@@ -143,9 +143,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 +181,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,6 +201,12 @@ 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();
     };
@@ -214,6 +224,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 +270,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 = {
@@ -285,14 +307,15 @@ export default function mParticleInstance(instanceName) {
     /**
      * Logs a Base Event to mParticle's servers
      * @param {Object} event Base Event Object
+     * @param {Object} [eventOptions] For Event-level Configuration Options
      */
-    this.logBaseEvent = function(event) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logBaseEvent(event);
-            });
-            return;
-        }
+    this.logBaseEvent = function(event, eventOptions) {
+        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);
@@ -308,7 +331,7 @@ export default function mParticleInstance(instanceName) {
             return;
         }
 
-        self._Events.logEvent(event);
+        self._Events.logEvent(event, eventOptions);
     };
     /**
      * Logs an event to mParticle's servers
@@ -317,14 +340,27 @@ export default function mParticleInstance(instanceName) {
      * @param {Number} [eventType] The eventType as seen [here](http://docs.mparticle.com/developers/sdk/web/event-tracking#event-type)
      * @param {Object} [eventInfo] Attributes for the event
      * @param {Object} [customFlags] Additional customFlags
+     * @param {Object} [eventOptions] For Event-level Configuration Options
      */
-    this.logEvent = function(eventName, eventType, eventInfo, customFlags) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logEvent(eventName, eventType, eventInfo, customFlags);
-            });
-            return;
-        }
+    this.logEvent = function(
+        eventName,
+        eventType,
+        eventInfo,
+        customFlags,
+        eventOptions
+    ) {
+        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);
@@ -350,13 +386,16 @@ export default function mParticleInstance(instanceName) {
             return;
         }
 
-        self._Events.logEvent({
-            messageType: Types.MessageType.PageEvent,
-            name: eventName,
-            data: eventInfo,
-            eventType: eventType,
-            customFlags: customFlags,
-        });
+        self._Events.logEvent(
+            {
+                messageType: Types.MessageType.PageEvent,
+                name: eventName,
+                data: eventInfo,
+                eventType: eventType,
+                customFlags: customFlags,
+            },
+            eventOptions
+        );
     };
     /**
      * Used to log custom errors
@@ -366,12 +405,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;
@@ -443,14 +482,15 @@ export default function mParticleInstance(instanceName) {
      * @param {String} eventName The name of the event. Defaults to 'PageView'.
      * @param {Object} [attrs] Attributes for the event
      * @param {Object} [customFlags] Custom flags for the event
+     * @param {Object} [eventOptions] For Event-level Configuration Options
      */
-    this.logPageView = function(eventName, attrs, customFlags) {
-        if (!self._Store.isInitialized) {
-            self.ready(function() {
-                self.logPageView(eventName, attrs, customFlags);
-            });
-            return;
-        }
+    this.logPageView = function(eventName, attrs, customFlags, eventOptions) {
+        var queued = queueIfNotInitialized(function() {
+            self.logPageView(eventName, attrs, customFlags, eventOptions);
+        }, self);
+
+        if (queued) return;
+
         self._SessionManager.resetSessionTimer();
 
         if (self._Helpers.canLog()) {
@@ -480,13 +520,16 @@ export default function mParticleInstance(instanceName) {
             }
         }
 
-        self._Events.logEvent({
-            messageType: Types.MessageType.PageView,
-            name: eventName,
-            data: attrs,
-            eventType: Types.EventType.Unknown,
-            customFlags: customFlags,
-        });
+        self._Events.logEvent(
+            {
+                messageType: Types.MessageType.PageView,
+                name: eventName,
+                data: attrs,
+                eventType: Types.EventType.Unknown,
+                customFlags: customFlags,
+            },
+            eventOptions
+        );
     };
     /**
      * Forces an upload of the batch
@@ -619,12 +662,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');
@@ -742,6 +784,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(
@@ -751,8 +794,10 @@ export default function mParticleInstance(instanceName) {
                         customFlags
                     );
                 });
+
                 return;
             }
+
             self._SessionManager.resetSessionTimer();
             self._Events.logCheckoutEvent(step, option, attrs, customFlags);
         },
@@ -765,33 +810,37 @@ export default function mParticleInstance(instanceName) {
          * @param {Object} [attrs] attributes related to the product action
          * @param {Object} [customFlags] Custom flags for the event
          * @param {Object} [transactionAttributes] Transaction Attributes for the event
+         * @param {Object} [eventOptions] For Event-level Configuration Options
          */
         logProductAction: function(
             productActionType,
             product,
             attrs,
             customFlags,
-            transactionAttributes
+            transactionAttributes,
+            eventOptions
         ) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logProductAction(
-                        productActionType,
-                        product,
-                        attrs,
-                        customFlags,
-                        transactionAttributes
-                    );
-                });
-                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,
                 product,
                 attrs,
                 customFlags,
-                transactionAttributes
+                transactionAttributes,
+                eventOptions
             );
         },
         /**
@@ -847,21 +896,35 @@ export default function mParticleInstance(instanceName) {
          * @param {Object} promotion promotion object
          * @param {Object} [attrs] boolean to clear the cart after logging or not
          * @param {Object} [customFlags] Custom flags for the event
+         * @param {Object} [eventOptions] For Event-level Configuration Options
          */
-        logPromotion: function(type, promotion, attrs, customFlags) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logPromotion(
-                        type,
-                        promotion,
-                        attrs,
-                        customFlags
-                    );
-                });
-                return;
-            }
+        logPromotion: function(
+            type,
+            promotion,
+            attrs,
+            customFlags,
+            eventOptions
+        ) {
+            var queued = queueIfNotInitialized(function() {
+                self.eCommerce.logPromotion(
+                    type,
+                    promotion,
+                    attrs,
+                    customFlags,
+                    eventOptions
+                );
+            }, self);
+
+            if (queued) return;
+
             self._SessionManager.resetSessionTimer();
-            self._Events.logPromotionEvent(type, promotion, attrs, customFlags);
+            self._Events.logPromotionEvent(
+                type,
+                promotion,
+                attrs,
+                customFlags,
+                eventOptions
+            );
         },
         /**
          * Logs a product impression
@@ -870,20 +933,27 @@ export default function mParticleInstance(instanceName) {
          * @param {Object} impression product impression object
          * @param {Object} attrs attributes related to the impression log
          * @param {Object} [customFlags] Custom flags for the event
+         * @param {Object} [eventOptions] For Event-level Configuration Options
          */
-        logImpression: function(impression, attrs, customFlags) {
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logImpression(
-                        impression,
-                        attrs,
-                        customFlags
-                    );
-                });
-                return;
-            }
+        logImpression: function(impression, attrs, customFlags, eventOptions) {
+            var queued = queueIfNotInitialized(function() {
+                self.eCommerce.logImpression(
+                    impression,
+                    attrs,
+                    customFlags,
+                    eventOptions
+                );
+            }, self);
+
+            if (queued) return;
+
             self._SessionManager.resetSessionTimer();
-            self._Events.logImpressionEvent(impression, attrs, customFlags);
+            self._Events.logImpressionEvent(
+                impression,
+                attrs,
+                customFlags,
+                eventOptions
+            );
         },
         /**
          * Logs a refund
@@ -937,12 +1007,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');
@@ -988,12 +1058,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;
 
@@ -1026,12 +1096,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');
@@ -1117,6 +1186,9 @@ export default function mParticleInstance(instanceName) {
     this._setIntegrationDelay = function(module, boolean) {
         self._preInit.integrationDelays[module] = boolean;
     };
+    this.isInitialized = function() {
+        return self._Store ? self._Store.isInitialized : false;
+    };
 }
 
 // Some (server) config settings need to be returned before they are set on SDKConfig in a self hosted environment
@@ -1418,3 +1490,13 @@ function processPreloadedItem(readyQueueItem, mpInstance) {
         }
     }
 }
+
+function queueIfNotInitialized(func, self) {
+    if (!self.isInitialized()) {
+        self.ready(function() {
+            func();
+        });
+        return true;
+    }
+    return false;
+}