@mparticle/web-sdk 2.18.2 → 2.19.0

package/src/sdkRuntimeModels.ts

@@ -1,12 +1,12 @@
 import * as EventsApi from '@mparticle/event-models';
-import { Batch } from '@mparticle/event-models';
-import { DataPlanVersion, DataPlan } from '@mparticle/data-planning-models';
+import { DataPlanVersion } from '@mparticle/data-planning-models';
 import { MPConfiguration, IdentityApiData } from '@mparticle/web-sdk';
-import { IStore, SDKConfig } from './store';
+import { IStore } from './store';
 import Validators from './validators';
 import { Dictionary } from './utils';
 import { IServerModel } from './serverModel';
 import { IKitConfigs } from './configAPIClient';
+import { SDKConsentApi, SDKConsentState } from './consent.interfaces';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -131,12 +131,17 @@ export interface MParticleWebSDK {
     Logger: SDKLoggerApi;
     _APIClient: any; // TODO: Set up API Client
     _Store: IStore;
+    _Forwarders: any;
     _Helpers: SDKHelpersApi;
     config: SDKInitConfig;
     _ServerModel: IServerModel;
     _SessionManager: any; // TODO: Set up Session Manager
-    _Consent: any; // TODO: Set up Consent SDK
-    _resetForTests(MPConfig?: SDKConfig): void;
+    _Consent: SDKConsentApi;
+    Consent: SDKConsentApi;
+    _NativeSdkHelpers: any; // TODO: Set up API
+    _Persistence: any; // TODO: Set up Persistence API
+    _preInit: any; // TODO: Set up API
+    _resetForTests(MPConfig?: SDKInitConfig): void;
     init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
     getAppName(): string;
     getAppVersion(): string;
@@ -220,12 +225,19 @@ export interface SDKIdentityApi {
 export interface SDKHelpersApi {
     createServiceUrl(arg0: string, arg1: string): void;
     createXHR?(cb: () => void): XMLHttpRequest;
-    extend(...args: any[]);
-    parseNumber(value: string | number): number;
+    extend?(...args: any[]);
+    parseNumber?(value: string | number): number;
     generateUniqueId();
-    isObject(item: any);
+    getFeatureFlag?(feature: string); // TODO: Feature Constants should be converted to enum
+    getRampNumber?(deviceId: string): number;
+    isDelayedByIntegration?(
+        delayedIntegrations: Dictionary<boolean>,
+        timeoutStart: number,
+        now: number
+    ): boolean;
+    isObject?(item: any);
     returnConvertedBoolean(data: string | boolean | number): boolean;
-    sanitizeAttributes(
+    sanitizeAttributes?(
         attrs: Dictionary<string>,
         name: string
     ): Dictionary<string> | null;
@@ -254,6 +266,9 @@ export interface SDKConfigApi {
     appVersion?: string;
     onCreateBatch(batch: EventsApi.Batch): EventsApi.Batch;
 }
+
+// FIXME: Resolve with User in @types/mparticle-web-sdk
+//        https://go.mparticle.com/work/SQDSDKS-5033
 export interface MParticleUser {
     getMPID(): string;
     getConsentState(): any; // FIXME:
@@ -261,25 +276,6 @@ export interface MParticleUser {
     getUserIdentities(): IdentityApiData; // FIXME: Is this correct?
 }
 
-export interface SDKConsentState {
-    getGDPRConsentState(): SDKGDPRConsentState;
-    getCCPAConsentState(): SDKCCPAConsentState;
-}
-
-export interface SDKGDPRConsentState {
-    [key: string]: SDKConsentStateData;
-}
-
-export interface SDKConsentStateData {
-    Consented: boolean;
-    Timestamp?: number;
-    ConsentDocument?: string;
-    Location?: string;
-    HardwareId?: string;
-}
-
-export interface SDKCCPAConsentState extends SDKConsentStateData {}
-
 export interface SDKUserIdentityChangeData {
     New: Identity;
     Old: Identity;

package/src/sdkToEventsApiConverter.ts

@@ -1,9 +1,6 @@
 import {
     SDKEvent,
-    SDKConsentState,
-    SDKGDPRConsentState,
     SDKGeoLocation,
-    SDKCCPAConsentState,
     SDKProduct,
     SDKPromotion,
     SDKUserIdentity,
@@ -12,7 +9,13 @@ import {
     SDKIdentityTypeEnum,
 } from './sdkRuntimeModels';
 import * as EventsApi from '@mparticle/event-models';
+import {
+    SDKConsentState,
+    SDKGDPRConsentState,
+    SDKCCPAConsentState,
+} from './consent.interfaces';
 import Types from './types';
+import { isEmpty } from './utils';
 
 export function convertEvents(
     mpid: string,
@@ -26,6 +29,8 @@ export function convertEvents(
         return null;
     }
 
+    const user = mpInstance.Identity.getCurrentUser();
+
     const uploadEvents: EventsApi.BaseEvent[] = [];
     let lastEvent: SDKEvent = null;
     for (const sdkEvent of sdkEvents) {
@@ -42,6 +47,15 @@ export function convertEvents(
         return null;
     }
 
+    let currentConsentState: SDKConsentState = null;
+
+    // Add the consent state from either the Last Event or the user
+    if (!isEmpty(lastEvent.ConsentState)) {
+        currentConsentState = lastEvent.ConsentState;
+    } else if (!isEmpty(user)) {
+        currentConsentState = user.getConsentState();
+    }
+
     const upload: EventsApi.Batch = {
         source_request_id: mpInstance._Helpers.generateUniqueId(),
         mpid,
@@ -64,7 +78,7 @@ export function convertEvents(
         },
         user_attributes: lastEvent.UserAttributes,
         user_identities: convertUserIdentities(lastEvent.UserIdentities),
-        consent_state: convertConsentState(lastEvent.ConsentState),
+        consent_state: convertConsentState(currentConsentState),
         integration_attributes: lastEvent.IntegrationAttributes,
     };
 
@@ -82,7 +96,7 @@ export function convertEvents(
 export function convertConsentState(
     sdkConsentState?: SDKConsentState
 ): EventsApi.ConsentState | null {
-    if (!sdkConsentState) {
+    if (isEmpty(sdkConsentState)) {
         return null;
     }
     const consentState: EventsApi.ConsentState = {
@@ -327,7 +341,8 @@ export function convertPromotionAction(
         return null;
     }
     const promotionAction: EventsApi.PromotionAction = {
-        action: sdkEvent.PromotionAction.PromotionActionType as EventsApi.PromotionActionActionEnum,
+        action: sdkEvent.PromotionAction
+            .PromotionActionType as EventsApi.PromotionActionActionEnum,
         promotions: convertPromotions(sdkEvent.PromotionAction.PromotionList),
     };
     return promotionAction;
@@ -388,9 +403,8 @@ 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),
@@ -409,9 +423,8 @@ 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,
     };
@@ -425,9 +438,8 @@ 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
@@ -447,9 +459,8 @@ 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.
@@ -465,9 +476,8 @@ 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,
@@ -482,9 +492,8 @@ 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,
@@ -497,9 +506,8 @@ 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,
     };
@@ -511,9 +519,8 @@ 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
@@ -596,7 +603,7 @@ export function convertBaseEventData(
         session_start_unixtime_ms: sdkEvent.SessionStartDate,
         custom_attributes: sdkEvent.EventAttributes,
         location: convertSDKLocation(sdkEvent.Location),
-        source_message_id: sdkEvent.SourceMessageId
+        source_message_id: sdkEvent.SourceMessageId,
     };
 
     return commonEventData;
@@ -617,9 +624,8 @@ 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,
@@ -642,9 +648,8 @@ 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: {
@@ -683,48 +688,48 @@ export function convertUserIdentityTypeToServerIdentityType(
 ): EventsApi.IdentityType {
     switch (identityType) {
         case SDKIdentityTypeEnum.other:
-            return EventsApi.IdentityTypeEnum.other
+            return EventsApi.IdentityTypeEnum.other;
         case SDKIdentityTypeEnum.customerId:
-            return EventsApi.IdentityTypeEnum.customerId
+            return EventsApi.IdentityTypeEnum.customerId;
         case SDKIdentityTypeEnum.facebook:
-            return EventsApi.IdentityTypeEnum.facebook
+            return EventsApi.IdentityTypeEnum.facebook;
         case SDKIdentityTypeEnum.twitter:
-            return EventsApi.IdentityTypeEnum.twitter
+            return EventsApi.IdentityTypeEnum.twitter;
         case SDKIdentityTypeEnum.google:
-            return EventsApi.IdentityTypeEnum.google
+            return EventsApi.IdentityTypeEnum.google;
         case SDKIdentityTypeEnum.microsoft:
-            return EventsApi.IdentityTypeEnum.microsoft
+            return EventsApi.IdentityTypeEnum.microsoft;
         case SDKIdentityTypeEnum.yahoo:
-            return EventsApi.IdentityTypeEnum.yahoo
+            return EventsApi.IdentityTypeEnum.yahoo;
         case SDKIdentityTypeEnum.email:
-            return EventsApi.IdentityTypeEnum.email
+            return EventsApi.IdentityTypeEnum.email;
         case SDKIdentityTypeEnum.alias:
-            return EventsApi.IdentityTypeEnum.alias
+            return EventsApi.IdentityTypeEnum.alias;
         case SDKIdentityTypeEnum.facebookCustomAudienceId:
-            return EventsApi.IdentityTypeEnum.facebookCustomAudienceId
+            return EventsApi.IdentityTypeEnum.facebookCustomAudienceId;
         case SDKIdentityTypeEnum.otherId2:
-            return EventsApi.IdentityTypeEnum.otherId2
+            return EventsApi.IdentityTypeEnum.otherId2;
         case SDKIdentityTypeEnum.otherId3:
-            return EventsApi.IdentityTypeEnum.otherId3
+            return EventsApi.IdentityTypeEnum.otherId3;
         case SDKIdentityTypeEnum.otherId4:
-            return EventsApi.IdentityTypeEnum.otherId4
+            return EventsApi.IdentityTypeEnum.otherId4;
         case SDKIdentityTypeEnum.otherId5:
-            return EventsApi.IdentityTypeEnum.otherId5
+            return EventsApi.IdentityTypeEnum.otherId5;
         case SDKIdentityTypeEnum.otherId6:
-            return EventsApi.IdentityTypeEnum.otherId6
+            return EventsApi.IdentityTypeEnum.otherId6;
         case SDKIdentityTypeEnum.otherId7:
-            return EventsApi.IdentityTypeEnum.otherId7
+            return EventsApi.IdentityTypeEnum.otherId7;
         case SDKIdentityTypeEnum.otherId8:
-            return EventsApi.IdentityTypeEnum.otherId8
+            return EventsApi.IdentityTypeEnum.otherId8;
         case SDKIdentityTypeEnum.otherId9:
-            return EventsApi.IdentityTypeEnum.otherId9
+            return EventsApi.IdentityTypeEnum.otherId9;
         case SDKIdentityTypeEnum.otherId10:
-            return EventsApi.IdentityTypeEnum.otherId10
+            return EventsApi.IdentityTypeEnum.otherId10;
         case SDKIdentityTypeEnum.mobileNumber:
-            return EventsApi.IdentityTypeEnum.mobileNumber
+            return EventsApi.IdentityTypeEnum.mobileNumber;
         case SDKIdentityTypeEnum.phoneNumber2:
-            return EventsApi.IdentityTypeEnum.phoneNumber2
+            return EventsApi.IdentityTypeEnum.phoneNumber2;
         case SDKIdentityTypeEnum.phoneNumber3:
-            return EventsApi.IdentityTypeEnum.phoneNumber3
+            return EventsApi.IdentityTypeEnum.phoneNumber3;
     }
 }

package/src/serverModel.ts

@@ -8,7 +8,6 @@ import {
     BaseEvent,
     MParticleUser,
     MParticleWebSDK,
-    SDKConsentState,
     SDKEvent,
     SDKGeoLocation,
     SDKProduct,
@@ -17,35 +16,16 @@ import {
 import { parseNumber, parseStringOrNumber, Dictionary } from './utils';
 import { ServerSettings } from './store';
 import { MPID } from '@mparticle/web-sdk';
+import {
+    IConsentStateDTO,
+    IGDPRConsentStateDTO,
+    IPrivacyV2DTO,
+    SDKConsentState,
+} from './consent.interfaces';
 
 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;
-}
-
-// TODO: Move to Consent Module
-export interface ICCPAConsentStateDTO {
-    data_sale_opt_out: IPrivacyV2DTO;
-}
-
-// TODO: Break this up into GDPR and CCPA interfaces
-export interface IConsentStateDTO {
-    gdpr?: IGDPRConsentStateDTO;
-    ccpa?: ICCPAConsentStateDTO;
-}
-
 // TODO: Confirm which attributes are optional
 export interface IServerDTO {
     id: string | number;

package/src/store.ts

@@ -16,7 +16,6 @@ import {
     LogLevelType,
     MParticleWebSDK,
     MPForwarder,
-    SDKConsentState,
     SDKDataPlan,
     SDKEvent,
     SDKGeoLocation,
@@ -24,6 +23,7 @@ import {
     SDKProduct,
 } from './sdkRuntimeModels';
 import { isNumber, isDataPlanSlug, Dictionary } from './utils';
+import { SDKConsentState } from './consent.interfaces';
 
 // This represents the runtime configuration of the SDK AFTER
 // initialization has been complete and all settings and

package/src/vault.ts

@@ -0,0 +1,141 @@
+import { Logger } from '@mparticle/web-sdk';
+import { Dictionary, isEmpty } from './utils';
+
+interface IVaultOptions {
+    logger?: Logger;
+    offlineStorageEnabled?: boolean;
+}
+
+export default class Vault<StorableItem extends Dictionary> {
+    public contents: Dictionary<StorableItem>;
+    private readonly _storageKey: string;
+    private readonly _itemKey: keyof StorableItem;
+    private logger?: Logger;
+    private offlineStorageEnabled: boolean = false;
+
+    /**
+     *
+     * @param {string} storageKey the local storage key string
+     * @param {string} itemKey an element within your StorableItem to use as a key
+     * @param {IVaultOptions} options A Dictionary of IVaultOptions
+     */
+    constructor(
+        storageKey: string,
+        itemKey: keyof StorableItem,
+        options?: IVaultOptions
+    ) {
+        this._storageKey = storageKey;
+        this._itemKey = itemKey;
+        this.contents = this.getItems() || {};
+
+        this.offlineStorageEnabled = options?.offlineStorageEnabled;
+
+        // Add a fake logger in case one is not provided or needed
+        this.logger = options?.logger || {
+            verbose: () => {},
+            warning: () => {},
+            error: () => {},
+        };
+    }
+
+    /**
+     * Stores a single Item using `itemId` as an index
+     * @method storeItem
+     * @param item {StorableItem} a Dictonary with key to store
+     */
+    public storeItem(item: StorableItem): void {
+        this.contents = this.getItems();
+
+        if (item[this._itemKey]) {
+            this.contents[item[this._itemKey]] = item;
+            this.logger.verbose(
+                `Saved items to vault with key: ${item[this._itemKey]}`
+            );
+        }
+
+        this.saveItems(this.contents);
+    }
+
+    /**
+     * Stores Items using `itemId` as an index
+     * @method storeItems
+     * @param {StorableItem[]} an Array of StorableItems
+     */
+    public storeItems(items: StorableItem[]): void {
+        items.forEach((item) => this.storeItem(item));
+    }
+
+    /**
+     * Removes a single StorableItem based on `indexId`
+     * @method removeItem
+     * @param {String} indexId
+     */
+    public removeItem(indexId: string): void {
+        this.logger.verbose(`Removing from vault: ${indexId}`);
+        this.contents = this.getItems() || {};
+
+        try {
+            delete this.contents[indexId];
+
+            this.saveItems(this.contents);
+        } catch (error) {
+            this.logger.error(
+                `Unable to remove item without a matching ID ${indexId}`
+            );
+            this.logger.error(error as string);
+        }
+    }
+
+    /**
+     * Retrieves all StorableItems from local storage as an array
+     * @method retrieveItems
+     * @returns {StorableItem[]} an array of Items
+     */
+    public retrieveItems(): StorableItem[] {
+        this.contents = this.getItems();
+
+        return Object.keys(this.contents).map((item) => this.contents[item]);
+    }
+
+    /**
+     * Removes all persisted data from local storage based on this vault's `key`
+     * @method purge
+     */
+    public purge(): void {
+        this.contents = {};
+        this.removeItems();
+    }
+
+    private saveItems(items: Dictionary<StorableItem>): void {
+        if (!this.offlineStorageEnabled) {
+            return;
+        }
+        try {
+            window.localStorage.setItem(
+                this._storageKey,
+                !isEmpty(items) ? JSON.stringify(items) : ''
+            );
+        } catch (error) {
+            this.logger.error(`Cannot Save items to Local Storage: ${items}`);
+            this.logger.error(error as string);
+        }
+    }
+
+    private getItems(): Dictionary<StorableItem> {
+        if (!this.offlineStorageEnabled) {
+            return this.contents;
+        }
+        // TODO: Handle cases where Local Storage is unavailable
+        // https://go.mparticle.com/work/SQDSDKS-5022
+        const itemString = window.localStorage.getItem(this._storageKey);
+
+        return itemString ? JSON.parse(itemString) : {};
+    }
+
+    private removeItems(): void {
+        if (!this.offlineStorageEnabled) {
+            return;
+        }
+        window.localStorage.removeItem(this._storageKey);
+    }
+}