@mparticle/web-sdk 2.32.2 → 2.32.4

package/src/sdkRuntimeModels.ts

@@ -3,20 +3,19 @@ import { DataPlanVersion } from '@mparticle/data-planning-models';
 import {
     MPConfiguration,
     MPID,
-    IdentityApiData,
+    SDKEventOptions,
+    SDKEventAttrs,
+    Callback,
 } from '@mparticle/web-sdk';
-import { IStore } from './store';
+import { IntegrationAttribute, IntegrationAttributes, IStore, WrapperSDKTypes } from './store';
 import Validators from './validators';
-import { Dictionary } from './utils';
-import { IServerModel } from './serverModel';
+import { Dictionary, valueof } from './utils';
 import { IKitConfigs } from './configAPIClient';
 import { SDKConsentApi, SDKConsentState } from './consent';
-import { IPersistence } from './persistence.interfaces';
-import { IMPSideloadedKit } from './sideloadedKit';
+import MPSideloadedKit from './sideloadedKit';
 import { ISessionManager } from './sessionManager';
 import { Kit, MPForwarder } from './forwarders.interfaces';
 import {
-    IIdentity,
     SDKIdentityApi,
     IAliasCallback,
 } from './identity.interfaces';
@@ -28,10 +27,18 @@ import {
     IdentityCallback,
     ISDKUserAttributes,
 } from './identity-user-interfaces';
-import { IIdentityType } from './types.interfaces';
-import IntegrationCapture from './integrationCapture';
-import { INativeSdkHelpers } from './nativeSdkHelpers.interfaces';
-import { ICookieSyncManager, IPixelConfiguration } from './cookieSyncManager';
+import {
+    CommerceEventType,
+    EventType,
+    IdentityType,
+    ProductActionType,
+    PromotionActionType,
+} from './types';
+import { IPixelConfiguration } from './cookieSyncManager';
+import _BatchValidator from './mockBatchCreator';
+import {  SDKECommerceAPI } from './ecommerce.interfaces';
+import { IErrorLogMessage, IMParticleWebSDKInstance, IntegrationDelays } from './mp-instance';
+import Constants from './constants';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -61,7 +68,7 @@ export interface SDKEvent {
     AppName?: string;
     Package?: string;
     ConsentState?: SDKConsentState;
-    IntegrationAttributes?: { [key: string]: { [key: string]: string } };
+    IntegrationAttributes?: IntegrationAttributes;
     ProductAction?: SDKProductAction;
     PromotionAction?: SDKPromotionAction;
     ProductImpressions?: SDKProductImpression[];
@@ -99,6 +106,11 @@ export interface SDKPromotion {
     Position?: string;
 }
 
+export interface SDKImpression {
+    Name: string;
+    Product: SDKProduct;
+}
+
 export interface SDKProductImpression {
     ProductImpressionList?: string;
     ProductList?: SDKProduct[];
@@ -142,72 +154,98 @@ export interface SDKProduct {
     Position?: number;
     CouponCode?: string;
     TotalAmount?: number;
-    Attributes?: { [key: string]: string };
-}
 
-// Temporary Interfaces for Events Module
-interface IEvents {
-    logEvent?(event: BaseEvent): void;
+    // https://go.mparticle.com/work/SQDSDKS-4801
+    Attributes?: Record<string, unknown> | null;
 }
 
+// https://go.mparticle.com/work/SQDSDKS-6949
 export interface MParticleWebSDK {
     addForwarder(mockForwarder: MPForwarder): void;
-    _IntegrationCapture: IntegrationCapture;
-    IdentityType: IIdentityType;
-    _Identity: IIdentity;
+    IdentityType: valueof<typeof IdentityType>;
+    CommerceEventType: valueof<typeof CommerceEventType>;
+    EventType: valueof<typeof EventType>;
+    PromotionType: valueof<typeof PromotionActionType>;
     Identity: SDKIdentityApi;
     Logger: SDKLoggerApi;
-    MPSideloadedKit: IMPSideloadedKit;
-    _APIClient: any; // TODO: Set up API Client
-    _CookieSyncManager: ICookieSyncManager;
-    _Store: IStore;
-    _Forwarders: any;
-    _Helpers: SDKHelpersApi;
-    _Events: IEvents;
-    config: SDKInitConfig;
-    _ServerModel: IServerModel;
-    _SessionManager: ISessionManager;
-    _Consent: SDKConsentApi;
     Consent: SDKConsentApi;
-    _NativeSdkHelpers: INativeSdkHelpers;
-    _Persistence: IPersistence;
-    _preInit: any; // TODO: Set up API
-    _instances?: Dictionary<MParticleWebSDK>;
-    _isTestEnv?: boolean;
     _resetForTests(
         MPConfig?: SDKInitConfig,
         keepPersistence?: boolean,
-        instance?: MParticleWebSDK
+        instance?: IMParticleWebSDKInstance,
     ): void;
+    configurePixel(config: IPixelConfiguration): void;
     endSession(): void;
-    identifyRequest: IdentityApiData;
     init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
     _getActiveForwarders(): MPForwarder[];
+    _getIntegrationDelays(): IntegrationDelays;
+    _setIntegrationDelay(module: number, shouldDelayIntegration: boolean): void;
+    _setWrapperSDKInfo(name: WrapperSDKTypes, version: string): void;
     getAppName(): string;
     getAppVersion(): string;
     getDeviceId(): string;
     setDeviceId(deviceId: string): void;
+    getEnvironment(): valueof<typeof Constants.Environment>;
     setSessionAttribute(key: string, value: string): void;
-    getInstance(): MParticleWebSDK; // TODO: Create a new type for MParticleWebSDKInstance
-    ServerModel();
-    upload();
+    getVersion(): string;
+    upload(): void;
     setLogLevel(logLevel: LogLevelType): void;
     setPosition(lat: number | string, lng: number | string): void;
     startNewSession(): void;
     logEvent(
         eventName: string,
-        eventType?: number,
-        attrs?: { [key: string]: string },
-        customFlags?: SDKEventCustomFlags
+        eventType?: valueof<typeof EventType>,
+        attrs?: SDKEventAttrs,
+        customFlags?: SDKEventCustomFlags,
+        eventOptions?: SDKEventOptions
     ): void;
-    logBaseEvent(event: any): void;
-    eCommerce: any;
-    logLevel: string;
-    ProductActionType: SDKProductActionType;
+    logBaseEvent(event: BaseEvent, eventOptions?: SDKEventOptions): void;
+    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;
+    setOptOut(isOptingOut: boolean): void;
+    eCommerce: SDKECommerceAPI;
+    isInitialized(): boolean;
+    ProductActionType: valueof<typeof ProductActionType>;
+    ready(f: Function): void;
+    reset(instance: IMParticleWebSDKInstance): void;
+    setAppName(name: string): void;
+    setAppVersion(version: string): void;
+    setOptOut(isOptingOut: boolean): void;
+
+    // https://go.mparticle.com/work/SQDSDKS-7063
+    startTrackingLocation(callback?: Callback): void;
+
+    stopTrackingLocation(): void;
     generateHash(value: string): string;
+    setIntegrationAttribute(integrationModuleId: number, attrs: IntegrationAttribute): void;
+    getIntegrationAttributes(integrationModuleId: number): IntegrationAttribute;
+}
+
+// https://go.mparticle.com/work/SQDSDKS-4805
+
+// https://go.mparticle.com/work/SQDSDKS-6949
+export interface IMParticleInstanceManager extends MParticleWebSDK {
+    // https://go.mparticle.com/work/SQDSDKS-5053
+    // Private Properties
+    _BatchValidator: _BatchValidator;
+    _instances: Dictionary<IMParticleWebSDKInstance>;
+    _isTestEnv?: boolean;
+
+    // Public Properties
+    config: SDKInitConfig;
     isIOS?: boolean;
+    MPSideloadedKit: typeof MPSideloadedKit;
+    // https://go.mparticle.com/work/SQDSDKS-7060
+    sessionManager: Pick<ISessionManager, 'getSession'>; 
+    Store: IStore;
+
+    // Public Methods
+    getInstance(instanceName?: string): IMParticleWebSDKInstance;
 }
 
+
 // Used in cases where server requires booleans as strings
 export type BooleanStringLowerCase = 'false' | 'true';
 export type BooleanStringTitleCase = 'False' | 'True';
@@ -254,6 +292,8 @@ export interface SDKInitConfig
 
     // https://go.mparticle.com/work/SQDSDKS-6460
     identityCallback?: IdentityCallback;
+
+    rq?: Function[] | any[];
 }
 
 export interface DataPlanConfig {
@@ -269,6 +309,7 @@ export interface SDKHelpersApi {
     createServiceUrl(url: string, devToken?: string): string;
     createXHR?(cb: () => void): XMLHttpRequest;
     extend?(...args: any[]);
+    findKeyInObject?(obj: any, key: string): string;
     parseNumber?(value: string | number): number;
     generateUniqueId();
     generateHash?(value: string): string;
@@ -284,6 +325,7 @@ export interface SDKHelpersApi {
         timeoutStart: number,
         now: number
     ): boolean;
+    isEventType?(type: valueof<typeof EventType>): boolean;
     isObject?(item: any);
     invokeCallback?(
         callback: IdentityCallback,
@@ -293,7 +335,7 @@ export interface SDKHelpersApi {
         previousMpid?: MPID
     ): void;
     sanitizeAttributes?(
-        attrs: Dictionary<string>,
+        attrs: SDKEventAttrs,
         name: string
     ): Dictionary<string> | null;
     Validators: typeof Validators;
@@ -303,6 +345,7 @@ export interface SDKLoggerApi {
     error(arg0: string): void;
     verbose(arg0: string): void;
     warning(arg0: string): void;
+    setLogLevel(logLevel: LogLevelType): void;
 }
 
 // TODO: Merge this with IStore in store.ts
@@ -326,7 +369,7 @@ export interface BaseEvent {
     messageType: number;
     name?: string;
     eventType?: number;
-    data?: { [key: string]: string };
+    data?: SDKEventAttrs;
     customFlags?: { [key: string]: string };
     toEventAPIObject?(): SDKEvent;
     sourceMessageId?: string;

package/src/sdkToEventsApiConverter.ts

@@ -4,7 +4,6 @@ import {
     SDKProduct,
     SDKPromotion,
     SDKProductActionType,
-    MParticleWebSDK,
 } from './sdkRuntimeModels';
 import * as EventsApi from '@mparticle/event-models';
 import {
@@ -17,6 +16,7 @@ import { Dictionary, isEmpty } from './utils';
 import { ISDKUserIdentity } from './identity-user-interfaces';
 import { SDKIdentityTypeEnum } from './identity.interfaces';
 import Constants from './constants';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const { 
     FeatureFlags
@@ -35,7 +35,7 @@ interface Batch extends EventsApi.Batch {
 export function convertEvents(
     mpid: string,
     sdkEvents: SDKEvent[],
-    mpInstance: MParticleWebSDK
+    mpInstance: IMParticleWebSDKInstance
 ): Batch | null {
     if (!mpid) {
         return null;
@@ -373,7 +373,7 @@ export function convertProducts(
             price: sdkProduct.Price,
             quantity: sdkProduct.Quantity,
             coupon_code: sdkProduct.CouponCode,
-            custom_attributes: sdkProduct.Attributes,
+            custom_attributes: sdkProduct.Attributes as Record<string, string>,
         };
         products.push(product);
     }

package/src/serverModel.ts

@@ -6,7 +6,6 @@ import Types from './types';
 import Constants from './constants';
 import {
     BaseEvent,
-    MParticleWebSDK,
     SDKEvent,
     SDKEventCustomFlags,
     SDKGeoLocation,
@@ -27,6 +26,7 @@ import {
     SDKConsentState,
 } from './consent';
 import { IMParticleUser, ISDKUserIdentity } from './identity-user-interfaces';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const MessageType = Types.MessageType;
 const ApplicationTransitionType = Types.ApplicationTransitionType;
@@ -110,7 +110,7 @@ export interface IProductV2DTO {
     ps: number;
     cc: string | number;
     tpa: number;
-    attrs: Record<string, string> | null;
+    attrs: Dictionary<string> | null;
 }
 
 export interface IPromotionV2DTO {
@@ -181,7 +181,7 @@ function convertProductToV2DTO(product: SDKProduct): IProductV2DTO {
         ps: parseNumber(product.Position),
         cc: parseStringOrNumber(product.CouponCode),
         tpa: parseNumber(product.TotalAmount),
-        attrs: product.Attributes,
+        attrs: product.Attributes as Dictionary<string> | null,
     };
 }
 
@@ -197,7 +197,7 @@ function convertProductListToV2DTO(productList: SDKProduct[]): IProductV2DTO[] {
 
 export default function ServerModel(
     this: IServerModel,
-    mpInstance: MParticleWebSDK
+    mpInstance: IMParticleWebSDKInstance
 ) {
     var self = this;
 

package/src/sessionManager.ts

@@ -1,10 +1,10 @@
 import { MPID } from '@mparticle/web-sdk';
 import Constants from './constants';
 import { IPersistenceMinified } from './persistence.interfaces';
-import { MParticleWebSDK } from './sdkRuntimeModels';
 import Types from './types';
 import { generateDeprecationMessage } from './utils';
 import { IMParticleUser } from './identity-user-interfaces';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const { Messages } = Constants;
 
@@ -26,7 +26,7 @@ export interface ISessionManager {
 
 export default function SessionManager(
     this: ISessionManager,
-    mpInstance: MParticleWebSDK
+    mpInstance: IMParticleWebSDKInstance
 ) {
     const self = this;
 

package/src/sideloadedKit.ts

@@ -6,22 +6,23 @@ import {
     IKitFilterSettings,
 } from './configAPIClient';
 import { UnregisteredKit } from './forwarders.interfaces';
-import { EventTypeEnum, IdentityType } from './types.interfaces';
+import { EventType, IdentityType } from './types';
+import { valueof } from './utils';
 
 export interface IMPSideloadedKit {
     kitInstance: UnregisteredKit;
     filterDictionary: IKitFilterSettings;
 
-    addEventTypeFilter(eventType: EventTypeEnum): void;
-    addEventNameFilter(eventType: EventTypeEnum, eventName: string): void;
+    addEventTypeFilter(eventType: valueof<typeof EventType>): void;
+    addEventNameFilter(eventType: valueof<typeof EventType>, eventName: string): void;
     addEventAttributeFilter(
-        eventType: EventTypeEnum,
+        eventType: valueof<typeof EventType>,
         eventName: string,
         customAttributeKey: string
     ): void;
     addScreenNameFilter(screenName: string): void;
     addScreenAttributeFilter(screenName: string, screenAttribute: string): void;
-    addUserIdentityFilter(userIdentity: IdentityType): void;
+    addUserIdentityFilter(userIdentity: typeof IdentityType): void;
     addUserAttributeFilter(userAttributeKey: string): void;
 }
 
@@ -57,13 +58,13 @@ export default class MPSideloadedKit implements IMPSideloadedKit{
         this.kitInstance = unregisteredKitInstance;
     }
 
-    public addEventTypeFilter(eventType: EventTypeEnum): void {
+    public addEventTypeFilter(eventType: valueof<typeof EventType>): void {
         const hashedEventType = KitFilterHelper.hashEventType(eventType);
         this.filterDictionary.eventTypeFilters.push(hashedEventType);
     }
 
     public addEventNameFilter(
-        eventType: EventTypeEnum,
+        eventType: valueof<typeof EventType>,
         eventName: string
     ): void {
         const hashedEventName = KitFilterHelper.hashEventName(
@@ -74,7 +75,7 @@ export default class MPSideloadedKit implements IMPSideloadedKit{
     }
 
     public addEventAttributeFilter(
-        eventType: EventTypeEnum,
+        eventType: valueof<typeof EventType>,
         eventName: string,
         customAttributeKey: string
     ): void {
@@ -89,7 +90,7 @@ export default class MPSideloadedKit implements IMPSideloadedKit{
     public addScreenNameFilter(screenName: string): void {
         const hashedScreenName = KitFilterHelper.hashEventName(
             screenName,
-            EventTypeEnum.Unknown
+            EventType.Unknown,
         );
         this.filterDictionary.screenNameFilters.push(hashedScreenName);
     }
@@ -99,7 +100,7 @@ export default class MPSideloadedKit implements IMPSideloadedKit{
         screenAttribute: string
     ): void {
         const hashedScreenAttribute = KitFilterHelper.hashEventAttributeKey(
-            EventTypeEnum.Unknown,
+            EventType.Unknown,
             screenName,
             screenAttribute
         );
@@ -108,7 +109,7 @@ export default class MPSideloadedKit implements IMPSideloadedKit{
         );
     }
 
-    public addUserIdentityFilter(userIdentity: IdentityType): void {
+    public addUserIdentityFilter(userIdentity: typeof IdentityType): void {
         const hashedIdentityType = KitFilterHelper.hashUserIdentity(
             userIdentity
         );

package/src/store.ts

@@ -13,7 +13,6 @@ import {
     DataPlanResult,
     KitBlockerOptions,
     LogLevelType,
-    MParticleWebSDK,
     SDKDataPlan,
     SDKEvent,
     SDKGeoLocation,
@@ -38,6 +37,7 @@ import {
     IPersistenceMinified,
 } from './persistence.interfaces';
 import { CookieSyncDates, IPixelConfiguration } from './cookieSyncManager';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 // This represents the runtime configuration of the SDK AFTER
 // initialization has been complete and all settings and
@@ -121,10 +121,10 @@ function createSDKConfig(config: SDKInitConfig): SDKConfig {
 //       to TypeScript
 export type ServerSettings = Dictionary;
 export type SessionAttributes = Dictionary;
-export type IntegrationAttributes = Dictionary<Dictionary<string>>;
-
-type WrapperSDKTypes = 'flutter' | 'none';
-interface WrapperSDKInfo {
+export type IntegrationAttribute = Dictionary<string>;
+export type IntegrationAttributes = Dictionary<IntegrationAttribute>;
+export type WrapperSDKTypes = 'flutter' | 'none';
+export interface WrapperSDKInfo {
     name: WrapperSDKTypes;
     version: string | null;
     isInfoSet: boolean;
@@ -142,6 +142,7 @@ export interface IFeatureFlags {
 // Temporary Interface until Store can be refactored as a class
 export interface IStore {
     isEnabled: boolean;
+    isInitialized: boolean;
     sessionAttributes: SessionAttributes;
     currentSessionMPIDs: MPID[];
     consentState: SDKConsentState | null;
@@ -213,7 +214,7 @@ export interface IStore {
 export default function Store(
     this: IStore,
     config: SDKInitConfig,
-    mpInstance: MParticleWebSDK,
+    mpInstance: IMParticleWebSDKInstance,
     apiKey?: string
 ) {
     const {