@splitsoftware/splitio 11.0.0-rc.0 → 11.0.0-rc.1

package/CHANGES.txt

@@ -1,15 +1,18 @@
 11.0.0 (October XX, 2024)
  - Added support for targeting rules based on large segments for browsers.
+ - Added `factory.getState()` method for standalone server-side SDKs, which returns the rollout plan snapshot from the storage.
+ - Added `preloadedData` configuration option for standalone client-side SDKs, which allows preloading the SDK storage with a snapshot of the rollout plan.
  - Added `factory.destroy()` method, which invokes the `destroy` method of all clients created by the factory.
  - Updated @splitsoftware/splitio-commons package to version 2.0.0 that includes major updates and updated some transitive dependencies for vulnerability fixes.
+ - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for EcmaScript Modules build.
  - BREAKING CHANGES:
-    - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for EcmaScript Modules build.
-    - Drop support for NodeJS v6. The SDK now requires NodeJS v14 or above.
-    - Removed internal ponyfills for `Map`, `Set` and `Array.from` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or to provide a polyfill.
-    - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations.
-    - Removed clients with bound traffic type. the `core.trafficType` configuration option. The SDK now uses the `core.trafficType` value from the factory configuration to create clients.
-    - Updated TypeScript definitions.
-    - Bugfixing - Removed an overloaded `client` method in the `SplitIO.ISDK` interface that accepted a key and trafficType parameters. This interface corresponds to the SDK factory instance in NodeJS, which, unlike `SplitIO.IBrowserSDK` for the Browser, does not handle multiple client instances based on keys or traffic types.
+    - Dropped support for NodeJS v6. The SDK now requires NodeJS v14 or above.
+    - Removed internal ponyfills for the `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or provide a polyfill.
+    - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations. The `integrations` configuration option has been removed from the SDK factory configuration, along with the associated interfaces in the TypeScript definitions.
+    - Removed the `core.trafficType` configuration option (`SplitIO.IBrowserSettings['core']['trafficType]`) and the `trafficType` parameter from the SDK `client()` method in Browser (`SplitIO.IBrowserSDK['client']`). As a result, traffic types can no longer be bound to SDK clients, and the traffic type must be provided in the `track` method.
+    - TypeScript definitions:
+       - Removed an overloaded `client` method in the `SplitIO.ISDK` interface that accepted `key` and `trafficType` parameters. This interface corresponds to the SDK factory instance in NodeJS, which, unlike `SplitIO.IBrowserSDK` for the Browser, does not handle multiple client instances based on keys.
+       - Updated the `SplitIO.IBrowserSDK` and `SplitIO.IBrowserClient` interfaces to no longer extend the `SplitIO.ISDK` and `SplitIO.IClient` interfaces respectively, as the SDK factory instance in NodeJS or server-side (`SplitIO.ISDK`) has a different API than the SDK client instance in the Browser or client-side (`SplitIO.IBrowserClient`).
 
 10.28.0 (September 6, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:

package/cjs/factory/node.js

@@ -7,6 +7,7 @@ var pushManager_1 = require("@splitsoftware/splitio-commons/cjs/sync/streaming/p
 var pollingManagerSS_1 = require("@splitsoftware/splitio-commons/cjs/sync/polling/pollingManagerSS");
 var inRedis_1 = require("@splitsoftware/splitio-commons/cjs/storages/inRedis");
 var InMemoryStorage_1 = require("@splitsoftware/splitio-commons/cjs/storages/inMemory/InMemoryStorage");
+var dataLoader_1 = require("@splitsoftware/splitio-commons/cjs/storages/dataLoader");
 var sdkManager_1 = require("@splitsoftware/splitio-commons/cjs/sdkManager");
 var sdkClientMethod_1 = require("@splitsoftware/splitio-commons/cjs/sdkClient/sdkClientMethod");
 var impressionObserverSS_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/impressionObserverSS");
@@ -36,7 +37,16 @@ function getModules(settings) {
         sdkClientMethodFactory: sdkClientMethod_1.sdkClientMethodFactory,
         SignalListener: platform_1.SignalListener,
         impressionsObserverFactory: impressionObserverSS_1.impressionObserverSSFactory,
-        filterAdapterFactory: bloomFilter_1.bloomFilterFactory
+        filterAdapterFactory: bloomFilter_1.bloomFilterFactory,
+        extraProps: function (params) {
+            if (params.settings.mode !== constants_1.CONSUMER_MODE) {
+                return {
+                    getState: function (userKeys) {
+                        return (0, dataLoader_1.getSnapshot)(params.storage, userKeys);
+                    }
+                };
+            }
+        }
     };
     switch (settings.mode) {
         case constants_1.LOCALHOST_MODE:

package/cjs/settings/defaults/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageVersion = void 0;
-exports.packageVersion = '11.0.0-rc.0';
+exports.packageVersion = '11.0.0-rc.1';

package/esm/factory/node.js

@@ -4,6 +4,7 @@ import { pushManagerFactory } from '@splitsoftware/splitio-commons/esm/sync/stre
 import { pollingManagerSSFactory } from '@splitsoftware/splitio-commons/esm/sync/polling/pollingManagerSS';
 import { InRedisStorage } from '@splitsoftware/splitio-commons/esm/storages/inRedis';
 import { InMemoryStorageFactory } from '@splitsoftware/splitio-commons/esm/storages/inMemory/InMemoryStorage';
+import { getSnapshot } from '@splitsoftware/splitio-commons/esm/storages/dataLoader';
 import { sdkManagerFactory } from '@splitsoftware/splitio-commons/esm/sdkManager';
 import { sdkClientMethodFactory } from '@splitsoftware/splitio-commons/esm/sdkClient/sdkClientMethod';
 import { impressionObserverSSFactory } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/impressionObserverSS';
@@ -33,7 +34,16 @@ function getModules(settings) {
         sdkClientMethodFactory: sdkClientMethodFactory,
         SignalListener: SignalListener,
         impressionsObserverFactory: impressionObserverSSFactory,
-        filterAdapterFactory: bloomFilterFactory
+        filterAdapterFactory: bloomFilterFactory,
+        extraProps: function (params) {
+            if (params.settings.mode !== CONSUMER_MODE) {
+                return {
+                    getState: function (userKeys) {
+                        return getSnapshot(params.storage, userKeys);
+                    }
+                };
+            }
+        }
     };
     switch (settings.mode) {
         case LOCALHOST_MODE:

package/esm/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '11.0.0-rc.0';
+export var packageVersion = '11.0.0-rc.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "11.0.0-rc.0",
+  "version": "11.0.0-rc.1",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -38,7 +38,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "2.0.0-rc.0",
+    "@splitsoftware/splitio-commons": "2.0.0-rc.2",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",
     "ioredis": "^4.28.0",

package/src/factory/node.js

@@ -4,6 +4,7 @@ import { pushManagerFactory } from '@splitsoftware/splitio-commons/src/sync/stre
 import { pollingManagerSSFactory } from '@splitsoftware/splitio-commons/src/sync/polling/pollingManagerSS';
 import { InRedisStorage } from '@splitsoftware/splitio-commons/src/storages/inRedis';
 import { InMemoryStorageFactory } from '@splitsoftware/splitio-commons/src/storages/inMemory/InMemoryStorage';
+import { getSnapshot } from '@splitsoftware/splitio-commons/src/storages/dataLoader';
 import { sdkManagerFactory } from '@splitsoftware/splitio-commons/src/sdkManager';
 import { sdkClientMethodFactory } from '@splitsoftware/splitio-commons/src/sdkClient/sdkClientMethod';
 import { impressionObserverSSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverSS';
@@ -47,7 +48,17 @@ function getModules(settings) {
 
     impressionsObserverFactory: impressionObserverSSFactory,
 
-    filterAdapterFactory: bloomFilterFactory
+    filterAdapterFactory: bloomFilterFactory,
+
+    extraProps: (params) => {
+      if (params.settings.mode !== CONSUMER_MODE) {
+        return {
+          getState(userKeys) {
+            return getSnapshot(params.storage, userKeys);
+          }
+        };
+      }
+    }
   };
 
   switch (settings.mode) {

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '11.0.0-rc.0';
+export const packageVersion = '11.0.0-rc.1';

package/types/splitio.d.ts

@@ -92,6 +92,7 @@ interface ISettings {
     options: Object,
     type: StorageType
   },
+  readonly preloadedData?: SplitIO.PreloadedData,
   readonly urls: {
     events: string,
     sdk: string,
@@ -441,7 +442,17 @@ interface IStatusInterface extends EventEmitter {
   /**
    * Returns a promise that resolves once the SDK has finished loading (`SDK_READY` event emitted) or rejected if the SDK has timedout (`SDK_READY_TIMED_OUT` event emitted).
    * As it's meant to provide similar flexibility to the event approach, given that the SDK might be eventually ready after a timeout event, the `ready` 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 you can set the `startup.readyTimeout` configuration option to 0 to avoid the timeout and thus the rejection.
+   *
+   * Caveats: the method was designed to avoid an unhandled Promise rejection if the rejection case is not handled, so that `onRejected` handler is optional when using promises.
+   * However, when using async/await syntax, the rejection should be explicitly propagated like in the following example:
+   * ```
+   * try {
+   *   await client.ready().catch((e) => { throw e; });
+   *   // SDK is ready
+   * } catch(e) {
+   *   // SDK has timedout
+   * }
+   * ```
    *
    * @function ready
    * @returns {Promise<void>}
@@ -788,6 +799,10 @@ declare namespace SplitIO {
    * @typedef {string} ConsentStatus
    */
   type ConsentStatus = 'GRANTED' | 'DECLINED' | 'UNKNOWN';
+  /**
+   * Defines the format of rollout plan data to preload on the factory storage (cache).
+   */
+  type PreloadedData = Object;
   /**
    * Settings interface for SDK instances created on the browser
    * @interface IBrowserSettings
@@ -946,6 +961,10 @@ declare namespace SplitIO {
        */
       prefix?: string
     },
+    /**
+     * @TODO Add description. Should be inside storage?
+     */
+    preloadedData?: SplitIO.PreloadedData,
     /**
      * List of URLs that the SDK will use as base for it's synchronization functionalities, applicable only when running as standalone.
      * Do not change these settings unless you're working an advanced use case, like connecting to the Split proxy.
@@ -1211,7 +1230,11 @@ declare namespace SplitIO {
      * @function manager
      * @returns {IManager} The manager instance.
      */
-    manager(): IManager
+    manager(): IManager,
+    /**
+     * @TODO add description
+     */
+    getState(keys?: SplitKey[]): PreloadedData,
   }
   /**
    * This represents the interface for the SDK instance with synchronous storage.