js.documents 2.0.0 → 2.2.0

package/dist/svg/write.cjs

@@ -0,0 +1,127 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_edit_odg_svg_path = require("../edit/odg/svg-path.cjs");
+const require_model_paint_order = require("../model/paint-order.cjs");
+let document_schema_js = require("document-schema.js");
+let odf_js = require("odf.js");
+//#region src/svg/write.ts
+var SvgUnsupportedDocumentKindError = class extends Error {
+	kind;
+	constructor(kind) {
+		super(`buildSvgText: expected a drawing ContentDocument, got kind '${kind}'`);
+		this.name = "SvgUnsupportedDocumentKindError";
+		this.kind = kind;
+	}
+};
+var SvgMultiPageNotSpecifiedError = class extends Error {
+	pageCount;
+	constructor(pageCount) {
+		super(`buildSvgText: this document has more than one page (${pageCount}) -- pass { page: <index> } to select one`);
+		this.name = "SvgMultiPageNotSpecifiedError";
+		this.pageCount = pageCount;
+	}
+};
+var SvgPageNotFoundError = class extends Error {
+	page;
+	pageCount;
+	constructor(page, pageCount) {
+		super(`buildSvgText: page index ${page} not found -- the document has ${pageCount} page(s)`);
+		this.name = "SvgPageNotFoundError";
+		this.page = page;
+		this.pageCount = pageCount;
+	}
+};
+function selectPage(pages, page) {
+	if (page !== void 0) {
+		const found = pages[page];
+		if (found === void 0) throw new SvgPageNotFoundError(page, pages.length);
+		return found;
+	}
+	if (pages.length === 0) throw new SvgPageNotFoundError(0, 0);
+	if (pages.length > 1) throw new SvgMultiPageNotSpecifiedError(pages.length);
+	return pages[0];
+}
+const DASHED_PATTERN = "6 4";
+const DOTTED_PATTERN = "1 3";
+function svgColor(fill) {
+	return `#${(0, document_schema_js.colorToRgbHex)(fill)}`;
+}
+function fillAttr(fill) {
+	return fill === void 0 ? " fill=\"none\"" : ` fill="${svgColor(fill)}"`;
+}
+function strokeAttr(vector, stroke, sink) {
+	let attrs = ` stroke="${svgColor(stroke.color)}" stroke-width="${require_edit_odg_svg_path.formatPathNumber(stroke.widthPt)}"`;
+	if (stroke.style === "dashed") attrs += ` stroke-dasharray="${DASHED_PATTERN}"`;
+	else if (stroke.style === "dotted") attrs += ` stroke-dasharray="${DOTTED_PATTERN}" stroke-linecap="round"`;
+	else if (stroke.style === "double") sink?.({
+		code: "svg/stroke-style-unsupported",
+		detail: `${vector.sourcePath ?? vector.kind}: stroke style 'double' written as solid`
+	});
+	return attrs;
+}
+function rotationAttr(rotationDeg, frame) {
+	if (rotationDeg === void 0 || rotationDeg === 0) return "";
+	const cx = frame.xPt + frame.widthPt / 2;
+	const cy = frame.yPt + frame.heightPt / 2;
+	return ` transform="rotate(${require_edit_odg_svg_path.formatPathNumber(rotationDeg)} ${require_edit_odg_svg_path.formatPathNumber(cx)} ${require_edit_odg_svg_path.formatPathNumber(cy)})"`;
+}
+function offsetSubpaths(subpaths, offsetX, offsetY) {
+	const offsetPoint = (point) => ({
+		xPt: point.xPt + offsetX,
+		yPt: point.yPt + offsetY
+	});
+	return subpaths.map((subpath) => ({
+		start: offsetPoint(subpath.start),
+		closed: subpath.closed,
+		segments: subpath.segments.map((segment) => segment.kind === "line" ? {
+			kind: "line",
+			to: offsetPoint(segment.to)
+		} : {
+			kind: "cubic",
+			control1: offsetPoint(segment.control1),
+			control2: offsetPoint(segment.control2),
+			to: offsetPoint(segment.to)
+		})
+	}));
+}
+function vectorElement(vector, sink) {
+	switch (vector.kind) {
+		case "rect": return `<rect x="${require_edit_odg_svg_path.formatPathNumber(vector.frame.xPt)}" y="${require_edit_odg_svg_path.formatPathNumber(vector.frame.yPt)}" width="${require_edit_odg_svg_path.formatPathNumber(vector.frame.widthPt)}" height="${require_edit_odg_svg_path.formatPathNumber(vector.frame.heightPt)}"${fillAttr(vector.fill)}${vector.stroke === void 0 ? "" : strokeAttr(vector, vector.stroke, sink)}${rotationAttr(vector.rotationDeg, vector.frame)}/>`;
+		case "ellipse": {
+			const cx = vector.frame.xPt + vector.frame.widthPt / 2;
+			const cy = vector.frame.yPt + vector.frame.heightPt / 2;
+			const rx = vector.frame.widthPt / 2;
+			const ry = vector.frame.heightPt / 2;
+			return `<ellipse cx="${require_edit_odg_svg_path.formatPathNumber(cx)}" cy="${require_edit_odg_svg_path.formatPathNumber(cy)}" rx="${require_edit_odg_svg_path.formatPathNumber(rx)}" ry="${require_edit_odg_svg_path.formatPathNumber(ry)}"${fillAttr(vector.fill)}${vector.stroke === void 0 ? "" : strokeAttr(vector, vector.stroke, sink)}${rotationAttr(vector.rotationDeg, vector.frame)}/>`;
+		}
+		case "line": return `<line x1="${require_edit_odg_svg_path.formatPathNumber(vector.from.xPt)}" y1="${require_edit_odg_svg_path.formatPathNumber(vector.from.yPt)}" x2="${require_edit_odg_svg_path.formatPathNumber(vector.to.xPt)}" y2="${require_edit_odg_svg_path.formatPathNumber(vector.to.yPt)}"${strokeAttr(vector, vector.stroke, sink)}/>`;
+		case "path": {
+			const d = require_edit_odg_svg_path.buildSvgPathData(offsetSubpaths(vector.subpaths, vector.frame.xPt, vector.frame.yPt));
+			const fillRule = vector.fillRule === "evenodd" ? " fill-rule=\"evenodd\"" : "";
+			return `<path d="${d}"${fillAttr(vector.fill)}${vector.stroke === void 0 ? "" : strokeAttr(vector, vector.stroke, sink)}${fillRule}${rotationAttr(vector.rotationDeg, vector.frame)}/>`;
+		}
+	}
+}
+function shapeDetail(shape) {
+	return shape.name ?? shape.sourcePath ?? "shape";
+}
+function buildSvgText(content, options) {
+	if (content.kind !== "drawing") throw new SvgUnsupportedDocumentKindError(content.kind);
+	const sink = options?.onSvgDiagnostic;
+	const page = selectPage(content.pages, options?.page);
+	const lines = [];
+	lines.push("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
+	lines.push(`<svg xmlns="http://www.w3.org/2000/svg" width="${require_edit_odg_svg_path.formatPathNumber(page.size.widthPt)}pt" height="${require_edit_odg_svg_path.formatPathNumber(page.size.heightPt)}pt" viewBox="${require_edit_odg_svg_path.buildSvgViewBox(page.size.widthPt, page.size.heightPt)}">`);
+	if (content.metadata.title !== void 0 && content.metadata.title !== "") lines.push(`  <title>${(0, odf_js.encodeXmlText)(content.metadata.title)}</title>`);
+	for (const entry of require_model_paint_order.mergeByPaintOrder(page.vectors, page.shapes)) if (entry.kind === "vector") lines.push(`  ${vectorElement(entry.value, sink)}`);
+	else sink?.({
+		code: "svg/shape-unsupported",
+		detail: `${shapeDetail(entry.value)}: draw:frame text/image/table content has no SVG vector representation`
+	});
+	lines.push("</svg>");
+	return `${lines.join("\n")}\n`;
+}
+//#endregion
+exports.SvgMultiPageNotSpecifiedError = SvgMultiPageNotSpecifiedError;
+exports.SvgPageNotFoundError = SvgPageNotFoundError;
+exports.SvgUnsupportedDocumentKindError = SvgUnsupportedDocumentKindError;
+exports.buildSvgText = buildSvgText;

package/dist/svg/write.d.cts

@@ -0,0 +1,23 @@
+import { SvgDiagnosticSink } from "./diagnostics.cjs";
+import { ContentDocument } from "document-schema.js";
+//#region src/svg/write.d.ts
+declare class SvgUnsupportedDocumentKindError extends Error {
+  readonly kind: ContentDocument['kind'];
+  constructor(kind: ContentDocument['kind']);
+}
+declare class SvgMultiPageNotSpecifiedError extends Error {
+  readonly pageCount: number;
+  constructor(pageCount: number);
+}
+declare class SvgPageNotFoundError extends Error {
+  readonly page: number;
+  readonly pageCount: number;
+  constructor(page: number, pageCount: number);
+}
+interface BuildSvgTextOptions {
+  readonly page?: number;
+  readonly onSvgDiagnostic?: SvgDiagnosticSink;
+}
+declare function buildSvgText(content: ContentDocument, options?: BuildSvgTextOptions): string;
+//#endregion
+export { BuildSvgTextOptions, SvgMultiPageNotSpecifiedError, SvgPageNotFoundError, SvgUnsupportedDocumentKindError, buildSvgText };

package/dist/svg/write.d.ts

@@ -0,0 +1,23 @@
+import { SvgDiagnosticSink } from "./diagnostics.js";
+import { ContentDocument } from "document-schema.js";
+//#region src/svg/write.d.ts
+declare class SvgUnsupportedDocumentKindError extends Error {
+  readonly kind: ContentDocument['kind'];
+  constructor(kind: ContentDocument['kind']);
+}
+declare class SvgMultiPageNotSpecifiedError extends Error {
+  readonly pageCount: number;
+  constructor(pageCount: number);
+}
+declare class SvgPageNotFoundError extends Error {
+  readonly page: number;
+  readonly pageCount: number;
+  constructor(page: number, pageCount: number);
+}
+interface BuildSvgTextOptions {
+  readonly page?: number;
+  readonly onSvgDiagnostic?: SvgDiagnosticSink;
+}
+declare function buildSvgText(content: ContentDocument, options?: BuildSvgTextOptions): string;
+//#endregion
+export { BuildSvgTextOptions, SvgMultiPageNotSpecifiedError, SvgPageNotFoundError, SvgUnsupportedDocumentKindError, buildSvgText };

package/dist/svg/write.js

@@ -0,0 +1,123 @@
+import { buildSvgPathData, buildSvgViewBox, formatPathNumber } from "../edit/odg/svg-path.js";
+import { mergeByPaintOrder } from "../model/paint-order.js";
+import { colorToRgbHex } from "document-schema.js";
+import { encodeXmlText } from "odf.js";
+//#region src/svg/write.ts
+var SvgUnsupportedDocumentKindError = class extends Error {
+	kind;
+	constructor(kind) {
+		super(`buildSvgText: expected a drawing ContentDocument, got kind '${kind}'`);
+		this.name = "SvgUnsupportedDocumentKindError";
+		this.kind = kind;
+	}
+};
+var SvgMultiPageNotSpecifiedError = class extends Error {
+	pageCount;
+	constructor(pageCount) {
+		super(`buildSvgText: this document has more than one page (${pageCount}) -- pass { page: <index> } to select one`);
+		this.name = "SvgMultiPageNotSpecifiedError";
+		this.pageCount = pageCount;
+	}
+};
+var SvgPageNotFoundError = class extends Error {
+	page;
+	pageCount;
+	constructor(page, pageCount) {
+		super(`buildSvgText: page index ${page} not found -- the document has ${pageCount} page(s)`);
+		this.name = "SvgPageNotFoundError";
+		this.page = page;
+		this.pageCount = pageCount;
+	}
+};
+function selectPage(pages, page) {
+	if (page !== void 0) {
+		const found = pages[page];
+		if (found === void 0) throw new SvgPageNotFoundError(page, pages.length);
+		return found;
+	}
+	if (pages.length === 0) throw new SvgPageNotFoundError(0, 0);
+	if (pages.length > 1) throw new SvgMultiPageNotSpecifiedError(pages.length);
+	return pages[0];
+}
+const DASHED_PATTERN = "6 4";
+const DOTTED_PATTERN = "1 3";
+function svgColor(fill) {
+	return `#${colorToRgbHex(fill)}`;
+}
+function fillAttr(fill) {
+	return fill === void 0 ? " fill=\"none\"" : ` fill="${svgColor(fill)}"`;
+}
+function strokeAttr(vector, stroke, sink) {
+	let attrs = ` stroke="${svgColor(stroke.color)}" stroke-width="${formatPathNumber(stroke.widthPt)}"`;
+	if (stroke.style === "dashed") attrs += ` stroke-dasharray="${DASHED_PATTERN}"`;
+	else if (stroke.style === "dotted") attrs += ` stroke-dasharray="${DOTTED_PATTERN}" stroke-linecap="round"`;
+	else if (stroke.style === "double") sink?.({
+		code: "svg/stroke-style-unsupported",
+		detail: `${vector.sourcePath ?? vector.kind}: stroke style 'double' written as solid`
+	});
+	return attrs;
+}
+function rotationAttr(rotationDeg, frame) {
+	if (rotationDeg === void 0 || rotationDeg === 0) return "";
+	const cx = frame.xPt + frame.widthPt / 2;
+	const cy = frame.yPt + frame.heightPt / 2;
+	return ` transform="rotate(${formatPathNumber(rotationDeg)} ${formatPathNumber(cx)} ${formatPathNumber(cy)})"`;
+}
+function offsetSubpaths(subpaths, offsetX, offsetY) {
+	const offsetPoint = (point) => ({
+		xPt: point.xPt + offsetX,
+		yPt: point.yPt + offsetY
+	});
+	return subpaths.map((subpath) => ({
+		start: offsetPoint(subpath.start),
+		closed: subpath.closed,
+		segments: subpath.segments.map((segment) => segment.kind === "line" ? {
+			kind: "line",
+			to: offsetPoint(segment.to)
+		} : {
+			kind: "cubic",
+			control1: offsetPoint(segment.control1),
+			control2: offsetPoint(segment.control2),
+			to: offsetPoint(segment.to)
+		})
+	}));
+}
+function vectorElement(vector, sink) {
+	switch (vector.kind) {
+		case "rect": return `<rect x="${formatPathNumber(vector.frame.xPt)}" y="${formatPathNumber(vector.frame.yPt)}" width="${formatPathNumber(vector.frame.widthPt)}" height="${formatPathNumber(vector.frame.heightPt)}"${fillAttr(vector.fill)}${vector.stroke === void 0 ? "" : strokeAttr(vector, vector.stroke, sink)}${rotationAttr(vector.rotationDeg, vector.frame)}/>`;
+		case "ellipse": {
+			const cx = vector.frame.xPt + vector.frame.widthPt / 2;
+			const cy = vector.frame.yPt + vector.frame.heightPt / 2;
+			const rx = vector.frame.widthPt / 2;
+			const ry = vector.frame.heightPt / 2;
+			return `<ellipse cx="${formatPathNumber(cx)}" cy="${formatPathNumber(cy)}" rx="${formatPathNumber(rx)}" ry="${formatPathNumber(ry)}"${fillAttr(vector.fill)}${vector.stroke === void 0 ? "" : strokeAttr(vector, vector.stroke, sink)}${rotationAttr(vector.rotationDeg, vector.frame)}/>`;
+		}
+		case "line": return `<line x1="${formatPathNumber(vector.from.xPt)}" y1="${formatPathNumber(vector.from.yPt)}" x2="${formatPathNumber(vector.to.xPt)}" y2="${formatPathNumber(vector.to.yPt)}"${strokeAttr(vector, vector.stroke, sink)}/>`;
+		case "path": {
+			const d = buildSvgPathData(offsetSubpaths(vector.subpaths, vector.frame.xPt, vector.frame.yPt));
+			const fillRule = vector.fillRule === "evenodd" ? " fill-rule=\"evenodd\"" : "";
+			return `<path d="${d}"${fillAttr(vector.fill)}${vector.stroke === void 0 ? "" : strokeAttr(vector, vector.stroke, sink)}${fillRule}${rotationAttr(vector.rotationDeg, vector.frame)}/>`;
+		}
+	}
+}
+function shapeDetail(shape) {
+	return shape.name ?? shape.sourcePath ?? "shape";
+}
+function buildSvgText(content, options) {
+	if (content.kind !== "drawing") throw new SvgUnsupportedDocumentKindError(content.kind);
+	const sink = options?.onSvgDiagnostic;
+	const page = selectPage(content.pages, options?.page);
+	const lines = [];
+	lines.push("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
+	lines.push(`<svg xmlns="http://www.w3.org/2000/svg" width="${formatPathNumber(page.size.widthPt)}pt" height="${formatPathNumber(page.size.heightPt)}pt" viewBox="${buildSvgViewBox(page.size.widthPt, page.size.heightPt)}">`);
+	if (content.metadata.title !== void 0 && content.metadata.title !== "") lines.push(`  <title>${encodeXmlText(content.metadata.title)}</title>`);
+	for (const entry of mergeByPaintOrder(page.vectors, page.shapes)) if (entry.kind === "vector") lines.push(`  ${vectorElement(entry.value, sink)}`);
+	else sink?.({
+		code: "svg/shape-unsupported",
+		detail: `${shapeDetail(entry.value)}: draw:frame text/image/table content has no SVG vector representation`
+	});
+	lines.push("</svg>");
+	return `${lines.join("\n")}\n`;
+}
+//#endregion
+export { SvgMultiPageNotSpecifiedError, SvgPageNotFoundError, SvgUnsupportedDocumentKindError, buildSvgText };

package/dist/xml/odf-text.js

@@ -1,5 +1,5 @@
 import { el, txt } from "./fragment.js";
-import { encodeXmlText } from "./entities.js";
+import { encodeXmlText as encodeXmlText$1 } from "./entities.js";
 import { decodeOdfText as decodeOdfText$1 } from "odf.js";
 //#region src/xml/odf-text.ts
 const MIN_SPACE_RUN_FOR_TEXT_S = 2;
@@ -8,7 +8,7 @@ function encodeOdfText(text) {
 	let literal = "";
 	const flushLiteral = () => {
 		if (literal.length > 0) {
-			nodes.push(txt(encodeXmlText(literal)));
+			nodes.push(txt(encodeXmlText$1(literal)));
 			literal = "";
 		}
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js.documents",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Bidirectional docx/pptx <-> PDF conversion and a read+write editable OOXML document model, built on ooxml.js and Zod 4 codecs.",
   "type": "module",
   "repository": {