@segnavia/format 0.38.0 → 0.40.0

package/dist/cover.d.ts

@@ -0,0 +1,500 @@
+import { Page, PageBody } from "./page.js";
+import { Motif } from "./motif.js";
+import { z } from "zod";
+//#region src/cover.d.ts
+export declare const COVER_SHEET: {
+  readonly width: 160;
+  readonly height: 100;
+};
+export declare const COVER_DRAWING_VERSION = 1;
+export declare const Cover: z.ZodPipe<z.ZodObject<{
+  page: z.ZodPipe<z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+      html: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+      markdown: z.ZodString;
+    }, z.core.$strict>]>>;
+    html: z.ZodOptional<z.ZodString>;
+    markdown: z.ZodOptional<z.ZodString>;
+    size: z.ZodDefault<z.ZodUnion<readonly [z.ZodPipe<z.ZodLiteral<"fluid">, z.ZodTransform<{
+      readonly width: "full";
+      readonly height: "auto";
+    }, "fluid">>, z.ZodObject<{
+      width: z.ZodNumber;
+      height: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+      width: z.ZodUnion<readonly [z.ZodLiteral<"full">, z.ZodLiteral<"standard">, z.ZodLiteral<"wide">, z.ZodNumber]>;
+      height: z.ZodLiteral<"auto">;
+    }, z.core.$strip>]>>;
+    scripts: z.ZodDefault<z.ZodEnum<{
+      refuse: "refuse";
+      sandboxed: "sandboxed";
+    }>>;
+    dir: z.ZodOptional<z.ZodEnum<{
+      auto: "auto";
+      ltr: "ltr";
+      rtl: "rtl";
+    }>>;
+    lang: z.ZodOptional<z.ZodString>;
+    print: z.ZodOptional<z.ZodObject<{
+      paper: z.ZodUnion<readonly [z.ZodEnum<{
+        letter: "letter";
+        legal: "legal";
+        tabloid: "tabloid";
+        a3: "a3";
+        a4: "a4";
+        a5: "a5";
+        "business-card-us": "business-card-us";
+        "business-card-eu": "business-card-eu";
+        "business-card-square-us": "business-card-square-us";
+        "business-card-slim-us": "business-card-slim-us";
+        "postcard-4x6": "postcard-4x6";
+        "postcard-5x7": "postcard-5x7";
+        "postcard-6x9": "postcard-6x9";
+        "postcard-6x11": "postcard-6x11";
+        "card-square-4in": "card-square-4in";
+        "half-letter": "half-letter";
+        a6: "a6";
+        dl: "dl";
+        "rack-card-4x9": "rack-card-4x9";
+        "rack-card-3.5x8.5": "rack-card-3.5x8.5";
+        "poster-12x18": "poster-12x18";
+        "poster-16x20": "poster-16x20";
+        "poster-18x24": "poster-18x24";
+        "poster-24x36": "poster-24x36";
+        a2: "a2";
+        a1: "a1";
+        a0: "a0";
+      }>, z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        unit: z.ZodEnum<{
+          in: "in";
+          mm: "mm";
+          pt: "pt";
+        }>;
+      }, z.core.$strip>]>;
+      orientation: z.ZodDefault<z.ZodEnum<{
+        portrait: "portrait";
+        landscape: "landscape";
+      }>>;
+      margin: z.ZodOptional<z.ZodObject<{
+        top: z.ZodDefault<z.ZodNumber>;
+        right: z.ZodDefault<z.ZodNumber>;
+        bottom: z.ZodDefault<z.ZodNumber>;
+        left: z.ZodDefault<z.ZodNumber>;
+      }, z.core.$strip>>;
+      bleed: z.ZodDefault<z.ZodNumber>;
+      safe: z.ZodDefault<z.ZodNumber>;
+      marks: z.ZodDefault<z.ZodBoolean>;
+      markColor: z.ZodDefault<z.ZodEnum<{
+        black: "black";
+        registration: "registration";
+      }>>;
+    }, z.core.$strip>>;
+    printedPages: z.ZodOptional<z.ZodObject<{
+      parents: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        basedOn: z.ZodOptional<z.ZodString>;
+        margin: z.ZodOptional<z.ZodObject<{
+          top: z.ZodNumber;
+          bottom: z.ZodNumber;
+          inner: z.ZodNumber;
+          outer: z.ZodNumber;
+        }, z.core.$strip>>;
+        head: z.ZodOptional<z.ZodString>;
+        foot: z.ZodOptional<z.ZodString>;
+      }, z.core.$strip>>;
+      rules: z.ZodPipe<z.ZodObject<{
+        every: z.ZodString;
+        first: z.ZodOptional<z.ZodString>;
+        recto: z.ZodOptional<z.ZodString>;
+        verso: z.ZodOptional<z.ZodString>;
+        last: z.ZodOptional<z.ZodString>;
+      }, z.core.$loose>, z.ZodTransform<{
+        last?: string | undefined;
+        verso?: string | undefined;
+        recto?: string | undefined;
+        first?: string | undefined;
+        every: string;
+      }, {
+        [x: string]: unknown;
+        every: string;
+        first?: string | undefined;
+        recto?: string | undefined;
+        verso?: string | undefined;
+        last?: string | undefined;
+      }>>;
+      numbering: z.ZodOptional<z.ZodEnum<{
+        arabic: "arabic";
+        "roman-lower": "roman-lower";
+        "roman-upper": "roman-upper";
+        hebrew: "hebrew";
+      }>>;
+    }, z.core.$strip>>;
+    slots: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodObject<{
+      key: z.ZodString;
+      label: z.ZodString;
+      type: z.ZodEnum<{
+        text: "text";
+        image: "image";
+        phone: "phone";
+        email: "email";
+        link: "link";
+        qr: "qr";
+      }>;
+      required: z.ZodDefault<z.ZodBoolean>;
+      placeholder: z.ZodOptional<z.ZodString>;
+      overflow: z.ZodDefault<z.ZodEnum<{
+        refuse: "refuse";
+        shrink: "shrink";
+        truncate: "truncate";
+        wrap: "wrap";
+      }>>;
+      minSize: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodTransform<{
+      key: string;
+      label: string;
+      type: "text" | "image" | "phone" | "email" | "link" | "qr";
+      required: boolean;
+      overflow: "refuse" | "shrink" | "truncate" | "wrap";
+      placeholder?: string | undefined;
+      minSize?: number | undefined;
+    }, {
+      key: string;
+      label: string;
+      type: "text" | "image" | "phone" | "email" | "link" | "qr";
+      required: boolean;
+      overflow: "refuse" | "shrink" | "truncate" | "wrap";
+      placeholder?: string | undefined;
+      minSize?: number | undefined;
+    }>>>>;
+    fonts: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+      app: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      local: z.ZodString;
+      fallback: z.ZodString;
+    }, z.core.$strip>]>>>;
+  }, z.core.$strip>, z.ZodTransform<{
+    body: PageBody;
+    size: {
+      width: number;
+      height: number;
+    } | {
+      readonly width: "full";
+      readonly height: "auto";
+    } | {
+      width: number | "full" | "standard" | "wide";
+      height: "auto";
+    };
+    scripts: "refuse" | "sandboxed";
+    id?: string | undefined;
+    dir?: "auto" | "ltr" | "rtl" | undefined;
+    lang?: string | undefined;
+    print?: {
+      paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | "business-card-us" | "business-card-eu" | "business-card-square-us" | "business-card-slim-us" | "postcard-4x6" | "postcard-5x7" | "postcard-6x9" | "postcard-6x11" | "card-square-4in" | "half-letter" | "a6" | "dl" | "rack-card-4x9" | "rack-card-3.5x8.5" | "poster-12x18" | "poster-16x20" | "poster-18x24" | "poster-24x36" | "a2" | "a1" | "a0" | {
+        width: number;
+        height: number;
+        unit: "in" | "mm" | "pt";
+      };
+      orientation: "portrait" | "landscape";
+      bleed: number;
+      safe: number;
+      marks: boolean;
+      markColor: "black" | "registration";
+      margin?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+      } | undefined;
+    } | undefined;
+    printedPages?: {
+      parents: {
+        name: string;
+        basedOn?: string | undefined;
+        margin?: {
+          top: number;
+          bottom: number;
+          inner: number;
+          outer: number;
+        } | undefined;
+        head?: string | undefined;
+        foot?: string | undefined;
+      }[];
+      rules: {
+        last?: string | undefined;
+        verso?: string | undefined;
+        recto?: string | undefined;
+        first?: string | undefined;
+        every: string;
+      };
+      numbering?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | undefined;
+    } | undefined;
+    slots?: {
+      key: string;
+      label: string;
+      type: "text" | "image" | "phone" | "email" | "link" | "qr";
+      required: boolean;
+      overflow: "refuse" | "shrink" | "truncate" | "wrap";
+      placeholder?: string | undefined;
+      minSize?: number | undefined;
+    }[] | undefined;
+    fonts?: ({
+      app: string;
+    } | {
+      local: string;
+      fallback: string;
+    })[] | undefined;
+  }, {
+    size: {
+      width: number;
+      height: number;
+    } | {
+      readonly width: "full";
+      readonly height: "auto";
+    } | {
+      width: number | "full" | "standard" | "wide";
+      height: "auto";
+    };
+    scripts: "refuse" | "sandboxed";
+    id?: string | undefined;
+    body?: {
+      html: string;
+    } | {
+      markdown: string;
+    } | undefined;
+    html?: string | undefined;
+    markdown?: string | undefined;
+    dir?: "auto" | "ltr" | "rtl" | undefined;
+    lang?: string | undefined;
+    print?: {
+      paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | "business-card-us" | "business-card-eu" | "business-card-square-us" | "business-card-slim-us" | "postcard-4x6" | "postcard-5x7" | "postcard-6x9" | "postcard-6x11" | "card-square-4in" | "half-letter" | "a6" | "dl" | "rack-card-4x9" | "rack-card-3.5x8.5" | "poster-12x18" | "poster-16x20" | "poster-18x24" | "poster-24x36" | "a2" | "a1" | "a0" | {
+        width: number;
+        height: number;
+        unit: "in" | "mm" | "pt";
+      };
+      orientation: "portrait" | "landscape";
+      bleed: number;
+      safe: number;
+      marks: boolean;
+      markColor: "black" | "registration";
+      margin?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+      } | undefined;
+    } | undefined;
+    printedPages?: {
+      parents: {
+        name: string;
+        basedOn?: string | undefined;
+        margin?: {
+          top: number;
+          bottom: number;
+          inner: number;
+          outer: number;
+        } | undefined;
+        head?: string | undefined;
+        foot?: string | undefined;
+      }[];
+      rules: {
+        last?: string | undefined;
+        verso?: string | undefined;
+        recto?: string | undefined;
+        first?: string | undefined;
+        every: string;
+      };
+      numbering?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | undefined;
+    } | undefined;
+    slots?: {
+      key: string;
+      label: string;
+      type: "text" | "image" | "phone" | "email" | "link" | "qr";
+      required: boolean;
+      overflow: "refuse" | "shrink" | "truncate" | "wrap";
+      placeholder?: string | undefined;
+      minSize?: number | undefined;
+    }[] | undefined;
+    fonts?: ({
+      app: string;
+    } | {
+      local: string;
+      fallback: string;
+    })[] | undefined;
+  }>>;
+  id: z.ZodOptional<z.ZodString>;
+  name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodTransform<{
+  page: {
+    print: {
+      paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | "business-card-us" | "business-card-eu" | "business-card-square-us" | "business-card-slim-us" | "postcard-4x6" | "postcard-5x7" | "postcard-6x9" | "postcard-6x11" | "card-square-4in" | "half-letter" | "a6" | "dl" | "rack-card-4x9" | "rack-card-3.5x8.5" | "poster-12x18" | "poster-16x20" | "poster-18x24" | "poster-24x36" | "a2" | "a1" | "a0" | {
+        width: number;
+        height: number;
+        unit: "in" | "mm" | "pt";
+      };
+      orientation: "portrait" | "landscape";
+      bleed: number;
+      safe: number;
+      marks: boolean;
+      markColor: "black" | "registration";
+      margin?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+      } | undefined;
+    };
+    body: PageBody;
+    size: {
+      width: number;
+      height: number;
+    } | {
+      readonly width: "full";
+      readonly height: "auto";
+    } | {
+      width: number | "full" | "standard" | "wide";
+      height: "auto";
+    };
+    scripts: "refuse" | "sandboxed";
+    id?: string | undefined;
+    dir?: "auto" | "ltr" | "rtl" | undefined;
+    lang?: string | undefined;
+    printedPages?: {
+      parents: {
+        name: string;
+        basedOn?: string | undefined;
+        margin?: {
+          top: number;
+          bottom: number;
+          inner: number;
+          outer: number;
+        } | undefined;
+        head?: string | undefined;
+        foot?: string | undefined;
+      }[];
+      rules: {
+        last?: string | undefined;
+        verso?: string | undefined;
+        recto?: string | undefined;
+        first?: string | undefined;
+        every: string;
+      };
+      numbering?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | undefined;
+    } | undefined;
+    slots?: {
+      key: string;
+      label: string;
+      type: "text" | "image" | "phone" | "email" | "link" | "qr";
+      required: boolean;
+      overflow: "refuse" | "shrink" | "truncate" | "wrap";
+      placeholder?: string | undefined;
+      minSize?: number | undefined;
+    }[] | undefined;
+    fonts?: ({
+      app: string;
+    } | {
+      local: string;
+      fallback: string;
+    })[] | undefined;
+  };
+  id?: string | undefined;
+  name?: string | undefined;
+}, {
+  page: {
+    body: PageBody;
+    size: {
+      width: number;
+      height: number;
+    } | {
+      readonly width: "full";
+      readonly height: "auto";
+    } | {
+      width: number | "full" | "standard" | "wide";
+      height: "auto";
+    };
+    scripts: "refuse" | "sandboxed";
+    id?: string | undefined;
+    dir?: "auto" | "ltr" | "rtl" | undefined;
+    lang?: string | undefined;
+    print?: {
+      paper: "letter" | "legal" | "tabloid" | "a3" | "a4" | "a5" | "business-card-us" | "business-card-eu" | "business-card-square-us" | "business-card-slim-us" | "postcard-4x6" | "postcard-5x7" | "postcard-6x9" | "postcard-6x11" | "card-square-4in" | "half-letter" | "a6" | "dl" | "rack-card-4x9" | "rack-card-3.5x8.5" | "poster-12x18" | "poster-16x20" | "poster-18x24" | "poster-24x36" | "a2" | "a1" | "a0" | {
+        width: number;
+        height: number;
+        unit: "in" | "mm" | "pt";
+      };
+      orientation: "portrait" | "landscape";
+      bleed: number;
+      safe: number;
+      marks: boolean;
+      markColor: "black" | "registration";
+      margin?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+      } | undefined;
+    } | undefined;
+    printedPages?: {
+      parents: {
+        name: string;
+        basedOn?: string | undefined;
+        margin?: {
+          top: number;
+          bottom: number;
+          inner: number;
+          outer: number;
+        } | undefined;
+        head?: string | undefined;
+        foot?: string | undefined;
+      }[];
+      rules: {
+        last?: string | undefined;
+        verso?: string | undefined;
+        recto?: string | undefined;
+        first?: string | undefined;
+        every: string;
+      };
+      numbering?: "arabic" | "roman-lower" | "roman-upper" | "hebrew" | undefined;
+    } | undefined;
+    slots?: {
+      key: string;
+      label: string;
+      type: "text" | "image" | "phone" | "email" | "link" | "qr";
+      required: boolean;
+      overflow: "refuse" | "shrink" | "truncate" | "wrap";
+      placeholder?: string | undefined;
+      minSize?: number | undefined;
+    }[] | undefined;
+    fonts?: ({
+      app: string;
+    } | {
+      local: string;
+      fallback: string;
+    })[] | undefined;
+  };
+  id?: string | undefined;
+  name?: string | undefined;
+}>>;
+export type Cover = z.infer<typeof Cover>;
+export type CoverInput = z.input<typeof Cover>;
+export interface CoverDigestMaterial {
+  page: Page;
+  sheet: {
+    width: number;
+    height: number;
+  };
+  drawingVersion: number;
+  stamp: string;
+  fonts: readonly string[];
+  motifs: readonly Motif[];
+}
+export declare function digestCoverMaterial(material: CoverDigestMaterial): Promise<string>;
+export declare function coverDigest(cover: Cover, inputs: {
+  stamp: string;
+  fonts?: readonly string[];
+  motifs?: readonly Motif[];
+}): Promise<string>;
+//#endregion

package/dist/cover.js

@@ -0,0 +1,100 @@
+import { sheetMm } from "./paper.js";
+import { Print } from "./print.js";
+import { Page } from "./page.js";
+import { z } from "zod";
+//#region src/cover.ts
+const COVER_SHEET = {
+	width: 160,
+	height: 100
+};
+const COVER_DRAWING_VERSION = 1;
+const COVER_PRINT = {
+	paper: {
+		width: COVER_SHEET.width,
+		height: COVER_SHEET.height,
+		unit: "mm"
+	},
+	orientation: "landscape"
+};
+const Cover = z.object({
+	page: Page,
+	id: z.string().optional(),
+	name: z.string().optional()
+}).transform((cover) => ({
+	...cover,
+	page: {
+		...cover.page,
+		print: cover.page.print ?? Print.parse(COVER_PRINT)
+	}
+})).superRefine((cover, ctx) => {
+	const print = cover.page.print;
+	if (print.bleed !== 0) ctx.addIssue({
+		code: "custom",
+		path: [
+			"page",
+			"print",
+			"bleed"
+		],
+		message: "page.print.bleed must be 0; remove bleed from the cover"
+	});
+	if (print.safe !== 0) ctx.addIssue({
+		code: "custom",
+		path: [
+			"page",
+			"print",
+			"safe"
+		],
+		message: "page.print.safe must be 0; remove the safe area from the cover"
+	});
+	if (print.marks) ctx.addIssue({
+		code: "custom",
+		path: [
+			"page",
+			"print",
+			"marks"
+		],
+		message: "page.print.marks must be false; remove marks from the cover"
+	});
+	if (cover.page.scripts !== "refuse") ctx.addIssue({
+		code: "custom",
+		path: ["page", "scripts"],
+		message: "page.scripts must be 'refuse'; refuse scripts on the cover"
+	});
+});
+function canonicalValue(value) {
+	if (Array.isArray(value)) return value.filter((item) => item !== void 0).map(canonicalValue);
+	if (value === null || typeof value !== "object") return value;
+	return Object.fromEntries(Object.entries(value).filter(([, entry]) => entry !== void 0).sort(([left], [right]) => compareText(left, right)).map(([key, entry]) => [key, canonicalValue(entry)]));
+}
+function compareText(left, right) {
+	return left < right ? -1 : left > right ? 1 : 0;
+}
+function canonicalJson(value) {
+	return JSON.stringify(canonicalValue(value));
+}
+function orderedMotifs(motifs) {
+	return [...motifs].sort((left, right) => compareText(left.key, right.key) || compareText(left.revision, right.revision) || compareText(canonicalJson(left), canonicalJson(right)));
+}
+async function digestCoverMaterial(material) {
+	const { id: _pageId, ...page } = material.page;
+	const canonical = canonicalJson({
+		...material,
+		page,
+		fonts: [...material.fonts].sort(),
+		motifs: orderedMotifs(material.motifs)
+	});
+	const digest = await globalThis.crypto.subtle.digest("SHA-256", new TextEncoder().encode(canonical));
+	return [...new Uint8Array(digest)].map((byte) => byte.toString(16).padStart(2, "0")).join("");
+}
+function coverDigest(cover, inputs) {
+	return digestCoverMaterial({
+		page: cover.page,
+		sheet: sheetMm(cover.page.print),
+		drawingVersion: 1,
+		stamp: inputs.stamp,
+		fonts: inputs.fonts ?? [],
+		motifs: inputs.motifs ?? []
+	});
+}
+//#endregion
+export { COVER_DRAWING_VERSION, COVER_SHEET, Cover, coverDigest, digestCoverMaterial };

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

@@ -88,6 +88,25 @@ export declare function deckFromSlides(rows: SlideRow[], options: DeckFromSlides
       alt: string;
       fit?: "width" | "contain" | "cover" | "focus" | undefined;
       frame?: boolean | undefined;
+    } | {
+      media: {
+        kind: "deck" | "page" | "paper" | "book" | "media" | "shot";
+        address: string;
+        page?: string | number | undefined;
+        box?: "media" | "crop" | "trim" | "bleed" | "art" | undefined;
+        crop?: {
+          top?: string | undefined;
+          right?: string | undefined;
+          bottom?: string | undefined;
+          left?: string | undefined;
+        } | undefined;
+        fit?: "width" | "contain" | "cover" | "focus" | undefined;
+        alt?: {
+          text: string;
+          lang?: string | undefined;
+          dir?: "auto" | "ltr" | "rtl" | undefined;
+        } | undefined;
+      };
     };
     notes?: string | undefined;
     narration?: {
@@ -106,7 +125,7 @@ export declare function deckFromSlides(rows: SlideRow[], options: DeckFromSlides
         untilWord?: number | undefined;
       }[];
       lang?: string | undefined;
-      dir?: "ltr" | "rtl" | "auto" | undefined;
+      dir?: "auto" | "ltr" | "rtl" | undefined;
       voice?: string | undefined;
     } | undefined;
     beforeMs?: number | undefined;
@@ -114,18 +133,18 @@ export declare function deckFromSlides(rows: SlideRow[], options: DeckFromSlides
     holdMs?: number | undefined;
     printAtMs?: number | undefined;
   }[];
-  dir?: "ltr" | "rtl" | "auto" | undefined;
+  dir?: "auto" | "ltr" | "rtl" | undefined;
   lang?: string | undefined;
   transition?: {
     kind: "none" | "fade" | "slide";
     duration: number;
   } | undefined;
-  playback?: "continuous" | "segmented" | undefined;
+  playback?: "segmented" | "continuous" | undefined;
   captions?: "on" | "off" | "viewer" | undefined;
   slots?: {
     key: string;
     label: string;
-    type: "text" | "phone" | "email" | "link" | "qr" | "image";
+    type: "text" | "image" | "phone" | "email" | "link" | "qr";
     required: boolean;
     overflow: "refuse" | "shrink" | "truncate" | "wrap";
     placeholder?: string | undefined;