@splitsoftware/splitio-commons 2.0.0-rc.3 → 2.0.0-rc.5

package/src/utils/Backoff.ts

@@ -15,10 +15,6 @@ export class Backoff {
 
   /**
    * Schedule function calls with exponential backoff
-   *
-   * @param {function} cb
-   * @param {number} baseMillis
-   * @param {number} maxMillis
    */
   constructor(cb: (...args: any[]) => any, baseMillis?: number, maxMillis?: number) {
     this.baseMillis = Backoff.__TEST__BASE_MILLIS || baseMillis || Backoff.DEFAULT_BASE_MILLIS;

package/src/utils/MinEventEmitter.ts

@@ -1,5 +1,4 @@
-
-import { IEventEmitter } from '../types';
+import SplitIO from '../../types/splitio';
 
 const NEW_LISTENER_EVENT = 'newListener';
 const REMOVE_LISTENER_EVENT = 'removeListener';
@@ -11,7 +10,7 @@ function checkListener(listener: unknown) {
 }
 
 // @TODO implement missing methods, check spec and add UTs
-export class EventEmitter implements IEventEmitter {
+export class EventEmitter implements SplitIO.IEventEmitter {
 
   private listeners: Record<string, Array<[
     (...args: any[]) => void, // the event listener

package/src/utils/MinEvents.ts

@@ -30,7 +30,7 @@
 // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-import { IEventEmitter } from '../types';
+import SplitIO from '../../types/splitio';
 
 var R = typeof Reflect === 'object' ? Reflect : null;
 var ReflectApply = R && typeof R.apply === 'function'
@@ -39,7 +39,7 @@ var ReflectApply = R && typeof R.apply === 'function'
     return Function.prototype.apply.call(target, receiver, args);
   };
 
-export const EventEmitter: { new(): IEventEmitter } = function EventEmitter() {
+export const EventEmitter: { new(): SplitIO.IEventEmitter } = function EventEmitter() {
   EventEmitter.init.call(this);
 };
 

package/src/utils/Semver.ts

@@ -84,7 +84,7 @@ export class Semver {
   /**
    * Precedence comparision between 2 Semver objects.
    *
-   * @return `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
+   * @returns `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
    */
   public compare(toCompare: Semver): number {
     if (this.version === toCompare.version) return 0;

package/src/utils/base64/index.ts

@@ -22,7 +22,7 @@ const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=
 /**
  * Decode a given string value in Base64 format
  *
- * @param {string} input value to decode
+ * @param input - value to decode
  */
 export function decodeFromBase64(input: string): string {
   const str = (String(input)).replace(/[=]+$/, ''); // #31: ExtendScript bad parse of /=
@@ -48,7 +48,7 @@ export function decodeFromBase64(input: string): string {
 /**
  * Encode a given string value to Base64 format.
  *
- * @param {string} input value to encode
+ * @param input - value to encode
  */
 export function encodeToBase64(input: string): string {
   const str = String(input);

package/src/utils/constants/index.ts

@@ -1,5 +1,4 @@
-import { StorageType } from '../../storages/types';
-import { SDKMode } from '../../types';
+import SplitIO from '../../../types/splitio';
 
 // Special treatments
 export const CONTROL = 'control';
@@ -22,17 +21,17 @@ export const OPTIMIZED = 'OPTIMIZED';
 export const NONE = 'NONE';
 
 // SDK Modes
-export const LOCALHOST_MODE: SDKMode = 'localhost';
-export const STANDALONE_MODE: SDKMode = 'standalone';
+export const LOCALHOST_MODE = 'localhost';
+export const STANDALONE_MODE = 'standalone';
 export const PRODUCER_MODE = 'producer';
-export const CONSUMER_MODE: SDKMode = 'consumer';
-export const CONSUMER_PARTIAL_MODE: SDKMode = 'consumer_partial';
+export const CONSUMER_MODE = 'consumer';
+export const CONSUMER_PARTIAL_MODE = 'consumer_partial';
 
 // Storage types
-export const STORAGE_MEMORY: StorageType = 'MEMORY';
-export const STORAGE_LOCALSTORAGE: StorageType = 'LOCALSTORAGE';
-export const STORAGE_REDIS: StorageType = 'REDIS';
-export const STORAGE_PLUGGABLE: StorageType = 'PLUGGABLE';
+export const STORAGE_MEMORY: SplitIO.StorageType = 'MEMORY';
+export const STORAGE_LOCALSTORAGE: SplitIO.StorageType = 'LOCALSTORAGE';
+export const STORAGE_REDIS: SplitIO.StorageType = 'REDIS';
+export const STORAGE_PLUGGABLE: SplitIO.StorageType = 'PLUGGABLE';
 
 // User consent
 export const CONSENT_GRANTED = 'GRANTED'; // The user has granted consent for tracking events and impressions

package/src/utils/decompress/index.ts

@@ -409,8 +409,8 @@ export const algorithms = (function iifeDecompress() {
   return {
     /**
      * Expands GZIP data
-     * @param data The data to decompress
-     * @param out Where to write the data. GZIP already encodes the output size, so providing this doesn't save memory.
+     * @param data - The data to decompress
+     * @param out - Where to write the data. GZIP already encodes the output size, so providing this doesn't save memory.
      * @returns The decompressed version of the data
      */
     gunzipSync(data: Uint8Array, out?: Uint8Array): Uint8Array {
@@ -418,8 +418,8 @@ export const algorithms = (function iifeDecompress() {
     },
     /**
      * Expands Zlib data
-     * @param data The data to decompress
-     * @param out Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.
+     * @param data - The data to decompress
+     * @param out - Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.
      * @returns The decompressed version of the data
      */
     unzlibSync(data: Uint8Array, out?: Uint8Array): Uint8Array {

package/src/utils/inputValidation/attributes.ts

@@ -1,5 +1,5 @@
 import { isObject } from '../lang';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 import { validateAttribute } from './attribute';
 import { ERROR_NOT_PLAIN_OBJECT } from '../../logger/constants';

package/src/utils/inputValidation/eventProperties.ts

@@ -1,6 +1,6 @@
 import { isObject, isString, isFiniteNumber, isBoolean } from '../lang';
 import { objectAssign } from '../lang/objectAssign';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 import { ERROR_NOT_PLAIN_OBJECT, ERROR_SIZE_EXCEEDED, WARN_SETTING_NULL, WARN_TRIMMING_PROPERTIES } from '../../logger/constants';
 

package/src/utils/inputValidation/key.ts

@@ -1,5 +1,5 @@
 import { isObject, isString, isFiniteNumber, toString } from '../lang';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 import { ERROR_NULL, WARN_CONVERTING, ERROR_EMPTY, ERROR_TOO_LONG, ERROR_INVALID, ERROR_INVALID_KEY_OBJECT } from '../../logger/constants';
 

package/src/utils/inputValidation/preloadedData.ts

@@ -1,6 +1,5 @@
 import { isObject, isString, isFiniteNumber } from '../lang';
 import { validateSplit } from './split';
-import { SplitIO } from '../../types';
 import { ILogger } from '../../logger/types';
 
 function validateTimestampData(log: ILogger, maybeTimestamp: any, method: string, item: string) {
@@ -42,7 +41,7 @@ function validateSegmentsData(log: ILogger, maybeSegmentsData: any, method: stri
   return false;
 }
 
-export function validatePreloadedData(log: ILogger, maybePreloadedData: any, method: string): maybePreloadedData is SplitIO.PreloadedData {
+export function validatePreloadedData(log: ILogger, maybePreloadedData: any, method: string) {
   if (!isObject(maybePreloadedData)) {
     log.error(`${method}: preloadedData must be an object.`);
   } else if (

package/src/utils/inputValidation/trafficTypeExistence.ts

@@ -2,7 +2,7 @@ import { thenable } from '../promise/thenable';
 import { LOCALHOST_MODE } from '../constants';
 import { ISplitsCacheBase } from '../../storages/types';
 import { IReadinessManager } from '../../readiness/types';
-import { SDKMode } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { MaybeThenable } from '../../dtos/types';
 import { ILogger } from '../../logger/types';
 import { WARN_NOT_EXISTENT_TT } from '../../logger/constants';
@@ -14,7 +14,7 @@ function logTTExistenceWarning(log: ILogger, maybeTT: string, method: string) {
 /**
  * Separated from the previous method since on some cases it'll be async.
  */
-export function validateTrafficTypeExistence(log: ILogger, readinessManager: IReadinessManager, splitsCache: ISplitsCacheBase, mode: SDKMode, maybeTT: string, method: string): MaybeThenable<boolean> {
+export function validateTrafficTypeExistence(log: ILogger, readinessManager: IReadinessManager, splitsCache: ISplitsCacheBase, mode: SplitIO.SDKMode, maybeTT: string, method: string): MaybeThenable<boolean> {
 
   // If not ready or in localhost mode, we won't run the validation
   if (!readinessManager.isReady() || mode === LOCALHOST_MODE) return true;

package/src/utils/key/index.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { isObject } from '../lang';
 
 // function isSplitKeyObject(key: any): key is SplitIO.SplitKeyObject {

package/src/utils/lang/binarySearch.ts

@@ -1,8 +1,8 @@
 /**
  * Searches the index of the specified `value` inside an ordered array of `items` using the binary search algorithm.
  *
- * @param items the array to be searched
- * @param value the value to be searched for
+ * @param items - the array to be searched
+ * @param value - the value to be searched for
  * @returns integer number between 0 and `items.length`. This value is the index of the search value,
  * if it is contained in the array, or the index at which the value should be inserted to keep the array ordered.
  */

package/src/utils/murmur3/murmur3_128.ts

@@ -266,7 +266,7 @@ function hash128x64(key?: string, seed?: number) {
 /**
  * x64 version of Murmur3 for 128bits.
  *
- * @param {string} str
+ * @param str - The string to hash.
  */
 export function hash128(str: string, seed?: number): string {
   return hash128x64(UTF16ToUTF8(str), (seed as number) >>> 0);

package/src/utils/murmur3/murmur3_128_x86.ts

@@ -181,7 +181,7 @@ function hash128x86(key?: string, seed?: number): string {
  * x86 version of Murmur3 for 128bits.
  * Used by hashImpression128 because in JS it is more efficient than the x64 version, no matter the underlying OS/CPU arch.
  *
- * @param {string} str
+ * @param str - The string to hash.
  */
 export function hash128(str: string, seed?: number): string {
   return hash128x86(UTF16ToUTF8(str), (seed as number) >>> 0);

package/src/utils/murmur3/murmur3_64.ts

@@ -25,7 +25,7 @@ function hex2dec(s: string): string {
 /**
  * Gets the higher 64 bits of the x64 version of Murmur3 for 128bits, as decimal and hexadecimal number strings.
  * Used for MySegments channel V2 notifications.
- * @param {string} str
+ * @param str - The string to hash
  */
 export function hash64(str: string): Hash64 {
   const hex = hash128(str).slice(0, 16);

package/src/utils/murmur3/utfx.ts

@@ -14,10 +14,9 @@ export interface utfx {
 
 /**
  * Encodes UTF8 code points to UTF8 bytes.
- * @param {(!function():number|null) | number} src Code points source, either as a function returning the next code point
+ * @param src - Code points source, either as a function returning the next code point
  *  respectively `null` if there are no more code points left or a single numeric code point.
- * @param {!function(number)} dst Bytes destination as a function successively called with the next byte
- * @expose
+ * @param dst - Bytes destination as a function successively called with the next byte
  */
 function encodeUTF8(src: (() => number | null) | number, dst: (cp: number) => void): void {
   var cp = null;
@@ -38,11 +37,10 @@ function encodeUTF8(src: (() => number | null) | number, dst: (cp: number) => vo
 
 /**
  * Converts UTF16 characters to UTF8 code points.
- * @param {!function():number|null} src Characters source as a function returning the next char code respectively
+ * @param src - Characters source as a function returning the next char code respectively
  *  `null` if there are no more characters left.
- * @param {!function(number)} dst Code points destination as a function successively called with each converted code
+ * @param dst - Code points destination as a function successively called with each converted code
  *  point.
- * @expose
  */
 function UTF16toUTF8(src: () => number | null, dst: (cp: number) => void): void {
   var c1, c2 = null;
@@ -65,10 +63,9 @@ function UTF16toUTF8(src: () => number | null, dst: (cp: number) => void): void
 
 /**
  * Converts and encodes UTF16 characters to UTF8 bytes.
- * @param {!function():number|null} src Characters source as a function returning the next char code respectively `null`
+ * @param src - Characters source as a function returning the next char code respectively `null`
  *  if there are no more characters left.
- * @param {!function(number)} dst Bytes destination as a function successively called with the next byte.
- * @expose
+ * @param dst - Bytes destination as a function successively called with the next byte.
  */
 export function encodeUTF16toUTF8(src: () => number | null, dst: (...args: number[]) => string | undefined): void {
   UTF16toUTF8(src, function (cp) {
@@ -78,18 +75,15 @@ export function encodeUTF16toUTF8(src: () => number | null, dst: (...args: numbe
 
 /**
  * String.fromCharCode reference for compile time renaming.
- * @type {!function(...[number]):string}
- * @inner
  */
 var stringFromCharCode = String.fromCharCode;
 
 /**
  * Creates a source function for a string.
- * @param {string} s String to read from
- * @returns {!function():number|null} Source function returning the next char code respectively `null` if there are
+ * @param s - String to read from
+ * @returns Source function returning the next char code respectively `null` if there are
  *  no more characters left.
- * @throws {TypeError} If the argument is invalid
- * @expose
+ * @throws If the argument is invalid
  */
 export function stringSource(s: string): () => number | null {
   if (typeof s !== 'string')
@@ -101,9 +95,8 @@ export function stringSource(s: string): () => number | null {
 
 /**
  * Creates a destination function for a string.
- * @returns {function(number=):undefined|string} Destination function successively called with the next char code.
+ * @returns Destination function successively called with the next char code.
  *  Returns the final string when called without arguments.
- * @expose
  */
 export function stringDestination(): (...args: number[]) => string | undefined {
   const cs: number[] = [], ps: string[] = []; return function () {

package/src/utils/promise/wrapper.ts

@@ -11,8 +11,8 @@
  *  - If the wrapped promise is rejected when using native async/await syntax, the `defaultOnRejected` handler is invoked
  * and neither the catch block nor the remaining try block are executed.
  *
- * @param customPromise promise to wrap
- * @param defaultOnRejected default onRejected function
+ * @param customPromise - promise to wrap
+ * @param defaultOnRejected - default onRejected function
  * @returns a promise that doesn't need to be handled for rejection (except when using async/await syntax) and
  * includes a method named `hasOnFulfilled` that returns true if the promise has attached an onFulfilled handler.
  */

package/src/utils/settingsValidation/consent.ts

@@ -1,12 +1,12 @@
 import { ERROR_INVALID_CONFIG_PARAM } from '../../logger/constants';
 import { ILogger } from '../../logger/types';
-import { ConsentStatus } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { CONSENT_DECLINED, CONSENT_GRANTED, CONSENT_UNKNOWN } from '../constants';
 import { stringToUpperCase } from '../lang';
 
 const userConsentValues = [CONSENT_DECLINED, CONSENT_GRANTED, CONSENT_UNKNOWN];
 
-export function validateConsent({ userConsent, log }: { userConsent?: any, log: ILogger }): ConsentStatus {
+export function validateConsent({ userConsent, log }: { userConsent?: any, log: ILogger }): SplitIO.ConsentStatus {
   userConsent = stringToUpperCase(userConsent);
 
   if (userConsentValues.indexOf(userConsent) > -1) return userConsent;

package/src/utils/settingsValidation/impressionsMode.ts

@@ -1,6 +1,6 @@
 import { ERROR_INVALID_CONFIG_PARAM } from '../../logger/constants';
 import { ILogger } from '../../logger/types';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { DEBUG, OPTIMIZED, NONE } from '../constants';
 import { stringToUpperCase } from '../lang';
 

package/src/utils/settingsValidation/index.ts

@@ -96,8 +96,8 @@ function fromSecondsToMillis(n: number) {
  * Validates the given config and use it to build a settings object.
  * NOTE: it doesn't validate the SDK Key. Call `validateApiKey` or `validateAndTrackApiKey` for that after settings validation.
  *
- * @param config user defined configuration
- * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config
+ * @param config - user defined configuration
+ * @param validationParams - defaults and fields validators used to validate and creates a settings object from a given config
  */
 export function settingsValidation(config: unknown, validationParams: ISettingsValidationParams) {
 

package/src/utils/settingsValidation/integrations/common.ts

@@ -4,11 +4,11 @@ import { ILogger } from '../../../logger/types';
 /**
  * This function validates `settings.integrations` object
  *
- * @param {any} settings config object provided by the user to initialize the sdk
- * @param {function} integrationValidator filter used to remove invalid integration items
- * @param {string} extraWarning optional string used to better describe why an item might be invalid
+ * @param settings - config object provided by the user to initialize the sdk
+ * @param integrationValidator - filter used to remove invalid integration items
+ * @param extraWarning - optional string used to better describe why an item might be invalid
  *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
+ * @returns array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
  */
 export function validateIntegrations(settings: { log: ILogger, integrations?: any }, integrationValidator: (integrationItem: any) => boolean, extraWarning?: string) {
   const { integrations, log } = settings;

package/src/utils/settingsValidation/integrations/configurable.ts

@@ -5,10 +5,10 @@ import { ILogger } from '../../../logger/types';
 /**
  * This function validates `settings.integrations` object that consists of a list of configuration items, used by the isomorphic JS SDK.
  *
- * @param {any} settings config object provided by the user to initialize the sdk
- * @param {Array<string>} validIntegrationTypes list of integration types to filter from `settings.integrations`
+ * @param settings - config object provided by the user to initialize the sdk
+ * @param validIntegrationTypes - list of integration types to filter from `settings.integrations`
  *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
+ * @returns array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
  */
 export function validateConfigurableIntegrations(settings: { log: ILogger, integrations?: any }, validIntegrationTypes: string[] = []) {
 

package/src/utils/settingsValidation/integrations/pluggable.ts

@@ -5,9 +5,9 @@ import { ILogger } from '../../../logger/types';
 /**
  * This function validates `settings.integrations` object that consists of a list of pluggable integration factories.
  *
- * @param {any} settings config object provided by the user to initialize the sdk
+ * @param settings - config object provided by the user to initialize the sdk
  *
- * @returns {Array} array of valid integration factories. The array might be empty if `settings` object does not have valid integrations.
+ * @returns array of valid integration factories. The array might be empty if `settings` object does not have valid integrations.
  */
 export function validatePluggableIntegrations(settings: { log: ILogger, integrations?: any }): ISettings['integrations'] {
 

package/src/utils/settingsValidation/logger/builtinLogger.ts

@@ -4,7 +4,7 @@ import { isLocalStorageAvailable } from '../../env/isLocalStorageAvailable';
 import { isNode } from '../../env/isNode';
 import { codesDebug } from '../../../logger/messages/debug';
 import { getLogLevel } from './commons';
-import { LogLevel } from '../../../types';
+import SplitIO from '../../../../types/splitio';
 
 const allCodes = new Map(codesDebug);
 
@@ -37,13 +37,13 @@ if (/^(enabled?|on)/i.test(initialState)) {
 /**
  * Validates the `debug` property at config and use it to set the log level.
  *
- * @param settings user config object, with an optional `debug` property of type boolean or string log level.
+ * @param settings - user config object, with an optional `debug` property of type boolean or string log level.
  * @returns a logger instance with the log level at `settings.debug`. If `settings.debug` is invalid or not provided, `initialLogLevel` is used.
  */
 export function validateLogger(settings: { debug: unknown }): ILogger {
   const { debug } = settings;
 
-  const logLevel: LogLevel | undefined = debug !== undefined ? getLogLevel(debug) : initialLogLevel;
+  const logLevel: SplitIO.LogLevel | undefined = debug !== undefined ? getLogLevel(debug) : initialLogLevel;
 
   const log = new Logger({ logLevel: logLevel || initialLogLevel }, allCodes);
 

package/src/utils/settingsValidation/logger/commons.ts

@@ -1,15 +1,15 @@
 
 import { LogLevels, isLogLevelString } from '../../../logger';
-import { LogLevel } from '../../../types';
+import SplitIO from '../../../../types/splitio';
 
 /**
  * Returns the LogLevel for the given debugValue or undefined if it is invalid,
  * i.e., if the debugValue is not a boolean or LogLevel string.
  *
- * @param debugValue debug value at config
+ * @param debugValue - debug value at config
  * @returns LogLevel of the given debugValue or undefined if the provided value is invalid
  */
-export function getLogLevel(debugValue: unknown): LogLevel | undefined {
+export function getLogLevel(debugValue: unknown): SplitIO.LogLevel | undefined {
   if (typeof debugValue === 'boolean') {
     if (debugValue) {
       return LogLevels.DEBUG;

package/src/utils/settingsValidation/logger/pluggableLogger.ts

@@ -1,6 +1,6 @@
 import { Logger, LogLevels } from '../../../logger';
 import { ILogger } from '../../../logger/types';
-import { LogLevel } from '../../../types';
+import SplitIO from '../../../../types/splitio';
 import { getLogLevel } from './commons';
 
 function isLogger(log: any): log is ILogger {
@@ -13,13 +13,13 @@ let initialLogLevel = LogLevels.NONE;
 /**
  * Validates the `debug` property at config and use it to set the logger.
  *
- * @param settings user config object, with an optional `debug` property of type boolean, string log level or a Logger object.
+ * @param settings - user config object, with an optional `debug` property of type boolean, string log level or a Logger object.
  * @returns a logger instance, that might be: the provided logger at `settings.debug`, or one with the given `debug` log level,
  * or one with NONE log level if `debug` is not defined or invalid.
  */
 export function validateLogger(settings: { debug: unknown }): ILogger {
   const { debug } = settings;
-  let logLevel: LogLevel | undefined = initialLogLevel;
+  let logLevel: SplitIO.LogLevel | undefined = initialLogLevel;
 
   if (debug !== undefined) {
     if (isLogger(debug)) return debug;

package/src/utils/settingsValidation/splitFilters.ts

@@ -1,6 +1,6 @@
 import { validateSplits } from '../inputValidation/splits';
 import { ISplitFiltersValidation } from '../../dtos/types';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 import { WARN_SPLITS_FILTER_IGNORED, WARN_SPLITS_FILTER_EMPTY, WARN_SPLITS_FILTER_INVALID, SETTINGS_SPLITS_FILTER, LOG_PREFIX_SETTINGS, ERROR_SETS_FILTER_EXCLUSIVE, WARN_LOWERCASE_FLAGSET, WARN_INVALID_FLAGSET, WARN_FLAGSET_NOT_CONFIGURED } from '../../logger/constants';
 import { objectAssign } from '../lang/objectAssign';
@@ -40,9 +40,9 @@ function validateFilterType(maybeFilterType: any): maybeFilterType is SplitIO.Sp
 /**
  * Validate, deduplicate and sort a given list of filter values.
  *
- * @param {string} type filter type string used for log messages
- * @param {string[]} values list of values to validate, deduplicate and sort
- * @param {number} maxLength
+ * @param type - filter type string used for log messages
+ * @param values - list of values to validate, deduplicate and sort
+ * @param maxLength - max length allowed for the list of values
  * @returns list of valid, unique and alphabetically sorted non-empty strings. The list is empty if `values` param is not a non-empty array or all its values are invalid.
  *
  * @throws Error if the sanitized list exceeds the length indicated by `maxLength`
@@ -75,7 +75,7 @@ function validateSplitFilter(log: ILogger, type: SplitIO.SplitFilterType, values
  *  - '&prefixes=<comma-separated-values>': if only `byName` filter is undefined
  *  - '&names=<comma-separated-values>&prefixes=<comma-separated-values>': if no one is undefined
  *
- * @param {Object} groupedFilters object of filters. Each filter must be a list of valid, unique and ordered string values.
+ * @param groupedFilters - object of filters. Each filter must be a list of valid, unique and ordered string values.
  * @returns null or string with the `split filter query` component of the URL.
  */
 function queryStringBuilder(groupedFilters: Record<SplitIO.SplitFilterType, string[]>) {
@@ -90,15 +90,12 @@ function queryStringBuilder(groupedFilters: Record<SplitIO.SplitFilterType, stri
 /**
  * Sanitizes set names list taking into account:
  *  - It should be lowercase
- *  - Must adhere the following regular expression /^[a-z0-9][_a-z0-9]{0,49}$/ that means
+ *  - Must adhere the following regular expression `/^[a-z0-9][_a-z0-9]{0,49}$/` that means
  *   - must start with a letter or number
  *   - Be in lowercase
  *   - Be alphanumeric
  *   - have a max length of 50 characters
  *
- * @param {ILogger} log
- * @param {string[]} flagSets
- * @param {string} method
  * @returns sanitized list of set names
  */
 function sanitizeFlagSets(log: ILogger, flagSets: string[], method: string) {
@@ -128,9 +125,9 @@ function configuredFilter(validFilters: SplitIO.SplitFilter[], filterType: Split
 /**
  * Validates `splitFilters` configuration object and parses it into a query string for filtering splits on `/splitChanges` fetch.
  *
- * @param {ILogger} log logger
- * @param {any} maybeSplitFilters split filters configuration param provided by the user
- * @param {string} mode settings mode
+ * @param log - logger
+ * @param maybeSplitFilters - split filters configuration param provided by the user
+ * @param mode - settings mode
  * @returns it returns an object with the following properties:
  *  - `validFilters`: the validated `splitFilters` configuration object defined by the user.
  *  - `queryString`: the parsed split filter query. it is null if all filters are invalid or all values in filters are invalid.

package/src/utils/settingsValidation/storage/storageCS.ts

@@ -1,5 +1,6 @@
 import { InMemoryStorageCSFactory } from '../../../storages/inMemory/InMemoryStorageCS';
-import { ISettings, SDKMode } from '../../../types';
+import { ISettings } from '../../../types';
+import SplitIO from '../../../../types/splitio';
 import { ILogger } from '../../../logger/types';
 import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
 import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
@@ -15,13 +16,13 @@ __InLocalStorageMockFactory.type = STORAGE_MEMORY;
 /**
  * This function validates `settings.storage` object
  *
- * @param {any} settings config object provided by the user to initialize the sdk
+ * @param settings - config object provided by the user to initialize the sdk
  *
- * @returns {Object} valid storage factory. Default to `InMemoryStorageCSFactory` if the provided storage is invalid or not compatible with the sdk mode if mode is standalone or localhost
+ * @returns valid storage factory. Default to `InMemoryStorageCSFactory` if the provided storage is invalid or not compatible with the sdk mode if mode is standalone or localhost
  *
  * @throws error if mode is consumer and the provided storage is not compatible
  */
-export function validateStorageCS(settings: { log: ILogger, storage?: any, mode: SDKMode }): ISettings['storage'] {
+export function validateStorageCS(settings: { log: ILogger, storage?: any, mode: SplitIO.SDKMode }): ISettings['storage'] {
   let { storage = InMemoryStorageCSFactory, log, mode } = settings;
 
   // If an invalid storage is provided, fallback into MEMORY

package/src/utils/settingsValidation/url.ts

@@ -9,9 +9,9 @@ const streamingEndpointMatcher = /^\/(sse|event-stream)/;
  * Get URL based on a given target (path).
  * ATM, it is only used for testing purposes.
  *
- * @param settings settings object
- * @param target url path
- * @return complete url
+ * @param settings - settings object
+ * @param target - url path
+ * @returns complete url
  */
 export function url(settings: ISettings, target: string) {
   if (telemetryEndpointMatcher.test(target)) {

package/types/index.d.ts

@@ -1,5 +1,5 @@
-export { InMemoryStorageFactory } from './storages/inMemory/InMemoryStorage';
-export { InMemoryStorageCSFactory } from './storages/inMemory/InMemoryStorageCS';
-export { InLocalStorage } from './storages/inLocalStorage';
-export { PluggableStorage } from './storages/pluggable';
-export { InRedisStorage } from './storages/inRedis';
+// Declaration file for JavaScript Browser Split Software SDK
+// Project: http://www.split.io/
+// Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
+
+/// <reference path="./splitio.d.ts" />