@mparticle/web-sdk 2.80.1 → 3.0.0

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,

package/src/mp-instance.ts

@@ -780,78 +780,6 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
      * @class mParticle.eCommerce
      */
     this.eCommerce = {
-        /**
-         * Invoke these methods on the mParticle.eCommerce.Cart object.
-         * Example: mParticle.eCommerce.Cart.add(...)
-         * @class mParticle.eCommerce.Cart
-         * @deprecated
-         */
-        Cart: {
-            /**
-             * Adds a product to the cart
-             * @method add
-             * @param {Object} product The product you want to add to the cart
-             * @param {Boolean} [logEventBoolean] Option to log the event to mParticle's servers. If blank, no logging occurs.
-             * @deprecated
-             */
-            add: function(product, logEventBoolean) {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName: 'mPInstance.eCommerce.Cart.add()',
-                        warningMessage: generateDeprecationMessage(
-                            'eCommerce.Cart.add()',
-                            true,
-                            'eCommerce.logProductAction()',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    self.Logger,
-                    self._ErrorReportingDispatcher
-                );
-            },
-            /**
-             * Removes a product from the cart
-             * @method remove
-             * @param {Object} product The product you want to add to the cart
-             * @param {Boolean} [logEventBoolean] Option to log the event to mParticle's servers. If blank, no logging occurs.
-             * @deprecated
-             */
-            remove: function(product, logEventBoolean) {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName: 'mPInstance.eCommerce.Cart.remove()',
-                        warningMessage: generateDeprecationMessage(
-                            'eCommerce.Cart.remove()',
-                            true,
-                            'eCommerce.logProductAction()',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    self.Logger,
-                    self._ErrorReportingDispatcher
-                );
-            },
-            /**
-             * Clears the cart
-             * @method clear
-             * @deprecated
-             */
-            clear: function() {
-                logDeprecatedMethodUsage(
-                    {
-                        methodName: 'mPInstance.eCommerce.Cart.clear()',
-                        warningMessage: generateDeprecationMessage(
-                            'eCommerce.Cart.clear()',
-                            true,
-                            '',
-                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                        ),
-                    },
-                    self.Logger,
-                    self._ErrorReportingDispatcher
-                );
-            },
-        },
         /**
          * Sets the currency code
          * @for mParticle.eCommerce
@@ -967,42 +895,6 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
                 tax
             );
         },
-        /**
-         * Logs a checkout action
-         * @for mParticle.eCommerce
-         * @method logCheckout
-         * @param {Number} step checkout step number
-         * @param {String} checkout option string
-         * @param {Object} attrs
-         * @param {Object} [customFlags] Custom flags for the event
-         * @deprecated
-         */
-        logCheckout: function(step, option, attrs, customFlags) {
-            logDeprecatedMethodUsage(
-                {
-                    methodName: 'mParticle.logCheckout',
-                    warningMessage: 'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead',
-                },
-                self.Logger,
-                self._ErrorReportingDispatcher
-            );
-
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logCheckout(
-                        step,
-                        option,
-                        attrs,
-                        customFlags
-                    );
-                });
-
-                return;
-            }
-
-            self._SessionManager.resetSessionTimer();
-            self._Events.logCheckoutEvent(step, option, attrs, customFlags);
-        },
         /**
          * Logs a product action
          * @for mParticle.eCommerce
@@ -1054,7 +946,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
          * @param {Boolean} [clearCart] boolean to clear the cart after logging or not. Defaults to false
          * @param {Object} [attrs] other attributes related to the product purchase
          * @param {Object} [customFlags] Custom flags for the event
-         * @deprecated
+         * @deprecated Use `logProductAction` with `ProductActionType.Purchase` instead.
          */
         logPurchase: function(
             transactionAttributes,
@@ -1066,7 +958,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             logDeprecatedMethodUsage(
                 {
                     methodName: 'mParticle.logPurchase',
-                    warningMessage: 'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead',
+                    warningMessage: 'mParticle.logPurchase is deprecated, please use mParticle.logProductAction with ProductActionType.Purchase instead',
                 },
                 self.Logger,
                 self._ErrorReportingDispatcher
@@ -1162,52 +1054,6 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
                 eventOptions
             );
         },
-        /**
-         * Logs a refund
-         * @for mParticle.eCommerce
-         * @method logRefund
-         * @param {Object} transactionAttributes transaction attributes related to the refund
-         * @param {Object} product product being refunded
-         * @param {Boolean} [clearCart] boolean to clear the cart after refund is logged. Defaults to false.
-         * @param {Object} [attrs] attributes related to the refund
-         * @param {Object} [customFlags] Custom flags for the event
-         * @deprecated
-         */
-        logRefund: function(
-            transactionAttributes,
-            product,
-            clearCart,
-            attrs,
-            customFlags
-        ) {
-            logDeprecatedMethodUsage(
-                {
-                    methodName: 'mParticle.logRefund',
-                    warningMessage: 'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead',
-                },
-                self.Logger,
-                self._ErrorReportingDispatcher
-            );
-            if (!self._Store.isInitialized) {
-                self.ready(function() {
-                    self.eCommerce.logRefund(
-                        transactionAttributes,
-                        product,
-                        clearCart,
-                        attrs,
-                        customFlags
-                    );
-                });
-                return;
-            }
-            self._SessionManager.resetSessionTimer();
-            self._Events.logRefundEvent(
-                transactionAttributes,
-                product,
-                attrs,
-                customFlags
-            );
-        },
         expandCommerceEvent: function(event) {
             return self._Ecommerce.expandCommerceEvent(event);
         },

package/src/mparticle-instance-manager.ts

@@ -198,20 +198,6 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
         self.getInstance().upload();
     };
     this.eCommerce = {
-        Cart: {
-            add: function(product, logEventBoolean) {
-                self.getInstance().eCommerce.Cart.add(product, logEventBoolean);
-            },
-            remove: function(product, logEventBoolean) {
-                self.getInstance().eCommerce.Cart.remove(
-                    product,
-                    logEventBoolean
-                );
-            },
-            clear: function() {
-                self.getInstance().eCommerce.Cart.clear();
-            },
-        },
         setCurrencyCode: function(code) {
             self.getInstance().eCommerce.setCurrencyCode(code);
         },
@@ -269,14 +255,6 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
                     tax
                 );
         },
-        logCheckout: function(step, options, attrs, customFlags) {
-            self.getInstance().eCommerce.logCheckout(
-                step,
-                options,
-                attrs,
-                customFlags
-            );
-        },
         logProductAction: function(
             productActionType,
             product,
@@ -332,21 +310,6 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
                 eventOptions
             );
         },
-        logRefund: function(
-            transactionAttributes,
-            product,
-            clearCart,
-            attrs,
-            customFlags
-        ) {
-            self.getInstance().eCommerce.logRefund(
-                transactionAttributes,
-                product,
-                clearCart,
-                attrs,
-                customFlags
-            );
-        },
         expandCommerceEvent: function(event) {
             return self.getInstance().eCommerce.expandCommerceEvent(event);
         },

package/src/public-types.ts

@@ -67,7 +67,6 @@ export type {
 // eCommerce
 export type {
     SDKECommerceAPI,
-    SDKCart,
 } from './ecommerce.interfaces';
 
 export type {

package/src/roktManager.ts

@@ -83,6 +83,9 @@ export interface IRoktKit {
     setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
     use: <T>(name: string) => Promise<T>;
     onShoppableAdsReady(callback: () => void): void;
+    // Optional because the Rokt Kit ships on its own release cadence; a kit
+    // published before terminate() existed will not implement it.
+    terminate?: () => Promise<void>;
     launcherOptions?: Dictionary<any>;
     settings?: IRoktKitSettings;
     integrationName?: string;
@@ -479,6 +482,40 @@ export default class RoktManager {
         }
     }
 
+    /**
+     * Tears down the current Rokt launcher and removes the placements it rendered.
+     *
+     * Intended for hosts that cannot simply destroy the container element —
+     * SPA route changes and confirmation pages, for example.
+     *
+     * Unlike the other proxied methods, a call made before the kit is ready is
+     * *not* queued. Replaying a teardown against a launcher created later would
+     * silently tear down placements the caller never asked to remove; with no
+     * launcher there is nothing to terminate, so this resolves as a no-op.
+     *
+     * @example
+     * await window.mParticle.Rokt.terminate();
+     *
+     * @returns {Promise<void>} Resolves once the launcher has torn down. Never rejects.
+     */
+    public async terminate(): Promise<void> {
+        if (!this.isReady()) {
+            this.logger?.verbose('mParticle.Rokt.terminate called before the Rokt kit was ready. Nothing to terminate.');
+            return;
+        }
+
+        if (!isFunction(this.kit.terminate)) {
+            this.logger?.error('mParticle.Rokt.terminate is not supported by the attached Rokt Kit version.');
+            return;
+        }
+
+        try {
+            await this.kit.terminate();
+        } catch (error) {
+            this.logger?.error(`Failed to terminate the Rokt launcher: ${getErrorMessage(error)}`);
+        }
+    }
+
     public onShoppableAdsReady(callback: () => void): void {
         if (!this.kit || !this.isShoppableAdsLoaded) {
             this.deferredCall<void>('onShoppableAdsReady', callback);

package/src/sdkRuntimeModels.ts

@@ -87,7 +87,6 @@ export interface SDKEvent {
     ProductAction?: SDKProductAction;
     PromotionAction?: SDKPromotionAction;
     ProductImpressions?: SDKProductImpression[];
-    ShoppingCart?: SDKShoppingCart;
     UserIdentityChanges?: ISDKUserIdentityChanges;
     UserAttributeChanges?: ISDKUserAttributeChangeData;
     CurrencyCode: string;
@@ -111,10 +110,6 @@ export interface SDKDataPlan {
     PlanId?: string | null;
 }
 
-export interface SDKShoppingCart {
-    ProductList?: SDKProduct[];
-}
-
 export interface SDKPromotionAction {
     PromotionActionType: string;
     PromotionList?: SDKPromotion[];
@@ -340,7 +335,6 @@ export interface SDKInitConfig
     identityUrl?: string;
     integrationDelayTimeout?: number;
     isIOS?: boolean;
-    maxProducts?: number;
     requestConfig?: boolean;
     sessionTimeout?: number;
     useNativeSdk?: boolean;

package/src/sdkToEventsApiConverter.ts

@@ -433,22 +433,6 @@ export function convertImpressions(
     return impressions;
 }
 
-export function convertShoppingCart(
-    sdkEvent: SDKEvent
-): EventsApi.ShoppingCart | null {
-    if (
-        !sdkEvent.ShoppingCart ||
-        !sdkEvent.ShoppingCart.ProductList ||
-        !sdkEvent.ShoppingCart.ProductList.length
-    ) {
-        return null;
-    }
-    const shoppingCart: EventsApi.ShoppingCart = {
-        products: convertProducts(sdkEvent.ShoppingCart.ProductList),
-    };
-    return shoppingCart;
-}
-
 export function convertCommerceEvent(
     sdkEvent: SDKEvent
 ): EventsApi.CommerceEvent {
@@ -460,7 +444,6 @@ export function convertCommerceEvent(
         product_action: convertProductAction(sdkEvent),
         promotion_action: convertPromotionAction(sdkEvent),
         product_impressions: convertImpressions(sdkEvent),
-        shopping_cart: convertShoppingCart(sdkEvent),
         currency_code: sdkEvent.CurrencyCode,
     };
 

package/src/serverModel.ts

@@ -445,15 +445,6 @@ export default function ServerModel(
         if (event.EventDataType === MessageType.Commerce) {
             dto.cu = event.CurrencyCode;
 
-            // TODO: If Cart is deprecated, we should deprecate this too
-            if (event.ShoppingCart) {
-                dto.sc = {
-                    pl: convertProductListToV2DTO(
-                        event.ShoppingCart.ProductList
-                    ),
-                };
-            }
-
             if (event.ProductAction) {
                 dto.pd = {
                     an: event.ProductAction.ProductActionType,

package/src/store.ts

@@ -85,7 +85,6 @@ export interface SDKConfig {
     userAudienceUrl?: string;
     isIOS?: boolean;
     maxAliasWindow: number;
-    maxProducts: number;
     requestConfig?: boolean;
     sessionTimeout?: number;
     timeout?: number;
@@ -375,12 +374,6 @@ export default function Store(
             this.SDKConfig.useCookieStorage = false;
         }
 
-        if (config.hasOwnProperty('maxProducts')) {
-            this.SDKConfig.maxProducts = config.maxProducts;
-        } else {
-            this.SDKConfig.maxProducts = Constants.DefaultConfig.maxProducts;
-        }
-
         if (config.hasOwnProperty('maxCookieSize')) {
             this.SDKConfig.maxCookieSize = config.maxCookieSize;
         } else {

package/src/stub/mparticle.stub.js

@@ -34,14 +34,11 @@ let mParticle = {
         createProduct: returnProduct,
         createPromotion: returnPromotion,
         createTransactionAttributes: returnTransactionAttributes,
-        logCheckout: voidFunction,
         logImpression: voidFunction,
         logProductAction: voidFunction,
         logPromotion: voidFunction,
         logPurchase: voidFunction,
-        logRefund: voidFunction,
         setCurrencyCode: voidFunction,
-        Cart: new Cart(),
     },
     Consent: {
         createConsentState: createConsentState,
@@ -88,7 +85,6 @@ function returnUser() {
         removeAllUserAttributes: voidFunction,
         getUserAttributesLists: returnObject,
         getAllUserAttributes: returnObject,
-        getCart: Cart,
         getConsentState: createConsentState,
         setConsentState: voidFunction,
     };
@@ -98,17 +94,6 @@ function returnUsers() {
     return [returnUser()];
 }
 
-function Cart() {
-    return {
-        add: voidFunction,
-        clear: voidFunction,
-        remove: voidFunction,
-        getCartProducts: function() {
-            return [returnProduct()];
-        },
-    };
-}
-
 function returnImpression() {
     return {
         Name: 'name',