@mparticle/web-sdk 3.24.0 → 3.26.0

package/src/roktLauncherOptions.ts

@@ -5,6 +5,7 @@ export interface IRoktLauncherOptions extends Dictionary<any> {
     noDeviceID?: boolean;
     noFunctional?: boolean;
     noTargeting?: boolean;
+    doNotShareOrSell?: boolean;
     sessionId?: string;
     sessionToken?: string;
 }

package/src/roktManager.ts

@@ -23,11 +23,12 @@ import { PARTNER_MODULE_IDS } from "./cookieSyncManager";
 import IntegrationCapture from "./integrationCapture";
 import Constants from "./constants";
 import { subscribeToRouteChange } from "./routeChangeMonitor";
-import type { CheckoutIntentKind, CheckoutIntentSource } from "./buttonTracking/checkoutIntent";
+import type { CheckoutIntentKind, CheckoutIntentSource, PaymentFrameFamily } from "./buttonTracking/checkoutIntent";
 
 const PASSBACK_CONVERSION_TRACKING_ID = 'passbackconversiontrackingid';
-// One signal per kind (commit, wallet, checkout_step, frame and cart), so a new kind never evicts another.
-const CHECKOUT_INTENT_BUFFER_LIMIT = 5;
+// One signal per kind (commit, wallet, checkout_step, frame and cart), with an
+// add-to-cart click apart from a cart open, so a new one never evicts another.
+const CHECKOUT_INTENT_BUFFER_LIMIT = 6;
 const CHECKOUT_INTENT_MAX_AGE_MS = 30000;
 
 type AttributeTargetUser = Pick<IMParticleUser, 'getUserIdentities' | 'setUserAttributes'>;
@@ -83,6 +84,19 @@ export interface ICheckoutIntentSignal {
     t: number;
     source?: CheckoutIntentSource;
     pathname?: string;
+    // On a cart click that puts something in the cart. Older kits ignore it.
+    adds?: true;
+}
+
+// What a kit receives when the shopper picks a payment method: the names of a
+// payment radio's option, masked like a label, or the payment family of a
+// frame the shopper moved into. It is handed over in memory only: the kit
+// keeps the family it reads and nothing of the names.
+export interface IPaymentPickSignal {
+    t: number;
+    pathname: string;
+    names?: readonly string[];
+    family?: PaymentFrameFamily;
 }
 
 export interface IRoktKitSettings {
@@ -109,6 +123,8 @@ export interface IRoktKit {
     onRouteChange?: () => void;
     // Set by the kit only when it wants checkout intent signals.
     onCheckoutIntent?: (signal: ICheckoutIntentSignal) => void;
+    // Set by the kit only when it wants payment picks.
+    onPaymentPick?: (signal: IPaymentPickSignal) => void;
     launcherOptions?: Dictionary<any>;
     settings?: IRoktKitSettings;
     integrationName?: string;
@@ -315,6 +331,18 @@ export default class RoktManager {
         this.autoButtonClicksForwarded = forwarded;
     }
 
+    // noTargeting (which noDeviceId implies), doNotShareOrSell or Global Privacy
+    // Control. Unlike noFunctional, these also stop auto button and link clicks
+    // from being logged.
+    public hasTargetingOptOut(): boolean {
+        const options = this.launcherOptions || {};
+        if (options.noTargeting || options.doNotShareOrSell) {
+            return true;
+        }
+        const nav = typeof navigator === 'undefined' ? undefined : (navigator as Navigator & { globalPrivacyControl?: boolean });
+        return !!nav && nav.globalPrivacyControl === true;
+    }
+
     // Checkout intent is off unless the flag is on, and under opt-out, any Rokt
     // privacy launcher option, Global Privacy Control, or a Rokt connection that
     // does not receive auto button clicks.
@@ -328,12 +356,7 @@ export default class RoktManager {
         ) {
             return true;
         }
-        const options = this.launcherOptions || {};
-        if (options.noFunctional || options.noTargeting || options.doNotShareOrSell) {
-            return true;
-        }
-        const nav = typeof navigator === 'undefined' ? undefined : (navigator as Navigator & { globalPrivacyControl?: boolean });
-        return !!nav && nav.globalPrivacyControl === true;
+        return !!this.launcherOptions?.noFunctional || this.hasTargetingOptOut();
     }
 
     // True when the kit can wait for the shopper's confirm click: signals are not
@@ -355,8 +378,14 @@ export default class RoktManager {
 
         const kit = this.kit;
         if (!kit) {
+            // One per kind, with an add-to-cart click kept apart from a
+            // click that opens the cart.
             this.pendingCheckoutIntents = this.pendingCheckoutIntents
-                .filter(pending => pending.signal.kind !== signal.kind)
+                .filter(
+                    pending =>
+                        pending.signal.kind !== signal.kind ||
+                        !!pending.signal.adds !== !!signal.adds
+                )
                 .concat({ signal, pathname })
                 .slice(-CHECKOUT_INTENT_BUFFER_LIMIT);
             return;
@@ -377,6 +406,26 @@ export default class RoktManager {
         this.pendingCheckoutIntents = [];
     }
 
+    // Under the same gates as checkout intent. A pick made before a kit
+    // attaches is not kept: the shopper is still choosing, and the next pick
+    // replaces it.
+    public notifyPaymentPick(signal: IPaymentPickSignal): void {
+        if (this.isCheckoutIntentSuppressed()) {
+            return;
+        }
+
+        const kit = this.kit;
+        try {
+            if (kit && isFunction(kit.onPaymentPick)) {
+                kit.onPaymentPick(signal);
+            }
+        } catch (e) {
+            this.logger?.error(
+                `RoktManager: Error in onPaymentPick: ${getErrorMessage(e)}`
+            );
+        }
+    }
+
     // Replays recent buffered signals raised on the current page, oldest first.
     private flushCheckoutIntents(): void {
         const pending = this.pendingCheckoutIntents;

package/src/store.ts

@@ -159,6 +159,7 @@ export interface IFeatureFlags {
     astBackgroundEvents?: boolean;
     autoLogPageView?: boolean;
     autoButtonTracking?: boolean;
+    autoLinkTracking?: boolean;
 }
 
 // Temporary Interface until Store can be refactored as a class
@@ -793,6 +794,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
         AstBackgroundEvents,
         AutoLogPageView,
         AutoButtonTracking,
+        AutoLinkTracking,
     } = Constants.FeatureFlags;
 
     if (!config.flags) {
@@ -815,6 +817,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
     flags[AstBackgroundEvents] = config.flags[AstBackgroundEvents] === 'True';
     flags[AutoLogPageView] = config.flags[AutoLogPageView] === 'True';
     flags[AutoButtonTracking] = config.flags[AutoButtonTracking] === 'True';
+    flags[AutoLinkTracking] = config.flags[AutoLinkTracking] === 'True';
     return flags;
 }