# @fayz-ai/contracts 中文文档

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

版本：0\.7\.0
npm 元数据更新时间：2026-11-05T13:47:38.793Z
中文译文更新时间：2026-11-14T12:15:24.700Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fayz-ai/contracts
原文对照：https://npmcn.com/package/%40fayz-ai/contracts/?lang=original

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

- 包体积（解压后）：575 kB，37 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-10-13T17:29:59.475Z
- 最新版本发布：2026-11-05T13:47:38.537Z
- 近 30 天下载量：5325（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

Canonical models every Fayz产品和集成服务都同意:一个交付订单,它的状态机器,它的指令,和沉槽口一个产品填充. 没有反应,没有Supabase,没有提供者形状.

## 安装

```sh
npm install @fayz-ai/contracts
```

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

## README

# @fayz-ai/ 合同

状态:预览

每个Fayz产品和整合服务 的卡通模型 说定了 ADR 0003的接合物2(`control-sdk-backend/docs/0003-where-logic-lives.md`: 这是合同,在这里, 服务消耗, 插件 下沉,然后在屏幕旁作为数据 API 的正文.

这里有什么,什么是故意的:

-   `CanonicalOrder` v1:一个送货订单,无论来自哪个市场. 钱在小单位(centavos)为整数. 没有提供者的形状 : 服务中的正常人将iFood或Open交付有效载荷变成这个.
-   `OrderStatus` 财务报告和审定财务报表 `nextStatus`:状态机,单调,取消 最终.
-   `OrderCommand`, (中文(简体) ), `availableCommands`, (中文(简体) ), `commandObserved`: 一个厨房可以做什么 命令在特定状态, 如何告诉命令着陆.
-   `OrderSink` 财务报告和审定财务报表 `Binding`:一个产品填充的端口接收订单. 这个 服务称为:; `@fayz-ai/plugin-orders/server` v1 的适配器执行 每个都有一个 SQL 函数.

没有反应,没有Supabase, 没有运行时间依赖 超过zod.

## 常见问题

### @fayz-ai/contracts 是什么？

Canonical models every Fayz产品和集成服务都同意:一个交付订单,它的状态机器,它的指令,和沉槽口一个产品填充\. 没有反应,没有Supabase,没有提供者形状\.

### 如何安装 @fayz-ai/contracts？

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

### @fayz-ai/contracts 支持 TypeScript 吗？

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

### @fayz-ai/contracts 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fayz-ai/contracts 可以商用吗？

@fayz-ai/contracts 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fayz-ai/contracts 的下载量有多少？

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

### @fayz-ai/contracts 还在维护吗？

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