refactor: Migrate mParticle Instance to TypeScript

Author: alexs-mparticle

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/batchUploader.ts

@@ -1,6 +1,6 @@
 import { Batch } from '@mparticle/event-models';
 import Constants from './constants';
-import { SDKEvent, MParticleWebSDK, SDKLoggerApi } from './sdkRuntimeModels';
+import { SDKEvent, SDKLoggerApi } from './sdkRuntimeModels';
 import { convertEvents } from './sdkToEventsApiConverter';
 import { MessageType } from './types';
 import { getRampNumber, isEmpty } from './utils';
@@ -12,6 +12,7 @@ import {
     IFetchPayload,
 } from './uploaders';
 import { IMParticleUser } from './identity-user-interfaces';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 /**
  * BatchUploader contains all the logic to store/retrieve events and batches
@@ -36,7 +37,7 @@ export class BatchUploader {
     uploadIntervalMillis: number;
     eventsQueuedForProcessing: SDKEvent[];
     batchesQueuedForProcessing: Batch[];
-    mpInstance: MParticleWebSDK;
+    mpInstance: IMParticleWebSDKInstance;
     uploadUrl: string;
     batchingEnabled: boolean;
     private eventVault: SessionStorageVault<SDKEvent[]>;
@@ -46,10 +47,10 @@ export class BatchUploader {
 
     /**
      * Creates an instance of a BatchUploader
-     * @param {MParticleWebSDK} mpInstance - the mParticle SDK instance
+     * @param {IMParticleWebSDKInstance} mpInstance - the mParticle SDK instance
      * @param {number} uploadInterval - the desired upload interval in milliseconds
      */
-    constructor(mpInstance: MParticleWebSDK, uploadInterval: number) {
+    constructor(mpInstance: IMParticleWebSDKInstance, uploadInterval: number) {
         this.mpInstance = mpInstance;
         this.uploadIntervalMillis = uploadInterval;
         this.batchingEnabled =
@@ -208,7 +209,7 @@ export class BatchUploader {
     private static createNewBatches(
         sdkEvents: SDKEvent[],
         defaultUser: IMParticleUser,
-        mpInstance: MParticleWebSDK
+        mpInstance: IMParticleWebSDKInstance
     ): Batch[] | null {
         if (!defaultUser || !sdkEvents || !sdkEvents.length) {
             return null;
@@ -280,9 +281,9 @@ export class BatchUploader {
      * @param triggerFuture whether to trigger the loop again - for manual/forced uploads this should be false
      * @param useBeacon whether to use the beacon API - used when the page is being unloaded
      */
-    private async prepareAndUpload(
-        triggerFuture: boolean,
-        useBeacon: boolean
+    public async prepareAndUpload(
+        triggerFuture: boolean = false,
+        useBeacon: boolean = false,
     ): Promise<void> {
         // Fetch current user so that events can be grouped by MPID
         const currentUser = this.mpInstance.Identity.getCurrentUser();

src/configAPIClient.ts

@@ -2,7 +2,6 @@ import { DataPlanConfig } from '@mparticle/web-sdk';
 import {
     BooleanStringLowerCase,
     DataPlanResult,
-    MParticleWebSDK,
     SDKEventCustomFlags,
     SDKInitConfig,
 } from './sdkRuntimeModels';
@@ -14,6 +13,7 @@ import {
     XHRUploader,
 } from './uploaders';
 import { IPixelConfiguration } from './cookieSyncManager';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 export interface IKitConfigs extends IKitFilterSettings {
     name: string;
@@ -82,7 +82,7 @@ export interface IConfigResponse {
 export interface IConfigAPIClient {
     apiKey: string;
     config: SDKInitConfig;
-    mpInstance: MParticleWebSDK;
+    mpInstance: IMParticleWebSDKInstance;
     getSDKConfiguration: () => Promise<IConfigResponse>;
 }
 
@@ -113,7 +113,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/consent.ts

@@ -4,11 +4,11 @@ import {
     GDPRConsentState,
     PrivacyConsentState,
 } from '@mparticle/web-sdk';
-import { MParticleWebSDK } from './sdkRuntimeModels';
 import { Dictionary, isObject } from './utils';
 import KitFilterHelper from './kitFilterHelper';
 import Constants from './constants';
 import { IMParticleUser } from './identity-user-interfaces';
+import { IMParticleWebSDKInstance } from './mp-instance';
 
 const { CCPAPurpose } = Constants;
 
@@ -36,12 +36,6 @@ export interface SDKConsentApi {
     createGDPRConsent: ICreatePrivacyConsentFunction;
     createCCPAConsent: ICreatePrivacyConsentFunction;
     createConsentState: (consentState?: ConsentState) => ConsentState;
-    ConsentSerialization: IConsentSerialization;
-    createPrivacyConsent: ICreatePrivacyConsentFunction;
-    isEnabledForUserConsent: (
-        consentRules: IConsentRules,
-        user: IMParticleUser
-    ) => boolean;
 }
 
 export interface IConsentSerialization {
@@ -120,7 +114,7 @@ export interface IConsent {
     ConsentSerialization: IConsentSerialization;
 }
 
-export default function Consent(this: IConsent, mpInstance: MParticleWebSDK) {
+export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInstance) {
     const self = this;
 
     // this function is called when consent is required to

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/events.interfaces.ts

@@ -53,7 +53,7 @@ export interface IEvents {
     logOptOut(): void;
     logProductActionEvent(
         productActionType: valueof<typeof ProductActionType>,
-        product: SDKProduct,
+        product: SDKProduct | SDKProduct[],
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags,
         transactionAttributes?: TransactionAttributes,
@@ -68,13 +68,13 @@ export interface IEvents {
     ): void;
     logPurchaseEvent(
         transactionAttributes: TransactionAttributes,
-        product: SDKProduct,
+        product: SDKProduct | SDKProduct[],
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags
     ): void;
     logRefundEvent(
         transactionAttributes: TransactionAttributes,
-        product: SDKProduct,
+        product: SDKProduct | SDKProduct[],
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags
     ): void;

src/identity-user-interfaces.ts

@@ -115,10 +115,10 @@ export interface IdentityModifyResultBody {
 }
 
 export interface mParticleUserCart {
-    add(product: Product, logEvent: boolean): void;
-    remove(product: Product, logEvent: boolean): void;
+    add(product: SDKProduct | SDKProduct[], logEvent: boolean): void;
+    remove(product: SDKProduct | SDKProduct[], logEvent: boolean): void;
     clear(): void;
-    getCartProducts(): Product[];
+    getCartProducts(): SDKProduct[];
 }
 
 // https://go.mparticle.com/work/SQDSDKS-5196

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

@@ -1,11 +1,10 @@
 // This file is used ONLY for the mParticle ESLint plugin. It should NOT be used otherwise!
 
 import ServerModel from './serverModel';
-import { SDKEvent, BaseEvent, MParticleWebSDK } from './sdkRuntimeModels';
+import { SDKEvent, BaseEvent } from './sdkRuntimeModels';
 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 +14,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 +117,7 @@ export default class _BatchValidator {
             logLevel: 'none',
             setPosition: mockFunction,
             upload: mockFunction,
-        } as unknown) as MParticleWebSDK;
+        } as unknown) as IMParticleWebSDKInstance;
     }
 
     private createSDKEventFunction(event): SDKEvent {