# @chat-adapter/catalog 中文文档

规范地址：https://npmcn.com/package/%40chat-adapter/catalog/

版本：4\.44\.0
npm 元数据更新时间：2026-11-02T14:55:26.068Z
中文译文更新时间：2026-11-09T11:11:10.015Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40chat-adapter/catalog
原文对照：https://npmcn.com/package/%40chat-adapter/catalog/?lang=original
项目主页：https://chat-sdk.dev/docs/adapter-catalog
源码仓库：https://github.com/vercel/chat

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

- 包体积（解压后）：250 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-10-08T19:30:52.368Z
- 最新版本发布：2026-11-02T14:55:25.620Z
- 近 30 天下载量：3473594（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

Chat SDK 适配器的目录: 软件包、 能力和设置要求, 没有适配器依赖性

## 安装

```sh
npm install @chat-adapter/catalog
```

也可以使用：`pnpm add @chat-adapter/catalog`、`yarn add @chat-adapter/catalog`、`bun add @chat-adapter/catalog`

## README

# @chat-adapter/ catalog 页面存档备份,存于互联网档案馆

> npm 软件包 : [`@chat-adapter/catalog`](https://www.npmjs.com/package/@chat-adapter/catalog)

[![MIT License](https://img.shields.io/badge/License-MIT-000?style=flat-square&logo=opensourceinitiative&logoColor=white&labelColor=000&color=000)](https://npmcn.com/package/LICENSE)

静态目录 [聊天SDK](https://chat-sdk.dev/) 适配器: 列出的每个官方、供应商官方和社区适配器 [聊天sdk.dev/适应器](https://chat-sdk.dev/adapters),带有npm软件包,维护者,以及支持的能力. 官方和供应商官方的条目还包括工厂出口、同行依赖以及建立这些实体所需的环境变量.

软件包没有依赖性,导入时没有适配码,因此可以在网站,构建脚本,设置屏幕,以及CLI中使用. 聊天-sdk.dev和 [`create-chat-sdk`](https://chat-sdk.dev/docs/create-chat-sdk) 都从它读.

联合国 [聊天- sdk.dev/docs/适应器-目录](https://chat-sdk.dev/docs/adapter-catalog) 指南: [vercel.com/kb/chat-sdk (英语)](https://vercel.com/kb/chat-sdk)

## 安装

```bash
pnpm add @chat-adapter/catalog
```

## 使用量

列出适配器并检查它们的能力:

```typescript
import { getFeatureSupport, listAdapters } from "@chat-adapter/catalog";

for (const adapter of listAdapters({ type: "platform" })) {
  const streaming = getFeatureSupport(adapter, "streaming");
  console.log(adapter.name, adapter.group, adapter.packageName, streaming);
}
```

`listAdapters()` 返回 talk-sdk.dev 中的官方和供应商官方适配器,然后列出社区适配器。 过 `group` (一组或数组)或 `type` 用于过滤.

阅读官方或供应商-官方适配器的设置要求:

```typescript
import { getAdapter, getSecretEnvVars, listEnvVars } from "@chat-adapter/catalog";

const slack = getAdapter("slack");
console.log(slack.packageName, slack.factoryExport, slack.peerDeps);

const allVars = listEnvVars("slack").map((envVar) => envVar.key);
const secrets = getSecretEnvVars("slack").map((envVar) => envVar.key);
```

## API 密码

| 导出 | 说明 |
| --- | --- |
| `listAdapters(options?)` | 每个条目,包括社区适配器,均经过过滤 `group` 财务报告和审定财务报表 `type` |
| `getCatalogEntry(slug)` | 任何通过弹道进入,或 `undefined` |
| `getAdapter(slug)` | 官方或销售商官方通过喷口进入,或 `undefined` |
| `isAdapterSlug(slug)` | 缩小字符串到 `AdapterSlug` (官方和供应商-官员) |
| `listPlatformAdapters()` 编号 : `listStateAdapters()` | 官方和供应商官方条目按流星分类 |
| `getFeatureSupport(adapterOrSlug, key)` | `{ status, label? }` \* 恢复未申报的能力 `{ status: "no" }` |
| `getFeatureCategories(type)` | 用于显示的能力密钥和标签 |
| `listEnvVars(slug)` 编号 : `getSecretEnvVars(slug)` | 平整、去重复的 Env vars; 社区适配器空置 |
| `ADAPTERS` 编号 : `COMMUNITY_ADAPTERS` | 被 sult 键入的条目 |
| `ADAPTER_NAMES` | 官方和供应商官方流涕 |
| `PLATFORM_FEATURE_CATEGORIES` 编号 : `STATE_FEATURE_CATEGORIES` | 每个显示标签的能力键 |

这个 `chat/adapters` 子路径 `chat` 套件是本套件中官方和供应商官方API被贬值后再出口.

## 添加适配器

每个适配器是一个文件在 `src/adapters/<group>/<slug>.ts`,注册于 `src/adapters/index.ts`,其中有一个文件页 `apps/docs/content/adapters/<group>/`。见 [发布您的适配器](https://chat-sdk.dev/docs/contributing/publishing#listing-on-chat-sdkdev) 社区名单 [列出供应商官方适配器](https://chat-sdk.dev/docs/contributing/vendor-official) 供应商正式上市.

## AI 编码代理

如果您使用OpenAI Codex, Claude Code, 或 Cursor 等AI编码代理, 在写入代码前安装 Chat SDK 技能, 使其了解 SDK API, 适配器模式, 以及项目常规 .

```bash
npx skills add vercel/chat
```

关于可代理阅读的文件,见 [聊天- sdk.dev/llms.txt](https://chat-sdk.dev/llms.txt) (页数索引)或 [聊天- sdk.dev/llms- full.txt](https://chat-sdk.dev/llms-full.txt) (全文).

## 许可证

麻省理工学院

## 常见问题

### @chat-adapter/catalog 是什么？

Chat SDK 适配器的目录: 软件包、 能力和设置要求, 没有适配器依赖性

### 如何安装 @chat-adapter/catalog？

在项目目录运行 npm install @chat-adapter/catalog，或使用 pnpm add / yarn add / bun add。

### @chat-adapter/catalog 支持 TypeScript 吗？

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

### @chat-adapter/catalog 支持 ESM 还是 CommonJS？

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

### @chat-adapter/catalog 需要什么版本的 Node\.js？

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

### @chat-adapter/catalog 可以商用吗？

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

### @chat-adapter/catalog 的下载量有多少？

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

### @chat-adapter/catalog 还在维护吗？

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