# @starcier/collab-core 中文文档

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

版本：1\.0\.0
npm 元数据更新时间：2026-11-02T12:15:45.626Z
中文译文更新时间：2026-11-02T13:39:51.384Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40starcier/collab-core
原文对照：https://npmcn.com/package/%40starcier/collab-core/?lang=original
项目主页：https://github.com/starcier/starcier-platform#readme
源码仓库：https://github.com/starcier/starcier-platform

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

- 包体积（解压后）：166 kB，63 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-10-23T09:38:26.916Z
- 最新版本发布：2026-11-02T12:15:45.394Z
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

Starcier协作层的一半：注释和工作流存储，API客户端及其类型。

## 安装

```sh
npm install @starcier/collab-core
```

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

## README

# @starcier / collab-core

Starcier协作层的“无头”部分：注释和工作流存储、API 客户端及其类型。这里没有渲染任何东西或知道一个设计系统。

大多数构建器不直接使用这个包。 `@starcier/builder-shell` 为你装上它， 和 `@starcier/collab-ui` 在上面绘制注释和游览。只能自己去拿 当你的应用保持自己的外壳。

## 安装

```bash
npm install @starcier/collab-core@next
```

直到 `1.0.0` 已发布，版本为预发布(`1.0.0-next.N`)：总是安装 `@next`． 没有它，npm会安装第一个预发布版，而不是最新的。需要React 18或19。

## 使用

包装应用程序中使用注释或工作流的部分：

```tsx
import { CollabProvider } from '@starcier/collab-core';

<CollabProvider
  apiBaseUrl={API_BASE_URL}       // the API origin, without /v1
  getToken={getAccessToken}       // null while nobody is signed in
  tenant={TENANT_SLUG}            // your builder's tenant slug
>
  {children}
</CollabProvider>
```

离开 `apiBaseUrl` 不设定，一切都背道而驰 `localStorage`，没有后端。保持 `tenant` 即使这样设置：它使该构造器的本地数据与同一构造器上的其他构造器分开 来源。作为 `workflowSeeds` 被复制到每个浏览器一次；后来编辑为a 代码中的种子只能在new下到达浏览器 `id`.

在启动时，提供者询问API是否仍然支持此版本。如果太旧， Comments和Tours会关闭，并显示一条消息，命名您需要的版本和升级 命令;应用程序的其余部分继续工作。

## 许可证

麻省理工学院

## 常见问题

### @starcier/collab-core 是什么？

Starcier协作层的一半：注释和工作流存储，API客户端及其类型。

### 如何安装 @starcier/collab-core？

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

### @starcier/collab-core 支持 TypeScript 吗？

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

### @starcier/collab-core 支持 ESM 还是 CommonJS？

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

### @starcier/collab-core 可以商用吗？

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

### @starcier/collab-core 还在维护吗？

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