@splitsoftware/splitio-commons 2.5.0-rc.1 → 2.5.0

package/CHANGES.txt

@@ -1,4 +1,4 @@
-2.5.0 (September 9, 2025)
+2.5.0 (September 10, 2025)
  - Added `factory.getRolloutPlan()` method for standalone server-side SDKs, which returns the rollout plan snapshot from the storage.
  - Added `initialRolloutPlan` configuration option for standalone client-side SDKs, which allows preloading the SDK storage with a snapshot of the rollout plan.
 

package/cjs/storages/getRolloutPlan.js

@@ -10,7 +10,7 @@ function getRolloutPlan(log, storage, options) {
     if (options === void 0) { options = {}; }
     var keys = options.keys, exposeSegments = options.exposeSegments;
     var splits = storage.splits, segments = storage.segments, rbSegments = storage.rbSegments;
-    log.debug("storage: get feature flags" + (keys ? ", and memberships for keys " + keys : '') + (exposeSegments ? ', and segments' : ''));
+    log.debug("storage: get feature flags" + (keys ? ", and memberships for keys: " + keys : '') + (exposeSegments ? ', and segments' : ''));
     return {
         splitChanges: {
             ff: {

package/esm/storages/getRolloutPlan.js

@@ -7,7 +7,7 @@ export function getRolloutPlan(log, storage, options) {
     if (options === void 0) { options = {}; }
     var keys = options.keys, exposeSegments = options.exposeSegments;
     var splits = storage.splits, segments = storage.segments, rbSegments = storage.rbSegments;
-    log.debug("storage: get feature flags" + (keys ? ", and memberships for keys " + keys : '') + (exposeSegments ? ', and segments' : ''));
+    log.debug("storage: get feature flags" + (keys ? ", and memberships for keys: " + keys : '') + (exposeSegments ? ', and segments' : ''));
     return {
         splitChanges: {
             ff: {

package/package.json

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

package/src/storages/getRolloutPlan.ts

@@ -14,7 +14,7 @@ export function getRolloutPlan(log: ILogger, storage: IStorageSync, options: Spl
   const { keys, exposeSegments } = options;
   const { splits, segments, rbSegments } = storage;
 
-  log.debug(`storage: get feature flags${keys ? `, and memberships for keys ${keys}` : ''}${exposeSegments ? ', and segments' : ''}`);
+  log.debug(`storage: get feature flags${keys ? `, and memberships for keys: ${keys}` : ''}${exposeSegments ? ', and segments' : ''}`);
 
   return {
     splitChanges: {

package/types/splitio.d.ts

@@ -1594,7 +1594,14 @@ declare namespace SplitIO {
     /**
      * Returns the current snapshot of the SDK rollout plan in cache.
      *
-     * @param keys - Optional list of keys to generate the rollout plan snapshot with the memberships of the given keys, rather than the complete segments data.
+     * Wait for the SDK client to be ready before calling this method.
+     *
+     * ```js
+     * await factory.client().ready();
+     * const rolloutPlan = factory.getRolloutPlan();
+     * ```
+     *
+     * @param options - An object of type RolloutPlanOptions for advanced options.
      * @returns The current snapshot of the SDK rollout plan.
      */
     getRolloutPlan(options?: RolloutPlanOptions): RolloutPlan;