@splitsoftware/splitio-browserjs 0.4.1-rc.0 → 0.5.0

package/CHANGES.txt

@@ -1,3 +1,14 @@
+0.5.0 (April 7, 2022)
+ - Added user consent feature to allow delaying or disabling the data tracking from SDK until user consent is explicitly granted or declined. Read more in our docs.
+ - Added `scheduler.impressionsQueueSize` property to SDK configuration to limit the amount of impressions tracked in memory. Read more in our docs.
+ - Updated format for MySegments keys in LocalStorage, keeping backwards compatibility (issue https://github.com/splitio/javascript-client/issues/638).
+ - Updated some dependencies for vulnerability fixes.
+ - Bugfixing - Updated internal isObject utility function, to avoid unexpected behaviors on frameworks and libraries that uses multiple VM contexts, like NuxtJS dev server.
+ - Bugfixing - Fixed validation of `core.key` SDK configuration param, to parse it into a string and log a warning when passing a number (Related to issue https://github.com/splitio/react-native-client/issues/19).
+ - Bugfixing - Fixed validation of `sync.impressionsMode` SDK configuration param, to avoid an exception on SplitFactory instantiation when passing a non-string value.
+ - Bugfixing - Fixed streaming synchronization issue when using multiple clients.
+ - Bugfixing - Fixed issue with internal Map ponyfill that results in logger not working properly on IE11 browser.
+
 0.4.1 (February 22, 2022)
  - Updated karma and some transitive dependencies for vulnerability fixes.
 

package/cjs/full/splitFactory.js

@@ -4,7 +4,6 @@ exports.SplitFactory = void 0;
 var full_1 = require("../settings/full");
 var getModules_1 = require("../platform/getModules");
 var index_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory/index");
-var lang_1 = require("@splitsoftware/splitio-commons/cjs/utils/lang");
 var getFetchFull_1 = require("../platform/getFetchFull");
 var getEventSource_1 = require("../platform/getEventSource");
 var MinEvents_1 = require("@splitsoftware/splitio-commons/cjs/utils/MinEvents");
@@ -13,13 +12,16 @@ var platform = { getFetch: getFetchFull_1.getFetch, getEventSource: getEventSour
  * SplitFactory with pluggable modules for Browser.
  * Includes localhost mode and fetch polyfill out-of-the-box.
  *
- * @param config configuration object used to instantiates the SDK
- * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @param config configuration object used to instantiate the SDK
+ * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-function SplitFactory(config, customModules) {
-    var settings = full_1.settingsValidator(config);
-    var modules = getModules_1.getModules(settings, platform);
-    return index_1.sdkFactory(customModules ? lang_1.merge(modules, customModules) : modules);
+function SplitFactory(config, __updateModules) {
+    var settings = (0, full_1.settingsValidator)(config);
+    var modules = (0, getModules_1.getModules)(settings, platform);
+    if (__updateModules)
+        __updateModules(modules);
+    return (0, index_1.sdkFactory)(modules);
 }
 exports.SplitFactory = SplitFactory;

package/cjs/full/umd.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
+var index_1 = require("./index");
+// Include all pluggable modules as properties to expose at the global `splitio` object
+index_1.SplitFactory.SplitFactory = index_1.SplitFactory;
+index_1.SplitFactory.InLocalStorage = index_1.InLocalStorage;
+index_1.SplitFactory.GoogleAnalyticsToSplit = index_1.GoogleAnalyticsToSplit;
+index_1.SplitFactory.SplitToGoogleAnalytics = index_1.SplitToGoogleAnalytics;
+index_1.SplitFactory.ErrorLogger = index_1.ErrorLogger;
+index_1.SplitFactory.WarnLogger = index_1.WarnLogger;
+index_1.SplitFactory.InfoLogger = index_1.InfoLogger;
+index_1.SplitFactory.DebugLogger = index_1.DebugLogger;
+// eslint-disable-next-line import/no-default-export
+exports.default = index_1.SplitFactory;

package/cjs/index.js

@@ -1,4 +1,19 @@
 "use strict";
+/**
+Copyright 2022 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluggableStorage = exports.LocalhostFromObject = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
 var splitFactory_1 = require("./splitFactory");

package/cjs/platform/getFetchFull.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFetch = void 0;
 var tslib_1 = require("tslib");
-var unfetch_1 = tslib_1.__importDefault(require("unfetch"));
+var unfetch_1 = (0, tslib_1.__importDefault)(require("unfetch"));
 function getFetch() {
     return typeof fetch === 'function' ? fetch : unfetch_1.default;
 }

package/cjs/platform/getModules.js

@@ -12,11 +12,12 @@ var impressionObserverCS_1 = require("@splitsoftware/splitio-commons/cjs/tracker
 var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/integrations/pluggable");
 var utils_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/utils");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
+var sdkUserConsent_1 = require("@splitsoftware/splitio-commons/cjs/consent/sdkUserConsent");
 var syncManagerStandaloneFactory;
 var syncManagerSubmittersFactory;
 function getModules(settings, platform) {
     if (!syncManagerStandaloneFactory)
-        syncManagerStandaloneFactory = syncManagerOnline_1.syncManagerOnlineFactory(pollingManagerCS_1.pollingManagerCSFactory, pushManager_1.pushManagerFactory);
+        syncManagerStandaloneFactory = (0, syncManagerOnline_1.syncManagerOnlineFactory)(pollingManagerCS_1.pollingManagerCSFactory, pushManager_1.pushManagerFactory);
     var modules = {
         settings: settings,
         platform: platform,
@@ -26,9 +27,13 @@ function getModules(settings, platform) {
         sdkManagerFactory: index_1.sdkManagerFactory,
         sdkClientMethodFactory: sdkClientMethodCS_1.sdkClientMethodCSFactory,
         SignalListener: browser_1.BrowserSignalListener,
-        impressionListener: settings.impressionListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggable_1.pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
-        impressionsObserverFactory: utils_1.shouldAddPt(settings) ? impressionObserverCS_1.impressionObserverCSFactory : undefined,
+        impressionsObserverFactory: (0, utils_1.shouldAddPt)(settings) ? impressionObserverCS_1.impressionObserverCSFactory : undefined,
+        extraProps: function (params) {
+            return {
+                UserConsent: (0, sdkUserConsent_1.createUserConsentAPI)(params)
+            };
+        },
     };
     switch (settings.mode) {
         case constants_1.LOCALHOST_MODE:
@@ -41,7 +46,7 @@ function getModules(settings, platform) {
             break;
         case constants_1.CONSUMER_PARTIAL_MODE:
             if (!syncManagerSubmittersFactory)
-                syncManagerSubmittersFactory = syncManagerOnline_1.syncManagerOnlineFactory(undefined, undefined);
+                syncManagerSubmittersFactory = (0, syncManagerOnline_1.syncManagerOnlineFactory)(undefined, undefined);
             modules.syncManagerFactory = syncManagerSubmittersFactory;
     }
     return modules;

package/cjs/settings/defaults.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaults = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/logger/index");
-var packageVersion = '0.4.1-rc.0';
+var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
+var packageVersion = '0.5.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -14,7 +15,7 @@ var LS_KEY = 'splitio_debug';
 try {
     var initialState = localStorage.getItem(LS_KEY) || '';
     // Kept to avoid a breaking change ('on', 'enable' and 'enabled' are equivalent)
-    initialLogLevel = /^(enabled?|on)/i.test(initialState) ? index_1.LogLevels.DEBUG : index_1.isLogLevelString(initialState) ? initialState : index_1.LogLevels.NONE;
+    initialLogLevel = /^(enabled?|on)/i.test(initialState) ? index_1.LogLevels.DEBUG : (0, index_1.isLogLevelString)(initialState) ? initialState : index_1.LogLevels.NONE;
     // eslint-disable-next-line no-empty
 }
 catch (_a) { }
@@ -29,6 +30,8 @@ exports.defaults = {
         // Amount of time we will wait before the first push of events.
         eventsFirstPushWindow: 10
     },
+    // Consent is considered granted by default
+    userConsent: constants_1.CONSENT_GRANTED,
     // Instance version.
     version: "browserjs-" + packageVersion,
     debug: initialLogLevel

package/cjs/settings/full.js

@@ -3,19 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.settingsValidator = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/index");
 var defaults_1 = require("./defaults");
+var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime");
 var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/storage/storageCS");
 var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/integrations/pluggable");
 var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
 var builtin_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/localhost/builtin");
+var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
 var params = {
     defaults: defaults_1.defaults,
+    acceptKey: true,
+    runtime: runtime_1.validateRuntime,
     storage: storageCS_1.validateStorageCS,
     integrations: pluggable_1.validatePluggableIntegrations,
     logger: pluggableLogger_1.validateLogger,
-    // Full SplitFactory returns a default instance, except a valid one is provided
-    localhost: builtin_1.validateLocalhostWithDefault
+    localhost: builtin_1.validateLocalhostWithDefault,
+    consent: consent_1.validateConsent,
 };
 function settingsValidator(config) {
-    return index_1.settingsValidation(config, params);
+    return (0, index_1.settingsValidation)(config, params);
 }
 exports.settingsValidator = settingsValidator;

package/cjs/settings/index.js

@@ -3,19 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.settingsValidator = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/index");
 var defaults_1 = require("./defaults");
+var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime");
 var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/storage/storageCS");
 var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/integrations/pluggable");
 var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
 var pluggable_2 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/localhost/pluggable");
+var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
 var params = {
     defaults: defaults_1.defaults,
+    acceptKey: true,
+    runtime: runtime_1.validateRuntime,
     storage: storageCS_1.validateStorageCS,
     integrations: pluggable_1.validatePluggableIntegrations,
     logger: pluggableLogger_1.validateLogger,
-    // Slim SplitFactory validates that the localhost module is passed in localhost mode
-    localhost: pluggable_2.validateLocalhost
+    localhost: pluggable_2.validateLocalhost,
+    consent: consent_1.validateConsent,
 };
 function settingsValidator(config) {
-    return index_1.settingsValidation(config, params);
+    return (0, index_1.settingsValidation)(config, params);
 }
 exports.settingsValidator = settingsValidator;

package/cjs/splitFactory.js

@@ -4,7 +4,6 @@ exports.SplitFactory = void 0;
 var settings_1 = require("./settings");
 var getModules_1 = require("./platform/getModules");
 var index_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory/index");
-var lang_1 = require("@splitsoftware/splitio-commons/cjs/utils/lang");
 var getFetchSlim_1 = require("./platform/getFetchSlim");
 var getEventSource_1 = require("./platform/getEventSource");
 var MinEvents_1 = require("@splitsoftware/splitio-commons/cjs/utils/MinEvents");
@@ -13,13 +12,16 @@ var platform = { getFetch: getFetchSlim_1.getFetch, getEventSource: getEventSour
  * Slim SplitFactory with pluggable modules for Browser.
  * Doesn't include localhost mode and fetch ponyfill out-of-the-box.
  *
- * @param config configuration object used to instantiates the SDK
- * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @param config configuration object used to instantiate the SDK
+ * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-function SplitFactory(config, customModules) {
-    var settings = settings_1.settingsValidator(config);
-    var modules = getModules_1.getModules(settings, platform);
-    return index_1.sdkFactory(customModules ? lang_1.merge(modules, customModules) : modules);
+function SplitFactory(config, __updateModules) {
+    var settings = (0, settings_1.settingsValidator)(config);
+    var modules = (0, getModules_1.getModules)(settings, platform);
+    if (__updateModules)
+        __updateModules(modules);
+    return (0, index_1.sdkFactory)(modules);
 }
 exports.SplitFactory = SplitFactory;

package/cjs/umd.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
+var splitFactory_1 = require("./splitFactory");
+splitFactory_1.SplitFactory.SplitFactory = splitFactory_1.SplitFactory;
+// eslint-disable-next-line import/no-default-export
+exports.default = splitFactory_1.SplitFactory;

package/esm/full/splitFactory.js

@@ -1,7 +1,6 @@
 import { settingsValidator } from '../settings/full';
 import { getModules } from '../platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory/index';
-import { merge } from '@splitsoftware/splitio-commons/esm/utils/lang';
 import { getFetch } from '../platform/getFetchFull';
 import { getEventSource } from '../platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/esm/utils/MinEvents';
@@ -10,12 +9,15 @@ var platform = { getFetch: getFetch, getEventSource: getEventSource, EventEmitte
  * SplitFactory with pluggable modules for Browser.
  * Includes localhost mode and fetch polyfill out-of-the-box.
  *
- * @param config configuration object used to instantiates the SDK
- * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @param config configuration object used to instantiate the SDK
+ * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-export function SplitFactory(config, customModules) {
+export function SplitFactory(config, __updateModules) {
     var settings = settingsValidator(config);
     var modules = getModules(settings, platform);
-    return sdkFactory(customModules ? merge(modules, customModules) : modules);
+    if (__updateModules)
+        __updateModules(modules);
+    return sdkFactory(modules);
 }

package/esm/full/umd.js

@@ -0,0 +1,13 @@
+// @ts-nocheck
+import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger } from './index';
+// Include all pluggable modules as properties to expose at the global `splitio` object
+SplitFactory.SplitFactory = SplitFactory;
+SplitFactory.InLocalStorage = InLocalStorage;
+SplitFactory.GoogleAnalyticsToSplit = GoogleAnalyticsToSplit;
+SplitFactory.SplitToGoogleAnalytics = SplitToGoogleAnalytics;
+SplitFactory.ErrorLogger = ErrorLogger;
+SplitFactory.WarnLogger = WarnLogger;
+SplitFactory.InfoLogger = InfoLogger;
+SplitFactory.DebugLogger = DebugLogger;
+// eslint-disable-next-line import/no-default-export
+export default SplitFactory;

package/esm/index.js

@@ -1,3 +1,18 @@
+/**
+Copyright 2022 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
 export { SplitFactory } from './splitFactory';
 export { InLocalStorage } from '@splitsoftware/splitio-commons/esm/storages/inLocalStorage/index';
 export { GoogleAnalyticsToSplit } from '@splitsoftware/splitio-commons/esm/integrations/ga/GoogleAnalyticsToSplit';

package/esm/platform/getModules.js

@@ -9,6 +9,7 @@ import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/esm/
 import { pluggableIntegrationsManagerFactory } from '@splitsoftware/splitio-commons/esm/integrations/pluggable';
 import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
 import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
+import { createUserConsentAPI } from '@splitsoftware/splitio-commons/esm/consent/sdkUserConsent';
 var syncManagerStandaloneFactory;
 var syncManagerSubmittersFactory;
 export function getModules(settings, platform) {
@@ -23,9 +24,13 @@ export function getModules(settings, platform) {
         sdkManagerFactory: sdkManagerFactory,
         sdkClientMethodFactory: sdkClientMethodCSFactory,
         SignalListener: BrowserSignalListener,
-        impressionListener: settings.impressionListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
         impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+        extraProps: function (params) {
+            return {
+                UserConsent: createUserConsentAPI(params)
+            };
+        },
     };
     switch (settings.mode) {
         case LOCALHOST_MODE:

package/esm/settings/defaults.js

@@ -1,5 +1,6 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/esm/logger/index';
-var packageVersion = '0.4.1-rc.0';
+import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/esm/utils/constants';
+var packageVersion = '0.5.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -26,6 +27,8 @@ export var defaults = {
         // Amount of time we will wait before the first push of events.
         eventsFirstPushWindow: 10
     },
+    // Consent is considered granted by default
+    userConsent: CONSENT_GRANTED,
     // Instance version.
     version: "browserjs-" + packageVersion,
     debug: initialLogLevel

package/esm/settings/full.js

@@ -1,16 +1,20 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/index';
 import { defaults } from './defaults';
+import { validateRuntime } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/runtime';
 import { validateStorageCS } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/storage/storageCS';
 import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/integrations/pluggable';
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/localhost/builtin';
+import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
 var params = {
     defaults: defaults,
+    acceptKey: true,
+    runtime: validateRuntime,
     storage: validateStorageCS,
     integrations: validatePluggableIntegrations,
     logger: validateLogger,
-    // Full SplitFactory returns a default instance, except a valid one is provided
-    localhost: validateLocalhostWithDefault
+    localhost: validateLocalhostWithDefault,
+    consent: validateConsent,
 };
 export function settingsValidator(config) {
     return settingsValidation(config, params);

package/esm/settings/index.js

@@ -1,16 +1,20 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/index';
 import { defaults } from './defaults';
+import { validateRuntime } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/runtime';
 import { validateStorageCS } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/storage/storageCS';
 import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/integrations/pluggable';
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhost } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/localhost/pluggable';
+import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
 var params = {
     defaults: defaults,
+    acceptKey: true,
+    runtime: validateRuntime,
     storage: validateStorageCS,
     integrations: validatePluggableIntegrations,
     logger: validateLogger,
-    // Slim SplitFactory validates that the localhost module is passed in localhost mode
-    localhost: validateLocalhost
+    localhost: validateLocalhost,
+    consent: validateConsent,
 };
 export function settingsValidator(config) {
     return settingsValidation(config, params);

package/esm/splitFactory.js

@@ -1,7 +1,6 @@
 import { settingsValidator } from './settings';
 import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory/index';
-import { merge } from '@splitsoftware/splitio-commons/esm/utils/lang';
 import { getFetch } from './platform/getFetchSlim';
 import { getEventSource } from './platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/esm/utils/MinEvents';
@@ -10,12 +9,15 @@ var platform = { getFetch: getFetch, getEventSource: getEventSource, EventEmitte
  * Slim SplitFactory with pluggable modules for Browser.
  * Doesn't include localhost mode and fetch ponyfill out-of-the-box.
  *
- * @param config configuration object used to instantiates the SDK
- * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @param config configuration object used to instantiate the SDK
+ * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-export function SplitFactory(config, customModules) {
+export function SplitFactory(config, __updateModules) {
     var settings = settingsValidator(config);
     var modules = getModules(settings, platform);
-    return sdkFactory(customModules ? merge(modules, customModules) : modules);
+    if (__updateModules)
+        __updateModules(modules);
+    return sdkFactory(modules);
 }

package/esm/umd.js

@@ -0,0 +1,5 @@
+// @ts-nocheck
+import { SplitFactory } from './splitFactory';
+SplitFactory.SplitFactory = SplitFactory;
+// eslint-disable-next-line import/no-default-export
+export default SplitFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.4.1-rc.0",
+  "version": "0.5.0",
   "description": "Split SDK for Javascript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -22,8 +22,8 @@
     "check:types": "tsc --noEmit",
     "check:version": "./scripts/check_version.sh",
     "build": "npm run build:cjs && npm run build:esm && npm run build:umd",
-    "build:esm": "rimraf esm && tsc -outDir esm --importHelpers && ./scripts/build_esm_replace_imports.sh",
-    "build:cjs": "rimraf cjs && tsc -outDir cjs -m CommonJS --importHelpers && ./scripts/build_cjs_replace_imports.sh",
+    "build:esm": "rimraf esm && tsc -outDir esm && ./scripts/build_esm_replace_imports.sh",
+    "build:cjs": "rimraf cjs && tsc -outDir cjs -m CommonJS && ./scripts/build_cjs_replace_imports.sh",
     "build:umd-visualizer": "rollup --config rollup.visualizer.config.js",
     "build:umd": "rollup --config rollup.ci.config.js --branch=$BUILD_BRANCH --commit_hash=$BUILD_COMMIT",
     "test": "npm run test:unit && npm run test:e2e",
@@ -61,7 +61,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "^1.2.0",
+    "@splitsoftware/splitio-commons": "1.3.0",
     "@types/google.analytics": "0.0.40"
   },
   "devDependencies": {
@@ -87,13 +87,13 @@
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-string": "^3.0.0",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-ts": "^1.4.0",
+    "rollup-plugin-ts": "^1.4.7",
     "rollup-plugin-visualizer": "^4.2.0",
     "sinon": "^9.2.2",
     "tape": "4.13.2",
     "tape-catch": "1.0.6",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.1.3",
+    "typescript": "4.4.4",
     "unfetch": "^4.2.0"
   },
   "sideEffects": false

package/src/full/splitFactory.ts

@@ -2,7 +2,6 @@ import { settingsValidator } from '../settings/full';
 import { getModules } from '../platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
 import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
-import { merge } from '@splitsoftware/splitio-commons/src/utils/lang';
 import { getFetch } from '../platform/getFetchFull';
 import { getEventSource } from '../platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
@@ -13,12 +12,14 @@ const platform = { getFetch, getEventSource, EventEmitter };
  * SplitFactory with pluggable modules for Browser.
  * Includes localhost mode and fetch polyfill out-of-the-box.
  *
- * @param config configuration object used to instantiates the SDK
- * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @param config configuration object used to instantiate the SDK
+ * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-export function SplitFactory(config: any, customModules?: Partial<ISdkFactoryParams>) {
+export function SplitFactory(config: any, __updateModules: (modules: ISdkFactoryParams) => void) {
   const settings = settingsValidator(config);
   const modules = getModules(settings, platform);
-  return sdkFactory(customModules ? merge(modules, customModules) as ISdkFactoryParams : modules);
+  if (__updateModules) __updateModules(modules);
+  return sdkFactory(modules);
 }

package/src/index.ts

@@ -1,3 +1,19 @@
+/**
+Copyright 2022 Split Software
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+**/
+
 export { SplitFactory } from './splitFactory';
 export { InLocalStorage } from '@splitsoftware/splitio-commons/src/storages/inLocalStorage/index';
 export { GoogleAnalyticsToSplit } from '@splitsoftware/splitio-commons/src/integrations/ga/GoogleAnalyticsToSplit';

package/src/platform/getModules.ts

@@ -10,8 +10,9 @@ import { pluggableIntegrationsManagerFactory } from '@splitsoftware/splitio-comm
 
 import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
 import { IPlatform, ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
-import { SplitIO, ISettings } from '@splitsoftware/splitio-commons/src/types';
+import { ISettings } from '@splitsoftware/splitio-commons/src/types';
 import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
+import { createUserConsentAPI } from '@splitsoftware/splitio-commons/src/consent/sdkUserConsent';
 
 let syncManagerStandaloneFactory: ISdkFactoryParams['syncManagerFactory'];
 let syncManagerSubmittersFactory: ISdkFactoryParams['syncManagerFactory'];
@@ -37,11 +38,15 @@ export function getModules(settings: ISettings, platform: IPlatform): ISdkFactor
 
     SignalListener: BrowserSignalListener as ISdkFactoryParams['SignalListener'],
 
-    impressionListener: settings.impressionListener as SplitIO.IImpressionListener,
-
     integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
 
     impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+
+    extraProps: (params) => {
+      return {
+        UserConsent: createUserConsentAPI(params)
+      };
+    },
   };
 
   switch (settings.mode) {

package/src/settings/defaults.ts

@@ -1,7 +1,8 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/logger/index';
-import { LogLevel } from '@splitsoftware/splitio-commons/src/types';
+import { ConsentStatus, LogLevel } from '@splitsoftware/splitio-commons/src/types';
+import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const packageVersion = '0.4.1-rc.0';
+const packageVersion = '0.5.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
@@ -32,6 +33,9 @@ export const defaults = {
     eventsFirstPushWindow: 10
   },
 
+  // Consent is considered granted by default
+  userConsent: CONSENT_GRANTED as ConsentStatus,
+
   // Instance version.
   version: `browserjs-${packageVersion}`,
 

package/src/settings/full.ts

@@ -1,17 +1,21 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/index';
 import { defaults } from './defaults';
+import { validateRuntime } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/runtime';
 import { validateStorageCS } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/storage/storageCS';
 import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/integrations/pluggable';
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/builtin';
+import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
 
 const params = {
   defaults,
+  acceptKey: true, // Client with bound key
+  runtime: validateRuntime,
   storage: validateStorageCS,
   integrations: validatePluggableIntegrations,
   logger: validateLogger,
-  // Full SplitFactory returns a default instance, except a valid one is provided
-  localhost: validateLocalhostWithDefault
+  localhost: validateLocalhostWithDefault, // Full SplitFactory provides a default localhost module, except a valid one is provided
+  consent: validateConsent,
 };
 
 export function settingsValidator(config: any) {

package/src/settings/index.ts

@@ -1,17 +1,21 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/index';
 import { defaults } from './defaults';
+import { validateRuntime } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/runtime';
 import { validateStorageCS } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/storage/storageCS';
 import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/integrations/pluggable';
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhost } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/pluggable';
+import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
 
 const params = {
   defaults,
+  acceptKey: true, // Client with bound key
+  runtime: validateRuntime,
   storage: validateStorageCS,
   integrations: validatePluggableIntegrations,
   logger: validateLogger,
-  // Slim SplitFactory validates that the localhost module is passed in localhost mode
-  localhost: validateLocalhost
+  localhost: validateLocalhost, // Slim SplitFactory validates that the localhost module is passed in localhost mode
+  consent: validateConsent,
 };
 
 export function settingsValidator(config: any) {

package/src/splitFactory.ts

@@ -2,7 +2,6 @@ import { settingsValidator } from './settings';
 import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
 import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
-import { merge } from '@splitsoftware/splitio-commons/src/utils/lang';
 import { getFetch } from './platform/getFetchSlim';
 import { getEventSource } from './platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
@@ -13,12 +12,14 @@ const platform = { getFetch, getEventSource, EventEmitter };
  * Slim SplitFactory with pluggable modules for Browser.
  * Doesn't include localhost mode and fetch ponyfill out-of-the-box.
  *
- * @param config configuration object used to instantiates the SDK
- * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @param config configuration object used to instantiate the SDK
+ * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-export function SplitFactory(config: any, customModules?: Partial<ISdkFactoryParams>) {
+export function SplitFactory(config: any, __updateModules: (modules: ISdkFactoryParams) => void) {
   const settings = settingsValidator(config);
   const modules = getModules(settings, platform);
-  return sdkFactory(customModules ? merge(modules, customModules) as ISdkFactoryParams : modules);
+  if (__updateModules) __updateModules(modules);
+  return sdkFactory(modules);
 }

package/types/splitio.d.ts

@@ -58,6 +58,7 @@ interface ISettings {
   readonly scheduler: {
     featuresRefreshRate: number,
     impressionsRefreshRate: number,
+    impressionsQueueSize: number,
     segmentsRefreshRate: number,
     offlineRefreshRate: number,
     eventsPushRate: number,
@@ -89,7 +90,8 @@ interface ISettings {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
     localhostMode?: SplitIO.LocalhostFactory
-  }
+  },
+  readonly userConsent: SplitIO.ConsentStatus
 }
 /**
  * Log levels.
@@ -123,7 +125,38 @@ interface ILoggerAPI {
    * Log level constants. Use this to pass them to setLogLevel function.
    */
   LogLevel: {
-    [level: string]: LogLevel
+    [level in LogLevel]: LogLevel
+  }
+}
+/**
+ * User consent API
+ * @interface IUserConsentAPI
+ */
+interface IUserConsentAPI {
+  /**
+   * Set or update the user consent status. Possible values are `true` and `false`, which represent user consent `'GRANTED'` and `'DECLINED'` respectively.
+   * - `true ('GRANTED')`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
+   * - `false ('DECLINED')`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
+   *
+   * NOTE: calling this method updates the user consent at a factory level, affecting all clients of the same factory.
+   *
+   * @function setStatus
+   * @param {boolean} userConsent The user consent status, true for 'GRANTED' and false for 'DECLINED'.
+   * @returns {boolean} Whether the provided param is a valid value (i.e., a boolean value) or not.
+   */
+  setStatus(userConsent: boolean): boolean;
+  /**
+   * Get the user consent status.
+   *
+   * @function getStatus
+   * @returns {ConsentStatus} The user consent status.
+   */
+  getStatus(): SplitIO.ConsentStatus;
+  /**
+   * Consent status constants. Use this to compare with the getStatus function result.
+   */
+  Status: {
+    [status in SplitIO.ConsentStatus]: SplitIO.ConsentStatus
   }
 }
 /**
@@ -268,7 +301,12 @@ interface IBasicSDK {
    * Logger API.
    * @property Logger
    */
-  Logger: ILoggerAPI
+  Logger: ILoggerAPI,
+  /**
+   * User consent API.
+   * @property UserConsent
+   */
+  UserConsent: IUserConsentAPI
 }
 /****** Exposed namespace ******/
 /**
@@ -548,7 +586,10 @@ declare namespace SplitIO {
    * By returning an integration, the SDK will queue events and impressions into it.
    * Input parameter details are not part of the public API.
    */
-  type IntegrationFactory = (params: {}) => (Integration | void)
+  type IntegrationFactory = {
+    readonly type: string
+    (params: {}): (Integration | void)
+  }
   /**
    * A pair of user key and it's trafficType, required for tracking valid Split events.
    * @typedef {Object} Identity
@@ -739,6 +780,11 @@ declare namespace SplitIO {
   * @typedef {string} ImpressionsMode
   */
   type ImpressionsMode = 'OPTIMIZED' | 'DEBUG';
+  /**
+   * User consent status.
+   * @typedef {string} ConsentStatus
+   */
+  type ConsentStatus = 'GRANTED' | 'DECLINED' | 'UNKNOWN';
   /**
    * Logger
    * Its interface details are not part of the public API. It shouldn't be used directly.
@@ -794,6 +840,17 @@ declare namespace SplitIO {
      * @property {Object} integrations
      */
     integrations?: IntegrationFactory[],
+    /**
+     * User consent status. Possible values are `'GRANTED'`, which is the default, `'DECLINED'` or `'UNKNOWN'`.
+     * - `'GRANTED'`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
+     * - `'DECLINED'`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
+     * - `'UNKNOWN'`: the user has neither granted nor declined consent for tracking events and impressions. The SDK will track them in its internal storage, and eventually send
+     * them or not if the consent status is updated to 'GRANTED' or 'DECLINED' respectively. The status can be updated at any time with the `setUserConsent` factory method.
+     *
+     * @typedef {string} userConsent
+     * @default 'GRANTED'
+     */
+    userConsent?: ConsentStatus
   }
   /**
    * Settings interface for SDK instances created on the browser.
@@ -877,6 +934,13 @@ declare namespace SplitIO {
        * @default 60
        */
       impressionsRefreshRate?: number,
+      /**
+       * The maximum number of impression items we want to queue. If we queue more values, it will trigger a flush and reset the timer.
+       * If you use a 0 here, the queue will have no maximum size.
+       * @property {number} impressionsQueueSize
+       * @default 30000
+       */
+      impressionsQueueSize?: number,
       /**
        * The SDK polls Split servers for changes to segment definitions. This parameter controls this polling period in seconds.
        * @property {number} segmentsRefreshRate
@@ -975,6 +1039,13 @@ declare namespace SplitIO {
        * @default 60
        */
       impressionsRefreshRate?: number,
+      /**
+       * The maximum number of impression items we want to queue. If we queue more values, it will trigger a flush and reset the timer.
+       * If you use a 0 here, the queue will have no maximum size.
+       * @property {number} impressionsQueueSize
+       * @default 30000
+       */
+      impressionsQueueSize?: number,
       /**
        * The SDK posts the queued events data in bulks. This parameter controls the posting rate in seconds.
        *
@@ -1002,13 +1073,13 @@ declare namespace SplitIO {
    */
   interface ISDK extends IBasicSDK {
     /**
-     * Returns the default client instance of the SDK, associated with the key and optional traffic type from settings.
+     * Returns the default client instance of the SDK, associated with the key provided on settings.
      * @function client
      * @returns {IClient} The client instance.
      */
     client(): IClient,
     /**
-     * Returns a shared client of the SDK, associated with the given key and optional traffic type.
+     * Returns a shared client of the SDK, associated with the given key.
      * @function client
      * @param {SplitKey} key The key for the new client instance.
      * @returns {IClient} The client instance.
@@ -1029,11 +1100,18 @@ declare namespace SplitIO {
    */
   interface IAsyncSDK extends IBasicSDK {
     /**
-     * Returns the default client instance of the SDK.
+     * Returns the default client instance of the SDK, associated with the key provided on settings.
      * @function client
      * @returns {IAsyncClient} The asynchronous client instance.
      */
     client(): IAsyncClient,
+    /**
+     * Returns a shared client of the SDK, associated with the given key.
+     * @function client
+     * @param {SplitKey} key The key for the new client instance.
+     * @returns {IAsyncClient} The asynchronous client instance.
+     */
+    client(key: SplitKey): IAsyncClient,
     /**
      * Returns a manager instance of the SDK to explore available information.
      * @function manager
@@ -1207,7 +1285,7 @@ declare namespace SplitIO {
     /**
      * Add an attribute to client's in memory attributes storage.
      *
-     * @param {string} attributeName Attrinute name
+     * @param {string} attributeName Attribute name
      * @param {AttributeType} attributeValue Attribute value
      * @returns {boolean} true if the attribute was stored and false otherwise
      */
@@ -1297,7 +1375,7 @@ declare namespace SplitIO {
     /**
      * Add an attribute to client's in memory attributes storage.
      *
-     * @param {string} attributeName Attrinute name
+     * @param {string} attributeName Attribute name
      * @param {AttributeType} attributeValue Attribute value
      * @returns {boolean} true if the attribute was stored and false otherwise
      */