@mccaskie-labs/workbench-config 0.1.14 → 0.1.15

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mccaskie-labs/workbench-config
 
+## 0.1.15
+
+### Patch Changes
+
+- The `email` manifest's probe ids now match wb-probe's, which already hold stored history and appear in the phase 4 checkpoint: `email.send.inline-attachment` (was `email.send.inline-image`) and `email.send.dev-key-recipient-refused` (was `email.send.dev-recipient-refused`). `email.send.transactional` is no longer in the daily smoke run, so the smoke run sends no daily mail. `email.send.new-sender` (after the Control drill's `gw_sender_add`) is listed.
+- The `config` manifest lists the brand file exports (`BRAND_FILE`, `brandSchema`, `defineBrand`, `resolveBrand`, `BRAND_DEFAULTS`), a rule to keep one `brand.json` per app, and the probe `config.brand-file`.
+
 ## 0.1.14
 
 ### Patch Changes

package/capabilities/config.json

@@ -17,7 +17,12 @@
       "capabilitySchema",
       "capabilities",
       "MANIFEST_VERSION",
-      "compareDevVars"
+      "compareDevVars",
+      "BRAND_FILE",
+      "brandSchema",
+      "defineBrand",
+      "resolveBrand",
+      "BRAND_DEFAULTS"
     ]
   },
   "config": [
@@ -36,7 +41,8 @@
     { "id": "config.fail-by-name", "kind": "must", "text": "Fail at startup when a required variable is missing or invalid, naming every bad variable in one error.", "enforced_by": "types", "probe": "config.missing-variable-named" },
     { "id": "config.never-print-values", "kind": "must_not", "text": "Print, log or include in an error the value of any variable, valid or not.", "enforced_by": "types", "probe": "config.value-never-printed" },
     { "id": "config.no-node-env", "kind": "must_not", "text": "Decide the environment from NODE_ENV or a default. WORKBENCH_ENV is required and has no fallback.", "enforced_by": "types", "probe": "config.env-required" },
-    { "id": "config.dev-vars-example", "kind": "must", "text": "Keep .dev.vars.example listing every variable .dev.vars has, with no values; check with npx workbench-config check.", "enforced_by": "review", "probe": "config.dev-vars-check" }
+    { "id": "config.dev-vars-example", "kind": "must", "text": "Keep .dev.vars.example listing every variable .dev.vars has, with no values; check with npx workbench-config check.", "enforced_by": "review", "probe": "config.dev-vars-check" },
+    { "id": "config.one-brand-file", "kind": "must", "text": "Keep the app's name, logo, colours and fonts in brand.json at the repo root, read with defineBrand, so emails, PDFs and sign-in mails are branded from one file.", "enforced_by": "types", "probe": "config.brand-file" }
   ],
   "examples": [
     {
@@ -51,6 +57,7 @@
     { "id": "config.missing-variable-named", "half": "runtime", "expect": "pass", "smoke": true, "cost_hint_usd": 0 },
     { "id": "config.value-never-printed", "half": "runtime", "expect": "pass", "smoke": true, "cost_hint_usd": 0 },
     { "id": "config.env-required", "half": "runtime", "expect": "pass", "cost_hint_usd": 0 },
+    { "id": "config.brand-file", "half": "runtime", "expect": "pass", "cost_hint_usd": 0, "note": "The app's brand.json passes defineBrand and a bad one is refused with every bad field named" },
     { "id": "config.dev-vars-check", "half": "runtime", "expect": "pass", "cost_hint_usd": 0, "note": "Manual: run npx workbench-config check in the project" }
   ]
 }

package/capabilities/email.json

@@ -35,10 +35,10 @@
   "rules": [
     { "id": "email.text-always", "kind": "must", "text": "Send a text part with every mail, even when there is HTML.", "enforced_by": "gateway", "probe": "email.send.transactional" },
     { "id": "email.idempotency-key", "kind": "must", "text": "Give an idempotencyKey to any send a retry could repeat (invites, receipts, resets). A repeat within 24 hours returns the first result and sends nothing.", "enforced_by": "review", "probe": "email.send.idempotent-repeat" },
-    { "id": "email.attachments-as-bytes", "kind": "must", "text": "Pass attachments as bytes (Uint8Array), and give an inline image a contentId that the HTML references as cid:.", "enforced_by": "types", "probe": "email.send.inline-image" },
+    { "id": "email.attachments-as-bytes", "kind": "must", "text": "Pass attachments as bytes (Uint8Array), and give an inline image a contentId that the HTML references as cid:.", "enforced_by": "types", "probe": "email.send.inline-attachment" },
     { "id": "email.allowed-sender", "kind": "must", "text": "Send only from an address added with gw_sender_add on a domain onboarded with cf_email_sending_onboard.", "enforced_by": "gateway", "probe": "email.send.sender-not-allowed" },
     { "id": "email.no-capture-outside-dev", "kind": "must_not", "text": "Use the capture transport outside development. createMailer throws when WORKBENCH_ENV is staging or production.", "enforced_by": "types", "probe": "email.capture-refused-in-staging" },
-    { "id": "email.dev-key-allowlist", "kind": "must_not", "text": "Expect a development key to mail anyone but Robert. The Gateway refuses other recipients before the budget.", "enforced_by": "gateway", "probe": "email.send.dev-recipient-refused" },
+    { "id": "email.dev-key-allowlist", "kind": "must_not", "text": "Expect a development key to mail anyone but Robert. The Gateway refuses other recipients before the budget.", "enforced_by": "gateway", "probe": "email.send.dev-key-recipient-refused" },
     { "id": "email.transactional-only", "kind": "must_not", "text": "Send bulk or marketing mail. type bulk is refused with not_available until Amazon SES is built.", "enforced_by": "gateway", "probe": "email.send.transactional" }
   ],
   "examples": [
@@ -46,16 +46,17 @@
       "id": "email.example.send",
       "title": "Send a transactional mail with an inline logo",
       "lang": "ts",
-      "probe": "email.send.inline-image",
+      "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' }] })"
     }
   ],
   "probes": [
-    { "id": "email.send.transactional", "half": "runtime", "expect": "pass", "smoke": true, "cost_hint_usd": 0.00035, "note": "To Robert; check that it arrives" },
-    { "id": "email.send.inline-image", "half": "runtime", "expect": "pass", "cost_hint_usd": 0.00035, "note": "Robert checks the image renders" },
+    { "id": "email.send.transactional", "half": "runtime", "expect": "pass", "cost_hint_usd": 0.00035, "note": "To Robert; check that it arrives. Not in the daily smoke run, so it sends no daily mail" },
+    { "id": "email.send.inline-attachment", "half": "runtime", "expect": "pass", "cost_hint_usd": 0.00035, "note": "Robert checks the image renders" },
     { "id": "email.send.idempotent-repeat", "half": "runtime", "expect": "pass", "cost_hint_usd": 0.00035, "note": "The repeat answers replayed: true and no second mail arrives" },
-    { "id": "email.send.dev-recipient-refused", "half": "runtime", "expect": "refused_as_expected", "refusal": "recipient_not_allowed", "cost_hint_usd": 0 },
+    { "id": "email.send.dev-key-recipient-refused", "half": "runtime", "expect": "refused_as_expected", "refusal": "recipient_not_allowed", "cost_hint_usd": 0 },
     { "id": "email.send.sender-not-allowed", "half": "runtime", "expect": "refused_as_expected", "refusal": "sender_not_allowed", "cost_hint_usd": 0 },
-    { "id": "email.capture-refused-in-staging", "half": "runtime", "expect": "pass", "cost_hint_usd": 0, "note": "createMailer with transport capture and WORKBENCH_ENV=staging throws invalid_config" }
+    { "id": "email.capture-refused-in-staging", "half": "runtime", "expect": "pass", "cost_hint_usd": 0, "note": "createMailer with transport capture and WORKBENCH_ENV=staging throws invalid_config" },
+    { "id": "email.send.new-sender", "half": "runtime", "expect": "pass", "cost_hint_usd": 0.00035, "note": "Runs after the Control drill's gw_sender_add step; skipped without it" }
   ]
 }

package/dist/capabilities.gen.d.ts

@@ -1,4 +1,4 @@
-export declare const MANIFEST_VERSION: "d0f2550e1f81";
+export declare const MANIFEST_VERSION: "f81423629d34";
 export declare const capabilities: {
     readonly ai: {
         readonly $schema: "./schema.json";
@@ -275,7 +275,7 @@ export declare const capabilities: {
         readonly summary: "Reads WORKBENCH_ENV and the app's own variables and secrets. A missing or invalid variable fails at startup, by name, and no value is ever printed.";
         readonly status: "built";
         readonly surfaces: {
-            readonly package: readonly ["workbenchEnv", "defineConfig", "sharedSecret", "workerSecret", "redact", "redactAll", "WorkbenchConfigError", "capabilitySchema", "capabilities", "MANIFEST_VERSION", "compareDevVars"];
+            readonly package: readonly ["workbenchEnv", "defineConfig", "sharedSecret", "workerSecret", "redact", "redactAll", "WorkbenchConfigError", "capabilitySchema", "capabilities", "MANIFEST_VERSION", "compareDevVars", "BRAND_FILE", "brandSchema", "defineBrand", "resolveBrand", "BRAND_DEFAULTS"];
         };
         readonly config: readonly [{
             readonly name: "WORKBENCH_ENV";
@@ -311,6 +311,12 @@ export declare const capabilities: {
             readonly text: "Keep .dev.vars.example listing every variable .dev.vars has, with no values; check with npx workbench-config check.";
             readonly enforced_by: "review";
             readonly probe: "config.dev-vars-check";
+        }, {
+            readonly id: "config.one-brand-file";
+            readonly kind: "must";
+            readonly text: "Keep the app's name, logo, colours and fonts in brand.json at the repo root, read with defineBrand, so emails, PDFs and sign-in mails are branded from one file.";
+            readonly enforced_by: "types";
+            readonly probe: "config.brand-file";
         }];
         readonly examples: readonly [{
             readonly id: "config.example.define";
@@ -336,6 +342,12 @@ export declare const capabilities: {
             readonly half: "runtime";
             readonly expect: "pass";
             readonly cost_hint_usd: 0;
+        }, {
+            readonly id: "config.brand-file";
+            readonly half: "runtime";
+            readonly expect: "pass";
+            readonly cost_hint_usd: 0;
+            readonly note: "The app's brand.json passes defineBrand and a bad one is refused with every bad field named";
         }, {
             readonly id: "config.dev-vars-check";
             readonly half: "runtime";
@@ -610,7 +622,7 @@ export declare const capabilities: {
             readonly kind: "must";
             readonly text: "Pass attachments as bytes (Uint8Array), and give an inline image a contentId that the HTML references as cid:.";
             readonly enforced_by: "types";
-            readonly probe: "email.send.inline-image";
+            readonly probe: "email.send.inline-attachment";
         }, {
             readonly id: "email.allowed-sender";
             readonly kind: "must";
@@ -628,7 +640,7 @@ export declare const capabilities: {
             readonly kind: "must_not";
             readonly text: "Expect a development key to mail anyone but Robert. The Gateway refuses other recipients before the budget.";
             readonly enforced_by: "gateway";
-            readonly probe: "email.send.dev-recipient-refused";
+            readonly probe: "email.send.dev-key-recipient-refused";
         }, {
             readonly id: "email.transactional-only";
             readonly kind: "must_not";
@@ -641,17 +653,16 @@ export declare const capabilities: {
             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 probe: "email.send.inline-image";
+            readonly probe: "email.send.inline-attachment";
         }];
         readonly probes: readonly [{
             readonly id: "email.send.transactional";
             readonly half: "runtime";
             readonly expect: "pass";
-            readonly smoke: true;
             readonly cost_hint_usd: 0.00035;
-            readonly note: "To Robert; check that it arrives";
+            readonly note: "To Robert; check that it arrives. Not in the daily smoke run, so it sends no daily mail";
         }, {
-            readonly id: "email.send.inline-image";
+            readonly id: "email.send.inline-attachment";
             readonly half: "runtime";
             readonly expect: "pass";
             readonly cost_hint_usd: 0.00035;
@@ -663,7 +674,7 @@ export declare const capabilities: {
             readonly cost_hint_usd: 0.00035;
             readonly note: "The repeat answers replayed: true and no second mail arrives";
         }, {
-            readonly id: "email.send.dev-recipient-refused";
+            readonly id: "email.send.dev-key-recipient-refused";
             readonly half: "runtime";
             readonly expect: "refused_as_expected";
             readonly refusal: "recipient_not_allowed";
@@ -680,6 +691,12 @@ export declare const capabilities: {
             readonly expect: "pass";
             readonly cost_hint_usd: 0;
             readonly note: "createMailer with transport capture and WORKBENCH_ENV=staging throws invalid_config";
+        }, {
+            readonly id: "email.send.new-sender";
+            readonly half: "runtime";
+            readonly expect: "pass";
+            readonly cost_hint_usd: 0.00035;
+            readonly note: "Runs after the Control drill's gw_sender_add step; skipped without it";
         }];
     };
     readonly "email-inbound": {

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 = "d0f2550e1f81";
+export const MANIFEST_VERSION = "f81423629d34";
 export const capabilities = {
     "ai": {
         "$schema": "./schema.json",
@@ -412,7 +412,12 @@ export const capabilities = {
                 "capabilitySchema",
                 "capabilities",
                 "MANIFEST_VERSION",
-                "compareDevVars"
+                "compareDevVars",
+                "BRAND_FILE",
+                "brandSchema",
+                "defineBrand",
+                "resolveBrand",
+                "BRAND_DEFAULTS"
             ]
         },
         "config": [
@@ -463,6 +468,13 @@ export const capabilities = {
                 "text": "Keep .dev.vars.example listing every variable .dev.vars has, with no values; check with npx workbench-config check.",
                 "enforced_by": "review",
                 "probe": "config.dev-vars-check"
+            },
+            {
+                "id": "config.one-brand-file",
+                "kind": "must",
+                "text": "Keep the app's name, logo, colours and fonts in brand.json at the repo root, read with defineBrand, so emails, PDFs and sign-in mails are branded from one file.",
+                "enforced_by": "types",
+                "probe": "config.brand-file"
             }
         ],
         "examples": [
@@ -495,6 +507,13 @@ export const capabilities = {
                 "expect": "pass",
                 "cost_hint_usd": 0
             },
+            {
+                "id": "config.brand-file",
+                "half": "runtime",
+                "expect": "pass",
+                "cost_hint_usd": 0,
+                "note": "The app's brand.json passes defineBrand and a bad one is refused with every bad field named"
+            },
             {
                 "id": "config.dev-vars-check",
                 "half": "runtime",
@@ -861,7 +880,7 @@ export const capabilities = {
                 "kind": "must",
                 "text": "Pass attachments as bytes (Uint8Array), and give an inline image a contentId that the HTML references as cid:.",
                 "enforced_by": "types",
-                "probe": "email.send.inline-image"
+                "probe": "email.send.inline-attachment"
             },
             {
                 "id": "email.allowed-sender",
@@ -882,7 +901,7 @@ export const capabilities = {
                 "kind": "must_not",
                 "text": "Expect a development key to mail anyone but Robert. The Gateway refuses other recipients before the budget.",
                 "enforced_by": "gateway",
-                "probe": "email.send.dev-recipient-refused"
+                "probe": "email.send.dev-key-recipient-refused"
             },
             {
                 "id": "email.transactional-only",
@@ -898,7 +917,7 @@ export const capabilities = {
                 "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' }] })",
-                "probe": "email.send.inline-image"
+                "probe": "email.send.inline-attachment"
             }
         ],
         "probes": [
@@ -906,12 +925,11 @@ export const capabilities = {
                 "id": "email.send.transactional",
                 "half": "runtime",
                 "expect": "pass",
-                "smoke": true,
                 "cost_hint_usd": 0.00035,
-                "note": "To Robert; check that it arrives"
+                "note": "To Robert; check that it arrives. Not in the daily smoke run, so it sends no daily mail"
             },
             {
-                "id": "email.send.inline-image",
+                "id": "email.send.inline-attachment",
                 "half": "runtime",
                 "expect": "pass",
                 "cost_hint_usd": 0.00035,
@@ -925,7 +943,7 @@ export const capabilities = {
                 "note": "The repeat answers replayed: true and no second mail arrives"
             },
             {
-                "id": "email.send.dev-recipient-refused",
+                "id": "email.send.dev-key-recipient-refused",
                 "half": "runtime",
                 "expect": "refused_as_expected",
                 "refusal": "recipient_not_allowed",
@@ -944,6 +962,13 @@ export const capabilities = {
                 "expect": "pass",
                 "cost_hint_usd": 0,
                 "note": "createMailer with transport capture and WORKBENCH_ENV=staging throws invalid_config"
+            },
+            {
+                "id": "email.send.new-sender",
+                "half": "runtime",
+                "expect": "pass",
+                "cost_hint_usd": 0.00035,
+                "note": "Runs after the Control drill's gw_sender_add step; skipped without it"
             }
         ]
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mccaskie-labs/workbench-config",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "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",