@mccaskie-labs/workbench-config 0.2.4 → 0.3.0

package/dist/capabilities.gen.d.ts

@@ -1,4 +1,4 @@
-export declare const MANIFEST_VERSION: "15786d683e1e";
+export declare const MANIFEST_VERSION: "de365af27674";
 export declare const capabilities: {
     readonly ai: {
         readonly $schema: "./schema.json";
@@ -413,10 +413,45 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0;
             readonly note: "Create the site, drive page views, query them back (cf_analytics_query, later)";
         }];
+        readonly offer: {
+            readonly pattern: "switch_on";
+            readonly when: "The client wants to know how many people visit, which pages they open, or to count an action such as a sign-up or an order.";
+            readonly say: "The project already has Workbench visitor counts: page views counted by Cloudflare without cookies, and the actions you choose counted in the app's own database. I'll switch on what you want.";
+            readonly answers_file: "workbench/analytics.json";
+            readonly answers_format: "`{ \"format\": 1, \"page_views\": true, \"events\": [{ \"name\": \"order.placed\", \"when\": \"a customer sends an order\", \"details\": [\"items\", \"total_band\"] }] }`. For page views, create the Web Analytics site with Workbench Control (`cf_web_analytics_site_create`), write its beacon token onto staging and production (`cf_worker_secret_put source=web_analytics`), and put `beacon(env)` on every page customers see. For each event, call `eventsFor(db).track(name, details)` where the action happens.";
+            readonly questions: readonly [{
+                readonly id: "analytics.page-views";
+                readonly sets: "page_views";
+                readonly ask: "Should the site count its page views?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "Yes";
+                    readonly value: true;
+                    readonly means: "How many people visit and which pages they open, counted by Cloudflare. No cookies, and no personal details kept.";
+                }, {
+                    readonly label: "No";
+                    readonly value: false;
+                    readonly means: "Nothing is counted on the site's pages.";
+                }];
+                readonly note: "Only pages customers see; never the owner's or admins' pages.";
+            }, {
+                readonly id: "analytics.actions";
+                readonly sets: "events";
+                readonly ask: "Which actions should be counted?";
+                readonly style: "table";
+                readonly note: "Propose the few actions that show whether the site is working for the business (a sign-up, an order, a booking, a form sent), each with a name (`thing.past_verb`, lower case: `order.placed`), when it happens in the client's words, and its details. Details are counts, choices and bands (`items`, `plan`, `total_band`), never an email address, a name, a phone number or free text someone typed. The client accepts, removes or adds; an empty list is fine.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "consent";
+                readonly why: "The page-view counter sets no cookies and keeps no personal details, and events hold none either, so they add nothing that a cookie notice would need to cover.";
+            }, {
+                readonly sets: "reports";
+                readonly why: "Page views are seen in Cloudflare's Web Analytics, and events are rows in the app's own `events` table; ask what the owner wants to see when they ask for a report.";
+            }];
+        };
         readonly delivery: {
             readonly choice: "optional";
             readonly intro: "Counting page views and the things visitors do on the site.";
-            readonly when: "The client wants to know how many people visit, which pages they open, or to count an action such as a sign-up or an order.";
         };
     };
     readonly config: {
@@ -565,10 +600,137 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0;
             readonly note: "Every pack's spelling is one the Gateway accepts (en-PH, en-AU, en-GB, en-US), checked against the ai manifest's spellings; no Gateway call";
         }];
+        readonly offer: {
+            readonly pattern: "project";
+            readonly when: "The app shows a date, a time, a number, a phone number or an amount of money to its readers, or the client says where their readers are.";
+            readonly say: "I'll write dates, times and money with Workbench country formats, the way your readers expect them. That needs to know where they are, once for the whole site.";
+            readonly answers_file: "workbench/country.json";
+            readonly answers_format: "`{ \"format\": 1, \"country\": \"AU\", \"time_zone\": null, \"currency\": null }`: the country code (or `ZZ`, the package's WORLDWIDE, for readers everywhere), and an IANA time zone or `{ \"code\", \"symbol\" }` currency only when they differ from the country's own (the Australian and US time questions both fill `time_zone`). Then set `READERS` in `src/lib/country.ts` to match: `audiencePack({ country, timeZone, currency })`, leaving out what is null. Every page, email, PDF and form reads `READERS`, so nothing else changes.";
+            readonly questions: readonly [{
+                readonly id: "country.where";
+                readonly sets: "audience.country";
+                readonly ask: "Where are most of the site's readers?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "Australia";
+                    readonly value: "AU";
+                    readonly means: "26 September 2026, A$1,400, Sydney time, Australian spelling.";
+                }, {
+                    readonly label: "The Philippines";
+                    readonly value: "PH";
+                    readonly means: "September 26, 2026, ₱1,400, Manila time.";
+                }, {
+                    readonly label: "The United Kingdom";
+                    readonly value: "GB";
+                    readonly means: "26 September 2026, £1,400, UK time, British spelling.";
+                }, {
+                    readonly label: "The United States";
+                    readonly value: "US";
+                    readonly means: "September 26, 2026, US$1,400, Eastern time, American spelling.";
+                }];
+                readonly other: {
+                    readonly kind: "text";
+                    readonly min: 2;
+                    readonly max: 60;
+                    readonly description: "Another country, or readers all over the world.";
+                };
+                readonly note: "Recommend Australia unless the client's words say otherwise. A country with no pack yet, or readers everywhere, gets the neutral one (`ZZ`: 26 September 2026, 24-hour clock, UTC, US$): say so, and ask for the currency.";
+            }, {
+                readonly id: "country.au-time";
+                readonly sets: "audience.time_zone.au";
+                readonly ask: "Which Australian time should the site show?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "Sydney, Melbourne, Canberra";
+                    readonly value: null;
+                    readonly means: "The pack's own (Australia/Sydney), with daylight saving.";
+                }, {
+                    readonly label: "Brisbane";
+                    readonly value: "Australia/Brisbane";
+                    readonly means: "Queensland, no daylight saving.";
+                }, {
+                    readonly label: "Adelaide";
+                    readonly value: "Australia/Adelaide";
+                    readonly means: "South Australia, half an hour behind Sydney.";
+                }, {
+                    readonly label: "Perth";
+                    readonly value: "Australia/Perth";
+                    readonly means: "Western Australia.";
+                }];
+                readonly other: {
+                    readonly kind: "text";
+                    readonly min: 5;
+                    readonly max: 40;
+                    readonly description: "Another Australian time zone, such as Australia/Darwin or Australia/Hobart.";
+                };
+                readonly when: {
+                    readonly id: "country.where";
+                    readonly is: readonly ["AU"];
+                };
+                readonly note: "The time zone of the business, where bookings and opening hours happen. Hobart follows Sydney; Darwin is Australia/Darwin.";
+            }, {
+                readonly id: "country.us-time";
+                readonly sets: "audience.time_zone.us";
+                readonly ask: "Which US time should the site show?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "Eastern";
+                    readonly value: null;
+                    readonly means: "The pack's own (America/New_York).";
+                }, {
+                    readonly label: "Central";
+                    readonly value: "America/Chicago";
+                }, {
+                    readonly label: "Mountain";
+                    readonly value: "America/Denver";
+                }, {
+                    readonly label: "Pacific";
+                    readonly value: "America/Los_Angeles";
+                }];
+                readonly other: {
+                    readonly kind: "text";
+                    readonly min: 5;
+                    readonly max: 40;
+                    readonly description: "Another US time zone, such as America/Phoenix or Pacific/Honolulu.";
+                };
+                readonly when: {
+                    readonly id: "country.where";
+                    readonly is: readonly ["US"];
+                };
+                readonly note: "The time zone of the business.";
+            }, {
+                readonly id: "country.currency";
+                readonly sets: "audience.currency";
+                readonly ask: "Which money are prices in?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "The country's own";
+                    readonly value: null;
+                    readonly means: "A$ in Australia, ₱ in the Philippines, £ in the UK, US$ in the US.";
+                }, {
+                    readonly label: "US dollars";
+                    readonly value: "USD";
+                    readonly means: "Shown as US$1,400.";
+                }];
+                readonly other: {
+                    readonly kind: "text";
+                    readonly min: 3;
+                    readonly max: 3;
+                    readonly description: "Another currency's three-letter code, such as NZD or EUR.";
+                };
+                readonly note: "Write a currency other than the country's as `{ \"code\", \"symbol\" }` (NZD is NZ$). Ask it only when the client sells something; otherwise record null.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "audience.format";
+                readonly why: "Date order, the clock, number separators, spelling and phone number shapes all come from the country's pack, so they match what readers expect without asking.";
+            }, {
+                readonly sets: "audience.owner_pages";
+                readonly why: "Pages only the owner sees use workbench-ui's own times and money, not the readers'.";
+            }];
+        };
         readonly delivery: {
             readonly choice: "optional";
             readonly intro: "Dates, times, numbers and money written the way readers in your country expect.";
-            readonly when: "The app shows a date, a time, a number, a phone number or an amount of money to its readers, or the client says where their readers are.";
         };
     };
     readonly database: {
@@ -747,10 +909,33 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0;
             readonly note: "On a project's staging: cf_turnstile_widget_create and the turnstile_sitekey and turnstile_secret sources; the sign-in page shows the check, /auth/code without a passed token sends no code, and with one it does";
         }];
+        readonly offer: {
+            readonly pattern: "settings";
+            readonly when: "The app needs to store or read data, or the client asks for a change to what is stored: a new table, column, rule or migration.";
+            readonly say: "The app's data goes in its own Workbench database, one for testing and one for the live site. I'll propose what to store and who can see it, and change it with a migration you can undo.";
+            readonly answers_file: "workbench/database.json";
+            readonly answers_format: "`{ \"format\": 1, \"status\": \"draft\", \"tables\": [{ \"name\": \"orders\", \"row\": \"one order\", \"columns\": [{ \"name\": \"total\", \"kind\": \"money\", \"required\": true }], \"read\": \"own\", \"change\": \"own\" }] }`. Then write one migration (`supabase/migrations/<14 digits>_<name>.sql`) with its down file, turning on row-level security with one policy per answer, apply it on staging with Workbench Control (`sb_migration_apply`), and refresh `supabase/staging-columns.json`.";
+            readonly questions: readonly [{
+                readonly id: "database.tables";
+                readonly sets: "tables";
+                readonly ask: "What should the app store, and who can see and change it?";
+                readonly style: "table";
+                readonly note: "Propose the tables the request needs, each with what one row is, its columns (name, kind such as text, number, money, date, yes/no, a link to another table; and whether it is required), and who may read and who may change its rows: `own` (the person who made the row), `admins`, `signed_in` (anyone signed in) or `public` (anyone, read only). Recommend `own` for anything about a person. Show money as whole cents, never a fraction. The client accepts, removes or adds tables and columns.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "keys";
+                readonly why: "The app reaches the database as the signed-in person (`dbAs`), so row-level security decides what each person sees; the template holds no secret key.";
+            }, {
+                readonly sets: "hosting";
+                readonly why: "Each project has its own staging and production databases, made by Workbench Control in the region set for the install.";
+            }, {
+                readonly sets: "sign_in_settings";
+                readonly why: "The database's sign-in settings follow the Workbench baseline (the workbench-sign-in skill).";
+            }];
+        };
         readonly delivery: {
             readonly choice: "built_in";
             readonly intro: "The app's own database, one for testing and one for the live site.";
-            readonly when: "The app needs to store or read data, or the client asks for a change to what is stored: a new table, column, rule or migration.";
         };
     };
     readonly email: {
@@ -995,13 +1180,67 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0;
             readonly note: "GET brand.json's logo.url from outside with no sign-in answers 200 with an image content type";
         }];
+        readonly offer: {
+            readonly pattern: "settings";
+            readonly when: "The app needs to send an email: a confirmation, receipt, notification, invitation or sign-in code.";
+            readonly say: "I'll send these with Workbench email, which sends from the app's own address in your brand, with no email key in the app. The sign-in codes are already there; I'll add yours beside them.";
+            readonly answers_file: "workbench/email.json";
+            readonly answers_format: "`{ \"format\": 1, \"status\": \"draft\", \"reply_to\": null, \"emails\": [{ \"id\": \"order_confirmed\", \"when\": \"a customer sends an order\", \"to\": \"the customer\", \"parts\": [\"heading\", \"paragraph\", \"button\"], \"link_changes_something\": false }] }`. Declare each email in `src/lib/emails.ts` with `defineEmails` (stream `transactional`, shell `account`, `decidedBy` naming this answers file), put its words in the strings under `email.<id>.<key>`, and send it with `mailerFor(env)` and an `idempotencyKey` whenever a retry could repeat it.";
+            readonly questions: readonly [{
+                readonly id: "email.emails";
+                readonly sets: "emails";
+                readonly ask: "Which emails should the app send?";
+                readonly style: "table";
+                readonly note: "Propose the emails the request needs, each with an id (snake_case: `order_confirmed`), when it is sent, who gets it, its parts in order (heading, paragraphs, a button and its link, small print) and whether its link changes something (then the link lands on a confirmation page first). Only emails a person's own action or account causes: receipts, confirmations, notices. The client accepts, removes or adds. The wording is drafted afterwards, one email at a time.";
+            }, {
+                readonly id: "email.reply-to";
+                readonly sets: "reply_to";
+                readonly ask: "Where should a reply to these emails go?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "Nowhere";
+                    readonly value: null;
+                    readonly means: "The emails come from an address that isn't read. Say so in the small print, with where to get help instead.";
+                }, {
+                    readonly label: "To the app";
+                    readonly value: "app";
+                    readonly means: "Replies go to an address the app reads itself (Workbench inbound email).";
+                }];
+                readonly other: {
+                    readonly kind: "text";
+                    readonly min: 6;
+                    readonly max: 254;
+                    readonly description: "An email address someone at the business reads.";
+                };
+                readonly must_ask: true;
+                readonly note: "A typed address goes in each send as `replyTo`; check it looks like an email address. With the app, the workbench-email-inbound skill sets up the address.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "sender";
+                readonly why: "Emails come from the project's own sending address (`FROM` in `src/lib/email.ts`) on its own domain, which Workbench Control sets up.";
+            }, {
+                readonly sets: "marketing";
+                readonly why: "Only transactional email exists: newsletters and other bulk mail are refused until Workbench has a sender for them, so offer none.";
+            }, {
+                readonly sets: "look";
+                readonly why: "Emails take the brand's name, colour and logo, and the project's `project.css` (see Restyling).";
+            }];
+            readonly drafts: {
+                readonly of: "wording for one email";
+                readonly surface: "ai";
+                readonly alias: "claude-default";
+                readonly count: 3;
+                readonly max_rounds: 3;
+                readonly job: "ai.drafts";
+                readonly command: "npx workbench-ai drafts text email_<id> --about \"<what the email is for, who gets it and its parts>\"";
+            };
+        };
         readonly styles: {
             readonly prefix: "wb-email-";
         };
         readonly delivery: {
             readonly choice: "built_in";
             readonly intro: "The emails the app sends, such as confirmations, receipts and sign-in codes.";
-            readonly when: "The app needs to send an email: a confirmation, receipt, notification, invitation or sign-in code.";
         };
     };
     readonly "email-inbound": {
@@ -1104,10 +1343,45 @@ export declare const capabilities: {
             readonly two_step: true;
             readonly note: "cf_email_routing_rule_delete returns a confirmation and changes nothing until Robert approves";
         }];
+        readonly offer: {
+            readonly pattern: "switch_on";
+            readonly when: "The client wants the app to receive email: replies to its messages, or an address such as hello@ that the app handles.";
+            readonly say: "The project can already receive email with Workbench inbound email: each address goes straight to the app, which decides what to do with every message. I'll switch on the addresses you want.";
+            readonly answers_file: "workbench/email-inbound.json";
+            readonly answers_format: "`{ \"format\": 1, \"addresses\": [{ \"name\": \"hello\", \"does\": \"saves it as a message the admins see\" }] }`. Then set `INBOUND_EMAIL` to `\"on\"` in `wrangler.jsonc`, write `handleEmail` in `src/app.ts` to do what each address `does`, and make the addresses with Workbench Control: `cf_email_routing_enable`, then `cf_email_routing_rule_create` for each address on staging first (the capabilities guide below has the steps).";
+            readonly questions: readonly [{
+                readonly id: "email-inbound.addresses";
+                readonly sets: "addresses";
+                readonly ask: "Which addresses should the app receive, and what should it do with each message?";
+                readonly style: "table";
+                readonly note: "Propose the addresses the request needs, each with its name (the part before @, lower case: `hello`, `bookings`) and what the app does with a message, in the client's words: save it for the admins to read, add it to a booking, answer it automatically. One address, one job. Say plainly that the app reads the mail itself: nothing is forwarded to anyone's inbox.";
+            }, {
+                readonly id: "email-inbound.attachments";
+                readonly sets: "attachments";
+                readonly ask: "What should happen to files attached to these emails?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "Leave them out";
+                    readonly value: "drop";
+                    readonly means: "The app keeps the words of each email, not its files. Nothing extra to store or check.";
+                }, {
+                    readonly label: "Keep them";
+                    readonly value: "keep";
+                    readonly means: "The app stores each file for the admins. Files can be large or unsafe, so keep only the types the job needs.";
+                }];
+                readonly note: "With keep, ask which types (photos, PDFs) and store them outside the Worker, in file storage the app already has, or ask the owner before adding some; refuse other types with `reject`.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "domain";
+                readonly why: "Addresses are on the project's own email domain: its staging name first, and the client's own domain once it is attached for production (`cf_zone_attach`).";
+            }, {
+                readonly sets: "forwarding";
+                readonly why: "Workbench never forwards mail outside the project or catches every address: each literal address goes to the app.";
+            }];
+        };
         readonly delivery: {
             readonly choice: "optional";
             readonly intro: "Receiving email at the project's own addresses, for the app to act on.";
-            readonly when: "The client wants the app to receive email: replies to its messages, or an address such as hello@ that the app handles.";
         };
     };
     readonly "email-sending": {
@@ -2567,10 +2841,45 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0;
             readonly note: "The app's own checkStrings run passes in its tests, and npx workbench-strings check passes in CI";
         }];
+        readonly offer: {
+            readonly pattern: "project";
+            readonly when: "The client wants to add or change wording on a page or in an email, or asks about showing the app in another language.";
+            readonly say: "Every word the app shows is kept in one place with Workbench strings, so changing wording never means hunting through code, and other languages can be added later.";
+            readonly answers_file: "workbench/strings.json";
+            readonly answers_format: "`{ \"format\": 1, \"languages\": [\"en-AU\"], \"later\": [\"fil\"] }`: the language the site is written in first, and any the client wants later. New wording goes into `strings/strings.<base>.json` with one key per sentence, and `npm run check:strings` checks it.";
+            readonly questions: readonly [{
+                readonly id: "strings.languages";
+                readonly sets: "languages";
+                readonly ask: "Does the site need to be in any language besides English?";
+                readonly style: "cards";
+                readonly answers: readonly [{
+                    readonly label: "English only";
+                    readonly value: "none";
+                    readonly means: "Every page and email is in English.";
+                }, {
+                    readonly label: "Another language later";
+                    readonly value: "later";
+                    readonly means: "English now. The words are kept so a translation can be added, checked by a native speaker, without changing the code.";
+                }];
+                readonly other: {
+                    readonly kind: "text";
+                    readonly min: 2;
+                    readonly max: 120;
+                    readonly description: "The languages, such as Filipino or Spanish.";
+                };
+                readonly note: "Translations come with a Workbench tool that isn't built yet: record the languages under `later`, keep every word in the catalogue, and tell the client a translation goes live only once a named native speaker has checked it.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "base";
+                readonly why: "The site is written first in English, in the readers' spelling from the country answers, so it isn't asked again.";
+            }, {
+                readonly sets: "wording";
+                readonly why: "Wording is content, not a setting: the client says what they want in their own words, or asks for drafts (the workbench-ai skill), and it goes into the catalogue.";
+            }];
+        };
         readonly delivery: {
             readonly choice: "built_in";
             readonly intro: "The words on the app's screens and in its emails, kept in one place for each language.";
-            readonly when: "The client wants to add or change wording on a page or in an email, or asks about showing the app in another language.";
         };
     };
     readonly ui: {
@@ -2636,13 +2945,33 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0;
             readonly note: "In the Worker itself: compares money (US$0.0042, US$12.50, and an en dash for nothing), duration (640 ms, 2.35 s, 3 min 5 s) and timeLeft against a fixed now (42 minutes left) with the expected text, and checks when and shortWhen write one fixed moment as its Manila day and hour with UTC beside it";
         }];
+        readonly offer: {
+            readonly pattern: "switch_on";
+            readonly when: "The client wants a page only the owner or the app's admins see: a dashboard, a list, a settings page or a status page.";
+            readonly say: "I'll build this with the Workbench owner-page look, the same top bar, cards and pills as the other admin pages, so it's quick to build and consistent. Your customers never see it.";
+            readonly answers_file: "workbench/ui.json";
+            readonly answers_format: "`{ \"format\": 1, \"pages\": [{ \"path\": \"/admin/orders\", \"what\": \"every order this month, newest first\", \"who\": \"admins\" }] }`. Build each page with `shell`, `topBar`, `card` and `pill`. An `admins` page lives under `/admin/` and checks `requireUser` and `app_admins` (the workbench-sign-in skill); an `owner` page lives under `/owner/` and is behind Access in production.";
+            readonly questions: readonly [{
+                readonly id: "ui.pages";
+                readonly sets: "pages";
+                readonly ask: "Which admin pages should the app have?";
+                readonly style: "table";
+                readonly note: "Propose the pages the request needs, each with its path, what it shows or lets them change in the client's words, and who sees it: `admins` (the business's people, who sign in to the app) or `owner` (whoever runs the app's Workbench, through Access). Recommend `admins` unless the page is about running the app itself, such as a status page. The client accepts, removes or adds pages.";
+            }];
+            readonly not_asked: readonly [{
+                readonly sets: "look";
+                readonly why: "Every admin page has the same Workbench look, so the business's people learn it once. Restyle it in project.css (see Restyling) if the client wants their colours.";
+            }, {
+                readonly sets: "formats";
+                readonly why: "Times, amounts and durations on these pages come from workbench-ui's `when`, `money` and `duration`. What customers see uses the readers' formats (the workbench-country skill).";
+            }];
+        };
         readonly styles: {
             readonly prefix: "wb-ui-";
         };
         readonly delivery: {
             readonly choice: "optional";
             readonly intro: "A ready-made look for the pages only you and your admins see.";
-            readonly when: "The client wants a page only the owner or the app's admins see: a dashboard, a list, a settings page or a status page.";
         };
     };
 };