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

package/esm/consent/sdkUserConsent.js

@@ -0,0 +1,54 @@
+import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants';
+import { isConsentGranted } from './index';
+import { CONSENT_GRANTED, CONSENT_DECLINED, CONSENT_UNKNOWN } from '../utils/constants';
+import { isBoolean } from '../utils/lang';
+// User consent enum
+var ConsentStatus = {
+    GRANTED: CONSENT_GRANTED,
+    DECLINED: CONSENT_DECLINED,
+    UNKNOWN: CONSENT_UNKNOWN,
+};
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+export 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 (!isConsentGranted(settings))
+        log.info(USER_CONSENT_INITIAL, [settings.userConsent]);
+    return {
+        setStatus: function (consent) {
+            var _a, _b;
+            // validate input param
+            if (!isBoolean(consent)) {
+                log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']);
+                return false;
+            }
+            var newConsentStatus = consent ? CONSENT_GRANTED : CONSENT_DECLINED;
+            if (settings.userConsent !== newConsentStatus) {
+                log.info(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(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
+            }
+            return true;
+        },
+        getStatus: function () {
+            return settings.userConsent;
+        },
+        Status: ConsentStatus
+    };
+}

package/esm/listeners/browser.js

@@ -3,7 +3,7 @@ import { fromImpressionCountsCollector } from '../sync/submitters/impressionCoun
 import { OPTIMIZED, DEBUG } from '../utils/constants';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
-import { isConsentGranted } from '../utils/consent';
+import { isConsentGranted } from '../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/esm/logger/constants.js

@@ -69,6 +69,7 @@ export var EVENTS_TRACKER_SUCCESS = 120;
 export var IMPRESSIONS_TRACKER_SUCCESS = 121;
 export var USER_CONSENT_UPDATED = 122;
 export var USER_CONSENT_NOT_UPDATED = 123;
+export var USER_CONSENT_INITIAL = 124;
 export var ENGINE_VALUE_INVALID = 200;
 export var ENGINE_VALUE_NO_ATTRIBUTES = 201;
 export var CLIENT_NO_LISTENER = 202;

package/esm/logger/messages/info.js

@@ -14,6 +14,7 @@ export var codesInfo = 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/esm/sdkClient/client.js

@@ -4,7 +4,7 @@ import { getMatching, getBucketing } from '../utils/key';
 import { validateSplitExistance } from '../utils/inputValidation/splitExistance';
 import { validateTrafficTypeExistance } from '../utils/inputValidation/trafficTypeExistance';
 import { SDK_NOT_READY } from '../utils/labels';
-import { CONSENT_DECLINED, CONTROL } from '../utils/constants';
+import { CONTROL } from '../utils/constants';
 import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants';
 /**
  * Creator of base client with getTreatments and track methods.
@@ -18,8 +18,7 @@ export function clientFactory(params) {
         var wrapUp = function (evaluationResult) {
             var queue = [];
             var treatment = processEvaluation(evaluationResult, splitName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
-            if (settings.userConsent !== CONSENT_DECLINED)
-                impressionsTracker.track(queue, attributes);
+            impressionsTracker.track(queue, attributes);
             return treatment;
         };
         var evaluation = evaluateFeature(log, key, splitName, attributes, storage);
@@ -36,8 +35,7 @@ export 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 !== CONSENT_DECLINED)
-                impressionsTracker.track(queue, attributes);
+            impressionsTracker.track(queue, attributes);
             return treatments;
         };
         var evaluations = evaluateFeatures(log, key, splitNames, attributes, storage);
@@ -91,10 +89,7 @@ export 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.
         validateTrafficTypeExistance(log, readinessManager, storage.splits, mode, trafficTypeName, 'track');
-        if (settings.userConsent !== CONSENT_DECLINED)
-            return eventTracker.track(eventData, size);
-        else
-            return false;
+        return eventTracker.track(eventData, size);
     }
     return {
         getTreatment: getTreatment,
@@ -102,6 +97,6 @@ export function clientFactory(params) {
         getTreatments: getTreatments,
         getTreatmentsWithConfig: getTreatmentsWithConfig,
         track: track,
-        isBrowserClient: false
+        isClientSide: false
     };
 }

package/esm/sdkClient/clientCS.js

@@ -17,6 +17,6 @@ export 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
     });
 }

package/esm/sdkClient/clientInputValidation.js

@@ -2,12 +2,14 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { validateAttributes, validateEvent, validateEventValue, validateEventProperties, validateKey, validateSplit, validateSplits, validateTrafficType, validateIfNotDestroyed, validateIfOperational } from '../utils/inputValidation';
 import { startsWith } from '../utils/lang';
 import { CONTROL, CONTROL_WITH_CONFIG } from '../utils/constants';
+import { isStorageSync } from '../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.
  */
-export function clientInputValidationDecorator(log, client, readinessManager, isStorageSync) {
-    if (isStorageSync === void 0) { isStorageSync = false; }
+export function clientInputValidationDecorator(settings, client, readinessManager) {
+    var log = settings.log;
+    var isSync = isStorageSync(settings);
     /**
      * Avoid repeating this validations code
      */
@@ -27,9 +29,7 @@ export function clientInputValidationDecorator(log, client, readinessManager, is
         };
     }
     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');
@@ -84,9 +84,7 @@ export function clientInputValidationDecorator(log, client, readinessManager, is
             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/esm/sdkClient/sdkClient.js

@@ -1,20 +1,17 @@
 import { objectAssign } from '../utils/lang/objectAssign';
-import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE } from '../utils/constants';
 import { releaseApiKey } from '../utils/inputValidation/apiKey';
 import { clientFactory } from './client';
 import { clientInputValidationDecorator } from './clientInputValidation';
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-export function sdkClientFactory(params) {
-    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, sharedClient = params.sharedClient;
+export function sdkClientFactory(params, isSharedClient) {
+    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings;
     return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
     // Client API (getTreatment* & track methods)
-    clientInputValidationDecorator(settings.log, clientFactory(params), sdkReadinessManager.readinessManager, 
-    // storage is async if and only if mode is consumer or partial consumer
-    [CONSUMER_MODE, CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false), 
+    clientInputValidationDecorator(settings, clientFactory(params), sdkReadinessManager.readinessManager), 
     // Sdk destroy
     {
         destroy: function () {
@@ -26,7 +23,7 @@ export function sdkClientFactory(params) {
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();
                 // Release the API Key if it is the main client
-                if (!sharedClient)
+                if (!isSharedClient)
                     releaseApiKey(settings.core.authorizationKey);
                 // Cleanup storage
                 return storage.destroy();

package/esm/sdkClient/sdkClientMethodCS.js

@@ -16,12 +16,7 @@ var method = 'Client instantiation';
  */
 export 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 = validateKey(log, key, method);
-    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), // @ts-ignore
-    validKey);
+    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key);
     var parsedDefaultKey = keyParser(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey);
     // Cache instances created per factory.
@@ -59,9 +54,8 @@ export 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(NEW_SHARED_CLIENT);
         }

package/esm/sdkClient/sdkClientMethodCSWithTT.js

@@ -18,16 +18,7 @@ var method = 'Client instantiation';
  */
 export 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 = validateKey(log, key, method);
-    var validTrafficType;
-    if (trafficType !== undefined) {
-        validTrafficType = validateTrafficType(log, trafficType, method);
-    }
-    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), // @ts-ignore
-    validKey, validTrafficType);
+    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key, trafficType);
     var parsedDefaultKey = keyParser(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
     // Cache instances created per factory.
@@ -72,9 +63,8 @@ export 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(NEW_SHARED_CLIENT);
         }

package/esm/sdkFactory/index.js

@@ -13,7 +13,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
  * Modular SDK factory
  */
 export 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.
@@ -56,12 +56,13 @@ export function sdkFactory(params) {
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
     // trackers
     var observer = impressionsObserverFactory && impressionsObserverFactory();
-    var impressionsTracker = impressionsTrackerFactory(log, storage.impressions, settings, impressionListener, integrationsManager, observer, storage.impressionCounts);
-    var eventTracker = eventTrackerFactory(log, storage.events, integrationsManager);
+    var impressionsTracker = impressionsTrackerFactory(settings, storage.impressions, integrationsManager, observer, storage.impressionCounts);
+    var eventTracker = 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();
@@ -78,5 +79,5 @@ export function sdkFactory(params) {
         // Logger wrapper API
         Logger: createLoggerAPI(settings.log),
         settings: settings,
-    }, extraProps && extraProps(settings, syncManager));
+    }, extraProps && extraProps(ctx));
 }

package/esm/storages/inRedis/RedisAdapter.js

@@ -143,13 +143,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) {
+            merge(opts, { connectTimeout: options.connectionTimeout });
+        }
+        if (options.tls) {
+            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,
@@ -157,7 +163,8 @@ var RedisAdapter = /** @class */ (function (_super) {
             host: host,
             port: port,
             db: db,
-            pass: pass
+            pass: pass,
+            tls: tls
         };
         return merge({}, DEFAULT_OPTIONS, parsedOptions);
     };

package/esm/sync/syncManagerOnline.js

@@ -1,7 +1,7 @@
 import { submitterManagerFactory } from './submitters/submitterManager';
 import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
 import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
-import { isConsentGranted } from '../utils/consent';
+import { isConsentGranted } from '../consent';
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.

package/esm/trackers/eventTracker.js

@@ -1,13 +1,17 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { thenable } from '../utils/promise/thenable';
 import { EVENTS_TRACKER_SUCCESS, ERROR_EVENTS_TRACKER } from '../logger/constants';
+import { CONSENT_DECLINED } from '../utils/constants';
+import { isStorageSync } from './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
  */
-export function eventTrackerFactory(log, eventsCache, integrationsManager) {
+export function eventTrackerFactory(settings, eventsCache, integrationsManager) {
+    var log = settings.log;
+    var isSync = 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.
@@ -33,6 +37,9 @@ export function eventTrackerFactory(log, eventsCache, integrationsManager) {
     }
     return {
         track: function (eventData, size) {
+            if (settings.userConsent === CONSENT_DECLINED) {
+                return isSync ? false : Promise.resolve(false);
+            }
             var tracked = eventsCache.track(eventData, size);
             if (thenable(tracked)) {
                 return tracked.then(queueEventsCallback.bind(null, eventData));

package/esm/trackers/impressionObserver/utils.js

@@ -1,4 +1,4 @@
-import { CONSUMER_PARTIAL_MODE, OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../../utils/constants';
+import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '../../utils/constants';
 /**
  * Checks if impressions previous time should be added or not.
  */
@@ -13,3 +13,9 @@ export function shouldBeOptimized(settings) {
         return false;
     return settings.sync.impressionsMode === OPTIMIZED ? true : false;
 }
+/**
+ * Storage is async if mode is consumer or partial consumer
+ */
+export function isStorageSync(settings) {
+    return [CONSUMER_MODE, CONSUMER_PARTIAL_MODE].indexOf(settings.mode) === -1 ? true : false;
+}

package/esm/trackers/impressionsTracker.js

@@ -2,6 +2,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { thenable } from '../utils/promise/thenable';
 import { truncateTimeFrame } from '../utils/time';
 import { IMPRESSIONS_TRACKER_SUCCESS, ERROR_IMPRESSIONS_TRACKER, ERROR_IMPRESSIONS_LISTENER } from '../logger/constants';
+import { CONSENT_DECLINED } from '../utils/constants';
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
  *
@@ -12,16 +13,16 @@ import { IMPRESSIONS_TRACKER_SUCCESS, ERROR_IMPRESSIONS_TRACKER, ERROR_IMPRESSIO
  * @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)
  */
-export function impressionsTrackerFactory(log, impressionsCache, 
-// @TODO consider passing only an optional integrationsManager to handle impressions
-_a, impressionListener, integrationsManager, 
+export 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 === 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
@@ -65,7 +66,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/esm/utils/inputValidation/attributes.js

@@ -3,7 +3,7 @@ import { validateAttribute } from './attribute';
 import { ERROR_NOT_PLAIN_OBJECT } from '../../logger/constants';
 export function validateAttributes(log, maybeAttrs, method) {
     // Attributes are optional
-    if (isObject(maybeAttrs) || maybeAttrs == undefined) // eslint-disable-line eqeqeq
+    if (maybeAttrs == undefined || isObject(maybeAttrs)) // eslint-disable-line eqeqeq
         return maybeAttrs;
     log.error(ERROR_NOT_PLAIN_OBJECT, [method, 'attributes']);
     return false;

package/esm/utils/lang/index.js

@@ -141,10 +141,12 @@ export function isNaNNumber(val) {
     return val !== val;
 }
 /**
- * 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.
  */
 export 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'));
 }
 /**
  * Checks if a given value is a string.

package/esm/utils/lang/maps.js

@@ -68,4 +68,17 @@ var MapPoly = /** @class */ (function () {
     return MapPoly;
 }());
 export { MapPoly };
-export var _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.
+ */
+export 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;
+}
+export var _Map = __getMapConstructor();

package/esm/utils/settingsValidation/index.js

@@ -3,6 +3,8 @@ import { mode } from './mode';
 import { validateSplitFilters } from './splitFilters';
 import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE } from '../constants';
 import { validImpressionsMode } from './impressionsMode';
+import { validateKey } from '../inputValidation/key';
+import { validateTrafficType } from '../inputValidation/trafficType';
 var base = {
     // Define which kind of object you want to retrieve from SplitFactory
     mode: STANDALONE_MODE,
@@ -106,9 +108,25 @@ export 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 === 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 === 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 = validateKey(log, maybeKey, 'Client instantiation');
+        }
+        if (validationParams.acceptTT) {
+            var maybeTT = withDefaults.core.trafficType;
+            if (maybeTT !== undefined) { // @ts-ignore
+                withDefaults.core.trafficType = validateTrafficType(log, maybeTT, 'Client instantiation');
+            }
+        }
     }
     // Current ip/hostname information
     // @ts-ignore, modify readonly prop

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.2.1-rc.7",
+  "version": "1.3.0",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/{utils/consent.ts → consent/index.ts}

@@ -1,5 +1,5 @@
 import { ISettings } from '../types';
-import { CONSENT_GRANTED } from './constants';
+import { CONSENT_GRANTED } from '../utils/constants';
 
 export function isConsentGranted(settings: ISettings) {
   const userConsent = settings.userConsent;

package/src/consent/sdkUserConsent.ts

@@ -0,0 +1,58 @@
+import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants';
+import { isConsentGranted } from './index';
+import { CONSENT_GRANTED, CONSENT_DECLINED, CONSENT_UNKNOWN } from '../utils/constants';
+import { isBoolean } from '../utils/lang';
+import { ISdkFactoryContext } from '../sdkFactory/types';
+
+// User consent enum
+const ConsentStatus = {
+  GRANTED: CONSENT_GRANTED,
+  DECLINED: CONSENT_DECLINED,
+  UNKNOWN: CONSENT_UNKNOWN,
+};
+
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+export function createUserConsentAPI(params: ISdkFactoryContext) {
+  const { settings, settings: { log }, syncManager, storage: { events, impressions, impressionCounts } } = params;
+
+  if (!isConsentGranted(settings)) log.info(USER_CONSENT_INITIAL, [settings.userConsent]);
+
+  return {
+    setStatus(consent: unknown) {
+      // validate input param
+      if (!isBoolean(consent)) {
+        log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']);
+        return false;
+      }
+
+      const newConsentStatus = consent ? CONSENT_GRANTED : CONSENT_DECLINED;
+
+      if (settings.userConsent !== newConsentStatus) {
+        log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop
+        settings.userConsent = newConsentStatus;
+
+        if (consent) { // resumes submitters if transitioning to GRANTED
+          syncManager?.submitter?.start();
+        } else { // pauses submitters and drops tracked data if transitioning to DECLINED
+          syncManager?.submitter?.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(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
+      }
+
+      return true;
+    },
+
+    getStatus() {
+      return settings.userConsent;
+    },
+
+    Status: ConsentStatus
+  };
+}

package/src/evaluator/parser/index.ts

@@ -31,7 +31,7 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
       const matcher = matcherFactory(log, matcherDto, storage);
 
       // Evaluator function.
-      return (key: string, attributes: SplitIO.Attributes, splitEvaluator: ISplitEvaluator) => {
+      return (key: string, attributes: SplitIO.Attributes | undefined, splitEvaluator: ISplitEvaluator) => {
         const value = sanitizeValue(log, key, matcherDto, attributes);
         const result = value !== undefined && matcher ? matcher(value, splitEvaluator) : false;
 

package/src/evaluator/types.ts

@@ -6,7 +6,7 @@ import { ILogger } from '../logger/types';
 
 export interface IDependencyMatcherValue {
   key: SplitIO.SplitKey,
-  attributes: SplitIO.Attributes
+  attributes?: SplitIO.Attributes
 }
 
 export interface IMatcherDto {
@@ -27,7 +27,7 @@ export interface IEvaluation {
 
 export type IEvaluationResult = IEvaluation & { treatment: string }
 
-export type ISplitEvaluator = (log: ILogger, key: SplitIO.SplitKey, splitName: string, attributes: SplitIO.Attributes, storage: IStorageSync | IStorageAsync) => MaybeThenable<IEvaluation>
+export type ISplitEvaluator = (log: ILogger, key: SplitIO.SplitKey, splitName: string, attributes: SplitIO.Attributes | undefined, storage: IStorageSync | IStorageAsync) => MaybeThenable<IEvaluation>
 
 export type IEvaluator = (key: SplitIO.SplitKey, seed: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: ISplitEvaluator) => MaybeThenable<IEvaluation | undefined>