@mparticle/web-sdk 2.17.3 → 2.18.0

package/dist/mparticle.js

@@ -708,6 +708,10 @@ var mParticle = (function () {
     var ApplicationTransitionType$1 = {
       AppInit: 1
     };
+    var Environment = {
+      Production: 'production',
+      Development: 'development'
+    };
     var Types = {
       MessageType: MessageType$1,
       EventType: EventType,
@@ -717,10 +721,11 @@ var mParticle = (function () {
       ApplicationTransitionType: ApplicationTransitionType$1,
       ProductActionType: ProductActionType,
       PromotionActionType: PromotionActionType,
-      TriggerUploadType: TriggerUploadType
+      TriggerUploadType: TriggerUploadType,
+      Environment: Environment
     };
 
-    var version = "2.17.3";
+    var version = "2.18.0";
 
     var Constants = {
       sdkVersion: version,
@@ -2555,7 +2560,7 @@ var mParticle = (function () {
       };
     }
 
-    var slugify = {exports: {}};
+    var slugify$1 = {exports: {}};
 
     (function (module, exports) {
     (function (name, root, factory) {
@@ -2619,9 +2624,9 @@ var mParticle = (function () {
 
     	  return replace
     	}));
-    } (slugify));
+    } (slugify$1));
 
-    var Slugify = slugify.exports;
+    var slugify = slugify$1.exports;
 
     var inArray = function inArray(items, name) {
       var i = 0;
@@ -2663,6 +2668,14 @@ var mParticle = (function () {
 
       var floatValue = parseFloat(value);
       return isNaN(floatValue) ? 0 : floatValue;
+    };
+
+    var parseStringOrNumber = function parseStringOrNumber(value) {
+      if (isStringOrNumber(value)) {
+        return value;
+      } else {
+        return null;
+      }
     }; // FIXME: REFACTOR for V3
     // only used in store.js to sanitize server-side formatting of
     // booleans when checking for `isDevelopmentMode`
@@ -2689,23 +2702,41 @@ var mParticle = (function () {
       return s;
     };
 
+    var isString = function isString(value) {
+      return typeof value === 'string';
+    };
+
+    var isNumber = function isNumber(value) {
+      return typeof value === 'number';
+    };
+
+    var isFunction = function isFunction(fn) {
+      return typeof fn === 'function';
+    }; // TODO: Refactor this to a regex
+
+
+    var isDataPlanSlug = function isDataPlanSlug(str) {
+      return isString(str) && str === slugify(str);
+    };
+
+    var isStringOrNumber = function isStringOrNumber(value) {
+      return isString(value) || isNumber(value);
+    };
+
     var Validators = {
+      // From ./utils
+      // Utility Functions for backwards compatability
+      isNumber: isNumber,
+      isFunction: isFunction,
+      isStringOrNumber: isStringOrNumber,
       isValidAttributeValue: function isValidAttributeValue(value) {
         return value !== undefined && !isObject(value) && !Array.isArray(value);
       },
+      // Validator Functions
       // Neither null nor undefined can be a valid Key
       isValidKeyValue: function isValidKeyValue(key) {
         return Boolean(key && !isObject(key) && !Array.isArray(key) && !this.isFunction(key));
       },
-      isStringOrNumber: function isStringOrNumber(value) {
-        return typeof value === 'string' || typeof value === 'number';
-      },
-      isNumber: function isNumber(value) {
-        return typeof value === 'number';
-      },
-      isFunction: function isFunction(fn) {
-        return typeof fn === 'function';
-      },
       validateIdentities: function validateIdentities(identityApiData, method) {
         var validIdentityRequestKeys = {
           userIdentities: 1,
@@ -3132,14 +3163,6 @@ var mParticle = (function () {
         return false;
       };
 
-      this.parseStringOrNumber = function (value) {
-        if (Validators.isStringOrNumber(value)) {
-          return value;
-        } else {
-          return null;
-        }
-      };
-
       this.generateHash = function (name) {
         var hash = 0,
             i = 0,
@@ -3220,10 +3243,6 @@ var mParticle = (function () {
         } else {
           return StorageNames$2.currentStorageProductsName;
         }
-      };
-
-      this.isSlug = function (str) {
-        return str === Slugify(str);
       }; // Utility Functions
 
 
@@ -3233,7 +3252,8 @@ var mParticle = (function () {
       this.inArray = inArray;
       this.isObject = isObject;
       this.decoded = decoded;
-      this.returnConvertedBoolean = returnConvertedBoolean; // Imported Validators
+      this.returnConvertedBoolean = returnConvertedBoolean;
+      this.parseStringOrNumber = parseStringOrNumber; // Imported Validators
 
       this.Validators = Validators;
     }
@@ -4137,6 +4157,7 @@ var mParticle = (function () {
     }
 
     function createSDKConfig(config) {
+      // TODO: Refactor to create a default config object
       var sdkConfig = {};
 
       for (var prop in Constants.DefaultConfig) {
@@ -4146,14 +4167,14 @@ var mParticle = (function () {
       }
 
       if (config) {
-        for (prop in config) {
+        for (var prop in config) {
           if (config.hasOwnProperty(prop)) {
             sdkConfig[prop] = config[prop];
           }
         }
       }
 
-      for (prop in Constants.DefaultUrls) {
+      for (var prop in Constants.DefaultUrls) {
         sdkConfig[prop] = Constants.DefaultUrls[prop];
       }
 
@@ -4182,7 +4203,7 @@ var mParticle = (function () {
         eventQueue: [],
         currencyCode: null,
         globalTimer: null,
-        context: '',
+        context: null,
         configurationLoaded: false,
         identityCallInFlight: false,
         SDKConfig: {},
@@ -4248,15 +4269,8 @@ var mParticle = (function () {
           this.SDKConfig.logLevel = config.logLevel;
         }
 
-        if (config.hasOwnProperty('useNativeSdk')) {
-          this.SDKConfig.useNativeSdk = config.useNativeSdk;
-        } else {
-          this.SDKConfig.useNativeSdk = false;
-        }
-
-        if (config.hasOwnProperty('kits')) {
-          this.SDKConfig.kits = config.kits;
-        }
+        this.SDKConfig.useNativeSdk = !!config.useNativeSdk;
+        this.SDKConfig.kits = config.kits || {};
 
         if (config.hasOwnProperty('isIOS')) {
           this.SDKConfig.isIOS = config.isIOS;
@@ -4306,7 +4320,7 @@ var mParticle = (function () {
           if (mpInstance._Helpers.Validators.isFunction(callback)) {
             this.SDKConfig.identityCallback = config.identityCallback;
           } else {
-            mpInstance.Logger.warning('The optional callback must be a function. You tried entering a(n) ' + _typeof(callback), ' . Callback not set. Please set your callback again.');
+            mpInstance.Logger.warning('The optional callback must be a function. You tried entering a(n) ' + _typeof(callback) + ' . Callback not set. Please set your callback again.');
           }
         }
 
@@ -4327,26 +4341,25 @@ var mParticle = (function () {
             PlanVersion: null,
             PlanId: null
           };
+          var dataPlan = config.dataPlan;
 
-          if (config.dataPlan.hasOwnProperty('planId')) {
-            if (typeof config.dataPlan.planId === 'string') {
-              if (mpInstance._Helpers.isSlug(config.dataPlan.planId)) {
-                this.SDKConfig.dataPlan.PlanId = config.dataPlan.planId;
-              } else {
-                mpInstance.Logger.error('Your data plan id must be in a slug format');
-              }
+          if (dataPlan.planId) {
+            if (isDataPlanSlug(dataPlan.planId)) {
+              this.SDKConfig.dataPlan.PlanId = dataPlan.planId;
             } else {
-              mpInstance.Logger.error('Your data plan id must be a string');
+              mpInstance.Logger.error('Your data plan id must be a string and match the data plan slug format (i.e. under_case_slug)');
             }
           }
 
-          if (config.dataPlan.hasOwnProperty('planVersion')) {
-            if (typeof config.dataPlan.planVersion === 'number') {
-              this.SDKConfig.dataPlan.PlanVersion = config.dataPlan.planVersion;
+          if (dataPlan.planVersion) {
+            if (isNumber(dataPlan.planVersion)) {
+              this.SDKConfig.dataPlan.PlanVersion = dataPlan.planVersion;
             } else {
               mpInstance.Logger.error('Your data plan version must be a number');
             }
           }
+        } else {
+          this.SDKConfig.dataPlan = {};
         }
 
         if (config.hasOwnProperty('forceHttps')) {
@@ -4356,9 +4369,7 @@ var mParticle = (function () {
         } // Some forwarders require custom flags on initialization, so allow them to be set using config object
 
 
-        if (config.hasOwnProperty('customFlags')) {
-          this.SDKConfig.customFlags = config.customFlags;
-        }
+        this.SDKConfig.customFlags = config.customFlags || {};
 
         if (config.hasOwnProperty('minWebviewBridgeVersion')) {
           this.SDKConfig.minWebviewBridgeVersion = config.minWebviewBridgeVersion;
@@ -9368,6 +9379,16 @@ var mParticle = (function () {
           self._preInit.readyQueue.push(f);
         }
       };
+      /**
+       * Returns the current mParticle environment setting
+       * @method getEnvironment
+       * @returns {String} mParticle environment setting
+       */
+
+
+      this.getEnvironment = function () {
+        return self._Store.SDKConfig.isDevelopmentMode ? Types.Environment.Development : Types.Environment.Production;
+      };
       /**
        * Returns the mParticle SDK version number
        * @method getVersion
@@ -10247,9 +10268,44 @@ var mParticle = (function () {
       this._getIntegrationDelays = function () {
         return self._preInit.integrationDelays;
       };
+      /*
+          An integration delay is a workaround that prevents events from being sent when it is necessary to do so.
+          Some server side integrations require a client side value to be included in the payload to successfully 
+          forward.  This value can only be pulled from the client side partner SDK.
+           During the kit initialization, the kit:
+          * sets an integration delay to `true`
+          * grabs the required value from the partner SDK,
+          * sets it via `setIntegrationAttribute`
+          * sets the integration delay to `false`
+           The core SDK can then read via `isDelayedByIntegration` to no longer delay sending events.
+           This integration attribute is now on the batch payload for the server side to read.
+           If there is no delay, then the events sent before an integration attribute is included would not
+          be forwarded successfully server side.
+      */
+
 
-      this._setIntegrationDelay = function (module, _boolean) {
-        self._preInit.integrationDelays[module] = _boolean;
+      this._setIntegrationDelay = function (module, shouldDelayIntegration) {
+        self._preInit.integrationDelays[module] = shouldDelayIntegration; // If the integration delay is set to true, no further action needed
+
+        if (shouldDelayIntegration === true) {
+          return;
+        } // If the integration delay is set to false, check to see if there are any
+        // other integration delays set to true.  It not, process the queued events/.
+
+
+        var integrationDelaysKeys = Object.keys(self._preInit.integrationDelays);
+
+        if (integrationDelaysKeys.length === 0) {
+          return;
+        }
+
+        var hasIntegrationDelays = integrationDelaysKeys.some(function (integration) {
+          return self._preInit.integrationDelays[integration] === true;
+        });
+
+        if (!hasIntegrationDelays) {
+          self._APIClient.processQueuedEvents();
+        }
       };
     } // Some (server) config settings need to be returned before they are set on SDKConfig in a self hosted environment
 
@@ -10682,6 +10738,10 @@ var mParticle = (function () {
         return self.getInstance().getAppVersion();
       };
 
+      this.getEnvironment = function () {
+        return self.getInstance().getEnvironment();
+      };
+
       this.stopTrackingLocation = function () {
         self.getInstance().stopTrackingLocation();
       };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.17.3",
+    "version": "2.18.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [

package/src/helpers.js

@@ -1,6 +1,5 @@
 import Types from './types';
 import Constants from './constants';
-import Slugify from 'slugify';
 import * as utils from './utils';
 import Validators from './validators';
 
@@ -399,14 +398,6 @@ export default function Helpers(mpInstance) {
         return false;
     };
 
-    this.parseStringOrNumber = function(value) {
-        if (Validators.isStringOrNumber(value)) {
-            return value;
-        } else {
-            return null;
-        }
-    };
-
     this.generateHash = function(name) {
         var hash = 0,
             i = 0,
@@ -505,10 +496,6 @@ export default function Helpers(mpInstance) {
         }
     };
 
-    this.isSlug = function(str) {
-        return str === Slugify(str);
-    };
-
     // Utility Functions
     this.converted = utils.converted;
     this.findKeyInObject = utils.findKeyInObject;
@@ -517,6 +504,7 @@ export default function Helpers(mpInstance) {
     this.isObject = utils.isObject;
     this.decoded = utils.decoded;
     this.returnConvertedBoolean = utils.returnConvertedBoolean;
+    this.parseStringOrNumber = utils.parseStringOrNumber;
 
     // Imported Validators
     this.Validators = Validators;

package/src/mp-instance.js

@@ -188,6 +188,16 @@ export default function mParticleInstance(instanceName) {
             self._preInit.readyQueue.push(f);
         }
     };
+    /**
+     * Returns the current mParticle environment setting
+     * @method getEnvironment
+     * @returns {String} mParticle environment setting
+     */
+    this.getEnvironment = function() {
+        return self._Store.SDKConfig.isDevelopmentMode
+            ? Types.Environment.Development
+            : Types.Environment.Production;
+    };
     /**
      * Returns the mParticle SDK version number
      * @method getVersion
@@ -1205,8 +1215,51 @@ export default function mParticleInstance(instanceName) {
     this._getIntegrationDelays = function() {
         return self._preInit.integrationDelays;
     };
-    this._setIntegrationDelay = function(module, boolean) {
-        self._preInit.integrationDelays[module] = boolean;
+    /*
+        An integration delay is a workaround that prevents events from being sent when it is necessary to do so.
+        Some server side integrations require a client side value to be included in the payload to successfully 
+        forward.  This value can only be pulled from the client side partner SDK.
+
+        During the kit initialization, the kit:
+        * sets an integration delay to `true`
+        * grabs the required value from the partner SDK,
+        * sets it via `setIntegrationAttribute`
+        * sets the integration delay to `false`
+
+        The core SDK can then read via `isDelayedByIntegration` to no longer delay sending events.
+
+        This integration attribute is now on the batch payload for the server side to read.
+
+        If there is no delay, then the events sent before an integration attribute is included would not
+        be forwarded successfully server side.
+    */
+    this._setIntegrationDelay = function(module, shouldDelayIntegration) {
+        self._preInit.integrationDelays[module] = shouldDelayIntegration;
+
+        // If the integration delay is set to true, no further action needed
+        if (shouldDelayIntegration === true) {
+            return;
+        }
+        // If the integration delay is set to false, check to see if there are any
+        // other integration delays set to true.  It not, process the queued events/.
+
+        const integrationDelaysKeys = Object.keys(
+            self._preInit.integrationDelays
+        );
+
+        if (integrationDelaysKeys.length === 0) {
+            return;
+        }
+
+        const hasIntegrationDelays = integrationDelaysKeys.some(function(
+            integration
+        ) {
+            return self._preInit.integrationDelays[integration] === true;
+        });
+
+        if (!hasIntegrationDelays) {
+            self._APIClient.processQueuedEvents();
+        }
     };
 }
 

package/src/mparticle-instance-manager.js

@@ -128,6 +128,9 @@ function mParticle() {
     this.getAppVersion = function() {
         return self.getInstance().getAppVersion();
     };
+    this.getEnvironment = function() {
+        return self.getInstance().getEnvironment();
+    };
     this.stopTrackingLocation = function() {
         self.getInstance().stopTrackingLocation();
     };

package/src/sdkRuntimeModels.ts

@@ -1,5 +1,9 @@
-import * as EventsApi from '@mparticle/event-models';
-import { DataPlanVersion, DataPlan } from '@mparticle/data-planning-models';
+import { DataPlanVersion } from '@mparticle/data-planning-models';
+import { Batch } from '@mparticle/event-models';
+import { MPConfiguration, SDKEventCustomFlags } from '@mparticle/web-sdk';
+import { SDKConfig } from './store';
+import { Dictionary } from './utils';
+import Validators from './validators';
 
 export interface SDKEvent {
     DeviceId: string;
@@ -116,59 +120,77 @@ export interface SDKProduct {
 }
 
 export interface MParticleWebSDK {
-    addForwarder(mockForwarder: any);
+    addForwarder(mockForwarder: MPForwarder): void;
     Identity: SDKIdentityApi;
     Logger: SDKLoggerApi;
     _Store: SDKStoreApi;
     _Helpers: SDKHelpersApi;
-    config: SDKConfig;
+    config: SDKInitConfig;
     _resetForTests(MPConfig: SDKConfig): void;
-    init(apiKey: string, config: SDKConfig): void;
+    init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
     getInstance();
     ServerModel();
     upload();
     setPosition(lat: number | string, lng: number | string): void;
-    logEvent(eventName: string, eventType?: number, attrs?: { [key: string]: string }): void;
+    logEvent(
+        eventName: string,
+        eventType?: number,
+        attrs?: { [key: string]: string },
+        customFlags?: SDKEventCustomFlags
+    ): void;
     logBaseEvent(event: any): void;
     eCommerce: any;
     logLevel: string;
     ProductActionType: SDKProductActionType;
     generateHash(value: string);
+    isIOS?: boolean;
 }
 
-export interface SDKConfig {
-    isDevelopmentMode?: boolean;
-    logger: {
-        error?(msg);
-        warning?(msg) 
-        verbose?(msg) 
-    };
-    onCreateBatch(batch: EventsApi.Batch): EventsApi.Batch;
-    dataPlan: DataPlanConfig;
-    appVersion?: string;
-    package?: string;
-    flags?: { [key: string]: string | number };
-    kitConfigs: any;
-    appName?: string;
-    logLevel?: string;
+export type LogLevelType = 'none' | 'verbose' | 'warning' | 'error';
+
+// TODO: Create true types for Kits and Kit Configs
+export type KitConfigs = Dictionary;
+export type Kit = Dictionary;
+export type MPForwarder = Dictionary;
+
+// TODO: This should eventually be moved into wherever init logic lives
+// TODO: Replace/Merge this with MPConfiguration in @types/mparticle__web-sdk
+// SDK Init Config represents the config that is passed into mParticle.init when
+// the sdk is initialized.
+// Currently, this extends MPConfiguration in @types/mparticle__web-sdk
+// and the two will be merged in once the Store module is refactored
+export interface SDKInitConfig
+    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel'> {
+    dataPlan?: DataPlanConfig | KitBlockerDataPlan; // TODO: These should be eventually split into two different attributes
+    logLevel?: LogLevelType;
+
+    kitConfigs?: KitConfigs[];
+    kits?: Dictionary<Kit>;
+    dataPlanOptions?: KitBlockerOptions;
+    flags?: Dictionary;
+
+    aliasMaxWindow: number;
+    deviceId?: string;
+    forceHttps?: boolean;
+    aliasUrl?: string;
+    configUrl?: string;
+    identityUrl?: string;
+    integrationDelayTimeout: number;
+    isIOS?: boolean;
+    maxProducts: number;
+    requestConfig?: boolean;
     sessionTimeout?: number;
+    useNativeSdk?: boolean;
     useCookieStorage?: boolean;
-    cookieDomain?: string;
-    workspaceToken: string;
-    requiredWebviewBridgeName: string;
-    minWebviewBridgeVersion: number;
-    isIOS?: boolean;
-    identifyRequest: { [key: string]: {[key: string]: string} };
-    identityCallback: (result) => void;
-    requestConfig: boolean;
-    dataPlanOptions: KitBlockerOptions // when the user provides their own data plan
-    dataPlanResult?: DataPlanResult  // when the data plan comes from the server via /config
+    v1SecureServiceUrl?: string;
+    v2SecureServiceUrl?: string;
+    v3SecureServiceUrl?: string;
 }
 
 export interface DataPlanConfig {
     planId?: string;
     planVersion?: number;
-    document?: DataPlanResult  // when the data plan comes from the server via /mparticle.js
+    document?: DataPlanResult; // when the data plan comes from the server via /mparticle.js
 }
 
 export interface SDKIdentityApi {
@@ -182,9 +204,11 @@ export interface SDKIdentityApi {
 
 export interface SDKHelpersApi {
     createServiceUrl(arg0: string, arg1: string): void;
-    parseNumber(value: number)
+    parseNumber(value: number);
     generateUniqueId();
-    isObject(item: any)
+    isObject(item: any);
+    returnConvertedBoolean(data: string | boolean | number): boolean;
+    Validators: typeof Validators;
 }
 
 export interface SDKLoggerApi {
@@ -205,7 +229,7 @@ export interface SDKConfigApi {
     v3SecureServiceUrl?: string;
     isDevelopmentMode: boolean;
     appVersion?: string;
-    onCreateBatch(batch: EventsApi.Batch): EventsApi.Batch
+    onCreateBatch(batch: Batch): Batch;
 }
 export interface MParticleUser {
     getMPID(): string;
@@ -267,7 +291,7 @@ export interface KitBlockerOptions {
 }
 
 export interface KitBlockerDataPlan {
-    document: DataPlanResult
+    document: DataPlanResult;
 }
 
 export interface DataPlanResult {
@@ -280,30 +304,30 @@ export interface DataPlanResult {
             id: boolean;
         };
     };
-    error_message?: string
+    error_message?: string;
 }
 
 export enum SDKIdentityTypeEnum {
-    other = "other",
-    customerId = "customerid",
-    facebook = "facebook",
-    twitter = "twitter",
-    google = "google",
-    microsoft = "microsoft",
-    yahoo = "yahoo",
-    email = "email",
-    alias = "alias",
-    facebookCustomAudienceId = "facebookcustomaudienceid",
-    otherId2 = "other2",
-    otherId3 = "other3",
-    otherId4 = "other4",
-    otherId5 = "other5",
-    otherId6 = "other6",
-    otherId7 = "other7",
-    otherId8 = "other8",
-    otherId9 = "other9",
-    otherId10 = "other10",
-    mobileNumber = "mobile_number",
-    phoneNumber2 = "phone_number_2",
-    phoneNumber3 = "phone_number_3"
-}
+    other = 'other',
+    customerId = 'customerid',
+    facebook = 'facebook',
+    twitter = 'twitter',
+    google = 'google',
+    microsoft = 'microsoft',
+    yahoo = 'yahoo',
+    email = 'email',
+    alias = 'alias',
+    facebookCustomAudienceId = 'facebookcustomaudienceid',
+    otherId2 = 'other2',
+    otherId3 = 'other3',
+    otherId4 = 'other4',
+    otherId5 = 'other5',
+    otherId6 = 'other6',
+    otherId7 = 'other7',
+    otherId8 = 'other8',
+    otherId9 = 'other9',
+    otherId10 = 'other10',
+    mobileNumber = 'mobile_number',
+    phoneNumber2 = 'phone_number_2',
+    phoneNumber3 = 'phone_number_3',
+}