refactor: Migrate mParticle Instance Imports

src/apiClient.ts

@@ -1,13 +1,14 @@
 import Constants from './constants';
 import Types from './types';
 import { BatchUploader } from './batchUploader';
-import { MParticleWebSDK, SDKEvent, SDKDataPlan } from './sdkRuntimeModels';
+import { SDKEvent, SDKDataPlan } from './sdkRuntimeModels';
 import KitBlocker from './kitBlocking';
-import { Dictionary, getRampNumber, isEmpty, parseNumber } from './utils';
+import { Dictionary, isEmpty, parseNumber } from './utils';
 import { IUploadObject } from './serverModel';
 import { MPForwarder } from './forwarders.interfaces';
 import { IMParticleUser, ISDKUserAttributes } from './identity-user-interfaces';
 import { AsyncUploader, FetchUploader, XHRUploader } from './uploaders';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 export interface IAPIClient {
     uploader: BatchUploader | null;
@@ -43,7 +44,7 @@ export interface IForwardingStatsData {
 
 export default function APIClient(
     this: IAPIClient,
-    mpInstance: MParticleWebSDK,
+    mpInstance: IMParticleWebSDKInstance,
     kitBlocker: KitBlocker
 ) {
     this.uploader = null;

src/configAPIClient.ts

@@ -14,6 +14,7 @@ import {
     XHRUploader,
 } from './uploaders';
 import { IPixelConfiguration } from './cookieSyncManager';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 export interface IKitConfigs extends IKitFilterSettings {
     name: string;
@@ -113,7 +114,7 @@ export default function ConfigAPIClient(
     this: IConfigAPIClient,
     apiKey: string,
     config: SDKInitConfig,
-    mpInstance: MParticleWebSDK
+    mpInstance: IMParticleWebSDKInstance
 ): void {
     const baseUrl = 'https://' + mpInstance._Store.SDKConfig.configUrl;
     const { isDevelopmentMode } = config;

src/cookieSyncManager.ts

@@ -4,9 +4,9 @@ import {
     createCookieSyncUrl,
 } from './utils';
 import Constants from './constants';
-import { MParticleWebSDK } from './sdkRuntimeModels';
 import { MPID } from '@mparticle/web-sdk';
 import { IConsentRules } from './consent';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const { Messages } = Constants;
 const { InformationMessages } = Messages;
@@ -47,7 +47,7 @@ export interface ICookieSyncManager {
 
 export default function CookieSyncManager(
     this: ICookieSyncManager,
-    mpInstance: MParticleWebSDK
+    mpInstance: IMParticleWebSDKInstance
 ) {
     const self = this;
 

src/identityApiClient.ts

@@ -24,7 +24,7 @@ import {
     IdentityResultBody,
     IIdentityResponse,
 } from './identity-user-interfaces';
-import { MParticleWebSDK } from './sdkRuntimeModels';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const { HTTPCodes, Messages, IdentityMethods } = Constants;
 
@@ -82,7 +82,7 @@ interface IAliasErrorResponse extends IdentityApiError {}
 
 export default function IdentityAPIClient(
     this: IIdentityApiClient,
-    mpInstance: MParticleWebSDK
+    mpInstance: IMParticleWebSDKInstance
 ) {
     this.sendAliasRequest = async function(
         aliasRequest: IAliasRequest,

src/kitBlocking.ts

@@ -3,6 +3,7 @@ import { SDKEvent, MParticleWebSDK, KitBlockerDataPlan, SDKProduct } from './sdk
 import { BaseEvent, EventTypeEnum, CommerceEvent, ScreenViewEvent, CustomEvent } from '@mparticle/event-models';
 import Types from './types'
 import { DataPlanPoint } from '@mparticle/data-planning-models';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 /*  
     TODO: Including this as a workaround because attempting to import it from
@@ -41,9 +42,9 @@ export default class KitBlocker {
     blockUserAttributes = false;
     blockUserIdentities = false;
     kitBlockingEnabled = false;
-    mpInstance: MParticleWebSDK;
+    mpInstance: IMParticleWebSDKInstance;
 
-    constructor(dataPlan: KitBlockerDataPlan, mpInstance: MParticleWebSDK) {
+    constructor(dataPlan: KitBlockerDataPlan, mpInstance: IMParticleWebSDKInstance) {
         // if data plan is not requested, the data plan is {document: null}
         if (dataPlan && !dataPlan.document) {
             this.kitBlockingEnabled = false;

src/mockBatchCreator.ts

@@ -6,6 +6,7 @@ import { convertEvents } from './sdkToEventsApiConverter';
 import * as EventsApi from '@mparticle/event-models';
 import { Batch } from '@mparticle/event-models';
 import { IMPSideloadedKit } from './sideloadedKit';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const mockFunction = function() {
     return null;
@@ -15,15 +16,15 @@ export default class _BatchValidator {
         return ({
             // Certain Helper, Store, and Identity properties need to be mocked to be used in the `returnBatch` method
             _Helpers: {
-                sanitizeAttributes: window.mParticle.getInstance()._Helpers
+                sanitizeAttributes: (window.mParticle.getInstance() as unknown as IMParticleWebSDKInstance)._Helpers
                     .sanitizeAttributes,
                 generateHash: function() {
                     return 'mockHash';
                 },
                 generateUniqueId: function() {
                     return 'mockId';
                 },
-                extend: window.mParticle.getInstance()._Helpers.extend,
+                extend: (window.mParticle.getInstance() as unknown as IMParticleWebSDKInstance)._Helpers.extend,
                 createServiceUrl: mockFunction,
                 parseNumber: mockFunction,
                 isObject: mockFunction,
@@ -118,7 +119,7 @@ export default class _BatchValidator {
             logLevel: 'none',
             setPosition: mockFunction,
             upload: mockFunction,
-        } as unknown) as MParticleWebSDK;
+        } as unknown) as IMParticleWebSDKInstance;
     }
 
     private createSDKEventFunction(event): SDKEvent {

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;

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;
 

test/jest/cookieSyncManager.spec.ts

@@ -4,7 +4,7 @@ import CookieSyncManager, {
     CookieSyncDates,
     isLastSyncDateExpired
 } from '../../src/cookieSyncManager';
-import { MParticleWebSDK } from '../../src/sdkRuntimeModels';
+import { IMParticleWebSDKInstance } from '../../src/mp-instance';
 import { testMPID } from '../src/config/constants';
 
 const pixelSettings: IPixelConfiguration = {
@@ -43,7 +43,7 @@ describe('CookieSyncManager', () => {
                         getMPID: () => testMPID,
                     }),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -78,7 +78,7 @@ describe('CookieSyncManager', () => {
                         getMPID: () => testMPID,
                     }),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -99,7 +99,7 @@ describe('CookieSyncManager', () => {
                         csd: {}
                     }}),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -120,7 +120,7 @@ describe('CookieSyncManager', () => {
                         csd: {}
                     }}),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -158,7 +158,7 @@ describe('CookieSyncManager', () => {
                 _Consent: {
                     isEnabledForUserConsent: jest.fn().mockReturnValue(true),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -197,7 +197,7 @@ describe('CookieSyncManager', () => {
                         getMPID: () => testMPID,
                     }),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -229,7 +229,7 @@ describe('CookieSyncManager', () => {
                         getMPID: () => testMPID,
                     }),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -268,7 +268,7 @@ describe('CookieSyncManager', () => {
                         getMPID: () => testMPID,
                     }),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -305,7 +305,7 @@ describe('CookieSyncManager', () => {
                 Logger: {
                     verbose: jest.fn(),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -329,7 +329,7 @@ describe('CookieSyncManager', () => {
                 _Persistence: {
                     getPersistence: () => ({}),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -370,7 +370,7 @@ describe('CookieSyncManager', () => {
                 Logger: {
                     verbose: loggerSpy,
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -413,7 +413,7 @@ describe('CookieSyncManager', () => {
                 Logger: {
                     verbose: loggerSpy,
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
             cookieSyncManager.performCookieSync = jest.fn();
@@ -457,7 +457,7 @@ describe('CookieSyncManager', () => {
                 Logger: {
                     verbose: jest.fn(),
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
 
@@ -521,7 +521,7 @@ describe('CookieSyncManager', () => {
                 Logger: {
                     verbose: loggerSpy,
                 },
-            } as unknown) as MParticleWebSDK;
+            } as unknown) as IMParticleWebSDKInstance;
 
             const cookieSyncManager = new CookieSyncManager(mockMPInstance);
 

test/src/config/setup.ts

@@ -1,9 +1,9 @@
 import { MPConfig, workspaceToken } from './constants';
-import { MParticleWebSDK } from '../../../src/sdkRuntimeModels';
+import { IMParticleInstanceManager } from '../../../src/sdkRuntimeModels';
 
 declare global {
     interface Window {
-        mParticle: MParticleWebSDK;
+        mParticle: IMParticleInstanceManager;
     }
 }
 

test/src/tests-apiClient.ts

@@ -1,12 +1,12 @@
 import Types from '../../src/types';
 import { apiKey, MPConfig } from './config/constants';
-import { MParticleWebSDK } from '../../src/sdkRuntimeModels';
 import { expect } from 'chai';
 import { IMParticleUser } from '../../src/identity-user-interfaces';
+import { IMParticleInstanceManager } from '../../src/sdkRuntimeModels';
 
 declare global {
     interface Window {
-        mParticle: MParticleWebSDK;
+        mParticle: IMParticleInstanceManager;
     }
 }
 

test/src/tests-audience-manager.ts

@@ -1,9 +1,9 @@
 import sinon from 'sinon';
 import fetchMock from 'fetch-mock/esm/client';
 import { expect } from 'chai';
-import { urls, apiKey, MPConfig, testMPID } from './config/constants';
+import { urls, apiKey, testMPID } from './config/constants';
 import Constants from '../../src/constants';
-import { MParticleWebSDK, SDKLoggerApi } from '../../src/sdkRuntimeModels';
+import { IMParticleInstanceManager, SDKLoggerApi } from '../../src/sdkRuntimeModels';
 import AudienceManager, {
     IAudienceMemberships, IAudienceMembershipsServerResponse
 } from '../../src/audienceManager';
@@ -13,7 +13,7 @@ const { fetchMockSuccess } = Utils;
 
 declare global {
     interface Window {
-        mParticle: MParticleWebSDK;
+        mParticle: IMParticleInstanceManager;
         fetchMock: any;
     }
 }

test/src/tests-batchUploader.ts

@@ -2,9 +2,8 @@ import sinon from 'sinon';
 import { urls, apiKey, MPConfig, testMPID } from './config/constants';
 import {
     BaseEvent,
-    MParticleWebSDK,
+    IMParticleInstanceManager,
     SDKEvent,
-    SDKProductActionType,
 } from '../../src/sdkRuntimeModels';
 import { Batch, CustomEventData } from '@mparticle/event-models';
 import Utils from './config/utils';
@@ -18,7 +17,7 @@ const { fetchMockSuccess, waitForCondition, hasIdentifyReturned  } = Utils;
 
 declare global {
     interface Window {
-        mParticle: MParticleWebSDK;
+        mParticle: IMParticleInstanceManager;
     }
 }