# @adbls/api-types 中文文档

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

版本：1\.9\.27
npm 元数据更新时间：2026-11-04T17:46:56.657Z
中文译文更新时间：2026-11-06T07:43:18.296Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40adbls/api-types
原文对照：https://npmcn.com/package/%40adbls/api-types/?lang=original
项目主页：https://github.com/Adibilis/sdk
源码仓库：https://github.com/Adibilis/sdk

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

- 包体积（解压后）：837 kB，1437 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：zod ^4\.1\.12
- 首次发布：2026-09-27T15:58:13.199Z
- 最新版本发布：2026-11-04T17:46:56.341Z
- 近 30 天下载量：4111（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 39 个）

## 中文简介

为 Adibilis CORE API 生成了 TypeScript 和 zod 类型 。 版本跟踪核心发布标记 1:1.

## 安装

```sh
npm install @adbls/api-types
```

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

## README

# `@adbls/api-types`

为 Adibilis CORE API 生成了 TypeScript + zod 类型. **这里没有手写的.**

## 它是什么(和它没有)

这个软件包是 _构建产出_ ajtg 读取 core 编辑的后端字节码 `mvn process-classes` 将类型输出到 `src/`这就是为什么它发表于 `core/core` 而不是从 `core/SDK` ——在别处出版将意味着重新运行核心的Java 在重播中构建, 或复制生成的输出在重播之间, 这恰恰就是漂移 软件包是用来消除的.

没错 **没有** sDK号. `@adbls/sdk` 由手写(API客户端、表层、结帐、节假日), 取决于这个软件包, 并且再出口实际上需要的符号卫星。 一般的卫星 只安装 SDK .

## 版本合同

A 类 **已发行** 版本为 **1:1 有核心释放标记**数字 : `@adbls/api-types@1.4.2` 没错 核心的 API 表面 `v1.4.2`CI从标签上盖上 `0.0.0` 内 `package.json` 是一个 占位者,绝不是被打倒的.

该套件跟核心图像遵循相同的三个通道,因此两者永远无法漂移:

| 核心参考文献 | 图像标签 | 软件包版本 | npm 二边形 | 发表于 |
| --- | --- | --- | --- | --- |
| `v1.4.2` | `:v1.4.2` | `1.4.2` | `latest` | npmjs.org (公开) (中文(简体) ) **财务报告和审定财务报表** 福吉乔 |
| `main` | `:latest` | `0.0.0-stage.<run>` | `stage` | 只有福吉乔 |
| `dev` | `:dev` | `0.0.0-dev.<run>` | `dev` | 只有福吉乔 |

发布是公开的,所以任何人都可以建立 前端对核心: `@adbls/sdk` 取决于这个 软件包,是公开的。 预先释放者留在福尔热霍——他们描述的是未释放的API,以及 每次发布一次会淹没公共登记处.

```bash
pnpm add @adbls/api-types          # newest released version (npmjs, no token)
pnpm add @adbls/api-types@dev      # newest dev build (Forgejo, see below)
pnpm add @adbls/api-types@stage    # newest stage build (Forgejo, see below)
```

发行前的发行都是在他们自己的旗下, 所以一个平地 `pnpm add` 从来没有决定一个. 键 `latest` 用于生产卫星 `dev` ,同时针对未释放的 API 更改进行开发.

`@adbls/sdk` 携带自己的铸币局并宣布兼容 _范围_ 在这个包裹上,所以它可以 发送一个没有核心释放的固定, 并声明它说话的核心版本.

## 说完了

发布版本不需要任何信息 : `pnpm add @adbls/api-types zod` 由 npmjs.org 解决.

给 `dev` 财务报告和审定财务报表 `stage` 预发版,将范围映射到Forgejo:复制 `.npmrc.example` 改为 `.npmrc` 导出 a **读取** 符号 。 地图是每个范围,所以虽然它已经存在 _每个_ `@adbls/*` 软件包——包括发行品——来自Forgejo,它也携带这些软件.

```ini
@adbls:registry=https://forge.cloud.adibilis.ch/api/packages/core/npm/
//forge.cloud.adibilis.ch/api/packages/core/npm/:_authToken=${NPM_TOKEN}
```

```bash
export NPM_TOKEN=<read token>
pnpm add @adbls/api-types zod
```

`zod` 是一个 **端点** 依赖你就能解决一个问题.

> Npm 注册符号是构建时间,与 **WeBSITE API 密钥** (单位:千美元) 卫星在运行时用于调用核心。 不同的一生,不同的发光线——不要 把他们拼起来.

### 出版(维护者)

CI 与 Org 级出版 `REGISTRY_TOKEN`. Forgejo服务于集装箱登记和npm 从一个软件包子系统登记,两者都需要 `write:package`,所以这个符号已经 `docker login` 图像构建封面 `npm publish` 也不存在单独的 npm 秘密 .

然后通过可信赖的出版方式发布标记到npmjs.org, npm只向 GitHub, GitLab 和 GitLab 提供 CircleCI——不是福热霍. 所以,释放工作pings `publish-api-types` 在公众中 [阿迪比利斯/斯德克语](https://github.com/Adibilis/sdk) repo( 机密 `SDK_DISPATCH_TOKEN`),该副本 (原始内容存档于2018-09-26). the Forgejo tarball to npmjs. 它的时钟时刻表 抓住了错过了的接力。 npm 符号不存在 .

预先释放的消费者仍需要自己的 **读取**\- 扫描 Forgejo 标志;不要发 发表一.

## 你得到的东西

-   **验证的 DTO** → zod schema+其推断类型: `ContactRequestModel` (司马)和 `ContactRequest` (类型).
-   **数字** → `UserRoleModel` (司马)和 `UserRole` (类型).
-   **未验证的 DTO** − 一个纯接口,默认出口,并按名称再出口 枪管.

```ts
import { ContactRequestModel, type ContactRequest } from '@adbls/api-types';

const parsed = ContactRequestModel.safeParse(formValues);
```

Schemas 镜像后端的豆类验证: a `@NotBlank` 字段为 **所需经费** 输入 计划,所以 `parse({})` 而不是默默地通过.

## 说明和限制

-   **普通JS输出.** 发电机释放出无延伸的相对进口,节点的无害环境管理装载器 拒绝;CJS解决了它们,而每个消耗的捆绑者(Next.js,Vite)都会处理CJS精细. 类型 来自 `.d.ts` 无论是哪种方式的文件.
-   **无角服务.** 构造会发出它们( jattg- angular 在插件类路径上) 但路径 它们通过一个丢弃目录 `typesOnlyOutputDirectories` - 他们进口 `@angular/*` 财务报告和审定财务报表 将打破卫星的构造.
-   **枪管产生** (单位:千美元)`scripts/generate-index.mjs`运行为 `prebuild`. ajtg 擦伤 `src/` ,所以它不能是一个承诺文件.
-   `src/` 财务报告和审定财务报表 `dist/` {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}被点燃了 以 `mvn clean package -DskipTests` 从还款 根,则 `pnpm build` 在这里.

## 常见问题

### @adbls/api-types 是什么？

为 Adibilis CORE API 生成了 TypeScript 和 zod 类型 。 版本跟踪核心发布标记 1:1\.

### 如何安装 @adbls/api-types？

在项目目录运行 npm install @adbls/api-types，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.1\.12）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @adbls/api-types 支持 TypeScript 吗？

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

### @adbls/api-types 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @adbls/api-types 可以商用吗？

@adbls/api-types 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @adbls/api-types 的下载量有多少？

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

### @adbls/api-types 还在维护吗？

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