@mparticle/web-sdk 2.67.0 → 2.69.0

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 {
@@ -161,9 +170,9 @@ export interface SDKProductAction {
 }
 
 export interface SDKProduct {
-    Sku?: string;
-    Name?: string;
-    Price?: number;
+    Sku: string;
+    Name: string;
+    Price: number;
     Quantity?: number;
     Brand?: string;
     Variant?: string;
@@ -173,7 +182,7 @@ export interface SDKProduct {
     TotalAmount?: number;
 
     // https://go.mparticle.com/work/SQDSDKS-4801
-    Attributes?: Record<string, unknown> | null;
+    Attributes?: Record<string, unknown>;
 }
 
 // https://go.mparticle.com/work/SQDSDKS-6949
@@ -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;
@@ -306,7 +316,7 @@ export const LogLevelType = {
 // Currently, this extends MPConfiguration in @types/mparticle__web-sdk
 // and the two will be merged in once the Store module is refactored
 export interface SDKInitConfig
-    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel'> {
+    extends Omit<MPConfiguration, 'dataPlan' | 'logLevel' | 'identityCallback'> {
     dataPlan?: DataPlanConfig | KitBlockerDataPlan; // TODO: These should be eventually split into two different attributes
     logLevel?: LogLevelType;
 

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

@@ -205,6 +205,10 @@ export const IdentityType = {
                 return IdentityType.PhoneNumber2;
             case 'phone_number_3':
                 return IdentityType.PhoneNumber3;
+            case 'email_sha256':
+                return IdentityType.Other;
+            case 'mobile_sha256':
+                return IdentityType.Other2;
             default:
                 return false;
         }
@@ -298,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:
@@ -320,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';
         }
@@ -348,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,
@@ -540,5 +618,6 @@ export default {
     ApplicationTransitionType,
     ProductActionType,
     PromotionActionType,
+    RoktEvents,
     Environment: Constants.Environment,
 } as const;