CHANGES.txt

11.0.3 (December 4, 2024)
 - Bugfixing - Updated @splitsoftware/splitio-commons package to version 2.0.2 that sanitizes the `SplitSDKMachineName` header value to avoid exceptions on HTTP/S requests when it contains non ISO-8859-1 characters (Related to issue https://github.com/splitio/javascript-client/issues/847).

11.0.2 (November 25, 2024)
 - Updated bloom-filters and fetch-mock dependencies for vulnerability fixes.
 - Bugfixing - Updated @splitsoftware/splitio-commons package to version 2.0.1 that fixes an issue with the SDK_UPDATE event on Node.js, where it was not being emitted if there was an empty segment and the SDK received a feature flag update notification.

11.0.1 (November 11, 2024)
 - Bugfixing - Revert removal of TypeScript `SplitIO` namespace at `/types/splitio.d.ts` to allow explicit imports of types from the JavaScript SDK package. E.g., `import type { IBrowserSettings } from '@splitsoftware/splitio/types/splitio';`.

11.0.0 (November 1, 2024)
 - Added support for targeting rules based on large segments for browsers (client-side API).
 - Added `factory.destroy()` method, which invokes the `destroy` method of all clients created by the factory.
 - Updated @splitsoftware/splitio-commons package to version 2.0.0 that includes major updates and updated some transitive dependencies for vulnerability fixes.
 - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for ECMAScript Modules build.
 - BREAKING CHANGES:
    - NOTE: Refer to ./MIGRATION-GUIDE.md for instructions on how to migrate your codebase from version 0.x to 1.0.0.
    - Dropped support for Split Proxy below version 5.9.0, when using in the browser (client-side API). The SDK now requires Split Proxy 5.9.0 or above.
    - Dropped support for Node.js v6. The SDK now requires Node.js v14 or above.
    - Removed TypeScript `SplitIO` namespace from `@splitsoftware/splitio/types/splitio`. Reverted in 11.0.1.
    - Removed internal ponyfills for the `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or provide a polyfill.
    - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations. The `integrations` configuration option has been removed from the SDK factory configuration, along with the associated interfaces in the TypeScript definitions.
    - Removed the `core.trafficType` configuration option (`SplitIO.IBrowserSettings['core']['trafficType]`) and the `trafficType` parameter from the SDK `client()` method in Browser (`SplitIO.IBrowserSDK['client']`). As a result, traffic types can no longer be bound to SDK clients, and the traffic type must be provided in the `track` method.

10.28.0 (September 6, 2024)
 - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:
    - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
    - Updated some transitive dependencies for vulnerability fixes.

10.27.0 (June 25, 2024)
 - Added `sync.requestOptions.agent` option to SDK configuration for Node.js. This allows passing a custom Node.js HTTP(S) Agent with specific configurations for the SDK requests, like custom TLS settings or a network proxy (See https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#proxy).
 - Updated some transitive dependencies for vulnerability fixes.

10.26.1 (June 14, 2024)
 - Updated the internal imports of 'os' and 'ioredis' modules for Node.js, to use EcmaScript 'import' rather than CommonJS 'require' for the ES modules build. This avoids runtime errors on some scenarios when bundling the SDK into a .mjs file or importing it from a .mjs file.
 - Updated eventsource dependency for Node.js. The eventsource v1.1.2 dependency was removed, and the SDK now uses an embedded adaptation that can accept an HTTP(S) agent option, like other HTTP(S) requests.
 - Updated @splitsoftware/splitio-commons package to version 1.16.0 that includes some vulnerability and bug fixes.
 - Bugfixing - Restored some input validation error logs that were removed in version 10.24.0. The logs inform the user when the `getTreatment(s)` methods are called with an invalid value as feature flag name or flag set name.
 - Bugfixing - Fixed localhost mode to emit SDK_UPDATE when mocked feature flags are updated in the `features` object map of the config object (Related to issue https://github.com/splitio/javascript-browser-client/issues/119).

10.26.0 (May 6, 2024)
 - Updated @splitsoftware/splitio-commons package to version 1.14.0 that includes minor updates:
    - Added support for targeting rules based on semantic versions (https://semver.org/).
    - Added special impression label "targeting rule type unsupported by sdk" when the matcher type is not supported by the SDK, which returns 'control' treatment.
    - Updated Split API client to include the flags spec version query parameter for the `splitChanges` and `auth` endpoints.

10.25.2 (March 26, 2024)
 - Updated some transitive dependencies for vulnerability fixes.
 - Bugfixing - Added tslib as an explicit dependency to avoid issues with some package managers that don't resolve it automatically as a transitive dependency from @splitsoftware/splitio-commons (Related to issue https://github.com/splitio/javascript-client/issues/795).

10.25.1 (January 16, 2024)
 - Updated @splitsoftware/splitio-commons package to version 1.13.1 and some transitive dependencies for vulnerability fixes.

10.25.0 (January 4, 2024)
 - Updated SDK to support URLs without TLS protocol in Node.js, to simplify proxy usage inside private networks.

10.24.1 (December 12, 2023)
 - Updated SDK cache for browsers using localStorage, to clear cached feature flag definitions before initiating the synchronization process if the cache was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria, to avoid using invalid cached data when the SDK is ready from cache.
 - Updated @splitsoftware/splitio-commons package to version 1.12.1.

10.24.0 (December 4, 2023)
 - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
    - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
      - getTreatmentsByFlagSet and getTreatmentsByFlagSets
      - getTreatmentsWithConfigByFlagSets and getTreatmentsWithConfigByFlagSets
    - Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
      - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
    - Added `sets` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager to expose flag sets on flag views.
 - Added `defaultTreatment` property to the `SplitView` object returned by the `split` and `splits` methods of the SDK manager (Related to issue https://github.com/splitio/javascript-commons/issues/225).
 - Updated @splitsoftware/splitio-commons package to version 1.12.0 that includes vulnerability fixes, flag sets support, and other improvements.
 - Updated Redis adapter to handle timeouts and queueing of some missing commands: 'hincrby', 'popNRaw', and 'pipeline.exec'.
 - Bugfixing - Fixed manager methods in consumer modes to return results in a promise when the SDK is not operational (not ready or destroyed).
 - Bugfixing - Fixed SDK key validation in Node.js to ensure the SDK_READY_TIMED_OUT event is emitted when a client-side type SDK key is provided instead of a server-side one (Related to issue https://github.com/splitio/javascript-client/issues/768).

10.23.1 (September 22, 2023)
 - Updated @splitsoftware/splitio-commons package to version 1.9.1. This update removes the handler for 'unload' DOM events, that can prevent browsers from being able to put pages in the back/forward cache for faster back and forward loads (Related to issue https://github.com/splitio/javascript-client/issues/759).

10.23.0 (July 18, 2023)
 - Updated @splitsoftware/splitio-commons package to version 1.9.0 that includes minor improvements:
    - Updated streaming architecture implementation to apply feature flag updates from the notification received which is now enhanced, improving efficiency and reliability of the whole update system.

10.22.6 (July 6, 2023)
 - Updated some transitive dependencies for vulnerability fixes.
 - Updated @splitsoftware/splitio-commons package to version 1.8.3 that includes the following bug fix:
    - Bugfixing - The `destroy` method has been updated to immediately flag the SDK client as destroyed, to prevent access to the storage when `getTreatment` and `track` methods are called after the SDK is destroyed.

10.22.5 (May 15, 2023)
 - Updated @splitsoftware/splitio-commons package to version 1.8.2 that includes minor improvements.
    - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and IntelliSense comments.
    - Updated split storage modules to optimize some operations when using Redis and pluggable storages.
 - Updated some transitive dependencies for vulnerability fixes.

10.22.4 (March 9, 2023)
 - Updated @splitsoftware/splitio-commons package to version 1.8.1 that includes minor improvements.
 - Updated some transitive dependencies for vulnerability fixes.

10.22.3 (December 16, 2022)
 - Updated some transitive dependencies for vulnerability fixes.
 - Bugfixing - Upgrade @splitsoftware/splitio-commons package to version 1.7.3 which includes a memory leak fix for localhost mode (Related to issue https://github.com/splitio/javascript-commons/issues/181) among other improvements.

10.22.2 (November 3, 2022)
 - Bugfixing - Replaced bloom filter dependency that caused dependency conflicts (with farmhash lib) in AWS Lambda. This change only affects Node.js flavor.

10.22.1 (October 14, 2022)
 - Bugfixing - Upgrade @splitsoftware/splitio-commons package to version 1.7.2, that handles `Navigator.sendBeacon` API exceptions in the browser, and fallback to regular Fetch/XHR transport in case of error.

10.22.0 (October 5, 2022)
 - Added a new impressions mode for the SDK called NONE, to be used in factory when there is no desire to capture impressions on an SDK factory to feed Split's analytics engine. Running NONE mode, the SDK will only capture unique keys evaluated for a particular feature flag instead of full blown impressions.
 - Updated default value of `scheduler.featuresRefreshRate` config parameter from 5 seconds to 60 seconds for Node.js and from 30 seconds to 60 seconds for Browser.
 - Updated @splitsoftware/splitio-commons package to version 1.7.1, that improves the performance of feature flag evaluations (i.e., `getTreatment(s)` method calls) when using the default storage in memory, among other improvements.

10.21.1 (July 25, 2022)
 - Bugfixing - Added missed type definitions `enabled` from `sync`.

10.21.0 (July 22, 2022)
 - Added `autoRequire` configuration option to the Google Analytics to Split integration, which takes care of requiring the splitTracker plugin on trackers dynamically created by Google tag managers (See https://help.split.io/hc/en-us/articles/360040838752#set-up-with-gtm-and-gtag.js).
 - Updated browser listener to push remaining impressions and events on 'visibilitychange' and 'pagehide' DOM events, instead of 'unload', which is not reliable in modern mobile and desktop Web browsers.
 - Updated the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
 - Updated some dependencies for vulnerability fixes.
 - Bugfixing - Moved js-yaml dependency from @splitsoftware/splitio-commons to avoid resolution to an incompatible version on certain npm versions when installing third-party dependencies that also define js-yaml as transitive dependency (Related to issue https://github.com/splitio/javascript-client/issues/662).

10.20.0 (June 29, 2022)
 - Added a new config option to control the tasks that listen or poll for updates on feature flags and segments, via the new config `sync.enabled`. Running online Split will always pull the most recent updates upon initialization, this only affects updates fetching on a running instance. Useful when a consistent session experience is a must or to save resources when updates are not being used.
 - Updated telemetry logic to track the anonymous config for user consent flag set to declined or unknown.
 - Updated submitters logic, to avoid duplicating the post of impressions to Split cloud when the SDK is destroyed while its periodic post of impressions is running.

10.19.1 (Jun 13, 2022)
 - Updated eventsource dependency range to ^1.1.2 to avoid a vulnerability and dependency resolution to a vulnerable version of url-parse transitive dependency.
 - Bugfixing - Updated submitters logic, to avoid dropping impressions and events that are being tracked while POST request is pending.

10.19.0 (May 24, 2022)
 - Added `scheduler.telemetryRefreshRate` property to SDK configuration, and deprecated `scheduler.metricsRefreshRate` property.
 - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
 - Bugfixing - Updated default values for `scheduler.impressionsRefreshRate` config parameter: 300s for OPTIMIZED impression mode and 60s for DEBUG impression mode,
   in both Browser and Node.js (previously it was 60s and 300s in Browser and Node.js respectively, equal for DEBUG and OPTIMIZED impression modes).

10.18.2 (May 6, 2022)
 - Bugfixing - Removed "ip" dependency to use an inline copy of it that fixes an error when using it in Node.js v18 (https://github.com/indutny/node-ip/issues/113).

10.18.1 (April 20, 2022)
 - Updated some dependencies for vulnerability fixes.
 - Bugfixing - Updated @splitsoftware/splitio-commons package to avoid an error when requiring some third-party dependencies used by the package (Related to issue https://github.com/splitio/javascript-client/issues/662).
 - Bugfixing - Updated `ready` method to rejects the promise with an Error object instead of a string value (Related to issue https://github.com/splitio/javascript-client/issues/654).

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 Node.js. Read more in our docs.
 - Updated type definitions to specialize the type of the `storage.options` object for Redis storage in Node.js.
 - 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. Fallback 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).
 - 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)

10.17.1 (January 13, 2022)
 - Updated some transitive dependencies for vulnerability fixes.
 - Bugfixing - Fixed internal handling of SDK_READY_FROM_CACHE event, to avoid CSP issues in browsers.

10.17.0 (January 3, 2022)
 - Added support to SDK clients on browser to optionally bind attributes to the client, keeping these loaded within the SDK along with the user ID, for easier usage when requesting flag.
 - Bugfixing - Fixed an issue returning dynamic configs when the treatment name contains a dot (".").

10.16.1 (October 25, 2021)
 - Updated some internal modules to optimize the time efficiency of feature flag evaluations (i.e., `getTreatment(s)` method calls).
 - Updated some dependencies for vulnerability fixes (ioredis, @babel/cli, eslint, eslint-plugin-compat).
 - Bugfixing - Fixed localhost mode with localStorage, to use a mock in memory instead of localStorage API directly but keep emitting emit SDK_READY_FROM_CACHE event.

10.16.0 (September 28, 2021)
 - Updated localhost mode to emit SDK_READY_FROM_CACHE event in Browser when using localStorage (issue https://github.com/splitio/react-client/issues/34).
 - Updated streaming logic to use the newest version of our streaming service, including:
      - Integration with Auth service V2, connecting to the new channels and applying the received connection delay.
      - Implemented handling of the new MySegmentsV2 notification types (SegmentRemoval, KeyList, Bounded and Unbounded)
      - New control notification for environment scoped streaming reset.
 - Updated some dependencies to their latest versions, including Webpack 4 to 5, to build a more optimized UMD bundle.
 - NOTE: build script is configured to transpile to ES5 with Babel loose mode (https://2ality.com/2015/12/babel6-loose-mode.html). It results in a smaller bundle size and faster code execution but with some differences in the transpiled code, that may affect old browser versions like some builds of IE10.

10.15.9 (Aug 13, 2021)
 - Updated some dependencies with vulnerability fixes.
 - Updated some log messages related to HTTP request errors.
 - Bugfixing - Fixed internal promise wrapper to avoid an error with Meteor framework.
 - Bugfixing - Fixed type definitions for `ISettings['features']` (issue #560).
 - Bugfixing - Name remaining anonymous functions that generate warnings when transpiling for IE11 (issue #557)

10.15.8 (June 11, 2021)
 - Updated listener for 'unload' DOM events to close any remaining streaming connections.
 - Added telemetry headers in form of query params to SSE connection.

10.15.7 (June 3, 2021)
 - Updated some dependencies with vulnerability fixes.
 - Removed "utfx" dependency to use an inline copy of it with the minimum features used by the SDK (issue #544).
 - Bugfixing - Fixed some issues of localhost mode:
      - Support localhost mode on multiple SDK instances. Each instance handles its own mocked features, instead of sharing the same mock.
      - SDK_UPDATE is emitted only once if mocked features changes.
      - On shared clients, SDK_UPDATE event is now emitted if mocked features changes.

10.15.6 (May 21, 2021)
 - Updated error handling following the recommended practice of throwing only Error objects.
 - Updated ioredis version now that their incompatibility with Node.js <10 was already fixed.
 - Updated Karma and a transitive dependency with vulnerabilities.
 - Updated dev dependency on redis-dump to redis-dumpz package to be able to fix a vulnerability on Redis transitive dependency.
 - Bugfixing - Name two anonymous functions that generate warnings when transpiling for IE11 (issue #535)

10.15.5 (Apr 29, 2021)
 - Updated some dependencies, including a vulnerability fix.

10.15.4 (Mar 17, 2021)
 - Updated Streaming logic with some improvements and fixes, including:
      - Updated SSE error handling.
      - Extended publishers tracking to support multi-region infrastructure.
      - Enforced revalidation for requests stored in local caches, like proxies or browsers.
      - Bugfixing - In Node.js, fetch new segments captured due to streaming notifications.
 - Updated some dependencies, including a vulnerability fix.

10.15.3 (Feb 10, 2021)
 - Updated type definitions to remove `@types/node` dependency and avoid conflicts between Node.js and DOM type definitions.
 - Bugfixing - Handle issue importing node-fetch library (issue #505).

10.15.2 (Dec 3, 2020)
 - Updated requests for `/testImpressions/beacon` to include the impressions mode.

10.15.1 (Nov 12, 2020)
 - Updated the version for ioredis in the package.json to be fixed to 4.18.0 given after 4.19.0 it requires Node.js 10, in case this SDK is installed without considering our package-lock.json file on an old Node.js.
 - Updated TypeScript declarations to include the `urls` settings object (to connect to Split Synchronizer in proxy mode) for the non-async settings where it would be applicable.
 - Bugfixing - Updating some imports of hashing utilities to use safe relative paths and avoid module resolution issues.
 - Bugfixing - Updating logic to avoid a corner case issue with the sendHitTask callback handling of the GOOGLE_ANALYTICS_TO_SPLIT integration.
 - Bugfixing - Updating the package.json version import to be compatible with latest standards (Related to issue https://github.com/splitio/javascript-client/pull/495, thanks @andrew-t-james-hm).

10.15.0 (Oct 6, 2020)
 - Added impressions dedupe logic to avoid sending duplicated impressions:
    - Added `ImpressionsCount` cache to count impressions generated per feature.
    - Added `ImpressionObserver` to detect previous generated impression.
    - Added new endpoint (`testImpressions/count`) to send all the generated impressions in a time frame.
    - Added beacon endpoint for ImpressionsCount.
    - Added murmur3 128 bits hashing and splitted logic between browser and Node.js.
    - Added `OPTIMIZED` and `DEBUG` modes in order to enabling/disabling how impressions are going to be sent into Split servers,
        - `OPTIMIZED`: will send unique impressions in a timeframe in order to reduce how many times impressions are posted to Split.
        - `DEBUG`: will send every impression generated to Split.
 - Updated JSON bulk properties for Impressions to decrease the payload size.
 - Updated `ImpressionsTracker` and `ImpressionTracker` to be only one and be used for both type of evaluations: `getTreatment` and `getTreatments`.
 - Bugfixing - added URI encoding of user keys to avoid HTTP errors when fetching MySegments for keys with special characters.

10.14.2 (Sep 18, 2020)
 - Updated `node-fetch` dependency to fix a vulnerability.
 - Bugfixing - updated the feature detection of Set global constructor to avoid possible reference errors.

10.14.1 (Aug 13, 2020)
 - Updated push streaming support for Node.js to optimize requests to Split services.
 - Bugfixing - Replaced the use of `for...in` statements since it iterates over enumerable properties on the prototype chain, which might be polluted by code external to the library.

10.14.0 (Jul 31, 2020)
 - Added `sync.splitFilters` property to SDK configuration to pass a list of filters for the feature flags that will be downloaded. Read more in our docs.
 - Added expiration policy to SDK cache for browsers using localStorage: cache is cleared after 10 days of the last successful update.
 - Updated babel configuration to remove core-js dependency and refactored code in favor of size reduction of UMD, ESM and CommonJS builds.
 - NOTE: removed some polyfills of global objects not available in some builds of IE10.

10.13.0 (Jun 25, 2020)
 - Updated client.ready() and manager.ready() functions to be consumed on demand and return a promise reflecting the current status of the SDK at the time the method was invoked.
 - Updated readiness events on consumer mode: the SDK emits SDK_READY event once the connection to Redis cache is successful.
 - Updated streamingEnabled default value from false to true, to use streaming synchronization by default.
 - Removed the use of Promise.prototype.finally to avoid issues with some promise polyfills.

10.12.1 (May 18, 2020)
 - Updated logging messages for streaming notifications to DEBUG log level.
 - Updated asynchronous logic handling to avoid async/await syntax in order to remove regenerator-runtime dependency.
 - Removed axios HTTP library in favor of fetch for browsers (with XHR as fallback) and node-fetch for Node.js.

10.12.0 (April 30, 2020)
 - Added support for the new Split streaming architecture. When enabled, the SDK will not poll for updates but instead receive notifications every time there's a change in your environments,
  allowing to process those much quicker. If disabled (default) or in the event of an issue, the SDK will fallback to the known polling mechanism to provide a seamless experience.

10.11.1 (Mar 19, 2020)
 - Updated @babel/runtime-corejs3, @types/node and several dev dependencies.
 - Updated the name of the "events" config of GOOGLE_ANALYTICS_TO_SPLIT integration to "hits".

10.11.0 (Mar 13, 2020)
 - Added integrations property to configuration which could receive a list of valid integrations.
 - Added support of inbound and outbound SDK to SDK integrations for Google Analytics. Read more in our documentation's integrations section.
 - Updated logging logic to avoid calling console.error in the client side.
 - Updated logging error messages priority to significantly reduce the amount of error level logs that can't be silenced.
 - Updated axios to 0.19.2 and few other minor updates on dev dependencies.
 - Updated default metricsRefreshRate from 60s to 120s and reduced the log level from ERROR to INFO for telemetry post failures.
 - Bugfixing - Emit SDK_UPDATE in localhost only when mock was actually updated.

10.10.0 (Jan 10, 2020)
 - Added SDK_READY_FROM_CACHE event, which will be emitted in LocalStorage mode when the SDK finds feature flag definitions in the storage of the browser.
 - Updated a dependency to fix a vulnerability (serialize-javascript).
 - Updated multiple dependencies and dev dependencies (@types/node, axios, core-js, events, sinon, tape and the babel cli, core, preset-env, register and plugin-transform-runtime)

10.9.2 (Nov 20, 2019)
 - Bugfixing - When using Redis, return expire result to avoid race condition with redis disconnection due to a client destroy.
 - Sonar - Removed extra parameter from function invocation to remove the only bug highlighted by Sonar.

10.9.1 (Nov 7, 2019)
 - Bugfixing - Avoid certain keys (containing one of three keywords) on the browser to generate a request to the wrong endpoint.
 - Added SonarQube integration.

10.9.0 (Oct 24, 2019)
 - Added listener for 'unload' DOM events to push remaining impressions and events when the browser page is closed or reloaded.
 - Added setting core.IPAddressesEnabled to disable reporting IP Addresses and Machine name back to Split cloud.
 - Updated Redis storage to fetch multiple feature flags at once for getTreatments/getTreatmentsWithConfig.
 - Updated most dependencies to their latest versions. Biggest change is babel (from 6 to 7), Webpack 3 to 4, Karma and ioredis.

10.8.4 (Sep 24, 2019)
 - Added module "events" as optional dependency.
 - Removed dependency on "util" module.
 - Updated transport module to use a local axios instance instead of the global one, to avoid polluting the shared one.
 - Updated input validation log when trying to get data of a non-existent feature flag to have level WARN instead of ERROR.

10.8.3 (Sep 16, 2019)
 - Updated two default values on startup configuration for Browsers:
   - startup.readyTimeout default value went up from 1.5s to 10s.
   - startup.retriesOnFailureBeforeReady default value went up from 1.5s to 5s.
 - Updated trafficType from manager to 'localhost' when the SDK is running in localhost mode.
 - Updated polling logic to stop and restart mySegments data synchronization (on browsers) when not currently used on Splits.

10.8.2 (Jul 26, 2019)
 - Added `/src` folder to the npm package distribution for users that needs to transpile the package themselves.
 - Bugfixing - Incorrect warnings caused by TrafficType storage counter when a Split is updated for inMemory and LocalStorage mode.
 - Updated three dev dependencies to remove vulnerability warnings when running npm audit (lodash, set-value, mixin-deep).

10.8.1 (May 31, 2019)
 - Updated axios version to 0.19.0 to remove a DoS vulnerability (not affecting the SDK but worth updating).

10.8.0 (May 23, 2019)
 - Added support for optional event properties via our client.track() method. Read more in our docs!

10.7.2 (May 15, 2019)
 - Bugfixing - Fixing ES6 import syntax for LabelConstants module.

10.7.1 (May 10, 2019)
 - Added Block Until Ready functionality support for consumer clients (Redis mode on Node.js) to make integration code work the same between modes.
 - Added more Input and Usage Validation rules, including an extra label for impressions when the SDK is not ready.
 - Updated the SDK Redis adapter to handle pending commands when disconnecting from the Redis server.
 - Bugfixing - Clearing up readyTimeout after we don't need it anymore. It also fixes the misleading SDK_READY_TIMED_OUT error log when using Redis.

10.7.0 (Apr 30, 2019)
 - Added Block Until Ready functionality to the manager, shared with the main client. Now you can subscribe to SDK events or use the .ready() promise from the manager as well.
 - Added Dynamic Configurations support through two new methods that mimic the regular ones, changing the type of what is returned.
   - getTreatmentWithConfig: Same as getTreatment, but instead of a string it returns a map with treatment and config as a stringified JSON.
   - getTreatmentWithConfig: Same as getTreatments, but instead of a map of string it returns a map of objects with treatment and config as a stringified JSON.
 - Added configs to SplitViews returned by the manager module.
 - Updated localhost mode. Now besides supporting the old text files with `.split` extension (to be deprecated soon), we support YAML (.yaml/.yml) files where you can
  define configurations for your treatments and also whitelisted keys. Read more in our docs!
 - Updated manager method to avoid creating more than one instance.
 - Updated how we handle timeout per request, setting startup.requestTimeoutBeforeReady to less than 1 applies no timeout per request.

10.6.1 (Mar 15, 2019)
 - Updated default value for scheduler.featuresRefreshRate on Node.js. New default is 5 seconds.

10.6.0 (Feb 12, 2019)
 - BREAKING CHANGE: Updated impressions cache for Redis storage to reduce the amount of Redis operations by using a single queue (Must use Synchronizer 2.x or above with this or newer SDK versions).
 - Added stricter validations to the input of the SDK api to provide better and faster feedback in case of misuse. We want our users to be able to diagnose issues sooner,
  instead of when you can't find the data you're looking for. As part of this, some error logs (just logs) will be visible even with the SDK Logger disabled.
 - Updated getTreatments to have it's own latency metric for the whole operation, instead of one per each feature evaluation.
 - Updated default values on configuration for Node.js.
   - startup.readyTimeout default value went up from 0s (no timeout limit) to 15s.
   - startup.retriesOnFailureBeforeReady default value went up from 0 (no retries) to 1.
 - Bugfixing - Preventing "Uncaught in promise (undefined)" error for .ready() promise when no error handlers are attached to it.
 - Bugfixing - Always throw JS errors inside callbacks attached to the SDK, so developers don't miss them.

10.5.1 (Dec 20, 2018)
 - Bugfixing - Fixing an issue where a Split with Traffic Allocation set to one would return the default treatment for 100% of the traffic (instead of 99%).

10.5.0 (Nov 7, 2018)
 - Added custom impression listener feature, so customers can receive all the impressions data on a callback to handle as they place.
  Completely optional, the only requirement is that the element being set as impression listener should have a method called `logImpression`
  where they'll receive all the data. Read more in our docs!
 - Added Redis support for track events. Now if you're running the `split-synchronizer` and the Node.js SDK on `consumer mode`, your track events
  will go to Redis and be sent to Split by the synchronizer.
 - Added a wrapper on top of ioredis to better handle operations and reduce unwanted library effects.
 - Removed unnecessary keys/scans on Redis.
 - Bugfixing - Calling factory.client on the browser with the same key used on configuration created a new unnecessary instance.
 - Bugfixing - Fixing multiple instances of the client without specific scheduler configurations cause overflow on timeout values.

10.4.0 (Oct 4, 2018)
 - Removed dependency for logging library.
 - Removed dependency on lodash.
 - Added log level support for SDK logs using our own Logger implementation. Now besides just enable/disable,
  you can set the log level as a string (more information on our docs or on Detailed-README.md).
 - Added automatic cleanup and data flush for Node.js on SIGTERM signals.
 - Updated default value for startup.requestTimeoutBeforeReady on the Browser from 0.8 seconds to 1.5 seconds to match startup.readyTimeout.
 - Updated dependency versions.
 - Bugfixing - Capturing uncaught exception on some http and network errors.
 - Bugfixing - IE - Producer names logged as undefined.

10.3.3 (Aug 8, 2018)
 - Removing logplease dependency hosted on GitHub.

10.3.2 (Jun 19, 2018)
 - Updating logging utility check for Node.js environments.

10.3.1 (Jun 4, 2018)
 - Added events npm package as a dependency.

10.3.0 (May 10, 2018)
 - Input and output validations.
 - Improved how the SDK parse the key.
 - Not push impressions if matchingKey is invalid.
 - Fixed memory leak on events factory.
 - Improved UT for the Node.js SDK.
 - TS declarations now accept boolean properties on Attributes.

10.2.0 (April 3, 2018)
 - Added greenkeeper configuration within package.json.
 - Updated several libraries versions.
 - Removed global polyfills.

10.1.1 (March 20, 2018)
 - Bugfixing - getTreatment will return 'control' and the impression registered
  will have label 'exception' when there is a Redis Exception.

10.1.0 (March 8, 2018)
 - Replaced isomorphic-fetch with axios.

10.0.0 (Feb 26, 2018)
 - Migrated source code to es modules.
 - Localhost mode uses fewer dependencies now.
 - Removed flowtype since it was not used anymore.
 - Updated to last Node.js LTS.
 - Added package-lock.json.
 - Fixed eslint configuration.

9.4.0 (Jan 12, 2018)
 - Adding support for client.track method, for tracking custom events.
 - Adding trafficType as an optional core setting. If provided on the browser it will be bound to the client as the key.
 - TypeScript declarations polishing.
 - Updated SDK labels.
 - Bugfixing - Shared clients (browser) were ready even if the main client was not.
 - Bugfixing - Shared clients (browser) from different SDK instances should be separate.
 - Bugfixing - When using SDK key with wrong permissions, Node.js was throwing a false ready event (without segments).
 - Bugfixing - Localhost mode was trying to flush impressions when client.destroy was invoked.

9.3.7 (Dec 22, 2017)
 - Updated SDK labels.

9.3.6 (Oct 12, 2017)
 - Fixed an issue that was not rejecting client.ready() on SDK_READY_TIMED_OUT event.
 - Fixed an issue where the SDK required a key even on localhost mode.
 - Added custom message for 404 errors.
 - Updated TypeScript declaration files for exposing startup settings on Node.js.

9.3.5 (Sep 13, 2017)
 - Internal context module added.
 - Removed /src folder and some misc files from NPM package.
 - Dependencies update & cleanup.

9.3.4 (Aug 23, 2017)
 - Removed FullStory integration

9.3.3 (Aug 15, 2017)
 - Improved metrics collection.

9.3.2 (Aug 9, 2017)
 - Adding support for Node.js v0.10.X

9.3.1 (Jul 28, 2017)
 - Bugfixing - Fixed a bug on Manager API which was not retrieving the right treatments for a Split on some cases.

9.3.0 (Jul 25, 2017)
 - Several new matchers have been released:
   - Dependency Matchers
   - Boolean Matchers
   - Regex Matchers

9.2.2 (Jul 20, 2017)
 - Bugfixing - Added support into the SDK to flush impressions before destroy the instance.

9.2.1 (May 19, 2017)
 - Bugfixing - Issue with dependency that exposes untranspiled code through cjs require, causes
  problems on IE and Node.js 3.

9.2.0 (May 11, 2017)
 - Dropped migration build. Migration packages will no longer receive updates.
 - Updated logging functionality. SDK will handle logging with a minimalistic enable/disable approach.
  Now you have three ways to enable/disable SDK logging:

  1. By setting the localStorage.splitio_debug (browser) or SPLITIO_DEBUG environment var (Node.js)
    with 'on', 'enable' or 'enabled'.

  2. By passing an extra setting when instantiating the SDK.

    ```js
    var splitio = require('@splitsoftware/splitio');

    var settings = {
      core: {
        authorizationKey: 'YOUR_SDK_KEY',
        key: 'CUSTOMER_KEY'  // If on the browser.
      },
      debug: true  // Boolean flag for enabling logs. Default value is false.
    };

    var sdk = splitio(settings);
    ```

  3. By calling the SDK Logger API (no need for browser refresh):

    ```js
    var splitio = require('@splitsoftware/splitio');

    var sdk = splitio({
      core: {
        authorizationKey: 'YOUR_SDK_KEY',
        key: 'CUSTOMER_KEY'  // If on the browser.
      }
    });

    // Logger API.
    sdk.Logger.enable();
    sdk.Logger.disable();
    ```

 - Added Time Tracker logs. When logs are enabled, we log how much time takes to complete
  SDK important tasks, like getting ready, downloading important information or pushing
  metrics and impressions to Split.
 - Bugfixing - Return correct label when consulted Split is not found.

9.1.1 (May 03, 2017)
 - Bugfixing - Fixed invalid behavior when using native Fetch API and comparing statusText
  instead of resp.ok

9.1.0 (April 21, 2017)
 - Adding support for STRING matchers.
 - client.destroy() will disconnect from Redis instance, if you are using that storage.
 - Improved support for multiple SDK instances working at the same time.
 - Improved attribute values type coercion.
 - No API changes.

9.0.0 (April 17, 2017)
 - Adding support for SET matchers.
 - Added some type coercion for attribute values, in case we don't receive a value of the expected type.
 - No API changes.

8.2.0 (April 12, 2017)
 - Adding traffic allocation support.
 - Adding support for murmur hashing algorithm.
 - Adding getTreatments method to client API. For example:

```js
var treatmentsMap = client.getTreatments('CUSTOMER_KEY', ['Feature_flag_1', 'Feature_flag_2']);

/*
* treatmentsMap will be an object mapping feature flags with treatments. For example:
* {
*   Feature_flag_1: 'on',
*   Feature_flag_2: 'off
* }
*/
```

 - Bugfixing on manager API for localhost.

8.1.3 (April 11, 2017)
 - No API changes. Bug fixing release.

8.1.2 (April 6, 2017)
 - Bug fixing release to improve startup performance.

8.1.1 (March 31, 2017)
 - Small fix on declaration files.

8.1.0 (March 30, 2017)
 - No API changes.
 - Added typescript support. SplitSDK custom types live on the SplitIO namespace.

  For example:

  ```ts
  const myTreatment: SplitIO.Treatment;
  const myBrowserSettings: SplitIO.IBrowserSettings;
  ```

8.0.0 (March 10, 2017)
 - New API to improve development experience. We added a migration layer so you
  could use the new version of the SDK and make the migration when you have
  time.

  In the browser we only need:

  ```html
  <script src="//cdn.split.io/sdk/split-7.4.0.min.js"></script>
  ```

  Change by:

  ```html
  <script src="//cdn.split.io/sdk/split-migration-8.0.0.min.js"></script>
  ```

  In Node.js or CommonJS environments:

  ```js
  var sdk = require('@splitsoftware/splitio');
  ```

  Change with:

  ```js
  var sdk = require('@splitsoftware/splitio/migration');
  ```

 - Node.js now added support for Redis to keep consistency across multiple SDK
  instances.

  We have added a new setting parameter to control which storage use, and how
  the SDK works internally:

  ```js
  const SplitFactory = require('@splitsoftware/splitio');
  const config = {
    mode: 'consumer',
    core: {
      authorizationKey: '<your-api-token>'
    },
    storage: {
      type: 'REDIS',
      options: {
        url: 'redis://<your-redis-server>:<your-redis-server-port>/0'
      },
      prefix: 'nodejs' // Optional prefix to prevent any kind of data collision between SDK versions.
    }
  };

  const client = SplitFactory(config);

  // Redis in Node.js is async so we can use async/await syntax
  const treatment = await client.getTreatment('my-feature-coming-from-localstorage');

  // or just use the returned promise
  client.getTreatment('my-feature-coming-from-localstorage').then(treatment => {
    // do something with the treatment
  });
  ```

 - Added Manager API to query the state of the SDK. Please check the official
  documentation for details.

 - In Browser land, we can now enable localStorage as backend so we can reload
  the SDK quickly without downloading all the data again.

  This should improve the ready event significantly when you have a good amount
  of Splits in your setup.

  ```js
  const config = {
    core: {
      authorizationKey: '<your-api-token>',
      key: '<user-key>'
    },
    storage: {
      type: 'LOCALSTORAGE'
    }
  };

  const factory = splitio(config);
  const client = factory.client();

  const treatment = client.getTreatment('my-feature-comming-from-localstorage');
  ```

 - Added support for offline changes release to improve development experience,
  specially in Node.js where we used to have a server running and spin it up each
  time we change a treatment is a headache.

  ```js
  const config = {
    core: {
      authorizationKey: '<your-api-token>',
      key: '<user-key>'
    },
    scheduler: {
      offlineRefreshRate: 15 // update internal SDK state each 15 sec
    },
    features: {
      mySplit: 'on'
    }
  };

  const factory = splitio(config);
  const client = factory.client();

  await client.ready();

  client.getTreatment('my_feature') === 'on'; // true

  factory.settings.features.my_feature = 'off'; // Apply this cache programmatically

  client.getTreatment('my_feature') === 'off'; // Some time after you will be able to verify this
  ```

7.4.0 (January 23, 2017)
 - None API changes. Bug fixing release.

7.3.0 (January 19, 2017)
 - Small addition to SDK configurations so you can inject bucketing key and labels.

7.1.1 (November 16, 2016)
 - None API changes. Bug fixing release.

7.1.0 (November 15, 2016)
 - None API changes. Bug fixing release.

7.0.1 (September 16, 2016)
 - Huge project refactoring, specially focus on simplicity. We have replaced the
  library building system to get more power while we generate the release.
 - Improved documentation.

6.0.1 (June 24, 2016)
 - Critical bug fixed which prevent ready state of the SDK.

6.0.0 (June 24, 2016)
 - In the browser land we allow quick retries before start using the refresh
  rates defined for segments and feature flags, plus the possibility of receive an
  event when the SDK is taking to much time to startup.

  ```html
  <script src="//cdn.split.io/sdk/split-6.0.0.min.js"></script>
  <script>
    var sdk = splitio({
      core: {
        authorizationKey: '<your-token>',
        key: 'myuser@domain.com'
      },
      startup: {
        // timeout an *initial* request after 0.8 seconds (only affects startup)
        requestTimeoutBeforeReady: 0.8,
        // how many quick retries are allowed before use the schedulers refresh
        // rates (only affects startup)
        retriesOnFailureBeforeReady: 1,
        // maximum amount of seconds we are going to wait for the ready event
        readyTimeout: 1.5
      }
    });

    sdk.on(sdk.Event.SDK_READY_TIMED_OUT, function () {
      // this callback will be called after 1.5 seconds if and only if the SDK
      // is not ready for that time
    });

    sdk.on(sdk.Event.SDK_READY, function () {
      // the SDK is ready for start making evaluations with your data
    });

    sdk.on(sdk.Event.SDK_UPDATE, function () {
      // fired each time the SDK state change
    });
  </script>
  ```

5.1.1 (June 13, 2016)
 - None API changes. Bug fixing release.

5.1.0 (June 9, 2016)
 - Bug fixing release.

5.0.0 (June 6, 2016)
 - Added support for multiple instances.

  ```html
  <script src="//cdn.split.io/sdk/split-5.0.0.min.js"></script>
  <script>
    // instantiation
    var dynamic1 = splitio({
      core: {
        authorizationKey: '<your-token>',
        key: 'myuser@domain.com'
      }
    });

    var dynamic2 = splitio({
      core: {
        authorizationKey: '<your-token>',
        key: 'annoy@domain.com'
      }
    });

    // usage
    var t1 = dynamic1.getTreatment('feature-flag-name');
    var t2 = dynamic2.getTreatment('another-feature-flag-name');

    // stop SDK
    dynamic1.destroy();
    dynamic2.destroy();

    // unreference
    dynamic1 = null;
    dynamic2 = null;
  </script>
  ```

 - SDK instances inherit from EventEmitter.

  ```html
  <script src="//cdn.split.io/sdk/split-5.0.0.min.js"></script>
  <script>
    var sdk = splitio({
      core: {
        authorizationKey: '<your-token>',
        key: 'myuser@domain.com'
      }
    });

    sdk.on(sdk.Event.SDK_READY, function sdkReadyEvent() {
      // This event will be fired once
    });

    sdk.on(sdk.Event.SDK_UPDATE, function sdkUpdateEvent() {
      // This event will be fired each time the SDK downloads an update
    });
  </script>
  ```

4.0.0 (April 13, 2016)
 - No more url changes required to switch to development mode.

  - Before (3.0.0 or earlier)
  ```html
  <script src="https://cdn.split.io/sdk/offline-3.0.0.js"></script>
  <script>
    var sdk = splitio({
      features: {
        feature_name_1: 'treatment_value_1',
        feature_name_2: 'treatment_value_2',
        ...
      }
    });
  </script>
  ```

  - After (4+)
  ```html
  <script src="https://cdn.split.io/sdk/split-4.0.0.js"></script>
  <script>
    var sdk = splitio({
      core: {
        authorizationKey: 'localhost'
      },
      features: {
        feature_name_1: 'treatment_value_1',
        feature_name_2: 'treatment_value_2',
        ...
      }
    });
  </script>
  ```

  Now you can forget the switch between urls, everything is bundled into the same
  package!

3.0.0 (April 10, 2016)
 - Added support for attributes.

```js
var sdk = splitio({
  core: {
    authorizationKey: 'c1l5vkd50gimccout3c03pntbu', // your SDK key
    key: '4a2c4490-ced1-11e5-9b97-d8a25e8b1578'     // your customer id
  }
});

var treatment = sdk.getTreatment('my_feature', {
  age: 24,
  likes: ['apple', 'orange'],
  dob: new Date('1991-05-22').getTime()
});
```

 - Minor bug fixes and code clean up.

2.1.0 (March 29, 2016)
 - Added better handling of possible error situations when:

  1. If there is none defaultTreatment present, use 'control' treatment.
  2. Unexpected matcher structures should produce a 'control' treatment.

2.0.0 (March 21, 2016)
 - Breaking Changes

  - If you are using custom refresh rates, please change them from milliseconds to
seconds:

```js
var sdk = splitio({
  core: {
    authorizationKey: 'c1l5vkd50gimccout3c03pntbu', // your SDK key
    key: '4a2c4490-ced1-11e5-9b97-d8a25e8b1578'     // your customer id
  },
  scheduler: {
    featuresRefreshRate:    60, // in 2.x 60 sec, in 1.x 60000 milliseconds
    segmentsRefreshRate:    60, // in 2.x 60 sec, in 1.x 60000 milliseconds
    metricsRefreshRate:     30, // in 2.x 30 sec, in 1.x 30000 milliseconds
    impressionsRefreshRate: 30  // in 2.x 30 sec, in 1.x 30000 milliseconds
  }
});
```

 - New features

 - Based on users feedback, the new recommended values for all the refresh rates are:

```js
scheduler: {
  featuresRefreshRate:    30, // in 2.x 30 sec, in 1.x 60000 milliseconds (1min)
  segmentsRefreshRate:    60, // in 2.x 60 sec, in 1.x 60000 milliseconds (1min)
  metricsRefreshRate:     60, // in 2.x 60 sec, in 1.x 300000 milliseconds (5min)
  impressionsRefreshRate: 60  // in 2.x 60 sec, in 1.x 300000 milliseconds (5min)
}
```

1.0.1 (March 16, 2016)
 - Make it public in npm

1.0.0 (March 15, 2016)
 - Initial public release