@mparticle/web-sdk 2.26.2 → 2.26.4

package/src/sdkRuntimeModels.ts

@@ -1,14 +1,9 @@
 import * as EventsApi from '@mparticle/event-models';
 import { DataPlanVersion } from '@mparticle/data-planning-models';
-import {
-    MPConfiguration,
-    IdentityApiData,
-    MPID,
-    Callback,
-} from '@mparticle/web-sdk';
+import { MPConfiguration, MPID, Callback } from '@mparticle/web-sdk';
 import { IStore } from './store';
 import Validators from './validators';
-import { Dictionary, valueof } from './utils';
+import { Dictionary } from './utils';
 import { IServerModel } from './serverModel';
 import { IKitConfigs } from './configAPIClient';
 import { SDKConsentApi, SDKConsentState } from './consent';
@@ -16,7 +11,13 @@ import { IPersistence } from './persistence.interfaces';
 import { IMPSideloadedKit } from './sideloadedKit';
 import { ISessionManager } from './sessionManager';
 import { Kit, MPForwarder } from './forwarders.interfaces';
-import Constants from './constants';
+import { SDKIdentityApi } from './identity.interfaces';
+import {
+    ISDKUserAttributeChangeData,
+    ISDKUserIdentityChanges,
+    IMParticleUser,
+    ISDKUserIdentity,
+} from './identity-user-interfaces';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -26,11 +27,8 @@ export interface SDKEvent {
     IsFirstRun: boolean;
     EventName: string;
     EventCategory: number;
-
-    // https://go.mparticle.com/work/SQDSDKS-5196
     UserAttributes?: { [key: string]: string | string[] | null };
-
-    UserIdentities?: SDKUserIdentity[];
+    UserIdentities?: ISDKUserIdentity[];
     SourceMessageId: string;
     MPID: string;
     EventAttributes?: { [key: string]: string };
@@ -54,15 +52,12 @@ export interface SDKEvent {
     PromotionAction?: SDKPromotionAction;
     ProductImpressions?: SDKProductImpression[];
     ShoppingCart?: SDKShoppingCart;
-    UserIdentityChanges?: SDKUserIdentityChangeData;
-    UserAttributeChanges?: SDKUserAttributeChangeData;
+    UserIdentityChanges?: ISDKUserIdentityChanges;
+    UserAttributeChanges?: ISDKUserAttributeChangeData;
     CurrencyCode: string;
     DataPlan?: SDKDataPlan;
     LaunchReferral?: string;
 }
-
-export type IdentityAPIMethod = valueof<typeof Constants.IdentityMethods>;
-
 export interface SDKGeoLocation {
     lat: number | string;
     lng: number | string;
@@ -73,11 +68,6 @@ export interface SDKDataPlan {
     PlanId?: string | null;
 }
 
-export interface SDKUserIdentity {
-    Identity?: string;
-    Type: number;
-}
-
 export interface SDKShoppingCart {
     ProductList?: SDKProduct[];
 }
@@ -242,16 +232,6 @@ export interface DataPlanConfig {
     document?: DataPlanResult; // when the data plan comes from the server via /mparticle.js
 }
 
-export interface SDKIdentityApi {
-    getCurrentUser();
-    IdentityAPI;
-    identify;
-    login;
-    logout;
-    modify;
-    getUser(mpid: string): MParticleUser;
-}
-
 export interface SDKHelpersApi {
     canLog?(): boolean;
     createMainStorageName?(workspaceToken: string): string;
@@ -274,7 +254,7 @@ export interface SDKHelpersApi {
         callback: Callback,
         code: string,
         body: string,
-        mParticleUser?: MParticleUser,
+        mParticleUser?: IMParticleUser,
         previousMpid?: MPID
     ): void;
     sanitizeAttributes?(
@@ -307,38 +287,6 @@ export interface SDKConfigApi {
     onCreateBatch(batch: EventsApi.Batch): EventsApi.Batch;
 }
 
-// https://go.mparticle.com/work/SQDSDKS-5033
-export interface MParticleUser {
-    getMPID?(): string;
-    getConsentState?(): SDKConsentState;
-
-    // https://go.mparticle.com/work/SQDSDKS-5196
-    getAllUserAttributes?(): any;
-
-    getUserIdentities?(): IdentityApiData;
-    isLoggedIn?(): boolean;
-}
-
-export interface SDKUserIdentityChangeData {
-    New: Identity;
-    Old: Identity;
-}
-
-export interface Identity {
-    IdentityType: SDKIdentityTypeEnum;
-    Identity: string;
-    Timestamp: number;
-    CreatedThisBatch: boolean;
-}
-
-export interface SDKUserAttributeChangeData {
-    UserAttributeName: string;
-    New: string;
-    Old: string;
-    Deleted: boolean;
-    IsNewAttribute: boolean;
-}
-
 export interface BaseEvent {
     messageType: number;
     name?: string;
@@ -347,8 +295,8 @@ export interface BaseEvent {
     customFlags?: { [key: string]: string };
     toEventAPIObject?(): SDKEvent;
     sourceMessageId?: string;
-    userAttributeChanges?: SDKUserAttributeChangeData;
-    userIdentityChanges?: SDKUserIdentityChangeData;
+    userAttributeChanges?: ISDKUserAttributeChangeData;
+    userIdentityChanges?: ISDKUserIdentityChanges;
 }
 
 export interface KitBlockerOptions {
@@ -375,28 +323,3 @@ export interface DataPlanResult {
     };
     error_message?: string;
 }
-
-export enum SDKIdentityTypeEnum {
-    other = 'other',
-    customerId = 'customerid',
-    facebook = 'facebook',
-    twitter = 'twitter',
-    google = 'google',
-    microsoft = 'microsoft',
-    yahoo = 'yahoo',
-    email = 'email',
-    alias = 'alias',
-    facebookCustomAudienceId = 'facebookcustomaudienceid',
-    otherId2 = 'other2',
-    otherId3 = 'other3',
-    otherId4 = 'other4',
-    otherId5 = 'other5',
-    otherId6 = 'other6',
-    otherId7 = 'other7',
-    otherId8 = 'other8',
-    otherId9 = 'other9',
-    otherId10 = 'other10',
-    mobileNumber = 'mobile_number',
-    phoneNumber2 = 'phone_number_2',
-    phoneNumber3 = 'phone_number_3',
-}

package/src/sdkToEventsApiConverter.ts

@@ -3,10 +3,8 @@ import {
     SDKGeoLocation,
     SDKProduct,
     SDKPromotion,
-    SDKUserIdentity,
     SDKProductActionType,
     MParticleWebSDK,
-    SDKIdentityTypeEnum,
 } from './sdkRuntimeModels';
 import * as EventsApi from '@mparticle/event-models';
 import {
@@ -16,6 +14,8 @@ import {
 } from './consent';
 import Types from './types';
 import { isEmpty } from './utils';
+import { ISDKUserIdentity } from './identity-user-interfaces';
+import { SDKIdentityTypeEnum } from './identity.interfaces';
 
 export function convertEvents(
     mpid: string,
@@ -151,7 +151,7 @@ export function convertCcpaConsentState(
 }
 
 export function convertUserIdentities(
-    sdkUserIdentities?: SDKUserIdentity[]
+    sdkUserIdentities?: ISDKUserIdentity[]
 ): EventsApi.BatchUserIdentities | null {
     if (!sdkUserIdentities || !sdkUserIdentities.length) {
         return null;
@@ -407,8 +407,9 @@ export function convertShoppingCart(
 export function convertCommerceEvent(
     sdkEvent: SDKEvent
 ): EventsApi.CommerceEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let commerceEventData: EventsApi.CommerceEventData = {
         custom_flags: sdkEvent.CustomFlags,
         product_action: convertProductAction(sdkEvent),
@@ -427,8 +428,9 @@ export function convertCommerceEvent(
 export function convertCrashReportEvent(
     sdkEvent: SDKEvent
 ): EventsApi.CrashReportEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let crashReportEventData: EventsApi.CrashReportEventData = {
         message: sdkEvent.EventName,
     };
@@ -442,8 +444,9 @@ export function convertCrashReportEvent(
 export function convertAST(
     sdkEvent: SDKEvent
 ): EventsApi.ApplicationStateTransitionEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let astEventData: EventsApi.ApplicationStateTransitionEventData = {
         application_transition_type:
             EventsApi
@@ -463,8 +466,9 @@ export function convertAST(
 export function convertSessionEndEvent(
     sdkEvent: SDKEvent
 ): EventsApi.SessionEndEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let sessionEndEventData: EventsApi.SessionEndEventData = {
         session_duration_ms: sdkEvent.SessionLength,
         //note: External Events DTO does not support the session mpids array as of this time.
@@ -480,8 +484,9 @@ export function convertSessionEndEvent(
 export function convertSessionStartEvent(
     sdkEvent: SDKEvent
 ): EventsApi.SessionStartEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let sessionStartEventData: EventsApi.SessionStartEventData = {};
     sessionStartEventData = Object.assign(
         sessionStartEventData,
@@ -496,8 +501,9 @@ export function convertSessionStartEvent(
 export function convertPageViewEvent(
     sdkEvent: SDKEvent
 ): EventsApi.ScreenViewEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let screenViewEventData: EventsApi.ScreenViewEventData = {
         custom_flags: sdkEvent.CustomFlags,
         screen_name: sdkEvent.EventName,
@@ -510,8 +516,9 @@ export function convertPageViewEvent(
 }
 
 export function convertOptOutEvent(sdkEvent: SDKEvent): EventsApi.OptOutEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let optOutEventData: EventsApi.OptOutEventData = {
         is_opted_out: sdkEvent.OptOut,
     };
@@ -523,8 +530,9 @@ export function convertOptOutEvent(sdkEvent: SDKEvent): EventsApi.OptOutEvent {
 }
 
 export function convertCustomEvent(sdkEvent: SDKEvent): EventsApi.CustomEvent {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let customEventData: EventsApi.CustomEventData = {
         custom_event_type: convertSdkEventType(
             sdkEvent.EventCategory
@@ -628,8 +636,9 @@ export function convertSDKLocation(
 export function convertUserAttributeChangeEvent(
     sdkEvent: SDKEvent
 ): EventsApi.UserAttributeChangeEvent | null {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
     let userAttributeChangeEvent: EventsApi.UserAttributeChangeEventData = {
         user_attribute_name: sdkEvent.UserAttributeChanges.UserAttributeName,
         new: sdkEvent.UserAttributeChanges.New,
@@ -652,8 +661,9 @@ export function convertUserAttributeChangeEvent(
 export function convertUserIdentityChangeEvent(
     sdkEvent: SDKEvent
 ): EventsApi.UserIdentityChangeEvent | null {
-    const commonEventData: EventsApi.CommonEventData =
-        convertBaseEventData(sdkEvent);
+    const commonEventData: EventsApi.CommonEventData = convertBaseEventData(
+        sdkEvent
+    );
 
     let userIdentityChangeEvent: EventsApi.UserIdentityChangeEventData = {
         new: {

package/src/serverModel.ts

@@ -6,12 +6,10 @@ import Types from './types';
 import Constants from './constants';
 import {
     BaseEvent,
-    MParticleUser,
     MParticleWebSDK,
     SDKEvent,
     SDKGeoLocation,
     SDKProduct,
-    SDKUserIdentity,
 } from './sdkRuntimeModels';
 import {
     parseNumber,
@@ -27,7 +25,7 @@ import {
     IPrivacyV2DTO,
     SDKConsentState,
 } from './consent';
-import { UserAttributes } from './persistence.interfaces';
+import { IMParticleUser, ISDKUserIdentity } from './identity-user-interfaces';
 
 const MessageType = Types.MessageType;
 const ApplicationTransitionType = Types.ApplicationTransitionType;
@@ -48,11 +46,8 @@ export interface IServerV2DTO {
     dp_v?: number;
     n?: string;
     et?: number;
-
-    // https://go.mparticle.com/work/SQDSDKS-5196
     ua?: Dictionary<string | string[]>;
-
-    ui?: SDKUserIdentity[];
+    ui?: ISDKUserIdentity[];
     ia?: Dictionary<Dictionary<string>>;
     str?: ServerSettings;
     sdk?: string;
@@ -139,9 +134,9 @@ export interface IUploadObject extends SDKEvent {
 
 export interface IServerModel {
     convertEventToV2DTO: (event: IUploadObject) => IServerV2DTO;
-    createEventObject: (event: BaseEvent, user?: MParticleUser) => SDKEvent;
+    createEventObject: (event: BaseEvent, user?: IMParticleUser) => SDKEvent;
     convertToConsentStateV2DTO: (state: SDKConsentState) => IConsentStateV2DTO;
-    appendUserInfo: (user: MParticleUser, event: SDKEvent) => void;
+    appendUserInfo: (user: IMParticleUser, event: SDKEvent) => void;
 }
 
 // TODO: Make this a pure function that returns a new object
@@ -203,7 +198,10 @@ export default function ServerModel(
     var self = this;
 
     // TODO: Can we refactor this to not mutate the event?
-    this.appendUserInfo = function(user: MParticleUser, event: SDKEvent): void {
+    this.appendUserInfo = function(
+        user: IMParticleUser,
+        event: SDKEvent
+    ): void {
         if (!event) {
             return;
         }
@@ -234,7 +232,7 @@ export default function ServerModel(
         if (mpInstance._Helpers.isObject(dtoUserIdentities)) {
             if (Object.keys(dtoUserIdentities).length) {
                 for (var key in dtoUserIdentities) {
-                    var userIdentity: Partial<SDKUserIdentity> = {};
+                    var userIdentity: Partial<ISDKUserIdentity> = {};
                     userIdentity.Identity = dtoUserIdentities[key];
                     userIdentity.Type = mpInstance._Helpers.parseNumber(key);
                     validUserIdentities.push(userIdentity);
@@ -296,7 +294,7 @@ export default function ServerModel(
 
     this.createEventObject = function(
         event: BaseEvent,
-        user?: MParticleUser
+        user?: IMParticleUser
     ): SDKEvent | IUploadObject {
         var uploadObject: Partial<IUploadObject> = {};
         var eventObject: Partial<SDKEvent> = {};

package/src/sessionManager.ts

@@ -1,9 +1,10 @@
 import { MPID } from '@mparticle/web-sdk';
 import Constants from './constants';
 import { IPersistenceMinified } from './persistence.interfaces';
-import { MParticleUser, MParticleWebSDK } from './sdkRuntimeModels';
+import { MParticleWebSDK } from './sdkRuntimeModels';
 import Types from './types';
 import { generateDeprecationMessage } from './utils';
+import { IMParticleUser } from './identity-user-interfaces';
 
 const { Messages } = Constants;
 
@@ -86,7 +87,7 @@ export default function SessionManager(
                 .generateUniqueId()
                 .toUpperCase();
 
-            const currentUser: MParticleUser = mpInstance.Identity.getCurrentUser();
+            const currentUser: IMParticleUser = mpInstance.Identity.getCurrentUser();
             const mpid: MPID = currentUser ? currentUser.getMPID() : null;
 
             if (mpid) {

package/src/store.ts

@@ -26,7 +26,6 @@ import {
     isEmpty,
     isNumber,
     isObject,
-    moveElementToEnd,
     parseNumber,
     returnConvertedBoolean,
 } from './utils';
@@ -186,7 +185,6 @@ export interface IStore {
     getLastSeenTime?(mpid: MPID): number;
     setLastSeenTime?(mpid: MPID, time?: number): void;
 
-    addMpidToSessionHistory?(mpid: MPID, previousMpid?: MPID): void;
     hasInvalidIdentifyRequest?: () => boolean;
     nullifySession?: () => void;
     processConfig(config: SDKInitConfig): void;
@@ -495,22 +493,6 @@ export default function Store(
         mpInstance._Persistence.update();
     };
 
-    this.addMpidToSessionHistory = (mpid: MPID, previousMPID?: MPID): void => {
-        const indexOfMPID = this.currentSessionMPIDs.indexOf(mpid);
-
-        if (mpid && previousMPID !== mpid && indexOfMPID < 0) {
-            this.currentSessionMPIDs.push(mpid);
-            return;
-        }
-
-        if (indexOfMPID >= 0) {
-            this.currentSessionMPIDs = moveElementToEnd(
-                this.currentSessionMPIDs,
-                indexOfMPID
-            );
-        }
-    };
-
     this.getFirstSeenTime = (mpid: MPID) => {
         if (!mpid) {
             return null;

package/src/types.js

@@ -1,5 +1,3 @@
-import { getIdentityName } from './type-utils';
-
 var MessageType = {
     SessionStart: 1,
     SessionEnd: 2,
@@ -211,7 +209,50 @@ IdentityType.getIdentityType = function(identityName) {
 };
 
 IdentityType.getIdentityName = function(identityType) {
-    return getIdentityName(identityType);
+    switch (identityType) {
+        case IdentityType.Other:
+            return 'other';
+        case IdentityType.CustomerId:
+            return 'customerid';
+        case IdentityType.Facebook:
+            return 'facebook';
+        case IdentityType.Twitter:
+            return 'twitter';
+        case IdentityType.Google:
+            return 'google';
+        case IdentityType.Microsoft:
+            return 'microsoft';
+        case IdentityType.Yahoo:
+            return 'yahoo';
+        case IdentityType.Email:
+            return 'email';
+        case IdentityType.FacebookCustomAudienceId:
+            return 'facebookcustomaudienceid';
+        case IdentityType.Other2:
+            return 'other2';
+        case IdentityType.Other3:
+            return 'other3';
+        case IdentityType.Other4:
+            return 'other4';
+        case IdentityType.Other5:
+            return 'other5';
+        case IdentityType.Other6:
+            return 'other6';
+        case IdentityType.Other7:
+            return 'other7';
+        case IdentityType.Other8:
+            return 'other8';
+        case IdentityType.Other9:
+            return 'other9';
+        case IdentityType.Other10:
+            return 'other10';
+        case IdentityType.MobileNumber:
+            return 'mobile_number';
+        case IdentityType.PhoneNumber2:
+            return 'phone_number_2';
+        case IdentityType.PhoneNumber3:
+            return 'phone_number_3';
+    }
 };
 
 var ProductActionType = {

package/src/utils.ts

@@ -7,6 +7,8 @@ type valueof<T> = T[keyof T];
 // Placeholder for Dictionary-like Types
 export type Dictionary<V = any> = Record<string, V>;
 
+export type Environment = 'development' | 'production';
+
 const createCookieString = (value: string): string =>
     replaceCommasWithPipes(replaceQuotesWithApostrophes(value));
 
@@ -227,9 +229,6 @@ const mergeObjects = <T extends object>(...objects: T[]): T => {
     return Object.assign({}, ...objects);
 };
 
-const moveElementToEnd = <T>(array: T[], index: number): T[] =>
-    array.slice(0, index).concat(array.slice(index + 1), array[index]);
-
 export {
     createCookieString,
     revertCookieString,
@@ -259,5 +258,4 @@ export {
     isEmpty,
     isValidCustomFlagProperty,
     mergeObjects,
-    moveElementToEnd,
 };

package/src/validators.ts

@@ -8,7 +8,7 @@ import {
 } from './utils';
 import Constants from './constants';
 import { IdentityApiData } from '@mparticle/web-sdk';
-import { IdentityAPIMethod } from './sdkRuntimeModels';
+import { IdentityAPIMethod } from './identity.interfaces';
 
 type ValidationIdentitiesReturn = {
     valid: boolean;

package/src/type-utils.ts

@@ -1,66 +0,0 @@
-import { IdentityType } from './types.interfaces';
-import { parseNumber } from './utils';
-
-export interface IIdentitiesByType {
-    [key: number]: string;
-}
-
-export function getNewIdentitiesByName(newIdentitiesByType: IIdentitiesByType) {
-    const newIdentitiesByName = {};
-
-    for (var key in newIdentitiesByType) {
-        const identityNameKey = getIdentityName(parseNumber(key));
-        newIdentitiesByName[identityNameKey] = newIdentitiesByType[key];
-    }
-
-    return newIdentitiesByName;
-}
-
-export function getIdentityName(identityType: IdentityType): string | null {
-    switch (identityType) {
-        case IdentityType.Other:
-            return 'other';
-        case IdentityType.CustomerId:
-            return 'customerid';
-        case IdentityType.Facebook:
-            return 'facebook';
-        case IdentityType.Twitter:
-            return 'twitter';
-        case IdentityType.Google:
-            return 'google';
-        case IdentityType.Microsoft:
-            return 'microsoft';
-        case IdentityType.Yahoo:
-            return 'yahoo';
-        case IdentityType.Email:
-            return 'email';
-        case IdentityType.FacebookCustomAudienceId:
-            return 'facebookcustomaudienceid';
-        case IdentityType.Other2:
-            return 'other2';
-        case IdentityType.Other3:
-            return 'other3';
-        case IdentityType.Other4:
-            return 'other4';
-        case IdentityType.Other5:
-            return 'other5';
-        case IdentityType.Other6:
-            return 'other6';
-        case IdentityType.Other7:
-            return 'other7';
-        case IdentityType.Other8:
-            return 'other8';
-        case IdentityType.Other9:
-            return 'other9';
-        case IdentityType.Other10:
-            return 'other10';
-        case IdentityType.MobileNumber:
-            return 'mobile_number';
-        case IdentityType.PhoneNumber2:
-            return 'phone_number_2';
-        case IdentityType.PhoneNumber3:
-            return 'phone_number_3';
-        default:
-            return null;
-    }
-}

package/src/user-utils.ts

@@ -1,12 +0,0 @@
-import { MParticleUser } from './sdkRuntimeModels';
-
-export function didUserChange(
-    previousUser: MParticleUser,
-    newUser: MParticleUser
-): boolean {
-    return (
-        !previousUser ||
-        newUser.getMPID() !== previousUser.getMPID() ||
-        previousUser.isLoggedIn() !== newUser.isLoggedIn()
-    );
-}