kkrpc 0.0.15 → 0.0.18

package/README.md

@@ -12,6 +12,10 @@
 - [Documentation by JSR](https://jsr.io/@kunkun/kkrpc/doc)
 - [Typedoc Documentation](https://kunkunsh.github.io/kkrpc/)
 
+![](https://imgur.com/vR3Lmv0.png)
+![](https://imgur.com/u728aVv.png)
+![](https://imgur.com/2ycWgVQ.png)
+
 ## Supported Environments
 
 - stdio: RPC over stdio between any combinations of Node.js, Deno, Bun processes
@@ -47,7 +51,7 @@ class RPCChannel<
 > {}
 ```
 
-## Examplesr
+## Examples
 
 Below are simple examples.
 
@@ -166,3 +170,51 @@ console.log("echoResponse", echoResponse)
 const sum = await clientAPI.add(2, 3)
 console.log("Sum: ", sum)
 ```
+
+### Chrome Extension Example
+
+#### `background.ts`
+
+```ts
+import { ChromeBackgroundIO, RPCChannel } from "kkrpc"
+import type { API } from "./api"
+
+// Store RPC channels for each tab
+const rpcChannels = new Map<number, RPCChannel<API, {}>>()
+
+// Listen for tab connections
+chrome.runtime.onConnect.addListener((port) => {
+	if (port.sender?.tab?.id) {
+		const tabId = port.sender.tab.id
+		const io = new ChromeBackgroundIO(tabId)
+		const rpc = new RPCChannel(io, { expose: backgroundAPI })
+		rpcChannels.set(tabId, rpc)
+
+		port.onDisconnect.addListener(() => {
+			rpcChannels.delete(tabId)
+		})
+	}
+})
+```
+
+#### `content.ts`
+
+```ts
+import { ChromeContentIO, RPCChannel } from "kkrpc"
+import type { API } from "./api"
+
+const io = new ChromeContentIO()
+const rpc = new RPCChannel<API, API>(io, {
+	expose: {
+		updateUI: async (data) => {
+			document.body.innerHTML = data.message
+			return true
+		}
+	}
+})
+
+// Get API from background script
+const api = rpc.getAPI()
+const data = await api.getData()
+console.log(data) // { message: "Hello from background!" }
+```

package/dist/browser-mod.cjs

@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // browser-mod.ts
 var browser_mod_exports = {};
 __export(browser_mod_exports, {
+  ChromeBackgroundIO: () => ChromeBackgroundIO,
+  ChromeContentIO: () => ChromeContentIO,
   IframeChildIO: () => IframeChildIO,
   IframeParentIO: () => IframeParentIO,
   RPCChannel: () => RPCChannel,
@@ -117,6 +119,220 @@ var WorkerChildIO = class {
   }
 };
 
+// src/adapters/chrome.ts
+var DESTROY_SIGNAL2 = "__DESTROY__";
+var ChromeBackgroundIO = class {
+  name = "chrome-background-io";
+  messageQueue = [];
+  resolveRead = null;
+  tabId;
+  handleMessage = (message, sender, _sendResponse) => {
+    if (sender.tab?.id !== this.tabId) return;
+    if (message === DESTROY_SIGNAL2) {
+      this.destroy();
+      return;
+    }
+    if (this.resolveRead) {
+      this.resolveRead(message);
+      this.resolveRead = null;
+    } else {
+      this.messageQueue.push(message);
+    }
+  };
+  constructor(tabId) {
+    this.tabId = tabId;
+    chrome.runtime.onMessage.addListener(this.handleMessage);
+  }
+  async read() {
+    if (this.messageQueue.length > 0) {
+      return this.messageQueue.shift() ?? null;
+    }
+    return new Promise((resolve) => {
+      this.resolveRead = resolve;
+    });
+  }
+  async write(data) {
+    await chrome.tabs.sendMessage(this.tabId, data);
+  }
+  destroy() {
+    chrome.runtime.onMessage.removeListener(this.handleMessage);
+  }
+  signalDestroy() {
+    this.write(DESTROY_SIGNAL2);
+  }
+};
+var ChromeContentIO = class {
+  name = "chrome-content-io";
+  messageQueue = [];
+  resolveRead = null;
+  constructor() {
+    chrome.runtime.onMessage.addListener(this.handleMessage);
+  }
+  handleMessage = (message, _sender, _sendResponse) => {
+    if (message === DESTROY_SIGNAL2) {
+      this.destroy();
+      return;
+    }
+    if (this.resolveRead) {
+      this.resolveRead(message);
+      this.resolveRead = null;
+    } else {
+      this.messageQueue.push(message);
+    }
+  };
+  async read() {
+    if (this.messageQueue.length > 0) {
+      return this.messageQueue.shift() ?? null;
+    }
+    return new Promise((resolve) => {
+      this.resolveRead = resolve;
+    });
+  }
+  async write(data) {
+    await chrome.runtime.sendMessage(data);
+  }
+  destroy() {
+    chrome.runtime.onMessage.removeListener(this.handleMessage);
+  }
+  signalDestroy() {
+    this.write(DESTROY_SIGNAL2);
+  }
+};
+
+// src/adapters/iframe.ts
+var DESTROY_SIGNAL3 = "__DESTROY__";
+var PORT_INIT_SIGNAL = "__PORT_INIT__";
+var IframeParentIO = class {
+  /**
+   * @example
+   * ```ts
+   * const io = new IframeParentIO(iframeRef.contentWindow);
+   * const rpc = new RPCChannel(io, {
+   *   expose: {
+   *     add: (a: number, b: number) => Promise.resolve(a + b),
+   *   },
+   * });
+   * ```
+   */
+  constructor(targetWindow) {
+    this.targetWindow = targetWindow;
+    this.port = null;
+    window.addEventListener("message", (event) => {
+      if (event.source !== this.targetWindow) return;
+      if (event.data === PORT_INIT_SIGNAL && event.ports.length > 0) {
+        this.port = event.ports[0];
+        this.port.onmessage = this.handleMessage;
+        while (this.messageQueue.length > 0) {
+          const message = this.messageQueue.shift();
+          if (message) this.port.postMessage(message);
+        }
+      }
+    });
+  }
+  name = "iframe-parent-io";
+  messageQueue = [];
+  resolveRead = null;
+  port = null;
+  handleMessage = (event) => {
+    const message = event.data;
+    if (message === DESTROY_SIGNAL3) {
+      this.destroy();
+      return;
+    }
+    if (this.resolveRead) {
+      this.resolveRead(message);
+      this.resolveRead = null;
+    } else {
+      this.messageQueue.push(message);
+    }
+  };
+  async read() {
+    if (this.messageQueue.length > 0) {
+      return this.messageQueue.shift() ?? null;
+    }
+    return new Promise((resolve) => {
+      this.resolveRead = resolve;
+    });
+  }
+  async write(data) {
+    if (!this.port) {
+      this.messageQueue.push(data);
+      return;
+    }
+    this.port.postMessage(data);
+  }
+  destroy() {
+    if (this.port) {
+      this.port.postMessage(DESTROY_SIGNAL3);
+      this.port.close();
+    }
+  }
+  signalDestroy() {
+    if (this.port) {
+      this.port.postMessage(DESTROY_SIGNAL3);
+    }
+  }
+};
+var IframeChildIO = class {
+  name = "iframe-child-io";
+  messageQueue = [];
+  resolveRead = null;
+  port = null;
+  pendingMessages = [];
+  initialized;
+  channel;
+  constructor() {
+    this.channel = new MessageChannel();
+    this.port = this.channel.port1;
+    this.port.onmessage = this.handleMessage;
+    window.parent.postMessage(PORT_INIT_SIGNAL, "*", [this.channel.port2]);
+    this.initialized = Promise.resolve();
+  }
+  handleMessage = (event) => {
+    const message = event.data;
+    if (message === DESTROY_SIGNAL3) {
+      this.destroy();
+      return;
+    }
+    if (this.resolveRead) {
+      this.resolveRead(message);
+      this.resolveRead = null;
+    } else {
+      this.messageQueue.push(message);
+    }
+  };
+  async read() {
+    await this.initialized;
+    if (this.messageQueue.length > 0) {
+      return this.messageQueue.shift() ?? null;
+    }
+    return new Promise((resolve) => {
+      this.resolveRead = resolve;
+    });
+  }
+  async write(data) {
+    await this.initialized;
+    if (this.port) {
+      this.port.postMessage(data);
+    } else {
+      this.pendingMessages.push(data);
+    }
+  }
+  destroy() {
+    if (this.port) {
+      this.port.postMessage(DESTROY_SIGNAL3);
+      this.port.close();
+    }
+  }
+  signalDestroy() {
+    if (this.port) {
+      this.port.postMessage(DESTROY_SIGNAL3);
+    } else {
+      this.pendingMessages.push(DESTROY_SIGNAL3);
+    }
+  }
+};
+
 // src/interface.ts
 var import_node_buffer = require("buffer");
 
@@ -356,142 +572,10 @@ var RPCChannel = class {
     this.callbackCache.clear();
   }
 };
-
-// src/adapters/iframe.ts
-var DESTROY_SIGNAL2 = "__DESTROY__";
-var PORT_INIT_SIGNAL = "__PORT_INIT__";
-var IframeParentIO = class {
-  /**
-   * @example
-   * ```ts
-   * const io = new IframeParentIO(iframeRef.contentWindow);
-   * const rpc = new RPCChannel(io, {
-   *   expose: {
-   *     add: (a: number, b: number) => Promise.resolve(a + b),
-   *   },
-   * });
-   * ```
-   */
-  constructor(targetWindow) {
-    this.targetWindow = targetWindow;
-    this.port = null;
-    window.addEventListener("message", (event) => {
-      if (event.source !== this.targetWindow) return;
-      if (event.data === PORT_INIT_SIGNAL && event.ports.length > 0) {
-        this.port = event.ports[0];
-        this.port.onmessage = this.handleMessage;
-        while (this.messageQueue.length > 0) {
-          const message = this.messageQueue.shift();
-          if (message) this.port.postMessage(message);
-        }
-      }
-    });
-  }
-  name = "iframe-parent-io";
-  messageQueue = [];
-  resolveRead = null;
-  port = null;
-  handleMessage = (event) => {
-    const message = event.data;
-    if (message === DESTROY_SIGNAL2) {
-      this.destroy();
-      return;
-    }
-    if (this.resolveRead) {
-      this.resolveRead(message);
-      this.resolveRead = null;
-    } else {
-      this.messageQueue.push(message);
-    }
-  };
-  async read() {
-    if (this.messageQueue.length > 0) {
-      return this.messageQueue.shift() ?? null;
-    }
-    return new Promise((resolve) => {
-      this.resolveRead = resolve;
-    });
-  }
-  async write(data) {
-    if (!this.port) {
-      this.messageQueue.push(data);
-      return;
-    }
-    this.port.postMessage(data);
-  }
-  destroy() {
-    if (this.port) {
-      this.port.postMessage(DESTROY_SIGNAL2);
-      this.port.close();
-    }
-  }
-  signalDestroy() {
-    if (this.port) {
-      this.port.postMessage(DESTROY_SIGNAL2);
-    }
-  }
-};
-var IframeChildIO = class {
-  name = "iframe-child-io";
-  messageQueue = [];
-  resolveRead = null;
-  port = null;
-  pendingMessages = [];
-  initialized;
-  channel;
-  constructor() {
-    this.channel = new MessageChannel();
-    this.port = this.channel.port1;
-    this.port.onmessage = this.handleMessage;
-    window.parent.postMessage(PORT_INIT_SIGNAL, "*", [this.channel.port2]);
-    this.initialized = Promise.resolve();
-  }
-  handleMessage = (event) => {
-    const message = event.data;
-    if (message === DESTROY_SIGNAL2) {
-      this.destroy();
-      return;
-    }
-    if (this.resolveRead) {
-      this.resolveRead(message);
-      this.resolveRead = null;
-    } else {
-      this.messageQueue.push(message);
-    }
-  };
-  async read() {
-    await this.initialized;
-    if (this.messageQueue.length > 0) {
-      return this.messageQueue.shift() ?? null;
-    }
-    return new Promise((resolve) => {
-      this.resolveRead = resolve;
-    });
-  }
-  async write(data) {
-    await this.initialized;
-    if (this.port) {
-      this.port.postMessage(data);
-    } else {
-      this.pendingMessages.push(data);
-    }
-  }
-  destroy() {
-    if (this.port) {
-      this.port.postMessage(DESTROY_SIGNAL2);
-      this.port.close();
-    }
-  }
-  signalDestroy() {
-    if (this.port) {
-      this.port.postMessage(DESTROY_SIGNAL2);
-    } else {
-      this.pendingMessages.push(DESTROY_SIGNAL2);
-    }
-  }
-};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ChromeBackgroundIO,
+  ChromeContentIO,
   IframeChildIO,
   IframeParentIO,
   RPCChannel,

package/dist/browser-mod.d.cts

@@ -1,4 +1,5 @@
-export { M as Message, R as Response, a as WorkerChildIO, W as WorkerParentIO, d as deserializeMessage, c as deserializeResponse, g as generateUUID, s as serializeMessage, b as serializeResponse } from './serialization-BrfKixNU.cjs';
+export { a as WorkerChildIO, W as WorkerParentIO } from './worker-ByZFWF48.cjs';
+export { ChromeBackgroundIO, ChromeContentIO, Message, Response, deserializeMessage, deserializeResponse, generateUUID, serializeMessage, serializeResponse } from './chrome.cjs';
 import { D as DestroyableIoInterface } from './channel-CGr_xSbe.cjs';
 export { I as IoInterface, R as RPCChannel } from './channel-CGr_xSbe.cjs';
 import 'node:buffer';

package/dist/browser-mod.d.ts

@@ -1,4 +1,5 @@
-export { M as Message, R as Response, a as WorkerChildIO, W as WorkerParentIO, d as deserializeMessage, c as deserializeResponse, g as generateUUID, s as serializeMessage, b as serializeResponse } from './serialization-C0yxGsSr.js';
+export { a as WorkerChildIO, W as WorkerParentIO } from './worker-sUTyf1YL.js';
+export { ChromeBackgroundIO, ChromeContentIO, Message, Response, deserializeMessage, deserializeResponse, generateUUID, serializeMessage, serializeResponse } from './chrome.js';
 import { D as DestroyableIoInterface } from './channel-CGr_xSbe.js';
 export { I as IoInterface, R as RPCChannel } from './channel-CGr_xSbe.js';
 import 'node:buffer';

package/dist/browser-mod.js

@@ -2,6 +2,10 @@ import {
   WorkerChildIO,
   WorkerParentIO
 } from "./chunk-XU7DWWSJ.js";
+import {
+  ChromeBackgroundIO,
+  ChromeContentIO
+} from "./chunk-INKNKSKA.js";
 import {
   RPCChannel,
   deserializeMessage,
@@ -145,6 +149,8 @@ var IframeChildIO = class {
   }
 };
 export {
+  ChromeBackgroundIO,
+  ChromeContentIO,
   IframeChildIO,
   IframeParentIO,
   RPCChannel,