# @adonis-agora/collaboration-client 中文文档

规范地址：https://npmcn.com/package/%40adonis-agora/collaboration-client/

版本：0\.10\.4
npm 元数据更新时间：2026-11-01T01:31:08.944Z
中文译文更新时间：2026-11-07T02:03:43.046Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40adonis-agora/collaboration-client
原文对照：https://npmcn.com/package/%40adonis-agora/collaboration-client/?lang=original
项目主页：https://davidecarvalho.github.io/agora/docs/collaboration
源码仓库：https://github.com/DavideCarvalho/adonis-agora-collaboration

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

- 包体积（解压后）：198 kB，118 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：6 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，@excalidraw/excalidraw ^0\.17\.6 \|\| ^0\.18\.0
- 首次发布：2026-08-26T11:38:43.791Z
- 最新版本发布：2026-11-01T01:31:08.597Z
- 近 30 天下载量：2087（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 25 个）

## 中文简介

@ados-agora/collising的客户端反应钩子——协作文件、存在、评论和版本。 阿戈拉生态系统的一部分.

## 安装

```sh
npm install @adonis-agora/collaboration-client
```

也可以使用：`pnpm add @adonis-agora/collaboration-client`、`yarn add @adonis-agora/collaboration-client`、`bun add @adonis-agora/collaboration-client`

## README

# @ados-agora/协作-客户

反应客户端钩 [`@adonis-agora/collaboration`](https://github.com/DavideCarvalho/adonis-agora-collaboration) 协作文件、存在、定位注释和版本控制,自动选择运输(Hocuspocus 自我托管或PartyKit边缘).

反应 18/19 超出零依赖性 `yjs` · 无害环境管理.

## 安装

```sh
pnpm add @adonis-agora/collaboration-client
```

服务器侧: 安装 `@adonis-agora/collaboration` 运行 `node ace collaboration:init` 以发布这些钩子所消耗的 REST 路线.

## 使用量

包装您的应用程序一次 :

```tsx
import { CollaborationProvider } from '@adonis-agora/collaboration-client'

<CollaborationProvider
  baseUrl="https://api.app"
  getHeaders={() => ({ cookie: sessionCookie })}
>
  <App />
</CollaborationProvider>
```

然后根据协作视图:

```tsx
import {
  useCollabDoc,
  useAwareness,
  useComments,
  useVersions,
} from '@adonis-agora/collaboration-client'

function Writing({ docName }: { docName: string }) {
  // Y.Doc shared per docName (cached across mounts), + connection status
  const { doc, status, error } = useCollabDoc(docName)
  const { peers } = useAwareness(docName)          // who's online
  const { comments, create, resolve, remove } = useComments(docName, 'text')
  const { versions, create: createVersion, restore } = useVersions(docName)

  if (status === 'error') return <p>{error?.message}</p>

  return (
    <>
      {/* feed `doc` into Tiptap / ProseMirror / Monaco… */}
      {peers.map((peer) => <Avatar key={peer.clientId} name={peer.name} />)}
    </>
  )
}
```

## 如何运作

1.  `useCollabDoc` 从 `GET {baseUrl}/collaboration/token?doc=<name>` (您的认证中间软件保护此路径).
2.  反应是 `engine` 字段选择传送:
    -   `yjs` → `HocuspocusProvider` 对抗Adonis服务器(`wsUrl` 路径)
    -   `partykit` → `YPartyKitProvider` 直奔云霄的房间
3.  评论意见和版本如下: **资源**,不是 CRDT 状态——它们通过服务器软件包的存储在您的数据库中生活.
4.  会话幸存组件卸载; 1 `Y.Doc` 每个文件名每个提供者.

## 自定义运输

给工厂注入同步引擎:

```tsx
<CollaborationProvider baseUrl="…" createTransport={(info, doc, docName) => new MyTransport(info, doc)}>
```

## API 密码

| 钩子 | 回返 |
| --- | --- |
| `useCollabDoc(docName)` | `{ doc: Y.Doc, status: 'connecting'|'connected'|'disconnected'|'error', error }` |
| `useAwareness(docName)` | `{ peers: CollabPeer[], status }` |
| `useComments(docName, space?)` | `{ comments, loading, error, refresh, create, resolve, remove }` |
| `useVersions(docName)` | `{ versions, loading, error, refresh, create, restore }` |

## 许可证

麻省理工学院

## 常见问题

### @adonis-agora/collaboration-client 是什么？

@ados-agora/collising的客户端反应钩子——协作文件、存在、评论和版本。 阿戈拉生态系统的一部分\.

### 如何安装 @adonis-agora/collaboration-client？

在项目目录运行 npm install @adonis-agora/collaboration-client，或使用 pnpm add / yarn add / bun add。

### @adonis-agora/collaboration-client 支持 TypeScript 吗？

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

### @adonis-agora/collaboration-client 支持 ESM 还是 CommonJS？

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

### @adonis-agora/collaboration-client 需要什么版本的 Node\.js？

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

### @adonis-agora/collaboration-client 可以商用吗？

@adonis-agora/collaboration-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @adonis-agora/collaboration-client 的下载量有多少？

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

### @adonis-agora/collaboration-client 还在维护吗？

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