@segnavia/format 0.19.0 → 0.21.0

package/dist/book.js

@@ -1,7 +1,7 @@
 import { Direction } from "./direction.js";
 import { Scripts } from "./scripts.js";
 import { NoteMarker, NumberSystem } from "./numbering.js";
-import { Paper, sheetMm } from "./paper.js";
+import { Orientation, Paper, sheetMm } from "./paper.js";
 import { z } from "zod";
 //#region src/book.ts
 const BookMode = z.enum(["continuous", "paginated"]);
@@ -25,7 +25,7 @@ const Chapter = z.object({
 });
 const BookPage = z.object({
 	paper: Paper,
-	orientation: z.enum(["portrait", "landscape"]).default("portrait"),
+	orientation: Orientation.default("portrait"),
 	margin: z.object({
 		top: z.number().nonnegative(),
 		bottom: z.number().nonnegative(),

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import { assignMembership, fitSection, fitTouchedSections, makeRoom, settleBoard
 import { Book, BookContents, BookFrontMatterEntry, BookInput, BookMode, BookPage, BookSection, BookView, BookViewInput, Chapter, isBookContents, isHebrew, noteMarkerIssues } from "./book.js";
 import { DeckFromSlidesOptions, SlideRow, deckFromSlides } from "./deck-from-slides.js";
 import { Direction, TextDirection, firstStrongDirection, languageDirection, resolveDirection } from "./direction.js";
-import { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, PAPER_MM, PX_PER_MM, Paper, PaperBox, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
+import { CUSTOM_PAPER_MAX_MM, CUSTOM_PAPER_MIN_MM, MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, NamedPaper, NamedPaperMetadata, ORIENTATIONS, Orientation, PAPER_GROUPS, PAPER_METADATA, PAPER_MM, PAPER_UNITS, PX_PER_MM, Paper, PaperBox, PaperGroup, PaperUnit, PrintSetting, PrintSettingInput, fromMillimeters, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
 import { Imposed, MillimeterEdges, PageFit, PagePlacementKind, PagePlacementLayout, Placement, fitPage, impose, mirrorPlacement, pagePlacementLayout } from "./imposition.js";
 import { Lexicon, PronunciationEntry, lexiconVersion } from "./lexicon.js";
 import { NoteMarker, NumberSystem, formatNumber, noteMarker } from "./numbering.js";
@@ -178,6 +178,7 @@ export declare const PageSize: z.ZodUnion<readonly [z.ZodLiteral<"fluid">, z.Zod
 }, z.core.$strip>]>;
 export type PageSize = z.infer<typeof PageSize>;
 export declare const Page: z.ZodObject<{
+  id: z.ZodOptional<z.ZodString>;
   html: z.ZodString;
   size: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"fluid">, z.ZodObject<{
     width: z.ZodNumber;
@@ -390,6 +391,7 @@ export declare function jsonSchemas(): {
     html: z.ZodString;
   }, z.core.$strip>>;
   page: z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
     html: z.ZodString;
     size: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"fluid">, z.ZodObject<{
       width: z.ZodNumber;
@@ -858,6 +860,92 @@ export declare function jsonSchemas(): {
       }, z.core.$strip>>>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
+  printSetting: z.core.ZodStandardJSONSchemaPayload<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<{
+        mm: "mm";
+        in: "in";
+        pt: "pt";
+      }>;
+    }, z.core.$strip>]>;
+    orientation: z.ZodEnum<{
+      portrait: "portrait";
+      landscape: "landscape";
+    }>;
+  }, z.core.$strip>>;
+  printSettingInput: z.core.ZodStandardJSONSchemaPayload<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<{
+        mm: "mm";
+        in: "in";
+        pt: "pt";
+      }>;
+    }, z.core.$strip>]>;
+    orientation: z.ZodEnum<{
+      portrait: "portrait";
+      landscape: "landscape";
+    }>;
+  }, z.core.$strict>>;
 };
 //#endregion
-export { Annotation, type ArrangeOptions, Board, type BoardInput, BoardItem, type BoardItemAnchor, BoardLabel, type BoardListingGroup, BoardSection, type BoardShapes, type BoardView, Book, BookContents, BookFrontMatterEntry, type BookInput, BookMode, BookPage, BookSection, BookView, type BookViewInput, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, type DeckFromSlidesOptions, type DeckInput, type DeckLimits, Direction, GridCell, type GridDropTarget, ImageFit, type Imposed, Lexicon, MAKE_ROOM_LIMIT, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ITEM_WIDTH, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, type MillimeterEdges, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PLAYBACK_MODES, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, Paper, type PaperBox, type Placement, Playback, type PlaybackMode, Point, PronunciationEntry, PublishedShot, SECTION_GAP, SECTION_MIN_SIZE, SECTION_PADDING, SECTION_TITLE_ROOM, SHOT_KEY, Scripts, Shot, type ShotUse, Size, Slide, SlideContent, type SlideRow, TextDirection, Transition, TransitionInput, Word, type ZoomBounds, addItem, annotationCueIssues, arrange, assignMembership, boardBounds, boardListing, boardListingIsEmpty, boardToScreen, deckFromSlides, deriveSectionCells, exceedsLimits, firstStrongDirection, fitPage, fitSection, fitTouchedSections, foldForSearch, formatNumber, gridDropMarkerBox, gridDropTarget, impose, insertIntoGrid, isBookContents, isHebrew, itemAt, itemHeight, languageDirection, layoutSection, lexiconVersion, makeRoom, mirrorPlacement, moveItems, moveSection, nameMatches, noteMarker, noteMarkerIssues, pagePlacementLayout, parsePlayback, printBoxes, printPadding, printProperties, removeFromGrid, removeItems, resizeItem, resolveDirection, revealView, roundMillimeters, screenToBoard, settleBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };
+export { Annotation, type ArrangeOptions, Board, type BoardInput, BoardItem, type BoardItemAnchor, BoardLabel, type BoardListingGroup, BoardSection, type BoardShapes, type BoardView, Book, BookContents, BookFrontMatterEntry, type BookInput, BookMode, BookPage, BookSection, BookView, type BookViewInput, Box, CUSTOM_PAPER_MAX_MM, CUSTOM_PAPER_MIN_MM, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, type DeckFromSlidesOptions, type DeckInput, type DeckLimits, Direction, GridCell, type GridDropTarget, ImageFit, type Imposed, Lexicon, MAKE_ROOM_LIMIT, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ITEM_WIDTH, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, type MillimeterEdges, NAMED_PAPERS, type NamedPaper, type NamedPaperMetadata, Narration, NoteMarker, NumberSystem, ORIENTATIONS, Orientation, PAPER_GROUPS, PAPER_METADATA, PAPER_MM, PAPER_UNITS, PLAYBACK_MODES, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, Paper, type PaperBox, type PaperGroup, PaperUnit, type Placement, Playback, type PlaybackMode, Point, PrintSetting, PrintSettingInput, PronunciationEntry, PublishedShot, SECTION_GAP, SECTION_MIN_SIZE, SECTION_PADDING, SECTION_TITLE_ROOM, SHOT_KEY, Scripts, Shot, type ShotUse, Size, Slide, SlideContent, type SlideRow, TextDirection, Transition, TransitionInput, Word, type ZoomBounds, addItem, annotationCueIssues, arrange, assignMembership, boardBounds, boardListing, boardListingIsEmpty, boardToScreen, deckFromSlides, deriveSectionCells, exceedsLimits, firstStrongDirection, fitPage, fitSection, fitTouchedSections, foldForSearch, formatNumber, fromMillimeters, gridDropMarkerBox, gridDropTarget, impose, insertIntoGrid, isBookContents, isHebrew, itemAt, itemHeight, languageDirection, layoutSection, lexiconVersion, makeRoom, mirrorPlacement, moveItems, moveSection, nameMatches, noteMarker, noteMarkerIssues, pagePlacementLayout, parsePlayback, printBoxes, printPadding, printProperties, removeFromGrid, removeItems, resizeItem, resolveDirection, revealView, roundMillimeters, screenToBoard, settleBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };

package/dist/index.js

@@ -5,7 +5,7 @@ import { DEFAULT_TRANSITION_DURATION_MS, MAX_TRANSITION_DURATION_MS, MIN_TRANSIT
 import { Annotation, Box, Cue, DECK_SIZE, Deck, DeckShape, ImageFit, Manifest, Narration, PLAYBACK_MODES, Playback, Point, PublishedShot, SHOT_KEY, Shot, Size, Slide, SlideContent, Word, annotationCueIssues, exceedsLimits, parsePlayback } from "./deck.js";
 import { Board, BoardItem, BoardLabel, BoardSection, GridCell } from "./board.js";
 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 { CUSTOM_PAPER_MAX_MM, CUSTOM_PAPER_MIN_MM, MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, ORIENTATIONS, Orientation, PAPER_GROUPS, PAPER_METADATA, PAPER_MM, PAPER_UNITS, PX_PER_MM, Paper, PaperUnit, PrintSetting, PrintSettingInput, fromMillimeters, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
 import { Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookShape, BookView, Chapter, isBookContents, isHebrew, noteMarkerIssues } from "./book.js";
 import { Lexicon, PronunciationEntry, lexiconVersion } from "./lexicon.js";
 import { MIN_BOARD_ITEM_WIDTH, addItem, moveItems, moveSection, removeItems, resizeItem } from "./board-edit.js";
@@ -27,7 +27,7 @@ const Margin = z.object({
 });
 const Print = z.object({
 	paper: Paper,
-	orientation: z.enum(["portrait", "landscape"]).default("portrait"),
+	orientation: Orientation.default("portrait"),
 	margin: Margin.optional(),
 	bleed: z.number().nonnegative().default(0),
 	safe: z.number().nonnegative().default(0),
@@ -52,12 +52,8 @@ const ImpositionGap = z.object({
 const MAX_IMPOSITION_CELLS = 1e4;
 const Imposition = z.object({
 	paper: Paper,
-	orientation: z.enum(["portrait", "landscape"]).default("portrait"),
-	unit: z.enum([
-		"mm",
-		"in",
-		"pt"
-	]).default("mm"),
+	orientation: Orientation.default("portrait"),
+	unit: PaperUnit.default("mm"),
 	margin: Margin.default({
 		top: 0,
 		right: 0,
@@ -138,6 +134,7 @@ const PageSize = z.union([
 	})
 ]);
 const Page = z.object({
+	id: z.string().optional(),
 	html: z.string(),
 	size: PageSize.default("fluid"),
 	scripts: Scripts.default("refuse"),
@@ -155,8 +152,10 @@ function jsonSchemas() {
 		deck: z.toJSONSchema(DeckShape, { io: "input" }),
 		manifest: z.toJSONSchema(Manifest, { io: "input" }),
 		publishedShot: z.toJSONSchema(PublishedShot, { io: "input" }),
-		board: z.toJSONSchema(Board, { io: "input" })
+		board: z.toJSONSchema(Board, { io: "input" }),
+		printSetting: z.toJSONSchema(PrintSetting, { io: "input" }),
+		printSettingInput: z.toJSONSchema(PrintSettingInput, { io: "input" })
 	};
 }
 //#endregion
-export { Annotation, Board, BoardItem, BoardLabel, BoardSection, Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookView, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, Direction, GridCell, ImageFit, Imposition, Lexicon, MAKE_ROOM_LIMIT, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_IMPOSITION_CELLS, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ITEM_WIDTH, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, Margin, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PLAYBACK_MODES, PX_PER_MM, Page, PageSize, Paper, Playback, Point, Print, PronunciationEntry, PublishedShot, SECTION_GAP, SECTION_MIN_SIZE, SECTION_PADDING, SECTION_TITLE_ROOM, SHOT_KEY, Scripts, Shot, Size, Slide, SlideContent, TextDirection, Transition, Word, addItem, annotationCueIssues, arrange, assignMembership, boardBounds, boardListing, boardListingIsEmpty, boardToScreen, deckFromSlides, deriveSectionCells, exceedsLimits, firstStrongDirection, fitPage, fitSection, fitTouchedSections, foldForSearch, formatNumber, gridDropMarkerBox, gridDropTarget, impose, insertIntoGrid, isBookContents, isHebrew, itemAt, itemHeight, jsonSchemas, languageDirection, layoutSection, lexiconVersion, makeRoom, mirrorPlacement, moveItems, moveSection, nameMatches, noteMarker, noteMarkerIssues, pagePlacementLayout, parsePlayback, printBoxes, printPadding, printProperties, removeFromGrid, removeItems, resizeItem, resolveDirection, revealView, roundMillimeters, screenToBoard, settleBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };
+export { Annotation, Board, BoardItem, BoardLabel, BoardSection, Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookView, Box, CUSTOM_PAPER_MAX_MM, CUSTOM_PAPER_MIN_MM, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, Direction, GridCell, ImageFit, Imposition, Lexicon, MAKE_ROOM_LIMIT, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_IMPOSITION_CELLS, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ITEM_WIDTH, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, Margin, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, ORIENTATIONS, Orientation, PAPER_GROUPS, PAPER_METADATA, PAPER_MM, PAPER_UNITS, PLAYBACK_MODES, PX_PER_MM, Page, PageSize, Paper, PaperUnit, Playback, Point, Print, PrintSetting, PrintSettingInput, PronunciationEntry, PublishedShot, SECTION_GAP, SECTION_MIN_SIZE, SECTION_PADDING, SECTION_TITLE_ROOM, SHOT_KEY, Scripts, Shot, Size, Slide, SlideContent, TextDirection, Transition, Word, addItem, annotationCueIssues, arrange, assignMembership, boardBounds, boardListing, boardListingIsEmpty, boardToScreen, deckFromSlides, deriveSectionCells, exceedsLimits, firstStrongDirection, fitPage, fitSection, fitTouchedSections, foldForSearch, formatNumber, fromMillimeters, gridDropMarkerBox, gridDropTarget, impose, insertIntoGrid, isBookContents, isHebrew, itemAt, itemHeight, jsonSchemas, languageDirection, layoutSection, lexiconVersion, makeRoom, mirrorPlacement, moveItems, moveSection, nameMatches, noteMarker, noteMarkerIssues, pagePlacementLayout, parsePlayback, printBoxes, printPadding, printProperties, removeFromGrid, removeItems, resizeItem, resolveDirection, revealView, roundMillimeters, screenToBoard, settleBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };

package/dist/paper.d.ts

@@ -2,6 +2,166 @@ import { Print } from "./index.js";
 import { z } from "zod";
 //#region src/paper.d.ts
 export declare const NAMED_PAPERS: readonly ["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"];
+export type NamedPaper = (typeof NAMED_PAPERS)[number];
+export declare const PAPER_GROUPS: readonly ["Office", "Cards", "Leaflets", "Posters"];
+export type PaperGroup = (typeof PAPER_GROUPS)[number];
+export interface NamedPaperMetadata {
+  name: string;
+  group: PaperGroup;
+  size: string;
+}
+export declare const PAPER_METADATA: {
+  letter: {
+    name: string;
+    group: "Office";
+    size: string;
+  };
+  legal: {
+    name: string;
+    group: "Office";
+    size: string;
+  };
+  tabloid: {
+    name: string;
+    group: "Office";
+    size: string;
+  };
+  a3: {
+    name: string;
+    group: "Office";
+    size: string;
+  };
+  a4: {
+    name: string;
+    group: "Office";
+    size: string;
+  };
+  a5: {
+    name: string;
+    group: "Office";
+    size: string;
+  };
+  'business-card-us': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'business-card-eu': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'business-card-square-us': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'business-card-slim-us': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'postcard-4x6': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'postcard-5x7': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'postcard-6x9': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'postcard-6x11': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'card-square-4in': {
+    name: string;
+    group: "Cards";
+    size: string;
+  };
+  'half-letter': {
+    name: string;
+    group: "Leaflets";
+    size: string;
+  };
+  a6: {
+    name: string;
+    group: "Leaflets";
+    size: string;
+  };
+  dl: {
+    name: string;
+    group: "Leaflets";
+    size: string;
+  };
+  'rack-card-4x9': {
+    name: string;
+    group: "Leaflets";
+    size: string;
+  };
+  'rack-card-3.5x8.5': {
+    name: string;
+    group: "Leaflets";
+    size: string;
+  };
+  'poster-12x18': {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+  'poster-16x20': {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+  'poster-18x24': {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+  'poster-24x36': {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+  a2: {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+  a1: {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+  a0: {
+    name: string;
+    group: "Posters";
+    size: string;
+  };
+};
+export declare const CUSTOM_PAPER_MIN_MM = 10;
+export declare const CUSTOM_PAPER_MAX_MM = 2000;
+export declare const PAPER_UNITS: readonly ["mm", "in", "pt"];
+export declare const PaperUnit: z.ZodEnum<{
+  mm: "mm";
+  in: "in";
+  pt: "pt";
+}>;
+export type PaperUnit = z.infer<typeof PaperUnit>;
+export declare const ORIENTATIONS: readonly ["portrait", "landscape"];
+export declare const Orientation: z.ZodEnum<{
+  portrait: "portrait";
+  landscape: "landscape";
+}>;
+export type Orientation = z.infer<typeof Orientation>;
 export declare const Paper: z.ZodUnion<readonly [z.ZodEnum<{
   letter: "letter";
   legal: "legal";
@@ -40,11 +200,100 @@ export declare const Paper: z.ZodUnion<readonly [z.ZodEnum<{
   }>;
 }, z.core.$strip>]>;
 export type Paper = z.infer<typeof Paper>;
+export declare const PrintSetting: 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<{
+      mm: "mm";
+      in: "in";
+      pt: "pt";
+    }>;
+  }, z.core.$strip>]>;
+  orientation: z.ZodEnum<{
+    portrait: "portrait";
+    landscape: "landscape";
+  }>;
+}, z.core.$strip>;
+export type PrintSetting = z.infer<typeof PrintSetting>;
+export declare const PrintSettingInput: 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<{
+      mm: "mm";
+      in: "in";
+      pt: "pt";
+    }>;
+  }, z.core.$strip>]>;
+  orientation: z.ZodEnum<{
+    portrait: "portrait";
+    landscape: "landscape";
+  }>;
+}, z.core.$strict>;
+export type PrintSettingInput = z.input<typeof PrintSettingInput>;
 export declare const MM_PER_PT: number;
 export declare const MARK_LENGTH_MM = 5;
 export declare const MARK_GAP_MM = 1;
 export declare const roundMillimeters: (mm: number) => number;
-export declare function toMillimeters(value: number, unit: 'mm' | 'in' | 'pt'): number;
+export declare function toMillimeters(value: number, unit: PaperUnit): number;
+export declare function fromMillimeters(millimeters: number, unit: PaperUnit): number;
 export declare const PAPER_MM: Record<Extract<Paper, string>, {
   width: number;
   height: number;

package/dist/paper.js

@@ -29,15 +29,180 @@ const NAMED_PAPERS = [
 	"a1",
 	"a0"
 ];
-const Paper = z.union([z.enum(NAMED_PAPERS), z.object({
+const PAPER_GROUPS = [
+	"Office",
+	"Cards",
+	"Leaflets",
+	"Posters"
+];
+const PAPER_METADATA = {
+	letter: {
+		name: "Letter",
+		group: "Office",
+		size: "8.5 × 11 in"
+	},
+	legal: {
+		name: "Legal",
+		group: "Office",
+		size: "8.5 × 14 in"
+	},
+	tabloid: {
+		name: "Tabloid",
+		group: "Office",
+		size: "11 × 17 in"
+	},
+	a3: {
+		name: "A3",
+		group: "Office",
+		size: "297 × 420 mm"
+	},
+	a4: {
+		name: "A4",
+		group: "Office",
+		size: "210 × 297 mm"
+	},
+	a5: {
+		name: "A5",
+		group: "Office",
+		size: "148 × 210 mm"
+	},
+	"business-card-us": {
+		name: "Business card (US)",
+		group: "Cards",
+		size: "3.5 × 2 in"
+	},
+	"business-card-eu": {
+		name: "Business card (EU)",
+		group: "Cards",
+		size: "85 × 55 mm"
+	},
+	"business-card-square-us": {
+		name: "Square business card (US)",
+		group: "Cards",
+		size: "2.5 × 2.5 in"
+	},
+	"business-card-slim-us": {
+		name: "Slim business card (US)",
+		group: "Cards",
+		size: "3.5 × 1.75 in"
+	},
+	"postcard-4x6": {
+		name: "Postcard",
+		group: "Cards",
+		size: "4 × 6 in"
+	},
+	"postcard-5x7": {
+		name: "Postcard",
+		group: "Cards",
+		size: "5 × 7 in"
+	},
+	"postcard-6x9": {
+		name: "Postcard",
+		group: "Cards",
+		size: "6 × 9 in"
+	},
+	"postcard-6x11": {
+		name: "Postcard",
+		group: "Cards",
+		size: "6 × 11 in"
+	},
+	"card-square-4in": {
+		name: "Square card",
+		group: "Cards",
+		size: "4 × 4 in"
+	},
+	"half-letter": {
+		name: "Half letter",
+		group: "Leaflets",
+		size: "5.5 × 8.5 in"
+	},
+	a6: {
+		name: "A6",
+		group: "Leaflets",
+		size: "105 × 148 mm"
+	},
+	dl: {
+		name: "DL",
+		group: "Leaflets",
+		size: "99 × 210 mm"
+	},
+	"rack-card-4x9": {
+		name: "Rack card",
+		group: "Leaflets",
+		size: "4 × 9 in"
+	},
+	"rack-card-3.5x8.5": {
+		name: "Rack card",
+		group: "Leaflets",
+		size: "3.5 × 8.5 in"
+	},
+	"poster-12x18": {
+		name: "Poster",
+		group: "Posters",
+		size: "12 × 18 in"
+	},
+	"poster-16x20": {
+		name: "Poster",
+		group: "Posters",
+		size: "16 × 20 in"
+	},
+	"poster-18x24": {
+		name: "Poster",
+		group: "Posters",
+		size: "18 × 24 in"
+	},
+	"poster-24x36": {
+		name: "Poster",
+		group: "Posters",
+		size: "24 × 36 in"
+	},
+	a2: {
+		name: "A2",
+		group: "Posters",
+		size: "420 × 594 mm"
+	},
+	a1: {
+		name: "A1",
+		group: "Posters",
+		size: "594 × 841 mm"
+	},
+	a0: {
+		name: "A0",
+		group: "Posters",
+		size: "841 × 1189 mm"
+	}
+};
+const CUSTOM_PAPER_MIN_MM = 10;
+const CUSTOM_PAPER_MAX_MM = 2e3;
+const PAPER_UNITS = [
+	"mm",
+	"in",
+	"pt"
+];
+const PaperUnit = z.enum(PAPER_UNITS);
+const ORIENTATIONS = ["portrait", "landscape"];
+const Orientation = z.enum(ORIENTATIONS);
+const CustomPaper = z.object({
 	width: z.number().positive(),
 	height: z.number().positive(),
-	unit: z.enum([
-		"mm",
-		"in",
-		"pt"
-	])
-})]);
+	unit: PaperUnit
+}).superRefine((paper, ctx) => {
+	for (const side of ["width", "height"]) {
+		const millimeters = toMillimeters(paper[side], paper.unit);
+		if (millimeters < 10 || millimeters > 2e3) ctx.addIssue({
+			code: "custom",
+			path: [side],
+			message: `${side} must be between 10mm and ${CUSTOM_PAPER_MAX_MM}mm`
+		});
+	}
+});
+const Paper = z.union([z.enum(NAMED_PAPERS), CustomPaper]);
+const PrintSettingShape = {
+	paper: Paper,
+	orientation: Orientation
+};
+const PrintSetting = z.object(PrintSettingShape);
+const PrintSettingInput = z.strictObject(PrintSettingShape);
 const MM_PER_PT = 25.4 / 72;
 const MARK_LENGTH_MM = 5;
 const MARK_GAP_MM = 1;
@@ -45,6 +210,9 @@ const roundMillimeters = (mm) => Math.round(mm * 100) / 100;
 function toMillimeters(value, unit) {
 	return value * (unit === "in" ? 25.4 : unit === "pt" ? MM_PER_PT : 1);
 }
+function fromMillimeters(millimeters, unit) {
+	return millimeters / (unit === "in" ? 25.4 : unit === "pt" ? MM_PER_PT : 1);
+}
 const PAPER_SIZE = {
 	letter: {
 		width: 8.5,
@@ -314,4 +482,4 @@ function printBoxes(print) {
 	};
 }
 //#endregion
-export { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, PAPER_MM, PX_PER_MM, Paper, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters };
+export { CUSTOM_PAPER_MAX_MM, CUSTOM_PAPER_MIN_MM, MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, ORIENTATIONS, Orientation, PAPER_GROUPS, PAPER_METADATA, PAPER_MM, PAPER_UNITS, PX_PER_MM, Paper, PaperUnit, PrintSetting, PrintSettingInput, fromMillimeters, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters };

package/package.json

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