Skip to content

refactor: migrate identity module to TS #1248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jaissica12 wants to merge 1 commit into
base: development
Choose a base branch
from
Draft

refactor: migrate identity module to TS #1248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/identity-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type IParseCachedIdentityResponse = (
callback: IdentityCallback,
identityApiData: IdentityApiData,
identityMethod: string,
knownIdentities: IKnownIdentities,
knownIdentities: IKnownIdentities | UserIdentities,
fromCachedIdentity: boolean
) => void;

Expand Down
47 changes: 30 additions & 17 deletions src/identity.interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { IdentityApiData, MPID, UserIdentities } from '@mparticle/web-sdk';
import { Context } from '@mparticle/event-models';
import AudienceManager from './audienceManager';
import { ICachedIdentityCall, IKnownIdentities } from './identity-utils';
import { BaseVault } from './vault';
Expand All @@ -17,6 +18,7 @@
export type IdentityPreProcessResult = {
valid: boolean;
error?: string;
cleanedIdentities?: IdentityApiData;
};

export type IdentityAPIMethod = valueof<typeof Constants.IdentityMethods>;
Expand Down Expand Up @@ -48,14 +50,14 @@

export interface IIdentityAPIRequestData {
client_sdk: {
platform: typeof platform;
sdk_vendor: typeof sdkVendor;
sdk_version: typeof sdkVersion;
platform: string;
sdk_vendor: string;
sdk_version: string;
};
context: string | null;
context: Context | null;
environment: Environment;
request_id: string;
request_timestamp_unixtime_ms: number;
request_timestamp_ms: number;
previous_mpid: MPID | null;
known_identities: IKnownIdentities;
}
Expand Down Expand Up @@ -85,7 +87,7 @@
sdkVendor: string,
sdkVersion: string,
deviceId: string,
context: string | null,
context: Context | null,
mpid: MPID
): IIdentityAPIRequestData;
createModifyIdentityRequest(
Expand All @@ -94,17 +96,20 @@
platform: string,
sdkVendor: string,
sdkVersion: string,
context: string | null
context: Context | null
): IIdentityAPIModifyRequestData;
createIdentityChanges(
previousIdentities: UserIdentities,
newIdentitie: UserIdentities
): IIdentityAPIIdentityChangeData;
newIdentities: UserIdentities
): IIdentityAPIIdentityChangeData[];
preProcessIdentityRequest(
identityApiData: IdentityApiData,
callback: IdentityCallback,
method: IdentityAPIMethod
): IdentityPreProcessResult;
createAliasNetworkRequest(aliasRequest: IAliasRequest): object;
convertAliasToNative(aliasRequest: IAliasRequest): object;
convertToNative(identityApiData: IdentityApiData): object | void;
}

export type AliasRequestScope = 'device' | 'mpid';
Expand Down Expand Up @@ -149,7 +154,7 @@
getUsers?(): IMParticleUser[];
aliasUsers?(
aliasRequest?: IAliasRequest,
callback?: IdentityCallback
callback?: IAliasCallback
): void;
createAliasRequest?(
sourceUser: IMParticleUser,
Expand All @@ -165,18 +170,18 @@
IdentityAPI: SDKIdentityApi;
IdentityRequest: IIdentityRequest;

mParticleUser(mpid: MPID, IsLoggedIn: boolean): IMParticleUser;
mParticleUser(mpid?: MPID, IsLoggedIn?: boolean): IMParticleUser;

createUserAttributeChange(
key: string,
newValue: string,
previousUserAttributeValue: string,
newValue: string | string[] | null,

Check warning on line 177 in src/identity.interfaces.ts

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Replace this union type with a type alias. 


See more on https://sonarcloud.io/project/issues?id=mParticle_mparticle-web-sdk&issues=AZ2Iz2vIpP9saPcjGiXG&open=AZ2Iz2vIpP9saPcjGiXG&pullRequest=1248
previousUserAttributeValue: string | string[] | null,
isNewAttribute: boolean,
deleted: boolean,
user: IMParticleUser
): IUserAttributeChangeEvent;
createUserIdentityChange(
identityType: SDKIdentityTypeEnum,
identityType: SDKIdentityTypeEnum | string,
newIdentity: string,
oldIdentity: string,
newCreatedThisBatch: boolean,
Expand All @@ -188,13 +193,13 @@
callback: IdentityCallback,
identityApiData: IdentityApiData,
method: IdentityAPIMethod,
knownIdentities: UserIdentities,
knownIdentities: IKnownIdentities | UserIdentities,
parsingCachedResponse: boolean
): void;
sendUserAttributeChangeEvent(
attributeKey: string,
newUserAttributeValue: string,
previousUserAttributeValue: string,
newUserAttributeValue: string | string[] | null,
previousUserAttributeValue: string | string[] | null,
isNewAttribute: boolean,
deleted: boolean,
user: IMParticleUser
Expand All @@ -205,6 +210,14 @@
mpid: MPID,
prevUserIdentities: UserIdentities
): void;
reinitForwardersOnUserChange(
prevUser: IMParticleUser,
newUser: IMParticleUser
): void;
setForwarderCallbacks(
user: IMParticleUser,
method: IdentityAPIMethod
): void;

/**
* @deprecated
Expand Down
Loading
Loading