@splitsoftware/splitio-commons 1.10.0 → 1.10.1-rc.1

package/CHANGES.txt

@@ -1,3 +1,12 @@
+1.11.0 (November XX, 2023)
+  - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
+    - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
+      - getTreatmentsByFlagSet and getTreatmentsByFlagSets
+      - getTreatmentsWithConfigByFlagSets and getTreatmentsWithConfigByFlagSets
+    - Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
+      - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
+    - Added `sets` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager to expose flag sets on flag views.
+
 1.10.0 (October 20, 2023)
  - Added `defaultTreatment` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager (Related to issue https://github.com/splitio/javascript-commons/issues/225).
  - Updated log warning message to include the feature flag name when `getTreatment` method is called and the SDK client is not ready.

package/cjs/evaluator/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.evaluateFeatures = exports.evaluateFeature = void 0;
+exports.evaluateFeaturesByFlagSets = exports.evaluateFeatures = exports.evaluateFeature = void 0;
 var tslib_1 = require("tslib");
 var Engine_1 = require("./Engine");
 var thenable_1 = require("../utils/promise/thenable");
 var LabelsConstants = (0, tslib_1.__importStar)(require("../utils/labels"));
 var constants_1 = require("../utils/constants");
+var sets_1 = require("../utils/lang/sets");
 var treatmentException = {
     treatment: constants_1.CONTROL,
     label: LabelsConstants.EXCEPTION,
@@ -55,6 +56,22 @@ function evaluateFeatures(log, key, splitNames, attributes, storage) {
         getEvaluations(log, splitNames, parsedSplits, key, attributes, storage);
 }
 exports.evaluateFeatures = evaluateFeatures;
+function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage) {
+    var storedFlagNames;
+    // get features by flag sets
+    try {
+        storedFlagNames = storage.splits.getNamesByFlagSets(flagSets);
+    }
+    catch (e) {
+        // return empty evaluations
+        return {};
+    }
+    // evaluate related features
+    return (0, thenable_1.thenable)(storedFlagNames) ?
+        storedFlagNames.then(function (splitNames) { return evaluateFeatures(log, key, (0, sets_1.setToArray)(splitNames), attributes, storage); }) :
+        evaluateFeatures(log, key, (0, sets_1.setToArray)(storedFlagNames), attributes, storage);
+}
+exports.evaluateFeaturesByFlagSets = evaluateFeaturesByFlagSets;
 function getEvaluation(log, splitJSON, key, attributes, storage) {
     var evaluation = {
         treatment: constants_1.CONTROL,

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_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_SPLIT_UPDATE = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_SDK_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_UNIQUE_KEYS_TRACKER = 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_MIN_CONFIG_PARAM = 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 = exports.ERROR_EVENT_TYPE_FORMAT = void 0;
+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.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_SPLITS_FILTER_LOWERCASE_SET = exports.WARN_SPLITS_FILTER_INVALID_SET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = 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_UNIQUE_KEYS_TRACKER = 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_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = 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 = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = 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.
@@ -94,12 +94,14 @@ exports.WARN_NOT_EXISTENT_SPLIT = 215;
 exports.WARN_LOWERCASE_TRAFFIC_TYPE = 216;
 exports.WARN_NOT_EXISTENT_TT = 217;
 exports.WARN_INTEGRATION_INVALID = 218;
-exports.WARN_SPLITS_FILTER_IGNORED = 219;
 exports.WARN_SPLITS_FILTER_INVALID = 220;
 exports.WARN_SPLITS_FILTER_EMPTY = 221;
 exports.WARN_SDK_KEY = 222;
 exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 exports.STREAMING_PARSING_SPLIT_UPDATE = 224;
+exports.WARN_SPLITS_FILTER_INVALID_SET = 225;
+exports.WARN_SPLITS_FILTER_LOWERCASE_SET = 226;
+exports.WARN_FLAGSET_NOT_CONFIGURED = 227;
 exports.ERROR_ENGINE_COMBINER_IFELSEIF = 300;
 exports.ERROR_LOGLEVEL_INVALID = 301;
 exports.ERROR_CLIENT_LISTENER = 302;
@@ -127,6 +129,8 @@ exports.ERROR_LOCALHOST_MODULE_REQUIRED = 323;
 exports.ERROR_STORAGE_INVALID = 324;
 exports.ERROR_NOT_BOOLEAN = 325;
 exports.ERROR_MIN_CONFIG_PARAM = 326;
+exports.ERROR_TOO_MANY_SETS = 327;
+exports.ERROR_SETS_FILTER_EXCLUSIVE = 328;
 // 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

@@ -37,4 +37,6 @@ exports.codesError = [
     [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 Falling back into default MEMORY storage'],
     [c.ERROR_MIN_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': the provided "%s" config param is lower than allowed. Setting to the minimum value %s seconds'],
+    [c.ERROR_TOO_MANY_SETS, c.LOG_PREFIX_SETTINGS + ': the amount of flag sets provided are big causing uri length error.'],
+    [c.ERROR_SETS_FILTER_EXCLUSIVE, c.LOG_PREFIX_SETTINGS + ': the Set filter is exclusive and cannot be used simultaneously with names or prefix filters. Ignoring names and prefixes.'],
 ];

package/cjs/logger/messages/warn.js

@@ -27,12 +27,14 @@ exports.codesWarn = error_1.codesError.concat([
     [c.WARN_NOT_EXISTENT_SPLIT, '%s: feature flag "%s" does not exist in this environment. Please double check what feature flags exist in the Split user interface.'],
     [c.WARN_LOWERCASE_TRAFFIC_TYPE, '%s: traffic_type_name should be all lowercase - converting string to lowercase.'],
     [c.WARN_NOT_EXISTENT_TT, '%s: traffic type "%s" does not have any corresponding feature flag in this environment, make sure you\'re tracking your events to a valid traffic type defined in the Split user interface.'],
+    [c.WARN_FLAGSET_NOT_CONFIGURED, '%s: : you passed %s wich is not part of the configured FlagSetsFilter, ignoring Flag Set.'],
     // initialization / settings validation
     [c.WARN_INTEGRATION_INVALID, c.LOG_PREFIX_SETTINGS + ': %s integration item(s) at settings is invalid. %s'],
-    [c.WARN_SPLITS_FILTER_IGNORED, c.LOG_PREFIX_SETTINGS + ': feature flag filters have been configured but will have no effect if mode is not "%s", since synchronization is being deferred to an external tool.'],
-    [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': feature flag filter at position %s is invalid. It must be an object with a valid filter type ("byName" or "byPrefix") and a list of "values".'],
+    [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': feature flag filter at position %s is invalid. It must be an object with a valid filter type ("bySet", "byName" or "byPrefix") and a list of "values".'],
     [c.WARN_SPLITS_FILTER_EMPTY, c.LOG_PREFIX_SETTINGS + ': feature flag filter configuration must be a non-empty array of filter objects.'],
     [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
     [c.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching MySegments due to an error processing %s notification: %s'],
     [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing SPLIT_UPDATE notification: %s'],
+    [c.WARN_SPLITS_FILTER_INVALID_SET, c.LOG_PREFIX_SETTINGS + ': you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
+    [c.WARN_SPLITS_FILTER_LOWERCASE_SET, c.LOG_PREFIX_SETTINGS + ': flag set %s should be all lowercase - converting string to lowercase.'],
 ]);

package/cjs/sdkClient/client.js

@@ -67,6 +67,35 @@ function clientFactory(params) {
     function getTreatmentsWithConfig(key, featureFlagNames, attributes) {
         return getTreatments(key, featureFlagNames, attributes, true);
     }
+    function getTreatmentsByFlagSets(key, flagSetNames, attributes, withConfig, method) {
+        if (withConfig === void 0) { withConfig = false; }
+        if (method === void 0) { method = constants_1.TREATMENTS_BY_FLAGSETS; }
+        var stopTelemetryTracker = telemetryTracker.trackEval(method);
+        var wrapUp = function (evaluationResults) {
+            var queue = [];
+            var treatments = {};
+            var evaluations = evaluationResults;
+            Object.keys(evaluations).forEach(function (featureFlagName) {
+                treatments[featureFlagName] = processEvaluation(evaluations[featureFlagName], featureFlagName, key, attributes, withConfig, "getTreatmentsByFlagSets" + (withConfig ? 'WithConfig' : ''), queue);
+            });
+            impressionsTracker.track(queue, attributes);
+            stopTelemetryTracker(queue[0] && queue[0].label);
+            return treatments;
+        };
+        var evaluations = readinessManager.isReady() || readinessManager.isReadyFromCache() ?
+            (0, evaluator_1.evaluateFeaturesByFlagSets)(log, key, flagSetNames, attributes, storage) :
+            (0, utils_1.isStorageSync)(settings) ? {} : Promise.resolve({}); // Promisify if async
+        return (0, thenable_1.thenable)(evaluations) ? evaluations.then(function (res) { return wrapUp(res); }) : wrapUp(evaluations);
+    }
+    function getTreatmentsWithConfigByFlagSets(key, flagSetNames, attributes) {
+        return getTreatmentsByFlagSets(key, flagSetNames, attributes, true, constants_1.TREATMENTS_WITH_CONFIG_BY_FLAGSETS);
+    }
+    function getTreatmentsByFlagSet(key, flagSetName, attributes) {
+        return getTreatmentsByFlagSets(key, [flagSetName], attributes, false, constants_1.TREATMENTS_BY_FLAGSET);
+    }
+    function getTreatmentsWithConfigByFlagSet(key, flagSetName, attributes) {
+        return getTreatmentsByFlagSets(key, [flagSetName], attributes, true, constants_1.TREATMENTS_WITH_CONFIG_BY_FLAGSET);
+    }
     // Internal function
     function processEvaluation(evaluation, featureFlagName, key, attributes, withConfig, invokingMethodName, queue) {
         var matchingKey = (0, key_1.getMatching)(key);
@@ -125,6 +154,10 @@ function clientFactory(params) {
         getTreatmentWithConfig: getTreatmentWithConfig,
         getTreatments: getTreatments,
         getTreatmentsWithConfig: getTreatmentsWithConfig,
+        getTreatmentsByFlagSets: getTreatmentsByFlagSets,
+        getTreatmentsWithConfigByFlagSets: getTreatmentsWithConfigByFlagSets,
+        getTreatmentsByFlagSet: getTreatmentsByFlagSet,
+        getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
         track: track,
         isClientSide: false
     };

package/cjs/sdkClient/clientAttributesDecoration.js

@@ -14,6 +14,10 @@ function clientAttributesDecoration(log, client) {
     var clientGetTreatmentWithConfig = client.getTreatmentWithConfig;
     var clientGetTreatments = client.getTreatments;
     var clientGetTreatmentsWithConfig = client.getTreatmentsWithConfig;
+    var clientGetTreatmentsByFlagSets = client.getTreatmentsByFlagSets;
+    var clientGetTreatmentsWithConfigByFlagSets = client.getTreatmentsWithConfigByFlagSets;
+    var clientGetTreatmentsByFlagSet = client.getTreatmentsByFlagSet;
+    var clientGetTreatmentsWithConfigByFlagSet = client.getTreatmentsWithConfigByFlagSet;
     var clientTrack = client.track;
     function getTreatment(maybeKey, maybeFeatureFlagName, maybeAttributes) {
         return clientGetTreatment(maybeKey, maybeFeatureFlagName, combineAttributes(maybeAttributes));
@@ -27,6 +31,18 @@ function clientAttributesDecoration(log, client) {
     function getTreatmentsWithConfig(maybeKey, maybeFeatureFlagNames, maybeAttributes) {
         return clientGetTreatmentsWithConfig(maybeKey, maybeFeatureFlagNames, combineAttributes(maybeAttributes));
     }
+    function getTreatmentsByFlagSets(maybeKey, maybeFlagSets, maybeAttributes) {
+        return clientGetTreatmentsByFlagSets(maybeKey, maybeFlagSets, combineAttributes(maybeAttributes));
+    }
+    function getTreatmentsWithConfigByFlagSets(maybeKey, maybeFlagSets, maybeAttributes) {
+        return clientGetTreatmentsWithConfigByFlagSets(maybeKey, maybeFlagSets, combineAttributes(maybeAttributes));
+    }
+    function getTreatmentsByFlagSet(maybeKey, maybeFlagSet, maybeAttributes) {
+        return clientGetTreatmentsByFlagSet(maybeKey, maybeFlagSet, combineAttributes(maybeAttributes));
+    }
+    function getTreatmentsWithConfigByFlagSet(maybeKey, maybeFlagSet, maybeAttributes) {
+        return clientGetTreatmentsWithConfigByFlagSet(maybeKey, maybeFlagSet, combineAttributes(maybeAttributes));
+    }
     function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
         return clientTrack(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties);
     }
@@ -42,6 +58,10 @@ function clientAttributesDecoration(log, client) {
         getTreatmentWithConfig: getTreatmentWithConfig,
         getTreatments: getTreatments,
         getTreatmentsWithConfig: getTreatmentsWithConfig,
+        getTreatmentsByFlagSets: getTreatmentsByFlagSets,
+        getTreatmentsWithConfigByFlagSets: getTreatmentsWithConfigByFlagSets,
+        getTreatmentsByFlagSet: getTreatmentsByFlagSet,
+        getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
         track: track,
         /**
          * Add an attribute to client's in memory attributes storage

package/cjs/sdkClient/clientCS.js

@@ -18,6 +18,10 @@ function clientCSDecorator(log, client, key, trafficType) {
         getTreatmentWithConfig: clientCS.getTreatmentWithConfig.bind(clientCS, key),
         getTreatments: clientCS.getTreatments.bind(clientCS, key),
         getTreatmentsWithConfig: clientCS.getTreatmentsWithConfig.bind(clientCS, key),
+        getTreatmentsByFlagSets: clientCS.getTreatmentsByFlagSets.bind(clientCS, key),
+        getTreatmentsWithConfigByFlagSets: clientCS.getTreatmentsWithConfigByFlagSets.bind(clientCS, key),
+        getTreatmentsByFlagSet: clientCS.getTreatmentsByFlagSet.bind(clientCS, key),
+        getTreatmentsWithConfigByFlagSet: clientCS.getTreatmentsWithConfigByFlagSet.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),
         // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)

package/cjs/sdkClient/clientInputValidation.js

@@ -6,6 +6,7 @@ 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");
+var splitFilters_1 = require("../utils/settingsValidation/splitFilters");
 /**
  * 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.
@@ -16,18 +17,26 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
     /**
      * Avoid repeating this validations code
      */
-    function validateEvaluationParams(maybeKey, maybeFeatureFlagNameOrNames, maybeAttributes, methodName) {
+    function validateEvaluationParams(maybeKey, maybeFeatureFlagNameOrNames, maybeAttributes, methodName, maybeFlagSetNameOrNames) {
         var multi = (0, lang_1.startsWith)(methodName, 'getTreatments');
         var key = (0, inputValidation_1.validateKey)(log, maybeKey, methodName);
-        var splitOrSplits = multi ? (0, inputValidation_1.validateSplits)(log, maybeFeatureFlagNameOrNames, methodName) : (0, inputValidation_1.validateSplit)(log, maybeFeatureFlagNameOrNames, methodName);
+        var splitOrSplits = false;
+        var flagSetOrFlagSets = [];
+        if (maybeFeatureFlagNameOrNames) {
+            splitOrSplits = multi ? (0, inputValidation_1.validateSplits)(log, maybeFeatureFlagNameOrNames, methodName) : (0, inputValidation_1.validateSplit)(log, maybeFeatureFlagNameOrNames, methodName);
+        }
         var attributes = (0, inputValidation_1.validateAttributes)(log, maybeAttributes, methodName);
         var isNotDestroyed = (0, inputValidation_1.validateIfNotDestroyed)(log, readinessManager, methodName);
+        if (maybeFlagSetNameOrNames) {
+            flagSetOrFlagSets = (0, splitFilters_1.flagSetsAreValid)(log, methodName, maybeFlagSetNameOrNames, settings.sync.__splitFiltersValidation.groupedFilters.bySet);
+        }
         (0, inputValidation_1.validateIfOperational)(log, readinessManager, methodName, splitOrSplits);
-        var valid = isNotDestroyed && key && splitOrSplits && attributes !== false;
+        var valid = isNotDestroyed && key && (splitOrSplits || flagSetOrFlagSets.length > 0) && attributes !== false;
         return {
             valid: valid,
             key: key,
             splitOrSplits: splitOrSplits,
+            flagSetOrFlagSets: flagSetOrFlagSets,
             attributes: attributes
         };
     }
@@ -76,6 +85,42 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
             return wrapResult(res_2);
         }
     }
+    function getTreatmentsByFlagSets(maybeKey, maybeFlagSets, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsByFlagSets', maybeFlagSets);
+        if (params.valid) {
+            return client.getTreatmentsByFlagSets(params.key, params.flagSetOrFlagSets, params.attributes);
+        }
+        else {
+            return wrapResult({});
+        }
+    }
+    function getTreatmentsWithConfigByFlagSets(maybeKey, maybeFlagSets, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsWithConfigByFlagSets', maybeFlagSets);
+        if (params.valid) {
+            return client.getTreatmentsWithConfigByFlagSets(params.key, params.flagSetOrFlagSets, params.attributes);
+        }
+        else {
+            return wrapResult({});
+        }
+    }
+    function getTreatmentsByFlagSet(maybeKey, maybeFlagSet, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsByFlagSet', [maybeFlagSet]);
+        if (params.valid) {
+            return client.getTreatmentsByFlagSet(params.key, params.flagSetOrFlagSets[0], params.attributes);
+        }
+        else {
+            return wrapResult({});
+        }
+    }
+    function getTreatmentsWithConfigByFlagSet(maybeKey, maybeFlagSet, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, undefined, maybeAttributes, 'getTreatmentsWithConfigByFlagSet', [maybeFlagSet]);
+        if (params.valid) {
+            return client.getTreatmentsWithConfigByFlagSet(params.key, params.flagSetOrFlagSets[0], params.attributes);
+        }
+        else {
+            return wrapResult({});
+        }
+    }
     function track(maybeKey, maybeTT, maybeEvent, maybeEventValue, maybeProperties) {
         var key = (0, inputValidation_1.validateKey)(log, maybeKey, 'track');
         var tt = (0, inputValidation_1.validateTrafficType)(log, maybeTT, 'track');
@@ -95,6 +140,10 @@ function clientInputValidationDecorator(settings, client, readinessManager) {
         getTreatmentWithConfig: getTreatmentWithConfig,
         getTreatments: getTreatments,
         getTreatmentsWithConfig: getTreatmentsWithConfig,
+        getTreatmentsByFlagSets: getTreatmentsByFlagSets,
+        getTreatmentsWithConfigByFlagSets: getTreatmentsWithConfigByFlagSets,
+        getTreatmentsByFlagSet: getTreatmentsByFlagSet,
+        getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
         track: track
     };
 }

package/cjs/sdkManager/index.js

@@ -28,6 +28,7 @@ function objectToView(splitObject) {
         changeNumber: splitObject.changeNumber || 0,
         treatments: collectTreatments(splitObject),
         configs: splitObject.configurations || {},
+        sets: splitObject.sets || [],
         defaultTreatment: splitObject.defaultTreatment
     };
 }

package/cjs/services/splitApi.js

@@ -4,6 +4,7 @@ exports.splitApiFactory = void 0;
 var splitHttpClient_1 = require("./splitHttpClient");
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("../utils/constants");
+var constants_2 = require("../logger/constants");
 var noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
 function userKeyToQueryParam(userKey) {
     return 'users=' + encodeURIComponent(userKey); // no need to check availability of `encodeURIComponent`, since it is a global highly supported.
@@ -40,7 +41,12 @@ function splitApiFactory(settings, platform, telemetryTracker) {
         },
         fetchSplitChanges: function (since, noCache, till) {
             var url = urls.sdk + "/splitChanges?since=" + since + (till ? '&till=' + till : '') + (filterQueryString || '');
-            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SPLITS));
+            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SPLITS))
+                .catch(function (err) {
+                if (err.statusCode === 414)
+                    settings.log.error(constants_2.ERROR_TOO_MANY_SETS);
+                throw err;
+            });
         },
         fetchSegmentChanges: function (since, segmentName, noCache, till) {
             var url = urls.sdk + "/segmentChanges/" + segmentName + "?since=" + since + (till ? '&till=' + till : '');

package/cjs/storages/KeyBuilder.js

@@ -16,6 +16,9 @@ var KeyBuilder = /** @class */ (function () {
     KeyBuilder.prototype.buildTrafficTypeKey = function (trafficType) {
         return this.prefix + ".trafficType." + trafficType;
     };
+    KeyBuilder.prototype.buildFlagSetKey = function (flagSet) {
+        return this.prefix + ".flagset." + flagSet;
+    };
     KeyBuilder.prototype.buildSplitKey = function (splitName) {
         return this.prefix + ".split." + splitName;
     };

package/cjs/storages/KeyBuilderSS.js

@@ -8,6 +8,10 @@ exports.METHOD_NAMES = {
     ts: 'treatments',
     tc: 'treatmentWithConfig',
     tcs: 'treatmentsWithConfig',
+    tf: 'treatmentsByFlagSet',
+    tfs: 'treatmentsByFlagSets',
+    tcf: 'treatmentsWithConfigByFlagSet',
+    tcfs: 'treatmentsWithConfigByFlagSets',
     tr: 'track'
 };
 var KeyBuilderSS = /** @class */ (function (_super) {

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -5,6 +5,7 @@ var tslib_1 = require("tslib");
 var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
+var sets_1 = require("../../utils/lang/sets");
 /**
  * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
  */
@@ -16,12 +17,12 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * @param {ISplitFiltersValidation} splitFiltersValidation
      */
     function SplitsCacheInLocal(log, keys, expirationTimestamp, splitFiltersValidation) {
-        if (splitFiltersValidation === void 0) { splitFiltersValidation = { queryString: null, groupedFilters: { byName: [], byPrefix: [] }, validFilters: [] }; }
+        if (splitFiltersValidation === void 0) { splitFiltersValidation = { queryString: null, groupedFilters: { bySet: [], byName: [], byPrefix: [] }, validFilters: [] }; }
         var _this = _super.call(this) || this;
         _this.log = log;
-        _this.cacheReadyButNeedsToFlush = false;
         _this.keys = keys;
         _this.splitFiltersValidation = splitFiltersValidation;
+        _this.flagSetsFilter = _this.splitFiltersValidation.groupedFilters.bySet;
         _this._checkExpiration(expirationTimestamp);
         _this._checkFilterQuery();
         return _this;
@@ -94,6 +95,9 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             localStorage.setItem(splitKey, JSON.stringify(split));
             this._incrementCounts(split);
             this._decrementCounts(previousSplit);
+            if (previousSplit)
+                this.removeFromFlagSets(previousSplit.name, previousSplit.sets);
+            this.addToFlagSets(split);
             return true;
         }
         catch (e) {
@@ -106,6 +110,8 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             var split = this.getSplit(name);
             localStorage.removeItem(this.keys.buildSplitKey(name));
             this._decrementCounts(split);
+            if (split)
+                this.removeFromFlagSets(split.name, split.sets);
             return true;
         }
         catch (e) {
@@ -118,11 +124,6 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return item && JSON.parse(item);
     };
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
-        // when cache is ready but using a new split query, we must clear all split data
-        if (this.cacheReadyButNeedsToFlush) {
-            this.clear();
-            this.cacheReadyButNeedsToFlush = false;
-        }
         // when using a new split query, we must update it at the store
         if (this.updateNewFilter) {
             this.log.info(constants_1.LOG_PREFIX + 'Split filter query was modified. Updating cache.');
@@ -195,7 +196,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * @override
      */
     SplitsCacheInLocal.prototype.checkCache = function () {
-        return this.getChangeNumber() > -1 || this.cacheReadyButNeedsToFlush;
+        return this.getChangeNumber() > -1;
     };
     /**
      * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
@@ -211,31 +212,16 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         }
     };
     SplitsCacheInLocal.prototype._checkFilterQuery = function () {
-        var _this = this;
-        var _a = this.splitFiltersValidation, queryString = _a.queryString, groupedFilters = _a.groupedFilters;
+        var queryString = this.splitFiltersValidation.queryString;
         var queryKey = this.keys.buildSplitsFilterQueryKey();
         var currentQueryString = localStorage.getItem(queryKey);
         if (currentQueryString !== queryString) {
             try {
                 // mark cache to update the new query filter on first successful splits fetch
                 this.updateNewFilter = true;
-                // if cache is ready:
-                if (this.checkCache()) {
-                    // * set change number to -1, to fetch splits with -1 `since` value.
-                    localStorage.setItem(this.keys.buildSplitsTillKey(), '-1');
-                    // * remove from cache splits that doesn't match with the new filters
-                    this.getSplitNames().forEach(function (splitName) {
-                        if (queryString && (
-                        // @TODO consider redefining `groupedFilters` to expose a method like `groupedFilters::filter(splitName): boolean`
-                        groupedFilters.byName.indexOf(splitName) > -1 ||
-                            groupedFilters.byPrefix.some(function (prefix) { return splitName.startsWith(prefix + '__'); }))) {
-                            // * set `cacheReadyButNeedsToFlush` so that `checkCache` returns true (the storage is ready to be used) and the data is cleared before updating on first successful splits fetch
-                            _this.cacheReadyButNeedsToFlush = true;
-                            return;
-                        }
-                        _this.removeSplit(splitName);
-                    });
-                }
+                // if there is cache, clear it
+                if (this.checkCache())
+                    this.clear();
             }
             catch (e) {
                 this.log.error(constants_1.LOG_PREFIX + e);
@@ -243,6 +229,56 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         }
         // if the filter didn't change, nothing is done
     };
+    SplitsCacheInLocal.prototype.getNamesByFlagSets = function (flagSets) {
+        var _this = this;
+        var toReturn = new sets_1._Set([]);
+        flagSets.forEach(function (flagSet) {
+            var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
+            var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
+            if (flagSetFromLocalStorage) {
+                var flagSetCache = new sets_1._Set(JSON.parse(flagSetFromLocalStorage));
+                toReturn = (0, sets_1.returnSetsUnion)(toReturn, flagSetCache);
+            }
+        });
+        return toReturn;
+    };
+    SplitsCacheInLocal.prototype.addToFlagSets = function (featureFlag) {
+        var _this = this;
+        if (!featureFlag.sets)
+            return;
+        featureFlag.sets.forEach(function (featureFlagSet) {
+            if (_this.flagSetsFilter.length > 0 && !_this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === featureFlagSet; }))
+                return;
+            var flagSetKey = _this.keys.buildFlagSetKey(featureFlagSet);
+            var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
+            if (!flagSetFromLocalStorage)
+                flagSetFromLocalStorage = '[]';
+            var flagSetCache = new sets_1._Set(JSON.parse(flagSetFromLocalStorage));
+            flagSetCache.add(featureFlag.name);
+            localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+        });
+    };
+    SplitsCacheInLocal.prototype.removeFromFlagSets = function (featureFlagName, flagSets) {
+        var _this = this;
+        if (!flagSets)
+            return;
+        flagSets.forEach(function (flagSet) {
+            _this.removeNames(flagSet, featureFlagName);
+        });
+    };
+    SplitsCacheInLocal.prototype.removeNames = function (flagSetName, featureFlagName) {
+        var flagSetKey = this.keys.buildFlagSetKey(flagSetName);
+        var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
+        if (!flagSetFromLocalStorage)
+            return;
+        var flagSetCache = new sets_1._Set(JSON.parse(flagSetFromLocalStorage));
+        flagSetCache.delete(featureFlagName);
+        if (flagSetCache.size === 0) {
+            localStorage.removeItem(flagSetKey);
+            return;
+        }
+        localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+    };
     return SplitsCacheInLocal;
 }(AbstractSplitsCacheSync_1.AbstractSplitsCacheSync));
 exports.SplitsCacheInLocal = SplitsCacheInLocal;

package/cjs/storages/inLocalStorage/index.js

@@ -46,7 +46,7 @@ function InLocalStorage(options) {
             uniqueKeys: impressionsMode === constants_2.NONE ? new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS() : undefined,
             destroy: function () {
                 var _a;
-                this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
+                this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
                 this.segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
                 this.impressions.clear();
                 this.impressionCounts && this.impressionCounts.clear();
@@ -64,7 +64,7 @@ function InLocalStorage(options) {
                     events: this.events,
                     telemetry: this.telemetry,
                     destroy: function () {
-                        this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
+                        this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
                         this.segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
                     }
                 };

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -15,8 +15,8 @@ var UniqueKeysCacheInMemory_1 = require("./UniqueKeysCacheInMemory");
  * @param params parameters required by EventsCacheSync
  */
 function InMemoryStorageFactory(params) {
-    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, impressionsMode = _a.sync.impressionsMode;
-    var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
+    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
+    var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
     var segments = new SegmentsCacheInMemory_1.SegmentsCacheInMemory();
     var storage = {
         splits: splits,

package/cjs/storages/inMemory/InMemoryStorageCS.js

@@ -15,8 +15,8 @@ var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
  * @param params parameters required by EventsCacheSync
  */
 function InMemoryStorageCSFactory(params) {
-    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, impressionsMode = _a.sync.impressionsMode;
-    var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
+    var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;
+    var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
     var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
     var storage = {
         splits: splits,
@@ -46,7 +46,7 @@ function InMemoryStorageCSFactory(params) {
                 telemetry: this.telemetry,
                 // Set a new splits cache to clean it for the client without affecting other clients
                 destroy: function () {
-                    this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
+                    this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
                     this.segments.clear();
                 }
             };