# @ever-works/contracts 中文文档

规范地址：https://npmcn.com/package/%40ever-works/contracts/

版本：1\.0\.19
npm 元数据更新时间：2026-11-03T08:55:28.042Z
中文译文更新时间：2026-11-14T01:17:36.197Z
软件包许可：AGPL-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40ever-works/contracts
原文对照：https://npmcn.com/package/%40ever-works/contracts/?lang=original
项目主页：https://github.com/ever-works/ever-works/tree/main/packages/contracts#readme
源码仓库：https://github.com/ever-works/ever-works

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

- 包体积（解压后）：5.7 MB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-09-20T22:31:51.495Z
- 最新版本发布：2026-11-03T08:55:27.553Z
- 近 30 天下载量：7412（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 19 个）

## 中文简介

Ever Works平台的共享类型定义和合同

## 安装

```sh
npm install @ever-works/contracts
```

也可以使用：`pnpm add @ever-works/contracts`、`yarn add @ever-works/contracts`、`bun add @ever-works/contracts`

## README

# @ever-works/ 合同

共享类型Script类型定义和跨Ever Works平台使用的无运行时间合同.

## 概览

这个软件包包含了其他每个软件包和app所依赖的交叉类型原始——工作项目,域模型,形成计划,以及API合同. 它的运行时间依赖性为零,同时作为无害环境管理和CJS发布,从而可以从Node.js,Next.js,浏览器,以及插件系统中消费.

`@ever-works/contracts` 是一个纯型包:没有NestJS,没有LangChain,没有I/O. 需要由API,网络应用,以及独立插件共享的任何东西都在这里居住.

## 安装

```bash
pnpm add @ever-works/contracts
```

## 子路径导出

| 导入路径 | 目录 |
| --- | --- |
| `@ever-works/contracts` | 再出口 `item`, (中文(简体) ), `domain`,以及 `form` (默认桶) |
| `@ever-works/contracts/item` | `ItemData`,项目生命周期状态,项目字段形状 |
| `@ever-works/contracts/domain` | `DomainType`,域类元数据 |
| `@ever-works/contracts/form` | 窗体字段计划( E)`x-widget`, (中文(简体) ), `x-secret`(单位:百分数) |
| `@ever-works/contracts/api` | REST API 请求/响应形状 |

## 使用量

```typescript
import type { ItemData } from '@ever-works/contracts/item';
import type { DomainType } from '@ever-works/contracts/domain';
import type { JsonSchema } from '@ever-works/contracts/form';

const item: ItemData = {
    name: 'Example',
    slug: 'example'
    // ...
};
```

## 为什么是单独的包裹?

-   **插件保持轻量级.** 插件只导入类型——没有NestJS,没有DB,没有代理运行时间.
-   **类型漂移在编译时被捕获 .** API,web,代理,和插件都共享相同的真理源.
-   **越跑越快的安全.** 纯TypeScript表示它为Node,浏览器,Edge以及不附带条件出口的Workers所构建.

## 构建

```bash
pnpm --filter @ever-works/contracts build      # tsup -> ESM + CJS + .d.ts
pnpm --filter @ever-works/contracts type-check # tsc --noEmit
```

## 文档

-   [工程文档](https://docs.ever.works/)
-   [仓库](https://github.com/ever-works/ever-works)
-   [插件系统合同](https://npmcn.com/package/%40ever-works/plugin/README.md)

## 许可证

AGPL-3.0 导弹

## 常见问题

### @ever-works/contracts 是什么？

Ever Works平台的共享类型定义和合同

### 如何安装 @ever-works/contracts？

在项目目录运行 npm install @ever-works/contracts，或使用 pnpm add / yarn add / bun add。

### @ever-works/contracts 支持 TypeScript 吗？

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

### @ever-works/contracts 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @ever-works/contracts 可以商用吗？

@ever-works/contracts 使用 AGPL-3\.0 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @ever-works/contracts 的下载量有多少？

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

### @ever-works/contracts 还在维护吗？

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