refactor: Create Distinct Kit Interfaces

Author: alexs-mparticle

src/forwarders.interfaces.ts

@@ -1,29 +1,37 @@
 import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
 import { Dictionary } from './utils';
-import { IKitConfigs } from './configAPIClient';
+import { IKitConfigs, IKitFilterSettings } from './configAPIClient';
 import { IdentityApiData } from '@mparticle/web-sdk';
 import {
     IMParticleUser,
     ISDKUserIdentity,
     UserAttributes,
 } from './identity-user-interfaces';
 
-// TODO: https://go.mparticle.com/work/SQDSDKS-6035
-export type Kit = Dictionary;
+// TODO: https://go.mparticle.com/work/SQDSDKS-4475
 export type MPForwarder = Dictionary;
 
 // The state of the kit when accessed via window.KitName via CDN
 // or imported as an NPM package
 export interface UnregisteredKit {
-    register(config): void;
+    constructor: () => void;
+    register(config: KitRegistrationConfig): void;
+    name: string;
+    suffix?: string;
 }
 
 // The state of the kit after being added to forwarderConstructors in the CDN
 // or after registered to SDKConfig.kits via NPM
 export interface RegisteredKit {
-    constructor(): void;
-    name: string;
-    getId(): number;
+    constructor: () => void;
+
+    // Applies to sideloaded kits only
+    filters: IKitFilterSettings;
+}
+
+// This is the subset of the SDKConfig.kits object that is used to register kits.
+export interface KitRegistrationConfig {
+    kits: Dictionary<RegisteredKit>;
 }
 
 // The state of the kit after being configured. This is what the kit looks like when acted on.
@@ -45,22 +53,22 @@ export interface ConfiguredKit
     onIdentifyComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
+    ): string;
     onLoginComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
+    ): string;
     onLogoutComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
+    ): string;
     onModifyComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
-    onUserIdentified(user: IMParticleUser): string | KitMappedMethodFailure;
+    ): string;
+    onUserIdentified(user: IMParticleUser): string;
     process(event: SDKEvent): string;
-    setOptOut(isOptingOut: boolean): string | KitMappedMethodFailure;
+    setOptOut(isOptingOut: boolean): string;
     removeUserAttribute(key: string): string;
     setUserAttribute(key: string, value: string): string;
     setUserIdentity(id: UserIdentityId, type: UserIdentityType): void;
@@ -69,9 +77,6 @@ export interface ConfiguredKit
     isSandbox: boolean;
     hasSandbox: boolean;
 }
-export interface KitMappedMethodFailure {
-    error: string;
-}
 
 export type UserIdentityId = string;
 export type UserIdentityType = number;

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,
@@ -163,7 +163,7 @@ export interface SDKProduct {
 
 // https://go.mparticle.com/work/SQDSDKS-6949
 export interface MParticleWebSDK {
-    addForwarder(mockForwarder: MPForwarder): void;
+    addForwarder(forwarder: UnregisteredKit): void;
     IdentityType: valueof<typeof IdentityType>;
     CommerceEventType: valueof<typeof CommerceEventType>;
     EventType: valueof<typeof EventType>;
@@ -179,7 +179,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;
@@ -266,7 +266,7 @@ export interface SDKInitConfig
     logLevel?: LogLevelType;
 
     kitConfigs?: IKitConfigs[];
-    kits?: Dictionary<Kit>;
+    kits?: Dictionary<UnregisteredKit>;
     sideloadedKits?: MPForwarder[];
     dataPlanOptions?: KitBlockerOptions;
     flags?: Dictionary;

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;
@@ -176,7 +176,7 @@ export interface IStore {
     isLocalStorageAvailable: boolean | null;
     storageName: string | null;
     prodStorageName: string | null;
-    activeForwarders: MPForwarder[];
+    activeForwarders: ConfiguredKit[];
     kits: Dictionary<MPForwarder>;
     sideloadedKits: MPForwarder[];
     configuredForwarders: MPForwarder[];

test/jest/sideloadedKit.spec.ts

@@ -5,7 +5,9 @@ import { UnregisteredKit } from '../../src/forwarders.interfaces';
 import { IKitFilterSettings } from '../../src/configAPIClient';
 
 const mockKitInstance: UnregisteredKit = {
-    register: function() {}
+    register: function() {},
+    name: 'mock-kit',
+    constructor: function() {},
 };
 
 describe('MPSideloadedKit', () => {

test/jest/utils.ts

@@ -1,4 +1,4 @@
-import { UnregisteredKit } from "../../src/forwarders.interfaces";
+import { ConfiguredKit, KitRegistrationConfig, RegisteredKit, UnregisteredKit } from "../../src/forwarders.interfaces";
 import { SDKInitConfig } from "../../src/sdkRuntimeModels";
 
 // export interface IMockForwarder {
@@ -37,11 +37,11 @@ export class MockForwarder {
         this.moduleId = id || 1;
     }
 
-    public register = (config: SDKInitConfig): void => {
+    public register = (config: KitRegistrationConfig): void => {
         if (config.kits) {
             config.kits[this.name] = {
-                constructor: this.constructor,
-            };
+                constructor: this.constructor as () => RegisteredKit,
+            } as unknown as RegisteredKit;
         }
     }