@mparticle/web-sdk 2.18.1 → 2.18.3

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

@@ -7,16 +7,15 @@ import {
     IdentityCallback,
     SDKEventCustomFlags,
 } from '@mparticle/web-sdk';
+import { IKitConfigs } from './configAPIClient';
 import Constants from './constants';
 import {
     DataPlanResult,
     Kit,
     KitBlockerOptions,
-    KitConfigs,
     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
@@ -45,7 +45,7 @@ export interface SDKConfig {
     appVersion?: string;
     package?: string;
     flags?: { [key: string]: string | number | boolean };
-    kitConfigs: KitConfigs[];
+    kitConfigs: IKitConfigs[];
     kits: Dictionary<Kit>;
     logLevel?: LogLevelType;
     cookieDomain?: string;
@@ -102,6 +102,13 @@ export type PixelConfiguration = Dictionary;
 export type MigrationData = Dictionary;
 export type ServerSettings = Dictionary;
 
+type WrapperSDKTypes = 'flutter' | 'none';
+interface WrapperSDKInfo {
+    name: WrapperSDKTypes;
+    version: string | null;
+    isInfoSet: boolean;
+}
+
 // Temporary Interface until Store can be refactored as a class
 export interface IStore {
     isEnabled: boolean;
@@ -144,6 +151,7 @@ export interface IStore {
     pixelConfigurations: PixelConfiguration[];
     integrationDelayTimeoutStart: number; // UNIX Timestamp
     webviewBridgeEnabled?: boolean;
+    wrapperSDKInfo: WrapperSDKInfo;
 }
 
 // TODO: Merge this with SDKStoreApi in sdkRuntimeModels
@@ -191,6 +199,11 @@ export default function Store(
         kits: {},
         configuredForwarders: [],
         pixelConfigurations: [],
+        wrapperSDKInfo: {
+            name: 'none',
+            version: null,
+            isInfoSet: false,
+        },
     };
 
     for (var key in defaultStore) {

package/src/configAPIClient.js

@@ -1,67 +0,0 @@
-export default function ConfigAPIClient() {
-    this.getSDKConfiguration = function(
-        apiKey,
-        config,
-        completeSDKInitialization,
-        mpInstance
-    ) {
-        var url;
-        try {
-            var xhrCallback = function() {
-                if (xhr.readyState === 4) {
-                    // when a 200 returns, merge current config with what comes back from config, prioritizing user inputted config
-                    if (xhr.status === 200) {
-                        config = mpInstance._Helpers.extend(
-                            {},
-                            config,
-                            JSON.parse(xhr.responseText)
-                        );
-                        completeSDKInitialization(apiKey, config, mpInstance);
-                        mpInstance.Logger.verbose(
-                            'Successfully received configuration from server'
-                        );
-                    } else {
-                        // if for some reason a 200 doesn't return, then we initialize with the just the passed through config
-                        completeSDKInitialization(apiKey, config, mpInstance);
-                        mpInstance.Logger.verbose(
-                            'Issue with receiving configuration from server, received HTTP Code of ' +
-                                xhr.status
-                        );
-                    }
-                }
-            };
-
-            var xhr = mpInstance._Helpers.createXHR(xhrCallback);
-            url =
-                'https://' +
-                mpInstance._Store.SDKConfig.configUrl +
-                apiKey +
-                '/config?env=';
-            if (config.isDevelopmentMode) {
-                url = url + '1';
-            } else {
-                url = url + '0';
-            }
-
-            var dataPlan = config.dataPlan;
-            if (dataPlan) {
-                if (dataPlan.planId) {
-                    url = url + '&plan_id=' + dataPlan.planId || '';
-                }
-                if (dataPlan.planVersion) {
-                    url = url + '&plan_version=' + dataPlan.planVersion || '';
-                }
-            }
-
-            if (xhr) {
-                xhr.open('get', url);
-                xhr.send(null);
-            }
-        } catch (e) {
-            completeSDKInitialization(apiKey, config, mpInstance);
-            mpInstance.Logger.error(
-                'Error getting forwarder configuration from mParticle servers.'
-            );
-        }
-    };
-}