@asyncswap/jsonrpc 0.3.1 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @asyncswap/jsonrpc
 
+## 0.5.0
+
+### Minor Changes
+
+- 7e8300c: changes api for jsonrpc contruction
+
+### Patch Changes
+
+- 43de065: update docs
+- 7126afa: add `otherHeaders` to inializedClient calls
+
 ## 0.3.1
 
 ### Patch Changes

package/README.md

@@ -41,12 +41,10 @@ console.log("JSON-RPC running on http://localhost:4444")
 ### RPC Client
 
 ```ts
-import { initializeRpcClient } from "@asyncswap/jsonrpc";
+
+import { JsonRpcClient } from "@asyncswap/jsonrpc";
 const url = "http://localhost:4444";
-const client = initializeRpcClient(url);
-const result = await client.call(
-  "ping",
-  []
-);
-console.log(result)
+const client = new JsonRpcClient(url);
+const result = await client.call("ping", []);
+console.log(result);
 ```

package/dist/client.d.ts

@@ -1,9 +1,15 @@
 export declare class JsonRpcClient {
-    private send;
+    private url;
     private id;
-    constructor(send: (req: JsonRpcRequest<unknown>) => Promise<JsonRpcResponse<unknown, number>>);
-    call<Method = string, Result = unknown, E = unknown>(method: Method, params?: unknown[]): Promise<Result | E>;
+    constructor(url: string);
+    call<Method = string, Result = unknown, E = unknown>(method: Method, params?: unknown[], headers?: Record<string, string>): Promise<Result | E>;
+    buildRequest<Method>(method: Method, params?: unknown[]): {
+        jsonrpc: "2.0";
+        method: Method;
+        params: unknown[];
+        id: number;
+    };
+    private request;
     notify<Method = string>(method: Method, params?: unknown[]): Promise<JsonRpcResponse<unknown, number>>;
 }
-export declare function initializeRpcClient(url: string, jwtToken?: string, timeout?: number): JsonRpcClient;
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAa;IAIxB,OAAO,CAAC,IAAI;IAHb,OAAO,CAAC,EAAE,CAAK;gBAGN,IAAI,EAAE,CACb,GAAG,EAAE,cAAc,CAAC,OAAO,CAAC,KACxB,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAGzC,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EACxD,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,OAAO,EAAE,GAChB,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IActB,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE;CAQ1D;AAED,wBAAgB,mBAAmB,CAClC,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,GAAE,MAAa,GACpB,aAAa,CA2Bf"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAa;IAGb,OAAO,CAAC,GAAG;IAFvB,OAAO,CAAC,EAAE,CAAK;gBAEK,GAAG,EAAE,MAAM;IAEzB,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EACxD,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,OAAO,EAAO,EACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC9B,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAatB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO;;;;;;YAS7C,OAAO;IA4BrB,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE;CAQ1D"}

package/dist/client.js

@@ -1,43 +1,35 @@
 export class JsonRpcClient {
-    send;
+    url;
     id = 0;
-    constructor(send) {
-        this.send = send;
+    constructor(url) {
+        this.url = url;
     }
-    async call(method, params) {
-        const request = {
-            jsonrpc: "2.0",
-            method,
-            params,
-            id: ++this.id,
-        };
-        const response = await this.send(request);
+    async call(method, params = [], headers) {
+        const request = this.buildRequest(method, params);
+        const response = await this.request(request, headers);
+        ++this.id;
         if ("error" in response) {
             return response.error;
         }
         return response.result;
     }
-    notify(method, params) {
-        const request = {
+    buildRequest(method, params = []) {
+        return {
             jsonrpc: "2.0",
             method,
             params,
+            id: this.id,
         };
-        return this.send(request);
     }
-}
-export function initializeRpcClient(url, jwtToken, timeout = 5000) {
-    const client = new JsonRpcClient(async (req) => {
+    async request(req, customHeaders, timeout = 5000) {
         const controller = new AbortController();
         const timeoutId = setTimeout(() => controller.abort(), timeout);
         try {
             const headers = {
                 "Content-Type": "application/json",
+                ...(customHeaders ?? {}),
             };
-            if (jwtToken) {
-                headers["Authorization"] = `Bearer ${jwtToken}`;
-            }
-            const res = await fetch(url, {
+            const res = await fetch(this.url, {
                 method: "POST",
                 headers,
                 body: JSON.stringify(req),
@@ -51,7 +43,14 @@ export function initializeRpcClient(url, jwtToken, timeout = 5000) {
             }
             throw err;
         }
-    });
-    return client;
+    }
+    notify(method, params) {
+        const request = {
+            jsonrpc: "2.0",
+            method,
+            params,
+        };
+        return this.request(request);
+    }
 }
 //# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,aAAa;IAIhB;IAHD,EAAE,GAAG,CAAC,CAAC;IAEf,YACS,IAEsC;QAFtC,SAAI,GAAJ,IAAI,CAEkC;IAC3C,CAAC;IAEL,KAAK,CAAC,IAAI,CACT,MAAc,EACd,MAAkB;QAElB,MAAM,OAAO,GAA2B;YACvC,OAAO,EAAE,KAAK;YACd,MAAM;YACN,MAAM;YACN,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE;SACb,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC,KAAU,CAAC;QAC5B,CAAC;QACD,OAAO,QAAQ,CAAC,MAAgB,CAAC;IAClC,CAAC;IAED,MAAM,CAAkB,MAAc,EAAE,MAAkB;QACzD,MAAM,OAAO,GAA2B;YACvC,OAAO,EAAE,KAAK;YACd,MAAM;YACN,MAAM;SACN,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CACD;AAED,MAAM,UAAU,mBAAmB,CAClC,GAAW,EACX,QAAiB,EACjB,UAAkB,IAAI;IAEtB,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,KAAK,EAAE,GAA4B,EAAE,EAAE;QACvE,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC;YACJ,MAAM,OAAO,GAA2B;gBACvC,cAAc,EAAE,kBAAkB;aAClC,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACd,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,QAAQ,EAAE,CAAC;YACjD,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC5B,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;aACzB,CAAC,CAAC;YAEH,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAqC,CAAC;QAC/D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,IAAI,CAAC,CAAC;YACnD,CAAC;YACD,MAAM,GAAG,CAAC;QACX,CAAC;IACF,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AACf,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,aAAa;IAGL;IAFZ,EAAE,GAAG,CAAC,CAAC;IAEf,YAAoB,GAAW;QAAX,QAAG,GAAH,GAAG,CAAQ;IAAI,CAAC;IAEpC,KAAK,CAAC,IAAI,CACT,MAAc,EACd,SAAoB,EAAE,EACtB,OAAgC;QAEhC,MAAM,OAAO,GAA2B,IAAI,CAAC,YAAY,CACxD,MAAM,EACN,MAAM,CACN,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACtD,EAAE,IAAI,CAAC,EAAE,CAAC;QACV,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC,KAAU,CAAC;QAC5B,CAAC;QACD,OAAO,QAAQ,CAAC,MAAgB,CAAC;IAClC,CAAC;IAED,YAAY,CAAS,MAAc,EAAE,SAAoB,EAAE;QAC1D,OAAO;YACN,OAAO,EAAE,KAAc;YACvB,MAAM;YACN,MAAM;YACN,EAAE,EAAE,IAAI,CAAC,EAAE;SACX,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CACpB,GAA4B,EAC5B,aAAsC,EACtC,UAAkB,IAAI;QAEtB,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC;YACJ,MAAM,OAAO,GAA2B;gBACvC,cAAc,EAAE,kBAAkB;gBAClC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC;aACxB,CAAC;YACF,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjC,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;aACzB,CAAC,CAAC;YAEH,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAqC,CAAC;QAC/D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,IAAI,CAAC,CAAC;YACnD,CAAC;YACD,MAAM,GAAG,CAAC;QACX,CAAC;IACF,CAAC;IAED,MAAM,CAAkB,MAAc,EAAE,MAAkB;QACzD,MAAM,OAAO,GAA2B;YACvC,OAAO,EAAE,KAAK;YACd,MAAM;YACN,MAAM;SACN,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACD"}

package/example.ts

@@ -22,9 +22,9 @@ Bun.serve({
 
 console.log("JSON-RPC running on http://localhost:4444");
 
-import { initializeRpcClient } from "./src";
+import { JsonRpcClient } from "./src";
 
 const url = "http://localhost:4444";
-const client = initializeRpcClient(url);
+const client = new JsonRpcClient(url);
 const result = await client.call("ping", []);
 console.log(result);

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@asyncswap/jsonrpc",
 	"description": "A minimal jsonrpc spec implementation.",
 	"author": "Meek Msaki",
-	"version": "0.3.1",
+	"version": "0.4.1",
 	"license": "MIT",
 	"main": "dist/index.js",
 	"module": "dist/index.mjs",

package/src/client.ts

@@ -1,55 +1,47 @@
 export class JsonRpcClient {
 	private id = 0;
 
-	constructor(
-		private send: (
-			req: JsonRpcRequest<unknown>,
-		) => Promise<JsonRpcResponse<unknown, number>>,
-	) { }
+	constructor(private url: string) { }
 
 	async call<Method = string, Result = unknown, E = unknown>(
 		method: Method,
-		params?: unknown[],
+		params: unknown[] = [],
+		headers?: Record<string, string>,
 	): Promise<Result | E> {
-		const request: JsonRpcRequest<Method> = {
-			jsonrpc: "2.0",
+		const request: JsonRpcRequest<Method> = this.buildRequest<Method>(
 			method,
 			params,
-			id: ++this.id,
-		};
-		const response = await this.send(request);
+		);
+		const response = await this.request(request, headers);
+		++this.id;
 		if ("error" in response) {
 			return response.error as E;
 		}
 		return response.result as Result;
 	}
 
-	notify<Method = string>(method: Method, params?: unknown[]) {
-		const request: JsonRpcRequest<Method> = {
-			jsonrpc: "2.0",
+	buildRequest<Method>(method: Method, params: unknown[] = []) {
+		return {
+			jsonrpc: "2.0" as const,
 			method,
 			params,
+			id: this.id,
 		};
-		return this.send(request);
 	}
-}
 
-export function initializeRpcClient(
-	url: string,
-	jwtToken?: string,
-	timeout: number = 5000,
-): JsonRpcClient {
-	const client = new JsonRpcClient(async (req: JsonRpcRequest<unknown>) => {
+	private async request(
+		req: JsonRpcRequest<unknown>,
+		customHeaders?: Record<string, string>,
+		timeout: number = 5000,
+	) {
 		const controller = new AbortController();
 		const timeoutId = setTimeout(() => controller.abort(), timeout);
 		try {
 			const headers: Record<string, string> = {
 				"Content-Type": "application/json",
+				...(customHeaders ?? {}),
 			};
-			if (jwtToken) {
-				headers["Authorization"] = `Bearer ${jwtToken}`;
-			}
-			const res = await fetch(url, {
+			const res = await fetch(this.url, {
 				method: "POST",
 				headers,
 				body: JSON.stringify(req),
@@ -63,6 +55,14 @@ export function initializeRpcClient(
 			}
 			throw err;
 		}
-	});
-	return client;
+	}
+
+	notify<Method = string>(method: Method, params?: unknown[]) {
+		const request: JsonRpcRequest<Method> = {
+			jsonrpc: "2.0",
+			method,
+			params,
+		};
+		return this.request(request);
+	}
 }