@mparticle/web-sdk 2.79.2 → 2.80.0

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;
 }

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

@@ -1,13 +1,40 @@
 import Constants from './constants';
+import { IMParticleWebSDKInstance } from './mp-instance';
+import {
+    IAndroidNativeBridge,
+    INativeSdkHelpers,
+} from './nativeSdkHelpers.interfaces';
 
-var Messages = Constants.Messages;
+const Messages = Constants.Messages;
 
-var androidBridgeNameBase = 'mParticleAndroid';
-var iosBridgeNameBase = 'mParticle';
+const androidBridgeNameBase = 'mParticleAndroid';
+const iosBridgeNameBase = 'mParticle';
 
-export default function NativeSdkHelpers(mpInstance) {
-    var self = this;
-    this.initializeSessionAttributes = function(apiKey) {
+function getAndroidBridge(name: string): IAndroidNativeBridge | undefined {
+    if (!Object.prototype.hasOwnProperty.call(window, name)) {
+        return undefined;
+    }
+
+    return (window as unknown as Record<string, IAndroidNativeBridge | undefined>)[
+        name
+    ];
+}
+
+function getInstanceNamedValue(
+    instance: IMParticleWebSDKInstance,
+    name: string
+): unknown {
+    return (instance as IMParticleWebSDKInstance & Record<string, unknown>)[
+        name
+    ];
+}
+
+export default function NativeSdkHelpers(
+    this: INativeSdkHelpers,
+    mpInstance: IMParticleWebSDKInstance
+): void {
+    const self = this;
+    this.initializeSessionAttributes = function(apiKey: string): void {
         const { SetSessionAttribute } = Constants.NativeSdkPaths;
         const env = JSON.stringify({
             key: '$src_env',
@@ -25,20 +52,16 @@ export default function NativeSdkHelpers(mpInstance) {
         }
     };
 
-    this.isBridgeV2Available = function(bridgeName) {
+    this.isBridgeV2Available = function(bridgeName: string): boolean {
         if (!bridgeName) {
             return false;
         }
-        var androidBridgeName =
+        const androidBridgeName =
             androidBridgeNameBase + '_' + bridgeName + '_v2';
-        var iosBridgeName = iosBridgeNameBase + '_' + bridgeName + '_v2';
+        const iosBridgeName = iosBridgeNameBase + '_' + bridgeName + '_v2';
 
         // iOS v2 bridge
-        if (
-            window.webkit &&
-            window.webkit.messageHandlers &&
-            window.webkit.messageHandlers.hasOwnProperty(iosBridgeName)
-        ) {
+        if (window.webkit?.messageHandlers?.hasOwnProperty(iosBridgeName)) {
             return true;
         }
         // other iOS v2 bridge
@@ -58,9 +81,9 @@ export default function NativeSdkHelpers(mpInstance) {
     };
 
     this.isWebviewEnabled = function(
-        requiredWebviewBridgeName,
-        minWebviewBridgeVersion
-    ) {
+        requiredWebviewBridgeName: string,
+        minWebviewBridgeVersion: number
+    ): boolean {
         mpInstance._Store.bridgeV2Available = self.isBridgeV2Available(
             requiredWebviewBridgeName
         );
@@ -92,7 +115,7 @@ export default function NativeSdkHelpers(mpInstance) {
         return false;
     };
 
-    this.isBridgeV1Available = function() {
+    this.isBridgeV1Available = function(): boolean {
         if (
             mpInstance._Store.SDKConfig.useNativeSdk ||
             window.mParticleAndroid ||
@@ -104,7 +127,7 @@ export default function NativeSdkHelpers(mpInstance) {
         return false;
     };
 
-    this.sendToNative = function(path, value) {
+    this.sendToNative = function(path: string, value?: string): void {
         if (
             mpInstance._Store.bridgeV2Available &&
             mpInstance._Store.SDKConfig.minWebviewBridgeVersion === 2
@@ -136,7 +159,7 @@ export default function NativeSdkHelpers(mpInstance) {
         }
     };
 
-    this.sendViaBridgeV1 = function(path, value) {
+    this.sendViaBridgeV1 = function(path: string, value: string): void {
         if (
             window.mParticleAndroid &&
             window.mParticleAndroid.hasOwnProperty(path)
@@ -153,8 +176,8 @@ export default function NativeSdkHelpers(mpInstance) {
         }
     };
 
-    this.sendViaIframeToIOS = function(path, value) {
-        var iframe = document.createElement('IFRAME');
+    this.sendViaIframeToIOS = function(path: string, value: string): void {
+        const iframe = document.createElement('IFRAME');
         iframe.setAttribute(
             'src',
             'mp-sdk://' + path + '/' + encodeURIComponent(value)
@@ -163,30 +186,32 @@ export default function NativeSdkHelpers(mpInstance) {
         iframe.parentNode.removeChild(iframe);
     };
 
-    this.sendViaBridgeV2 = function(path, value, requiredWebviewBridgeName) {
+    this.sendViaBridgeV2 = function(
+        path: string,
+        value: string,
+        requiredWebviewBridgeName: string
+    ): void {
         if (!requiredWebviewBridgeName) {
             return;
         }
 
-        var androidBridgeName =
+        const androidBridgeName =
                 androidBridgeNameBase + '_' + requiredWebviewBridgeName + '_v2',
-            androidBridge = window[androidBridgeName],
+            androidBridge = getAndroidBridge(androidBridgeName),
             iosBridgeName =
-                iosBridgeNameBase + '_' + requiredWebviewBridgeName + '_v2',
-            iOSBridgeMessageHandler,
-            iOSBridgeNonMessageHandler;
+                iosBridgeNameBase + '_' + requiredWebviewBridgeName + '_v2';
+        let iOSBridgeMessageHandler, iOSBridgeNonMessageHandler;
 
-        if (
-            window.webkit &&
-            window.webkit.messageHandlers &&
-            window.webkit.messageHandlers[iosBridgeName]
-        ) {
+        if (window.webkit?.messageHandlers?.[iosBridgeName]) {
             iOSBridgeMessageHandler =
                 window.webkit.messageHandlers[iosBridgeName];
         }
 
         if (mpInstance.uiwebviewBridgeName === iosBridgeName) {
-            iOSBridgeNonMessageHandler = mpInstance[iosBridgeName];
+            iOSBridgeNonMessageHandler = getInstanceNamedValue(
+                mpInstance,
+                iosBridgeName
+            );
         }
 
         if (androidBridge && androidBridge.hasOwnProperty(path)) {