@mparticle/web-sdk 2.21.1 → 2.22.0

package/src/sideloadedKit.ts

@@ -0,0 +1,124 @@
+import KitFilterHelper from './kitFilterHelper';
+import {
+    IFilteringConsentRuleValues,
+    IFilteringEventAttributeValue,
+    IFilteringUserAttributeValue,
+    IKitFilterSettings,
+} from './configAPIClient';
+import { UnregisteredKit } from './forwarders.interfaces';
+import { EventTypeEnum, IdentityType } from './types.interfaces';
+
+export interface IMPSideloadedKit {
+    kitInstance: UnregisteredKit;
+    filterDictionary: IKitFilterSettings;
+
+    addEventTypeFilter(eventType: EventTypeEnum): void;
+    addEventNameFilter(eventType: EventTypeEnum, eventName: string): void;
+    addEventAttributeFilter(
+        eventType: EventTypeEnum,
+        eventName: string,
+        customAttributeKey: string
+    ): void;
+    addScreenNameFilter(screenName: string): void;
+    addScreenAttributeFilter(screenName: string, screenAttribute: string): void;
+    addUserIdentityFilter(userIdentity: IdentityType): void;
+    addUserAttributeFilter(userAttributeKey: string): void;
+}
+
+// This constructor is necessary to be able ot call new on mParticle.SideloadedKit
+// https://stackoverflow.com/questions/13407036/how-does-interfaces-with-construct-signatures-work
+export interface IMPSideloadedKitConstructor {
+    new(unregisteredKitInstance: UnregisteredKit): IMPSideloadedKit;
+}
+
+export default class MPSideloadedKit implements IMPSideloadedKit{
+    public kitInstance: UnregisteredKit;
+    public filterDictionary: IKitFilterSettings = {
+        eventTypeFilters: [],
+        eventNameFilters: [],
+        screenNameFilters: [],
+        screenAttributeFilters: [],
+        userIdentityFilters: [],
+        userAttributeFilters: [],
+        attributeFilters: [],
+        consentRegulationFilters: [],
+        consentRegulationPurposeFilters: [],
+        messageTypeFilters: [],
+        messageTypeStateFilters: [],
+
+        // The below filtering members are optional, but we instantiate them
+        // to simplify public method assignment
+        filteringEventAttributeValue: {} as IFilteringEventAttributeValue,
+        filteringUserAttributeValue: {} as IFilteringUserAttributeValue,
+        filteringConsentRuleValues: {} as IFilteringConsentRuleValues,
+    };
+
+    constructor(unregisteredKitInstance: UnregisteredKit) {
+        this.kitInstance = unregisteredKitInstance;
+    }
+
+    public addEventTypeFilter(eventType: EventTypeEnum): void {
+        const hashedEventType = KitFilterHelper.hashEventType(eventType);
+        this.filterDictionary.eventTypeFilters.push(hashedEventType);
+    }
+
+    public addEventNameFilter(
+        eventType: EventTypeEnum,
+        eventName: string
+    ): void {
+        const hashedEventName = KitFilterHelper.hashEventName(
+            eventName,
+            eventType
+        );
+        this.filterDictionary.eventNameFilters.push(hashedEventName);
+    }
+
+    public addEventAttributeFilter(
+        eventType: EventTypeEnum,
+        eventName: string,
+        customAttributeKey: string
+    ): void {
+        const hashedEventAttribute = KitFilterHelper.hashEventAttributeKey(
+            eventType,
+            eventName,
+            customAttributeKey
+        );
+        this.filterDictionary.attributeFilters.push(hashedEventAttribute);
+    }
+
+    public addScreenNameFilter(screenName: string): void {
+        const hashedScreenName = KitFilterHelper.hashEventName(
+            screenName,
+            EventTypeEnum.Unknown
+        );
+        this.filterDictionary.screenNameFilters.push(hashedScreenName);
+    }
+
+    public addScreenAttributeFilter(
+        screenName: string,
+        screenAttribute: string
+    ): void {
+        const hashedScreenAttribute = KitFilterHelper.hashEventAttributeKey(
+            EventTypeEnum.Unknown,
+            screenName,
+            screenAttribute
+        );
+        this.filterDictionary.screenAttributeFilters.push(
+            hashedScreenAttribute
+        );
+    }
+
+    public addUserIdentityFilter(userIdentity: IdentityType): void {
+        const hashedIdentityType = KitFilterHelper.hashUserIdentity(
+            userIdentity
+        );
+        this.filterDictionary.userIdentityFilters.push(hashedIdentityType);
+    }
+
+    public addUserAttributeFilter(userAttributeKey: string): void {
+        const hashedUserAttributeKey = KitFilterHelper.hashUserAttribute(
+            userAttributeKey
+        );
+        this.filterDictionary.userAttributeFilters.push(hashedUserAttributeKey);
+    }
+}

package/src/store.ts

@@ -416,13 +416,6 @@ export default function Store(
         if (!config.hasOwnProperty('flags')) {
             this.SDKConfig.flags = {};
         }
-        if (
-            !this.SDKConfig.flags.hasOwnProperty(
-                Constants.FeatureFlags.EventsV3
-            )
-        ) {
-            this.SDKConfig.flags[Constants.FeatureFlags.EventsV3] = 0;
-        }
         if (
             !this.SDKConfig.flags.hasOwnProperty(
                 Constants.FeatureFlags.EventBatchingIntervalMillis

package/src/types.interfaces.ts

@@ -0,0 +1,52 @@
+export enum EventTypeEnum {
+    Unknown,
+    Navigation,
+    Location,
+    Search,
+    Transaction,
+    UserContent,
+    UserPreference,
+    Social,
+    Other,
+    Media,
+}
+
+// TODO: https://mparticle-eng.atlassian.net/browse/SQDSDKS-5403
+export enum MessageType {
+    SessionStart = 1,
+    SessionEnd = 2,
+    PageView = 3,
+    PageEvent = 4,
+    CrashReport = 5,
+    OptOut = 6,
+    AppStateTransition = 10,
+    Profile = 14,
+    Commerce = 16,
+    UserAttributeChange = 17,
+    UserIdentityChange = 18,
+    Media = 20,
+};
+
+export enum IdentityType {
+    Other = 0,
+    CustomerId = 1,
+    Facebook = 2,
+    Twitter = 3,
+    Google = 4,
+    Microsoft = 5,
+    Yahoo = 6,
+    Email = 7,
+    FacebookCustomAudienceId = 9,
+    Other2 = 10,
+    Other3 = 11,
+    Other4 = 12,
+    Other5 = 13,
+    Other6 = 14,
+    Other7 = 15,
+    Other8 = 16,
+    Other9 = 17,
+    Other10 = 18,
+    MobileNumber = 19,
+    PhoneNumber2 = 20,
+    PhoneNumber3 = 21,
+}