@mparticle/web-sdk 2.26.0 → 2.26.2

package/src/store.ts

@@ -20,7 +20,16 @@ import {
     SDKInitConfig,
     SDKProduct,
 } from './sdkRuntimeModels';
-import { isNumber, isDataPlanSlug, Dictionary, parseNumber } from './utils';
+import {
+    Dictionary,
+    isDataPlanSlug,
+    isEmpty,
+    isNumber,
+    isObject,
+    moveElementToEnd,
+    parseNumber,
+    returnConvertedBoolean,
+} from './utils';
 import { SDKConsentState } from './consent';
 import { Kit, MPForwarder } from './forwarders.interfaces';
 import { IPersistenceMinified } from './persistence.interfaces';
@@ -71,6 +80,9 @@ export interface SDKConfig {
     v1SecureServiceUrl?: string;
     v2SecureServiceUrl?: string;
     v3SecureServiceUrl?: string;
+    webviewBridgeName?: string;
+    workspaceToken?: string;
+    requiredWebviewBridgeName?: string;
 }
 
 function createSDKConfig(config: SDKInitConfig): SDKConfig {
@@ -114,7 +126,7 @@ interface WrapperSDKInfo {
 
 // https://go.mparticle.com/work/SQDSDKS-5954
 export interface IFeatureFlags {
-    reportBatching?: string;
+    reportBatching?: boolean;
     eventBatchingIntervalMillis?: number;
     offlineStorage?: string;
     directURLRouting?: boolean;
@@ -169,13 +181,15 @@ export interface IStore {
 
     getDeviceId?(): string;
     setDeviceId?(deviceId: string): void;
-
     getFirstSeenTime?(mpid: MPID): number;
     setFirstSeenTime?(mpid: MPID, time?: number): void;
     getLastSeenTime?(mpid: MPID): number;
     setLastSeenTime?(mpid: MPID, time?: number): void;
 
+    addMpidToSessionHistory?(mpid: MPID, previousMpid?: MPID): void;
+    hasInvalidIdentifyRequest?: () => boolean;
     nullifySession?: () => void;
+    processConfig(config: SDKInitConfig): void;
 }
 
 // TODO: Merge this with SDKStoreApi in sdkRuntimeModels
@@ -185,6 +199,13 @@ export default function Store(
     mpInstance: MParticleWebSDK,
     apiKey?: string
 ) {
+    const {
+        createMainStorageName,
+        createProductStorageName,
+    } = mpInstance._Helpers;
+
+    const { isWebviewEnabled } = mpInstance._NativeSdkHelpers;
+
     const defaultStore: Partial<IStore> = {
         isEnabled: true,
         sessionAttributes: {},
@@ -266,14 +287,17 @@ export default function Store(
             this.SDKConfig.flags = {};
         }
 
-        this.SDKConfig.flags = processFlags(config, this
-            .SDKConfig as SDKConfig);
+        // We process the initial config that is passed via the SDK init
+        // and then we will reprocess the config within the processConfig
+        // function when the config is updated from the server
+        // https://go.mparticle.com/work/SQDSDKS-6317
+        this.SDKConfig.flags = processFlags(config);
 
         if (config.deviceId) {
             this.deviceId = config.deviceId;
         }
         if (config.hasOwnProperty('isDevelopmentMode')) {
-            this.SDKConfig.isDevelopmentMode = mpInstance._Helpers.returnConvertedBoolean(
+            this.SDKConfig.isDevelopmentMode = returnConvertedBoolean(
                 config.isDevelopmentMode
             );
         } else {
@@ -454,6 +478,16 @@ export default function Store(
         }
     }
 
+    this.hasInvalidIdentifyRequest = (): boolean => {
+        const { identifyRequest } = this.SDKConfig;
+        return (
+            (isObject(identifyRequest) &&
+                isObject(identifyRequest.userIdentities) &&
+                isEmpty(identifyRequest.userIdentities)) ||
+            !identifyRequest
+        );
+    };
+
     this.getDeviceId = () => this.deviceId;
     this.setDeviceId = (deviceId: string) => {
         this.deviceId = deviceId;
@@ -461,11 +495,20 @@ export default function Store(
         mpInstance._Persistence.update();
     };
 
-    this.nullifySession = (): void => {
-        this.sessionId = null;
-        this.dateLastEventSent = null;
-        this.sessionAttributes = {};
-        mpInstance._Persistence.update();
+    this.addMpidToSessionHistory = (mpid: MPID, previousMPID?: MPID): void => {
+        const indexOfMPID = this.currentSessionMPIDs.indexOf(mpid);
+
+        if (mpid && previousMPID !== mpid && indexOfMPID < 0) {
+            this.currentSessionMPIDs.push(mpid);
+            return;
+        }
+
+        if (indexOfMPID >= 0) {
+            this.currentSessionMPIDs = moveElementToEnd(
+                this.currentSessionMPIDs,
+                indexOfMPID
+            );
+        }
     };
 
     this.getFirstSeenTime = (mpid: MPID) => {
@@ -539,12 +582,47 @@ export default function Store(
             }
         }
     };
+
+    this.nullifySession = (): void => {
+        this.sessionId = null;
+        this.dateLastEventSent = null;
+        this.sessionAttributes = {};
+        mpInstance._Persistence.update();
+    };
+
+    this.processConfig = (config: SDKInitConfig) => {
+        const { workspaceToken, requiredWebviewBridgeName } = config;
+
+        // We should reprocess the flags in case they have changed when we request an updated config
+        // such as if the SDK is being self-hosted and the flags are different on the server config
+        // https://go.mparticle.com/work/SQDSDKS-6317
+        this.SDKConfig.flags = processFlags(config);
+
+        if (workspaceToken) {
+            this.SDKConfig.workspaceToken = workspaceToken;
+        } else {
+            mpInstance.Logger.warning(
+                'You should have a workspaceToken on your config object for security purposes.'
+            );
+        }
+        // add a new function to apply items to the store that require config to be returned
+        this.storageName = createMainStorageName(workspaceToken);
+        this.prodStorageName = createProductStorageName(workspaceToken);
+
+        this.SDKConfig.requiredWebviewBridgeName =
+            requiredWebviewBridgeName || workspaceToken;
+
+        this.webviewBridgeEnabled = isWebviewEnabled(
+            this.SDKConfig.requiredWebviewBridgeName,
+            this.SDKConfig.minWebviewBridgeVersion
+        );
+
+        this.configurationLoaded = true;
+    };
 }
 
-export function processFlags(
-    config: SDKInitConfig,
-    SDKConfig: SDKConfig
-): IFeatureFlags {
+// https://go.mparticle.com/work/SQDSDKS-6317
+export function processFlags(config: SDKInitConfig): IFeatureFlags {
     const flags: IFeatureFlags = {};
     const {
         ReportBatching,
@@ -559,6 +637,7 @@ export function processFlags(
         return {};
     }
 
+    // https://go.mparticle.com/work/SQDSDKS-6317
     // Passed in config flags take priority over defaults
     flags[ReportBatching] = config.flags[ReportBatching] || false;
     // The server returns stringified numbers, sowe need to parse

package/src/type-utils.ts

@@ -0,0 +1,66 @@
+import { IdentityType } from './types.interfaces';
+import { parseNumber } from './utils';
+
+export interface IIdentitiesByType {
+    [key: number]: string;
+}
+
+export function getNewIdentitiesByName(newIdentitiesByType: IIdentitiesByType) {
+    const newIdentitiesByName = {};
+
+    for (var key in newIdentitiesByType) {
+        const identityNameKey = getIdentityName(parseNumber(key));
+        newIdentitiesByName[identityNameKey] = newIdentitiesByType[key];
+    }
+
+    return newIdentitiesByName;
+}
+
+export function getIdentityName(identityType: IdentityType): string | null {
+    switch (identityType) {
+        case IdentityType.Other:
+            return 'other';
+        case IdentityType.CustomerId:
+            return 'customerid';
+        case IdentityType.Facebook:
+            return 'facebook';
+        case IdentityType.Twitter:
+            return 'twitter';
+        case IdentityType.Google:
+            return 'google';
+        case IdentityType.Microsoft:
+            return 'microsoft';
+        case IdentityType.Yahoo:
+            return 'yahoo';
+        case IdentityType.Email:
+            return 'email';
+        case IdentityType.FacebookCustomAudienceId:
+            return 'facebookcustomaudienceid';
+        case IdentityType.Other2:
+            return 'other2';
+        case IdentityType.Other3:
+            return 'other3';
+        case IdentityType.Other4:
+            return 'other4';
+        case IdentityType.Other5:
+            return 'other5';
+        case IdentityType.Other6:
+            return 'other6';
+        case IdentityType.Other7:
+            return 'other7';
+        case IdentityType.Other8:
+            return 'other8';
+        case IdentityType.Other9:
+            return 'other9';
+        case IdentityType.Other10:
+            return 'other10';
+        case IdentityType.MobileNumber:
+            return 'mobile_number';
+        case IdentityType.PhoneNumber2:
+            return 'phone_number_2';
+        case IdentityType.PhoneNumber3:
+            return 'phone_number_3';
+        default:
+            return null;
+    }
+}

package/src/types.js

@@ -1,3 +1,5 @@
+import { getIdentityName } from './type-utils';
+
 var MessageType = {
     SessionStart: 1,
     SessionEnd: 2,
@@ -209,50 +211,7 @@ IdentityType.getIdentityType = function(identityName) {
 };
 
 IdentityType.getIdentityName = function(identityType) {
-    switch (identityType) {
-        case IdentityType.Other:
-            return 'other';
-        case IdentityType.CustomerId:
-            return 'customerid';
-        case IdentityType.Facebook:
-            return 'facebook';
-        case IdentityType.Twitter:
-            return 'twitter';
-        case IdentityType.Google:
-            return 'google';
-        case IdentityType.Microsoft:
-            return 'microsoft';
-        case IdentityType.Yahoo:
-            return 'yahoo';
-        case IdentityType.Email:
-            return 'email';
-        case IdentityType.FacebookCustomAudienceId:
-            return 'facebookcustomaudienceid';
-        case IdentityType.Other2:
-            return 'other2';
-        case IdentityType.Other3:
-            return 'other3';
-        case IdentityType.Other4:
-            return 'other4';
-        case IdentityType.Other5:
-            return 'other5';
-        case IdentityType.Other6:
-            return 'other6';
-        case IdentityType.Other7:
-            return 'other7';
-        case IdentityType.Other8:
-            return 'other8';
-        case IdentityType.Other9:
-            return 'other9';
-        case IdentityType.Other10:
-            return 'other10';
-        case IdentityType.MobileNumber:
-            return 'mobile_number';
-        case IdentityType.PhoneNumber2:
-            return 'phone_number_2';
-        case IdentityType.PhoneNumber3:
-            return 'phone_number_3';
-    }
+    return getIdentityName(identityType);
 };
 
 var ProductActionType = {

package/src/user-utils.ts

@@ -0,0 +1,12 @@
+import { MParticleUser } from './sdkRuntimeModels';
+
+export function didUserChange(
+    previousUser: MParticleUser,
+    newUser: MParticleUser
+): boolean {
+    return (
+        !previousUser ||
+        newUser.getMPID() !== previousUser.getMPID() ||
+        previousUser.isLoggedIn() !== newUser.isLoggedIn()
+    );
+}

package/src/utils.ts

@@ -227,6 +227,9 @@ const mergeObjects = <T extends object>(...objects: T[]): T => {
     return Object.assign({}, ...objects);
 };
 
+const moveElementToEnd = <T>(array: T[], index: number): T[] =>
+    array.slice(0, index).concat(array.slice(index + 1), array[index]);
+
 export {
     createCookieString,
     revertCookieString,
@@ -256,4 +259,5 @@ export {
     isEmpty,
     isValidCustomFlagProperty,
     mergeObjects,
+    moveElementToEnd,
 };