@mparticle/web-sdk 3.25.0 → 3.26.0

package/dist/mparticle.js

@@ -204,7 +204,7 @@ var mParticle = (function () {
       Base64: Base64$1
     };
 
-    var version = "3.25.0";
+    var version = "3.26.0";
 
     var Constants = {
       sdkVersion: version,
@@ -10881,8 +10881,9 @@ var mParticle = (function () {
     }
 
     var PASSBACK_CONVERSION_TRACKING_ID = 'passbackconversiontrackingid';
-    // One signal per kind (commit, wallet, checkout_step, frame and cart), so a new kind never evicts another.
-    var 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.
+    var CHECKOUT_INTENT_BUFFER_LIMIT = 6;
     var CHECKOUT_INTENT_MAX_AGE_MS = 30000;
     var ON_SHOPPABLE_ADS_READY_METHOD = 'onShoppableAdsReady';
     // The purpose of this class is to create a link between the Core mParticle SDK and the
@@ -11085,8 +11086,10 @@ var mParticle = (function () {
         }
         var 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(function (pending) {
-            return pending.signal.kind !== signal.kind;
+            return pending.signal.kind !== signal.kind || !!pending.signal.adds !== !!signal.adds;
           }).concat({
             signal: signal,
             pathname: pathname
@@ -12729,17 +12732,17 @@ var mParticle = (function () {
     // does. Only the cart rule reads the title. Opening the cart counts only for a
     // control that opens it on the page, such as a flyout: one that leads to the cart
     // page unloads before a call made on the click can return.
-    function isCartControl(control, cores) {
+    function cartControlAction(control, cores) {
       var title = cores.length ? undefined : normalize(control.getAttribute('title'));
       var texts = title ? [coreLabel(title)] : cores;
       if (texts.some(function (text) {
         return addToCartLabels.test(text);
       })) {
-        return true;
+        return 'add';
       }
       return (control.hasAttribute('aria-expanded') || control.hasAttribute('aria-haspopup')) && texts.some(function (text) {
         return openCartLabels.test(text);
-      });
+      }) ? 'open' : undefined;
     }
     // "Buy now" and "Purchase" count only on a checkout route, and never on a plain
     // link, which is navigation.
@@ -12768,10 +12771,20 @@ var mParticle = (function () {
       }
       var texts = labels(control);
       var cores = texts.map(coreLabel);
-      var cart = isCartControl(control, cores) ? {
-        kind: 'cart',
-        source: 'label'
-      } : undefined;
+      var cartAction = cartControlAction(control, cores);
+      var cart;
+      if (cartAction === 'add') {
+        cart = {
+          kind: 'cart',
+          source: 'label',
+          adds: true
+        };
+      } else if (cartAction === 'open') {
+        cart = {
+          kind: 'cart',
+          source: 'label'
+        };
+      }
       if (isQuietIntentControl(control, false, !!cart)) {
         return undefined;
       }
@@ -13005,8 +13018,9 @@ var mParticle = (function () {
       passive: true
     };
     // Logs button clicks and clicks on links that leave the page as mParticle events, and hands checkout
-    // intent to the Rokt kit as a frozen {kind, t, source, pathname}. Submits and wallet frame focus feed the kit only,
-    // and so do payment picks: a payment radio's option names, or the payment family of a focused frame.
+    // intent to the Rokt kit as a frozen {kind, t, source, pathname}, with adds on an add-to-cart click.
+    // Submits and wallet frame focus feed the kit only, and so do payment picks: a payment radio's option
+    // names, or the payment family of a focused frame.
     var ButtonTracker = /** @class */function () {
       function ButtonTracker(mpInstance) {
         var _this = this;
@@ -13206,6 +13220,7 @@ var mParticle = (function () {
         var box;
         var kind;
         var source;
+        var adds;
         var choice;
         var family;
         var unconfirmedCommit = false;
@@ -13234,6 +13249,7 @@ var mParticle = (function () {
             var intent = signalsKit ? classifyIntent(control, pathname) : undefined;
             kind = intent ? intent.kind : undefined;
             source = intent ? intent.source : undefined;
+            adds = intent ? intent.adds : undefined;
             choice = signalsKit ? describePaymentChoice(control, path) : undefined;
           }
           this.lastClick = {
@@ -13254,6 +13270,7 @@ var mParticle = (function () {
             var intent = classifyIntent(control, pathname);
             kind = intent ? intent.kind : undefined;
             source = intent ? intent.source : undefined;
+            adds = intent ? intent.adds : undefined;
           }
           unconfirmedCommit = !submitter;
         }
@@ -13292,7 +13309,7 @@ var mParticle = (function () {
               _this.pickPayment(t, pathname, undefined, family);
             }
             if (kind) {
-              _this.emit(kind, source, layer, t, pathname);
+              _this.emit(kind, source, layer, t, pathname, adds);
             }
           } catch (e) {
             _this.log('[error] delivery threw: ' + e);
@@ -13355,22 +13372,31 @@ var mParticle = (function () {
         }
         this.uploadHeld = false;
       };
-      ButtonTracker.prototype.emit = function (kind, source, layer, t, pathname) {
+      ButtonTracker.prototype.emit = function (kind, source, layer, t, pathname, adds) {
         if (this.isKitSuppressed()) {
           return;
         }
         if (kind === 'commit' && layer === 'click') {
           this.lastCommitClick = t;
         }
-        var last = this.lastSent[kind];
+        // An add-to-cart click throttles apart from a click that opens the
+        // cart, so opening the cart first never drops the add.
+        var key = adds ? kind + ':adds' : kind;
+        var last = this.lastSent[key];
         if (last && last.pathname === pathname && t - last.t < THROTTLE_MS) {
           return;
         }
-        this.lastSent[kind] = {
+        this.lastSent[key] = {
           t: t,
           pathname: pathname
         };
-        this.mpInstance._RoktManager.notifyCheckoutIntent(Object.freeze({
+        this.mpInstance._RoktManager.notifyCheckoutIntent(Object.freeze(adds ? {
+          kind: kind,
+          t: t,
+          source: source,
+          pathname: pathname,
+          adds: adds
+        } : {
           kind: kind,
           t: t,
           source: source,

package/dist/types/src/buttonTracking/checkoutIntent.d.ts

@@ -4,6 +4,7 @@ export type CheckoutIntentSource = 'vendor' | 'label' | 'brand' | 'frame' | 'sub
 export interface ICheckoutIntent {
     kind: Exclude<CheckoutIntentKind, 'frame'>;
     source: CheckoutIntentSource;
+    adds?: true;
 }
 export declare function classifyIntent(control: Element, pathname: string): ICheckoutIntent | undefined;
 export declare function classifyIntentControl(control: Element, pathname: string): Exclude<CheckoutIntentKind, 'frame'> | undefined;

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

@@ -49,6 +49,7 @@ export interface ICheckoutIntentSignal {
     t: number;
     source?: CheckoutIntentSource;
     pathname?: string;
+    adds?: true;
 }
 export interface IPaymentPickSignal {
     t: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "3.25.0",
+    "version": "3.26.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [

package/src/buttonTracking/buttonTracker.ts

@@ -149,8 +149,9 @@ const CAPTURE_PASSIVE: AddEventListenerOptions = {
 const PASSIVE: AddEventListenerOptions = { passive: true };
 
 // Logs button clicks and clicks on links that leave the page as mParticle events, and hands checkout
-// intent to the Rokt kit as a frozen {kind, t, source, pathname}. Submits and wallet frame focus feed the kit only,
-// and so do payment picks: a payment radio's option names, or the payment family of a focused frame.
+// intent to the Rokt kit as a frozen {kind, t, source, pathname}, with adds on an add-to-cart click.
+// Submits and wallet frame focus feed the kit only, and so do payment picks: a payment radio's option
+// names, or the payment family of a focused frame.
 export class ButtonTracker {
     private readonly mpInstance: IMParticleWebSDKInstance;
     private active = false;
@@ -399,6 +400,7 @@ export class ButtonTracker {
         let box: HTMLInputElement | undefined;
         let kind: CheckoutIntentKind | undefined;
         let source: CheckoutIntentSource | undefined;
+        let adds: true | undefined;
         let choice: IPaymentChoice | undefined;
         let family: PaymentFrameFamily | undefined;
         let unconfirmedCommit = false;
@@ -441,6 +443,7 @@ export class ButtonTracker {
                     : undefined;
                 kind = intent ? intent.kind : undefined;
                 source = intent ? intent.source : undefined;
+                adds = intent ? intent.adds : undefined;
                 choice = signalsKit
                     ? describePaymentChoice(control, path)
                     : undefined;
@@ -459,6 +462,7 @@ export class ButtonTracker {
                 const intent = classifyIntent(control, pathname);
                 kind = intent ? intent.kind : undefined;
                 source = intent ? intent.source : undefined;
+                adds = intent ? intent.adds : undefined;
             }
             unconfirmedCommit = !submitter;
         }
@@ -507,7 +511,7 @@ export class ButtonTracker {
                     this.pickPayment(t, pathname, undefined, family);
                 }
                 if (kind) {
-                    this.emit(kind, source, layer, t, pathname);
+                    this.emit(kind, source, layer, t, pathname, adds);
                 }
             } catch (e) {
                 this.log('[error] delivery threw: ' + e);
@@ -591,7 +595,8 @@ export class ButtonTracker {
         source: CheckoutIntentSource | undefined,
         layer: string,
         t: number,
-        pathname: string
+        pathname: string,
+        adds?: true
     ): void {
         if (this.isKitSuppressed()) {
             return;
@@ -600,14 +605,21 @@ export class ButtonTracker {
             this.lastCommitClick = t;
         }
 
-        const last = this.lastSent[kind];
+        // An add-to-cart click throttles apart from a click that opens the
+        // cart, so opening the cart first never drops the add.
+        const key = adds ? kind + ':adds' : kind;
+        const last = this.lastSent[key];
         if (last && last.pathname === pathname && t - last.t < THROTTLE_MS) {
             return;
         }
-        this.lastSent[kind] = { t, pathname };
+        this.lastSent[key] = { t, pathname };
 
         this.mpInstance._RoktManager.notifyCheckoutIntent(
-            Object.freeze({ kind, t, source, pathname }),
+            Object.freeze(
+                adds
+                    ? { kind, t, source, pathname, adds }
+                    : { kind, t, source, pathname }
+            ),
             pathname
         );
     }

package/src/buttonTracking/checkoutIntent.ts

@@ -230,16 +230,16 @@ function labels(element: Element): string[] {
 // does. Only the cart rule reads the title. Opening the cart counts only for a
 // control that opens it on the page, such as a flyout: one that leads to the cart
 // page unloads before a call made on the click can return.
-function isCartControl(control: Element, cores: string[]): boolean {
+function cartControlAction(control: Element, cores: string[]): 'add' | 'open' | undefined {
     const title = cores.length ? undefined : normalize(control.getAttribute('title'));
     const texts = title ? [coreLabel(title)] : cores;
     if (texts.some(text => addToCartLabels.test(text))) {
-        return true;
+        return 'add';
     }
-    return (
-        (control.hasAttribute('aria-expanded') || control.hasAttribute('aria-haspopup')) &&
+    return (control.hasAttribute('aria-expanded') || control.hasAttribute('aria-haspopup')) &&
         texts.some(text => openCartLabels.test(text))
-    );
+        ? 'open'
+        : undefined;
 }
 
 // Which rule recognised the intent: a vendor's own markup, a phrase in the
@@ -258,6 +258,8 @@ export type CheckoutIntentSource =
 export interface ICheckoutIntent {
     kind: Exclude<CheckoutIntentKind, 'frame'>;
     source: CheckoutIntentSource;
+    // Set on a cart click that puts something in the cart, not one that opens it.
+    adds?: true;
 }
 
 // "Buy now" and "Purchase" count only on a checkout route, and never on a plain
@@ -294,9 +296,13 @@ export function classifyIntent(
     }
     const texts = labels(control);
     const cores = texts.map(coreLabel);
-    const cart: ICheckoutIntent | undefined = isCartControl(control, cores)
-        ? { kind: 'cart', source: 'label' }
-        : undefined;
+    const cartAction = cartControlAction(control, cores);
+    let cart: ICheckoutIntent | undefined;
+    if (cartAction === 'add') {
+        cart = { kind: 'cart', source: 'label', adds: true };
+    } else if (cartAction === 'open') {
+        cart = { kind: 'cart', source: 'label' };
+    }
     if (isQuietIntentControl(control, false, !!cart)) {
         return undefined;
     }

package/src/roktManager.ts

@@ -26,8 +26,9 @@ import { subscribeToRouteChange } from "./routeChangeMonitor";
 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,8 @@ 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
@@ -375,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;