@segnavia/format 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 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 { Imposed, MillimeterEdges, PageFit, PagePlacementKind, PagePlacementLayout, Placement, fitPage, impose, mirrorPlacement, pagePlacementLayout } from "./imposition.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";
 import { z } from "zod";
 //#region src/index.d.ts
 export declare const Size: z.ZodObject<{
@@ -526,6 +529,9 @@ export declare const Slide: z.ZodObject<{
       untilWord: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>>;
   }, z.core.$strip>>;
+  beforeMs: z.ZodOptional<z.ZodNumber>;
+  afterMs: z.ZodOptional<z.ZodNumber>;
+  holdMs: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type Slide = z.infer<typeof Slide>;
 export declare const DECK_SIZE: {
@@ -549,6 +555,23 @@ export declare const Deck: z.ZodObject<{
     auto: "auto";
   }>>;
   lang: z.ZodOptional<z.ZodString>;
+  transition: z.ZodOptional<z.ZodObject<{
+    kind: z.ZodEnum<{
+      none: "none";
+      fade: "fade";
+      slide: "slide";
+    }>;
+    duration: z.ZodDefault<z.ZodNumber>;
+  }, z.core.$strip>>;
+  playback: z.ZodOptional<z.ZodEnum<{
+    step: "step";
+    continuous: "continuous";
+  }>>;
+  captions: z.ZodOptional<z.ZodEnum<{
+    on: "on";
+    off: "off";
+    viewer: "viewer";
+  }>>;
   slides: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     content: z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -637,6 +660,9 @@ export declare const Deck: z.ZodObject<{
         untilWord: z.ZodOptional<z.ZodNumber>;
       }, z.core.$strip>>>;
     }, z.core.$strip>>;
+    beforeMs: z.ZodOptional<z.ZodNumber>;
+    afterMs: z.ZodOptional<z.ZodNumber>;
+    holdMs: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
 export type Deck = z.infer<typeof Deck>;
@@ -696,12 +722,6 @@ export interface DeckLimits {
   maxNotesBytes?: number;
 }
 export declare function exceedsLimits(deck: Deck, limits: DeckLimits): string[];
-export interface ShotUse {
-  slide: string;
-  key?: string;
-  href?: string;
-}
-export declare function shotsUsed(deck: Deck): ShotUse[];
 export declare function jsonSchemas(): {
   page: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
     html: z.ZodString;
@@ -836,6 +856,23 @@ export declare function jsonSchemas(): {
       auto: "auto";
     }>>;
     lang: z.ZodOptional<z.ZodString>;
+    transition: z.ZodOptional<z.ZodObject<{
+      kind: z.ZodEnum<{
+        none: "none";
+        fade: "fade";
+        slide: "slide";
+      }>;
+      duration: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    playback: z.ZodOptional<z.ZodEnum<{
+      step: "step";
+      continuous: "continuous";
+    }>>;
+    captions: z.ZodOptional<z.ZodEnum<{
+      on: "on";
+      off: "off";
+      viewer: "viewer";
+    }>>;
     slides: z.ZodArray<z.ZodObject<{
       id: z.ZodString;
       content: z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -924,6 +961,9 @@ export declare function jsonSchemas(): {
           untilWord: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strip>>>;
       }, z.core.$strip>>;
+      beforeMs: z.ZodOptional<z.ZodNumber>;
+      afterMs: z.ZodOptional<z.ZodNumber>;
+      holdMs: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
   manifest: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
@@ -1024,4 +1064,4 @@ export declare function jsonSchemas(): {
   }, z.core.$strip>>;
 };
 //#endregion
-export { type Imposed, MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, type MillimeterEdges, PAPER_MM, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, type PaperBox, type Placement, type TextDirection, firstStrongDirection, fitPage, impose, languageDirection, mirrorPlacement, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, toMillimeters };
+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 };

package/dist/index.js

@@ -1,6 +1,9 @@
 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 { 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";
 //#region src/index.ts
 const Size = z.object({
@@ -246,7 +249,10 @@ const Slide = z.object({
 	id: z.string(),
 	content: SlideContent,
 	notes: z.string().optional(),
-	narration: Narration.optional()
+	narration: Narration.optional(),
+	beforeMs: SlideTiming.optional(),
+	afterMs: SlideTiming.optional(),
+	holdMs: SlideTiming.optional()
 });
 const DECK_SIZE = {
 	width: 1280,
@@ -258,6 +264,13 @@ const DeckShape = z.object({
 	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) {
@@ -289,6 +302,18 @@ const Deck = DeckShape.superRefine((deck, ctx) => {
 			],
 			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) => {
@@ -318,19 +343,6 @@ function exceedsLimits(deck, limits) {
 	});
 	return reasons;
 }
-function shotsUsed(deck) {
-	return deck.slides.flatMap((slide) => {
-		if (slide.content.kind === "shot") return [{
-			slide: slide.id,
-			key: slide.content.shot.key
-		}];
-		if (slide.content.kind === "shot-ref") return [{
-			slide: slide.id,
-			href: slide.content.href
-		}];
-		return [];
-	});
-}
 function jsonSchemas() {
 	return {
 		page: z.toJSONSchema(Page, { io: "input" }),
@@ -341,4 +353,4 @@ function jsonSchemas() {
 	};
 }
 //#endregion
-export { Annotation, Box, Cue, DECK_SIZE, Deck, Direction, Imposition, MARK_GAP_MM, MARK_LENGTH_MM, MAX_IMPOSITION_CELLS, 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, Word, annotationCueIssues, exceedsLimits, firstStrongDirection, fitPage, impose, jsonSchemas, languageDirection, mirrorPlacement, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, sheetMm, shotsUsed, toMillimeters };
+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 };

package/dist/shots-used.d.ts

@@ -0,0 +1,9 @@
+import { Deck } from "./index.js";
+//#region src/shots-used.d.ts
+export interface ShotUse {
+  slide: string;
+  key?: string;
+  href?: string;
+}
+export declare function shotsUsed(deck: Deck): ShotUse[];
+//#endregion

package/dist/shots-used.js

@@ -0,0 +1,16 @@
+//#region src/shots-used.ts
+function shotsUsed(deck) {
+	return deck.slides.flatMap((slide) => {
+		if (slide.content.kind === "shot") return [{
+			slide: slide.id,
+			key: slide.content.shot.key
+		}];
+		if (slide.content.kind === "shot-ref") return [{
+			slide: slide.id,
+			href: slide.content.href
+		}];
+		return [];
+	});
+}
+//#endregion
+export { shotsUsed };

package/dist/timing.d.ts

@@ -0,0 +1,4 @@
+import { z } from "zod";
+//#region src/timing.d.ts
+export declare const MAX_SLIDE_TIMING_MS = 600000;
+//#endregion

package/dist/timing.js

@@ -0,0 +1,10 @@
+import { z } from "zod";
+//#region src/timing.ts
+const MAX_SLIDE_TIMING_MS = 6e5;
+const SlideTiming = z.number().finite().min(0).max(MAX_SLIDE_TIMING_MS);
+function slideTimingIssues(slide) {
+	if (slide.narration) return slide.holdMs === void 0 ? [] : ["holdMs"];
+	return ["beforeMs", "afterMs"].filter((field) => slide[field] !== void 0);
+}
+//#endregion
+export { MAX_SLIDE_TIMING_MS, SlideTiming, slideTimingIssues };

package/dist/transition.d.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+//#region src/transition.d.ts
+export declare const MIN_TRANSITION_DURATION_MS = 0;
+export declare const MAX_TRANSITION_DURATION_MS = 2000;
+export declare const DEFAULT_TRANSITION_DURATION_MS = 300;
+export declare const Transition: z.ZodObject<{
+  kind: z.ZodEnum<{
+    none: "none";
+    fade: "fade";
+    slide: "slide";
+  }>;
+  duration: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type Transition = z.infer<typeof Transition>;
+export type TransitionInput = z.input<typeof Transition>;
+//#endregion

package/dist/transition.js

@@ -0,0 +1,15 @@
+import { z } from "zod";
+//#region src/transition.ts
+const MIN_TRANSITION_DURATION_MS = 0;
+const MAX_TRANSITION_DURATION_MS = 2e3;
+const DEFAULT_TRANSITION_DURATION_MS = 300;
+const Transition = z.object({
+	kind: z.enum([
+		"none",
+		"fade",
+		"slide"
+	]),
+	duration: z.number().int().min(0).max(MAX_TRANSITION_DURATION_MS).default(300)
+});
+//#endregion
+export { DEFAULT_TRANSITION_DURATION_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSITION_DURATION_MS, Transition };

package/package.json

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