@mparticle/web-sdk 3.17.0 → 3.18.0

package/src/mp-instance.ts

@@ -66,10 +66,7 @@ import {
     PageViewTracker,
     resetPageViewTracking,
 } from './pageViewTracker';
-import {
-    CheckoutIntentTracker,
-    resetCheckoutIntentTracking,
-} from './checkoutIntentTracker';
+import { ButtonTracker, resetButtonTracking } from './buttonTracking/buttonTracker';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -103,7 +100,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _IntegrationCapture: IntegrationCapture;
     _NativeSdkHelpers: INativeSdkHelpers;
     _PageViewTracker?: PageViewTracker;
-    _CheckoutIntentTracker?: CheckoutIntentTracker;
+    _ButtonTracker?: ButtonTracker;
     _Persistence: IPersistence;
     _CookieConsentManager: ICookieConsentManager;
     _ErrorReportingDispatcher: ErrorReportingDispatcher;
@@ -291,10 +288,10 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
     this.reset = function(instance) {
         try {
             instance._Persistence.resetPersistence();
-            // The Rokt manager keeps its own store reference, so stop checkout
-            // intent here rather than relying on the deleted store.
-            resetCheckoutIntentTracking();
-            instance._CheckoutIntentTracker = undefined;
+            // The Rokt manager keeps its own store reference, so stop button
+            // tracking here rather than relying on the deleted store.
+            resetButtonTracking();
+            instance._ButtonTracker = undefined;
             if (instance._Store) {
                 delete instance._Store;
             }
@@ -320,8 +317,8 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
 
         resetPageViewTracking();
         instance._PageViewTracker = undefined;
-        resetCheckoutIntentTracking();
-        instance._CheckoutIntentTracker = undefined;
+        resetButtonTracking();
+        instance._ButtonTracker = undefined;
 
         if (!keepPersistence) {
             instance._Persistence.resetPersistence();
@@ -1145,8 +1142,8 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         self._Store.isEnabled = !isOptingOut;
 
         if (isOptingOut) {
-            if (self._CheckoutIntentTracker) {
-                self._CheckoutIntentTracker.clearPending();
+            if (self._ButtonTracker) {
+                self._ButtonTracker.clearPending();
             }
             self._RoktManager.discardCheckoutIntents();
         }
@@ -1365,7 +1362,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
 function completeSDKInitialization(apiKey, config, mpInstance) {
     const kitBlocker = createKitBlocker(config, mpInstance);
     const { getFeatureFlag } = mpInstance._Helpers;
-    const { AutoLogPageView, CheckoutIntent } = Constants.FeatureFlags;
+    const { AutoLogPageView, AutoButtonTracking } = Constants.FeatureFlags;
 
     // Destroy previous batch uploader to prevent leaked timers and event listeners
     if (mpInstance._APIClient?.uploader) {
@@ -1385,8 +1382,8 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
     // persistence or Identity directly.
     if (mpInstance._Store.webviewBridgeEnabled) {
         mpInstance._NativeSdkHelpers.initializeSessionAttributes(apiKey);
-        // Checkout intent never runs as a native passthrough.
-        resetCheckoutIntentTracking();
+        // Button tracking never runs as a native passthrough.
+        resetButtonTracking();
     } else {
         // Main SDK initialization flow
 
@@ -1497,19 +1494,17 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
             mpInstance._PageViewTracker.teardown();
         }
 
-        // Checkout intent only feeds the Rokt kit, so it listens only when the
-        // workspace opts in and this init configures a Rokt kit.
-        if (getFeatureFlag(CheckoutIntent) && roktConfig) {
-            if (!mpInstance._CheckoutIntentTracker) {
-                mpInstance._CheckoutIntentTracker = new CheckoutIntentTracker(
-                    mpInstance
-                );
+        // Button clicks are logged for any workspace that opts in. Checkout
+        // intent also goes to the Rokt kit when this init configures one.
+        if (getFeatureFlag(AutoButtonTracking)) {
+            if (!mpInstance._ButtonTracker) {
+                mpInstance._ButtonTracker = new ButtonTracker(mpInstance);
             }
-            mpInstance._CheckoutIntentTracker.init();
+            mpInstance._ButtonTracker.init({ hasRoktKit: !!roktConfig });
         } else {
             // Also retires a tracker left by an earlier bundle load. Like APV,
             // this assumes a single active SDK instance.
-            resetCheckoutIntentTracking();
+            resetButtonTracking();
         }
 
         processIdentityCallback(
@@ -1631,8 +1626,8 @@ function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
     mpInstance._LoggingDispatcher.logger = mpInstance.Logger;
     mpInstance._Store = new Store(config, mpInstance, apiKey);
     window.mParticle.Store = mpInstance._Store;
-    // Checkout intent stops until this init's config decides whether it runs.
-    resetCheckoutIntentTracking();
+    // Button tracking stops until this init's config decides whether it runs.
+    resetButtonTracking();
     mpInstance.Logger.verbose(StartingInitialization);
 
     // Initialize CookieConsentManager with privacy flags from launcherOptions

package/src/roktManager.ts

@@ -23,7 +23,7 @@ import { PARTNER_MODULE_IDS } from "./cookieSyncManager";
 import IntegrationCapture from "./integrationCapture";
 import Constants from "./constants";
 import { subscribeToRouteChange } from "./routeChangeMonitor";
-import type { CheckoutIntentKind } from "./checkoutIntentClassifier";
+import type { CheckoutIntentKind } from "./buttonTracking/checkoutIntent";
 
 const PASSBACK_CONVERSION_TRACKING_ID = 'passbackconversiontrackingid';
 const CHECKOUT_INTENT_BUFFER_LIMIT = 4;
@@ -303,7 +303,7 @@ export default class RoktManager {
     // privacy launcher option, or Global Privacy Control.
     public isCheckoutIntentSuppressed(): boolean {
         const flags = this.store?.SDKConfig?.flags;
-        if (!flags || flags[Constants.FeatureFlags.CheckoutIntent] !== true || !this.store.isEnabled) {
+        if (!flags || flags[Constants.FeatureFlags.AutoButtonTracking] !== true || !this.store.isEnabled) {
             return true;
         }
         const options = this.launcherOptions || {};

package/src/store.ts

@@ -153,7 +153,7 @@ export interface IFeatureFlags {
     'captureIntegrationSpecificIds.V2'?: string;
     astBackgroundEvents?: boolean;
     autoLogPageView?: boolean;
-    checkoutIntent?: boolean;
+    autoButtonTracking?: boolean;
 }
 
 // Temporary Interface until Store can be refactored as a class
@@ -778,7 +778,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
         CaptureIntegrationSpecificIdsV2,
         AstBackgroundEvents,
         AutoLogPageView,
-        CheckoutIntent,
+        AutoButtonTracking,
     } = Constants.FeatureFlags;
 
     if (!config.flags) {
@@ -800,7 +800,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
     flags[CaptureIntegrationSpecificIdsV2] = (config.flags[CaptureIntegrationSpecificIdsV2] || 'none');
     flags[AstBackgroundEvents] = config.flags[AstBackgroundEvents] === 'True';
     flags[AutoLogPageView] = config.flags[AutoLogPageView] === 'True';
-    flags[CheckoutIntent] = config.flags[CheckoutIntent] === 'True';
+    flags[AutoButtonTracking] = config.flags[AutoButtonTracking] === 'True';
     return flags;
 }
 

package/dist/types/src/checkoutIntentTracker.d.ts

@@ -1,23 +0,0 @@
-import { IMParticleWebSDKInstance } from './mp-instance';
-export declare const WIN_CIT_KEY = "__mpCit__";
-export declare const getActiveCheckoutIntentTracker: () => CheckoutIntentTracker | undefined;
-export declare const resetCheckoutIntentTracking: () => void;
-export declare class CheckoutIntentTracker {
-    private readonly mpInstance;
-    private active;
-    private generation;
-    private lastCommitClick;
-    private lastSent;
-    constructor(mpInstance: IMParticleWebSDKInstance);
-    get isActive(): boolean;
-    init(): void;
-    teardown(): void;
-    clearPending(): void;
-    private reset;
-    private readonly onPageShow;
-    private readonly onEvent;
-    private observe;
-    private emit;
-    private isSuppressed;
-    private log;
-}

package/src/checkoutIntentTracker.ts

@@ -1,244 +0,0 @@
-import { IMParticleWebSDKInstance } from './mp-instance';
-import {
-    CheckoutIntentKind,
-    classifyIntentControl,
-    classifyIntentFrame,
-} from './checkoutIntentClassifier';
-
-// State lives on `window`, like APV, so a re-executed bundle never doubles the
-// listeners. Inspect `window.__mpCit__` in a console to see if one is live.
-export const WIN_CIT_KEY = '__mpCit__';
-
-const THROTTLE_MS = 2000;
-const SUBMIT_AFTER_COMMIT_CLICK_MS = 1000;
-const PATH_LIMIT = 12;
-
-interface ICitState {
-    tracker?: CheckoutIntentTracker;
-}
-
-type WindowWithCit = Window & {
-    [WIN_CIT_KEY]?: ICitState;
-};
-
-const citWindow = (): WindowWithCit | null =>
-    typeof window === 'undefined' ? null : (window as WindowWithCit);
-
-export const getActiveCheckoutIntentTracker = ():
-    | CheckoutIntentTracker
-    | undefined => {
-    const win = citWindow();
-    const state = win ? win[WIN_CIT_KEY] : undefined;
-    return state ? state.tracker : undefined;
-};
-
-// Stops whichever tracker is active, including one from an earlier bundle load.
-export const resetCheckoutIntentTracking = (): void => {
-    const win = citWindow();
-    if (!win) {
-        return;
-    }
-    const active = getActiveCheckoutIntentTracker();
-    if (active) {
-        active.teardown();
-    }
-    win[WIN_CIT_KEY] = {};
-};
-
-const CAPTURE_PASSIVE: AddEventListenerOptions = {
-    capture: true,
-    passive: true,
-};
-const PASSIVE: AddEventListenerOptions = { passive: true };
-
-// Listens for checkout clicks, submits and wallet frame focus, and hands a
-// frozen {kind, t} to the Rokt kit. No storage, no network, no event logging.
-export class CheckoutIntentTracker {
-    private readonly mpInstance: IMParticleWebSDKInstance;
-    private active = false;
-    // Bumped on reset so classification queued before it is dropped.
-    private generation = 0;
-    private lastCommitClick = -Infinity;
-    private lastSent: { [kind: string]: { t: number; pathname: string } } = {};
-
-    constructor(mpInstance: IMParticleWebSDKInstance) {
-        this.mpInstance = mpInstance;
-    }
-
-    public get isActive(): boolean {
-        return this.active;
-    }
-
-    public init(): void {
-        const win = citWindow();
-        if (!win) {
-            return;
-        }
-
-        const previous = getActiveCheckoutIntentTracker();
-        if (previous) {
-            previous.teardown();
-        }
-        if (this.active) {
-            this.teardown();
-        }
-
-        if (this.isSuppressed()) {
-            this.log('privacy settings suppress checkout intent, not starting');
-            return;
-        }
-
-        win.document.addEventListener('click', this.onEvent, CAPTURE_PASSIVE);
-        win.document.addEventListener('submit', this.onEvent, CAPTURE_PASSIVE);
-        win.addEventListener('blur', this.onEvent, PASSIVE);
-        win.addEventListener('pageshow', this.onPageShow, PASSIVE);
-
-        this.active = true;
-        if (!win[WIN_CIT_KEY]) {
-            win[WIN_CIT_KEY] = {};
-        }
-        win[WIN_CIT_KEY].tracker = this;
-        this.log('listening');
-    }
-
-    public teardown(): void {
-        const win = citWindow();
-        if (win) {
-            win.document.removeEventListener('click', this.onEvent, true);
-            win.document.removeEventListener('submit', this.onEvent, true);
-            win.removeEventListener('blur', this.onEvent);
-            win.removeEventListener('pageshow', this.onPageShow);
-
-            const state = win[WIN_CIT_KEY];
-            if (state && state.tracker === this) {
-                state.tracker = undefined;
-            }
-        }
-        this.active = false;
-        // Signals not yet handed to a kit go with the tracker.
-        this.clearPending();
-    }
-
-    // Drops queued classification, commit timing and buffered signals, so
-    // nothing captured before an opt-out is delivered after an opt-in.
-    public clearPending(): void {
-        this.reset();
-        const roktManager = this.mpInstance._RoktManager;
-        if (roktManager) {
-            roktManager.discardCheckoutIntents();
-        }
-    }
-
-    private reset(): void {
-        this.generation++;
-        this.lastCommitClick = -Infinity;
-        this.lastSent = {};
-    }
-
-    private readonly onPageShow = (event: PageTransitionEvent): void => {
-        // A page restored from the back-forward cache starts fresh.
-        if (event.persisted) {
-            this.reset();
-        }
-    };
-
-    private readonly onEvent = (event: Event): void => {
-        try {
-            this.observe(event);
-        } catch (e) {
-            this.log('[error] event handler threw: ' + e);
-        }
-    };
-
-    private observe(event: Event): void {
-        if (!this.active || !event.isTrusted || this.isSuppressed()) {
-            return;
-        }
-
-        const t = Date.now();
-        const pathname = window.location.pathname;
-        const layer = event.type;
-        // The composed path is only populated during dispatch, so copy it now.
-        const path =
-            layer === 'click' && typeof event.composedPath === 'function'
-                ? event.composedPath().slice(0, PATH_LIMIT)
-                : [];
-        let target: EventTarget | null;
-        if (layer === 'submit') {
-            target = (event as Event & { submitter?: Element | null })
-                .submitter;
-        } else if (layer === 'blur') {
-            // Read after the blur settles: some browsers have not moved focus
-            // into the frame yet when the window blurs.
-            target = null;
-        } else {
-            target = event.target;
-        }
-
-        const generation = this.generation;
-        setTimeout(() => {
-            if (generation !== this.generation) {
-                return;
-            }
-            try {
-                let kind: CheckoutIntentKind | undefined;
-                if (layer === 'blur') {
-                    kind = classifyIntentFrame(document.activeElement, window);
-                } else if (layer === 'submit' && target === null) {
-                    // A form submitted without a submitter only counts right
-                    // after a commit click.
-                    kind =
-                        t - this.lastCommitClick <= SUBMIT_AFTER_COMMIT_CLICK_MS
-                            ? 'commit'
-                            : undefined;
-                } else {
-                    kind = classifyIntentControl(
-                        layer === 'submit' ? [target] : path,
-                        pathname
-                    );
-                }
-                if (kind) {
-                    this.emit(kind, layer, t, pathname);
-                }
-            } catch (e) {
-                this.log('[error] classification threw: ' + e);
-            }
-        }, 0);
-    }
-
-    private emit(
-        kind: CheckoutIntentKind,
-        layer: string,
-        t: number,
-        pathname: string
-    ): void {
-        if (this.isSuppressed()) {
-            return;
-        }
-        if (kind === 'commit' && layer === 'click') {
-            this.lastCommitClick = t;
-        }
-
-        const last = this.lastSent[kind];
-        if (last && last.pathname === pathname && t - last.t < THROTTLE_MS) {
-            return;
-        }
-        this.lastSent[kind] = { t, pathname };
-
-        this.mpInstance._RoktManager.notifyCheckoutIntent(
-            Object.freeze({ kind, t }),
-            pathname
-        );
-    }
-
-    // The Rokt manager owns the privacy gates: flag, opt-out, launcher options
-    // and Global Privacy Control.
-    private isSuppressed(): boolean {
-        const roktManager = this.mpInstance._RoktManager;
-        return !roktManager || roktManager.isCheckoutIntentSuppressed();
-    }
-
-    private log(message: string): void {
-        this.mpInstance.Logger.verbose('mParticle checkout intent: ' + message);
-    }
-}