@mparticle/web-sdk 2.22.0 → 2.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.22.0",
+    "version": "2.23.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [
@@ -82,12 +82,12 @@
         "@babel/preset-env": "^7.6.0",
         "@babel/preset-typescript": "^7.6.0",
         "@mparticle/data-planning-models": "^0.1.0",
-        "@mparticle/event-models": "^1.1.6",
+        "@mparticle/event-models": "^1.1.7",
         "@rollup/plugin-babel": "6.0.3",
-        "@rollup/plugin-commonjs": "22.0.2",
+        "@rollup/plugin-commonjs": "24.1.0",
         "@rollup/plugin-json": "^4.1.0",
-        "@rollup/plugin-node-resolve": "13.3.0",
-        "@rollup/plugin-typescript": "^8.3.3",
+        "@rollup/plugin-node-resolve": "15.1.0",
+        "@rollup/plugin-typescript": "^11.1.0",
         "@semantic-release/changelog": "^5.0.1",
         "@semantic-release/exec": "^5.0.0",
         "@semantic-release/git": "^9.0.0",
@@ -96,7 +96,7 @@
         "@types/jest-expect-message": "^1.1.0",
         "@types/mocha": "^9.0.0",
         "@types/mparticle__web-sdk": "^2.16.1",
-        "@types/node": "^18.7.11",
+        "@types/node": "^20.1.0",
         "babel-preset-minify": "^0.5.1",
         "browser-sync": "^2.26.3",
         "browserify": "^17.0.0",
@@ -131,7 +131,7 @@
         "typescript": "^5.0.2",
         "uglify-js": "^3.4.9",
         "webpack": "^5.36.2",
-        "webpack-cli": "^4.6.0"
+        "webpack-cli": "^5.0.2"
     },
     "dependencies": {
         "@babel/runtime": "^7.6.0",

package/src/configAPIClient.ts

@@ -16,6 +16,7 @@ export type SDKCompleteInitCallback = (
 
 export interface IKitConfigs extends IKitFilterSettings {
     name: string;
+    suffix?: string;
     moduleId: number;
     isDebug: boolean;
     isVisible: boolean;

package/src/forwarders.js

@@ -557,10 +557,12 @@ export default function Forwarders(mpInstance, kitBlocker) {
     // if there is a match before being initialized.
     // Only kits that are configured properly can be active and used for kit forwarding.
     this.processUIEnabledKits = function(config) {
+        let kits = this.returnKitConstructors();
+
         try {
             if (Array.isArray(config.kitConfigs) && config.kitConfigs.length) {
                 config.kitConfigs.forEach(function(kitConfig) {
-                    self.configureUIEnabledKit(kitConfig);
+                    self.configureUIEnabledKit(kitConfig, kits);
                 });
             }
         } catch (e) {
@@ -571,37 +573,56 @@ export default function Forwarders(mpInstance, kitBlocker) {
         }
     };
 
-    this.configureUIEnabledKit = function(configuration) {
-        var newForwarder = null,
-            config = configuration,
-            forwarders = {};
-
+    this.returnKitConstructors = function() {
+        let kits = {};
         // If there are kits inside of mpInstance._Store.SDKConfig.kits, then mParticle is self hosted
         if (!isEmpty(mpInstance._Store.SDKConfig.kits)) {
-            forwarders = mpInstance._Store.SDKConfig.kits;
+            kits = mpInstance._Store.SDKConfig.kits;
             // otherwise mParticle is loaded via script tag
         } else if (!isEmpty(mpInstance._preInit.forwarderConstructors)) {
             mpInstance._preInit.forwarderConstructors.forEach(function(
-                forwarder
+                kitConstructor
             ) {
-                forwarders[forwarder.name] = forwarder;
+                // A suffix is added to a kitConstructor and kit config if there are multiple different
+                // versions of a client kit.  This matches the suffix in the DB.  As an example
+                // the GA4 kit has a client kit and a server side kit which has a client side
+                // component.  They share the same name/module ID in the DB, so we include a
+                // suffix to distinguish them in the kits object.
+                // If a customer wanted simultaneous GA4 client and server connections,
+                // a suffix allows the SDK to distinguish the two.
+                if (kitConstructor.suffix) {
+                    const kitNameWithConstructorSuffix = `${kitConstructor.name}-${kitConstructor.suffix}`;
+                    kits[kitNameWithConstructorSuffix] = kitConstructor;
+                } else {
+                    kits[kitConstructor.name] = kitConstructor;
+                }
             });
         }
+        return kits;
+    };
+
+    this.configureUIEnabledKit = function(configuration, kits) {
+        let newKit = null;
+        const config = configuration;
 
-        for (var name in forwarders) {
-            if (name === config.name) {
+        for (let name in kits) {
+            // Configs are returned with suffixes also. We need to consider the
+            // config suffix here to match the constructor suffix
+            let kitNameWithConfigSuffix;
+            if (config.suffix) {
+                kitNameWithConfigSuffix = `${config.name}-${config.suffix}`;
+            }
+
+            if (name === kitNameWithConfigSuffix || name === config.name) {
                 if (
                     config.isDebug ===
                         mpInstance._Store.SDKConfig.isDevelopmentMode ||
                     config.isSandbox ===
                         mpInstance._Store.SDKConfig.isDevelopmentMode
                 ) {
-                    newForwarder = this.returnConfiguredKit(
-                        forwarders[name],
-                        config
-                    );
+                    newKit = this.returnConfiguredKit(kits[name], config);
 
-                    mpInstance._Store.configuredForwarders.push(newForwarder);
+                    mpInstance._Store.configuredForwarders.push(newKit);
                     break;
                 }
             }
@@ -640,6 +661,12 @@ export default function Forwarders(mpInstance, kitBlocker) {
                         sideloadedKits.kits[registeredKitKey];
                     self.configureSideloadedKit(kitConstructor);
                 }
+
+                // If Sideloaded Kits are successfully registered,
+                // record this in the Store.
+                if (!isEmpty(sideloadedKits.kits)) {
+                    mpInstance._Store.isUsingSideloadedKits = true;
+                }
             }
         } catch (e) {
             mpInstance.Logger.error(

package/src/mockBatchCreator.ts

@@ -111,6 +111,7 @@ export default class _BatchValidator {
             getAppVersion: mockFunction,
             getAppName: mockFunction,
             getInstance: mockFunction,
+            getDeviceId: mockFunction,
             init: mockFunction,
             logBaseEvent: mockFunction,
             logEvent: mockFunction,

package/src/persistence.js

@@ -194,10 +194,18 @@ export default function _Persistence(mpInstance) {
                     obj.gs.cgid ||
                     mpInstance._Store.clientId ||
                     mpInstance._Helpers.generateUniqueId();
+
+                // For most persistence values, we prioritize localstorage/cookie values over
+                // Store. However, we allow device ID to be overriden via a config value and
+                // thus the priority of the deviceId value is
+                // 1. value passed via config.deviceId
+                // 2. previous value in persistence
+                // 3. generate new guid
                 mpInstance._Store.deviceId =
-                    obj.gs.das ||
                     mpInstance._Store.deviceId ||
+                    obj.gs.das ||
                     mpInstance._Helpers.generateUniqueId();
+
                 mpInstance._Store.integrationAttributes = obj.gs.ia || {};
                 mpInstance._Store.context =
                     obj.gs.c || mpInstance._Store.context;

package/src/sdkRuntimeModels.ts

@@ -151,6 +151,7 @@ export interface MParticleWebSDK {
     init(apiKey: string, config: SDKInitConfig, instanceName?: string): void;
     getAppName(): string;
     getAppVersion(): string;
+    getDeviceId(): string;
     getInstance(): MParticleWebSDK; // TODO: Create a new type for MParticleWebSDKInstance
     ServerModel();
     upload();

package/src/sdkToEventsApiConverter.ts

@@ -66,11 +66,16 @@ export function convertEvents(
         events: uploadEvents,
         mp_deviceid: lastEvent.DeviceId,
         sdk_version: lastEvent.SDKVersion,
+
+        // TODO: Refactor this to read from _Store or a global config
         application_info: {
             application_version: lastEvent.AppVersion,
             application_name: lastEvent.AppName,
             package: lastEvent.Package,
+            is_using_sideloaded_kits:
+                mpInstance._Store.isUsingSideloadedKits || undefined,
         },
+
         device_info: {
             platform: EventsApi.DeviceInformationPlatformEnum.web,
             screen_width: window.screen.width,

package/src/store.ts

@@ -139,6 +139,7 @@ export interface IStore {
     nonCurrentUserMPIDs: Record<MPID, Dictionary>;
     identifyCalled: boolean;
     isLoggedIn: boolean;
+    isUsingSideloadedKits?: boolean;
     cookieSyncDates: Dictionary<number>;
     integrationAttributes: IntegrationAttributes;
     requireDelay: boolean;