@mparticle/web-sdk 2.47.0 → 2.47.1

package/src/identity.js

@@ -1215,7 +1215,7 @@ export default function Identity(mpInstance) {
                 mpInstance.Logger.warning(
                     'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases'
                 );
-                return self.mParticleUserCart(mpid);
+                return self.mParticleUserCart();
             },
 
             /**
@@ -1286,133 +1286,37 @@ export default function Identity(mpInstance) {
      * @class mParticle.Identity.getCurrentUser().getCart()
      * @deprecated
      */
-    this.mParticleUserCart = function(mpid) {
+    this.mParticleUserCart = function() {
         return {
             /**
              * Adds a cart product to the user cart
              * @method add
-             * @param {Object} product the product
-             * @param {Boolean} [logEvent] a boolean to log adding of the cart object. If blank, no logging occurs.
              * @deprecated
              */
-            add: function(product, logEvent) {
+            add: function() {
                 mpInstance.Logger.warning(
-                    'Deprecated function Identity.getCurrentUser().getCart().add() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'Identity.getCurrentUser().getCart().add()',
+                        true,
+                        'eCommerce.logProductAction()',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-                var allProducts, userProducts, arrayCopy;
-
-                arrayCopy = Array.isArray(product)
-                    ? product.slice()
-                    : [product];
-                arrayCopy.forEach(function(product) {
-                    product.Attributes = mpInstance._Helpers.sanitizeAttributes(
-                        product.Attributes
-                    );
-                });
-
-                if (mpInstance._Store.webviewBridgeEnabled) {
-                    mpInstance._NativeSdkHelpers.sendToNative(
-                        Constants.NativeSdkPaths.AddToCart,
-                        JSON.stringify(arrayCopy)
-                    );
-                } else {
-                    mpInstance._SessionManager.resetSessionTimer();
-
-                    userProducts = mpInstance._Persistence.getUserProductsFromLS(
-                        mpid
-                    );
-
-                    userProducts = userProducts.concat(arrayCopy);
-
-                    if (logEvent === true) {
-                        mpInstance._Events.logProductActionEvent(
-                            Types.ProductActionType.AddToCart,
-                            arrayCopy
-                        );
-                    }
-
-                    var productsForMemory = {};
-                    productsForMemory[mpid] = { cp: userProducts };
-
-                    if (
-                        userProducts.length >
-                        mpInstance._Store.SDKConfig.maxProducts
-                    ) {
-                        mpInstance.Logger.verbose(
-                            'The cart contains ' +
-                                userProducts.length +
-                                ' items. Only ' +
-                                mpInstance._Store.SDKConfig.maxProducts +
-                                ' can currently be saved in cookies.'
-                        );
-                        userProducts = userProducts.slice(
-                            -mpInstance._Store.SDKConfig.maxProducts
-                        );
-                    }
-
-                    allProducts = mpInstance._Persistence.getAllUserProductsFromLS();
-                    allProducts[mpid].cp = userProducts;
-
-                    mpInstance._Persistence.setCartProducts(allProducts);
-                }
             },
             /**
              * Removes a cart product from the current user cart
              * @method remove
-             * @param {Object} product the product
-             * @param {Boolean} [logEvent] a boolean to log adding of the cart object. If blank, no logging occurs.
              * @deprecated
              */
-            remove: function(product, logEvent) {
+            remove: function() {
                 mpInstance.Logger.warning(
-                    'Deprecated function Identity.getCurrentUser().getCart().remove() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'Identity.getCurrentUser().getCart().remove()',
+                        true,
+                        'eCommerce.logProductAction()',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-                var allProducts,
-                    userProducts,
-                    cartIndex = -1,
-                    cartItem = null;
-
-                if (mpInstance._Store.webviewBridgeEnabled) {
-                    mpInstance._NativeSdkHelpers.sendToNative(
-                        Constants.NativeSdkPaths.RemoveFromCart,
-                        JSON.stringify(product)
-                    );
-                } else {
-                    mpInstance._SessionManager.resetSessionTimer();
-
-                    userProducts = mpInstance._Persistence.getUserProductsFromLS(
-                        mpid
-                    );
-
-                    if (userProducts) {
-                        userProducts.forEach(function(cartProduct, i) {
-                            if (cartProduct.Sku === product.Sku) {
-                                cartIndex = i;
-                                cartItem = cartProduct;
-                            }
-                        });
-
-                        if (cartIndex > -1) {
-                            userProducts.splice(cartIndex, 1);
-
-                            if (logEvent === true) {
-                                mpInstance._Events.logProductActionEvent(
-                                    Types.ProductActionType.RemoveFromCart,
-                                    cartItem
-                                );
-                            }
-                        }
-                    }
-
-                    var productsForMemory = {};
-                    productsForMemory[mpid] = { cp: userProducts };
-
-                    allProducts = mpInstance._Persistence.getAllUserProductsFromLS();
-
-                    allProducts[mpid].cp = userProducts;
-
-                    mpInstance._Persistence.setCartProducts(allProducts);
-                }
             },
             /**
              * Clears the user's cart
@@ -1421,31 +1325,13 @@ export default function Identity(mpInstance) {
              */
             clear: function() {
                 mpInstance.Logger.warning(
-                    'Deprecated function Identity.getCurrentUser().getCart().clear() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'Identity.getCurrentUser().getCart().clear()',
+                        true,
+                        '',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-
-                var allProducts;
-
-                if (mpInstance._Store.webviewBridgeEnabled) {
-                    mpInstance._NativeSdkHelpers.sendToNative(
-                        Constants.NativeSdkPaths.ClearCart
-                    );
-                } else {
-                    mpInstance._SessionManager.resetSessionTimer();
-                    allProducts = mpInstance._Persistence.getAllUserProductsFromLS();
-
-                    if (
-                        allProducts &&
-                        allProducts[mpid] &&
-                        allProducts[mpid].cp
-                    ) {
-                        allProducts[mpid].cp = [];
-
-                        allProducts[mpid].cp = [];
-
-                        mpInstance._Persistence.setCartProducts(allProducts);
-                    }
-                }
             },
             /**
              * Returns all cart products
@@ -1455,9 +1341,14 @@ export default function Identity(mpInstance) {
              */
             getCartProducts: function() {
                 mpInstance.Logger.warning(
-                    'Deprecated function Identity.getCurrentUser().getCart().getCartProducts() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'Identity.getCurrentUser().getCart().getCartProducts()',
+                        true,
+                        'eCommerce.logProductAction()',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-                return mpInstance._Persistence.getCartProducts(mpid);
+                return [];
             },
         };
     };

package/src/mp-instance.ts

@@ -36,7 +36,7 @@ import Consent, { IConsent } from './consent';
 import KitBlocker from './kitBlocking';
 import ConfigAPIClient, { IKitConfigs } from './configAPIClient';
 import IdentityAPIClient from './identityApiClient';
-import { isFunction, parseConfig, valueof } from './utils';
+import { isFunction, parseConfig, valueof, generateDeprecationMessage } from './utils';
 import { DisabledVault, LocalStorageVault } from './vault';
 import { removeExpiredIdentityCacheDates } from './identity-utils';
 import IntegrationCapture from './integrationCapture';
@@ -706,16 +706,13 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              */
             add: function(product, logEventBoolean) {
                 self.Logger.warning(
-                    'Deprecated function eCommerce.Cart.add() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'eCommerce.Cart.add()',
+                        true,
+                        'eCommerce.logProductAction()',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-                let mpid;
-                const currentUser = self.Identity.getCurrentUser();
-                if (currentUser) {
-                    mpid = currentUser.getMPID();
-                }
-                self._Identity
-                    .mParticleUserCart(mpid)
-                    .add(product, logEventBoolean);
             },
             /**
              * Removes a product from the cart
@@ -726,16 +723,13 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              */
             remove: function(product, logEventBoolean) {
                 self.Logger.warning(
-                    'Deprecated function eCommerce.Cart.remove() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'eCommerce.Cart.remove()',
+                        true,
+                        'eCommerce.logProductAction()',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-                let mpid;
-                const currentUser = self.Identity.getCurrentUser();
-                if (currentUser) {
-                    mpid = currentUser.getMPID();
-                }
-                self._Identity
-                    .mParticleUserCart(mpid)
-                    .remove(product, logEventBoolean);
             },
             /**
              * Clears the cart
@@ -744,14 +738,13 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              */
             clear: function() {
                 self.Logger.warning(
-                    'Deprecated function eCommerce.Cart.clear() will be removed in future releases'
+                    generateDeprecationMessage(
+                        'eCommerce.Cart.clear()',
+                        true,
+                        '',
+                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                    )
                 );
-                let mpid;
-                const currentUser = self.Identity.getCurrentUser();
-                if (currentUser) {
-                    mpid = currentUser.getMPID();
-                }
-                self._Identity.mParticleUserCart(mpid).clear();
             },
         },
         /**

package/src/persistence.interfaces.ts

@@ -99,11 +99,8 @@ 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;
@@ -120,8 +117,6 @@ export interface IPersistence {
     decodePersistence(persistenceString: string): string;
     getCookieDomain(): string;
     getDomain(doc: string, locationHostname: string): string;
-    getCartProducts(mpid: MPID): Product[];
-    setCartProducts(allProducts: Product[]): void;
     saveUserCookieSyncDatesToPersistence(mpid: MPID, csd: CookieSyncDates): void;
     savePersistence(persistance: IPersistenceMinified): void;
     getPersistence(): IPersistenceMinified;

package/src/persistence.js

@@ -90,35 +90,6 @@ export default function _Persistence(mpInstance) {
                 self.storeDataInMemory(cookies);
             }
 
-            // https://go.mparticle.com/work/SQDSDKS-6048
-            try {
-                if (mpInstance._Store.isLocalStorageAvailable) {
-                    var encodedProducts = localStorage.getItem(
-                        mpInstance._Store.prodStorageName
-                    );
-
-                    if (encodedProducts) {
-                        var decodedProducts = JSON.parse(
-                            Base64.decode(encodedProducts)
-                        );
-                    }
-                    if (mpInstance._Store.mpid) {
-                        self.storeProductsInMemory(
-                            decodedProducts,
-                            mpInstance._Store.mpid
-                        );
-                    }
-                }
-            } catch (e) {
-                if (mpInstance._Store.isLocalStorageAvailable) {
-                    localStorage.removeItem(mpInstance._Store.prodStorageName);
-                }
-                mpInstance._Store.cartProducts = [];
-                mpInstance.Logger.error(
-                    'Error loading products in initialization: ' + e
-                );
-            }
-
             // https://go.mparticle.com/work/SQDSDKS-6046
             // Stores all non-current user MPID information into the store
             for (var key in allData) {
@@ -158,21 +129,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.storeProductsInMemory = function(products, mpid) {
-        if (products) {
-            try {
-                mpInstance._Store.cartProducts =
-                    products[mpid] && products[mpid].cp
-                        ? products[mpid].cp
-                        : [];
-            } catch (e) {
-                mpInstance.Logger.error(
-                    Messages.ErrorMessages.CookieParseError
-                );
-            }
-        }
-    };
-
     // https://go.mparticle.com/work/SQDSDKS-6045
     this.storeDataInMemory = function(obj, currentMPID) {
         try {
@@ -275,64 +231,6 @@ export default function _Persistence(mpInstance) {
         }
     };
 
-    this.getUserProductsFromLS = function(mpid) {
-        if (!mpInstance._Store.isLocalStorageAvailable) {
-            return [];
-        }
-
-        var decodedProducts,
-            userProducts,
-            parsedProducts,
-            encodedProducts = localStorage.getItem(
-                mpInstance._Store.prodStorageName
-            );
-        if (encodedProducts) {
-            decodedProducts = Base64.decode(encodedProducts);
-        }
-        // if there is an MPID, we are retrieving the user's products, which is an array
-        if (mpid) {
-            try {
-                if (decodedProducts) {
-                    parsedProducts = JSON.parse(decodedProducts);
-                }
-                if (
-                    decodedProducts &&
-                    parsedProducts[mpid] &&
-                    parsedProducts[mpid].cp &&
-                    Array.isArray(parsedProducts[mpid].cp)
-                ) {
-                    userProducts = parsedProducts[mpid].cp;
-                } else {
-                    userProducts = [];
-                }
-                return userProducts;
-            } catch (e) {
-                return [];
-            }
-        } else {
-            return [];
-        }
-    };
-
-    this.getAllUserProductsFromLS = function() {
-        var decodedProducts,
-            encodedProducts = localStorage.getItem(
-                mpInstance._Store.prodStorageName
-            ),
-            parsedDecodedProducts;
-        if (encodedProducts) {
-            decodedProducts = Base64.decode(encodedProducts);
-        }
-        // returns an object with keys of MPID and values of array of products
-        try {
-            parsedDecodedProducts = JSON.parse(decodedProducts);
-        } catch (e) {
-            parsedDecodedProducts = {};
-        }
-
-        return parsedDecodedProducts;
-    };
-
     // https://go.mparticle.com/work/SQDSDKS-6021
     this.setLocalStorage = function() {
         if (!mpInstance._Store.isLocalStorageAvailable) {
@@ -340,30 +238,9 @@ export default function _Persistence(mpInstance) {
         }
 
         var key = mpInstance._Store.storageName,
-            allLocalStorageProducts = self.getAllUserProductsFromLS(),
             localStorageData = self.getLocalStorage() || {},
             currentUser = mpInstance.Identity.getCurrentUser(),
-            mpid = currentUser ? currentUser.getMPID() : null,
-            currentUserProducts = {
-                cp: allLocalStorageProducts[mpid]
-                    ? allLocalStorageProducts[mpid].cp
-                    : [],
-            };
-        if (mpid) {
-            allLocalStorageProducts = allLocalStorageProducts || {};
-            allLocalStorageProducts[mpid] = currentUserProducts;
-            try {
-                window.localStorage.setItem(
-                    encodeURIComponent(mpInstance._Store.prodStorageName),
-                    Base64.encode(JSON.stringify(allLocalStorageProducts))
-                );
-            } catch (e) {
-                mpInstance.Logger.error(
-                    'Error with setting products on localStorage.'
-                );
-            }
-        }
-
+            mpid = currentUser ? currentUser.getMPID() : null;
         if (!mpInstance._Store.SDKConfig.useCookieStorage) {
             localStorageData.gs = localStorageData.gs || {};
 
@@ -900,42 +777,6 @@ export default function _Persistence(mpInstance) {
         return '';
     };
 
-    this.getCartProducts = function(mpid) {
-        var allCartProducts,
-            cartProductsString = localStorage.getItem(
-                mpInstance._Store.prodStorageName
-            );
-        if (cartProductsString) {
-            allCartProducts = JSON.parse(Base64.decode(cartProductsString));
-            if (
-                allCartProducts &&
-                allCartProducts[mpid] &&
-                allCartProducts[mpid].cp
-            ) {
-                return allCartProducts[mpid].cp;
-            }
-        }
-
-        return [];
-    };
-
-    this.setCartProducts = function(allProducts) {
-        if (!mpInstance._Store.isLocalStorageAvailable) {
-            return;
-        }
-
-        try {
-            window.localStorage.setItem(
-                encodeURIComponent(mpInstance._Store.prodStorageName),
-                Base64.encode(JSON.stringify(allProducts))
-            );
-        } catch (e) {
-            mpInstance.Logger.error(
-                'Error with setting products on localStorage.'
-            );
-        }
-    };
-
     this.saveUserCookieSyncDatesToPersistence = function(mpid, csd) {
         if (csd) {
             var persistence = self.getPersistence();
@@ -1111,7 +952,6 @@ export default function _Persistence(mpInstance) {
         removeLocalStorage(StorageNames.localStorageName);
         removeLocalStorage(StorageNames.localStorageNameV3);
         removeLocalStorage(StorageNames.localStorageNameV4);
-        removeLocalStorage(mpInstance._Store.prodStorageName);
         removeLocalStorage(mpInstance._Store.storageName);
         removeLocalStorage(StorageNames.localStorageProductsV4);
 
@@ -1119,7 +959,6 @@ export default function _Persistence(mpInstance) {
         self.expireCookies(StorageNames.cookieNameV2);
         self.expireCookies(StorageNames.cookieNameV3);
         self.expireCookies(StorageNames.cookieNameV4);
-        self.expireCookies(mpInstance._Store.prodStorageName);
         self.expireCookies(mpInstance._Store.storageName);
 
         if (mParticle._isTestEnv) {
@@ -1130,9 +969,6 @@ export default function _Persistence(mpInstance) {
             self.expireCookies(
                 mpInstance._Helpers.createMainStorageName(testWorkspaceToken)
             );
-            removeLocalStorage(
-                mpInstance._Helpers.createProductStorageName(testWorkspaceToken)
-            );
         }
     };
 

package/src/sdkRuntimeModels.ts

@@ -319,7 +319,6 @@ export interface DataPlanConfig {
 export interface SDKHelpersApi {
     canLog?(): boolean;
     createMainStorageName?(workspaceToken: string): string;
-    createProductStorageName?(workspaceToken: string): string;
     createServiceUrl(url: string, devToken?: string): string;
     createXHR?(cb: () => void): XMLHttpRequest;
     extend?(...args: any[]);

package/src/sessionManager.ts

@@ -72,7 +72,7 @@ export default function SessionManager(
         mpInstance.Logger.warning(
             generateDeprecationMessage(
                 'SessionManager.getSession()',
-
+                false,
                 'SessionManager.getSessionId()'
             )
         );

package/src/store.ts

@@ -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[];
@@ -247,7 +246,6 @@ export default function Store(
 ) {
     const {
         createMainStorageName,
-        createProductStorageName,
     } = mpInstance._Helpers;
 
     const { isWebviewEnabled } = mpInstance._NativeSdkHelpers;
@@ -287,7 +285,6 @@ export default function Store(
         requireDelay: true,
         isLocalStorageAvailable: null,
         storageName: null,
-        prodStorageName: null,
         activeForwarders: [],
         kits: {},
         sideloadedKits: [],
@@ -762,7 +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);
 
         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(' ');