@asyncswap/jsonrpc 0.4.7 → 0.4.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @asyncswap/jsonrpc
 
+## 0.4.9
+
+### Patch Changes
+
+- dc792b1: (refactor): change to `withHeaders` option and update BaseClient source
+
+## 0.4.8
+
+### Patch Changes
+
+- e9fc1df: remove biome dep
+
 ## 0.4.7
 
 ### Patch Changes

package/README.md

@@ -18,13 +18,13 @@ import { JsonRpcServer } from '@asyncswap/jsonrpc';
 const server = new JsonRpcServer();
 
 // Register methods
-server.register('add', ([a, b]: [number, number]) => a + b);
-server.register('ping', () => 'pong');
+server.register("eth_add", async ([a,b]: [number, number]) => a + b)
+server.register("eth_ping", async () => "pong")
 
 // Handle requests
 const response = await server.handle({
   jsonrpc: '2.0',
-  method: 'add',
+  method: 'eth_add',
   params: [2, 3],
   id: 1
 });
@@ -53,7 +53,7 @@ await client.notify('log', ['Hello world']);
 
 #### Methods
 
-- `register<Result>(method: string, handler: Handler<Result>)` - Register a method handler
+- `register<Method, Params, Result>(method: Method, handler: Handler<Params, Result>)` - Register a method handler
 - `handle(request: any)` - Process a JSON-RPC request
 
 ***Types***:
@@ -85,8 +85,8 @@ enum JsonRpcErrorCodes {
 
 #### Methods
 
-- `call<Result, Error>(request, headers?)` - Make a JSON-RPC call
-- `notify(method, params?)` - Send a JSON-RPC notification
+- `call(request, headers?)` - Make a JSON-RPC call
+- `notify(method: Method, params?)` - Send a JSON-RPC notification
 - `buildRequest(method, params?)` - Build a JSON-RPC request object
 
 ## Examples

package/dist/base.d.ts

@@ -0,0 +1,9 @@
+import { JsonRpcClient } from "./client";
+export type RpcSpecBase = Record<string, RpcMethodSpec>;
+export declare abstract class BaseClient<MethodsSpec extends RpcSpecBase> {
+    rpc: JsonRpcClient<MethodsSpec>;
+    protected headers: Record<string, string>;
+    constructor(url: string);
+    withHeaders(headers: Record<string, string>): this;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAExD,8BAAsB,UAAU,CAAC,WAAW,SAAS,WAAW;IAC/D,GAAG,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IAChC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;gBAEnC,GAAG,EAAE,MAAM;IA8BvB,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAM3C"}

package/dist/base.js

@@ -0,0 +1,36 @@
+import { JsonRpcClient } from "./client";
+export class BaseClient {
+    rpc;
+    headers = {};
+    constructor(url) {
+        this.rpc = new JsonRpcClient(url);
+        return new Proxy(this, {
+            get: (target, prop, receiver) => {
+                // let real properties / methods through
+                if (prop in target) {
+                    const value = Reflect.get(target, prop, receiver);
+                    if (typeof value === "function") {
+                        return (...args) => {
+                            const result = value.apply(target, args);
+                            // if method returns target, return proxy instead
+                            return result === target ? receiver : result;
+                        };
+                    }
+                    return value;
+                }
+                // dynamic rpc
+                if (typeof prop !== "string")
+                    return undefined;
+                const method = prop;
+                return (...params) => this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
+            },
+        });
+    }
+    withHeaders(headers) {
+        this.headers = {
+            ...headers,
+        };
+        return this;
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAIzC,MAAM,OAAgB,UAAU;IAC/B,GAAG,CAA6B;IACtB,OAAO,GAA2B,EAAE,CAAC;IAE/C,YAAY,GAAW;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;QAElC,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE;YACtB,GAAG,EAAE,CAAC,MAAY,EAAE,IAAqB,EAAE,QAAQ,EAAE,EAAE;gBACtD,wCAAwC;gBACxC,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;oBACpB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;oBAClD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;wBACjC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;4BACzB,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;4BACzC,iDAAiD;4BACjD,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;wBAC9C,CAAC,CAAC;oBACH,CAAC;oBACD,OAAO,KAAK,CAAC;gBACd,CAAC;gBACD,cAAc;gBACd,IAAI,OAAO,IAAI,KAAK,QAAQ;oBAAE,OAAO,SAAS,CAAC;gBAE/C,MAAM,MAAM,GAAG,IAAyB,CAAC;gBAEzC,OAAO,CACN,GAAG,MAA4C,EACR,EAAE,CACzC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACrE,CAAC;SACD,CAAC,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,OAA+B;QAC1C,IAAI,CAAC,OAAO,GAAG;YACd,GAAG,OAAO;SACV,CAAC;QACF,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./base";
 export * from "./client";
 export * from "./error";
 export * from "./server";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from "./base";
 export * from "./client";
 export * from "./error";
 export * from "./server";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/example.ts

@@ -2,8 +2,8 @@ import { JsonRpcServer } from "./src";
 
 const server = new JsonRpcServer();
 
-server.register("add", async ([a, b]: [number, number]) => a + b);
-server.register("ping", async () => "pong");
+server.register("eth_add", async ([a, b]: [number, number]) => a + b);
+server.register("eth_ping", async () => "pong");
 
 Bun.serve({
 	port: 4444,
@@ -26,5 +26,14 @@ import { JsonRpcClient } from "./src";
 
 const url = "http://localhost:4444";
 const client = new JsonRpcClient(url);
-const result = await client.call(client.buildRequest("ping", []));
-console.log(result);
+const result = await client.call(client.buildRequest("eth_ping", []));
+console.log(result); // pong
+
+const response = await server.handle({
+	jsonrpc: "2.0",
+	method: "eth_add",
+	params: [2, 3],
+	id: 1,
+});
+
+console.log(response); // { jsonrpc: '2.0', result: 5, id: 1 }

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@asyncswap/jsonrpc",
 	"description": "A minimal jsonrpc spec implementation.",
 	"author": "Meek Msaki",
-	"version": "0.4.7",
+	"version": "0.4.9",
 	"license": "MIT",
 	"main": "dist/index.js",
 	"module": "dist/index.mjs",
@@ -32,7 +32,6 @@
 		"format": "bun biome format --write"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "2.3.11",
 		"@types/bun": "latest"
 	},
 	"peerDependencies": {

package/src/base.ts

@@ -0,0 +1,45 @@
+import { JsonRpcClient } from "./client";
+
+export type RpcSpecBase = Record<string, RpcMethodSpec>;
+
+export abstract class BaseClient<MethodsSpec extends RpcSpecBase> {
+	rpc: JsonRpcClient<MethodsSpec>;
+	protected headers: Record<string, string> = {};
+
+	constructor(url: string) {
+		this.rpc = new JsonRpcClient(url);
+
+		return new Proxy(this, {
+			get: (target: this, prop: string | symbol, receiver) => {
+				// let real properties / methods through
+				if (prop in target) {
+					const value = Reflect.get(target, prop, receiver);
+					if (typeof value === "function") {
+						return (...args: any[]) => {
+							const result = value.apply(target, args);
+							// if method returns target, return proxy instead
+							return result === target ? receiver : result;
+						};
+					}
+					return value;
+				}
+				// dynamic rpc
+				if (typeof prop !== "string") return undefined;
+
+				const method = prop as keyof MethodsSpec;
+
+				return (
+					...params: MethodsSpec[typeof method]["params"]
+				): MethodsSpec[typeof method]["result"] =>
+					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
+			},
+		});
+	}
+
+	withHeaders(headers: Record<string, string>) {
+		this.headers = {
+			...headers,
+		};
+		return this;
+	}
+}

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from "./base";
 export * from "./client";
 export * from "./error";
 export * from "./server";

package/tsconfig.json

@@ -1,9 +1,7 @@
 {
 	"compilerOptions": {
 		// Environment setup & latest features
-		"lib": [
-			"ESNext"
-		],
+		"lib": ["ESNext"],
 		"target": "ESNext",
 		"module": "Preserve",
 		"moduleDetection": "force",
@@ -30,11 +28,6 @@
 		"noUnusedParameters": false,
 		"noPropertyAccessFromIndexSignature": false
 	},
-	"include": [
-		"src/**/*",
-		"global.d.ts"
-	],
-	"exclude": [
-		"example.ts"
-	]
+	"include": ["src/**/*", "global.d.ts"],
+	"exclude": ["example.ts"]
 }