Merge pull request #5 from hackbg/refactor/srp

v2.0.0 (v2.1.0?)

Author: mradkov

.editorconfig

@@ -0,0 +1,3 @@
+indent_style = space
+indent_size = 2
+max_line_length = 100

CHANGELOG.md

@@ -1,24 +1,28 @@
 # 2.0.0
 
-* Automatic and manual reconnection of WebSocket
-* Configuration changes:
-  * Full URLs now required instead of bare hostnames:
-    * `hostname` -> `apiUrl`, now requires protocol (i.e. `https://`)
-    * `wsHostname` -> `wsUrl`, now requires protocol (i.e. `wss://`)
-    * `http://` and `ws://` supported (for testing only!)
-  * `clientID` -> `clientId` to match capitalization of other parameters
-  * Configuration variables in `.env` updated accordingly;, see `.env.example`.
-  * `lazy` flag prevents initial autoconnect, allowing for `connect()`
-    to be called manually at a later time
+* **NEW:** Unencrypted `http://` and `ws://` are now supported (use for testing only!)
+* **NEW:** Custom `Error` classes, discernible using `instanceof`.
+* **NEW:** Constructor option `reconnect` (default on) allows reconnection of WebSocket.
+* **NEW:** Constructor option `lazy` (default off) prevents autoconnect to socket.
+* **NEW:** Methods `connect()` and `disconnect()` manually set the socket connection state.
+* **NEW:** Method `unsubscribeAll()` clears feeds and disconnects.
+* **NEW:** Field `socketState` reports connection state of currently used `WebSocket`.
+* **BREAKING:** `feeds` field is now read-only.
+* **BREAKING:** Constructor option `hostname` is now `apiUrl` and requires protocol
+  (preferably `https://`, alternatively `http://`, possibly `//`)
+* **BREAKING:** Constructor option `wsHostname` is now `wsUrl` and requires protocol
+  (preferably `wss://`, alternatively `ws://`, possibly `//`)
+* **BREAKING:** Constructor option `clientID` is now `clientId`, to match others.
+* **BREAKING:** Configuration variables in `.env` updated, see `.env.example`.
 
 # 1.1.0
 
-* Allow only `GET|HEAD|OPTIONS` in `generateHeaders`
+* **NEW**: Allow only `GET|HEAD|OPTIONS` in `generateHeaders`
 
 # 1.0.1
 
-* Harden `generateHeaders`
+* **FIX**: Harden `generateHeaders`
 
 # 1.0.0
 
-* Initial release
+* **NEW**: Initial release

index.d.ts

@@ -1,11 +1,22 @@
 import type { WebSocket } from 'ws';
 
-export type ReconnectOptions = {
-  enabled?: boolean;
-  maxReconnectAttempts?: number;
-  reconnectInterval?: number;
-};
-export default class ChainlinkDataStreamsConsumer {
+export {
+  Report,
+  EventEmitter,
+  ChainlinkDataStreamsConsumer as default,
+  ChainlinkDataStreamsConsumer as Consumer,
+  ChainlinkDataStreamsError as Error,
+  generateHeaders,
+}
+
+declare class EventEmitter {
+  on(event: string, cb: Function): this;
+  off(event: string, cb: Function): this;
+  once(event: string, cb: Function): this;
+  emit(event: string, data: unknown): this;
+}
+
+declare class ChainlinkDataStreamsConsumer extends EventEmitter {
   constructor(args: {
     /** API client ID. */
     clientId?: string;
@@ -17,40 +28,42 @@ export default class ChainlinkDataStreamsConsumer {
     wsUrl?: string;
     /** List of feed IDs to subscribe to. */
     feeds?: string[];
-    /** Disable or configure socket auto-reconnect. */
-    reconnect?: boolean|ReconnectOptions;
-    /** Don't automatically connect to socket on construction or setting feeds. */
+    /** Automatically connect to socket on construction or setting feeds? */
     lazy?: boolean;
+    /** Disable or configure socket auto-reconnect. */
+    reconnect?: boolean|{
+      enabled?: boolean;
+      maxAttempts?: number;
+      interval?: number;
+    };
   });
-
-  fetchFeed(args: {
-    timestamp: string | number;
-    feed: string;
-  }): Promise<Report>;
-
-  fetchFeeds(args: {
-    timestamp: string | number;
-    feeds: string[];
-  }): Promise<Record<string, Report>>;
-
-  subscribeTo(feeds: string | string[]): Promise<WebSocket | null>;
-
-  unsubscribeFrom(feeds: string | string[]): Promise<WebSocket | null>;
-
-  connect(): Promise<void>;
-
-  disconnect(): void;
-
-  feeds: Set<string>;
-
-  on(event: string, cb: Function): this;
-
-  off(event: string, cb: Function): this;
-
-  once(event: string, cb: Function): this;
+  get socketState ():
+    WebSocket["readyState"]|null;
+  fetchFeed(args: { timestamp: string | number; feed: string; }):
+    Promise<Report>;
+  fetchFeeds(args: { timestamp: string | number; feeds: string[]; }):
+    Promise<Record<string, Report>>;
+  subscribeTo(feeds: string | string[]): 
+    Promise<WebSocket | null>;
+  unsubscribeFrom(feeds: string | string[]):
+    Promise<WebSocket | null>;
+  unsubscribeAll():
+    Promise<WebSocket | null>;
+  connect():
+    Promise<void>;
+  disconnect():
+    void;
+  get feeds:
+    Set<string> & { add: never, delete: never, clear: never };
+  generateHeaders(
+    method: string,
+    path: string,
+    search: string|URLSearchParams,
+    timestamp?: number
+  ): AuthHeaders;
 }
 
-export type Report = {
+declare type Report = {
   feedId: string;
   observationsTimestamp: bigint;
 } & (
@@ -90,3 +103,21 @@ export type Report = {
       marketStatus: number;
     }
 );
+
+declare class ChainlinkDataStreamsError extends Error {
+}
+
+declare function generateHeaders (args: {
+  clientId: string,
+  clientSecret: string,
+  method: string,
+  path: string,
+  search: string|URLSearchParams,
+  timestamp?: number
+}): AuthHeaders
+
+declare type AuthHeaders = {
+  'Authorization':                    string
+  'X-Authorization-Timestamp':        string
+  'X-Authorization-Signature-SHA256': string
+}