hdoc-tools 0.60.1 → 0.62.0

package/hdoc-build-pdf.js

@@ -1,232 +1,232 @@
-(() => {
-	const cheerio = require("cheerio");
-	const fs = require("node:fs");
-	const path = require("node:path");
-	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
-
-	let hb_logo = "";
-	let footer = "";
-	let header = "";
-
-	const get_footer = (template_path) => {
-		let footer_content = null;
-		try {
-			footer_content = fs.readFileSync(
-				path.join(template_path, "template-footer.html"),
-				"utf8",
-			);
-		} catch (err) {
-			console.error(`Error loading template: ${err}`);
-		}
-		return footer_content;
-	};
-
-	const get_header = (template_path) => {
-		let header_content = null;
-		try {
-			header_content = fs.readFileSync(
-				path.join(template_path, "template-header.html"),
-				"utf8",
-			);
-		} catch (err) {
-			console.error(`Error loading template: ${err}`);
-		}
-		return header_content;
-	};
-
-	exports.process_images = async (file_path, html_source, verbose) => {
-		const book_work_root = file_path.path.replace(file_path.relativePath, "");
-		if (verbose) console.log("Parsing img tags from HTML source");
-
-		let processed_html_source = html_source;
-		// Use cheerio to parse html
-		const $ = cheerio.load(processed_html_source);
-
-		// Get iFrames from HTML, to replace with a tags
-		const iframes = [];
-		const iframe_html = $("iframe")
-			.map(function () {
-				const response = {
-					html: $.html(this),
-					src: $(this).attr("src"),
-					title: $(this).attr("title")
-						? $(this).attr("title")
-						: "No Link Title Provided",
-				};
-				return response;
-			})
-			.get();
-		iframes.push(...iframe_html);
-		for (let i = 0; i < iframes.length; i++) {
-			const link = `<p><a href="${iframes[i].src}">${iframes[i].title}</a></p>`;
-			const regex = new RegExp(
-				`<iframe.*src="${iframes[i].src.replace("/", "\\/")}".*</iframe>`,
-			);
-			processed_html_source = processed_html_source.replace(regex, link);
-		}
-
-		// Get image links from HTML, to embed into the pdf
-		const imgs = [];
-		const srcs = $("img")
-			.map(function (i) {
-				return $(this).attr("src");
-			})
-			.get();
-		imgs.push(...srcs);
-		for (let i = 0; i < imgs.length; i++) {
-			if (!hdoc.valid_url(imgs[i])) {
-				// Internal link
-				const image_path = path.join(
-					book_work_root,
-					imgs[i].replace("_books/", ""),
-				);
-				try {
-					const image_buffer = fs.readFileSync(image_path);
-					// Inline MIME type lookup for image formats commonly found in documentation.
-				// Falls back to application/octet-stream for any unrecognised extension so the
-				// base64 data URI is still well-formed even if the browser can't render it.
-				const mime_type = ({ '.png': 'image/png', '.jpg': 'image/jpeg', '.jpeg': 'image/jpeg', '.gif': 'image/gif', '.svg': 'image/svg+xml', '.webp': 'image/webp', '.bmp': 'image/bmp', '.ico': 'image/x-icon' })[path.extname(image_path).toLowerCase()] || 'application/octet-stream';
-					let image_b64 = image_buffer.toString("base64");
-					image_b64 = `data:${mime_type};base64,${image_b64}`;
-					processed_html_source = processed_html_source.replace(
-						imgs[i],
-						image_b64,
-					);
-				} catch (err) {
-					console.error(
-						"Error reading image from HTML source [",
-						image_path,
-						"] -",
-						err,
-					);
-					return null;
-				}
-			} else {
-				// External Link
-				try {
-					const file_response = await fetch(imgs[i]);
-					if (file_response.status === 200) {
-						let image_b64 = imageEncode(await file_response.arrayBuffer(), file_response.headers.get('content-type'));
-						
-						
-						const regexQ = `<img\\s+[^>]*src=["']${imgs[i].replaceAll('/', '\\/').replaceAll('.', '\\.')}["'][^>]*>`;
-						const regex = new RegExp(regexQ);
-
-						const found_img_tag = processed_html_source.match(regex);
-						const new_img_tag = found_img_tag[0].replace(imgs[i], image_b64);
-						
-						processed_html_source = processed_html_source.replace(
-							found_img_tag,
-							new_img_tag,
-						);
-					} else {
-						throw `Unexpected Status ${file_response.status}`;
-					}
-				} catch (err) {
-					console.error(
-						`Error downloading external source [${imgs[i]}] - ${err}`,
-					);
-				}
-			}
-		}
-
-		return processed_html_source;
-	};
-
-	const imageEncode = (arrayBuffer, mimeType) => {
-		let u8 = new Uint8Array(arrayBuffer)
-		let b64encoded = btoa([].reduce.call(new Uint8Array(arrayBuffer),function(p,c){return p+String.fromCharCode(c)},''))
-		let mimetype=`image/${mimeType}`
-		return "data:"+mimetype+";base64,"+b64encoded
-	}
-
-	exports.generate_pdf = async (
-		browser,
-		pdf_template_path,
-		pdf_template_content,
-		book_config,
-		html_source,
-		target_file,
-		css_templates,
-		verbose = false,
-	) => {
-		let pdf_size = 0;
-		// Cache footer
-		if (footer === "") footer = get_footer(pdf_template_path);
-
-		// Read svg logo file into buffer, convert to B64 string
-		if (hb_logo === "") {
-			const hb_logo_path = path.join(
-				pdf_template_path,
-				"images",
-				"hornbill-logo-full.svg",
-			);
-			try {
-				const hb_logo_file_buffer = fs.readFileSync(hb_logo_path);
-				hb_logo = hb_logo_file_buffer.toString("base64");
-				hb_logo = `data:image/svg+xml;base64,${hb_logo}`;
-			} catch (err) {
-				console.error("Error reading logo from template:", err);
-				return pdf_size;
-			}
-		}
-
-		// Cache header
-		if (header === "") {
-			header = get_header(pdf_template_path)
-				.replace("{{book_title}}", book_config.title)
-				.replace("{{hb_logo}}", hb_logo);
-		}
-
-		const processed_html_source = pdf_template_content
-			.replace("{{book_title}}", book_config.title)
-			.replace("{{document_content}}", html_source);
-
-		const page = await browser.newPage();
-
-		// To reflect CSS used for screens instead of print
-		await page.emulateMediaType("screen");
-
-		// Set HTML content from HTML source
-		await page.setContent(processed_html_source, {
-			waitUntil: "domcontentloaded",
-		});
-		for (let i = 0; i < css_templates.length; i++) {
-			try {
-				await page.addStyleTag({
-					content: css_templates[i],
-				});
-			} catch (e) {
-				console.error(`Error applying template for [${target_file}]: ${e}`);
-			}
-		}
-
-		try {
-			const pdf_gen = await page.pdf({
-				path: target_file,
-				printBackground: true,
-				format: "A4",
-				displayHeaderFooter: true,
-				headerTemplate: header,
-				footerTemplate: footer,
-				margin: {
-					top: "90px",
-					right: "30px",
-					bottom: "60px",
-					left: "30px",
-				},
-				timeout: 0,
-			});
-			const currdate = new Date();
-			const datetime = currdate.toISOString();
-			if (verbose)
-				console.log(`[${datetime}] PDF generation success: ${target_file}`);
-
-			pdf_size = pdf_gen.byteLength;
-		} catch (err) {
-			console.error(`Error generating PDF ${target_file} - ${err}`);
-		}
-		await page.close();
-		return pdf_size;
-	};
-})();
+(() => {
+	const cheerio = require("cheerio");
+	const fs = require("node:fs");
+	const path = require("node:path");
+	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
+
+	let hb_logo = "";
+	let footer = "";
+	let header = "";
+
+	const get_footer = (template_path) => {
+		let footer_content = null;
+		try {
+			footer_content = fs.readFileSync(
+				path.join(template_path, "template-footer.html"),
+				"utf8",
+			);
+		} catch (err) {
+			console.error(`Error loading template: ${err}`);
+		}
+		return footer_content;
+	};
+
+	const get_header = (template_path) => {
+		let header_content = null;
+		try {
+			header_content = fs.readFileSync(
+				path.join(template_path, "template-header.html"),
+				"utf8",
+			);
+		} catch (err) {
+			console.error(`Error loading template: ${err}`);
+		}
+		return header_content;
+	};
+
+	exports.process_images = async (file_path, html_source, verbose) => {
+		const book_work_root = file_path.path.replace(file_path.relativePath, "");
+		if (verbose) console.log("Parsing img tags from HTML source");
+
+		let processed_html_source = html_source;
+		// Use cheerio to parse html
+		const $ = cheerio.load(processed_html_source);
+
+		// Get iFrames from HTML, to replace with a tags
+		const iframes = [];
+		const iframe_html = $("iframe")
+			.map(function () {
+				const response = {
+					html: $.html(this),
+					src: $(this).attr("src"),
+					title: $(this).attr("title")
+						? $(this).attr("title")
+						: "No Link Title Provided",
+				};
+				return response;
+			})
+			.get();
+		iframes.push(...iframe_html);
+		for (let i = 0; i < iframes.length; i++) {
+			const link = `<p><a href="${iframes[i].src}">${iframes[i].title}</a></p>`;
+			const regex = new RegExp(
+				`<iframe.*src="${iframes[i].src.replace("/", "\\/")}".*</iframe>`,
+			);
+			processed_html_source = processed_html_source.replace(regex, link);
+		}
+
+		// Get image links from HTML, to embed into the pdf
+		const imgs = [];
+		const srcs = $("img")
+			.map(function (i) {
+				return $(this).attr("src");
+			})
+			.get();
+		imgs.push(...srcs);
+		for (let i = 0; i < imgs.length; i++) {
+			if (!hdoc.valid_url(imgs[i])) {
+				// Internal link
+				const image_path = path.join(
+					book_work_root,
+					imgs[i].replace("_books/", ""),
+				);
+				try {
+					const image_buffer = fs.readFileSync(image_path);
+					// Inline MIME type lookup for image formats commonly found in documentation.
+				// Falls back to application/octet-stream for any unrecognised extension so the
+				// base64 data URI is still well-formed even if the browser can't render it.
+				const mime_type = ({ '.png': 'image/png', '.jpg': 'image/jpeg', '.jpeg': 'image/jpeg', '.gif': 'image/gif', '.svg': 'image/svg+xml', '.webp': 'image/webp', '.bmp': 'image/bmp', '.ico': 'image/x-icon' })[path.extname(image_path).toLowerCase()] || 'application/octet-stream';
+					let image_b64 = image_buffer.toString("base64");
+					image_b64 = `data:${mime_type};base64,${image_b64}`;
+					processed_html_source = processed_html_source.replace(
+						imgs[i],
+						image_b64,
+					);
+				} catch (err) {
+					console.error(
+						"Error reading image from HTML source [",
+						image_path,
+						"] -",
+						err,
+					);
+					return null;
+				}
+			} else {
+				// External Link
+				try {
+					const file_response = await fetch(imgs[i]);
+					if (file_response.status === 200) {
+						let image_b64 = imageEncode(await file_response.arrayBuffer(), file_response.headers.get('content-type'));
+						
+						
+						const regexQ = `<img\\s+[^>]*src=["']${imgs[i].replaceAll('/', '\\/').replaceAll('.', '\\.')}["'][^>]*>`;
+						const regex = new RegExp(regexQ);
+
+						const found_img_tag = processed_html_source.match(regex);
+						const new_img_tag = found_img_tag[0].replace(imgs[i], image_b64);
+						
+						processed_html_source = processed_html_source.replace(
+							found_img_tag,
+							new_img_tag,
+						);
+					} else {
+						throw `Unexpected Status ${file_response.status}`;
+					}
+				} catch (err) {
+					console.error(
+						`Error downloading external source [${imgs[i]}] - ${err}`,
+					);
+				}
+			}
+		}
+
+		return processed_html_source;
+	};
+
+	const imageEncode = (arrayBuffer, mimeType) => {
+		let u8 = new Uint8Array(arrayBuffer)
+		let b64encoded = btoa([].reduce.call(new Uint8Array(arrayBuffer),function(p,c){return p+String.fromCharCode(c)},''))
+		let mimetype=`image/${mimeType}`
+		return "data:"+mimetype+";base64,"+b64encoded
+	}
+
+	exports.generate_pdf = async (
+		browser,
+		pdf_template_path,
+		pdf_template_content,
+		book_config,
+		html_source,
+		target_file,
+		css_templates,
+		verbose = false,
+	) => {
+		let pdf_size = 0;
+		// Cache footer
+		if (footer === "") footer = get_footer(pdf_template_path);
+
+		// Read svg logo file into buffer, convert to B64 string
+		if (hb_logo === "") {
+			const hb_logo_path = path.join(
+				pdf_template_path,
+				"images",
+				"hornbill-logo-full.svg",
+			);
+			try {
+				const hb_logo_file_buffer = fs.readFileSync(hb_logo_path);
+				hb_logo = hb_logo_file_buffer.toString("base64");
+				hb_logo = `data:image/svg+xml;base64,${hb_logo}`;
+			} catch (err) {
+				console.error("Error reading logo from template:", err);
+				return pdf_size;
+			}
+		}
+
+		// Cache header
+		if (header === "") {
+			header = get_header(pdf_template_path)
+				.replace("{{book_title}}", book_config.title)
+				.replace("{{hb_logo}}", hb_logo);
+		}
+
+		const processed_html_source = pdf_template_content
+			.replace("{{book_title}}", book_config.title)
+			.replace("{{document_content}}", html_source);
+
+		const page = await browser.newPage();
+
+		// To reflect CSS used for screens instead of print
+		await page.emulateMediaType("screen");
+
+		// Set HTML content from HTML source
+		await page.setContent(processed_html_source, {
+			waitUntil: "domcontentloaded",
+		});
+		for (let i = 0; i < css_templates.length; i++) {
+			try {
+				await page.addStyleTag({
+					content: css_templates[i],
+				});
+			} catch (e) {
+				console.error(`Error applying template for [${target_file}]: ${e}`);
+			}
+		}
+
+		try {
+			const pdf_gen = await page.pdf({
+				path: target_file,
+				printBackground: true,
+				format: "A4",
+				displayHeaderFooter: true,
+				headerTemplate: header,
+				footerTemplate: footer,
+				margin: {
+					top: "90px",
+					right: "30px",
+					bottom: "60px",
+					left: "30px",
+				},
+				timeout: 0,
+			});
+			const currdate = new Date();
+			const datetime = currdate.toISOString();
+			if (verbose)
+				console.log(`[${datetime}] PDF generation success: ${target_file}`);
+
+			pdf_size = pdf_gen.byteLength;
+		} catch (err) {
+			console.error(`Error generating PDF ${target_file} - ${err}`);
+		}
+		await page.close();
+		return pdf_size;
+	};
+})();

package/hdoc-build.js

@@ -9,7 +9,6 @@
 	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
 	const hdoc_build_db = require(path.join(__dirname, "hdoc-build-db.js"));
 	const hdoc_build_embeddings = require(path.join(__dirname, "hdoc-build-embeddings.js"));
-	const hdoc_build_onyx = require(path.join(__dirname, "hdoc-build-onyx.js"));
 	const hdoc_build_pdf = require(path.join(__dirname, "hdoc-build-pdf.js"));
 	const hdoc_index = require(path.join(__dirname, "hdoc-db.js"));
 	const hdoc_mermaid = require(path.join(__dirname, "hdoc-mermaid.js"));
@@ -49,9 +48,14 @@
 		"pdf-header-non-git.html",
 	);
 
+	// Mermaid theme — SINGLE source shared with the client-side renderer
+	// (ui/js/doc.hornbill.js fetches the same file). Emitted into each queued
+	// diagram as YAML frontmatter; inline JSON is valid YAML, so no conversion.
 	const mermaid_theme_path = path.resolve(
-		templates_path,
-		"mermaid-theme.yaml",
+		__dirname,
+		"ui",
+		"js",
+		"mermaid-theme.json",
 	);
 
 	const pdf_template_path = path.join(__dirname, "templates", "pdf");
@@ -171,7 +175,8 @@
 
 				let definition = str;
 				if (!definition.startsWith('---')) {
-					definition = '---\n' + fs.readFileSync(mermaid_theme_path, {encoding: 'utf-8'}) + `\n---\n${definition}`;
+					const theme_json = fs.readFileSync(mermaid_theme_path, {encoding: 'utf-8'});
+					definition = `---\nconfig: ${JSON.stringify(JSON.parse(theme_json))}\n---\n${definition}`;
 				}
 
 				// Dedupe identical diagrams (same hash -> same output file).
@@ -1097,7 +1102,9 @@
 			"hdocbook-project.json",
 		);
 		try {
-			hdocbook_project = require(hdocbook_project_config_path);
+			hdocbook_project = JSON.parse(
+				fs.readFileSync(hdocbook_project_config_path, "utf8"),
+			);
 		} catch (e) {
 			console.error("File not found: hdocbook-project.json\n");
 			console.error(
@@ -1147,7 +1154,7 @@
 		const work_hdocbook_path = path.join(work_path, doc_id, "hdocbook.json");
 
 		try {
-			hdocbook_config = require(hdocbook_path);
+			hdocbook_config = JSON.parse(fs.readFileSync(hdocbook_path, "utf8"));
 		} catch (e) {
 			console.error(`File not found: ${doc_id}/hdocbook.json\n`);
 			process.exit(1);
@@ -1476,6 +1483,7 @@
 			browser,
 			source_path,
 			output_links,
+			git_token,
 		);
 
 		// Close the Chromium browser instance

package/hdoc-bump.js

@@ -20,7 +20,9 @@
 		);
 		let hdocbook_project;
 		try {
-			hdocbook_project = require(hdocbook_project_config_path);
+			hdocbook_project = JSON.parse(
+				fs.readFileSync(hdocbook_project_config_path, "utf8"),
+			);
 		} catch (e) {
 			console.error("File not found: hdocbook-project.json:");
 			console.error(e, "\n");
@@ -34,7 +36,7 @@
 
 		let hdocbook_config;
 		try {
-			hdocbook_config = require(hdocbook_path);
+			hdocbook_config = JSON.parse(fs.readFileSync(hdocbook_path, "utf8"));
 		} catch (e) {
 			console.error("File not found: hdocbook.json");
 			console.error(e, "\n");