fayzfayz sdk

← Catálogo de plugins

plugin-orders

Beta

@fayz-ai/plugin-orders

Orders are the heartbeat of an operations business. plugin-orders gives a restaurant — or any food vertical — a real-time order board: dine-in, takeout, and delivery flowing across a kanban, with history behind it. It's the surface the floor staff actually live in.

Prévia do plugin-orders como o cliente vê

Visão geral

Comandas para operação de restaurante: um kanban de pedidos por status, com origens dine-in, takeout e delivery. Monta a página /orders. É um plugin vertical (scope: 'vertical') e declara dependência do plugin-menu para o catálogo de itens.

Não empacota migrations. Por padrão roda com um provider mock (em memória) e, para persistir na plataforma Fayz, usa createFayzOrdersProvider com nomes de tabela configuráveis (ordersTable, orderItemsTable). Os lookups de item de menu e de staff são injetados pelo app. O canal stable já pina ^0.3.0.

Para IA, expõe getOrdersSummary, getActiveOrders e createOrder. Status beta / capability parcial.

Quando usar

  • Operação de restaurante que precisa acompanhar comandas em tempo real.
  • Separar pedidos por dine-in, takeout e delivery num kanban.
  • Combinar com o plugin-menu (dependência declarada) para os itens.

Ficha técnica

Pacote@fayz-ai/plugin-orders
Versão0.3.0
Statusbeta
CapabilityCapability parcial
Canal stable^0.3.0
Migrationsnenhuma
FactorycreateOrdersPlugin()

Modelo de dados

Sem tabelas próprias — este plugin usa a biblioteca core / archetype (mesma regra: tenant_id + RLS). Veja Modelo de dados.

Tools de IA

idmododescrição
orders.today-summaryreadReturns order count, revenue, and average ticket for today or a given period.
orders.active-ordersreadLists currently active (non-completed) orders.
orders.create-orderpersistCreates a new restaurant order with items.

Ferramentas que um agente pode chamar contra o seu app. Seu app como camada de dados.

Integrações

Sem conector hospedado — provedores externos entram via connector spine. Veja o catálogo de integrações.

Use esta página como skill. A versão .md desta ficha (em plugins/plugin-orders.md) é o contrato agent-consumable — modelo de dados, tools e integrações num só arquivo que uma IA lê direto. Preview O comando fayz skill add plugin-orders chega em breve para instalar isso como skill. Veja Skills.

Integrar

Adicione o plugin em surfaces.admin.plugins do app.manifest.json do seu app e rode o doctor para validar:

{
  "surfaces": {
    "admin": {
      "plugins": [
        { "id": "orders", "enabled": true }
      ]
    }
  }
}
npx fayz doctor

O fayz doctor confere o manifesto contra o catálogo do SDK. Veja Configuração para o passo a passo completo.