# @aio-proxy/plugin-sdk 中文文档

规范地址：https://npmcn.com/package/%40aio-proxy/plugin-sdk/

版本：0\.42\.5
npm 元数据更新时间：2026-10-12T16:12:23.104Z
中文译文更新时间：2026-11-06T23:21:13.413Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：86.1 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- 首次发布：2026-07-29T23:34:03.131Z
- 最新版本发布：2026-10-12T16:12:22.625Z
- 近 30 天下载量：2180（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：80（近 12 个月 80 个）

## 中文简介

与提供商和OAuth插件公司签订延长Aio-prooxy的公共合同.

## 安装

```sh
npm install @aio-proxy/plugin-sdk
```

也可以使用：`pnpm add @aio-proxy/plugin-sdk`、`yarn add @aio-proxy/plugin-sdk`、`bun add @aio-proxy/plugin-sdk`

## README

# @aio- proxy/ plugin- sdk

与提供商和OAuth插件公司签订延长Aio-prooxy的公共合同.

## 运行时间兼容性

插件运行时间钩在 aio- proxy Bun 主机内执行 。 阿宝 `>=1.4.0` v1 运行时兼容性 目标。 插件作者可能使用以节点为基础的工具进行开发和类型检查,但在节点下执行 或 undici 不属于 v1 兼容承诺 .

## 已经用这台机器上的签名

OAuth 适配器可以声明 `localSignIn?: OAuthLocalSignIn<AccountOptions, Credential>` 提供供应商 工具已存在的本地登录,以替代其浏览器 OAuth 流量. `source` 是一个 `LocalizedText` 工具的标签,例如 `Codex`。该能力是可选的;现有的适配器保持其浏览器的流动.

-   `detect(context: OAuthLocalSignInContext)` 返回时 `Promise<boolean>` 并检查存在。 它必须 从不解析主机商店,读取秘密,或返回账户细节. 上下文仅包含 `signal`。 。 。 .
-   `read(context: OAuthCredentialImportContext, options: AccountOptions)` 返回时 `Promise<OAuthLoginResult<Credential>>`。只有在用户明确同意后才能读取主机商店 账户。 上下文供应 `progress`, (中文(简体) ), `signal`,可选 `fetch`如证书进口一样.
-   `write?(context: OAuthLocalSignInContext, next: Credential, previous: Credential)` 返回时 `Promise<void>`。 。 。 . 仅用于刷新令牌旋转的商店执行; 仅需要一次性的商店省略 证书副本.

对于适配器 `write`,相同的主机存储内容必须产生来自 `read`:这个框架比较了读取之间 canonical creditic cluises. 不合成证书 字段,或生成每个读取的随机值.

在原子取代之前, `write` 必须重新检查主机仍然持有 `previous`,包括 同样的账户和刷新代号。 如果更改, 则不写就返回 。 完成回写即使 信号在旋转消耗了符号后被中止。 删除提供商从不打电话 `write` 或更改 店主的店铺 将主机证书保存出日志,痕迹,诊断,出错,以及API响应.

## 目录模型元数据

`ModelDescriptor.modelMetadata` 输入模式信息,主机可以合并到上游 元数据层。 内容 `DescriptorModelMetadata` 类型是已发布的子集 `@aio-proxy/types` `ModelMetadataInput`数字 : `name`, (中文(简体) ), `description`, (中文(简体) ), `limit`, (中文(简体) ), `capabilities`,以及 `cost`。 。 。 . `extend` 仍然是用户配置 特性,而插件无法使用。 未知密钥被剥离; 无效 `modelMetadata` 数值被删除 因此,其他描述和目录仍然可用.

```ts
import type { ModelCatalog } from '@aio-proxy/plugin-sdk';

const catalog: ModelCatalog = {
  language: [
    {
      id: 'upstream-model-id',
      displayName: 'Upstream Model',
      modelMetadata: {
        limit: { context: 200_000, output: 32_000 },
        capabilities: { reasoning: true, toolCall: true },
        cost: { input: 1, output: 4 },
      },
      extra: { wireFamily: 'example-v2' },
    },
  ],
  image: [],
  video: [], // Optional; served by a plugin raw resolver for openai-video.
  embedding: [],
  speech: [],
  transcription: [],
  reranking: [],
  extra: { catalogRevision: 2 },
};
```

`extra` 是不透明的,插件- 私人 JSON 数据。 它取代了以前的免费形式 `metadata` 打开 `ModelDescriptor` 财务报告和审定财务报表 `ModelCatalog`,现在提供原始解析器输入 `extra` 改为 `metadata`。 。 。 . 使用 `modelMetadata` 仅针对主机消费模型元数据以及 `extra` 用于线条提示或其他插件状态.

## 常见问题

### @aio-proxy/plugin-sdk 是什么？

与提供商和OAuth插件公司签订延长Aio-prooxy的公共合同\.

### 如何安装 @aio-proxy/plugin-sdk？

在项目目录运行 npm install @aio-proxy/plugin-sdk，或使用 pnpm add / yarn add / bun add。

### @aio-proxy/plugin-sdk 支持 TypeScript 吗？

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

### @aio-proxy/plugin-sdk 支持 ESM 还是 CommonJS？

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

### @aio-proxy/plugin-sdk 可以商用吗？

@aio-proxy/plugin-sdk 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @aio-proxy/plugin-sdk 的下载量有多少？

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

### @aio-proxy/plugin-sdk 还在维护吗？

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