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

package/src/readiness/types.ts

@@ -1,4 +1,5 @@
-import { IEventEmitter, IStatusInterface } from '../types';
+import { IStatusInterface } from '../types';
+import SplitIO from '../../types/splitio';
 
 /** Splits data emitter */
 
@@ -6,7 +7,7 @@ type SDK_SPLITS_ARRIVED = 'state::splits-arrived'
 type SDK_SPLITS_CACHE_LOADED = 'state::splits-cache-loaded'
 type ISplitsEvent = SDK_SPLITS_ARRIVED | SDK_SPLITS_CACHE_LOADED
 
-export interface ISplitsEventEmitter extends IEventEmitter {
+export interface ISplitsEventEmitter extends SplitIO.IEventEmitter {
   emit(event: ISplitsEvent, ...args: any[]): boolean
   on(event: ISplitsEvent, listener: (...args: any[]) => void): this;
   once(event: ISplitsEvent, listener: (...args: any[]) => void): this;
@@ -21,7 +22,7 @@ export interface ISplitsEventEmitter extends IEventEmitter {
 type SDK_SEGMENTS_ARRIVED = 'state::segments-arrived'
 type ISegmentsEvent = SDK_SEGMENTS_ARRIVED
 
-export interface ISegmentsEventEmitter extends IEventEmitter {
+export interface ISegmentsEventEmitter extends SplitIO.IEventEmitter {
   emit(event: ISegmentsEvent, ...args: any[]): boolean
   on(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
   once(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
@@ -37,7 +38,7 @@ export type SDK_UPDATE = 'state::update'
 export type SDK_DESTROY = 'state::destroy'
 export type IReadinessEvent = SDK_READY_TIMED_OUT | SDK_READY | SDK_READY_FROM_CACHE | SDK_UPDATE | SDK_DESTROY
 
-export interface IReadinessEventEmitter extends IEventEmitter {
+export interface IReadinessEventEmitter extends SplitIO.IEventEmitter {
   emit(event: IReadinessEvent, ...args: any[]): boolean
 }
 

package/src/sdkClient/client.ts

@@ -6,7 +6,7 @@ import { validateTrafficTypeExistence } from '../utils/inputValidation/trafficTy
 import { SDK_NOT_READY } from '../utils/labels';
 import { CONTROL, TREATMENT, TREATMENTS, TREATMENT_WITH_CONFIG, TREATMENTS_WITH_CONFIG, TRACK, TREATMENTS_WITH_CONFIG_BY_FLAGSETS, TREATMENTS_BY_FLAGSETS, TREATMENTS_BY_FLAGSET, TREATMENTS_WITH_CONFIG_BY_FLAGSET, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENT_WITH_CONFIG, GET_TREATMENT, GET_TREATMENTS, TRACK_FN_LABEL } from '../utils/constants';
 import { IEvaluationResult } from '../evaluator/types';
-import { SplitIO, ImpressionDTO } from '../types';
+import SplitIO from '../../types/splitio';
 import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants';
 import { ISdkFactoryContext } from '../sdkFactory/types';
 import { isConsumerMode } from '../utils/settingsValidation/mode';
@@ -25,7 +25,7 @@ function treatmentsNotReady(featureFlagNames: string[]) {
 /**
  * Creator of base client with getTreatments and track methods.
  */
-export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | SplitIO.IAsyncClient {
+export function clientFactory(params: ISdkFactoryContext): SplitIO.INodeClient | SplitIO.INodeAsyncClient {
   const { sdkReadinessManager: { readinessManager }, storage, settings, impressionsTracker, eventTracker, telemetryTracker } = params;
   const { log, mode } = settings;
   const isAsync = isConsumerMode(mode);
@@ -34,7 +34,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     const stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENT_WITH_CONFIG : TREATMENT);
 
     const wrapUp = (evaluationResult: IEvaluationResult) => {
-      const queue: ImpressionDTO[] = [];
+      const queue: SplitIO.ImpressionDTO[] = [];
       const treatment = processEvaluation(evaluationResult, featureFlagName, key, attributes, withConfig, methodName, queue);
       impressionsTracker.track(queue, attributes);
 
@@ -59,7 +59,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     const stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? TREATMENTS_WITH_CONFIG : TREATMENTS);
 
     const wrapUp = (evaluationResults: Record<string, IEvaluationResult>) => {
-      const queue: ImpressionDTO[] = [];
+      const queue: SplitIO.ImpressionDTO[] = [];
       const treatments: Record<string, SplitIO.Treatment | SplitIO.TreatmentWithConfig> = {};
       Object.keys(evaluationResults).forEach(featureFlagName => {
         treatments[featureFlagName] = processEvaluation(evaluationResults[featureFlagName], featureFlagName, key, attributes, withConfig, methodName, queue);
@@ -87,7 +87,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     const stopTelemetryTracker = telemetryTracker.trackEval(method);
 
     const wrapUp = (evaluationResults: Record<string, IEvaluationResult>) => {
-      const queue: ImpressionDTO[] = [];
+      const queue: SplitIO.ImpressionDTO[] = [];
       const treatments: Record<string, SplitIO.Treatment | SplitIO.TreatmentWithConfig> = {};
       const evaluations = evaluationResults;
       Object.keys(evaluations).forEach(featureFlagName => {
@@ -128,7 +128,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     attributes: SplitIO.Attributes | undefined,
     withConfig: boolean,
     invokingMethodName: string,
-    queue: ImpressionDTO[]
+    queue: SplitIO.ImpressionDTO[]
   ): SplitIO.Treatment | SplitIO.TreatmentWithConfig {
     const matchingKey = getMatching(key);
     const bucketingKey = getBucketing(key);
@@ -199,6 +199,5 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     getTreatmentsByFlagSet,
     getTreatmentsWithConfigByFlagSet,
     track,
-    isClientSide: false
-  } as SplitIO.IClient | SplitIO.IAsyncClient;
+  } as SplitIO.INodeClient | SplitIO.INodeAsyncClient;
 }

package/src/sdkClient/clientAttributesDecoration.ts

@@ -1,13 +1,13 @@
 import { AttributesCacheInMemory } from '../storages/inMemory/AttributesCacheInMemory';
 import { validateAttributesDeep } from '../utils/inputValidation/attributes';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { ILogger } from '../logger/types';
 import { objectAssign } from '../utils/lang/objectAssign';
 
 /**
  * Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call
  */
-export function clientAttributesDecoration<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(log: ILogger, client: TClient) {
+export function clientAttributesDecoration<TClient extends SplitIO.INodeClient | SplitIO.INodeAsyncClient>(log: ILogger, client: TClient) {
 
   const attributeStorage = new AttributesCacheInMemory();
 
@@ -80,9 +80,9 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     /**
      * Add an attribute to client's in memory attributes storage
      *
-     * @param {string} attributeName Attrinute name
-     * @param {string, number, boolean, list} attributeValue Attribute value
-     * @returns {boolean} true if the attribute was stored and false otherways
+     * @param attributeName - Attribute name
+     * @param attributeValue - Attribute value
+     * @returns true if the attribute was stored and false otherways
      */
     setAttribute(attributeName: string, attributeValue: SplitIO.AttributeType) {
       const attribute: Record<string, Object> = {};
@@ -95,8 +95,8 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     /**
      * Returns the attribute with the given name
      *
-     * @param {string} attributeName Attribute name
-     * @returns {Object} Attribute with the given name
+     * @param attributeName - Attribute name
+     * @returns Attribute with the given name
      */
     getAttribute(attributeName: string) {
       log.debug(`retrieved attribute ${attributeName}`);
@@ -106,7 +106,7 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     /**
      * Add to client's in memory attributes storage the attributes in 'attributes'
      *
-     * @param {Object} attributes Object with attributes to store
+     * @param attributes - Object with attributes to store
      * @returns true if attributes were stored an false otherways
      */
     setAttributes(attributes: Record<string, Object>) {
@@ -117,7 +117,7 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     /**
      * Return all the attributes stored in client's in memory attributes storage
      *
-     * @returns {Object} returns all the stored attributes
+     * @returns returns all the stored attributes
      */
     getAttributes() {
       return attributeStorage.getAll();
@@ -126,8 +126,8 @@ export function clientAttributesDecoration<TClient extends SplitIO.IClient | Spl
     /**
      * Removes from client's in memory attributes storage the attribute with the given name
      *
-     * @param {string} attributeName
-     * @returns {boolean} true if attribute was removed and false otherways
+     * @param attributeName - Attribute name
+     * @returns true if attribute was removed and false otherways
      */
     removeAttribute(attributeName: string) {
       log.debug(`removed attribute ${attributeName}`);

package/src/sdkClient/clientCS.ts

@@ -1,16 +1,16 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { ILogger } from '../logger/types';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { clientAttributesDecoration } from './clientAttributesDecoration';
 
 
 /**
  * Decorator that binds a key to client methods
  *
- * @param client sync client instance
- * @param key validated split key
+ * @param client - sync client instance
+ * @param key - validated split key
  */
-export function clientCSDecorator(log: ILogger, client: SplitIO.IClient, key: SplitIO.SplitKey): SplitIO.ICsClient {
+export function clientCSDecorator(log: ILogger, client: SplitIO.INodeClient, key: SplitIO.SplitKey): SplitIO.IClient {
 
   let clientCS = clientAttributesDecoration(log, client);
 
@@ -30,5 +30,5 @@ export function clientCSDecorator(log: ILogger, client: SplitIO.IClient, key: Sp
     // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)
     isClientSide: true,
     key
-  }) as SplitIO.ICsClient;
+  }) as SplitIO.IClient;
 }

package/src/sdkClient/clientInputValidation.ts

@@ -15,7 +15,8 @@ import { startsWith } from '../utils/lang';
 import { CONTROL, CONTROL_WITH_CONFIG, GET_TREATMENT, GET_TREATMENTS, GET_TREATMENTS_BY_FLAG_SET, GET_TREATMENTS_BY_FLAG_SETS, GET_TREATMENTS_WITH_CONFIG, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET, GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, GET_TREATMENT_WITH_CONFIG, TRACK_FN_LABEL } from '../utils/constants';
 import { IReadinessManager } from '../readiness/types';
 import { MaybeThenable } from '../dtos/types';
-import { ISettings, SplitIO } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 import { isConsumerMode } from '../utils/settingsValidation/mode';
 import { validateFlagSets } from '../utils/settingsValidation/splitFilters';
 
@@ -23,7 +24,7 @@ import { validateFlagSets } from '../utils/settingsValidation/splitFilters';
  * Decorator that validates the input before actually executing the client methods.
  * We should "guard" the client here, while not polluting the "real" implementation of those methods.
  */
-export function clientInputValidationDecorator<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(settings: ISettings, client: TClient, readinessManager: IReadinessManager): TClient {
+export function clientInputValidationDecorator<TClient extends SplitIO.INodeClient | SplitIO.INodeAsyncClient>(settings: ISettings, client: TClient, readinessManager: IReadinessManager): TClient {
 
   const { log, mode } = settings;
   const isAsync = isConsumerMode(mode);

package/src/sdkClient/identity.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 
 export function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string) { // @ts-ignore
   return `${key.matchingKey ? key.matchingKey : key}-${key.bucketingKey ? key.bucketingKey : key}-${trafficType ? trafficType : ''}`;

package/src/sdkClient/sdkClient.ts

@@ -1,5 +1,5 @@
 import { objectAssign } from '../utils/lang/objectAssign';
-import { IStatusInterface, SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { releaseApiKey } from '../utils/inputValidation/apiKey';
 import { clientFactory } from './client';
 import { clientInputValidationDecorator } from './clientInputValidation';
@@ -10,7 +10,7 @@ const COOLDOWN_TIME_IN_MILLIS = 1000;
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient {
+export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.INodeClient | SplitIO.INodeAsyncClient {
   const { sdkReadinessManager, syncManager, storage, signalListener, settings, telemetryTracker, uniqueKeysTracker } = params;
 
   let lastActionTime = 0;
@@ -37,7 +37,7 @@ export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: bo
 
   return objectAssign(
     // Proto-linkage of the readiness Event Emitter
-    Object.create(sdkReadinessManager.sdkStatus) as IStatusInterface,
+    Object.create(sdkReadinessManager.sdkStatus) as SplitIO.IStatusInterface,
 
     // Client API (getTreatment* & track methods)
     clientInputValidationDecorator(

package/src/sdkClient/sdkClientMethod.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { sdkClientFactory } from './sdkClient';
 import { RETRIEVE_CLIENT_DEFAULT } from '../logger/constants';
 import { ISdkFactoryContext } from '../sdkFactory/types';
@@ -6,7 +6,7 @@ import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Factory of client method for server-side SDKs
  */
-export function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.IClient | SplitIO.IAsyncClient {
+export function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.INodeClient | SplitIO.INodeAsyncClient {
   const log = params.settings.log;
   const clientInstance = sdkClientFactory(params);
 

package/src/sdkClient/sdkClientMethodCS.ts

@@ -1,5 +1,5 @@
 import { clientCSDecorator } from './clientCS';
-import { SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { validateKey } from '../utils/inputValidation/key';
 import { getMatching, keyParser } from '../utils/key';
 import { sdkClientFactory } from './sdkClient';
@@ -14,12 +14,12 @@ import { buildInstanceId } from './identity';
  * Factory of client method for the client-side API variant where TT is ignored.
  * Therefore, clients don't have a bound TT for the track method.
  */
-export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.ICsClient {
+export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.IClient {
   const { clients, storage, syncManager, sdkReadinessManager, settings: { core: { key }, log } } = params;
 
   const mainClientInstance = clientCSDecorator(
     log,
-    sdkClientFactory(params) as SplitIO.IClient,
+    sdkClientFactory(params) as SplitIO.INodeClient,
     key
   );
 
@@ -71,7 +71,7 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
           sdkReadinessManager: sharedSdkReadiness,
           storage: sharedStorage || storage,
           syncManager: sharedSyncManager,
-        }), true) as SplitIO.IClient,
+        }), true) as SplitIO.INodeClient,
         validKey
       );
 
@@ -80,6 +80,6 @@ export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: Spl
       log.debug(RETRIEVE_CLIENT_EXISTING);
     }
 
-    return clients[instanceId] as SplitIO.ICsClient;
+    return clients[instanceId] as SplitIO.IClient;
   };
 }

package/src/sdkFactory/index.ts

@@ -3,7 +3,7 @@ import { sdkReadinessManagerFactory } from '../readiness/sdkReadinessManager';
 import { impressionsTrackerFactory } from '../trackers/impressionsTracker';
 import { eventTrackerFactory } from '../trackers/eventTracker';
 import { telemetryTrackerFactory } from '../trackers/telemetryTracker';
-import { IBasicClient, SplitIO } from '../types';
+import SplitIO from '../../types/splitio';
 import { validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
 import { createLoggerAPI } from '../logger/sdkLogger';
 import { NEW_FACTORY, RETRIEVE_MANAGER } from '../logger/constants';
@@ -18,7 +18,7 @@ import { NONE, OPTIMIZED } from '../utils/constants';
 /**
  * Modular SDK factory
  */
-export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.ISDK | SplitIO.IAsyncSDK {
+export function sdkFactory(params: ISdkFactoryParams): SplitIO.INodeSDK | SplitIO.INodeAsyncSDK | SplitIO.ISDK | SplitIO.IAsyncSDK {
 
   const { settings, platform, storageFactory, splitApiFactory, extraProps,
     syncManagerFactory, SignalListener, impressionsObserverFactory,
@@ -54,7 +54,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
     },
   });
   // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
-  const clients: Record<string, IBasicClient> = {};
+  const clients: Record<string, SplitIO.IBasicClient> = {};
   const telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);
   const integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings, storage, telemetryTracker });
 

package/src/sdkFactory/types.ts

@@ -8,7 +8,8 @@ import { IStorageAsync, IStorageSync, IStorageFactoryParams } from '../storages/
 import { ISyncManager } from '../sync/types';
 import { IImpressionObserver } from '../trackers/impressionObserver/types';
 import { IImpressionsTracker, IEventTracker, ITelemetryTracker, IFilterAdapter, IUniqueKeysTracker } from '../trackers/types';
-import { SplitIO, ISettings, IEventEmitter, IBasicClient } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 
 /**
  * Environment related dependencies.
@@ -29,7 +30,7 @@ export interface IPlatform {
   /**
    * EventEmitter constructor, like NodeJS.EventEmitter or a polyfill.
    */
-  EventEmitter: new () => IEventEmitter,
+  EventEmitter: new () => SplitIO.IEventEmitter,
   /**
    * Function used to track latencies for telemetry.
    */
@@ -49,7 +50,7 @@ export interface ISdkFactoryContext {
   signalListener?: ISignalListener
   splitApi?: ISplitApi
   syncManager?: ISyncManager,
-  clients: Record<string, IBasicClient>,
+  clients: Record<string, SplitIO.IBasicClient>,
 }
 
 export interface ISdkFactoryContextSync extends ISdkFactoryContext {
@@ -78,7 +79,7 @@ export interface ISdkFactoryParams {
   platform: IPlatform,
 
   // Storage factory. The result storage type implies the type of the SDK:
-  // sync SDK (`ISDK` or `ICsSDK`) with `IStorageSync`, and async SDK (`IAsyncSDK`) with `IStorageAsync`
+  // sync SDK (`ISDK` and `INodeSDK`) with `IStorageSync`, and async SDK (`IAsyncSDK` and `INodeAsyncSDK`) with `IStorageAsync`
   storageFactory: (params: IStorageFactoryParams) => IStorageSync | IStorageAsync,
 
   // Factory of Split Api (HTTP Client Service).
@@ -94,8 +95,8 @@ export interface ISdkFactoryParams {
   sdkManagerFactory: typeof sdkManagerFactory,
 
   // Sdk client method factory (ISDK::client method).
-  // It Allows to distinguish SDK clients with the client-side API (`ICsSDK`) or server-side API (`ISDK` or `IAsyncSDK`).
-  sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.ICsClient; (key: SplitIO.SplitKey): SplitIO.ICsClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient))
+  // It Allows to distinguish SDK clients with the client-side API (`ISDK` and `IAsyncSDK`) or server-side API (`INodeSDK` and `INodeAsyncSDK`).
+  sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.IClient; (key: SplitIO.SplitKey): SplitIO.IClient; } | (() => SplitIO.INodeClient) | (() => SplitIO.INodeAsyncClient))
 
   // Impression observer factory.
   impressionsObserverFactory: () => IImpressionObserver

package/src/sdkManager/index.ts

@@ -5,7 +5,8 @@ import { validateSplit, validateSplitExistence, validateIfNotDestroyed, validate
 import { ISplitsCacheAsync, ISplitsCacheSync } from '../storages/types';
 import { ISdkReadinessManager } from '../readiness/types';
 import { ISplit } from '../dtos/types';
-import { ISettings, SplitIO } from '../types';
+import { ISettings } from '../types';
+import SplitIO from '../../types/splitio';
 import { isConsumerMode } from '../utils/settingsValidation/mode';
 import { SPLIT_FN_LABEL, SPLITS_FN_LABEL, NAMES_FN_LABEL } from '../utils/constants';
 

package/src/services/splitApi.ts

@@ -16,9 +16,9 @@ function userKeyToQueryParam(userKey: string) {
 /**
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
- * @param settings validated settings object
- * @param platform object containing environment-specific dependencies
- * @param telemetryTracker telemetry tracker
+ * @param settings - validated settings object
+ * @param platform - object containing environment-specific dependencies
+ * @param telemetryTracker - telemetry tracker
  */
 export function splitApiFactory(
   settings: ISettings,
@@ -81,8 +81,8 @@ export function splitApiFactory(
     /**
      * Post events.
      *
-     * @param body  Events bulk payload
-     * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+     * @param body -  Events bulk payload
+     * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
      */
     postEventsBulk(body: string, headers?: Record<string, string>) {
       const url = `${urls.events}/events/bulk`;
@@ -92,8 +92,8 @@ export function splitApiFactory(
     /**
      * Post impressions.
      *
-     * @param body  Impressions bulk payload
-     * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+     * @param body -  Impressions bulk payload
+     * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
      */
     postTestImpressionsBulk(body: string, headers?: Record<string, string>) {
       const url = `${urls.events}/testImpressions/bulk`;
@@ -106,8 +106,8 @@ export function splitApiFactory(
     /**
      * Post impressions counts.
      *
-     * @param body  Impressions counts payload
-     * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+     * @param body -  Impressions counts payload
+     * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
      */
     postTestImpressionsCount(body: string, headers?: Record<string, string>) {
       const url = `${urls.events}/testImpressions/count`;
@@ -117,8 +117,8 @@ export function splitApiFactory(
     /**
      * Post unique keys for client side.
      *
-     * @param body  unique keys payload
-     * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+     * @param body -  unique keys payload
+     * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
      */
     postUniqueKeysBulkCs(body: string, headers?: Record<string, string>) {
       const url = `${urls.telemetry}/v1/keys/cs`;
@@ -128,8 +128,8 @@ export function splitApiFactory(
     /**
      * Post unique keys for server side.
      *
-     * @param body  unique keys payload
-     * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+     * @param body -  unique keys payload
+     * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
      */
     postUniqueKeysBulkSs(body: string, headers?: Record<string, string>) {
       const url = `${urls.telemetry}/v1/keys/ss`;

package/src/services/splitHttpClient.ts

@@ -10,8 +10,8 @@ const messageNoFetch = 'Global fetch API is not available.';
 /**
  * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
  *
- * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param platform object containing environment-specific dependencies
+ * @param settings - SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
+ * @param platform - object containing environment-specific dependencies
  */
 export function splitHttpClientFactory(settings: ISettings, { getOptions, getFetch }: Pick<IPlatform, 'getOptions' | 'getFetch'>): ISplitHttpClient {
 

package/src/storages/AbstractMySegmentsCacheSync.ts

@@ -38,8 +38,8 @@ export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync
 
   /**
    * Only used for the `skC`(segment keys count) telemetry stat: 1 for client-side, and total count of keys in server-side.
-   * @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
    */
+  // @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
   abstract getKeysCount(): number
 
   abstract getChangeNumber(name: string): number

package/src/storages/AbstractSplitsCacheAsync.ts

@@ -39,10 +39,7 @@ export abstract class AbstractSplitsCacheAsync implements ISplitsCacheAsync {
    * Kill `name` split and set `defaultTreatment` and `changeNumber`.
    * Used for SPLIT_KILL push notifications.
    *
-   * @param {string} name
-   * @param {string} defaultTreatment
-   * @param {number} changeNumber
-   * @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
+   * @returns a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
    * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
    * The promise will never be rejected.
    */

package/src/storages/AbstractSplitsCacheSync.ts

@@ -59,10 +59,7 @@ export abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
    * Kill `name` split and set `defaultTreatment` and `changeNumber`.
    * Used for SPLIT_KILL push notifications.
    *
-   * @param {string} name
-   * @param {string} defaultTreatment
-   * @param {number} changeNumber
-   * @returns {boolean} `true` if the operation successed updating the split, or `false` if no split is updated,
+   * @returns `true` if the operation successed updating the split, or `false` if no split is updated,
    * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
    */
   killLocally(name: string, defaultTreatment: string, changeNumber: number): boolean {

package/src/storages/dataLoader.ts

@@ -1,26 +1,25 @@
-import { SplitIO } from '../types';
+import { PreloadedData } from '../types';
 import { DEFAULT_CACHE_EXPIRATION_IN_MILLIS } from '../utils/constants/browser';
 import { DataLoader, ISegmentsCacheSync, ISplitsCacheSync } from './types';
 
 /**
  * Factory of client-side storage loader
  *
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
+ * @param preloadedData - validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
  * and extended with a `mySegmentsData` property.
  * @returns function to preload the storage
  */
-export function dataLoaderFactory(preloadedData: SplitIO.PreloadedData): DataLoader {
+export function dataLoaderFactory(preloadedData: PreloadedData): DataLoader {
 
   /**
    * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
    * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
    *
-   * @param storage object containing `splits` and `segments` cache (client-side variant)
-   * @param userId user key string of the provided MySegmentsCache
-   *
-   * @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
-   * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
+   * @param storage - object containing `splits` and `segments` cache (client-side variant)
+   * @param userId - user key string of the provided MySegmentsCache
    */
+  // @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
+  // @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
   return function loadData(storage: { splits: ISplitsCacheSync, segments: ISegmentsCacheSync }, userId: string) {
     // Do not load data if current preloadedData is empty
     if (Object.keys(preloadedData).length === 0) return;

package/src/storages/findLatencyIndex.ts

@@ -7,7 +7,7 @@ const BASE = 1.5;
 /**
  * Calculates buckets from latency in milliseconds
  *
- * @param latencyInMs
+ * @param latencyInMs - latency in milliseconds
  * @returns a bucket index from 0 to 22 inclusive
  */
 export function findLatencyIndex(latencyInMs: number): number {

package/src/storages/inLocalStorage/SplitsCacheInLocal.ts

@@ -20,11 +20,6 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
   private hasSync?: boolean;
   private updateNewFilter?: boolean;
 
-  /**
-   * @param {KeyBuilderCS} keys
-   * @param {number | undefined} expirationTimestamp
-   * @param {ISplitFiltersValidation} splitFiltersValidation
-   */
   constructor(settings: ISettings, keys: KeyBuilderCS, expirationTimestamp?: number) {
     super();
     this.keys = keys;
@@ -229,7 +224,7 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
   /**
    * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
    *
-   * @param {number | undefined} expirationTimestamp if the value is not a number, data will not be cleaned
+   * @param expirationTimestamp - if the value is not a number, data will not be cleaned
    */
   private _checkExpiration(expirationTimestamp?: number) {
     let value: string | number | null = localStorage.getItem(this.keys.buildLastUpdatedKey());

package/src/storages/inMemory/AttributesCacheInMemory.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../../types';
+import SplitIO from '../../../types/splitio';
 import { objectAssign } from '../../utils/lang/objectAssign';
 
 export class AttributesCacheInMemory {
@@ -9,9 +9,9 @@ export class AttributesCacheInMemory {
   /**
    * Create or update the value for the given attribute
    *
-   * @param {string} attributeName attribute name
-   * @param {Object} attributeValue attribute value
-   * @returns {boolean} the attribute was stored
+   * @param attributeName - attribute name
+   * @param attributeValue - attribute value
+   * @returns the attribute was stored
    */
   setAttribute(attributeName: string, attributeValue: SplitIO.AttributeType) {
     this.attributesCache[attributeName] = attributeValue;
@@ -21,8 +21,8 @@ export class AttributesCacheInMemory {
   /**
    * Retrieves the value of a given attribute
    *
-   * @param {string} attributeName attribute name
-   * @returns {Object?} stored attribute value
+   * @param attributeName - attribute name
+   * @returns stored attribute value
    */
   getAttribute(attributeName: string) {
     return this.attributesCache[attributeName];
@@ -31,8 +31,8 @@ export class AttributesCacheInMemory {
   /**
    * Create or update all the given attributes
    *
-   * @param {[string, Object]} attributes attributes to create or update
-   * @returns {boolean} attributes were stored
+   * @param attributes - attributes to create or update
+   * @returns attributes were stored
    */
   setAttributes(attributes: Record<string, Object>) {
     this.attributesCache = objectAssign(this.attributesCache, attributes);
@@ -42,7 +42,7 @@ export class AttributesCacheInMemory {
   /**
    * Retrieve the full attributes map
    *
-   * @returns {Map<string, Object>} stored attributes
+   * @returns stored attributes
    */
   getAll() {
     return this.attributesCache;
@@ -51,8 +51,8 @@ export class AttributesCacheInMemory {
   /**
    * Removes a given attribute from the map
    *
-   * @param {string} attributeName attribute to remove
-   * @returns {boolean} attribute removed
+   * @param attributeName - attribute to remove
+   * @returns attribute removed
    */
   removeAttribute(attributeName: string) {
     if (Object.keys(this.attributesCache).indexOf(attributeName) >= 0) {