@mparticle/web-sdk 2.81.0 → 2.82.0

package/dist/types/src/sdkRuntimeModels.d.ts

@@ -52,7 +52,6 @@ export interface SDKEvent {
     ProductAction?: SDKProductAction;
     PromotionAction?: SDKPromotionAction;
     ProductImpressions?: SDKProductImpression[];
-    ShoppingCart?: SDKShoppingCart;
     UserIdentityChanges?: ISDKUserIdentityChanges;
     UserAttributeChanges?: ISDKUserAttributeChangeData;
     CurrencyCode: string;
@@ -73,9 +72,6 @@ export interface SDKDataPlan {
     PlanVersion?: number | null;
     PlanId?: string | null;
 }
-export interface SDKShoppingCart {
-    ProductList?: SDKProduct[];
-}
 export interface SDKPromotionAction {
     PromotionActionType: string;
     PromotionList?: SDKPromotion[];
@@ -233,7 +229,6 @@ export interface SDKInitConfig extends Omit<MPConfiguration, 'dataPlan' | 'logLe
     identityUrl?: string;
     integrationDelayTimeout?: number;
     isIOS?: boolean;
-    maxProducts?: number;
     requestConfig?: boolean;
     sessionTimeout?: number;
     useNativeSdk?: boolean;

package/dist/types/src/sdkToEventsApiConverter.d.ts

@@ -25,7 +25,6 @@ export declare function convertProducts(sdkProducts: SDKProduct[]): EventsApi.Pr
 export declare function convertPromotionAction(sdkEvent: SDKEvent): EventsApi.PromotionAction | null;
 export declare function convertPromotions(sdkPromotions: SDKPromotion[]): EventsApi.Promotion[] | null;
 export declare function convertImpressions(sdkEvent: SDKEvent): EventsApi.ProductImpression[] | null;
-export declare function convertShoppingCart(sdkEvent: SDKEvent): EventsApi.ShoppingCart | null;
 export declare function convertCommerceEvent(sdkEvent: SDKEvent): EventsApi.CommerceEvent;
 export declare function convertCrashReportEvent(sdkEvent: SDKEvent): EventsApi.CrashReportEvent;
 export declare function convertAST(sdkEvent: SDKEvent): EventsApi.ApplicationStateTransitionEvent;

package/dist/types/src/store.d.ts

@@ -45,7 +45,6 @@ export interface SDKConfig {
     userAudienceUrl?: string;
     isIOS?: boolean;
     maxAliasWindow: number;
-    maxProducts: number;
     requestConfig?: boolean;
     sessionTimeout?: number;
     timeout?: number;

package/dist/types/src/stub/mparticle.stub.d.ts

@@ -35,14 +35,11 @@ declare namespace mParticle {
         export { returnProduct as createProduct };
         export { returnPromotion as createPromotion };
         export { returnTransactionAttributes as createTransactionAttributes };
-        export { voidFunction as logCheckout };
         export { voidFunction as logImpression };
         export { voidFunction as logProductAction };
         export { voidFunction as logPromotion };
         export { voidFunction as logPurchase };
-        export { voidFunction as logRefund };
         export { voidFunction as setCurrencyCode };
-        export let Cart: any;
     }
     export namespace Consent {
         export { createConsentState };
@@ -140,7 +137,6 @@ declare function returnUser(): {
     removeAllUserAttributes: typeof voidFunction;
     getUserAttributesLists: typeof returnObject;
     getAllUserAttributes: typeof returnObject;
-    getCart: typeof Cart;
     getConsentState: typeof createConsentState;
     setConsentState: typeof voidFunction;
 };
@@ -158,27 +154,8 @@ declare function returnUsers(): {
     removeAllUserAttributes: typeof voidFunction;
     getUserAttributesLists: typeof returnObject;
     getAllUserAttributes: typeof returnObject;
-    getCart: typeof Cart;
     getConsentState: typeof createConsentState;
     setConsentState: typeof voidFunction;
 }[];
 declare function returnThis(): any;
 declare function returnObject(): {};
-declare function Cart_1(): {
-    add: typeof voidFunction;
-    clear: typeof voidFunction;
-    remove: typeof voidFunction;
-    getCartProducts: () => {
-        Name: string;
-        Sku: string;
-        Price: number;
-        Quantity: number;
-        Brand: string;
-        Variant: string;
-        Category: string;
-        Position: string;
-        CouponCode: string;
-        TotalAmount: number;
-        Attributes: {};
-    }[];
-};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.81.0",
+    "version": "2.82.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [

package/src/consent.ts

@@ -9,7 +9,6 @@ import KitFilterHelper from './kitFilterHelper';
 import Constants from './constants';
 import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
-import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 const { CCPAPurpose } = Constants;
 
@@ -98,11 +97,6 @@ export interface IConsentRules {
     values: IConsentRulesValues[];
 }
 
-// TODO: Remove this if we can safely deprecate `removeCCPAState`
-export interface IConsentState extends ConsentState {
-    removeCCPAState: () => ConsentState;
-}
-
 // Represents Actual Interface for Consent Module
 // TODO: Should eventually consolidate with SDKConsentStateApi
 export interface IConsent {
@@ -326,7 +320,7 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
     this.createConsentState = function(
         this: ConsentState,
         consentState?: ConsentState
-    ): IConsentState {
+    ): ConsentState {
         let gdpr = {};
         let ccpa = {};
 
@@ -339,8 +333,7 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
                 consentState.getCCPAConsentState()
             );
 
-            // TODO: Remove casting once `removeCCPAState` is removed;
-            return consentStateCopy as IConsentState;
+            return consentStateCopy;
         }
 
         function canonicalizeForDeduplication(purpose: string): string {
@@ -504,20 +497,6 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
             return this;
         }
 
-        // TODO: Can we remove this? It is deprecated.
-        function removeCCPAState(this: ConsentState) {
-            logDeprecatedMethodUsage(
-                {
-                    methodName: 'Consent.removeCCPAState',
-                    warningMessage: 'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead',
-                },
-                mpInstance.Logger,
-                mpInstance._ErrorReportingDispatcher
-            );
-            // @ts-ignore
-            return removeCCPAConsentState();
-        }
-
         return {
             setGDPRConsentState,
             addGDPRConsentState,
@@ -525,7 +504,6 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
             getCCPAConsentState,
             getGDPRConsentState,
             removeGDPRConsentState,
-            removeCCPAState, // TODO: Can we remove? This is deprecated
             removeCCPAConsentState,
         };
     };

package/src/constants.ts

@@ -91,9 +91,6 @@ const Constants = {
         SetUserAttribute: 'setUserAttribute',
         RemoveUserAttribute: 'removeUserAttribute',
         SetSessionAttribute: 'setSessionAttribute',
-        AddToCart: 'addToCart',
-        RemoveFromCart: 'removeFromCart',
-        ClearCart: 'clearCart',
         LogOut: 'logOut',
         SetUserAttributeList: 'setUserAttributeList',
         RemoveAllUserAttributes: 'removeAllUserAttributes',
@@ -113,10 +110,8 @@ const Constants = {
         cookieNameV2: 'mprtcl-v2', // v2 Name of the cookie stored on the user's machine. Removed keys with no values, moved cartProducts and productBags to localStorage.
         cookieNameV3: 'mprtcl-v3', // v3 Name of the cookie stored on the user's machine. Base64 encoded keys in Base64CookieKeys object, final version on SDKv1
         localStorageNameV4: 'mprtcl-v4', // v4 Name of the mP localstorage, Current Version
-        localStorageProductsV4: 'mprtcl-prodv4', // The name for mP localstorage that contains products for cartProducs and productBags
         cookieNameV4: 'mprtcl-v4', // v4 Name of the cookie stored on the user's machine. Base64 encoded keys in Base64CookieKeys object, current version on SDK v2
         currentStorageName: 'mprtcl-v4',
-        currentStorageProductsName: 'mprtcl-prodv4',
     },
     DefaultConfig: {
         cookieDomain: null, // If null, defaults to current location.host
@@ -124,7 +119,6 @@ const Constants = {
         logLevel: null, // What logging will be provided in the console
         timeout: 300, // timeout in milliseconds for logging functions
         sessionTimeout: 30, // Session timeout in minutes
-        maxProducts: 20, // Number of products persisted in cartProducts and productBags
         forwarderStatsTimeout: 5000, // Milliseconds for forwarderStats timeout
         integrationDelayTimeout: 5000, // Milliseconds for forcing the integration delay to un-suspend event queueing due to integration partner errors
         maxCookieSize: 3000, // Number of bytes for cookie size to not exceed

package/src/ecommerce.interfaces.ts

@@ -45,20 +45,9 @@ interface IECommerceShared {
     expandCommerceEvent(event: SDKEvent): SDKEvent[] | null;
 }
 
-export interface SDKCart {
-    add(product: SDKProduct | SDKProduct[], logEvent?: boolean): void;
-    remove(product: SDKProduct | SDKProduct[], logEvent?: boolean): void;
-    clear(): void;
-}
 
 // Used for the public `eCommerce` namespace
 export interface SDKECommerceAPI extends IECommerceShared {
-    logCheckout(
-        step: number,
-        option?: string,
-        attrs?: SDKEventAttrs,
-        customFlags?: SDKEventCustomFlags
-    ): void;
     logImpression(
         impression: SDKImpression | SDKImpression[],
         attrs?: SDKEventAttrs,
@@ -82,13 +71,8 @@ export interface SDKECommerceAPI extends IECommerceShared {
     ): void;
     setCurrencyCode(code: string): void;
 
-    /*
-     * @deprecated
-     */
-    Cart: SDKCart;
-
-    /*
-     * @deprecated
+    /**
+     * @deprecated Use `logProductAction` with `ProductActionType.Purchase` instead.
      */
     logPurchase(
         transactionAttributes: TransactionAttributes,
@@ -97,17 +81,6 @@ export interface SDKECommerceAPI extends IECommerceShared {
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags
     ): void;
-
-    /*
-     * @deprecated
-     */
-    logRefund(
-        transactionAttributes: TransactionAttributes,
-        product: SDKProduct | SDKProduct[],
-        clearCart?: boolean,
-        attrs?: SDKEventAttrs,
-        customFlags?: SDKEventCustomFlags
-    ): void;
 }
 
 interface ExtractedActionAttributes {
@@ -144,10 +117,6 @@ interface ExtractedTransactionId {
 
 // Used for the private `_Ecommerce` namespace
 export interface IECommerce extends IECommerceShared {
-    buildProductList(
-        event: SDKEvent,
-        product: SDKProduct | SDKProduct[]
-    ): SDKProduct[];
     convertProductActionToEventType(
         productActionType: valueof<typeof ProductActionType>
     ): // https://go.mparticle.com/work/SQDSDKS-4801

package/src/ecommerce.ts

@@ -337,21 +337,6 @@ export default function Ecommerce(
         }
     };
 
-    this.buildProductList = function(
-        event: SDKEvent,
-        product: SDKProduct | SDKProduct[]
-    ): SDKProduct[] {
-        if (product) {
-            if (Array.isArray(product)) {
-                return product;
-            }
-
-            return [product];
-        }
-
-        return event.ShoppingCart.ProductList;
-    };
-
     this.createProduct = function(
         name: string,
         sku: string | number,
@@ -665,7 +650,6 @@ export default function Ecommerce(
             baseEvent.EventName = 'eCommerce - ';
 
             baseEvent.CurrencyCode = mpInstance._Store.currencyCode;
-            baseEvent.ShoppingCart = [];
             baseEvent.CustomFlags = extend(baseEvent.CustomFlags, customFlags);
 
             return baseEvent;

package/src/events.interfaces.ts

@@ -27,17 +27,6 @@ export interface IEvents {
         eventType: valueof<typeof EventType>
     ): void;
     logAST(): void;
-    logCheckoutEvent(
-        step: number,
-
-        // User options specified during the checkout process
-        // e.g., FedEx, DHL, UPS for delivery options;
-        // Visa, MasterCard, AmEx for payment options.
-        option?: string,
-
-        attrs?: SDKEventAttrs,
-        customFlags?: SDKEventCustomFlags
-    ): void;
     logCommerceEvent(
         commerceEvent: SDKEvent,
         attrs?: SDKEventAttrs,
@@ -73,12 +62,6 @@ export interface IEvents {
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags
     ): void;
-    logRefundEvent(
-        transactionAttributes: TransactionAttributes,
-        product: SDKProduct | SDKProduct[],
-        attrs?: SDKEventAttrs,
-        customFlags?: SDKEventCustomFlags
-    ): void;
     startTracking(callback: Callback): void;
     stopTracking(): void;
 }

package/src/events.ts

@@ -164,33 +164,6 @@ export default function Events(
         });
     };
 
-    this.logCheckoutEvent = function(
-        step: number,
-        option?: string,
-        attrs?: SDKEventAttrs,
-        customFlags?: SDKEventCustomFlags
-    ): void {
-        const event = mpInstance._Ecommerce.createCommerceEventObject(
-            customFlags
-        );
-
-        if (event) {
-            event.EventName += mpInstance._Ecommerce.getProductActionEventName(
-                Types.ProductActionType.Checkout
-            );
-            event.EventCategory = Types.CommerceEventType.ProductCheckout;
-            event.ProductAction = {
-                ProductActionType: Types.ProductActionType
-                    .Checkout as SDKProductActionType,
-                CheckoutStep: step,
-                CheckoutOptions: option,
-                ProductList: [],
-            };
-
-            self.logCommerceEvent(event, attrs);
-        }
-    };
-
     this.logProductActionEvent = function(
         productActionType: valueof<typeof ProductActionType>,
         product: SDKProduct | SDKProduct[],
@@ -287,49 +260,8 @@ export default function Events(
             event.ProductAction = {
                 ProductActionType: Types.ProductActionType
                     .Purchase as SDKProductActionType,
+                ProductList: Array.isArray(product) ? product : [product],
             };
-            event.ProductAction.ProductList = mpInstance._Ecommerce.buildProductList(
-                event,
-                product
-            );
-
-            mpInstance._Ecommerce.convertTransactionAttributesToProductAction(
-                transactionAttributes,
-                event.ProductAction
-            );
-
-            self.logCommerceEvent(event, attrs);
-        }
-    };
-
-    this.logRefundEvent = function(
-        transactionAttributes: TransactionAttributes,
-        product: SDKProduct | SDKProduct[],
-        attrs?: SDKEventAttrs,
-        customFlags?: SDKEventCustomFlags
-    ): void {
-        if (!transactionAttributes) {
-            mpInstance.Logger.error(Messages.ErrorMessages.TransactionRequired);
-            return;
-        }
-
-        const event = mpInstance._Ecommerce.createCommerceEventObject(
-            customFlags
-        );
-
-        if (event) {
-            event.EventName += mpInstance._Ecommerce.getProductActionEventName(
-                Types.ProductActionType.Refund
-            );
-            event.EventCategory = Types.CommerceEventType.ProductRefund;
-            event.ProductAction = {
-                ProductActionType: Types.ProductActionType
-                    .Refund as SDKProductActionType,
-            };
-            event.ProductAction.ProductList = mpInstance._Ecommerce.buildProductList(
-                event,
-                product
-            );
 
             mpInstance._Ecommerce.convertTransactionAttributesToProductAction(
                 transactionAttributes,
@@ -430,11 +362,6 @@ export default function Events(
         );
 
         if (mpInstance._Helpers.canLog()) {
-            if (mpInstance._Store.webviewBridgeEnabled) {
-                // Don't send shopping cart to parent sdks
-                commerceEvent.ShoppingCart = {};
-            }
-
             if (sanitizedAttrs) {
                 commerceEvent.EventAttributes = sanitizedAttrs;
             }

package/src/identity-user-interfaces.ts

@@ -1,42 +1,18 @@
 import { AllUserAttributes, MPID, User } from '@mparticle/web-sdk';
 import { SDKIdentityTypeEnum } from './identity.interfaces';
 import { MessageType } from './types';
-import { BaseEvent, SDKProduct } from './sdkRuntimeModels';
+import { BaseEvent } from './sdkRuntimeModels';
 import Constants from './constants';
 const { HTTPCodes } = Constants;
 
-// Cart is Deprecated and private to mParticle user in @mparticle/web-sdk
-// but we need to expose it here for type safety in some of our tests
-interface ICart {
-    /**
-     * @deprecated Cart persistence in mParticle has been deprecated. Please use mParticle.eCommerce.logProductAction(mParticle.ProductActionType.AddToCart, [products])
-     */
-    add: (product: SDKProduct, logEventBoolean?: boolean) => void;
-    /**
-     * @deprecated Cart persistence in mParticle has been deprecated. Please use mParticle.eCommerce.logProductAction(mParticle.ProductActionType.RemoveFromCart, [products])
-     */
-    remove: (product: SDKProduct, logEventBoolean?: boolean) => void;
-    /**
-     * @deprecated Cart persistence in mParticle has been deprecated.
-     */
-    clear: () => void;
-    /**
-     * @deprecated Cart Products have been deprecated
-     */
-    getCartProducts: () => SDKProduct[];
-}
 
 // https://go.mparticle.com/work/SQDSDKS-5033
 // https://go.mparticle.com/work/SQDSDKS-6354
-export interface IMParticleUser extends User {
+export interface IMParticleUser extends Omit<User, 'getCart'> {
     getAllUserAttributes(): any;
     setUserTag(tagName: string, value?: any): void;
     setUserAttribute(key: string, value: any): void;
     getUserAudiences?(callback?: IdentityCallback): void;
-    /*
-     * @deprecated
-     */
-    getCart(): ICart;
 }
 
 export interface ISDKUserIdentity {
@@ -114,12 +90,5 @@ export interface IdentityModifyResultBody {
     };
 }
 
-export interface mParticleUserCart {
-    add(): void;
-    remove(): void;
-    clear(): void;
-    getCartProducts(): SDKProduct[];
-}
-
 // https://go.mparticle.com/work/SQDSDKS-5196
 export type UserAttributes = AllUserAttributes;

package/src/identity.interfaces.ts

@@ -9,7 +9,6 @@ import {
     IUserAttributeChangeEvent,
     IUserIdentityChangeEvent,
     IMParticleUser,
-    mParticleUserCart,
     IIdentityResponse,
 } from './identity-user-interfaces';
 import { IdentitySearchCallback } from './identity/search';
@@ -295,9 +294,4 @@ export interface IIdentity {
         user: IMParticleUser,
         method: IdentityAPIMethod
     ): void;
-
-    /**
-     * @deprecated
-     */
-    mParticleUserCart(): mParticleUserCart;
 }

package/src/identity.ts

@@ -27,7 +27,6 @@ import {
     IdentityCallback,
     IIdentityResponse,
     IMParticleUser,
-    mParticleUserCart,
 } from './identity-user-interfaces';
 import {
     IIdentity,
@@ -1283,24 +1282,6 @@ export default function Identity(
 
                 return userAttributesCopy;
             },
-            /**
-             * Returns the cart object for the current user
-             * @method getCart
-             * @return a cart object
-             */
-            getCart: function() {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName: 'Identity.getCurrentUser().getCart()',
-                        warningMessage:
-                            'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases',
-                    },
-                    mpInstance.Logger,
-                    mpInstance._ErrorReportingDispatcher
-                );
-                return self.mParticleUserCart();
-            },
-
             /**
              * Returns the Consent State stored locally for this user.
              * @method getConsentState
@@ -1365,102 +1346,6 @@ export default function Identity(
         };
     };
 
-    /**
-     * Invoke these methods on the mParticle.Identity.getCurrentUser().getCart() object.
-     * Example: mParticle.Identity.getCurrentUser().getCart().add(...);
-     * @class mParticle.Identity.getCurrentUser().getCart()
-     * @deprecated
-     */
-    this.mParticleUserCart = function(): mParticleUserCart {
-        return {
-            /**
-             * Adds a cart product to the user cart
-             * @method add
-             * @deprecated
-             */
-            add: function() {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName: 'Identity.getCurrentUser().getCart().add()',
-                        warningMessage: generateDeprecationMessage(
-                            'Identity.getCurrentUser().getCart().add()',
-                            true,
-                            'eCommerce.logProductAction()',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    mpInstance.Logger,
-                    mpInstance._ErrorReportingDispatcher
-                );
-            },
-            /**
-             * Removes a cart product from the current user cart
-             * @method remove
-             * @deprecated
-             */
-            remove: function() {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName:
-                            'Identity.getCurrentUser().getCart().remove()',
-                        warningMessage: generateDeprecationMessage(
-                            'Identity.getCurrentUser().getCart().remove()',
-                            true,
-                            'eCommerce.logProductAction()',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    mpInstance.Logger,
-                    mpInstance._ErrorReportingDispatcher
-                );
-            },
-            /**
-             * Clears the user's cart
-             * @method clear
-             * @deprecated
-             */
-            clear: function() {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName:
-                            'Identity.getCurrentUser().getCart().clear()',
-                        warningMessage: generateDeprecationMessage(
-                            'Identity.getCurrentUser().getCart().clear()',
-                            true,
-                            '',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    mpInstance.Logger,
-                    mpInstance._ErrorReportingDispatcher
-                );
-            },
-            /**
-             * Returns all cart products
-             * @method getCartProducts
-             * @return {Array} array of cart products
-             * @deprecated
-             */
-            getCartProducts: function() {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName:
-                            'Identity.getCurrentUser().getCart().getCartProducts()',
-                        warningMessage: generateDeprecationMessage(
-                            'Identity.getCurrentUser().getCart().getCartProducts()',
-                            true,
-                            'eCommerce.logProductAction()',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    mpInstance.Logger,
-                    mpInstance._ErrorReportingDispatcher
-                );
-                return [];
-            },
-        };
-    };
-
     // https://go.mparticle.com/work/SQDSDKS-6355
     this.parseIdentityResponse = function(
         identityResponse: IIdentityResponse,

package/src/internal-types.ts

@@ -57,7 +57,6 @@ export type {
     SDKProductAction,
     SDKProductActionType,
     SDKPromotionAction,
-    SDKShoppingCart,
     SDKGeoLocation,
     SDKDataPlan,
     SDKLoggerApi,