@splitsoftware/splitio-commons 2.0.0-rc.6 → 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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.0.0-rc.6",
+  "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/types/splitio.d.ts

@@ -84,7 +84,7 @@ interface ISharedSettings {
   urls?: SplitIO.UrlSettings;
 }
 /**
- * Common settings properties for SDKs with synchronous API (standalone  and localhost modes).
+ * Common settings properties for SDKs with synchronous API (standalone and localhost modes).
  */
 interface ISyncSharedSettings extends ISharedSettings {
   /**
@@ -117,9 +117,9 @@ interface ISyncSharedSettings extends ISharedSettings {
   };
 }
 /**
- * Common settings properties for SDKs with pluggable configuration.
+ * Common settings properties for SDKs with pluggable options.
  */
-interface IPluggableSettings {
+interface IPluggableSharedSettings {
   /**
    * Boolean value to indicate whether the logger should be enabled or disabled by default, or a log level string or a Logger object.
    * Passing a logger object is required to get descriptive log messages. Otherwise most logs will print with message codes.
@@ -143,9 +143,9 @@ interface IPluggableSettings {
   integrations?: SplitIO.IntegrationFactory[];
 }
 /**
- * Common settings properties for SDKs without pluggable configuration.
+ * Common settings properties for SDKs without pluggable options.
  */
-interface INonPluggableSettings {
+interface INonPluggableSharedSettings {
   /**
    * Boolean value to indicate whether the logger should be enabled or disabled, or a log level string.
    *
@@ -160,7 +160,7 @@ interface INonPluggableSettings {
   debug?: boolean | SplitIO.LogLevel;
 }
 /**
- * Common settings properties for server-side SDKs.
+ * Common settings properties for SDKs with server-side API.
  */
 interface IServerSideSharedSettings {
   /**
@@ -295,7 +295,7 @@ interface IServerSideSharedSettings {
   features?: SplitIO.MockedFeaturesFilePath;
 }
 /**
- * Common settings properties for client-side SDKs.
+ * Common settings properties for SDKs with client-side API.
  */
 interface IClientSideSharedSettings {
   /**
@@ -333,7 +333,7 @@ interface IClientSideSharedSettings {
   userConsent?: SplitIO.ConsentStatus;
 }
 /**
- * Common settings properties for client-side standalone SDKs.
+ * Common settings properties for SDKs with client-side and synchronous API (standalone and localhost modes).
  */
 interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISyncSharedSettings {
   /**
@@ -1096,7 +1096,7 @@ declare namespace SplitIO {
    *
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
    */
-  interface IClientSideSettings extends IClientSideSyncSharedSettings, IPluggableSettings {
+  interface IClientSideSettings extends IClientSideSyncSharedSettings, IPluggableSharedSettings {
     /**
      * Defines the factory function to instantiate the storage. If not provided, the default in-memory storage is used.
      *
@@ -1124,7 +1124,7 @@ declare namespace SplitIO {
    *
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
    */
-  interface IClientSideAsyncSettings extends IClientSideSharedSettings, ISharedSettings, IPluggableSettings {
+  interface IClientSideAsyncSettings extends IClientSideSharedSettings, ISharedSettings, IPluggableSharedSettings {
     /**
      * The SDK mode. When using `PluggableStorage` as storage, the possible values are "consumer" and "consumer_partial".
      *
@@ -1216,7 +1216,7 @@ declare namespace SplitIO {
    *
    * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#configuration}
    */
-  interface IBrowserSettings extends IClientSideSyncSharedSettings, INonPluggableSettings {
+  interface IBrowserSettings extends IClientSideSyncSharedSettings, INonPluggableSharedSettings {
     /**
      * Defines which kind of storage we can instantiate on the browser.
      * Possible storage types are 'MEMORY', which is the default, and 'LOCALSTORAGE'.
@@ -1242,7 +1242,7 @@ declare namespace SplitIO {
    *
    * @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
    */
-  interface INodeSettings extends IServerSideSharedSettings, ISyncSharedSettings, INonPluggableSettings {
+  interface INodeSettings extends IServerSideSharedSettings, ISyncSharedSettings, INonPluggableSharedSettings {
     /**
      * Defines which kind of storage we can instantiate on NodeJS for 'standalone' mode.
      * The only possible storage type is 'MEMORY', which is the default.
@@ -1324,7 +1324,7 @@ declare namespace SplitIO {
    *
    * @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
    */
-  interface INodeAsyncSettings extends IServerSideSharedSettings, ISharedSettings, INonPluggableSettings {
+  interface INodeAsyncSettings extends IServerSideSharedSettings, ISharedSettings, INonPluggableSharedSettings {
     /**
      * The SDK mode. When using 'REDIS' storage type, the only possible value is "consumer", which is required.
      *