@trenskow/rpc 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2025 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,57 @@
+@trenskow/rpc
+----
+
+A simple RPC server and client for JavaScript.
+
+# Usage
+
+Below is an example on how to use.
+
+> The transport layer must be provided with a message sender and receiver.
+> In this example we just use an imaginary method called `onDidReceiveMessage(data)` to receive data.
+> Then we use another imaginary method called `sendMessage(data)` to send data.
+
+## Server
+
+````javascript
+import rpc from '@trenskow/rpc';
+
+const server = rpc.serve(
+  {
+    hello: async (name) => {
+      return `Hello, ${name}!.`;
+    },
+    /* Other methods available. */
+  },
+  (command, data) => {
+    sendMessage({ command, data });
+  }
+);
+
+onDidReceiveMessage(({ command, data }) => {
+  server.onMessage(command, data);
+});
+
+````
+
+## Client
+
+````javascript
+import rpc from '@trenskow/rpc';
+
+const client = rpc.connect(
+  (command, data) => {
+    sendMessage({ command, data })
+  }
+);
+
+await client.remote.hello('World'); // Returns 'Hello, World!'
+
+onDidReceiveMessage({ command, data }) => {
+  client.onMessage(command, data);
+});
+````
+
+# License
+
+See license in LICENSE.

package/eslint.config.js

@@ -0,0 +1,55 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+
+export default [...compat.extends('eslint:recommended'), {
+	languageOptions: {
+		globals: {
+			...globals.node,
+			...globals.mocha,
+		},
+
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+
+	rules: {
+		indent: ['error', 'tab', {
+			SwitchCase: 1,
+		}],
+
+		'linebreak-style': ['error', 'unix'],
+		quotes: ['error', 'single'],
+		semi: ['error', 'always'],
+
+		'no-console': ['error', {
+			allow: ['warn', 'error', 'info'],
+		}],
+
+		'no-unused-vars': ['error', {
+			argsIgnorePattern: '^_',
+		}],
+
+		'no-empty': ['error', {
+			allowEmptyCatch: true,
+		}],
+
+		'no-trailing-spaces': ['error', {
+			ignoreComments: true,
+		}],
+
+		'require-atomic-updates': 'off',
+		'no-implicit-globals': ['error'],
+		'eol-last': ['error', 'always'],
+	},
+}];

package/index.d.ts

@@ -0,0 +1,62 @@
+//
+// index.d.ts
+// 0-bit-games-frontend-vscode
+//
+// Created by Kristian Trenskow on 2025/12/21
+// See license in LICENSE.
+//
+
+type MessageSender = (command: string, data: any) => void;
+
+export interface RPC<D> {
+
+	sender: MessageSender;
+
+	onMessage(
+		command: string,
+		data: D
+	): void;
+
+}
+
+export class Server<T extends object> extends RPC<any[]> {
+
+	private readonly local: T;
+	
+	constructor(
+		local: T,
+		sender?: MessageSender
+	)
+
+};
+
+interface ClientOptions {
+	timeout?: number;
+}
+
+export class Client<T extends object> extends RPC<any> {
+
+	readonly remote: T;
+
+	sender: MessageSender;
+
+	constructor(
+		sender?: MessageSender,
+		options?: ClientOptions
+	)
+
+}
+
+function serve<T extends object>(
+	handler: T,
+	sender: MessageSender
+): Server<T>;
+
+function connect<T extends object>(
+	sender: MessageSender
+): Client<T>;
+
+export default {
+	serve,
+	connect
+};

package/index.js

@@ -0,0 +1,12 @@
+//
+// index.js
+// 0-bit-games-frontend-vscode
+//
+// Created by Kristian Trenskow on 2025/12/21
+// See license in LICENSE.
+//
+
+import rpc, { Server, Client } from './lib/index.js';
+
+export default rpc;
+export { Server, Client };

package/lib/index.js

@@ -0,0 +1,166 @@
+//
+// index.js
+// 0-bit-games-frontend-vscode
+//
+// Created by Kristian Trenskow on 2025/12/21
+// See license in LICENSE.
+//
+
+import { deflate, inflate } from '@trenskow/json-compressor';
+
+export class Server {
+
+	constructor(
+		local,
+		sender
+	) {
+
+		this.sender = sender;
+
+		this._local = local;
+
+	}
+
+	get local() {
+		return this._local;
+	}
+
+	onMessage(
+		command,
+		...data
+	) {
+
+		const parts = command.split(':');
+
+		if (parts[0] !== 'call') {
+			return;
+		}
+
+		const identifier = parts[1];
+
+		const methodName = parts[2];
+
+		const method = this._local[methodName];
+
+		if (typeof method !== 'function') {
+			console.warn(`RPC: Method ${methodName} is not a function on the handler.`);
+			return;
+		}
+
+		Promise.resolve(
+			method(...inflate(data))
+		).then((result) => {
+			this.sender(
+				`response:${identifier}`,
+				deflate(result)
+			);
+		}).catch((error) => {
+			this.sender(
+				`error:${identifier}`,
+				deflate(error?.toString() ?? 'Unknown error')
+			);
+		});
+
+	}
+
+};
+
+export class Client {
+
+	constructor(
+		sender,
+		options = {}
+	) {
+
+		this.sender = sender;
+
+		this._responses = new Map();
+		this._identifierCounter = 0;
+		this._options = options;
+
+	}
+
+	get remote() {
+		return new Proxy({}, {
+			get: (_target, prop) => {
+				return (...args) => {
+
+					const identifier = (this._identifierCounter++).toString();
+
+					return new Promise((resolve, reject) => {
+
+						this._responses.set(
+							identifier, {
+								resolve,
+								reject,
+								timeout: setTimeout(() => {
+									this._responses.delete(identifier);
+									reject(new Error(`RPC: Timeout waiting for response for identifier ${identifier}.`));
+								}, this._options.timeout ?? 5000)
+							});
+
+						this.sender(
+							`call:${identifier}:${String(prop)}`,
+							deflate(args)
+						);
+
+					});
+
+				};
+			}
+		});
+	}
+
+	onMessage(
+		command,
+		data
+	) {
+
+		const parts = command.split(':');
+
+		const type = parts[0];
+		const identifier = parts[1];
+
+		if (type !== 'response' && type !== 'error') {
+			return;
+		}
+
+		const responseHandler = this._responses.get(identifier);
+
+		clearTimeout(responseHandler.timeout);
+
+		if (!responseHandler) {
+			console.warn(`RPC: No response handler found for identifier ${identifier}.`);
+			return;
+		}
+
+		this._responses.delete(identifier);
+
+		data = inflate(data);
+
+		if (type === 'response') {
+			responseHandler.resolve(data);
+		} else if (type === 'error') {
+			responseHandler.reject(new Error(data));
+		}
+
+	}
+
+}
+
+export default {
+	serve: function(
+		handler,
+		sender
+	) {
+		return new Server(
+			handler,
+			sender);
+	},
+	connect: function(
+		sender
+	) {
+		return new Client(
+			sender);
+	}
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "@trenskow/rpc",
+	"version": "0.1.0",
+	"description": "A simple RPC server and client for JavaScript.",
+	"keywords": [
+		"rpc",
+		"json"
+	],
+	"homepage": "https://github.com/trenskow/rpc#readme",
+	"bugs": {
+		"url": "https://github.com/trenskow/rpc/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/trenskow/rpc.git"
+	},
+	"license": "BSD-2-Clause",
+	"author": "Kristian Trenskow <this.is@kristians.email>",
+	"type": "module",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"devDependencies": {
+		"@eslint/eslintrc": "^3.3.3",
+		"@eslint/js": "^9.39.2",
+		"eslint": "^9.39.2",
+		"globals": "^16.5.0"
+	},
+	"dependencies": {
+		"@trenskow/json-compressor": "^0.1.2"
+	}
+}