@aotter/mantle 0.2.0-alpha.1 → 0.2.0-alpha.11

package/docs/examples/purchasing/README.md

@@ -0,0 +1,99 @@
+# Purchasing
+
+An internal purchase-request workflow. Any signed-in employee submits a request against a department budget. An admin
+approves or rejects it, in Admin or through an AI agent on the admin MCP endpoint. Approval spends the budget and writes a
+ledger row in one transaction. The app then orders from the supplier's API and waits for the supplier's signed callback
+to mark the request confirmed. Requesters get an email on each decision, and a daily cron emails admins about requests
+that have been waiting too long.
+
+## Capabilities shown
+
+- **Status workflow with guarded transitions**: the write Procedures use
+  `UPDATE requests SET requestStatus = 'approved' ... WHERE id = input.id AND requestStatus = 'submitted'`. A match on
+  0 rows is a `CONFLICT` (409). See `manifests/purchasing.yaml` (`approve-request-write`, `reject-request-write`,
+  `change-amount`, `mark-ordered`, `confirm-order`). The column is `requestStatus` because `status` is reserved for
+  publishing Schemas. `requests` and `ledger` set `readOnly: true`, so Admin's generic editor cannot bypass the state
+  machine (for example by moving an ordered request back to `submitted` and approving it again).
+- **A status chosen at submission**: `submit-request` uses `CASE WHEN input.amount <= 100 THEN 'approved' ELSE
+  'submitted' END`. A small request also spends the budget and writes its ledger row in the same program, so
+  `remaining >= 0` refuses all three when it would overspend. Those two statements find the request by
+  `created_at = now()` (the instant of this program) and `NOT EXISTS` a ledger row, so the threshold is written only in
+  the `CASE`. Larger requests wait for an admin. An auto-approved request sends no approval email, and the daily cron
+  orders it from the supplier (it already retries every `approved` request); route small requests through a `ref`
+  handler like `approve-request` if they must be ordered and announced at once.
+- **Admin-only operations**: `approve-request` and `reject-request` declare `requires: ctx.admin` and a `target`, so
+  Admin shows them as operations on a request. Their `kind: mcp, surface: admin` Triggers make them
+  `approve_request` / `reject_request` tools on `/mcp/admin`. They are not listed on `/mcp`.
+- **Optimistic concurrency**: clients send `expectedVersion`, and the SQL matches `version = input.expectedVersion`.
+  If the requester changes the amount (`change-amount`, only their own request and only while it is `submitted`)
+  after an admin reviewed it, that admin's approval is a 409. When two admins approve the same version, one succeeds
+  and the other gets a 409.
+- **Several writes in one transaction**: `approve-request-write` runs three statements as one program: the status
+  change, `UPDATE budgets SET remaining = remaining - ...` and `INSERT INTO ledger`. If the request would overspend,
+  `checks: ["remaining >= 0"]` on `budgets` rolls back all three. `src/handlers.ts` turns that failure into a 409.
+- **External API + signed callback**: after the transaction commits, `src/supplier.ts` POSTs the order to
+  `env.SUPPLIER_API_URL` (request id as the idempotency key, 10 s timeout) and then sets the request to `ordered`.
+  If the supplier cannot be reached, the request stays `approved` and the daily cron retries it as a system caller
+  (`mark-ordered` has no `requires` for that reason, and no Trigger).
+  `src/routes.ts` serves `POST /callbacks/supplier`. It first checks an HMAC-SHA256 of the timestamp and the **raw**
+  body with `env.SUPPLIER_WEBHOOK_SECRET`, and only then parses the JSON. It then calls the generated `confirm-order`
+  Procedure as a `system` caller. No Trigger exposes that Procedure. The callback may arrive before `ordered` is
+  written, so `approved` is confirmed too. A replay of an applied callback answers 204 again.
+- **Email + cron as app code**: `src/notify.ts` sends through an `EmailSender` from `@aotter/mantle/email`
+  (`ConsoleEmailSender` locally). `src/schedule.ts` uses `toCloudflareCron`, and its cron is listed in
+  `wrangler.jsonc`. The cron retries failed orders (internal View `approved-requests`) and sends the reminder
+  (internal View `stale-requests`) to admins who are not banned.
+- Employees see only their own requests through `my-requests` (`restrict: { requests: "author_id = auth.uid()" }`).
+- **Sidebar for the approver's day**: `src/admin.tsx` declares an Approvals group (`defineAdmin` `nav.groups`) above Admin's built-in
+  groups; `pending-requests` and `requests` move into it with `uiSchema.nav: { group, order }`.
+- **A page only signed-in employees reach**: `src/requests-page.ts` serves `GET /requests`. An anonymous visitor gets a
+  303 to the shell's `/sign-in?return=/requests` (`src/sign-in.ts`, email code, then back). Signed in, the table reads
+  `my-requests` as the visitor's own caller. The form keeps `action="/api/requests" method="post"`; a small script sends
+  its fields as JSON to that REST Trigger, so the manifest's validation, `requires` and origin check apply and app code
+  never hands request data to a Procedure. Unstyled on purpose. `src/signup.ts` lets only `@EMPLOYEE_DOMAIN` emails
+  create an account (`vars` in `wrangler.jsonc`).
+
+Search for `AGENT:` to find what a real app must still provide: an email sender, the supplier's real API and signature
+scheme.
+
+## Combine with
+
+- Need members to own rows, prevent duplicates or cap capacity? Add club-events' `uniqueIndexes` and capacity `checks`.
+- Need public pages, SEO or media for the approved items? Add recipes' publishing lifecycle and visitor pages.
+- Need another approval flow? Copy the pattern: a ref Procedure (admin-only, side effects) that wraps a guarded SQL
+  write Procedure (one transaction).
+
+## Run it
+
+This runs the example by itself, to read and try. For your own app, run `mantle init` and take only the patterns you need into its manifests and `src/` (`mantle help examples`).
+
+```sh
+npx mantle init my-app
+cp -R node_modules/@aotter/mantle/docs/examples/purchasing/. my-app/   # run the example as is
+cd my-app && pnpm install && pnpm generate && pnpm types && pnpm check
+cp .dev.vars.example .dev.vars          # then set SUPPLIER_API_URL and SUPPLIER_WEBHOOK_SECRET
+pnpm db:init && pnpm db:seed && pnpm dev
+```
+
+## What `pnpm smoke` proves
+
+`smoke.mjs` starts a stand-in supplier API on a local port (which it can switch to 503) and passes its URL and the
+webhook secret through `smoke(scenario, { vars })`. It then checks the following:
+
+1. Employees submit requests and see only their own. A department without a budget creates nothing.
+2. An employee gets 403 on the Admin operation. The approve and reject tools exist only on `/mcp/admin`, and the
+   internal write Procedures are on neither MCP surface.
+3. Rejecting through the admin MCP tool emails the requester. Approving that request afterwards, with its current
+   version, is a 409 because the `requestStatus` guard matches no row.
+4. Approving more than the department has left is a 409. The request stays `submitted`, and the budget and ledger are
+   unchanged.
+5. Admin's generic editor cannot change a request. Another employee cannot change its amount (409); the requester can,
+   and then approving the version the admin reviewed is a 409 that changes nothing.
+6. Two admins approve the same version at the same time: one gets 200 and the other 409. The budget is deducted and
+   the ledger row written once.
+7. Approval places exactly one supplier order, sets `ordered` and emails the requester.
+8. The admin MCP tool approves too. With the supplier down, approvals still commit and stay `approved`.
+9. A callback with a bad signature is a 401 and changes nothing. A correctly signed callback sets `confirmed`, also
+   while the request is still `approved`; a replay is 204; a wrong order id or a `submitted` request is 409.
+10. The daily cron places the failed order (`ordered`) and emails every admin about requests pending more than 3
+    days, and only about those.

package/docs/examples/purchasing/manifests/purchasing.yaml

@@ -0,0 +1,374 @@
+# Internal purchase requests: employees submit, admins approve or reject, approval spends a department budget.
+# requestStatus: submitted -> approved -> ordered -> confirmed, or submitted -> rejected.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Schema
+metadata: { name: budgets }
+spec:
+  title: Budgets
+  lifecycle: operational
+  uniqueIndexes: [[department]]
+  # An approval that would overspend fails this check and the whole approval rolls back.
+  checks: ["remaining >= 0"]
+  uiSchema: { list: { primaryField: department, columns: [remaining] } }
+  schema:
+    type: object
+    additionalProperties: false
+    required: [department, remaining]
+    properties:
+      department: { type: string }
+      remaining: { type: integer }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Schema
+metadata: { name: requests }
+spec:
+  title: Purchase requests
+  lifecycle: operational
+  indexes: [[authorId, createdAt, id], [requestStatus, createdAt, id]]
+  # Sidebar: in the Approvals group (src/admin.tsx), after the queue of requests waiting for a decision.
+  uiSchema: { list: { primaryField: title, columns: [department, amount, requestStatus], filterField: requestStatus }, nav: { group: approvals, order: 2 } }
+  schema:
+    type: object
+    # Admin reads requests but cannot edit them generically: a generic edit could move requestStatus back to
+    # 'submitted' and spend the budget twice. Every change goes through the guarded Procedures below.
+    readOnly: true
+    additionalProperties: false
+    required: [title, amount, department, requestStatus]
+    properties:
+      title: { type: string, minLength: 1 }
+      amount: { type: integer, minimum: 1 }
+      department: { type: string }
+      requestStatus: { type: string, enum: [submitted, approved, rejected, ordered, confirmed] }
+      supplierOrderId: { type: string }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Schema
+metadata: { name: ledger }
+spec:
+  title: Budget ledger
+  lifecycle: operational
+  indexes: [[createdAt, id]]
+  # One row per spending request.
+  uniqueIndexes: [[requestId]]
+  uiSchema: { list: { primaryField: department, columns: [amount, remainingAfter, requestId] } }
+  schema:
+    type: object
+    readOnly: true # written only by approve-request-write and submit-request
+    additionalProperties: false
+    required: [requestId, department, amount, remainingAfter]
+    properties:
+      requestId: { type: string }
+      department: { type: string }
+      amount: { type: integer }
+      remainingAfter: { type: integer }
+---
+# Employees see only the requests they submitted.
+apiVersion: cms.mantle.aotter.net/v2
+kind: View
+metadata: { name: my-requests }
+spec:
+  surface: public
+  requires: { auth: { all: [ctx.user] } }
+  restrict: { requests: "author_id = auth.uid()" }
+  sql: |
+    SELECT id, title, amount, department, requestStatus AS "requestStatus", version
+    FROM requests ORDER BY created_at DESC, id DESC
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: View
+metadata: { name: pending-requests }
+spec:
+  title: Pending purchase requests
+  surface: admin
+  requires: { auth: { all: [ctx.admin] } }
+  uiSchema: { nav: { group: approvals, order: 1 } }
+  sql: |
+    SELECT id, title, amount, department, version
+    FROM requests WHERE requestStatus = 'submitted' ORDER BY created_at, id
+---
+# The daily reminder reads this from src/schedule.ts; no route or tool exposes it.
+apiVersion: cms.mantle.aotter.net/v2
+kind: View
+metadata: { name: stale-requests }
+spec:
+  surface: internal
+  input:
+    type: object
+    additionalProperties: false
+    required: [before]
+    properties:
+      before: { type: string, format: date-time }
+  sql: |
+    SELECT id, title, amount, department FROM requests
+    WHERE requestStatus = 'submitted' AND created_at < input.before
+    ORDER BY created_at, id LIMIT 100
+---
+# Approved but not yet ordered (the supplier call failed): the cron retries these.
+apiVersion: cms.mantle.aotter.net/v2
+kind: View
+metadata: { name: approved-requests }
+spec:
+  surface: internal
+  sql: |
+    SELECT id, title, amount FROM requests WHERE requestStatus = 'approved'
+    ORDER BY created_at, id LIMIT 20
+---
+# Selecting from budgets refuses a department that has no budget, so approval always has a budget row to deduct.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: submit-request }
+spec:
+  title: Submit a purchase request
+  description: Submit a purchase request against an existing department budget; a request of 100 or less is approved at once and spends the budget.
+  requires: { auth: { all: [ctx.user] } }
+  input:
+    type: object
+    additionalProperties: false
+    required: [title, amount, department]
+    properties:
+      title: { type: string, minLength: 1 }
+      amount: { type: integer, minimum: 1 }
+      department: { type: string }
+  output: { type: object }
+  # One program. CASE picks the status: up to 100 is approved now, more waits for an admin. The budget and ledger
+  # statements then act only on "the request this program approved": the caller's, created by this program
+  # (created_at = now(), the same instant Mantle writes into created_at), approved, and with no ledger row yet. So the
+  # threshold lives only in the CASE, and remaining >= 0 refuses all three statements when a small request would
+  # overspend. A pending request matches nothing there, which a set form (IN (SELECT ...), INSERT ... SELECT) allows.
+  handler:
+    sql: |
+      INSERT INTO requests (title, amount, department, requestStatus)
+      SELECT input.title, input.amount, b.department, CASE WHEN input.amount <= 100 THEN 'approved' ELSE 'submitted' END
+      FROM budgets b WHERE b.department = input.department
+      RETURNING id, version, requestStatus AS "requestStatus";
+      UPDATE budgets SET remaining = remaining - (SELECT SUM(r.amount) FROM requests r WHERE r.department = budgets.department
+          AND r.author_id = auth.uid() AND r.created_at = now() AND r.requestStatus = 'approved'
+          AND NOT EXISTS (SELECT 1 FROM ledger l WHERE l.requestId = r.id))
+      WHERE department IN (SELECT r.department FROM requests r WHERE r.author_id = auth.uid() AND r.created_at = now()
+          AND r.requestStatus = 'approved' AND NOT EXISTS (SELECT 1 FROM ledger l WHERE l.requestId = r.id));
+      INSERT INTO ledger (requestId, department, amount, remainingAfter)
+      SELECT r.id, r.department, r.amount, b.remaining FROM requests r JOIN budgets b ON b.department = r.department
+      WHERE r.author_id = auth.uid() AND r.created_at = now() AND r.requestStatus = 'approved'
+        AND NOT EXISTS (SELECT 1 FROM ledger l WHERE l.requestId = r.id)
+---
+# The requester may change the amount while the request is still 'submitted'. The version moves on, so an admin
+# approving the version they reviewed before the change gets a 409 and looks again.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: change-amount }
+spec:
+  title: Change the amount of my request
+  description: Change the amount of the signed-in member's submitted purchase request.
+  requires: { auth: { all: [ctx.user] } }
+  restrict: { requests: "author_id = auth.uid()" }
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, expectedVersion, amount]
+    properties:
+      id: { type: string }
+      expectedVersion: { type: integer }
+      amount: { type: integer, minimum: 1 }
+  output: { type: object }
+  handler:
+    sql: |
+      UPDATE requests SET amount = input.amount
+      WHERE id = input.id AND version = input.expectedVersion AND requestStatus = 'submitted'
+      RETURNING id, version
+---
+# Admin-only. The ref handler runs the write below, then places the supplier order and emails the requester.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: approve-request }
+spec:
+  title: Approve a purchase request
+  description: Approve a submitted request; deducts the department budget, records a ledger row and places the supplier order.
+  requires: { auth: { all: [ctx.admin] } }
+  target: { schema: requests, id: id, version: expectedVersion }
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, expectedVersion]
+    properties:
+      id: { type: string }
+      expectedVersion: { type: integer }
+  output: { type: object }
+  handler: { ref: approve-request }
+---
+# One program, one transaction. Statement 1 is the guarded transition: a stale version or a request that is no longer
+# 'submitted' matches 0 rows -> CONFLICT (409). Statement 2 fails remaining >= 0 when over budget. Either failure rolls
+# back all three statements.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: approve-request-write }
+spec:
+  requires: { auth: { all: [ctx.admin] } }
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, expectedVersion]
+    properties:
+      id: { type: string }
+      expectedVersion: { type: integer }
+  output: { type: object }
+  handler:
+    sql: |
+      UPDATE requests SET requestStatus = 'approved'
+      WHERE id = input.id AND version = input.expectedVersion AND requestStatus = 'submitted'
+      RETURNING id, title, amount, author_id AS "authorId";
+      UPDATE budgets SET remaining = remaining - (SELECT r.amount FROM requests r WHERE r.id = input.id)
+      WHERE department = (SELECT r.department FROM requests r WHERE r.id = input.id);
+      INSERT INTO ledger (requestId, department, amount, remainingAfter)
+      SELECT r.id, r.department, r.amount, b.remaining FROM requests r JOIN budgets b ON b.department = r.department
+      WHERE r.id = input.id
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: reject-request }
+spec:
+  title: Reject a purchase request
+  requires: { auth: { all: [ctx.admin] } }
+  target: { schema: requests, id: id, version: expectedVersion }
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, expectedVersion]
+    properties:
+      id: { type: string }
+      expectedVersion: { type: integer }
+  output: { type: object }
+  handler: { ref: reject-request }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: reject-request-write }
+spec:
+  requires: { auth: { all: [ctx.admin] } }
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, expectedVersion]
+    properties:
+      id: { type: string }
+      expectedVersion: { type: integer }
+  output: { type: object }
+  handler:
+    sql: |
+      UPDATE requests SET requestStatus = 'rejected'
+      WHERE id = input.id AND version = input.expectedVersion AND requestStatus = 'submitted'
+      RETURNING id, title, author_id AS "authorId"
+---
+# Called after the supplier accepted the order: by the approve handler (admin caller) and by the cron retry (system
+# caller). System callers satisfy no `requires` predicate, so it has none; no Trigger exposes it.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: mark-ordered }
+spec:
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, supplierOrderId]
+    properties:
+      id: { type: string }
+      supplierOrderId: { type: string }
+  output: { type: object }
+  handler:
+    sql: |
+      UPDATE requests SET requestStatus = 'ordered', supplierOrderId = input.supplierOrderId
+      WHERE id = input.id AND requestStatus = 'approved'
+      RETURNING id
+---
+# Called only by POST /callbacks/supplier (src/routes.ts) as a system caller after the signature checks out.
+# The callback can arrive before mark-ordered ran, so 'approved' is accepted too.
+# No Trigger exposes it; system callers satisfy no `requires` predicate, so it has none.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: confirm-order }
+spec:
+  input:
+    type: object
+    additionalProperties: false
+    required: [id, supplierOrderId]
+    properties:
+      id: { type: string }
+      supplierOrderId: { type: string }
+  output: { type: object }
+  handler:
+    sql: |
+      UPDATE requests SET requestStatus = 'confirmed', supplierOrderId = input.supplierOrderId
+      WHERE id = input.id AND (
+        (requestStatus = 'ordered' AND supplierOrderId = input.supplierOrderId)
+        OR requestStatus = 'approved')
+      RETURNING id
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: submit-request-http }
+spec:
+  source: { kind: http, method: POST, path: /api/requests }
+  target: { procedure: submit-request }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: submit-request-mcp }
+spec:
+  source: { kind: mcp, surface: public }
+  target: { procedure: submit-request }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: change-amount-http }
+spec:
+  source: { kind: http, method: POST, path: '/api/requests/{id}/amount' }
+  target: { procedure: change-amount }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: change-amount-mcp }
+spec:
+  source: { kind: mcp, surface: public }
+  target: { procedure: change-amount }
+---
+# Admin MCP tools: an AI agent connected to /mcp/admin can approve or reject.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: approve-request-mcp }
+spec:
+  source: { kind: mcp, surface: admin }
+  target: { procedure: approve-request }
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: reject-request-mcp }
+spec:
+  source: { kind: mcp, surface: admin }
+  target: { procedure: reject-request }
+---
+# Admins open a department's budget from the Budgets list header (operational collections have no generic create);
+# adjusting `remaining` later is an ordinary Admin edit.
+apiVersion: cms.mantle.aotter.net/v2
+kind: Procedure
+metadata: { name: open-budget }
+spec:
+  title: Open a budget
+  description: Give a department a purchasing budget.
+  requires: { auth: { all: [ctx.admin] } }
+  uiSchema: { collectionAction: budgets }
+  input:
+    type: object
+    required: [department, remaining]
+    additionalProperties: false
+    properties:
+      department: { type: string, minLength: 1, maxLength: 100, title: Department }
+      remaining: { type: integer, minimum: 0, title: Budget }
+  output: { type: object }
+  handler:
+    sql: |
+      INSERT INTO budgets (department, remaining) VALUES (input.department, input.remaining) RETURNING id
+---
+apiVersion: cms.mantle.aotter.net/v2
+kind: Trigger
+metadata: { name: open-budget-admin }
+spec:
+  source: { kind: mcp, surface: admin }
+  target: { procedure: open-budget }

package/docs/examples/purchasing/seed.sql

@@ -0,0 +1,4 @@
+-- Department budgets (whole currency units). Admins edit them in Admin > Budgets.
+INSERT INTO budgets (id, created_at, updated_at, department, remaining) VALUES
+  ('budget-engineering', 1767225600000000, 1767225600000000, 'Engineering', 5000),
+  ('budget-design', 1767225600000000, 1767225600000000, 'Design', 1000);