@mparticle/web-sdk 2.33.1 → 2.35.0

package/src/mparticle-instance-manager.ts

@@ -1,5 +1,5 @@
 import Polyfill from './polyfill';
-import Types, { CommerceEventType, EventType, ProductActionType, PromotionActionType } from './types';
+import { CommerceEventType, EventType, IdentityType, ProductActionType, PromotionActionType } from './types';
 import Constants from './constants';
 import mParticleInstance, { IMParticleWebSDKInstance } from './mp-instance.js';
 import _BatchValidator from './mockBatchCreator';
@@ -7,7 +7,6 @@ import MPSideloadedKit from './sideloadedKit';
 import { IMParticleInstanceManager } from './sdkRuntimeModels';
 import { IStore } from './store';
 import { Dictionary } from '@mparticle/web-sdk';
-import { valueof } from './utils';
 
 if (!Array.prototype.forEach) {
     Array.prototype.forEach = Polyfill.forEach;
@@ -32,11 +31,11 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
     // Only leaving this here in case any clients are trying to access mParticle.Store, to prevent from throwing
     this.Store = {} as IStore;
     this._instances = {} as Dictionary<IMParticleWebSDKInstance>;
-    this.IdentityType = Types.IdentityType;
-    this.EventType = EventType as unknown as valueof<typeof EventType>;
-    this.CommerceEventType = CommerceEventType as unknown as valueof<typeof CommerceEventType>;
-    this.PromotionType = PromotionActionType as unknown as valueof<typeof PromotionActionType>;
-    this.ProductActionType = ProductActionType as unknown as valueof<typeof ProductActionType>;
+    this.IdentityType = IdentityType;
+    this.EventType = EventType;
+    this.CommerceEventType = CommerceEventType;
+    this.PromotionType = PromotionActionType;
+    this.ProductActionType = ProductActionType;
 
     this.MPSideloadedKit = MPSideloadedKit;
 
@@ -104,6 +103,9 @@ function mParticleInstanceManager(this: IMParticleInstanceManager) {
             return client;
         }
     };
+
+    this.Rokt = self.getInstance()._RoktManager;
+
     this.getDeviceId = function() {
         return self.getInstance().getDeviceId();
     };

package/src/roktManager.ts

@@ -0,0 +1,76 @@
+// https://docs.rokt.com/developers/integration-guides/web/library/attributes
+export interface IRoktPartnerAttributes {
+    [key: string]: string | number | boolean | undefined | null;
+}
+
+// https://docs.rokt.com/developers/integration-guides/web/library/select-placements-options
+export interface IRoktSelectPlacementsOptions {
+    attributes: IRoktPartnerAttributes;
+    identifier?: string;
+}
+
+interface IRoktPlacement {}
+
+export interface IRoktSelection {
+    close: () => void;
+    getPlacements: () => Promise<IRoktPlacement[]>;
+}
+
+export interface IRoktLauncher {
+    selectPlacements: (options: IRoktSelectPlacementsOptions) => Promise<IRoktSelection>;
+}
+
+export interface IRoktMessage {
+    methodName: string;
+    payload: any;
+}
+
+export default class RoktManager {
+    public launcher: IRoktLauncher | null = null;
+    private messageQueue: IRoktMessage[] = [];
+
+    constructor() {
+        this.launcher = null;
+    }
+
+    public attachLauncher(launcher: IRoktLauncher): void {
+        this.setLauncher(launcher);
+        this.processMessageQueue();
+    }
+
+    public selectPlacements(options: IRoktSelectPlacementsOptions): Promise<IRoktSelection> {
+        if (!this.launcher) {
+            this.queueMessage({
+                methodName: 'selectPlacements',
+                payload: options,
+            });
+            return Promise.resolve({} as IRoktSelection);
+        }
+
+        try {
+            return this.launcher.selectPlacements(options);
+        } catch (error) {
+            return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));
+        }
+    }
+
+    private processMessageQueue(): void {
+        if (this.messageQueue.length > 0) {
+            this.messageQueue.forEach(async (message) => {
+                if (this.launcher && message.methodName in this.launcher) {
+                    await (this.launcher[message.methodName] as Function)(message.payload);
+                }
+            });
+            this.messageQueue = [];
+        }
+    }
+    
+
+    private queueMessage(message: IRoktMessage): void {
+        this.messageQueue.push(message);
+    }
+
+    private setLauncher(launcher: IRoktLauncher): void {
+        this.launcher = launcher;
+    }
+}

package/src/sdkRuntimeModels.ts

@@ -14,7 +14,7 @@ import { IKitConfigs } from './configAPIClient';
 import { SDKConsentApi, SDKConsentState } from './consent';
 import MPSideloadedKit from './sideloadedKit';
 import { ISessionManager } from './sessionManager';
-import { Kit, MPForwarder } from './forwarders.interfaces';
+import { ConfiguredKit, MPForwarder, UnregisteredKit } from './forwarders.interfaces';
 import {
     SDKIdentityApi,
     IAliasCallback,
@@ -39,6 +39,7 @@ import _BatchValidator from './mockBatchCreator';
 import {  SDKECommerceAPI } from './ecommerce.interfaces';
 import { IErrorLogMessage, IMParticleWebSDKInstance, IntegrationDelays } from './mp-instance';
 import Constants from './constants';
+import RoktManager from './roktManager';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -80,6 +81,7 @@ export interface SDKEvent {
     LaunchReferral?: string;
     ExpandedEventCount: number;
     ActiveTimeOnSite: number;
+    IsBackgroundAST?: boolean;
 }
 
 export interface SDKGeoLocation {
@@ -163,11 +165,12 @@ export interface SDKProduct {
 
 // https://go.mparticle.com/work/SQDSDKS-6949
 export interface MParticleWebSDK {
-    addForwarder(mockForwarder: MPForwarder): void;
-    IdentityType: valueof<typeof IdentityType>;
-    CommerceEventType: valueof<typeof CommerceEventType>;
-    EventType: valueof<typeof EventType>;
-    PromotionType: valueof<typeof PromotionActionType>;
+    addForwarder(forwarder: UnregisteredKit): void;
+    IdentityType: typeof IdentityType;
+    CommerceEventType: typeof CommerceEventType;
+    EventType: typeof EventType;
+    PromotionType: typeof PromotionActionType;
+    ProductActionType: typeof ProductActionType;
     Identity: SDKIdentityApi;
     Logger: SDKLoggerApi;
     Consent: SDKConsentApi;
@@ -179,7 +182,7 @@ export interface MParticleWebSDK {
     configurePixel(config: IPixelConfiguration): void;
     endSession(): void;
     init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
-    _getActiveForwarders(): MPForwarder[];
+    _getActiveForwarders(): ConfiguredKit[];
     _getIntegrationDelays(): IntegrationDelays;
     _setIntegrationDelay(module: number, shouldDelayIntegration: boolean): void;
     _setWrapperSDKInfo(name: WrapperSDKTypes, version: string): void;
@@ -205,13 +208,15 @@ export interface MParticleWebSDK {
     logError(error: IErrorLogMessage, attrs?: SDKEventAttrs): void;
     logLink(selector: string, eventName: string, eventType: valueof<typeof EventType>, eventInfo: SDKEventAttrs): void;
     logForm(selector: string, eventName: string, eventType: valueof<typeof EventType>, eventInfo: SDKEventAttrs): void;
-    logPageView(eventName: string, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
+    logPageView(eventName?: string, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
     setOptOut(isOptingOut: boolean): void;
     eCommerce: SDKECommerceAPI;
     isInitialized(): boolean;
-    ProductActionType: valueof<typeof ProductActionType>;
     ready(f: Function): void;
-    reset(instance: IMParticleWebSDKInstance): void;
+
+    // https://go.mparticle.com/work/SQDSDKS-7072
+    reset(instance?: IMParticleWebSDKInstance): void;
+
     setAppName(name: string): void;
     setAppVersion(version: string): void;
     setOptOut(isOptingOut: boolean): void;
@@ -239,6 +244,7 @@ export interface IMParticleInstanceManager extends MParticleWebSDK {
     config: SDKInitConfig;
     isIOS?: boolean;
     MPSideloadedKit: typeof MPSideloadedKit;
+    Rokt: RoktManager;
     // https://go.mparticle.com/work/SQDSDKS-7060
     sessionManager: Pick<ISessionManager, 'getSession'>; 
     Store: IStore;
@@ -266,7 +272,7 @@ export interface SDKInitConfig
     logLevel?: LogLevelType;
 
     kitConfigs?: IKitConfigs[];
-    kits?: Dictionary<Kit>;
+    kits?: Dictionary<UnregisteredKit>;
     sideloadedKits?: MPForwarder[];
     dataPlanOptions?: KitBlockerOptions;
     flags?: Dictionary;

package/src/sdkToEventsApiConverter.ts

@@ -489,11 +489,13 @@ export function convertAST(
     const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
         sdkEvent
     );
+
+    // Determine the transition type based on IsBackgroundAST flag
+    const { applicationBackground, applicationInitialized } = EventsApi.ApplicationStateTransitionEventDataApplicationTransitionTypeEnum;
+    const transitionType = sdkEvent.IsBackgroundAST ? applicationBackground : applicationInitialized;
+
     let astEventData: EventsApi.ApplicationStateTransitionEventData = {
-        application_transition_type:
-            EventsApi
-                .ApplicationStateTransitionEventDataApplicationTransitionTypeEnum
-                .applicationInitialized,
+        application_transition_type: transitionType,
         is_first_run: sdkEvent.IsFirstRun,
         is_upgrade: false,
         launch_referral: sdkEvent.LaunchReferral,

package/src/serverModel.ts

@@ -27,6 +27,7 @@ import {
 } from './consent';
 import { IMParticleUser, ISDKUserIdentity } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
+import { appendUserInfo } from './user-utils';
 
 const MessageType = Types.MessageType;
 const ApplicationTransitionType = Types.ApplicationTransitionType;
@@ -140,7 +141,6 @@ export interface IServerModel {
     convertEventToV2DTO: (event: IUploadObject) => IServerV2DTO;
     createEventObject: (event: BaseEvent, user?: IMParticleUser) => SDKEvent;
     convertToConsentStateV2DTO: (state: SDKConsentState) => IConsentStateV2DTO;
-    appendUserInfo: (user: IMParticleUser, event: SDKEvent) => void;
 }
 
 // TODO: Make this a pure function that returns a new object
@@ -201,51 +201,6 @@ export default function ServerModel(
 ) {
     var self = this;
 
-    // TODO: Can we refactor this to not mutate the event?
-    this.appendUserInfo = function(
-        user: IMParticleUser,
-        event: SDKEvent
-    ): void {
-        if (!event) {
-            return;
-        }
-        if (!user) {
-            event.MPID = null;
-            event.ConsentState = null;
-            event.UserAttributes = null;
-            event.UserIdentities = null;
-            return;
-        }
-        if (event.MPID && event.MPID === user.getMPID()) {
-            return;
-        }
-        event.MPID = user.getMPID();
-        event.ConsentState = user.getConsentState();
-        event.UserAttributes = user.getAllUserAttributes();
-
-        var userIdentities = user.getUserIdentities().userIdentities;
-        var dtoUserIdentities = {};
-        for (var identityKey in userIdentities) {
-            var identityType = Types.IdentityType.getIdentityType(identityKey);
-            if (identityType !== false) {
-                dtoUserIdentities[identityType] = userIdentities[identityKey];
-            }
-        }
-
-        var validUserIdentities = [];
-        if (mpInstance._Helpers.isObject(dtoUserIdentities)) {
-            if (Object.keys(dtoUserIdentities).length) {
-                for (var key in dtoUserIdentities) {
-                    var userIdentity: Partial<ISDKUserIdentity> = {};
-                    userIdentity.Identity = dtoUserIdentities[key];
-                    userIdentity.Type = mpInstance._Helpers.parseNumber(key);
-                    validUserIdentities.push(userIdentity);
-                }
-            }
-        }
-        event.UserIdentities = validUserIdentities;
-    };
-
     this.convertToConsentStateV2DTO = function(
         state: SDKConsentState
     ): IConsentStateV2DTO {
@@ -397,7 +352,7 @@ export default function ServerModel(
             // FIXME: Remove duplicate occurence
             eventObject.CurrencyCode = mpInstance._Store.currencyCode;
             var currentUser = user || mpInstance.Identity.getCurrentUser();
-            self.appendUserInfo(currentUser, eventObject as SDKEvent);
+            appendUserInfo(currentUser, eventObject as SDKEvent);
 
             if (event.messageType === Types.MessageType.SessionEnd) {
                 eventObject.SessionLength =

package/src/store.ts

@@ -30,7 +30,7 @@ import {
     returnConvertedBoolean,
 } from './utils';
 import { IMinifiedConsentJSONObject, SDKConsentState } from './consent';
-import { Kit, MPForwarder } from './forwarders.interfaces';
+import { ConfiguredKit, MPForwarder, UnregisteredKit } from './forwarders.interfaces';
 import { IdentityCallback, UserAttributes } from './identity-user-interfaces';
 import {
     IGlobalStoreV2MinifiedKeys,
@@ -61,7 +61,7 @@ export interface SDKConfig {
     package?: string;
     flags?: IFeatureFlags;
     kitConfigs: IKitConfigs[];
-    kits: Dictionary<Kit>;
+    kits: Dictionary<UnregisteredKit>;
     logLevel?: LogLevelType;
     cookieDomain?: string;
     maxCookieSize?: number | undefined;
@@ -138,6 +138,8 @@ export interface IFeatureFlags {
     offlineStorage?: string;
     directURLRouting?: boolean;
     cacheIdentity?: boolean;
+    captureIntegrationSpecificIds?: boolean;
+    astBackgroundEvents?: boolean;
 }
 
 // Temporary Interface until Store can be refactored as a class
@@ -176,7 +178,7 @@ export interface IStore {
     isLocalStorageAvailable: boolean | null;
     storageName: string | null;
     prodStorageName: string | null;
-    activeForwarders: MPForwarder[];
+    activeForwarders: ConfiguredKit[];
     kits: Dictionary<MPForwarder>;
     sideloadedKits: MPForwarder[];
     configuredForwarders: MPForwarder[];
@@ -714,6 +716,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
         CacheIdentity,
         AudienceAPI,
         CaptureIntegrationSpecificIds,
+        AstBackgroundEvents
     } = Constants.FeatureFlags;
 
     if (!config.flags) {
@@ -732,6 +735,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
     flags[CacheIdentity] = config.flags[CacheIdentity] === 'True';
     flags[AudienceAPI] = config.flags[AudienceAPI] === 'True';
     flags[CaptureIntegrationSpecificIds] = config.flags[CaptureIntegrationSpecificIds] === 'True';
+    flags[AstBackgroundEvents] = config.flags[AstBackgroundEvents] === 'True';
 
     return flags;
 }

package/src/user-utils.ts

@@ -1,4 +1,8 @@
-import { IMParticleUser, IdentityResultBody } from './identity-user-interfaces';
+import { UserIdentities } from '@mparticle/web-sdk';
+import { IMParticleUser, ISDKUserIdentity, IdentityResultBody } from './identity-user-interfaces';
+import { SDKEvent } from './sdkRuntimeModels';
+import Types from './types';
+import { isObject, parseNumber } from './utils';
 
 export function hasMPIDAndUserLoginChanged(
     previousUser: IMParticleUser,
@@ -23,3 +27,49 @@ export function hasMPIDChanged(
             identityApiResult.mpid !== prevUser.getMPID())
     );
 }
+
+// https://go.mparticle.com/work/SQDSDKS-7136
+export function appendUserInfo(
+    user: IMParticleUser,
+    event: SDKEvent
+): void {
+    if (!event) {
+        return;
+    }
+    if (!user) {
+        event.MPID = null;
+        event.ConsentState = null;
+        event.UserAttributes = null;
+        event.UserIdentities = null;
+        return;
+    }
+    if (event.MPID && event.MPID === user.getMPID()) {
+        return;
+    }
+
+    event.MPID = user.getMPID();
+    event.ConsentState = user.getConsentState();
+    event.UserAttributes = user.getAllUserAttributes();
+
+    const userIdentities: UserIdentities = user.getUserIdentities().userIdentities;
+    const dtoUserIdentities = {};
+    for (const identityKey in userIdentities) {
+        const identityType = Types.IdentityType.getIdentityType(identityKey);
+        if (identityType !== false) {
+            dtoUserIdentities[identityType] = userIdentities[identityKey];
+        }
+    }
+
+    const validUserIdentities: ISDKUserIdentity[] = [];
+    if (isObject(dtoUserIdentities)) {
+        if (Object.keys(dtoUserIdentities).length) {
+            for (const key in dtoUserIdentities) {
+                const userIdentity = {} as ISDKUserIdentity;
+                userIdentity.Identity = dtoUserIdentities[key];
+                userIdentity.Type = parseNumber(key);
+                validUserIdentities.push(userIdentity);
+            }
+        }
+    }
+    event.UserIdentities = validUserIdentities;
+}