add Rokt.CommerceEventType custom flag and isRoktCommerceType helper for new commerce event types

Author: jaissica12

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/types.ts

@@ -312,6 +312,10 @@ export const ProductActionType = {
     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:

test/jest/types.spec.ts

@@ -615,6 +615,40 @@ describe('ProductActionType', () => {
             expect(ProductActionType.getExpansionName(NaN)).toBe('unknown');
         });
     });
+
+    describe('#isRoktCommerceType', () => {
+        it('returns true for Rokt Brain commerce types (11-18)', () => {
+            expect(ProductActionType.isRoktCommerceType(ViewCart)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(AddShippingInfo)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(AddPaymentInfo)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(PaymentMethodSelected)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(PaymentAttempted)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(PaymentSucceeded)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(PaymentFailed)).toBe(true);
+            expect(ProductActionType.isRoktCommerceType(RefundInitiated)).toBe(true);
+        });
+
+        it('returns false for standard mParticle commerce types (0-10)', () => {
+            expect(ProductActionType.isRoktCommerceType(Unknown)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(AddToCart)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(RemoveFromCart)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(Checkout)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(CheckoutOption)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(Click)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(ViewDetail)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(Purchase)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(Refund)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(AddToWishlist)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(RemoveFromWishlist)).toBe(false);
+        });
+
+        it('returns false for out-of-range values', () => {
+            expect(ProductActionType.isRoktCommerceType(-1)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(19)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(100)).toBe(false);
+            expect(ProductActionType.isRoktCommerceType(NaN)).toBe(false);
+        });
+    });
 });
 
 describe('RoktEvents', () => {

test/src/tests-mparticle-instance-manager.ts

@@ -50,6 +50,7 @@ describe('mParticle instance manager', () => {
                 'PaymentSucceeded',
                 'PaymentFailed',
                 'RefundInitiated',
+                'isRoktCommerceType',
                 'getName',
                 'getExpansionName',
             ]