Merge pull request #87 from splitio/update_readme

Misc: fix typos, update README, bump dependencies for vulnerability fixes

Author: EmilianoSanchez

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up nodejs
+      - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'

CHANGES.txt

@@ -1,5 +1,8 @@
+0.7.1 (May XXX, 2025)
+ - Updated some transitive dependencies for vulnerability fixes.
+
 0.7.0 (August 5, 2024)
- - Added `sync.requestOptions.agent` option to allow passing a custom NodeJS HTTP(S) Agent with specific configurations for the Synchronizer requests, like custom TLS settings or a network proxy (See https://help.split.io/hc/en-us/articles/4421513571469-Split-JavaScript-synchronizer-tools#proxy).
+ - Added `sync.requestOptions.agent` option to allow passing a custom Node.js HTTP(S) Agent with specific configurations for the Synchronizer requests, like custom TLS settings or a network proxy (See https://help.split.io/hc/en-us/articles/4421513571469-Split-JavaScript-synchronizer-tools#proxy).
  - Updated some transitive dependencies for vulnerability fixes.
 
 0.6.0 (May 13, 2024)
@@ -31,8 +34,8 @@
 0.3.0 (May 4, 2023)
  - Added an optional error-first callback parameter to `execute` method, to be called when the synchronization is finished, with an error object if it finished unsuccessfully.
  - Updated @splitsoftware/splitio-commons and other dependencies for vulnerability fixes and performance improvements.
- - Bugfixing - Fixed `execute` method to ensure the returned promise resolves to `false` if any synchronization task fails (i.e., synchronization of feature flags, segments, impressions or events).
- - Bugfixing - Fixed `execute` method to await storage destroy promise and handle rejections.
+ - Bugfix - Fixed `execute` method to ensure the returned promise resolves to `false` if any synchronization task fails (i.e., synchronization of feature flags, segments, impressions or events).
+ - Bugfix - Fixed `execute` method to await storage destroy promise and handle rejections.
 
 0.2.0 (October 5, 2022)
  - Added support for synchronizing telemetry data, impression counts and unique keys in pluggable storage.

CONTRIBUTORS-GUIDE.md

@@ -7,7 +7,7 @@ Split JavaScript Sync Tools is an open source project and we welcome feedback an
 ### Development process
 
 1. Fork the repository and create a topic branch from `development` branch. Please use a descriptive name for your branch.
-2. Run `nvm use` to ensure that you are using the right npm and node version, and `npm install` to have the dependencies up to date.
+2. Run `nvm use` to ensure that you are using the right npm and Node.js version, and `npm install` to have the dependencies up to date.
 3. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like: "fix bug".
 4. Make sure to add tests for both positive and negative cases.
 5. Run the linter script of the project and fix any issues you find.

README.md

@@ -65,13 +65,14 @@ Split has built and maintains SDKs for:
 * .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
 * Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* Elixir thin-client [Github](https://github.com/splitio/elixir-thin-client) [Docs](https://help.split.io/hc/en-us/articles/26988707417869-Elixir-Thin-Client-SDK)
 * Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
 * JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
-* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
+* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://help.split.io/hc/en-us/articles/18305128673933-PHP-Thin-Client-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
@@ -84,4 +85,4 @@ For a comprehensive list of open source projects visit our [Github page](https:/
 
 **Learn more about Split:**
 
-Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.
+Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](https://help.split.io) for more detailed information.

e2e/utils/SDKConsumerMode.ts

@@ -33,7 +33,7 @@ export default function runSDKConsumer(impressionsMode: ImpressionsMode) {
       impressionsMode,
     }, // @ts-ignore
   }, (modules) => {
-    // Using pluggable storage in NodeJS SDK
+    // Using pluggable storage in Node.js
     modules.storageFactory = PluggableStorage({
       prefix: modules.settings.storage.prefix,
       wrapper: redisAdapterWrapper(modules.settings.storage.options),

e2e/utils/redisAdapterWrapper.ts

@@ -2,7 +2,7 @@ import { RedisAdapter } from '@splitsoftware/splitio-commons/src/storages/inRedi
 import { IPluggableStorageWrapper } from '@splitsoftware/splitio-commons/src/storages/types';
 import { noopLogger } from '../../src/submitters/__tests__/commonUtils';
 
-// @TODO refactor: move to JS-commons, rename to `ioredisWrapper`, and reuse in JS SDK for Node
+// @TODO refactor: move to JS-commons, rename to `ioredisWrapper`, and reuse in JS SDK for Node.js
 /**
  * Creates a storage wrapper that uses our RedisAdapter.
  * Operations fail until `connect` is resolved once the Redis 'ready' event is emitted.