jsonrpc-client-websocket 1.3.0 → 1.5.1

package/README.md

@@ -1,6 +1,6 @@
 [![Travis build status](https://travis-ci.com/fabriciobastian/jsonrpc-client-websocket.svg?branch=master)](https://travis-ci.com/fabriciobastian/jsonrpc-client-websocket) [![License](https://img.shields.io/github/license/fabriciobastian/jsonrpc-client-websocket)](https://choosealicense.com/licenses/mit/) [![NPM downloads](https://img.shields.io/npm/dt/jsonrpc-client-websocket.svg)](https://www.npmjs.com/package/jsonrpc-client-websocket) 
 
-# jsonrpc-client-websocket
+![jsonrpc-client-websocket](https://github.com/fabriciobastian/jsonrpc-client-websocket/blob/master/assets/jsonrpc-client-websocket-banner-light-small.png?raw=true)
 
 A simple JSON RPC 2.0 client over websockets
 
@@ -70,3 +70,8 @@ websocket.on('sum', (a: number, b: number) => {
 });
 ```
 The defined RPC methods can also be called with both positional and named parameters.
+
+## Remove RPC method
+```typescript
+websocket.off('sum');
+```

package/lib/deferred-promise.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class DeferredPromise {
+export class DeferredPromise {
     constructor() {
         this.promise = new Promise((resolve, reject) => {
             this.deferResolve = resolve;
@@ -17,4 +15,3 @@ class DeferredPromise {
         this.deferReject(error);
     }
 }
-exports.DeferredPromise = DeferredPromise;

package/lib/index.js

@@ -1,7 +1,2 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./jsonrpc-websocket"));
-__export(require("./jsonrpc.model"));
+export * from './jsonrpc-websocket';
+export * from './jsonrpc.model';

package/lib/jsonrpc-websocket.d.ts

@@ -21,8 +21,9 @@ export declare class JsonRpcWebsocket {
     open(): Promise<Event>;
     close(): Promise<CloseEvent>;
     on(methodName: string, callback: (...args: any[]) => any): void;
-    call(method: string, params?: any): Promise<JsonRpcResponse>;
-    notify(method: string, params?: any): void;
+    off(methodName: string): void;
+    call(method: string, params?: unknown): Promise<JsonRpcResponse>;
+    notify(method: string, params?: unknown): void;
     private createWebsocket;
     private respondOk;
     private respondError;

package/lib/jsonrpc-websocket.js

@@ -1,16 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const getParameterNames = require("get-parameter-names");
-const deferred_promise_1 = require("./deferred-promise");
-const jsonrpc_model_1 = require("./jsonrpc.model");
-var WebsocketReadyStates;
+import * as getParameterNames from 'get-parameter-names';
+import { DeferredPromise } from './deferred-promise';
+import { JsonRpcErrorCodes } from './jsonrpc.model';
+export var WebsocketReadyStates;
 (function (WebsocketReadyStates) {
     WebsocketReadyStates[WebsocketReadyStates["CONNECTING"] = 0] = "CONNECTING";
     WebsocketReadyStates[WebsocketReadyStates["OPEN"] = 1] = "OPEN";
     WebsocketReadyStates[WebsocketReadyStates["CLOSING"] = 2] = "CLOSING";
     WebsocketReadyStates[WebsocketReadyStates["CLOSED"] = 3] = "CLOSED";
-})(WebsocketReadyStates = exports.WebsocketReadyStates || (exports.WebsocketReadyStates = {}));
-class JsonRpcWebsocket {
+})(WebsocketReadyStates || (WebsocketReadyStates = {}));
+export class JsonRpcWebsocket {
     constructor(url, requestTimeoutMs, onError) {
         this.url = url;
         this.requestTimeoutMs = requestTimeoutMs;
@@ -30,21 +28,23 @@ class JsonRpcWebsocket {
         return this.createWebsocket();
     }
     close() {
-        if (this.websocket === void 0) {
+        if (this.websocket === undefined) {
             return Promise.resolve(new CloseEvent('No websocket was opened', { wasClean: false, code: 1005 }));
         }
         this.websocket.close(1000); // 1000 = normal closure
-        this.websocket = void 0;
+        this.websocket = undefined;
         return this.closeDeferredPromise.asPromise();
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(methodName, callback) {
         this.rpcMethods[methodName.toLowerCase()] = callback; // case-insensitive!
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    off(methodName) {
+        delete this.rpcMethods[methodName.toLowerCase()]; // case-insensitive!
+    }
     call(method, params) {
         if (!this.websocket || this.state !== WebsocketReadyStates.OPEN) {
-            return Promise.reject({ code: jsonrpc_model_1.JsonRpcErrorCodes.INTERNAL_ERROR, message: 'The websocket is not opened' });
+            return Promise.reject({ code: JsonRpcErrorCodes.INTERNAL_ERROR, message: 'The websocket is not opened' });
         }
         const request = {
             id: this.getRequestId(),
@@ -57,11 +57,10 @@ class JsonRpcWebsocket {
         }
         catch (e) {
             // istanbul ignore next
-            return Promise.reject({ code: jsonrpc_model_1.JsonRpcErrorCodes.INTERNAL_ERROR, message: `Internal error. ${e}` });
+            return Promise.reject({ code: JsonRpcErrorCodes.INTERNAL_ERROR, message: `Internal error. ${e}` });
         }
         return this.createPendingRequest(request);
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     notify(method, params) {
         if (!this.websocket || this.state !== WebsocketReadyStates.OPEN) {
             throw new Error('The websocket is not opened');
@@ -83,8 +82,8 @@ class JsonRpcWebsocket {
         // See https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent for close event codes
         // this.websocket = new WebSocket(this.url, ['jsonrpc-2.0']);
         this.websocket = new WebSocket(this.url);
-        const openDeferredPromise = new deferred_promise_1.DeferredPromise();
-        this.closeDeferredPromise = new deferred_promise_1.DeferredPromise();
+        const openDeferredPromise = new DeferredPromise();
+        this.closeDeferredPromise = new DeferredPromise();
         this.websocket.onopen = (event) => {
             openDeferredPromise.resolve(event);
         };
@@ -92,7 +91,7 @@ class JsonRpcWebsocket {
             openDeferredPromise.reject(err);
         };
         this.websocket.onclose = (event) => {
-            this.websocket = void 0;
+            this.websocket = undefined;
             if (event.code !== 1000) {
                 // 1000 = normal closure
                 const error = {
@@ -107,14 +106,12 @@ class JsonRpcWebsocket {
         this.websocket.onmessage = (message) => this.handleMessage(message.data);
         return openDeferredPromise.asPromise();
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     respondOk(id, result) {
         this.respond(id, result);
     }
     respondError(id, error) {
-        this.respond(id, void 0, error);
+        this.respond(id, undefined, error);
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     respond(id, result, error) {
         // istanbul ignore if
         if (!this.websocket || this.state !== WebsocketReadyStates.OPEN) {
@@ -128,7 +125,7 @@ class JsonRpcWebsocket {
             jsonrpc: this.jsonRpcVersion,
             error: error,
             id: id,
-            result: result
+            result: result,
         };
         try {
             this.websocket.send(JSON.stringify(response));
@@ -144,14 +141,14 @@ class JsonRpcWebsocket {
             data = JSON.parse(msg);
         }
         catch (e) /* istanbul ignore next */ {
-            this.handleError(jsonrpc_model_1.JsonRpcErrorCodes.PARSE_ERROR, `Invalid JSON was received. ${e}`);
+            this.handleError(JsonRpcErrorCodes.PARSE_ERROR, `Invalid JSON was received. ${e}`);
             return;
         }
         const isResponse = !!data && this.hasProperty(data, 'id') && (this.hasProperty(data, 'result') || this.hasProperty(data, 'error'));
         const isRequest = !!data && this.hasProperty(data, 'method');
-        const requestId = isRequest && data.id ? data.id : void 0;
+        const requestId = isRequest && data.id ? data.id : undefined;
         if (!data.jsonrpc || data.jsonrpc !== this.jsonRpcVersion) {
-            this.handleError(jsonrpc_model_1.JsonRpcErrorCodes.INVALID_REQUEST, `Invalid JSON RPC protocol version. Expecting ${this.jsonRpcVersion}, but got ${data.jsonrpc}`, requestId);
+            this.handleError(JsonRpcErrorCodes.INVALID_REQUEST, `Invalid JSON RPC protocol version. Expecting ${this.jsonRpcVersion}, but got ${data.jsonrpc}`, requestId);
             return;
         }
         if (isResponse) {
@@ -161,13 +158,13 @@ class JsonRpcWebsocket {
             this.handleRequest(data);
         }
         else {
-            this.handleError(jsonrpc_model_1.JsonRpcErrorCodes.INVALID_REQUEST, `Received unknown data: ${JSON.stringify(data)}`, requestId);
+            this.handleError(JsonRpcErrorCodes.INVALID_REQUEST, `Received unknown data: ${JSON.stringify(data)}`, requestId);
         }
     }
     handleRequest(request) {
         const method = this.rpcMethods[request.method.toLowerCase()]; // case-insensitive!
         if (!method) {
-            this.handleError(jsonrpc_model_1.JsonRpcErrorCodes.METHOD_NOT_FOUND, `Method '${request.method}' was not found`, request.id);
+            this.handleError(JsonRpcErrorCodes.METHOD_NOT_FOUND, `Method '${request.method}' was not found`, request.id);
             return;
         }
         let requestParams = [];
@@ -175,12 +172,17 @@ class JsonRpcWebsocket {
             requestParams = this.getRequestParams(method, request);
         }
         catch (error) {
-            this.handleError(jsonrpc_model_1.JsonRpcErrorCodes.INVALID_PARAMS, error.message, request.id);
+            this.handleError(JsonRpcErrorCodes.INVALID_PARAMS, error.message, request.id);
             return;
         }
-        const result = method(...requestParams);
-        if (request.id) {
-            this.respondOk(request.id, result);
+        try {
+            const result = method(...requestParams);
+            if (request.id) {
+                this.respondOk(request.id, result);
+            }
+        }
+        catch (error) {
+            this.handleError(JsonRpcErrorCodes.REQUEST_FAILED, `Method '${request.method}' has thrown: '${error.message}'`, request.id);
         }
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -198,9 +200,9 @@ class JsonRpcWebsocket {
                 if (method.length !== Object.keys(request.params).length) {
                     throw new Error(`Invalid parameters. Method '${request.method}' expects parameters [${parameterNames}], but got [${Object.keys(request.params)}]`);
                 }
-                parameterNames.forEach(paramName => {
+                parameterNames.forEach((paramName) => {
                     const paramValue = request.params[paramName];
-                    if (!paramValue) {
+                    if (paramValue === undefined) {
                         throw new Error(`Invalid parameters. Method '${request.method}' expects parameters [${parameterNames}], but got [${Object.keys(request.params)}]`);
                     }
                     requestParams.push(paramValue);
@@ -214,9 +216,9 @@ class JsonRpcWebsocket {
     }
     handleResponse(response) {
         const activeRequest = this.pendingRequests[response.id];
-        if (activeRequest === void 0) {
+        if (activeRequest === undefined) {
             this.callOnError({
-                code: jsonrpc_model_1.JsonRpcErrorCodes.INTERNAL_ERROR,
+                code: JsonRpcErrorCodes.INTERNAL_ERROR,
                 message: `Received a response with id ${response.id}, which does not match any requests made by this client`,
             });
             return;
@@ -225,7 +227,7 @@ class JsonRpcWebsocket {
         if (this.hasProperty(response, 'result') && this.hasProperty(response, 'error')) {
             const errorResponse = {
                 error: {
-                    code: jsonrpc_model_1.JsonRpcErrorCodes.INVALID_RESPONSE,
+                    code: JsonRpcErrorCodes.INVALID_RESPONSE,
                     message: `Invalid response. Either result or error must be set, but not both. ${JSON.stringify(response)}`,
                 },
                 id: activeRequest.request.id,
@@ -249,7 +251,7 @@ class JsonRpcWebsocket {
         }
     }
     createPendingRequest(request) {
-        const response = new deferred_promise_1.DeferredPromise();
+        const response = new DeferredPromise();
         this.pendingRequests[request.id] = {
             request,
             response,
@@ -261,12 +263,12 @@ class JsonRpcWebsocket {
         return self.setTimeout(() => {
             const activeRequest = this.pendingRequests[requestId];
             // istanbul ignore if
-            if (activeRequest === void 0) {
+            if (activeRequest === undefined) {
                 return;
             }
             const response = {
                 error: {
-                    code: jsonrpc_model_1.JsonRpcErrorCodes.REQUEST_TIMEOUT,
+                    code: JsonRpcErrorCodes.REQUEST_TIMEOUT,
                     message: `Request ${activeRequest.request.id} exceeded the maximum time of ${this.requestTimeoutMs}ms and was aborted`,
                 },
                 id: activeRequest.request.id,
@@ -277,16 +279,14 @@ class JsonRpcWebsocket {
         }, this.requestTimeoutMs);
     }
     callOnError(error) {
-        if (this.onError !== void 0) {
+        if (this.onError !== undefined) {
             this.onError(error);
         }
     }
     getRequestId() {
         return ++this.requestId;
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     hasProperty(object, propertyName) {
         return !!Object.prototype.hasOwnProperty.call(object, propertyName);
     }
 }
-exports.JsonRpcWebsocket = JsonRpcWebsocket;

package/lib/jsonrpc.model.d.ts

@@ -5,7 +5,8 @@ export declare enum JsonRpcErrorCodes {
     INVALID_PARAMS = -32602,
     INTERNAL_ERROR = -32603,
     INVALID_RESPONSE = -32001,
-    REQUEST_TIMEOUT = -32002
+    REQUEST_TIMEOUT = -32002,
+    REQUEST_FAILED = -32003
 }
 export declare class JsonRpcError {
     code: number;

package/lib/jsonrpc.model.js

@@ -1,8 +1,6 @@
-"use strict";
 /* tslint:disable:max-classes-per-file */
-Object.defineProperty(exports, "__esModule", { value: true });
 // See https://www.jsonrpc.org/specification for the protocol details
-var JsonRpcErrorCodes;
+export var JsonRpcErrorCodes;
 (function (JsonRpcErrorCodes) {
     JsonRpcErrorCodes[JsonRpcErrorCodes["PARSE_ERROR"] = -32700] = "PARSE_ERROR";
     JsonRpcErrorCodes[JsonRpcErrorCodes["INVALID_REQUEST"] = -32600] = "INVALID_REQUEST";
@@ -12,13 +10,11 @@ var JsonRpcErrorCodes;
     // App specific
     JsonRpcErrorCodes[JsonRpcErrorCodes["INVALID_RESPONSE"] = -32001] = "INVALID_RESPONSE";
     JsonRpcErrorCodes[JsonRpcErrorCodes["REQUEST_TIMEOUT"] = -32002] = "REQUEST_TIMEOUT";
-})(JsonRpcErrorCodes = exports.JsonRpcErrorCodes || (exports.JsonRpcErrorCodes = {}));
-class JsonRpcError {
+    JsonRpcErrorCodes[JsonRpcErrorCodes["REQUEST_FAILED"] = -32003] = "REQUEST_FAILED";
+})(JsonRpcErrorCodes || (JsonRpcErrorCodes = {}));
+export class JsonRpcError {
 }
-exports.JsonRpcError = JsonRpcError;
-class JsonRpcResponse {
+export class JsonRpcResponse {
 }
-exports.JsonRpcResponse = JsonRpcResponse;
-class JsonRpcRequest {
+export class JsonRpcRequest {
 }
-exports.JsonRpcRequest = JsonRpcRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsonrpc-client-websocket",
-  "version": "1.3.0",
+  "version": "1.5.1",
   "description": "A simple JSON RPC 2.0 websocket client",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -8,16 +8,17 @@
     "lib/**/*"
   ],
   "scripts": {
-    "test": "jest --config jestconfig.json",
+    "test": "jest",
     "coverage": "jest --config jestconfig.json --coverage",
     "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tsc --noEmit && eslint . --ext .js,.jsx,.ts,.tsx --fix",
     "prepublishOnly": "npm test && npm run lint",
     "prepare": "npm run build",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "postversion": "git push && git push --tags",
+    "updateAll": "npm-check-updates --upgrade"
   },
   "repository": {
     "type": "git",
@@ -37,18 +38,20 @@
   "author": "Fabricio Bastian",
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "^24.9.1",
-    "@typescript-eslint/eslint-plugin": "^2.27.0",
-    "@typescript-eslint/parser": "^2.27.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-plugin-jest": "^23.8.2",
-    "jest": "^24.9.0",
-    "jest-websocket-mock": "^1.5.1",
-    "mock-socket": "^8.1.1",
-    "prettier": "^1.19.1",
-    "ts-jest": "^24.3.0",
-    "typescript": "^3.8.3"
+    "@types/jest": "^27.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "eslint": "^8.3.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-jest": "^25.3.0",
+    "jest": "^27.3.1",
+    "jest-websocket-mock": "^2.2.1",
+    "mock-socket": "^9.0.8",
+    "npm-check-updates": "^12.0.2",
+    "prettier": "^2.5.0",
+    "ts-jest": "^27.0.7",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.2"
   },
   "dependencies": {
     "get-parameter-names": "^0.3.0"