@segnavia/format 0.37.0 → 0.39.0

package/dist/board-edit.d.ts

@@ -1,5 +1,6 @@
 import { Board, BoardItem } from "./board.js";
-import { Point } from "./deck.js";
+import { Point } from "./geometry.js";
+import "./deck.js";
 //#region src/board-edit.d.ts
 export declare const MIN_BOARD_ITEM_WIDTH = 16;
 export type BoardItemAnchor = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';

package/dist/board-geometry.d.ts

@@ -1,5 +1,6 @@
 import { Board, BoardItem } from "./board.js";
-import { Box, Point, Size } from "./deck.js";
+import { Box, Point, Size } from "./geometry.js";
+import "./deck.js";
 //#region src/board-geometry.d.ts
 export interface BoardShapes {
   items: Record<string, Size>;

package/dist/board-section-grid.d.ts

@@ -1,5 +1,6 @@
 import { Board, GridCell } from "./board.js";
-import { Box, Point } from "./deck.js";
+import { Box, Point } from "./geometry.js";
+import "./deck.js";
 import { BoardShapes } from "./board-geometry.js";
 //#region src/board-section-grid.d.ts
 export type GridDropTarget = {

package/dist/board-sections.d.ts

@@ -1,5 +1,6 @@
 import { Board, BoardSection } from "./board.js";
-import { Point } from "./deck.js";
+import { Point } from "./geometry.js";
+import "./deck.js";
 import { BoardShapes } from "./board-geometry.js";
 import { MAKE_ROOM_LIMIT, SECTION_GAP, SECTION_MIN_SIZE, SECTION_PADDING, SECTION_TITLE_ROOM } from "./board-section-constants.js";
 //#region src/board-sections.d.ts

package/dist/board.d.ts

@@ -3,12 +3,12 @@ import { z } from "zod";
 export declare const BoardItem: z.ZodObject<{
   id: z.ZodString;
   kind: z.ZodEnum<{
-    paper: "paper";
-    image: "image";
+    deck: "deck";
     page: "page";
+    paper: "paper";
     book: "book";
+    media: "media";
     shot: "shot";
-    deck: "deck";
   }>;
   address: z.ZodString;
   x: z.ZodNumber;
@@ -50,7 +50,7 @@ export declare const BoardSection: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type BoardSection = z.infer<typeof BoardSection>;
-export declare const Board: z.ZodObject<{
+export declare const Board: z.ZodPreprocess<z.ZodObject<{
   title: z.ZodString;
   direction: z.ZodEnum<{
     ltr: "ltr";
@@ -59,12 +59,12 @@ export declare const Board: z.ZodObject<{
   items: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     kind: z.ZodEnum<{
-      paper: "paper";
-      image: "image";
+      deck: "deck";
       page: "page";
+      paper: "paper";
       book: "book";
+      media: "media";
       shot: "shot";
-      deck: "deck";
     }>;
     address: z.ZodString;
     x: z.ZodNumber;
@@ -97,7 +97,7 @@ export declare const Board: z.ZodObject<{
       column: z.ZodNumber;
     }, z.core.$strip>>>;
   }, z.core.$strip>>;
-}, z.core.$strip>;
+}, z.core.$strip>, unknown>;
 export type Board = z.infer<typeof Board>;
 export type BoardInput = z.input<typeof Board>;
 //#endregion

package/dist/board.js

@@ -1,15 +1,9 @@
 import { TextDirection } from "./direction.js";
-import { Box } from "./deck.js";
+import { Box } from "./geometry.js";
+import { AssetKind } from "./placement.js";
 import { z } from "zod";
 //#region src/board.ts
-const BoardKind = z.enum([
-	"deck",
-	"page",
-	"paper",
-	"book",
-	"image",
-	"shot"
-], { error: "item kind is unknown; use deck, page, paper, book, image or shot" });
+const BoardKind = AssetKind;
 const BoardItem = z.object({
 	id: z.string(),
 	kind: BoardKind,
@@ -37,13 +31,23 @@ const BoardSection = z.object({
 	layout: z.enum(["auto", "manual"]).optional(),
 	cells: z.array(GridCell).optional()
 });
-const Board = z.object({
+const Board = z.preprocess((value) => {
+	if (typeof value !== "object" || value === null || !Array.isArray(value.items)) return value;
+	const board = value;
+	return {
+		...board,
+		items: board.items.map((item) => typeof item === "object" && item !== null && item.kind === "image" ? {
+			...item,
+			kind: "media"
+		} : item)
+	};
+}, z.object({
 	title: z.string(),
 	direction: TextDirection,
 	items: z.array(BoardItem),
 	labels: z.array(BoardLabel),
 	sections: z.array(BoardSection)
-}).superRefine((board, ctx) => {
+})).superRefine((board, ctx) => {
 	const ids = /* @__PURE__ */ new Set();
 	const checkIds = (entries, listName) => {
 		entries.forEach((entry, index) => {

package/dist/book-exports.d.ts

@@ -0,0 +1,4 @@
+import { NoteNumbering, NotePlacement, NoteSeries, NoteSeriesInput, ResolvedNoteSeries, noteMarkerIssues, resolveNoteSeries } from "./note-series.js";
+import { BookChapterEntry, BookContents, BookDivision, BookDivisions, BookFrontMatterEntry, BookItem, BookOpens, BookSection, BookSectionEntry, BookSectionParents, BookTemplate, Chapter, DesignedPage, DesignedSection, MAX_PART_DEPTH, Part, PlacedSection, REGION_NAME, TemplatedPage, TemplatedSection, bookSections, isBookContents, isChapter, isDesignedSection, isPart, isPlacedSection, isTemplatedSection } from "./book-section.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, PlacedSection, REGION_NAME, type ResolvedNoteSeries, TemplatedPage, TemplatedSection, bookSections, isBookContents, isChapter, isDesignedSection, isPart, isPlacedSection, 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;
@@ -116,6 +136,64 @@ export declare const BookContents: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 export type BookContents = z.infer<typeof BookContents>;
+export declare const PlacedSection: 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>>;
+  kind: z.ZodLiteral<"placed">;
+  placement: z.ZodObject<{
+    kind: z.ZodEnum<{
+      deck: "deck";
+      page: "page";
+      paper: "paper";
+      book: "book";
+      media: "media";
+      shot: "shot";
+    }>;
+    address: z.ZodString;
+    page: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    box: z.ZodOptional<z.ZodEnum<{
+      media: "media";
+      bleed: "bleed";
+      crop: "crop";
+      trim: "trim";
+      art: "art";
+    }>>;
+    crop: z.ZodOptional<z.ZodObject<{
+      top: z.ZodOptional<z.ZodString>;
+      right: z.ZodOptional<z.ZodString>;
+      bottom: z.ZodOptional<z.ZodString>;
+      left: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    fit: z.ZodOptional<z.ZodEnum<{
+      width: "width";
+      contain: "contain";
+      cover: "cover";
+      focus: "focus";
+    }>>;
+    alt: z.ZodOptional<z.ZodObject<{
+      text: z.ZodString;
+      lang: z.ZodOptional<z.ZodString>;
+      dir: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        ltr: "ltr";
+        rtl: "rtl";
+      }>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+export type PlacedSection = z.infer<typeof PlacedSection>;
 export declare const BookFrontMatterEntry: z.ZodDiscriminatedUnion<[z.ZodObject<{
   pages: z.ZodArray<z.ZodObject<{
     html: z.ZodString;
@@ -171,6 +249,62 @@ export declare const BookFrontMatterEntry: z.ZodDiscriminatedUnion<[z.ZodObject<
     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>>;
+  kind: z.ZodLiteral<"placed">;
+  placement: z.ZodObject<{
+    kind: z.ZodEnum<{
+      deck: "deck";
+      page: "page";
+      paper: "paper";
+      book: "book";
+      media: "media";
+      shot: "shot";
+    }>;
+    address: z.ZodString;
+    page: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    box: z.ZodOptional<z.ZodEnum<{
+      media: "media";
+      bleed: "bleed";
+      crop: "crop";
+      trim: "trim";
+      art: "art";
+    }>>;
+    crop: z.ZodOptional<z.ZodObject<{
+      top: z.ZodOptional<z.ZodString>;
+      right: z.ZodOptional<z.ZodString>;
+      bottom: z.ZodOptional<z.ZodString>;
+      left: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    fit: z.ZodOptional<z.ZodEnum<{
+      width: "width";
+      contain: "contain";
+      cover: "cover";
+      focus: "focus";
+    }>>;
+    alt: z.ZodOptional<z.ZodObject<{
+      text: z.ZodString;
+      lang: z.ZodOptional<z.ZodString>;
+      dir: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        ltr: "ltr";
+        rtl: "rtl";
+      }>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
   title: z.ZodOptional<z.ZodString>;
   contents: z.ZodDefault<z.ZodBoolean>;
@@ -248,6 +382,62 @@ export declare const BookChapterEntry: z.ZodDiscriminatedUnion<[z.ZodObject<{
     fixed: z.ZodOptional<z.ZodString>;
   }, z.core.$strip>>;
   kind: z.ZodLiteral<"templated">;
+}, 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>>;
+  kind: z.ZodLiteral<"placed">;
+  placement: z.ZodObject<{
+    kind: z.ZodEnum<{
+      deck: "deck";
+      page: "page";
+      paper: "paper";
+      book: "book";
+      media: "media";
+      shot: "shot";
+    }>;
+    address: z.ZodString;
+    page: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    box: z.ZodOptional<z.ZodEnum<{
+      media: "media";
+      bleed: "bleed";
+      crop: "crop";
+      trim: "trim";
+      art: "art";
+    }>>;
+    crop: z.ZodOptional<z.ZodObject<{
+      top: z.ZodOptional<z.ZodString>;
+      right: z.ZodOptional<z.ZodString>;
+      bottom: z.ZodOptional<z.ZodString>;
+      left: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    fit: z.ZodOptional<z.ZodEnum<{
+      width: "width";
+      contain: "contain";
+      cover: "cover";
+      focus: "focus";
+    }>>;
+    alt: z.ZodOptional<z.ZodObject<{
+      text: z.ZodString;
+      lang: z.ZodOptional<z.ZodString>;
+      dir: z.ZodOptional<z.ZodEnum<{
+        auto: "auto";
+        ltr: "ltr";
+        rtl: "rtl";
+      }>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
   title: z.ZodString;
   html: z.ZodString;
@@ -267,8 +457,40 @@ 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 isPlacedSection(entry: BookItem): entry is PlacedSection;
 export declare function isChapter(entry: BookChapterEntry): entry is Chapter;
 //#endregion

package/dist/book-section.js

@@ -1,3 +1,4 @@
+import { PlacementShape } from "./placement.js";
 import { BOOK_PARENT_NAMES, parentListIssues } from "./printed-pages.js";
 import { z } from "zod";
 //#region src/book-section.ts
@@ -15,6 +16,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 +35,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,
@@ -54,11 +65,17 @@ const BookContents = z.object({
 	opens: BookOpens.optional(),
 	parents: BookSectionParents.optional()
 });
+const PlacedSection = z.object({
+	kind: z.literal("placed"),
+	placement: PlacementShape,
+	...sectionFields
+});
 const flowingFront = BookSection.extend({ kind: z.literal("front").optional() });
 const BookFrontMatterEntry = z.discriminatedUnion("kind", [
 	DesignedSection,
 	TemplatedSection,
 	BookContents,
+	PlacedSection,
 	flowingFront
 ]);
 const Chapter = z.object({
@@ -72,8 +89,61 @@ const flowingChapter = Chapter.extend({ kind: z.literal("chapter").optional() })
 const BookChapterEntry = z.discriminatedUnion("kind", [
 	DesignedSection,
 	TemplatedSection,
+	PlacedSection,
 	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";
 }
@@ -83,37 +153,32 @@ function isDesignedSection(entry) {
 function isTemplatedSection(entry) {
 	return "kind" in entry && entry.kind === "templated";
 }
+function isPlacedSection(entry) {
+	return "kind" in entry && entry.kind === "placed";
+}
 function isChapter(entry) {
-	return !isDesignedSection(entry) && !isTemplatedSection(entry);
+	return !isDesignedSection(entry) && !isTemplatedSection(entry) && !isPlacedSection(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 +270,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, PlacedSection, REGION_NAME, TemplatedPage, TemplatedSection, bookParentIssues, bookSections, isBookContents, isChapter, isDesignedSection, isPart, isPlacedSection, isTemplatedSection };