@mparticle/web-sdk 2.68.0 → 2.70.0

package/src/mp-instance.ts

@@ -16,7 +16,7 @@
 //  Uses portions of code from jQuery
 //  jQuery v1.10.2 | (c) 2005, 2013 jQuery Foundation, Inc. | jquery.org/license
 
-import { EventType, IdentityType, CommerceEventType, PromotionActionType, ProductActionType, MessageType } from './types';
+import { EventType, IdentityType, CommerceEventType, PromotionActionType, ProductActionType, MessageType, RoktEvents } from './types';
 import Constants from './constants';
 import APIClient, { IAPIClient } from './apiClient';
 import Helpers from './helpers';
@@ -55,6 +55,7 @@ import CookieConsentManager, { ICookieConsentManager } from './cookieConsentMana
 import { ErrorReportingDispatcher } from './reporting/errorReportingDispatcher';
 import { LoggingDispatcher } from './reporting/loggingDispatcher';
 import { IErrorReportingService, ILoggingService } from './reporting/types';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -187,6 +188,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
     this.CommerceEventType = CommerceEventType;
     this.PromotionType = PromotionActionType;
     this.ProductActionType = ProductActionType;
+    this.RoktEvents = RoktEvents;
 
 
     this._Identity = new Identity(this);
@@ -772,13 +774,18 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              * @deprecated
              */
             add: function(product, logEventBoolean) {
-                self.Logger.warning(
-                    generateDeprecationMessage(
-                        'eCommerce.Cart.add()',
-                        true,
-                        'eCommerce.logProductAction()',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                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._LoggingDispatcher
                 );
             },
             /**
@@ -789,13 +796,18 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              * @deprecated
              */
             remove: function(product, logEventBoolean) {
-                self.Logger.warning(
-                    generateDeprecationMessage(
-                        'eCommerce.Cart.remove()',
-                        true,
-                        'eCommerce.logProductAction()',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                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._LoggingDispatcher
                 );
             },
             /**
@@ -804,13 +816,18 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
              * @deprecated
              */
             clear: function() {
-                self.Logger.warning(
-                    generateDeprecationMessage(
-                        'eCommerce.Cart.clear()',
-                        true,
-                        '',
-                        'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
-                    )
+                logDeprecatedMethodUsage(
+                    {
+                        methodName: 'mPInstance.eCommerce.Cart.clear()',
+                        warningMessage: generateDeprecationMessage(
+                            'eCommerce.Cart.clear()',
+                            true,
+                            '',
+                            'https://docs.mparticle.com/developers/sdk/web/commerce-tracking'
+                        ),
+                    },
+                    self.Logger,
+                    self._LoggingDispatcher
                 );
             },
         },
@@ -940,8 +957,13 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
          * @deprecated
          */
         logCheckout: function(step, option, attrs, customFlags) {
-            self.Logger.warning(
-                'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead'
+            logDeprecatedMethodUsage(
+                {
+                    methodName: 'mParticle.logCheckout',
+                    warningMessage: 'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead',
+                },
+                self.Logger,
+                self._LoggingDispatcher
             );
 
             if (!self._Store.isInitialized) {
@@ -1020,8 +1042,13 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             attrs,
             customFlags
         ) {
-            self.Logger.warning(
-                'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead'
+            logDeprecatedMethodUsage(
+                {
+                    methodName: 'mParticle.logPurchase',
+                    warningMessage: 'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead',
+                },
+                self.Logger,
+                self._LoggingDispatcher
             );
             if (!self._Store.isInitialized) {
                 self.ready(function() {
@@ -1132,8 +1159,13 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             attrs,
             customFlags
         ) {
-            self.Logger.warning(
-                'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead'
+            logDeprecatedMethodUsage(
+                {
+                    methodName: 'mParticle.logRefund',
+                    warningMessage: 'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead',
+                },
+                self.Logger,
+                self._LoggingDispatcher
             );
             if (!self._Store.isInitialized) {
                 self.ready(function() {
@@ -1741,4 +1773,3 @@ function queueIfNotInitialized(func, self) {
     });
     return true;
 }
-

package/src/mparticle-instance-manager.ts

@@ -1,5 +1,5 @@
 import Polyfill from './polyfill';
-import { CommerceEventType, EventType, IdentityType, PerformanceMarkType, ProductActionType, PromotionActionType } from './types';
+import { CommerceEventType, EventType, IdentityType, PerformanceMarkType, ProductActionType, PromotionActionType, RoktEvents } from './types';
 import Constants from './constants';
 import mParticleInstance, { IMParticleWebSDKInstance } from './mp-instance.js';
 import _BatchValidator from './mockBatchCreator';
@@ -36,6 +36,7 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
     this.CommerceEventType = CommerceEventType;
     this.PromotionType = PromotionActionType;
     this.ProductActionType = ProductActionType;
+    this.RoktEvents = RoktEvents;
 
     this.MPSideloadedKit = MPSideloadedKit;
 

package/src/public-types.ts

@@ -27,6 +27,8 @@ export type {
     ProductActionType,
     PromotionActionType,
     MessageType,
+    RoktEventName,
+    RoktEvents,
 } from './types';
 
 // Configuration

package/src/reporting/deprecatedMethodLogger.ts

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

package/src/reporting/types.ts

@@ -6,6 +6,7 @@ export const ErrorCodes = {
     IDENTITY_REQUEST: 'IDENTITY_REQUEST',
     IDENTITY_MISMATCH: 'IDENTITY_MISMATCH',
     ROKT_KIT_ATTACHED: 'ROKT_KIT_ATTACHED',
+    MP_DEPRECATED_METHOD_USAGE: 'MP_DEPRECATED_METHOD_USAGE',
 } as const;
 
 export type ErrorCodes = valueof<typeof ErrorCodes>;

package/src/sdkRuntimeModels.ts

@@ -39,6 +39,7 @@ import {
     IdentityType,
     ProductActionType,
     PromotionActionType,
+    RoktEvents,
 } from './types';
 import { IPixelConfiguration } from './cookieSyncManager';
 import _BatchValidator from './mockBatchCreator';
@@ -145,6 +146,14 @@ export enum SDKProductActionType {
     Refund = 8,
     AddToWishlist = 9,
     RemoveFromWishlist = 10,
+    ViewCart = 11,
+    AddShippingInfo = 12,
+    AddPaymentInfo = 13,
+    PaymentMethodSelected = 14,
+    PaymentAttempted = 15,
+    PaymentSucceeded = 16,
+    PaymentFailed = 17,
+    RefundInitiated = 18,
 }
 
 export interface SDKProductAction {
@@ -184,6 +193,7 @@ export interface MParticleWebSDK {
     EventType: typeof EventType;
     PromotionType: typeof PromotionActionType;
     ProductActionType: typeof ProductActionType;
+    RoktEvents: typeof RoktEvents;
     Identity: SDKIdentityApi;
     Logger: SDKLoggerApi;
     Consent: SDKConsentApi;

package/src/sessionManager.ts

@@ -6,6 +6,7 @@ import { generateDeprecationMessage } from './utils';
 import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
 import { hasIdentityRequestChanged, hasExplicitIdentifier } from './identity-utils';
+import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 
 const { Messages } = Constants;
 
@@ -67,12 +68,17 @@ export default function SessionManager(
     };
 
     this.getSession = function (): string {
-        mpInstance.Logger.warning(
-            generateDeprecationMessage(
-                'SessionManager.getSession()',
-                false,
-                'SessionManager.getSessionId()'
-            )
+        logDeprecatedMethodUsage(
+            {
+                methodName: 'SessionManager.getSession()',
+                warningMessage: generateDeprecationMessage(
+                    'SessionManager.getSession()',
+                    false,
+                    'SessionManager.getSessionId()'
+                ),
+            },
+            mpInstance.Logger,
+            mpInstance._LoggingDispatcher
         );
         return this.getSessionId();
     };

package/src/stub/mparticle.stub.js

@@ -28,6 +28,7 @@ let mParticle = {
     IdentityType: {},
     ProductActionType: {},
     PromotionType: {},
+    RoktEvents: {},
     eCommerce: {
         createImpression: returnImpression,
         createProduct: returnProduct,

package/src/types.ts

@@ -302,6 +302,20 @@ export const ProductActionType = {
     AddToWishlist: 9 as const,
     RemoveFromWishlist: 10 as const,
 
+    // Rokt Brain commerce-adjacent types
+    ViewCart: 11 as const,
+    AddShippingInfo: 12 as const,
+    AddPaymentInfo: 13 as const,
+    PaymentMethodSelected: 14 as const,
+    PaymentAttempted: 15 as const,
+    PaymentSucceeded: 16 as const,
+    PaymentFailed: 17 as const,
+    RefundInitiated: 18 as const,
+
+    isRoktCommerceType: (id: number): boolean => {
+        return id >= ProductActionType.ViewCart && id <= ProductActionType.RefundInitiated;
+    },
+
     getName: (id: number): string => {
         switch (id) {
             case ProductActionType.AddToCart:
@@ -324,6 +338,22 @@ export const ProductActionType = {
                 return 'Add to Wishlist';
             case ProductActionType.RemoveFromWishlist:
                 return 'Remove from Wishlist';
+            case ProductActionType.ViewCart:
+                return 'View Cart';
+            case ProductActionType.AddShippingInfo:
+                return 'Add Shipping Info';
+            case ProductActionType.AddPaymentInfo:
+                return 'Add Payment Info';
+            case ProductActionType.PaymentMethodSelected:
+                return 'Payment Method Selected';
+            case ProductActionType.PaymentAttempted:
+                return 'Payment Attempted';
+            case ProductActionType.PaymentSucceeded:
+                return 'Payment Succeeded';
+            case ProductActionType.PaymentFailed:
+                return 'Payment Failed';
+            case ProductActionType.RefundInitiated:
+                return 'Refund Initiated';
             default:
                 return 'Unknown';
         }
@@ -352,12 +382,56 @@ export const ProductActionType = {
                 return 'add_to_wishlist';
             case ProductActionType.RemoveFromWishlist:
                 return 'remove_from_wishlist';
+            case ProductActionType.ViewCart:
+                return 'view_cart';
+            case ProductActionType.AddShippingInfo:
+                return 'add_shipping_info';
+            case ProductActionType.AddPaymentInfo:
+                return 'add_payment_info';
+            case ProductActionType.PaymentMethodSelected:
+                return 'payment_method_selected';
+            case ProductActionType.PaymentAttempted:
+                return 'payment_attempted';
+            case ProductActionType.PaymentSucceeded:
+                return 'payment_succeeded';
+            case ProductActionType.PaymentFailed:
+                return 'payment_failed';
+            case ProductActionType.RefundInitiated:
+                return 'refund_initiated';
             default:
                 return '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 const RoktEvents = {
+    SignUp: 'sign_up' as const,
+    Subscribe: 'subscribe' as const,
+    StartTrial: 'start_trial' as const,
+    GenerateLead: 'generate_lead' as const,
+    Search: 'search' as const,
+    Upsell: 'upsell' as const,
+    EarnVirtualCurrency: 'earn_virtual_currency' as const,
+    DwellTime: 'dwell_time' as const,
+    Hover: 'hover' as const,
+    Scroll: 'scroll' as const,
+    ClickToExpand: 'click_to_expand' as const,
+};
+
 export const PromotionActionType = {
     Unknown: 0 as const,
     PromotionView: 1 as const,
@@ -544,5 +618,6 @@ export default {
     ApplicationTransitionType,
     ProductActionType,
     PromotionActionType,
+    RoktEvents,
     Environment: Constants.Environment,
 } as const;