@mparticle/web-sdk 3.22.0 → 3.24.0

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

@@ -1,5 +1,9 @@
+import { IKitFilterSettings } from '../configAPIClient';
+import type KitBlocker from '../kitBlocking';
 import { BaseEvent } from '../sdkRuntimeModels';
 import { IButtonClick } from './buttonDescription';
 export declare const AUTO_BUTTON_ATTRIBUTE = "is_auto_button_click";
 export declare const BUTTON_CLICK_EVENT_NAME = "Auto Button Click";
 export declare const buildButtonClickEvent: (click: IButtonClick, pathname: string) => BaseEvent;
+export type ButtonClickBlocker = 'data plan' | 'forwarding rule' | 'event name filter' | 'event type filter';
+export declare const getButtonClickBlocker: (forwarder: IKitFilterSettings, kitBlocker?: KitBlocker) => ButtonClickBlocker | undefined;

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

@@ -1,6 +1,6 @@
 export type ButtonElementKind = 'button' | 'input' | 'role' | 'wallet' | 'link';
 export type LinkType = 'same_page' | 'outbound' | 'download';
-export type ButtonLabelSource = 'labelledby' | 'aria' | 'text' | 'label' | 'alt' | 'title' | 'value' | 'none';
+export type ButtonLabelSource = 'labelledby' | 'aria' | 'text' | 'alt' | 'title' | 'value' | 'none';
 export interface IButtonClick {
     label?: string;
     labelSource: ButtonLabelSource;
@@ -18,4 +18,4 @@ export interface IButtonClick {
     fileExtension?: string;
     checked?: boolean;
 }
-export declare function describeButtonClick(control: Element): IButtonClick | undefined;
+export declare function describeButtonClick(control: Element, path?: Array<EventTarget | null>): IButtonClick | undefined;

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

@@ -11,6 +11,7 @@ export declare class ButtonTracker {
     private hasRoktKit;
     private generation;
     private lastCommitClick;
+    private lastClick;
     private lastSent;
     private pagePath;
     private pageEvents;
@@ -21,6 +22,7 @@ export declare class ButtonTracker {
     constructor(mpInstance: IMParticleWebSDKInstance);
     get isActive(): boolean;
     init(options: IButtonTrackerOptions): void;
+    onApplePayBegin(): void;
     teardown(): void;
     clearPending(): void;
     private reset;

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

@@ -1,5 +1,5 @@
-export type CheckoutIntentKind = 'commit' | 'wallet' | 'checkout_step' | 'frame';
-export type CheckoutIntentSource = 'vendor' | 'label' | 'brand' | 'frame' | 'submit';
+export type CheckoutIntentKind = 'commit' | 'wallet' | 'checkout_step' | 'frame' | 'cart';
+export type CheckoutIntentSource = 'vendor' | 'label' | 'brand' | 'frame' | 'submit' | 'name' | 'api';
 export interface ICheckoutIntent {
     kind: Exclude<CheckoutIntentKind, 'frame'>;
     source: CheckoutIntentSource;

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

@@ -1,9 +1,12 @@
 export declare const CONTROL_SELECTOR = "button, input[type=\"submit\"], input[type=\"button\"], input[type=\"image\"], [role=\"button\"]";
+export declare function someComposedAncestor(element: Element, test: (node: Element) => boolean, until?: Element): boolean;
 export declare function hasComposedAncestor(element: Element, selector: string): boolean;
 export declare function isRoktElement(element: Element): boolean;
 export declare function vendorButtonKind(control: Element): 'wallet' | 'checkout_step' | 'none' | undefined;
+export declare function isWalletNamed(element: Element): boolean;
 export declare function isWalletElement(element: Element): boolean;
-export declare function isQuietIntentControl(control: Element, isVendorWallet: boolean): boolean;
-export declare function findControl(path: Array<EventTarget | null>): Element | undefined;
+export declare function isQuietIntentControl(control: Element, isVendorWallet: boolean, isCart?: boolean): boolean;
+export declare function isWalletNamedControl(element: Element): boolean;
+export declare function isExcludedPath(path: Array<EventTarget | null>): boolean;
+export declare function findControl(path: Array<EventTarget | null>, included?: boolean): Element | undefined;
 export declare function isUnsafeTextSource(element: Element): boolean;
-export declare function isUnsafeLabelSource(label: Element): boolean;

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

@@ -1 +1,2 @@
+export declare const MAX_RAW_LABEL_LENGTH = 128;
 export declare function maskLabel(raw: string | null | undefined): string | undefined;

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

@@ -59,6 +59,7 @@ export interface IConfigResponse {
     workspaceToken: string;
     pixelConfigs: IPixelConfiguration[];
     flags: SDKEventCustomFlags;
+    autoLogPageViewQueryParams?: string;
 }
 export interface IConfigAPIClient {
     apiKey: string;

package/dist/types/src/forwarder-utils.d.ts

@@ -1,8 +1,11 @@
 import * as EventsApi from '@mparticle/event-models';
 import { IKitFilterSettings } from './configAPIClient';
+import type { SDKEvent } from './sdkRuntimeModels';
+import type KitBlocker from './kitBlocking';
 type ForwarderFilterConfig = Pick<IKitFilterSettings, 'eventNameFilters' | 'eventTypeFilters' | 'screenNameFilters' | 'screenAttributeFilters' | 'attributeFilters' | 'userIdentityFilters' | 'filteringEventAttributeValue'>;
 export declare function isBlockedByForwardingRule(messageType: number, attributes: Record<string, unknown> | null, forwarder: ForwarderFilterConfig): boolean;
 export declare function isBlockedByEventFilter(messageType: number, hashedEventName: number, hashedEventType: number, forwarder: ForwarderFilterConfig): boolean;
+export declare function isEventForwarded(event: SDKEvent, forwarder: ForwarderFilterConfig, kitBlocker?: KitBlocker): boolean;
 export declare function filterEventAttributes(messageType: number, eventCategory: number, eventName: string, attributes: Record<string, unknown> | null, forwarder: ForwarderFilterConfig): Record<string, unknown> | null;
 export declare function filterUserIdentities(userIdentities: Array<{
     Type: number;

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

@@ -0,0 +1,10 @@
+import { valueof } from './utils';
+export declare const UrlMode: {
+    readonly Path: "path";
+    readonly Full: "full";
+};
+export type UrlMode = valueof<typeof UrlMode>;
+export declare const EXCLUDED_URL_QUERY_PARAMS: string[];
+export declare const EXCLUDED_URL_FRAGMENT_PARAMS: string[];
+export declare const cleanUrl: (href: string, mode: UrlMode) => string;
+export declare const cleanPageHref: () => string;

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

@@ -3,9 +3,23 @@ import { BaseEvent } from './sdkRuntimeModels';
 import { Dictionary } from './utils';
 export declare const WIN_APV_KEY = "__mpApv__";
 export declare const ALLOWED_QUERY_PARAMS: string[];
+export declare const AUTO_PAGE_VIEW_ATTRIBUTE = "is_auto_page_view";
+export declare const MAX_CUSTOM_QUERY_PARAMS = 25;
+export interface IQueryParamAllowlist {
+    allowed: string[];
+    rejectedPositions: number[];
+    overLimit: number;
+}
+export declare const MAX_CUSTOM_QUERY_PARAM_VALUE_LENGTH = 512;
+export interface ICapturedParam {
+    name: string;
+    value: string;
+}
+export declare const ALLOWED_QUERY_PARAM_PREFIXES: string[];
+export declare const isAllowedQueryParam: (name: string) => boolean;
 interface IPageSnapshot {
     path: string;
-    params: Dictionary<string>;
+    params: ICapturedParam[];
 }
 interface IPageViewData extends IPageSnapshot {
     hostname: string;
@@ -15,8 +29,10 @@ interface IPageViewData extends IPageSnapshot {
 export interface IPageViewOptions {
     isAutoPageView?: boolean;
 }
-export declare const allowedQueryParams: (href: string) => Dictionary<string>;
-export declare const AUTO_PAGE_VIEW_ATTRIBUTE = "is_auto_page_view";
+export declare const parseQueryParamAllowlist: (configured: unknown) => IQueryParamAllowlist;
+export declare const effectiveAllowlist: (extras?: string[]) => string[];
+export declare const allowedQueryParams: (href: string, extras?: string[]) => ICapturedParam[];
+export declare const paramsToAttributes: (params: ICapturedParam[]) => Dictionary<string>;
 export declare const autoPageViewAttribute: (isAutoPageView?: boolean) => Dictionary<boolean>;
 export declare const pageKey: (page: IPageSnapshot) => string;
 export declare const isNewPage: (lastKey: string | null, candidateKey: string) => boolean;
@@ -29,6 +45,7 @@ export declare class PageViewTracker {
     private readonly mpInstance;
     private lastPage;
     private active;
+    private customQueryParams;
     private pendingNavigations;
     private undoHistoryPatch;
     private readonly isAutoPageView;
@@ -36,6 +53,7 @@ export declare class PageViewTracker {
     get isActive(): boolean;
     init(): void;
     teardown(): void;
+    private readCustomQueryParams;
     private retire;
     private takePendingNavigations;
     private safeHandleNavigation;

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

@@ -5,6 +5,7 @@ import { Dictionary, AttributeValue } from "./utils";
 import { SDKIdentityApi } from "./identity.interfaces";
 import { SDKLoggerApi } from "./sdkRuntimeModels";
 import { IStore, LocalSessionAttributes } from "./store";
+import { MPID } from "@mparticle/web-sdk";
 import { IErrorReportingService, ILoggingService } from "./reporting/types";
 import { IRoktLauncherOptions } from "./roktLauncherOptions";
 import IntegrationCapture from "./integrationCapture";
@@ -82,6 +83,7 @@ export default class RoktManager {
     kit: IRoktKit;
     filters: RoktKitFilterSettings;
     private currentUser;
+    private createFilteredUser?;
     private messageQueue;
     private sandbox;
     private placementAttributesMapping;
@@ -100,6 +102,7 @@ export default class RoktManager {
     private isShoppableAdsLoaded;
     private stopRouteChangeWatch;
     private pendingCheckoutIntents;
+    private autoButtonClicksForwarded;
     constructor(instanceName?: string);
     /**
      * Sets a callback to be invoked when RoktManager becomes ready
@@ -116,20 +119,22 @@ export default class RoktManager {
      * @param {Function} captureTiming - Function to capture performance timing marks
      * @param {IErrorReportingService} errorReporter - Dispatcher for error/warning reporting
      * @param {ILoggingService} loggingService - Dispatcher for informational logging
+     * @param {Function} createFilteredUser - Builds a user as the Rokt connection's filters and the data plan allow
      *
      * @throws Logs error to console if placementAttributesMapping parsing fails
      */
-    init(roktConfig: IKitConfigs, filteredUser: IMParticleUser, identityService: SDKIdentityApi, store: IStore, logger?: SDKLoggerApi, options?: IRoktOptions, captureTiming?: (metricsName: string) => void, errorReporter?: IErrorReportingService, loggingService?: ILoggingService, integrationCapture?: IntegrationCapture): void;
+    init(roktConfig: IKitConfigs, filteredUser: IMParticleUser, identityService: SDKIdentityApi, store: IStore, logger?: SDKLoggerApi, options?: IRoktOptions, captureTiming?: (metricsName: string) => void, errorReporter?: IErrorReportingService, loggingService?: ILoggingService, integrationCapture?: IntegrationCapture, createFilteredUser?: (mpid: MPID) => IMParticleUser): void;
     get isInitialized(): boolean;
     attachKit(kit: IRoktKit): void;
     private watchRouteChanges;
     private notifyRouteChange;
+    setAutoButtonClicksForwarded(forwarded: boolean): void;
     isCheckoutIntentSuppressed(): boolean;
     isCheckoutIntentLive(): boolean;
     notifyCheckoutIntent(signal: ICheckoutIntentSignal, pathname?: string): void;
     discardCheckoutIntents(): void;
     private flushCheckoutIntents;
-    private isAutoLogPageViewEnabled;
+    isAutoLogPageViewEnabled(): boolean;
     /**
      * Renders ads based on the options provided
      *
@@ -146,6 +151,7 @@ export default class RoktManager {
      * });
      */
     selectPlacements(options: IRoktSelectPlacementsOptions): Promise<IRoktSelection>;
+    private logFilteredIdentity;
     /**
      * Hashes attributes and returns both original and hashed versions
      * with Rokt-compatible key names (like emailsha256, mobilesha256)

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

@@ -19,6 +19,7 @@ import { IErrorLogMessage, IMParticleWebSDKInstance, IntegrationDelays } from '.
 import Constants from './constants';
 import RoktManager, { IRoktLauncherOptions } from './roktManager';
 import { IConsoleLogger } from './logger';
+import { UrlMode } from './pageUrl';
 import { ErrorCodes, IErrorReportingService, ILoggingService } from './reporting/types';
 export type SDKEventCustomFlags = Dictionary<any>;
 export interface SDKEvent {
@@ -194,6 +195,7 @@ export interface IMParticleInstanceManager extends MParticleWebSDK {
     _instances: Dictionary<IMParticleWebSDKInstance>;
     _isTestEnv?: boolean;
     _forceNoLocalStorage?: boolean;
+    _cleanUrl(href: string, mode: UrlMode): string;
     config: SDKInitConfig;
     isIOS?: boolean;
     MPSideloadedKit: typeof MPSideloadedKit;
@@ -221,6 +223,7 @@ export interface SDKInitConfig extends Omit<MPConfiguration, 'dataPlan' | 'logLe
     dataPlanOptions?: KitBlockerOptions;
     flags?: Dictionary;
     pixelConfigs?: IPixelConfiguration[];
+    autoLogPageViewQueryParams?: string;
     aliasMaxWindow?: number;
     deviceId?: string;
     forceHttps?: boolean;

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

@@ -1,6 +1,7 @@
 import { Batch } from '@mparticle/event-models';
 import { MPID, IdentifyRequest, SDKEventCustomFlags, ConsentState, UserIdentities } from '@mparticle/web-sdk';
 import { IKitConfigs } from './configAPIClient';
+import { IQueryParamAllowlist } from './pageViewTracker';
 import { DataPlanResult, KitBlockerOptions, LogLevelType, SDKDataPlan, SDKEvent, SDKGeoLocation, SDKInitConfig, SDKProduct } from './sdkRuntimeModels';
 import { Dictionary, AttributeValue } from './utils';
 import { SDKConsentState } from './consent';
@@ -25,6 +26,7 @@ export interface SDKConfig {
     appVersion?: string;
     package?: string;
     flags?: IFeatureFlags;
+    autoLogPageViewQueryParams?: IQueryParamAllowlist;
     kitConfigs: IKitConfigs[];
     kits: Dictionary<UnregisteredKit>;
     logLevel?: LogLevelType;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "3.22.0",
+    "version": "3.24.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [
@@ -101,20 +101,18 @@
         "lint"
     ],
     "devDependencies": {
-        "@babel/core": "^7.18.6",
-        "@babel/eslint-parser": "^7.18.2",
-        "@babel/eslint-plugin": "^7.17.7",
-        "@babel/plugin-proposal-class-properties": "^7.5.5",
-        "@babel/plugin-proposal-object-rest-spread": "^7.5.5",
-        "@babel/plugin-transform-runtime": "^7.6.0",
-        "@babel/preset-env": "^7.6.0",
-        "@babel/preset-typescript": "^7.6.0",
+        "@babel/core": "^8.0.7",
+        "@babel/plugin-transform-runtime": "^8.0.6",
+        "@babel/preset-env": "^8.0.7",
+        "@babel/preset-typescript": "^8.0.7",
+        "@babel/runtime": "^8.0.7",
         "@mparticle/data-planning-models": "^0.1.0",
         "@mparticle/event-models": "^1.3.1",
-        "@rollup/plugin-babel": "6.0.3",
+        "@rollup/plugin-babel": "^7.1.0",
         "@rollup/plugin-commonjs": "25.0.4",
         "@rollup/plugin-json": "^5.0.2",
         "@rollup/plugin-node-resolve": "15.2.1",
+        "@rollup/plugin-terser": "^1.0.1",
         "@rollup/plugin-typescript": "^11.1.0",
         "@semantic-release/changelog": "^6.0.3",
         "@semantic-release/exec": "^6.0.3",
@@ -126,7 +124,7 @@
         "@types/mocha": "^9.0.0",
         "@types/mparticle__web-sdk": "^2.66.0",
         "@types/node": "^20.1.0",
-        "babel-preset-minify": "^0.5.1",
+        "babel-plugin-polyfill-corejs3": "^1.0.0",
         "browser-sync": "^2.26.3",
         "browserify": "^17.0.0",
         "chai": "^4.2.0",
@@ -159,7 +157,7 @@
         "shelljs": "^0.8.4",
         "should": "^7.1.0",
         "sinon": "^16.1.3",
-        "ts-jest": "^29.1.0",
+        "ts-jest": "^29.4.15",
         "tslib": "^2.1.0",
         "typescript": "^5.0.2",
         "uglify-js": "^3.4.9",
@@ -169,7 +167,16 @@
     "peerDependencies": {
         "@mparticle/event-models": "^1.3.1"
     },
-    "dependencies": {
-        "@babel/runtime": "^7.23.2"
+    "overrides": {
+        "@rollup/plugin-babel": {
+            "@babel/core": "$@babel/core"
+        }
+    },
+    "devEngines": {
+        "runtime": {
+            "name": "node",
+            "version": "^22.18.0 || >=24.11.0",
+            "onFail": "warn"
+        }
     }
 }

package/src/batchUploader.ts

@@ -3,7 +3,8 @@ import Constants from './constants';
 import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
 import { convertEvents } from './sdkToEventsApiConverter';
 import { MessageType, EventType } from './types';
-import { getRampNumber, getHref, isEmpty, obfuscateDevData } from './utils';
+import { getRampNumber, isEmpty, obfuscateDevData } from './utils';
+import { cleanPageHref } from './pageUrl';
 import { SessionStorageVault, LocalStorageVault, StorageResult } from './vault';
 import {
     AsyncUploader,
@@ -204,7 +205,7 @@ export class BatchUploader {
             Debug: SDKConfig.isDevelopmentMode,
             ActiveTimeOnSite: _timeOnSiteTimer?.getTimeInForeground() || 0,
             TotalTimeOnSite: _Store.getTotalTimeOnSite?.() || 0,
-            PageUrl: getHref() || null,
+            PageUrl: cleanPageHref() || null,
             IsBackgroundAST: true
         } as SDKEvent;
 

package/src/buttonTracking/buttonClickEvent.ts

@@ -1,4 +1,8 @@
-import { BaseEvent } from '../sdkRuntimeModels';
+import { IKitFilterSettings } from '../configAPIClient';
+import { isEventForwarded } from '../forwarder-utils';
+import type KitBlocker from '../kitBlocking';
+import KitFilterHelper from '../kitFilterHelper';
+import { BaseEvent, SDKEvent } from '../sdkRuntimeModels';
 import { EventType, MessageType } from '../types';
 import { IButtonClick } from './buttonDescription';
 
@@ -52,3 +56,74 @@ export const buildButtonClickEvent = (
         eventType: EventType.Other,
     };
 };
+
+// Every attribute buildButtonClickEvent can set apart from the marker and the
+// hostname, which is the same on every click on this page. A spec checks the
+// two stay in step.
+const CLICK_ATTRIBUTES = [
+    'label_source',
+    'element',
+    'type',
+    'path',
+    'label',
+    'aria_label',
+    'icon',
+    'element_id',
+    'element_name',
+    'test_id',
+    'controls',
+    'form',
+    'link_type',
+    'link_domain',
+    'file_extension',
+    'checked',
+];
+
+export type ButtonClickBlocker =
+    | 'data plan'
+    | 'forwarding rule'
+    | 'event name filter'
+    | 'event type filter';
+
+// Which check keeps some or all auto button clicks from a kit, or undefined
+// when the kit receives every one. A forwarding rule on an attribute whose
+// value differs between clicks lets some through and not others. Each other
+// check goes through isEventForwarded on its own, so together they decide as
+// it does for each click.
+export const getButtonClickBlocker = (
+    forwarder: IKitFilterSettings,
+    kitBlocker?: KitBlocker
+): ButtonClickBlocker | undefined => {
+    const rule = forwarder.filteringEventAttributeValue;
+    if (
+        rule &&
+        rule.eventAttributeValue &&
+        CLICK_ATTRIBUTES.some(
+            name =>
+                KitFilterHelper.hashAttributeConditionalForwarding(name) ===
+                rule.eventAttributeName
+        )
+    ) {
+        return 'forwarding rule';
+    }
+    const click = ({
+        EventName: BUTTON_CLICK_EVENT_NAME,
+        EventCategory: EventType.Other,
+        EventDataType: MessageType.PageEvent,
+        EventAttributes: {
+            [AUTO_BUTTON_ATTRIBUTE]: true,
+            hostname: window.location.hostname,
+        },
+    } as unknown) as SDKEvent;
+    const checks: Array<[ButtonClickBlocker, Partial<IKitFilterSettings>]> = [
+        ['data plan', {}],
+        ['forwarding rule', { filteringEventAttributeValue: rule }],
+        ['event name filter', { eventNameFilters: forwarder.eventNameFilters }],
+        ['event type filter', { eventTypeFilters: forwarder.eventTypeFilters }],
+    ];
+    const failed = checks.find(
+        ([, filters]) =>
+            !isEventForwarded(click, filters as IKitFilterSettings, kitBlocker)
+    );
+    return failed ? failed[0] : undefined;
+};