@mparticle/web-sdk 2.19.2 → 2.20.0

package/src/identity.js

@@ -904,7 +904,8 @@ export default function Identity(mpInstance) {
                             self.IdentityAPI.getCurrentUser().getUserIdentities(),
                             mpInstance._APIClient.prepareForwardingStats
                         );
-                        mpInstance._Forwarders.callSetUserAttributeOnForwarders(
+                        mpInstance._Forwarders.handleForwarderUserAttributes(
+                            'setUserAttribute',
                             key,
                             newValue
                         );
@@ -990,9 +991,10 @@ export default function Identity(mpInstance) {
                         self.IdentityAPI.getCurrentUser().getUserIdentities(),
                         mpInstance._APIClient.prepareForwardingStats
                     );
-                    mpInstance._Forwarders.applyToForwarders(
+                    mpInstance._Forwarders.handleForwarderUserAttributes(
                         'removeUserAttribute',
-                        key
+                        key,
+                        null
                     );
                 }
             },
@@ -1098,7 +1100,8 @@ export default function Identity(mpInstance) {
                         self.IdentityAPI.getCurrentUser().getUserIdentities(),
                         mpInstance._APIClient.prepareForwardingStats
                     );
-                    mpInstance._Forwarders.callSetUserAttributeOnForwarders(
+                    mpInstance._Forwarders.handleForwarderUserAttributes(
+                        'setUserAttribute',
                         key,
                         arrayCopy
                     );
@@ -1127,9 +1130,10 @@ export default function Identity(mpInstance) {
                     if (userAttributes) {
                         for (var prop in userAttributes) {
                             if (userAttributes.hasOwnProperty(prop)) {
-                                mpInstance._Forwarders.applyToForwarders(
+                                mpInstance._Forwarders.handleForwarderUserAttributes(
                                     'removeUserAttribute',
-                                    prop
+                                    prop,
+                                    null
                                 );
                             }
                             this.removeUserAttribute(prop);

package/src/mockBatchCreator.ts

@@ -40,6 +40,7 @@ export default class _BatchValidator {
             _SessionManager: null,
             _Store: {
                 sessionId: 'mockSessionId',
+                sideloadedKits: [],
                 devToken: 'test_dev_token',
                 isFirstRun: true,
                 isEnabled: true,

package/src/mp-instance.js

@@ -1421,6 +1421,8 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
             mpInstance._APIClient.prepareForwardingStats
         );
 
+        mpInstance._Forwarders.processPixelConfigs(config);
+
         mpInstance._SessionManager.initialize();
         mpInstance._Events.logAST();
 

package/src/persistence.interfaces.ts

@@ -0,0 +1,138 @@
+import { Context } from '@mparticle/event-models';
+import {
+    AllUserAttributes,
+    ConsentState,
+    IdentityApiData,
+    MPID,
+    Product,
+    UserIdentities,
+} from '@mparticle/web-sdk';
+import { ForwardingStatsData } from './apiClient';
+import {
+    IntegrationAttributes,
+    ServerSettings,
+    SessionAttributes,
+} from './store';
+import { Dictionary } from './utils';
+
+export type CookieSyncDate = Dictionary<string>;
+export type UploadsTable = Dictionary<any>;
+export interface iForwardingStatsBatches {
+    uploadsTable: UploadsTable;
+    forwardingStatsEventQueue: ForwardingStatsData[];
+}
+
+// TODO: Migrate this to @types/mparticle__web-sdk
+//       https://go.mparticle.com/work/SQDSDKS-5196
+export type UserAttributes = AllUserAttributes;
+
+export interface IGlobalStoreV2MinifiedKeys {
+    sid: string; // Session ID
+    ie: boolean; // Is Enabled
+    sa: SessionAttributes;
+    ss: ServerSettings;
+    dt: string; // Dev Token
+    av: string; // App Version
+    cgid: string; // Client Generated ID
+    das: string; // Device ID/ Device Application String
+    ia: IntegrationAttributes;
+    c: Context;
+    csm: MPID[]; // Current Session MPIDs
+    les: number; // Last Event Sent Timestamp
+    ssd: number; // Session Start Date
+}
+
+export interface IPersistenceMinified extends Dictionary {
+    cu: MPID; // Current User MPID
+    gs: IGlobalStoreV2MinifiedKeys;
+    l: false; // IsLoggedIn
+
+    // Persistence Minified can also store optional dictionaries with
+    // an idex of MPID
+    // [mpid: MPID]: Dictionary<any>;
+
+    // For Example:
+    // {
+    //     cu: '123345',
+    //     gs: {
+    //         sid: '123',
+    //         ie: false,
+    //         sa: {},
+    //         ss: {},
+    //         dt: '',
+    //         av: '',
+    //         cgid: '123',
+    //         das: 'das',
+    //         ia: {},
+    //         c: null,
+    //         csm: ['123'],
+    //         les: 0,
+    //         ssd: 0,
+    //     },
+    //     l: false,
+    //     MPID1: {
+    //         csd: [],
+    //         ui: {
+    //             customerid: '12346',
+    //         },
+    //     },
+    // };
+}
+
+export interface IPersistence {
+    useLocalStorage(): boolean;
+    initializeStorage(): void;
+    update(): void;
+    storeProductsInMemory(products: Product[], mpid: MPID): void;
+    storeDataInMemory(obj: IPersistenceMinified, currentMPID: MPID): void;
+    determineLocalStorageAvailability(storage: Storage): boolean;
+    getUserProductsFromLS(mpid: MPID): Product[];
+    getAllUserProductsFromLS(): Product[];
+    setLocalStorage(): void;
+    getLocalStorage(): IPersistenceMinified | null;
+    expireCookies(cookieName: string): void;
+    getCookie(): IPersistenceMinified | null;
+    setCookie(): void;
+    reduceAndEncodePersistence(
+        persistence: IPersistenceMinified,
+        expires: string,
+        domain: string,
+        maxCookieSize: number
+    ): void;
+    findPrevCookiesBasedOnUI(identityApiData: IdentityApiData): void;
+    encodePersistence(persistance: IPersistenceMinified): string;
+    decodePersistence(persistance: IPersistenceMinified): string;
+    replaceCommasWithPipes(string: string): string;
+    replacePipesWithCommas(string: string): string;
+    replaceApostrophesWithQuotes(string: string): string;
+    replaceQuotesWithApostrophes(string: string): string;
+    createCookieString(string: string): string;
+    revertCookieString(string: string): string;
+    getCookieDomain(): string;
+    getDomain(doc: string, locationHostname: string): string;
+    getUserIdentities(mpid: MPID): UserIdentities;
+    getAllUserAttributes(mpid: MPID): AllUserAttributes;
+    getCartProducts(mpid: MPID): Product[];
+    setCartProducts(allProducts: Product[]): void;
+    saveUserIdentitiesToPersistence(
+        mpid: MPID,
+        userIdentities: UserIdentities
+    ): void;
+    saveUserAttributesToPersistence(
+        mpid: MPID,
+        userAttributes: UserAttributes
+    ): void;
+    saveUserCookieSyncDatesToPersistence(mpid: MPID, csd: CookieSyncDate): void;
+    saveUserConsentStateToCookies(mpid, consentState: ConsentState): void;
+    savePersistence(persistance: IPersistenceMinified): void;
+    getPersistence(): IPersistenceMinified;
+    getConsentState(mpid: MPID): ConsentState | null;
+    getFirstSeenTime(mpid: MPID): string | null;
+    setFirstSeenTime(mpid: MPID, time: number): void;
+    getLastSeenTime(mpid: MPID): number | null;
+    setLastSeenTime(mpid: MPID, time: number): void;
+    getDeviceId(): string;
+    setDeviceId(guid: string): void;
+    resetPersistence(): void;
+    forwardingStatsBatches: iForwardingStatsBatches;
+}

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;
 

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/vault.ts

@@ -6,12 +6,10 @@ interface IVaultOptions {
     offlineStorageEnabled?: boolean;
 }
 
-export default class Vault<StorableItem extends Dictionary> {
-    public contents: Dictionary<StorableItem>;
+export default class Vault<StorableItem> {
+    public contents: StorableItem;
     private readonly _storageKey: string;
-    private readonly _itemKey: keyof StorableItem;
     private logger?: Logger;
-    private offlineStorageEnabled: boolean = false;
 
     /**
      *
@@ -19,16 +17,9 @@ export default class Vault<StorableItem extends Dictionary> {
      * @param {string} itemKey an element within your StorableItem to use as a key
      * @param {IVaultOptions} options A Dictionary of IVaultOptions
      */
-    constructor(
-        storageKey: string,
-        itemKey: keyof StorableItem,
-        options?: IVaultOptions
-    ) {
+    constructor(storageKey: string, options?: IVaultOptions) {
         this._storageKey = storageKey;
-        this._itemKey = itemKey;
-        this.contents = this.getItems() || {};
-
-        this.offlineStorageEnabled = options?.offlineStorageEnabled;
+        this.contents = this.getFromLocalStorage();
 
         // Add a fake logger in case one is not provided or needed
         this.logger = options?.logger || {
@@ -39,51 +30,16 @@ export default class Vault<StorableItem extends Dictionary> {
     }
 
     /**
-     * Stores a single Item using `itemId` as an index
+     * Stores a StorableItem to Local Storage
      * @method storeItem
-     * @param item {StorableItem} a Dictonary with key to store
-     */
-    public storeItem(item: StorableItem): void {
-        this.contents = this.getItems();
-
-        if (item[this._itemKey]) {
-            this.contents[item[this._itemKey]] = item;
-            this.logger.verbose(
-                `Saved items to vault with key: ${item[this._itemKey]}`
-            );
-        }
-
-        this.saveItems(this.contents);
-    }
-
-    /**
-     * Stores Items using `itemId` as an index
-     * @method storeItems
-     * @param {StorableItem[]} an Array of StorableItems
-     */
-    public storeItems(items: StorableItem[]): void {
-        items.forEach((item) => this.storeItem(item));
-    }
-
-    /**
-     * Removes a single StorableItem based on `indexId`
-     * @method removeItem
-     * @param {String} indexId
+     * @param item {StorableItem}
      */
-    public removeItem(indexId: string): void {
-        this.logger.verbose(`Removing from vault: ${indexId}`);
-        this.contents = this.getItems() || {};
+    public store(item: StorableItem): void {
+        this.contents = item;
 
-        try {
-            delete this.contents[indexId];
+        this.logger.verbose(`Saved to local storage: ${item}`);
 
-            this.saveItems(this.contents);
-        } catch (error) {
-            this.logger.error(
-                `Unable to remove item without a matching ID ${indexId}`
-            );
-            this.logger.error(error as string);
-        }
+        this.saveToLocalStorage(this.contents);
     }
 
     /**
@@ -91,10 +47,10 @@ export default class Vault<StorableItem extends Dictionary> {
      * @method retrieveItems
      * @returns {StorableItem[]} an array of Items
      */
-    public retrieveItems(): StorableItem[] {
-        this.contents = this.getItems();
+    public retrieve(): StorableItem {
+        this.contents = this.getFromLocalStorage();
 
-        return Object.keys(this.contents).map((item) => this.contents[item]);
+        return this.contents;
     }
 
     /**
@@ -102,14 +58,11 @@ export default class Vault<StorableItem extends Dictionary> {
      * @method purge
      */
     public purge(): void {
-        this.contents = {};
-        this.removeItems();
+        this.contents = null;
+        this.removeFromLocalStorage();
     }
 
-    private saveItems(items: Dictionary<StorableItem>): void {
-        if (!this.offlineStorageEnabled) {
-            return;
-        }
+    private saveToLocalStorage(items: StorableItem): void {
         try {
             window.localStorage.setItem(
                 this._storageKey,
@@ -121,21 +74,15 @@ export default class Vault<StorableItem extends Dictionary> {
         }
     }
 
-    private getItems(): Dictionary<StorableItem> {
-        if (!this.offlineStorageEnabled) {
-            return this.contents;
-        }
+    private getFromLocalStorage(): StorableItem | null {
         // TODO: Handle cases where Local Storage is unavailable
         // https://go.mparticle.com/work/SQDSDKS-5022
-        const itemString = window.localStorage.getItem(this._storageKey);
+        const item: string = window.localStorage.getItem(this._storageKey);
 
-        return itemString ? JSON.parse(itemString) : {};
+        return item ? JSON.parse(item) : null;
     }
 
-    private removeItems(): void {
-        if (!this.offlineStorageEnabled) {
-            return;
-        }
+    private removeFromLocalStorage(): void {
         window.localStorage.removeItem(this._storageKey);
     }
-}
+}