@splitsoftware/splitio-browserjs 0.14.2-rc.0 → 0.15.1-rc.0

package/CHANGES.txt

@@ -1,5 +1,13 @@
-0.14.2 (August XX, 2024)
- - Updated some transitive dependencies for vulnerability fixes.
+0.16.0 (September XX, 2024)
+ - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
+ - Updated @splitsoftware/splitio-commons package to version 1.18.0 that includes minor updates:
+    - Added support for targeting rules based on large segments for browsers.
+    - Updated some transitive dependencies for vulnerability fixes.
+
+0.15.0 (September 13, 2024)
+ - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:
+    - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
+    - Updated some transitive dependencies for vulnerability fixes.
 
 0.14.1 (June 14, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.16.0 that includes some vulnerability and bug fixes.

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.14.2-rc.0';
+var packageVersion = '0.15.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/cjs/settings/full.js

@@ -22,7 +22,7 @@ var params = {
 };
 function settingsFactory(config) {
     var settings = (0, index_1.settingsValidation)(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    // @ts-ignore, Override in localhost and consumer modes to emit SDK_READY event
     if (settings.mode !== constants_1.STANDALONE_MODE)
         settings.sync.largeSegmentsEnabled = false;
     return settings;

package/cjs/settings/index.js

@@ -22,7 +22,7 @@ var params = {
 };
 function settingsFactory(config) {
     var settings = (0, index_1.settingsValidation)(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    // @ts-ignore, Override in localhost and consumer modes to emit SDK_READY event
     if (settings.mode !== constants_1.STANDALONE_MODE)
         settings.sync.largeSegmentsEnabled = false;
     return settings;

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.14.2-rc.0';
+var packageVersion = '0.15.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/full.js

@@ -19,7 +19,7 @@ var params = {
 };
 export function settingsFactory(config) {
     var settings = settingsValidation(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    // @ts-ignore, Override in localhost and consumer modes to emit SDK_READY event
     if (settings.mode !== STANDALONE_MODE)
         settings.sync.largeSegmentsEnabled = false;
     return settings;

package/esm/settings/index.js

@@ -19,7 +19,7 @@ var params = {
 };
 export function settingsFactory(config) {
     var settings = settingsValidation(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+    // @ts-ignore, Override in localhost and consumer modes to emit SDK_READY event
     if (settings.mode !== STANDALONE_MODE)
         settings.sync.largeSegmentsEnabled = false;
     return settings;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.14.2-rc.0",
+  "version": "0.15.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.16.1-rc.5",
+    "@splitsoftware/splitio-commons": "1.17.1-rc.1",
     "@types/google.analytics": "0.0.40",
     "tslib": "^2.3.1",
     "unfetch": "^4.2.0"
@@ -81,7 +81,7 @@
     "eslint": "^8.48.0",
     "eslint-plugin-compat": "^4.2.0",
     "eslint-plugin-import": "^2.25.4",
-    "fetch-mock": "^9.11.0",
+    "fetch-mock": "^11.1.3",
     "jest": "^27.2.3",
     "karma": "^6.4.1",
     "karma-chrome-launcher": "^3.1.1",

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.14.2-rc.0';
+const packageVersion = '0.15.1-rc.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/src/settings/full.ts

@@ -22,7 +22,7 @@ const params = {
 export function settingsFactory(config: any) {
   const settings = settingsValidation(config, params);
 
-  // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+  // @ts-ignore, Override in localhost and consumer modes to emit SDK_READY event
   if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
 
   return settings;

package/src/settings/index.ts

@@ -22,7 +22,7 @@ const params = {
 export function settingsFactory(config: any) {
   const settings = settingsValidation(config, params);
 
-  // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
+  // @ts-ignore, Override in localhost and consumer modes to emit SDK_READY event
   if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
 
   return settings;

package/types/splitio.d.ts

@@ -94,9 +94,11 @@ interface ISettings {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
     enabled: boolean,
-    largeSegmentsEnabled: boolean,
     flagSpecVersion: string,
-    localhostMode?: SplitIO.LocalhostFactory
+    localhostMode?: SplitIO.LocalhostFactory,
+    requestOptions?: {
+      getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
+    },
   },
   readonly userConsent: SplitIO.ConsentStatus
 }
@@ -256,6 +258,38 @@ interface ISharedSettings {
      * @default true
      */
     enabled?: boolean
+    /**
+     * Custom options object for HTTP(S) requests in the Browser.
+     * If provided, this object is merged with the options object passed by the SDK for EventSource and Fetch calls.
+     * This configuration has no effect in "consumer" mode, as no HTTP(S) requests are made by the SDK.
+     */
+    requestOptions?: {
+      /**
+       * Custom function called before each request, allowing you to add or update headers in SDK HTTP requests.
+       * Some headers, such as `SplitSDKVersion`, are required by the SDK and cannot be overridden.
+       * To pass multiple headers with the same name, combine their values into a single line, separated by commas. Example: `{ 'Authorization': 'value1, value2' }`
+       * Or provide keys with different case since headers are case-insensitive. Example: `{ 'authorization': 'value1', 'Authorization': 'value2' }`
+       *
+       * NOTE: to pass custom headers to the streaming connection in Browser, you should polyfill the `window.EventSource` object with a library that supports headers,
+       * like https://www.npmjs.com/package/event-source-polyfill, since native EventSource does not support them and will be ignored.
+       *
+       * @property getHeaderOverrides
+       * @default undefined
+       *
+       * @param context - The context for the request.
+       * @param context.headers - The current headers in the request.
+       * @returns A set of headers to be merged with the current headers.
+       *
+       * @example
+       * const getHeaderOverrides = (context) => {
+       *   return {
+       *     'Authorization': context.headers['Authorization'] + ', other-value',
+       *     'custom-header': 'custom-value'
+       *   };
+       * };
+       */
+      getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
+    },
   }
 }
 /**
@@ -327,7 +361,13 @@ interface IBasicSDK {
    * User consent API.
    * @property UserConsent
    */
-  UserConsent: IUserConsentAPI
+  UserConsent: IUserConsentAPI,
+  /**
+   * Destroys all the clients created by this factory.
+   * @function destroy
+   * @returns {Promise<void>}
+   */
+  destroy(): Promise<void>
 }
 /****** Exposed namespace ******/
 /**