@mparticle/web-sdk 2.19.3 → 2.20.1

package/src/persistence.js

@@ -959,6 +959,9 @@ export default function _Persistence(mpInstance) {
         if (userAttributes) {
             if (persistence) {
                 if (persistence[mpid]) {
+                    // TODO: Investigate why setting this to UI still shows up as UA
+                    //       when running `mParticle.getInstance()._Persistence.getLocalStorage()`
+                    // https://go.mparticle.com/work/SQDSDKS-5195
                     persistence[mpid].ui = userAttributes;
                 } else {
                     persistence[mpid] = {

package/src/sdkRuntimeModels.ts

@@ -7,6 +7,7 @@ import { Dictionary } from './utils';
 import { IServerModel } from './serverModel';
 import { IKitConfigs } from './configAPIClient';
 import { SDKConsentApi, SDKConsentState } from './consent';
+import { IPersistence } from './persistence.interfaces';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -139,7 +140,7 @@ export interface MParticleWebSDK {
     _Consent: SDKConsentApi;
     Consent: SDKConsentApi;
     _NativeSdkHelpers: any; // TODO: Set up API
-    _Persistence: any; // TODO: Set up Persistence API
+    _Persistence: IPersistence;
     _preInit: any; // TODO: Set up API
     _resetForTests(MPConfig?: SDKInitConfig): void;
     init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
@@ -186,6 +187,7 @@ export interface SDKInitConfig
 
     kitConfigs?: IKitConfigs[];
     kits?: Dictionary<Kit>;
+    sideloadedKits?: MPForwarder[];
     dataPlanOptions?: KitBlockerOptions;
     flags?: Dictionary;
 
@@ -230,7 +232,6 @@ export interface SDKHelpersApi {
     generateUniqueId();
     generateHash?(value: string): string;
     getFeatureFlag?(feature: string); // TODO: Feature Constants should be converted to enum
-    getRampNumber?(deviceId: string): number;
     isDelayedByIntegration?(
         delayedIntegrations: Dictionary<boolean>,
         timeoutStart: number,

package/src/store.ts

@@ -54,7 +54,7 @@ export interface SDKConfig {
     identifyRequest: IdentifyRequest;
     identityCallback: IdentityCallback;
     integrationDelayTimeout: number;
-
+    sideloadedKits: MPForwarder[];
     aliasMaxWindow: number;
     deviceId?: string;
     forceHttps?: boolean;
@@ -101,6 +101,8 @@ function createSDKConfig(config: SDKInitConfig): SDKConfig {
 export type PixelConfiguration = Dictionary;
 export type MigrationData = Dictionary;
 export type ServerSettings = Dictionary;
+export type SessionAttributes = Dictionary;
+export type IntegrationAttributes = Dictionary<Dictionary<string>>;
 
 type WrapperSDKTypes = 'flutter' | 'none';
 interface WrapperSDKInfo {
@@ -112,7 +114,7 @@ interface WrapperSDKInfo {
 // Temporary Interface until Store can be refactored as a class
 export interface IStore {
     isEnabled: boolean;
-    sessionAttributes: Dictionary;
+    sessionAttributes: SessionAttributes;
     currentSessionMPIDs: MPID[];
     consentState: SDKConsentState | null;
     sessionId: string | null;
@@ -140,13 +142,14 @@ export interface IStore {
     identifyCalled: boolean;
     isLoggedIn: boolean;
     cookieSyncDates: Dictionary<number>;
-    integrationAttributes: Dictionary<Dictionary<string>>;
+    integrationAttributes: IntegrationAttributes;
     requireDelay: boolean;
     isLocalStorageAvailable: boolean | null;
     storageName: string | null;
     prodStorageName: string | null;
     activeForwarders: MPForwarder[];
     kits: Dictionary<MPForwarder>;
+    sideloadedKits: MPForwarder[];
     configuredForwarders: MPForwarder[];
     pixelConfigurations: PixelConfiguration[];
     integrationDelayTimeoutStart: number; // UNIX Timestamp
@@ -197,6 +200,7 @@ export default function Store(
         prodStorageName: null,
         activeForwarders: [],
         kits: {},
+        sideloadedKits: [],
         configuredForwarders: [],
         pixelConfigurations: [],
         wrapperSDKInfo: {
@@ -259,6 +263,8 @@ export default function Store(
 
         this.SDKConfig.kits = config.kits || {};
 
+        this.SDKConfig.sideloadedKits = config.sideloadedKits || [];
+
         if (config.hasOwnProperty('isIOS')) {
             this.SDKConfig.isIOS = config.isIOS;
         } else {

package/src/utils.ts

@@ -36,6 +36,81 @@ const findKeyInObject = (obj: any, key: string): string => {
     return null;
 };
 
+function generateHash(name: string): number {
+    let hash: number = 0;
+    let character: number;
+
+    if (name === undefined || name === null) {
+        return 0;
+    }
+
+    name = name.toString().toLowerCase();
+
+    if (Array.prototype.reduce) {
+        return name.split('').reduce(function (a: number, b: string) {
+            a = (a << 5) - a + b.charCodeAt(0);
+            return a & a;
+        }, 0);
+    }
+
+    if (name.length === 0) {
+        return hash;
+    }
+
+    for (let i = 0; i < name.length; i++) {
+        character = name.charCodeAt(i);
+        hash = (hash << 5) - hash + character;
+        hash = hash & hash;
+    }
+
+    return hash;
+}
+
+const generateRandomValue = (value?: string): string => {
+    let randomValue: string;
+    let a: number;
+
+    if (window.crypto && window.crypto.getRandomValues) {
+        // @ts-ignore
+        randomValue = window.crypto.getRandomValues(new Uint8Array(1)); // eslint-disable-line no-undef
+    }
+    if (randomValue) {
+        // @ts-ignore
+        return (a ^ (randomValue[0] % 16 >> (a / 4))).toString(16);
+    }
+
+    return (a ^ ((Math.random() * 16) >> (a / 4))).toString(16);
+};
+
+const generateUniqueId = (a: string = ''): string =>
+    // https://gist.github.com/jed/982883
+    // Added support for crypto for better random
+
+    a // if the placeholder was passed, return
+        ? generateRandomValue(a) // if the placeholder was passed, return
+        : // [1e7] -> // 10000000 +
+          // -1e3  -> // -1000 +
+          // -4e3  -> // -4000 +
+          // -8e3  -> // -80000000 +
+          // -1e11 -> //-100000000000,
+          `${1e7}-${1e3}-${4e3}-${8e3}-${1e11}`.replace(
+              /[018]/g, // zeroes, ones, and eights with
+              generateUniqueId // random hex digits
+          );
+
+/**
+ * Returns a value between 1-100 inclusive.
+ */
+const getRampNumber = (value?: string): number => {
+    if (!value) {
+        return 100;
+    }
+
+    const hash = generateHash(value);
+
+    return Math.abs(hash % 100) + 1;
+};
+
 const isObject = (value: any): boolean => {
     var objType = Object.prototype.toString.call(value);
     return objType === '[object Object]' || objType === '[object Error]';
@@ -76,10 +151,7 @@ const decoded = (s: string): string =>
 
 const converted = (s: string): string => {
     if (s.indexOf('"') === 0) {
-        s = s
-            .slice(1, -1)
-            .replace(/\\"/g, '"')
-            .replace(/\\\\/g, '\\');
+        s = s.slice(1, -1).replace(/\\"/g, '"').replace(/\\\\/g, '\\');
     }
 
     return s;
@@ -104,6 +176,9 @@ export {
     converted,
     decoded,
     findKeyInObject,
+    generateHash,
+    generateUniqueId,
+    getRampNumber,
     inArray,
     isObject,
     isStringOrNumber,