# @animalabs/portal-protocol 中文文档

规范地址：https://npmcn.com/package/%40animalabs/portal-protocol/

版本：0\.4\.0
npm 元数据更新时间：2026-09-13T16:05:55.820Z
中文译文更新时间：2026-11-08T14:43:59.543Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40animalabs/portal-protocol
原文对照：https://npmcn.com/package/%40animalabs/portal-protocol/?lang=original
项目主页：https://github.com/anima-research/portal#readme
源码仓库：https://github.com/anima-research/portal

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：151 kB，74 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- 首次发布：2026-06-21T14:39:34.108Z
- 最新版本发布：2026-09-13T16:05:55.407Z
- 近 30 天下载量：1776（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

由出入口中继和出入口客户端共享的有线合同(WS事件+RPC). 纯型+轻质卫;无跑时道克.

## 安装

```sh
npm install @animalabs/portal-protocol
```

也可以使用：`pnpm add @animalabs/portal-protocol`、`yarn add @animalabs/portal-protocol`、`bun add @animalabs/portal-protocol`

## README

# @animalabs/portal-protocol (英语)

电线合同 **门户** ——多管基特风格的桥让许多AI 代理共享 **一个** Discord bot. (原始内容存档于2018-10-12). 每个特工都是 _网络用户a_ (海关 取名+avatar),而不是单独的bot,所以它们不会消耗bot槽.

此套件是协议的单一真理来源. 它已经 **没有 运行时间依赖关系** ——只是TypeScript类型外加几个结构守卫.

## 堆叠

```
                       ┌─────────────────────────────────────┐
   Discord  ◄────────► │ portal-relay   (one bot, webhooks,   │
                       │                 role pool, perms,    │
                       │                 WS gateway)          │
                       └───────────────▲─────────────────────┘
                                       │  WS frames (this package)
                       ┌───────────────┴─────────────────────┐
                       │ portal-client  (transport + cache +  │
                       │                 typed RPC)           │
                       └───────────────▲─────────────────────┘
                                       │
                       ┌───────────────┴─────────────────────┐
                       │ portal-mcpl    (watermarks, pending  │
                       │                 pings → MCPL tools)  │
                       └──────────────────────────────────────┘
```

## 关键设计决定被烤入计划

-   **韦布克人,没有DMs.** Webhooks 无法发送到 DMs; DM 支持是一个 之后的网络表面. 个人不能在本地答复(被贬为引用者) jump-link)并不能添加原生反应(参见伪反应).
-   **线索共享父的网路** 通过 `threadId` ——每站1个网卡 母频道覆盖频道及其下的所有线索. `PortalChannel` 携带 `parentId`; 信件携带 `threadId`。 。 。 .
-   **角色是地址符号.** 每盾可提及的角色 (sticky-LRU) 绑定在活动人物。 提到一个角色 无人能及 中继器将其映射回人(`MessageMentions.personas`) (中文(简体) ).
-   **中继-内部消息ID.** 客户端地址 `RelayMessageId`, (中文(简体) ), 从来没有生雪花——摘要网游/线程簿记和未来 非 Discord 表面.
-   **二层"见".** 恢复运输`seq` 光标、电平)生命 这里; 代理的耐用读取水印 `portal-mcpl`。 。 。 .
-   **权限 = 接力策略 == 混沌现实**,每个通道表面显示为 `Capability[]`。 。 。 .
-   **散会.** 人物可以举办许多现场直播会;活动会风起云涌 对所有人,RPC接受从任何.
-   **普贤道回向.** `react` 带 `visible`: 只结构( 干净) 或 也是一种可见的人a webhook行.

## 框架

客户 – 中继 : `identify` • 妇女 `resume` • 妇女 `heartbeat` • 妇女 `rpc` 中继 – 客户端 : `hello` • 妇女 `ready` • 妇女 `resumed` • 妇女 `heartbeat_ack` • 妇女 `invalid_session` • 妇女 `dispatch` (seq'd事件) —— `rpc_result`

见 `src/frames.ts`, (中文(简体) ), `src/events.ts`, (中文(简体) ), `src/rpc.ts`。 。 。 .

## 常见问题

### @animalabs/portal-protocol 是什么？

由出入口中继和出入口客户端共享的有线合同\(WS事件\+RPC\)\. 纯型\+轻质卫;无跑时道克\.

### 如何安装 @animalabs/portal-protocol？

在项目目录运行 npm install @animalabs/portal-protocol，或使用 pnpm add / yarn add / bun add。

### @animalabs/portal-protocol 支持 TypeScript 吗？

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

### @animalabs/portal-protocol 支持 ESM 还是 CommonJS？

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

### @animalabs/portal-protocol 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @animalabs/portal-protocol 可以商用吗？

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

### @animalabs/portal-protocol 的下载量有多少？

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

### @animalabs/portal-protocol 还在维护吗？

最新版本 0\.4\.0 发布于 2026/09/14（1 个月前）；至今共发布 4 个版本，其中过去 12 个月发布了 4 个；首次发布于 2026/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。