@mparticle/web-sdk 2.79.2 → 2.79.3

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

@@ -1,8 +1,16 @@
-export default function filteredMparticleUser(mpid: any, forwarder: any, mpInstance: any, kitBlocker: any): {
-    getUserIdentities: () => {
-        userIdentities: {};
+import { IMParticleWebSDKInstance } from './mp-instance';
+import { MPID } from '@mparticle/web-sdk';
+import { Dictionary } from './utils';
+import KitBlocker from './kitBlocking';
+import { MPForwarder } from './forwarders.interfaces';
+export interface IFilteredMparticleUser {
+    getUserIdentities(): {
+        userIdentities: Dictionary<string>;
     };
-    getMPID: () => any;
-    getUserAttributesLists: (forwarder: any) => {};
-    getAllUserAttributes: () => {};
-};
+    getMPID(): MPID;
+    getUserAttributesLists(forwarder: MPForwarder): Dictionary<string[]>;
+    getAllUserAttributes(): Dictionary;
+}
+export default function filteredMparticleUser(mpid: MPID, forwarder: MPForwarder | {
+    userAttributeFilters: number[];
+}, mpInstance: IMParticleWebSDKInstance, kitBlocker?: KitBlocker): IFilteredMparticleUser;

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

@@ -1,5 +1,5 @@
-export default function forwardingStatsUploader(mpInstance: any): void;
-export default class forwardingStatsUploader {
-    constructor(mpInstance: any);
-    startForwardingStatsTimer: () => void;
+import { IMParticleWebSDKInstance } from './mp-instance';
+export interface IForwardingStatsUploader {
+    startForwardingStatsTimer(): void;
 }
+export default function forwardingStatsUploader(this: IForwardingStatsUploader, mpInstance: IMParticleWebSDKInstance): void;

package/dist/types/src/mp-instance.d.ts

@@ -3,7 +3,7 @@ import { ICookieSyncManager } from './cookieSyncManager';
 import { ISessionManager } from './sessionManager';
 import { IStore } from './store';
 import { IServerModel } from './serverModel';
-import ForwardingStatsUploader from './forwardingStatsUploader';
+import { IForwardingStatsUploader } from './forwardingStatsUploader';
 import { IConsent } from './consent';
 import IdentityAPIClient from './identityApiClient';
 import IntegrationCapture from './integrationCapture';
@@ -39,7 +39,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _Ecommerce: IECommerce;
     _Events: IEvents;
     _Forwarders: any;
-    _ForwardingStatsUploader: ForwardingStatsUploader;
+    _ForwardingStatsUploader: IForwardingStatsUploader;
     _Helpers: SDKHelpersApi;
     _Identity: IIdentity;
     _IdentityAPIClient: typeof IdentityAPIClient;
@@ -62,6 +62,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     captureTiming(metricName: string): any;
     processQueueOnIdentityFailure?: () => void;
     processQueueOnNoFunctional?: () => void;
+    uiwebviewBridgeName?: string;
 }
 /**
  * <p>All of the following methods can be called on the primary mParticle class. In version 2.10.0, we introduced <a href="https://docs.mparticle.com/developers/sdk/web/multiple-instances/">multiple instances</a>. If you are using multiple instances (self hosted environments only), you should call these methods on each instance.</p>

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

@@ -1,12 +1,3 @@
-export default function NativeSdkHelpers(mpInstance: any): void;
-export default class NativeSdkHelpers {
-    constructor(mpInstance: any);
-    initializeSessionAttributes: (apiKey: any) => void;
-    isBridgeV2Available: (bridgeName: any) => boolean;
-    isWebviewEnabled: (requiredWebviewBridgeName: any, minWebviewBridgeVersion: any) => any;
-    isBridgeV1Available: () => boolean;
-    sendToNative: (path: any, value: any) => void;
-    sendViaBridgeV1: (path: any, value: any) => void;
-    sendViaIframeToIOS: (path: any, value: any) => void;
-    sendViaBridgeV2: (path: any, value: any, requiredWebviewBridgeName: any) => void;
-}
+import { IMParticleWebSDKInstance } from './mp-instance';
+import { INativeSdkHelpers } from './nativeSdkHelpers.interfaces';
+export default function NativeSdkHelpers(this: INativeSdkHelpers, mpInstance: IMParticleWebSDKInstance): void;

package/dist/types/src/nativeSdkHelpers.interfaces.d.ts

@@ -1,3 +1,17 @@
+export interface IWKScriptMessageHandler {
+    postMessage(message: string): void;
+}
+export interface IAndroidNativeBridge {
+    [methodName: string]: ((payload?: string) => void) | undefined;
+}
+declare global {
+    interface Window {
+        webkit?: {
+            messageHandlers?: Record<string, IWKScriptMessageHandler | undefined>;
+        };
+        mParticleAndroid?: IAndroidNativeBridge;
+    }
+}
 export interface INativeSdkHelpers {
     initializeSessionAttributes: (apiKey: string) => void;
     isBridgeV2Available: (bridgeName: string) => boolean;
@@ -6,5 +20,5 @@ export interface INativeSdkHelpers {
     sendToNative: (path: string, value?: string) => void;
     sendViaBridgeV1: (path: string, value: string) => void;
     sendViaIframeToIOS: (path: string, value: string) => void;
-    sendViaBridgeV2: (path: string, value: string, requiredWebviewBridgeName: boolean) => void;
+    sendViaBridgeV2: (path: string, value: string, requiredWebviewBridgeName: string) => void;
 }

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

@@ -1,34 +1,38 @@
 import { IMParticleWebSDKInstance } from './mp-instance';
-export declare const WIN_TRACKER_KEY = "__mpApvTracker__";
-export declare const WIN_INIT_PV_KEY: "__mpApvInitPVLogged__";
-export type WindowWithApvFlags = Window & {
-    [WIN_TRACKER_KEY]?: PageViewTracker;
-    [WIN_INIT_PV_KEY]?: boolean;
-};
+import { BaseEvent } from './sdkRuntimeModels';
+type HistoryMethodName = 'pushState' | 'replaceState';
+type NavigationSource = HistoryMethodName | 'popstate';
+export declare const WIN_APV_KEY = "__mpApv__";
+interface IPageViewData {
+    hostname: string;
+    title: string;
+    path: string;
+}
+export declare const isNewPage: (lastPath: string | null, candidatePath: string) => boolean;
+export declare const supportsHistoryTracking: (win: Window | null) => boolean;
+export declare const buildPageViewEvent: (data: IPageViewData) => BaseEvent;
+export declare const getActiveTracker: () => PageViewTracker | undefined;
+export declare const hasInitialPageViewFired: () => boolean;
+export declare const markInitialPageViewFired: () => void;
+export declare const resetPageViewTracking: () => void;
+export declare const patchHistory: (onNavigate: (source: NavigationSource) => void, log: (message: string) => void) => (() => void) | null;
 export declare class PageViewTracker {
-    static hasInitialPageViewFired(): boolean;
-    static markInitialPageViewFired(): void;
-    static resetWindowState(instanceTracker?: PageViewTracker): void;
-    mpInstance: IMParticleWebSDKInstance;
+    private readonly mpInstance;
     private lastPath;
-    private _isActive;
-    get isActive(): boolean;
+    private active;
     private pendingNavigations;
-    private originalPushState;
-    private originalReplaceState;
-    private pushStateWrapper;
-    private replaceStateWrapper;
+    private undoHistoryPatch;
     private popStateListener;
     constructor(mpInstance: IMParticleWebSDKInstance);
-    private isSupportedEnvironment;
+    get isActive(): boolean;
     init(): void;
-    private patchHistoryMethods;
-    private addNavigationListeners;
+    teardown(): void;
+    private retire;
+    private takePendingNavigations;
     private safeHandleNavigation;
-    private getCurrentKey;
     private handleNavigation;
+    private scheduleFire;
     private firePageView;
-    takePendingNavigations(): string[];
-    private restoreHistoryMethod;
-    teardown(): void;
+    private log;
 }
+export {};

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

@@ -204,6 +204,7 @@ export interface IMParticleInstanceManager extends MParticleWebSDK {
     sessionManager: Pick<ISessionManager, 'getSession'>;
     Store: IStore;
     getInstance(instanceName?: string): IMParticleWebSDKInstance;
+    uiwebviewBridgeName?: string;
 }
 export type BooleanStringLowerCase = 'false' | 'true';
 export type BooleanStringTitleCase = 'False' | 'True';
@@ -260,7 +261,7 @@ export interface SDKHelpersApi {
     createXHR?(cb: () => void): XMLHttpRequest;
     extend?(...args: any[]): any;
     findKeyInObject?(obj: any, key: string): string;
-    parseNumber?(value: string | number): number;
+    parseNumber(value: string | number): number;
     generateUniqueId(): any;
     generateHash?(value: string): number;
     getFeatureFlag?(feature: string): boolean | string;
@@ -268,8 +269,8 @@ export interface SDKHelpersApi {
     parseStringOrNumber?(value: string | number): string | number | null;
     inArray?(items: any[], value: any): boolean;
     converted?(s: string): string;
-    filterUserIdentitiesForForwarders?(userIdentities: Dictionary, filterList: number[]): Dictionary;
-    filterUserAttributes?(userAttributes: Dictionary, filterList: number[]): Dictionary;
+    filterUserIdentitiesForForwarders(userIdentities: Dictionary, filterList: number[]): Dictionary;
+    filterUserAttributes(userAttributes: Dictionary, filterList: number[]): Dictionary;
     filterUserIdentities?(userIdentitiesObject: Dictionary<string>, filterList: number[]): ISDKUserIdentity[];
     invokeAliasCallback(aliasCallback: IAliasCallback, number: number, errorMessage?: string): void;
     isDelayedByIntegration?(delayedIntegrations: Dictionary<boolean>, timeoutStart: number, now: number): boolean;

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

@@ -124,6 +124,8 @@ export interface IStore {
     pixelConfigurations: IPixelConfiguration[];
     integrationDelayTimeoutStart: number;
     webviewBridgeEnabled?: boolean;
+    bridgeV1Available?: boolean;
+    bridgeV2Available?: boolean;
     wrapperSDKInfo: WrapperSDKInfo;
     roktAccountId: string | null;
     integrationName: string | null;

package/package.json

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

package/src/filteredMparticleUser.ts

@@ -0,0 +1,160 @@
+import Types from './types';
+import { IMParticleWebSDKInstance } from './mp-instance';
+import { MPID, UserIdentities } from '@mparticle/web-sdk';
+import { Dictionary } from './utils';
+import KitBlocker from './kitBlocking';
+import { MPForwarder } from './forwarders.interfaces';
+
+export interface IFilteredMparticleUser {
+    getUserIdentities(): { userIdentities: Dictionary<string> };
+    getMPID(): MPID;
+    getUserAttributesLists(forwarder: MPForwarder): Dictionary<string[]>;
+    getAllUserAttributes(): Dictionary;
+}
+
+function isAttributeKeyAllowed(
+    kitBlocker: KitBlocker | undefined,
+    key: string
+): boolean {
+    return !kitBlocker?.isAttributeKeyBlocked(key);
+}
+
+function isIdentityAllowed(
+    kitBlocker: KitBlocker | undefined,
+    identityName: string
+): boolean {
+    return !kitBlocker?.isIdentityBlocked(identityName);
+}
+
+function copyUserAttributeValue(value: unknown): unknown {
+    return Array.isArray(value) ? (value as string[]).slice() : value;
+}
+
+function buildUserAttributesCopy(
+    userAttributes?: Dictionary,
+    kitBlocker?: KitBlocker
+): Dictionary {
+    const userAttributesCopy: Dictionary = {};
+
+    if (!userAttributes) {
+        return userAttributesCopy;
+    }
+
+    for (const prop in userAttributes) {
+        if (
+            !userAttributes.hasOwnProperty(prop) ||
+            !isAttributeKeyAllowed(kitBlocker, prop)
+        ) {
+            continue;
+        }
+
+        userAttributesCopy[prop] = copyUserAttributeValue(
+            userAttributes[prop]
+        );
+    }
+
+    return userAttributesCopy;
+}
+
+function buildUserAttributeLists(
+    userAttributes: Dictionary,
+    kitBlocker?: KitBlocker
+): Dictionary<string[]> {
+    const userAttributesLists: Dictionary<string[]> = {};
+
+    for (const key in userAttributes) {
+        if (
+            !userAttributes.hasOwnProperty(key) ||
+            !Array.isArray(userAttributes[key]) ||
+            !isAttributeKeyAllowed(kitBlocker, key)
+        ) {
+            continue;
+        }
+
+        userAttributesLists[key] = userAttributes[key].slice();
+    }
+
+    return userAttributesLists;
+}
+
+function buildFilteredUserIdentities(
+    identities: UserIdentities,
+    kitBlocker: KitBlocker | undefined,
+    parseNumber: (value: string | number) => number
+): Dictionary<string> {
+    const currentUserIdentities: Dictionary<string> = {};
+    const identitiesByType = identities as Dictionary<string>;
+
+    for (const identityType in identitiesByType) {
+        if (!identitiesByType.hasOwnProperty(identityType)) {
+            continue;
+        }
+
+        const identityName = Types.IdentityType.getIdentityName(
+            parseNumber(identityType)
+        );
+
+        if (!isIdentityAllowed(kitBlocker, identityName)) {
+            continue;
+        }
+
+        currentUserIdentities[identityName] = identitiesByType[identityType];
+    }
+
+    return currentUserIdentities;
+}
+
+export default function filteredMparticleUser(
+    mpid: MPID,
+    forwarder: MPForwarder | { userAttributeFilters: number[] },
+    mpInstance: IMParticleWebSDKInstance,
+    kitBlocker?: KitBlocker
+): IFilteredMparticleUser {
+    function getAllUserAttributes(): Dictionary {
+        const userAttributesCopy = buildUserAttributesCopy(
+            mpInstance._Store.getUserAttributes(mpid),
+            kitBlocker
+        );
+
+        return mpInstance._Helpers.filterUserAttributes(
+            userAttributesCopy,
+            (forwarder as MPForwarder).userAttributeFilters
+        );
+    }
+
+    return {
+        getUserIdentities: function(): { userIdentities: Dictionary<string> } {
+            let currentUserIdentities = buildFilteredUserIdentities(
+                mpInstance._Store.getUserIdentities(mpid),
+                kitBlocker,
+                mpInstance._Helpers.parseNumber
+            );
+
+            currentUserIdentities = mpInstance._Helpers.filterUserIdentitiesForForwarders(
+                currentUserIdentities,
+                (forwarder as MPForwarder).userIdentityFilters
+            );
+
+            return {
+                userIdentities: currentUserIdentities,
+            };
+        },
+        getMPID: function(): MPID {
+            return mpid;
+        },
+        getUserAttributesLists: function(
+            forwarder: MPForwarder
+        ): Dictionary<string[]> {
+            const userAttributesLists = buildUserAttributeLists(
+                getAllUserAttributes(),
+                kitBlocker
+            );
+
+            return mpInstance._Helpers.filterUserAttributes(
+                userAttributesLists,
+                forwarder.userAttributeFilters
+            ) as Dictionary<string[]>;
+        },
+        getAllUserAttributes: getAllUserAttributes,
+    };
+}

package/src/{forwardingStatsUploader.js → forwardingStatsUploader.ts}

@@ -1,12 +1,25 @@
-export default function forwardingStatsUploader(mpInstance) {
-    this.startForwardingStatsTimer = function() {
-        mParticle._forwardingStatsTimer = setInterval(function() {
-            prepareAndSendForwardingStatsBatch();
-        }, mpInstance._Store.SDKConfig.forwarderStatsTimeout);
+import { IMParticleWebSDKInstance } from './mp-instance';
+import { Dictionary } from './utils';
+
+export interface IForwardingStatsUploader {
+    startForwardingStatsTimer(): void;
+}
+
+export default function forwardingStatsUploader(
+    this: IForwardingStatsUploader,
+    mpInstance: IMParticleWebSDKInstance
+): void {
+    this.startForwardingStatsTimer = function(): void {
+        (window.mParticle as Dictionary)._forwardingStatsTimer = setInterval(
+            function() {
+                prepareAndSendForwardingStatsBatch();
+            },
+            (mpInstance._Store.SDKConfig as Dictionary).forwarderStatsTimeout
+        );
     };
 
-    function prepareAndSendForwardingStatsBatch() {
-        var forwarderQueue = mpInstance._Forwarders.getForwarderStatsQueue(),
+    function prepareAndSendForwardingStatsBatch(): void {
+        const forwarderQueue = mpInstance._Forwarders.getForwarderStatsQueue(),
             uploadsTable =
                 mpInstance._Persistence.forwardingStatsBatches.uploadsTable,
             now = Date.now();
@@ -16,11 +29,11 @@ export default function forwardingStatsUploader(mpInstance) {
             mpInstance._Forwarders.setForwarderStatsQueue([]);
         }
 
-        for (var date in uploadsTable) {
-            (function(date) {
+        for (const date in uploadsTable) {
+            (function(date: string) {
                 if (uploadsTable.hasOwnProperty(date)) {
                     if (uploadsTable[date].uploading === false) {
-                        var xhrCallback = function() {
+                        const xhrCallback = function(): void {
                             if (xhr.readyState === 4) {
                                 if (xhr.status === 200 || xhr.status === 202) {
                                     mpInstance.Logger.verbose(
@@ -39,8 +52,8 @@ export default function forwardingStatsUploader(mpInstance) {
                             }
                         };
 
-                        var xhr = mpInstance._Helpers.createXHR(xhrCallback);
-                        var forwardingStatsData = uploadsTable[date].data;
+                        const xhr = mpInstance._Helpers.createXHR(xhrCallback);
+                        const forwardingStatsData = uploadsTable[date].data;
                         uploadsTable[date].uploading = true;
                         mpInstance._APIClient.sendBatchForwardingStatsToServer(
                             forwardingStatsData,

package/src/mp-instance.ts

@@ -30,7 +30,9 @@ import Persistence from './persistence';
 import Events from './events';
 import Forwarders from './forwarders';
 import ServerModel, { IServerModel } from './serverModel';
-import ForwardingStatsUploader from './forwardingStatsUploader';
+import ForwardingStatsUploader, {
+    IForwardingStatsUploader,
+} from './forwardingStatsUploader';
 import Identity from './identity';
 import Consent, { IConsent } from './consent';
 import KitBlocker from './kitBlocking';
@@ -57,7 +59,12 @@ import { LoggingDispatcher } from './reporting/loggingDispatcher';
 import { IErrorReportingService, ILoggingService } from './reporting/types';
 import { logDeprecatedMethodUsage } from './reporting/deprecatedMethodLogger';
 import { normalizeRoktLauncherOptions } from './roktLauncherOptions';
-import { PageViewTracker } from './pageViewTracker';
+import {
+    hasInitialPageViewFired,
+    markInitialPageViewFired,
+    PageViewTracker,
+    resetPageViewTracking,
+} from './pageViewTracker';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -82,7 +89,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _Ecommerce: IECommerce;
     _Events: IEvents;
     _Forwarders: any; // https://go.mparticle.com/work/SQDSDKS-5767
-    _ForwardingStatsUploader: ForwardingStatsUploader;
+    _ForwardingStatsUploader: IForwardingStatsUploader;
     _Helpers: SDKHelpersApi;
     _Identity: IIdentity;
     _IdentityAPIClient: typeof IdentityAPIClient;
@@ -105,6 +112,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     captureTiming(metricName: string);
     processQueueOnIdentityFailure?: () => void;
     processQueueOnNoFunctional?: () => void;
+    uiwebviewBridgeName?: string;
 }
 
 const { Messages, HTTPCodes, FeatureFlags, CaptureIntegrationSpecificIdsV2Modes } = Constants;
@@ -298,12 +306,8 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         );
         instance._Events.stopTracking();
 
-        const instanceTracker = instance._PageViewTracker;
-        if (instanceTracker) {
-            instanceTracker.teardown();
-            instance._PageViewTracker = undefined;
-        }
-        PageViewTracker.resetWindowState(instanceTracker);
+        resetPageViewTracking();
+        instance._PageViewTracker = undefined;
 
         if (!keepPersistence) {
             instance._Persistence.resetPersistence();
@@ -1593,32 +1597,30 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
         mpInstance._SessionManager.initialize();
         mpInstance._Events.logAST();
 
-        // Note: APV uses window-level singletons (WIN_TRACKER_KEY, WIN_INIT_PV_KEY)
-        // that assume a single active SDK instance. Multiple-instance support is
-        // out of scope
+        // Note: APV state (the active tracker and the initial-page-view flag) is
+        // window-scoped and assumes a single active SDK instance. Multiple-instance
+        // support is out of scope.
         if (getFeatureFlag(AutoLogPageView)) {
             if (!mpInstance._PageViewTracker) {
                 mpInstance.Logger.verbose(
                     'mParticle APV: [sdk-init] creating new PageViewTracker for this instance'
                 );
                 mpInstance._PageViewTracker = new PageViewTracker(mpInstance);
+            }
 
-                // Fire the initial page view once per page load (hard navigation).
-                // The flag survives module re-evaluation so repeated init() calls
-                // from SPA re-renders don't fire duplicate logPageView() events.
-                if (PageViewTracker.hasInitialPageViewFired()) {
-                    mpInstance.Logger.verbose(
-                        'mParticle APV: [sdk-init] initial page view already logged this page load, skipping'
-                    );
-                } else {
-                    PageViewTracker.markInitialPageViewFired();
-                    mpInstance._Events.logPageView();
-                }
-            } else {
+            // The initial page view fires once per hard page load, not once per
+            // init(): the window flag survives the module re-evaluation Next.js
+            // performs on every SPA navigation, so repeated init() calls from SPA
+            // re-renders don't fire duplicate logPageView() events.
+            if (hasInitialPageViewFired()) {
                 mpInstance.Logger.verbose(
-                    'mParticle APV: [sdk-init] tracker already on this instance, skipping logPageView'
+                    'mParticle APV: [sdk-init] initial page view already logged this page load, skipping'
                 );
+            } else {
+                markInitialPageViewFired();
+                mpInstance._Events.logPageView();
             }
+
             mpInstance._PageViewTracker.init();
         } else if (mpInstance._PageViewTracker) {
             // AutoLogPageView was disabled on re-init: tear down the active tracker

package/src/nativeSdkHelpers.interfaces.ts

@@ -1,3 +1,23 @@
+export interface IWKScriptMessageHandler {
+    postMessage(message: string): void;
+}
+
+export interface IAndroidNativeBridge {
+    [methodName: string]: ((payload?: string) => void) | undefined;
+}
+
+declare global {
+    interface Window {
+        webkit?: {
+            messageHandlers?: Record<
+                string,
+                IWKScriptMessageHandler | undefined
+            >;
+        };
+        mParticleAndroid?: IAndroidNativeBridge;
+    }
+}
+
 export interface INativeSdkHelpers {
     initializeSessionAttributes: (apiKey: string) => void;
     isBridgeV2Available: (bridgeName: string) => boolean;
@@ -9,5 +29,5 @@ export interface INativeSdkHelpers {
     sendToNative: (path: string, value?: string) => void;
     sendViaBridgeV1: (path: string, value: string) => void;
     sendViaIframeToIOS: (path: string, value: string) => void;
-    sendViaBridgeV2: (path: string, value: string, requiredWebviewBridgeName: boolean) => void;
+    sendViaBridgeV2: (path: string, value: string, requiredWebviewBridgeName: string) => void;
 }