@segnavia/format 0.4.0 → 0.6.0

package/dist/index.js

@@ -2,18 +2,16 @@ import { Direction, firstStrongDirection, languageDirection, resolveDirection }
 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 { Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookShape, Chapter, isBookContents, noteMarkerIssues } from "./book.js";
+import { MAX_SLIDE_TIMING_MS } from "./timing.js";
 import { DEFAULT_TRANSITION_DURATION_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, Transition } from "./transition.js";
+import { Annotation, Box, Cue, DECK_SIZE, Deck, DeckShape, Manifest, Narration, Point, PublishedShot, SHOT_KEY, Shot, Size, Slide, SlideContent, Word, annotationCueIssues, exceedsLimits } from "./deck.js";
+import { Lexicon, PronunciationEntry, lexiconVersion } from "./lexicon.js";
+import { deckFromSlides } from "./deck-from-slides.js";
 import { fitPage, impose, mirrorPlacement, pagePlacementLayout } from "./imposition.js";
 import { shotsUsed } from "./shots-used.js";
 import { z } from "zod";
 //#region src/index.ts
-const Size = z.object({
-	width: z.number().int().positive(),
-	height: z.number().int().positive()
-});
 const Margin = z.object({
 	top: z.number().nonnegative().default(0),
 	right: z.number().nonnegative().default(0),
@@ -140,190 +138,6 @@ const Page = z.object({
 	lang: z.string().optional(),
 	print: Print.optional()
 });
-const Box = z.object({
-	x: z.number(),
-	y: z.number(),
-	width: z.number(),
-	height: z.number()
-});
-const Point = z.object({
-	x: z.number(),
-	y: z.number()
-});
-const Annotation = z.object({
-	ring: Box.nullable(),
-	badge: z.object({
-		center: Point,
-		number: z.number().int()
-	}).nullable(),
-	arrow: z.object({
-		head: Point,
-		tail: Point,
-		label: z.string().nullable()
-	}).nullable()
-});
-const SHOT_KEY = /^[a-z0-9]+(?:[.-][a-z0-9]+)*$/;
-const Shot = z.object({
-	key: z.string().regex(SHOT_KEY),
-	title: z.string(),
-	description: z.string().nullable().default(null),
-	tags: z.array(z.string()).default([]),
-	file: z.string(),
-	annotatedFile: z.string().nullable().default(null),
-	size: Size,
-	scale: z.number().positive(),
-	dir: z.enum(["ltr", "rtl"]).default("ltr"),
-	annotations: z.array(Annotation),
-	capturedAt: z.string(),
-	meta: z.record(z.string(), z.unknown()).default({})
-});
-const PublishedShot = z.object({
-	src: z.string(),
-	shot: Shot
-});
-const Word = z.object({
-	text: z.string(),
-	startMs: z.number().nonnegative(),
-	endMs: z.number().nonnegative()
-});
-const Cue = z.object({
-	word: z.number().int().nonnegative(),
-	annotation: z.number().int().nonnegative(),
-	untilWord: z.number().int().nonnegative().optional()
-});
-const Narration = z.object({
-	text: z.string(),
-	lang: z.string().optional(),
-	dir: Direction.optional(),
-	voice: z.string().optional(),
-	words: z.array(Word),
-	durationMs: z.number().nonnegative(),
-	audio: z.string().nullable(),
-	live: z.boolean().default(false),
-	cues: z.array(Cue).default([])
-});
-const SlideContent = z.discriminatedUnion("kind", [
-	z.object({
-		kind: z.literal("html"),
-		html: z.string()
-	}),
-	z.object({
-		kind: z.literal("url"),
-		src: z.string()
-	}),
-	z.object({
-		kind: z.literal("shot"),
-		src: z.string(),
-		shot: Shot
-	}),
-	z.object({
-		kind: z.literal("shot-ref"),
-		href: z.string()
-	}),
-	z.object({
-		kind: z.literal("image"),
-		src: z.string(),
-		alt: z.string()
-	})
-]);
-const Slide = z.object({
-	id: z.string(),
-	content: SlideContent,
-	notes: z.string().optional(),
-	narration: Narration.optional(),
-	beforeMs: SlideTiming.optional(),
-	afterMs: SlideTiming.optional(),
-	holdMs: SlideTiming.optional()
-});
-const DECK_SIZE = {
-	width: 1280,
-	height: 720
-};
-const DeckShape = z.object({
-	title: z.string(),
-	size: Size.default(DECK_SIZE),
-	scripts: Scripts.default("refuse"),
-	dir: Direction.optional(),
-	lang: z.string().optional(),
-	transition: Transition.optional(),
-	playback: z.enum(["step", "continuous"]).optional(),
-	captions: z.enum([
-		"on",
-		"off",
-		"viewer"
-	]).optional(),
-	slides: z.array(Slide).min(1)
-});
-function annotationCueIssues(narration, annotations) {
-	if (!narration) return [];
-	return narration.cues.filter((cue) => cue.annotation >= annotations).map((cue) => `a cue names annotation ${cue.annotation}, but the slide has ${annotations}`);
-}
-function cueIssues(slide) {
-	const narration = slide.narration;
-	if (!narration) return [];
-	const annotations = slide.content.kind === "shot" ? slide.content.shot.annotations.length : null;
-	const words = narration.live ? null : narration.words.length;
-	const issues = [];
-	for (const cue of narration.cues) {
-		for (const word of [cue.word, cue.untilWord]) if (word !== void 0 && words !== null && word >= words) issues.push(`a cue names word ${word}, but the narration has ${words} words`);
-		if (slide.content.kind !== "shot" && slide.content.kind !== "shot-ref") issues.push("a cue names an annotation, but only a shot carries annotations");
-	}
-	if (annotations !== null) issues.push(...annotationCueIssues(narration, annotations));
-	return issues;
-}
-const Deck = DeckShape.superRefine((deck, ctx) => {
-	deck.slides.forEach((slide, index) => {
-		for (const message of cueIssues(slide)) ctx.addIssue({
-			code: "custom",
-			path: [
-				"slides",
-				index,
-				"narration",
-				"cues"
-			],
-			message
-		});
-		for (const field of slideTimingIssues(slide)) {
-			const kind = field === "holdMs" ? "without" : "with";
-			ctx.addIssue({
-				code: "custom",
-				path: [
-					"slides",
-					index,
-					field
-				],
-				message: `${field} is allowed only ${kind} narration`
-			});
-		}
-	});
-	const ids = /* @__PURE__ */ new Set();
-	deck.slides.forEach((slide, index) => {
-		if (ids.has(slide.id)) ctx.addIssue({
-			code: "custom",
-			path: [
-				"slides",
-				index,
-				"id"
-			],
-			message: `slide id "${slide.id}" is used twice`
-		});
-		ids.add(slide.id);
-	});
-});
-const Manifest = z.object({
-	shots: z.record(z.string(), Shot),
-	updatedAt: z.string()
-});
-function exceedsLimits(deck, limits) {
-	const reasons = [];
-	const bytes = (text) => new TextEncoder().encode(text).length;
-	if (limits.maxSlides !== void 0 && deck.slides.length > limits.maxSlides) reasons.push(`the deck has ${deck.slides.length} slides; the limit is ${limits.maxSlides}`);
-	deck.slides.forEach((slide, index) => {
-		if (limits.maxSlideBytes !== void 0 && slide.content.kind === "html" && bytes(slide.content.html) > limits.maxSlideBytes) reasons.push(`slide ${index + 1} is ${bytes(slide.content.html)} bytes; the limit is ${limits.maxSlideBytes}`);
-		if (limits.maxNotesBytes !== void 0 && slide.notes && bytes(slide.notes) > limits.maxNotesBytes) reasons.push(`slide ${index + 1} has ${bytes(slide.notes)} bytes of notes; the limit is ${limits.maxNotesBytes}`);
-	});
-	return reasons;
-}
 function jsonSchemas() {
 	return {
 		book: z.toJSONSchema(BookShape, { io: "input" }),
@@ -336,4 +150,4 @@ function jsonSchemas() {
 	};
 }
 //#endregion
-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 };
+export { Annotation, Book, BookContents, BookFrontMatterEntry, 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, deckFromSlides, exceedsLimits, firstStrongDirection, fitPage, formatNumber, impose, isBookContents, jsonSchemas, languageDirection, lexiconVersion, mirrorPlacement, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, shotsUsed, toMillimeters };

package/dist/shots-used.d.ts

@@ -1,4 +1,5 @@
-import { Deck } from "./index.js";
+import { Deck } from "./deck.js";
+import "./index.js";
 //#region src/shots-used.d.ts
 export interface ShotUse {
   slide: string;

package/package.json

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