feat: add Rokt Brain event type constants (#1269)

Author: jaissica12

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 ' +

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,

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';
@@ -188,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);

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;
 

src/public-types.ts

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

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;

src/stub/mparticle.stub.js

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

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;