@segnavia/format 0.27.0 → 0.28.0

package/dist/motif.d.ts

@@ -13,12 +13,26 @@ export declare const BOOK_FURNITURE: readonly [{
   readonly value: "folio";
   readonly className: "segnavia-folio";
   readonly region: "foot";
+  readonly fields: readonly [];
 }, {
   readonly key: "segnavia:running-head";
   readonly path: "printedPage.runningHead";
   readonly value: "runningHead";
   readonly className: "segnavia-running-head";
   readonly region: "head";
+  readonly fields: readonly [];
+}, {
+  readonly key: "segnavia:mark";
+  readonly className: "segnavia-mark";
+  readonly region: "head";
+  readonly fields: readonly [{
+    readonly key: "name";
+    readonly required: true;
+  }, {
+    readonly key: "which";
+    readonly choices: readonly ["first", "last"];
+    readonly default: "first";
+  }];
 }];
 export type BookFurniture = (typeof BOOK_FURNITURE)[number];
 export declare const motifFieldAttribute: (key: string) => string;

package/dist/motif.js

@@ -9,19 +9,37 @@ const PRINTED_PAGE_TOTAL_PATH = `${PRINTED_PAGE_CONTEXT}.total`;
 const PRINTED_PAGE_FOLIO_PATH = `${PRINTED_PAGE_CONTEXT}.folio`;
 const PRINTED_PAGE_RUNNING_HEAD_PATH = `${PRINTED_PAGE_CONTEXT}.runningHead`;
 const LIBRARY_MOTIF_PREFIX = "segnavia:";
-const BOOK_FURNITURE = [{
-	key: "segnavia:folio",
-	path: PRINTED_PAGE_FOLIO_PATH,
-	value: "folio",
-	className: "segnavia-folio",
-	region: "foot"
-}, {
-	key: "segnavia:running-head",
-	path: PRINTED_PAGE_RUNNING_HEAD_PATH,
-	value: "runningHead",
-	className: "segnavia-running-head",
-	region: "head"
-}];
+const BOOK_FURNITURE = [
+	{
+		key: "segnavia:folio",
+		path: PRINTED_PAGE_FOLIO_PATH,
+		value: "folio",
+		className: "segnavia-folio",
+		region: "foot",
+		fields: []
+	},
+	{
+		key: "segnavia:running-head",
+		path: PRINTED_PAGE_RUNNING_HEAD_PATH,
+		value: "runningHead",
+		className: "segnavia-running-head",
+		region: "head",
+		fields: []
+	},
+	{
+		key: "segnavia:mark",
+		className: "segnavia-mark",
+		region: "head",
+		fields: [{
+			key: "name",
+			required: true
+		}, {
+			key: "which",
+			choices: ["first", "last"],
+			default: "first"
+		}]
+	}
+];
 const motifFieldAttribute = (key) => `${MOTIF_ATTRIBUTE}-${key}`;
 const uniqueChoices = (field, ctx) => {
 	if (field.choices && new Set(field.choices).size !== field.choices.length) ctx.addIssue({

package/dist/printed-pages.d.ts

@@ -99,6 +99,13 @@ export interface ResolvedParentPage {
   foot: string;
 }
 export declare function resolveParentPages(parents: ParentPage[]): ResolvedParentPage[];
+export declare function parentListIssues(parents: ParentPage[], options?: {
+  path?: (string | number)[];
+  known?: Iterable<string>;
+}): Array<{
+  path: (string | number)[];
+  message: string;
+}>;
 export declare function printedPagesIssues(value: PrintedPages): Array<{
   path: (string | number)[];
   message: string;

package/dist/printed-pages.js

@@ -1,5 +1,5 @@
-import { NumberSystem } from "./numbering.js";
 import { BOOK_FURNITURE } from "./motif.js";
+import { NumberSystem } from "./numbering.js";
 import { z } from "zod";
 //#region src/printed-pages.ts
 const PRINTED_PAGE_LIMIT = 500;
@@ -55,7 +55,7 @@ const BOOK_PARENT_NAMES = {
 	blank: "segnavia:blank"
 };
 function furniture(region) {
-	return BOOK_FURNITURE.filter((item) => item.region === region).map((item) => `<div class="${item.className}" data-motif="${item.key}"></div>`).join("");
+	return BOOK_FURNITURE.filter((item) => item.region === region).filter((item) => item.fields.every((field) => !("required" in field) || !field.required)).map((item) => `<div class="${item.className}" data-motif="${item.key}"></div>`).join("");
 }
 function bookParentPages(margin) {
 	const held = () => ({ ...margin });
@@ -110,56 +110,64 @@ function resolveParentPages(parents) {
 	};
 	return parents.map(resolve);
 }
-function printedPagesIssues(value) {
+function parentListIssues(parents, options = {}) {
 	const issues = [];
-	const parents = /* @__PURE__ */ new Map();
-	value.parents.forEach((parent, index) => {
-		if (parents.has(parent.name)) issues.push({
+	const root = options.path ?? ["parents"];
+	const listed = /* @__PURE__ */ new Map();
+	const known = /* @__PURE__ */ new Set([...options.known ?? []]);
+	parents.forEach((parent, index) => {
+		if (listed.has(parent.name)) issues.push({
 			path: [
-				"parents",
+				...root,
 				index,
 				"name"
 			],
 			message: `parent page "${parent.name}" is duplicated; give every parent page a unique name to clear this refusal`
 		});
-		parents.set(parent.name, parent);
+		listed.set(parent.name, parent);
+		known.add(parent.name);
 	});
-	for (const [role, name] of Object.entries(value.rules)) {
-		if (name === void 0) continue;
-		if (!parents.has(name)) issues.push({
-			path: ["rules", role],
-			message: `${role} names unknown parent page "${name}"; add that parent page or name an existing one to clear this refusal`
-		});
-	}
-	value.parents.forEach((parent, index) => {
-		if (parent.basedOn && !parents.has(parent.basedOn)) issues.push({
+	parents.forEach((parent, index) => {
+		if (parent.basedOn && !known.has(parent.basedOn)) issues.push({
 			path: [
-				"parents",
+				...root,
 				index,
 				"basedOn"
 			],
 			message: `parent page "${parent.name}" is based on unknown parent page "${parent.basedOn}"; add that parent page or remove basedOn to clear this refusal`
 		});
-		const path = [];
+		const chain = [];
 		let cursor = parent;
 		while (cursor) {
-			if (path.includes(cursor.name)) {
+			if (chain.includes(cursor.name)) {
 				issues.push({
 					path: [
-						"parents",
+						...root,
 						index,
 						"basedOn"
 					],
-					message: `parent page inheritance has a cycle ${[...path, cursor.name].join(" -> ")}; remove a basedOn link to clear this refusal`
+					message: `parent page inheritance has a cycle ${[...chain, cursor.name].join(" -> ")}; remove a basedOn link to clear this refusal`
 				});
 				break;
 			}
-			path.push(cursor.name);
-			cursor = cursor.basedOn ? parents.get(cursor.basedOn) : void 0;
+			chain.push(cursor.name);
+			cursor = cursor.basedOn ? listed.get(cursor.basedOn) : void 0;
 		}
 	});
 	return issues;
 }
+function printedPagesIssues(value) {
+	const issues = parentListIssues(value.parents);
+	const names = new Set(value.parents.map((parent) => parent.name));
+	for (const [role, name] of Object.entries(value.rules)) {
+		if (name === void 0) continue;
+		if (!names.has(name)) issues.push({
+			path: ["rules", role],
+			message: `${role} names unknown parent page "${name}"; add that parent page or name an existing one to clear this refusal`
+		});
+	}
+	return issues;
+}
 function pagePrintedPagesIssues(page) {
 	if (!page.printedPages) return [];
 	const issues = printedPagesIssues(page.printedPages).map((issue) => ({
@@ -185,4 +193,4 @@ function pagePrintedPagesIssues(page) {
 	return issues;
 }
 //#endregion
-export { BOOK_PARENT_NAMES, PRINTED_PAGE_LIMIT, PRINTED_PAGE_ROLES, ParentPage, ParentPageMargin, PrintedPageRules, PrintedPages, bookParentPages, pagePrintedPagesIssues, printedPagesIssues, resolveParentPages };
+export { BOOK_PARENT_NAMES, PRINTED_PAGE_LIMIT, PRINTED_PAGE_ROLES, ParentPage, ParentPageMargin, PrintedPageRules, PrintedPages, bookParentPages, pagePrintedPagesIssues, parentListIssues, printedPagesIssues, resolveParentPages };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@segnavia/format",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "type": "module",
   "license": "MIT",
   "repository": {