@splitsoftware/splitio-commons 1.2.1-rc.4 → 1.2.1-rc.5

package/cjs/listeners/browser.js

@@ -6,6 +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");
 // '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.';
@@ -51,15 +52,18 @@ var BrowserSignalListener = /** @class */ (function () {
     BrowserSignalListener.prototype.flushData = function () {
         if (!this.syncManager)
             return; // In consumer mode there is not sync manager and data to flush
-        var eventsUrl = this.settings.urls.events;
-        var extraMetadata = {
-            // sim stands for Sync/Split Impressions Mode
-            sim: this.settings.sync.impressionsMode === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : constants_1.DEBUG
-        };
-        this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
-        this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
-        if (this.storage.impressionCounts)
-            this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, impressionCountsSyncTask_1.fromImpressionCountsCollector);
+        // Flush data if there is user consent
+        if ((0, consent_1.isConsentGranted)(this.settings)) {
+            var eventsUrl = this.settings.urls.events;
+            var extraMetadata = {
+                // sim stands for Sync/Split Impressions Mode
+                sim: this.settings.sync.impressionsMode === constants_1.OPTIMIZED ? constants_1.OPTIMIZED : constants_1.DEBUG
+            };
+            this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
+            this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
+            if (this.storage.impressionCounts)
+                this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, impressionCountsSyncTask_1.fromImpressionCountsCollector);
+        }
         // Close streaming connection
         if (this.syncManager.pushManager)
             this.syncManager.pushManager.stop();
@@ -69,7 +73,7 @@ var BrowserSignalListener = /** @class */ (function () {
         if (!cache.isEmpty()) {
             var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.state()) : cache.state();
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
-                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exceptions
+                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
             }
             cache.clear();
         }

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_FINITE = exports.ERROR_SIZE_EXCEEDED = 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.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_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = exports.ERROR_INVALID_IMPRESSIONS_MODE = 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 = void 0;
+exports.ERROR_SIZE_EXCEEDED = 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_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 = 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.
@@ -72,6 +72,7 @@ exports.SYNC_CONTINUE_POLLING = 118;
 exports.SYNC_STOP_POLLING = 119;
 exports.EVENTS_TRACKER_SUCCESS = 120;
 exports.IMPRESSIONS_TRACKER_SUCCESS = 121;
+exports.USER_CONSENT_UPDATED = 122;
 exports.ENGINE_VALUE_INVALID = 200;
 exports.ENGINE_VALUE_NO_ATTRIBUTES = 201;
 exports.CLIENT_NO_LISTENER = 202;
@@ -117,10 +118,11 @@ exports.ERROR_INVALID_KEY_OBJECT = 317;
 exports.ERROR_INVALID = 318;
 exports.ERROR_EMPTY = 319;
 exports.ERROR_EMPTY_ARRAY = 320;
-exports.ERROR_INVALID_IMPRESSIONS_MODE = 321;
+exports.ERROR_INVALID_CONFIG_PARAM = 321;
 exports.ERROR_HTTP = 322;
 exports.ERROR_LOCALHOST_MODULE_REQUIRED = 323;
 exports.ERROR_STORAGE_INVALID = 324;
+exports.ERROR_NOT_BOOLEAN = 325;
 // Log prefixes (a.k.a. tags or categories)
 exports.LOG_PREFIX_SETTINGS = 'settings';
 exports.LOG_PREFIX_INSTANTIATION = 'Factory instantiation';

package/cjs/logger/messages/error.js

@@ -31,8 +31,9 @@ exports.codesError = [
     [c.ERROR_INVALID, '%s: you passed an invalid %s. It must be a non-empty string.'],
     [c.ERROR_EMPTY, '%s: you passed an empty %s. It must be a non-empty string.'],
     [c.ERROR_EMPTY_ARRAY, '%s: %s must be a non-empty array.'],
+    [c.ERROR_NOT_BOOLEAN, '%s: you must provide a boolean param.'],
     // initialization / settings validation
-    [c.ERROR_INVALID_IMPRESSIONS_MODE, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "impressionsMode". It should be one of the following values: %s. Defaulting to "%s" mode.'],
+    [c.ERROR_INVALID_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "%s" config param. It should be one of the following values: %s. Defaulting to "%s".'],
     [c.ERROR_LOCALHOST_MODULE_REQUIRED, c.LOG_PREFIX_SETTINGS + ': an invalid value was received for "sync.localhostMode" config. A valid entity should be provided for localhost mode.'],
     [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS + ': The provided storage is invalid.%s Fallbacking into default MEMORY storage'],
 ];

package/cjs/logger/messages/info.js

@@ -16,6 +16,7 @@ exports.codesInfo = warn_1.codesWarn.concat([
     [c.NEW_FACTORY, ' New Split SDK instance created.'],
     [c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
     [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
+    [c.USER_CONSENT_UPDATED, 'User consent changed from %s to %s.'],
     // 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

@@ -14,13 +14,15 @@ var constants_2 = require("../logger/constants");
  */
 // @TODO missing time tracking to collect telemetry
 function clientFactory(params) {
-    var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, _a = params.settings, log = _a.log, mode = _a.mode, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker;
+    var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker;
+    var log = settings.log, mode = settings.mode;
     function getTreatment(key, splitName, attributes, withConfig) {
         if (withConfig === void 0) { withConfig = false; }
         var wrapUp = function (evaluationResult) {
             var queue = [];
             var treatment = processEvaluation(evaluationResult, splitName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
-            impressionsTracker.track(queue, attributes);
+            if (settings.userConsent !== constants_1.CONSENT_DECLINED)
+                impressionsTracker.track(queue, attributes);
             return treatment;
         };
         var evaluation = (0, evaluator_1.evaluateFeature)(log, key, splitName, attributes, storage);
@@ -37,7 +39,8 @@ function clientFactory(params) {
             Object.keys(evaluationResults).forEach(function (splitName) {
                 treatments[splitName] = processEvaluation(evaluationResults[splitName], splitName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''), queue);
             });
-            impressionsTracker.track(queue, attributes);
+            if (settings.userConsent !== constants_1.CONSENT_DECLINED)
+                impressionsTracker.track(queue, attributes);
             return treatments;
         };
         var evaluations = (0, evaluator_1.evaluateFeatures)(log, key, splitNames, attributes, storage);
@@ -91,7 +94,10 @@ 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');
-        return eventTracker.track(eventData, size);
+        if (settings.userConsent !== constants_1.CONSENT_DECLINED)
+            return eventTracker.track(eventData, size);
+        else
+            return false;
     }
     return {
         getTreatment: getTreatment,

package/cjs/sdkFactory/index.js

@@ -11,11 +11,12 @@ var sdkLogger_1 = require("../logger/sdkLogger");
 var constants_1 = require("../logger/constants");
 var metadataBuilder_1 = require("../storages/metadataBuilder");
 var constants_2 = require("../readiness/constants");
+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, 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, impressionListener = params.impressionListener, 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.
@@ -68,11 +69,11 @@ function sdkFactory(params) {
     syncManager && syncManager.start();
     signalListener && signalListener.start();
     log.info(constants_1.NEW_FACTORY);
-    return {
+    // @ts-ignore
+    return (0, objectAssign_1.objectAssign)({
         // Split evaluation and event tracking engine
         client: clientMethod,
         // Manager API to explore available information
-        // @ts-ignore
         manager: function () {
             log.debug(constants_1.RETRIEVE_MANAGER);
             return managerInstance;
@@ -80,6 +81,6 @@ function sdkFactory(params) {
         // Logger wrapper API
         Logger: (0, sdkLogger_1.createLoggerAPI)(settings.log),
         settings: settings,
-    };
+    }, extraProps && extraProps(settings, syncManager));
 }
 exports.sdkFactory = sdkFactory;

package/cjs/sdkFactory/userConsentProps.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userConsentProps = void 0;
+var constants_1 = require("../logger/constants");
+var constants_2 = require("../utils/constants");
+// Extend client-side factory instances with user consent getter/setter
+function userConsentProps(settings, syncManager) {
+    var log = settings.log;
+    return {
+        setUserConsent: function (consent) {
+            var _a, _b;
+            // validate input param
+            if (typeof consent !== 'boolean') {
+                log.error(constants_1.ERROR_NOT_BOOLEAN, ['setUserConsent']);
+                return false;
+            }
+            var newConsentStatus = consent ? constants_2.CONSENT_GRANTED : constants_2.CONSENT_DECLINED;
+            if (settings.userConsent !== newConsentStatus) {
+                // resume/pause submitters
+                if (consent)
+                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _a === void 0 ? void 0 : _a.start();
+                else
+                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _b === void 0 ? void 0 : _b.stop();
+                log.info(constants_1.USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop
+                settings.userConsent = newConsentStatus;
+            }
+            return true;
+        },
+        getUserConsent: function () {
+            return settings.userConsent;
+        }
+    };
+}
+exports.userConsentProps = userConsentProps;

package/cjs/storages/KeyBuilderCS.js

@@ -16,9 +16,19 @@ var KeyBuilderCS = /** @class */ (function (_super) {
      * @override
      */
     KeyBuilderCS.prototype.buildSegmentNameKey = function (segmentName) {
-        return this.matchingKey + "." + this.prefix + ".segment." + segmentName;
+        return this.prefix + "." + this.matchingKey + ".segment." + segmentName;
     };
     KeyBuilderCS.prototype.extractSegmentName = function (builtSegmentKeyName) {
+        var prefix = this.prefix + "." + this.matchingKey + ".segment.";
+        if ((0, lang_1.startsWith)(builtSegmentKeyName, prefix))
+            return builtSegmentKeyName.substr(prefix.length);
+    };
+    // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
+    KeyBuilderCS.prototype.buildOldSegmentNameKey = function (segmentName) {
+        return this.matchingKey + "." + this.prefix + ".segment." + segmentName;
+    };
+    // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
+    KeyBuilderCS.prototype.extractOldSegmentKey = function (builtSegmentKeyName) {
         var prefix = this.matchingKey + "." + this.prefix + ".segment.";
         if ((0, lang_1.startsWith)(builtSegmentKeyName, prefix))
             return builtSegmentKeyName.substr(prefix.length);

package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js

@@ -60,9 +60,29 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
         var index;
         // Scan current values from localStorage
         var storedSegmentNames = Object.keys(localStorage).reduce(function (accum, key) {
-            var name = _this.keys.extractSegmentName(key);
-            if (name)
-                accum.push(name);
+            var segmentName = _this.keys.extractSegmentName(key);
+            if (segmentName) {
+                accum.push(segmentName);
+            }
+            else {
+                // @BREAKING: This is only to clean up "old" keys. Remove this whole else code block.
+                segmentName = _this.keys.extractOldSegmentKey(key);
+                if (segmentName) { // this was an old segment key, let's clean up.
+                    var newSegmentKey = _this.keys.buildSegmentNameKey(segmentName);
+                    try {
+                        // If the new format key is not there, create it.
+                        if (!localStorage.getItem(newSegmentKey) && names.indexOf(segmentName) > -1) {
+                            localStorage.setItem(newSegmentKey, constants_1.DEFINED);
+                            // we are migrating a segment, let's track it.
+                            accum.push(segmentName);
+                        }
+                        localStorage.removeItem(key); // we migrated the current key, let's delete it.
+                    }
+                    catch (e) {
+                        _this.log.error(e);
+                    }
+                }
+            }
             return accum;
         }, []);
         // Extreme fast => everything is empty

package/cjs/sync/submitters/eventsSyncTask.js

@@ -25,8 +25,12 @@ function eventsSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate,
     }
     // register events submitter to be executed when events cache is full
     eventsCache.setOnFullQueueCb(function () {
-        log.info(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-        syncTask.execute();
+        if (syncTask.isRunning()) {
+            log.info(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            syncTask.execute();
+        }
+        // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
+        // Data will be sent when submitter is resumed.
     });
     return syncTask;
 }

package/cjs/sync/submitters/impressionsSyncTask.js

@@ -41,8 +41,12 @@ function impressionsSyncTaskFactory(log, postTestImpressionsBulk, impressionsCac
     var syncTask = (0, submitterSyncTask_1.submitterSyncTaskFactory)(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, DATA_NAME, latencyTracker, fromImpressionsCollector.bind(undefined, sendLabels), 1);
     // register impressions submitter to be executed when impressions cache is full
     impressionsCache.setOnFullQueueCb(function () {
-        log.info(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-        syncTask.execute();
+        if (syncTask.isRunning()) {
+            log.info(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            syncTask.execute();
+        }
+        // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
+        // Data will be sent when submitter is resumed.
     });
     return syncTask;
 }

package/cjs/sync/syncManagerOnline.js

@@ -4,6 +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");
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -17,7 +18,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
      * SyncManager factory for modular SDK
      */
     return function (params) {
-        var _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled;
+        var settings = params.settings, _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled;
         /** Polling Manager */
         var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
@@ -52,11 +53,16 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
         var running = false; // flag that indicates whether the syncManager has been started (true) or stopped (false)
         var startFirstTime = true; // flag to distinguish calling the `start` method for the first time, to support pausing and resuming the synchronization
         return {
+            // Exposed for fine-grained control of synchronization.
+            // E.g.: user consent, app state changes (Page hide, Foreground/Background, Online/Offline).
+            pollingManager: pollingManager,
             pushManager: pushManager,
+            submitter: submitter,
             /**
              * Method used to start the syncManager for the first time, or resume it after being stopped.
              */
             start: function () {
+                running = true;
                 // start syncing splits and segments
                 if (pollingManager) {
                     if (pushManager) {
@@ -72,29 +78,27 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
-                if (submitter)
+                if ((0, consent_1.isConsentGranted)(settings))
                     submitter.start();
-                running = true;
             },
             /**
              * Method used to stop/pause the syncManager.
              */
             stop: function () {
+                running = false;
                 // stop syncing
                 if (pushManager)
                     pushManager.stop();
                 if (pollingManager && pollingManager.isRunning())
                     pollingManager.stop();
                 // stop periodic data recording (events, impressions, telemetry).
-                if (submitter)
-                    submitter.stop();
-                running = false;
+                submitter.stop();
             },
             isRunning: function () {
                 return running;
             },
             flush: function () {
-                if (submitter)
+                if ((0, consent_1.isConsentGranted)(settings))
                     return submitter.execute();
                 else
                     return Promise.resolve();

package/cjs/utils/consent.js

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

package/cjs/utils/constants/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
+exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
 // Special treatments
 exports.CONTROL = 'control';
 exports.CONTROL_WITH_CONFIG = {
@@ -27,3 +27,7 @@ exports.STORAGE_MEMORY = 'MEMORY';
 exports.STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 exports.STORAGE_REDIS = 'REDIS';
 exports.STORAGE_PLUGGABLE = 'PLUGGABLE';
+// User consent
+exports.CONSENT_GRANTED = 'GRANTED'; // The user has granted consent for tracking events and impressions
+exports.CONSENT_DECLINED = 'DECLINED'; // The user has declined consent for tracking events and impressions
+exports.CONSENT_UNKNOWN = 'UNKNOWN'; // The user has neither granted nor declined consent for tracking events and impressions

package/cjs/utils/settingsValidation/consent.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConsent = void 0;
+var constants_1 = require("../../logger/constants");
+var constants_2 = require("../constants");
+var userConsentValues = [constants_2.CONSENT_DECLINED, constants_2.CONSENT_GRANTED, constants_2.CONSENT_UNKNOWN];
+function validateConsent(_a) {
+    var userConsent = _a.userConsent, log = _a.log;
+    if (typeof userConsent === 'string')
+        userConsent = userConsent.toUpperCase();
+    if (userConsentValues.indexOf(userConsent) > -1)
+        return userConsent;
+    log.error(constants_1.ERROR_INVALID_CONFIG_PARAM, ['userConsent', userConsentValues, constants_2.CONSENT_GRANTED]);
+    return constants_2.CONSENT_GRANTED;
+}
+exports.validateConsent = validateConsent;

package/cjs/utils/settingsValidation/impressionsMode.js

@@ -4,11 +4,11 @@ exports.validImpressionsMode = void 0;
 var constants_1 = require("../../logger/constants");
 var constants_2 = require("../constants");
 function validImpressionsMode(log, impressionsMode) {
-    impressionsMode = impressionsMode.toUpperCase();
-    if ([constants_2.DEBUG, constants_2.OPTIMIZED].indexOf(impressionsMode) === -1) {
-        log.error(constants_1.ERROR_INVALID_IMPRESSIONS_MODE, [[constants_2.DEBUG, constants_2.OPTIMIZED], constants_2.OPTIMIZED]);
-        impressionsMode = constants_2.OPTIMIZED;
-    }
-    return impressionsMode;
+    if (typeof impressionsMode === 'string')
+        impressionsMode = impressionsMode.toUpperCase();
+    if ([constants_2.DEBUG, constants_2.OPTIMIZED].indexOf(impressionsMode) > -1)
+        return impressionsMode;
+    log.error(constants_1.ERROR_INVALID_CONFIG_PARAM, ['impressionsMode', [constants_2.DEBUG, constants_2.OPTIMIZED], constants_2.OPTIMIZED]);
+    return constants_2.OPTIMIZED;
 }
 exports.validImpressionsMode = validImpressionsMode;

package/cjs/utils/settingsValidation/index.js

@@ -83,7 +83,7 @@ function fromSecondsToMillis(n) {
  * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config
  */
 function settingsValidation(config, validationParams) {
-    var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost;
+    var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent;
     // creates a settings object merging base, defaults and config objects.
     var withDefaults = (0, lang_1.merge)({}, base, defaults, config);
     // ensure a valid logger.
@@ -136,6 +136,9 @@ function settingsValidation(config, validationParams) {
     withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
     // ensure a valid impressionsMode
     withDefaults.sync.impressionsMode = (0, impressionsMode_1.validImpressionsMode)(log, withDefaults.sync.impressionsMode);
+    // ensure a valid user consent value
+    // @ts-ignore, modify readonly prop
+    withDefaults.userConsent = consent(withDefaults);
     return withDefaults;
 }
 exports.settingsValidation = settingsValidation;

package/esm/listeners/browser.js

@@ -3,6 +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';
 // '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.';
@@ -48,15 +49,18 @@ var BrowserSignalListener = /** @class */ (function () {
     BrowserSignalListener.prototype.flushData = function () {
         if (!this.syncManager)
             return; // In consumer mode there is not sync manager and data to flush
-        var eventsUrl = this.settings.urls.events;
-        var extraMetadata = {
-            // sim stands for Sync/Split Impressions Mode
-            sim: this.settings.sync.impressionsMode === OPTIMIZED ? OPTIMIZED : DEBUG
-        };
-        this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
-        this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
-        if (this.storage.impressionCounts)
-            this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
+        // Flush data if there is user consent
+        if (isConsentGranted(this.settings)) {
+            var eventsUrl = this.settings.urls.events;
+            var extraMetadata = {
+                // sim stands for Sync/Split Impressions Mode
+                sim: this.settings.sync.impressionsMode === OPTIMIZED ? OPTIMIZED : DEBUG
+            };
+            this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
+            this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
+            if (this.storage.impressionCounts)
+                this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
+        }
         // Close streaming connection
         if (this.syncManager.pushManager)
             this.syncManager.pushManager.stop();
@@ -66,7 +70,7 @@ var BrowserSignalListener = /** @class */ (function () {
         if (!cache.isEmpty()) {
             var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.state()) : cache.state();
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
-                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exceptions
+                postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
             }
             cache.clear();
         }

package/esm/logger/constants.js

@@ -67,6 +67,7 @@ export var SYNC_CONTINUE_POLLING = 118;
 export var SYNC_STOP_POLLING = 119;
 export var EVENTS_TRACKER_SUCCESS = 120;
 export var IMPRESSIONS_TRACKER_SUCCESS = 121;
+export var USER_CONSENT_UPDATED = 122;
 export var ENGINE_VALUE_INVALID = 200;
 export var ENGINE_VALUE_NO_ATTRIBUTES = 201;
 export var CLIENT_NO_LISTENER = 202;
@@ -112,10 +113,11 @@ export var ERROR_INVALID_KEY_OBJECT = 317;
 export var ERROR_INVALID = 318;
 export var ERROR_EMPTY = 319;
 export var ERROR_EMPTY_ARRAY = 320;
-export var ERROR_INVALID_IMPRESSIONS_MODE = 321;
+export var ERROR_INVALID_CONFIG_PARAM = 321;
 export var ERROR_HTTP = 322;
 export var ERROR_LOCALHOST_MODULE_REQUIRED = 323;
 export var ERROR_STORAGE_INVALID = 324;
+export var ERROR_NOT_BOOLEAN = 325;
 // Log prefixes (a.k.a. tags or categories)
 export var LOG_PREFIX_SETTINGS = 'settings';
 export var LOG_PREFIX_INSTANTIATION = 'Factory instantiation';

package/esm/logger/messages/error.js

@@ -27,8 +27,9 @@ export var codesError = [
     [c.ERROR_INVALID, '%s: you passed an invalid %s. It must be a non-empty string.'],
     [c.ERROR_EMPTY, '%s: you passed an empty %s. It must be a non-empty string.'],
     [c.ERROR_EMPTY_ARRAY, '%s: %s must be a non-empty array.'],
+    [c.ERROR_NOT_BOOLEAN, '%s: you must provide a boolean param.'],
     // initialization / settings validation
-    [c.ERROR_INVALID_IMPRESSIONS_MODE, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "impressionsMode". It should be one of the following values: %s. Defaulting to "%s" mode.'],
+    [c.ERROR_INVALID_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "%s" config param. It should be one of the following values: %s. Defaulting to "%s".'],
     [c.ERROR_LOCALHOST_MODULE_REQUIRED, c.LOG_PREFIX_SETTINGS + ': an invalid value was received for "sync.localhostMode" config. A valid entity should be provided for localhost mode.'],
     [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS + ': The provided storage is invalid.%s Fallbacking into default MEMORY storage'],
 ];

package/esm/logger/messages/info.js

@@ -12,6 +12,7 @@ export var codesInfo = codesWarn.concat([
     [c.NEW_FACTORY, ' New Split SDK instance created.'],
     [c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
     [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
+    [c.USER_CONSENT_UPDATED, 'User consent changed from %s to %s.'],
     // 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,20 +4,22 @@ 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 { CONTROL } from '../utils/constants';
+import { CONSENT_DECLINED, CONTROL } from '../utils/constants';
 import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants';
 /**
  * Creator of base client with getTreatments and track methods.
  */
 // @TODO missing time tracking to collect telemetry
 export function clientFactory(params) {
-    var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, _a = params.settings, log = _a.log, mode = _a.mode, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker;
+    var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker;
+    var log = settings.log, mode = settings.mode;
     function getTreatment(key, splitName, attributes, withConfig) {
         if (withConfig === void 0) { withConfig = false; }
         var wrapUp = function (evaluationResult) {
             var queue = [];
             var treatment = processEvaluation(evaluationResult, splitName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
-            impressionsTracker.track(queue, attributes);
+            if (settings.userConsent !== CONSENT_DECLINED)
+                impressionsTracker.track(queue, attributes);
             return treatment;
         };
         var evaluation = evaluateFeature(log, key, splitName, attributes, storage);
@@ -34,7 +36,8 @@ export function clientFactory(params) {
             Object.keys(evaluationResults).forEach(function (splitName) {
                 treatments[splitName] = processEvaluation(evaluationResults[splitName], splitName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''), queue);
             });
-            impressionsTracker.track(queue, attributes);
+            if (settings.userConsent !== CONSENT_DECLINED)
+                impressionsTracker.track(queue, attributes);
             return treatments;
         };
         var evaluations = evaluateFeatures(log, key, splitNames, attributes, storage);
@@ -88,7 +91,10 @@ 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');
-        return eventTracker.track(eventData, size);
+        if (settings.userConsent !== CONSENT_DECLINED)
+            return eventTracker.track(eventData, size);
+        else
+            return false;
     }
     return {
         getTreatment: getTreatment,