@splitsoftware/splitio-commons 1.0.1-rc.2 → 1.0.1-rc.3

package/cjs/storages/pluggable/constants.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LOG_PREFIX = void 0;
-exports.LOG_PREFIX = 'storage:pluggable:';
+exports.LOG_PREFIX = 'storage:pluggable: ';

package/cjs/sync/streaming/SSEClient/index.js

@@ -34,7 +34,6 @@ var SSEClient = /** @class */ (function () {
      * @throws 'EventSource API is not available. ' if EventSource is not available.
      */
     function SSEClient(settings, useHeaders, getEventSource) {
-        // @ts-expect-error
         this.eventSource = getEventSource && getEventSource();
         // if eventSource is not available, throw an exception
         if (!this.eventSource)

package/cjs/utils/MinEventEmitter.js

@@ -35,13 +35,13 @@ var EventEmitter = /** @class */ (function () {
     EventEmitter.prototype.once = function (type, listener) {
         return this.registerListener(type, listener, true);
     };
-    // eslint-disable-next-line
-    EventEmitter.prototype.removeListener = function (type, listener) {
+    // @ts-ignore
+    EventEmitter.prototype.removeListener = function ( /* type: string, listener: (...args: any[]) => void */) {
         throw new Error('Method not implemented.');
     };
-    // alias of removeListener
-    EventEmitter.prototype.off = function (type, listener) {
-        return this.removeListener(type, listener);
+    // @ts-ignore alias of removeListener
+    EventEmitter.prototype.off = function ( /* type: string, listener: (...args: any[]) => void */) {
+        return this.removeListener( /* type, listener */);
     };
     EventEmitter.prototype.emit = function (type) {
         var args = [];

package/cjs/utils/env/isNode.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isNode = void 0;
-// We check for version truthiness since most shims will have that as empty string.
+/**
+ * 'true' if running in Node.js, or 'false' otherwise.
+ * We check for version truthiness since most shims will have that as empty string.
+ */
 // eslint-disable-next-line no-undef
 exports.isNode = typeof process !== 'undefined' && typeof process.version !== 'undefined' && !!process.version ? true : false;

package/esm/storages/pluggable/constants.js

@@ -1 +1 @@
-export var LOG_PREFIX = 'storage:pluggable:';
+export var LOG_PREFIX = 'storage:pluggable: ';

package/esm/sync/streaming/SSEClient/index.js

@@ -32,7 +32,6 @@ var SSEClient = /** @class */ (function () {
      * @throws 'EventSource API is not available. ' if EventSource is not available.
      */
     function SSEClient(settings, useHeaders, getEventSource) {
-        // @ts-expect-error
         this.eventSource = getEventSource && getEventSource();
         // if eventSource is not available, throw an exception
         if (!this.eventSource)

package/esm/utils/MinEventEmitter.js

@@ -33,13 +33,13 @@ var EventEmitter = /** @class */ (function () {
     EventEmitter.prototype.once = function (type, listener) {
         return this.registerListener(type, listener, true);
     };
-    // eslint-disable-next-line
-    EventEmitter.prototype.removeListener = function (type, listener) {
+    // @ts-ignore
+    EventEmitter.prototype.removeListener = function ( /* type: string, listener: (...args: any[]) => void */) {
         throw new Error('Method not implemented.');
     };
-    // alias of removeListener
-    EventEmitter.prototype.off = function (type, listener) {
-        return this.removeListener(type, listener);
+    // @ts-ignore alias of removeListener
+    EventEmitter.prototype.off = function ( /* type: string, listener: (...args: any[]) => void */) {
+        return this.removeListener( /* type, listener */);
     };
     EventEmitter.prototype.emit = function (type) {
         var args = [];

package/esm/utils/env/isNode.js

@@ -1,3 +1,6 @@
-// We check for version truthiness since most shims will have that as empty string.
+/**
+ * 'true' if running in Node.js, or 'false' otherwise.
+ * We check for version truthiness since most shims will have that as empty string.
+ */
 // eslint-disable-next-line no-undef
 export var isNode = typeof process !== 'undefined' && typeof process.version !== 'undefined' && !!process.version ? true : false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.0.1-rc.2",
+  "version": "1.0.1-rc.3",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -49,10 +49,9 @@
   },
   "devDependencies": {
     "@types/google.analytics": "0.0.40",
-    "@types/ioredis": "^4.14.1",
+    "@types/ioredis": "^4.28.0",
     "@types/jest": "^27.0.0",
     "@types/lodash": "^4.14.162",
-    "@types/node": "^14.14.7",
     "@types/object-assign": "^4.0.30",
     "@typescript-eslint/eslint-plugin": "^4.2.0",
     "@typescript-eslint/parser": "^4.2.0",
@@ -61,7 +60,7 @@
     "eslint": "^7.32.0",
     "eslint-plugin-compat": "3.7.0",
     "fetch-mock": "^9.10.7",
-    "ioredis": "^4.26.0",
+    "ioredis": "^4.28.0",
     "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
     "js-yaml": "^3.14.0",

package/src/sdkFactory/types.ts

@@ -3,7 +3,7 @@ import { ISignalListener } from '../listeners/types';
 import { ILogger } from '../logger/types';
 import { ISdkReadinessManager } from '../readiness/types';
 import { ISdkClientFactoryParams } from '../sdkClient/types';
-import { IFetch, ISplitApi } from '../services/types';
+import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
 import { IStorageAsync, IStorageSync, ISplitsCacheSync, ISplitsCacheAsync, IStorageFactoryParams } from '../storages/types';
 import { ISyncManager, ISyncManagerFactoryParams } from '../sync/types';
 import { IImpressionObserver } from '../trackers/impressionObserver/types';
@@ -16,7 +16,7 @@ import { SplitIO, ISettings, IEventEmitter } from '../types';
 export interface IPlatform {
   getOptions?: () => object
   getFetch?: () => (IFetch | undefined)
-  getEventSource?: () => (typeof EventSource | undefined)
+  getEventSource?: () => (IEventSourceConstructor | undefined)
   EventEmitter: new () => IEventEmitter
 }
 

package/src/services/types.ts

@@ -50,8 +50,8 @@ export type IPostMetricsCounters = (body: string) => Promise<IResponse>
 export type IPostMetricsTimes = (body: string) => Promise<IResponse>
 
 export interface ISplitApi {
-  getSdkAPIHealthCheck: IHealthCheckAPI
-  getEventsAPIHealthCheck: IHealthCheckAPI
+	getSdkAPIHealthCheck: IHealthCheckAPI
+	getEventsAPIHealthCheck: IHealthCheckAPI
 	fetchAuth: IFetchAuth
 	fetchSplitChanges: IFetchSplitChanges
 	fetchSegmentChanges: IFetchSegmentChanges
@@ -62,3 +62,17 @@ export interface ISplitApi {
 	postMetricsCounters: IPostMetricsCounters
 	postMetricsTimes: IPostMetricsTimes
 }
+
+// Minimal version of EventSource API used by the SDK
+interface EventSourceEventMap {
+	'error': Event
+	'message': MessageEvent
+	'open': Event
+}
+
+interface IEventSource {
+	addEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: IEventSource, ev: EventSourceEventMap[K]) => any): void
+	close(): void
+}
+
+export type IEventSourceConstructor = new (url: string, eventSourceInitDict?: { headers?: object }) => IEventSource

package/src/storages/pluggable/constants.ts

@@ -1 +1 @@
-export const LOG_PREFIX = 'storage:pluggable:';
+export const LOG_PREFIX = 'storage:pluggable: ';

package/src/sync/streaming/SSEClient/index.ts

@@ -1,3 +1,4 @@
+import { IEventSourceConstructor } from '../../../services/types';
 import { ISettings } from '../../../types';
 import { IAuthTokenPushEnabled } from '../AuthClient/types';
 import { ISSEClient, ISseEventHandler } from './types';
@@ -31,9 +32,9 @@ function buildSSEHeaders(settings: ISettings) {
  */
 export default class SSEClient implements ISSEClient {
   // Instance properties:
-  eventSource: typeof EventSource;
+  eventSource?: IEventSourceConstructor;
   streamingUrl: string;
-  connection?: InstanceType<typeof EventSource>;
+  connection?: InstanceType<IEventSourceConstructor>;
   handler?: ISseEventHandler;
   useHeaders?: boolean;
   headers: Record<string, string>;
@@ -46,8 +47,7 @@ export default class SSEClient implements ISSEClient {
    * @param getEventSource Function to get the EventSource constructor.
    * @throws 'EventSource API is not available. ' if EventSource is not available.
    */
-  constructor(settings: ISettings, useHeaders?: boolean, getEventSource?: () => (typeof EventSource | undefined)) {
-    // @ts-expect-error
+  constructor(settings: ISettings, useHeaders?: boolean, getEventSource?: () => (IEventSourceConstructor | undefined)) {
     this.eventSource = getEventSource && getEventSource();
     // if eventSource is not available, throw an exception
     if (!this.eventSource) throw new Error('EventSource API is not available. ');
@@ -79,7 +79,7 @@ export default class SSEClient implements ISSEClient {
     ).join(',');
     const url = `${this.streamingUrl}?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
 
-    this.connection = new this.eventSource(
+    this.connection = new this.eventSource!(
       // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
       // because native EventSource implementations for browser doesn't support headers.
       this.useHeaders ? url : url + `&SplitSDKVersion=${this.headers.SplitSDKVersion}&SplitSDKClientKey=${this.headers.SplitSDKClientKey}`,

package/src/types.ts

@@ -7,15 +7,16 @@ import { IStorageFactoryParams, IStorageSync, IStorageAsync, IStorageSyncFactory
 import { ISyncManagerFactoryParams, ISyncManagerCS } from './sync/types';
 
 /**
- * EventEmitter interface with the minimal methods used by the SDK
+ * Reduced version of NodeJS.EventEmitter interface with the minimal methods used by the SDK
+ * @see {@link https://nodejs.org/api/events.html}
  */
-export interface IEventEmitter extends Pick<NodeJS.EventEmitter, 'addListener' | 'on' | 'once' | 'removeListener' | 'off' | 'removeAllListeners' | 'emit'> {
-  addListener(event: string, listener: (...args: any[]) => void): any;
-  on(event: string, listener: (...args: any[]) => void): any
-  once(event: string, listener: (...args: any[]) => void): any
-  removeListener(event: string, listener: (...args: any[]) => void): any;
-  off(event: string, listener: (...args: any[]) => void): any;
-  removeAllListeners(event?: string): any
+export interface IEventEmitter {
+  addListener(event: string, listener: (...args: any[]) => void): this;
+  on(event: string, listener: (...args: any[]) => void): this
+  once(event: string, listener: (...args: any[]) => void): this
+  removeListener(event: string, listener: (...args: any[]) => void): this;
+  off(event: string, listener: (...args: any[]) => void): this;
+  removeAllListeners(event?: string): this
   emit(event: string, ...args: any[]): boolean
 }
 

package/src/utils/MinEventEmitter.ts

@@ -18,7 +18,7 @@ export default class EventEmitter implements IEventEmitter {
     boolean // whether it is a one-time listener or not
   ]>> = {};
 
-  private registerListener(type: string, listener: (...args: any[]) => void, oneTime: boolean): EventEmitter {
+  private registerListener(type: string, listener: (...args: any[]) => void, oneTime: boolean) {
     checkListener(listener);
 
     // To avoid recursion in the case that type === "newListener" before
@@ -33,27 +33,27 @@ export default class EventEmitter implements IEventEmitter {
     return this;
   }
 
-  addListener(type: string, listener: (...args: any[]) => void): EventEmitter {
+  addListener(type: string, listener: (...args: any[]) => void) {
     return this.registerListener(type, listener, false);
   }
 
   // alias of addListener
-  on(type: string, listener: (...args: any[]) => void): EventEmitter {
+  on(type: string, listener: (...args: any[]) => void) {
     return this.addListener(type, listener);
   }
 
-  once(type: string, listener: (...args: any[]) => void): EventEmitter {
+  once(type: string, listener: (...args: any[]) => void) {
     return this.registerListener(type, listener, true);
   }
 
-  // eslint-disable-next-line
-  removeListener(type: string, listener: (...args: any[]) => void): EventEmitter {
+  // @ts-ignore
+  removeListener(/* type: string, listener: (...args: any[]) => void */) {
     throw new Error('Method not implemented.');
   }
 
-  // alias of removeListener
-  off(type: string, listener: (...args: any[]) => void): EventEmitter {
-    return this.removeListener(type, listener);
+  // @ts-ignore alias of removeListener
+  off(/* type: string, listener: (...args: any[]) => void */) {
+    return this.removeListener(/* type, listener */);
   }
 
   emit(type: string, ...args: any[]): boolean {
@@ -68,7 +68,7 @@ export default class EventEmitter implements IEventEmitter {
     return true;
   }
 
-  removeAllListeners(type?: string): EventEmitter {
+  removeAllListeners(type?: string) {
     if (!this.listeners[REMOVE_LISTENER_EVENT]) {
       // if not listening for `removeListener`, no need to emit
       if (type) {

package/src/utils/env/isNode.ts

@@ -1,3 +1,6 @@
-// We check for version truthiness since most shims will have that as empty string.
+/**
+ * 'true' if running in Node.js, or 'false' otherwise.
+ * We check for version truthiness since most shims will have that as empty string.
+ */
 // eslint-disable-next-line no-undef
 export const isNode: boolean = typeof process !== 'undefined' && typeof process.version !== 'undefined' && !!process.version ? true : false;

package/types/sdkFactory/types.d.ts

@@ -3,7 +3,7 @@ import { ISignalListener } from '../listeners/types';
 import { ILogger } from '../logger/types';
 import { ISdkReadinessManager } from '../readiness/types';
 import { ISdkClientFactoryParams } from '../sdkClient/types';
-import { IFetch, ISplitApi } from '../services/types';
+import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
 import { IStorageAsync, IStorageSync, ISplitsCacheSync, ISplitsCacheAsync, IStorageFactoryParams } from '../storages/types';
 import { ISyncManager, ISyncManagerFactoryParams } from '../sync/types';
 import { IImpressionObserver } from '../trackers/impressionObserver/types';
@@ -15,7 +15,7 @@ import { SplitIO, ISettings, IEventEmitter } from '../types';
 export interface IPlatform {
     getOptions?: () => object;
     getFetch?: () => (IFetch | undefined);
-    getEventSource?: () => (typeof EventSource | undefined);
+    getEventSource?: () => (IEventSourceConstructor | undefined);
     EventEmitter: new () => IEventEmitter;
 }
 /**

package/types/services/types.d.ts

@@ -34,3 +34,16 @@ export interface ISplitApi {
     postMetricsCounters: IPostMetricsCounters;
     postMetricsTimes: IPostMetricsTimes;
 }
+interface EventSourceEventMap {
+    'error': Event;
+    'message': MessageEvent;
+    'open': Event;
+}
+interface IEventSource {
+    addEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: IEventSource, ev: EventSourceEventMap[K]) => any): void;
+    close(): void;
+}
+export declare type IEventSourceConstructor = new (url: string, eventSourceInitDict?: {
+    headers?: object;
+}) => IEventSource;
+export {};

package/types/storages/pluggable/constants.d.ts

@@ -1 +1 @@
-export declare const LOG_PREFIX = "storage:pluggable:";
+export declare const LOG_PREFIX = "storage:pluggable: ";

package/types/sync/streaming/SSEClient/index.d.ts

@@ -1,3 +1,4 @@
+import { IEventSourceConstructor } from '../../../services/types';
 import { ISettings } from '../../../types';
 import { IAuthTokenPushEnabled } from '../AuthClient/types';
 import { ISSEClient, ISseEventHandler } from './types';
@@ -5,9 +6,9 @@ import { ISSEClient, ISseEventHandler } from './types';
  * Handles streaming connections with EventSource API
  */
 export default class SSEClient implements ISSEClient {
-    eventSource: typeof EventSource;
+    eventSource?: IEventSourceConstructor;
     streamingUrl: string;
-    connection?: InstanceType<typeof EventSource>;
+    connection?: InstanceType<IEventSourceConstructor>;
     handler?: ISseEventHandler;
     useHeaders?: boolean;
     headers: Record<string, string>;
@@ -19,7 +20,7 @@ export default class SSEClient implements ISSEClient {
      * @param getEventSource Function to get the EventSource constructor.
      * @throws 'EventSource API is not available. ' if EventSource is not available.
      */
-    constructor(settings: ISettings, useHeaders?: boolean, getEventSource?: () => (typeof EventSource | undefined));
+    constructor(settings: ISettings, useHeaders?: boolean, getEventSource?: () => (IEventSourceConstructor | undefined));
     setEventHandler(handler: ISseEventHandler): void;
     /**
      * Open the connection with a given authToken

package/types/types.d.ts

@@ -1,19 +1,19 @@
-/// <reference types="node" />
 import { ISplitFiltersValidation } from './dtos/types';
 import { IIntegration, IIntegrationFactoryParams } from './integrations/types';
 import { ILogger } from './logger/types';
 import { IStorageFactoryParams, IStorageSync, IStorageAsync, IStorageSyncFactory, IStorageAsyncFactory } from './storages/types';
 import { ISyncManagerFactoryParams, ISyncManagerCS } from './sync/types';
 /**
- * EventEmitter interface with the minimal methods used by the SDK
+ * Reduced version of NodeJS.EventEmitter interface with the minimal methods used by the SDK
+ * @see {@link https://nodejs.org/api/events.html}
  */
-export interface IEventEmitter extends Pick<NodeJS.EventEmitter, 'addListener' | 'on' | 'once' | 'removeListener' | 'off' | 'removeAllListeners' | 'emit'> {
-    addListener(event: string, listener: (...args: any[]) => void): any;
-    on(event: string, listener: (...args: any[]) => void): any;
-    once(event: string, listener: (...args: any[]) => void): any;
-    removeListener(event: string, listener: (...args: any[]) => void): any;
-    off(event: string, listener: (...args: any[]) => void): any;
-    removeAllListeners(event?: string): any;
+export interface IEventEmitter {
+    addListener(event: string, listener: (...args: any[]) => void): this;
+    on(event: string, listener: (...args: any[]) => void): this;
+    once(event: string, listener: (...args: any[]) => void): this;
+    removeListener(event: string, listener: (...args: any[]) => void): this;
+    off(event: string, listener: (...args: any[]) => void): this;
+    removeAllListeners(event?: string): this;
     emit(event: string, ...args: any[]): boolean;
 }
 /**

package/types/utils/MinEventEmitter.d.ts

@@ -2,11 +2,11 @@ import { IEventEmitter } from '../types';
 export default class EventEmitter implements IEventEmitter {
     private listeners;
     private registerListener;
-    addListener(type: string, listener: (...args: any[]) => void): EventEmitter;
-    on(type: string, listener: (...args: any[]) => void): EventEmitter;
-    once(type: string, listener: (...args: any[]) => void): EventEmitter;
-    removeListener(type: string, listener: (...args: any[]) => void): EventEmitter;
-    off(type: string, listener: (...args: any[]) => void): EventEmitter;
+    addListener(type: string, listener: (...args: any[]) => void): this;
+    on(type: string, listener: (...args: any[]) => void): this;
+    once(type: string, listener: (...args: any[]) => void): this;
+    removeListener(): void;
+    off(): void;
     emit(type: string, ...args: any[]): boolean;
-    removeAllListeners(type?: string): EventEmitter;
+    removeAllListeners(type?: string): this;
 }

package/types/utils/env/isNode.d.ts

@@ -1 +1,5 @@
+/**
+ * 'true' if running in Node.js, or 'false' otherwise.
+ * We check for version truthiness since most shims will have that as empty string.
+ */
 export declare const isNode: boolean;