@splitsoftware/splitio 10.22.3 → 10.22.5-rc.0

package/CHANGES.txt

@@ -1,3 +1,13 @@
+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.
@@ -11,7 +21,7 @@
 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 NodeJS and from 30 seconds to 60 seconds for Browser.
- - Updated @splitsoftware/splitio-commons package to version 1.7.1, that improves the performance of split evaluations (i.e., `getTreatment(s)` method calls) when using the default storage in memory, among other improvements.
+ - 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`.
@@ -80,7 +90,7 @@
  - 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 split evaluations (i.e., `getTreatment(s)` method calls).
+ - 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.
 
@@ -91,6 +101,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 +152,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:
@@ -166,9 +177,10 @@
  - 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 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.
+ - 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.
@@ -199,7 +211,7 @@
  - 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 split cache in the storage of the browser.
+ - 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)
 
@@ -214,14 +226,14 @@
 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 splits at once for getTreatments/getTreatmentsWithConfig.
+ - 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 split to have level WARN instead of ERROR.
+ - 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:
@@ -344,7 +356,7 @@
  - 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 API key with wrong permissions, Node was throwing a false ready event (without segments).
+ - Bugfixing - When using SDK key with wrong permissions, Node 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)
@@ -401,7 +413,7 @@
 
     var settings = {
       core: {
-        authorizationKey: 'YOUR_API_KEY',
+        authorizationKey: 'YOUR_SDK_KEY',
         key: 'CUSTOMER_KEY'  // If on the browser.
       },
       debug: true  // Boolean flag for enabling logs. Default value is false.
@@ -417,7 +429,7 @@
 
     var sdk = splitio({
       core: {
-        authorizationKey: 'YOUR_API_KEY',
+        authorizationKey: 'YOUR_SDK_KEY',
         key: 'CUSTOMER_KEY'  // If on the browser.
       }
     });
@@ -454,13 +466,13 @@
  - Adding getTreatments method to client API. For example:
 
 ```js
-var treatmentsMap = client.getTreatments('CUSTOMER_KEY', ['Split_1', 'Split_2']);
+var treatmentsMap = client.getTreatments('CUSTOMER_KEY', ['Feature_flag_1', 'Feature_flag_2']);
 
 /*
-* treatmentsMap will be an object mapping splits with treatments. For example:
+* treatmentsMap will be an object mapping feature flags with treatments. For example:
 * {
-*   Split_1: 'on',
-*   Split_2: 'off
+*   Feature_flag_1: 'on',
+*   Feature_flag_2: 'off
 * }
 */
 ```
@@ -627,7 +639,7 @@ var treatmentsMap = client.getTreatments('CUSTOMER_KEY', ['Split_1', 'Split_2'])
 
 6.0.0 (June 24, 2016)
  - In the browser land we allow quick retries before start using the refresh
-  rates defined for segments and splits, plus the possibility of receive an
+  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
@@ -692,8 +704,8 @@ var treatmentsMap = client.getTreatments('CUSTOMER_KEY', ['Split_1', 'Split_2'])
     });
 
     // usage
-    var t1 = dynamic1.getTreatment('split-name');
-    var t2 = dynamic2.getTreatment('another-split-name');
+    var t1 = dynamic1.getTreatment('feature-flag-name');
+    var t2 = dynamic2.getTreatment('another-feature-flag-name');
 
     // stop SDK
     dynamic1.destroy();
@@ -770,7 +782,7 @@ var treatmentsMap = client.getTreatments('CUSTOMER_KEY', ['Split_1', 'Split_2'])
 ```js
 var sdk = splitio({
   core: {
-    authorizationKey: 'c1l5vkd50gimccout3c03pntbu', // your API key
+    authorizationKey: 'c1l5vkd50gimccout3c03pntbu', // your SDK key
     key: '4a2c4490-ced1-11e5-9b97-d8a25e8b1578'     // your customer id
   }
 });
@@ -799,7 +811,7 @@ seconds:
 ```js
 var sdk = splitio({
   core: {
-    authorizationKey: 'c1l5vkd50gimccout3c03pntbu', // your API key
+    authorizationKey: 'c1l5vkd50gimccout3c03pntbu', // your SDK key
     key: '4a2c4490-ced1-11e5-9b97-d8a25e8b1578'     // your customer id
   },
   scheduler: {

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/README.md

@@ -1,9 +1,9 @@
-# Split SDK for Javascript
+# Split SDK for JavaScript
 
 [![npm version](https://badge.fury.io/js/%40splitsoftware%2Fsplitio.svg)](https://badge.fury.io/js/%40splitsoftware%2Fsplitio) [![Build Status](https://github.com/splitio/javascript-client/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/splitio/javascript-client/actions/workflows/ci-cd.yml) [![Greenkeeper badge](https://badges.greenkeeper.io/splitio/javascript-client.svg)](https://greenkeeper.io/)
 
 ## Overview
-This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.
+This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
@@ -23,7 +23,7 @@ var SplitFactory = require('@splitsoftware/splitio').SplitFactory;
 // Instantiate the SDK
 var factory = SplitFactory({
   core: {
-    authorizationKey: 'YOUR_SDK_API_KEY'
+    authorizationKey: 'YOUR_SDK_KEY'
   }
 });
 
@@ -32,7 +32,7 @@ var client = factory.client();
 
 // Set a callback to listen for the SDK_READY event, to make sure the SDK is properly loaded before asking for a treatment
 client.on(client.Event.SDK_READY, function() {
-  var treatment = client.getTreatment('CUSTOMER_ID', 'SPLIT_NAME');
+  var treatment = client.getTreatment('CUSTOMER_ID', 'FEATURE_FLAG_NAME');
   if (treatment == 'on') {
     // insert code here for on treatment
   } else if (treatment == 'off') {
@@ -67,8 +67,8 @@ Split has built and maintains SDKs for:
 * 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)
+* 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)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)

package/es/index.js

@@ -1,16 +1 @@
-/**
-Copyright 2022 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
 export { SplitFactory } from './factory';

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.22.3';
+export var packageVersion = '10.22.5-rc.0';

package/es/sync/offline/splitsParserFromFile.js

@@ -3,31 +3,32 @@ import path from 'path';
 import yaml from 'js-yaml';
 import { isString, endsWith, find, forOwn, uniq, } from '@splitsoftware/splitio-commons/esm/utils/lang';
 import { parseCondition } from '@splitsoftware/splitio-commons/esm/sync/offline/splitsParser/parseCondition';
-var logPrefix = 'sync:offline:splits-fetcher: ';
+var logPrefix = 'sync:offline:fetcher: ';
 var DEFAULT_FILENAME = '.split';
 function configFilesPath(configFilePath) {
     if (configFilePath === DEFAULT_FILENAME || !isString(configFilePath)) {
         var root = process.env.HOME;
+        // @TODO env var not documented in help center
         if (process.env.SPLIT_CONFIG_ROOT)
             root = process.env.SPLIT_CONFIG_ROOT;
         if (!root)
-            throw new Error('Missing split mock configuration root.');
+            throw new Error('Missing root of the feature flags mock file.');
         configFilePath = path.join(root, DEFAULT_FILENAME);
     }
     // Validate the extensions
     if (!(endsWith(configFilePath, '.yaml', true) || endsWith(configFilePath, '.yml', true) || endsWith(configFilePath, '.split', true)))
-        throw new Error("Invalid extension specified for Splits mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
+        throw new Error("Invalid extension specified for feature flags mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
     if (!fs.existsSync(configFilePath))
-        throw new Error("Split configuration not found in " + configFilePath + " - Please review your Split file location.");
+        throw new Error("Feature flags mock file not found in " + configFilePath + " - Please review the file location.");
     return configFilePath;
 }
 // This function is not pure nor meant to be. Here we apply modifications to cover
 // for behaviour that's ensured by the BE.
 function arrangeConditions(mocksData) {
-    // Iterate through each Split data
+    // Iterate through each feature flag data
     forOwn(mocksData, function (data) {
         var conditions = data.conditions;
-        // On the manager, as the split jsons come with all treatments on the partitions prop,
+        // On the manager, as feature flag JSONs come with all treatments on the partitions prop,
         // we'll add all the treatments to the first condition.
         var firstRolloutCondition = find(conditions, function (cond) { return cond.conditionType === 'ROLLOUT'; });
         // Malformed mocks may have
@@ -49,9 +50,9 @@ function arrangeConditions(mocksData) {
 }
 export function splitsParserFromFileFactory() {
     var previousMock = 'NO_MOCK_LOADED';
-    // Parse `.split` configuration file and return a map of "Split Objects"
-    function readSplitConfigFile(log, filePath) {
-        var SPLIT_POSITION = 0;
+    // Parse `.split` configuration file and return a map of feature flag objects
+    function readFeatureFlagConfigFile(log, filePath) {
+        var FEATURE_FLAG_POSITION = 0;
         var TREATMENT_POSITION = 1;
         var data;
         try {
@@ -64,7 +65,7 @@ export function splitsParserFromFileFactory() {
         if (data === previousMock)
             return false;
         previousMock = data;
-        var splitObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
+        var featureFlagObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
             var tuple = line.trim();
             if (tuple === '' || tuple.charAt(0) === '#') {
                 log.debug(logPrefix + ("Ignoring empty line or comment at #" + index));
@@ -75,16 +76,16 @@ export function splitsParserFromFileFactory() {
                     log.debug(logPrefix + ("Ignoring line since it does not have exactly two columns #" + index));
                 }
                 else {
-                    var splitName = tuple[SPLIT_POSITION];
+                    var featureFlagName = tuple[FEATURE_FLAG_POSITION];
                     var condition = parseCondition({ treatment: tuple[TREATMENT_POSITION] });
-                    accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
+                    accum[featureFlagName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
                 }
             }
             return accum;
         }, {});
-        return splitObjects;
+        return featureFlagObjects;
     }
-    // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
+    // Parse `.yml` or `.yaml` configuration files and return a map of feature flag objects
     function readYAMLConfigFile(log, filePath) {
         var data = '';
         var yamldoc = null;
@@ -100,39 +101,39 @@ export function splitsParserFromFileFactory() {
             return {};
         }
         // Each entry will be mapped to a condition, but we'll also keep the configurations map.
-        var mocksData = (yamldoc).reduce(function (accum, splitEntry) {
-            var splitName = Object.keys(splitEntry)[0];
-            if (!splitName || !isString(splitEntry[splitName].treatment))
+        var mocksData = (yamldoc).reduce(function (accum, featureFlagEntry) {
+            var featureFlagName = Object.keys(featureFlagEntry)[0];
+            if (!featureFlagName || !isString(featureFlagEntry[featureFlagName].treatment))
                 log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
-            var mockData = splitEntry[splitName];
-            // "Template" for each split accumulated data
-            if (!accum[splitName]) {
-                accum[splitName] = {
+            var mockData = featureFlagEntry[featureFlagName];
+            // "Template" for each feature flag accumulated data
+            if (!accum[featureFlagName]) {
+                accum[featureFlagName] = {
                     configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
                 };
             }
             // Assign the config if there is one on the mock
             if (mockData.config)
-                accum[splitName].configurations[mockData.treatment] = mockData.config;
+                accum[featureFlagName].configurations[mockData.treatment] = mockData.config;
             // Parse the condition from the entry.
             var condition = parseCondition(mockData);
-            accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
+            accum[featureFlagName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
             // Also keep track of the treatments, will be useful for manager functionality.
-            accum[splitName].treatments.push(mockData.treatment);
+            accum[featureFlagName].treatments.push(mockData.treatment);
             return accum;
         }, {});
         arrangeConditions(mocksData);
         return mocksData;
     }
     // Load the content of a configuration file into an Object
-    return function splitsParserFromFile(_a) {
+    return function featureFlagsParserFromFile(_a) {
         var features = _a.features, log = _a.log;
         var filePath = configFilesPath(features);
         var mockData;
         // If we have a filePath, it means the extension is correct, choose the parser.
         if (endsWith(filePath, '.split')) {
             log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
-            mockData = readSplitConfigFile(log, filePath);
+            mockData = readFeatureFlagConfigFile(log, filePath);
         }
         else {
             mockData = readYAMLConfigFile(log, filePath);

package/lib/index.js

@@ -1,19 +1,4 @@
 "use strict";
-/**
-Copyright 2022 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SplitFactory = void 0;
 var factory_1 = require("./factory");

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.5-rc.0';

package/lib/sync/offline/splitsParserFromFile.js

@@ -7,31 +7,32 @@ var path_1 = (0, tslib_1.__importDefault)(require("path"));
 var js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
 var lang_1 = require("@splitsoftware/splitio-commons/cjs/utils/lang");
 var parseCondition_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/splitsParser/parseCondition");
-var logPrefix = 'sync:offline:splits-fetcher: ';
+var logPrefix = 'sync:offline:fetcher: ';
 var DEFAULT_FILENAME = '.split';
 function configFilesPath(configFilePath) {
     if (configFilePath === DEFAULT_FILENAME || !(0, lang_1.isString)(configFilePath)) {
         var root = process.env.HOME;
+        // @TODO env var not documented in help center
         if (process.env.SPLIT_CONFIG_ROOT)
             root = process.env.SPLIT_CONFIG_ROOT;
         if (!root)
-            throw new Error('Missing split mock configuration root.');
+            throw new Error('Missing root of the feature flags mock file.');
         configFilePath = path_1.default.join(root, DEFAULT_FILENAME);
     }
     // Validate the extensions
     if (!((0, lang_1.endsWith)(configFilePath, '.yaml', true) || (0, lang_1.endsWith)(configFilePath, '.yml', true) || (0, lang_1.endsWith)(configFilePath, '.split', true)))
-        throw new Error("Invalid extension specified for Splits mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
+        throw new Error("Invalid extension specified for feature flags mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
     if (!fs_1.default.existsSync(configFilePath))
-        throw new Error("Split configuration not found in " + configFilePath + " - Please review your Split file location.");
+        throw new Error("Feature flags mock file not found in " + configFilePath + " - Please review the file location.");
     return configFilePath;
 }
 // This function is not pure nor meant to be. Here we apply modifications to cover
 // for behaviour that's ensured by the BE.
 function arrangeConditions(mocksData) {
-    // Iterate through each Split data
+    // Iterate through each feature flag data
     (0, lang_1.forOwn)(mocksData, function (data) {
         var conditions = data.conditions;
-        // On the manager, as the split jsons come with all treatments on the partitions prop,
+        // On the manager, as feature flag JSONs come with all treatments on the partitions prop,
         // we'll add all the treatments to the first condition.
         var firstRolloutCondition = (0, lang_1.find)(conditions, function (cond) { return cond.conditionType === 'ROLLOUT'; });
         // Malformed mocks may have
@@ -53,9 +54,9 @@ function arrangeConditions(mocksData) {
 }
 function splitsParserFromFileFactory() {
     var previousMock = 'NO_MOCK_LOADED';
-    // Parse `.split` configuration file and return a map of "Split Objects"
-    function readSplitConfigFile(log, filePath) {
-        var SPLIT_POSITION = 0;
+    // Parse `.split` configuration file and return a map of feature flag objects
+    function readFeatureFlagConfigFile(log, filePath) {
+        var FEATURE_FLAG_POSITION = 0;
         var TREATMENT_POSITION = 1;
         var data;
         try {
@@ -68,7 +69,7 @@ function splitsParserFromFileFactory() {
         if (data === previousMock)
             return false;
         previousMock = data;
-        var splitObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
+        var featureFlagObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
             var tuple = line.trim();
             if (tuple === '' || tuple.charAt(0) === '#') {
                 log.debug(logPrefix + ("Ignoring empty line or comment at #" + index));
@@ -79,16 +80,16 @@ function splitsParserFromFileFactory() {
                     log.debug(logPrefix + ("Ignoring line since it does not have exactly two columns #" + index));
                 }
                 else {
-                    var splitName = tuple[SPLIT_POSITION];
+                    var featureFlagName = tuple[FEATURE_FLAG_POSITION];
                     var condition = (0, parseCondition_1.parseCondition)({ treatment: tuple[TREATMENT_POSITION] });
-                    accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
+                    accum[featureFlagName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
                 }
             }
             return accum;
         }, {});
-        return splitObjects;
+        return featureFlagObjects;
     }
-    // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
+    // Parse `.yml` or `.yaml` configuration files and return a map of feature flag objects
     function readYAMLConfigFile(log, filePath) {
         var data = '';
         var yamldoc = null;
@@ -104,39 +105,39 @@ function splitsParserFromFileFactory() {
             return {};
         }
         // Each entry will be mapped to a condition, but we'll also keep the configurations map.
-        var mocksData = (yamldoc).reduce(function (accum, splitEntry) {
-            var splitName = Object.keys(splitEntry)[0];
-            if (!splitName || !(0, lang_1.isString)(splitEntry[splitName].treatment))
+        var mocksData = (yamldoc).reduce(function (accum, featureFlagEntry) {
+            var featureFlagName = Object.keys(featureFlagEntry)[0];
+            if (!featureFlagName || !(0, lang_1.isString)(featureFlagEntry[featureFlagName].treatment))
                 log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
-            var mockData = splitEntry[splitName];
-            // "Template" for each split accumulated data
-            if (!accum[splitName]) {
-                accum[splitName] = {
+            var mockData = featureFlagEntry[featureFlagName];
+            // "Template" for each feature flag accumulated data
+            if (!accum[featureFlagName]) {
+                accum[featureFlagName] = {
                     configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
                 };
             }
             // Assign the config if there is one on the mock
             if (mockData.config)
-                accum[splitName].configurations[mockData.treatment] = mockData.config;
+                accum[featureFlagName].configurations[mockData.treatment] = mockData.config;
             // Parse the condition from the entry.
             var condition = (0, parseCondition_1.parseCondition)(mockData);
-            accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
+            accum[featureFlagName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
             // Also keep track of the treatments, will be useful for manager functionality.
-            accum[splitName].treatments.push(mockData.treatment);
+            accum[featureFlagName].treatments.push(mockData.treatment);
             return accum;
         }, {});
         arrangeConditions(mocksData);
         return mocksData;
     }
     // Load the content of a configuration file into an Object
-    return function splitsParserFromFile(_a) {
+    return function featureFlagsParserFromFile(_a) {
         var features = _a.features, log = _a.log;
         var filePath = configFilesPath(features);
         var mockData;
         // If we have a filePath, it means the extension is correct, choose the parser.
         if ((0, lang_1.endsWith)(filePath, '.split')) {
             log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
-            mockData = readSplitConfigFile(log, filePath);
+            mockData = readFeatureFlagConfigFile(log, filePath);
         }
         else {
             mockData = readYAMLConfigFile(log, filePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.22.3",
+  "version": "10.22.5-rc.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -27,6 +27,11 @@
       "url": "https://github.com/NicoZelaya"
     }
   ],
+  "keywords": [
+    "splitio",
+    "sdk",
+    "javascript"
+  ],
   "main": "lib/index.js",
   "module": "es/index.js",
   "types": "types",
@@ -35,7 +40,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.7.3",
+    "@splitsoftware/splitio-commons": "1.8.2-rc.2",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",

package/src/index.js

@@ -1,17 +1 @@
-/**
-Copyright 2022 Split Software
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-**/
-
 export { SplitFactory } from './factory';