@splitsoftware/splitio-browserjs 0.10.2-rc.2 → 0.11.1-rc.0

package/CHANGES.txt

@@ -1,4 +1,14 @@
-0.10.2 (October XX, 2023)
+0.12.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.
+  - Updated @splitsoftware/splitio-commons package to version 1.11.0.
+
+0.11.0 (October 31, 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 @splitsoftware/splitio-commons package to version 1.10.0 that includes vulnerability fixes, and adds the `defaultTreatment` property to the `SplitView` object.
 

package/cjs/settings/defaults.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaults = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/logger/index");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-var packageVersion = '0.10.2-rc.2';
+var packageVersion = '0.11.1-rc.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/esm/settings/defaults.js

@@ -1,6 +1,6 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/esm/logger/index';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/esm/utils/constants';
-var packageVersion = '0.10.2-rc.2';
+var packageVersion = '0.11.1-rc.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.10.2-rc.2",
+  "version": "0.11.1-rc.0",
   "description": "Split SDK for JavaScript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -64,7 +64,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.10.1-rc.0",
+    "@splitsoftware/splitio-commons": "1.10.1-rc.3",
     "@types/google.analytics": "0.0.40",
     "unfetch": "^4.2.0"
   },

package/src/settings/defaults.ts

@@ -2,7 +2,7 @@ import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/
 import { ConsentStatus, LogLevel } from '@splitsoftware/splitio-commons/src/types';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const packageVersion = '0.10.2-rc.2';
+const packageVersion = '0.11.1-rc.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/types/splitio.d.ts

@@ -499,6 +499,11 @@ declare namespace SplitIO {
     configs: {
       [treatmentName: string]: string
     },
+    /**
+     * List of sets of the feature flag.
+     * @property {string[]} sets
+     */
+    sets: string[],
     /**
      * The default treatment of the feature flag.
      * @property {string} defaultTreatment
@@ -801,7 +806,7 @@ declare namespace SplitIO {
    *
    * @typedef {string} SplitFilterType
    */
-  type SplitFilterType = 'byName' | 'byPrefix';
+  type SplitFilterType = 'bySet' | 'byName' | 'byPrefix';
   /**
    * Defines a feature flag filter, described by a type and list of values.
    */
@@ -1228,7 +1233,7 @@ declare namespace SplitIO {
      */
     getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes): 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.
+     * 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.
      * @function getTreatmentsWithConfigByFlagSet
      * @param {string} key - The string key representing the consumer.
      * @param {string} flagSet - The flag set name we want to get the treatments.
@@ -1325,7 +1330,7 @@ declare namespace SplitIO {
      */
     getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes): 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.
+     * 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.
      * For usage on NodeJS as we don't have only one key.
      * @function getTreatmentsWithConfigByFlagSet
      * @param {string} key - The string key representing the consumer.
@@ -1523,7 +1528,7 @@ declare namespace SplitIO {
      * @function getTreatmentsWithConfig
      * @param {Array<string>} featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatmentWithConfig} TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
+     * @returns {AsyncTreatmentsWithConfig} TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
      */
     getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes): AsyncTreatmentsWithConfig,
     /**
@@ -1539,7 +1544,7 @@ declare namespace SplitIO {
      * @function getTreatmentsWithConfigByFlagSet
      * @param {string} flagSet - The flag set name we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatmentWithConfig} TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
+     * @returns {AsyncTreatmentsWithConfig} TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
      */
     getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes): AsyncTreatmentsWithConfig,
     /**
@@ -1555,7 +1560,7 @@ declare namespace SplitIO {
      * @function getTreatmentsWithConfigByFlagSets
      * @param {Array<string>} flagSets - An array of the flag set names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatmentWithConfig} TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
+     * @returns {AsyncTreatmentsWithConfig} TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
      */
     getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes): AsyncTreatmentsWithConfig,
     /**