@getvitops/emdash 1.0.0-alpha.0 → 1.0.0

package/dist/index.mjs

@@ -4,7 +4,7 @@ import { designSystemPath, formatConfig, getAt, isConfig, mergePatch, resolveInp
 import { buildReverseIndex, patchToOverrideCss, validateColorContract } from "@getvitops/generator/tokens";
 import { commitFile } from "@getvitops/utils/git";
 
-//#region src/icon-options.ts
+// src/icon-options.ts
 /**
 * Semantic icon names, as Block Kit combobox options.
 *
@@ -25,8 +25,7 @@ const SEMANTIC_ICON_OPTIONS = Object.keys(iconMap.fa7).sort().map((name) => ({
 	value: name
 }));
 
-//#endregion
-//#region src/blocks.ts
+// src/blocks.ts
 const BLOCKS = [
 	{
 		/**
@@ -270,17 +269,34 @@ const BLOCKS = [
 		type: "vitops.carousel",
 		label: "Carousel",
 		placeholder: "Image carousel",
+		category: "Media",
 		fields: [
+			{
+				type: "repeater",
+				action_id: "slides",
+				label: "Slides",
+				item_label: "slide",
+				min_items: 1,
+				fields: [{
+					type: "text_input",
+					action_id: "src",
+					label: "Image URL"
+				}, {
+					type: "text_input",
+					action_id: "alt",
+					label: "Alt text"
+				}]
+			},
 			{
 				type: "text_input",
 				action_id: "images",
-				label: "Image URLs (one per line)",
+				label: "Image URLs, one per line (legacy — use Slides)",
 				multiline: true
 			},
 			{
 				type: "text_input",
 				action_id: "alts",
-				label: "Alt texts (one per line, same order)",
+				label: "Alt texts, one per line (legacy — use Slides)",
 				multiline: true
 			},
 			{
@@ -308,11 +324,302 @@ const BLOCKS = [
 				initial_value: "16 / 9"
 			}
 		]
+	},
+	{
+		type: "vitops.gallery",
+		label: "Gallery",
+		placeholder: "Thumbnail grid that opens a lightbox carousel",
+		category: "Media",
+		fields: [
+			{
+				type: "text_input",
+				action_id: "label",
+				label: "Accessible name",
+				initial_value: "Gallery"
+			},
+			{
+				type: "repeater",
+				action_id: "images",
+				label: "Images",
+				item_label: "image",
+				min_items: 1,
+				fields: [
+					{
+						type: "text_input",
+						action_id: "src",
+						label: "Image URL"
+					},
+					{
+						type: "text_input",
+						action_id: "alt",
+						label: "Alt text"
+					},
+					{
+						type: "text_input",
+						action_id: "caption",
+						label: "Caption"
+					}
+				]
+			},
+			{
+				type: "text_input",
+				action_id: "aspect",
+				label: "Thumbnail aspect ratio",
+				initial_value: "1"
+			},
+			{
+				type: "toggle",
+				action_id: "loop",
+				label: "Wrap around at the ends",
+				initial_value: false
+			}
+		]
+	},
+	{
+		type: "vitops.cards",
+		label: "Cards",
+		placeholder: "A grid of cards",
+		category: "Sections",
+		fields: [{
+			type: "repeater",
+			action_id: "cards",
+			label: "Cards",
+			item_label: "card",
+			min_items: 1,
+			fields: [
+				{
+					type: "text_input",
+					action_id: "title",
+					label: "Title"
+				},
+				{
+					type: "text_input",
+					action_id: "body",
+					label: "Text",
+					multiline: true
+				},
+				{
+					type: "text_input",
+					action_id: "image",
+					label: "Image URL"
+				},
+				{
+					type: "text_input",
+					action_id: "imageAlt",
+					label: "Image alt text"
+				},
+				{
+					type: "text_input",
+					action_id: "href",
+					label: "Link URL (makes the whole card clickable)"
+				},
+				{
+					type: "text_input",
+					action_id: "linkLabel",
+					label: "Link text",
+					initial_value: "Read more"
+				}
+			]
+		}, {
+			type: "select",
+			action_id: "columns",
+			label: "Columns",
+			initial_value: "3",
+			options: [
+				{
+					label: "1",
+					value: "1"
+				},
+				{
+					label: "2",
+					value: "2"
+				},
+				{
+					label: "3",
+					value: "3"
+				},
+				{
+					label: "4",
+					value: "4"
+				}
+			]
+		}]
+	},
+	{
+		type: "vitops.accordion",
+		label: "Accordion",
+		placeholder: "A group of collapsible sections",
+		category: "Sections",
+		fields: [{
+			type: "repeater",
+			action_id: "items",
+			label: "Items",
+			item_label: "item",
+			min_items: 1,
+			fields: [
+				{
+					type: "text_input",
+					action_id: "summary",
+					label: "Summary (always visible)"
+				},
+				{
+					type: "text_input",
+					action_id: "body",
+					label: "Body (revealed)",
+					multiline: true
+				},
+				{
+					type: "toggle",
+					action_id: "open",
+					label: "Open by default",
+					initial_value: false
+				}
+			]
+		}, {
+			type: "toggle",
+			action_id: "exclusive",
+			label: "Only one open at a time",
+			initial_value: false
+		}]
+	},
+	{
+		type: "vitops.hero",
+		label: "Hero",
+		placeholder: "Page opener: heading, text, buttons and an optional image",
+		category: "Sections",
+		fields: [
+			{
+				type: "text_input",
+				action_id: "eyebrow",
+				label: "Eyebrow (small line above)"
+			},
+			{
+				type: "text_input",
+				action_id: "heading",
+				label: "Heading"
+			},
+			{
+				type: "text_input",
+				action_id: "body",
+				label: "Text",
+				multiline: true
+			},
+			{
+				type: "text_input",
+				action_id: "primaryLabel",
+				label: "Main button text"
+			},
+			{
+				type: "text_input",
+				action_id: "primaryHref",
+				label: "Main button URL"
+			},
+			{
+				type: "text_input",
+				action_id: "secondaryLabel",
+				label: "Second link text"
+			},
+			{
+				type: "text_input",
+				action_id: "secondaryHref",
+				label: "Second link URL"
+			},
+			{
+				type: "text_input",
+				action_id: "image",
+				label: "Image URL (split layout)"
+			},
+			{
+				type: "text_input",
+				action_id: "imageAlt",
+				label: "Image alt text"
+			},
+			{
+				type: "select",
+				action_id: "layout",
+				label: "Layout",
+				initial_value: "centered",
+				options: [{
+					label: "Centered",
+					value: "centered"
+				}, {
+					label: "Text and image side by side",
+					value: "split"
+				}]
+			}
+		]
+	},
+	{
+		type: "vitops.marquee",
+		label: "Marquee",
+		placeholder: "A continuously scrolling row (logos, quotes, badges)",
+		category: "Media",
+		fields: [
+			{
+				type: "repeater",
+				action_id: "items",
+				label: "Items",
+				item_label: "item",
+				min_items: 1,
+				fields: [
+					{
+						type: "text_input",
+						action_id: "text",
+						label: "Text"
+					},
+					{
+						type: "text_input",
+						action_id: "image",
+						label: "Image URL (shown instead of text)"
+					},
+					{
+						type: "text_input",
+						action_id: "alt",
+						label: "Image alt text"
+					}
+				]
+			},
+			{
+				type: "toggle",
+				action_id: "pauseOnHover",
+				label: "Pause on hover",
+				initial_value: true
+			},
+			{
+				type: "toggle",
+				action_id: "reverse",
+				label: "Scroll the other way",
+				initial_value: false
+			}
+		]
 	}
 ];
+/**
+* Resolve {@link BlockSelection} against {@link BLOCKS}.
+*
+* Pure so a misconfiguration fails at plugin construction, with the offending name in the
+* message, rather than as an editor menu that is quietly missing something.
+*/
+function selectBlocks(selection = {}) {
+	const known = new Set(BLOCKS.map((b) => b.type));
+	const check = (names, option) => {
+		for (const name of names ?? []) if (!known.has(name)) throw new Error(`[vitops] blocks.${option}: unknown block '${name}'. Known: ${[...known].join(", ")}.`);
+	};
+	check(selection.include, "include");
+	check(selection.exclude, "exclude");
+	const include = selection.include ? new Set(selection.include) : null;
+	const exclude = new Set(selection.exclude);
+	const base = BLOCKS.filter((b) => (!include || include.has(b.type)) && !exclude.has(b.type));
+	const extra = selection.extra ?? [];
+	const taken = new Set(BLOCKS.map((b) => b.type));
+	for (const block of extra) {
+		if (taken.has(block.type)) throw new Error(`[vitops] blocks.extra: type '${block.type}' is already defined.`);
+		taken.add(block.type);
+	}
+	return [...base, ...extra];
+}
 
-//#endregion
-//#region src/design-system-route.ts
+// src/design-system-route.ts
 /**
 * The `vitops.design-system` plugin route — what `<wc-theme-editor>` probes
 * and POSTs its patch to when mounted inside the EmDash admin (see this
@@ -453,8 +760,53 @@ async function designSystemOverrideFragment(ctx, opts) {
 	};
 }
 
-//#endregion
-//#region src/hosting.ts
+// src/blocks-doc.ts
+const cell = (s) => (s ?? "").replace(/\|/g, "\\|").replace(/\n/g, " ");
+function describe(f) {
+	const bits = [];
+	if ("options" in f && Array.isArray(f.options) && f.options.length) {
+		const values = f.options.map((o) => String(o.value));
+		bits.push(values.length > 8 ? `one of ${values.length} values (e.g. ${values.slice(0, 4).join(", ")})` : `one of ${values.join(", ")}`);
+	}
+	if ("initial_value" in f && f.initial_value !== void 0) bits.push(`default \`${String(f.initial_value)}\``);
+	if (f.type === "repeater" && "min_items" in f && f.min_items) bits.push(`min ${f.min_items} rows`);
+	return bits.join("; ");
+}
+function fieldRows(fields, prefix = "") {
+	return fields.flatMap((f) => {
+		const own = `| \`${prefix}${f.action_id}\` | ${f.type} | ${cell(f.label)} | ${cell(describe(f))} |`;
+		return f.type === "repeater" ? [own, ...fieldRows(f.fields, `${f.action_id}[].`)] : [own];
+	});
+}
+/**
+* The block reference an agent reads via `vitops docs blocks`: every Portable Text `_type`,
+* its fields and what each saves. Rendered from the same `BLOCKS` the editor menu uses, so
+* it cannot describe a field the editor doesn't offer.
+*/
+function renderBlocksDoc(blocks = BLOCKS) {
+	const out = [
+		"---",
+		"type: concept",
+		"title: EmDash blocks",
+		"description: Portable Text block types from @getvitops/emdash, with every field",
+		"---",
+		"",
+		"# EmDash blocks",
+		"",
+		"Each block is a Portable Text object: `{ \"_type\": \"vitops.cards\", \"_key\": \"<unique>\", ...fields }`.",
+		"Blocks are flat — a block cannot contain other blocks, and a repeater row holds scalar fields only.",
+		"Give every block a unique `_key`; gallery and carousel derive their element id from it.",
+		""
+	];
+	for (const b of blocks) {
+		out.push(`## \`${b.type}\` — ${b.label}`, "");
+		if (b.placeholder) out.push(`${b.placeholder}.`, "");
+		if (b.fields?.length) out.push("| Field | Type | Label | Notes |", "| --- | --- | --- | --- |", ...fieldRows(b.fields), "");
+	}
+	return out.join("\n");
+}
+
+// src/hosting.ts
 const TARGETS = ["cloudflare", "node"];
 /**
 * Import an optional hosting dependency. The specifier is passed as a
@@ -483,7 +835,8 @@ async function vitopsHosting(options = {}) {
 			adapter: cloudflare(),
 			database: d1({
 				binding: cf.dbBinding ?? "DB",
-				session: cf.session ?? "auto"
+				session: cf.session ?? "auto",
+				coalesce: cf.coalesce ?? true
 			}),
 			storage: r2({ binding: cf.mediaBinding ?? "MEDIA" })
 		};
@@ -513,12 +866,10 @@ async function vitopsHosting(options = {}) {
 	throw new Error(`[vitops] unknown hosting target '${target}' (from ${process.env.HOSTING ? "HOSTING env var" : "options.target"}). Valid targets: ${TARGETS.join(", ")}.`);
 }
 
-//#endregion
-//#region package.json
-var version = "1.0.0-alpha.0";
+// package.json
+var version = "1.0.0";
 
-//#endregion
-//#region src/index.ts
+// src/index.ts
 /**
 * @getvitops/emdash — EmDash CMS native plugin for the Vitops design system.
 *
@@ -605,7 +956,7 @@ function createPlugin(options = {}) {
 		...editor ? { allowedHosts: ["api.github.com"] } : {},
 		...fragmentsEnabled ? { hooks: { "page:fragments": pageFragments } } : {},
 		admin: {
-			portableTextBlocks: BLOCKS,
+			portableTextBlocks: selectBlocks(options.blocks),
 			...editor ? {
 				entry: "@getvitops/emdash/admin",
 				pages: [{
@@ -619,6 +970,5 @@ function createPlugin(options = {}) {
 	});
 }
 
-//#endregion
-export { BLOCKS, createPlugin, createPlugin as default, vitopsEmdash, vitopsHosting };
+export { BLOCKS, createPlugin, createPlugin as default, renderBlocksDoc, selectBlocks, vitopsEmdash, vitopsHosting };
 //# sourceMappingURL=index.mjs.map