tighten identity type annotations per PR review

Author: jaissica12

src/forwarders.interfaces.ts

@@ -85,6 +85,8 @@ export interface ConfiguredKit
     removeUserAttribute(key: string): string;
     setUserAttribute(key: string, value: string): string;
     setUserIdentity(id: UserIdentityId, type: UserIdentityType): void;
+    // Legacy method present on some kit implementations; invoked on logout.
+    logOut?: (evt: SDKEvent) => void;
 
     // TODO: https://go.mparticle.com/work/SQDSDKS-5156
     isSandbox: boolean;

src/identity-utils.ts

@@ -34,7 +34,7 @@ export type IParseCachedIdentityResponse = (
     callback: IdentityCallback,
     identityApiData: IdentityApiData,
     identityMethod: string,
-    knownIdentities: IKnownIdentities | UserIdentities,
+    knownIdentities: IKnownIdentities,
     fromCachedIdentity: boolean
 ) => void;
 

src/identity.interfaces.ts

@@ -227,7 +227,7 @@ export interface IIdentity {
         user: IMParticleUser
     ): IUserAttributeChangeEvent;
     createUserIdentityChange(
-        identityType: SDKIdentityTypeEnum | string,
+        identityType: SDKIdentityTypeEnum,
         newIdentity: string,
         oldIdentity: string,
         newCreatedThisBatch: boolean,
@@ -239,7 +239,7 @@ export interface IIdentity {
         callback: IdentityCallback,
         identityApiData: IdentityApiData,
         method: IdentityAPIMethod,
-        knownIdentities: IKnownIdentities | UserIdentities,
+        knownIdentities: IKnownIdentities,
         parsingCachedResponse: boolean
     ): void;
     sendUserAttributeChangeEvent(

src/identity.ts

@@ -1,5 +1,6 @@
 import Constants, { HTTP_OK } from './constants';
 import Types, { IdentityType } from './types';
+import AudienceManager, { IAudienceMemberships } from './audienceManager';
 import {
     cacheOrClearIdCache,
     createKnownIdentities,
@@ -9,40 +10,45 @@ import {
     normalizeUserIdentityKeys,
     tryCacheIdentity,
 } from './identity-utils';
-import AudienceManager, { IAudienceMemberships } from './audienceManager';
-const { Messages, HTTPCodes, FeatureFlags, IdentityMethods } = Constants;
-const { ErrorMessages } = Messages;
-const { CacheIdentity } = FeatureFlags;
-const { Identify, Modify, Login, Logout } = IdentityMethods;
-import {
-    Environment,
-    generateDeprecationMessage,
-    isEmpty,
-    isFunction,
-    isObject,
-} from './utils';
-import { hasMPIDAndUserLoginChanged, hasMPIDChanged } from './user-utils';
-import { processReadyQueue } from './pre-init-utils';
 import {
     IdentityCallback,
     IIdentityResponse,
     IMParticleUser,
     mParticleUserCart,
 } from './identity-user-interfaces';
 import {
+    AliasRequestScope,
+    IAliasCallback,
+    IAliasRequest,
+    IdentityAPIMethod,
     IIdentity,
     IIdentityAPIRequestData,
-    IdentityAPIMethod,
-    IAliasRequest,
-    IAliasCallback,
-    AliasRequestScope,
     SDKIdentityTypeEnum,
 } from './identity.interfaces';
+import { IdentitySearchCallback } from './identity/search';
 import { IMParticleWebSDKInstance } from './mp-instance';
-import { IdentityApiData, UserIdentities, MPID, ConsentState, UserAttributesValue } from '@mparticle/web-sdk';
-import { Context } from '@mparticle/event-models';
+import { processReadyQueue } from './pre-init-utils';
 import { BaseEvent, SDKEvent, SDKLoggerApi } from './sdkRuntimeModels';
-import { IdentitySearchCallback } from './identity/search';
+import { hasMPIDAndUserLoginChanged, hasMPIDChanged } from './user-utils';
+import {
+    generateDeprecationMessage,
+    isEmpty,
+    isFunction,
+    isObject,
+} from './utils';
+import {
+    ConsentState,
+    IdentityApiData,
+    MPID,
+    UserAttributesValue,
+    UserIdentities,
+} from '@mparticle/web-sdk';
+import { Context } from '@mparticle/event-models';
+
+const { Messages, HTTPCodes, FeatureFlags, IdentityMethods } = Constants;
+const { ErrorMessages } = Messages;
+const { CacheIdentity } = FeatureFlags;
+const { Identify, Modify, Login, Logout } = IdentityMethods;
 
 export default function Identity(
     this: IIdentity,
@@ -423,9 +429,8 @@ export default function Identity(
                             mpInstance._Store.activeForwarders.forEach(function(
                                 forwarder
                             ) {
-                                const fwd = forwarder as unknown as Record<string, Function>;
-                                if (typeof fwd.logOut === 'function') {
-                                    fwd.logOut(evt);
+                                if (typeof forwarder.logOut === 'function') {
+                                    forwarder.logOut(evt);
                                 }
                             });
                         }
@@ -1435,7 +1440,7 @@ export default function Identity(
         callback: IdentityCallback,
         identityApiData: IdentityApiData,
         method: IdentityAPIMethod,
-        knownIdentities: IKnownIdentities | UserIdentities,
+        knownIdentities: IKnownIdentities,
         parsingCachedResponse: boolean
     ): void {
         const prevUser = mpInstance.Identity.getUser(previousMPID);
@@ -1687,17 +1692,19 @@ export default function Identity(
         for (const identityType in newUserIdentities) {
             // Verifies a change actually happened
             if (
-                prevUserIdentities[identityType] !==
-                newUserIdentities[identityType]
+                prevUserIdentities[identityType as keyof UserIdentities] !==
+                newUserIdentities[identityType as keyof UserIdentities]
             ) {
                 // If a new identity type was introduced when the identity changes
                 // we need to notify the server so that the user profile is updated in
                 // the mParticle UI.
-                const isNewUserIdentityType = !prevUserIdentities[identityType];
+                const isNewUserIdentityType = !prevUserIdentities[
+                    identityType as keyof UserIdentities
+                ];
                 const userIdentityChangeEvent = self.createUserIdentityChange(
-                    identityType,
-                    newUserIdentities[identityType],
-                    prevUserIdentities[identityType],
+                    identityType as SDKIdentityTypeEnum,
+                    newUserIdentities[identityType as keyof UserIdentities],
+                    prevUserIdentities[identityType as keyof UserIdentities],
                     isNewUserIdentityType,
                     currentUserInMemory
                 );
@@ -1709,7 +1716,7 @@ export default function Identity(
     };
 
     this.createUserIdentityChange = function(
-        identityType: string,
+        identityType: SDKIdentityTypeEnum,
         newIdentity: string,
         oldIdentity: string,
         isIdentityTypeNewToBatch: boolean,

src/identityApiClient.ts

@@ -5,7 +5,7 @@ import {
     XHRUploader,
     IFetchPayload,
 } from './uploaders';
-import { CACHE_HEADER } from './identity-utils';
+import { CACHE_HEADER, IKnownIdentities } from './identity-utils';
 import { obfuscateData, parseNumber, valueof } from './utils';
 import {
     IAliasCallback,
@@ -18,7 +18,6 @@ import {
 import {
     IdentityApiData,
     MPID,
-    UserIdentities,
 } from '@mparticle/web-sdk';
 import {
     IdentityCallback,
@@ -44,7 +43,7 @@ export interface IIdentityApiClient {
         originalIdentityApiData: IdentityApiData,
         parseIdentityResponse: IIdentity['parseIdentityResponse'],
         mpid: MPID,
-        knownIdentities?: UserIdentities
+        knownIdentities?: IKnownIdentities
     ) => Promise<void>;
     getUploadUrl: (method: IdentityAPIMethod, mpid: MPID) => string;
     getIdentityResponseFromFetch: (
@@ -193,7 +192,7 @@ export default function IdentityAPIClient(
         originalIdentityApiData: IdentityApiData,
         parseIdentityResponse: IIdentity['parseIdentityResponse'],
         mpid: MPID,
-        knownIdentities?: UserIdentities
+        knownIdentities?: IKnownIdentities
     ) {
         if (mpInstance._RoktManager?.isInitialized) {
             mpInstance._Store.identifyRequestCount = (mpInstance._Store.identifyRequestCount || 0) + 1;