@splitsoftware/splitio 10.27.1-rc.2 → 10.28.0-rc.0

package/CHANGES.txt

@@ -1,3 +1,7 @@
+10.28.0 (August XXX, 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.
+
 10.27.0 (June 25, 2024)
  - Added `sync.requestOptions.agent` option to SDK configuration for NodeJS. This allows passing a custom NodeJS HTTP(S) Agent with specific configurations for the SDK requests, like custom TLS settings or a network proxy (See https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#proxy).
  - Updated some transitive dependencies for vulnerability fixes.

package/es/settings/browser.js

@@ -3,7 +3,6 @@ import { validateRuntime } from '@splitsoftware/splitio-commons/esm/utils/settin
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/builtinLogger';
 import { LocalhostFromObject } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromObject';
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
-import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 import { defaults } from './defaults/browser';
 import { validateStorage } from './storage/browser';
 import { validateIntegrations } from './integrations/browser';
@@ -18,9 +17,5 @@ var params = {
     consent: validateConsent,
 };
 export function settingsFactory(config) {
-    var settings = settingsValidation(config, params);
-    // Override in localhost mode to emit SDK_READY event
-    if (settings.mode !== STANDALONE_MODE)
-        settings.sync.largeSegmentsEnabled = false;
-    return settings;
+    return settingsValidation(config, params);
 }

package/es/settings/defaults/browser.js

@@ -9,9 +9,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/es/settings/defaults/node.js

@@ -12,9 +12,7 @@ export var defaults = {
         // Maximum amount of time used before notifies me a timeout.
         readyTimeout: 15,
         // Don't wait a specific time for first flush on Node, no page load here.
-        eventsFirstPushWindow: 0,
-        // Don't wait for large segments to emit SDK_READY event.
-        waitForLargeSegments: false,
+        eventsFirstPushWindow: 0
     },
     features: '.split',
     // Instance version.

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.27.1-rc.2';
+export var packageVersion = '10.28.0-rc.0';

package/es/settings/node.js

@@ -10,6 +10,7 @@ var params = {
     storage: validateStorage,
     logger: validateLogger,
     localhost: function () { return LocalhostFromFile(); },
+    consent: function () { return undefined; }, // resets settings.userConsent to the default
     // In Node.js the SDK ignores `config.integrations`, so a validator for integrations is not required
 };
 export function settingsFactory(config) {
@@ -17,9 +18,5 @@ export function settingsFactory(config) {
     // if provided, keeps reference to the `requestOptions` object
     if (settings.sync.requestOptions)
         settings.sync.requestOptions = config.sync.requestOptions;
-    // Reset config options not supported in Node.js
-    if (settings.sync.largeSegmentsEnabled)
-        settings.log.warn('Client instantiation: config.sync.largeSegmentsEnabled option is not supported in NodeJS. Ignoring it.');
-    settings.sync.largeSegmentsEnabled = false;
     return settings;
 }

package/es/settings/storage/browser.js

@@ -18,7 +18,7 @@ export function validateStorage(settings) {
     if (type !== STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
         type === STORAGE_LOCALSTORAGE && !isLocalStorageAvailable()) {
         fallbackToMemory();
-        log.error('Invalid or unavailable storage. Fallback into MEMORY storage');
+        log.error('Invalid or unavailable storage. Fallbacking into MEMORY storage');
     }
     return {
         type: type,

package/es/settings/storage/node.js

@@ -6,7 +6,7 @@ export function validateStorage(settings) {
         case STORAGE_REDIS: {
             // If passing REDIS storage in localhost or standalone mode, we log an error and fallback to MEMORY storage
             if (mode === STANDALONE_MODE || mode === LOCALHOST_MODE) {
-                log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallback into default MEMORY storage.');
+                log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallbacking into default MEMORY storage.');
                 return {
                     type: STORAGE_MEMORY,
                     prefix: prefix
@@ -53,7 +53,7 @@ export function validateStorage(settings) {
                 throw new Error('A REDIS storage is required on consumer mode');
             // If passing an invalid storage type, log an error
             if (type !== STORAGE_MEMORY)
-                log.error("The provided '" + type + "' storage type is invalid. Fallback into default MEMORY storage.");
+                log.error("The provided '" + type + "' storage type is invalid. Fallbacking into default MEMORY storage.");
             return {
                 type: STORAGE_MEMORY,
                 prefix: prefix

package/lib/settings/browser.js

@@ -6,7 +6,6 @@ var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValida
 var builtinLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/builtinLogger");
 var LocalhostFromObject_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/LocalhostFromObject");
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
-var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var browser_1 = require("./defaults/browser");
 var browser_2 = require("./storage/browser");
 var browser_3 = require("./integrations/browser");
@@ -21,10 +20,6 @@ var params = {
     consent: consent_1.validateConsent,
 };
 function settingsFactory(config) {
-    var settings = (0, settingsValidation_1.settingsValidation)(config, params);
-    // Override in localhost mode to emit SDK_READY event
-    if (settings.mode !== constants_1.STANDALONE_MODE)
-        settings.sync.largeSegmentsEnabled = false;
-    return settings;
+    return (0, settingsValidation_1.settingsValidation)(config, params);
 }
 exports.settingsFactory = settingsFactory;

package/lib/settings/defaults/browser.js

@@ -12,9 +12,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/lib/settings/defaults/node.js

@@ -15,9 +15,7 @@ exports.defaults = {
         // Maximum amount of time used before notifies me a timeout.
         readyTimeout: 15,
         // Don't wait a specific time for first flush on Node, no page load here.
-        eventsFirstPushWindow: 0,
-        // Don't wait for large segments to emit SDK_READY event.
-        waitForLargeSegments: false,
+        eventsFirstPushWindow: 0
     },
     features: '.split',
     // Instance version.

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.27.1-rc.2';
+exports.packageVersion = '10.28.0-rc.0';

package/lib/settings/node.js

@@ -13,6 +13,7 @@ var params = {
     storage: node_2.validateStorage,
     logger: builtinLogger_1.validateLogger,
     localhost: function () { return (0, LocalhostFromFile_1.LocalhostFromFile)(); },
+    consent: function () { return undefined; }, // resets settings.userConsent to the default
     // In Node.js the SDK ignores `config.integrations`, so a validator for integrations is not required
 };
 function settingsFactory(config) {
@@ -20,10 +21,6 @@ function settingsFactory(config) {
     // if provided, keeps reference to the `requestOptions` object
     if (settings.sync.requestOptions)
         settings.sync.requestOptions = config.sync.requestOptions;
-    // Reset config options not supported in Node.js
-    if (settings.sync.largeSegmentsEnabled)
-        settings.log.warn('Client instantiation: config.sync.largeSegmentsEnabled option is not supported in NodeJS. Ignoring it.');
-    settings.sync.largeSegmentsEnabled = false;
     return settings;
 }
 exports.settingsFactory = settingsFactory;

package/lib/settings/storage/browser.js

@@ -21,7 +21,7 @@ function validateStorage(settings) {
     if (type !== constants_1.STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
         type === STORAGE_LOCALSTORAGE && !(0, isLocalStorageAvailable_1.isLocalStorageAvailable)()) {
         fallbackToMemory();
-        log.error('Invalid or unavailable storage. Fallback into MEMORY storage');
+        log.error('Invalid or unavailable storage. Fallbacking into MEMORY storage');
     }
     return {
         type: type,

package/lib/settings/storage/node.js

@@ -9,7 +9,7 @@ function validateStorage(settings) {
         case constants_1.STORAGE_REDIS: {
             // If passing REDIS storage in localhost or standalone mode, we log an error and fallback to MEMORY storage
             if (mode === constants_1.STANDALONE_MODE || mode === constants_1.LOCALHOST_MODE) {
-                log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallback into default MEMORY storage.');
+                log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallbacking into default MEMORY storage.');
                 return {
                     type: constants_1.STORAGE_MEMORY,
                     prefix: prefix
@@ -56,7 +56,7 @@ function validateStorage(settings) {
                 throw new Error('A REDIS storage is required on consumer mode');
             // If passing an invalid storage type, log an error
             if (type !== constants_1.STORAGE_MEMORY)
-                log.error("The provided '" + type + "' storage type is invalid. Fallback into default MEMORY storage.");
+                log.error("The provided '" + type + "' storage type is invalid. Fallbacking into default MEMORY storage.");
             return {
                 type: constants_1.STORAGE_MEMORY,
                 prefix: prefix

package/package.json

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

package/src/settings/browser.js

@@ -3,7 +3,6 @@ import { validateRuntime } from '@splitsoftware/splitio-commons/src/utils/settin
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/builtinLogger';
 import { LocalhostFromObject } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromObject';
 import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
-import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 import { defaults } from './defaults/browser';
 import { validateStorage } from './storage/browser';
@@ -21,10 +20,5 @@ const params = {
 };
 
 export function settingsFactory(config) {
-  const settings = settingsValidation(config, params);
-
-  // Override in localhost mode to emit SDK_READY event
-  if (settings.mode !== STANDALONE_MODE) settings.sync.largeSegmentsEnabled = false;
-
-  return settings;
+  return settingsValidation(config, params);
 }

package/src/settings/defaults/browser.js

@@ -10,9 +10,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/defaults/node.js

@@ -13,9 +13,7 @@ export const defaults = {
     // Maximum amount of time used before notifies me a timeout.
     readyTimeout: 15,
     // Don't wait a specific time for first flush on Node, no page load here.
-    eventsFirstPushWindow: 0,
-    // Don't wait for large segments to emit SDK_READY event.
-    waitForLargeSegments: false,
+    eventsFirstPushWindow: 0
   },
 
   features: '.split',

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.27.1-rc.2';
+export const packageVersion = '10.28.0-rc.0';

package/src/settings/node.js

@@ -12,6 +12,7 @@ const params = {
   storage: validateStorage,
   logger: validateLogger,
   localhost: () => LocalhostFromFile(),
+  consent: () => undefined, // resets settings.userConsent to the default
   // In Node.js the SDK ignores `config.integrations`, so a validator for integrations is not required
 };
 
@@ -20,10 +21,5 @@ export function settingsFactory(config) {
 
   // if provided, keeps reference to the `requestOptions` object
   if (settings.sync.requestOptions) settings.sync.requestOptions = config.sync.requestOptions;
-
-  // Reset config options not supported in Node.js
-  if (settings.sync.largeSegmentsEnabled) settings.log.warn('Client instantiation: config.sync.largeSegmentsEnabled option is not supported in NodeJS. Ignoring it.');
-  settings.sync.largeSegmentsEnabled = false;
-
   return settings;
 }

package/src/settings/storage/browser.js

@@ -31,7 +31,7 @@ export function validateStorage(settings) {
   if (type !== STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
     type === STORAGE_LOCALSTORAGE && !isLocalStorageAvailable()) {
     fallbackToMemory();
-    log.error('Invalid or unavailable storage. Fallback into MEMORY storage');
+    log.error('Invalid or unavailable storage. Fallbacking into MEMORY storage');
   }
 
   return {

package/src/settings/storage/node.js

@@ -16,7 +16,7 @@ export function validateStorage(settings) {
     case STORAGE_REDIS: {
       // If passing REDIS storage in localhost or standalone mode, we log an error and fallback to MEMORY storage
       if (mode === STANDALONE_MODE || mode === LOCALHOST_MODE) {
-        log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallback into default MEMORY storage.');
+        log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallbacking into default MEMORY storage.');
         return {
           type: STORAGE_MEMORY,
           prefix
@@ -74,7 +74,7 @@ export function validateStorage(settings) {
       // If passing MEMORY storage in consumer mode, throw an error (no way to fallback to REDIS storage)
       if (mode === CONSUMER_MODE) throw new Error('A REDIS storage is required on consumer mode');
       // If passing an invalid storage type, log an error
-      if (type !== STORAGE_MEMORY) log.error(`The provided '${type}' storage type is invalid. Fallback into default MEMORY storage.`);
+      if (type !== STORAGE_MEMORY) log.error(`The provided '${type}' storage type is invalid. Fallbacking into default MEMORY storage.`);
       return {
         type: STORAGE_MEMORY,
         prefix

package/types/splitio.d.ts

@@ -78,7 +78,6 @@ interface ISettings {
     metricsRefreshRate?: number,
     telemetryRefreshRate: number,
     segmentsRefreshRate: number,
-    largeSegmentsRefreshRate: number,
     offlineRefreshRate: number,
     eventsPushRate: number,
     eventsQueueSize: number,
@@ -88,8 +87,7 @@ interface ISettings {
     readyTimeout: number,
     requestTimeoutBeforeReady: number,
     retriesOnFailureBeforeReady: number,
-    eventsFirstPushWindow: number,
-    waitForLargeSegments: boolean
+    eventsFirstPushWindow: number
   },
   readonly storage: {
     prefix: string,
@@ -114,8 +112,10 @@ interface ISettings {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
     enabled: boolean,
-    largeSegmentsEnabled: boolean,
-    flagSpecVersion: string
+    flagSpecVersion: string,
+    requestOptions?: {
+      getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
+    }
   }
   /**
    * User consent status if using in browser. Undefined if using in NodeJS.
@@ -985,13 +985,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.
@@ -1036,13 +1029,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
@@ -1147,11 +1133,22 @@ declare namespace SplitIO {
     userConsent?: ConsentStatus,
     sync?: ISharedSettings['sync'] & {
       /**
-       * Enables synchronization of large segments.
-       * @property {boolean} largeSegmentsEnabled
-       * @default false
+       * 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.
+       * @see {@link https://www.npmjs.com/package/node-fetch#options}
        */
-      largeSegmentsEnabled?: boolean
+      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' }`.
+         *
+         * @property getHeaderOverrides
+         * @default undefined
+         */
+        getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
+      },
     }
   }
   /**
@@ -1202,6 +1199,16 @@ declare namespace SplitIO {
        * @see {@link https://www.npmjs.com/package/node-fetch#options}
        */
       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' }`.
+         *
+         * @property getHeaderOverrides
+         * @default undefined
+         */
+        getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>
         /**
          * Custom NodeJS HTTP(S) Agent used by the SDK for HTTP(S) requests.
          *