@splitsoftware/splitio 10.28.0-rc.3 → 10.28.0-rc.5

package/CHANGES.txt

@@ -1,4 +1,4 @@
-10.28.0 (September XXX, 2024)
+10.28.0 (September 6, 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.

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.28.0-rc.3';
+export var packageVersion = '10.28.0-rc.5';

package/lib/settings/defaults/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageVersion = void 0;
-exports.packageVersion = '10.28.0-rc.3';
+exports.packageVersion = '10.28.0-rc.5';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.28.0-rc.3",
+  "version": "10.28.0-rc.5",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -40,7 +40,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.17.0-rc.3",
+    "@splitsoftware/splitio-commons": "1.17.0-rc.5",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.28.0-rc.3';
+export const packageVersion = '10.28.0-rc.5';

package/types/splitio.d.ts

@@ -1138,13 +1138,28 @@ declare namespace SplitIO {
        */
       requestOptions?: {
         /**
-         * Custom function called before each request, allowing you to add or update custom headers on the SDK HTTP requests.
-         * Some headers are required by the SDK, like 'SplitSDKVersion', and cannot be overridden.
-         * To pass multiple headers with the same name, you can combine them into a single line separated by commas.
-         * Example: `{ 'Authorization': 'value1, value2' }`.
+         * 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/eventsource, since the native EventSource object does not support them in general 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>
       },
@@ -1199,13 +1214,25 @@ declare namespace SplitIO {
        */
       requestOptions?: {
         /**
-         * Custom function called before each request, allowing you to add or update custom headers on the SDK HTTP requests.
-         * Some headers are required by the SDK, like 'SplitSDKVersion', and cannot be overridden.
-         * To pass multiple headers with the same name, you can combine them into a single line separated by commas.
-         * Example: `{ 'Authorization': 'value1, value2' }`.
+         * 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' }`
          *
          * @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>
         /**