@mparticle/web-sdk 2.26.7 → 2.26.9

package/src/persistence.js

@@ -892,16 +892,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.getAllUserAttributes = function(mpid) {
-        var persistence = self.getPersistence();
-
-        if (persistence && persistence[mpid] && persistence[mpid].ua) {
-            return persistence[mpid].ua;
-        } else {
-            return {};
-        }
-    };
-
     this.getCartProducts = function(mpid) {
         var allCartProducts,
             cartProductsString = localStorage.getItem(
@@ -937,6 +927,7 @@ export default function _Persistence(mpInstance) {
             );
         }
     };
+
     this.saveUserIdentitiesToPersistence = function(mpid, userIdentities) {
         if (userIdentities) {
             var persistence = self.getPersistence();
@@ -953,25 +944,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.saveUserAttributesToPersistence = function(mpid, userAttributes) {
-        var persistence = self.getPersistence();
-        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] = {
-                        ui: userAttributes,
-                    };
-                }
-            }
-            self.savePersistence(persistence);
-        }
-    };
-
     this.saveUserCookieSyncDatesToPersistence = function(mpid, csd) {
         if (csd) {
             var persistence = self.getPersistence();
@@ -988,30 +960,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.saveUserConsentStateToCookies = function(mpid, consentState) {
-        //it's currently not supported to set persistence
-        //for any MPID that's not the current one.
-        if (consentState || consentState === null) {
-            var persistence = self.getPersistence();
-            if (persistence) {
-                if (persistence[mpid]) {
-                    persistence[
-                        mpid
-                    ].con = mpInstance._Consent.ConsentSerialization.toMinifiedJsonObject(
-                        consentState
-                    );
-                } else {
-                    persistence[mpid] = {
-                        con: mpInstance._Consent.ConsentSerialization.toMinifiedJsonObject(
-                            consentState
-                        ),
-                    };
-                }
-                self.savePersistence(persistence);
-            }
-        }
-    };
-
     this.swapCurrentUser = function(
         previousMPID,
         currentMPID,
@@ -1080,18 +1028,6 @@ export default function _Persistence(mpInstance) {
         return persistence;
     };
 
-    this.getConsentState = function(mpid) {
-        var persistence = self.getPersistence();
-
-        if (persistence && persistence[mpid] && persistence[mpid].con) {
-            return mpInstance._Consent.ConsentSerialization.fromMinifiedJsonObject(
-                persistence[mpid].con
-            );
-        } else {
-            return null;
-        }
-    };
-
     this.getFirstSeenTime = function(mpid) {
         if (!mpid) {
             return null;

package/src/sdkRuntimeModels.ts

@@ -23,6 +23,7 @@ import {
     IMParticleUser,
     ISDKUserIdentity,
     IdentityCallback,
+    ISDKUserAttributes,
 } from './identity-user-interfaces';
 import { IIdentityType } from './types.interfaces';
 
@@ -34,10 +35,7 @@ export interface SDKEvent {
     IsFirstRun: boolean;
     EventName: string;
     EventCategory: number;
-
-    // https://go.mparticle.com/work/SQDSDKS-5196
-    UserAttributes?: { [key: string]: string | string[] | null };
-
+    UserAttributes?: ISDKUserAttributes;
     UserIdentities?: ISDKUserIdentity[];
     SourceMessageId: string;
     MPID: string;

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';
@@ -29,10 +29,13 @@ import {
     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 { IdentityCallback, UserAttributes } 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
@@ -180,17 +183,26 @@ 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;
     setFirstSeenTime?(mpid: MPID, time?: number): void;
     getLastSeenTime?(mpid: MPID): number;
     setLastSeenTime?(mpid: MPID, time?: number): void;
+    getUserAttributes?(mpid: MPID): UserAttributes;
+    setUserAttributes?(mpid: MPID, attributes: UserAttributes): void;
 
     addMpidToSessionHistory?(mpid: MPID, previousMpid?: MPID): void;
     hasInvalidIdentifyRequest?: () => boolean;
     nullifySession?: () => void;
     processConfig(config: SDKInitConfig): void;
+    syncPersistenceData?: () => void;
 }
 
 // TODO: Merge this with SDKStoreApi in sdkRuntimeModels
@@ -253,24 +265,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) {
@@ -479,6 +475,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 (
@@ -487,47 +530,52 @@ export default function Store(
                 isEmpty(identifyRequest.userIdentities)) ||
             !identifyRequest
         );
-    };
+    }
 
-    this.getDeviceId = () => this.deviceId;
-    this.setDeviceId = (deviceId: string) => {
-        this.deviceId = deviceId;
-        this.persistenceData.gs.das = deviceId;
-        mpInstance._Persistence.update();
-    };
+ 
 
-    this.addMpidToSessionHistory = (mpid: MPID, previousMPID?: MPID): void => {
-        const indexOfMPID = this.currentSessionMPIDs.indexOf(mpid);
+    this.getConsentState = (mpid: MPID): ConsentState => {
+        const {
+            fromMinifiedJsonObject,
+        } = mpInstance._Consent.ConsentSerialization;
+        
+        const serializedConsentState = this._getFromPersistence<
+            IMinifiedConsentJSONObject
+        >(mpid, 'con');
 
-        if (mpid && previousMPID !== mpid && indexOfMPID < 0) {
-            this.currentSessionMPIDs.push(mpid);
-            return;
+        if (!isEmpty(serializedConsentState)) {
+            return fromMinifiedJsonObject(serializedConsentState);
         }
 
-        if (indexOfMPID >= 0) {
-            this.currentSessionMPIDs = moveElementToEnd(
-                this.currentSessionMPIDs,
-                indexOfMPID
-            );
-        }
+        return null;
     };
 
-    this.getFirstSeenTime = (mpid: MPID) => {
-        if (!mpid) {
-            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)
+            );
         }
+    };
 
-        if (
-            this.persistenceData &&
-            this.persistenceData[mpid] &&
-            this.persistenceData[mpid].fst
-        ) {
-            return this.persistenceData[mpid].fst;
-        } else {
-            return null;
-        }
+    this.getDeviceId = () => this.deviceId;
+    this.setDeviceId = (deviceId: string) => {
+        this.deviceId = deviceId;
+        this.persistenceData.gs.das = deviceId;
+        mpInstance._Persistence.update();
     };
 
+
+    this.getFirstSeenTime = (mpid: MPID) =>
+        this._getFromPersistence<number>(mpid, 'fst');
+
     this.setFirstSeenTime = (mpid: MPID, _time?: number) => {
         if (!mpid) {
             return;
@@ -535,35 +583,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) => {
@@ -573,14 +606,40 @@ 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.getUserAttributes = (mpid: MPID): UserAttributes =>
+        this._getFromPersistence(mpid, 'ua') || {};
+
+    this.setUserAttributes = (
+        mpid: MPID,
+        userAttributes: UserAttributes
+    ): void => this._setPersistence(mpid, 'ua', userAttributes);
+
+    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
+            );
         }
     };