@mccaskie-labs/workbench-config 0.1.35 → 0.1.36

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mccaskie-labs/workbench-config
 
+## 0.1.36
+
+### Patch Changes
+
+- A manifest may say `styles: { prefix }` for a component that draws on a project's pages. Its generated skill then has a "Restyling" section: every class and variable is listed in `public/styles/workbench.css`, and the project restyles them in `public/styles/project.css`. The forms manifest has `styles: { prefix: "wb-form-" }`.
+
 ## 0.1.35
 
 ### Patch Changes

package/capabilities/forms.json

@@ -327,5 +327,8 @@
         "why": "The client's own words for an answered limit, otherwise \"Workbench default, not yet confirmed\"."
       }
     ]
+  },
+  "styles": {
+    "prefix": "wb-form-"
   }
 }

package/capabilities/schema.json

@@ -685,6 +685,19 @@
     "no_offer": {
       "type": "string",
       "minLength": 1
+    },
+    "styles": {
+      "type": "object",
+      "properties": {
+        "prefix": {
+          "type": "string",
+          "pattern": "^wb-[a-z]+-$"
+        }
+      },
+      "required": [
+        "prefix"
+      ],
+      "additionalProperties": false
     }
   },
   "required": [

package/dist/capabilities.gen.d.ts

@@ -1,4 +1,4 @@
-export declare const MANIFEST_VERSION: "d5366f2127fb";
+export declare const MANIFEST_VERSION: "399d06007bb4";
 export declare const capabilities: {
     readonly ai: {
         readonly $schema: "./schema.json";
@@ -1316,6 +1316,9 @@ export declare const capabilities: {
                 readonly why: "The client's own words for an answered limit, otherwise \"Workbench default, not yet confirmed\".";
             }];
         };
+        readonly styles: {
+            readonly prefix: "wb-form-";
+        };
     };
     readonly gateway: {
         readonly $schema: "./schema.json";

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 = "d5366f2127fb";
+export const MANIFEST_VERSION = "399d06007bb4";
 export const capabilities = {
     "ai": {
         "$schema": "./schema.json",
@@ -1806,6 +1806,9 @@ export const capabilities = {
                     "why": "The client's own words for an answered limit, otherwise \"Workbench default, not yet confirmed\"."
                 }
             ]
+        },
+        "styles": {
+            "prefix": "wb-form-"
         }
     },
     "gateway": {

package/dist/capability-schema.d.ts

@@ -356,6 +356,9 @@ export declare const capabilitySchema: z.ZodObject<{
         needs: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strict>>;
     no_offer: z.ZodOptional<z.ZodString>;
+    styles: z.ZodOptional<z.ZodObject<{
+        prefix: z.ZodString;
+    }, z.core.$strict>>;
 }, z.core.$strict>;
 export type Capability = z.infer<typeof capabilitySchema>;
 export type Offer = z.infer<typeof offer>;

package/dist/capability-schema.js

@@ -217,6 +217,12 @@ const baseShape = {
     offer: offer.optional(),
     /** Why a client has nothing to answer for this component (plumbing). A manifest has `offer` or `no_offer`. */
     no_offer: z.string().min(1).optional(),
+    /**
+     * For a component that draws on a project's pages: the prefix of its classes
+     * and variables (docs/capabilities-manifest.md §10). Its skill then says how to
+     * restyle them through public/styles/project.css.
+     */
+    styles: z.strictObject({ prefix: z.string().regex(/^wb-[a-z]+-$/) }).optional(),
 };
 /** One file in `capabilities/`. Parsing checks shape only; cross-references are checked by `checkManifests`. */
 export const capabilitySchema = z.strictObject(baseShape).superRefine((m, ctx) => {

package/dist/skills.js

@@ -117,8 +117,14 @@ export function renderSkill(m) {
     if (o.not_asked?.length) {
         out.push("", "## Not asked", "", ...o.not_asked.map((n) => `- \`${n.sets}\`: ${n.why}`));
     }
+    if (m.styles)
+        out.push("", "## Restyling", "", restyleLine(m.styles.prefix));
     return `${out.join("\n")}\n`;
 }
+/** How a project restyles what a component draws (docs/capabilities-manifest.md §10). */
+function restyleLine(prefix) {
+    return `Everything this tool draws on a page has a \`${prefix}\` class with a default Workbench style, and its colours and sizes are \`--${prefix}*\` variables. All of them are listed, each with what it is, in \`public/styles/workbench.css\`, which \`npx workbench-ui styles\` generates: never edit it. To match the project's own look, write rules for those classes, or set the variables to the project's own colours, in \`public/styles/project.css\`. It loads after workbench.css and always wins. When the client asks for a different look, change project.css, never the tool's markup.`;
+}
 /** Every skill the manifests produce, keyed by its path in a project. */
 export function renderSkills(manifests) {
     const files = {};

package/package.json

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