# @atlaskit/collab-provider 中文文档

规范地址：https://npmcn.com/package/%40atlaskit/collab-provider/

版本：39\.1\.10
npm 元数据更新时间：2026-11-07T01:22:32.356Z
中文译文更新时间：2026-11-07T03:08:58.624Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/collab-provider
原文对照：https://npmcn.com/package/%40atlaskit/collab-provider/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-mirror

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

- 包体积（解压后）：1.2 MB，193 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：22 个
- peer 依赖：@atlaskit/editor-common ^134\.9\.0
- 首次发布：2020-03-13T01:38:39.234Z
- 最新版本发布：2026-11-07T01:22:32.202Z
- 近 30 天下载量：9761（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：657（近 12 个月 318 个）

## 中文简介

合作编辑的提供者.

## 安装

```sh
npm install @atlaskit/collab-provider
```

也可以使用：`pnpm add @atlaskit/collab-provider`、`yarn add @atlaskit/collab-provider`、`bun add @atlaskit/collab-provider`

## README

# 与 Collab- provider 合并

本指南概述了与协作提供者相结合的两个主要使用案例.

# 使用大小写

1.  全面整合:FE事件和BE API呼叫
    -   对于既需要前端事件又需要后端 API 交互的情景,后端 API 由 `pf-collab-service`为确定是否需要API呼叫,请参见 [OpenAPI 文档](https://bitbucket.org/atlassian/pf-collab-service/src/c25a7614f30c68cae50b8f8da827a844c4ccecc2/openapi.yaml#openapi.yaml),具体在 `Service to Service` 节.
2.  部分整合:仅FE活动
    -   对于只需要前端事件,没有后端API交互的情景.

# 整合细节

1.  全面整合:FE事件和BE API呼叫
    -   确保供应商以下列方式初始化:
        -   `DocumentService` 从 `document-service.ts`
        -   `Api` 从 `api.ts`
2.  部分整合:仅FE活动
    -   确保供应商以下列方式初始化:
        -   `NullDocumentService` 从 `null-document-service.ts`
        -   `NullApi` 从 `null-api.ts`

关于这些整合方法的详细比较,请参考以下表格中的源代码: `../platform/packages/editor/collab-provider/src/provider/index.ts`

```
// Full integration
- setup({getState, onSyncUpError}: {getState: () => EditorState; onSyncUpError?: SyncUpErrorFunction;})

// Partial Integration, initialize the provider with passing config isPresenceOnly as true
- setupForPresenceOnly(clientId: string)
```

# 支助

如有其他问题或需要帮助,请联系 [#团队-cc-编辑服务](https://atlassian.enterprise.slack.com/archives/C02GEULKMLN) 在斯莱克.

## 常见问题

### @atlaskit/collab-provider 是什么？

合作编辑的提供者\.

### 如何安装 @atlaskit/collab-provider？

在项目目录运行 npm install @atlaskit/collab-provider，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@atlaskit/editor-common（^134\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atlaskit/collab-provider 支持 TypeScript 吗？

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

### @atlaskit/collab-provider 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atlaskit/collab-provider 可以商用吗？

@atlaskit/collab-provider 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @atlaskit/collab-provider 的下载量有多少？

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

### @atlaskit/collab-provider 还在维护吗？

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