@mparticle/web-sdk 2.20.1 → 2.20.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.20.1",
+    "version": "2.20.2",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [
@@ -78,7 +78,7 @@
         "@mparticle/event-models": "^1.1.6",
         "@rollup/plugin-json": "^4.1.0",
         "@rollup/plugin-typescript": "^8.3.3",
-        "@rollup/plugin-babel": "6.0.3",
+        "@rollup/plugin-babel": "5.3.1",
         "@rollup/plugin-commonjs": "22.0.2",
         "@rollup/plugin-node-resolve": "13.3.0",
         "@semantic-release/changelog": "^5.0.1",
@@ -93,8 +93,8 @@
         "browserify": "^17.0.0",
         "chai": "^4.2.0",
         "cross-env": "^7.0.3",
-        "eslint": "^8.36.0",
-        "eslint-config-prettier": "8.8.0",
+        "eslint": "^7.32.0",
+        "eslint-config-prettier": "8.3.0",
         "eslint-plugin-prettier": "3.4.1",
         "fetch-mock": "^7.5.1",
         "gts": "^3.1.0",
@@ -116,7 +116,7 @@
         "should": "^7.1.0",
         "sinon": "^11.0.0",
         "tslib": "^2.1.0",
-        "typescript": "^5.0.2",
+        "typescript": "^4.2.4",
         "uglify-js": "^3.4.9",
         "webpack": "^5.36.2",
         "webpack-cli": "^4.6.0"

package/src/apiClient.ts

@@ -8,7 +8,7 @@ import {
     SDKEvent,
 } from './sdkRuntimeModels';
 import KitBlocker from './kitBlocking';
-import { Dictionary, getRampNumber } from './utils';
+import { Dictionary } from './utils';
 import { IUploadObject } from './serverModel';
 
 const Messages = Constants.Messages;
@@ -67,7 +67,9 @@ export default function APIClient(
             return false;
         }
 
-        const rampNumber = getRampNumber(mpInstance._Store.deviceId);
+        const rampNumber = mpInstance._Helpers.getRampNumber(
+            mpInstance._Store.deviceId
+        );
         return eventsV3Percentage >= rampNumber;
     };
 

package/src/configAPIClient.ts

@@ -29,9 +29,8 @@ export interface IKitConfigs {
     eventNameFilters: number[];
     eventTypeFilters: number[];
     attributeFilters: number[];
-    filteringEventAttributeValue: IFilteringAttributeValue;
-    filteringUserAttributeValue: IFilteringAttributeValue;
-    filteringConsentRuleValues: IFilteringConsentRulesValue;
+    filteringEventAttributeValue: Dictionary;
+    filteringConsentRuleValues: Dictionary;
     consentRegulationFilters: number[];
     consentRegulationPurposeFilters: number[];
     messageTypeFilters: number[];
@@ -40,22 +39,6 @@ export interface IKitConfigs {
     excludeAnonymousUser: boolean;
 }
 
-export interface IFilteringAttributeValue {
-    eventAttributeName: string;
-    eventAttributeValue: string;
-    includeOnMatch: boolean
-}
-export interface IFilteringConsentRulesValue {
-    includeOnMatch: boolean;
-    values: IConsentRuleValue[];
-}
-
-export interface IConsentRuleValue {
-    consentPurpose: string;
-    hasConsented: boolean
-}
-
-
 export interface IPixelConfig {
     name: string;
     moduleId: number;

package/src/forwarders.js

@@ -650,7 +650,7 @@ export default function Forwarders(mpInstance, kitBlocker) {
         newForwarder.id = config.moduleId;
 
         // TODO: isSandbox, hasSandbox is never used in any kit or in core SDK.
-        // isVisible.  Investigate is only used in 1 place. It is always true if
+        // isVisibleInvestigate is only used in 1 place. It is always true if
         // it is sent to JS. Investigate further to determine if these can be removed.
         // https://go.mparticle.com/work/SQDSDKS-5156
         newForwarder.isSandbox = config.isDebug || config.isSandbox;

package/src/helpers.js

@@ -26,6 +26,17 @@ export default function Helpers(mpInstance) {
         return null;
     };
 
+    /**
+     * Returns a value between 1-100 inclusive.
+     */
+    this.getRampNumber = function(deviceId) {
+        if (!deviceId) {
+            return 100;
+        }
+        var hash = self.generateHash(deviceId);
+        return Math.abs(hash % 100) + 1;
+    };
+
     this.invokeCallback = function(
         callback,
         code,
@@ -273,6 +284,39 @@ export default function Helpers(mpInstance) {
         return xhr;
     };
 
+    function generateRandomValue(a) {
+        var randomValue;
+        if (window.crypto && window.crypto.getRandomValues) {
+            randomValue = window.crypto.getRandomValues(new Uint8Array(1)); // eslint-disable-line no-undef
+        }
+        if (randomValue) {
+            return (a ^ (randomValue[0] % 16 >> (a / 4))).toString(16);
+        }
+
+        return (a ^ ((Math.random() * 16) >> (a / 4))).toString(16);
+    }
+
+    this.generateUniqueId = function(a) {
+        // https://gist.github.com/jed/982883
+        // Added support for crypto for better random
+
+        return a // if the placeholder was passed, return
+            ? generateRandomValue(a) // a random number
+            : // or otherwise a concatenated string:
+              (
+                  [1e7] + // 10000000 +
+                  -1e3 + // -1000 +
+                  -4e3 + // -4000 +
+                  -8e3 + // -80000000 +
+                  -1e11
+              ) // -100000000000,
+                  .replace(
+                      // replacing
+                      /[018]/g, // zeroes, ones, and eights with
+                      self.generateUniqueId // random hex digits
+                  );
+    };
+
     this.filterUserIdentities = function(userIdentitiesObject, filterList) {
         var filteredUserIdentities = [];
 
@@ -359,6 +403,37 @@ export default function Helpers(mpInstance) {
         return false;
     };
 
+    this.generateHash = function(name) {
+        var hash = 0,
+            i = 0,
+            character;
+
+        if (name === undefined || name === null) {
+            return 0;
+        }
+
+        name = name.toString().toLowerCase();
+
+        if (Array.prototype.reduce) {
+            return name.split('').reduce(function(a, b) {
+                a = (a << 5) - a + b.charCodeAt(0);
+                return a & a;
+            }, 0);
+        }
+
+        if (name.length === 0) {
+            return hash;
+        }
+
+        for (i = 0; i < name.length; i++) {
+            character = name.charCodeAt(i);
+            hash = (hash << 5) - hash + character;
+            hash = hash & hash;
+        }
+
+        return hash;
+    };
+
     this.sanitizeAttributes = function(attrs, name) {
         if (!attrs || !self.isObject(attrs)) {
             return null;
@@ -426,8 +501,6 @@ export default function Helpers(mpInstance) {
         }
     };
 
-    // TODO: Refactor SDK to directly use these methods
-    // https://go.mparticle.com/work/SQDSDKS-5239
     // Utility Functions
     this.converted = utils.converted;
     this.findKeyInObject = utils.findKeyInObject;
@@ -437,8 +510,6 @@ export default function Helpers(mpInstance) {
     this.decoded = utils.decoded;
     this.returnConvertedBoolean = utils.returnConvertedBoolean;
     this.parseStringOrNumber = utils.parseStringOrNumber;
-    this.generateHash = utils.generateHash;
-    this.generateUniqueId = utils.generateUniqueId;
 
     // Imported Validators
     this.Validators = Validators;

package/src/sdkRuntimeModels.ts

@@ -232,6 +232,7 @@ export interface SDKHelpersApi {
     generateUniqueId();
     generateHash?(value: string): string;
     getFeatureFlag?(feature: string); // TODO: Feature Constants should be converted to enum
+    getRampNumber?(deviceId: string): number;
     isDelayedByIntegration?(
         delayedIntegrations: Dictionary<boolean>,
         timeoutStart: number,

package/src/utils.ts

@@ -36,81 +36,6 @@ const findKeyInObject = (obj: any, key: string): string => {
     return null;
 };
 
-function generateHash(name: string): number {
-    let hash: number = 0;
-    let character: number;
-
-    if (name === undefined || name === null) {
-        return 0;
-    }
-
-    name = name.toString().toLowerCase();
-
-    if (Array.prototype.reduce) {
-        return name.split('').reduce(function (a: number, b: string) {
-            a = (a << 5) - a + b.charCodeAt(0);
-            return a & a;
-        }, 0);
-    }
-
-    if (name.length === 0) {
-        return hash;
-    }
-
-    for (let i = 0; i < name.length; i++) {
-        character = name.charCodeAt(i);
-        hash = (hash << 5) - hash + character;
-        hash = hash & hash;
-    }
-
-    return hash;
-}
-
-const generateRandomValue = (value?: string): string => {
-    let randomValue: string;
-    let a: number;
-
-    if (window.crypto && window.crypto.getRandomValues) {
-        // @ts-ignore
-        randomValue = window.crypto.getRandomValues(new Uint8Array(1)); // eslint-disable-line no-undef
-    }
-    if (randomValue) {
-        // @ts-ignore
-        return (a ^ (randomValue[0] % 16 >> (a / 4))).toString(16);
-    }
-
-    return (a ^ ((Math.random() * 16) >> (a / 4))).toString(16);
-};
-
-const generateUniqueId = (a: string = ''): string =>
-    // https://gist.github.com/jed/982883
-    // Added support for crypto for better random
-
-    a // if the placeholder was passed, return
-        ? generateRandomValue(a) // if the placeholder was passed, return
-        : // [1e7] -> // 10000000 +
-          // -1e3  -> // -1000 +
-          // -4e3  -> // -4000 +
-          // -8e3  -> // -80000000 +
-          // -1e11 -> //-100000000000,
-          `${1e7}-${1e3}-${4e3}-${8e3}-${1e11}`.replace(
-              /[018]/g, // zeroes, ones, and eights with
-              generateUniqueId // random hex digits
-          );
-
-/**
- * Returns a value between 1-100 inclusive.
- */
-const getRampNumber = (value?: string): number => {
-    if (!value) {
-        return 100;
-    }
-
-    const hash = generateHash(value);
-
-    return Math.abs(hash % 100) + 1;
-};
-
 const isObject = (value: any): boolean => {
     var objType = Object.prototype.toString.call(value);
     return objType === '[object Object]' || objType === '[object Error]';
@@ -151,7 +76,10 @@ const decoded = (s: string): string =>
 
 const converted = (s: string): string => {
     if (s.indexOf('"') === 0) {
-        s = s.slice(1, -1).replace(/\\"/g, '"').replace(/\\\\/g, '\\');
+        s = s
+            .slice(1, -1)
+            .replace(/\\"/g, '"')
+            .replace(/\\\\/g, '\\');
     }
 
     return s;
@@ -176,9 +104,6 @@ export {
     converted,
     decoded,
     findKeyInObject,
-    generateHash,
-    generateUniqueId,
-    getRampNumber,
     inArray,
     isObject,
     isStringOrNumber,

package/src/forwarders.interfaces.ts

@@ -1,61 +0,0 @@
-import { MParticleUser, SDKEvent, SDKEventCustomFlags, SDKUserIdentity } from './sdkRuntimeModels';
-import { Dictionary } from './utils';
-import { IKitConfigs } from './configAPIClient';
-import { UserAttributes } from './persistence.interfaces';
-import { IdentityApiData } from '@mparticle/web-sdk';
-
-// The state of the kit when accessed via window.KitName via CDN
-// or imported as an NPM package
-export interface UnregisteredKit {
-    register(config): void;
-}
-
-// The state of the kit after being added to forwarderConstructors in the CDN 
-// or after registered to SDKConfig.kits via NPM
-export interface RegisteredKit {
-    constructor(): void;
-    name: string;
-    getId(): number;
-}
-
-// The state of the kit after being configured. This is what the kit looks like when acted on.
-export interface ConfiguredKit
-    extends Omit<IKitConfigs, 'isDebugString' | 'hasDebugString'> {
-    common: Dictionary<unknown>;
-    init(
-        settings: Dictionary<unknown>,
-        service: forwardingStatsCallback,
-        testMode: boolean,
-        trackerId: string | null,
-        userAttributes: UserAttributes,
-        userIdentities: SDKUserIdentity,
-        appVersion: string,
-        appName: string,
-        customFlags: SDKEventCustomFlags,
-        clientId: string): string;
-    onIdentifyComplete(user: MParticleUser, filteredIdentityRequest: IdentityApiData): string | KitMappedMethodFailure;
-    onLoginComplete(user: MParticleUser, filteredIdentityRequest: IdentityApiData): string | KitMappedMethodFailure;
-    onLogoutComplete(user: MParticleUser, filteredIdentityRequest: IdentityApiData): string | KitMappedMethodFailure;
-    onModifyComplete(user: MParticleUser, filteredIdentityRequest: IdentityApiData): string | KitMappedMethodFailure;
-    onUserIdentified(user: MParticleUser): string | KitMappedMethodFailure;
-    process(event: SDKEvent): string;
-    setOptOut(isOptingOut: boolean): string | KitMappedMethodFailure;
-    removeUserAttribute(key: string): string;
-    setUserAttribute(key: string, value:string): string;
-
-    // TODO: Convert type to enum during Identity migration
-    // https://go.mparticle.com/work/SQDSDKS-5218
-    setUserIdentity(id: UserIdentityId, type: UserIdentityType): void;
-
-    // TODO: https://go.mparticle.com/work/SQDSDKS-5156
-    isSandbox: boolean;  
-    hasSandbox: boolean;
-}
-export interface KitMappedMethodFailure {
-    error: string
-}
-
-export type UserIdentityId = string;
-export type UserIdentityType = number;
-
-export type forwardingStatsCallback = (forwarder: ConfiguredKit, event: SDKEvent) => void;