@msaki/jsonrpc 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @msaki/jsonrpc
+
+## 0.3.0
+
+### Minor Changes
+
+- dc1718c: refactor of types dir to global types
+- 00ba692: - Converts error codes as enums
+  - Uses generic types on rpc request and response methods, and results
+- 07dc4e5: improve docs example and updates to build config
+
+### Patch Changes
+
+- e15733c: update scripts and make changeset in monorepo
+- e3ac747: patch
+- abddcdc: add source map to typescript build build
+- ded3e6b: update

package/README.md

@@ -35,7 +35,7 @@ Bun.serve({
   }
 })
 
-console.log("JSON-RPC sever on http://localhost:4444")
+console.log("JSON-RPC running on http://localhost:4444")
 ```
 
 ### RPC Client

package/dist/client.d.ts

@@ -5,5 +5,5 @@ export declare class JsonRpcClient {
     call<Method = string, Result = unknown, E = unknown>(method: Method, params?: unknown[]): Promise<Result | E>;
     notify<Method = string>(method: Method, params?: unknown[]): Promise<JsonRpcResponse<unknown, number>>;
 }
-export declare function initializeRpcClient(url: string, jwtToken?: string): JsonRpcClient;
+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,GACf,aAAa,CAiBf"}
+{"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"}

package/dist/client.js

@@ -26,20 +26,31 @@ export class JsonRpcClient {
         return this.send(request);
     }
 }
-export function initializeRpcClient(url, jwtToken) {
+export function initializeRpcClient(url, jwtToken, timeout = 5000) {
     const client = new JsonRpcClient(async (req) => {
-        const headers = {
-            "Content-Type": "application/json",
-        };
-        if (jwtToken) {
-            headers["Authorization"] = `Bearer ${jwtToken}`;
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), timeout);
+        try {
+            const headers = {
+                "Content-Type": "application/json",
+            };
+            if (jwtToken) {
+                headers["Authorization"] = `Bearer ${jwtToken}`;
+            }
+            const res = await fetch(url, {
+                method: "POST",
+                headers,
+                body: JSON.stringify(req),
+            });
+            return (await res.json());
+        }
+        catch (err) {
+            clearTimeout(timeoutId);
+            if (err instanceof Error && err.name === "AbortError") {
+                throw new Error(`Req timeout after ${timeout}ms`);
+            }
+            throw err;
         }
-        const res = await fetch(url, {
-            method: "POST",
-            headers,
-            body: JSON.stringify(req),
-        });
-        return (await res.json());
     });
     return client;
 }

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;IAEjB,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,KAAK,EAAE,GAA4B,EAAE,EAAE;QACvE,MAAM,OAAO,GAA2B;YACvC,cAAc,EAAE,kBAAkB;SAClC,CAAC;QACF,IAAI,QAAQ,EAAE,CAAC;YACd,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,QAAQ,EAAE,CAAC;QACjD,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAC5B,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAqC,CAAC;IAC/D,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;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"}

package/example.ts

@@ -0,0 +1,30 @@
+import { JsonRpcServer } from "./src";
+
+const server = new JsonRpcServer();
+
+server.register("add", ([a, b]: [number, number]) => a + b);
+server.register("ping", () => "pong");
+
+Bun.serve({
+	port: 4444,
+	async fetch(req) {
+		if (req.method !== "POST") {
+			return new Response("JSON-RPC only", { status: 405 });
+		}
+		const payload = await req.json();
+		const response = await server.handle(payload);
+		if (!response) {
+			return new Response(null, { status: 204 });
+		}
+		return Response.json(response);
+	},
+});
+
+console.log("JSON-RPC running on http://localhost:4444");
+
+import { initializeRpcClient } from "./src";
+
+const url = "http://localhost:4444";
+const client = initializeRpcClient(url);
+const result = await client.call("ping", []);
+console.log(result);

package/global.d.ts

@@ -0,0 +1,3 @@
+declare global { }
+
+export { };

package/package.json

@@ -1,30 +1,26 @@
 {
 	"name": "@msaki/jsonrpc",
-	"description": "A minimal jsonrpc server, and client implementation.",
+	"description": "A minimal jsonrpc spec implementation.",
 	"author": "Meek Msaki",
-	"version": "0.2.2",
+	"version": "0.3.0",
 	"license": "MIT",
 	"main": "dist/index.js",
 	"module": "dist/index.mjs",
 	"types": "dist/index.d.ts",
-	"files": [
-		"dist",
-		"src"
-	],
 	"keywords": [
 		"jsonrpc",
 		"2.0",
 		"rpc",
 		"bun"
 	],
-	"homepage": "https://github.com/mmsaki/libs/tree/main/packages/jsonrpc",
+	"homepage": "https://github.com/mmsaki/eth-libs/tree/main/packages/jsonrpc",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/mmsaki/libs.git",
+		"url": "git+https://github.com/mmsaki/eth-libs.git",
 		"directory": "packages/jsonrpc"
 	},
 	"bugs": {
-		"url": "https://github.com/mmsaki/libs/issues"
+		"url": "https://github.com/mmsaki/eth-libs/issues"
 	},
 	"publishConfig": {
 		"access": "public",

package/src/client.ts

@@ -37,21 +37,32 @@ export class JsonRpcClient {
 export function initializeRpcClient(
 	url: string,
 	jwtToken?: string,
+	timeout: number = 5000,
 ): JsonRpcClient {
 	const client = new JsonRpcClient(async (req: JsonRpcRequest<unknown>) => {
-		const headers: Record<string, string> = {
-			"Content-Type": "application/json",
-		};
-		if (jwtToken) {
-			headers["Authorization"] = `Bearer ${jwtToken}`;
-		}
-		const res = await fetch(url, {
-			method: "POST",
-			headers,
-			body: JSON.stringify(req),
-		});
+		const controller = new AbortController();
+		const timeoutId = setTimeout(() => controller.abort(), timeout);
+		try {
+			const headers: Record<string, string> = {
+				"Content-Type": "application/json",
+			};
+			if (jwtToken) {
+				headers["Authorization"] = `Bearer ${jwtToken}`;
+			}
+			const res = await fetch(url, {
+				method: "POST",
+				headers,
+				body: JSON.stringify(req),
+			});
 
-		return (await res.json()) as JsonRpcResponse<unknown, number>;
+			return (await res.json()) as JsonRpcResponse<unknown, number>;
+		} catch (err) {
+			clearTimeout(timeoutId);
+			if (err instanceof Error && err.name === "AbortError") {
+				throw new Error(`Req timeout after ${timeout}ms`);
+			}
+			throw err;
+		}
 	});
 	return client;
 }

package/tsconfig.json

@@ -0,0 +1,40 @@
+{
+	"compilerOptions": {
+		// Environment setup & latest features
+		"lib": [
+			"ESNext"
+		],
+		"target": "ESNext",
+		"module": "Preserve",
+		"moduleDetection": "force",
+		"jsx": "react-jsx",
+		"allowJs": true,
+		// Bundler mode
+		"sourceMap": true,
+		"declaration": true,
+		"declarationMap": true,
+		"moduleResolution": "bundler",
+		"outDir": "dist",
+		"rootDir": "src",
+		"allowImportingTsExtensions": false,
+		"verbatimModuleSyntax": true,
+		"noEmit": false,
+		// Best practices
+		"strict": true,
+		"skipLibCheck": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedIndexedAccess": true,
+		"noImplicitOverride": true,
+		// Some stricter flags (disabled by default)
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+		"noPropertyAccessFromIndexSignature": false
+	},
+	"include": [
+		"src/**/*",
+		"global.d.ts"
+	],
+	"exclude": [
+		"example.ts"
+	]
+}