@splitsoftware/splitio 10.17.4-rc.2 → 10.18.0

package/CHANGES.txt

@@ -1,14 +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.18.0 (April 7, 2022)
+ - Added user consent feature to allow delaying or disabling the data tracking from SDK until user consent is explicitly granted or declined. Read more in our docs.
+ - Added `scheduler.impressionsQueueSize` property to SDK configuration to limit the amount of impressions tracked in memory. Read more in our docs.
+ - Added support to accept TLS configuration options to the Redis storage in NodeJS. Read more in our docs.
+ - Updated type definitions to specialize the type of the `storage.options` object for Redis storage in NodeJS.
+ - Updated some dependencies for vulnerability fixes.
+ - Bugfixing - Updated internal isObject utility function, to avoid unexpected behaviors on frameworks and libraries that uses multiple VM contexts, like NuxtJS dev server.
+ - Bugfixing - Logging settings (i.e., the `debug` SDK configuration param and factory logger methods) are configurable per factory instance, instead of affecting all factories globally.
+ - Bugfixing - Fixed an issue with `connectionTimeout` options params of Redis storage, that was being ignored and not passed down to the underlying ioredis client.
+ - Bugfixing - Updated the validation of some SDK configuration params to log errors and throw exceptions with clear descriptions of the invalid setup:
+    - If passing a non-string value to `sync.impressionsMode`, the SDK logs the error: "you passed an invalid impressionsMode config param. It should be one of the following values: 'OPTIMIZED', 'DEBUG'. Defaulting to 'OPTIMIZED'.".
+    - If passing 'REDIS' storage type without setting `mode` to 'consumer', the SDK logs the error: "The provided REDIS storage is invalid for this mode. It requires 'consumer' mode. Fallbacking into default MEMORY storage.".
+    - If passing 'consumer' mode without setting `storage.type` to 'REDIS', the SDK throws an exception with message: "A REDIS storage is required on consumer mode.".
+
+ - NOTABLE CHANGE: since version 10.18.0, the SDK has been refactored to use @splitsoftware/splitio-commons package in order to reuse core modules shared across all JavaScript-based SDKs. Most internal modules have been moved and renamed,
+  but it does not imply a breaking change as long as the library is imported via its main entrypoint (e.g., `const { SplitFactory } = require('@splitsoftware/splitio')` or `import { SplitFactory } from '@splitsoftware/splitio'`).
 
 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).

package/es/factory/browser.js

@@ -12,7 +12,7 @@ import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/esm/
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
-import { userConsentProps } from '@splitsoftware/splitio-commons/esm/sdkFactory/userConsentProps';
+import { createUserConsentAPI } from '@splitsoftware/splitio-commons/esm/consent/sdkUserConsent';
 import { settingsFactory } from '../settings/browser';
 import { platform, SignalListener } from '../platform';
 var syncManagerOnlineCSFactory = syncManagerOnlineFactory(pollingManagerCSFactory, pushManagerFactory);
@@ -39,7 +39,11 @@ function getModules(settings) {
         SignalListener: SignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? integrationsManagerFactory.bind(null, settings.integrations) : undefined,
         impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
-        extraProps: userConsentProps
+        extraProps: function (params) {
+            return {
+                UserConsent: createUserConsentAPI(params)
+            };
+        }
     };
     switch (settings.mode) {
         case LOCALHOST_MODE:

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.18.0';

package/lib/factory/browser.js

@@ -15,7 +15,7 @@ var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsVali
 var sdkFactory_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var utils_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/utils");
-var userConsentProps_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory/userConsentProps");
+var sdkUserConsent_1 = require("@splitsoftware/splitio-commons/cjs/consent/sdkUserConsent");
 var browser_2 = require("../settings/browser");
 var platform_1 = require("../platform");
 var syncManagerOnlineCSFactory = (0, syncManagerOnline_1.syncManagerOnlineFactory)(pollingManagerCS_1.pollingManagerCSFactory, pushManager_1.pushManagerFactory);
@@ -42,7 +42,11 @@ function getModules(settings) {
         SignalListener: platform_1.SignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? browser_1.integrationsManagerFactory.bind(null, settings.integrations) : undefined,
         impressionsObserverFactory: (0, utils_1.shouldAddPt)(settings) ? impressionObserverCS_1.impressionObserverCSFactory : undefined,
-        extraProps: userConsentProps_1.userConsentProps
+        extraProps: function (params) {
+            return {
+                UserConsent: (0, sdkUserConsent_1.createUserConsentAPI)(params)
+            };
+        }
     };
     switch (settings.mode) {
         case constants_1.LOCALHOST_MODE:

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.18.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.17.4-rc.2",
+  "version": "10.18.0",
   "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.3.0",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "ioredis": "^4.28.0",

package/src/factory/browser.js

@@ -12,7 +12,7 @@ import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/src/
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/src/utils/constants';
 import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
-import { userConsentProps } from '@splitsoftware/splitio-commons/src/sdkFactory/userConsentProps';
+import { createUserConsentAPI } from '@splitsoftware/splitio-commons/src/consent/sdkUserConsent';
 
 import { settingsFactory } from '../settings/browser';
 import { platform, SignalListener } from '../platform';
@@ -54,7 +54,11 @@ function getModules(settings) {
 
     impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
 
-    extraProps: userConsentProps
+    extraProps: (params) => {
+      return {
+        UserConsent: createUserConsentAPI(params)
+      };
+    }
   };
 
   switch (settings.mode) {

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.18.0';

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
 }
@@ -143,7 +143,38 @@ interface ILoggerAPI {
    * Log level constants. Use this to pass them to setLogLevel function.
    */
   LogLevel: {
-    [level: string]: LogLevel
+    [level in LogLevel]: LogLevel
+  }
+}
+/**
+ * User consent API
+ * @interface IUserConsentAPI
+ */
+interface IUserConsentAPI {
+  /**
+   * Set or update the user consent status. Possible values are `true` and `false`, which represent user consent `'GRANTED'` and `'DECLINED'` respectively.
+   * - `true ('GRANTED')`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
+   * - `false ('DECLINED')`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
+   *
+   * NOTE: calling this method updates the user consent at a factory level, affecting all clients of the same factory.
+   *
+   * @function setStatus
+   * @param {boolean} userConsent The user consent status, true for 'GRANTED' and false for 'DECLINED'.
+   * @returns {boolean} Whether the provided param is a valid value (i.e., a boolean value) or not.
+   */
+  setStatus(userConsent: boolean): boolean;
+  /**
+   * Get the user consent status.
+   *
+   * @function getStatus
+   * @returns {ConsentStatus} The user consent status.
+   */
+  getStatus(): SplitIO.ConsentStatus;
+  /**
+   * Consent status constants. Use this to compare with the getStatus function result.
+   */
+  Status: {
+    [status in SplitIO.ConsentStatus]: SplitIO.ConsentStatus
   }
 }
 /**
@@ -326,7 +357,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 +368,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 +670,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 +1017,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 +1073,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 +1108,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 +1120,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
@@ -1213,24 +1246,10 @@ declare namespace SplitIO {
      */
     client(key: SplitKey, trafficType?: string): IBrowserClient
     /**
-     * Set or update the user consent status. Possible values are `true` and `false`, which represent user consent `'GRANTED'` and `'DECLINED'` respectively.
-     * - `true ('GRANTED')`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
-     * - `false ('DECLINED')`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
-     *
-     * NOTE: calling this method updates the user consent at a factory level, affecting all clients of the same factory.
-     *
-     * @function setUserConsent
-     * @param {boolean} userConsent The user consent status, true for 'GRANTED' and false for 'DECLINED'.
-     * @returns {boolean} Whether the provided param is a valid value (i.e., a boolean value) or not.
-     */
-    setUserConsent(userConsent: boolean): boolean;
-    /**
-     * Get the user consent status.
-     *
-     * @function getUserConsent
-     * @returns {ConsentStatus} The user consent status.
+     * User consent API.
+     * @property UserConsent
      */
-    getUserConsent(): ConsentStatus;
+    UserConsent: IUserConsentAPI
   }
   /**
    * This represents the interface for the SDK instance with asynchronous storage.