@terreno/mcp 57.12.0 → 57.13.0

package/src/docs/versioned/next/how-to/agent-ui-blocks.md

@@ -14,9 +14,17 @@ The same check is `validateBlocks` in `@terreno/blocks`. Field tables are in the
 ## Preview a document in the playground
 
 1. Open the component demo and choose **BlocksPlayground**.
-2. Start from Layout or Invalid, or paste your own document into the text area.
+2. Start from a preset: **All blocks** (one of each block type), **Block type** (one preset per
+   block type, with every chart kind, callout status, and action kind), Layout, Invalid, or
+   Sunday roast. Or paste your own document into the text area.
 3. The preview updates as you type. An invalid document shows the error banner and keeps
    the raw text collapsed.
+4. Press the controls. The playground has no server: a stepper's − and + and a checklist tick
+   run on the device with `scaleStepperBlock` and `applyChecklistState` from `@terreno/blocks`
+   (the helpers `scaleStepperHostAction` and `toggleChecklistHostAction` use), and a toast names
+   the callback and its result, such as "scaleStepper → 6 People". A reply, open, select, or
+   other callback shows a toast describing the event instead. Copy writes the clipboard.
+   Editing the text drops the local results.
 
 ## Require documents from the model
 
@@ -72,6 +80,133 @@ addGptRoutes(router, {
 
 The path is `/gpt/actions`, so a limiter on `/gpt` covers it. Each call is stored as an `AIRequest` with `requestType: "ui_action"`.
 
+## Add a stepper callback
+
+A `stepper` is a − value + control. Each tap goes to a host action, and the action returns the
+replacement stepper. Use it when a number changes other numbers, such as guests changing a
+shopping list.
+
+1. Register a stepper action. `scaleStepperHostAction` from `@terreno/ai` scales every item
+   linearly from the stepper the agent wrote:
+
+   ```ts
+   import {addGptRoutes, scaleStepperHostAction} from "@terreno/ai";
+
+   addGptRoutes(router, {
+     aiService,
+     uiBlocks: {hostActions: {scaleStepper: scaleStepperHostAction}},
+   });
+   ```
+
+2. Leave `uiBlocks.richBlocks` unset (it defaults to `true`). The prompt offers `stepper` only
+   when some host action has `handles: "stepper"`, and names those actions as its callbacks.
+3. List the same name in `GPTChat` `hostActions` (`["scaleStepper"]`). `onBlockCallback` posts
+   to `POST /gpt/actions` and returns the result, as in [Wire the example chat](#wire-the-example-chat).
+4. The agent writes a stepper whose `callback.name` is that action:
+
+   ```yaml
+   - type: stepper
+     id: guests
+     label: Number of people
+     unit: People
+     value: 5
+     min: 1
+     max: 20
+     callback: {name: scaleStepper}
+     items:
+       - {label: Bone-in leg of lamb, amount: 2, unit: kg, decimals: 1}
+       - {label: Carrots, amount: 8, round: up}
+   ```
+
+5. Press +. The client sends `payload: {...callback.payload, value: 6}`, with `blockId: guests`
+   and `elementId: guests_increase`. The action returns `{replace: "block", blocks}` and
+   `GPTChat` swaps the stepper: lamb reads "2.4 kg", carrots "10". Both buttons are disabled
+   until the reply lands, so a fast second tap is dropped.
+
+A stepper whose `callback.name` is not a `handles: "stepper"` action fails `UNKNOWN_HOST_ACTION`.
+`value` outside `min`–`max`, or off the `step` grid, returns 400.
+
+**Stored prompts are owner-writable.** The history owner can change any stored prompt with
+`PATCH /gpt/histories/:id`, including the stepper `scaleStepperHostAction` reads. When the numbers
+matter (prices, stock, dosage), write your own action and compute them from your own data:
+
+```ts
+import {findAgentBlock, type HostAction} from "@terreno/ai";
+import {z} from "@terreno/api";
+
+const priceGuests: HostAction = {
+  handles: "stepper",
+  logResponse: false, // keep the returned block out of the AIRequest log
+  payload: z.object({value: z.number().int().min(1).max(20)}).passthrough(),
+  handler: async ({blockId, history, messageId, payload, user}) => {
+    const stepper = findAgentBlock({blockId, history, messageId, type: "stepper"});
+    const {value} = payload as {value: number};
+    const items = await quoteItems({guests: value, userId: user._id}); // your data, not the stored block
+    return {replace: "block", blocks: {v: 1, blocks: [{...stepper, items, value}]}};
+  },
+};
+```
+
+`findAgentBlock` reads `history.prompts[n]` for `messageId: msg-<n>`, otherwise the only assistant
+prompt holding that block: several matches throw 409, none 404. Field rules are in
+[Stepper](../reference/blocks.md#stepper) and [Host actions](../reference/ai.md#host-actions).
+
+## Add a checklist callback
+
+A `checklist` without a `callback` ticks on the device only. To send ticks to the server:
+
+1. Register `toggleChecklistHostAction` (or your own `handles: "checklist"` action) under a name,
+   such as `toggleChecklist`, and list it in `GPTChat` `hostActions`.
+2. The prompt then tells the model to set `callback: {name: toggleChecklist}` on a checklist.
+3. A tick sends `{...callback.payload, itemId, checked, state}`, where `state` holds every item's
+   tick after this one. The whole checklist is locked until the reply lands, and the "n of m"
+   counter changes when the returned checklist arrives.
+
+`toggleChecklistHostAction` returns the stored checklist with `checked` from `state` and saves
+nothing. An unknown item id returns 400. An app that records progress writes its own action.
+
+## Copy a block's text
+
+Add a button with `action: {kind: copy, target: <block id>}` (or `text` for a literal). The
+target is a `stepper`, `checklist`, `list`, `table`, or `text` block. `BlocksView` copies the
+block as it is shown now, so a stepper at 6 copies the scaled amounts. Nothing reaches the
+server, so `hostActions` does not apply. See [Copy](../reference/blocks.md#copy).
+
+## Keep the old catalog for shipped native builds
+
+Rich blocks (`stepper`, `checklist`, `gallery`, `list`, `card.eyebrow`, `copy`) are in the prompt
+by default. A native build released before them shows an error banner for a reply that uses
+them. Until those builds update, turn them off:
+
+```ts
+addGptRoutes(router, {aiService, uiBlocks: {hostActions, richBlocks: false}});
+```
+
+The prompt is then the same as before rich blocks, even with a stepper action registered.
+Validation still accepts the new blocks.
+
+## Smoke-test a real model
+
+`bun run blocks:smoke` (from the repo root) sends "Give me a plan for a sunday lamb roast, I'm
+having friends over still figuring out numbers tbh" through one real chat turn with the example
+backend's `uiBlocks` options and the `findPhotos` tool.
+
+| Check | Passes when |
+| --- | --- |
+| Document | The reply parses and passes `validateBlocks` |
+| Blocks | It holds a `gallery`, `list`, `stepper`, and `checklist`, and a `copy` action |
+| Photos | Every image `src` is a `file:` id that `findPhotos` returned in that turn |
+
+| Variable | Use |
+| --- | --- |
+| `GOOGLE_VERTEX_PROJECT` (with Application Default Credentials) or `GEMINI_API_KEY` | The model. With neither, the script prints that it skipped and exits 0 |
+| `BLOCKS_SMOKE_MODEL` | Optional model id instead of the server default |
+| `MONGO_URI`, `MONGO_DB_NAME` | The database holding the photo library ([Give the agent photos](#give-the-agent-photos)) |
+| `BLOCKS_SMOKE_OUT_DIR` or `--out <dir>` | Where `reply.yaml` and `result.json` go (default: a new temp directory) |
+
+It exits 1 when any check fails. The turn runs as `blocks-smoke@system.invalid`, and its history
+is deleted afterwards.
+
 ## Wire the example chat
 
 1. Turn `uiBlocks` on in `addGptRoutes` so `GET /gpt/datasets/:id` and `POST /gpt/actions` are in the OpenAPI spec.
@@ -84,11 +219,57 @@ The path is `/gpt/actions`, so a limiter on `/gpt` covers it. Each call is store
 
 ## Turn blocks on in the example backend
 
-`example-backend` passes `uiBlocks` with `repair: true` and one host callback, `exportDataset`. Its payload is `{dataset: string}`. The handler returns `{replace: "block", blocks}` with a badge that names that dataset. Dataset TTL stays at the default, so stored rows are kept.
+`example-backend` passes `uiBlocks` (`exampleUiBlocksOptions` in `src/ai/hostActions.ts`) with
+`repair: true`, `html: true`, and three host callbacks:
+
+| Name | Handles | Does |
+| --- | --- | --- |
+| `exportDataset` | buttons | Payload `{dataset: string}`. Returns a badge that names that dataset |
+| `scaleStepper` | `stepper` | `scaleStepperHostAction` |
+| `toggleChecklist` | `checklist` | `toggleChecklistHostAction` |
+
+`richBlocks` is left at its default (`true`). Dataset TTL stays at the default, so stored rows are kept.
 
 The per-request tool `todoStats` counts the signed-in user's open and completed todos, calls `registerAiDataset`, and returns `datasetId`. It stores the rows on `req.body.historyId` when that id belongs to the caller. With no history id it uses the caller's newest history, and with no history it returns `{datasetId: null, rowCount: 0}`. A chart dataset uses `source: ref` and that id. Columns are `status` and `count`.
 
-`GPTChat` lists `exportDataset` in `hostActions`, so that callback stays enabled. The e2e mock also allows `export_csv`.
+`GPTChat` lists `exportDataset`, `scaleStepper`, and `toggleChecklist` in `hostActions`, so those callbacks stay enabled. The e2e mock also allows `export_csv`.
+
+## Give the agent photos
+
+The model cannot make photos on the fly, and an `https` image needs `imageHosts`. The example
+app generates a photo library once, and the agent cites its photos as `file:` ids.
+
+1. Generate the library, once per environment. From `example-backend`, with `GOOGLE_VERTEX_PROJECT`,
+   Application Default Credentials for Vertex, and `GCS_BUCKET` set, run `bun run photos:generate`.
+   Each prompt in `src/scripts/photoPrompts.ts` becomes one `PhotoLibraryEntry`. A re-run skips
+   prompts that already have an entry; pass `--force` to regenerate them. `PHOTO_IMAGE_MODEL`
+   (default `imagen-4.0-fast-generate-001`) and `GOOGLE_VERTEX_LOCATION` (default `us-central1`)
+   are optional.
+2. Register the `findPhotos` tool. `createFindPhotosTool()` from `src/ai/tools.ts` is in the
+   example's per-request tools. `findPhotos({query, count})` matches the query words against each
+   entry's `tags` and `alt`. `count` is 1–6. It returns `{photos: [{src: "file:<entry id>", alt}], note}`.
+   Entries that match more words come first; ties keep entry id order. Soft-deleted entries are
+   left out. When nothing matches, `photos` is empty and `note` tells the model not to invent an
+   id. The tool description tells the model to put each `src` into a `gallery`, `list`, or
+   `image` block exactly as returned.
+3. Serve the URLs. `photoLibraryRouter` (`src/api/photoLibrary.ts`) mounts `/photoLibrary`.
+   List and read need a signed-in user; create, update, and delete return 405.
+   `GET /photoLibrary/:id/url` returns `{url}`, a signed read URL that lasts one hour, to any
+   signed-in user. The library is shared, so the per-user `GET /files/*` route does not fit.
+   An unknown or soft-deleted id is 404. Without a bucket (`GCS_BUCKET` unset and none saved in
+   Profile) it returns 503 `Photo storage is not configured`.
+4. Regenerate the frontend SDK: `cd example-frontend && bun run sdk`. This adds
+   `useLazyPhotoLibraryUrlQuery`.
+5. Pass `resolveImage` to `GPTChat`. The example builds it with `createPhotoImageResolver`
+   (`example-frontend/lib/photoLibraryImages.ts`) around `openapi.useLazyPhotoLibraryUrlQuery`.
+   It fetches each id once while the URL is fresh (50 minutes). A failed lookup returns
+   `undefined`, so the block keeps its labelled placeholder, and a later render tries again.
+
+In the example app, every `file:` image id in a block is a photo library entry id. Nothing else
+in the example writes `file:` image ids, so the ids carry no extra prefix. A host that also cites
+its own files must tell the two apart in its `resolveImage`. An id that is not in the library,
+such as `file:roast-lamb` in the reference examples, resolves to `undefined` and shows the
+placeholder.
 
 ## Render documents in chat
 
@@ -100,5 +281,8 @@ is true, finished top-level blocks render and a spinner marks the block still ar
 - `callback` calls `onBlockCallback`. Return `{replace: "block", blocks}` to swap that
   block, or `{text}` to append an assistant message. The button shows loading until the
   promise settles.
+- Stepper taps and checklist ticks with a callback also call `onBlockCallback`. The block is
+  disabled until the promise settles.
+- `copy` writes the clipboard on the device and calls nothing.
 - Pass `hostActions` to disable callbacks the host does not run, `resolveDataset` to
   load `ref` datasets, and `resolveImage` to turn a `file:` image id into a URL.

package/src/docs/versioned/next/how-to/circleci.md

@@ -179,6 +179,8 @@ an isolated `pr-N` backend: `deploy-frontend-preview` always points
 up to 20 minutes for its `/health` before publishing, because `gcp-cd-preview`
 runs in a separate workflow.
 
+Those backend deploys set `GCS_BUCKET` to `flourish-terreno-example-documents` (override with `GCP_DOCUMENTS_BUCKET`). Preview revisions also set `GCS_FOLDER_PREFIX=pr-<number>/` so each PR keeps its own folder. Without `GCS_BUCKET`, `GET /documents/` returns 503 and the Files section shows “Storage is not configured.”
+
 Backend previews prune not-Ready tagged revisions from traffic
 (`rebuild-cloud-run-ready-traffic.sh`), deploy untagged with
 `--revision-suffix`, then point the `pr-N` tag at that revision. Terraform

package/src/docs/versioned/next/how-to/preview-demo.md

@@ -1,10 +1,10 @@
 # Preview a component demo
 
-Open a component demo and change the shareable query. The preview controls sit in the
-navigation header on demo and dev component routes: dropdowns for theme, viewport, and
+Open a demo or dev route and change the shareable query. The preview controls sit in the
+navigation header on every demo and dev screen, including the catalogs: dropdowns for theme, viewport, and
 background, plus a settings button (sliders icon) that opens a modal for right-to-left,
 reduced motion, locale, and the share query. In windows narrower than 768px every
-preview control moves into that modal; the Dev/Demo mode link stays in the header. `?embed=1` applies the same query and hides
+preview control moves into that modal; the Dev/Demo mode link stays in the header. The header chrome uses the same `theme` query. `?embed=1` applies the same query and hides
 the controls.
 
 ```text
@@ -13,11 +13,11 @@ the controls.
 
 | Query | Values |
 | --- | --- |
-| `theme` | `light` (default) or `dark` (canonical dark role remap) |
+| `theme` | `light` (default), `dark`, or `system` (follow the device color scheme) |
 | `viewport` | `full` (default), `320`, `375`, `1024`, `1280` |
 | `background` | `default`, `inverse`, `transparent` |
 | `locale` | Passed to components that already read a locale, such as consent |
 | `rtl` | `1` sets document direction to `rtl` on web |
 | `reducedMotion` | `1` sets `data-reduced-motion="1"` on the document element |
 
-Reload keeps the query. The settings modal shows the current query when any value is not the default. Choosing a control's default removes that key from the URL. Leaving the component route restores the app theme and, on web, document direction and reduced motion. Custom palettes stay on `/palette`.
+Reload keeps the query. The settings modal shows the current query when any value is not the default. Choosing a control's default removes that key from the URL. Opening a component from the catalog keeps the current preview query. Leaving a component route restores document direction and reduced motion on web. Custom palettes stay on `/palette`.

package/src/docs/versioned/next/how-to/rate-limiting.md

@@ -52,6 +52,23 @@ Pass `{store: "mongo"}`. Hits live in `rateLimitHits` on the same mongoose conne
 
 Unauthenticated keys use `req.ip`. Express `trust proxy` defaults to **off** so a client cannot rotate `X-Forwarded-For` to bypass the auth bucket. On Cloud Run (one hop via GFE), pass `trustProxy: 1`. Extra proxies: hop count or a subnet list. `trustProxy: false` is the same as the default.
 
+## Limit one route
+
+Use `createRouteRateLimitMiddleware` for a stricter limit on one expensive route. It works with or without the global limiter.
+
+```typescript
+import {createRouteRateLimitMiddleware} from "@terreno/api";
+
+const uploadLimit = createRouteRateLimitMiddleware({
+  name: "uploads",
+  max: 1,
+  windowMs: 60_000,
+  store: "mongo",
+});
+```
+
+`DocumentStorageApp` takes the same options as `uploadRateLimit`. The example backend allows one upload per IP per minute and sets `trust proxy` to `1` on Cloud Run so the key is the real client IP.
+
 ## Auth vs API buckets
 
 | Path | Bucket |

package/src/docs/versioned/next/how-to/test-ui-accessibility.md

@@ -0,0 +1,35 @@
+# Test UI accessibility
+
+Run the WCAG scanner against every changed rendered state:
+
+```bash
+bun run accessibility:scan \
+  "http://localhost:8085/dev/Theme?story=ThemeComponent&theme=light" \
+  "http://localhost:8085/dev/Theme?story=ThemeComponent&theme=dark"
+```
+
+The scanner applies axe rules tagged WCAG 2.0 A/AA, WCAG 2.1 A/AA, and WCAG
+2.2 AA. It writes a JSON report and full-page screenshots under
+`/opt/cursor/artifacts/accessibility/` and exits nonzero when any violation is
+found.
+
+## Verify what automation cannot
+
+1. Use only the keyboard to reach and operate each changed control.
+2. Confirm focus order and the visible focus indicator match the visual order.
+3. Inspect each control's accessible name, role, state, and error relationship.
+4. Check light and dark modes, plus loading, empty, disabled, and error states
+   affected by the change.
+5. At 200% browser zoom, confirm content remains usable without clipping or
+   losing actions.
+
+Automated scans do not prove keyboard behavior, announcement quality, reading
+order, or whether alternative text conveys the intended meaning. Record those
+manual checks with the automated report in the pull request Verification table.
+
+## Fixing findings
+
+Fix violations in the changed feature before submission. If a finding is
+pre-existing and outside the changed path, capture a baseline on an unaffected
+route and name both routes in the pull request. Do not suppress an axe rule
+without a linked issue and a documented reason.