@splitsoftware/splitio 10.17.4-rc.2 → 10.17.4-rc.3

package/CHANGES.txt

@@ -7,6 +7,7 @@
       - Updated dependencies for vulnerability fixes
       - Bugfixing - Logger settings is configurable per factory instance instead of globally.
       - Bugfixing - Wrongly logging warning 'No listeners for SDK Readiness detected' in consumer mode.
+      - Bugfixing - Updated internal `isObject` util that was returning false negatives on some environment, like Nuxt dev server or Miniflare.
   - Added TLS support for Redis
   -
 

package/es/settings/browser.js

@@ -8,7 +8,7 @@ import { LocalhostFromObject } from '@splitsoftware/splitio-commons/esm/sync/off
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
 var params = {
     defaults: defaults,
-    isClientSide: true,
+    acceptKey: true, acceptTT: true,
     runtime: validateRuntime,
     storage: validateStorage,
     integrations: validateIntegrations,

package/es/settings/defaults/version.js

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

package/lib/settings/browser.js

@@ -11,7 +11,7 @@ var LocalhostFromObject_1 = require("@splitsoftware/splitio-commons/cjs/sync/off
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
 var params = {
     defaults: browser_1.defaults,
-    isClientSide: true,
+    acceptKey: true, acceptTT: true,
     runtime: runtime_1.validateRuntime,
     storage: browser_2.validateStorage,
     integrations: browser_3.validateIntegrations,

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.17.4-rc.2';
+exports.packageVersion = '10.17.4-rc.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.17.4-rc.2",
+  "version": "10.17.4-rc.3",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -32,7 +32,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.2.1-rc.9",
+    "@splitsoftware/splitio-commons": "1.2.1-rc.10",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "ioredis": "^4.28.0",

package/src/settings/browser.js

@@ -9,7 +9,7 @@ import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settin
 
 const params = {
   defaults,
-  isClientSide: true,
+  acceptKey: true, acceptTT: true, // Client with bound key and optional TT
   runtime: validateRuntime,
   storage: validateStorage,
   integrations: validateIntegrations,

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.17.4-rc.2';
+export const packageVersion = '10.17.4-rc.3';

package/types/splitio.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Javascript and Node Split Software SDK
+// Type definitions for Javascript and NodeJS Split Software SDK
 // Project: http://www.split.io/
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
@@ -98,7 +98,7 @@ interface ISettings {
   readonly debug: boolean | LogLevel,
   readonly version: string,
   /**
-   * Mocked features map if using in browser, or mocked features file path string if using in Node.
+   * Mocked features map if using in browser, or mocked features file path string if using in NodeJS.
    */
   features: SplitIO.MockedFeaturesMap | SplitIO.MockedFeaturesFilePath,
   readonly streamingEnabled: boolean,
@@ -107,7 +107,7 @@ interface ISettings {
     impressionsMode: SplitIO.ImpressionsMode,
   }
   /**
-   * User consent status if using in browser. Undefined if using in Node.
+   * User consent status if using in browser. Undefined if using in NodeJS.
    */
   readonly userConsent?: SplitIO.ConsentStatus
 }
@@ -326,7 +326,7 @@ interface INodeBasicSettings extends ISharedSettings {
     IPAddressesEnabled?: boolean
   },
   /**
-   * Defines which kind of storage we should instanciate.
+   * Defines which kind of storage we should instantiate.
    * @property {Object} storage
    */
   storage?: {
@@ -337,10 +337,10 @@ interface INodeBasicSettings extends ISharedSettings {
      */
     type?: StorageType,
     /**
-     * Options to be passed to the selected storage. Use it with type: 'REDIS'
-     * @property {SplitIO.RedisStorageOptions} options
+     * Options to be passed to the selected storage.
+     * @property {Object} options
      */
-    options?: SplitIO.RedisStorageOptions,
+    options?: Object,
     /**
      * Optional prefix to prevent any kind of data collision between SDK versions.
      * @property {string} prefix
@@ -639,69 +639,6 @@ declare namespace SplitIO {
    * @typedef {string} BrowserStorage
    */
   type BrowserStorage = 'MEMORY' | 'LOCALSTORAGE';
-  /**
-   * Options to be passed to the Redis storage. Use it with storage type: 'REDIS'.
-   * @typedef {Object} RedisStorageOptions
-   */
-  type RedisStorageOptions = {
-    /**
-     * Redis URL. If set, `host`, `port`, `db` and `pass` params will be ignored.
-     *
-     * Examples:
-     * ```
-     *   url: 'localhost'
-     *   url: '127.0.0.1:6379'
-     *   url: 'redis://:authpassword@127.0.0.1:6379/0'
-     * ```
-     * @property {string=} url
-     */
-    url?: string,
-    /**
-     * Redis host.
-     * @property {string=} host
-     * @default 'localhost'
-     */
-    host?: string,
-    /**
-     * Redis port.
-     * @property {number=} port
-     * @default 6379
-     */
-    port?: number,
-    /**
-     * Redis database to be used.
-     * @property {number=} db
-     * @default 0
-     */
-    db?: number,
-    /**
-     * Redis password. Don't define if no password is used.
-     * @property {string=} pass
-     * @default undefined
-     */
-    pass?: string,
-    /**
-     * The milliseconds before a timeout occurs during the initial connection to the Redis server.
-     * @property {number=} connectionTimeout
-     * @default 10000
-     */
-    connectionTimeout?: number,
-    /**
-     * The milliseconds before Redis commands are timeout by the SDK.
-     * Method calls that involve Redis commands, like `client.getTreatment` or `client.track` calls, are resolved when the commands success or timeout.
-     * @property {number=} operationTimeout
-     * @default 5000
-     */
-    operationTimeout?: number,
-    /**
-     * TLS configuration for Redis connection.
-     * @see {@link https://www.npmjs.com/package/ioredis#tls-options }
-     *
-     * @property {Object=} tls
-     * @default undefined
-     */
-    tls?: RedisOptions['tls'],
-  }
   /**
    * Impression listener interface. This is the interface that needs to be implemented
    * by the element you provide to the SDK as impression listener.
@@ -1049,7 +986,8 @@ declare namespace SplitIO {
      */
     features?: MockedFeaturesMap,
     /**
-     * Defines which kind of storage we should instanciate.
+     * Defines which kind of storage we can instantiate on the browser.
+     * Possible storage types are 'MEMORY', which is the default, and 'LOCALSTORAGE'.
      * @property {Object} storage
      */
     storage?: {
@@ -1104,7 +1042,8 @@ declare namespace SplitIO {
      */
     urls?: UrlSettings,
     /**
-     * Defines which kind of storage we should instanciate.
+     * Defines which kind of storage we can instantiate on NodeJS for 'standalone' mode.
+     * The only possible storage type is 'MEMORY', which is the default.
      * @property {Object} storage
      */
     storage?: {
@@ -1138,6 +1077,11 @@ declare namespace SplitIO {
    * @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
    */
   interface INodeAsyncSettings extends INodeBasicSettings {
+    /**
+     * Defines which kind of async storage we can instantiate on NodeJS for 'consumer' mode.
+     * The only possible storage type is 'REDIS'.
+     * @property {Object} storage
+     */
     storage: {
       /**
        * 'REDIS' storage type to be instantiated by the SDK.
@@ -1145,10 +1089,68 @@ declare namespace SplitIO {
        */
       type: NodeAsyncStorage,
       /**
-       * Options to be passed to the selected storage. Use it with type: 'REDIS'
-       * @property {SplitIO.RedisStorageOptions} options
+       * Options to be passed to the Redis storage. Use it with storage type: 'REDIS'.
+       * @property {Object} options
        */
-      options?: RedisStorageOptions,
+      options?: {
+        /**
+         * Redis URL. If set, `host`, `port`, `db` and `pass` params will be ignored.
+         *
+         * Examples:
+         * ```
+         *   url: 'localhost'
+         *   url: '127.0.0.1:6379'
+         *   url: 'redis://:authpassword@127.0.0.1:6379/0'
+         * ```
+         * @property {string=} url
+         */
+        url?: string,
+        /**
+         * Redis host.
+         * @property {string=} host
+         * @default 'localhost'
+         */
+        host?: string,
+        /**
+         * Redis port.
+         * @property {number=} port
+         * @default 6379
+         */
+        port?: number,
+        /**
+         * Redis database to be used.
+         * @property {number=} db
+         * @default 0
+         */
+        db?: number,
+        /**
+         * Redis password. Don't define if no password is used.
+         * @property {string=} pass
+         * @default undefined
+         */
+        pass?: string,
+        /**
+         * The milliseconds before a timeout occurs during the initial connection to the Redis server.
+         * @property {number=} connectionTimeout
+         * @default 10000
+         */
+        connectionTimeout?: number,
+        /**
+         * The milliseconds before Redis commands are timeout by the SDK.
+         * Method calls that involve Redis commands, like `client.getTreatment` or `client.track` calls, are resolved when the commands success or timeout.
+         * @property {number=} operationTimeout
+         * @default 5000
+         */
+        operationTimeout?: number,
+        /**
+         * TLS configuration for Redis connection.
+         * @see {@link https://www.npmjs.com/package/ioredis#tls-options }
+         *
+         * @property {Object=} tls
+         * @default undefined
+         */
+        tls?: RedisOptions['tls'],
+      },
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix