@splitsoftware/splitio-commons 2.0.0-rc.4 → 2.0.0-rc.6

package/esm/utils/murmur3/utfx.js

@@ -8,10 +8,9 @@
 */
 /**
  * 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, dst) {
     var cp = null;
@@ -31,11 +30,10 @@ function encodeUTF8(src, dst) {
 }
 /**
  * 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, dst) {
     var c1, c2 = null;
@@ -59,10 +57,9 @@ function UTF16toUTF8(src, dst) {
 }
 /**
  * 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, dst) {
     UTF16toUTF8(src, function (cp) {
@@ -71,17 +68,14 @@ export function encodeUTF16toUTF8(src, dst) {
 }
 /**
  * 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) {
     if (typeof s !== 'string')
@@ -93,9 +87,8 @@ export function stringSource(s) {
 }
 /**
  * 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() {
     var cs = [], ps = [];

package/esm/utils/promise/wrapper.js

@@ -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/esm/utils/settingsValidation/index.js

@@ -80,8 +80,8 @@ function fromSecondsToMillis(n) {
  * 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, validationParams) {
     var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, consent = validationParams.consent, flagSpec = validationParams.flagSpec;

package/esm/utils/settingsValidation/integrations/common.js

@@ -2,11 +2,11 @@ import { WARN_INTEGRATION_INVALID } from '../../../logger/constants';
 /**
  * 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, integrationValidator, extraWarning) {
     var integrations = settings.integrations, log = settings.log;

package/esm/utils/settingsValidation/integrations/configurable.js

@@ -3,10 +3,10 @@ import { isString } from '../../lang';
 /**
  * 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, validIntegrationTypes) {
     if (validIntegrationTypes === void 0) { validIntegrationTypes = []; }

package/esm/utils/settingsValidation/integrations/pluggable.js

@@ -2,9 +2,9 @@ import { validateIntegrations } from './common';
 /**
  * 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) {
     return validateIntegrations(settings, function (integration) { return typeof integration === 'function'; }, 'Integration items must be functions that initialize the integrations');

package/esm/utils/settingsValidation/logger/builtinLogger.js

@@ -28,7 +28,7 @@ else if (isLogLevelString(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) {

package/esm/utils/settingsValidation/logger/commons.js

@@ -3,7 +3,7 @@ import { LogLevels, isLogLevelString } from '../../../logger';
  * 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) {

package/esm/utils/settingsValidation/logger/pluggableLogger.js

@@ -8,7 +8,7 @@ var 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.
  */

package/esm/utils/settingsValidation/splitFilters.js

@@ -33,9 +33,9 @@ function validateFilterType(maybeFilterType) {
 /**
  * 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`
@@ -64,7 +64,7 @@ function validateSplitFilter(log, type, values, maxLength) {
  *  - '&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) {
@@ -80,15 +80,12 @@ function queryStringBuilder(groupedFilters) {
 /**
  * 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, flagSets, method) {
@@ -117,9 +114,9 @@ function configuredFilter(validFilters, filterType) {
 /**
  * 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/esm/utils/settingsValidation/storage/storageCS.js

@@ -10,9 +10,9 @@ __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
  */

package/esm/utils/settingsValidation/url.js

@@ -6,9 +6,9 @@ var 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, target) {
     if (telemetryEndpointMatcher.test(target)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.0.0-rc.4",
+  "version": "2.0.0-rc.6",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "check": "npm run check:lint && npm run check:types",
-    "check:lint": "eslint src --ext .js,.ts",
+    "check:lint": "eslint src types --ext .js,.ts",
     "check:types": "tsc --noEmit",
     "build": "npm run build:cjs && npm run build:esm",
     "build:esm": "rimraf esm && tsc -m es2015 --outDir esm",
@@ -67,6 +67,7 @@
     "eslint": "^8.48.0",
     "eslint-plugin-compat": "^6.0.1",
     "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-tsdoc": "^0.3.0",
     "fetch-mock": "^9.11.0",
     "ioredis": "^4.28.0",
     "jest": "^27.2.3",

package/src/dtos/types.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 
 export type MaybeThenable<T> = T | Promise<T>
 

package/src/evaluator/Engine.ts

@@ -5,7 +5,7 @@ import { thenable } from '../utils/promise/thenable';
 import { EXCEPTION, NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED } from '../utils/labels';
 import { CONTROL } from '../utils/constants';
 import { ISplit, MaybeThenable } from '../dtos/types';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { IStorageAsync, IStorageSync } from '../storages/types';
 import { IEvaluation, IEvaluationResult, IEvaluator, ISplitEvaluator } from './types';
 import { ILogger } from '../logger/types';

package/src/evaluator/combiners/ifelseif.ts

@@ -3,7 +3,7 @@ import { ILogger } from '../../logger/types';
 import { thenable } from '../../utils/promise/thenable';
 import { UNSUPPORTED_MATCHER_TYPE } from '../../utils/labels';
 import { CONTROL } from '../../utils/constants';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { IEvaluation, IEvaluator, ISplitEvaluator } from '../types';
 import { ENGINE_COMBINER_IFELSEIF, ENGINE_COMBINER_IFELSEIF_NO_TREATMENT, ERROR_ENGINE_COMBINER_IFELSEIF } from '../../logger/constants';
 

package/src/evaluator/condition/index.ts

@@ -3,7 +3,7 @@ import { thenable } from '../../utils/promise/thenable';
 import { NOT_IN_SPLIT } from '../../utils/labels';
 import { MaybeThenable } from '../../dtos/types';
 import { IEvaluation, IEvaluator, ISplitEvaluator } from '../types';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 
 // Build Evaluation object if and only if matchingResult is true

package/src/evaluator/index.ts

@@ -5,7 +5,7 @@ import { CONTROL } from '../utils/constants';
 import { ISplit, MaybeThenable } from '../dtos/types';
 import { IStorageAsync, IStorageSync } from '../storages/types';
 import { IEvaluationResult } from './types';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { ILogger } from '../logger/types';
 import { returnSetsUnion, setToArray } from '../utils/lang/sets';
 import { WARN_FLAGSET_WITHOUT_FLAGS } from '../logger/constants';

package/src/evaluator/parser/index.ts

@@ -9,7 +9,7 @@ import { thenable } from '../../utils/promise/thenable';
 import { IEvaluator, IMatcherDto, ISplitEvaluator } from '../types';
 import { ISplitCondition, MaybeThenable } from '../../dtos/types';
 import { IStorageAsync, IStorageSync } from '../../storages/types';
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 import { ENGINE_MATCHER_ERROR, ENGINE_MATCHER_RESULT } from '../../logger/constants';
 

package/src/evaluator/types.ts

@@ -1,6 +1,6 @@
 import { IBetweenMatcherData, IBetweenStringMatcherData, IDependencyMatcherData, MaybeThenable } from '../dtos/types';
 import { IStorageAsync, IStorageSync } from '../storages/types';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { ILogger } from '../logger/types';
 
 export interface IDependencyMatcherValue {

package/src/evaluator/value/index.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { IMatcherDto } from '../types';
 import { ILogger } from '../../logger/types';
 import { sanitize } from './sanitize';

package/src/evaluator/value/sanitize.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { IDependencyMatcherValue } from '../types';
 import { ILogger } from '../../logger/types';
 import { isObject, uniq, toString, toNumber } from '../../utils/lang';

package/src/integrations/pluggable.ts

@@ -1,13 +1,13 @@
 import { SPLIT_IMPRESSION, SPLIT_EVENT } from '../utils/constants';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { IIntegration, IIntegrationManager, IIntegrationFactoryParams } from './types';
 
 /**
  * Factory function for IntegrationsManager with pluggable integrations.
  * The integrations manager instantiates integration, and bypass tracked events and impressions to them.
  *
- * @param integrations validated list of integration factories
- * @param params information of the Sdk factory instance that integrations can access to
+ * @param integrations - validated list of integration factories
+ * @param params - information of the Sdk factory instance that integrations can access to
  *
  * @returns integration manager or undefined if `integrations` are not present in settings.
  */

package/src/integrations/types.ts

@@ -1,6 +1,7 @@
 import { IEventsCacheBase } from '../storages/types';
 import { IEventsHandler, IImpressionsHandler, ITelemetryTracker } from '../trackers/types';
-import { ISettings, SplitIO } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 
 export interface IIntegration {
   queue(data: SplitIO.IntegrationData): void
@@ -14,7 +15,7 @@ export interface IIntegrationFactoryParams {
   telemetryTracker: ITelemetryTracker
 }
 
-export type IntegrationFactory = {
+export type IntegrationFactory = SplitIO.IntegrationFactory & {
   readonly type: string
   (params: IIntegrationFactoryParams): IIntegration | void
 }

package/src/listeners/browser.ts

@@ -5,7 +5,8 @@ import { IRecorderCacheSync, IStorageSync } from '../storages/types';
 import { fromImpressionsCollector } from '../sync/submitters/impressionsSubmitter';
 import { fromImpressionCountsCollector } from '../sync/submitters/impressionCountsSubmitter';
 import { IResponse, ISplitApi } from '../services/types';
-import { ImpressionDTO, ISettings } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 import { ImpressionsPayload } from '../sync/submitters/types';
 import { OPTIMIZED, DEBUG, NONE } from '../utils/constants';
 import { objectAssign } from '../utils/lang/objectAssign';
@@ -22,7 +23,7 @@ const EVENT_NAME = 'for visibilitychange and pagehide events.';
  */
 export class BrowserSignalListener implements ISignalListener {
 
-  private fromImpressionsCollector: (data: ImpressionDTO[]) => ImpressionsPayload;
+  private fromImpressionsCollector: (data: SplitIO.ImpressionDTO[]) => ImpressionsPayload;
 
   constructor(
     private syncManager: ISyncManager | undefined,

package/src/logger/index.ts

@@ -1,9 +1,9 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { ILoggerOptions, ILogger } from './types';
 import { find, isObject } from '../utils/lang';
-import { LogLevel } from '../types';
+import SplitIO from '../../types/splitio';
 
-export const LogLevels: { [level: string]: LogLevel } = {
+export const LogLevels: SplitIO.ILoggerAPI['LogLevel'] = {
   DEBUG: 'DEBUG',
   INFO: 'INFO',
   WARN: 'WARN',
@@ -19,7 +19,7 @@ const LogLevelIndexes = {
   NONE: 5
 };
 
-export function isLogLevelString(str: string): str is LogLevel {
+export function isLogLevelString(str: string): str is SplitIO.LogLevel {
   return !!find(LogLevels, (lvl: string) => str === lvl);
 }
 
@@ -55,7 +55,7 @@ export class Logger implements ILogger {
     this.logLevel = LogLevelIndexes[this.options.logLevel];
   }
 
-  setLogLevel(logLevel: LogLevel) {
+  setLogLevel(logLevel: SplitIO.LogLevel) {
     this.options.logLevel = logLevel;
     this.logLevel = LogLevelIndexes[logLevel];
   }
@@ -76,7 +76,7 @@ export class Logger implements ILogger {
     if (this._shouldLog(LogLevelIndexes.ERROR)) this._log(LogLevels.ERROR, msg, args);
   }
 
-  private _log(level: LogLevel, msg: string | number, args?: any[]) {
+  private _log(level: SplitIO.LogLevel, msg: string | number, args?: any[]) {
     if (typeof msg === 'number') {
       const format = this.codes.get(msg);
       msg = format ? _sprintf(format, args) : `Message code ${msg}${args ? ', with args: ' + args.toString() : ''}`;
@@ -89,7 +89,7 @@ export class Logger implements ILogger {
     console.log(formattedText);
   }
 
-  private _generateLogMessage(level: LogLevel, text: string) {
+  private _generateLogMessage(level: SplitIO.LogLevel, text: string) {
     const textPre = ' => ';
     let result = '';
 

package/src/logger/sdkLogger.ts

@@ -1,14 +1,14 @@
 import { LogLevels, isLogLevelString } from './index';
-import { ILoggerAPI } from '../types';
+import SplitIO from '../../types/splitio';
 import { ILogger } from './types';
 import { ERROR_LOGLEVEL_INVALID } from './constants';
 
 /**
  * The public Logger utility API exposed via SplitFactory, used to update the log level.
  *
- * @param log the factory logger instance to handle
+ * @param log - the factory logger instance to handle
  */
-export function createLoggerAPI(log: ILogger): ILoggerAPI {
+export function createLoggerAPI(log: ILogger): SplitIO.ILoggerAPI {
 
   function setLogLevel(logLevel: string) {
     if (isLogLevelString(logLevel)) {
@@ -27,7 +27,7 @@ export function createLoggerAPI(log: ILogger): ILoggerAPI {
     },
     /**
      * Sets a custom log Level for the SDK.
-     * @param {string} logLevel - Custom LogLevel value.
+     * @param logLevel - Custom LogLevel value.
      */
     setLogLevel,
     /**

package/src/logger/types.ts

@@ -1,23 +1,21 @@
-import { LogLevel } from '../types';
+import SplitIO from '../../types/splitio';
 
 export interface ILoggerOptions {
   prefix?: string,
-  logLevel?: LogLevel,
+  logLevel?: SplitIO.LogLevel,
   showLevel?: boolean, // @TODO remove this param eventually since it is not being set `false` anymore
 }
 
-export interface ILogger {
-  setLogLevel(logLevel: LogLevel): void
+export interface ILogger extends SplitIO.ILogger {
+  debug(msg: any): void;
+  debug(msg: string | number, args?: any[]): void;
 
-  debug(msg: any): void
-  debug(msg: string | number, args?: any[]): void
+  info(msg: any): void;
+  info(msg: string | number, args?: any[]): void;
 
-  info(msg: any): void
-  info(msg: string | number, args?: any[]): void
+  warn(msg: any): void;
+  warn(msg: string | number, args?: any[]): void;
 
-  warn(msg: any): void
-  warn(msg: string | number, args?: any[]): void
-
-  error(msg: any): void
-  error(msg: string | number, args?: any[]): void
+  error(msg: any): void;
+  error(msg: string | number, args?: any[]): void;
 }

package/src/readiness/readinessManager.ts

@@ -1,9 +1,10 @@
 import { objectAssign } from '../utils/lang/objectAssign';
-import { IEventEmitter, ISettings } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
 import { IReadinessEventEmitter, IReadinessManager, ISegmentsEventEmitter, ISplitsEventEmitter } from './types';
 
-function splitsEventEmitterFactory(EventEmitter: new () => IEventEmitter): ISplitsEventEmitter {
+function splitsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter): ISplitsEventEmitter {
   const splitsEventEmitter = objectAssign(new EventEmitter(), {
     splitsArrived: false,
     splitsCacheLoaded: false,
@@ -20,7 +21,7 @@ function splitsEventEmitterFactory(EventEmitter: new () => IEventEmitter): ISpli
   return splitsEventEmitter;
 }
 
-function segmentsEventEmitterFactory(EventEmitter: new () => IEventEmitter): ISegmentsEventEmitter {
+function segmentsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter): ISegmentsEventEmitter {
   const segmentsEventEmitter = objectAssign(new EventEmitter(), {
     segmentsArrived: false
   });
@@ -34,7 +35,7 @@ function segmentsEventEmitterFactory(EventEmitter: new () => IEventEmitter): ISe
  * Factory of readiness manager, which handles the ready / update event propagation.
  */
 export function readinessManagerFactory(
-  EventEmitter: new () => IEventEmitter,
+  EventEmitter: new () => SplitIO.IEventEmitter,
   settings: ISettings,
   splits: ISplitsEventEmitter = splitsEventEmitterFactory(EventEmitter)): IReadinessManager {
 

package/src/readiness/sdkReadinessManager.ts

@@ -2,7 +2,8 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { promiseWrapper } from '../utils/promise/wrapper';
 import { readinessManagerFactory } from './readinessManager';
 import { ISdkReadinessManager } from './types';
-import { IEventEmitter, ISettings } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 import { SDK_READY, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE } from './constants';
 import { ERROR_CLIENT_LISTENER, CLIENT_READY_FROM_CACHE, CLIENT_READY, CLIENT_NO_LISTENER } from '../logger/constants';
 
@@ -13,11 +14,11 @@ const REMOVE_LISTENER_EVENT = 'removeListener';
  * SdkReadinessManager factory, which provides the public status API of SDK clients and manager: ready promise, readiness event emitter and constants (SDK_READY, etc).
  * It also updates logs related warnings and errors.
  *
- * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param readinessManager optional readinessManager to use. only used internally for `shared` method
+ * @param readyTimeout - time in millis to emit SDK_READY_TIME_OUT event
+ * @param readinessManager - optional readinessManager to use. only used internally for `shared` method
  */
 export function sdkReadinessManagerFactory(
-  EventEmitter: new () => IEventEmitter,
+  EventEmitter: new () => SplitIO.IEventEmitter,
   settings: ISettings,
   readinessManager = readinessManagerFactory(EventEmitter, settings)): ISdkReadinessManager {
 
@@ -91,25 +92,7 @@ export function sdkReadinessManagerFactory(
           SDK_UPDATE,
           SDK_READY_TIMED_OUT,
         },
-        /**
-         * Returns a promise that will be resolved once the SDK has finished loading (SDK_READY event emitted) or rejected if the SDK has timedout (SDK_READY_TIMED_OUT event emitted).
-         * As it's meant to provide similar flexibility to the event approach, given that the SDK might be eventually ready after a timeout event, calling the `ready` method after the
-         * SDK had timed out will return a new promise that should eventually resolve if the SDK gets ready.
-         *
-         * Caveats: the method was designed to avoid an unhandled Promise rejection if the rejection case is not handled, so that `onRejected` handler is optional when using promises.
-         * However, when using async/await syntax, the rejection should be explicitly propagated like in the following example:
-         * ```
-         * try {
-         *   await client.ready().catch((e) => { throw e; });
-         *   // SDK is ready
-         * } catch(e) {
-         *   // SDK has timedout
-         * }
-         * ```
-         *
-         * @function ready
-         * @returns {Promise<void>}
-         */
+
         ready() {
           if (readinessManager.hasTimedout()) {
             if (!readinessManager.isReady()) {