@mparticle/web-sdk 2.78.0 → 2.79.1

package/src/{helpers.js → helpers.ts}

@@ -1,14 +1,72 @@
 import Types from './types';
 import Constants from './constants';
 import * as utils from './utils';
+import { Dictionary } from './utils';
 import Validators from './validators';
 import KitFilterHelper from './kitFilterHelper';
+import { IMParticleWebSDKInstance } from './mp-instance';
+import { SDKHelpersApi } from './sdkRuntimeModels';
+import { IMParticleUser, IdentityCallback, IdentityResult, ISDKUserIdentity } from './identity-user-interfaces';
+import { IAliasResult } from './identity.interfaces';
+import { AliasUsersCallback, MPID } from '@mparticle/web-sdk';
 
-var StorageNames = Constants.StorageNames;
+const StorageNames = Constants.StorageNames;
 
-export default function Helpers(mpInstance) {
-    var self = this;
-    this.canLog = function() {
+function appendFilteredUserIdentity(
+    filteredUserIdentities: ISDKUserIdentity[],
+    identity: ISDKUserIdentity,
+    userIdentityType: number
+): void {
+    if (userIdentityType === Types.IdentityType.CustomerId) {
+        filteredUserIdentities.unshift(identity);
+    } else {
+        filteredUserIdentities.push(identity);
+    }
+}
+
+function buildFilteredUserIdentities(
+    userIdentitiesObject: utils.Dictionary<string> | null | undefined,
+    filterList: number[],
+    inArray: (items: any[], value: any) => boolean
+): ISDKUserIdentity[] {
+    const filteredUserIdentities: ISDKUserIdentity[] = [];
+
+    if (!userIdentitiesObject || !Object.keys(userIdentitiesObject).length) {
+        return filteredUserIdentities;
+    }
+
+    for (const userIdentityName in userIdentitiesObject) {
+        if (!userIdentitiesObject.hasOwnProperty(userIdentityName)) {
+            continue;
+        }
+
+        const userIdentityType = Types.IdentityType.getIdentityType(
+            userIdentityName
+        );
+
+        if (inArray(filterList, userIdentityType)) {
+            continue;
+        }
+
+        appendFilteredUserIdentity(
+            filteredUserIdentities,
+            {
+                Type: userIdentityType,
+                Identity: userIdentitiesObject[userIdentityName],
+            },
+            userIdentityType
+        );
+    }
+
+    return filteredUserIdentities;
+}
+
+export default function Helpers(
+    this: SDKHelpersApi,
+    mpInstance: IMParticleWebSDKInstance
+): void {
+    const self = this;
+    this.canLog = function(): boolean {
         if (
             mpInstance._Store.isEnabled &&
             (mpInstance._Store.devToken ||
@@ -20,7 +78,7 @@ export default function Helpers(mpInstance) {
         return false;
     };
 
-    this.getFeatureFlag = function(feature) {
+    this.getFeatureFlag = function(feature: string): boolean | string {
         if (mpInstance._Store.SDKConfig.flags.hasOwnProperty(feature)) {
             return mpInstance._Store.SDKConfig.flags[feature];
         }
@@ -28,12 +86,12 @@ export default function Helpers(mpInstance) {
     };
 
     this.invokeCallback = function(
-        callback,
-        code,
-        body,
-        mParticleUser,
-        previousMpid
-    ) {
+        callback: IdentityCallback,
+        code: number,
+        body: string,
+        mParticleUser?: IMParticleUser,
+        previousMpid?: MPID
+    ): void {
         if (!callback) {
             mpInstance.Logger.warning('There is no callback provided');
         }
@@ -51,9 +109,9 @@ export default function Helpers(mpInstance) {
                     },
                     getPreviousUser: function() {
                         if (!previousMpid) {
-                            var users = mpInstance.Identity.getUsers();
-                            var mostRecentUser = users.shift();
-                            var currentUser =
+                            const users = mpInstance.Identity.getUsers();
+                            let mostRecentUser = users.shift();
+                            const currentUser =
                                 mParticleUser ||
                                 mpInstance.Identity.getCurrentUser();
                             if (
@@ -69,7 +127,7 @@ export default function Helpers(mpInstance) {
                             return mpInstance.Identity.getUser(previousMpid);
                         }
                     },
-                });
+                } as unknown as IdentityResult);
             }
         } catch (e) {
             mpInstance.Logger.error(
@@ -78,19 +136,23 @@ export default function Helpers(mpInstance) {
         }
     };
 
-    this.invokeAliasCallback = function(callback, code, message) {
+    this.invokeAliasCallback = function(
+        callback: AliasUsersCallback,
+        code: number,
+        message?: string
+    ): void {
         if (!callback) {
             mpInstance.Logger.warning('There is no callback provided');
         }
         try {
             if (self.Validators.isFunction(callback)) {
-                var callbackMessage = {
+                const callbackMessage: Dictionary = {
                     httpCode: code,
                 };
                 if (message) {
                     callbackMessage.message = message;
                 }
-                callback(callbackMessage);
+                callback(callbackMessage as IAliasResult);
             }
         } catch (e) {
             mpInstance.Logger.error(
@@ -101,12 +163,15 @@ export default function Helpers(mpInstance) {
 
     this.extend = utils.extend;
 
-    this.createServiceUrl = function(secureServiceUrl, devToken) {
-        var serviceScheme =
+    this.createServiceUrl = function(
+        secureServiceUrl: string,
+        devToken?: string
+    ): string {
+        const serviceScheme =
             window.mParticle && mpInstance._Store.SDKConfig.forceHttps
                 ? 'https://'
                 : window.location.protocol + '//';
-        var baseUrl;
+        let baseUrl;
         if (mpInstance._Store.SDKConfig.forceHttps) {
             baseUrl = 'https://' + secureServiceUrl;
         } else {
@@ -118,8 +183,8 @@ export default function Helpers(mpInstance) {
         return baseUrl;
     };
 
-    this.createXHR = function(cb) {
-        var xhr;
+    this.createXHR = function(cb: () => void): XMLHttpRequest {
+        let xhr;
 
         try {
             xhr = new window.XMLHttpRequest();
@@ -129,11 +194,13 @@ export default function Helpers(mpInstance) {
 
         if (xhr && cb && 'withCredentials' in xhr) {
             xhr.onreadystatechange = cb;
-        } else if (typeof window.XDomainRequest !== 'undefined') {
+        } else if (
+            typeof (window as Dictionary).XDomainRequest !== 'undefined'
+        ) {
             mpInstance.Logger.verbose('Creating XDomainRequest object');
 
             try {
-                xhr = new window.XDomainRequest();
+                xhr = new (window as Dictionary).XDomainRequest();
                 xhr.onload = cb;
             } catch (e) {
                 mpInstance.Logger.error('Error creating XDomainRequest object');
@@ -143,41 +210,25 @@ export default function Helpers(mpInstance) {
         return xhr;
     };
 
-    this.filterUserIdentities = function(userIdentitiesObject, filterList) {
-        var filteredUserIdentities = [];
-
-        if (userIdentitiesObject && Object.keys(userIdentitiesObject).length) {
-            for (var userIdentityName in userIdentitiesObject) {
-                if (userIdentitiesObject.hasOwnProperty(userIdentityName)) {
-                    var userIdentityType = Types.IdentityType.getIdentityType(
-                        userIdentityName
-                    );
-                    if (!self.inArray(filterList, userIdentityType)) {
-                        var identity = {
-                            Type: userIdentityType,
-                            Identity: userIdentitiesObject[userIdentityName],
-                        };
-                        if (
-                            userIdentityType === Types.IdentityType.CustomerId
-                        ) {
-                            filteredUserIdentities.unshift(identity);
-                        } else {
-                            filteredUserIdentities.push(identity);
-                        }
-                    }
-                }
-            }
-        }
-
-        return filteredUserIdentities;
+    this.filterUserIdentities = function(
+        userIdentitiesObject: Dictionary<string>,
+        filterList: number[]
+    ): ISDKUserIdentity[] {
+        return buildFilteredUserIdentities(
+            userIdentitiesObject,
+            filterList,
+            self.inArray
+        );
     };
 
     this.filterUserIdentitiesForForwarders =
         KitFilterHelper.filterUserIdentities;
     this.filterUserAttributes = KitFilterHelper.filterUserAttributes;
 
-    this.isEventType = function(type) {
-        for (var prop in Types.EventType) {
+    this.isEventType = function(
+        type: utils.valueof<typeof Types.EventType>
+    ): boolean {
+        for (const prop in Types.EventType) {
             if (Types.EventType.hasOwnProperty(prop)) {
                 if (Types.EventType[prop] === type) {
                     return true;
@@ -187,14 +238,17 @@ export default function Helpers(mpInstance) {
         return false;
     };
 
-    this.sanitizeAttributes = function(attrs, name) {
+    this.sanitizeAttributes = function(
+        attrs: Dictionary,
+        name: string
+    ): Dictionary<string> | null {
         if (!attrs || !self.isObject(attrs)) {
             return null;
         }
 
-        var sanitizedAttrs = {};
+        const sanitizedAttrs: Dictionary<string> = {};
 
-        for (var prop in attrs) {
+        for (const prop in attrs) {
             // Make sure that attribute values are not objects or arrays, which are not valid
             if (
                 attrs.hasOwnProperty(prop) &&
@@ -216,17 +270,17 @@ export default function Helpers(mpInstance) {
     };
 
     this.isDelayedByIntegration = function(
-        delayedIntegrations,
-        timeoutStart,
-        now
-    ) {
+        delayedIntegrations: Dictionary<boolean>,
+        timeoutStart: number,
+        now: number
+    ): boolean {
         if (
             now - timeoutStart >
             mpInstance._Store.SDKConfig.integrationDelayTimeout
         ) {
             return false;
         }
-        for (var integration in delayedIntegrations) {
+        for (const integration in delayedIntegrations) {
             if (delayedIntegrations[integration] === true) {
                 return true;
             } else {
@@ -236,7 +290,7 @@ export default function Helpers(mpInstance) {
         return false;
     };
 
-    this.createMainStorageName = function(workspaceToken) {
+    this.createMainStorageName = function(workspaceToken: string): string {
         if (workspaceToken) {
             return StorageNames.currentStorageName + '_' + workspaceToken;
         } else {

package/src/{polyfill.js → polyfill.ts}

@@ -1,10 +1,10 @@
 // Base64 encoder/decoder - http://www.webtoolkit.info/javascript_base64.html
-var Base64 = {
+const Base64 = {
     _keyStr:
         'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=',
 
     // Input must be a string
-    encode: function encode(input) {
+    encode: function encode(input: string): string {
         try {
             if (window.btoa && window.atob) {
                 return window.btoa(unescape(encodeURIComponent(input)));
@@ -15,10 +15,10 @@ var Base64 = {
         return this._encode(input);
     },
 
-    _encode: function _encode(input) {
-        var output = '';
-        var chr1, chr2, chr3, enc1, enc2, enc3, enc4;
-        var i = 0;
+    _encode: function _encode(input: string): string {
+        let output = '';
+        let chr1, chr2, chr3, enc1, enc2, enc3, enc4;
+        let i = 0;
 
         input = UTF8.encode(input);
 
@@ -48,7 +48,7 @@ var Base64 = {
         return output;
     },
 
-    decode: function decode(input) {
+    decode: function decode(input: string): string {
         try {
             if (window.btoa && window.atob) {
                 return decodeURIComponent(escape(window.atob(input)));
@@ -59,11 +59,11 @@ var Base64 = {
         return Base64._decode(input);
     },
 
-    _decode: function _decode(input) {
-        var output = '';
-        var chr1, chr2, chr3;
-        var enc1, enc2, enc3, enc4;
-        var i = 0;
+    _decode: function _decode(input: string): string {
+        let output = '';
+        let chr1, chr2, chr3;
+        let enc1, enc2, enc3, enc4;
+        let i = 0;
 
         input = input.replace(/[^A-Za-z0-9\+\/\=]/g, '');
 
@@ -91,12 +91,12 @@ var Base64 = {
     },
 };
 
-var UTF8 = {
-    encode: function encode(s) {
-        var utftext = '';
+const UTF8 = {
+    encode: function encode(s: string): string {
+        let utftext = '';
 
-        for (var n = 0; n < s.length; n++) {
-            var c = s.charCodeAt(n);
+        for (let n = 0; n < s.length; n++) {
+            const c = s.charCodeAt(n);
 
             if (c < 128) {
                 utftext += String.fromCharCode(c);
@@ -112,10 +112,10 @@ var UTF8 = {
         return utftext;
     },
 
-    decode: function decode(utftext) {
-        var s = '';
-        var i = 0;
-        var c = 0,
+    decode: function decode(utftext: string): string {
+        let s = '';
+        let i = 0;
+        let c = 0,
             c1 = 0,
             c2 = 0;
 
@@ -146,14 +146,14 @@ export default {
     // Production steps of ECMA-262, Edition 5, 15.4.4.18
     // Reference: http://es5.github.io/#x15.4.4.18
     forEach: function(callback, thisArg) {
-        var T, k;
+        let T, k;
 
         if (this == null) {
             throw new TypeError(' this is null or not defined');
         }
 
-        var O = Object(this);
-        var len = O.length >>> 0;
+        const O = Object(this);
+        const len = O.length >>> 0;
 
         if (typeof callback !== 'function') {
             throw new TypeError(callback + ' is not a function');
@@ -166,7 +166,7 @@ export default {
         k = 0;
 
         while (k < len) {
-            var kValue;
+            let kValue;
             if (k in O) {
                 kValue = O[k];
                 callback.call(T, kValue, k, O);
@@ -179,14 +179,14 @@ export default {
     // Production steps of ECMA-262, Edition 5, 15.4.4.19
     // Reference: http://es5.github.io/#x15.4.4.19
     map: function(callback, thisArg) {
-        var T, A, k;
+        let T, A, k;
 
         if (this === null) {
             throw new TypeError(' this is null or not defined');
         }
 
-        var O = Object(this);
-        var len = O.length >>> 0;
+        const O = Object(this);
+        const len = O.length >>> 0;
 
         if (typeof callback !== 'function') {
             throw new TypeError(callback + ' is not a function');
@@ -201,7 +201,7 @@ export default {
         k = 0;
 
         while (k < len) {
-            var kValue, mappedValue;
+            let kValue, mappedValue;
             if (k in O) {
                 kValue = O[k];
                 mappedValue = callback.call(T, kValue, k, O);
@@ -223,17 +223,17 @@ export default {
             throw new TypeError();
         }
 
-        var t = Object(this);
-        var len = t.length >>> 0;
+        const t = Object(this);
+        const len = t.length >>> 0;
         if (typeof fun !== 'function') {
             throw new TypeError();
         }
 
-        var res = [];
-        var thisArg = arguments.length >= 2 ? arguments[1] : void 0;
-        for (var i = 0; i < len; i++) {
+        const res = [];
+        const thisArg = arguments.length >= 2 ? arguments[1] : void 0;
+        for (let i = 0; i < len; i++) {
             if (i in t) {
-                var val = t[i];
+                const val = t[i];
                 if (fun.call(thisArg, val, i, t)) {
                     res.push(val);
                 }
@@ -244,7 +244,7 @@ export default {
     },
 
     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
-    isArray: function(arg) {
+    isArray: function(arg: unknown): boolean {
         return Object.prototype.toString.call(arg) === '[object Array]';
     },
 

package/src/roktLauncherOptions.ts

@@ -5,6 +5,8 @@ export interface IRoktLauncherOptions extends Dictionary<any> {
     noDeviceID?: boolean;
     noFunctional?: boolean;
     noTargeting?: boolean;
+    sessionId?: string;
+    sessionToken?: string;
 }
 
 export function normalizeRoktLauncherOptions(

package/src/sdkRuntimeModels.ts

@@ -265,7 +265,7 @@ export interface MParticleWebSDK {
     startTrackingLocation(callback?: Callback): void;
 
     stopTrackingLocation(): void;
-    generateHash(value: string): string;
+    generateHash(value: string): number;
     setIntegrationAttribute(
         integrationModuleId: number,
         attrs: IntegrationAttribute
@@ -375,13 +375,29 @@ export interface SDKHelpersApi {
     findKeyInObject?(obj: any, key: string): string;
     parseNumber?(value: string | number): number;
     generateUniqueId();
-    generateHash?(value: string): string;
+    generateHash?(value: string): number;
     // https://go.mparticle.com/work/SQDSDKS-6317
     getFeatureFlag?(feature: string): boolean | string; // TODO: Feature Constants should be converted to enum
+    decoded?(s: string): string;
+    parseStringOrNumber?(value: string | number): string | number | null;
+    inArray?(items: any[], value: any): boolean;
+    converted?(s: string): string;
+    filterUserIdentitiesForForwarders?(
+        userIdentities: Dictionary,
+        filterList: number[]
+    ): Dictionary;
+    filterUserAttributes?(
+        userAttributes: Dictionary,
+        filterList: number[]
+    ): Dictionary;
+    filterUserIdentities?(
+        userIdentitiesObject: Dictionary<string>,
+        filterList: number[]
+    ): ISDKUserIdentity[];
     invokeAliasCallback(
         aliasCallback: IAliasCallback,
         number: number,
-        errorMessage: string
+        errorMessage?: string
     ): void;
     isDelayedByIntegration?(
         delayedIntegrations: Dictionary<boolean>,

package/src/store.ts

@@ -87,6 +87,7 @@ export interface SDKConfig {
     maxProducts: number;
     requestConfig?: boolean;
     sessionTimeout?: number;
+    timeout?: number;
     useNativeSdk?: boolean;
     useCookieStorage?: boolean;
     v1SecureServiceUrl?: string;