@core / orders

1.1.0 ▾

1.1.0

已验证MIT

GitHub

订单：冻结明细、库存预留、支付与发货状态、部分发货、退款、邮件和事件

代码10 个文件上下文约 743 个 token扫描通过

约 743 个 token→ src/lib/orders/AGENTS.md→ .cursor/rules/genpm-core-orders.mdc

这正是你的 AI 在 src/lib/orders 中工作时读取的内容。不会向其上下文添加其他任何内容。

@core/orders — rules for AI agents

Purpose

Orders after payment: lines frozen at purchase time (name, price, discount), stock reserved in the same transaction (@core/catalog), sequential order numbers, two independent states — payment (pending → paid → partially_refunded/refunded, or cancelled) and fulfillment (unfulfilled → partial → fulfilled → delivered) — partial shipments with tracking, refunds through the registered PaymentProvider, a timeline, customer access by owner session or signed link, and background events (onOrderEvent) with built-in emails (confirmation, shipped, refund). Payment itself is @core/checkout.

Map

index.ts — public API: createOrder, markPaid, addFulfillment, markDelivered, cancelOrder, refundOrder, getOrder, getOrderForCustomer, onOrderEvent, onOrderPaidTx, registerPaymentProvider, ordersAdminResource, setOrderMessages.
orders.ts — logic and the orders.event job. emails.ts — default emails. admin.ts — admin. schema.ts — tables.
adapters/hono.ts — orderRoutes({ currentUserId }). adapters/next.ts — orderRoute, publicOrder.

Integration

Env: ORDER_LINK_SECRET (≥ 32 chars), SITE_URL, EMAIL_FROM, optional ORDER_NUMBER_PREFIX. Migrations as in src/lib/db/AGENTS.md; the @core/jobs cron must run.
Orders are created by @core/checkout from the paid cart; for manual flows call createOrder({ … }).
Customer page /orders/[number]: getOrderForCustomer(number, { userId, token }) (404 when null) rendered with publicOrder.
React to events in a module imported at startup: onOrderEvent('paid', 'my-crm', async (order) => …). Translate emails with setOrderMessages((locale) => ({ … })). For bookkeeping that must be atomic with the payment (e.g. counting coupon uses) use onOrderPaidTx(name, async (order, tx) => …): it runs inside the order transaction, must be fast and must not throw for business rules (a throw aborts the order).
Add ordersAdminResource to src/genpm/admin.ts (permissions orders:read|update|fulfill|refund).
Verify: create a paid order, ship it from the admin with a tracking URL, the customer gets both emails.

Conventions

Change states only with these functions; they lock the order row and validate transitions.
Cancel only unfulfilled orders; after shipping, refund instead (optionally restocking returned lines).
A paid order that was cancelled is refunded with refundOrder (up to total - refundedTotal, no restock: the stock was returned when cancelling); it stays cancelled.
Event handlers must be idempotent; each runs once per event and retries if it fails.

Don't

Don't delete orders or edit their lines/totals after creation (legal and accounting record).
Don't expose orders by id or number without the owner check or the signed token.
Don't mark orders paid from the browser's success redirect; only from the payment webhook or the admin.

# @core/orders — rules for AI agents

## Purpose
Orders after payment: lines frozen at purchase time (name, price, discount), stock reserved in the same transaction
(@core/catalog), sequential order numbers, two independent states — payment (`pending → paid → partially_refunded/refunded`,
or `cancelled`) and fulfillment (`unfulfilled → partial → fulfilled → delivered`) — partial shipments with tracking,
refunds through the registered `PaymentProvider`, a timeline, customer access by owner session or signed link, and
background events (`onOrderEvent`) with built-in emails (confirmation, shipped, refund). Payment itself is @core/checkout.

## Map
- `index.ts` — public API: `createOrder`, `markPaid`, `addFulfillment`, `markDelivered`, `cancelOrder`, `refundOrder`, `getOrder`, `getOrderForCustomer`, `onOrderEvent`, `onOrderPaidTx`, `registerPaymentProvider`, `ordersAdminResource`, `setOrderMessages`.
- `orders.ts` — logic and the `orders.event` job. `emails.ts` — default emails. `admin.ts` — admin. `schema.ts` — tables.
- `adapters/hono.ts` — `orderRoutes({ currentUserId })`. `adapters/next.ts` — `orderRoute`, `publicOrder`.

## Integration
1. Env: `ORDER_LINK_SECRET` (≥ 32 chars), `SITE_URL`, `EMAIL_FROM`, optional `ORDER_NUMBER_PREFIX`. Migrations as in `src/lib/db/AGENTS.md`; the @core/jobs cron must run.
2. Orders are created by @core/checkout from the paid cart; for manual flows call `createOrder({ … })`.
3. Customer page `/orders/[number]`: `getOrderForCustomer(number, { userId, token })` (404 when null) rendered with `publicOrder`.
4. React to events in a module imported at startup: `onOrderEvent('paid', 'my-crm', async (order) => …)`.
   Translate emails with `setOrderMessages((locale) => ({ … }))`. For bookkeeping that must be atomic with the payment
   (e.g. counting coupon uses) use `onOrderPaidTx(name, async (order, tx) => …)`: it runs inside the order transaction,
   must be fast and must not throw for business rules (a throw aborts the order).
5. Add `ordersAdminResource` to `src/genpm/admin.ts` (permissions `orders:read|update|fulfill|refund`).
6. Verify: create a paid order, ship it from the admin with a tracking URL, the customer gets both emails.

## Conventions
- Change states only with these functions; they lock the order row and validate transitions.
- Cancel only unfulfilled orders; after shipping, refund instead (optionally restocking returned lines).
- A paid order that was cancelled is refunded with `refundOrder` (up to `total - refundedTotal`, no `restock`: the
  stock was returned when cancelling); it stays `cancelled`.
- Event handlers must be idempotent; each runs once per event and retries if it fails.

## Don't
- Don't delete orders or edit their lines/totals after creation (legal and accounting record).
- Don't expose orders by id or number without the owner check or the signed token.
- Don't mark orders paid from the browser's success redirect; only from the payment webhook or the admin.

应用 .genpmignore 后将被注入的确切目录树。固定于

src/lib/orders/LICENSE只读 · f73e6a4

MIT License

Copyright (c) 2026 GenPM

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.