@segnavia/idml 0.28.0 → 0.30.0

package/dist/frame-preferences.js

@@ -0,0 +1,45 @@
+import { localName, numberAttribute } from "./xml.js";
+import { isTag } from "domhandler";
+//#region src/frame-preferences.ts
+function preferenceElement(frame) {
+	const pending = [...frame.children];
+	while (pending.length > 0) {
+		const node = pending.pop();
+		if (!node || !isTag(node)) continue;
+		if (localName(node.name) === "TextFramePreference") return node;
+		pending.push(...node.children);
+	}
+}
+function framePreference(frame, location) {
+	const element = preferenceElement(frame);
+	if (!element) return void 0;
+	return {
+		columns: numberAttribute(element, "TextColumnCount", 1),
+		gutter: numberAttribute(element, "TextColumnGutter", 0),
+		location
+	};
+}
+var FramePreferenceIndex = class {
+	byStory = /* @__PURE__ */ new Map();
+	add(story, preference) {
+		if (!preference || preference.columns < 2) return;
+		const values = this.byStory.get(story) ?? [];
+		values.push(preference);
+		this.byStory.set(story, values);
+	}
+	preferred(story) {
+		const values = this.byStory.get(story) ?? [];
+		const counts = /* @__PURE__ */ new Map();
+		for (const value of values) {
+			const key = `${value.columns}\u0000${value.gutter}`;
+			counts.set(key, (counts.get(key) ?? 0) + 1);
+		}
+		const selected = [...counts].sort((left, right) => right[1] - left[1])[0]?.[0];
+		return values.find((value) => `${value.columns}\u0000${value.gutter}` === selected);
+	}
+	values() {
+		return [...this.byStory.values()].flat();
+	}
+};
+//#endregion
+export { FramePreferenceIndex, framePreference };

package/dist/import.d.ts

@@ -1,9 +1,9 @@
+import { IdmlReportData } from "./report.js";
 import { Book } from "@segnavia/format";
 //#region src/import.d.ts
 export type IdmlImportOptions = Record<never, never>;
-export interface IdmlImportReport {
+export interface IdmlImportReport extends IdmlReportData {
   partsRead: string[];
-  unsupportedElements: Record<string, number>;
 }
 export interface IdmlImportResult {
   book: Book;

package/dist/import.js

@@ -1,4 +1,5 @@
 import { refusal } from "./refusal.js";
+import { ReportCollector } from "./report.js";
 import { modelToBook } from "./map-book.js";
 import { idmlModel } from "./model.js";
 import { readZip } from "./zip.js";
@@ -13,11 +14,12 @@ async function importIdml(bytes, _options = {}) {
 	if (value !== IDML_MIMETYPE) throw refusal(`the IDML mimetype entry is ${JSON.stringify(value)}, not ${IDML_MIMETYPE}`, "use the IDML package mimetype");
 	if (!byName.has("designmap.xml")) throw refusal("the IDML designmap.xml entry is missing", "add the required designmap.xml entry");
 	const model = idmlModel(entries);
+	const collector = new ReportCollector(model.report);
 	return {
-		book: modelToBook(model),
+		book: modelToBook(model, collector),
 		report: {
 			partsRead: model.partsRead,
-			unsupportedElements: model.unsupportedElements
+			...collector.data()
 		}
 	};
 }

package/dist/index.d.ts

@@ -1,4 +1,6 @@
+import { IdmlFontUse, IdmlReportData } from "./report.js";
 import { IdmlImportOptions, IdmlImportReport, IdmlImportResult, importIdml } from "./import.js";
 import { IDML_LIMITS, MAX_IDML_ENTRIES, MAX_IDML_PACKAGE_BYTES, MAX_IDML_PART_BYTES, MAX_IDML_TOTAL_INFLATED_BYTES, MAX_IDML_XML_DEPTH } from "./limits.js";
-import { IdmlDocumentPreferences, IdmlMargin, IdmlMasterSpread, IdmlModel, IdmlPage, IdmlSpread, IdmlStory } from "./model.js";
-export { IDML_LIMITS, type IdmlDocumentPreferences, type IdmlImportOptions, type IdmlImportReport, type IdmlImportResult, type IdmlMargin, type IdmlMasterSpread, type IdmlModel, type IdmlPage, type IdmlSpread, type IdmlStory, MAX_IDML_ENTRIES, MAX_IDML_PACKAGE_BYTES, MAX_IDML_PART_BYTES, MAX_IDML_TOTAL_INFLATED_BYTES, MAX_IDML_XML_DEPTH, importIdml };
+import { IdmlDocumentPreferences, IdmlMargin, IdmlMasterSpread, IdmlPage, IdmlSpread, IdmlStory } from "./types.js";
+import { IdmlModel } from "./model.js";
+export { IDML_LIMITS, type IdmlDocumentPreferences, type IdmlFontUse, type IdmlImportOptions, type IdmlImportReport, type IdmlImportResult, type IdmlMargin, type IdmlMasterSpread, type IdmlModel, type IdmlPage, type IdmlReportData, type IdmlSpread, type IdmlStory, MAX_IDML_ENTRIES, MAX_IDML_PACKAGE_BYTES, MAX_IDML_PART_BYTES, MAX_IDML_TOTAL_INFLATED_BYTES, MAX_IDML_XML_DEPTH, importIdml };

package/dist/map-book.js

@@ -1,27 +1,65 @@
 import { refusal } from "./refusal.js";
+import { logicalMargin } from "./margins.js";
+import { storyHtml } from "./stories.js";
+import { chapterParents, mapMasters } from "./masters.js";
+import { ReportCollector } from "./report.js";
+import { StyleMapper } from "./styles.js";
+import { matchVariables } from "./variables.js";
 import { Book, MM_PER_PT } from "@segnavia/format";
 import { findActiveContent } from "@segnavia/html";
-import serialize from "dom-serializer";
-import { Element } from "domhandler";
 //#region src/map-book.ts
-const emptyParagraph = () => serialize(new Element("p", {}, []), { xmlMode: false });
 function orderedStories(model) {
 	const order = /* @__PURE__ */ new Map();
 	for (const spread of model.spreads) for (const page of spread.pages) for (const story of page.stories) if (!order.has(story)) order.set(story, order.size);
 	const masterStories = new Set(model.masterStoryIds);
 	return model.stories.filter((story) => !masterStories.has(story.id)).sort((left, right) => (order.get(left.id) ?? Number.MAX_SAFE_INTEGER) - (order.get(right.id) ?? Number.MAX_SAFE_INTEGER));
 }
-function modelToBook(model) {
+function bodyColumnGap(model, stories, report) {
+	const storyFrames = stories.flatMap((story) => story.frame?.columns && story.frame.columns >= 2 ? [story.frame] : []);
+	const frames = (model.bodyFramePreferences ?? storyFrames).filter((frame) => frame.columns >= 2);
+	const representativeFrames = storyFrames.length > 0 ? storyFrames : frames;
+	const counts = /* @__PURE__ */ new Map();
+	for (const frame of representativeFrames) counts.set(frame.gutter, (counts.get(frame.gutter) ?? 0) + 1);
+	const selected = [...counts].sort((left, right) => right[1] - left[1])[0]?.[0];
+	if (selected === void 0) return void 0;
+	for (const gutter of new Set(frames.map((frame) => frame.gutter).filter((gutter) => gutter !== selected))) {
+		const frame = frames.find((candidate) => candidate.gutter === gutter);
+		report.add(report.unsupportedElements, "differing body frame gutters", frame?.location ?? model.id);
+	}
+	return selected;
+}
+function refuseActiveBookHtml(chapters, parents) {
+	const html = [...chapters.map((chapter) => chapter.html), ...parents.flatMap((parent) => [parent.head ?? "", parent.foot ?? ""])].join("");
+	const active = findActiveContent(html);
+	if (active.length > 0) throw refusal(`the imported Book contains active content (${active.join(", ")})`, "remove that active content");
+}
+function modelToBook(model, report = new ReportCollector(model.report)) {
 	const preferences = model.preferences;
 	const rightBinding = preferences.binding === "right-to-left";
-	const chapters = orderedStories(model).map((story) => ({
-		title: story.id,
-		html: emptyParagraph()
-	}));
+	const bookDirection = rightBinding ? "rtl" : "ltr";
+	const styles = new StyleMapper(model.styles ?? [], model.swatches ?? [], report, bookDirection);
+	const matchedVariables = matchVariables(model.textVariables ?? [], report);
+	const bookLanguage = styles.rootLanguage();
+	const stories = orderedStories(model);
+	const masters = mapMasters(model, matchedVariables, styles, report);
+	const chapters = stories.map((story) => ({
+		story,
+		mapped: storyHtml({
+			...story,
+			textVariables: matchedVariables
+		}, styles, report, bookDirection, bookLanguage)
+	})).map(({ story, mapped: value }) => {
+		const parents = chapterParents(story.id, model, masters, report);
+		return {
+			title: story.id,
+			html: value.html,
+			...parents ? { parents } : {}
+		};
+	});
 	if (chapters.length === 0) throw refusal("the IDML has no stories", "add at least one Story");
-	const html = chapters.map((chapter) => chapter.html).join("");
-	const active = findActiveContent(html);
-	if (active.length > 0) throw refusal(`the imported Book contains active content (${active.join(", ")})`, "remove that active content");
+	refuseActiveBookHtml(chapters, masters.parents);
+	const columnGap = bodyColumnGap(model, stories, report);
+	const css = `${styles.css()}${masters.css}`;
 	return Book.parse({
 		title: model.id,
 		mode: "paginated",
@@ -31,17 +69,16 @@ function modelToBook(model) {
 				height: preferences.pageHeight,
 				unit: "pt"
 			},
-			margin: {
-				top: preferences.margin.top * MM_PER_PT,
-				bottom: preferences.margin.bottom * MM_PER_PT,
-				inner: (rightBinding ? preferences.margin.right : preferences.margin.left) * MM_PER_PT,
-				outer: (rightBinding ? preferences.margin.left : preferences.margin.right) * MM_PER_PT
-			}
+			margin: masters.bookMargin ?? logicalMargin(preferences.margin, rightBinding ? "left" : "right"),
+			...columnGap === void 0 ? {} : { columnGap: columnGap * MM_PER_PT }
 		},
-		dir: rightBinding ? "rtl" : "ltr",
+		dir: bookDirection,
+		...bookLanguage ? { lang: bookLanguage } : {},
+		...css ? { css } : {},
 		rectoOpenings: preferences.facingPages,
+		parentPages: masters.parents,
 		chapters
 	});
 }
 //#endregion
-export { modelToBook };
+export { modelToBook, refuseActiveBookHtml };

package/dist/margins.js

@@ -0,0 +1,21 @@
+import { numberAttribute } from "./xml.js";
+import { MM_PER_PT } from "@segnavia/format";
+//#region src/margins.ts
+function readMargin(element) {
+	return {
+		top: numberAttribute(element, "Top", 0),
+		bottom: numberAttribute(element, "Bottom", 0),
+		left: numberAttribute(element, "Left", 0),
+		right: numberAttribute(element, "Right", 0)
+	};
+}
+function logicalMargin(margin, side) {
+	return {
+		top: margin.top * MM_PER_PT,
+		bottom: margin.bottom * MM_PER_PT,
+		inner: (side === "left" ? margin.right : margin.left) * MM_PER_PT,
+		outer: (side === "left" ? margin.left : margin.right) * MM_PER_PT
+	};
+}
+//#endregion
+export { logicalMargin, readMargin };

package/dist/masters.js

@@ -0,0 +1,200 @@
+import { logicalMargin } from "./margins.js";
+import { storyHtml } from "./stories.js";
+import { BOOK_PARENT_NAMES, MM_PER_PT } from "@segnavia/format";
+import serialize from "dom-serializer";
+import { Element } from "domhandler";
+import { parseDocument } from "htmlparser2";
+const slug = (value) => value.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "") || "master";
+const mm = (points) => `${Number((points * MM_PER_PT).toFixed(6))}mm`;
+function roleFor(page, rtl, ordinal) {
+	if (!page.side || page.side === "single") return (ordinal ?? 0) % 2 === 0 ? "recto" : "verso";
+	return page.side === (rtl ? "left" : "right") ? "recto" : "verso";
+}
+function masterPage(master, role, rtl) {
+	if (master.pages.length === 1) return master.pages[0];
+	const side = role === "recto" ? rtl ? "left" : "right" : rtl ? "right" : "left";
+	return master.pages.find((page) => page.side === side);
+}
+function parentName(master, role) {
+	return `idml-${slug(master.name)}-${master.pages.length === 1 ? "recto" : role}`;
+}
+function frameRegion(page, frame, height) {
+	if (frame.bounds.top + frame.bounds.height <= page.margin.top) return "head";
+	if (frame.bounds.top >= height - page.margin.bottom) return "foot";
+}
+function regionHtml(master, page, region, context) {
+	const boxes = [];
+	for (const frame of page.frames) {
+		if (frameRegion(page, frame, context.model.preferences.pageHeight) !== region) continue;
+		const story = context.stories.get(frame.story);
+		if (!story) {
+			context.report.add(context.report.unsupportedElements, "master story missing", `${master.name}#${frame.id}`);
+			continue;
+		}
+		const className = `idml-master-frame-${context.css.length}`;
+		const mapped = storyHtml({
+			...story,
+			textVariables: context.variables,
+			master: true
+		}, context.styles, context.report, context.rtl ? "rtl" : "ltr", void 0);
+		const nodes = parseDocument(mapped.html, { xmlMode: false }).children;
+		boxes.push(new Element("div", { class: className }, nodes));
+		const right = frame.bounds.left + frame.bounds.width;
+		const inlineStart = context.rtl ? context.model.preferences.pageWidth - page.margin.right - right : frame.bounds.left - page.margin.left;
+		const blockStart = region === "head" ? frame.bounds.top : frame.bounds.top - (context.model.preferences.pageHeight - page.margin.bottom);
+		context.css.push(`:where(.${className}){position:absolute;inset-inline-start:${mm(inlineStart)};inline-size:${mm(frame.bounds.width)};inset-block-start:${mm(blockStart)};block-size:${mm(frame.bounds.height)}}`);
+		context.mappedStories.add(frame.story);
+	}
+	if (boxes.length === 0) return void 0;
+	return serialize(new Element("div", { class: "idml-master-region" }, boxes), {
+		xmlMode: false,
+		encodeEntities: "utf8"
+	});
+}
+function pageSide(page, role, rtl) {
+	if (page.side === "left" || page.side === "right") return page.side;
+	return role === "recto" ? rtl ? "left" : "right" : rtl ? "right" : "left";
+}
+function buildParent(master, role, byId, context) {
+	const page = masterPage(master, role, context.rtl);
+	if (!page) return void 0;
+	const base = master.basedOn ? byId.get(master.basedOn) : void 0;
+	const head = regionHtml(master, page, "head", context);
+	const foot = regionHtml(master, page, "foot", context);
+	for (const frame of page.frames) if (!frameRegion(page, frame, context.model.preferences.pageHeight)) context.report.add(context.report.unsupportedElements, "master TextFrame", `${master.name}#${frame.id}`);
+	return {
+		name: parentName(master, role),
+		...base ? { basedOn: parentName(base, role) } : {},
+		margin: logicalMargin(page.margin, pageSide(page, role, context.rtl)),
+		...head ? { head } : {},
+		...foot ? { foot } : {}
+	};
+}
+function reportExtraPages(master, selected, report) {
+	for (const page of master.pages) {
+		if (selected.has(page.id)) continue;
+		report.add(report.unsupportedElements, "master page", `${master.name}#${page.id}`);
+		for (const frame of page.frames) report.add(report.unsupportedElements, "master TextFrame", `${master.name}#${frame.id}`);
+	}
+}
+function buildParents(masters, byId, context) {
+	const result = [];
+	for (const master of masters) {
+		const roles = master.pages.length === 1 ? ["recto"] : ["recto", "verso"];
+		const selected = /* @__PURE__ */ new Set();
+		for (const role of roles) {
+			const page = masterPage(master, role, context.rtl);
+			if (page) selected.add(page.id);
+			const parent = buildParent(master, role, byId, context);
+			if (parent) result.push(parent);
+		}
+		reportExtraPages(master, selected, context.report);
+		for (const item of master.unmappedItems) context.report.add(context.report.unsupportedElements, `master ${item.type}`, `${master.name}#${item.id}`);
+	}
+	return result;
+}
+function emittedMasters(model, applied) {
+	const byId = new Map(model.masterSpreads.map((master) => [master.id, master]));
+	const emitted = new Set(applied);
+	for (const id of emitted) {
+		const basedOn = byId.get(id)?.basedOn;
+		if (basedOn) emitted.add(basedOn);
+	}
+	return model.masterSpreads.filter((master) => emitted.has(master.id));
+}
+function appliedBookMargin(model, applied, report) {
+	const masters = model.masterSpreads.filter((master) => applied.has(master.id));
+	if (masters.length !== applied.size) return void 0;
+	const pages = masters.flatMap((master) => master.pages.map((page) => ({
+		master,
+		page
+	})));
+	const first = pages[0]?.page.margin;
+	if (!first) return void 0;
+	const signature = (margin) => `${margin.top},${margin.bottom},${margin.left},${margin.right}`;
+	if (pages.some(({ page }) => signature(page.margin) !== signature(first))) {
+		for (const master of masters) {
+			const margins = [...new Set(master.pages.map((page) => signature(page.margin)))];
+			report.add(report.unsupportedElements, "master margins disagree", `${master.name}:${margins.join("|")}`);
+		}
+		return;
+	}
+	return logicalMargin(first, model.preferences.binding === "right-to-left" ? "left" : "right");
+}
+function mapMasters(model, variables, styles, report) {
+	const rtl = model.preferences.binding === "right-to-left";
+	const applied = new Set(model.spreads.flatMap((spread) => spread.pages.map((page) => page.appliedMaster).filter((id) => Boolean(id && id !== "n"))));
+	const masters = emittedMasters(model, applied);
+	const byId = new Map(model.masterSpreads.map((master) => [master.id, master]));
+	for (const spread of model.spreads) for (const page of spread.pages) {
+		const id = page.appliedMaster;
+		if (id && id !== "n" && !byId.has(id)) report.addOnce(report.unsupportedElements, `applied master unknown:${id}`, page.id);
+	}
+	const css = [":where(.idml-master-region){position:relative;block-size:100%}"];
+	const mappedStories = /* @__PURE__ */ new Set();
+	const parents = buildParents(masters, byId, {
+		model,
+		variables,
+		styles,
+		report,
+		rtl,
+		stories: new Map(model.stories.map((story) => [story.id, story])),
+		mappedStories,
+		css
+	});
+	if (model.spreads.some((spread) => spread.pages.some((page) => !page.appliedMaster || page.appliedMaster === "n"))) parents.push({
+		name: "idml-none",
+		basedOn: BOOK_PARENT_NAMES.blank
+	});
+	for (const story of model.masterStoryIds) if (!mappedStories.has(story)) report.add(report.unsupportedElements, "master story", story);
+	const parentFor = (masterId, role, location) => {
+		if (!masterId || masterId === "n") return "idml-none";
+		const master = byId.get(masterId);
+		if (master && applied.has(masterId)) return parentName(master, role);
+		report.addOnce(report.unsupportedElements, `applied master unknown:${masterId}`, location);
+		return role === "recto" ? BOOK_PARENT_NAMES.recto : BOOK_PARENT_NAMES.verso;
+	};
+	return {
+		parents,
+		css: css.join(""),
+		bookMargin: appliedBookMargin(model, applied, report),
+		parentFor,
+		mappedStories
+	};
+}
+function chapterParents(story, model, mapping, report) {
+	const rtl = model.preferences.binding === "right-to-left";
+	const pages = [];
+	let ordinal = 0;
+	for (const spread of model.spreads) for (const page of spread.pages) {
+		if (page.stories.includes(story)) pages.push({
+			page,
+			ordinal
+		});
+		ordinal += 1;
+	}
+	const first = pages[0];
+	if (!first) return void 0;
+	const firstRole = roleFor(first.page, rtl, first.ordinal);
+	const result = { opener: mapping.parentFor(first.page.appliedMaster, firstRole, first.page.id) };
+	for (const role of ["recto", "verso"]) {
+		const candidates = pages.slice(1).filter((entry) => roleFor(entry.page, rtl, entry.ordinal) === role);
+		if (candidates.length === 0) continue;
+		const counts = /* @__PURE__ */ new Map();
+		for (const entry of candidates) {
+			const id = entry.page.appliedMaster ?? "n";
+			counts.set(id, (counts.get(id) ?? 0) + 1);
+		}
+		const chosen = [...counts].sort((a, b) => b[1] - a[1])[0]?.[0];
+		if (chosen) result[role] = mapping.parentFor(chosen, role, candidates[0]?.page.id ?? story);
+		if (chosen && counts.size > 1) report.mixedMasterChapters.push({
+			chapter: story,
+			side: role,
+			masters: [...counts.keys()],
+			chosen
+		});
+	}
+	return result;
+}
+//#endregion
+export { chapterParents, mapMasters };

package/dist/model.d.ts

@@ -1,34 +1,6 @@
+import { IdmlReportData } from "./report.js";
+import { IdmlDocumentPreferences, IdmlFramePreference, IdmlMargin, IdmlMasterPage, IdmlMasterSpread, IdmlPage, IdmlSpread, IdmlStory, IdmlStyle, IdmlSwatch, IdmlTextVariable } from "./types.js";
 //#region src/model.d.ts
-export interface IdmlMargin {
-  top: number;
-  bottom: number;
-  left: number;
-  right: number;
-}
-export interface IdmlDocumentPreferences {
-  pageWidth: number;
-  pageHeight: number;
-  facingPages: boolean;
-  binding: 'left-to-right' | 'right-to-left';
-  margin: IdmlMargin;
-}
-export interface IdmlPage {
-  id: string;
-  appliedMaster?: string;
-  stories: string[];
-}
-export interface IdmlSpread {
-  id: string;
-  pages: IdmlPage[];
-}
-export interface IdmlMasterSpread {
-  id: string;
-  pages: IdmlPage[];
-}
-export interface IdmlStory {
-  id: string;
-  part: string;
-}
 export interface IdmlModel {
   id: string;
   preferences: IdmlDocumentPreferences;
@@ -37,6 +9,11 @@ export interface IdmlModel {
   stories: IdmlStory[];
   masterStoryIds: string[];
   partsRead: string[];
-  unsupportedElements: Record<string, number>;
+  styles?: IdmlStyle[];
+  swatches?: IdmlSwatch[];
+  bodyFramePreferences?: IdmlFramePreference[];
+  textVariables?: IdmlTextVariable[];
+  report?: IdmlReportData;
 }
-//#endregion
+//#endregion
+export type { IdmlDocumentPreferences, IdmlMargin, IdmlMasterSpread, IdmlPage, IdmlSpread, IdmlStory };