@fayz-ai/orders

中文文档
0.3.2发布于 2026/11/11MITTypeScriptES Module近 30 天下载 7484

Fayz SDK orders context — the order domain and its status flow, the repository port and adapters, the store and UI pieces

原始使用文档

@fayz-ai/orders

The orders bounded context: what an order is, how it moves through its kind's flow, where it is stored, and the UI pieces over it.

Status: beta — extracted from @fayz-ai/plugin-orders, which composes it and still exports every name it had. Pre-1.0: minor APIs may change before 1.0.

Built to the shape in docs/platform/PATTERNS.md. There is no entry file: each module is imported by its path.

Install

npm install @fayz-ai/orders

Modules

ImportWhat it holds
@fayz-ai/orders/domain/orderRestaurantOrder, RestaurantOrderItem, OrdersSummary and the pure rules (getNextStatus, canMoveTo, boardColumnFor, summarizeOrders, commercialColumnOf…)
@fayz-ai/orders/data/providerOrdersDataProvider, the repository port
@fayz-ai/orders/data/supabasecreateSupabaseOrdersProvider over the core order archetype (v_orders), read-only unless given writes
@fayz-ai/orders/data/platformcreateFayzOrdersProvider over the Fayz data API
@fayz-ai/orders/data/mockcreateMockOrdersProvider, the same contract in memory
@fayz-ai/orders/storecreateOrdersStore(provider, hooks): lists, the active board, lifecycle events and hooks
@fayz-ai/orders/components/*presentational pieces: OrderBoardCard, CommercialOrderCard, OrderStatusDot, PaymentStateBadge

The screens stay in @fayz-ai/plugin-orders: they compose the shell's order list, detail rail and record picker, which a domain package does not import.

import { getNextStatus } from '@fayz-ai/orders/domain/order'
import { createMockOrdersProvider } from '@fayz-ai/orders/data/mock'
import { createOrdersStore } from '@fayz-ai/orders/store'

const store = createOrdersStore(createMockOrdersProvider())
await store.getState().fetchActiveOrders()

Words used here are defined in GLOSSARY.md.

版本与发布记录

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

版本发布日期距今
0.3.2latest2026/11/112 天前
0.3.12026/11/113 天前
0.3.02026/11/104 天前
0.2.52026/11/067 天前
0.2.42026/11/068 天前
0.2.32026/11/068 天前

其他发布通道:canary → 0.2.0-canary.20261028153856。

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

@fayz-ai/orders 是什么?

Fayz SDK orders context — the order domain and its status flow, the repository port and adapters, the store and UI pieces

如何安装 @fayz-ai/orders?

在项目目录运行 npm install @fayz-ai/orders,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、lucide-react(>=0.400.0 <1.0.0)、@supabase/supabase-js(^2.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/orders 支持 TypeScript 吗?

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

@fayz-ai/orders 支持 ESM 还是 CommonJS?

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

@fayz-ai/orders 可以商用吗?

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

@fayz-ai/orders 的下载量有多少?

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

@fayz-ai/orders 还在维护吗?

最新版本 0.3.2 发布于 2026/11/11(2 天前);至今共发布 38 个版本,其中过去 12 个月发布了 38 个;首次发布于 2026/10/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。