# @fayz-ai/plugin-orders 中文文档

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

版本：0\.24\.12
npm 元数据更新时间：2026-11-11T14:55:08.573Z
中文译文更新时间：2026-11-14T12:07:48.370Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：901 kB，85 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：7 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，zustand ^4\.5\.0 \|\| ^5\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，lucide-react \>=0\.400\.0 \<1\.0\.0
- 首次发布：2026-06-19T20:20:33.769Z
- 最新版本发布：2026-11-11T14:55:08.236Z
- 近 30 天下载量：13190（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：118（近 12 个月 118 个）

## 中文简介

Fayz SDK — 插件顺序插件

## 安装

```sh
npm install @fayz-ai/plugin-orders
```

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

## README

# @fayz-ai/plugin - 顺序

> 餐厅现场订单板——坎班,历史,以及知道烹饪内容的AI.

[![npm](https://img.shields.io/npm/v/@fayz-ai/plugin-orders.svg)](https://www.npmjs.com/package/@fayz-ai/plugin-orders) [![license](https://img.shields.io/npm/l/@fayz-ai/plugin-orders.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)

**状态 :** β-前1.0 (中文(简体) ). 核心表面稳定;一些后端侧面(见 `PLUGIN_PATTERNS.md`)仍在着陆. API在1.0前可能会有变化.

命令是业务的心跳. `plugin-orders` 给一家餐厅——或任何垂直的食物——一个实时订单板:用餐、外卖和运送都流过一个坎班,后面有历史。 这是地板工作人员实际居住的地表.

这是先建成的供应商:a `MenuDataProvider`\- 发现有模拟供应商的船 即时演示和 `createFayzOrdersProvider` 对于真实数据。 订单来源,货币,和标签都是可配置的,主机AI助手可以阅读今天的概要,列出活性订单,甚至可以创建出新的订单. 重点不是一次性的 POS —— 这是一个插件,你冲入 `defineSaas` 在菜单和库存旁边应用 来组成一个完整的餐厅SaaS.

## 里面的东西

-   **命令的背景** ——订单模型,状态流,适配器和存储活在 [`@fayz-ai/orders`](https://npmcn.com/package/packages/orders/README.md); 此插件将它们编成显示器、 屏幕、 设置和连接器
-   **导航+页面** - 一个 `/orders` 带相机板的表面( name`OrderKanbanView`)和命令历史
-   **可插入数据** - 注入一个 `OrdersDataProvider`,使用时 `createFayzOrdersProvider`,或者回到被捆绑的模拟提供者
-   **可配置命令来源** ——缺餐取出;送出/取出模块切换上下
-   **AI 工具** —— 说 `getOrdersSummary` (计算、收入、平均票价), `getActiveOrders` (按类型/状况分类的过滤器)和 `createOrder` (维持新顺序与项目)
-   **设置 + i18n** 命令源和首选项的设置面板,外加捆绑的地块
-   **钩子** —— 说 `onOrderCompleted` 调用, 加 `menuItemLookup` 编号 : `staffLookup` 实体查询

## 安装

```bash
npm install @fayz-ai/plugin-orders
```

端点 : `@fayz-ai/core`, (中文(简体) ), `@fayz-ai/admin`, (中文(简体) ), `@fayz-ai/sdk` (+反应,反应-度). 宣布依赖 `menu` 插件 .

## 使用量

```tsx
import { defineSaas } from '@fayz-ai/admin'
import { createOrdersPlugin, createFayzOrdersProvider } from '@fayz-ai/plugin-orders'

export const app = defineSaas({
  // ...
  plugins: [
    createOrdersPlugin({
      modules: { delivery: true, takeout: true },
      currency: { code: 'BRL', locale: 'pt-BR', symbol: 'R$' },
      dataProvider: createFayzOrdersProvider({ /* ... */ }),
      onOrderCompleted: async (order) => { /* fire a webhook, print, etc. */ },
    }),
  ],
})
```

选项 : `modules`, (中文(简体) ), `labels`, (中文(简体) ), `currency`, (中文(简体) ), `navPosition`, (中文(简体) ), `navSection`, (中文(简体) ), `scope`, (中文(简体) ), `verticalId`, (中文(简体) ), `dataProvider`, (中文(简体) ), `menuItemLookup`, (中文(简体) ), `staffLookup`, (中文(简体) ), `onOrderCompleted`, (中文(简体) ), `orderSources`。 。 。 .

## 费兹SDK的一部分

Fayz SDK 的可堆放插件 。 取决于 `@fayz-ai/plugin-menu` 和配对 `@fayz-ai/plugin-inventory` 财务报告和审定财务报表 `@fayz-ai/plugin-shop` 食物到现金的完全流动.

## 路线图贡献( I)

建设并不断发展于开阔. 见 [费兹SDK路线图](https://npmcn.com/package/docs/platform/ROADMAP.md#plugin-orders) 对于当前空白,缺失的特征,以及良好的第一问题.

## 常见问题

### @fayz-ai/plugin-orders 是什么？

Fayz SDK — 插件顺序插件

### 如何安装 @fayz-ai/plugin-orders？

在项目目录运行 npm install @fayz-ai/plugin-orders，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、zustand（^4\.5\.0 \|\| ^5\.0\.0）、react-dom（^18\.0\.0 \|\| ^19\.0\.0）、lucide-react（\>=0\.400\.0 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fayz-ai/plugin-orders 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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