@segnavia/format 0.27.0 → 0.28.0

package/dist/book-section.d.ts

@@ -0,0 +1,274 @@
+import "./printed-pages.js";
+import { z } from "zod";
+//#region src/book-section.d.ts
+export declare const BookOpens: z.ZodEnum<{
+  any: "any";
+  recto: "recto";
+  verso: "verso";
+}>;
+export type BookOpens = z.infer<typeof BookOpens>;
+export declare const BookSectionParents: z.ZodObject<{
+  opener: z.ZodOptional<z.ZodString>;
+  recto: z.ZodOptional<z.ZodString>;
+  verso: z.ZodOptional<z.ZodString>;
+  blank: z.ZodOptional<z.ZodString>;
+  fixed: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type BookSectionParents = z.infer<typeof BookSectionParents>;
+export declare const DesignedPage: z.ZodObject<{
+  html: z.ZodString;
+}, z.core.$strip>;
+export type DesignedPage = z.infer<typeof DesignedPage>;
+export declare const REGION_NAME: RegExp;
+export declare const TemplatedPage: z.ZodObject<{
+  template: z.ZodOptional<z.ZodString>;
+  regions: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
+export type TemplatedPage = z.infer<typeof TemplatedPage>;
+export declare const BookTemplate: z.ZodObject<{
+  name: z.ZodString;
+  html: z.ZodString;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+export type BookTemplate = z.infer<typeof BookTemplate>;
+export declare const DesignedSection: z.ZodObject<{
+  pages: z.ZodArray<z.ZodObject<{
+    html: z.ZodString;
+  }, z.core.$strip>>;
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodLiteral<"designed">;
+}, z.core.$strip>;
+export type DesignedSection = z.infer<typeof DesignedSection>;
+export declare const TemplatedSection: z.ZodObject<{
+  template: z.ZodString;
+  pages: z.ZodArray<z.ZodObject<{
+    template: z.ZodOptional<z.ZodString>;
+    regions: z.ZodRecord<z.ZodString, z.ZodString>;
+  }, z.core.$strip>>;
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodLiteral<"templated">;
+}, z.core.$strip>;
+export type TemplatedSection = z.infer<typeof TemplatedSection>;
+export declare const BookSection: z.ZodObject<{
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  html: z.ZodString;
+}, z.core.$strip>;
+export type BookSection = z.infer<typeof BookSection>;
+export declare const BookContents: z.ZodObject<{
+  kind: z.ZodLiteral<"contents">;
+  title: z.ZodOptional<z.ZodString>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+export type BookContents = z.infer<typeof BookContents>;
+export declare const BookFrontMatterEntry: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  pages: z.ZodArray<z.ZodObject<{
+    html: z.ZodString;
+  }, z.core.$strip>>;
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodLiteral<"designed">;
+}, z.core.$strip>, z.ZodObject<{
+  template: z.ZodString;
+  pages: z.ZodArray<z.ZodObject<{
+    template: z.ZodOptional<z.ZodString>;
+    regions: z.ZodRecord<z.ZodString, z.ZodString>;
+  }, z.core.$strip>>;
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodLiteral<"templated">;
+}, z.core.$strip>, z.ZodObject<{
+  kind: z.ZodLiteral<"contents">;
+  title: z.ZodOptional<z.ZodString>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  html: z.ZodString;
+  kind: z.ZodOptional<z.ZodLiteral<"front">>;
+}, z.core.$strip>], "kind">;
+export type BookFrontMatterEntry = z.infer<typeof BookFrontMatterEntry>;
+export declare const Chapter: z.ZodObject<{
+  title: z.ZodString;
+  html: z.ZodString;
+  runningHead: z.ZodOptional<z.ZodString>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Chapter = z.infer<typeof Chapter>;
+export declare const BookChapterEntry: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  pages: z.ZodArray<z.ZodObject<{
+    html: z.ZodString;
+  }, z.core.$strip>>;
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodLiteral<"designed">;
+}, z.core.$strip>, z.ZodObject<{
+  template: z.ZodString;
+  pages: z.ZodArray<z.ZodObject<{
+    template: z.ZodOptional<z.ZodString>;
+    regions: z.ZodRecord<z.ZodString, z.ZodString>;
+  }, z.core.$strip>>;
+  title: z.ZodOptional<z.ZodString>;
+  contents: z.ZodDefault<z.ZodBoolean>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodLiteral<"templated">;
+}, z.core.$strip>, z.ZodObject<{
+  title: z.ZodString;
+  html: z.ZodString;
+  runningHead: z.ZodOptional<z.ZodString>;
+  opens: z.ZodOptional<z.ZodEnum<{
+    any: "any";
+    recto: "recto";
+    verso: "verso";
+  }>>;
+  parents: z.ZodOptional<z.ZodObject<{
+    opener: z.ZodOptional<z.ZodString>;
+    recto: z.ZodOptional<z.ZodString>;
+    verso: z.ZodOptional<z.ZodString>;
+    blank: z.ZodOptional<z.ZodString>;
+    fixed: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  kind: z.ZodOptional<z.ZodLiteral<"chapter">>;
+}, z.core.$strip>], "kind">;
+export type BookChapterEntry = z.infer<typeof BookChapterEntry>;
+export declare function isBookContents(entry: BookFrontMatterEntry): entry is BookContents;
+export declare function isDesignedSection(entry: BookFrontMatterEntry | BookChapterEntry): entry is DesignedSection;
+export declare function isTemplatedSection(entry: BookFrontMatterEntry | BookChapterEntry): entry is TemplatedSection;
+export declare function isChapter(entry: BookChapterEntry): entry is Chapter;
+//#endregion

package/dist/book-section.js

@@ -0,0 +1,208 @@
+import { BOOK_PARENT_NAMES, parentListIssues } from "./printed-pages.js";
+import { z } from "zod";
+//#region src/book-section.ts
+const BookOpens = z.enum([
+	"recto",
+	"verso",
+	"any"
+]);
+const BookSectionParents = z.object({
+	opener: z.string().min(1).optional(),
+	recto: z.string().min(1).optional(),
+	verso: z.string().min(1).optional(),
+	blank: z.string().min(1).optional(),
+	fixed: z.string().min(1).optional()
+});
+const DesignedPage = z.object({ html: z.string() });
+const REGION_NAME = /^[A-Za-z][\w-]*$/;
+const TemplatedPage = z.object({
+	template: z.string().min(1).optional(),
+	regions: z.record(z.string(), z.string())
+});
+const BookTemplate = z.object({
+	name: z.string().min(1),
+	html: z.string(),
+	parents: BookSectionParents.optional()
+});
+const designedPagesRefusal = "a designed section needs at least one page; add a page or remove the section to clear this refusal";
+const templatedPagesRefusal = "a templated section needs at least one page; add a page or remove the section to clear this refusal";
+const regionNameClear = "use a letter followed by letters, digits, hyphens or underscores to clear this refusal";
+const sectionFields = {
+	title: z.string().optional(),
+	contents: z.boolean().default(true),
+	opens: BookOpens.optional(),
+	parents: BookSectionParents.optional()
+};
+const DesignedSection = z.object({
+	kind: z.literal("designed"),
+	...sectionFields,
+	pages: z.array(DesignedPage, { error: designedPagesRefusal }).min(1, designedPagesRefusal)
+});
+const TemplatedSection = z.object({
+	kind: z.literal("templated"),
+	...sectionFields,
+	template: z.string().min(1),
+	pages: z.array(TemplatedPage, { error: templatedPagesRefusal }).min(1, templatedPagesRefusal)
+});
+const BookSection = z.object({
+	html: z.string(),
+	...sectionFields
+});
+const BookContents = z.object({
+	kind: z.literal("contents"),
+	title: z.string().optional(),
+	opens: BookOpens.optional(),
+	parents: BookSectionParents.optional()
+});
+const flowingFront = BookSection.extend({ kind: z.literal("front").optional() });
+const BookFrontMatterEntry = z.discriminatedUnion("kind", [
+	DesignedSection,
+	TemplatedSection,
+	BookContents,
+	flowingFront
+]);
+const Chapter = z.object({
+	title: z.string(),
+	html: z.string(),
+	runningHead: z.string().optional(),
+	opens: BookOpens.optional(),
+	parents: BookSectionParents.optional()
+});
+const flowingChapter = Chapter.extend({ kind: z.literal("chapter").optional() });
+const BookChapterEntry = z.discriminatedUnion("kind", [
+	DesignedSection,
+	TemplatedSection,
+	flowingChapter
+]);
+function isBookContents(entry) {
+	return "kind" in entry && entry.kind === "contents";
+}
+function isDesignedSection(entry) {
+	return "kind" in entry && entry.kind === "designed";
+}
+function isTemplatedSection(entry) {
+	return "kind" in entry && entry.kind === "templated";
+}
+function isChapter(entry) {
+	return !isDesignedSection(entry) && !isTemplatedSection(entry);
+}
+function namedSections(book) {
+	const front = book.frontMatter.map((entry, index) => {
+		const path = ["frontMatter", index];
+		return {
+			label: entry.title ?? `frontMatter[${index}]`,
+			path,
+			parents: entry.parents,
+			templated: isTemplatedSection(entry) ? entry : void 0
+		};
+	});
+	const chapters = book.chapters.map((entry, index) => {
+		const path = ["chapters", index];
+		if (isDesignedSection(entry) || isTemplatedSection(entry)) return {
+			label: entry.title ?? `chapters[${index}]`,
+			path,
+			parents: entry.parents,
+			templated: isTemplatedSection(entry) ? entry : void 0
+		};
+		return {
+			label: entry.title,
+			path,
+			parents: entry.parents
+		};
+	});
+	return [...front, ...chapters];
+}
+function hasKind(book, match) {
+	return book.frontMatter.some(match) || book.chapters.some(match);
+}
+function unknownParent(label, role, name, path) {
+	return {
+		path: [
+			...path,
+			"parents",
+			role
+		],
+		message: `${label} names unknown parent page "${name}"; add that parent page or name an existing one to clear this refusal`
+	};
+}
+function parentNameIssues(label, path, parents, known) {
+	if (!parents) return [];
+	return Object.entries(parents).flatMap(([role, name]) => name && !known.has(name) ? [unknownParent(label, role, name, path)] : []);
+}
+function templateListIssues(templates, knownParents) {
+	const issues = [];
+	const seen = /* @__PURE__ */ new Set();
+	templates.forEach((template, index) => {
+		const path = ["templates", index];
+		if (!REGION_NAME.test(template.name)) issues.push({
+			path: [...path, "name"],
+			message: `template "${template.name}" is not an HTML name token; ${regionNameClear}`
+		});
+		if (seen.has(template.name)) issues.push({
+			path: [...path, "name"],
+			message: `template "${template.name}" is duplicated; give every template a unique name to clear this refusal`
+		});
+		seen.add(template.name);
+		issues.push(...parentNameIssues(`template ${template.name}`, path, template.parents, knownParents));
+	});
+	return issues;
+}
+function templatedPageIssues(section, knownTemplates) {
+	const entry = section.templated;
+	if (!entry) return [];
+	const issues = [];
+	if (!knownTemplates.has(entry.template)) issues.push({
+		path: [...section.path, "template"],
+		message: `section ${section.label} names unknown template "${entry.template}"; add that template or name an existing one to clear this refusal`
+	});
+	entry.pages.forEach((page, index) => {
+		if (page.template !== void 0 && !knownTemplates.has(page.template)) issues.push({
+			path: [
+				...section.path,
+				"pages",
+				index,
+				"template"
+			],
+			message: `section ${section.label} page ${index + 1} names unknown template "${page.template}"; add that template or name an existing one to clear this refusal`
+		});
+		for (const key of Object.keys(page.regions)) {
+			if (REGION_NAME.test(key)) continue;
+			issues.push({
+				path: [
+					...section.path,
+					"pages",
+					index,
+					"regions",
+					key
+				],
+				message: `section ${section.label} page ${index + 1} region "${key}" is not an HTML name token; ${regionNameClear}`
+			});
+		}
+	});
+	return issues;
+}
+function bookParentIssues(book) {
+	const issues = [];
+	if (book.mode === "continuous" && hasKind(book, isDesignedSection)) issues.push({
+		path: ["mode"],
+		message: "designed sections print in paginated mode; set mode: 'paginated' to clear this refusal"
+	});
+	if (book.mode === "continuous" && hasKind(book, isTemplatedSection)) issues.push({
+		path: ["mode"],
+		message: "templated sections print in paginated mode; set mode: 'paginated' to clear this refusal"
+	});
+	issues.push(...parentListIssues(book.parentPages, {
+		path: ["parentPages"],
+		known: Object.values(BOOK_PARENT_NAMES)
+	}));
+	const knownParents = /* @__PURE__ */ new Set([...Object.values(BOOK_PARENT_NAMES), ...book.parentPages.map((parent) => parent.name)]);
+	issues.push(...templateListIssues(book.templates, knownParents));
+	const knownTemplates = new Set(book.templates.map((template) => template.name));
+	for (const section of namedSections(book)) {
+		issues.push(...parentNameIssues(`section ${section.label}`, section.path, section.parents, knownParents));
+		issues.push(...templatedPageIssues(section, knownTemplates));
+	}
+	return issues;
+}
+//#endregion
+export { BookChapterEntry, BookContents, BookFrontMatterEntry, BookOpens, BookSection, BookSectionParents, BookTemplate, Chapter, DesignedPage, DesignedSection, REGION_NAME, TemplatedPage, TemplatedSection, bookParentIssues, isBookContents, isChapter, isDesignedSection, isTemplatedSection };