@mccaskie-labs/workbench-config 0.1.41 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mccaskie-labs/workbench-config
 
+## 0.2.0
+
+### Minor Changes
+
+- Breaking: there is no built-in Gateway address any more (hard rule 13, `docs/install-plan.md`). `DEFAULT_GATEWAY_URL` is removed from workbench-config, `createAi` needs `url`, and `createMailer`'s gateway transport needs `gateway.url`. Pass the app's `WORKBENCH_GATEWAY_URL`, which Control writes into `wrangler.jsonc` when it creates a project. A missing address fails at start-up with `invalid_config` and the message "WORKBENCH_GATEWAY_URL is missing". The gateway manifest marks `WORKBENCH_GATEWAY_URL` required with no default.
+
 ## 0.1.41
 
 ### Patch Changes

package/README.md

@@ -30,7 +30,6 @@ const { WORKBENCH_GATEWAY_KEY } = config.parse(env)
 | `defineBrand(json)`, `brandSchema`, `resolveBrand`, `BRAND_DEFAULTS`, `BRAND_FILE` | The app's brand file, `brand.json` at the repo root: `name`, `siteUrl` (https), `logo.url` (https PNG, JPEG or SVG; optional `alt`, `width`, `height`), `colours.primary` (`#rrggbb`; `text`, `background`, `muted` default), optional `fonts.heading`/`fonts.body` (`{ family, url? }`, `url` an https stylesheet), `supportEmail` and `footer`. Unknown keys fail. Account emails, PDFs and Supabase's sign-in emails all read it |
 | `checkLogo(bytes)`, `placeholderLogo(name, colour)`, `colourForId(id)`, `parseColour`, `whiteContrast`, `shownSize`, `LOGO_PATHS`, `MAX_LOGO_BYTES`, `BrandAssetError` | Setting a brand from an upload: the logo is checked by its own bytes (PNG or JPEG, at most 256 KiB; SVG refused because Gmail and Outlook don't show it), a project with no logo gets its initials on its colour as a 96 × 96 PNG, and a project with no colour gets a steady one from its id that white text reads on (WCAG 4.5:1). Runs in Workers, the browser and Node |
 | `VENDOR_SETTINGS`, `resolveVendorSettings(file, env)`, `vendorSettingsFileSchema`, `VENDOR_SETTINGS_FILE`, `SEND_EMAIL_HOOK`, `SEND_EMAIL_HOOK_PATH`, `SEND_EMAIL_HOOK_SECRET` | The vendor settings baseline: settings that live in a vendor dashboard (field, value, where it is, what breaks if it changes). A project changes a row in `vendor-settings.json` at its repo root, with a reason. Control applies it with `vendor_settings_apply` and compares it every day |
-| `DEFAULT_GATEWAY_URL` | `https://gateway.mccaskielabs.dev` |
 
 `npx workbench-config check [dir]` compares the variable names in `.dev.vars` with `.dev.vars.example` and prints names only.
 

package/capabilities/ai.json

@@ -95,7 +95,7 @@
       "title": "One-shot text",
       "lang": "ts",
       "probe": "ai.text.claude-default",
-      "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst r = await ai.text({ model: 'claude-default', job: 'article.write', prompt })\nawait save({ text: r.text, model: r.model, requestId: r.requestId })"
+      "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst r = await ai.text({ model: 'claude-default', job: 'article.write', prompt })\nawait save({ text: r.text, model: r.model, requestId: r.requestId })"
     },
     {
       "id": "ai.example.voice",

package/capabilities/email.json

@@ -52,7 +52,7 @@
       "title": "Send a transactional mail with an inline logo",
       "lang": "ts",
       "probe": "email.send.inline-attachment",
-      "code": "const env = workbenchEnv(process.env)\nconst mailer = createMailer({ env, transport: selectTransport(env), from: { address: 'hello@mail.example.com', name: 'Example' }, gateway: { key: process.env.WORKBENCH_GATEWAY_KEY! } })\nawait mailer.send({ to: user.email, subject: 'Welcome', text, html: '<img src=\"cid:logo\"> ...', template: 'welcome', idempotencyKey: `welcome:${user.id}`, attachments: [{ filename: 'logo.png', mimeType: 'image/png', bytes: logo, contentId: 'logo' }] })"
+      "code": "const env = workbenchEnv(process.env)\nconst mailer = createMailer({ env, transport: selectTransport(env), from: { address: 'hello@mail.example.com', name: 'Example' }, gateway: { key: process.env.WORKBENCH_GATEWAY_KEY!, url: process.env.WORKBENCH_GATEWAY_URL! } })\nawait mailer.send({ to: user.email, subject: 'Welcome', text, html: '<img src=\"cid:logo\"> ...', template: 'welcome', idempotencyKey: `welcome:${user.id}`, attachments: [{ filename: 'logo.png', mimeType: 'image/png', bytes: logo, contentId: 'logo' }] })"
     }
   ],
   "probes": [

package/capabilities/gateway.json

@@ -6,8 +6,7 @@
   "summary": "What every Gateway endpoint shares: project keys by environment and scope, the request and response headers, the monthly budget check and the error codes. Apps hold one Workbench key and never a vendor key.",
   "status": "built",
   "surfaces": {
-    "gateway": ["GET /v1/health", "GET /v1/usage", "GET /v1/capabilities", "GET /v1/calls"],
-    "package": ["DEFAULT_GATEWAY_URL"]
+    "gateway": ["GET /v1/health", "GET /v1/usage", "GET /v1/capabilities", "GET /v1/calls"]
   },
   "config": [
     {
@@ -19,11 +18,10 @@
     },
     {
       "name": "WORKBENCH_GATEWAY_URL",
-      "required": false,
+      "required": true,
       "secret": false,
-      "default": "https://gateway.mccaskielabs.dev",
       "environments": ["development", "staging", "production"],
-      "description": "Gateway base URL. Leave unset outside tests"
+      "description": "The address of this Workbench install's Gateway. Control writes it into wrangler.jsonc when it creates the project; there is no built-in address"
     }
   ],
   "allowed": {

package/capabilities/image-search.json

@@ -120,7 +120,7 @@
       "title": "Search for images",
       "lang": "ts",
       "probe": "image-search.serper",
-      "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst results = await ai.images.search({ q: 'Mayon volcano', job: 'editor.image-search', num: 10 })"
+      "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst results = await ai.images.search({ q: 'Mayon volcano', job: 'editor.image-search', num: 10 })"
     }
   ],
   "probes": [

package/capabilities/images.json

@@ -166,7 +166,7 @@
       "title": "Generate one image",
       "lang": "ts",
       "probe": "images.generate.image-default",
-      "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst img = await ai.images.generate({ prompt, aspectRatio: '3:2', job: 'article.hero' })\nawait env.IMAGES.put(key, img.bytes, { httpMetadata: { contentType: img.mimeType }, customMetadata: { model: img.model, requestId: img.requestId } })"
+      "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst img = await ai.images.generate({ prompt, aspectRatio: '3:2', job: 'article.hero' })\nawait env.IMAGES.put(key, img.bytes, { httpMetadata: { contentType: img.mimeType }, customMetadata: { model: img.model, requestId: img.requestId } })"
     },
     {
       "id": "images.example.reference",

package/dist/capabilities.gen.d.ts

@@ -1,4 +1,4 @@
-export declare const MANIFEST_VERSION: "b986177e8690";
+export declare const MANIFEST_VERSION: "5f4a5d2dad37";
 export declare const capabilities: {
     readonly ai: {
         readonly $schema: "./schema.json";
@@ -119,7 +119,7 @@ export declare const capabilities: {
             readonly id: "ai.example.text";
             readonly title: "One-shot text";
             readonly lang: "ts";
-            readonly code: "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst r = await ai.text({ model: 'claude-default', job: 'article.write', prompt })\nawait save({ text: r.text, model: r.model, requestId: r.requestId })";
+            readonly code: "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst r = await ai.text({ model: 'claude-default', job: 'article.write', prompt })\nawait save({ text: r.text, model: r.model, requestId: r.requestId })";
             readonly probe: "ai.text.claude-default";
         }, {
             readonly id: "ai.example.voice";
@@ -816,7 +816,7 @@ export declare const capabilities: {
             readonly id: "email.example.send";
             readonly title: "Send a transactional mail with an inline logo";
             readonly lang: "ts";
-            readonly code: "const env = workbenchEnv(process.env)\nconst mailer = createMailer({ env, transport: selectTransport(env), from: { address: 'hello@mail.example.com', name: 'Example' }, gateway: { key: process.env.WORKBENCH_GATEWAY_KEY! } })\nawait mailer.send({ to: user.email, subject: 'Welcome', text, html: '<img src=\"cid:logo\"> ...', template: 'welcome', idempotencyKey: `welcome:${user.id}`, attachments: [{ filename: 'logo.png', mimeType: 'image/png', bytes: logo, contentId: 'logo' }] })";
+            readonly code: "const env = workbenchEnv(process.env)\nconst mailer = createMailer({ env, transport: selectTransport(env), from: { address: 'hello@mail.example.com', name: 'Example' }, gateway: { key: process.env.WORKBENCH_GATEWAY_KEY!, url: process.env.WORKBENCH_GATEWAY_URL! } })\nawait mailer.send({ to: user.email, subject: 'Welcome', text, html: '<img src=\"cid:logo\"> ...', template: 'welcome', idempotencyKey: `welcome:${user.id}`, attachments: [{ filename: 'logo.png', mimeType: 'image/png', bytes: logo, contentId: 'logo' }] })";
             readonly probe: "email.send.inline-attachment";
         }];
         readonly probes: readonly [{
@@ -1366,7 +1366,6 @@ export declare const capabilities: {
         readonly status: "built";
         readonly surfaces: {
             readonly gateway: readonly ["GET /v1/health", "GET /v1/usage", "GET /v1/capabilities", "GET /v1/calls"];
-            readonly package: readonly ["DEFAULT_GATEWAY_URL"];
         };
         readonly config: readonly [{
             readonly name: "WORKBENCH_GATEWAY_KEY";
@@ -1376,11 +1375,10 @@ export declare const capabilities: {
             readonly description: "The project's Gateway key for this environment, delivered as a Worker secret by gw_key_issue. Never in code, .dev.vars.example or logs";
         }, {
             readonly name: "WORKBENCH_GATEWAY_URL";
-            readonly required: false;
+            readonly required: true;
             readonly secret: false;
-            readonly default: "https://gateway.mccaskielabs.dev";
             readonly environments: readonly ["development", "staging", "production"];
-            readonly description: "Gateway base URL. Leave unset outside tests";
+            readonly description: "The address of this Workbench install's Gateway. Control writes it into wrangler.jsonc when it creates the project; there is no built-in address";
         }];
         readonly allowed: {
             readonly scopes: readonly ["ai", "images", "search", "email"];
@@ -1679,7 +1677,7 @@ export declare const capabilities: {
             readonly id: "image-search.example.search";
             readonly title: "Search for images";
             readonly lang: "ts";
-            readonly code: "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst results = await ai.images.search({ q: 'Mayon volcano', job: 'editor.image-search', num: 10 })";
+            readonly code: "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst results = await ai.images.search({ q: 'Mayon volcano', job: 'editor.image-search', num: 10 })";
             readonly probe: "image-search.serper";
         }];
         readonly probes: readonly [{
@@ -1809,7 +1807,7 @@ export declare const capabilities: {
             readonly id: "images.example.generate";
             readonly title: "Generate one image";
             readonly lang: "ts";
-            readonly code: "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst img = await ai.images.generate({ prompt, aspectRatio: '3:2', job: 'article.hero' })\nawait env.IMAGES.put(key, img.bytes, { httpMetadata: { contentType: img.mimeType }, customMetadata: { model: img.model, requestId: img.requestId } })";
+            readonly code: "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst img = await ai.images.generate({ prompt, aspectRatio: '3:2', job: 'article.hero' })\nawait env.IMAGES.put(key, img.bytes, { httpMetadata: { contentType: img.mimeType }, customMetadata: { model: img.model, requestId: img.requestId } })";
             readonly probe: "images.generate.image-default";
         }, {
             readonly id: "images.example.reference";

package/dist/capabilities.gen.js

@@ -1,6 +1,6 @@
 // Generated by `npm run capabilities:build` from capabilities/*.json. Do not edit.
 // check:capabilities fails in Checks when this file is stale.
-export const MANIFEST_VERSION = "b986177e8690";
+export const MANIFEST_VERSION = "5f4a5d2dad37";
 export const capabilities = {
     "ai": {
         "$schema": "./schema.json",
@@ -204,7 +204,7 @@ export const capabilities = {
                 "id": "ai.example.text",
                 "title": "One-shot text",
                 "lang": "ts",
-                "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst r = await ai.text({ model: 'claude-default', job: 'article.write', prompt })\nawait save({ text: r.text, model: r.model, requestId: r.requestId })",
+                "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst r = await ai.text({ model: 'claude-default', job: 'article.write', prompt })\nawait save({ text: r.text, model: r.model, requestId: r.requestId })",
                 "probe": "ai.text.claude-default"
             },
             {
@@ -1139,7 +1139,7 @@ export const capabilities = {
                 "id": "email.example.send",
                 "title": "Send a transactional mail with an inline logo",
                 "lang": "ts",
-                "code": "const env = workbenchEnv(process.env)\nconst mailer = createMailer({ env, transport: selectTransport(env), from: { address: 'hello@mail.example.com', name: 'Example' }, gateway: { key: process.env.WORKBENCH_GATEWAY_KEY! } })\nawait mailer.send({ to: user.email, subject: 'Welcome', text, html: '<img src=\"cid:logo\"> ...', template: 'welcome', idempotencyKey: `welcome:${user.id}`, attachments: [{ filename: 'logo.png', mimeType: 'image/png', bytes: logo, contentId: 'logo' }] })",
+                "code": "const env = workbenchEnv(process.env)\nconst mailer = createMailer({ env, transport: selectTransport(env), from: { address: 'hello@mail.example.com', name: 'Example' }, gateway: { key: process.env.WORKBENCH_GATEWAY_KEY!, url: process.env.WORKBENCH_GATEWAY_URL! } })\nawait mailer.send({ to: user.email, subject: 'Welcome', text, html: '<img src=\"cid:logo\"> ...', template: 'welcome', idempotencyKey: `welcome:${user.id}`, attachments: [{ filename: 'logo.png', mimeType: 'image/png', bytes: logo, contentId: 'logo' }] })",
                 "probe": "email.send.inline-attachment"
             }
         ],
@@ -1861,9 +1861,6 @@ export const capabilities = {
                 "GET /v1/usage",
                 "GET /v1/capabilities",
                 "GET /v1/calls"
-            ],
-            "package": [
-                "DEFAULT_GATEWAY_URL"
             ]
         },
         "config": [
@@ -1879,15 +1876,14 @@ export const capabilities = {
             },
             {
                 "name": "WORKBENCH_GATEWAY_URL",
-                "required": false,
+                "required": true,
                 "secret": false,
-                "default": "https://gateway.mccaskielabs.dev",
                 "environments": [
                     "development",
                     "staging",
                     "production"
                 ],
-                "description": "Gateway base URL. Leave unset outside tests"
+                "description": "The address of this Workbench install's Gateway. Control writes it into wrangler.jsonc when it creates the project; there is no built-in address"
             }
         ],
         "allowed": {
@@ -2278,7 +2274,7 @@ export const capabilities = {
                 "id": "image-search.example.search",
                 "title": "Search for images",
                 "lang": "ts",
-                "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst results = await ai.images.search({ q: 'Mayon volcano', job: 'editor.image-search', num: 10 })",
+                "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst results = await ai.images.search({ q: 'Mayon volcano', job: 'editor.image-search', num: 10 })",
                 "probe": "image-search.serper"
             }
         ],
@@ -2459,7 +2455,7 @@ export const capabilities = {
                 "id": "images.example.generate",
                 "title": "Generate one image",
                 "lang": "ts",
-                "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env) })\nconst img = await ai.images.generate({ prompt, aspectRatio: '3:2', job: 'article.hero' })\nawait env.IMAGES.put(key, img.bytes, { httpMetadata: { contentType: img.mimeType }, customMetadata: { model: img.model, requestId: img.requestId } })",
+                "code": "const ai = createAi({ key: env.WORKBENCH_GATEWAY_KEY, env: workbenchEnv(env), url: env.WORKBENCH_GATEWAY_URL })\nconst img = await ai.images.generate({ prompt, aspectRatio: '3:2', job: 'article.hero' })\nawait env.IMAGES.put(key, img.bytes, { httpMetadata: { contentType: img.mimeType }, customMetadata: { model: img.model, requestId: img.requestId } })",
                 "probe": "images.generate.image-default"
             },
             {

package/dist/env.d.ts

@@ -1,6 +1,5 @@
 export declare const WORKBENCH_ENVS: readonly ["development", "staging", "production"];
 export type WorkbenchEnv = (typeof WORKBENCH_ENVS)[number];
-export declare const DEFAULT_GATEWAY_URL = "https://gateway.mccaskielabs.dev";
 /**
  * Reads `WORKBENCH_ENV`. Throws if it is missing or not one of the three
  * environments. Never falls back to `NODE_ENV` or a default (audit F9, F18).

package/dist/env.js

@@ -1,6 +1,5 @@
 import { invalid, missing } from "./errors.js";
 export const WORKBENCH_ENVS = ["development", "staging", "production"];
-export const DEFAULT_GATEWAY_URL = "https://gateway.mccaskielabs.dev";
 /**
  * Reads `WORKBENCH_ENV`. Throws if it is missing or not one of the three
  * environments. Never falls back to `NODE_ENV` or a default (audit F9, F18).

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { WORKBENCH_ENVS, DEFAULT_GATEWAY_URL, workbenchEnv, type WorkbenchEnv } from "./env.ts";
+export { WORKBENCH_ENVS, workbenchEnv, type WorkbenchEnv } from "./env.ts";
 export { defineConfig, type Config } from "./define-config.ts";
 export { sharedSecret, workerSecret, redact, redactAll, type SecretsStoreSecretLike } from "./secrets.ts";
 export { WorkbenchConfigError, type ConfigErrorCode, type ConfigProblem } from "./errors.ts";

package/dist/index.js

@@ -1,4 +1,4 @@
-export { WORKBENCH_ENVS, DEFAULT_GATEWAY_URL, workbenchEnv } from "./env.js";
+export { WORKBENCH_ENVS, workbenchEnv } from "./env.js";
 export { defineConfig } from "./define-config.js";
 export { sharedSecret, workerSecret, redact, redactAll } from "./secrets.js";
 export { WorkbenchConfigError } from "./errors.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mccaskie-labs/workbench-config",
-  "version": "0.1.41",
+  "version": "0.2.0",
   "description": "Workbench app configuration: WORKBENCH_ENV, typed variables that fail by name, secrets that are never printed, and the capabilities manifest.",
   "license": "UNLICENSED",
   "type": "module",