@segnavia/format 0.4.0 → 0.6.0

package/dist/book.d.ts

@@ -11,6 +11,21 @@ export declare const BookSection: z.ZodObject<{
   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;
@@ -90,11 +105,14 @@ export declare const Book: z.ZodPipe<z.ZodObject<{
     auto: "auto";
   }>>;
   lang: z.ZodOptional<z.ZodString>;
-  frontMatter: z.ZodDefault<z.ZodArray<z.ZodObject<{
+  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.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;
@@ -137,10 +155,12 @@ export declare const Book: z.ZodPipe<z.ZodObject<{
       chapter: "chapter";
       book: "book";
     }>>;
+    title: z.ZodOptional<z.ZodString>;
   }, z.core.$strip>>;
-  rightHandOpenings: z.ZodDefault<z.ZodBoolean>;
+  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: {
@@ -153,24 +173,29 @@ export declare const Book: z.ZodPipe<z.ZodObject<{
   };
   endnotes: {
     marker: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | "symbols";
+    title: string;
     placement: "chapter" | "book";
   };
   title: string;
   mode: "continuous" | "paginated";
   scripts: "refuse" | "sandboxed";
-  frontMatter: {
+  frontMatter: ({
     html: string;
     contents: boolean;
     title?: string | undefined;
-  }[];
+  } | {
+    kind: "contents";
+    title?: string | undefined;
+  })[];
   chapters: {
     title: string;
     html: string;
     runningHead?: string | undefined;
   }[];
-  rightHandOpenings: boolean;
+  rectoOpenings: boolean;
   contents: {
     pageNumbers: boolean;
+    depth: number;
   };
   page?: {
     paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | {
@@ -192,11 +217,14 @@ export declare const Book: z.ZodPipe<z.ZodObject<{
   title: string;
   mode: "continuous" | "paginated";
   scripts: "refuse" | "sandboxed";
-  frontMatter: {
+  frontMatter: ({
     html: string;
     contents: boolean;
     title?: string | undefined;
-  }[];
+  } | {
+    kind: "contents";
+    title?: string | undefined;
+  })[];
   chapters: {
     title: string;
     html: string;
@@ -213,10 +241,12 @@ export declare const Book: z.ZodPipe<z.ZodObject<{
   endnotes: {
     placement: "chapter" | "book";
     marker?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | "symbols" | undefined;
+    title?: string | undefined;
   };
-  rightHandOpenings: boolean;
+  rectoOpenings: boolean;
   contents: {
     pageNumbers: boolean;
+    depth: number;
   };
   page?: {
     paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | {

package/dist/book.js

@@ -10,6 +10,14 @@ const BookSection = z.object({
 	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(),
@@ -32,7 +40,7 @@ const BookShape = z.object({
 	scripts: Scripts.default("refuse"),
 	dir: Direction.optional(),
 	lang: z.string().optional(),
-	frontMatter: z.array(BookSection).default([]),
+	frontMatter: z.array(BookFrontMatterEntry).default([]),
 	chapters: z.array(Chapter).min(1),
 	numbering: z.object({
 		frontMatter: NumberSystem.optional(),
@@ -44,10 +52,17 @@ const BookShape = z.object({
 	}).default({ restart: "chapter" }),
 	endnotes: z.object({
 		marker: NoteMarker.optional(),
-		placement: z.enum(["book", "chapter"]).default("book")
+		placement: z.enum(["book", "chapter"]).default("book"),
+		title: z.string().optional()
 	}).default({ placement: "book" }),
-	rightHandOpenings: z.boolean().default(false),
-	contents: z.object({ pageNumbers: z.boolean().default(true) }).default({ pageNumbers: true })
+	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();
@@ -67,10 +82,17 @@ const Book = BookShape.transform((book) => {
 		},
 		endnotes: {
 			...book.endnotes,
-			marker: book.endnotes.marker ?? "arabic"
+			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"],
@@ -106,4 +128,4 @@ function noteMarkerIssues(book, used) {
 	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 };
+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 };