# @antelopejs/interface-dms 中文文档

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

版本：0\.12\.0
npm 元数据更新时间：2026-11-04T20:34:18.384Z
中文译文更新时间：2026-11-06T06:26:15.641Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.3 MB，1048 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@antelopejs/interface-api \>=0\.3\.0 \<1\.0\.0，@antelopejs/interface-core \>=0\.4\.0 \<1\.0\.0，@antelopejs/interface-api-util \>=0\.1\.3 \<1\.0\.0，@antelopejs/interface-data-api \>=0\.6\.0 \<1\.0\.0，@antelopejs/interface-database \>=0\.1\.11 \<1\.0\.0，@antelopejs/interface-file-storage \>=0\.1\.4 \<1\.0\.0，@antelopejs/interface-database-decorators \>=0\.1\.12 \<1\.0\.0
- 首次发布：2026-09-16T22:55:15.792Z
- 最新版本发布：2026-11-04T20:34:17.968Z
- 近 30 天下载量：14497（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：54（近 12 个月 54 个）

## 中文简介

DMS的公共羚羊JS接口:页面,组件,权限,租赁,认证,通知和HTML渲染.

## 安装

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

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

## README

# `@antelopejs/interface-dms`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-dms?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-dms) [![License](https://img.shields.io/npm/l/@antelopejs/interface-dms?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-dms/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/interfaces)

藏羚羊JS DMS的公共合同:页面和组件,权限和租赁,认证,通知和HTML渲染.

## 它会做什么

-   宣布页面、类别、模块和页面扩展(`/page`表格、表格、图表和布局`/base`) (中文(简体) ).
-   登记许可、警卫路线和范围数据给租户(`/permissions`, (中文(简体) ), `/guards`, (中文(简体) ), `/tenant-scoped-model`(......) (中文(简体) ).
-   认证请求和管理用户、会话和外部身份`/auth`) (中文(简体) ).
-   宣布通知类别并发出通知`/notifications`),并让 HTML 模板服务器侧(`/html-render`) (中文(简体) ).
-   让我们对照合同而不是执行而汇编一个模块, [`@antelopejs/dms`](https://www.npmjs.com/package/@antelopejs/dms)。 。 。 .

## 安装

将接口添加到扩展 DMS 的模块中:

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

取决于其范围足够广,每个模块共享一个已安装的复制件,并且从不捆绑或销售:主机和每个模块必须解决同一个已安装的复制件,因为软件包持有活的注册. `@antelopejs/core` 启动时失败 `Incompatible interface package resolution` 当模块解决了另一个副本时.

## 快开始

```ts
import { PageController, RegisterPage, pagesCategory } from "@antelopejs/interface-dms/page";
import { KpiCard } from "@antelopejs/interface-dms/base/kpi-card";

@RegisterPage()
export class SalesPage extends PageController("sales", {
  displayName: "Sales",
  icon: "i-ph-chart-line",
  category: pagesCategory,
}) {
  static revenue = KpiCard({ title: "Revenue", fetchUrl: "/api/sales/revenue" });
}
```

| 导入 | 它所持有的 |
| --- | --- |
| `@antelopejs/interface-dms` | 核心表面:页面、权限、租赁、钩子 |
| `@antelopejs/interface-dms/<module>` | 其中一个单元: `/page`, (中文(简体) ), `/permissions`, (中文(简体) ), `/hooks`, (中文(简体) ), `/db`. |
| `@antelopejs/interface-dms/auth` | 认证:用户、会话、外部身份 |
| `@antelopejs/interface-dms/base` | 组件库:窗体、表格、图表、布局 |
| `@antelopejs/interface-dms/notifications` | 通知类别、对象和交付 |
| `@antelopejs/interface-dms/html-render` | 服务器侧 HTML 模板 |

## 兼容性

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-api` | `>=0.3.0 <1.0.0` | `0.2.0` |
| `@antelopejs/interface-api-util` | `>=0.1.3 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-core` | `>=0.4.0 <1.0.0` | `0.4.0` |
| `@antelopejs/interface-data-api` | `>=0.6.0 <1.0.0` | `0.6.0` |
| `@antelopejs/interface-database` | `>=0.1.11 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-database-decorators` | `>=0.1.12 <1.0.0` | `0.2.0` |
| `@antelopejs/interface-file-storage` | `>=0.1.4 <1.0.0` | `0.1.4` |

A 类 `@antelopejs/dms` 释放执行 `@antelopejs/interface-dms` 区域列表于相容区块 [`dms` 读取](https://npmcn.com/package/%40antelopejs/dms/README.md#compatibility)。 。 。 .

## 文档

-   [DMS 接口](https://npmcn.com/package/%40antelopejs/interface-dms/docs/index.md): cononical 消费者参考书,随此套件发运并发表于 [文件/接口](https://dms.antelopejs.com/docs/interfaces)
-   [核心](https://npmcn.com/package/%40antelopejs/interface-dms/docs/1.core/1.introduction.md), (中文(简体) ), [认证](https://npmcn.com/package/%40antelopejs/interface-dms/docs/2.auth/1.introduction.md), (中文(简体) ), [基础](https://npmcn.com/package/%40antelopejs/interface-dms/docs/3.base/1.introduction.md), (中文(简体) ), [通知](https://npmcn.com/package/%40antelopejs/interface-dms/docs/4.notifications/1.introduction.md), (中文(简体) ), [HTML 渲染器](https://npmcn.com/package/%40antelopejs/interface-dms/docs/5.html-render/1.introduction.md)
-   [页和组件](https://dms.antelopejs.com/docs/building/pages-and-components): 任务指南

可导入文件不一定是支持的 API 。 路径 `internal/`,标记符号 `@internal`,以及 `internal` 命名空间是执行线条,即使通配符导出使其可以到达。 使用这里记载的公开声明和合同.

## 捐款

这个包裹住在 [`AntelopeJS/dms`](https://github.com/AntelopeJS/dms) pnpm 工作空间, 运行时间旁边执行它 。 读取 [捐款额](https://github.com/AntelopeJS/dms/blob/main/CONTRIBUTING.md),则 [仓库读取器](https://github.com/AntelopeJS/dms#contributing) 财务报告和审定财务报表 [一般事务人员(其他职等)](https://github.com/AntelopeJS/dms/blob/main/AGENTS.md)包括公众和内部 释放此软件包( E)**发布 DMS 接口**a 之前 `@antelopejs/dms` 这个版本需要它.

## 许可证

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

## 常见问题

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

DMS的公共羚羊JS接口:页面,组件,权限,租赁,认证,通知和HTML渲染\.

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

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

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

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

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

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

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

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

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

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

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

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