hdoc-tools 0.19.7 → 0.20.0

package/custom_modules/tips.js

@@ -1,86 +1,88 @@
-(function () {
-    'use strict';
-
-    // GS: based on markdown-it-tips extension but customized for our specific needs
-
-    var container = require('markdown-it-container');
-
-    module.exports = function md_tip_plugin(md, options) {
-        var containerOpenCount = 0;
-        var links = options ? options.links : true;
-        init();
-        return;
-
-        function icon_from_type(name) {
-            switch (name) {
-                case "note":
-                    return {
-                        class: "bi bi-exclamation-circle", title: "Note"
-                    };
-                case "tip":
-                    return {
-                        class: "bi bi-lightbulb", title: "Tip"
-                    };
-                case "important":
-                    return {
-                        class: "bi bi-megaphone", title: "Important"
-                    };
-                case "caution":
-                    return {
-                        class: "bi bi-x-circle", title: "Caution"
-                    };
-                case "warning":
-                    return {
-                        class: "bi bi-exclamation-triangle", title: "Warning"
-                    };
-            }
-        }
-
-        function setupContainer(name) {
-            md.use(container, name, {
-                render: function (tokens, idx) {
-                    if (tokens[idx].nesting === 1) {
-                        containerOpenCount += 1;
-                        let inf = icon_from_type(name);
-                        return '<div class="hdoc-alert alert-icon-' + name + '">\n<p class="hdoc-alert-title"><span class="' + inf.class + '"></span>' + inf.title + '</p>\n';
-                    } else {
-                        containerOpenCount -= 1;
-                        return '</div>\n';
-                    }
-                }
-            });
-        }
-
-        function isContainerOpen() {
-            return containerOpenCount > 0;
-        }
-
-        function selfRender(tokens, idx, options, env, self) {
-            return self.renderToken(tokens, idx, options);
-        }
-
-        function setupLinks() {
-            var defaultRender = md.renderer.rules.link_open || selfRender;
-
-            md.renderer.rules.link_open = function (tokens, idx, options, env, self) {
-                if (isContainerOpen()) {
-                    tokens[idx].attrPush(['class', 'md-tip-link']);
-                }
-
-                return defaultRender(tokens, idx, options, env, self);
-            };
-        }
-
-        function init() {
-            setupContainer('note');
-            setupContainer('tip');
-            setupContainer('important');
-            setupContainer('caution');
-            setupContainer('warning');
-
-            if (links) {
-                setupLinks();
-            }
-        }
-    };
-})();
+(() => {
+	// GS: based on markdown-it-tips extension but customized for our specific needs
+
+	const container = require("markdown-it-container");
+
+	module.exports = function md_tip_plugin(md, options) {
+		let containerOpenCount = 0;
+		const links = options ? options.links : true;
+		init();
+		return;
+
+		function icon_from_type(name) {
+			switch (name) {
+				case "note":
+					return {
+						class: "bi bi-exclamation-circle",
+						title: "Note",
+					};
+				case "tip":
+					return {
+						class: "bi bi-lightbulb",
+						title: "Tip",
+					};
+				case "important":
+					return {
+						class: "bi bi-megaphone",
+						title: "Important",
+					};
+				case "caution":
+					return {
+						class: "bi bi-x-circle",
+						title: "Caution",
+					};
+				case "warning":
+					return {
+						class: "bi bi-exclamation-triangle",
+						title: "Warning",
+					};
+			}
+		}
+
+		function setupContainer(name) {
+			md.use(container, name, {
+				render: (tokens, idx) => {
+					if (tokens[idx].nesting === 1) {
+						containerOpenCount += 1;
+						const inf = icon_from_type(name);
+						return `<div class="hdoc-alert alert-icon-${name}">\n<p class="hdoc-alert-title"><span class="${inf.class}"></span>${inf.title}</p>\n`;
+					}
+					containerOpenCount -= 1;
+					return "</div>\n";
+				},
+			});
+		}
+
+		function isContainerOpen() {
+			return containerOpenCount > 0;
+		}
+
+		function selfRender(tokens, idx, options, env, self) {
+			return self.renderToken(tokens, idx, options);
+		}
+
+		function setupLinks() {
+			const defaultRender = md.renderer.rules.link_open || selfRender;
+
+			md.renderer.rules.link_open = (tokens, idx, options, env, self) => {
+				if (isContainerOpen()) {
+					tokens[idx].attrPush(["class", "md-tip-link"]);
+				}
+
+				return defaultRender(tokens, idx, options, env, self);
+			};
+		}
+
+		function init() {
+			setupContainer("note");
+			setupContainer("tip");
+			setupContainer("important");
+			setupContainer("caution");
+			setupContainer("warning");
+
+			if (links) {
+				setupLinks();
+			}
+		}
+	};
+})();

package/hdoc-build-db.js

@@ -1,198 +1,260 @@
-(function () {
-    'use strict';
-
-    const path = require('path'),
-        hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
-        database = require('better-sqlite3');
-
-    const db_schema = {
-        hdoc_index: [
-            'resource_url UNINDEXED',
-            'book_id',
-            'book_audience UNINDEXED',
-            'book_tags',
-            'doc_title',
-            'doc_content',
-            'doc_preview UNINDEXED',
-            'doc_family_id',
-            'doc_md5_hash UNINDEXED',
-            'doc_lastmod'
-        ],
-        hdoc_meta: [
-            'resource_url',
-            'book_id',
-            'contributor_count INTEGER UNINDEXED',
-            'edit_url UNINDEXED',
-            'last_commit UNINDEXED',
-            'pdf_size INTEGER UNINDEXED'
-        ],
-        hdoc_contributors: [
-            'resource_url',
-            'book_id',
-            'login',
-            'name',
-            'avatar UNINDEXED',
-            'url UNINDEXED'
-        ],
-        hdoc_redirects: [
-            'resource_url',
-            'location_url',
-            'http_code INTEGER UNINDEXED'
-        ]
-    };
-
-    exports.create_table = function (db, table, cols, virtual, fts5) {
-        const table_created = hdoc_index.create_table(db, table, cols, virtual, fts5);
-        if (table_created !== null) {
-            return `\nError creating table: ${table_created}`;
-        } else {
-            console.log(`\nTable created: ${table}`);
-        }
-        return null;
-    };
-
-    exports.create_db = function (db_path, doc_id) {
-        let response = {
-            error: null,
-            db: null
-        };
-        console.log('\nPerforming SQlite index creation...');
-        let db_name = path.join(db_path, doc_id, 'index.db');
-        response.db = new database(db_name);
-        response.db.pragma('encoding="UTF-8"');
-        console.log(`\nDatabase created: ${db_name}`);
-
-        // Create tables
-        for (const key in db_schema) {
-            if (db_schema.hasOwnProperty(key)) {
-                const virtual = key === 'hdoc_index' ? true : false;
-                const fts5 = key === 'hdoc_index' ? true : false;
-                const table_created_error = this.create_table(response.db, key, db_schema[key], virtual, fts5);
-                if (table_created_error !== null) {
-                    console.error(table_created_error);
-                }
-            }
-        }
-        return response;
-    };
-
-    exports.populate_redirects = function (db, redirect_records, verbose = false) {
-        let response = {
-            success: true,
-            errors: [],
-            index_success_count: 0
-        };
-
-        for (let i = 0; i < redirect_records.length; i++) {
-            const index_vals = [
-                redirect_records[i].url,
-                redirect_records[i].location ? redirect_records[i].location : '',
-                redirect_records[i].code
-            ];
-            const index_response = hdoc_index.insert_record(db, 'hdoc_redirects', db_schema.hdoc_redirects, index_vals);
-            if (!index_response.success) {
-                response.success = false;
-                response.errors.push(`Redirect record creation failed - ${redirect_records[i].url}: ${index_response.error}`);
-            } else {
-                response.index_success_count++
-            }
-        }
-        console.log(`\nRedirect Index Build Complete: ${response.index_success_count} document records created.`);
-        return response;
-    };
-
-    exports.populate_index = async function (db, doc_id, book_config, index_records, verbose = false) {
-        let response = {
-            success: false,
-            index_success_count: 0,
-            error: ''
-        };
-
-        if (!book_config.tags) book_config.tags = [];
-
-        let indexPromises = [];
-        for (let i = 0; i < index_records.length; i++) {
-            indexPromises.push(index_records[i]);
-        }
-        let curr_file = '';
-        await Promise.all(indexPromises.map(async (file) => {
-            let index_path_name = file.relative_path.replaceAll('\\', '/');
-            if (index_path_name.endsWith('/index.md') || index_path_name.endsWith('/index.html') || index_path_name.endsWith('/index.htm')) {
-                index_path_name = index_path_name.substring(0, index_path_name.lastIndexOf('/'));
-            }
-            index_path_name = '/' + index_path_name.replace(path.extname(file.relative_path), '');
-
-            let index_response = {
-                success: true,
-                row_id: 0
-            };
-            let index_content_path = index_path_name;
-            if (file.index_html.id !== null) index_content_path += `#${file.index_html.id}`;
-            if (!file.inline) {
-                const index_vals = [
-                    index_content_path,
-                    doc_id,
-                    book_config.audience.join(','),
-                    book_config.tags.join(','),
-                    file.index_html.fm_props.title,
-                    file.index_html.text,
-                    file.index_html.preview,
-                    book_config.productFamily,
-                    file.md5,
-                    file.lastmod
-                ];
-                index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
-            }
-            if (!index_response.success) {
-                console.error(`Index record creation failed - ${doc_id}/${file.index_html.fm_props.title}: ${index_response.error}`);
-            } else {
-                if (curr_file === index_path_name) return;
-                curr_file = index_path_name;
-                // Now add metadata
-                const meta_vals = [
-                    index_path_name,
-                    doc_id,
-                    file.metadata.contributor_count,
-                    file.metadata.edit_url,
-                    file.metadata.last_commit,
-                    file.pdf_size
-                ];
-                const meta_response = await hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
-                if (!meta_response.success) {
-                    console.error(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${meta_response.error}`);
-                } else {
-                    if (verbose) {
-                        console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.index_html.fm_props.title}`);
-                        console.log(`Inserted index metadata record for index ID: ${meta_response.row_id}`);
-                    }
-
-                    // Now add contributor records
-                    for (let j = 0; j < file.contributors.length; j++) {
-                        const contrib_vals = [
-                            index_path_name,
-                            doc_id,
-                            file.contributors[j].login,
-                            file.contributors[j].name,
-                            file.contributors[j].avatar_url,
-                            file.contributors[j].html_url
-                        ];
-                        const cont_response = await hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
-                        if (!cont_response.success) {
-                            console.error(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${cont_response.error}`);
-                            continue;
-                        }
-                        if (verbose) {
-                            console.log(`Inserted document contributor record ${cont_response.row_id}`);
-                        }
-                    }
-                    response.index_success_count++;
-                }
-            }
-
-        }));
-
-        response.success = true;
-        console.log(`\nIndex Build Complete: ${response.index_success_count} document index records created.`);
-        return response;
-    };
-})();
+(() => {
+	const path = require("node:path");
+	const hdoc_index = require(path.join(__dirname, "hdoc-db.js"));
+	const database = require("better-sqlite3");
+
+	const db_schema = {
+		hdoc_index: [
+			"resource_url UNINDEXED",
+			"book_id",
+			"book_audience UNINDEXED",
+			"book_tags",
+			"doc_title",
+			"doc_content",
+			"doc_preview UNINDEXED",
+			"doc_family_id",
+			"doc_md5_hash UNINDEXED",
+			"doc_lastmod",
+		],
+		hdoc_meta: [
+			"resource_url",
+			"book_id",
+			"contributor_count INTEGER UNINDEXED",
+			"edit_url UNINDEXED",
+			"last_commit UNINDEXED",
+			"pdf_size INTEGER UNINDEXED",
+		],
+		hdoc_contributors: [
+			"resource_url",
+			"book_id",
+			"login",
+			"name",
+			"avatar UNINDEXED",
+			"url UNINDEXED",
+		],
+		hdoc_redirects: [
+			"resource_url",
+			"location_url",
+			"http_code INTEGER UNINDEXED",
+		],
+	};
+
+	exports.create_table = (db, table, cols, virtual, fts5) => {
+		const table_created = hdoc_index.create_table(
+			db,
+			table,
+			cols,
+			virtual,
+			fts5,
+		);
+		if (table_created !== null) {
+			return `\nError creating table: ${table_created}`;
+		}
+		console.log(`\nTable created: ${table}`);
+		return null;
+	};
+
+	exports.create_db = function (db_path, doc_id) {
+		const response = {
+			error: null,
+			db: null,
+		};
+		console.log("\nPerforming SQlite index creation...");
+		const db_name = path.join(db_path, doc_id, "index.db");
+		response.db = new database(db_name);
+		response.db.pragma('encoding="UTF-8"');
+		console.log(`\nDatabase created: ${db_name}`);
+
+		// Create tables
+		for (const key in db_schema) {
+			if (Object.hasOwn(db_schema, key)) {
+				const virtual = key === "hdoc_index";
+				const fts5 = key === "hdoc_index";
+				const table_created_error = this.create_table(
+					response.db,
+					key,
+					db_schema[key],
+					virtual,
+					fts5,
+				);
+				if (table_created_error !== null) {
+					console.error(table_created_error);
+				}
+			}
+		}
+		return response;
+	};
+
+	exports.populate_redirects = (db, redirect_records, verbose = false) => {
+		const response = {
+			success: true,
+			errors: [],
+			index_success_count: 0,
+		};
+
+		for (let i = 0; i < redirect_records.length; i++) {
+			const index_vals = [
+				redirect_records[i].url,
+				redirect_records[i].location ? redirect_records[i].location : "",
+				redirect_records[i].code,
+			];
+			const index_response = hdoc_index.insert_record(
+				db,
+				"hdoc_redirects",
+				db_schema.hdoc_redirects,
+				index_vals,
+			);
+			if (!index_response.success) {
+				response.success = false;
+				response.errors.push(
+					`Redirect record creation failed - ${redirect_records[i].url}: ${index_response.error}`,
+				);
+			} else {
+				response.index_success_count++;
+			}
+		}
+		console.log(
+			`\nRedirect Index Build Complete: ${response.index_success_count} document records created.`,
+		);
+		return response;
+	};
+
+	exports.populate_index = async (
+		db,
+		doc_id,
+		book_config,
+		index_records,
+		verbose = false,
+	) => {
+		const response = {
+			success: false,
+			index_success_count: 0,
+			error: "",
+		};
+
+		if (!book_config.tags) book_config.tags = [];
+
+		const indexPromises = [];
+		for (let i = 0; i < index_records.length; i++) {
+			indexPromises.push(index_records[i]);
+		}
+		let curr_file = "";
+		await Promise.all(
+			indexPromises.map(async (file) => {
+				let index_path_name = file.relative_path.replaceAll("\\", "/");
+				if (
+					index_path_name.endsWith("/index.md") ||
+					index_path_name.endsWith("/index.html") ||
+					index_path_name.endsWith("/index.htm")
+				) {
+					index_path_name = index_path_name.substring(
+						0,
+						index_path_name.lastIndexOf("/"),
+					);
+				}
+				index_path_name = `/${index_path_name.replace(path.extname(file.relative_path), "")}`;
+
+				let index_response = {
+					success: true,
+					row_id: 0,
+				};
+				let index_content_path = index_path_name;
+				if (file.index_html.id !== null)
+					index_content_path += `#${file.index_html.id}`;
+				if (!file.inline) {
+					const index_vals = [
+						index_content_path,
+						doc_id,
+						book_config.audience.join(","),
+						book_config.tags.join(","),
+						file.index_html.fm_props.title,
+						file.index_html.text,
+						file.index_html.preview,
+						book_config.productFamily,
+						file.md5,
+						file.lastmod,
+					];
+					index_response = hdoc_index.insert_record(
+						db,
+						"hdoc_index",
+						db_schema.hdoc_index,
+						index_vals,
+					);
+				}
+				if (!index_response.success) {
+					console.error(
+						`Index record creation failed - ${doc_id}/${file.index_html.fm_props.title}: ${index_response.error}`,
+					);
+				} else {
+					if (curr_file === index_path_name) return;
+					curr_file = index_path_name;
+					// Now add metadata
+					const meta_vals = [
+						index_path_name,
+						doc_id,
+						file.metadata.contributor_count,
+						file.metadata.edit_url,
+						file.metadata.last_commit,
+						file.pdf_size,
+					];
+					const meta_response = await hdoc_index.insert_record(
+						db,
+						"hdoc_meta",
+						db_schema.hdoc_meta,
+						meta_vals,
+					);
+					if (!meta_response.success) {
+						console.error(
+							`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${meta_response.error}`,
+						);
+					} else {
+						if (verbose) {
+							console.log(
+								`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.index_html.fm_props.title}`,
+							);
+							console.log(
+								`Inserted index metadata record for index ID: ${meta_response.row_id}`,
+							);
+						}
+
+						// Now add contributor records
+						for (let j = 0; j < file.contributors.length; j++) {
+							const contrib_vals = [
+								index_path_name,
+								doc_id,
+								file.contributors[j].login,
+								file.contributors[j].name,
+								file.contributors[j].avatar_url,
+								file.contributors[j].html_url,
+							];
+							const cont_response = await hdoc_index.insert_record(
+								db,
+								"hdoc_contributors",
+								db_schema.hdoc_contributors,
+								contrib_vals,
+							);
+							if (!cont_response.success) {
+								console.error(
+									`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${cont_response.error}`,
+								);
+								continue;
+							}
+							if (verbose) {
+								console.log(
+									`Inserted document contributor record ${cont_response.row_id}`,
+								);
+							}
+						}
+						response.index_success_count++;
+					}
+				}
+			}),
+		);
+
+		response.success = true;
+		console.log(
+			`\nIndex Build Complete: ${response.index_success_count} document index records created.`,
+		);
+		return response;
+	};
+})();