# @clozeinc/forge-api 中文文档

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

版本：2026\.11\.2
npm 元数据更新时间：2026-11-07T03:08:46.891Z
中文译文更新时间：2026-11-10T04:16:16.245Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40clozeinc/forge-api
原文对照：https://npmcn.com/package/%40clozeinc/forge-api/?lang=original

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

- 包体积（解压后）：635 kB，79 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-09-08T19:15:23.706Z
- 最新版本发布：2026-11-07T03:08:46.642Z
- 近 30 天下载量：2393（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

Cloze Forge API 的TypeScript客户端. 被Cloze Forge应用模板的脚手架所使用.

## 安装

```sh
npm install @clozeinc/forge-api
```

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

## README

# @clozeinc/forge-api

Cloze Forge API 的TypeScript客户端. 被用在脚手架上 Cloze Forge 应用模板.

## 安装

```sh
npm install @clozeinc/forge-api
```

## 使用量

```ts
import { Cloze } from "@clozeinc/forge-api";

const cloze = new Cloze();

const { data, error } = await cloze.projects.get({
  query: { id: "direct:12345" },
});

if (error) {
  // transport / HTTP failure
} else if (data.errorcode !== 0) {
  // application-level Cloze error (data.message has details)
} else {
  const project = data.project;
}
```

成绩= `!error && data.errorcode === 0`. 两层关系——礼物 `data` 单靠自己是不够的.

## 住在这里的东西

-   生成的 `Cloze` 类别和每种资源(`People`, (中文(简体) ), `Projects`, (中文(简体) ), `Companies`, (中文(简体) ), `Timeline`, (中文(简体) ), `Analytics`, (中文(简体) ), `Team`, (中文(简体) ), `User`, (中文(简体) ), `Webhooks`, (中文(简体) ), `Messages`, (中文(简体) ), `Account`\+ 每个请求/答复类型.
-   自动检测三种运行时环境的传输接线:
    1.  嵌入 Cloze 主机 iframe = 向父程序请求 窗口结束 `postMessage`。 。 。 .
    2.  运行在一个 `cloze.app` 编号 : `cloze.build` 子域 - 使用 网站的会话 cookie 加上 `X-CSRF` 头曰.
    3.  独立在别处 解决无记名标志 明确 `auth` 配置, a `?api_key=` URL 参数, 或提示 .

需要超越运输的消费者可以自行通过 `client` 改为 `new Cloze({ client })` 或导入 `createClientConfig` 财务报告和审定财务报表 `postMessageFetch` 从软件包根开始,然后编出自己的设置.

## 不要手动编辑 `.gen.ts` 文件

结束于 `.gen.ts` 由 `@hey-api/openapi-ts` 从 克洛兹OpenAPI spec (`forge-openapi.json`) (中文(简体) ). 他们被重新生成 批发——手版编辑会丢失.

运行时的行为 `src/api-config.ts` 财务报告和审定财务报表 `src/iframe-transport.ts`;这些可以编辑.

## 常见问题

### @clozeinc/forge-api 是什么？

Cloze Forge API 的TypeScript客户端\. 被Cloze Forge应用模板的脚手架所使用\.

### 如何安装 @clozeinc/forge-api？

在项目目录运行 npm install @clozeinc/forge-api，或使用 pnpm add / yarn add / bun add。

### @clozeinc/forge-api 支持 TypeScript 吗？

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

### @clozeinc/forge-api 支持 ESM 还是 CommonJS？

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

### @clozeinc/forge-api 可以商用吗？

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

### @clozeinc/forge-api 的下载量有多少？

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

### @clozeinc/forge-api 还在维护吗？

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