kkrpc 0.0.4 → 0.0.6

package/.turbo/turbo-test.log

@@ -1,51 +1,51 @@
 
 
-> kkrpc@ test /Users/hacker/Dev/projects/kkrpc/packages/kkrpc
+> kkrpc@0.0.5 test /Users/hacker/Dev/projects/kkrpc/packages/kkrpc
 > bun run scripts/test.ts
 
 Check file:///Users/hacker/Dev/projects/kkrpc/packages/kkrpc/__deno_tests__/deno-web-worker.test.ts
+Check file:///Users/hacker/Dev/projects/kkrpc/packages/kkrpc/__tests__/scripts/worker.ts
 running 1 test from ./__deno_tests__/deno-web-worker.test.ts
-Call Worker Exposed API ...Check file:///Users/hacker/Dev/projects/kkrpc/packages/kkrpc/__tests__/scripts/worker.ts
- ok (538ms)
+Call Worker Exposed API ... ok (377ms)
 
-ok | 1 passed | 0 failed (541ms)
+ok | 1 passed | 0 failed (379ms)
 
 bun test v1.1.34 (5e5e7c60)
 
 __tests__/http.test.ts:
-(pass) HTTP RPC > echo service [4.72ms]
-(pass) HTTP RPC > math operations [0.81ms]
-(pass) HTTP RPC > concurrent calls [0.74ms]
-(pass) HTTP RPC > stress test with concurrent calls [220.99ms]
-(pass) HTTP RPC > error handling - invalid endpoint [0.85ms]
-(pass) HTTP RPC > error handling - wrong method [0.30ms]
+(pass) HTTP RPC > echo service [4.33ms]
+(pass) HTTP RPC > math operations [1.16ms]
+(pass) HTTP RPC > concurrent calls [0.59ms]
+(pass) HTTP RPC > stress test with concurrent calls [200.21ms]
+(pass) HTTP RPC > error handling - invalid endpoint [0.38ms]
+(pass) HTTP RPC > error handling - wrong method [0.48ms]
 
 __tests__/websocket.test.ts:
-(pass) WebSocket RPC [32.65ms]
-(pass) WebSocket concurrent connections [2.86ms]
+(pass) WebSocket RPC [26.99ms]
+(pass) WebSocket concurrent connections [2.45ms]
 
 __tests__/bun.worker.test.ts:
-(pass) Bun Worker [33.52ms]
+(pass) Bun Worker [35.24ms]
 
 __tests__/stdio-rpc.test.ts:
-(pass) RPCChannel Test > DenoStdio [483.69ms]
-(pass) RPCChannel Test > NodeStdio [374.62ms]
+(pass) RPCChannel Test > DenoStdio [463.95ms]
+(pass) RPCChannel Test > NodeStdio [339.55ms]
 
 __tests__/serialization.test.ts:
-(pass) Serializer > should serialize and deserialize a message [0.16ms]
-(pass) Serializer > should serialize and deserialize a response [1.69ms]
+(pass) Serializer > should serialize and deserialize a message [0.38ms]
+(pass) Serializer > should serialize and deserialize a response [0.17ms]
 ---------------------------|---------|---------|-------------------
 File                       | % Funcs | % Lines | Uncovered Line #s
 ---------------------------|---------|---------|-------------------
-All files                  |   78.63 |   70.89 |
- __tests__/scripts/api.ts  |   80.00 |   94.74 | 
+All files                  |   77.97 |   70.24 |
+ __tests__/scripts/api.ts  |   72.73 |   87.50 | 24,41-42
  mod.ts                    |  100.00 |  100.00 | 
  src/adapters/deno.ts      |    0.00 |   20.00 | 13-28,32-35
  src/adapters/http.ts      |  100.00 |  100.00 | 
  src/adapters/node.ts      |   84.62 |   91.43 | 25,42-43
  src/adapters/websocket.ts |   77.27 |    1.61 | 3-124
  src/adapters/worker.ts    |   50.00 |    1.77 | 3-113
- src/channel.ts            |   73.08 |   88.39 | 42,159,178-184,213-219,251-252
+ src/channel.ts            |   73.08 |   88.54 | 46,164,183-189,218-224,256-257
  src/interface.ts          |  100.00 |  100.00 | 
  src/serialization.ts      |  100.00 |   81.82 | 28-29,46-47
  src/utils.ts              |  100.00 |  100.00 | 
@@ -54,4 +54,4 @@ All files                  |   78.63 |   70.89 |
  13 pass
  0 fail
  14640 expect() calls
-Ran 13 tests across 5 files. [1205.00ms]
+Ran 13 tests across 5 files. [1118.00ms]

package/README.md

@@ -1,8 +1,17 @@
 # kkrpc
 
+[![NPM Version](https://img.shields.io/npm/v/kkrpc)](https://www.npmjs.com/package/kkrpc)
+![JSR Version](https://img.shields.io/jsr/v/kunkun/kkrpc)
+![GitHub last commit](https://img.shields.io/github/last-commit/kunkunsh/kkrpc)
+
 > A TypeScript-first RPC library that enables seamless bi-directional communication between processes.
 > Call remote functions as if they were local, with full TypeScript type safety and autocompletion support.
 
+- [JSR Package](https://jsr.io/@kunkun/kkrpc)
+- [NPM Package](https://www.npmjs.com/package/kkrpc)
+- [Documentation by JSR](https://jsr.io/@kunkun/kkrpc/doc)
+- [Typedoc Documentation](https://kunkunsh.github.io/kkrpc/)
+
 ## Supported Environments
 
 - stdio: RPC over stdio between any combinations of Node.js, Deno, Bun processes
@@ -49,15 +58,15 @@ import { NodeIo, RPCChannel } from "kkrpc"
 import { apiMethods } from "./api.ts"
 
 const stdio = new NodeIo(process.stdin, process.stdout)
-const child = new RPCChannel(stdio, apiMethods)
+const child = new RPCChannel(stdio, { expose: apiMethods })
 ```
 
 ```ts
 import { spawn } from "child_process"
 
-const workerBun = spawn("bun", ["scripts/node-api.ts"])
+const worker = spawn("bun", ["scripts/node-api.ts"])
 const io = new NodeIo(worker.stdout, worker.stdin)
-const parent = new RPCChannel<{}, API>(io, {})
+const parent = new RPCChannel<{}, API>(io)
 const api = parent.getAPI()
 
 expect(await api.add(1, 2)).toBe(3)
@@ -70,7 +79,7 @@ import { RPCChannel, WorkerChildIO, type DestroyableIoInterface } from "kkrpc"
 
 const worker = new Worker(new URL("./scripts/worker.ts", import.meta.url).href, { type: "module" })
 const io = new WorkerChildIO(worker)
-const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, apiMethods)
+const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, { expose: apiMethods })
 const api = rpc.getAPI()
 
 expect(await api.add(1, 2)).toBe(3)
@@ -80,7 +89,7 @@ expect(await api.add(1, 2)).toBe(3)
 import { RPCChannel, WorkerParentIO, type DestroyableIoInterface } from "kkrpc"
 
 const io: DestroyableIoInterface = new WorkerChildIO()
-const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, apiMethods)
+const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, { expose: apiMethods })
 const api = rpc.getAPI()
 
 const sum = await api.add(1, 2)
@@ -121,7 +130,7 @@ import { HTTPServerIO, RPCChannel } from "kkrpc"
 import { api, type API } from "./api"
 
 const serverIO = new HTTPServerIO()
-const serverRPC = new RPCChannel<API, API>(serverIO, api)
+const serverRPC = new RPCChannel<API, API>(serverIO, { expose: api })
 
 const server = Bun.serve({
 	port: 3000,
@@ -148,7 +157,7 @@ import { api, type API } from "./api"
 const clientIO = new HTTPClientIO({
 	url: "http://localhost:3000/rpc"
 })
-const clientRPC = new RPCChannel<{}, API>(clientIO, api)
+const clientRPC = new RPCChannel<{}, API>(clientIO, { expose: api })
 const clientAPI = clientRPC.getAPI()
 
 const echoResponse = await clientAPI.echo("hello")

package/__deno_tests__/deno-web-worker.test.ts

@@ -11,7 +11,7 @@ const worker = new Worker(new URL("../__tests__/scripts/worker.ts", import.meta.
 	type: "module"
 })
 const io = new WorkerParentIO(worker)
-const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, apiMethods)
+const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, { expose: apiMethods })
 const api = rpc.getAPI()
 
 Deno.test("Call Worker Exposed API", async () => {

package/__tests__/bun.worker.test.ts

@@ -4,7 +4,7 @@ import { apiMethods, type API } from "./scripts/api.ts"
 
 const worker = new Worker(new URL("./scripts/worker.ts", import.meta.url).href, { type: "module" })
 const io = new WorkerParentIO(worker)
-const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, apiMethods)
+const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, { expose: apiMethods })
 const api = rpc.getAPI()
 
 test("Bun Worker", async () => {

package/__tests__/http.test.ts

@@ -15,7 +15,7 @@ describe("HTTP RPC", () => {
 	beforeAll(() => {
 		// Create server
 		serverIO = new HTTPServerIO()
-		serverRPC = new RPCChannel<API, API>(serverIO, apiMethods)
+		serverRPC = new RPCChannel<API, API>(serverIO, { expose: apiMethods })
 
 		server = Bun.serve({
 			port: 3000,
@@ -36,7 +36,7 @@ describe("HTTP RPC", () => {
 		clientIO = new HTTPClientIO({
 			url: "http://localhost:3000/rpc"
 		})
-		const clientRPC = new RPCChannel<API, API>(clientIO, apiMethods)
+		const clientRPC = new RPCChannel<API, API>(clientIO, { expose: apiMethods })
 		api = clientRPC.getAPI()
 	})
 

package/__tests__/scripts/deno-api.ts

@@ -2,4 +2,4 @@ import { DenoIo, RPCChannel } from "../../mod.ts"
 import { apiMethods } from "./api.ts"
 
 const io = new DenoIo(Deno.stdin.readable, Deno.stdout.writable)
-const child = new RPCChannel(io, apiMethods)
+const child = new RPCChannel(io, { expose: apiMethods })

package/__tests__/scripts/node-api.ts

@@ -2,4 +2,4 @@ import { NodeIo, RPCChannel } from "../../mod.ts"
 import { apiMethods } from "./api.ts"
 
 const stdio = new NodeIo(process.stdin, process.stdout)
-const child = new RPCChannel(stdio, apiMethods)
+const child = new RPCChannel(stdio, { expose: apiMethods })

package/__tests__/scripts/worker.ts

@@ -2,7 +2,7 @@ import { RPCChannel, WorkerChildIO, type DestroyableIoInterface } from "../../mo
 import { apiMethods, type API } from "./api.ts"
 
 const io: DestroyableIoInterface = new WorkerChildIO()
-const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, apiMethods)
+const rpc = new RPCChannel<API, API, DestroyableIoInterface>(io, { expose: apiMethods })
 const api = rpc.getAPI()
 
 // const randInt1 = Math.floor(Math.random() * 100)

package/__tests__/stdio-rpc.test.ts

@@ -21,7 +21,7 @@ async function runWorker(worker: ChildProcessWithoutNullStreams) {
 
 	// const stdio = createStdio();
 	const io = new NodeIo(worker.stdout, worker.stdin)
-	const rpc = new RPCChannel<{}, API>(io, {})
+	const rpc = new RPCChannel<{}, API>(io)
 	const api = rpc.getAPI()
 
 	expect(await api.add(1, 2)).toEqual(3)

package/__tests__/websocket.test.ts

@@ -16,7 +16,7 @@ beforeAll(() => {
 	// Handle WebSocket connections
 	wss.on("connection", (ws: WebSocket) => {
 		const serverIO = new WebSocketServerIO(ws)
-		serverRPC = new RPCChannel<API, API>(serverIO, apiMethods)
+		serverRPC = new RPCChannel<API, API>(serverIO, { expose: apiMethods })
 	})
 })
 
@@ -29,7 +29,9 @@ test("WebSocket RPC", async () => {
 		url: `ws://localhost:${PORT}`
 	})
 
-	const clientRPC = new RPCChannel<API, API, DestroyableIoInterface>(clientIO, apiMethods)
+	const clientRPC = new RPCChannel<API, API, DestroyableIoInterface>(clientIO, {
+		expose: apiMethods
+	})
 	const api = clientRPC.getAPI()
 
 	// Test individual calls
@@ -70,7 +72,7 @@ test("WebSocket RPC", async () => {
 // 		url: `ws://localhost:${invalidPort}`
 // 	})
 
-// 	const clientRPC = new RPCChannel<{}, API, DestroyableIoInterface>(clientIO, {})
+// 	const clientRPC = new RPCChannel<{}, API, DestroyableIoInterface>(clientIO)
 // 	const api = clientRPC.getAPI()
 // 	expect(() => api.add(1, 2)).toThrow()
 // 	clientIO.destroy()
@@ -84,7 +86,7 @@ test("WebSocket concurrent connections", async () => {
 		})
 		return {
 			io: clientIO,
-			rpc: new RPCChannel<{}, API, DestroyableIoInterface>(clientIO, {})
+			rpc: new RPCChannel<{}, API, DestroyableIoInterface>(clientIO)
 		}
 	})
 

package/deno.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kunkun/kkrpc",
-	"version": "0.0.4",
+	"version": "0.0.6",
 	"tasks": {
 		"dev": "deno run --watch main.ts"
 	},

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kkrpc",
   "module": "index.ts",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "type": "module",
   "exports": {
     ".": "./mod.ts",

package/scripts/prepare.ts

@@ -1,6 +1,12 @@
 import { $ } from "bun"
 
-// const denoTypes = await $`deno types`.text()
-// // filter out the line with no-default-lib
-// const denoTypesFiltered = denoTypes.split("\n").filter((line) => !line.includes("no-default-lib"))
-// await Bun.write("./deno.d.ts", denoTypesFiltered.join("\n"))
+// check if CF_PAGES is set to 1
+const isCFPages = process.env.CF_PAGES === "1"
+if (isCFPages) {
+	process.exit(0)
+}
+
+const denoTypes = await $`deno types`.text()
+// filter out the line with no-default-lib
+const denoTypesFiltered = denoTypes.split("\n").filter((line) => !line.includes("no-default-lib"))
+await Bun.write("./deno.d.ts", denoTypesFiltered.join("\n"))

package/src/adapters/iframe.ts

@@ -28,10 +28,12 @@ export class IframeParentIO implements DestroyableIoInterface {
 	/**
 	 * @example
 	 * ```ts
-	 * const io = new IframeParentIO(iframeRef.contentWindow)
+	 * const io = new IframeParentIO(iframeRef.contentWindow);
 	 * const rpc = new RPCChannel(io, {
-	 *	 add: (a: number, b: number) => Promise.resolve(a + b)
-	 * })
+	 *   expose: {
+	 *     add: (a: number, b: number) => Promise.resolve(a + b),
+	 *   },
+	 * });
 	 * ```
 	 */
 	constructor(private targetWindow: Window) {

package/src/channel.ts

@@ -31,11 +31,15 @@ export class RPCChannel<
 	private callbackCache: Map<CallbackFunction, string> = new Map()
 	private count: number = 0
 	private messageStr = ""
+	private apiImplementation?: LocalAPI
 
 	constructor(
 		private io: Io,
-		private apiImplementation: LocalAPI
+		options?: {
+			expose?: LocalAPI
+		}
 	) {
+		this.apiImplementation = options?.expose
 		this.listen()
 	}
 
@@ -134,6 +138,7 @@ export class RPCChannel<
 
 		// Split the method path and traverse the API implementation
 		const methodPath = method.split(".")
+		if (!this.apiImplementation) return
 		let target: any = this.apiImplementation
 
 		// Traverse the object path

package/src/http.ts

@@ -8,7 +8,7 @@ export function createHttpClient<API extends Record<string, any>>(
 	channel: RPCChannel<{}, API, IoInterface>
 	api: API
 } {
-	const channel = new RPCChannel<{}, API>(new HTTPClientIO({ url }), {})
+	const channel = new RPCChannel<{}, API>(new HTTPClientIO({ url }))
 	const api = channel.getAPI()
 	return { channel, api }
 }
@@ -17,7 +17,7 @@ export function createHttpHandler<API extends Record<string, any>>(
 	api: API
 ): { handleRequest: (data: string) => Promise<string> } {
 	const serverIO = new HTTPServerIO()
-	new RPCChannel<{}, API>(serverIO, api)
+	new RPCChannel<{}, API>(serverIO, { expose: api })
 	return serverIO
 }
 export { RPCChannel } from "./channel"

package/typedoc.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://typedoc.org/schema.json",
-	"entryPoints": ["mod.ts", "browser-mod.ts"],
+	"entryPoints": ["mod.ts", "browser-mod.ts", "./src/http.ts"],
 	"visibilityFilters": {
 		"protected": false,
 		"private": false,