@getvitops/emdash 2.0.0-alpha.0 → 2.0.0-alpha.1

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @getvitops/emdash
 
+## 2.0.0-alpha.1
+
+### Minor Changes
+
+- 24c568b: Escape hatches on every block, a section theme, widget areas, a badges block, Tailwind scanning of package renderers, and a sturdier `vitops audit`.
+
+  **@getvitops/emdash**
+
+  - Every `vitops.*` block and `vitops_section` gains three fields: `anchor` (rendered as the `id`, so `#contact` works), `className` (`class_name` on the section type: block-type slugs are lowercase) and `style`. `style` takes CSS custom properties only (`--p-card: 2rem`); any other declaration, and any value containing `url(`, `@`, `{`, `}` or a backslash, is dropped. With the `tailwind` format a class typed in the CMS only works if the site already uses it. They are applied to the block's own outermost element (the grid `<ul>` for `vitops.cards`), never an extra wrapper, so a block's markup is the same whether or not an editor fills them in.
+  - `vitops_section` gains a `theme` select: a role, or `<role>:solid`, with readable text chosen by the generator's contrast rules. It overrides `tone`/`color`/`solid`, which stay for existing content. Other site roles still go through `tone`.
+  - New `vitops.badges` block (a row of `.badge` or `.tag` labels, each with an optional tone, icon and link) and `vitops.widgetArea` block, plus `<VitopsWidgetArea name level />` from `@getvitops/emdash/astro`. A widget area is content defined once under Widgets and shown wherever it is placed. An area cannot hold another area, and an area containing a `core:*` component widget is rendered by EmDash's own renderer.
+  - Existing sites: re-run the block-type seed only on a new database; on an existing one add the `theme`, `anchor`, `className` and `style` fields to the `vitops_section` block type in the admin.
+
+  **@getvitops/create**: the emdash template seeds `announcement` and `pre-footer` widget areas, renders them in `Layout.astro`, and documents when to use a Section, a block or a widget area. Sites scaffolded earlier add the two `<VitopsWidgetArea>` lines and the `widgetAreas` seed entries by hand.
+
+  **@getvitops/generator / astro / vite** (`tailwind` format only): the Astro integration now adds `@source` lines for `@getvitops/astro` and `@getvitops/emdash`, because Tailwind v4 does not scan `node_modules`; utilities used only by their renderers (`font-display`, `font-caption`, `font-footnote`) were never emitted and the page silently rendered at body size. New `sources` option on `generate()` and the Vite plugin. A site's `src/package-classes.txt` workaround can be deleted. css and bricks: no change.
+
+  **@getvitops/cli**: `vitops emdash check-prerender` now also warns when a page uses a type-role class (`font-display`, …) the built CSS has no rule for; `--strict` makes it fail. `vitops audit` checks for its optional packages and a Chromium binary before starting the preview server (so a failed run no longer leaves port 4398 busy), stops the server on Ctrl+C and termination, and takes its page list from the built sitemap, then the menus; the guessed defaults (`/privacy`, `/contact`, …) are used only when neither exists.
+
+  **@getvitops/utils**: the audit helpers behind the above (`preflight`, `fetchSitemapPaths`, `sitemapLocs`, `pathsFromSitemapLocs`).
+
+  **@getvitops/core** (all formats): new `.block-anchor` rule gives an anchored block `scroll-margin-top: var(--header-offset, 5rem)`; set `--header-offset` to a sticky header's height. New `widget-area.css` partial. No other consumer-facing change.
+
+  The other fixed-group packages: no consumer-facing change beyond the above.
+
+  **Also fixed in the emdash template** (`site.json`): it defined only the `display`, `heading` and `body` type roles while the blocks use `title`, `eyebrow`, `lead`, `caption` and `footnote`, so those rendered at body size with no rule behind them. The roles are added with the reference design system's specs. A site scaffolded earlier adds the same five entries under `designSystem.themes.default.typography.roles`; `vitops emdash check-prerender` now names any that are missing.
+
+### Patch Changes
+
+- Updated dependencies [24c568b]
+  - @getvitops/generator@8.3.0-alpha.1
+  - @getvitops/utils@8.3.0-alpha.1
+
 ## 2.0.0-alpha.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -7,6 +7,7 @@ type BlockKitFieldDef = Extract<NonNullable<PortableTextBlockConfig['fields']>[n
 type PortableTextBlockDef = Omit<PortableTextBlockConfig, 'fields'> & {
   fields?: BlockKitFieldDef[];
 };
+/** Every block gets the escape hatches last, so the editor reads content first. */
 export declare const BLOCKS: PortableTextBlockDef[];
 /** Which Vitops blocks a site's editor offers, and any it adds of its own. */
 interface BlockSelection {

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/blocks.ts","../src/design-system-route.ts","../src/blocks-doc.ts","../src/block-types.ts","../src/astro/blocks/tone.ts","../src/hosting.ts","../src/index.ts"],"mappings":";;;KAuBY,mBAAmB,QAC7B,YAAY;EAEV;;KAWQ,uBAAuB,KAAK;EACtC,SAAS;;qBAmDE,QAAQ;;UA62BJ;;EAEf;;EAEA;;;;;;;EAOA,QAAQ;;;;;;;;wBASM,aAAa,YAAW,iBAAsB;UCn6B7C;;;;;;;;EAQf;;EAEA;;;;;;;wBC9Bc,gBAAgB,kBAAiB;;qBCZpC;;qBAqCA,oBAAoB;;;;;;wBAejB,oBAAoB;;wBCzBpB,UAAU;UAcT;;EAEf;;EAEA;;;;;;;;wBASc,YAAY,gBAAgB,kBAAkB;KC7ClD;UAIK;;EAEf,SAAS;EACT;;IAEE;;IAEA;;IAEA;;;;;;;IAOA;;EAEF;;IAEE;;IAEA;;IAEA;;IAEA;;;UAIa;EACf,QAAQ;EACR,SAAS;;EAET;;EAEA;;wBAoBoB,cAAc,UAAS,uBAA4B,QAAQ;iBCzBhE;;;;;;;;;;;EAWf;;EAEA;;;;;;;;;EASA,qBAAqB;;;;;;EAMrB,SAAS;;;;;;;EAOT;;;;;;wBAOc,aAAa,UAAS,sBAA2B;;wBAmBjD,aAAa,UAAS,uCAAwB,gCAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/blocks.ts","../src/design-system-route.ts","../src/blocks-doc.ts","../src/block-types.ts","../src/astro/blocks/tone.ts","../src/hosting.ts","../src/index.ts"],"mappings":";;;KAuBY,mBAAmB,QAC7B,YAAY;EAEV;;KAWQ,uBAAuB,KAAK;EACtC,SAAS;;;qBA8/BE,QAAQ;;UAMJ;;EAEf;;EAEA;;;;;;;EAOA,QAAQ;;;;;;;;wBASM,aAAa,YAAW,iBAAsB;UCvgC7C;;;;;;;;EAQf;;EAEA;;;;;;;wBC9Bc,gBAAgB,kBAAiB;;qBCZpC;;qBA+DA,oBAAoB;;;;;;wBAejB,oBAAoB;;wBCnDpB,UAAU;UAcT;;EAEf;;EAEA;;;;;;;;wBASc,YAAY,gBAAgB,kBAAkB;KC7ClD;UAIK;;EAEf,SAAS;EACT;;IAEE;;IAEA;;IAEA;;;;;;;IAOA;;EAEF;;IAEE;;IAEA;;IAEA;;IAEA;;;UAIa;EACf,QAAQ;EACR,SAAS;;EAET;;EAEA;;wBAoBoB,cAAc,UAAS,uBAA4B,QAAQ;iBClBhE;;;;;;;;;;;EAWf;;EAEA;;;;;;;;;EASA,qBAAqB;;;;;;EAMrB,SAAS;;;;;;;EAOT;;;;;;wBAOc,aAAa,UAAS,sBAA2B;;wBAmBjD,aAAa,UAAS,uCAAwB,gCAAA"}

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { definePlugin, getMenus, pluginResponse } from "emdash";
+import { definePlugin, getMenus, getWidgetAreas, pluginResponse } from "emdash";
 import { iconMap } from "@getvitops/utils";
 import { designSystemPath, formatConfig, getAt, isConfig, mergePatch, resolveInput, setAt } from "@getvitops/generator/config";
 import { buildReverseIndex, patchToOverrideCss, validateColorContract } from "@getvitops/generator/tokens";
@@ -167,6 +167,31 @@ function toneFields() {
 		label: "Palette colour instead of a tone (e.g. amber or amber-300)"
 	}];
 }
+/** Route that lists the site's widget areas for `vitops.widgetArea`'s `area` select. */
+const WIDGET_AREAS_ROUTE = "widget-areas/list";
+/**
+* The escape hatches every block carries, appended last by `BLOCKS` (see `astro/blocks/attrs.ts`
+* for how each is validated and why `style` takes custom properties only).
+*/
+function commonFields() {
+	return [
+		{
+			type: "text_input",
+			action_id: "anchor",
+			label: "Anchor id (so a link can point here with #id)"
+		},
+		{
+			type: "text_input",
+			action_id: "className",
+			label: "Extra CSS classes (with the tailwind format, only classes the site already uses)"
+		},
+		{
+			type: "text_input",
+			action_id: "style",
+			label: "CSS custom properties, e.g. --p-card: 2rem; --tone-bg: #fee"
+		}
+	];
+}
 /** Heading level for a block's own heading; `h1` is reserved for the page title. */
 const levelField = (initial) => ({
 	type: "select",
@@ -184,7 +209,7 @@ const levelField = (initial) => ({
 		value: n
 	}))
 });
-const BLOCKS = [
+const BASE_BLOCKS = [
 	{
 		/**
 		* A link or button, optionally with an icon at either end.
@@ -1530,8 +1555,95 @@ const BLOCKS = [
 			},
 			...toneFields()
 		]
+	},
+	{
+		/** A row of static labels (`badge`) or editable/dismissable ones (`tag`). */
+		type: "vitops.badges",
+		label: "Badges",
+		icon: "tag",
+		placeholder: "A row of short labels",
+		fields: [
+			{
+				type: "repeater",
+				action_id: "items",
+				label: "Labels",
+				fields: [
+					{
+						type: "text_input",
+						action_id: "label",
+						label: "Label"
+					},
+					{
+						type: "select",
+						action_id: "tone",
+						label: "Tone (blank uses the block tone)",
+						initial_value: "",
+						options: STATIC_TONE_OPTIONS,
+						optionsRoute: TONES_ROUTE
+					},
+					{
+						type: "text_input",
+						action_id: "color",
+						label: "Palette colour instead (e.g. amber)"
+					},
+					{
+						type: "combobox",
+						action_id: "icon",
+						label: "Icon before the label",
+						placeholder: "None",
+						options: SEMANTIC_ICON_OPTIONS
+					},
+					{
+						type: "text_input",
+						action_id: "href",
+						label: "Link URL (optional)"
+					}
+				]
+			},
+			{
+				type: "select",
+				action_id: "variant",
+				label: "Style",
+				initial_value: "badge",
+				options: [{
+					label: "Badge (static label)",
+					value: "badge"
+				}, {
+					label: "Tag",
+					value: "tag"
+				}]
+			},
+			...toneFields()
+		]
+	},
+	{
+		/**
+		* A widget area: content defined once under Widgets in the admin and shown wherever this
+		* block is placed. Edits reach every page it sits on (after the next build, on a
+		* prerendered site) — unlike a Section, which is copied.
+		*/
+		type: "vitops.widgetArea",
+		label: "Widget area",
+		icon: "layout",
+		placeholder: "Shared content managed under Widgets",
+		fields: [{
+			type: "select",
+			action_id: "area",
+			label: "Widget area",
+			initial_value: "",
+			options: [{
+				label: "Choose…",
+				value: ""
+			}],
+			optionsRoute: WIDGET_AREAS_ROUTE
+		}, levelField("3")]
 	}
 ];
+/** Every block gets the escape hatches last, so the editor reads content first. */
+const BLOCKS = BASE_BLOCKS.map((b) => ({
+	...b,
+	fields: [...b.fields ?? [], ...commonFields()]
+}));
 /**
 * Resolve {@link BlockSelection} against {@link BLOCKS}.
 *
@@ -1778,6 +1890,26 @@ const select = (slug, label, options, defaultValue) => ({
 	defaultValue,
 	validation: { options }
 });
+/**
+* The `theme` select's values: `none`, a role, or `<role>:solid`. Block-type selects are
+* static, so this lists the roles every site defines; any other site role still works through
+* the `tone` field. `<role>:solid` is the filled backdrop with the contrast-computed text.
+*/
+const THEME_ROLES = [
+	"neutral",
+	"surface",
+	"brand-primary",
+	"brand-secondary",
+	"info",
+	"success",
+	"warning",
+	"danger"
+];
+const THEMES = [
+	"none",
+	...THEME_ROLES,
+	...THEME_ROLES.map((r) => `${r}:solid`)
+];
 const SECTION_FIELDS = [
 	{
 		slug: "kicker",
@@ -1832,6 +1964,22 @@ const SECTION_FIELDS = [
 		label: "Fill with the solid colour",
 		type: "boolean",
 		defaultValue: false
+	},
+	select("theme", "Theme (backdrop and readable text in one pick; overrides the tone fields)", THEMES, "none"),
+	{
+		slug: "anchor",
+		label: "Anchor id (so a link can point here with #id)",
+		type: "string"
+	},
+	{
+		slug: "class_name",
+		label: "Extra CSS classes",
+		type: "string"
+	},
+	{
+		slug: "style",
+		label: "CSS custom properties, e.g. --p-card: 2rem",
+		type: "string"
 	}
 ];
 /** `vitops.section`: kicker, heading, lead-in, tone/backdrop, optional heading-left layout, and a body of blocks. */
@@ -1986,7 +2134,7 @@ async function vitopsHosting(options = {}) {
 }
 
 // package.json
-var version = "2.0.0-alpha.0";
+var version = "2.0.0-alpha.1";
 
 // src/index.ts
 /**
@@ -2089,6 +2237,7 @@ function createPlugin(options = {}) {
 		routes: {
 			[TONES_ROUTE]: createTonesRoute(() => roles),
 			[MENUS_ROUTE]: createMenusRoute(() => getMenus()),
+			[WIDGET_AREAS_ROUTE]: createMenusRoute(() => getWidgetAreas()),
 			...editor ? { "design-system": createDesignSystemRoute(editor) } : {}
 		}
 	});