@splitsoftware/splitio 10.22.3 → 10.22.4

package/CHANGES.txt

@@ -1,3 +1,7 @@
+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.
@@ -91,6 +95,7 @@
       - 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.
@@ -141,7 +146,7 @@
  - 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 (thanks @andrew-t-james-hm).
+ - 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:
@@ -169,6 +174,7 @@
  - Added `sync.splitFilters` property to SDK configuration to pass a list of filters for the splits that will be downloaded. Read more in our docs.
  - Added expiration policy to split 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.

package/CONTRIBUTORS-GUIDE.md

@@ -7,10 +7,10 @@ Split SDK is an open source project and we welcome feedback and contribution. Th
 ### 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 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. If your changes have any impact on the public API, make sure you update the TypeScript delcarations as well as it's related test file.
+5. If your changes have any impact on the public API, make sure you update the TypeScript declarations as well as it's related test file.
 6. Run the linter script of the project and fix any issues you find.
 7. Run the build script and make sure it runs with no errors.
 8. Run all tests and make sure there are no failures.

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2022 Split Software, Inc.
+Copyright © 2023 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.22.3';
+export var packageVersion = '10.22.4';

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.22.3';
+exports.packageVersion = '10.22.4';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.22.3",
+  "version": "10.22.4",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -35,7 +35,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.7.3",
+    "@splitsoftware/splitio-commons": "1.8.1",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.22.3';
+export const packageVersion = '10.22.4';

package/types/splitio.d.ts

@@ -458,9 +458,12 @@ interface IStatusInterface extends EventEmitter {
  */
 interface IBasicClient extends IStatusInterface {
   /**
-   * Destroy the client instance.
+   * Destroys the client instance.
+   * In 'standalone' mode, this method will flush any pending impressions and events, and stop the synchronization of feature flag definitions with the backend.
+   * In 'consumer' mode, this method will disconnect the SDK from the Redis or Pluggable storage.
+   *
    * @function destroy
-   * @returns {Promise<void>}
+   * @returns {Promise<void>} A promise that will be resolved once the client is destroyed.
    */
   destroy(): Promise<void>
 }
@@ -1130,13 +1133,13 @@ declare namespace SplitIO {
       /**
        * Synchronous storage type to be instantiated by the SDK.
        * @property {NodeSyncStorage} type
-       * @default MEMORY
+       * @default 'MEMORY'
        */
       type?: NodeSyncStorage,
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix
-       * @default SPLITIO
+       * @default 'SPLITIO'
        */
       prefix?: string
     },
@@ -1145,7 +1148,7 @@ declare namespace SplitIO {
      * For "localhost" mode, use "localhost" as authorizationKey.
      *
      * @property {'standalone'} mode
-     * @default standalone
+     * @default 'standalone'
      */
     mode?: 'standalone'
   }
@@ -1234,7 +1237,7 @@ declare namespace SplitIO {
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix
-       * @default SPLITIO
+       * @default 'SPLITIO'
        */
       prefix?: string
     },