@splitsoftware/splitio-commons 1.2.1-rc.7 → 1.3.0

package/CHANGES.txt

@@ -1,3 +1,17 @@
+1.3.0 (April 6, 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.
+ - Added support to accept TLS configuration options to the Redis storage in NodeJS. 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 modules due to general polishing and refactors, including updates in some log messages.
+ - 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 an issue with `connectionTimeout` options params of Redis storage, that was being ignored and not passed down to the underlying ioredis client.
+ - Bugfixing - Fixed streaming synchronization issue with multiple clients.
+ - Bugfixing - Fixed issue with internal Map ponyfill that results in logger not working properly on IE11 browser.
+
 1.2.0 (January 19, 2022)
  - Added support to SDK clients on browser to optionally bind attributes to the client, keeping these loaded within the SDK along with the user ID, for easier usage when requesting flag.
 

package/cjs/{utils/consent.js → consent/index.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isConsentGranted = void 0;
-var constants_1 = require("./constants");
+var constants_1 = require("../utils/constants");
 function isConsentGranted(settings) {
     var userConsent = settings.userConsent;
     // undefined userConsent is handled as granted (default)

package/cjs/consent/sdkUserConsent.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUserConsentAPI = void 0;
+var constants_1 = require("../logger/constants");
+var index_1 = require("./index");
+var constants_2 = require("../utils/constants");
+var lang_1 = require("../utils/lang");
+// User consent enum
+var ConsentStatus = {
+    GRANTED: constants_2.CONSENT_GRANTED,
+    DECLINED: constants_2.CONSENT_DECLINED,
+    UNKNOWN: constants_2.CONSENT_UNKNOWN,
+};
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+function createUserConsentAPI(params) {
+    var settings = params.settings, log = params.settings.log, syncManager = params.syncManager, _a = params.storage, events = _a.events, impressions = _a.impressions, impressionCounts = _a.impressionCounts;
+    if (!(0, index_1.isConsentGranted)(settings))
+        log.info(constants_1.USER_CONSENT_INITIAL, [settings.userConsent]);
+    return {
+        setStatus: function (consent) {
+            var _a, _b;
+            // validate input param
+            if (!(0, lang_1.isBoolean)(consent)) {
+                log.warn(constants_1.ERROR_NOT_BOOLEAN, ['setUserConsent']);
+                return false;
+            }
+            var newConsentStatus = consent ? constants_2.CONSENT_GRANTED : constants_2.CONSENT_DECLINED;
+            if (settings.userConsent !== newConsentStatus) {
+                log.info(constants_1.USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop
+                settings.userConsent = newConsentStatus;
+                if (consent) { // resumes submitters if transitioning to GRANTED
+                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _a === void 0 ? void 0 : _a.start();
+                }
+                else { // pauses submitters and drops tracked data if transitioning to DECLINED
+                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _b === void 0 ? void 0 : _b.stop();
+                    // @ts-ignore, clear method is present in storage for standalone and partial consumer mode
+                    if (events.clear)
+                        events.clear(); // @ts-ignore
+                    if (impressions.clear)
+                        impressions.clear();
+                    if (impressionCounts)
+                        impressionCounts.clear();
+                }
+            }
+            else {
+                log.info(constants_1.USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
+            }
+            return true;
+        },
+        getStatus: function () {
+            return settings.userConsent;
+        },
+        Status: ConsentStatus
+    };
+}
+exports.createUserConsentAPI = createUserConsentAPI;

package/cjs/listeners/browser.js

@@ -6,7 +6,7 @@ var impressionCountsSyncTask_1 = require("../sync/submitters/impressionCountsSyn
 var constants_1 = require("../utils/constants");
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_2 = require("../logger/constants");
-var consent_1 = require("../utils/consent");
+var consent_1 = require("../consent");
 // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
 var UNLOAD_DOM_EVENT = 'unload';
 var EVENT_NAME = 'for unload page event.';

package/cjs/logger/constants.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
-exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = void 0;
-exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = void 0;
+exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = void 0;
+exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = void 0;
 /**
  * Message codes used to trim string log messages from commons and client-side API modules,
  * in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
@@ -74,6 +74,7 @@ exports.EVENTS_TRACKER_SUCCESS = 120;
 exports.IMPRESSIONS_TRACKER_SUCCESS = 121;
 exports.USER_CONSENT_UPDATED = 122;
 exports.USER_CONSENT_NOT_UPDATED = 123;
+exports.USER_CONSENT_INITIAL = 124;
 exports.ENGINE_VALUE_INVALID = 200;
 exports.ENGINE_VALUE_NO_ATTRIBUTES = 201;
 exports.CLIENT_NO_LISTENER = 202;

package/cjs/logger/messages/info.js

@@ -18,6 +18,7 @@ exports.codesInfo = warn_1.codesWarn.concat([
     [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
     [c.USER_CONSENT_UPDATED, 'setUserConsent: consent status changed from %s to %s.'],
     [c.USER_CONSENT_NOT_UPDATED, 'setUserConsent: call had no effect because it was the current consent status (%s).'],
+    [c.USER_CONSENT_INITIAL, 'Starting the SDK with %s user consent. No data will be sent.'],
     // synchronizer
     [c.POLLING_SMART_PAUSING, c.LOG_PREFIX_SYNC_POLLING + 'Turning segments data polling %s.'],
     [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],

package/cjs/sdkClient/client.js

@@ -21,8 +21,7 @@ function clientFactory(params) {
         var wrapUp = function (evaluationResult) {
             var queue = [];
             var treatment = processEvaluation(evaluationResult, splitName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
-            if (settings.userConsent !== constants_1.CONSENT_DECLINED)
-                impressionsTracker.track(queue, attributes);
+            impressionsTracker.track(queue, attributes);
             return treatment;
         };
         var evaluation = (0, evaluator_1.evaluateFeature)(log, key, splitName, attributes, storage);
@@ -39,8 +38,7 @@ function clientFactory(params) {
             Object.keys(evaluationResults).forEach(function (splitName) {
                 treatments[splitName] = processEvaluation(evaluationResults[splitName], splitName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''), queue);
             });
-            if (settings.userConsent !== constants_1.CONSENT_DECLINED)
-                impressionsTracker.track(queue, attributes);
+            impressionsTracker.track(queue, attributes);
             return treatments;
         };
         var evaluations = (0, evaluator_1.evaluateFeatures)(log, key, splitNames, attributes, storage);
@@ -94,10 +92,7 @@ function clientFactory(params) {
         };
         // This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
         (0, trafficTypeExistance_1.validateTrafficTypeExistance)(log, readinessManager, storage.splits, mode, trafficTypeName, 'track');
-        if (settings.userConsent !== constants_1.CONSENT_DECLINED)
-            return eventTracker.track(eventData, size);
-        else
-            return false;
+        return eventTracker.track(eventData, size);
     }
     return {
         getTreatment: getTreatment,
@@ -105,7 +100,7 @@ function clientFactory(params) {
         getTreatments: getTreatments,
         getTreatmentsWithConfig: getTreatmentsWithConfig,
         track: track,
-        isBrowserClient: false
+        isClientSide: false
     };
 }
 exports.clientFactory = clientFactory;

package/cjs/sdkClient/clientCS.js

@@ -20,7 +20,7 @@ function clientCSDecorator(log, client, key, trafficType) {
         getTreatmentsWithConfig: clientCS.getTreatmentsWithConfig.bind(clientCS, key),
         // Key is bound to the `track` method. Same thing happens with trafficType but only if provided
         track: trafficType ? clientCS.track.bind(clientCS, key, trafficType) : clientCS.track.bind(clientCS, key),
-        isBrowserClient: true
+        isClientSide: true
     });
 }
 exports.clientCSDecorator = clientCSDecorator;

package/cjs/sdkClient/clientInputValidation.js

@@ -5,12 +5,14 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var inputValidation_1 = require("../utils/inputValidation");
 var lang_1 = require("../utils/lang");
 var constants_1 = require("../utils/constants");
+var utils_1 = require("../trackers/impressionObserver/utils");
 /**
  * Decorator that validates the input before actually executing the client methods.
  * We should "guard" the client here, while not polluting the "real" implementation of those methods.
  */
-function clientInputValidationDecorator(log, client, readinessManager, isStorageSync) {
-    if (isStorageSync === void 0) { isStorageSync = false; }
+function clientInputValidationDecorator(settings, client, readinessManager) {
+    var log = settings.log;
+    var isSync = (0, utils_1.isStorageSync)(settings);
     /**
      * Avoid repeating this validations code
      */
@@ -30,9 +32,7 @@ function clientInputValidationDecorator(log, client, readinessManager, isStorage
         };
     }
     function wrapResult(value) {
-        if (isStorageSync)
-            return value;
-        return Promise.resolve(value);
+        return isSync ? value : Promise.resolve(value);
     }
     function getTreatment(maybeKey, maybeSplit, maybeAttributes) {
         var params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatment');
@@ -87,9 +87,7 @@ function clientInputValidationDecorator(log, client, readinessManager, isStorage
             return client.track(key, tt, event, eventValue, properties, size);
         }
         else {
-            if (isStorageSync)
-                return false;
-            return Promise.resolve(false);
+            return isSync ? false : Promise.resolve(false);
         }
     }
     return {

package/cjs/sdkClient/sdkClient.js

@@ -2,22 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sdkClientFactory = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
-var constants_1 = require("../utils/constants");
 var apiKey_1 = require("../utils/inputValidation/apiKey");
 var client_1 = require("./client");
 var clientInputValidation_1 = require("./clientInputValidation");
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-function sdkClientFactory(params) {
-    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, sharedClient = params.sharedClient;
+function sdkClientFactory(params, isSharedClient) {
+    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings;
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
     // Client API (getTreatment* & track methods)
-    (0, clientInputValidation_1.clientInputValidationDecorator)(settings.log, (0, client_1.clientFactory)(params), sdkReadinessManager.readinessManager, 
-    // storage is async if and only if mode is consumer or partial consumer
-    [constants_1.CONSUMER_MODE, constants_1.CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false), 
+    (0, clientInputValidation_1.clientInputValidationDecorator)(settings, (0, client_1.clientFactory)(params), sdkReadinessManager.readinessManager), 
     // Sdk destroy
     {
         destroy: function () {
@@ -29,7 +26,7 @@ function sdkClientFactory(params) {
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();
                 // Release the API Key if it is the main client
-                if (!sharedClient)
+                if (!isSharedClient)
                     (0, apiKey_1.releaseApiKey)(settings.core.authorizationKey);
                 // Cleanup storage
                 return storage.destroy();

package/cjs/sdkClient/sdkClientMethodCS.js

@@ -19,12 +19,7 @@ var method = 'Client instantiation';
  */
 function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    // Keeping similar behaviour as in the isomorphic JS SDK: if settings key is invalid,
-    // `false` value is used as binded key of the default client, but trafficType is ignored
-    // @TODO handle as a non-recoverable error
-    var validKey = (0, key_1.validateKey)(log, key, method);
-    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), // @ts-ignore
-    validKey);
+    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey);
     // Cache instances created per factory.
@@ -62,9 +57,8 @@ function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey);
             sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
         }

package/cjs/sdkClient/sdkClientMethodCSWithTT.js

@@ -21,16 +21,7 @@ var method = 'Client instantiation';
  */
 function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    // Keeping the behaviour as in the isomorphic JS SDK: if settings key or TT are invalid,
-    // `false` value is used as binded key/TT of the default client, which leads to several issues.
-    // @TODO update when supporting non-recoverable errors
-    var validKey = (0, key_1.validateKey)(log, key, method);
-    var validTrafficType;
-    if (trafficType !== undefined) {
-        validTrafficType = (0, trafficType_1.validateTrafficType)(log, trafficType, method);
-    }
-    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), // @ts-ignore
-    validKey, validTrafficType);
+    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key, trafficType);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
     // Cache instances created per factory.
@@ -75,9 +66,8 @@ function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey, validTrafficType);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey, validTrafficType);
             sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
         }

package/cjs/sdkFactory/index.js

@@ -16,7 +16,7 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
  * Modular SDK factory
  */
 function sdkFactory(params) {
-    var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, impressionListener = params.impressionListener, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory;
+    var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory;
     var log = settings.log;
     // @TODO handle non-recoverable errors: not start sync, mark the SDK as destroyed, etc.
     // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
@@ -59,12 +59,13 @@ function sdkFactory(params) {
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
     // trackers
     var observer = impressionsObserverFactory && impressionsObserverFactory();
-    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(log, storage.impressions, settings, impressionListener, integrationsManager, observer, storage.impressionCounts);
-    var eventTracker = (0, eventTracker_1.eventTrackerFactory)(log, storage.events, integrationsManager);
+    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, integrationsManager, observer, storage.impressionCounts);
+    var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager);
     // signal listener
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
     // Sdk client and manager
-    var clientMethod = sdkClientMethodFactory({ eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener });
+    var ctx = { eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener };
+    var clientMethod = sdkClientMethodFactory(ctx);
     var managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
     syncManager && syncManager.start();
     signalListener && signalListener.start();
@@ -81,6 +82,6 @@ function sdkFactory(params) {
         // Logger wrapper API
         Logger: (0, sdkLogger_1.createLoggerAPI)(settings.log),
         settings: settings,
-    }, extraProps && extraProps(settings, syncManager));
+    }, extraProps && extraProps(ctx));
 }
 exports.sdkFactory = sdkFactory;

package/cjs/storages/inRedis/RedisAdapter.js

@@ -146,13 +146,19 @@ var RedisAdapter = /** @class */ (function (_super) {
         else { // If it IS the string URL, that'll be the first param for ioredis.
             result.unshift(options.url);
         }
+        if (options.connectionTimeout) {
+            (0, lang_1.merge)(opts, { connectTimeout: options.connectionTimeout });
+        }
+        if (options.tls) {
+            (0, lang_1.merge)(opts, { tls: options.tls });
+        }
         return result;
     };
     /**
      * Parses the options into what we care about.
      */
     RedisAdapter._defineOptions = function (_a) {
-        var connectionTimeout = _a.connectionTimeout, operationTimeout = _a.operationTimeout, url = _a.url, host = _a.host, port = _a.port, db = _a.db, pass = _a.pass;
+        var connectionTimeout = _a.connectionTimeout, operationTimeout = _a.operationTimeout, url = _a.url, host = _a.host, port = _a.port, db = _a.db, pass = _a.pass, tls = _a.tls;
         var parsedOptions = {
             connectionTimeout: connectionTimeout,
             operationTimeout: operationTimeout,
@@ -160,7 +166,8 @@ var RedisAdapter = /** @class */ (function (_super) {
             host: host,
             port: port,
             db: db,
-            pass: pass
+            pass: pass,
+            tls: tls
         };
         return (0, lang_1.merge)({}, DEFAULT_OPTIONS, parsedOptions);
     };

package/cjs/sync/syncManagerOnline.js

@@ -4,7 +4,7 @@ exports.syncManagerOnlineFactory = void 0;
 var submitterManager_1 = require("./submitters/submitterManager");
 var constants_1 = require("./streaming/constants");
 var constants_2 = require("../logger/constants");
-var consent_1 = require("../utils/consent");
+var consent_1 = require("../consent");
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.

package/cjs/trackers/eventTracker.js

@@ -4,13 +4,17 @@ exports.eventTrackerFactory = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var thenable_1 = require("../utils/promise/thenable");
 var constants_1 = require("../logger/constants");
+var constants_2 = require("../utils/constants");
+var utils_1 = require("./impressionObserver/utils");
 /**
  * Event tracker stores events in cache and pass them to the integrations manager if provided.
  *
  * @param eventsCache cache to save events
  * @param integrationsManager optional event handler used for integrations
  */
-function eventTrackerFactory(log, eventsCache, integrationsManager) {
+function eventTrackerFactory(settings, eventsCache, integrationsManager) {
+    var log = settings.log;
+    var isSync = (0, utils_1.isStorageSync)(settings);
     function queueEventsCallback(eventData, tracked) {
         var eventTypeId = eventData.eventTypeId, trafficTypeName = eventData.trafficTypeName, key = eventData.key, value = eventData.value, timestamp = eventData.timestamp, properties = eventData.properties;
         // Logging every prop would be too much.
@@ -36,6 +40,9 @@ function eventTrackerFactory(log, eventsCache, integrationsManager) {
     }
     return {
         track: function (eventData, size) {
+            if (settings.userConsent === constants_2.CONSENT_DECLINED) {
+                return isSync ? false : Promise.resolve(false);
+            }
             var tracked = eventsCache.track(eventData, size);
             if ((0, thenable_1.thenable)(tracked)) {
                 return tracked.then(queueEventsCallback.bind(null, eventData));

package/cjs/trackers/impressionObserver/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldBeOptimized = exports.shouldAddPt = void 0;
+exports.isStorageSync = exports.shouldBeOptimized = exports.shouldAddPt = void 0;
 var constants_1 = require("../../utils/constants");
 /**
  * Checks if impressions previous time should be added or not.
@@ -18,3 +18,10 @@ function shouldBeOptimized(settings) {
     return settings.sync.impressionsMode === constants_1.OPTIMIZED ? true : false;
 }
 exports.shouldBeOptimized = shouldBeOptimized;
+/**
+ * Storage is async if mode is consumer or partial consumer
+ */
+function isStorageSync(settings) {
+    return [constants_1.CONSUMER_MODE, constants_1.CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false;
+}
+exports.isStorageSync = isStorageSync;

package/cjs/trackers/impressionsTracker.js

@@ -5,6 +5,7 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var thenable_1 = require("../utils/promise/thenable");
 var time_1 = require("../utils/time");
 var constants_1 = require("../logger/constants");
+var constants_2 = require("../utils/constants");
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
  *
@@ -15,16 +16,16 @@ var constants_1 = require("../logger/constants");
  * @param observer optional impression observer. If provided, previous time (pt property) is included in impression instances
  * @param countsCache optional cache to save impressions count. If provided, impressions will be deduped (OPTIMIZED mode)
  */
-function impressionsTrackerFactory(log, impressionsCache, 
-// @TODO consider passing only an optional integrationsManager to handle impressions
-_a, impressionListener, integrationsManager, 
+function impressionsTrackerFactory(settings, impressionsCache, integrationsManager, 
 // if observer is provided, it implies `shouldAddPreviousTime` flag (i.e., if impressions previous time should be added or not)
 observer, 
 // if countsCache is provided, it implies `isOptimized` flag (i.e., if impressions should be deduped or not)
 countsCache) {
-    var _b = _a.runtime, ip = _b.ip, hostname = _b.hostname, version = _a.version;
+    var log = settings.log, impressionListener = settings.impressionListener, _a = settings.runtime, ip = _a.ip, hostname = _a.hostname, version = settings.version;
     return {
         track: function (impressions, attributes) {
+            if (settings.userConsent === constants_2.CONSENT_DECLINED)
+                return;
             var impressionsCount = impressions.length;
             var impressionsToStore = []; // Track only the impressions that are going to be stored
             // Wraps impressions to store and adds previousTime if it corresponds
@@ -68,7 +69,7 @@ countsCache) {
                         // integrationsManager.handleImpression does not throw errors
                         if (integrationsManager)
                             integrationsManager.handleImpression(impressionData);
-                        try { // An exception on the listeners should not break the SDK.
+                        try { // @ts-ignore. An exception on the listeners should not break the SDK.
                             if (impressionListener)
                                 impressionListener.logImpression(impressionData);
                         }

package/cjs/utils/inputValidation/attributes.js

@@ -6,7 +6,7 @@ var attribute_1 = require("./attribute");
 var constants_1 = require("../../logger/constants");
 function validateAttributes(log, maybeAttrs, method) {
     // Attributes are optional
-    if ((0, lang_1.isObject)(maybeAttrs) || maybeAttrs == undefined) // eslint-disable-line eqeqeq
+    if (maybeAttrs == undefined || (0, lang_1.isObject)(maybeAttrs)) // eslint-disable-line eqeqeq
         return maybeAttrs;
     log.error(constants_1.ERROR_NOT_PLAIN_OBJECT, [method, 'attributes']);
     return false;

package/cjs/utils/lang/index.js

@@ -154,10 +154,12 @@ function isNaNNumber(val) {
 }
 exports.isNaNNumber = isNaNNumber;
 /**
- * Validates if a value is an object with the Object prototype (map object).
+ * Validates if a value is an object created by the Object constructor (plain object).
+ * It checks `constructor.name` to avoid false negatives when validating values on a separate VM context, which has its own global built-ins.
  */
 function isObject(obj) {
-    return obj !== null && typeof obj === 'object' && obj.constructor === Object;
+    return obj !== null && typeof obj === 'object' && (obj.constructor === Object ||
+        (obj.constructor != null && obj.constructor.name === 'Object'));
 }
 exports.isObject = isObject;
 /**

package/cjs/utils/lang/maps.js

@@ -24,7 +24,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 **/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._Map = exports.MapPoly = void 0;
+exports._Map = exports.__getMapConstructor = exports.MapPoly = void 0;
 var MapPoly = /** @class */ (function () {
     // unlike ES6 `Map`, it only accepts an array as first argument iterable
     function MapPoly(entries) {
@@ -71,4 +71,18 @@ var MapPoly = /** @class */ (function () {
     return MapPoly;
 }());
 exports.MapPoly = MapPoly;
-exports._Map = typeof Map !== 'undefined' ? Map : MapPoly;
+/**
+ * return the Map constructor to use. If native Map is not available or it doesn't support the required features (e.g., IE11),
+ * a ponyfill with minimal features is returned instead.
+ *
+ * Exported for testing purposes only.
+ */
+function __getMapConstructor() {
+    // eslint-disable-next-line compat/compat
+    if (typeof Array.from === 'function' && typeof Map === 'function' && Map.prototype && Map.prototype.values) {
+        return Map;
+    }
+    return MapPoly;
+}
+exports.__getMapConstructor = __getMapConstructor;
+exports._Map = __getMapConstructor();

package/cjs/utils/settingsValidation/index.js

@@ -6,6 +6,8 @@ var mode_1 = require("./mode");
 var splitFilters_1 = require("./splitFilters");
 var constants_1 = require("../constants");
 var impressionsMode_1 = require("./impressionsMode");
+var key_1 = require("../inputValidation/key");
+var trafficType_1 = require("../inputValidation/trafficType");
 var base = {
     // Define which kind of object you want to retrieve from SplitFactory
     mode: constants_1.STANDALONE_MODE,
@@ -109,9 +111,25 @@ function settingsValidation(config, validationParams) {
     // @ts-ignore, modify readonly prop
     if (storage)
         withDefaults.storage = storage(withDefaults);
-    // Although `key` is mandatory according to TS declaration files, it can be omitted in LOCALHOST mode. In that case, the value `localhost_key` is used.
-    if (withDefaults.mode === constants_1.LOCALHOST_MODE && withDefaults.core.key === undefined) {
-        withDefaults.core.key = 'localhost_key';
+    // Validate key and TT (for client-side)
+    if (validationParams.acceptKey) {
+        var maybeKey = withDefaults.core.key;
+        // Although `key` is required in client-side, it can be omitted in LOCALHOST mode. In that case, the value `localhost_key` is used.
+        if (withDefaults.mode === constants_1.LOCALHOST_MODE && maybeKey === undefined) {
+            withDefaults.core.key = 'localhost_key';
+        }
+        else {
+            // Keeping same behaviour than JS SDK: if settings key or TT are invalid,
+            // `false` value is used as binded key/TT of the default client, which leads to some issues.
+            // @ts-ignore, @TODO handle invalid keys as a non-recoverable error?
+            withDefaults.core.key = (0, key_1.validateKey)(log, maybeKey, 'Client instantiation');
+        }
+        if (validationParams.acceptTT) {
+            var maybeTT = withDefaults.core.trafficType;
+            if (maybeTT !== undefined) { // @ts-ignore
+                withDefaults.core.trafficType = (0, trafficType_1.validateTrafficType)(log, maybeTT, 'Client instantiation');
+            }
+        }
     }
     // Current ip/hostname information
     // @ts-ignore, modify readonly prop

package/esm/{utils/consent.js → consent/index.js}

@@ -1,4 +1,4 @@
-import { CONSENT_GRANTED } from './constants';
+import { CONSENT_GRANTED } from '../utils/constants';
 export function isConsentGranted(settings) {
     var userConsent = settings.userConsent;
     // undefined userConsent is handled as granted (default)