@splitsoftware/splitio-commons 2.10.2-rc.6 → 2.10.2-rc.7

package/CHANGES.txt

@@ -1,4 +1,4 @@
-2.11.0 (January XX, 2026)
+2.11.0 (January 26, 2026)
  - Added metadata to SDK_UPDATE events to indicate the type of update (FLAGS_UPDATE or SEGMENTS_UPDATE) and the names of updated flags or segments.
  - Added metadata to SDK_READY and SDK_READY_FROM_CACHE events, including `initialCacheLoad` (boolean: `true` for fresh install/first app launch, `false` for warm cache/second app launch) and `lastUpdateTimestamp` (milliseconds since epoch).
 

package/cjs/readiness/readinessManager.js

@@ -154,7 +154,8 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
         hasTimedout: function () { return hasTimedout; },
         isDestroyed: function () { return isDestroyed; },
         isOperational: function () { return (isReady || isReadyFromCache) && !isDestroyed; },
-        lastUpdate: function () { return lastUpdate; }
+        lastUpdate: function () { return lastUpdate; },
+        metadataReady: function () { return metadataReady; }
     };
 }
 exports.readinessManagerFactory = readinessManagerFactory;

package/cjs/readiness/sdkReadinessManager.js

@@ -106,7 +106,7 @@ function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
             whenReady: function () {
                 return new Promise(function (resolve, reject) {
                     if (readinessManager.isReady()) {
-                        resolve();
+                        resolve(readinessManager.metadataReady());
                     }
                     else if (readinessManager.hasTimedout()) {
                         reject(TIMEOUT_ERROR);
@@ -120,13 +120,13 @@ function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
             whenReadyFromCache: function () {
                 return new Promise(function (resolve, reject) {
                     if (readinessManager.isReadyFromCache()) {
-                        resolve(readinessManager.isReady());
+                        resolve(readinessManager.metadataReady());
                     }
                     else if (readinessManager.hasTimedout()) {
                         reject(TIMEOUT_ERROR);
                     }
                     else {
-                        readinessManager.gate.once(constants_1.SDK_READY_FROM_CACHE, function () { return resolve(readinessManager.isReady()); });
+                        readinessManager.gate.once(constants_1.SDK_READY_FROM_CACHE, resolve);
                         readinessManager.gate.once(constants_1.SDK_READY_TIMED_OUT, function () { return reject(TIMEOUT_ERROR); });
                     }
                 });

package/esm/readiness/readinessManager.js

@@ -151,6 +151,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
         hasTimedout: function () { return hasTimedout; },
         isDestroyed: function () { return isDestroyed; },
         isOperational: function () { return (isReady || isReadyFromCache) && !isDestroyed; },
-        lastUpdate: function () { return lastUpdate; }
+        lastUpdate: function () { return lastUpdate; },
+        metadataReady: function () { return metadataReady; }
     };
 }

package/esm/readiness/sdkReadinessManager.js

@@ -103,7 +103,7 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
             whenReady: function () {
                 return new Promise(function (resolve, reject) {
                     if (readinessManager.isReady()) {
-                        resolve();
+                        resolve(readinessManager.metadataReady());
                     }
                     else if (readinessManager.hasTimedout()) {
                         reject(TIMEOUT_ERROR);
@@ -117,13 +117,13 @@ export function sdkReadinessManagerFactory(EventEmitter, settings, readinessMana
             whenReadyFromCache: function () {
                 return new Promise(function (resolve, reject) {
                     if (readinessManager.isReadyFromCache()) {
-                        resolve(readinessManager.isReady());
+                        resolve(readinessManager.metadataReady());
                     }
                     else if (readinessManager.hasTimedout()) {
                         reject(TIMEOUT_ERROR);
                     }
                     else {
-                        readinessManager.gate.once(SDK_READY_FROM_CACHE, function () { return resolve(readinessManager.isReady()); });
+                        readinessManager.gate.once(SDK_READY_FROM_CACHE, resolve);
                         readinessManager.gate.once(SDK_READY_TIMED_OUT, function () { return reject(TIMEOUT_ERROR); });
                     }
                 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.10.2-rc.6",
+  "version": "2.10.2-rc.7",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/readiness/readinessManager.ts

@@ -172,7 +172,8 @@ export function readinessManagerFactory(
     hasTimedout() { return hasTimedout; },
     isDestroyed() { return isDestroyed; },
     isOperational() { return (isReady || isReadyFromCache) && !isDestroyed; },
-    lastUpdate() { return lastUpdate; }
+    lastUpdate() { return lastUpdate; },
+    metadataReady() { return metadataReady; }
   };
 
 }

package/src/readiness/sdkReadinessManager.ts

@@ -120,9 +120,9 @@ export function sdkReadinessManagerFactory(
         },
 
         whenReady() {
-          return new Promise<void>((resolve, reject) => {
+          return new Promise<SplitIO.SdkReadyMetadata>((resolve, reject) => {
             if (readinessManager.isReady()) {
-              resolve();
+              resolve(readinessManager.metadataReady());
             } else if (readinessManager.hasTimedout()) {
               reject(TIMEOUT_ERROR);
             } else {
@@ -133,13 +133,13 @@ export function sdkReadinessManagerFactory(
         },
 
         whenReadyFromCache() {
-          return new Promise<boolean>((resolve, reject) => {
+          return new Promise<SplitIO.SdkReadyMetadata>((resolve, reject) => {
             if (readinessManager.isReadyFromCache()) {
-              resolve(readinessManager.isReady());
+              resolve(readinessManager.metadataReady());
             } else if (readinessManager.hasTimedout()) {
               reject(TIMEOUT_ERROR);
             } else {
-              readinessManager.gate.once(SDK_READY_FROM_CACHE, () => resolve(readinessManager.isReady()));
+              readinessManager.gate.once(SDK_READY_FROM_CACHE, resolve);
               readinessManager.gate.once(SDK_READY_TIMED_OUT, () => reject(TIMEOUT_ERROR));
             }
           });

package/src/readiness/types.ts

@@ -12,19 +12,8 @@ export type IReadinessEvent = SDK_READY_TIMED_OUT | SDK_READY | SDK_READY_FROM_C
 
 export interface IReadinessEventEmitter extends SplitIO.IEventEmitter {
   emit(event: IReadinessEvent, ...args: any[]): boolean
-  on(event: SDK_READY, listener: (metadata: SplitIO.SdkReadyMetadata) => void): this;
-  on(event: SDK_READY_FROM_CACHE, listener: (metadata: SplitIO.SdkReadyMetadata) => void): this;
-  on(event: SDK_UPDATE, listener: (metadata: SplitIO.SdkUpdateMetadata) => void): this;
-  on(event: string | symbol, listener: (...args: any[]) => void): this;
-  once(event: SDK_READY, listener: (metadata: SplitIO.SdkReadyMetadata) => void): this;
-  once(event: SDK_READY_FROM_CACHE, listener: (metadata: SplitIO.SdkReadyMetadata) => void): this;
-  once(event: SDK_UPDATE, listener: (metadata: SplitIO.SdkUpdateMetadata) => void): this;
-  once(event: string | symbol, listener: (...args: any[]) => void): this;
-  addListener(event: SDK_READY, listener: (metadata: SplitIO.SdkReadyMetadata) => void): this;
-  addListener(event: SDK_READY_FROM_CACHE, listener: (metadata: SplitIO.SdkReadyMetadata) => void): this;
-  addListener(event: SDK_UPDATE, listener: (metadata: SplitIO.SdkUpdateMetadata) => void): this;
-  addListener(event: string | symbol, listener: (...args: any[]) => void): this;
 }
+
 /** Splits data emitter */
 
 type SDK_SPLITS_ARRIVED = 'state::splits-arrived'
@@ -71,6 +60,7 @@ export interface IReadinessManager {
   isDestroyed(): boolean,
   isOperational(): boolean,
   lastUpdate(): number,
+  metadataReady(): SplitIO.SdkReadyMetadata,
 
   timeout(): void,
   setDestroyed(): void,

package/types/splitio.d.ts

@@ -83,7 +83,7 @@ interface ISharedSettings {
        * });
        * ```
        */
-      getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>;
+      getHeaderOverrides?: (context: { headers: Record<string, string>; }) => Record<string, string>;
     };
   };
   /**
@@ -499,21 +499,17 @@ declare namespace SplitIO {
     /**
      * The type of update event.
      */
-    type: 'FLAGS_UPDATE' | 'SEGMENTS_UPDATE'
+    type: SdkUpdateMetadataType;
     /**
      * The names of the flags or segments that were updated.
      */
-    names: string[]
+    names: string[];
   }
 
   /**
-   * Metadata keys for SDK update events.
-   * Use the string literals directly: 'FLAGS_UPDATE' or 'SEGMENTS_UPDATE'
+   * Metadata type for SDK update events.
    */
-  type SdkUpdateMetadataKeys = {
-    FLAGS_UPDATE: 'FLAGS_UPDATE';
-    SEGMENTS_UPDATE: 'SEGMENTS_UPDATE';
-  };
+  type SdkUpdateMetadataType = 'FLAGS_UPDATE' | 'SEGMENTS_UPDATE';
 
   /**
    * Metadata for the ready events emitted when the SDK is ready to evaluate feature flags.
@@ -526,11 +522,11 @@ declare namespace SplitIO {
      * - `true` when SDK_READY_FROM_CACHE is emitted because SDK became ready without cache
      * - `true` when SDK_READY is emitted and the SDK was not ready from cache
      */
-    initialCacheLoad: boolean
+    initialCacheLoad: boolean;
     /**
      * Timestamp in milliseconds since epoch when the cache was last updated. Undefined if `initialCacheLoad` is `true`.
      */
-    lastUpdateTimestamp?: number
+    lastUpdateTimestamp?: number;
   }
 
   /**
@@ -662,7 +658,7 @@ declare namespace SplitIO {
       enabled: boolean;
       flagSpecVersion: string;
       requestOptions?: {
-        getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>;
+        getHeaderOverrides?: (context: { headers: Record<string, string>; }) => Record<string, string>;
       };
     };
     readonly runtime: {
@@ -835,18 +831,19 @@ declare namespace SplitIO {
      * As it's meant to provide similar flexibility than event listeners, given that the SDK might be ready after a timeout event, the `whenReady` method will return a resolved promise once the SDK is ready.
      * You must handle the promise rejection to avoid an unhandled promise rejection error, or set the `startup.readyTimeout` configuration option to 0 to avoid the timeout and thus the rejection.
      *
-     * @returns A promise that resolves once the SDK_READY event is emitted or rejects if the SDK has timedout.
+     * @returns A promise that resolves once the SDK_READY event is emitted or rejects if the SDK has timedout. The promise resolves with a metadata object that contains the `initialCacheLoad` property,
+     * which indicates whether the SDK_READY event was emitted together with the SDK_READY_FROM_CACHE event (i.e., fresh install/first app launch) or not (warm cache/subsequent app launch).
      */
-    whenReady(): Promise<void>;
+    whenReady(): Promise<SdkReadyMetadata>;
     /**
      * Returns a promise that resolves when the SDK is ready for evaluations using cached data, which might not yet be synchronized with the backend (`SDK_READY_FROM_CACHE` event emitted), or rejected if the SDK has timedout (`SDK_READY_TIMED_OUT` event emitted).
      * As it's meant to provide similar flexibility than event listeners, given that the SDK might be ready from cache after a timeout event, the `whenReadyFromCache` method will return a resolved promise once the SDK is ready from cache.
      * You must handle the promise rejection to avoid an unhandled promise rejection error, or set the `startup.readyTimeout` configuration option to 0 to avoid the timeout and thus the rejection.
      *
-     * @returns A promise that resolves once the SDK_READY_FROM_CACHE event is emitted or rejects if the SDK has timedout. The promise resolves with a boolean value that
-     * indicates whether the SDK_READY_FROM_CACHE event was emitted together with the SDK_READY event (i.e., the SDK is ready and synchronized with the backend) or not.
+     * @returns A promise that resolves once the SDK_READY_FROM_CACHE event is emitted or rejects if the SDK has timedout. The promise resolves with a metadata object that contains the `initialCacheLoad` property,
+     * which indicates whether the SDK_READY_FROM_CACHE event was emitted together with the SDK_READY event (i.e., fresh install/first app launch) or not (warm cache/subsequent app launch).
      */
-    whenReadyFromCache(): Promise<boolean>;
+    whenReadyFromCache(): Promise<SdkReadyMetadata>;
   }
   /**
    * Common definitions between clients for different environments interface.
@@ -1100,7 +1097,7 @@ declare namespace SplitIO {
     /**
      * Prerequisites for the feature flag.
      */
-    prerequisites: Array<{ flagName: string, treatments: string[] }>;
+    prerequisites: Array<{ flagName: string; treatments: string[]; }>;
   };
   /**
    * A promise that resolves to a feature flag view or null if the feature flag is not found.
@@ -1370,13 +1367,13 @@ declare namespace SplitIO {
     /**
      * Fallback treatment for all flags.
      */
-    global?: Treatment | TreatmentWithConfig,
+    global?: Treatment | TreatmentWithConfig;
     /**
      * Fallback treatments for specific flags. It takes precedence over the global fallback treatment.
      */
     byFlag?: {
-      [featureFlagName: string]: Treatment | TreatmentWithConfig
-    }
+      [featureFlagName: string]: Treatment | TreatmentWithConfig;
+    };
   }
   /**
    * Logger. Its interface details are not part of the public API. It shouldn't be used directly.
@@ -1603,7 +1600,7 @@ declare namespace SplitIO {
          * });
          * ```
          */
-        getHeaderOverrides?: (context: { headers: Record<string, string> }) => Record<string, string>;
+        getHeaderOverrides?: (context: { headers: Record<string, string>; }) => Record<string, string>;
         /**
          * Custom Node.js HTTP(S) Agent used by the SDK for HTTP(S) requests.
          *