@core / orders

1.1.0 ▾

1.1.0

認証済みMIT

GitHub

注文：明細の固定、在庫引当、支払いと配送の状態、分割出荷、返金、メールとイベント

コード10 ファイルコンテキスト約 743 トークンスキャン合格

約 743 トークン→ 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/adapters/hono.ts読み取り専用 · f73e6a4

// Adaptador Hono: `app.route('/api/orders', orderRoutes({ currentUserId }))` → GET /api/orders/:number?token=…
import { Hono } from 'hono';
import { type CurrentUserId, handleCustomerOrder } from './http.ts';

export function orderRoutes(opts: { currentUserId: CurrentUserId }) {
  return new Hono().get('/:number', (c) => handleCustomerOrder(c.req.raw, c.req.param('number'), opts.currentUserId));
}

バージョン	コミット	公開日	スキャン
1.1.0	f73e6a4	3 時間前	スキャン合格

$genpm add @core/orders

組み込み先: src/lib/orders
コミット
タグ: v1.1.0
必要: @core/auth ^1.1.0 @core/catalog ^1.0.0 @core/contracts ^1.0.0 @core/db ^1.0.0 @core/email ^1.0.1 @core/jobs ^1.0.0 @core/money ^1.0.0
npm: zod ^4.0.0
Env: ORDER_LINK_SECRET ORDER_NUMBER_PREFIX SITE_URL
品質: 100/100
利用元: 6
インストール数: 0 / 30日
公開日: 3 時間前 · genpm-system

README バッジ

[![genpm](https://api.genpm.net/v1/badge/@core/orders.svg)](https://genpm.net/p/@core/orders)