@segnavia/format 0.39.0 → 0.40.0

package/dist/page.d.ts

@@ -1,22 +1,59 @@
 import { z } from "zod";
 //#region src/page.d.ts
-export declare const FLUID_WIDTH = 1024;
-export declare const PageSize: z.ZodUnion<readonly [z.ZodLiteral<"fluid">, z.ZodObject<{
+export declare const PAGE_WIDTHS: {
+  readonly standard: 1024;
+  readonly wide: 1440;
+};
+export declare const FULL_PAGE_SIZE: {
+  readonly width: "full";
+  readonly height: "auto";
+};
+export declare const FlowingWidth: z.ZodUnion<readonly [z.ZodLiteral<"full">, z.ZodLiteral<"standard">, z.ZodLiteral<"wide">, z.ZodNumber]>;
+export type FlowingWidth = z.infer<typeof FlowingWidth>;
+export declare const PageWidths: z.ZodObject<{
+  standard: z.ZodOptional<z.ZodNumber>;
+  wide: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PageWidths = z.infer<typeof PageWidths>;
+export declare const PageSize: 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.ZodNumber;
+  width: z.ZodUnion<readonly [z.ZodLiteral<"full">, z.ZodLiteral<"standard">, z.ZodLiteral<"wide">, z.ZodNumber]>;
   height: z.ZodLiteral<"auto">;
 }, z.core.$strip>]>;
 export type PageSize = z.infer<typeof PageSize>;
-export declare const Page: z.ZodObject<{
-  id: z.ZodOptional<z.ZodString>;
+export interface ResolvedPageWidth {
+  measure?: number;
+  viewportWidth: number;
+}
+export declare const PageBody: z.ZodUnion<readonly [z.ZodObject<{
   html: z.ZodString;
-  size: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"fluid">, z.ZodObject<{
+}, z.core.$strict>, z.ZodObject<{
+  markdown: z.ZodString;
+}, z.core.$strict>]>;
+export type PageBody = z.infer<typeof PageBody>;
+export declare function resolvePageWidth(size: PageSize, overrides?: PageWidths): ResolvedPageWidth;
+export declare const 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.ZodNumber;
+    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<{
@@ -62,8 +99,8 @@ export declare const Page: z.ZodObject<{
       width: z.ZodNumber;
       height: z.ZodNumber;
       unit: z.ZodEnum<{
-        mm: "mm";
         in: "in";
+        mm: "mm";
         pt: "pt";
       }>;
     }, z.core.$strip>]>;
@@ -168,7 +205,155 @@ export declare const Page: z.ZodObject<{
     local: z.ZodString;
     fallback: z.ZodString;
   }, z.core.$strip>]>>>;
-}, 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;
+}>>;
 export type Page = z.infer<typeof Page>;
 export type PageInput = z.input<typeof Page>;
 //#endregion

package/dist/page.js

@@ -7,19 +7,54 @@ import { PrintedPages, pagePrintedPagesIssues } from "./printed-pages.js";
 import { Print } from "./print.js";
 import { z } from "zod";
 //#region src/page.ts
-const FLUID_WIDTH = 1024;
+const PAGE_WIDTHS = {
+	standard: 1024,
+	wide: 1440
+};
+const FULL_PAGE_SIZE = {
+	width: "full",
+	height: "auto"
+};
+const FlowingWidth = z.union([
+	z.literal("full"),
+	z.literal("standard"),
+	z.literal("wide"),
+	z.number().int().positive()
+]);
+const PageWidths = z.object({
+	standard: z.number().positive().optional(),
+	wide: z.number().positive().optional()
+});
+const FlowingPageSize = z.object({
+	width: FlowingWidth,
+	height: z.literal("auto")
+});
+const LegacyFluidPageSize = z.literal("fluid").transform(() => FULL_PAGE_SIZE);
 const PageSize = z.union([
-	z.literal("fluid"),
+	LegacyFluidPageSize,
 	Size,
-	z.object({
-		width: z.number().int().positive(),
-		height: z.literal("auto")
-	})
+	FlowingPageSize
 ]);
-const Page = z.object({
+const PageBody = z.union([z.strictObject({ html: z.string() }), z.strictObject({ markdown: z.string() })]);
+function resolvePageWidth(size, overrides = {}) {
+	const width = size.width;
+	if (typeof width === "number") return {
+		measure: width,
+		viewportWidth: width
+	};
+	if (width === "full") return { viewportWidth: overrides.standard ?? PAGE_WIDTHS.standard };
+	const measure = overrides[width] ?? PAGE_WIDTHS[width];
+	return {
+		measure,
+		viewportWidth: measure
+	};
+}
+const PageShape = z.object({
 	id: z.string().optional(),
-	html: z.string(),
-	size: PageSize.default("fluid"),
+	body: PageBody.optional(),
+	html: z.string().optional(),
+	markdown: z.string().optional(),
+	size: PageSize.default(FULL_PAGE_SIZE),
 	scripts: Scripts.default("refuse"),
 	dir: Direction.optional(),
 	lang: z.string().optional(),
@@ -28,10 +63,48 @@ const Page = z.object({
 	slots: Slots.optional(),
 	fonts: z.array(FontReference).optional()
 }).superRefine((page, ctx) => {
+	const fields = bodyChoices(page).map(({ field }) => field);
+	if (fields.length === 0) ctx.addIssue({
+		code: "custom",
+		path: ["body"],
+		message: "body, html or markdown is required; provide exactly one page body"
+	});
+	if (fields.length > 1) {
+		const names = fields.join(", ");
+		for (const field of fields) ctx.addIssue({
+			code: "custom",
+			path: [field],
+			message: `${names} were all given; provide exactly one of body, html or markdown`
+		});
+	}
 	for (const issue of pagePrintedPagesIssues(page)) ctx.addIssue({
 		code: "custom",
 		...issue
 	});
 });
+const BODY_SHORTHANDS = [{
+	field: "html",
+	body: (value) => ({ html: value })
+}, {
+	field: "markdown",
+	body: (value) => ({ markdown: value })
+}];
+function bodyChoices(page) {
+	return [...page.body === void 0 ? [] : [{
+		field: "body",
+		body: page.body
+	}], ...BODY_SHORTHANDS.flatMap(({ field, body }) => page[field] === void 0 ? [] : [{
+		field,
+		body: body(page[field])
+	}])];
+}
+const Page = PageShape.transform(({ html, markdown, ...page }) => ({
+	...page,
+	body: bodyChoices({
+		...page,
+		html,
+		markdown
+	})[0]?.body
+}));
 //#endregion
-export { FLUID_WIDTH, Page, PageSize };
+export { FULL_PAGE_SIZE, FlowingWidth, PAGE_WIDTHS, Page, PageBody, PageSize, PageWidths, resolvePageWidth };

package/dist/paper.d.ts

@@ -151,8 +151,8 @@ 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";
+  mm: "mm";
   pt: "pt";
 }>;
 export type PaperUnit = z.infer<typeof PaperUnit>;
@@ -194,8 +194,8 @@ export declare const Paper: z.ZodUnion<readonly [z.ZodEnum<{
   width: z.ZodNumber;
   height: z.ZodNumber;
   unit: z.ZodEnum<{
-    mm: "mm";
     in: "in";
+    mm: "mm";
     pt: "pt";
   }>;
 }, z.core.$strip>]>;
@@ -233,8 +233,8 @@ export declare const PrintSetting: z.ZodObject<{
     width: z.ZodNumber;
     height: z.ZodNumber;
     unit: z.ZodEnum<{
-      mm: "mm";
       in: "in";
+      mm: "mm";
       pt: "pt";
     }>;
   }, z.core.$strip>]>;
@@ -277,8 +277,8 @@ export declare const PrintSettingInput: z.ZodObject<{
     width: z.ZodNumber;
     height: z.ZodNumber;
     unit: z.ZodEnum<{
-      mm: "mm";
       in: "in";
+      mm: "mm";
       pt: "pt";
     }>;
   }, z.core.$strip>]>;

package/dist/placement.d.ts

@@ -40,9 +40,9 @@ export declare const PlacementShape: z.ZodObject<{
   page: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
   box: z.ZodOptional<z.ZodEnum<{
     media: "media";
-    bleed: "bleed";
     crop: "crop";
     trim: "trim";
+    bleed: "bleed";
     art: "art";
   }>>;
   crop: z.ZodOptional<z.ZodObject<{

package/dist/print.d.ts

@@ -44,8 +44,8 @@ export declare const Print: z.ZodObject<{
     width: z.ZodNumber;
     height: z.ZodNumber;
     unit: z.ZodEnum<{
-      mm: "mm";
       in: "in";
+      mm: "mm";
       pt: "pt";
     }>;
   }, z.core.$strip>]>;

package/package.json

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