# @antelopejs/interface-dms-builder 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-dms-builder/

版本：0\.4\.0
npm 元数据更新时间：2026-11-04T23:06:14.145Z
中文译文更新时间：2026-11-06T22:45:37.385Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-dms-builder
原文对照：https://npmcn.com/package/%40antelopejs/interface-dms-builder/?lang=original
项目主页：https://dms.antelopejs.com/docs/modules/builder/extending
源码仓库：https://github.com/AntelopeJS/dms-builder

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

- 包体积（解压后）：624 kB，64 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@antelopejs/interface-core \>=0\.2\.4 \<1\.0\.0
- 首次发布：2026-09-16T22:55:46.983Z
- 最新版本发布：2026-11-04T23:06:13.649Z
- 近 30 天下载量：2220（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

用于DMS构建器的羚羊JS接口:从另一个模块创建并编辑DMS项目中的页面,块,资源和查询.

## 安装

```sh
npm install @antelopejs/interface-dms-builder
```

也可以使用：`pnpm add @antelopejs/interface-dms-builder`、`yarn add @antelopejs/interface-dms-builder`、`bun add @antelopejs/interface-dms-builder`

## README

# `@antelopejs/interface-dms-builder`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-dms-builder?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-dms-builder) [![License](https://img.shields.io/npm/l/@antelopejs/interface-dms-builder?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-dms-builder/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Documentation](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://dms.antelopejs.com/docs/modules/builder/extending)

从代码编辑一个DMS项目的页面,块,资源和查询的AntelopeJS接口.

## 它会做什么

-   创建和编辑页面、分类及其块树,并进行操作,例如 `CreatePage`, (中文(简体) ), `AddBlock`, (中文(简体) ), `ConfigureBlock`, (中文(简体) ), `MoveBlock` 财务报告和审定财务报表 `SetPageBlocks`。 。 。 .
-   生成资源, 每个 a `Table`页:1 `DataController` 和模范,并编辑他们的字段.
-   将查询模板编成模型方法和页面路由,因此一卡获得一个没有手写代码的数字.
-   报告每个区块类型和构建者可以写的DataType,并附有其选项的计划(`GetCatalog`) (中文(简体) ).
-   返回每个变异为 `OpResult`。它持有在成功时更改的文件,否则会输入错误.

每个行动都是 `InterfaceFunction` 路由到 [`@antelopejs/dms-builder`](https://www.npmjs.com/package/@antelopejs/dms-builder)。该模块对工程进行解析,将编辑应用为 AST 重写,只有在工程仍然进行打字检查时才写.

## 安装

在调用构建器的模块中添加接口.

```bash
pnpm add @antelopejs/interface-dms-builder
```

## 快开始

以下代码创建一页并在上面放入了KPI卡.

```ts
import { AddBlock, CreatePage } from "@antelopejs/interface-dms-builder";

const page = await CreatePage({
  name: "revenue",
  displayName: "Revenue",
  category: "pages",
  icon: "i-ph-chart-line",
});
if (!page.ok) {
  throw new Error(`could not create the page: ${page.error.code}`);
}

const block = await AddBlock({
  page: page.data.ref,
  name: "total",
  type: "KpiCard",
  config: { title: "Total revenue", icon: "i-ph-currency-eur" },
});
if (!block.ok) {
  throw new Error(`could not add the block: ${block.error.code}`);
}
```

## 兼容性

界面宣布此对等依赖 :

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.4.0` |

这个 `@antelopejs/dms-builder` 模块执行此接口。 这个 `@antelopejs/interface-dms-builder` 相容区块中的行 [模块读取器](https://npmcn.com/package/%40antelopejs/dms-builder/README.md#compatibility) 给出每个模块的释放工具的接口范围。 执行不是接口软件包的同伴依赖。 它只在发展中运行,除非它 [`api.enabled`](https://dms.antelopejs.com/docs/modules/builder/configuration) 选项打开.

## 文档

-   [扩展构建者](https://dms.antelopejs.com/docs/modules/builder/extending) 覆盖接口和HTTP API.
-   [界面参考](https://npmcn.com/package/%40antelopejs/interface-dms-builder/docs/1.introduction.md) 是犬科合同。 它带着这个包装船,并发表在 [/docs/模块/建设者/参考](https://dms.antelopejs.com/docs/modules/builder/reference)。 。 。 .
-   [没有代码的图表](https://npmcn.com/package/%40antelopejs/interface-dms-builder/docs/10.a-chart-without-code.md) 从选择一个计量到重新打开的页面都遵循一个图表.

## 捐款

这个包裹住在 [`AntelopeJS/dms-builder`](https://github.com/AntelopeJS/dms-builder) pnpm 工作空间,位于执行它的模块旁边. 读取 [捐款额](https://github.com/AntelopeJS/dms-builder/blob/main/CONTRIBUTING.md) 编辑 [仓库读取器](https://github.com/AntelopeJS/dms-builder#contributing) 用于开发命令。 在模块执行之前释放此软件包 .

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-dms-builder/LICENSE)

## 常见问题

### @antelopejs/interface-dms-builder 是什么？

用于DMS构建器的羚羊JS接口:从另一个模块创建并编辑DMS项目中的页面,块,资源和查询\.

### 如何安装 @antelopejs/interface-dms-builder？

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

### @antelopejs/interface-dms-builder 支持 TypeScript 吗？

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

### @antelopejs/interface-dms-builder 支持 ESM 还是 CommonJS？

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

### @antelopejs/interface-dms-builder 可以商用吗？

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

### @antelopejs/interface-dms-builder 的下载量有多少？

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

### @antelopejs/interface-dms-builder 还在维护吗？

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