@mparticle/web-sdk 2.26.6 → 2.26.8

package/src/store.ts

@@ -1,10 +1,10 @@
-import { Batch } from '@mparticle/event-models';
-import { Context } from '@mparticle/event-models';
+import { Batch, Context } from '@mparticle/event-models';
 import {
     DataPlanConfig,
     MPID,
     IdentifyRequest,
     SDKEventCustomFlags,
+    ConsentState,
 } from '@mparticle/web-sdk';
 import { IKitConfigs } from './configAPIClient';
 import Constants from './constants';
@@ -25,13 +25,17 @@ import {
     isEmpty,
     isNumber,
     isObject,
+    moveElementToEnd,
     parseNumber,
     returnConvertedBoolean,
 } from './utils';
-import { SDKConsentState } from './consent';
+import { IMinifiedConsentJSONObject, SDKConsentState } from './consent';
 import { Kit, MPForwarder } from './forwarders.interfaces';
-import { IPersistenceMinified } from './persistence.interfaces';
 import { IdentityCallback } from './identity-user-interfaces';
+import {
+    IGlobalStoreV2MinifiedKeys,
+    IPersistenceMinified,
+} from './persistence.interfaces';
 
 // This represents the runtime configuration of the SDK AFTER
 // initialization has been complete and all settings and
@@ -179,6 +183,12 @@ export interface IStore {
 
     persistenceData?: IPersistenceMinified;
 
+    getConsentState?(mpid: MPID): ConsentState | null;
+    setConsentState?(mpid: MPID, consentState: ConsentState): void;
+
+    _getFromPersistence?<T>(mpid: MPID, key: string): T;
+    _setPersistence?<T>(mpid: MPID, key: string, value: T): void;
+
     getDeviceId?(): string;
     setDeviceId?(deviceId: string): void;
     getFirstSeenTime?(mpid: MPID): number;
@@ -186,9 +196,11 @@ export interface IStore {
     getLastSeenTime?(mpid: MPID): number;
     setLastSeenTime?(mpid: MPID, time?: number): void;
 
+    addMpidToSessionHistory?(mpid: MPID, previousMpid?: MPID): void;
     hasInvalidIdentifyRequest?: () => boolean;
     nullifySession?: () => void;
     processConfig(config: SDKInitConfig): void;
+    syncPersistenceData?: () => void;
 }
 
 // TODO: Merge this with SDKStoreApi in sdkRuntimeModels
@@ -251,24 +263,8 @@ export default function Store(
 
         // Placeholder for in-memory persistence model
         persistenceData: {
-            cu: null,
-            gs: {
-                sid: null,
-                ie: null,
-                sa: null,
-                ss: null,
-                dt: null,
-                av: null,
-                cgid: null,
-                das: null,
-                ia: null,
-                c: null,
-                csm: null,
-                les: null,
-                ssd: null,
-            },
-            l: null,
-        },
+            gs: {} as IGlobalStoreV2MinifiedKeys,
+        } as IPersistenceMinified,
     };
 
     for (var key in defaultStore) {
@@ -477,6 +473,53 @@ export default function Store(
         }
     }
 
+    this._getFromPersistence = <T>(mpid: MPID, key: string): T | null => {
+        if (!mpid) {
+            return null;
+        }
+
+        this.syncPersistenceData();
+
+        if (
+            this.persistenceData &&
+            this.persistenceData[mpid] &&
+            this.persistenceData[mpid][key]
+        ) {
+            return this.persistenceData[mpid][key] as T;
+        } else {
+            return null;
+        }
+    };
+
+    this._setPersistence = <T>(mpid: MPID, key: string, value: T): void => {
+        if (!mpid) {
+            return;
+        }
+
+        this.syncPersistenceData();
+
+        if (this.persistenceData) {
+            if (this.persistenceData[mpid]) {
+                this.persistenceData[mpid][key] = value;
+            } else {
+                this.persistenceData[mpid] = {
+                    [key]: value,
+                };
+            }
+
+            // Clear out persistence attributes that are empty
+            // so that we don't upload empty or undefined values
+            if (
+                isObject(this.persistenceData[mpid][key]) &&
+                isEmpty(this.persistenceData[mpid][key])
+            ) {
+                delete this.persistenceData[mpid][key];
+            }
+
+            mpInstance._Persistence.savePersistence(this.persistenceData);
+        }
+    };
+
     this.hasInvalidIdentifyRequest = (): boolean => {
         const { identifyRequest } = this.SDKConfig;
         return (
@@ -485,6 +528,39 @@ export default function Store(
                 isEmpty(identifyRequest.userIdentities)) ||
             !identifyRequest
         );
+    }
+
+ 
+
+    this.getConsentState = (mpid: MPID): ConsentState => {
+        const {
+            fromMinifiedJsonObject,
+        } = mpInstance._Consent.ConsentSerialization;
+        
+        const serializedConsentState = this._getFromPersistence<
+            IMinifiedConsentJSONObject
+        >(mpid, 'con');
+
+        if (!isEmpty(serializedConsentState)) {
+            return fromMinifiedJsonObject(serializedConsentState);
+        }
+
+        return null;
+    };
+
+    this.setConsentState = (mpid: MPID, consentState: ConsentState) => {
+        const {
+            toMinifiedJsonObject,
+        } = mpInstance._Consent.ConsentSerialization;
+
+        // If ConsentState is null, we assume the intent is to clear out the consent state
+        if (consentState || consentState === null) {
+            this._setPersistence(
+                mpid,
+                'con',
+                toMinifiedJsonObject(consentState)
+            );
+        }
     };
 
     this.getDeviceId = () => this.deviceId;
@@ -494,21 +570,9 @@ export default function Store(
         mpInstance._Persistence.update();
     };
 
-    this.getFirstSeenTime = (mpid: MPID) => {
-        if (!mpid) {
-            return null;
-        }
 
-        if (
-            this.persistenceData &&
-            this.persistenceData[mpid] &&
-            this.persistenceData[mpid].fst
-        ) {
-            return this.persistenceData[mpid].fst;
-        } else {
-            return null;
-        }
-    };
+    this.getFirstSeenTime = (mpid: MPID) =>
+        this._getFromPersistence<number>(mpid, 'fst');
 
     this.setFirstSeenTime = (mpid: MPID, _time?: number) => {
         if (!mpid) {
@@ -517,35 +581,20 @@ export default function Store(
 
         const time = _time || new Date().getTime();
 
-        if (this.persistenceData) {
-            if (!this.persistenceData[mpid]) {
-                this.persistenceData[mpid] = {};
-            }
-            if (!this.persistenceData[mpid].fst) {
-                this.persistenceData[mpid].fst = time;
-                mpInstance._Persistence.savePersistence(this.persistenceData);
-            }
-        }
+        this._setPersistence(mpid, 'fst', time);
     };
 
-    this.getLastSeenTime = (mpid: MPID) => {
+    this.getLastSeenTime = (mpid: MPID): number => {
         if (!mpid) {
             return null;
         }
-        //     // https://go.mparticle.com/work/SQDSDKS-6315
+        // https://go.mparticle.com/work/SQDSDKS-6315
         const currentUser = mpInstance.Identity.getCurrentUser();
         if (mpid === currentUser?.getMPID()) {
             // if the mpid is the current user, its last seen time is the current time
             return new Date().getTime();
-        } else if (
-            this.persistenceData &&
-            this.persistenceData[mpid] &&
-            this.persistenceData[mpid].lst
-        ) {
-            return this.persistenceData[mpid].lst;
-        } else {
-            return null;
         }
+        return this._getFromPersistence<number>(mpid, 'lst');
     };
 
     this.setLastSeenTime = (mpid: MPID, _time?: number) => {
@@ -555,14 +604,32 @@ export default function Store(
 
         const time = _time || new Date().getTime();
 
-        if (this.persistenceData) {
-            if (!this.persistenceData[mpid]) {
-                this.persistenceData[mpid] = {};
-            }
-            if (!this.persistenceData[mpid].lst) {
-                this.persistenceData[mpid].lst = time;
-                mpInstance._Persistence.savePersistence(this.persistenceData);
-            }
+        this._setPersistence(mpid, 'lst', time);
+    };
+
+    this.syncPersistenceData = () => {
+        const persistenceData = mpInstance._Persistence.getPersistence();
+
+        this.persistenceData = mpInstance._Helpers.extend(
+            {},
+            this.persistenceData,
+            persistenceData,
+        );
+    };
+
+    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
+            );
         }
     };
 

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,25 @@
+import { IMParticleUser, IdentityResultBody } from './identity-user-interfaces';
+
+export function hasMPIDAndUserLoginChanged(
+    previousUser: IMParticleUser,
+    newUser: IMParticleUser
+): boolean {
+    return (
+        !previousUser ||
+        newUser.getMPID() !== previousUser.getMPID() ||
+        previousUser.isLoggedIn() !== newUser.isLoggedIn()
+    );
+}
+
+// https://go.mparticle.com/work/SQDSDKS-6504
+export function hasMPIDChanged(
+    prevUser: IMParticleUser,
+    identityApiResult: IdentityResultBody
+): boolean {
+    return (
+        !prevUser ||
+        (prevUser.getMPID() &&
+            identityApiResult.mpid &&
+            identityApiResult.mpid !== prevUser.getMPID())
+    );
+}

package/src/utils.ts

@@ -229,6 +229,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,
@@ -258,4 +261,5 @@ export {
     isEmpty,
     isValidCustomFlagProperty,
     mergeObjects,
+    moveElementToEnd,
 };