Merge pull request #836 from splitio/development

Release v11.0.0

Author: EmilianoSanchez

.eslintrc

@@ -46,7 +46,7 @@
       ],
       "rules": {
         "no-restricted-syntax": ["error", "ForOfStatement", "ForInStatement", "ArrayPattern"],
-        "compat/compat": ["error", "defaults, ie 10, node 6"],
+        "compat/compat": ["error", "defaults, node >=14"],
         "no-throw-literal": "error",
         "import/no-default-export": "error",
         "import/no-self-import": "error"

.gitignore

@@ -19,8 +19,8 @@ dump.rdb
 /stats
 
 ## transpiled code
-/lib
-/es
+/cjs
+/esm
 /umd
 
 ## TS tests compilated files

CHANGES.txt

@@ -1,3 +1,15 @@
+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:
+    - 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 NodeJS v6. The SDK now requires NodeJS v14 or above.
+    - 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.
@@ -507,7 +519,7 @@
  - Bugfixing - Return correct label when consulted Split is not found.
 
 9.1.1 (May 03, 2017)
- - Bugfixing - Fixed invalid behaviour when using native Fetch API and comparing statusText
+ - Bugfixing - Fixed invalid behavior when using native Fetch API and comparing statusText
   instead of resp.ok
 
 9.1.0 (April 21, 2017)

README.md

@@ -10,9 +10,9 @@ This SDK is designed to work with Split, the platform for controlled rollouts, w
 ## Compatibility
 The JavaScript SDK is an isomorphic library for both Node.js and Web browser environments.
 
-It supports **Node.js version 6.x and npm 3.x or later**.
+It supports **Node.js version 14.x or later**.
 
-For browsers it supports **IE10+ and all the other major browsers**. *However, IE doesn't have native support for Promises, which we require to properly work. If you're targeting IE it's up to you to provide Promises support. You should include a polyfill like [es6-promise](https://github.com/stefanpenner/es6-promise).*
+For browsers, the library was build to support ES5 syntax and all major browsers. *However, there are a few polyfills that would be required when targeting old browsers that don't have native support for Promises, Map and Set global objects. You should include polyfills for those, like [es6-promise](https://github.com/stefanpenner/es6-promise) for promises.*
 
 ## Getting started
 Below is a simple Node.js example that describes the instantiation and most basic usage of our SDK:

client/package.json

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