@splitsoftware/splitio 10.17.4-rc.3 → 10.18.1-rc.0

package/CHANGES.txt

@@ -1,15 +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.
-      - Bugfixing - Updated internal `isObject` util that was returning false negatives on some environment, like Nuxt dev server or Miniflare.
-  - 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

@@ -1,11 +1,11 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation';
-import { defaults } from './defaults/browser';
 import { validateRuntime } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/runtime';
-import { validateStorage } from './storage/browser';
-import { validateIntegrations } from './integrations/browser';
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/builtinLogger';
 import { LocalhostFromObject } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromObject';
 import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
+import { defaults } from './defaults/browser';
+import { validateStorage } from './storage/browser';
+import { validateIntegrations } from './integrations/browser';
 var params = {
     defaults: defaults,
     acceptKey: true, acceptTT: true,

package/es/settings/defaults/version.js

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

package/es/settings/node.js

@@ -1,9 +1,9 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation';
-import { defaults } from './defaults/node';
-import { validateRuntime } from './runtime/node';
-import { validateStorage } from './storage/node';
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/builtinLogger';
 import { LocalhostFromFile } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromFile';
+import { defaults } from './defaults/node';
+import { validateStorage } from './storage/node';
+import { validateRuntime } from './runtime/node';
 var params = {
     defaults: defaults,
     runtime: validateRuntime,

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

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.settingsFactory = void 0;
 var settingsValidation_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation");
-var browser_1 = require("./defaults/browser");
 var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime");
-var browser_2 = require("./storage/browser");
-var browser_3 = require("./integrations/browser");
 var builtinLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/builtinLogger");
 var LocalhostFromObject_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/LocalhostFromObject");
 var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
+var browser_1 = require("./defaults/browser");
+var browser_2 = require("./storage/browser");
+var browser_3 = require("./integrations/browser");
 var params = {
     defaults: browser_1.defaults,
     acceptKey: true, acceptTT: true,

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.3';
+exports.packageVersion = '10.18.1-rc.0';

package/lib/settings/node.js

@@ -2,15 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.settingsFactory = void 0;
 var settingsValidation_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation");
-var node_1 = require("./defaults/node");
-var node_2 = require("./runtime/node");
-var node_3 = require("./storage/node");
 var builtinLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/builtinLogger");
 var LocalhostFromFile_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/LocalhostFromFile");
+var node_1 = require("./defaults/node");
+var node_2 = require("./storage/node");
+var node_3 = require("./runtime/node");
 var params = {
     defaults: node_1.defaults,
-    runtime: node_2.validateRuntime,
-    storage: node_3.validateStorage,
+    runtime: node_3.validateRuntime,
+    storage: node_2.validateStorage,
     logger: builtinLogger_1.validateLogger,
     localhost: function () { return (0, LocalhostFromFile_1.LocalhostFromFile)(); },
     consent: function () { return undefined; }, // resets settings.userConsent to the default

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.17.4-rc.3",
+  "version": "10.18.1-rc.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -32,7 +32,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.2.1-rc.10",
+    "@splitsoftware/splitio-commons": "1.3.1-rc.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

@@ -1,12 +1,13 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation';
-import { defaults } from './defaults/browser';
 import { validateRuntime } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/runtime';
-import { validateStorage } from './storage/browser';
-import { validateIntegrations } from './integrations/browser';
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/builtinLogger';
 import { LocalhostFromObject } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromObject';
 import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
 
+import { defaults } from './defaults/browser';
+import { validateStorage } from './storage/browser';
+import { validateIntegrations } from './integrations/browser';
+
 const params = {
   defaults,
   acceptKey: true, acceptTT: true, // Client with bound key and optional TT

package/src/settings/defaults/version.js

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

package/src/settings/node.js

@@ -1,10 +1,11 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation';
-import { defaults } from './defaults/node';
-import { validateRuntime } from './runtime/node';
-import { validateStorage } from './storage/node';
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/builtinLogger';
 import { LocalhostFromFile } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromFile';
 
+import { defaults } from './defaults/node';
+import { validateStorage } from './storage/node';
+import { validateRuntime } from './runtime/node';
+
 const params = {
   defaults,
   runtime: validateRuntime,

package/types/splitio.d.ts

@@ -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
   }
 }
 /**
@@ -1017,10 +1048,10 @@ declare namespace SplitIO {
     integrations?: BrowserIntegration[],
     /**
      * User consent status. Possible values are `'GRANTED'`, which is the default, `'DECLINED'` or `'UNKNOWN'`.
-     * - `'GRANTED'`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
-     * - `'DECLINED'`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
-     * - `'UNKNOWN'`: the user has neither granted nor declined consent for tracking events and impressions. The SDK will track them in its internal storage, and eventually send
-     * them or not if the consent status is updated to 'GRANTED' or 'DECLINED' respectively. The status can be updated at any time with the `setUserConsent` factory method.
+     * - `'GRANTED'`: the user grants consent for tracking events and impressions. The SDK sends them to Split cloud.
+     * - `'DECLINED'`: the user declines consent for tracking events and impressions. The SDK does not send them to Split cloud.
+     * - `'UNKNOWN'`: the user neither grants nor declines consent for tracking events and impressions. The SDK tracks them in its internal storage, and eventually either sends
+     * them or not if the consent status is updated to 'GRANTED' or 'DECLINED' respectively. The status can be updated at any time with the `UserConsent.setStatus` factory method.
      *
      * @typedef {string} userConsent
      * @default 'GRANTED'
@@ -1215,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.