# @aalis/api-approval 中文文档

规范地址：https://npmcn.com/package/%40aalis/api-approval/

版本：0\.2\.0
npm 元数据更新时间：2026-10-31T01:45:42.756Z
中文译文更新时间：2026-11-07T00:03:53.696Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aalis/api-approval
原文对照：https://npmcn.com/package/%40aalis/api-approval/?lang=original
项目主页：https://github.com/AalisLabs/Aalis#readme
源码仓库：https://github.com/AalisLabs/Aalis

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

- 包体积（解压后）：33.3 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@aalis/core \>=0\.21\.0 \<1\.0\.0
- 首次发布：2026-10-11T10:58:02.548Z
- 最新版本发布：2026-10-31T01:45:42.612Z
- 近 30 天下载量：2137（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

审批契约：approvals 服务描述符（发起、应答、结算、审批面登记与在场）、审批对象的类型与卡片清洗函数

## 安装

```sh
npm install @aalis/api-approval
```

也可以使用：`pnpm add @aalis/api-approval`、`yarn add @aalis/api-approval`、`bun add @aalis/api-approval`

## README

# @aalis/api-approval

审批契约：模型发起、需要 owner 批准的操作以审批对象的形式发起、推给在场的审批面、由 owner 应答、结算后回给发起方。不含服务实现，默认实现是 `@aalis/plugin-session-server`。

## 角色

-   `approvals`：服务描述符（服务名 `approvals`）。发起方调 `request(req, signal)` 等结算；审批面经绑定门面 `registerSurface(name)` 登记，随激活撤回，每个客户端 `attend` 一次，在场上报与应答都经它。
-   `Approval`、`ApprovalRequest`、`ApprovalOutcome` 等：审批对象、请求与结局的类型。
-   `approval:created`、`approval:settled`：审批推给审批面、结算时发出的事件。
-   `sanitizeForCard(text)`：审批卡显示事实之前的清洗，各审批面共用；`clipForCard(text, limit)` 清洗并截断，交出开头、结尾与中间省略的字数，「省略 N 字」由审批面按读者语言写。
-   应答被拒（`ApprovalResponse` 的 `ok: false`）时 `message` 是给应答人看的原因，可以是文字对象（`@aalis/schema-i18n`），审批面按读者语言渲染。

## 安装

```bash
pnpm add @aalis/api-approval
```

## 使用

```ts
import { approvals, clipForCard } from '@aalis/api-approval';
// 审批面自己的字典（@aalis/schema-i18n 的 defineTexts），「省略 N 字」整句在那里
import { t } from './texts.js';

// uses: { approvals: optional(approvals) }
const surface = caps.approvals.use.registerSurface('cli');
const attendance = surface.attend({ platform: 'cli', userId: 'console' }, {
  requested: approval => {
    const { head, omitted, tail } = clipForCard(approval.facts.command ?? approval.tool, 400);
    // render：按读者语言把文字对象渲染成字符串
    showCard(omitted === 0 ? head : `${head}${render(t('charsOmitted', { count: omitted }))}${tail}`);
  },
  settled: approvalId => closeCard(approvalId),
});
attendance.presence(true);
```

详见 [docs/api/api-approval.md](https://npmcn.com/package/docs/api/api-approval.md)。

## 常见问题

### @aalis/api-approval 是什么？

审批契约：approvals 服务描述符（发起、应答、结算、审批面登记与在场）、审批对象的类型与卡片清洗函数

### 如何安装 @aalis/api-approval？

在项目目录运行 npm install @aalis/api-approval，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@aalis/core（\>=0\.21\.0 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aalis/api-approval 支持 TypeScript 吗？

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

### @aalis/api-approval 支持 ESM 还是 CommonJS？

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

### @aalis/api-approval 可以商用吗？

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

### @aalis/api-approval 的下载量有多少？

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

### @aalis/api-approval 还在维护吗？

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