|
|
1 month ago | |
|---|---|---|
| .. | ||
| src | 1 month ago | |
| LICENSE | 1 month ago | |
| README.md | 1 month ago | |
| package.json | 1 month ago | |
README.md
electron-trpc 适配器
模板内维护的 electron-trpc 兼容适配包,参考 jsonnull/electron-trpc 0.7.1 与 ai-friend 的 tRPC 11 适配方式。保留上游 MIT 许可。包名为 electron-trpc,使用 workspace 依赖;不是直接安装 npm 的 0.7.1。版本后缀 template.1 表示本地维护版本。
客户端与服务器固定使用 tRPC 11.19.0,升级时一起升级并运行完整验证。此包不依赖应用代码或具体路由。
electron-trpc/main:createIPCHandler,必须注入来源授权、上下文与错误记录。上下文创建失败也会进入错误处理。全局 listener 可销毁,所有请求与订阅按 owner 管理。electron-trpc/preload:exposeElectronTRPC,固定通道,校验消息结构,onMessage返回解除监听函数。electron-trpc/renderer:ipcLink,提供标准 tRPC query/mutation/subscription 调用,每次调用负责释放监听。electron-trpc/shared:浏览器安全的消息 schema 与桥接类型。
相比参考实现,增加主框架/来源授权接入、取消来源验证、消息校验与大小限制、订阅限额、发送时来源复查、刷新/关闭时取消、重复请求 ID 保护以及全局 listener 清理。业务权限、输入输出 schema、限流与错误脱敏由调用方的 RpcGateway 和主进程模块 tRPC router 负责。
目前采用 JSON 兼容数据,不支持自定义 transformer、二进制传输或断线自动重连。request.cancel 支持所有请求,保留 subscription.stop 兼容消息。query 默认 15 秒、mutation 默认 120 秒、订阅启动默认 15 秒;context.timeoutMs 可覆盖,0 表示不限时。订阅启动成功后解除等待计时。支持 AbortSignal,完成/失败/取消均清理客户端监听和计时器;不自动重试 mutation,超时不意味着业务回滚。observable 订阅在取消时主动退订;异步生成器须监听 procedure signal,让等待中的任务在取消时退出。renderer 刷新后应用会重新初始化客户端与订阅。IPC 暂不提供服务器推送事件的断线重放。
验证覆盖:查询/修改、类型推导、权限、错误脱敏、订阅退订、取消竞态、刷新/关闭、全局监听清理、真实 Electron 与打包程序。