@mparticle/web-sdk 2.46.0 → 2.47.1

package/src/store.ts

@@ -8,7 +8,7 @@ import {
     UserIdentities,
 } from '@mparticle/web-sdk';
 import { IKitConfigs } from './configAPIClient';
-import Constants from './constants';
+import Constants, { PrivacyControl, StoragePrivacyMap, StorageTypes } from './constants';
 import {
     DataPlanResult,
     KitBlockerOptions,
@@ -194,7 +194,6 @@ export interface IStore {
     requireDelay: boolean;
     isLocalStorageAvailable: boolean | null;
     storageName: string | null;
-    prodStorageName: string | null;
     activeForwarders: ConfiguredKit[];
     kits: Dictionary<MPForwarder>;
     sideloadedKits: MPForwarder[];
@@ -216,6 +215,7 @@ export interface IStore {
     setNoFunctional?(noFunctional: boolean): void;
     getNoTargeting?(): boolean;
     setNoTargeting?(noTargeting: boolean): void;
+    getPrivacyFlag?(storageType: StorageTypes): boolean;
 
     getDeviceId?(): string;
     setDeviceId?(deviceId: string): void;
@@ -246,7 +246,6 @@ export default function Store(
 ) {
     const {
         createMainStorageName,
-        createProductStorageName,
     } = mpInstance._Helpers;
 
     const { isWebviewEnabled } = mpInstance._NativeSdkHelpers;
@@ -286,7 +285,6 @@ export default function Store(
         requireDelay: true,
         isLocalStorageAvailable: null,
         storageName: null,
-        prodStorageName: null,
         activeForwarders: [],
         kits: {},
         sideloadedKits: [],
@@ -608,6 +606,17 @@ export default function Store(
         this.noTargeting = noTargeting;
     };
 
+    this.getPrivacyFlag = (storageType: StorageTypes): boolean => {
+        const privacyControl: PrivacyControl = StoragePrivacyMap[storageType];
+        if (privacyControl === 'functional') {
+            return this.getNoFunctional();
+        }
+        if (privacyControl === 'targeting') {
+            return this.getNoTargeting();
+        }
+        return false;
+    };
+
     this.getDeviceId = () => this.deviceId;
     this.setDeviceId = (deviceId: string) => {
         this.deviceId = deviceId;
@@ -728,9 +737,21 @@ export default function Store(
             this.SDKConfig[baseUrlKeys] = baseUrls[baseUrlKeys];
         }
 
+        const { noFunctional, noTargeting } = config?.launcherOptions ?? {};
+
+        if (noFunctional != null) {
+            this.setNoFunctional(noFunctional);
+        }
+        
+        if (noTargeting != null) {
+            this.setNoTargeting(noTargeting);
+        }
+
         if (workspaceToken) {
             this.SDKConfig.workspaceToken = workspaceToken;
-            mpInstance._timeOnSiteTimer = new ForegroundTimer(workspaceToken);
+            if (!this.getPrivacyFlag('TimeOnSite')) {
+                mpInstance._timeOnSiteTimer = new ForegroundTimer(workspaceToken);
+            }
         } else {
             mpInstance.Logger.warning(
                 'You should have a workspaceToken on your config object for security purposes.'
@@ -738,16 +759,6 @@ export default function Store(
         }
         // add a new function to apply items to the store that require config to be returned
         this.storageName = createMainStorageName(workspaceToken);
-        this.prodStorageName = createProductStorageName(workspaceToken);
-
-        // Extract privacy flags directly from config into Store
-        if (config.hasOwnProperty('noFunctional')) {
-            this.setNoFunctional(config.noFunctional);
-        }
-
-        if (config.hasOwnProperty('noTargeting')) {
-            this.setNoTargeting(config.noTargeting);
-        }
 
         this.SDKConfig.requiredWebviewBridgeName =
             requiredWebviewBridgeName || workspaceToken;

package/src/utils.ts

@@ -57,18 +57,25 @@ const findKeyInObject = (obj: any, key: string): string => {
 
 const generateDeprecationMessage = (
     methodName: string,
-    alternateMethod: string
+    isDeprecated?: boolean,
+    alternateMethod?: string,
+    docsUrl?: string,
 ): string => {
-    const messageArray: string[] = [
-        methodName,
-        Messages.DeprecationMessages.MethodIsDeprecatedPostfix,
-    ];
+    const messageArray: string[] = [methodName];
+
+    if (isDeprecated) {
+        messageArray.push(Messages.DeprecationMessages.MethodHasBeenDeprecated);
+    } else {
+        messageArray.push(Messages.DeprecationMessages.MethodMarkedForDeprecationPostfix);
+    }
 
     if (alternateMethod) {
-        messageArray.push(alternateMethod);
-        messageArray.push(
-            Messages.DeprecationMessages.MethodIsDeprecatedPostfix
-        );
+        messageArray.push(Messages.DeprecationMessages.AlternativeMethodPrefix);
+        messageArray.push(alternateMethod + ".");
+    }
+
+    if (docsUrl) {
+        messageArray.push("See - " + docsUrl);
     }
 
     return messageArray.join(' ');

package/src/vault.ts

@@ -102,4 +102,20 @@ export class SessionStorageVault<StorableItem> extends BaseVault<StorableItem> {
     constructor(storageKey: string, options?: IVaultOptions) {
         super(storageKey, window.sessionStorage, options);
     }
+}
+
+// DisabledVault is used when persistence is disabled by privacy flags.
+export class DisabledVault<StorableItem> extends BaseVault<StorableItem> {
+    constructor(storageKey: string, options?: IVaultOptions) {
+        super(storageKey, window.localStorage, options);
+        this.contents = null;
+    }
+
+    public store(_item: StorableItem): void {
+        this.contents = null;
+    }
+
+    public retrieve(): StorableItem | null {
+        return this.contents;
+    }
 }