@segnavia/format 0.3.0 → 0.4.0

package/dist/book.d.ts

@@ -0,0 +1,244 @@
+import { z } from "zod";
+//#region src/book.d.ts
+export declare const BookMode: z.ZodEnum<{
+  continuous: "continuous";
+  paginated: "paginated";
+}>;
+export type BookMode = z.infer<typeof BookMode>;
+export declare const BookSection: z.ZodObject<{
+  title: z.ZodOptional<z.ZodString>;
+  html: z.ZodString;
+  contents: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type BookSection = z.infer<typeof BookSection>;
+export declare const Chapter: z.ZodObject<{
+  title: z.ZodString;
+  html: z.ZodString;
+  runningHead: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type Chapter = z.infer<typeof Chapter>;
+export declare const BookPage: z.ZodObject<{
+  paper: z.ZodUnion<readonly [z.ZodEnum<{
+    letter: "letter";
+    legal: "legal";
+    tabloid: "tabloid";
+    a3: "a3";
+    a4: "a4";
+    a5: "a5";
+  }>, z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    unit: z.ZodEnum<{
+      mm: "mm";
+      in: "in";
+      pt: "pt";
+    }>;
+  }, z.core.$strip>]>;
+  orientation: z.ZodDefault<z.ZodEnum<{
+    portrait: "portrait";
+    landscape: "landscape";
+  }>>;
+  margin: z.ZodObject<{
+    top: z.ZodNumber;
+    bottom: z.ZodNumber;
+    inner: z.ZodNumber;
+    outer: z.ZodNumber;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+export type BookPage = z.infer<typeof BookPage>;
+export declare const Book: z.ZodPipe<z.ZodObject<{
+  title: z.ZodString;
+  mode: z.ZodEnum<{
+    continuous: "continuous";
+    paginated: "paginated";
+  }>;
+  page: z.ZodOptional<z.ZodObject<{
+    paper: z.ZodUnion<readonly [z.ZodEnum<{
+      letter: "letter";
+      legal: "legal";
+      tabloid: "tabloid";
+      a3: "a3";
+      a4: "a4";
+      a5: "a5";
+    }>, z.ZodObject<{
+      width: z.ZodNumber;
+      height: z.ZodNumber;
+      unit: z.ZodEnum<{
+        mm: "mm";
+        in: "in";
+        pt: "pt";
+      }>;
+    }, z.core.$strip>]>;
+    orientation: z.ZodDefault<z.ZodEnum<{
+      portrait: "portrait";
+      landscape: "landscape";
+    }>>;
+    margin: z.ZodObject<{
+      top: z.ZodNumber;
+      bottom: z.ZodNumber;
+      inner: z.ZodNumber;
+      outer: z.ZodNumber;
+    }, z.core.$strip>;
+  }, z.core.$strip>>;
+  scripts: z.ZodDefault<z.ZodEnum<{
+    refuse: "refuse";
+    sandboxed: "sandboxed";
+  }>>;
+  dir: z.ZodOptional<z.ZodEnum<{
+    ltr: "ltr";
+    rtl: "rtl";
+    auto: "auto";
+  }>>;
+  lang: z.ZodOptional<z.ZodString>;
+  frontMatter: z.ZodDefault<z.ZodArray<z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    html: z.ZodString;
+    contents: z.ZodDefault<z.ZodBoolean>;
+  }, z.core.$strip>>>;
+  chapters: z.ZodArray<z.ZodObject<{
+    title: z.ZodString;
+    html: z.ZodString;
+    runningHead: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  numbering: z.ZodDefault<z.ZodObject<{
+    frontMatter: z.ZodOptional<z.ZodEnum<{
+      arabic: "arabic";
+      "roman-lower": "roman-lower";
+      "roman-upper": "roman-upper";
+      hebrew: "hebrew";
+    }>>;
+    body: z.ZodOptional<z.ZodEnum<{
+      arabic: "arabic";
+      "roman-lower": "roman-lower";
+      "roman-upper": "roman-upper";
+      hebrew: "hebrew";
+    }>>;
+  }, z.core.$strip>>;
+  footnotes: z.ZodDefault<z.ZodObject<{
+    marker: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+      arabic: "arabic";
+      "roman-lower": "roman-lower";
+      "roman-upper": "roman-upper";
+      hebrew: "hebrew";
+    }>, z.ZodLiteral<"symbols">]>>;
+    restart: z.ZodDefault<z.ZodEnum<{
+      chapter: "chapter";
+      book: "book";
+    }>>;
+  }, z.core.$strip>>;
+  endnotes: z.ZodDefault<z.ZodObject<{
+    marker: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+      arabic: "arabic";
+      "roman-lower": "roman-lower";
+      "roman-upper": "roman-upper";
+      hebrew: "hebrew";
+    }>, z.ZodLiteral<"symbols">]>>;
+    placement: z.ZodDefault<z.ZodEnum<{
+      chapter: "chapter";
+      book: "book";
+    }>>;
+  }, z.core.$strip>>;
+  rightHandOpenings: z.ZodDefault<z.ZodBoolean>;
+  contents: z.ZodDefault<z.ZodObject<{
+    pageNumbers: z.ZodDefault<z.ZodBoolean>;
+  }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodTransform<{
+  numbering: {
+    frontMatter: "arabic" | "roman-lower" | "roman-upper" | "hebrew";
+    body: "arabic" | "roman-lower" | "roman-upper" | "hebrew";
+  };
+  footnotes: {
+    marker: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | "symbols";
+    restart: "chapter" | "book";
+  };
+  endnotes: {
+    marker: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | "symbols";
+    placement: "chapter" | "book";
+  };
+  title: string;
+  mode: "continuous" | "paginated";
+  scripts: "refuse" | "sandboxed";
+  frontMatter: {
+    html: string;
+    contents: boolean;
+    title?: string | undefined;
+  }[];
+  chapters: {
+    title: string;
+    html: string;
+    runningHead?: string | undefined;
+  }[];
+  rightHandOpenings: boolean;
+  contents: {
+    pageNumbers: boolean;
+  };
+  page?: {
+    paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | {
+      width: number;
+      height: number;
+      unit: "mm" | "in" | "pt";
+    };
+    orientation: "portrait" | "landscape";
+    margin: {
+      top: number;
+      bottom: number;
+      inner: number;
+      outer: number;
+    };
+  } | undefined;
+  dir?: "ltr" | "rtl" | "auto" | undefined;
+  lang?: string | undefined;
+}, {
+  title: string;
+  mode: "continuous" | "paginated";
+  scripts: "refuse" | "sandboxed";
+  frontMatter: {
+    html: string;
+    contents: boolean;
+    title?: string | undefined;
+  }[];
+  chapters: {
+    title: string;
+    html: string;
+    runningHead?: string | undefined;
+  }[];
+  numbering: {
+    frontMatter?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | undefined;
+    body?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | undefined;
+  };
+  footnotes: {
+    restart: "chapter" | "book";
+    marker?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | "symbols" | undefined;
+  };
+  endnotes: {
+    placement: "chapter" | "book";
+    marker?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | "symbols" | undefined;
+  };
+  rightHandOpenings: boolean;
+  contents: {
+    pageNumbers: boolean;
+  };
+  page?: {
+    paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | {
+      width: number;
+      height: number;
+      unit: "mm" | "in" | "pt";
+    };
+    orientation: "portrait" | "landscape";
+    margin: {
+      top: number;
+      bottom: number;
+      inner: number;
+      outer: number;
+    };
+  } | undefined;
+  dir?: "ltr" | "rtl" | "auto" | undefined;
+  lang?: string | undefined;
+}>>;
+export type Book = z.infer<typeof Book>;
+export type BookInput = z.input<typeof Book>;
+export declare function noteMarkerIssues(book: Book, used: {
+  footnotes: boolean;
+  endnotes: boolean;
+}): string[];
+//#endregion

package/dist/book.js

@@ -0,0 +1,109 @@
+import { Direction } from "./direction.js";
+import { NoteMarker, NumberSystem } from "./numbering.js";
+import { Paper, sheetMm } from "./paper.js";
+import { Scripts } from "./scripts.js";
+import { z } from "zod";
+//#region src/book.ts
+const BookMode = z.enum(["continuous", "paginated"]);
+const BookSection = z.object({
+	title: z.string().optional(),
+	html: z.string(),
+	contents: z.boolean().default(true)
+});
+const Chapter = z.object({
+	title: z.string(),
+	html: z.string(),
+	runningHead: z.string().optional()
+});
+const BookPage = z.object({
+	paper: Paper,
+	orientation: z.enum(["portrait", "landscape"]).default("portrait"),
+	margin: z.object({
+		top: z.number().nonnegative(),
+		bottom: z.number().nonnegative(),
+		inner: z.number().nonnegative(),
+		outer: z.number().nonnegative()
+	})
+});
+const BookShape = z.object({
+	title: z.string(),
+	mode: BookMode,
+	page: BookPage.optional(),
+	scripts: Scripts.default("refuse"),
+	dir: Direction.optional(),
+	lang: z.string().optional(),
+	frontMatter: z.array(BookSection).default([]),
+	chapters: z.array(Chapter).min(1),
+	numbering: z.object({
+		frontMatter: NumberSystem.optional(),
+		body: NumberSystem.optional()
+	}).default({}),
+	footnotes: z.object({
+		marker: NoteMarker.optional(),
+		restart: z.enum(["chapter", "book"]).default("chapter")
+	}).default({ restart: "chapter" }),
+	endnotes: z.object({
+		marker: NoteMarker.optional(),
+		placement: z.enum(["book", "chapter"]).default("book")
+	}).default({ placement: "book" }),
+	rightHandOpenings: z.boolean().default(false),
+	contents: z.object({ pageNumbers: z.boolean().default(true) }).default({ pageNumbers: true })
+});
+function isHebrew(lang) {
+	const primary = lang?.split("-")[0]?.toLowerCase();
+	return primary === "he" || primary === "iw";
+}
+const Book = BookShape.transform((book) => {
+	const hebrew = isHebrew(book.lang);
+	return {
+		...book,
+		numbering: {
+			frontMatter: book.numbering.frontMatter ?? (hebrew ? "arabic" : "roman-lower"),
+			body: book.numbering.body ?? (hebrew ? "hebrew" : "arabic")
+		},
+		footnotes: {
+			...book.footnotes,
+			marker: book.footnotes.marker ?? (hebrew ? "hebrew" : "symbols")
+		},
+		endnotes: {
+			...book.endnotes,
+			marker: book.endnotes.marker ?? "arabic"
+		}
+	};
+}).superRefine((book, ctx) => {
+	if (book.mode === "paginated" && !book.page) ctx.addIssue({
+		code: "custom",
+		path: ["page"],
+		message: "a paginated book needs page; set page or use continuous mode"
+	});
+	if (book.frontMatter.length > 0 && book.numbering.frontMatter === book.numbering.body) ctx.addIssue({
+		code: "custom",
+		path: ["numbering"],
+		message: `front-matter and body numbering are both ${book.numbering.body}; the two must differ when front matter is present`
+	});
+	if (book.endnotes.placement === "chapter" && book.mode === "continuous") ctx.addIssue({
+		code: "custom",
+		path: ["endnotes", "placement"],
+		message: "endnotes are placed at the end of each chapter only in paginated mode; use book placement or paginated mode"
+	});
+	if (!book.page) return;
+	const trim = sheetMm(book.page);
+	const vertical = book.page.margin.top + book.page.margin.bottom;
+	const horizontal = book.page.margin.inner + book.page.margin.outer;
+	if (vertical >= trim.height) ctx.addIssue({
+		code: "custom",
+		path: ["page", "margin"],
+		message: `the top and bottom margins total ${vertical}mm and the page is ${trim.height}mm high; reduce the vertical margins to leave a text area`
+	});
+	if (horizontal >= trim.width) ctx.addIssue({
+		code: "custom",
+		path: ["page", "margin"],
+		message: `the inner and outer margins total ${horizontal}mm and the page is ${trim.width}mm wide; reduce the horizontal margins to leave a text area`
+	});
+});
+function noteMarkerIssues(book, used) {
+	if (!used.footnotes || !used.endnotes || book.footnotes.marker !== book.endnotes.marker) return [];
+	return [`footnote and endnote markers are both ${book.footnotes.marker}; the two must differ when both kinds are used`];
+}
+//#endregion
+export { Book, BookMode, BookPage, BookSection, BookShape, Chapter, noteMarkerIssues };

package/dist/direction.d.ts

@@ -1,4 +1,10 @@
+import { z } from "zod";
 //#region src/direction.d.ts
+export declare const Direction: z.ZodEnum<{
+  ltr: "ltr";
+  rtl: "rtl";
+  auto: "auto";
+}>;
 export type TextDirection = 'ltr' | 'rtl';
 export declare function firstStrongDirection(text: string): TextDirection | null;
 export declare function languageDirection(lang: string | undefined): TextDirection | null;

package/dist/direction.js

@@ -1,4 +1,10 @@
+import { z } from "zod";
 //#region src/direction.ts
+const Direction = z.enum([
+	"ltr",
+	"rtl",
+	"auto"
+]);
 const RTL_LETTER = /[\p{Script=Hebrew}\p{Script=Arabic}\p{Script=Syriac}\p{Script=Thaana}\p{Script=Nko}\p{Script=Samaritan}\p{Script=Mandaic}\p{Script=Adlam}\p{Script=Hanifi_Rohingya}\p{Script=Mende_Kikakui}\p{Script=Old_Hungarian}\p{Script=Imperial_Aramaic}\p{Script=Phoenician}]/u;
 const LETTER = /\p{L}/u;
 const RTL_LANGUAGES = /* @__PURE__ */ new Set([
@@ -36,4 +42,4 @@ function resolveDirection(dir, lang, sample) {
 	return languageDirection(lang) ?? firstStrongDirection(sample) ?? "ltr";
 }
 //#endregion
-export { firstStrongDirection, languageDirection, resolveDirection };
+export { Direction, firstStrongDirection, languageDirection, resolveDirection };

package/dist/index.d.ts

@@ -1,6 +1,10 @@
-import { TextDirection, firstStrongDirection, languageDirection, resolveDirection } from "./direction.js";
-import { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, PAPER_MM, PX_PER_MM, PaperBox, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
+import { Book, BookInput, BookMode, BookPage, BookSection, Chapter, noteMarkerIssues } from "./book.js";
+import { Direction, TextDirection, firstStrongDirection, languageDirection, resolveDirection } from "./direction.js";
+import { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, PAPER_MM, PX_PER_MM, Paper, PaperBox, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
 import { Imposed, MillimeterEdges, PageFit, PagePlacementKind, PagePlacementLayout, Placement, fitPage, impose, mirrorPlacement, pagePlacementLayout } from "./imposition.js";
+import { Lexicon, PronunciationEntry, lexiconVersion } from "./lexicon.js";
+import { NoteMarker, NumberSystem, formatNumber, noteMarker } from "./numbering.js";
+import { Scripts } from "./scripts.js";
 import { ShotUse, shotsUsed } from "./shots-used.js";
 import { MAX_SLIDE_TIMING_MS } from "./timing.js";
 import { DEFAULT_TRANSITION_DURATION_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, Transition, TransitionInput } from "./transition.js";
@@ -11,34 +15,6 @@ export declare const Size: z.ZodObject<{
   height: z.ZodNumber;
 }, z.core.$strip>;
 export type Size = z.infer<typeof Size>;
-export declare const Scripts: z.ZodEnum<{
-  refuse: "refuse";
-  sandboxed: "sandboxed";
-}>;
-export type Scripts = z.infer<typeof Scripts>;
-export declare const Direction: z.ZodEnum<{
-  ltr: "ltr";
-  rtl: "rtl";
-  auto: "auto";
-}>;
-export declare const NAMED_PAPERS: readonly ["letter", "legal", "tabloid", "a3", "a4", "a5"];
-export declare const Paper: z.ZodUnion<readonly [z.ZodEnum<{
-  letter: "letter";
-  legal: "legal";
-  tabloid: "tabloid";
-  a3: "a3";
-  a4: "a4";
-  a5: "a5";
-}>, z.ZodObject<{
-  width: z.ZodNumber;
-  height: z.ZodNumber;
-  unit: z.ZodEnum<{
-    mm: "mm";
-    in: "in";
-    pt: "pt";
-  }>;
-}, z.core.$strip>]>;
-export type Paper = z.infer<typeof Paper>;
 export declare const Margin: z.ZodObject<{
   top: z.ZodDefault<z.ZodNumber>;
   right: z.ZodDefault<z.ZodNumber>;
@@ -723,6 +699,103 @@ export interface DeckLimits {
 }
 export declare function exceedsLimits(deck: Deck, limits: DeckLimits): string[];
 export declare function jsonSchemas(): {
+  book: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
+    title: z.ZodString;
+    mode: z.ZodEnum<{
+      continuous: "continuous";
+      paginated: "paginated";
+    }>;
+    page: z.ZodOptional<z.ZodObject<{
+      paper: z.ZodUnion<readonly [z.ZodEnum<{
+        letter: "letter";
+        legal: "legal";
+        tabloid: "tabloid";
+        a3: "a3";
+        a4: "a4";
+        a5: "a5";
+      }>, z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        unit: z.ZodEnum<{
+          mm: "mm";
+          in: "in";
+          pt: "pt";
+        }>;
+      }, z.core.$strip>]>;
+      orientation: z.ZodDefault<z.ZodEnum<{
+        portrait: "portrait";
+        landscape: "landscape";
+      }>>;
+      margin: z.ZodObject<{
+        top: z.ZodNumber;
+        bottom: z.ZodNumber;
+        inner: z.ZodNumber;
+        outer: z.ZodNumber;
+      }, z.core.$strip>;
+    }, z.core.$strip>>;
+    scripts: z.ZodDefault<z.ZodEnum<{
+      refuse: "refuse";
+      sandboxed: "sandboxed";
+    }>>;
+    dir: z.ZodOptional<z.ZodEnum<{
+      ltr: "ltr";
+      rtl: "rtl";
+      auto: "auto";
+    }>>;
+    lang: z.ZodOptional<z.ZodString>;
+    frontMatter: z.ZodDefault<z.ZodArray<z.ZodObject<{
+      title: z.ZodOptional<z.ZodString>;
+      html: z.ZodString;
+      contents: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    chapters: z.ZodArray<z.ZodObject<{
+      title: z.ZodString;
+      html: z.ZodString;
+      runningHead: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    numbering: z.ZodDefault<z.ZodObject<{
+      frontMatter: z.ZodOptional<z.ZodEnum<{
+        arabic: "arabic";
+        "roman-lower": "roman-lower";
+        "roman-upper": "roman-upper";
+        hebrew: "hebrew";
+      }>>;
+      body: z.ZodOptional<z.ZodEnum<{
+        arabic: "arabic";
+        "roman-lower": "roman-lower";
+        "roman-upper": "roman-upper";
+        hebrew: "hebrew";
+      }>>;
+    }, z.core.$strip>>;
+    footnotes: z.ZodDefault<z.ZodObject<{
+      marker: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+        arabic: "arabic";
+        "roman-lower": "roman-lower";
+        "roman-upper": "roman-upper";
+        hebrew: "hebrew";
+      }>, z.ZodLiteral<"symbols">]>>;
+      restart: z.ZodDefault<z.ZodEnum<{
+        chapter: "chapter";
+        book: "book";
+      }>>;
+    }, z.core.$strip>>;
+    endnotes: z.ZodDefault<z.ZodObject<{
+      marker: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+        arabic: "arabic";
+        "roman-lower": "roman-lower";
+        "roman-upper": "roman-upper";
+        hebrew: "hebrew";
+      }>, z.ZodLiteral<"symbols">]>>;
+      placement: z.ZodDefault<z.ZodEnum<{
+        chapter: "chapter";
+        book: "book";
+      }>>;
+    }, z.core.$strip>>;
+    rightHandOpenings: z.ZodDefault<z.ZodBoolean>;
+    contents: z.ZodDefault<z.ZodObject<{
+      pageNumbers: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
   page: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
     html: z.ZodString;
     size: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"fluid">, z.ZodObject<{
@@ -774,6 +847,13 @@ export declare function jsonSchemas(): {
       marks: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
+  lexicon: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
+    entries: z.ZodArray<z.ZodObject<{
+      term: z.ZodString;
+      say: z.ZodString;
+      ipa: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
   imposition: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
     paper: z.ZodUnion<readonly [z.ZodEnum<{
       letter: "letter";
@@ -1064,4 +1144,4 @@ export declare function jsonSchemas(): {
   }, z.core.$strip>>;
 };
 //#endregion
-export { DEFAULT_TRANSITION_DURATION_MS, type Imposed, MARK_GAP_MM, MARK_LENGTH_MM, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, MM_PER_PT, type MillimeterEdges, PAPER_MM, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, type PaperBox, type Placement, type ShotUse, type TextDirection, Transition, TransitionInput, firstStrongDirection, fitPage, impose, languageDirection, mirrorPlacement, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, shotsUsed, toMillimeters };
+export { Book, type BookInput, BookMode, BookPage, BookSection, Chapter, DEFAULT_TRANSITION_DURATION_MS, Direction, type Imposed, Lexicon, MARK_GAP_MM, MARK_LENGTH_MM, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, MM_PER_PT, type MillimeterEdges, NAMED_PAPERS, NoteMarker, NumberSystem, PAPER_MM, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, Paper, type PaperBox, type Placement, PronunciationEntry, Scripts, type ShotUse, type TextDirection, Transition, TransitionInput, firstStrongDirection, fitPage, formatNumber, impose, languageDirection, lexiconVersion, mirrorPlacement, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, shotsUsed, toMillimeters };

package/dist/index.js

@@ -1,7 +1,11 @@
-import { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, PAPER_MM, PX_PER_MM, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
+import { Direction, firstStrongDirection, languageDirection, resolveDirection } from "./direction.js";
+import { NoteMarker, NumberSystem, formatNumber, noteMarker } from "./numbering.js";
+import { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, PAPER_MM, PX_PER_MM, Paper, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
+import { Scripts } from "./scripts.js";
+import { Book, BookMode, BookPage, BookSection, BookShape, Chapter, noteMarkerIssues } from "./book.js";
+import { Lexicon, PronunciationEntry, lexiconVersion } from "./lexicon.js";
 import { MAX_SLIDE_TIMING_MS, SlideTiming, slideTimingIssues } from "./timing.js";
 import { DEFAULT_TRANSITION_DURATION_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, Transition } from "./transition.js";
-import { firstStrongDirection, languageDirection, resolveDirection } from "./direction.js";
 import { fitPage, impose, mirrorPlacement, pagePlacementLayout } from "./imposition.js";
 import { shotsUsed } from "./shots-used.js";
 import { z } from "zod";
@@ -10,29 +14,6 @@ const Size = z.object({
 	width: z.number().int().positive(),
 	height: z.number().int().positive()
 });
-const Scripts = z.enum(["refuse", "sandboxed"]);
-const Direction = z.enum([
-	"ltr",
-	"rtl",
-	"auto"
-]);
-const NAMED_PAPERS = [
-	"letter",
-	"legal",
-	"tabloid",
-	"a3",
-	"a4",
-	"a5"
-];
-const Paper = z.union([z.enum(NAMED_PAPERS), z.object({
-	width: z.number().positive(),
-	height: z.number().positive(),
-	unit: z.enum([
-		"mm",
-		"in",
-		"pt"
-	])
-})]);
 const Margin = z.object({
 	top: z.number().nonnegative().default(0),
 	right: z.number().nonnegative().default(0),
@@ -345,7 +326,9 @@ function exceedsLimits(deck, limits) {
 }
 function jsonSchemas() {
 	return {
+		book: z.toJSONSchema(BookShape, { io: "input" }),
 		page: z.toJSONSchema(Page, { io: "input" }),
+		lexicon: z.toJSONSchema(Lexicon, { io: "input" }),
 		imposition: z.toJSONSchema(Imposition, { io: "input" }),
 		deck: z.toJSONSchema(DeckShape, { io: "input" }),
 		manifest: z.toJSONSchema(Manifest, { io: "input" }),
@@ -353,4 +336,4 @@ function jsonSchemas() {
 	};
 }
 //#endregion
-export { Annotation, Box, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, Direction, Imposition, MARK_GAP_MM, MARK_LENGTH_MM, MAX_IMPOSITION_CELLS, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, Margin, NAMED_PAPERS, Narration, PAPER_MM, PX_PER_MM, Page, PageSize, Paper, Point, Print, PublishedShot, SHOT_KEY, Scripts, Shot, Size, Slide, SlideContent, Transition, Word, annotationCueIssues, exceedsLimits, firstStrongDirection, fitPage, impose, jsonSchemas, languageDirection, mirrorPlacement, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, shotsUsed, toMillimeters };
+export { Annotation, Book, BookMode, BookPage, BookSection, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, Direction, Imposition, Lexicon, MARK_GAP_MM, MARK_LENGTH_MM, MAX_IMPOSITION_CELLS, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, Margin, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PX_PER_MM, Page, PageSize, Paper, Point, Print, PronunciationEntry, PublishedShot, SHOT_KEY, Scripts, Shot, Size, Slide, SlideContent, Transition, Word, annotationCueIssues, exceedsLimits, firstStrongDirection, fitPage, formatNumber, impose, jsonSchemas, languageDirection, lexiconVersion, mirrorPlacement, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, shotsUsed, toMillimeters };

package/dist/lexicon.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+//#region src/lexicon.d.ts
+export declare const PronunciationEntry: z.ZodObject<{
+  term: z.ZodString;
+  say: z.ZodString;
+  ipa: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PronunciationEntry = z.infer<typeof PronunciationEntry>;
+export declare const Lexicon: z.ZodObject<{
+  entries: z.ZodArray<z.ZodObject<{
+    term: z.ZodString;
+    say: z.ZodString;
+    ipa: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Lexicon = z.infer<typeof Lexicon>;
+export declare function lexiconVersion(lexicon: Lexicon): string;
+//#endregion

package/dist/lexicon.js

@@ -0,0 +1,38 @@
+import { z } from "zod";
+//#region src/lexicon.ts
+const SingleWord = z.string().min(1).regex(/^\S+$/u);
+const PronunciationEntry = z.object({
+	term: SingleWord,
+	say: SingleWord,
+	ipa: z.string().optional()
+});
+const Lexicon = z.object({ entries: z.array(PronunciationEntry) }).superRefine((lexicon, ctx) => {
+	const terms = /* @__PURE__ */ new Set();
+	lexicon.entries.forEach((entry, index) => {
+		if (terms.has(entry.term)) ctx.addIssue({
+			code: "custom",
+			path: [
+				"entries",
+				index,
+				"term"
+			],
+			message: `the term ${JSON.stringify(entry.term)} appears more than once`
+		});
+		terms.add(entry.term);
+	});
+});
+function lexiconVersion(lexicon) {
+	const canonical = [...lexicon.entries].sort((left, right) => left.term < right.term ? -1 : left.term > right.term ? 1 : 0).map(({ term, say, ipa }) => [
+		term,
+		say,
+		ipa ?? null
+	]);
+	let hash = 14695981039346656037n;
+	for (const byte of new TextEncoder().encode(JSON.stringify(canonical))) {
+		hash ^= BigInt(byte);
+		hash = BigInt.asUintN(64, hash * 1099511628211n);
+	}
+	return hash.toString(16).padStart(16, "0").slice(0, 12);
+}
+//#endregion
+export { Lexicon, PronunciationEntry, lexiconVersion };

package/dist/numbering.d.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+//#region src/numbering.d.ts
+export declare const NumberSystem: z.ZodEnum<{
+  arabic: "arabic";
+  "roman-lower": "roman-lower";
+  "roman-upper": "roman-upper";
+  hebrew: "hebrew";
+}>;
+export type NumberSystem = z.infer<typeof NumberSystem>;
+export declare const NoteMarker: z.ZodUnion<readonly [z.ZodEnum<{
+  arabic: "arabic";
+  "roman-lower": "roman-lower";
+  "roman-upper": "roman-upper";
+  hebrew: "hebrew";
+}>, z.ZodLiteral<"symbols">]>;
+export type NoteMarker = z.infer<typeof NoteMarker>;
+export declare function formatNumber(value: number, system: NumberSystem): string;
+export declare function noteMarker(index: number, marker: NoteMarker): string;
+//#endregion

package/dist/numbering.js

@@ -0,0 +1,106 @@
+import { z } from "zod";
+//#region src/numbering.ts
+const NumberSystem = z.enum([
+	"arabic",
+	"roman-lower",
+	"roman-upper",
+	"hebrew"
+]);
+const NoteMarker = z.union([NumberSystem, z.literal("symbols")]);
+const ROMAN_DIGITS = [
+	[1e3, "M"],
+	[900, "CM"],
+	[500, "D"],
+	[400, "CD"],
+	[100, "C"],
+	[90, "XC"],
+	[50, "L"],
+	[40, "XL"],
+	[10, "X"],
+	[9, "IX"],
+	[5, "V"],
+	[4, "IV"],
+	[1, "I"]
+];
+const HEBREW_ONES = [
+	"",
+	"א",
+	"ב",
+	"ג",
+	"ד",
+	"ה",
+	"ו",
+	"ז",
+	"ח",
+	"ט"
+];
+const HEBREW_TENS = [
+	"",
+	"י",
+	"כ",
+	"ל",
+	"מ",
+	"נ",
+	"ס",
+	"ע",
+	"פ",
+	"צ"
+];
+const NOTE_SYMBOLS = [
+	"*",
+	"†",
+	"‡",
+	"§"
+];
+function positiveInteger(value) {
+	if (!Number.isInteger(value) || value < 1) throw new RangeError(`value ${value} must be a positive integer`);
+}
+function inRange(value, maximum, system) {
+	if (value > maximum) throw new RangeError(`${system} value ${value} is outside the range 1 to ${maximum}`);
+}
+function roman(value) {
+	let remaining = value;
+	let result = "";
+	for (const [amount, digit] of ROMAN_DIGITS) while (remaining >= amount) {
+		result += digit;
+		remaining -= amount;
+	}
+	return result;
+}
+function hebrewBelowThousand(value) {
+	const hundreds = "ת".repeat(Math.floor(value / 400));
+	const underFourHundred = value % 400;
+	const hundredsLetter = [
+		"",
+		"ק",
+		"ר",
+		"ש"
+	][Math.floor(underFourHundred / 100)];
+	const remainder = underFourHundred % 100;
+	if (remainder === 15) return `${hundreds}${hundredsLetter}טו`;
+	if (remainder === 16) return `${hundreds}${hundredsLetter}טז`;
+	return `${hundreds}${hundredsLetter}${HEBREW_TENS[Math.floor(remainder / 10)]}${HEBREW_ONES[remainder % 10]}`;
+}
+function hebrew(value) {
+	const thousands = Math.floor(value / 1e3);
+	const rest = value % 1e3;
+	return `${thousands === 0 ? "" : `${HEBREW_ONES[thousands]}׳`}${hebrewBelowThousand(rest)}`;
+}
+function formatNumber(value, system) {
+	positiveInteger(value);
+	if (system === "arabic") return String(value);
+	if (system === "hebrew") {
+		inRange(value, 9999, system);
+		return hebrew(value);
+	}
+	inRange(value, 3999, system);
+	const result = roman(value);
+	return system === "roman-lower" ? result.toLowerCase() : result;
+}
+function noteMarker(index, marker) {
+	positiveInteger(index);
+	if (marker !== "symbols") return formatNumber(index, marker);
+	return NOTE_SYMBOLS[(index - 1) % NOTE_SYMBOLS.length].repeat(Math.ceil(index / NOTE_SYMBOLS.length));
+}
+//#endregion
+export { NoteMarker, NumberSystem, formatNumber, noteMarker };

package/dist/paper.d.ts

@@ -1,5 +1,24 @@
-import { Paper, Print } from "./index.js";
+import { Print } from "./index.js";
+import { z } from "zod";
 //#region src/paper.d.ts
+export declare const NAMED_PAPERS: readonly ["letter", "legal", "tabloid", "a3", "a4", "a5"];
+export declare const Paper: z.ZodUnion<readonly [z.ZodEnum<{
+  letter: "letter";
+  legal: "legal";
+  tabloid: "tabloid";
+  a3: "a3";
+  a4: "a4";
+  a5: "a5";
+}>, z.ZodObject<{
+  width: z.ZodNumber;
+  height: z.ZodNumber;
+  unit: z.ZodEnum<{
+    mm: "mm";
+    in: "in";
+    pt: "pt";
+  }>;
+}, z.core.$strip>]>;
+export type Paper = z.infer<typeof Paper>;
 export declare const MM_PER_PT: number;
 export declare const MARK_LENGTH_MM = 5;
 export declare const MARK_GAP_MM = 1;

package/dist/paper.js

@@ -1,4 +1,22 @@
+import { z } from "zod";
 //#region src/paper.ts
+const NAMED_PAPERS = [
+	"letter",
+	"legal",
+	"tabloid",
+	"a3",
+	"a4",
+	"a5"
+];
+const Paper = z.union([z.enum(NAMED_PAPERS), z.object({
+	width: z.number().positive(),
+	height: z.number().positive(),
+	unit: z.enum([
+		"mm",
+		"in",
+		"pt"
+	])
+})]);
 const MM_PER_PT = 25.4 / 72;
 const MARK_LENGTH_MM = 5;
 const MARK_GAP_MM = 1;
@@ -156,4 +174,4 @@ function printBoxes(print) {
 	};
 }
 //#endregion
-export { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, PAPER_MM, PX_PER_MM, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters };
+export { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, PAPER_MM, PX_PER_MM, Paper, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters };

package/dist/scripts.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+//#region src/scripts.d.ts
+export declare const Scripts: z.ZodEnum<{
+  refuse: "refuse";
+  sandboxed: "sandboxed";
+}>;
+export type Scripts = z.infer<typeof Scripts>;
+//#endregion

package/dist/scripts.js

@@ -0,0 +1,5 @@
+import { z } from "zod";
+//#region src/scripts.ts
+const Scripts = z.enum(["refuse", "sandboxed"]);
+//#endregion
+export { Scripts };

package/package.json

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