@splitsoftware/splitio-commons 2.1.1-rc.0 → 2.1.1-rc.2

package/types/splitio.d.ts

@@ -778,6 +778,15 @@ declare namespace SplitIO {
   type Properties = {
     [propertyName: string]: string | number | boolean | null;
   };
+  /**
+   * Evaluation options object for getTreatment methods.
+   */
+  type EvaluationOptions = {
+    /**
+     * Optional properties to append to the generated impression object sent to Split backend.
+     */
+    properties?: Properties;
+  }
   /**
    * The SplitKey object format.
    */
@@ -803,14 +812,42 @@ declare namespace SplitIO {
    * Impression DTO generated by the SDK when processing evaluations.
    */
   type ImpressionDTO = {
+    /**
+     * Feature flag name.
+     */
     feature: string;
+    /**
+     * Key.
+     */
     keyName: string;
+    /**
+     * Treatment value.
+     */
     treatment: string;
+    /**
+     * Impression timestamp.
+     */
     time: number;
+    /**
+     * Bucketing Key
+     */
     bucketingKey?: string;
+    /**
+     * Rule label
+     */
     label: string;
+    /**
+     * Version of the feature flag
+     */
     changeNumber: number;
+    /**
+     * Previous time
+     */
     pt?: number;
+    /**
+     * JSON stringified version of the impression properties.
+     */
+    properties?: string;
   }
   /**
    * Object with information about an impression. It contains the generated impression DTO as well as
@@ -910,6 +947,18 @@ declare namespace SplitIO {
      * @defaultValue `'SPLITIO'`
      */
     prefix?: string;
+    /**
+     * Number of days before cached data expires if it was not updated. If cache expires, it is cleared on initialization.
+     *
+     * @defaultValue `10`
+     */
+    expirationDays?: number;
+    /**
+     * Optional settings to clear the cache. If set to `true`, the SDK clears the cached data on initialization, unless the cache was cleared within the last 24 hours.
+     *
+     * @defaultValue `false`
+     */
+    clearOnInit?: boolean;
   }
   /**
    * Storage for asynchronous (consumer) SDK.
@@ -1233,11 +1282,23 @@ declare namespace SplitIO {
        */
       type?: BrowserStorage;
       /**
-       * Optional prefix to prevent any kind of data collision between SDK versions.
+       * Optional prefix to prevent any kind of data collision between SDK versions when using 'LOCALSTORAGE'.
        *
        * @defaultValue `'SPLITIO'`
        */
       prefix?: string;
+      /**
+       * Optional settings for the 'LOCALSTORAGE' storage type. It specifies the number of days before cached data expires if it was not updated. If cache expires, it is cleared on initialization.
+       *
+       * @defaultValue `10`
+       */
+      expirationDays?: number;
+      /**
+       * Optional settings for the 'LOCALSTORAGE' storage type. If set to `true`, the SDK clears the cached data on initialization, unless the cache was cleared within the last 24 hours.
+       *
+       * @defaultValue `false`
+       */
+      clearOnInit?: boolean;
     };
   }
   /**
@@ -1514,73 +1575,80 @@ declare namespace SplitIO {
      * @param key - The string key representing the consumer.
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The treatment string.
      */
-    getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes): Treatment;
+    getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): Treatment;
     /**
      * Returns a TreatmentWithConfig value, which is an object with both treatment and config string for the given feature.
      *
      * @param key - The string key representing the consumer.
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns The TreatmentWithConfig, the object containing the treatment string and the
-     *                                configuration stringified JSON (or null if there was no config for that treatment).
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
+     * @returns The TreatmentWithConfig object that contains the treatment string and the configuration stringified JSON (or null if there was no config for that treatment).
      */
-    getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes): TreatmentWithConfig;
+    getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentWithConfig;
     /**
      * Returns a Treatments value, which is an object map with the treatments for the given features.
      *
      * @param key - The string key representing the consumer.
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The treatments object map.
      */
-    getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): Treatments;
+    getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      *
      * @param key - The string key representing the consumer.
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): TreatmentsWithConfig;
+    getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
     /**
      * Returns a Treatments value, which is an object map with the treatments for the feature flags related to the given flag set.
      *
      * @param key - The string key representing the consumer.
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the Treatment objects
      */
-    getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes): Treatments;
+    getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): Treatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag set.
      *
      * @param key - The string key representing the consumer.
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfigByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes): TreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
     /**
      * Returns a Returns a Treatments value, which is an object with both treatment and config string for to the feature flags related to the given flag sets.
      *
      * @param key - The string key representing the consumer.
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the Treatment objects
      */
-    getTreatmentsByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes): Treatments;
+    getTreatmentsByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag sets.
      *
      * @param key - The string key representing the consumer.
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfigByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes): TreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
     /**
      * Tracks an event to be fed to the results product on Split user interface.
      *
@@ -1605,72 +1673,80 @@ declare namespace SplitIO {
      * @param key - The string key representing the consumer.
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatment promise that resolves to the treatment string.
      */
-    getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes): AsyncTreatment;
+    getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatment;
     /**
      * Returns a TreatmentWithConfig value, which will be (or eventually be) an object with both treatment and config string for the given feature.
      *
      * @param key - The string key representing the consumer.
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
      */
-    getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes): AsyncTreatmentWithConfig;
+    getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentWithConfig;
     /**
      * Returns a Treatments value, which will be (or eventually be) an object map with the treatments for the given features.
      *
      * @param key - The string key representing the consumer.
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatments promise that resolves to the treatments object map.
      */
-    getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): AsyncTreatments;
+    getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
     /**
      * Returns a TreatmentsWithConfig value, which will be (or eventually be) an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      *
      * @param key - The string key representing the consumer.
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
      */
-    getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): AsyncTreatmentsWithConfig;
+    getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
     /**
      * Returns a Treatments value, which is an object map with the treatments for the feature flags related to the given flag set.
      *
      * @param key - The string key representing the consumer.
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatments promise that resolves to the treatments object map.
      */
-    getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes): AsyncTreatments;
+    getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag set.
      *
      * @param key - The string key representing the consumer.
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
      */
-    getTreatmentsWithConfigByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes): AsyncTreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
     /**
      * Returns a Returns a Treatments value, which is an object with both treatment and config string for to the feature flags related to the given flag sets.
      *
      * @param key - The string key representing the consumer.
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatments promise that resolves to the treatments object map.
      */
-    getTreatmentsByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes): AsyncTreatments;
+    getTreatmentsByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag sets.
      *
      * @param key - The string key representing the consumer.
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
      */
-    getTreatmentsWithConfigByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes): AsyncTreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
     /**
      * Tracks an event to be fed to the results product on Split user interface, and returns a promise to signal when the event was successfully queued (or not).
      *
@@ -1735,65 +1811,73 @@ declare namespace SplitIO {
      *
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The treatment string.
      */
-    getTreatment(featureFlagName: string, attributes?: Attributes): Treatment;
+    getTreatment(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): Treatment;
     /**
      * Returns a TreatmentWithConfig value, which is an object with both treatment and config string for the given feature.
      *
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns The map containing the treatment and the configuration stringified JSON (or null if there was no config for that treatment).
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
+     * @returns The TreatmentWithConfig object that contains the treatment string and the configuration stringified JSON (or null if there was no config for that treatment).
      */
-    getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes): TreatmentWithConfig;
+    getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentWithConfig;
     /**
      * Returns a Treatments value, which is an object map with the treatments for the given features.
      *
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The treatments object map.
      */
-    getTreatments(featureFlagNames: string[], attributes?: Attributes): Treatments;
+    getTreatments(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      *
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes): TreatmentsWithConfig;
+    getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
     /**
      * Returns a Treatments value, which is an object map with the treatments for the feature flags related to the given flag set.
      *
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the Treatments objects
      */
-    getTreatmentsByFlagSet(flagSet: string, attributes?: Attributes): Treatments;
+    getTreatmentsByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): Treatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag set.
      *
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes): TreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
     /**
      * Returns a Returns a Treatments value, which is an object with both treatment and config string for to the feature flags related to the given flag sets.
      *
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the Treatments objects
      */
-    getTreatmentsByFlagSets(flagSets: string[], attributes?: Attributes): Treatments;
+    getTreatmentsByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag sets.
      *
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes): TreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
     /**
      * Tracks an event to be fed to the results product on Split user interface.
      *
@@ -1814,65 +1898,73 @@ declare namespace SplitIO {
      *
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatment promise that resolves to the treatment string.
      */
-    getTreatment(featureFlagName: string, attributes?: Attributes): AsyncTreatment;
+    getTreatment(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatment;
     /**
      * Returns a TreatmentWithConfig value, which will be (or eventually be) an object with both treatment and config string for the given feature.
      *
      * @param featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
      */
-    getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes): AsyncTreatmentWithConfig;
+    getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentWithConfig;
     /**
      * Returns a Treatments value, which will be (or eventually be) an object map with the treatments for the given features.
      *
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatments promise that resolves to the treatments object map.
      */
-    getTreatments(featureFlagNames: string[], attributes?: Attributes): AsyncTreatments;
+    getTreatments(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
     /**
      * Returns a TreatmentsWithConfig value, which will be (or eventually be) an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      *
      * @param featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
      */
-    getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes): AsyncTreatmentsWithConfig;
+    getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
     /**
      * Returns a Treatments value, which is an object map with the treatments for the feature flags related to the given flag set.
      *
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatments promise that resolves to the treatments object map.
      */
-    getTreatmentsByFlagSet(flagSet: string, attributes?: Attributes): AsyncTreatments;
+    getTreatmentsByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag set.
      *
      * @param flagSet - The flag set name we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
      */
-    getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes): AsyncTreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
     /**
      * Returns a Returns a Treatments value, which is an object with both treatment and config string for to the feature flags related to the given flag sets.
      *
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns Treatments promise that resolves to the treatments object map.
      */
-    getTreatmentsByFlagSets(flagSets: string[], attributes?: Attributes): AsyncTreatments;
+    getTreatmentsByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the feature flags related to the given flag sets.
      *
      * @param flagSets - An array of the flag set names we want to get the treatments.
      * @param attributes - An object of type Attributes defining the attributes for the given key.
+     * @param options - An object of type EvaluationOptions for advanced evaluation options.
      * @returns TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
      */
-    getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes): AsyncTreatmentsWithConfig;
+    getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
     /**
      * Tracks an event to be fed to the results product on Split user interface, and returns a promise to signal when the event was successfully queued (or not).
      *

package/cjs/evaluator/matchers/rbsegment.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ruleBasedSegmentMatcherContext = void 0;
-var thenable_1 = require("../../utils/promise/thenable");
-var key_1 = require("../../utils/key");
-var parser_1 = require("../parser");
-function ruleBasedSegmentMatcherContext(segmentName, storage, log) {
-    return function ruleBasedSegmentMatcher(_a, splitEvaluator) {
-        var key = _a.key, attributes = _a.attributes;
-        function matchConditions(rbsegment) {
-            var conditions = rbsegment.conditions;
-            var evaluator = (0, parser_1.parser)(log, conditions, storage);
-            var evaluation = evaluator((0, key_1.keyParser)(key), undefined, undefined, undefined, attributes, splitEvaluator);
-            return (0, thenable_1.thenable)(evaluation) ?
-                evaluation.then(function (evaluation) { return evaluation ? true : false; }) :
-                evaluation ? true : false;
-        }
-        function isExcluded(rbSegment) {
-            var matchingKey = (0, key_1.getMatching)(key);
-            if (rbSegment.excluded.keys.indexOf(matchingKey) !== -1)
-                return true;
-            var isInSegment = rbSegment.excluded.segments.map(function (segmentName) {
-                return storage.segments.isInSegment(segmentName, matchingKey);
-            });
-            return isInSegment.length && (0, thenable_1.thenable)(isInSegment[0]) ?
-                Promise.all(isInSegment).then(function (results) { return results.some(function (result) { return result; }); }) :
-                isInSegment.some(function (result) { return result; });
-        }
-        function isInSegment(rbSegment) {
-            if (!rbSegment)
-                return false;
-            var excluded = isExcluded(rbSegment);
-            return (0, thenable_1.thenable)(excluded) ?
-                excluded.then(function (excluded) { return excluded ? false : matchConditions(rbSegment); }) :
-                excluded ? false : matchConditions(rbSegment);
-        }
-        var rbSegment = storage.rbSegments.get(segmentName);
-        return (0, thenable_1.thenable)(rbSegment) ?
-            rbSegment.then(isInSegment) :
-            isInSegment(rbSegment);
-    };
-}
-exports.ruleBasedSegmentMatcherContext = ruleBasedSegmentMatcherContext;

package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js

@@ -1,117 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RBSegmentsCacheInLocal = void 0;
-var lang_1 = require("../../utils/lang");
-var sets_1 = require("../../utils/lang/sets");
-var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
-var constants_1 = require("./constants");
-var RBSegmentsCacheInLocal = /** @class */ (function () {
-    function RBSegmentsCacheInLocal(settings, keys) {
-        this.keys = keys;
-        this.log = settings.log;
-    }
-    RBSegmentsCacheInLocal.prototype.clear = function () {
-        var _this = this;
-        this.getNames().forEach(function (name) { return _this.remove(name); });
-        localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
-    };
-    RBSegmentsCacheInLocal.prototype.update = function (toAdd, toRemove, changeNumber) {
-        var _this = this;
-        this.setChangeNumber(changeNumber);
-        var updated = toAdd.map(function (toAdd) { return _this.add(toAdd); }).some(function (result) { return result; });
-        return toRemove.map(function (toRemove) { return _this.remove(toRemove.name); }).some(function (result) { return result; }) || updated;
-    };
-    RBSegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
-        try {
-            localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
-            localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
-        }
-        catch (e) {
-            this.log.error(constants_1.LOG_PREFIX + e);
-        }
-    };
-    RBSegmentsCacheInLocal.prototype.updateSegmentCount = function (diff) {
-        var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-        var count = (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + diff;
-        // @ts-expect-error
-        if (count > 0)
-            localStorage.setItem(segmentsCountKey, count);
-        else
-            localStorage.removeItem(segmentsCountKey);
-    };
-    RBSegmentsCacheInLocal.prototype.add = function (rbSegment) {
-        try {
-            var name_1 = rbSegment.name;
-            var rbSegmentKey = this.keys.buildRBSegmentKey(name_1);
-            var rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
-            var previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
-            localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
-            var usesSegmentsDiff = 0;
-            if (previous && (0, AbstractSplitsCacheSync_1.usesSegments)(previous))
-                usesSegmentsDiff--;
-            if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
-                usesSegmentsDiff++;
-            if (usesSegmentsDiff !== 0)
-                this.updateSegmentCount(usesSegmentsDiff);
-            return true;
-        }
-        catch (e) {
-            this.log.error(constants_1.LOG_PREFIX + e);
-            return false;
-        }
-    };
-    RBSegmentsCacheInLocal.prototype.remove = function (name) {
-        try {
-            var rbSegment = this.get(name);
-            if (!rbSegment)
-                return false;
-            localStorage.removeItem(this.keys.buildRBSegmentKey(name));
-            if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
-                this.updateSegmentCount(-1);
-            return true;
-        }
-        catch (e) {
-            this.log.error(constants_1.LOG_PREFIX + e);
-            return false;
-        }
-    };
-    RBSegmentsCacheInLocal.prototype.getNames = function () {
-        var len = localStorage.length;
-        var accum = [];
-        var cur = 0;
-        while (cur < len) {
-            var key = localStorage.key(cur);
-            if (key != null && this.keys.isRBSegmentKey(key))
-                accum.push(this.keys.extractKey(key));
-            cur++;
-        }
-        return accum;
-    };
-    RBSegmentsCacheInLocal.prototype.get = function (name) {
-        var item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
-        return item && JSON.parse(item);
-    };
-    RBSegmentsCacheInLocal.prototype.contains = function (names) {
-        var namesArray = (0, sets_1.setToArray)(names);
-        var namesInStorage = this.getNames();
-        return namesArray.every(function (name) { return namesInStorage.indexOf(name) !== -1; });
-    };
-    RBSegmentsCacheInLocal.prototype.getChangeNumber = function () {
-        var n = -1;
-        var value = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
-        if (value !== null) {
-            value = parseInt(value, 10);
-            return (0, lang_1.isNaNNumber)(value) ? n : value;
-        }
-        return n;
-    };
-    RBSegmentsCacheInLocal.prototype.usesSegments = function () {
-        var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
-        var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
-        return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
-            splitsWithSegmentsCount > 0 :
-            true;
-    };
-    return RBSegmentsCacheInLocal;
-}());
-exports.RBSegmentsCacheInLocal = RBSegmentsCacheInLocal;