@segnavia/format 0.3.0 → 0.5.0

package/dist/book.d.ts

@@ -0,0 +1,274 @@
+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 BookContents: z.ZodObject<{
+  kind: z.ZodLiteral<"contents">;
+  title: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type BookContents = z.infer<typeof BookContents>;
+export declare const BookFrontMatterEntry: z.ZodUnion<readonly [z.ZodObject<{
+  title: z.ZodOptional<z.ZodString>;
+  html: z.ZodString;
+  contents: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+  kind: z.ZodLiteral<"contents">;
+  title: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>]>;
+export type BookFrontMatterEntry = z.infer<typeof BookFrontMatterEntry>;
+export declare function isBookContents(entry: BookFrontMatterEntry): entry is BookContents;
+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.ZodUnion<readonly [z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    html: z.ZodString;
+    contents: z.ZodDefault<z.ZodBoolean>;
+  }, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"contents">;
+    title: z.ZodOptional<z.ZodString>;
+  }, 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";
+    }>>;
+    title: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  rectoOpenings: z.ZodDefault<z.ZodBoolean>;
+  contents: z.ZodDefault<z.ZodObject<{
+    pageNumbers: z.ZodDefault<z.ZodBoolean>;
+    depth: z.ZodDefault<z.ZodNumber>;
+  }, 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";
+    title: string;
+    placement: "chapter" | "book";
+  };
+  title: string;
+  mode: "continuous" | "paginated";
+  scripts: "refuse" | "sandboxed";
+  frontMatter: ({
+    html: string;
+    contents: boolean;
+    title?: string | undefined;
+  } | {
+    kind: "contents";
+    title?: string | undefined;
+  })[];
+  chapters: {
+    title: string;
+    html: string;
+    runningHead?: string | undefined;
+  }[];
+  rectoOpenings: boolean;
+  contents: {
+    pageNumbers: boolean;
+    depth: number;
+  };
+  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;
+  } | {
+    kind: "contents";
+    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;
+    title?: string | undefined;
+  };
+  rectoOpenings: boolean;
+  contents: {
+    pageNumbers: boolean;
+    depth: number;
+  };
+  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,131 @@
+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 BookContents = z.object({
+	kind: z.literal("contents"),
+	title: z.string().optional()
+});
+const BookFrontMatterEntry = z.union([BookSection, BookContents]);
+function isBookContents(entry) {
+	return "kind" in entry && entry.kind === "contents";
+}
+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(BookFrontMatterEntry).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"),
+		title: z.string().optional()
+	}).default({ placement: "book" }),
+	rectoOpenings: z.boolean().default(false),
+	contents: z.object({
+		pageNumbers: z.boolean().default(true),
+		depth: z.number().int().min(1).max(6).default(2)
+	}).default({
+		pageNumbers: true,
+		depth: 2
+	})
+});
+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",
+			title: book.endnotes.title ?? (hebrew ? "הערות" : "Notes")
+		}
+	};
+}).superRefine((book, ctx) => {
+	const contentsPositions = book.frontMatter.flatMap((entry, index) => isBookContents(entry) ? [index + 1] : []);
+	if (contentsPositions.length > 1) ctx.addIssue({
+		code: "custom",
+		path: ["frontMatter"],
+		message: `front-matter entries at positions ${contentsPositions[0]} and ${contentsPositions[1]} are both contents entries; one must go`
+	});
+	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, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookShape, Chapter, isBookContents, noteMarkerIssues };

package/dist/deck-from-slides.d.ts

@@ -0,0 +1,116 @@
+import { DeckInput } from "./deck.js";
+//#region src/deck-from-slides.d.ts
+type SlideInput = DeckInput['slides'][number];
+type SlideFields = Omit<SlideInput, 'content'>;
+type ShotContent = Extract<SlideInput['content'], {
+  kind: 'shot';
+}>;
+export type SlideRow = SlideFields & ({
+  kind: 'html';
+  html: string;
+} | ShotContent);
+export type DeckFromSlidesOptions = Omit<DeckInput, 'slides'> & {
+  omitNotes?: boolean;
+};
+export declare function deckFromSlides(rows: SlideRow[], options: DeckFromSlidesOptions): {
+  title: string;
+  size: {
+    width: number;
+    height: number;
+  };
+  scripts: "refuse" | "sandboxed";
+  slides: {
+    id: string;
+    content: {
+      kind: "html";
+      html: string;
+    } | {
+      kind: "url";
+      src: string;
+    } | {
+      kind: "shot";
+      src: string;
+      shot: {
+        key: string;
+        title: string;
+        description: string | null;
+        tags: string[];
+        file: string;
+        annotatedFile: string | null;
+        size: {
+          width: number;
+          height: number;
+        };
+        scale: number;
+        dir: "ltr" | "rtl";
+        annotations: {
+          ring: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+          } | null;
+          badge: {
+            center: {
+              x: number;
+              y: number;
+            };
+            number: number;
+          } | null;
+          arrow: {
+            head: {
+              x: number;
+              y: number;
+            };
+            tail: {
+              x: number;
+              y: number;
+            };
+            label: string | null;
+          } | null;
+        }[];
+        capturedAt: string;
+        meta: Record<string, unknown>;
+      };
+    } | {
+      kind: "shot-ref";
+      href: string;
+    } | {
+      kind: "image";
+      src: string;
+      alt: string;
+    };
+    notes?: string | undefined;
+    narration?: {
+      text: string;
+      words: {
+        text: string;
+        startMs: number;
+        endMs: number;
+      }[];
+      durationMs: number;
+      audio: string | null;
+      live: boolean;
+      cues: {
+        word: number;
+        annotation: number;
+        untilWord?: number | undefined;
+      }[];
+      lang?: string | undefined;
+      dir?: "ltr" | "rtl" | "auto" | undefined;
+      voice?: string | undefined;
+    } | undefined;
+    beforeMs?: number | undefined;
+    afterMs?: number | undefined;
+    holdMs?: number | undefined;
+  }[];
+  dir?: "ltr" | "rtl" | "auto" | undefined;
+  lang?: string | undefined;
+  transition?: {
+    kind: "none" | "fade" | "slide";
+    duration: number;
+  } | undefined;
+  playback?: "continuous" | "step" | undefined;
+  captions?: "on" | "off" | "viewer" | undefined;
+};
+//#endregion

package/dist/deck-from-slides.js

@@ -0,0 +1,36 @@
+import { Deck } from "./deck.js";
+//#region src/deck-from-slides.ts
+function deckFromSlides(rows, options) {
+	const { omitNotes = false, ...deckOptions } = options;
+	const slides = rows.map(({ kind, ...row }) => {
+		const { id, notes, narration, beforeMs, afterMs, holdMs } = row;
+		const common = {
+			id,
+			...!omitNotes && notes !== void 0 ? { notes } : {},
+			...narration !== void 0 ? { narration } : {},
+			...beforeMs !== void 0 ? { beforeMs } : {},
+			...afterMs !== void 0 ? { afterMs } : {},
+			...holdMs !== void 0 ? { holdMs } : {}
+		};
+		return kind === "html" ? {
+			...common,
+			content: {
+				kind,
+				html: row.html
+			}
+		} : {
+			...common,
+			content: {
+				kind,
+				src: row.src,
+				shot: row.shot
+			}
+		};
+	});
+	return Deck.parse({
+		...deckOptions,
+		slides
+	});
+}
+//#endregion
+export { deckFromSlides };