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

package/CHANGES.txt

@@ -1,5 +1,7 @@
-0.14.2 (August XX, 2024)
- - 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.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -28,9 +28,7 @@ exports.defaults = {
         // Maximum amount of time used before notifies me a timeout.
         readyTimeout: 10,
         // Amount of time we will wait before the first push of events.
-        eventsFirstPushWindow: 10,
-        // Wait for large segments to emit SDK_READY event.
-        waitForLargeSegments: true,
+        eventsFirstPushWindow: 10
     },
     // Consent is considered granted by default
     userConsent: constants_1.CONSENT_GRANTED,

package/cjs/settings/full.js

@@ -9,7 +9,6 @@ var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsVali
 var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
 var builtin_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/localhost/builtin");
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
-var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var params = {
     defaults: defaults_1.defaults,
     acceptKey: true,
@@ -21,10 +20,6 @@ var params = {
     consent: consent_1.validateConsent,
 };
 function settingsFactory(config) {
-    var settings = (0, index_1.settingsValidation)(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
-    if (settings.mode !== constants_1.STANDALONE_MODE)
-        settings.sync.largeSegmentsEnabled = false;
-    return settings;
+    return (0, index_1.settingsValidation)(config, params);
 }
 exports.settingsFactory = settingsFactory;

package/cjs/settings/index.js

@@ -9,7 +9,6 @@ var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsVali
 var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
 var pluggable_2 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/localhost/pluggable");
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
-var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var params = {
     defaults: defaults_1.defaults,
     acceptKey: true,
@@ -21,10 +20,6 @@ var params = {
     consent: consent_1.validateConsent,
 };
 function settingsFactory(config) {
-    var settings = (0, index_1.settingsValidation)(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
-    if (settings.mode !== constants_1.STANDALONE_MODE)
-        settings.sync.largeSegmentsEnabled = false;
-    return settings;
+    return (0, index_1.settingsValidation)(config, params);
 }
 exports.settingsFactory = settingsFactory;

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.0';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
@@ -25,9 +25,7 @@ export var defaults = {
         // Maximum amount of time used before notifies me a timeout.
         readyTimeout: 10,
         // Amount of time we will wait before the first push of events.
-        eventsFirstPushWindow: 10,
-        // Wait for large segments to emit SDK_READY event.
-        waitForLargeSegments: true,
+        eventsFirstPushWindow: 10
     },
     // Consent is considered granted by default
     userConsent: CONSENT_GRANTED,

package/esm/settings/full.js

@@ -6,7 +6,6 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/es
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/localhost/builtin';
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
-import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 var params = {
     defaults: defaults,
     acceptKey: true,
@@ -18,9 +17,5 @@ var params = {
     consent: validateConsent,
 };
 export function settingsFactory(config) {
-    var settings = settingsValidation(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
-    if (settings.mode !== STANDALONE_MODE)
-        settings.sync.largeSegmentsEnabled = false;
-    return settings;
+    return settingsValidation(config, params);
 }

package/esm/settings/index.js

@@ -6,7 +6,6 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/es
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhost } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/localhost/pluggable';
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
-import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 var params = {
     defaults: defaults,
     acceptKey: true,
@@ -18,9 +17,5 @@ var params = {
     consent: validateConsent,
 };
 export function settingsFactory(config) {
-    var settings = settingsValidation(config, params);
-    // @ts-ignore, Override in localhost and consumer modes to properly emit SDK_READY
-    if (settings.mode !== STANDALONE_MODE)
-        settings.sync.largeSegmentsEnabled = false;
-    return settings;
+    return settingsValidation(config, params);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.14.2-rc.0",
+  "version": "0.15.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.0",
     "@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.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
@@ -30,9 +30,7 @@ export const defaults = {
     // Maximum amount of time used before notifies me a timeout.
     readyTimeout: 10,
     // Amount of time we will wait before the first push of events.
-    eventsFirstPushWindow: 10,
-    // Wait for large segments to emit SDK_READY event.
-    waitForLargeSegments: true,
+    eventsFirstPushWindow: 10
   },
 
   // Consent is considered granted by default

package/src/settings/full.ts

@@ -6,7 +6,6 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/sr
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/builtin';
 import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
-import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 const params = {
   defaults,
@@ -20,10 +19,5 @@ 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
-  if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
-
-  return settings;
+  return settingsValidation(config, params);
 }

package/src/settings/index.ts

@@ -6,7 +6,6 @@ import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/sr
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
 import { validateLocalhost } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/pluggable';
 import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
-import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 const params = {
   defaults,
@@ -20,10 +19,5 @@ 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
-  if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
-
-  return settings;
+  return settingsValidation(config, params);
 }

package/types/splitio.d.ts

@@ -61,7 +61,6 @@ interface ISettings {
     impressionsQueueSize: number,
     telemetryRefreshRate: number,
     segmentsRefreshRate: number,
-    largeSegmentsRefreshRate: number,
     offlineRefreshRate: number,
     eventsPushRate: number,
     eventsQueueSize: number,
@@ -71,8 +70,7 @@ interface ISettings {
     readyTimeout: number,
     requestTimeoutBeforeReady: number,
     retriesOnFailureBeforeReady: number,
-    eventsFirstPushWindow: number,
-    waitForLargeSegments: boolean
+    eventsFirstPushWindow: number
   },
   readonly storage?: SplitIO.StorageSyncFactory | SplitIO.StorageAsyncFactory,
   readonly urls: {
@@ -94,9 +92,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 +256,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>
+    },
   }
 }
 /**
@@ -967,13 +999,6 @@ declare namespace SplitIO {
        * @default 10
        */
       eventsFirstPushWindow?: number,
-      /**
-       * Whether the SDK should wait for large segments to be ready before emitting SDK_READY event.
-       * It only applies if largeSegmentsEnabled is true.
-       * @property {boolean} waitForLargeSegments
-       * @default true
-       */
-      waitForLargeSegments?: boolean
     },
     /**
      * SDK scheduler settings.
@@ -1011,13 +1036,6 @@ declare namespace SplitIO {
        * @default 60
        */
       segmentsRefreshRate?: number,
-      /**
-       * The SDK polls Split servers for changes to large segment definitions. This parameter controls this polling period in seconds.
-       * It only applies if largeSegmentsEnabled is true.
-       * @property {number} largeSegmentsRefreshRate
-       * @default 60
-       */
-      largeSegmentsRefreshRate?: number,
       /**
        * The SDK posts the queued events data in bulks. This parameter controls the posting rate in seconds.
        * @property {number} eventsPushRate
@@ -1045,14 +1063,6 @@ declare namespace SplitIO {
        * @default 1
        */
       pushRetryBackoffBase?: number,
-    },
-    sync?: ISharedSettings['sync'] & {
-      /**
-       * Enables synchronization of large segments.
-       * @property {boolean} largeSegmentsEnabled
-       * @default false
-       */
-      largeSegmentsEnabled?: boolean
     }
   }
   /**