@gd-kirie/ipc

中文文档
0.16.0发布于 2026/10/29TypeScriptES Module构建来源已验证近 30 天下载 1.3万
原始使用文档
文档目录4 节
  1. API
  2. Web iframe transport
  3. Pointer input forwarding
  4. Custom event orchestration

@gd-kirie/ipc

Thin browser-side IPC transport for Kirie WebView pages.

The package is imported by web content running inside a Kirie WebView. Native platforms continue to provide the low level bridge on globalThis, and this package only wraps that bridge with a small typed module API.

API

import { onTextReceived, sendText } from "@gd-kirie/ipc";

sendText(JSON.stringify({
  type: "web_ready",
}));

const unsubscribe = onTextReceived((message) => {
  console.log(message);
});

unsubscribe();

The package selects native transports from window.kirie.platform. Native backends inject this property before page scripts run. On Web, the first API call discovers the iframe port and sets the platform property.

Android exposes three channels backed by CBOR packets and AndroidX WebKit ArrayBuffer messages. iOS exposes the same lane API over WKWebView script messages, carrying each CBOR packet as base64 inside the platform string message:

  • sendText() / onTextReceived() for CBOR text strings
  • sendBinary() / onBinaryReceived() for CBOR byte strings
  • sendData() / onDataReceived() for CBOR-encoded structured data through cborg

The structured data subset is limited to null, booleans, numbers, strings, arrays, and objects with string keys. JSON message shapes are a caller or adapter convention and should be sent with sendText() when needed.

Web iframe transport

On Web exports, the package discovers its same-origin parent. The first API call sets window.kirie.platform to { os: "web", backend: "iframe" }. These values extend KiriePlatformOs and KiriePlatformBackend. Each receive function returns an unsubscribe function that removes its message listener. After the iframe document loads, the host transfers one end of a browser MessageChannel. The iframe reports readiness through that port. Readiness does not depend on lane subscriptions, so a text-only adapter such as Eventa does not need empty binary or data handlers. Subscribe only to the lanes the page consumes:

import { onTextReceived, sendText } from "@gd-kirie/ipc";

const stopText = onTextReceived(sendText);

window.addEventListener("pagehide", () => {
  stopText();
}, { once: true });

Web sends text strings, binary ArrayBuffers, and data values through the transferred MessagePort and structured clone. It does not serialize payloads as JSON or CBOR. Binary API arguments and callbacks still use Uint8Array. The transport copies the selected byte range and keeps the sender's buffer intact. Data accepts only the documented cross-platform subset. It rejects custom prototypes, cycles, non-finite numbers, unsafe integers, and nesting beyond 64 container levels.

The host uses an exact target origin when it transfers the port. The iframe accepts that port only from its same-origin parent. Later lane traffic stays on the private port, so Kirie does not implement another window-message router or channel registry. Cross-origin content and opaque origins are unsupported.

createIframeTransport(window, { origin }) exposes the transport explicitly. KirieIframeConfig and KirieTransport describe its configuration and API. The factory receives the port from its parent; it does not create or own an iframe.

Pointer input forwarding

[!IMPORTANT] Kirie WebViews normally fill their native host above Godot. CSS transparency does not pass native hit tests through to Godot, so visible Godot controls behind the WebView cannot be clicked without pointer forwarding. Most Kirie pages should import @gd-kirie/ipc/pointer-input/auto.

Enable both sides; the browser entry registers on import:

$KirieNode.pointer_input_forwarding_enabled = true
import "@gd-kirie/ipc/pointer-input/auto";

Custom event orchestration

For custom targets or lifetimes, use the explicit entry instead:

import {
  createPointerEventsHandler,
  phaseFromPointerEvent,
  sendPointerEvent,
} from "@gd-kirie/ipc/pointer-input";

createPointerEventsHandler() returns capture, bubble, and cancel handlers; the caller owns their registration and removal.

pointerdown bubbling decides ownership: event.stopPropagation() keeps the sequence in the WebView; otherwise its move, up, and cancel events are forwarded to Godot.

Forwarding uses Godot's Input.parse_input_event() API; forwarded mouse and touch events retain their destination window_id.

版本与发布记录

@gd-kirie/ipc 共发布 31 个版本,首次发布于 2026/04/30;过去 12 个月发布了 31 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.16.0latest2026/10/2917 天前
0.15.32026/10/2917 天前
0.15.22026/10/2818 天前
0.15.12026/10/2818 天前
0.15.02026/10/2125 天前
0.14.22026/10/1729 天前

关于 @gd-kirie/ipc 的常见问题

如何安装 @gd-kirie/ipc?

在项目目录运行 npm install @gd-kirie/ipc,或使用 pnpm add / yarn add / bun add。

@gd-kirie/ipc 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gd-kirie/ipc 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gd-kirie/ipc 可以商用吗?

@gd-kirie/ipc 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@gd-kirie/ipc 的下载量有多少?

根据 npm 官方下载统计,@gd-kirie/ipc 在 2026/10/16 – 2026/11/14 这 30 天内被下载 12,532 次,日均约 418 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gd-kirie/ipc 还在维护吗?

最新版本 0.16.0 发布于 2026/10/29(17 天前);至今共发布 31 个版本,其中过去 12 个月发布了 31 个;首次发布于 2026/04/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。