@mparticle/web-sdk 3.30.0 → 3.32.0

package/src/buttonTracking/checkoutIntent.ts

@@ -96,7 +96,7 @@ const steps = new RegExp(
             'ir a caja|continuar al pago|tramitar pedido',
             "procedi al checkout|procedi all'acquisto|procedi al pagamento|vai alla cassa",
             'afrekenen|verder naar betalen|doorgaan naar betalen',
-            'レジに進む|ご?(?:購入|注文)手続き(?:へ|に)(?:進む)?|お?支払い(?:へ|に)進む|(?:ご注文内容の)?確認画面へ(?:進む)?',
+            'レジに進む|ご?(?:購入|注文)手続き(?:(?:へ|に)(?:進む)?)?|お?支払い(?:へ|に)進む|(?:ご注文内容の)?確認画面へ(?:進む)?',
         ].join('|') +
         ')$'
 );
@@ -280,7 +280,34 @@ export type CheckoutIntentSource =
     | 'frame'
     | 'submit'
     | 'name'
-    | 'api';
+    | 'api'
+    | 'selector';
+
+// CSS selectors a kit supplies for the page's own confirm and checkout-step
+// buttons. A control matching one counts as that kind before any label rule,
+// except that a confirm, wallet or add-to-cart label beats a checkout-step
+// selector.
+export interface ICheckoutIntentSelectors {
+    commit?: readonly string[];
+    checkout_step?: readonly string[];
+}
+
+// A selector the browser can't parse is skipped rather than thrown.
+function matchesAnySelector(
+    control: Element,
+    selectors: readonly string[] | undefined
+): boolean {
+    if (!selectors) {
+        return false;
+    }
+    return selectors.some(selector => {
+        try {
+            return control.matches(selector);
+        } catch (e) {
+            return false;
+        }
+    });
+}
 
 export interface ICheckoutIntent {
     kind: Exclude<CheckoutIntentKind, 'frame'>;
@@ -328,13 +355,17 @@ function isCommitLabel(text: string, isLink: boolean, pathname: string, control:
 
 // Classifies a clicked or submitting control found by findControl, in order:
 // pickers, toggles and pay-later messages never count; a vendor's own wallet
-// button counts before any label rule; a confirm label on any source counts
-// before the look-alike exclusions veto; then a wallet-named control, wallet
-// phrases and steps. An add-to-cart label, links included, or a control that
-// opens the cart on the page counts only where none of those do.
+// button keeps its vendor kind; a control matching a kit-supplied commit
+// selector counts as a commit before any label rule, and one matching a
+// checkout-step selector as a step unless its labels make it a confirm, a
+// wallet or an add-to-cart click; a confirm label on any source
+// counts before the look-alike exclusions veto; then a wallet-named control,
+// wallet phrases and steps. An add-to-cart label, links included, or a control
+// that opens the cart on the page counts only where none of those do.
 export function classifyIntent(
     control: Element,
-    pathname: string
+    pathname: string,
+    selectors?: ICheckoutIntentSelectors
 ): ICheckoutIntent | undefined {
     const vendor = vendorButtonKind(control);
     if (vendor === 'none') {
@@ -345,6 +376,30 @@ export function classifyIntent(
             ? undefined
             : { kind: vendor, source: 'vendor' };
     }
+    if (selectors && !isQuietIntentControl(control, false)) {
+        if (matchesAnySelector(control, selectors.commit)) {
+            return { kind: 'commit', source: 'selector' };
+        }
+        if (matchesAnySelector(control, selectors.checkout_step)) {
+            // A confirm, wallet or add-to-cart label still wins, so a class those
+            // buttons share with a step button can't turn their clicks into steps.
+            const byLabel = classifyLabels(control, pathname);
+            return byLabel &&
+                (byLabel.kind === 'commit' ||
+                    byLabel.kind === 'wallet' ||
+                    byLabel.adds === true)
+                ? byLabel
+                : { kind: 'checkout_step', source: 'selector' };
+        }
+    }
+    return classifyLabels(control, pathname);
+}
+
+// The label rules, read once the vendor and selector checks have passed.
+function classifyLabels(
+    control: Element,
+    pathname: string
+): ICheckoutIntent | undefined {
     const texts = labels(control);
     const cores = texts.map(coreLabel);
     const cartAction = cartControlAction(control, cores);

package/src/ecommerce.ts

@@ -369,7 +369,7 @@ export default function Ecommerce(
             );
             return null;
         } else {
-            price = mpInstance._Helpers.parseNumber(price);
+            price = parseNumber(price);
         }
 
         if (position && !mpInstance._Helpers.Validators.isNumber(position)) {
@@ -382,7 +382,7 @@ export default function Ecommerce(
         if (!mpInstance._Helpers.Validators.isStringOrNumber(quantity)) {
             quantity = 1;
         } else {
-            quantity = mpInstance._Helpers.parseNumber(quantity);
+            quantity = parseNumber(quantity);
         }
 
         return {
@@ -680,6 +680,6 @@ export default function Ecommerce(
         }
 
         // if amount is a string, it will be parsed into a number if possible, or set to 0
-        return mpInstance._Helpers.parseNumber(amount);
+        return parseNumber(amount);
     };
 }

package/src/events.ts

@@ -20,7 +20,7 @@ import {
     SDKEventOptions,
     TransactionAttributes,
 } from '@mparticle/web-sdk';
-import { getHref, valueof } from './utils';
+import { getHref, valueof, isObject } from './utils';
 import {
     allowedQueryParams,
     autoPageViewAttribute,
@@ -242,7 +242,7 @@ export default function Events(
                 );
             }
 
-            if (mpInstance._Helpers.isObject(transactionAttributes)) {
+            if (isObject(transactionAttributes)) {
                 mpInstance._Ecommerce.convertTransactionAttributesToProductAction(
                     transactionAttributes,
                     event.ProductAction

package/src/forwarders.ts

@@ -1,7 +1,7 @@
 import filteredMparticleUser, {
     isIdentityAllowed,
 } from './filteredMparticleUser';
-import { isEmpty, extend, hasOwnProp, Dictionary } from './utils';
+import { isEmpty, extend, hasOwnProp, Dictionary, isObject } from './utils';
 import KitFilterHelper from './kitFilterHelper';
 import Constants from './constants';
 import APIClient, { IForwardingStatsData } from './apiClient';
@@ -197,7 +197,7 @@ export default function Forwarders(
     ): boolean {
         if (
             !filterObject ||
-            !mpInstance._Helpers.isObject(filterObject) ||
+            !isObject(filterObject) ||
             !Object.keys(filterObject).length
         ) {
             return true;
@@ -212,7 +212,7 @@ export default function Forwarders(
         try {
             const hasUserAttributes =
                 userAttributes &&
-                mpInstance._Helpers.isObject(userAttributes) &&
+                isObject(userAttributes) &&
                 Object.keys(userAttributes).length > 0;
 
             const isMatch = hasUserAttributes

package/src/identity.ts

@@ -20,6 +20,7 @@ import {
     isReservedStoredPropertyName,
     isFunction,
     isObject,
+    findKeyInObject,
 } from './utils';
 import { getIdentityTypeFromStoredKey } from './types';
 import { hasMPIDAndUserLoginChanged, hasMPIDChanged } from './user-utils';
@@ -990,7 +991,7 @@ export default function Identity(
                         let previousUserAttributeValue;
                         let isNewAttribute;
 
-                        const existingProp = mpInstance._Helpers.findKeyInObject(
+                        const existingProp = findKeyInObject(
                             userAttributes,
                             key
                         );
@@ -1080,7 +1081,7 @@ export default function Identity(
 
                     userAttributes = this.getAllUserAttributes();
 
-                    const existingProp = mpInstance._Helpers.findKeyInObject(
+                    const existingProp = findKeyInObject(
                         userAttributes,
                         key
                     );
@@ -1157,7 +1158,7 @@ export default function Identity(
                     let isNewAttribute;
                     let userAttributeChange;
 
-                    const existingProp = mpInstance._Helpers.findKeyInObject(
+                    const existingProp = findKeyInObject(
                         userAttributes,
                         key
                     );

package/src/internal-types.ts

@@ -35,6 +35,7 @@ export type {
     IRoktKitSettings,
     IRoktKit,
     ICheckoutIntentSignal,
+    ICheckoutIntentSelectors,
     IRoktOptions,
     IRoktLauncherOptions,
 } from './roktManager';

package/src/kitBlocking.ts

@@ -4,6 +4,7 @@ import { BaseEvent, EventTypeEnum, CommerceEvent, ScreenViewEvent, CustomEvent }
 import Types from './types'
 import { DataPlanPoint } from '@mparticle/data-planning-models';
 import { IMParticleWebSDKInstance } from './mp-instance';
+import { isObject, parseNumber } from './utils';
 
 /*  
     TODO: Including this as a workaround because attempting to import it from
@@ -476,7 +477,7 @@ export default class KitBlocker {
         const clonedEvent = {...event};
         if (this.blockUserAttributes) {
             const matchedAttributes = this.dataPlanMatchLookups['user_attributes'];
-            if (this.mpInstance._Helpers.isObject(matchedAttributes) && clonedEvent.UserAttributes) {
+            if (isObject(matchedAttributes) && clonedEvent.UserAttributes) {
                 const plannedUserAttributes = {};
                 for (const ua of Object.keys(clonedEvent.UserAttributes)) {
                     if (matchedAttributes[ua] === true) {
@@ -545,11 +546,11 @@ export default class KitBlocker {
 
         if (this.blockUserIdentities) {
             const matchedIdentities = this.dataPlanMatchLookups['user_identities'];
-            if (this.mpInstance._Helpers.isObject(matchedIdentities)) {
+            if (isObject(matchedIdentities)) {
                 if (clonedEvent?.UserIdentities?.length) {
                     clonedEvent.UserIdentities = clonedEvent.UserIdentities.filter(uiByType => {
                         const identityName = Types.IdentityType.getIdentityName(
-                            this.mpInstance._Helpers.parseNumber(uiByType.Type)
+                            parseNumber(uiByType.Type)
                         );
 
                         return matchedIdentities[identityName];

package/src/mp-instance.ts

@@ -39,7 +39,7 @@ import Consent, { IConsent } from './consent';
 import KitBlocker from './kitBlocking';
 import ConfigAPIClient, { IKitConfigs } from './configAPIClient';
 import IdentityAPIClient, { IIdentityApiClient } from './identityApiClient';
-import { isFunction, parseConfig, valueof, generateDeprecationMessage, extend } from './utils';
+import { isFunction, parseConfig, valueof, generateDeprecationMessage, extend, findKeyInObject, isObject } from './utils';
 import { DisabledVault, LocalStorageVault } from './vault';
 import { removeExpiredIdentityCacheDates, hasExplicitIdentifier } from './identity-utils';
 import IntegrationCapture, { isIntegrationCaptureEnabled } from './integrationCapture';
@@ -703,7 +703,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
                     hostname: window.location.hostname,
                     title: window.document.title,
                 };
-            } else if (!self._Helpers.isObject(attrs)) {
+            } else if (!isObject(attrs)) {
                 self.Logger.error(
                     'The attributes argument must be an object. A ' +
                         typeof attrs +
@@ -711,7 +711,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
                 );
                 return;
             }
-            if (customFlags && !self._Helpers.isObject(customFlags)) {
+            if (customFlags && !isObject(customFlags)) {
                 self.Logger.error(
                     'The customFlags argument must be an object. A ' +
                         typeof customFlags +
@@ -1108,7 +1108,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
                     JSON.stringify({ key: key, value: value })
                 );
             } else {
-                const existingProp = self._Helpers.findKeyInObject(
+                const existingProp = findKeyInObject(
                     self._Store.sessionAttributes,
                     key
                 );
@@ -1190,7 +1190,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         }
         if (attrs === null) {
             self._Store.integrationAttributes[integrationId] = {};
-        } else if (self._Helpers.isObject(attrs)) {
+        } else if (isObject(attrs)) {
             if (Object.keys(attrs).length === 0) {
                 self._Store.integrationAttributes[integrationId] = {};
             } else {
@@ -1198,7 +1198,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
                     if (typeof key === 'string') {
                         if (typeof attrs[key] === 'string') {
                             if (
-                                self._Helpers.isObject(
+                                isObject(
                                     self._Store.integrationAttributes[
                                         integrationId
                                     ]

package/src/persistence.ts

@@ -5,7 +5,7 @@ import { IMParticleWebSDKInstance } from './mp-instance';
 import { IPersistence, IPersistenceMinified } from './persistence.interfaces';
 import { MPID } from '@mparticle/web-sdk';
 import { CookieSyncDates } from './cookieSyncManager';
-import { Dictionary } from './utils';
+import { Dictionary, isObject } from './utils';
 import { IMParticleInstanceManager } from './sdkRuntimeModels';
 
 const Base64 = Polyfill.Base64,
@@ -370,7 +370,7 @@ export default function _Persistence(
             return null;
         }
         const record = JSON.parse(decoded);
-        return mpInstance._Helpers.isObject(record) &&
+        return isObject(record) &&
             Object.keys(record).length
             ? (record as IPersistenceMinified)
             : null;
@@ -737,7 +737,7 @@ export default function _Persistence(
         if (Array.isArray(value)) {
             return value.length > 0;
         }
-        if (!mpInstance._Helpers.isObject(value)) {
+        if (!isObject(value)) {
             return false;
         }
         return Object.keys(value).length > 0;
@@ -773,7 +773,7 @@ export default function _Persistence(
     function encodeMpidBase64Field(container, key: string): void {
         const value = container[key];
         if (
-            mpInstance._Helpers.isObject(value) &&
+            isObject(value) &&
             Object.keys(value).length
         ) {
             container[key] = Base64.encode(JSON.stringify(value));
@@ -855,7 +855,7 @@ export default function _Persistence(
                 continue;
             }
             if (!SDKv2NonMPIDCookieKeys[mpid]) {
-                if (!mpInstance._Helpers.isObject(persistence[mpid])) {
+                if (!isObject(persistence[mpid])) {
                     delete persistence[mpid];
                     continue;
                 }
@@ -881,7 +881,7 @@ export default function _Persistence(
                 Utils.revertCookieString(persistenceString)
             ) as IPersistenceMinified;
             if (
-                mpInstance._Helpers.isObject(persistence) &&
+                isObject(persistence) &&
                 Object.keys(persistence).length
             ) {
                 decodeGlobalSettings(persistence.gs);
@@ -935,7 +935,7 @@ export default function _Persistence(
         if (csd) {
             let persistence = self.getPersistence();
             if (persistence) {
-                if (mpInstance._Helpers.isObject(persistence[mpid])) {
+                if (isObject(persistence[mpid])) {
                     persistence[mpid].csd = csd;
                 } else {
                     persistence[mpid] = {
@@ -1053,7 +1053,7 @@ export default function _Persistence(
         }
         let persistence = self.getPersistence();
         if (persistence) {
-            if (!mpInstance._Helpers.isObject(persistence[mpid])) {
+            if (!isObject(persistence[mpid])) {
                 persistence[mpid] = {};
             }
             if (!persistence[mpid].fst) {
@@ -1093,7 +1093,7 @@ export default function _Persistence(
             time = new Date().getTime();
         }
         let persistence = self.getPersistence();
-        if (persistence && mpInstance._Helpers.isObject(persistence[mpid])) {
+        if (persistence && isObject(persistence[mpid])) {
             persistence[mpid].lst = time;
             self.savePersistence(persistence);
         }

package/src/reporting/types.ts

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

package/src/roktManager.ts

@@ -23,7 +23,8 @@ import { PARTNER_MODULE_IDS } from "./cookieSyncManager";
 import IntegrationCapture from "./integrationCapture";
 import Constants from "./constants";
 import { subscribeToRouteChange } from "./routeChangeMonitor";
-import type { CheckoutIntentKind, CheckoutIntentSource, PaymentFrameFamily } from "./buttonTracking/checkoutIntent";
+import type { CheckoutIntentKind, CheckoutIntentSource, ICheckoutIntentSelectors, PaymentFrameFamily } from "./buttonTracking/checkoutIntent";
+export type { ICheckoutIntentSelectors } from "./buttonTracking/checkoutIntent";
 
 const PASSBACK_CONVERSION_TRACKING_ID = 'passbackconversiontrackingid';
 // One signal per kind (commit, wallet, checkout_step, frame and cart), with an
@@ -123,6 +124,9 @@ export interface IRoktKit {
     onRouteChange?: () => void;
     // Set by the kit only when it wants checkout intent signals.
     onCheckoutIntent?: (signal: ICheckoutIntentSignal) => void;
+    // Set by the kit when its config names the page's confirm or checkout-step
+    // buttons. Older kits leave it unset, and the label rules apply alone.
+    checkoutIntentSelectors?: ICheckoutIntentSelectors;
     // Set by the kit only when it wants payment picks.
     onPaymentPick?: (signal: IPaymentPickSignal) => void;
     launcherOptions?: Dictionary<any>;
@@ -415,6 +419,13 @@ export default class RoktManager {
         }
     }
 
+    // Read at click time, so selectors from a kit that attaches later apply to
+    // the next click.
+    public getCheckoutIntentSelectors(): ICheckoutIntentSelectors | undefined {
+        const kit = this.kit;
+        return kit ? kit.checkoutIntentSelectors : undefined;
+    }
+
     public discardCheckoutIntents(): void {
         this.pendingCheckoutIntents = [];
     }
@@ -484,11 +495,19 @@ export default class RoktManager {
     public async selectPlacements(options: IRoktSelectPlacementsOptions): Promise<IRoktSelection> {
         this.captureTiming?.(PerformanceMarkType.JointSdkSelectPlacements);
         
-        // Queue if kit isn't ready OR if identity is in flight
-        if (!this.isReady() || this.store?.identityCallInFlight) {
+        if (!this.isReady()) {
             return this.deferredCall<IRoktSelection>('selectPlacements', options);
         }
 
+        // Like the iOS and Android SDKs, this does not wait for an identity request, so the
+        // selection can go out for the user from before it. The log counts how often that happens.
+        if (this.store?.identityCallInFlight) {
+            this.loggingService?.log({
+                message: 'RoktManager: selectPlacements ran while an identity request was in flight',
+                code: ErrorCodes.SELECT_PLACEMENTS_IDENTITY_IN_FLIGHT,
+            });
+        }
+
         try {
             const { attributes } = options;
             const sandboxValue = attributes?.sandbox || null;
@@ -570,10 +589,6 @@ export default class RoktManager {
                                 );
                             }
                             this.setUserAttributes(result?.getUser?.(), userAttributes, newIdentities);
-                            // Drain any selectPlacements calls that were deferred while
-                            // identify was in-flight. By the time this callback fires,
-                            // identityCallInFlight has already been reset to false.
-                            this.processMessageQueue();
                         }
                     );
                 } catch (error) {
@@ -896,7 +911,6 @@ export default class RoktManager {
     public onIdentityComplete(): void {
         if (this.isReady()) {
             this.currentUser = this.identityService.getCurrentUser();
-            // Process any queued selectPlacements calls that were waiting for identity
             this.processMessageQueue();
         }
     }