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

package/types/splitio.d.ts

@@ -463,6 +463,24 @@ interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISync
  */
 declare namespace SplitIO {
 
+  interface StorageWrapper {
+    /**
+     * Returns the value associated with the given key, or null if the key does not exist.
+     * If the operation is asynchronous, returns a Promise.
+     */
+    getItem(key: string): string | null | Promise<string | null>;
+    /**
+     * Sets the value for the given key, creating a new key/value pair if key does not exist.
+     * If the operation is asynchronous, returns a Promise.
+     */
+    setItem(key: string, value: string): void | Promise<void>;
+    /**
+     * Removes the key/value pair for the given key, if the key exists.
+     * If the operation is asynchronous, returns a Promise.
+     */
+    removeItem(key: string): void | Promise<void>;
+  }
+
   /**
    * EventEmitter interface based on a subset of the Node.js EventEmitter methods.
    */
@@ -978,6 +996,12 @@ declare namespace SplitIO {
      * @defaultValue `false`
      */
     clearOnInit?: boolean;
+    /**
+     * Optional storage wrapper to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
+     *
+     * @defaultValue `window.localStorage`
+     */
+    wrapper?: StorageWrapper;
   }
   /**
    * Storage for asynchronous (consumer) SDK.
@@ -1339,6 +1363,12 @@ declare namespace SplitIO {
        * @defaultValue `false`
        */
       clearOnInit?: boolean;
+      /**
+       * Optional storage wrapper to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
+       *
+       * @defaultValue `window.localStorage`
+       */
+      wrapper?: StorageWrapper;
     };
   }
   /**
@@ -1594,7 +1624,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;