@mparticle/web-sdk 2.80.0 → 2.81.0

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

@@ -7,6 +7,7 @@ export interface IKitConfigs extends IKitFilterSettings {
     suffix?: string;
     moduleId: number;
     isDebug: boolean;
+    isSandbox?: boolean;
     isVisible: boolean;
     isDebugString: BooleanStringLowerCase;
     hasDebugString: BooleanStringLowerCase;

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

@@ -1,53 +1,3 @@
-export default function Ecommerce(mpInstance: any): void;
-export default class Ecommerce {
-    constructor(mpInstance: any);
-    convertTransactionAttributesToProductAction: (transactionAttributes: any, productAction: any) => void;
-    calculateProductActionTotalAmount: (productAction: any) => any;
-    getProductActionEventName: (productActionType: any) => "AddToCart" | "AddToWishlist" | "Checkout" | "CheckoutOption" | "Click" | "Purchase" | "Refund" | "RemoveFromCart" | "RemoveFromWishlist" | "ViewDetail" | "ViewCart" | "AddShippingInfo" | "AddPaymentInfo" | "PaymentMethodSelected" | "PaymentAttempted" | "PaymentSucceeded" | "PaymentFailed" | "RefundInitiated" | "Unknown";
-    getPromotionActionEventName: (promotionActionType: any) => "Unknown" | "PromotionClick" | "PromotionView";
-    convertProductActionToEventType: (productActionType: any) => 0 | 20 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 21;
-    convertPromotionActionToEventType: (promotionActionType: any) => 18 | 19;
-    generateExpandedEcommerceName: (eventName: any, plusOne: any) => string;
-    extractProductAttributes: (attributes: any, product: any) => void;
-    extractTransactionId: (attributes: any, productAction: any) => void;
-    extractActionAttributes: (attributes: any, productAction: any) => void;
-    extractPromotionAttributes: (attributes: any, promotion: any) => void;
-    buildProductList: (event: any, product: any) => any;
-    createProduct: (name: any, sku: any, price: any, quantity: any, variant: any, category: any, brand: any, position: any, couponCode: any, attributes: any) => {
-        Name: string;
-        Sku: any;
-        Price: any;
-        Quantity: any;
-        Brand: any;
-        Variant: any;
-        Category: any;
-        Position: any;
-        CouponCode: any;
-        TotalAmount: number;
-        Attributes: any;
-    };
-    createPromotion: (id: any, creative: any, name: any, position: any) => {
-        Id: any;
-        Creative: any;
-        Name: any;
-        Position: any;
-    };
-    createImpression: (name: any, product: any) => {
-        Name: string;
-        Product: any;
-    };
-    createTransactionAttributes: (id: any, affiliation: any, couponCode: any, revenue: any, shipping: any, tax: any) => {
-        Id: any;
-        Affiliation: any;
-        CouponCode: any;
-        Revenue: any;
-        Shipping: any;
-        Tax: any;
-    };
-    expandProductImpression: (commerceEvent: any) => any[];
-    expandCommerceEvent: (event: any) => any[];
-    expandPromotionAction: (commerceEvent: any) => any[];
-    expandProductAction: (commerceEvent: any) => any[];
-    createCommerceEventObject: (customFlags: any, options: any) => any;
-    sanitizeAmount: (amount: any, category: any) => any;
-}
+import { IMParticleWebSDKInstance } from './mp-instance';
+import { IECommerce } from './ecommerce.interfaces';
+export default function Ecommerce(this: IECommerce, mpInstance: IMParticleWebSDKInstance): void;

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

@@ -1,14 +1,13 @@
-import { ProductAction, Product, Promotion, CommerceEvent } from '@mparticle/event-models';
 import { SDKEventAttrs, SDKEventOptions, TransactionAttributes } from '@mparticle/web-sdk';
 import { valueof } from './utils';
 import { ProductActionType, PromotionActionType } from './types';
 import { SDKEvent, SDKEventCustomFlags, SDKImpression, SDKProduct, SDKProductAction, SDKPromotion } from './sdkRuntimeModels';
 interface IECommerceShared {
     createProduct(name: string, sku: string | number, price: string | number, quantity?: string | number, variant?: string, category?: string, brand?: string, position?: number, couponCode?: string, attributes?: SDKEventAttrs): SDKProduct | null;
-    createImpression(name: string, product: Product): SDKImpression | null;
+    createImpression(name: string, product: SDKProduct): SDKImpression | null;
     createPromotion(id: string | number, creative?: string, name?: string, position?: number): SDKPromotion | null;
     createTransactionAttributes(id: string | number, affiliation?: string, couponCode?: string, revenue?: string | number, shipping?: string | number, tax?: number): TransactionAttributes | null;
-    expandCommerceEvent(event: CommerceEvent): SDKEvent[] | null;
+    expandCommerceEvent(event: SDKEvent): SDKEvent[] | null;
 }
 export interface SDKCart {
     add(product: SDKProduct | SDKProduct[], logEvent?: boolean): void;
@@ -19,7 +18,7 @@ export interface SDKECommerceAPI extends IECommerceShared {
     logCheckout(step: number, option?: string, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags): void;
     logImpression(impression: SDKImpression | SDKImpression[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
     logProductAction(productActionType: valueof<typeof ProductActionType>, product: SDKProduct | SDKProduct[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, transactionAttributes?: TransactionAttributes, eventOptions?: SDKEventOptions): void;
-    logPromotion(type: valueof<typeof PromotionActionType>, promotion: SDKPromotion, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
+    logPromotion(type: valueof<typeof PromotionActionType>, promotion: SDKPromotion | SDKPromotion[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
     setCurrencyCode(code: string): void;
     Cart: SDKCart;
     logPurchase(transactionAttributes: TransactionAttributes, product: SDKProduct | SDKProduct[], clearCart?: boolean, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags): void;
@@ -64,14 +63,14 @@ export interface IECommerce extends IECommerceShared {
     calculateProductActionTotalAmount(productAction: SDKProductAction): SDKProductAction;
     convertTransactionAttributesToProductAction(transactionAttributes: TransactionAttributes, productAction: SDKProductAction): void;
     createCommerceEventObject(customFlags: SDKEventCustomFlags, options?: SDKEventOptions): SDKEvent | null;
-    expandProductAction(commerceEvent: CommerceEvent): SDKEvent[];
-    expandProductImpression(commerceEvent: CommerceEvent): SDKEvent[];
-    expandPromotionAction(commerceEvent: CommerceEvent): SDKEvent[];
-    extractActionAttributes(attributes: ExtractedActionAttributes, productAction: ProductAction): void;
-    extractProductAttributes(attributes: ExtractedProductAttributes, product: Product): void;
-    extractPromotionAttributes(attributes: ExtractedPromotionAttributes, promotion: Promotion): void;
-    extractTransactionId(attributes: ExtractedTransactionId, productAction: ProductAction): void;
-    generateExpandedEcommerceName(eventName: string, plusOne: boolean): string;
+    expandProductAction(commerceEvent: SDKEvent): SDKEvent[];
+    expandProductImpression(commerceEvent: SDKEvent): SDKEvent[];
+    expandPromotionAction(commerceEvent: SDKEvent): SDKEvent[];
+    extractActionAttributes(attributes: ExtractedActionAttributes, productAction: SDKProductAction): void;
+    extractProductAttributes(attributes: ExtractedProductAttributes, product: SDKProduct): void;
+    extractPromotionAttributes(attributes: ExtractedPromotionAttributes, promotion: SDKPromotion): void;
+    extractTransactionId(attributes: ExtractedTransactionId, productAction: SDKProductAction): void;
+    generateExpandedEcommerceName(eventName: string, plusOne?: boolean): string;
     getProductActionEventName(productActionType: valueof<typeof ProductActionType>): string;
     getPromotionActionEventName(promotionActionType: valueof<typeof PromotionActionType>): string;
     sanitizeAmount(amount: string | number, category: string): number;

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

@@ -13,7 +13,7 @@ export interface IEvents {
     logOptOut(): void;
     logPageView(): void;
     logProductActionEvent(productActionType: valueof<typeof ProductActionType>, product: SDKProduct | SDKProduct[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, transactionAttributes?: TransactionAttributes, eventOptions?: SDKEventOptions): void;
-    logPromotionEvent(promotionType: valueof<typeof PromotionActionType>, promotion: SDKPromotion, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
+    logPromotionEvent(promotionType: valueof<typeof PromotionActionType>, promotion: SDKPromotion | SDKPromotion[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
     logPurchaseEvent(transactionAttributes: TransactionAttributes, product: SDKProduct | SDKProduct[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags): void;
     logRefundEvent(transactionAttributes: TransactionAttributes, product: SDKProduct | SDKProduct[], attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags): void;
     startTracking(callback: Callback): void;

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

@@ -1,26 +1,4 @@
-export default function Forwarders(mpInstance: any, kitBlocker: any): void;
-export default class Forwarders {
-    constructor(mpInstance: any, kitBlocker: any);
-    forwarderStatsUploader: any;
-    initForwarders: (userIdentities: any, forwardingStatsCallback: any) => void;
-    isEnabledForUserAttributes: (filterObject: any, user: any) => boolean;
-    isEnabledForUnknownUser: (excludeAnonymousUserBoolean: any, user: any) => boolean;
-    applyToForwarders: (functionName: any, functionArgs: any) => void;
-    sendEventToForwarders: (event: any) => void;
-    handleForwarderUserAttributes: (functionNameKey: any, key: any, value: any) => void;
-    setForwarderUserIdentities: (userIdentities: any) => void;
-    setForwarderOnUserIdentified: (user: any) => void;
-    setForwarderOnIdentityComplete: (user: any, identityMethod: any) => void;
-    getForwarderStatsQueue: () => any;
-    setForwarderStatsQueue: (queue: any) => void;
-    processForwarders: (config: any, forwardingStatsCallback: any) => void;
-    processUIEnabledKits: (config: any) => void;
-    returnKitConstructors: () => {};
-    configureUIEnabledKit: (configuration: any, kits: any) => void;
-    processSideloadedKits: (mpConfig: any) => void;
-    configureSideloadedKit: (kitConstructor: any) => void;
-    returnConfiguredKit: (forwarder: any, config?: {}) => any;
-    configurePixel: (settings: any) => void;
-    processPixelConfigs: (config: any) => void;
-    sendSingleForwardingStatsToServer: (forwardingStatsData: any) => Promise<void>;
-}
+import { IMParticleWebSDKInstance } from './mp-instance';
+import KitBlocker from './kitBlocking';
+import { IForwarders } from './forwarders.interfaces';
+export default function Forwarders(this: IForwarders, mpInstance: IMParticleWebSDKInstance, kitBlocker: KitBlocker): void;

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

@@ -1,9 +1,13 @@
-import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
+import { SDKEvent, SDKEventCustomFlags, SDKInitConfig, SDKLoggerApi } from './sdkRuntimeModels';
 import { Dictionary } from './utils';
-import { IKitConfigs, IKitFilterSettings } from './configAPIClient';
-import { IdentityApiData, IdentityType } from '@mparticle/web-sdk';
+import { IKitConfigs, IKitFilterSettings, IFilteringUserAttributeValue } from './configAPIClient';
+import { IdentityApiData, IdentityType, UserIdentities } from '@mparticle/web-sdk';
 import { Batch } from '@mparticle/event-models';
+import { IForwardingStatsData } from './apiClient';
+import { AsyncUploader } from './uploaders';
+import { IPixelConfiguration } from './cookieSyncManager';
 import { IMParticleUser, ISDKUserIdentity, UserAttributes } from './identity-user-interfaces';
+import type { IFilteredMparticleUser } from './filteredMparticleUser';
 export type MPForwarder = Dictionary;
 export interface UnregisteredKit {
     constructor: () => void;
@@ -22,19 +26,22 @@ export interface KitRegistrationConfig {
 export interface ConfiguredKit extends Omit<IKitConfigs, 'isDebugString' | 'hasDebugString'> {
     common: Dictionary<unknown>;
     id: number;
-    init(settings: Dictionary<unknown>, service: forwardingStatsCallback, testMode: boolean, trackerId: string | null, userAttributes: UserAttributes, userIdentities: ISDKUserIdentity, appVersion: string, appName: string, customFlags: SDKEventCustomFlags, clientId: string): string;
-    onIdentifyComplete(user: IMParticleUser, filteredIdentityRequest: IdentityApiData): string;
-    onLoginComplete(user: IMParticleUser, filteredIdentityRequest: IdentityApiData): string;
-    onLogoutComplete(user: IMParticleUser, filteredIdentityRequest: IdentityApiData): string;
-    onModifyComplete(user: IMParticleUser, filteredIdentityRequest: IdentityApiData): string;
-    onUserIdentified(user: IMParticleUser): string;
+    init(settings: Dictionary<unknown>, service: forwardingStatsCallback, testMode: boolean, trackerId: string | null, userAttributes: UserAttributes, userIdentities: ISDKUserIdentity[], appVersion: string, appName: string, customFlags: SDKEventCustomFlags, clientId: string): string;
+    onIdentifyComplete(user: IFilteredMparticleUser, filteredIdentityRequest: IdentityApiData): string;
+    onLoginComplete(user: IFilteredMparticleUser, filteredIdentityRequest: IdentityApiData): string;
+    onLogoutComplete(user: IFilteredMparticleUser, filteredIdentityRequest: IdentityApiData): string;
+    onModifyComplete(user: IFilteredMparticleUser, filteredIdentityRequest: IdentityApiData): string;
+    onUserIdentified(user: IFilteredMparticleUser): string;
     process(event: SDKEvent): string;
     setOptOut(isOptingOut: boolean): string;
     removeUserAttribute(key: string): string;
     setUserAttribute(key: string, value: string): string;
-    setUserIdentity(id: UserIdentityId, type: UserIdentityType): void;
+    setUserIdentity(id: UserIdentityId, type: UserIdentityType): string | void;
+    logOut?(evt: SDKEvent): void;
     isSandbox: boolean;
     hasSandbox: boolean;
+    initialized?: boolean;
+    logger?: SDKLoggerApi;
 }
 export interface KitInterface {
     id: number;
@@ -57,3 +64,27 @@ export type UserIdentityType = number;
 export type UserAttributeFilters = number[];
 export type UserIdentityFilters = typeof IdentityType[];
 export type forwardingStatsCallback = (forwarder: ConfiguredKit, event: SDKEvent) => void;
+export interface IForwarders {
+    forwarderStatsUploader: AsyncUploader;
+    initForwarders(userIdentities: UserIdentities, forwardingStatsCallback: forwardingStatsCallback): void;
+    isEnabledForUserAttributes(filterObject: Partial<IFilteringUserAttributeValue>, user: IMParticleUser): boolean;
+    isEnabledForUnknownUser(excludeAnonymousUserBoolean: boolean, user: IMParticleUser): boolean;
+    applyToForwarders(functionName: string, functionArgs: unknown): void;
+    sendEventToForwarders(event: SDKEvent): void;
+    handleForwarderUserAttributes(functionNameKey: string, key: string, value: string): void;
+    setForwarderUserIdentities(userIdentities: UserIdentities): void;
+    setForwarderOnUserIdentified(user: IMParticleUser): void;
+    setForwarderOnIdentityComplete(user: IMParticleUser, identityMethod: string): void;
+    getForwarderStatsQueue(): IForwardingStatsData[];
+    setForwarderStatsQueue(queue: IForwardingStatsData[]): void;
+    processForwarders(config: SDKInitConfig, forwardingStatsCallback: forwardingStatsCallback): void;
+    processUIEnabledKits(config: SDKInitConfig): void;
+    returnKitConstructors(): Dictionary<RegisteredKit>;
+    configureUIEnabledKit(configuration: IKitConfigs, kits: Dictionary<RegisteredKit>): void;
+    processSideloadedKits(mpConfig: SDKInitConfig): void;
+    configureSideloadedKit(kitConstructor: RegisteredKit): void;
+    returnConfiguredKit(forwarder: RegisteredKit, config?: Partial<IKitConfigs>): ConfiguredKit;
+    configurePixel(settings: IPixelConfiguration): void;
+    processPixelConfigs(config: SDKInitConfig): void;
+    sendSingleForwardingStatsToServer(forwardingStatsData: IForwardingStatsData): Promise<void>;
+}

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

@@ -1,14 +1,14 @@
 import { Dictionary, Environment } from './utils';
 import { BaseVault } from './vault';
-import { IdentityApiData, UserIdentities, IdentityCallback } from '@mparticle/web-sdk';
+import { IdentityApiData, UserIdentities } from '@mparticle/web-sdk';
 import { IdentityAPIMethod } from './identity.interfaces';
-import { IIdentityResponse, IMParticleUser } from './identity-user-interfaces';
+import { IdentityCallback, IIdentityResponse, IMParticleUser } from './identity-user-interfaces';
 import { IStore } from './store';
 import type { IMParticleWebSDKInstance } from './mp-instance';
 import { IIdentitySearchRequestBody, IdentitySearchCallback } from './identity/search';
 export declare const CACHE_HEADER: "x-mp-max-age";
 export type IdentityCache = BaseVault<Dictionary<ICachedIdentityCall>>;
-export type IParseCachedIdentityResponse = (cachedIdentity: IIdentityResponse, mpid: string, callback: IdentityCallback, identityApiData: IdentityApiData, identityMethod: string, knownIdentities: IKnownIdentities, fromCachedIdentity: boolean) => void;
+export type IParseCachedIdentityResponse = (cachedIdentity: IIdentityResponse, mpid: string, callback: IdentityCallback, identityApiData: IdentityApiData, identityMethod: IdentityAPIMethod, knownIdentities: IKnownIdentities, fromCachedIdentity: boolean) => void;
 export interface IKnownIdentities extends UserIdentities {
     device_application_stamp?: string;
 }

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

@@ -0,0 +1,3 @@
+import { IIdentity } from './identity.interfaces';
+import { IMParticleWebSDKInstance } from './mp-instance';
+export default function Identity(this: IIdentity, mpInstance: IMParticleWebSDKInstance): void;

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

@@ -6,7 +6,7 @@ import { Dictionary, Environment, valueof } from './utils';
 import Constants from './constants';
 import { IdentityCallback, IUserAttributeChangeEvent, IUserIdentityChangeEvent, IMParticleUser, mParticleUserCart, IIdentityResponse } from './identity-user-interfaces';
 import { IdentitySearchCallback } from './identity/search';
-declare const platform: "web", sdkVendor: "mparticle", sdkVersion: string, HTTPCodes: {
+declare const HTTPCodes: {
     readonly noHttpCoverage: -1;
     readonly activeIdentityRequest: -2;
     readonly activeSession: -3;
@@ -18,6 +18,7 @@ declare const platform: "web", sdkVendor: "mparticle", sdkVersion: string, HTTPC
 export type IdentityPreProcessResult = {
     valid: boolean;
     error?: string;
+    cleanedIdentities?: IdentityApiData;
 };
 export type IdentityAPIMethod = valueof<typeof Constants.IdentityMethods>;
 export declare enum SDKIdentityTypeEnum {
@@ -46,14 +47,14 @@ export declare enum SDKIdentityTypeEnum {
 }
 export interface IIdentityAPIRequestData {
     client_sdk: {
-        platform: typeof platform;
-        sdk_vendor: typeof sdkVendor;
-        sdk_version: typeof sdkVersion;
+        platform: string;
+        sdk_vendor: string;
+        sdk_version: string;
     };
     context: string | null;
     environment: Environment;
     request_id: string;
-    request_timestamp_unixtime_ms: number;
+    request_timestamp_ms: number;
     previous_mpid: MPID | null;
     known_identities: IKnownIdentities;
 }
@@ -69,9 +70,13 @@ export interface IIdentityRequest {
     combineUserIdentities(previousUIByName: UserIdentities, newUIByName: UserIdentities): UserIdentities;
     createIdentityRequest(identityApiData: IdentityApiData, platform: string, sdkVendor: string, sdkVersion: string, deviceId: string, context: string | null, mpid: MPID): IIdentityAPIRequestData;
     createModifyIdentityRequest(currentUserIdentities: UserIdentities, newUserIdentities: UserIdentities, platform: string, sdkVendor: string, sdkVersion: string, context: string | null): IIdentityAPIModifyRequestData;
-    createIdentityChanges(previousIdentities: UserIdentities, newIdentitie: UserIdentities): IIdentityAPIIdentityChangeData;
+    createIdentityChanges(previousIdentities: UserIdentities, newIdentities: UserIdentities): IIdentityAPIIdentityChangeData[];
     preProcessIdentityRequest(identityApiData: IdentityApiData, callback: IdentityCallback, method: IdentityAPIMethod): IdentityPreProcessResult;
+    createAliasNetworkRequest(aliasRequest: IAliasRequest): IAliasNetworkRequest;
+    convertAliasToNative(aliasRequest: IAliasRequest): IAliasNativeRequest;
+    convertToNative(identityApiData: IdentityApiData): IIdentityNativeRequest | undefined;
 }
+export type UserAttributeChangeValue = string | string[] | null;
 export type AliasRequestScope = 'device' | 'mpid';
 export interface IAliasRequest {
     destinationMpid: MPID;
@@ -80,6 +85,33 @@ export interface IAliasRequest {
     endTime: number;
     scope?: AliasRequestScope;
 }
+export interface IAliasNetworkRequest {
+    request_id: string;
+    request_type: 'alias';
+    environment: Environment;
+    api_key: string;
+    data: {
+        destination_mpid: MPID;
+        source_mpid: MPID;
+        start_unixtime_ms: number;
+        end_unixtime_ms: number;
+        scope?: AliasRequestScope;
+        device_application_stamp: string;
+    };
+}
+export interface IAliasNativeRequest {
+    DestinationMpid: MPID;
+    SourceMpid: MPID;
+    StartUnixtimeMs: number;
+    EndUnixtimeMs: number;
+    Scope?: AliasRequestScope;
+}
+export interface IIdentityNativeRequest {
+    UserIdentities: Array<{
+        Type: number;
+        Identity: string;
+    }>;
+}
 export interface IAliasCallback {
     (result: IAliasResult): void;
 }
@@ -96,7 +128,7 @@ export interface SDKIdentityApi {
     getCurrentUser?(): IMParticleUser;
     getUser?(mpid: string): IMParticleUser;
     getUsers?(): IMParticleUser[];
-    aliasUsers?(aliasRequest?: IAliasRequest, callback?: IdentityCallback): void;
+    aliasUsers?(aliasRequest?: IAliasRequest, callback?: IAliasCallback): void;
     createAliasRequest?(sourceUser: IMParticleUser, destinationUser: IMParticleUser, scope?: AliasRequestScope): IAliasRequest;
     /**
      * Sends a request to mParticle's IDSync `/v1/search` endpoint to look up
@@ -140,12 +172,14 @@ export interface IIdentity {
     idCache: BaseVault<Dictionary<ICachedIdentityCall>>;
     IdentityAPI: SDKIdentityApi;
     IdentityRequest: IIdentityRequest;
-    mParticleUser(mpid: MPID, IsLoggedIn: boolean): IMParticleUser;
-    createUserAttributeChange(key: string, newValue: string, previousUserAttributeValue: string, isNewAttribute: boolean, deleted: boolean, user: IMParticleUser): IUserAttributeChangeEvent;
+    mParticleUser(mpid?: MPID, IsLoggedIn?: boolean): IMParticleUser;
+    createUserAttributeChange(key: string, newValue: UserAttributeChangeValue, previousUserAttributeValue: UserAttributeChangeValue, isNewAttribute: boolean, deleted: boolean, user: IMParticleUser): IUserAttributeChangeEvent;
     createUserIdentityChange(identityType: SDKIdentityTypeEnum, newIdentity: string, oldIdentity: string, newCreatedThisBatch: boolean, userInMemory: IMParticleUser): IUserIdentityChangeEvent;
-    parseIdentityResponse(identityResponse: IIdentityResponse, previousMPID: MPID, callback: IdentityCallback, identityApiData: IdentityApiData, method: IdentityAPIMethod, knownIdentities: UserIdentities, parsingCachedResponse: boolean): void;
-    sendUserAttributeChangeEvent(attributeKey: string, newUserAttributeValue: string, previousUserAttributeValue: string, isNewAttribute: boolean, deleted: boolean, user: IMParticleUser): void;
+    parseIdentityResponse(identityResponse: IIdentityResponse, previousMPID: MPID, callback: IdentityCallback, identityApiData: IdentityApiData, method: IdentityAPIMethod, knownIdentities: IKnownIdentities, parsingCachedResponse: boolean): void;
+    sendUserAttributeChangeEvent(attributeKey: string, newUserAttributeValue: UserAttributeChangeValue, previousUserAttributeValue: UserAttributeChangeValue, isNewAttribute: boolean, deleted: boolean, user: IMParticleUser): void;
     sendUserIdentityChangeEvent(newUserIdentities: UserIdentities, method: IdentityAPIMethod, mpid: MPID, prevUserIdentities: UserIdentities): void;
+    reinitForwardersOnUserChange(prevUser: IMParticleUser, newUser: IMParticleUser): void;
+    setForwarderCallbacks(user: IMParticleUser, method: IdentityAPIMethod): void;
     /**
      * @deprecated
      */

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

@@ -1,10 +1,11 @@
-import { IAliasCallback, IAliasRequest, IdentityAPIMethod, IIdentity, IIdentityAPIRequestData } from './identity.interfaces';
-import { IdentityApiData, MPID, UserIdentities } from '@mparticle/web-sdk';
+import { IKnownIdentities } from './identity-utils';
+import { IAliasCallback, IAliasNetworkRequest, IdentityAPIMethod, IIdentity, IIdentityAPIRequestData, IIdentityAPIModifyRequestData } from './identity.interfaces';
+import { IdentityApiData, MPID } from '@mparticle/web-sdk';
 import { IdentityCallback, IdentityResultBody, IIdentityResponse } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
 export interface IIdentityApiClient {
-    sendAliasRequest: (aliasRequest: IAliasRequest, aliasCallback: IAliasCallback) => Promise<void>;
-    sendIdentityRequest: (identityApiRequest: IIdentityAPIRequestData, method: IdentityAPIMethod, callback: IdentityCallback, originalIdentityApiData: IdentityApiData, parseIdentityResponse: IIdentity['parseIdentityResponse'], mpid: MPID, knownIdentities: UserIdentities) => Promise<void>;
+    sendAliasRequest: (aliasRequest: IAliasNetworkRequest, aliasCallback: IAliasCallback) => Promise<void>;
+    sendIdentityRequest: (identityApiRequest: IIdentityAPIRequestData | IIdentityAPIModifyRequestData, method: IdentityAPIMethod, callback: IdentityCallback, originalIdentityApiData: IdentityApiData, parseIdentityResponse: IIdentity['parseIdentityResponse'], mpid: MPID, knownIdentities?: IKnownIdentities) => Promise<void>;
     getUploadUrl: (method: IdentityAPIMethod, mpid: MPID) => string;
     getIdentityResponseFromFetch: (response: Response, responseBody: IdentityResultBody) => IIdentityResponse;
     getIdentityResponseFromXHR: (response: XMLHttpRequest) => IIdentityResponse;

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

@@ -5,7 +5,7 @@ import { IStore } from './store';
 import { IServerModel } from './serverModel';
 import { IForwardingStatsUploader } from './forwardingStatsUploader';
 import { IConsent } from './consent';
-import IdentityAPIClient from './identityApiClient';
+import { IIdentityApiClient } from './identityApiClient';
 import IntegrationCapture from './integrationCapture';
 import { IPreInit } from './pre-init-utils';
 import { MParticleWebSDK, SDKHelpersApi } from './sdkRuntimeModels';
@@ -42,7 +42,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _ForwardingStatsUploader: IForwardingStatsUploader;
     _Helpers: SDKHelpersApi;
     _Identity: IIdentity;
-    _IdentityAPIClient: typeof IdentityAPIClient;
+    _IdentityAPIClient: IIdentityApiClient;
     _IntegrationCapture: IntegrationCapture;
     _NativeSdkHelpers: INativeSdkHelpers;
     _PageViewTracker?: PageViewTracker;

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

@@ -1,4 +1,3 @@
-import { Context } from '@mparticle/event-models';
 import { IdentityApiData, MPID, Product, UserIdentities } from '@mparticle/web-sdk';
 import { IForwardingStatsData } from './apiClient';
 import { IntegrationAttributes, ServerSettings, SessionAttributes, LocalSessionAttributes } from './store';
@@ -22,7 +21,7 @@ export interface IGlobalStoreV2MinifiedKeys {
     cgid: string;
     das: string;
     ia: IntegrationAttributes;
-    c: Context;
+    c: string | null;
     csm: MPID[];
     les: number;
     ssd: number;
@@ -59,7 +58,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/dist/types/src/roktManager.d.ts

@@ -57,6 +57,7 @@ export interface IRoktKit {
     setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
     use: <T>(name: string) => Promise<T>;
     onShoppableAdsReady(callback: () => void): void;
+    terminate?: () => Promise<void>;
     launcherOptions?: Dictionary<any>;
     settings?: IRoktKitSettings;
     integrationName?: string;
@@ -136,6 +137,23 @@ export default class RoktManager {
     hashAttributes(attributes: RoktAttributes): Promise<RoktAttributes>;
     setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
     use<T>(name: string): Promise<T>;
+    /**
+     * 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.
+     */
+    terminate(): Promise<void>;
     onShoppableAdsReady(callback: () => void): void;
     flushOnShoppableAdsReadyMessageQueue(kit: IRoktKit): void;
     /**

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

@@ -1,6 +1,6 @@
 import * as EventsApi from '@mparticle/event-models';
 import { DataPlanVersion } from '@mparticle/data-planning-models';
-import { MPConfiguration, MPID, SDKEventOptions, SDKEventAttrs, Callback } from '@mparticle/web-sdk';
+import { MPConfiguration, MPID, SDKEventOptions, SDKEventAttrs, Callback, UserIdentities } from '@mparticle/web-sdk';
 import { IntegrationAttribute, IntegrationAttributes, IStore, WrapperSDKTypes } from './store';
 import Validators from './validators';
 import { Dictionary, valueof } from './utils';
@@ -272,7 +272,7 @@ export interface SDKHelpersApi {
     converted?(s: string): string;
     filterUserIdentitiesForForwarders(userIdentities: Dictionary, filterList: number[]): Dictionary;
     filterUserAttributes(userAttributes: Dictionary, filterList: number[]): Dictionary;
-    filterUserIdentities?(userIdentitiesObject: Dictionary<string>, filterList: number[]): ISDKUserIdentity[];
+    filterUserIdentities?(userIdentitiesObject: UserIdentities | Dictionary<string>, filterList: number[]): ISDKUserIdentity[];
     invokeAliasCallback(aliasCallback: IAliasCallback, number: number, errorMessage?: string): void;
     isDelayedByIntegration?(delayedIntegrations: Dictionary<boolean>, timeoutStart: number, now: number): boolean;
     isEventType?(type: valueof<typeof EventType>): boolean;

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

@@ -1,4 +1,4 @@
-import { Batch, Context } from '@mparticle/event-models';
+import { Batch } from '@mparticle/event-models';
 import { MPID, IdentifyRequest, SDKEventCustomFlags, ConsentState, UserIdentities } from '@mparticle/web-sdk';
 import { IKitConfigs } from './configAPIClient';
 import { DataPlanResult, KitBlockerOptions, LogLevelType, SDKDataPlan, SDKEvent, SDKGeoLocation, SDKInitConfig, SDKProduct } from './sdkRuntimeModels';
@@ -84,6 +84,7 @@ export interface IFeatureFlags {
 export interface IStore {
     isEnabled: boolean;
     isInitialized: boolean;
+    mpid: MPID;
     sessionAttributes: SessionAttributes;
     localSessionAttributes: LocalSessionAttributes;
     currentSessionMPIDs: MPID[];
@@ -103,7 +104,7 @@ export interface IStore {
     eventQueue: SDKEvent[];
     currencyCode: string | null;
     globalTimer: number | null;
-    context: Context | null;
+    context: string | null;
     configurationLoaded: boolean;
     identityCallInFlight: boolean;
     identityCallFailed: boolean;
@@ -121,7 +122,7 @@ export interface IStore {
     activeForwarders: ConfiguredKit[];
     kits: Dictionary<MPForwarder>;
     sideloadedKits: MPForwarder[];
-    configuredForwarders: MPForwarder[];
+    configuredForwarders: ConfiguredKit[];
     pixelConfigurations: IPixelConfiguration[];
     integrationDelayTimeoutStart: number;
     webviewBridgeEnabled?: boolean;

package/package.json

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

package/src/configAPIClient.ts

@@ -20,6 +20,7 @@ export interface IKitConfigs extends IKitFilterSettings {
     suffix?: string;
     moduleId: number;
     isDebug: boolean;
+    isSandbox?: boolean;
     isVisible: boolean;
     isDebugString: BooleanStringLowerCase;
     hasDebugString: BooleanStringLowerCase;

package/src/ecommerce.interfaces.ts

@@ -1,19 +1,10 @@
-import {
-    ProductAction,
-    Product,
-    Promotion,
-    CommerceEvent,
-} from '@mparticle/event-models';
 import {
     SDKEventAttrs,
     SDKEventOptions,
     TransactionAttributes,
 } from '@mparticle/web-sdk';
 import { valueof } from './utils';
-import {
-    ProductActionType,
-    PromotionActionType,
-} from './types';
+import { ProductActionType, PromotionActionType } from './types';
 import {
     SDKEvent,
     SDKEventCustomFlags,
@@ -36,7 +27,7 @@ interface IECommerceShared {
         couponCode?: string,
         attributes?: SDKEventAttrs
     ): SDKProduct | null;
-    createImpression(name: string, product: Product): SDKImpression | null;
+    createImpression(name: string, product: SDKProduct): SDKImpression | null;
     createPromotion(
         id: string | number,
         creative?: string,
@@ -51,7 +42,7 @@ interface IECommerceShared {
         shipping?: string | number,
         tax?: number
     ): TransactionAttributes | null;
-    expandCommerceEvent(event: CommerceEvent): SDKEvent[] | null;
+    expandCommerceEvent(event: SDKEvent): SDKEvent[] | null;
 }
 
 export interface SDKCart {
@@ -84,7 +75,7 @@ export interface SDKECommerceAPI extends IECommerceShared {
     ): void;
     logPromotion(
         type: valueof<typeof PromotionActionType>,
-        promotion: SDKPromotion,
+        promotion: SDKPromotion | SDKPromotion[],
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags,
         eventOptions?: SDKEventOptions
@@ -175,26 +166,26 @@ export interface IECommerce extends IECommerceShared {
         customFlags: SDKEventCustomFlags,
         options?: SDKEventOptions
     ): SDKEvent | null;
-    expandProductAction(commerceEvent: CommerceEvent): SDKEvent[];
-    expandProductImpression(commerceEvent: CommerceEvent): SDKEvent[];
-    expandPromotionAction(commerceEvent: CommerceEvent): SDKEvent[];
+    expandProductAction(commerceEvent: SDKEvent): SDKEvent[];
+    expandProductImpression(commerceEvent: SDKEvent): SDKEvent[];
+    expandPromotionAction(commerceEvent: SDKEvent): SDKEvent[];
     extractActionAttributes(
         attributes: ExtractedActionAttributes,
-        productAction: ProductAction
+        productAction: SDKProductAction
     ): void;
     extractProductAttributes(
         attributes: ExtractedProductAttributes,
-        product: Product
+        product: SDKProduct
     ): void;
     extractPromotionAttributes(
         attributes: ExtractedPromotionAttributes,
-        promotion: Promotion
+        promotion: SDKPromotion
     ): void;
     extractTransactionId(
         attributes: ExtractedTransactionId,
-        productAction: ProductAction
+        productAction: SDKProductAction
     ): void;
-    generateExpandedEcommerceName(eventName: string, plusOne: boolean): string;
+    generateExpandedEcommerceName(eventName: string, plusOne?: boolean): string;
     getProductActionEventName(
         productActionType: valueof<typeof ProductActionType>
     ): string;