@mparticle/web-sdk 2.17.4 → 2.18.1

package/src/{serverModel.js → serverModel.ts}

@@ -1,47 +1,230 @@
+// TODO: This file is no longer the server model because the web SDK payload
+//       is now the server-to-server model.  We should rename this to
+//       something more appropriate.
+
 import Types from './types';
 import Constants from './constants';
+import {
+    BaseEvent,
+    MParticleUser,
+    MParticleWebSDK,
+    SDKConsentState,
+    SDKEvent,
+    SDKGeoLocation,
+    SDKProduct,
+    SDKUserIdentity,
+} from './sdkRuntimeModels';
+import { parseNumber, parseStringOrNumber, Dictionary } from './utils';
+import { ServerSettings } from './store';
+import { MPID } from '@mparticle/web-sdk';
+
+const MessageType = Types.MessageType;
+const ApplicationTransitionType = Types.ApplicationTransitionType;
+
+// TODO: Move to Consent Module
+export interface IPrivacyV2DTO {
+    c: boolean; // Consented
+    ts: number; // Timestamp
+    d: string; // Document
+    l: string; // Location
+    h: string; // HardwareID
+}
+
+// TODO: Move to Consent Module
+export interface IGDPRConsentStateDTO {
+    [key: string]: IPrivacyV2DTO;
+}
 
-var MessageType = Types.MessageType,
-    ApplicationTransitionType = Types.ApplicationTransitionType;
+// TODO: Move to Consent Module
+export interface ICCPAConsentStateDTO {
+    data_sale_opt_out: IPrivacyV2DTO;
+}
 
-export default function ServerModel(mpInstance) {
-    var self = this;
-    function convertCustomFlags(event, dto) {
-        var valueArray = [];
-        dto.flags = {};
+// TODO: Break this up into GDPR and CCPA interfaces
+export interface IConsentStateDTO {
+    gdpr?: IGDPRConsentStateDTO;
+    ccpa?: ICCPAConsentStateDTO;
+}
 
-        for (var prop in event.CustomFlags) {
-            valueArray = [];
+// TODO: Confirm which attributes are optional
+export interface IServerDTO {
+    id: string | number;
+    nm: string | number;
+    pr: number;
+    qt: number;
+    br: string | number;
+    va: string | number;
+    ca: string | number;
+    ps: number;
+    cc: string | number;
+    attrs: Record<string, string> | null;
+    dp_id?: string;
+    dp_v?: number;
+    n?: string;
+    et?: number;
+    ua?: Dictionary<string | string[]>;
+    ui?: SDKUserIdentity[];
+    ia?: Dictionary<Dictionary<string>>;
+    str?: ServerSettings;
+    sdk?: string;
+    sid?: string;
+    sl?: number;
+    ssd?: number;
+    dt?: number;
+    dbg?: boolean;
+    ct?: number;
+    lc?: SDKGeoLocation;
+    o?: boolean;
+    eec?: number;
+    av?: string;
+    cgid?: string;
+    das?: string;
+    mpid?: MPID;
+    smpids?: MPID[];
+    con?: IConsentStateDTO;
+    fr?: boolean;
+    iu?: boolean; // isUpgrade
+    at?: number;
+    lr?: string;
+    flags?: Dictionary<string[]>;
+    cu?: string;
+    sc?: {
+        pl: IProductDTO[];
+    };
+    pd?: {
+        an: number;
+        cs: number;
+        co: string;
+        pl: IProductDTO[];
+        ta: string;
+        ti: string;
+        tcc: string;
+        tr: number;
+        ts: number;
+        tt: number;
+    };
+    pm?: {
+        an: string;
+        pl: IPromotionDTO[];
+    };
+    pi?: IProductImpressionDTO[];
+    pet?: number;
+}
 
-            if (event.CustomFlags.hasOwnProperty(prop)) {
-                if (Array.isArray(event.CustomFlags[prop])) {
-                    event.CustomFlags[prop].forEach(function(
-                        customFlagProperty
+export interface IProductDTO {
+    id: string | number;
+    nm: string | number;
+    pr: number;
+    qt: number;
+    br: string | number;
+    va: string | number;
+    ca: string | number;
+    ps: number;
+    cc: string | number;
+    tpa: number;
+    attrs: Record<string, string> | null;
+}
+
+export interface IPromotionDTO {
+    id: string | number;
+    nm: string | number;
+    ps: string | number;
+    cr: string;
+}
+
+export interface IProductImpressionDTO {
+    pil: string;
+    pl: IProductDTO[];
+}
+
+export interface IUploadObject extends SDKEvent {
+    // TODO: References to `ClientGeneratedId` can be removed when we remove the
+    //       V2 event upload path because it does not exist in the V3 payload
+    ClientGeneratedId: string;
+    // FIXME: This reference to Store is misleading and can be removed whenever
+    //        we deprecate v2 related code
+    Store: ServerSettings;
+    ExpandedEventCount: number;
+    ProfileMessageType: number;
+}
+
+export interface IServerModel {
+    convertEventToDTO: (event: IUploadObject) => IServerDTO;
+    createEventObject: (event: BaseEvent, user?: MParticleUser) => SDKEvent;
+    convertToConsentStateDTO: (state: SDKConsentState) => IConsentStateDTO;
+    appendUserInfo: (user: MParticleUser, event: SDKEvent) => void;
+}
+
+// TODO: Make this a pure function that returns a new object
+function convertCustomFlags(event: SDKEvent, dto: IServerDTO) {
+    var valueArray: string[] = [];
+    dto.flags = {};
+
+    for (var prop in event.CustomFlags) {
+        valueArray = [];
+
+        if (event.CustomFlags.hasOwnProperty(prop)) {
+            if (Array.isArray(event.CustomFlags[prop])) {
+                event.CustomFlags[prop].forEach(function(customFlagProperty) {
+                    // TODO: Can we use our utility functions here?
+                    if (
+                        typeof customFlagProperty === 'number' ||
+                        typeof customFlagProperty === 'string' ||
+                        typeof customFlagProperty === 'boolean'
                     ) {
-                        if (
-                            typeof customFlagProperty === 'number' ||
-                            typeof customFlagProperty === 'string' ||
-                            typeof customFlagProperty === 'boolean'
-                        ) {
-                            valueArray.push(customFlagProperty.toString());
-                        }
-                    });
-                } else if (
-                    typeof event.CustomFlags[prop] === 'number' ||
-                    typeof event.CustomFlags[prop] === 'string' ||
-                    typeof event.CustomFlags[prop] === 'boolean'
-                ) {
-                    valueArray.push(event.CustomFlags[prop].toString());
-                }
+                        valueArray.push(customFlagProperty.toString());
+                    }
+                });
+            } else if (
+                // TODO: Can we use our utility functions here?
+                typeof event.CustomFlags[prop] === 'number' ||
+                typeof event.CustomFlags[prop] === 'string' ||
+                typeof event.CustomFlags[prop] === 'boolean'
+            ) {
+                valueArray.push(event.CustomFlags[prop].toString());
+            }
 
-                if (valueArray.length) {
-                    dto.flags[prop] = valueArray;
-                }
+            if (valueArray.length) {
+                dto.flags[prop] = valueArray;
             }
         }
     }
+}
+
+function convertProductToDTO(product: SDKProduct): IProductDTO {
+    return {
+        id: parseStringOrNumber(product.Sku),
+        nm: parseStringOrNumber(product.Name),
+        pr: parseNumber(product.Price),
+        qt: parseNumber(product.Quantity),
+        br: parseStringOrNumber(product.Brand),
+        va: parseStringOrNumber(product.Variant),
+        ca: parseStringOrNumber(product.Category),
+        ps: parseNumber(product.Position),
+        cc: parseStringOrNumber(product.CouponCode),
+        tpa: parseNumber(product.TotalAmount),
+        attrs: product.Attributes,
+    };
+}
+
+function convertProductListToDTO(productList: SDKProduct[]): IProductDTO[] {
+    if (!productList) {
+        return [];
+    }
 
-    this.appendUserInfo = function(user, event) {
+    return productList.map(function(product) {
+        return convertProductToDTO(product);
+    });
+}
+
+export default function ServerModel(
+    this: IServerModel,
+    mpInstance: MParticleWebSDK
+) {
+    var self = this;
+
+    // TODO: Can we refactor this to not mutate the event?
+    this.appendUserInfo = function(user: MParticleUser, event: SDKEvent): void {
         if (!event) {
             return;
         }
@@ -72,7 +255,7 @@ export default function ServerModel(mpInstance) {
         if (mpInstance._Helpers.isObject(dtoUserIdentities)) {
             if (Object.keys(dtoUserIdentities).length) {
                 for (var key in dtoUserIdentities) {
-                    var userIdentity = {};
+                    var userIdentity: Partial<SDKUserIdentity> = {};
                     userIdentity.Identity = dtoUserIdentities[key];
                     userIdentity.Type = mpInstance._Helpers.parseNumber(key);
                     validUserIdentities.push(userIdentity);
@@ -82,45 +265,21 @@ export default function ServerModel(mpInstance) {
         event.UserIdentities = validUserIdentities;
     };
 
-    function convertProductListToDTO(productList) {
-        if (!productList) {
-            return [];
-        }
-
-        return productList.map(function(product) {
-            return convertProductToDTO(product);
-        });
-    }
-
-    function convertProductToDTO(product) {
-        return {
-            id: mpInstance._Helpers.parseStringOrNumber(product.Sku),
-            nm: mpInstance._Helpers.parseStringOrNumber(product.Name),
-            pr: mpInstance._Helpers.parseNumber(product.Price),
-            qt: mpInstance._Helpers.parseNumber(product.Quantity),
-            br: mpInstance._Helpers.parseStringOrNumber(product.Brand),
-            va: mpInstance._Helpers.parseStringOrNumber(product.Variant),
-            ca: mpInstance._Helpers.parseStringOrNumber(product.Category),
-            ps: mpInstance._Helpers.parseNumber(product.Position),
-            cc: mpInstance._Helpers.parseStringOrNumber(product.CouponCode),
-            tpa: mpInstance._Helpers.parseNumber(product.TotalAmount),
-            attrs: product.Attributes,
-        };
-    }
-
-    this.convertToConsentStateDTO = function(state) {
+    this.convertToConsentStateDTO = function(
+        state: SDKConsentState
+    ): IConsentStateDTO {
         if (!state) {
             return null;
         }
-        var jsonObject = {};
+        var jsonObject: IConsentStateDTO = {};
         var gdprConsentState = state.getGDPRConsentState();
         if (gdprConsentState) {
-            var gdpr = {};
+            var gdpr: IGDPRConsentStateDTO = {};
             jsonObject.gdpr = gdpr;
             for (var purpose in gdprConsentState) {
                 if (gdprConsentState.hasOwnProperty(purpose)) {
                     var gdprConsent = gdprConsentState[purpose];
-                    jsonObject.gdpr[purpose] = {};
+                    jsonObject.gdpr[purpose] = {} as IPrivacyV2DTO;
                     if (typeof gdprConsent.Consented === 'boolean') {
                         gdpr[purpose].c = gdprConsent.Consented;
                     }
@@ -153,28 +312,41 @@ export default function ServerModel(mpInstance) {
             };
         }
 
-        return jsonObject;
+        return jsonObject as IConsentStateDTO;
     };
 
-    this.createEventObject = function(event, user) {
-        var uploadObject = {};
-        var eventObject = {};
-
+    this.createEventObject = function(
+        event: BaseEvent,
+        user?: MParticleUser
+    ): SDKEvent | IUploadObject {
+        var uploadObject: Partial<IUploadObject> = {};
+        var eventObject: Partial<SDKEvent> = {};
+
+        //  The `optOut` variable is passed later in this method to the `uploadObject`
+        //  so that it can be used to denote whether or not a user has "opted out" of being
+        //  tracked. If this is an `optOut` Event, we set `optOut` to the inverse of the SDK's
+        // `isEnabled` boolean which is controlled via `MPInstanceManager.setOptOut`.
         var optOut =
             event.messageType === Types.MessageType.OptOut
                 ? !mpInstance._Store.isEnabled
                 : null;
 
+        // TODO: Why is Webview Bridge Enabled or Opt Out necessary here?
         if (
             mpInstance._Store.sessionId ||
-            event.messageType == Types.MessageType.OptOut ||
+            event.messageType === Types.MessageType.OptOut ||
             mpInstance._Store.webviewBridgeEnabled
         ) {
             if (event.hasOwnProperty('toEventAPIObject')) {
                 eventObject = event.toEventAPIObject();
             } else {
                 eventObject = {
-                    EventName: event.name || event.messageType,
+                    // This is an artifact from v2 events where SessionStart/End and AST event
+                    //  names are numbers (1, 2, or 10), but going forward with v3, these lifecycle
+                    //  events do not have names, but are denoted by their `event_type`
+                    EventName:
+                        event.name ||
+                        ((event.messageType as unknown) as string),
                     EventCategory: event.eventType,
                     EventAttributes: mpInstance._Helpers.sanitizeAttributes(
                         event.data,
@@ -190,11 +362,13 @@ export default function ServerModel(mpInstance) {
                 };
             }
 
+            // TODO: Should we move this side effect outside of this method?
             if (event.messageType !== Types.MessageType.SessionEnd) {
                 mpInstance._Store.dateLastEventSent = new Date();
             }
 
             uploadObject = {
+                // FIXME: Deprecate when we get rid of V2
                 Store: mpInstance._Store.serverSettings,
                 SDKVersion: Constants.sdkVersion,
                 SessionId: mpInstance._Store.sessionId,
@@ -222,9 +396,10 @@ export default function ServerModel(mpInstance) {
                 eventObject.LaunchReferral = window.location.href || null;
             }
 
+            // FIXME: Remove duplicate occurence
             eventObject.CurrencyCode = mpInstance._Store.currencyCode;
             var currentUser = user || mpInstance.Identity.getCurrentUser();
-            self.appendUserInfo(currentUser, eventObject);
+            self.appendUserInfo(currentUser, eventObject as SDKEvent);
 
             if (event.messageType === Types.MessageType.SessionEnd) {
                 eventObject.SessionLength =
@@ -232,9 +407,15 @@ export default function ServerModel(mpInstance) {
                     mpInstance._Store.sessionStartDate.getTime();
                 eventObject.currentSessionMPIDs =
                     mpInstance._Store.currentSessionMPIDs;
+
+                // Session attributes are assigned on a session level, but only uploaded
+                // when a session ends. As there is no way to attach event attributes to
+                // a `SessionEnd` event, we are uploading the session level attributes
+                // as event level attributes in a `SessionEnd` event.
                 eventObject.EventAttributes =
                     mpInstance._Store.sessionAttributes;
 
+                // TODO: We should move this out of here to avoid side effects
                 mpInstance._Store.currentSessionMPIDs = [];
                 mpInstance._Store.sessionStartDate = null;
             }
@@ -247,8 +428,8 @@ export default function ServerModel(mpInstance) {
         return null;
     };
 
-    this.convertEventToDTO = function(event) {
-        var dto = {
+    this.convertEventToDTO = function(event: IUploadObject): IServerDTO {
+        var dto: Partial<IServerDTO> = {
             n: event.EventName,
             et: event.EventCategory,
             ua: event.UserAttributes,
@@ -290,16 +471,20 @@ export default function ServerModel(mpInstance) {
             dto.iu = false;
             dto.at = ApplicationTransitionType.AppInit;
             dto.lr = event.LaunchReferral;
+
+            // Nullify Attributes in case AST Was logged manually or
+            // via logBaseEvent. AST should not have any attributes
             dto.attrs = null;
         }
 
         if (event.CustomFlags) {
-            convertCustomFlags(event, dto);
+            convertCustomFlags(event, dto as IServerDTO);
         }
 
         if (event.EventDataType === MessageType.Commerce) {
             dto.cu = event.CurrencyCode;
 
+            // TODO: If Cart is deprecated, we should deprecate this too
             if (event.ShoppingCart) {
                 dto.sc = {
                     pl: convertProductListToDTO(event.ShoppingCart.ProductList),
@@ -355,6 +540,6 @@ export default function ServerModel(mpInstance) {
             dto.pet = event.ProfileMessageType;
         }
 
-        return dto;
+        return dto as IServerDTO;
     };
 }

package/src/store.ts

@@ -115,8 +115,8 @@ export interface IStore {
     devToken: string | null;
     migrationData: MigrationData;
     serverSettings: ServerSettings;
-    dateLastEventSent: number | null;
-    sessionStartDate: number | null;
+    dateLastEventSent: Date;
+    sessionStartDate: Date;
     currentPosition: SDKGeoLocation | null;
     isTracking: boolean;
     watchPositionId: number | null;
@@ -143,8 +143,10 @@ export interface IStore {
     configuredForwarders: MPForwarder[];
     pixelConfigurations: PixelConfiguration[];
     integrationDelayTimeoutStart: number; // UNIX Timestamp
+    webviewBridgeEnabled?: boolean;
 }
 
+// TODO: Merge this with SDKStoreApi in sdkRuntimeModels
 export default function Store(
     this: IStore,
     config: SDKInitConfig,

package/src/stub/mparticle.stub.js

@@ -3,6 +3,7 @@ let mParticle = {
     getAppName: returnString,
     getAppVersion: returnString,
     getDeviceId: returnString,
+    getEnvironment: returnString,
     getVersion: returnString,
     init: voidFunction,
     logError: voidFunction,

package/src/types.js

@@ -361,6 +361,11 @@ var ApplicationTransitionType = {
     AppInit: 1,
 };
 
+const Environment = {
+    Production: 'production',
+    Development: 'development',
+};
+
 export default {
     MessageType: MessageType,
     EventType: EventType,
@@ -371,4 +376,5 @@ export default {
     ProductActionType: ProductActionType,
     PromotionActionType: PromotionActionType,
     TriggerUploadType: TriggerUploadType,
+    Environment,
 };

package/src/utils.ts

@@ -49,6 +49,16 @@ const parseNumber = (value: string | number): number => {
     return isNaN(floatValue) ? 0 : floatValue;
 };
 
+const parseStringOrNumber = (
+    value: string | number
+): string | number | null => {
+    if (isStringOrNumber(value)) {
+        return value;
+    } else {
+        return null;
+    }
+};
+
 // FIXME: REFACTOR for V3
 // only used in store.js to sanitize server-side formatting of
 // booleans when checking for `isDevelopmentMode`
@@ -86,6 +96,9 @@ const isDataPlanSlug = (str: string): boolean =>
 const isStringOrNumber = (value: any): boolean =>
     isString(value) || isNumber(value);
 
+const isEmpty = (value: Dictionary<any> | null | undefined): boolean =>
+    value == null || !(Object.keys(value) || value).length;
+
 export {
     valueof,
     converted,
@@ -93,11 +106,13 @@ export {
     findKeyInObject,
     inArray,
     isObject,
+    isStringOrNumber,
     parseNumber,
+    parseStringOrNumber,
     returnConvertedBoolean,
     isString,
     isNumber,
     isFunction,
-    isStringOrNumber,
     isDataPlanSlug,
+    isEmpty,
 };

package/src/validators.ts

@@ -1,8 +1,7 @@
 import Types from './types';
-import { isFunction, isNumber, isObject, isStringOrNumber } from './utils';
+import { isFunction, isNumber, isObject, isStringOrNumber, valueof } from './utils';
 import Constants from './constants';
 import { IdentityApiData } from '@mparticle/web-sdk';
-import { valueof } from './utils';
 
 type IdentityAPIMethod = 'login' | 'logout' | 'identify' | 'modify';
 
@@ -13,14 +12,17 @@ type ValidationIdentitiesReturn = {
 
 const Validators = {
     // From ./utils
+    // Utility Functions for backwards compatability
     isNumber,
     isFunction,
     isStringOrNumber,
 
+    // Validator Functions
     isValidAttributeValue: function(value: any): boolean {
         return value !== undefined && !isObject(value) && !Array.isArray(value);
     },
 
+    // Validator Functions
     // Neither null nor undefined can be a valid Key
     isValidKeyValue: function(key: any): boolean {
         return Boolean(