@splitsoftware/splitio 10.28.1-rc.1 → 10.28.1-rc.3

package/CHANGES.txt

@@ -1,7 +1,9 @@
 10.29.0 (September XX, 2024)
+ - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
  - Updated @splitsoftware/splitio-commons package to version 1.18.0 that includes minor updates:
     - Added support for targeting rules based on large segments for browsers.
     - Updated some transitive dependencies for vulnerability fixes.
+ - 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.
 
 10.28.0 (September 6, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:

package/es/factory/browser.js

@@ -8,7 +8,6 @@ import { sdkManagerFactory } from '@splitsoftware/splitio-commons/esm/sdkManager
 import { sdkClientMethodCSFactory } from '@splitsoftware/splitio-commons/esm/sdkClient/sdkClientMethodCSWithTT';
 import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/impressionObserverCS';
 import { integrationsManagerFactory } from '@splitsoftware/splitio-commons/esm/integrations/browser';
-import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/storage/storageCS';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 import { createUserConsentAPI } from '@splitsoftware/splitio-commons/esm/consent/sdkUserConsent';
@@ -17,10 +16,8 @@ import { platform, SignalListener } from '../platform';
 var syncManagerOnlineCSFactory = syncManagerOnlineFactory(pollingManagerCSFactory, pushManagerFactory);
 function getStorage(settings) {
     return settings.storage.type === STORAGE_LOCALSTORAGE ?
-        InLocalStorage(settings.storage)
-        : settings.storage.__originalType === STORAGE_LOCALSTORAGE ?
-            __InLocalStorageMockFactory
-            : InMemoryStorageCSFactory;
+        InLocalStorage(settings.storage) :
+        InMemoryStorageCSFactory;
 }
 /**
  *

package/es/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/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.28.1-rc.1';
+export var packageVersion = '10.28.1-rc.3';

package/es/settings/storage/browser.js

@@ -1,29 +1,18 @@
 import { isLocalStorageAvailable } from '@splitsoftware/splitio-commons/esm/utils/env/isLocalStorageAvailable';
-import { LOCALHOST_MODE, STORAGE_MEMORY } from '@splitsoftware/splitio-commons/esm/utils/constants';
+import { STORAGE_MEMORY } from '@splitsoftware/splitio-commons/esm/utils/constants';
 var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 export function validateStorage(settings) {
-    var log = settings.log, mode = settings.mode, _a = settings.storage, _b = _a === void 0 ? { type: STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
-    var __originalType;
-    var fallbackToMemory = function () {
-        __originalType = type;
-        type = STORAGE_MEMORY;
-    };
-    // In localhost mode, fallback to Memory storage and track original type to emit SDK_READY_FROM_CACHE if corresponds.
-    // ATM, other mode settings (e.g., 'consumer') are ignored in client-side API, and so treated as standalone.
-    if (mode === LOCALHOST_MODE && type === STORAGE_LOCALSTORAGE) {
-        fallbackToMemory();
-    }
+    var log = settings.log, _a = settings.storage, _b = _a === void 0 ? { type: STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
     // If an invalid storage type is provided OR we want to use LOCALSTORAGE and
     // it's not available, fallback into MEMORY
     if (type !== STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
         type === STORAGE_LOCALSTORAGE && !isLocalStorageAvailable()) {
-        fallbackToMemory();
+        type = STORAGE_MEMORY;
         log.error('Invalid or unavailable storage. Fallback into MEMORY storage');
     }
     return {
         type: type,
         options: options,
         prefix: prefix,
-        __originalType: __originalType
     };
 }

package/lib/factory/browser.js

@@ -11,7 +11,6 @@ var sdkManager_1 = require("@splitsoftware/splitio-commons/cjs/sdkManager");
 var sdkClientMethodCSWithTT_1 = require("@splitsoftware/splitio-commons/cjs/sdkClient/sdkClientMethodCSWithTT");
 var impressionObserverCS_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/impressionObserverCS");
 var browser_1 = require("@splitsoftware/splitio-commons/cjs/integrations/browser");
-var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/storage/storageCS");
 var sdkFactory_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var sdkUserConsent_1 = require("@splitsoftware/splitio-commons/cjs/consent/sdkUserConsent");
@@ -20,10 +19,8 @@ var platform_1 = require("../platform");
 var syncManagerOnlineCSFactory = (0, syncManagerOnline_1.syncManagerOnlineFactory)(pollingManagerCS_1.pollingManagerCSFactory, pushManager_1.pushManagerFactory);
 function getStorage(settings) {
     return settings.storage.type === constants_1.STORAGE_LOCALSTORAGE ?
-        (0, inLocalStorage_1.InLocalStorage)(settings.storage)
-        : settings.storage.__originalType === constants_1.STORAGE_LOCALSTORAGE ?
-            storageCS_1.__InLocalStorageMockFactory
-            : InMemoryStorageCS_1.InMemoryStorageCSFactory;
+        (0, inLocalStorage_1.InLocalStorage)(settings.storage) :
+        InMemoryStorageCS_1.InMemoryStorageCSFactory;
 }
 /**
  *

package/lib/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/lib/settings/defaults/version.js

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

package/lib/settings/storage/browser.js

@@ -5,29 +5,18 @@ var isLocalStorageAvailable_1 = require("@splitsoftware/splitio-commons/cjs/util
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 function validateStorage(settings) {
-    var log = settings.log, mode = settings.mode, _a = settings.storage, _b = _a === void 0 ? { type: constants_1.STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
-    var __originalType;
-    var fallbackToMemory = function () {
-        __originalType = type;
-        type = constants_1.STORAGE_MEMORY;
-    };
-    // In localhost mode, fallback to Memory storage and track original type to emit SDK_READY_FROM_CACHE if corresponds.
-    // ATM, other mode settings (e.g., 'consumer') are ignored in client-side API, and so treated as standalone.
-    if (mode === constants_1.LOCALHOST_MODE && type === STORAGE_LOCALSTORAGE) {
-        fallbackToMemory();
-    }
+    var log = settings.log, _a = settings.storage, _b = _a === void 0 ? { type: constants_1.STORAGE_MEMORY } : _a, type = _b.type, _c = _b.options, options = _c === void 0 ? {} : _c, prefix = _b.prefix;
     // If an invalid storage type is provided OR we want to use LOCALSTORAGE and
     // it's not available, fallback into MEMORY
     if (type !== constants_1.STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
         type === STORAGE_LOCALSTORAGE && !(0, isLocalStorageAvailable_1.isLocalStorageAvailable)()) {
-        fallbackToMemory();
+        type = constants_1.STORAGE_MEMORY;
         log.error('Invalid or unavailable storage. Fallback into MEMORY storage');
     }
     return {
         type: type,
         options: options,
         prefix: prefix,
-        __originalType: __originalType
     };
 }
 exports.validateStorage = validateStorage;

package/package.json

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

package/src/factory/browser.js

@@ -8,7 +8,6 @@ import { sdkManagerFactory } from '@splitsoftware/splitio-commons/src/sdkManager
 import { sdkClientMethodCSFactory } from '@splitsoftware/splitio-commons/src/sdkClient/sdkClientMethodCSWithTT';
 import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverCS';
 import { integrationsManagerFactory } from '@splitsoftware/splitio-commons/src/integrations/browser';
-import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/storage/storageCS';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/src/utils/constants';
 import { createUserConsentAPI } from '@splitsoftware/splitio-commons/src/consent/sdkUserConsent';
@@ -20,10 +19,8 @@ const syncManagerOnlineCSFactory = syncManagerOnlineFactory(pollingManagerCSFact
 
 function getStorage(settings) {
   return settings.storage.type === STORAGE_LOCALSTORAGE ?
-    InLocalStorage(settings.storage)
-    : settings.storage.__originalType === STORAGE_LOCALSTORAGE ?
-      __InLocalStorageMockFactory
-      : InMemoryStorageCSFactory;
+    InLocalStorage(settings.storage) :
+    InMemoryStorageCSFactory;
 }
 
 /**

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 = '10.28.1-rc.1';
+export const packageVersion = '10.28.1-rc.3';

package/src/settings/storage/browser.js

@@ -1,36 +1,23 @@
 import { isLocalStorageAvailable } from '@splitsoftware/splitio-commons/src/utils/env/isLocalStorageAvailable';
-import { LOCALHOST_MODE, STORAGE_MEMORY } from '@splitsoftware/splitio-commons/src/utils/constants';
+import { STORAGE_MEMORY } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 const STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 
 export function validateStorage(settings) {
   let {
     log,
-    mode,
     storage: {
       type,
       options = {},
       prefix
     } = { type: STORAGE_MEMORY },
   } = settings;
-  let __originalType;
-
-  const fallbackToMemory = () => {
-    __originalType = type;
-    type = STORAGE_MEMORY;
-  };
-
-  // In localhost mode, fallback to Memory storage and track original type to emit SDK_READY_FROM_CACHE if corresponds.
-  // ATM, other mode settings (e.g., 'consumer') are ignored in client-side API, and so treated as standalone.
-  if (mode === LOCALHOST_MODE && type === STORAGE_LOCALSTORAGE) {
-    fallbackToMemory();
-  }
 
   // If an invalid storage type is provided OR we want to use LOCALSTORAGE and
   // it's not available, fallback into MEMORY
   if (type !== STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
     type === STORAGE_LOCALSTORAGE && !isLocalStorageAvailable()) {
-    fallbackToMemory();
+    type = STORAGE_MEMORY;
     log.error('Invalid or unavailable storage. Fallback into MEMORY storage');
   }
 
@@ -38,6 +25,5 @@ export function validateStorage(settings) {
     type,
     options,
     prefix,
-    __originalType
   };
 }

package/types/splitio.d.ts

@@ -94,6 +94,7 @@ interface ISettings {
     options: Object,
     type: StorageType
   },
+  readonly preloadedData?: SplitIO.PreloadedData,
   readonly urls: {
     events: string,
     sdk: string,
@@ -491,6 +492,12 @@ interface IBasicSDK {
    * @property Logger
    */
   Logger: ILoggerAPI
+  /**
+   * Destroys all the clients created by this factory.
+   * @function destroy
+   * @returns {Promise<void>}
+   */
+  destroy(): Promise<void>
 }
 /****** Exposed namespace ******/
 /**
@@ -947,6 +954,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
@@ -1374,27 +1385,23 @@ declare namespace SplitIO {
      * @returns {IClient} The client instance.
      */
     client(): IClient,
-    /**
-     * Returns a shared client of the SDK. For usage on the browser.
-     * @function client
-     * @param {SplitKey} key The key for the new client instance.
-     * @param {string=} trafficType The traffic type of the provided key.
-     * @returns {IClient} The client instance.
-     */
-    client(key: SplitKey, trafficType?: string): IClient,
     /**
      * Returns a manager instance of the SDK to explore available information.
      * @function manager
      * @returns {IManager} The manager instance.
      */
-    manager(): IManager
+    manager(): IManager,
+    /**
+     * @TODO add description
+     */
+    getState(): PreloadedData,
   }
   /**
    * This represents the interface for the SDK instance with synchronous storage.
    * @interface IBrowserSDK
-   * @extends ISDK
+   * @extends IBasicSDK
    */
-  interface IBrowserSDK extends ISDK {
+  interface IBrowserSDK extends IBasicSDK {
     /**
      * Returns the default client instance of the SDK.
      * @function client
@@ -1402,7 +1409,7 @@ declare namespace SplitIO {
      */
     client(): IBrowserClient,
     /**
-     * Returns a shared client of the SDK. For usage on the browser.
+     * Returns a shared client of the SDK.
      * @function client
      * @param {SplitKey} key The key for the new client instance.
      * @param {string=} trafficType The traffic type of the provided key.