# @antelopejs/dms-saas 中文文档

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

版本：0\.10\.0
npm 元数据更新时间：2026-11-04T22:50:22.081Z
中文译文更新时间：2026-11-06T08:33:07.128Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.7 MB，1203 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- 首次发布：2026-09-16T22:59:17.364Z
- 最新版本发布：2026-11-04T22:50:21.778Z
- 近 30 天下载量：3811（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

藏羚羊JS DMS的SaaS模块:自助注册和定价,门的功能计划,花纹计费,工作空间设置和一个后台.

## 安装

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

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

## README

# `@antelopejs/dms-saas`

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

注册,计划,花纹计费 和一个后台办公室 一个多租户的羚羊JS DMS.

![The SaaS dashboard of the Helio demo: what needs attention, recurring revenue, paid invoices and workspaces by status](https://npmcn.com/package/%40antelopejs/dms-saas/docs/images/captures/dashboard.webp)

## 它会做什么

-   增加公共定价和注册屏幕,合法页面,OAuth登录的完成屏幕.
-   定义每个工作空间所能做的、具有特征、限制、试验和座位定价的许可限制的计划.
-   通过花旗的账单:结账,订阅,发票,信用票据,退税和花旗税,计划保持同步.
-   给工作空间所有者设置:一般,成员,计费和数据导出.
-   给予平台所有者一个后台:工作空间,用户,片段,计划迁移,计费规则和法律文件.

## 安装

从装入的工程的根部运行羚羊JS CLI `@antelopejs/dms` 具有数据库模块、电子邮件模块和文件存储的多租户模式:

```bash
ajs project modules add @antelopejs/dms-saas
```

## 快开始

给模块环境的条纹键 :

```ts
// antelope.config.ts
import { defineConfig } from "@antelopejs/interface-core/config";

export default defineConfig({
  name: "my-saas",
  envOverrides: {
    STRIPE_SECRET_KEY: "modules.dms-saas.config.stripe.secretKey",
    STRIPE_PUBLISHABLE_KEY: "modules.dms-saas.config.stripe.publishableKey",
    STRIPE_WEBHOOK_SECRET: "modules.dms-saas.config.stripe.webhookSecret",
  },
  modules: {
    "dms-saas": {
      source: { type: "package", package: "@antelopejs/dms-saas", version: "^0.9.0" },
      config: {
        stripe: {
          secretKey: "sk_test_placeholder",
          publishableKey: "pk_test_placeholder",
          webhookSecret: "whsec_placeholder",
        },
      },
    },
    // dms, api, mongodb, auth-jwt, nodemailer, file-storage-local, ...
  },
});
```

然后指向条纹网路 `https://<api>/api/saas/webhooks/stripe`,并在 **计划**登记打开了计划的所有工作空间。 有占位符键,模块仍会运行,需要花脸的块会这么说. 对于没有花纹的部署,也设置 `registration.paymentMethod` 改为 `none`,或者注册屏幕保持其牌步.

## 兼容性

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-api` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-api-util` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-core` | `>=0.4.0 <1.0.0` | `0.4.0` |
| `@antelopejs/interface-data-api` | `>=0.6.1 <1.0.0` | `0.6.1` |
| `@antelopejs/interface-database` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-database-decorators` | `>=0.2.0 <1.0.0` | `0.2.0` |
| `@antelopejs/interface-dms` | `>=0.12.0 <1.0.0` | `0.12.0` |
| `@antelopejs/interface-dms-automation` | `>=0.6.0 <1.0.0` | `0.6.0` |
| `@antelopejs/interface-dms-saas` | `workspace:^` | `0.6.1` |

模块还需要一个执行 `@antelopejs/interface-dms` 区域,以及 `@antelopejs/dms-frontend` 区域中的渲染器,其前端模块宣布在 `engines["@antelopejs/dms-frontend"]` 联 合 国 `frontend-vue/package.json`编辑 `ajs dms` CLI拒绝用这个范围以外的渲染器来建造.

模块使用 API 版本调用 Strebe `2026-08-26.dahlia`在更新现有数据库之前,请读作 [升级](https://dms.antelopejs.com/docs/modules/saas/faq#upgrading)。 。 。 .

## 文档

-   [导言](https://dms.antelopejs.com/docs/modules/saas/introduction)
-   [安装](https://dms.antelopejs.com/docs/modules/saas/installation)
-   [配置](https://dms.antelopejs.com/docs/modules/saas/configuration)
-   [使用量](https://dms.antelopejs.com/docs/modules/saas/usage/public-screens)
-   [扩展](https://dms.antelopejs.com/docs/modules/saas/extending)
-   [财务问题](https://dms.antelopejs.com/docs/modules/saas/faq)
-   [条纹](https://dms.antelopejs.com/docs/modules/saas/stripe)
-   [业务](https://dms.antelopejs.com/docs/modules/saas/operations)

向导的消息来源 [`packages/dms-saas/docs`](https://github.com/AntelopeJS/dms-saas/tree/main/packages/dms-saas/docs)模块将 `dms-saas` Claude代码技巧 [`packages/dms-saas/skills`](https://github.com/AntelopeJS/dms-saas/tree/main/packages/dms-saas/skills),在 `antelopeJs.skills`。 。 。 .

## 捐款

这个包裹住在 [`AntelopeJS/dms-saas`](https://github.com/AntelopeJS/dms-saas) pnpm 工作空间旁边 `@antelopejs/interface-dms-saas`读取 [捐款额](https://github.com/AntelopeJS/dms-saas/blob/main/CONTRIBUTING.md) 编辑 [仓库读取器](https://github.com/AntelopeJS/dms-saas#contributing) 用于开发命令.

## 许可证

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

## 常见问题

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

藏羚羊JS DMS的SaaS模块:自助注册和定价,门的功能计划,花纹计费,工作空间设置和一个后台\.

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

在项目目录运行 npm install @antelopejs/dms-saas，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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

