# @forumone/throughline 中文文档

规范地址：https://npmcn.com/package/%40forumone/throughline/

版本：2\.7\.1
npm 元数据更新时间：2026-11-11T03:46:30.736Z
中文译文更新时间：2026-11-15T10:47:53.215Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40forumone/throughline
原文对照：https://npmcn.com/package/%40forumone/throughline/?lang=original
项目主页：https://github.com/forumone/throughline/tree/main/packages/throughline#readme
源码仓库：https://github.com/forumone/throughline

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

- 包体积（解压后）：2.6 MB，1109 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：next ^15\.0\.0 \|\| ^16\.0\.0，react ^18\.0\.0 \|\| ^19\.0\.0，resend ^6\.1\.4，vitest ^3\.0\.0 \|\| ^4\.0\.0，inngest ^4\.0\.0，payload ^3\.89\.0，@vercel/blob ^2\.0\.0，@payloadcms/ui ^3\.0\.0，@payloadcms/next ^3\.0\.0，@react-email/render ^1\.3\.2，@react-email/components ^0\.5\.4，@payloadcms/plugin-cloud-storage ^3\.0\.0
- 首次发布：2026-10-03T02:13:27.960Z
- 最新版本发布：2026-11-11T03:46:30.271Z
- 近 30 天下载量：2213（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：106（近 12 个月 106 个）

## 中文简介

通过行:为"活塞CMS"提供编辑平台. 出版、批准、审计、整合、电子邮件和工作,每个功能都可以通过MCP实现.

## 安装

```sh
npm install @forumone/throughline
```

也可以使用：`pnpm add @forumone/throughline`、`yarn add @forumone/throughline`、`bun add @forumone/throughline`

## README

# @ forumone/ 透线

通过有效载荷内容管理系统:在政策编审、核准、审计日志、编辑 报告、整合、电子邮件和背景工作,每个功能都可以在MCP上达到。 一通电话 登记套房;每个部分还生活在自己的子路径上.

> **来自0.x?** 这个软件包是核心,插件合同,出版,工作流程,审计, 核准、组件、集成和电子邮件. [从 0.x 升级](https://github.com/forumone/throughline/blob/main/docs/guides/upgrading.md) 将一个 0.x 站点移动到它上, 并带有导入的编码器 .

**参考: [`docs/reference/throughline.md`](https://github.com/forumone/throughline/blob/main/docs/reference/throughline.md)**,每个插件都有一页.

## 里面的东西

| 子路径 | 持有 |
| --- | --- |
| (基层) | `assertEnvironment`, (中文(简体) ), `checkEnvValue`, (中文(简体) ), `hardenCoreCollections`, (中文(简体) ), `mcpApiKeyAccess`, (中文(简体) ), `withMeta`, (中文(简体) ), `auditContext`,日志、公用事业和插件类型 |
| `/publishing` | `publishingPlugin`出版部门, `isDraftWrite`、无障碍检查、重新鉴定和定期出版工作;见 [出版](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/publishing.md) |
| `/editorial` | `editorialPlugin`:内容健康,内容日历,"你的工作",命令调色板搜索,及其MCP工具 |
| `/approvals` | `approvalsPlugin`,签名动作链接, `expireStaleApprovalsJob`; 见 [核准数](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/approvals.md) |
| `/audit` | `auditPlugin`, (中文(简体) ), `getAuditWriter`, (中文(简体) ), `AUDIT_ACTIONS`, (中文(简体) ), `auditQueryPlugin` 及其工具, `auditEventEchoJob`; 见 [审计](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/audit.md) |
| `/components` | `componentsPlugin`: MCP 上显示的设计系统;见 [组件](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/components.md) |
| `/integrations` | `integrationsPlugin`,注册,网页浏览集成,手动同步, `healthcheckJob`; 见 [整合](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/integrations.md) |
| `/email` | `emailPlugin`,重新发送客户端、批准通知及其模板;见 [电子邮件](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/email.md) |
| `/jobs` | `defineJob`,工作类型,故障处理者,以及 `CoreEvents` 模块增强;见 [任务](https://github.com/forumone/throughline/blob/main/docs/reference/throughline/jobs.md) |
| `/jobs/inngest` | `inngestJobs`, (中文(简体) ), `createInngestClient`, (中文(简体) ), `resolveInngestEnv`, (中文(简体) ), `registrableInngestFunctions` |
| `/jobs/payload` | `payloadJobs` |
| `/media` | Blob 客户端加载硬化和参考跟踪 : `referencesPlugin`, (中文(简体) ), `findReferences`,删除和垃圾保护 |
| `/fields` | 外地工具包: `slugField`, (中文(简体) ), `publishingFields`, (中文(简体) ), `revisedAtField`, (中文(简体) ), `unlistedField`, (中文(简体) ), `characterCountPlugin`, (中文(简体) ), `fieldsPlugin` |
| `/observability` | `jobFailuresPlugin`, (中文(简体) ), `getJobFailureWriter`, (中文(简体) ), `createErrorReporter`, (中文(简体) ), `reportError`, (中文(简体) ), `buildRequestErrorReport` |
| `/testing` | `describeAnonymousAccess`, (中文(简体) ), `checkAnonymousAccess`: 测试站点的助手 |
| `/cache-tags` | `createCacheTags`用于前端阅读器 |
| `/links` | `markLinkTarget`, (中文(简体) ), `LINK_TARGET_KEY` 财务报告和审定财务报表 `linkTargetMarker`。这是链接目标标记。 它不进口, 所以一个链接- 域帮助器, 客户端组件也可以进口 |
| `/client`, (中文(简体) ), `/rsc` | 管理员的客户端和服务器组件, 在 Biveload 导入地图中命名 |
| 选项 | `throughline migrate-imports`,参见 [从 0.x 升级](https://github.com/forumone/throughline/blob/main/docs/guides/upgrading.md)· ; `throughline-payload`,参见 [参考文献](https://github.com/forumone/throughline/blob/main/docs/reference/throughline.md#throughline-payload-bin) |

## `throughline()`

```ts
// payload.config.ts
import { mcpApiKeyAccess, throughline } from '@forumone/throughline'
import { inngestJobs } from '@forumone/throughline/jobs/inngest'

export const suite = throughline({
  jobs: inngestJobs(inngest), // or payloadJobs() from /jobs/payload
  collections: ['pages', 'posts'],
  publishing: { urls: { pages: (slug) => `/${slug}`, posts: (slug) => `/blog/${slug}` } },
  approvals: { groups, groupResolver },
  email: { resolveApprover, resolveRequester },
  integrations: {},
  healthcheck: { checks: [createPayloadReachableCheck()] },
})

export default buildConfig({
  // …
  plugins: [
    suite.plugin,
    mcpPlugin({
      mcp: { tools: suite.mcpTools },
      overrideApiKeyCollection: mcpApiKeyAccess(isAdmin),
    }),
  ],
})
```

```ts
// app/api/inngest/route.ts, on Inngest. On Payload Jobs, suite.plugin registers the jobs itself.
const jobs = inngestJobs(inngest, { onFailure: createTerminalFailureHandler({ payload }), payload })
export const { GET, POST, PUT } = serve({ client: inngest, functions: jobs.functions(suite.jobs) })
```

-   **它按照每个插件需要的顺序进行注册.** 审计、工作失败和 `check_slug` 总是在。 每个其它插件在键出现时都会打开 .
-   **它让每个插件都有一个MCP收藏器.** `suite.mcpTools` 这是什么 `mcpPlugin` 服务.
-   **共享值一次给出.** `approvals.collectionSlug` 达到批准采集,电子邮件和到期工作. `collections` 达到出版,"你的作品"和预定出版. `admin` 除非插件本身另有说明.
-   **`suite.jobs` 方案要求的每一项工作是:** 重新验证( 给定 ) `publishing.urls`),计划出版及其支持,批准期满,审核回声,健康检查,三个批准电子邮件,以及每个整合的工作. 功能标识是登记在案的 0.x工厂.
-   **它的默认是每个网站手写的.** 预定出版的刊物要经过出版程序。 核准链接与 `APPROVAL_TOKEN_SECRET` 反对 `NEXT_PUBLIC_SERVER_URL`健康检查失败记录于 `job-failures`。 。 。 .

理由是 [`1.0-throughline-call.md`](https://github.com/forumone/throughline/blob/main/docs/spec/1.0-throughline-call.md)。每个插件仍然从它的子路径导出,用于一个用手电线连接它们的站点.

## 安装

```bash
pnpm add @forumone/throughline
```

`payload@^3.89.0` 是需要的对等方。 其余的都是可选的,每个只能由使用它的子路径所需要,没有一个被根所加载:

| 安装 | 网站使用时 |
| --- | --- |
| `inngest` | `/jobs/inngest`: Inngest 上的作业 |
| `resend`, (中文(简体) ), `@react-email/components`, (中文(简体) ), `@react-email/render`, (中文(简体) ), `react` | `/email`,或 `email` 内 `throughline()`。发送电子邮件时已装入,所以缺失的邮件会这么说,并命名软件包 |
| `next`, (中文(简体) ), `react`, (中文(简体) ), `@payloadcms/ui`, (中文(简体) ), `@payloadcms/next` | `/client` 财务报告和审定财务报表 `/rsc`,该有效载荷的管理进口 |
| `@vercel/blob`, (中文(简体) ), `@payloadcms/plugin-cloud-storage` | `/media`客户端加载硬化 |
| `vitest` | `/testing` |

`src/peers.test.ts` 检查表格: 静态导入, 从其它地方装入可选对等器失败 .

每一个选择,工作 `suite.jobs` 持有、审计日志、MCP认证、环境检查和 `throughline-payload` 弹箱在 [参考文献](https://github.com/forumone/throughline/blob/main/docs/reference/throughline.md)。 。 。 .

## 常见问题

### @forumone/throughline 是什么？

通过行:为"活塞CMS"提供编辑平台\. 出版、批准、审计、整合、电子邮件和工作,每个功能都可以通过MCP实现\.

### 如何安装 @forumone/throughline？

在项目目录运行 npm install @forumone/throughline，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：payload（^3\.89\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 throughline、throughline-payload，可以用 npx throughline 直接运行。

### @forumone/throughline 支持 TypeScript 吗？

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

### @forumone/throughline 支持 ESM 还是 CommonJS？

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

### @forumone/throughline 可以商用吗？

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

### @forumone/throughline 的下载量有多少？

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

### @forumone/throughline 还在维护吗？

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