@mparticle/web-sdk 2.68.0 → 2.70.0

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

@@ -2,7 +2,7 @@ export default function Ecommerce(mpInstance: any): void;
 export default class Ecommerce {
     constructor(mpInstance: any);
     convertTransactionAttributesToProductAction: (transactionAttributes: any, productAction: any) => void;
-    getProductActionEventName: (productActionType: any) => "AddToCart" | "AddToWishlist" | "Checkout" | "CheckoutOption" | "Click" | "Purchase" | "Refund" | "RemoveFromCart" | "RemoveFromWishlist" | "ViewDetail" | "Unknown";
+    getProductActionEventName: (productActionType: any) => "AddToCart" | "AddToWishlist" | "Checkout" | "CheckoutOption" | "Click" | "Purchase" | "Refund" | "RemoveFromCart" | "RemoveFromWishlist" | "ViewDetail" | "ViewCart" | "AddShippingInfo" | "AddPaymentInfo" | "PaymentMethodSelected" | "PaymentAttempted" | "PaymentSucceeded" | "PaymentFailed" | "RefundInitiated" | "Unknown";
     getPromotionActionEventName: (promotionActionType: any) => "Unknown" | "PromotionClick" | "PromotionView";
     convertProductActionToEventType: (productActionType: any) => 0 | 20 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 21;
     convertPromotionActionToEventType: (promotionActionType: any) => 18 | 19;

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

@@ -7,7 +7,6 @@ export default class Forwarders {
     isEnabledForUnknownUser: (excludeAnonymousUserBoolean: any, user: any) => boolean;
     applyToForwarders: (functionName: any, functionArgs: any) => void;
     sendEventToForwarders: (event: any) => void;
-    sendBatchToForwarders: (batch: any) => void;
     handleForwarderUserAttributes: (functionNameKey: any, key: any, value: any) => void;
     setForwarderUserIdentities: (userIdentities: any) => void;
     setForwarderOnUserIdentified: (user: any) => void;

package/dist/types/src/public-types.d.ts

@@ -13,7 +13,7 @@
  * natively defined in this SDK and the DT package is deprecated.
  */
 export type { Batch, } from '@mparticle/event-models';
-export type { EventType, CommerceEventType, IdentityType, ProductActionType, PromotionActionType, MessageType, } from './types';
+export type { EventType, CommerceEventType, IdentityType, ProductActionType, PromotionActionType, MessageType, RoktEventName, RoktEvents, } from './types';
 export type { SDKInitConfig, DataPlanConfig, BaseEvent, SDKEventCustomFlags, LogLevelType, MParticleWebSDK, } from './sdkRuntimeModels';
 export type { IMParticleUser, IdentityCallback, IdentityResult, IdentityResultBody, IdentityModifyResultBody, ISDKUserIdentity, ISDKUserAttributes, } from './identity-user-interfaces';
 export type { SDKIdentityApi, IAliasRequest, IAliasCallback, IAliasResult, SDKIdentityTypeEnum, IIdentitySearchResult, IIdentitySearchResponseBody, IdentitySearchCallback, IUserIdentities } from './identity.interfaces';

package/dist/types/src/reporting/deprecatedMethodLogger.d.ts

@@ -0,0 +1,8 @@
+import { ILoggingService } from './types';
+import { SDKLoggerApi } from '../sdkRuntimeModels';
+interface DeprecatedMethodUsage {
+    methodName: string;
+    warningMessage: string;
+}
+export declare function logDeprecatedMethodUsage(usage: DeprecatedMethodUsage, logger: Pick<SDKLoggerApi, 'warning'>, loggingDispatcher: ILoggingService | undefined): void;
+export {};

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

@@ -5,6 +5,7 @@ export declare const ErrorCodes: {
     readonly IDENTITY_REQUEST: "IDENTITY_REQUEST";
     readonly IDENTITY_MISMATCH: "IDENTITY_MISMATCH";
     readonly ROKT_KIT_ATTACHED: "ROKT_KIT_ATTACHED";
+    readonly MP_DEPRECATED_METHOD_USAGE: "MP_DEPRECATED_METHOD_USAGE";
 };
 export type ErrorCodes = valueof<typeof ErrorCodes>;
 export declare const WSDKErrorSeverity: {

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

@@ -11,7 +11,7 @@ import { ISessionManager } from './sessionManager';
 import { ConfiguredKit, MPForwarder, UnregisteredKit } from './forwarders.interfaces';
 import { SDKIdentityApi, IAliasCallback } from './identity.interfaces';
 import { ISDKUserAttributeChangeData, ISDKUserIdentityChanges, IMParticleUser, ISDKUserIdentity, IdentityCallback, ISDKUserAttributes } from './identity-user-interfaces';
-import { CommerceEventType, EventType, IdentityType, ProductActionType, PromotionActionType } from './types';
+import { CommerceEventType, EventType, IdentityType, ProductActionType, PromotionActionType, RoktEvents } from './types';
 import { IPixelConfiguration } from './cookieSyncManager';
 import _BatchValidator from './mockBatchCreator';
 import { SDKECommerceAPI } from './ecommerce.interfaces';
@@ -103,7 +103,15 @@ export declare enum SDKProductActionType {
     Purchase = 7,
     Refund = 8,
     AddToWishlist = 9,
-    RemoveFromWishlist = 10
+    RemoveFromWishlist = 10,
+    ViewCart = 11,
+    AddShippingInfo = 12,
+    AddPaymentInfo = 13,
+    PaymentMethodSelected = 14,
+    PaymentAttempted = 15,
+    PaymentSucceeded = 16,
+    PaymentFailed = 17,
+    RefundInitiated = 18
 }
 export interface SDKProductAction {
     ProductActionType: SDKProductActionType;
@@ -137,6 +145,7 @@ export interface MParticleWebSDK {
     EventType: typeof EventType;
     PromotionType: typeof PromotionActionType;
     ProductActionType: typeof ProductActionType;
+    RoktEvents: typeof RoktEvents;
     Identity: SDKIdentityApi;
     Logger: SDKLoggerApi;
     Consent: SDKConsentApi;

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

@@ -29,6 +29,7 @@ declare namespace mParticle {
     export let IdentityType: {};
     export let ProductActionType: {};
     export let PromotionType: {};
+    export let RoktEvents: {};
     export namespace eCommerce {
         export { returnImpression as createImpression };
         export { returnProduct as createProduct };

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

@@ -53,8 +53,31 @@ export declare const ProductActionType: {
     Refund: 8;
     AddToWishlist: 9;
     RemoveFromWishlist: 10;
+    ViewCart: 11;
+    AddShippingInfo: 12;
+    AddPaymentInfo: 13;
+    PaymentMethodSelected: 14;
+    PaymentAttempted: 15;
+    PaymentSucceeded: 16;
+    PaymentFailed: 17;
+    RefundInitiated: 18;
+    isRoktCommerceType: (id: number) => boolean;
     getName: (id: number) => string;
-    getExpansionName: (id: number) => "add_to_cart" | "remove_from_cart" | "checkout" | "checkout_option" | "click" | "view_detail" | "purchase" | "refund" | "add_to_wishlist" | "remove_from_wishlist" | "unknown";
+    getExpansionName: (id: number) => "add_to_cart" | "remove_from_cart" | "checkout" | "checkout_option" | "click" | "view_detail" | "purchase" | "refund" | "add_to_wishlist" | "remove_from_wishlist" | "view_cart" | "add_shipping_info" | "add_payment_info" | "payment_method_selected" | "payment_attempted" | "payment_succeeded" | "payment_failed" | "refund_initiated" | "unknown";
+};
+export type RoktEventName = 'sign_up' | 'subscribe' | 'start_trial' | 'generate_lead' | 'search' | 'upsell' | 'earn_virtual_currency' | 'dwell_time' | 'hover' | 'scroll' | 'click_to_expand' | (string & {});
+export declare const RoktEvents: {
+    SignUp: "sign_up";
+    Subscribe: "subscribe";
+    StartTrial: "start_trial";
+    GenerateLead: "generate_lead";
+    Search: "search";
+    Upsell: "upsell";
+    EarnVirtualCurrency: "earn_virtual_currency";
+    DwellTime: "dwell_time";
+    Hover: "hover";
+    Scroll: "scroll";
+    ClickToExpand: "click_to_expand";
 };
 export declare const PromotionActionType: {
     Unknown: 0;
@@ -139,8 +162,17 @@ declare const _default: {
         Refund: 8;
         AddToWishlist: 9;
         RemoveFromWishlist: 10;
+        ViewCart: 11;
+        AddShippingInfo: 12;
+        AddPaymentInfo: 13;
+        PaymentMethodSelected: 14;
+        PaymentAttempted: 15;
+        PaymentSucceeded: 16;
+        PaymentFailed: 17;
+        RefundInitiated: 18;
+        isRoktCommerceType: (id: number) => boolean;
         getName: (id: number) => string;
-        getExpansionName: (id: number) => "add_to_cart" | "remove_from_cart" | "checkout" | "checkout_option" | "click" | "view_detail" | "purchase" | "refund" | "add_to_wishlist" | "remove_from_wishlist" | "unknown";
+        getExpansionName: (id: number) => "add_to_cart" | "remove_from_cart" | "checkout" | "checkout_option" | "click" | "view_detail" | "purchase" | "refund" | "add_to_wishlist" | "remove_from_wishlist" | "view_cart" | "add_shipping_info" | "add_payment_info" | "payment_method_selected" | "payment_attempted" | "payment_succeeded" | "payment_failed" | "refund_initiated" | "unknown";
     };
     readonly PromotionActionType: {
         Unknown: 0;
@@ -149,6 +181,19 @@ declare const _default: {
         getName: (id: number) => string;
         getExpansionName: (id: number) => string;
     };
+    readonly RoktEvents: {
+        SignUp: "sign_up";
+        Subscribe: "subscribe";
+        StartTrial: "start_trial";
+        GenerateLead: "generate_lead";
+        Search: "search";
+        Upsell: "upsell";
+        EarnVirtualCurrency: "earn_virtual_currency";
+        DwellTime: "dwell_time";
+        Hover: "hover";
+        Scroll: "scroll";
+        ClickToExpand: "click_to_expand";
+    };
     readonly Environment: {
         readonly Development: "development";
         readonly Production: "production";

package/package.json

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

package/src/batchUploader.ts

@@ -368,18 +368,6 @@ export class BatchUploader {
                     mpInstance
                 );
 
-                if (uploadBatchObject) {
-                    try {
-                        mpInstance._Forwarders.sendBatchToForwarders(
-                            uploadBatchObject
-                        );
-                    } catch (e) {
-                        mpInstance.Logger.error(
-                            `Error forwarding batch to kits. ${e}`
-                        );
-                    }
-                }
-
                 const onCreateBatchCallback =
                     mpInstance._Store.SDKConfig.onCreateBatch;
 

package/src/consent.ts

@@ -9,6 +9,7 @@ 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;
 
@@ -505,8 +506,13 @@ export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInst
 
         // TODO: Can we remove this? It is deprecated.
         function removeCCPAState(this: ConsentState) {
-            mpInstance.Logger.warning(
-                'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead'
+            logDeprecatedMethodUsage(
+                {
+                    methodName: 'Consent.removeCCPAState',
+                    warningMessage: 'removeCCPAState is deprecated and will be removed in a future release; use removeCCPAConsentState instead',
+                },
+                mpInstance.Logger,
+                mpInstance._LoggingDispatcher
             );
             // @ts-ignore
             return removeCCPAConsentState();

package/src/ecommerce.js

@@ -69,6 +69,22 @@ export default function Ecommerce(mpInstance) {
                 return 'RemoveFromWishlist';
             case Types.ProductActionType.ViewDetail:
                 return 'ViewDetail';
+            case Types.ProductActionType.ViewCart:
+                return 'ViewCart';
+            case Types.ProductActionType.AddShippingInfo:
+                return 'AddShippingInfo';
+            case Types.ProductActionType.AddPaymentInfo:
+                return 'AddPaymentInfo';
+            case Types.ProductActionType.PaymentMethodSelected:
+                return 'PaymentMethodSelected';
+            case Types.ProductActionType.PaymentAttempted:
+                return 'PaymentAttempted';
+            case Types.ProductActionType.PaymentSucceeded:
+                return 'PaymentSucceeded';
+            case Types.ProductActionType.PaymentFailed:
+                return 'PaymentFailed';
+            case Types.ProductActionType.RefundInitiated:
+                return 'RefundInitiated';
             case Types.ProductActionType.Unknown:
             default:
                 return 'Unknown';
@@ -113,6 +129,18 @@ export default function Ecommerce(mpInstance) {
 
             case Types.ProductActionType.ViewDetail:
                 return Types.CommerceEventType.ProductViewDetail;
+
+            // Rokt Brain commerce-adjacent types map to Unknown on server
+            case Types.ProductActionType.ViewCart:
+            case Types.ProductActionType.AddShippingInfo:
+            case Types.ProductActionType.AddPaymentInfo:
+            case Types.ProductActionType.PaymentMethodSelected:
+            case Types.ProductActionType.PaymentAttempted:
+            case Types.ProductActionType.PaymentSucceeded:
+            case Types.ProductActionType.PaymentFailed:
+            case Types.ProductActionType.RefundInitiated:
+                return Types.EventType.Unknown;
+
             default:
                 mpInstance.Logger.error(
                     'Could not convert product action type ' +

package/src/events.js

@@ -174,6 +174,13 @@ export default function Events(mpInstance) {
                 ProductList: productList,
             };
 
+            if (Types.ProductActionType.isRoktCommerceType(productActionType)) {
+                event.CustomFlags = event.CustomFlags || {};
+                event.CustomFlags[
+                    'Rokt.CommerceEventType'
+                ] = Types.ProductActionType.getExpansionName(productActionType);
+            }
+
             if (mpInstance._Helpers.isObject(transactionAttributes)) {
                 mpInstance._Ecommerce.convertTransactionAttributesToProductAction(
                     transactionAttributes,

package/src/forwarders.js

@@ -8,9 +8,6 @@ import {
     isBlockedByEventFilter,
     filterEventAttributes,
     filterUserIdentities,
-    isBatchEventAllowed,
-    filterBatchEventAttributes,
-    filterBatchIdentities,
 } from './forwarder-utils';
 
 const { Modify, Identify, Login, Logout } = Constants.IdentityMethods;
@@ -266,61 +263,6 @@ export default function Forwarders(mpInstance, kitBlocker) {
         }
     };
 
-    this.sendBatchToForwarders = function(batch) {
-        if (
-            mpInstance._Store.webviewBridgeEnabled ||
-            !mpInstance._Store.activeForwarders
-        ) {
-            return;
-        }
-
-        for (const forwarder of mpInstance._Store.activeForwarders) {
-            if (!forwarder.processBatch) {
-                continue;
-            }
-
-            try {
-                const batchCopy = extend(true, {}, batch);
-
-                if (batchCopy.events) {
-                    batchCopy.events = batchCopy.events.filter(function(
-                        batchEvent
-                    ) {
-                        return isBatchEventAllowed(batchEvent, forwarder);
-                    });
-
-                    batchCopy.events.forEach(function(batchEvent) {
-                        filterBatchEventAttributes(batchEvent, forwarder);
-                    });
-                }
-
-                batchCopy.user_identities = filterBatchIdentities(
-                    batchCopy.user_identities,
-                    forwarder.userIdentityFilters
-                );
-
-                if (batchCopy.user_attributes) {
-                    batchCopy.user_attributes = KitFilterHelper.filterUserAttributes(
-                        batchCopy.user_attributes,
-                        forwarder.userAttributeFilters
-                    );
-                }
-
-                if (!batchCopy.events || batchCopy.events.length === 0) {
-                    continue;
-                }
-
-                const result = forwarder.processBatch(batchCopy);
-
-                if (result) {
-                    mpInstance.Logger.verbose(result);
-                }
-            } catch (e) {
-                mpInstance.Logger.verbose(e);
-            }
-        }
-    };
-
     this.handleForwarderUserAttributes = function(functionNameKey, key, value) {
         if (
             (kitBlocker && kitBlocker.isAttributeKeyBlocked(key)) ||

package/src/identity.js

@@ -20,6 +20,7 @@ import {
 } from './utils';
 import { hasMPIDAndUserLoginChanged, hasMPIDChanged } from './user-utils';
 import { processReadyQueue } from './pre-init-utils';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 export default function Identity(mpInstance) {
     const { getFeatureFlag, extend } = mpInstance._Helpers;
@@ -1252,8 +1253,14 @@ export default function Identity(mpInstance) {
              * @return a cart object
              */
             getCart: function() {
-                mpInstance.Logger.warning(
-                    'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases'
+                logDeprecatedMethodUsage(
+                    {
+                        methodName: 'Identity.getCurrentUser().getCart()',
+                        warningMessage:
+                            'Deprecated function Identity.getCurrentUser().getCart() will be removed in future releases',
+                    },
+                    mpInstance.Logger,
+                    mpInstance._LoggingDispatcher
                 );
                 return self.mParticleUserCart();
             },
@@ -1334,13 +1341,18 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             add: function() {
-                mpInstance.Logger.warning(
-                    generateDeprecationMessage(
-                        'Identity.getCurrentUser().getCart().add()',
-                        true,
-                        'eCommerce.logProductAction()',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                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._LoggingDispatcher
                 );
             },
             /**
@@ -1349,13 +1361,19 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             remove: function() {
-                mpInstance.Logger.warning(
-                    generateDeprecationMessage(
-                        'Identity.getCurrentUser().getCart().remove()',
-                        true,
-                        'eCommerce.logProductAction()',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                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._LoggingDispatcher
                 );
             },
             /**
@@ -1364,13 +1382,19 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             clear: function() {
-                mpInstance.Logger.warning(
-                    generateDeprecationMessage(
-                        'Identity.getCurrentUser().getCart().clear()',
-                        true,
-                        '',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                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._LoggingDispatcher
                 );
             },
             /**
@@ -1380,13 +1404,19 @@ export default function Identity(mpInstance) {
              * @deprecated
              */
             getCartProducts: function() {
-                mpInstance.Logger.warning(
-                    generateDeprecationMessage(
-                        'Identity.getCurrentUser().getCart().getCartProducts()',
-                        true,
-                        'eCommerce.logProductAction()',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                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._LoggingDispatcher
                 );
                 return [];
             },
@@ -1540,7 +1570,8 @@ export default function Identity(mpInstance) {
                     prevUser,
                     newUser,
                     identityApiData,
-                    mpInstance.Logger
+                    mpInstance.Logger,
+                    mpInstance._LoggingDispatcher
                 );
 
                 const persistence = mpInstance._Persistence.getPersistence();
@@ -1775,14 +1806,27 @@ export default function Identity(mpInstance) {
 }
 
 // https://go.mparticle.com/work/SQDSDKS-6359
-function tryOnUserAlias(previousUser, newUser, identityApiData, logger) {
+function tryOnUserAlias(
+    previousUser,
+    newUser,
+    identityApiData,
+    logger,
+    loggingDispatcher
+) {
     if (
         identityApiData &&
         identityApiData.onUserAlias &&
         isFunction(identityApiData.onUserAlias)
     ) {
         try {
-            logger.warning(generateDeprecationMessage('onUserAlias'));
+            logDeprecatedMethodUsage(
+                {
+                    methodName: 'onUserAlias',
+                    warningMessage: generateDeprecationMessage('onUserAlias'),
+                },
+                logger,
+                loggingDispatcher
+            );
             identityApiData.onUserAlias(previousUser, newUser);
         } catch (e) {
             logger.error(