@segnavia/format 0.37.0 → 0.38.0

package/dist/book-exports.d.ts

@@ -0,0 +1,4 @@
+import { BookChapterEntry, BookContents, BookDivision, BookDivisions, BookFrontMatterEntry, BookItem, BookOpens, BookSection, BookSectionEntry, BookSectionParents, BookTemplate, Chapter, DesignedPage, DesignedSection, MAX_PART_DEPTH, Part, REGION_NAME, TemplatedPage, TemplatedSection, bookSections, isBookContents, isChapter, isDesignedSection, isPart, isTemplatedSection } from "./book-section.js";
+import { NoteNumbering, NotePlacement, NoteSeries, NoteSeriesInput, ResolvedNoteSeries, noteMarkerIssues, resolveNoteSeries } from "./note-series.js";
+import { Book, BookInput, BookMode, BookPage, BookRunningHead, BookRunningHeadSource, BookView, BookViewInput, BookViewPagination, resolveBookPagination } from "./book.js";
+export { Book, BookChapterEntry, BookContents, type BookDivision, type BookDivisions, BookFrontMatterEntry, type BookInput, BookItem, BookMode, BookOpens, BookPage, BookRunningHead, BookRunningHeadSource, BookSection, type BookSectionEntry, BookSectionParents, BookTemplate, BookView, type BookViewInput, BookViewPagination, Chapter, DesignedPage, DesignedSection, MAX_PART_DEPTH, NoteNumbering, NotePlacement, NoteSeries, type NoteSeriesInput, Part, REGION_NAME, type ResolvedNoteSeries, TemplatedPage, TemplatedSection, bookSections, isBookContents, isChapter, isDesignedSection, isPart, isTemplatedSection, noteMarkerIssues, resolveBookPagination, resolveNoteSeries };

package/dist/book-section.d.ts

@@ -20,6 +20,7 @@ export declare const DesignedPage: z.ZodObject<{
 }, z.core.$strip>;
 export type DesignedPage = z.infer<typeof DesignedPage>;
 export declare const REGION_NAME: RegExp;
+export declare const MAX_PART_DEPTH = 6;
 export declare const TemplatedPage: z.ZodObject<{
   template: z.ZodOptional<z.ZodString>;
   regions: z.ZodRecord<z.ZodString, z.ZodString>;
@@ -37,6 +38,25 @@ export declare const BookTemplate: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 export type BookTemplate = z.infer<typeof BookTemplate>;
+declare const partFields: {
+  name: z.ZodString;
+  title: z.ZodOptional<z.ZodString>;
+  html: 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>>;
+  runningHead: z.ZodOptional<z.ZodString>;
+};
 export declare const DesignedSection: z.ZodObject<{
   pages: z.ZodArray<z.ZodObject<{
     html: z.ZodString;
@@ -267,8 +287,39 @@ export declare const BookChapterEntry: z.ZodDiscriminatedUnion<[z.ZodObject<{
   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 interface Part extends z.infer<z.ZodObject<typeof partFields>> {
+  children: BookItem[];
+}
+export type BookItem = Part | BookFrontMatterEntry | BookChapterEntry;
+export declare const Part: z.ZodType<Part>;
+export declare const BookItem: z.ZodType<BookItem>;
+export type BookDivision = 'front' | 'body' | 'end';
+interface BookSectionLocation {
+  ancestry: Array<{
+    name: string;
+    title?: string;
+    runningHead?: string;
+    id: string;
+  }>;
+  depth: number;
+  path: (string | number)[];
+}
+export type BookSectionEntry = BookSectionLocation & {
+  entry: BookItem;
+  division: BookDivision;
+  id?: string;
+};
+export declare function isPart(entry: BookItem): entry is Part;
+export interface BookDivisions {
+  frontMatter: BookItem[];
+  body: BookItem[];
+  bodyKey?: 'body' | 'chapters';
+  endMatter: BookItem[];
+}
+/** The canonical reading order for every feature that consumes a book. */
+export declare function bookSections(book: BookDivisions): BookSectionEntry[];
+export declare function isBookContents(entry: BookItem): entry is BookContents;
+export declare function isDesignedSection(entry: BookItem): entry is DesignedSection;
+export declare function isTemplatedSection(entry: BookItem): entry is TemplatedSection;
 export declare function isChapter(entry: BookChapterEntry): entry is Chapter;
 //#endregion

package/dist/book-section.js

@@ -15,6 +15,7 @@ const BookSectionParents = z.object({
 });
 const DesignedPage = z.object({ html: z.string() });
 const REGION_NAME = /^[A-Za-z][\w-]*$/;
+const MAX_PART_DEPTH = 6;
 const TemplatedPage = z.object({
 	template: z.string().min(1).optional(),
 	regions: z.record(z.string(), z.string())
@@ -33,6 +34,15 @@ const sectionFields = {
 	opens: BookOpens.optional(),
 	parents: BookSectionParents.optional()
 };
+const partFields = {
+	name: z.string().regex(REGION_NAME, "a part name must be an HTML name token"),
+	title: z.string().optional(),
+	html: z.string().optional(),
+	contents: z.boolean().default(true),
+	opens: BookOpens.optional(),
+	parents: BookSectionParents.optional(),
+	runningHead: z.string().optional()
+};
 const DesignedSection = z.object({
 	kind: z.literal("designed"),
 	...sectionFields,
@@ -74,6 +84,58 @@ const BookChapterEntry = z.discriminatedUnion("kind", [
 	TemplatedSection,
 	flowingChapter
 ]);
+const Part = z.lazy(() => z.object({
+	...partFields,
+	children: z.array(BookItem).default([])
+}));
+const BookItem = z.lazy(() => z.union([
+	Part,
+	BookFrontMatterEntry,
+	BookChapterEntry
+]));
+function isPart(entry) {
+	return "name" in entry;
+}
+/** The canonical reading order for every feature that consumes a book. */
+function bookSections(book) {
+	const sections = [];
+	let partNumber = 0;
+	const walk = (items, division, parentPath, ancestry) => {
+		items.forEach((entry, index) => {
+			const path = [...parentPath, index];
+			if (!isPart(entry)) {
+				sections.push({
+					entry,
+					division,
+					ancestry,
+					depth: ancestry.length,
+					path
+				});
+				return;
+			}
+			partNumber += 1;
+			const id = `segnavia-part-${partNumber}`;
+			if (entry.html !== void 0 || entry.title !== void 0) sections.push({
+				entry,
+				division,
+				ancestry,
+				depth: ancestry.length,
+				path,
+				id
+			});
+			walk(entry.children, division, [...path, "children"], [...ancestry, {
+				name: entry.name,
+				title: entry.title,
+				runningHead: entry.runningHead,
+				id
+			}]);
+		});
+	};
+	walk(book.frontMatter, "front", ["frontMatter"], []);
+	walk(book.body, "body", [book.bodyKey ?? "body"], []);
+	walk(book.endMatter, "end", ["endMatter"], []);
+	return sections;
+}
 function isBookContents(entry) {
 	return "kind" in entry && entry.kind === "contents";
 }
@@ -86,34 +148,26 @@ function isTemplatedSection(entry) {
 function isChapter(entry) {
 	return !isDesignedSection(entry) && !isTemplatedSection(entry);
 }
+function pathLabel(path) {
+	return path.join(".");
+}
 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];
+	return bookSections(book).map(({ entry, path }) => {
 		if (isDesignedSection(entry) || isTemplatedSection(entry)) return {
-			label: entry.title ?? `chapters[${index}]`,
+			label: entry.title ?? pathLabel(path),
 			path,
 			parents: entry.parents,
 			templated: isTemplatedSection(entry) ? entry : void 0
 		};
 		return {
-			label: entry.title,
+			label: entry.title ?? pathLabel(path),
 			path,
 			parents: entry.parents
 		};
 	});
-	return [...front, ...chapters];
 }
 function hasKind(book, match) {
-	return book.frontMatter.some(match) || book.chapters.some(match);
+	return bookSections(book).some(({ entry }) => match(entry));
 }
 function unknownParent(label, role, name, path) {
 	return {
@@ -205,4 +259,4 @@ function bookParentIssues(book) {
 	return issues;
 }
 //#endregion
-export { BookChapterEntry, BookContents, BookFrontMatterEntry, BookOpens, BookSection, BookSectionParents, BookTemplate, Chapter, DesignedPage, DesignedSection, REGION_NAME, TemplatedPage, TemplatedSection, bookParentIssues, isBookContents, isChapter, isDesignedSection, isTemplatedSection };
+export { BookChapterEntry, BookContents, BookFrontMatterEntry, BookItem, BookOpens, BookSection, BookSectionParents, BookTemplate, Chapter, DesignedPage, DesignedSection, MAX_PART_DEPTH, Part, REGION_NAME, TemplatedPage, TemplatedSection, bookParentIssues, bookSections, isBookContents, isChapter, isDesignedSection, isPart, isTemplatedSection };