@mparticle/web-sdk 2.80.0 → 2.81.0

package/src/identityApiClient.ts

@@ -5,19 +5,19 @@ import {
     XHRUploader,
     IFetchPayload,
 } from './uploaders';
-import { CACHE_HEADER } from './identity-utils';
+import { CACHE_HEADER, IKnownIdentities } from './identity-utils';
 import { obfuscateData, parseNumber, valueof, getErrorMessage } from './utils';
 import {
     IAliasCallback,
-    IAliasRequest,
+    IAliasNetworkRequest,
     IdentityAPIMethod,
     IIdentity,
     IIdentityAPIRequestData,
+    IIdentityAPIModifyRequestData,
 } from './identity.interfaces';
 import {
     IdentityApiData,
     MPID,
-    UserIdentities,
 } from '@mparticle/web-sdk';
 import {
     IdentityCallback,
@@ -33,17 +33,17 @@ const { Modify } = IdentityMethods;
 
 export interface IIdentityApiClient {
     sendAliasRequest: (
-        aliasRequest: IAliasRequest,
+        aliasRequest: IAliasNetworkRequest,
         aliasCallback: IAliasCallback
     ) => Promise<void>;
     sendIdentityRequest: (
-        identityApiRequest: IIdentityAPIRequestData,
+        identityApiRequest: IIdentityAPIRequestData | IIdentityAPIModifyRequestData,
         method: IdentityAPIMethod,
         callback: IdentityCallback,
         originalIdentityApiData: IdentityApiData,
         parseIdentityResponse: IIdentity['parseIdentityResponse'],
         mpid: MPID,
-        knownIdentities: UserIdentities
+        knownIdentities?: IKnownIdentities
     ) => Promise<void>;
     getUploadUrl: (method: IdentityAPIMethod, mpid: MPID) => string;
     getIdentityResponseFromFetch: (
@@ -86,7 +86,7 @@ export default function IdentityAPIClient(
     mpInstance: IMParticleWebSDKInstance
 ) {
     this.sendAliasRequest = async function(
-        aliasRequest: IAliasRequest,
+        aliasRequest: IAliasNetworkRequest,
         aliasCallback: IAliasCallback
     ) {
         const { Logger } = mpInstance;
@@ -186,13 +186,13 @@ export default function IdentityAPIClient(
     };
 
     this.sendIdentityRequest = async function(
-        identityApiRequest: IIdentityAPIRequestData,
+        identityApiRequest: IIdentityAPIRequestData | IIdentityAPIModifyRequestData,
         method: IdentityAPIMethod,
         callback: IdentityCallback,
         originalIdentityApiData: IdentityApiData,
         parseIdentityResponse: IIdentity['parseIdentityResponse'],
         mpid: MPID,
-        knownIdentities: UserIdentities
+        knownIdentities?: IKnownIdentities
     ) {
         if (mpInstance._RoktManager?.isInitialized) {
             mpInstance._Store.identifyRequestCount = (mpInstance._Store.identifyRequestCount || 0) + 1;

package/src/mp-instance.ts

@@ -37,7 +37,7 @@ import Identity from './identity';
 import Consent, { IConsent } from './consent';
 import KitBlocker from './kitBlocking';
 import ConfigAPIClient, { IKitConfigs } from './configAPIClient';
-import IdentityAPIClient from './identityApiClient';
+import IdentityAPIClient, { IIdentityApiClient } from './identityApiClient';
 import { isFunction, parseConfig, valueof, generateDeprecationMessage, extend } from './utils';
 import { DisabledVault, LocalStorageVault } from './vault';
 import { removeExpiredIdentityCacheDates, hasExplicitIdentifier } from './identity-utils';
@@ -92,7 +92,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _ForwardingStatsUploader: IForwardingStatsUploader;
     _Helpers: SDKHelpersApi;
     _Identity: IIdentity;
-    _IdentityAPIClient: typeof IdentityAPIClient;
+    _IdentityAPIClient: IIdentityApiClient;
     _IntegrationCapture: IntegrationCapture;
     _NativeSdkHelpers: INativeSdkHelpers;
     _PageViewTracker?: PageViewTracker;

package/src/persistence.interfaces.ts

@@ -1,4 +1,3 @@
-import { Context } from '@mparticle/event-models';
 import {
     IdentityApiData,
     MPID,
@@ -34,7 +33,7 @@ export interface IGlobalStoreV2MinifiedKeys {
     cgid: string; // Client Generated ID
     das: string; // Device ID/ Device Application String
     ia: IntegrationAttributes;
-    c: Context;
+    c: string | null;
     csm: MPID[]; // Current Session MPIDs
     les: number; // Last Event Sent Timestamp
     ssd: number; // Session Start Date
@@ -118,7 +117,7 @@ export interface IPersistence {
     getCookieDomain(): string;
     getDomain(doc: Document, locationHostname: string): string;
     saveUserCookieSyncDatesToPersistence(mpid: MPID, csd: CookieSyncDates): void;
-    savePersistence(persistance: IPersistenceMinified): void;
+    savePersistence(persistence: IPersistenceMinified): void;
     getPersistence(): IPersistenceMinified | null;
     getFirstSeenTime(mpid: MPID): number | null;
     setFirstSeenTime(mpid: MPID, time?: number): void;

package/src/roktManager.ts

@@ -83,6 +83,9 @@ export interface IRoktKit {
     setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
     use: <T>(name: string) => Promise<T>;
     onShoppableAdsReady(callback: () => void): void;
+    // Optional because the Rokt Kit ships on its own release cadence; a kit
+    // published before terminate() existed will not implement it.
+    terminate?: () => Promise<void>;
     launcherOptions?: Dictionary<any>;
     settings?: IRoktKitSettings;
     integrationName?: string;
@@ -479,6 +482,40 @@ export default class RoktManager {
         }
     }
 
+    /**
+     * Tears down the current Rokt launcher and removes the placements it rendered.
+     *
+     * Intended for hosts that cannot simply destroy the container element —
+     * SPA route changes and confirmation pages, for example.
+     *
+     * Unlike the other proxied methods, a call made before the kit is ready is
+     * *not* queued. Replaying a teardown against a launcher created later would
+     * silently tear down placements the caller never asked to remove; with no
+     * launcher there is nothing to terminate, so this resolves as a no-op.
+     *
+     * @example
+     * await window.mParticle.Rokt.terminate();
+     *
+     * @returns {Promise<void>} Resolves once the launcher has torn down. Never rejects.
+     */
+    public async terminate(): Promise<void> {
+        if (!this.isReady()) {
+            this.logger?.verbose('mParticle.Rokt.terminate called before the Rokt kit was ready. Nothing to terminate.');
+            return;
+        }
+
+        if (!isFunction(this.kit.terminate)) {
+            this.logger?.error('mParticle.Rokt.terminate is not supported by the attached Rokt Kit version.');
+            return;
+        }
+
+        try {
+            await this.kit.terminate();
+        } catch (error) {
+            this.logger?.error(`Failed to terminate the Rokt launcher: ${getErrorMessage(error)}`);
+        }
+    }
+
     public onShoppableAdsReady(callback: () => void): void {
         if (!this.kit || !this.isShoppableAdsLoaded) {
             this.deferredCall<void>('onShoppableAdsReady', callback);

package/src/sdkRuntimeModels.ts

@@ -6,6 +6,7 @@ import {
     SDKEventOptions,
     SDKEventAttrs,
     Callback,
+    UserIdentities,
 } from '@mparticle/web-sdk';
 import {
     IntegrationAttribute,
@@ -393,7 +394,7 @@ export interface SDKHelpersApi {
         filterList: number[]
     ): Dictionary;
     filterUserIdentities?(
-        userIdentitiesObject: Dictionary<string>,
+        userIdentitiesObject: UserIdentities | Dictionary<string>,
         filterList: number[]
     ): ISDKUserIdentity[];
     invokeAliasCallback(

package/src/store.ts

@@ -1,4 +1,4 @@
-import { Batch, Context } from '@mparticle/event-models';
+import { Batch } from '@mparticle/event-models';
 import {
     DataPlanConfig,
     MPID,
@@ -160,6 +160,7 @@ export interface IFeatureFlags {
 export interface IStore {
     isEnabled: boolean;
     isInitialized: boolean;
+    mpid: MPID;
 
     // Session Attributes are persistent attributes that are tied to the current session and
     // are uploaded then cleared when the session ends.
@@ -186,7 +187,7 @@ export interface IStore {
     eventQueue: SDKEvent[];
     currencyCode: string | null;
     globalTimer: number | null;
-    context: Context | null;
+    context: string | null;
     configurationLoaded: boolean;
     identityCallInFlight: boolean;
     identityCallFailed: boolean;
@@ -204,7 +205,7 @@ export interface IStore {
     activeForwarders: ConfiguredKit[];
     kits: Dictionary<MPForwarder>;
     sideloadedKits: MPForwarder[];
-    configuredForwarders: MPForwarder[];
+    configuredForwarders: ConfiguredKit[];
     pixelConfigurations: IPixelConfiguration[];
     integrationDelayTimeoutStart: number; // UNIX Timestamp
     webviewBridgeEnabled?: boolean;