@fayz-ai/contracts

中文文档
0.7.0发布于 2026/11/05MITTypeScriptES Module近 30 天下载 5325

The canonical models every Fayz product and the integration service agree on: a delivery order, its status machine, its commands, and the sink port a product fills. No React, no Supabase, no provider shapes.

原始使用文档

@fayz-ai/contracts

Status: preview

The canonical models that every Fayz product and the integration service agree on. Seam 2 of ADR 0003 (control-sdk-backend/docs/0003-where-logic-lives.md): these are the contract, versioned here, consumed by the service, by a plugin's sink, and later by the screens as the bodies of the data API.

What is here, and what is deliberately not:

  • CanonicalOrder v1: one delivery order, whatever marketplace it came from. Money is in minor units (centavos) as integers. No provider's shape leaks in: a normaliser in the service turns an iFood or OpenDelivery payload into this.
  • OrderStatus and nextStatus: the status machine, monotonic, cancellation final.
  • OrderCommand, availableCommands, commandObserved: what a kitchen may do to an order in a given status, and how to tell a command landed.
  • OrderSink and Binding: the port a product fills to receive orders. The service calls it; @fayz-ai/plugin-orders/server and V1's adapter implement it with one SQL function each.

No React, no Supabase, no runtime dependency beyond zod.

版本与发布记录

@fayz-ai/contracts 共发布 15 个版本,首次发布于 2026/10/14;过去 12 个月发布了 15 个版本。

版本发布日期距今
0.7.0latest2026/11/058 天前
0.6.02026/10/3015 天前
0.6.0-canary.20261028153856canary2026/10/2816 天前
0.6.0-canary.202610281427492026/10/2816 天前
0.6.0-canary.202610281406172026/10/2816 天前
0.6.0-canary.202610281123272026/10/2817 天前

关于 @fayz-ai/contracts 的常见问题

@fayz-ai/contracts 是什么?

The canonical models every Fayz product and the integration service agree on: a delivery order, its status machine, its commands, and the sink port a product fills. No React, no Supabase, no provider shapes.

如何安装 @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 和提交记录判断。