@splitsoftware/splitio-commons 2.0.0-rc.5 → 2.0.0

package/CHANGES.txt

@@ -1,11 +1,11 @@
-2.0.0 (October XX, 2024)
+2.0.0 (November 1, 2024)
  - Added support for targeting rules based on large segments.
  - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
- - Added `SplitIO` namespace with the public TypeScript definitions to be reused by the SDKs, rather than having each SDK define its own types.
+ - Added `SplitIO` namespace with the public TypeScript definitions to be reused by the SDKs.
  - Updated the handling of timers and async operations inside an `init` factory method to enable lazy initialization of the SDK in standalone mode. This update is intended for the React SDK.
  - Bugfixing - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
  - BREAKING CHANGES:
-   - Updated default flag spec version to 1.2.
+   - Updated default flag spec version to 1.2, which requires Split Proxy v5.9.0 or higher.
    - Removed `/mySegments` endpoint from SplitAPI module, as it is replaced by `/memberships` endpoint.
    - Removed support for MY_SEGMENTS_UPDATE and MY_SEGMENTS_UPDATE_V2 notification types, as they are replaced by MEMBERSHIPS_MS_UPDATE and MEMBERSHIPS_LS_UPDATE notification types.
    - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations.

package/cjs/readiness/readinessManager.js

@@ -7,7 +7,7 @@ function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = (0, objectAssign_1.objectAssign)(new EventEmitter(), {
         splitsArrived: false,
         splitsCacheLoaded: false,
-        initialized: false,
+        hasInit: false,
         initCallbacks: []
     });
     // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
@@ -56,7 +56,7 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
     }
     var readyTimeoutId;
     if (readyTimeout > 0) {
-        if (splits.initialized)
+        if (splits.hasInit)
             readyTimeoutId = setTimeout(timeout, readyTimeout);
         else
             splits.initCallbacks.push(function () { readyTimeoutId = setTimeout(timeout, readyTimeout); });
@@ -122,9 +122,9 @@ function readinessManagerFactory(EventEmitter, settings, splits) {
         // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
         setDestroyed: function () { isDestroyed = true; },
         init: function () {
-            if (splits.initialized)
+            if (splits.hasInit)
                 return;
-            splits.initialized = true;
+            splits.hasInit = true;
             splits.initCallbacks.forEach(function (cb) { return cb(); });
         },
         destroy: function () {

package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js

@@ -4,11 +4,6 @@ exports.UniqueKeysCacheInMemoryCS = void 0;
 var constants_1 = require("../inRedis/constants");
 var sets_1 = require("../../utils/lang/sets");
 var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
-    /**
-     *
-     * @param impressionsQueueSize - number of queued impressions to call onFullQueueCb.
-     * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
-     */
     function UniqueKeysCacheInMemoryCS(uniqueKeysQueueSize) {
         if (uniqueKeysQueueSize === void 0) { uniqueKeysQueueSize = constants_1.DEFAULT_CACHE_SIZE; }
         this.uniqueTrackerSize = 0;

package/esm/readiness/readinessManager.js

@@ -4,7 +4,7 @@ function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = objectAssign(new EventEmitter(), {
         splitsArrived: false,
         splitsCacheLoaded: false,
-        initialized: false,
+        hasInit: false,
         initCallbacks: []
     });
     // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
@@ -53,7 +53,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
     }
     var readyTimeoutId;
     if (readyTimeout > 0) {
-        if (splits.initialized)
+        if (splits.hasInit)
             readyTimeoutId = setTimeout(timeout, readyTimeout);
         else
             splits.initCallbacks.push(function () { readyTimeoutId = setTimeout(timeout, readyTimeout); });
@@ -119,9 +119,9 @@ export function readinessManagerFactory(EventEmitter, settings, splits) {
         // tracking and evaluations, while keeping event listeners to emit SDK_READY_TIMED_OUT event
         setDestroyed: function () { isDestroyed = true; },
         init: function () {
-            if (splits.initialized)
+            if (splits.hasInit)
                 return;
-            splits.initialized = true;
+            splits.hasInit = true;
             splits.initCallbacks.forEach(function (cb) { return cb(); });
         },
         destroy: function () {

package/esm/storages/inMemory/UniqueKeysCacheInMemoryCS.js

@@ -1,11 +1,6 @@
 import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { setToArray } from '../../utils/lang/sets';
 var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
-    /**
-     *
-     * @param impressionsQueueSize - number of queued impressions to call onFullQueueCb.
-     * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
-     */
     function UniqueKeysCacheInMemoryCS(uniqueKeysQueueSize) {
         if (uniqueKeysQueueSize === void 0) { uniqueKeysQueueSize = DEFAULT_CACHE_SIZE; }
         this.uniqueTrackerSize = 0;

package/package.json

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

package/src/readiness/readinessManager.ts

@@ -8,7 +8,7 @@ function splitsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter
   const splitsEventEmitter = objectAssign(new EventEmitter(), {
     splitsArrived: false,
     splitsCacheLoaded: false,
-    initialized: false,
+    hasInit: false,
     initCallbacks: []
   });
 
@@ -68,7 +68,7 @@ export function readinessManagerFactory(
 
   let readyTimeoutId: ReturnType<typeof setTimeout>;
   if (readyTimeout > 0) {
-    if (splits.initialized) readyTimeoutId = setTimeout(timeout, readyTimeout);
+    if (splits.hasInit) readyTimeoutId = setTimeout(timeout, readyTimeout);
     else splits.initCallbacks.push(() => { readyTimeoutId = setTimeout(timeout, readyTimeout); });
   }
 
@@ -137,8 +137,8 @@ export function readinessManagerFactory(
     setDestroyed() { isDestroyed = true; },
 
     init() {
-      if (splits.initialized) return;
-      splits.initialized = true;
+      if (splits.hasInit) return;
+      splits.hasInit = true;
       splits.initCallbacks.forEach(cb => cb());
     },
 

package/src/readiness/types.ts

@@ -13,7 +13,7 @@ export interface ISplitsEventEmitter extends SplitIO.IEventEmitter {
   once(event: ISplitsEvent, listener: (...args: any[]) => void): this;
   splitsArrived: boolean
   splitsCacheLoaded: boolean
-  initialized: boolean,
+  hasInit: boolean,
   initCallbacks: (() => void)[]
 }
 

package/src/sdkClient/client.ts

@@ -25,7 +25,7 @@ function treatmentsNotReady(featureFlagNames: string[]) {
 /**
  * Creator of base client with getTreatments and track methods.
  */
-export function clientFactory(params: ISdkFactoryContext): SplitIO.INodeClient | SplitIO.INodeAsyncClient {
+export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | SplitIO.IAsyncClient {
   const { sdkReadinessManager: { readinessManager }, storage, settings, impressionsTracker, eventTracker, telemetryTracker } = params;
   const { log, mode } = settings;
   const isAsync = isConsumerMode(mode);
@@ -199,5 +199,5 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.INodeClient |
     getTreatmentsByFlagSet,
     getTreatmentsWithConfigByFlagSet,
     track,
-  } as SplitIO.INodeClient | SplitIO.INodeAsyncClient;
+  } as SplitIO.IClient | SplitIO.IAsyncClient;
 }

package/src/sdkClient/clientAttributesDecoration.ts

@@ -7,7 +7,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
 /**
  * Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call
  */
-export function clientAttributesDecoration<TClient extends SplitIO.INodeClient | SplitIO.INodeAsyncClient>(log: ILogger, client: TClient) {
+export function clientAttributesDecoration<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(log: ILogger, client: TClient) {
 
   const attributeStorage = new AttributesCacheInMemory();
 

package/src/sdkClient/clientCS.ts

@@ -10,7 +10,7 @@ import { clientAttributesDecoration } from './clientAttributesDecoration';
  * @param client - sync client instance
  * @param key - validated split key
  */
-export function clientCSDecorator(log: ILogger, client: SplitIO.INodeClient, key: SplitIO.SplitKey): SplitIO.IClient {
+export function clientCSDecorator(log: ILogger, client: SplitIO.IClient, key: SplitIO.SplitKey): SplitIO.IBrowserClient {
 
   let clientCS = clientAttributesDecoration(log, client);
 
@@ -30,5 +30,5 @@ export function clientCSDecorator(log: ILogger, client: SplitIO.INodeClient, key
     // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)
     isClientSide: true,
     key
-  }) as SplitIO.IClient;
+  }) as SplitIO.IBrowserClient;
 }

package/src/sdkClient/clientInputValidation.ts

@@ -24,7 +24,7 @@ import { validateFlagSets } from '../utils/settingsValidation/splitFilters';
  * Decorator that validates the input before actually executing the client methods.
  * We should "guard" the client here, while not polluting the "real" implementation of those methods.
  */
-export function clientInputValidationDecorator<TClient extends SplitIO.INodeClient | SplitIO.INodeAsyncClient>(settings: ISettings, client: TClient, readinessManager: IReadinessManager): TClient {
+export function clientInputValidationDecorator<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(settings: ISettings, client: TClient, readinessManager: IReadinessManager): TClient {
 
   const { log, mode } = settings;
   const isAsync = isConsumerMode(mode);

package/src/sdkClient/sdkClient.ts

@@ -10,7 +10,7 @@ const COOLDOWN_TIME_IN_MILLIS = 1000;
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.INodeClient | SplitIO.INodeAsyncClient {
+export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient {
   const { sdkReadinessManager, syncManager, storage, signalListener, settings, telemetryTracker, uniqueKeysTracker } = params;
 
   let lastActionTime = 0;

package/src/sdkClient/sdkClientMethod.ts

@@ -6,7 +6,7 @@ import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Factory of client method for server-side SDKs
  */
-export function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.INodeClient | SplitIO.INodeAsyncClient {
+export function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.IClient | SplitIO.IAsyncClient {
   const log = params.settings.log;
   const clientInstance = sdkClientFactory(params);
 

package/src/sdkClient/sdkClientMethodCS.ts

@@ -14,12 +14,12 @@ import { buildInstanceId } from './identity';
  * Factory of client method for the client-side API variant where TT is ignored.
  * Therefore, clients don't have a bound TT for the track method.
  */
-export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.IClient {
+export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.IBrowserClient {
   const { clients, storage, syncManager, sdkReadinessManager, settings: { core: { key }, log } } = params;
 
   const mainClientInstance = clientCSDecorator(
     log,
-    sdkClientFactory(params) as SplitIO.INodeClient,
+    sdkClientFactory(params) as SplitIO.IClient,
     key
   );
 
@@ -71,7 +71,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
           sdkReadinessManager: sharedSdkReadiness,
           storage: sharedStorage || storage,
           syncManager: sharedSyncManager,
-        }), true) as SplitIO.INodeClient,
+        }), true) as SplitIO.IClient,
         validKey
       );
 
@@ -80,6 +80,6 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
       log.debug(RETRIEVE_CLIENT_EXISTING);
     }
 
-    return clients[instanceId] as SplitIO.IClient;
+    return clients[instanceId] as SplitIO.IBrowserClient;
   };
 }

package/src/sdkFactory/index.ts

@@ -18,7 +18,7 @@ import { NONE, OPTIMIZED } from '../utils/constants';
 /**
  * Modular SDK factory
  */
-export function sdkFactory(params: ISdkFactoryParams): SplitIO.INodeSDK | SplitIO.INodeAsyncSDK | SplitIO.ISDK | SplitIO.IAsyncSDK {
+export function sdkFactory(params: ISdkFactoryParams): SplitIO.ISDK | SplitIO.IAsyncSDK | SplitIO.IBrowserSDK | SplitIO.IBrowserAsyncSDK {
 
   const { settings, platform, storageFactory, splitApiFactory, extraProps,
     syncManagerFactory, SignalListener, impressionsObserverFactory,

package/src/sdkFactory/types.ts

@@ -79,7 +79,7 @@ export interface ISdkFactoryParams {
   platform: IPlatform,
 
   // Storage factory. The result storage type implies the type of the SDK:
-  // sync SDK (`ISDK` and `INodeSDK`) with `IStorageSync`, and async SDK (`IAsyncSDK` and `INodeAsyncSDK`) with `IStorageAsync`
+  // sync SDK (`IBrowserSDK` and `ISDK`) with `IStorageSync`, and async SDK (`IBrowserAsyncSDK` and `IAsyncSDK`) with `IStorageAsync`
   storageFactory: (params: IStorageFactoryParams) => IStorageSync | IStorageAsync,
 
   // Factory of Split Api (HTTP Client Service).
@@ -94,9 +94,9 @@ export interface ISdkFactoryParams {
   // Sdk manager factory
   sdkManagerFactory: typeof sdkManagerFactory,
 
-  // Sdk client method factory (ISDK::client method).
-  // It Allows to distinguish SDK clients with the client-side API (`ISDK` and `IAsyncSDK`) or server-side API (`INodeSDK` and `INodeAsyncSDK`).
-  sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.IClient; (key: SplitIO.SplitKey): SplitIO.IClient; } | (() => SplitIO.INodeClient) | (() => SplitIO.INodeAsyncClient))
+  // Sdk client method factory.
+  // It Allows to distinguish SDK clients with the client-side API (`IBrowserSDK` and `IBrowserAsyncSDK`) or server-side API (`ISDK` and `IAsyncSDK`).
+  sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.IBrowserClient; (key: SplitIO.SplitKey): SplitIO.IBrowserClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient))
 
   // Impression observer factory.
   impressionsObserverFactory: () => IImpressionObserver

package/src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts

@@ -10,11 +10,6 @@ export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
   private uniqueTrackerSize = 0;
   private uniqueKeysTracker: { [userKey: string]: Set<string> } = {};
 
-  /**
-   *
-   * @param impressionsQueueSize - number of queued impressions to call onFullQueueCb.
-   * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
-   */
   constructor(uniqueKeysQueueSize = DEFAULT_CACHE_SIZE) {
     this.maxStorage = uniqueKeysQueueSize;
   }