feat: add support for default timeout, onNotify, and onError

Support for default timeout is added to allow clients to set a timeout
for request being made. Default timeout is not set by default. Timeout
is disabled by setting the timeout to undefined and enabled by setting
the timeout to a number to specify the timeout parameter in ms.

onNotify is used to receive notifications and onError is used to
receive errors that can't be attributed to a specific request.

Author: zcstarr

templates/typescript/static/_package.json

@@ -13,7 +13,7 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "@open-rpc/client-js": "^1.1.1",
+    "@open-rpc/client-js": "^1.2.2",
     "@open-rpc/meta-schema": "^1.5.3",
     "@open-rpc/schema-utils-js": "^1.11.4",
     "lodash": "^4.17.15"

templates/typescript/templated/exported-class.template.ts

@@ -2,7 +2,7 @@ import { template } from "lodash";
 
 export default template(`
 // Code generated by @open-rpc/client-generator DO NOT EDIT.
-import { RequestManager, WebSocketTransport, HTTPTransport, Client } from '@open-rpc/client-js';
+import { RequestManager, WebSocketTransport, HTTPTransport, Client, JSONRPCError } from '@open-rpc/client-js';
 import _ from "lodash";
 import { OpenRPC, MethodObject, ContentDescriptorObject } from "@open-rpc/meta-schema";
 import { MethodCallValidator, MethodNotFoundError } from "@open-rpc/schema-utils-js";
@@ -23,6 +23,7 @@ export class <%= className %> {
   public static openrpcDocument: OpenRPC = <%= JSON.stringify(openrpcDocument) %> ;
   public transport: HTTPTransport | WebSocketTransport;
   private validator: MethodCallValidator;
+  private timeout: number | undefined;
 
   constructor(options: Options) {
 
@@ -49,6 +50,36 @@ export class <%= className %> {
     this.rpc = new Client(new RequestManager([this.transport]));
     this.validator = new MethodCallValidator(<%= className %>.openrpcDocument);
   }
+  /**
+   * Adds a JSONRPC notification handler to handle receiving notifications.
+   * @example
+   * myClient.onNotification((data)=>console.log(data));
+   */
+  public onNotification(callback: (data: any) => void) {
+    this.rpc.onNotification(callback);
+  }
+
+  /**
+   * Adds an optional JSONRPCError handler to handle receiving errors that cannot be resolved to a specific request
+   * @example
+   * myClient.onError((err: JSONRPCError)=>console.log(err.message));
+   */
+  public onError(callback: (data: JSONRPCError) => void) {
+     this.rpc.onError(callback);
+  }
+
+  /**
+   * Sets a default timeout in ms for all requests excluding notifications. 
+   * @example
+   * // 20s timeout
+   * myClient.setDefaultTimeout(20000);
+   * // Removes timeout from request
+   * myClient.setDefaultTimeout(undefined);
+   */
+   public setDefaultTimeout(ms?: number) {
+    this.timeout = ms;
+  }
+
 
   /**
    * Initiates [[<%= className %>.startBatch]] in order to build a batch call.
@@ -85,6 +116,7 @@ export class <%= className %> {
 
   private request(methodName: string, params: any[]): Promise<any> {
     const methodObject = _.find(<%= className %>.openrpcDocument.methods, ({name}) => name === methodName) as MethodObject;
+    const notification = methodObject.result ? false : true;
     const openRpcMethodValidationErrors = this.validator.validate(methodName, params);
     if ( openRpcMethodValidationErrors instanceof MethodNotFoundError || openRpcMethodValidationErrors.length > 0) {
       return Promise.reject(openRpcMethodValidationErrors);
@@ -96,13 +128,17 @@ export class <%= className %> {
     } else {
       rpcParams = params;
     }
-    return this.rpc.request(methodName, rpcParams);
+    if(notification) {
+      return this.rpc.notify(methodName, rpcParams);
+    }
+    return this.rpc.request(methodName, rpcParams, this.timeout);
   }
 
   <% openrpcDocument.methods.forEach((method) => { %>
   /**
    * <%= method.summary %>
    */
+  // tslint:disable-next-line:max-line-length
   public <%= method.name %>: <%= methodTypings.getTypingNames("typescript", method).method %> = (...params) => {
     return this.request("<%= method.name %>", params);
   }