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

package/CHANGES.txt

@@ -1,3 +1,19 @@
+10.18.0 (March XXX, 2022)
+ - Updated internal dependencies to use @splitsoftware/splitio-commons dependency, which includes:
+      - Added support for user consent in client-side
+      - Added impressionsQueueSize config parameter
+      - Update SplitToGa integration ...
+      - Update modules to simplify the usage with bundling tools ...
+      - 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.
+  - Added TLS support for Redis
+  -
+
+10.17.3 (February 25, 2022)
+ - Updated format for MySegments keys in LocalStorage, keeping backwards compatibility (issue https://github.com/splitio/javascript-client/issues/638).
+ - Updated some dependencies for vulnerability fixes.
+
 10.17.2 (January 31, 2022)
  - Updated some dependencies for vulnerability fixes.
  - Bugfixing - Fixed internal handling of Fetch API promise rejection, to avoid unhandled exceptions on some Web browsers (issue https://github.com/splitio/javascript-client/issues/621)

package/es/settings/browser.js

@@ -8,6 +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,
     runtime: validateRuntime,
     storage: validateStorage,
     integrations: validateIntegrations,

package/es/settings/defaults/version.js

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

package/es/settings/storage/node.js

@@ -12,7 +12,7 @@ export function validateStorage(settings) {
                     prefix: prefix
                 };
             }
-            var host = options.host, port = options.port, db = options.db, pass = options.pass, url = options.url, connectionTimeout = options.connectionTimeout, operationTimeout = options.operationTimeout;
+            var host = options.host, port = options.port, db = options.db, pass = options.pass, url = options.url, tls = options.tls, connectionTimeout = options.connectionTimeout, operationTimeout = options.operationTimeout;
             if (process.env.REDIS_HOST)
                 host = process.env.REDIS_HOST;
             if (process.env.REDIS_PORT)
@@ -36,6 +36,9 @@ export function validateStorage(settings) {
                 newOpts.db = db;
                 newOpts.pass = pass;
             }
+            if (tls) {
+                newOpts.tls = tls;
+            }
             return {
                 type: type,
                 prefix: prefix,

package/lib/settings/browser.js

@@ -11,6 +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,
     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.1';
+exports.packageVersion = '10.17.4-rc.2';

package/lib/settings/storage/node.js

@@ -15,7 +15,7 @@ function validateStorage(settings) {
                     prefix: prefix
                 };
             }
-            var host = options.host, port = options.port, db = options.db, pass = options.pass, url = options.url, connectionTimeout = options.connectionTimeout, operationTimeout = options.operationTimeout;
+            var host = options.host, port = options.port, db = options.db, pass = options.pass, url = options.url, tls = options.tls, connectionTimeout = options.connectionTimeout, operationTimeout = options.operationTimeout;
             if (process.env.REDIS_HOST)
                 host = process.env.REDIS_HOST;
             if (process.env.REDIS_PORT)
@@ -39,6 +39,9 @@ function validateStorage(settings) {
                 newOpts.db = db;
                 newOpts.pass = pass;
             }
+            if (tls) {
+                newOpts.tls = tls;
+            }
             return {
                 type: type,
                 prefix: prefix,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.17.4-rc.1",
+  "version": "10.17.4-rc.2",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -10,9 +10,7 @@
     "lib",
     "types",
     "es",
-    "src",
-    "client",
-    "server"
+    "src"
   ],
   "repository": "splitio/javascript-client",
   "homepage": "https://github.com/splitio/javascript-client#readme",
@@ -34,8 +32,9 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.2.1-rc.8",
+    "@splitsoftware/splitio-commons": "1.2.1-rc.9",
     "@types/google.analytics": "0.0.40",
+    "@types/ioredis": "^4.28.0",
     "ioredis": "^4.28.0",
     "ip": "1.1.5",
     "js-yaml": "3.13.1",
@@ -46,7 +45,6 @@
     "eventsource": "^1.0.7"
   },
   "devDependencies": {
-    "@types/ioredis": "^4.28.0",
     "@types/node-fetch": "^2.5.12",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",

package/src/settings/browser.js

@@ -9,6 +9,7 @@ import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settin
 
 const params = {
   defaults,
+  isClientSide: true,
   runtime: validateRuntime,
   storage: validateStorage,
   integrations: validateIntegrations,

package/src/settings/defaults/version.js

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

package/src/settings/storage/node.js

@@ -28,6 +28,7 @@ export function validateStorage(settings) {
         db,
         pass,
         url,
+        tls,
         connectionTimeout,
         operationTimeout
       } = options;
@@ -56,6 +57,10 @@ export function validateStorage(settings) {
         newOpts.pass = pass;
       }
 
+      if (tls) {
+        newOpts.tls = tls;
+      }
+
       return {
         type,
         prefix,

package/types/splitio.d.ts

@@ -3,6 +3,7 @@
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
 /// <reference types="google.analytics" />
+import { RedisOptions } from "ioredis";
 
 export as namespace SplitIO;
 export = SplitIO;
@@ -337,9 +338,9 @@ interface INodeBasicSettings extends ISharedSettings {
     type?: StorageType,
     /**
      * Options to be passed to the selected storage. Use it with type: 'REDIS'
-     * @property {Object} options
+     * @property {SplitIO.RedisStorageOptions} options
      */
-    options?: Object,
+    options?: SplitIO.RedisStorageOptions,
     /**
      * Optional prefix to prevent any kind of data collision between SDK versions.
      * @property {string} prefix
@@ -638,6 +639,69 @@ 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.
@@ -1082,9 +1146,9 @@ declare namespace SplitIO {
       type: NodeAsyncStorage,
       /**
        * Options to be passed to the selected storage. Use it with type: 'REDIS'
-       * @property {Object} options
+       * @property {SplitIO.RedisStorageOptions} options
        */
-      options?: Object,
+      options?: RedisStorageOptions,
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix

package/client/package.json

@@ -1,5 +0,0 @@
-{
-  "main": "../lib/factory/browser.js",
-  "module": "../es/factory/browser.js",
-  "types": "../types/client/index.d.ts"
-}

package/server/package.json

@@ -1,5 +0,0 @@
-{
-  "main": "../lib/factory/node.js",
-  "module": "../es/factory/node.js",
-  "types": "../types/server/index.d.ts"
-}

package/types/client/index.d.ts

@@ -1,14 +0,0 @@
-// Declaration file for Javascript Split Software SDK
-// Project: http://www.split.io/
-
-/// <reference path="../splitio.d.ts" />
-export = JsSdk;
-
-declare module JsSdk {
-  /**
-   * Split.io sdk factory function.
-   * The settings parameter should be an object that complies with the SplitIO.IBrowserSettings.
-   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#configuration}
-   */
-  export function SplitFactory(settings: SplitIO.IBrowserSettings): SplitIO.IBrowserSDK;
-}

package/types/server/index.d.ts

@@ -1,20 +0,0 @@
-// Declaration file for Javascript Split Software SDK
-// Project: http://www.split.io/
-
-/// <reference path="../splitio.d.ts" />
-export = JsSdk;
-
-declare module JsSdk {
-  /**
-   * Split.io sdk factory function.
-   * The settings parameter should be an object that complies with the SplitIO.INodeAsyncSettings.
-   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
-   */
-  export function SplitFactory(settings: SplitIO.INodeAsyncSettings): SplitIO.IAsyncSDK;
-  /**
-   * Split.io sdk factory function.
-   * The settings parameter should be an object that complies with the SplitIO.INodeSettings.
-   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
-   */
-  export function SplitFactory(settings: SplitIO.INodeSettings): SplitIO.ISDK;
-}