hdoc-tools 0.17.33 → 0.18.0

package/hdoc-build-db.js

@@ -114,19 +114,23 @@
         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_path_name,
+                    index_content_path,
                     doc_id,
                     book_config.audience.join(','),
                     book_config.tags.join(','),
@@ -142,6 +146,8 @@
             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,

package/hdoc-build.js

@@ -450,6 +450,9 @@
       if (inline_content) html_txt = `${fm_header_content}\n${html_txt}`;
       else html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
 
+      // Wrap h2 and h3 tags, plus content, in id'd divs
+      html_txt = hdoc.wrapHContent(html_txt);
+
       let relative_path = file_path.relativePath;
       if (
         !bc[relative_path.replace(".html", "")] &&
@@ -458,15 +461,19 @@
         relative_path = relative_path.replace("/index.html", "");
       }
 
-      index_records.push({
-        relative_path: relative_path,
-        index_html: hdoc_index.transform_html_for_index(html_txt),
-        metadata: metadata,
-        contributors: contribs,
-        pdf_size: pdf_size,
-        md5: file_path.hash,
-        lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
-        inline: inline_content,
+      const index_data = hdoc_index.transform_html_for_index(html_txt);
+
+      index_data.sections.forEach(section => {
+        index_records.push({
+          relative_path: relative_path,
+          index_html: { fm_props: index_data.fm_props, text: section.text, preview: section.preview, id: section.id ? section.id : null},
+          metadata: metadata,
+          contributors: contribs,
+          pdf_size: pdf_size,
+          md5: file_path.hash,
+          lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
+          inline: inline_content,
+        });
       });
 
       // Save HTML into HTML file
@@ -804,6 +811,9 @@
       if (inline_content) html_txt = `${fm_header}\n${html_txt}`;
       else html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
 
+      // Wrap h2 and h3 tags, plus content, in id'd divs
+      html_txt = hdoc.wrapHContent(html_txt);
+
       // Save HTML into HTML file
       const target_file = file_path.path.replace(
         path.extname(file_path.path),
@@ -826,15 +836,19 @@
         relative_path = relative_path.replace("/index.html", "");
       }
 
-      index_records.push({
-        relative_path: relative_path,
-        index_html: hdoc_index.transform_html_for_index(html_txt),
-        metadata: metadata,
-        contributors: contribs,
-        pdf_size: pdf_size,
-        md5: file_path.hash,
-        lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
-        inline: inline_content,
+      const index_data = hdoc_index.transform_html_for_index(html_txt);
+
+      index_data.sections.forEach(section => {
+        index_records.push({
+          relative_path: relative_path,
+          index_html: { fm_props: index_data.fm_props, text: section.text, preview: section.preview, id: section.id ? section.id : null},
+          metadata: metadata,
+          contributors: contribs,
+          pdf_size: pdf_size,
+          md5: file_path.hash,
+          lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
+          inline: inline_content,
+        });
       });
 
       // Add MD file to delete queue
@@ -1297,7 +1311,7 @@
 
     if (pdf_enable) {
       // Create a Chromium browser instance generate PDFs with
-      browser = await puppeteer.launch({ headless: "new" });
+      browser = await puppeteer.launch({ headless: 'shell' });
     }
 
     // Work through MD files and convert to HTML

package/hdoc-db.js

@@ -62,32 +62,62 @@
 
     exports.transform_html_for_index = function (html_txt) {
         let response = {
-            text: '',
-            preview: '',
-            fm_props: {}
+            fm_props: {},
+            sections: []
         };
 
+        const divs = hdoc.getIDDivs(html_txt);
+
         // Get frontmatter properties
         const fm_headers = hdoc.getHTMLFrontmatterHeader(html_txt);
         response.fm_props = fm_headers.fm_properties;
 
-        // Convert HTML into plain text
-        response.text = html2text.convert(html_txt, {
-            ignoreHref: true,
-            ignoreImage: true,
-            uppercaseHeadings: false,
-            wordwrap: null
-        });
-
-        // Convert HTML into preview text
-        response.preview = html2text.convert(html_txt, {
-            baseElement: 'p',
-            ignoreHref: true,
-            ignoreImage: true,
-            uppercaseHeadings: false,
-            wordwrap: null
-        });
-        response.preview = hdoc.truncate_string(response.preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
+        if (divs.length > 0) {
+            divs.forEach(div => {
+                // Convert HTML into plain text
+                let text = response.text = html2text.convert(div.html, {
+                    ignoreHref: true,
+                    ignoreImage: true,
+                    uppercaseHeadings: false,
+                    wordwrap: null
+                });
+                // Convert HTML into preview text
+                let preview = html2text.convert(div.html, {
+                    baseElement: 'p',
+                    ignoreHref: true,
+                    ignoreImage: true,
+                    uppercaseHeadings: false,
+                    wordwrap: null
+                });
+                preview = hdoc.truncate_string(preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
+                response.sections.push({
+                    id: div.id.replace('hb-doc-anchor-', ''),
+                    text: text,
+                    preview: preview
+                })
+            });
+        } else {
+            // Convert HTML into plain text
+            let text = response.text = html2text.convert(html_txt, {
+                ignoreHref: true,
+                ignoreImage: true,
+                uppercaseHeadings: false,
+                wordwrap: null
+            });
+            // Convert HTML into preview text
+            let preview = html2text.convert(html_txt, {
+                baseElement: 'p',
+                ignoreHref: true,
+                ignoreImage: true,
+                uppercaseHeadings: false,
+                wordwrap: null
+            });
+            preview = hdoc.truncate_string(preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
+            response.sections.push({
+                text: text,
+                preview: preview
+            })
+        }
         return response;
     };
 

package/hdoc-module.js

@@ -2,12 +2,13 @@
     'use strict';
 
     const axios = require('axios'),
-        axiosRetry = require('axios-retry'),
+        axiosRetry = require('axios-retry').default,
         cheerio = require('cheerio'),
         fs = require('fs'),
-        html2text = require('html-to-text'),
         https = require('https'),
         htmlentities = require('html-entities'),
+        html2text = require('html-to-text'),
+        { JSDOM } = require('jsdom'),
         path = require('path'),
         wordsCount = require('words-count').default;
 
@@ -202,6 +203,102 @@
         return false;
     };
 
+    const makeAnchorIdFriendly = function(str) {
+        return 'hb-doc-anchor-' + str       // Add prefix
+            .toLowerCase()                  // Convert to lowercase
+            .trim()                         // Trim leading and trailing spaces
+            .replace(/[^a-z0-9\s-]/g, '')   // Remove all non-alphanumeric characters except spaces and hyphens
+            .replace(/\s+/g, '-')           // Replace spaces with hyphens
+            .replace(/-+/g, '-');           // Replace multiple hyphens with a single hyphen
+    };
+
+    // Processes HTML, wraps h2 and h3 tags and their content in divs with an id matching that of the h text
+    exports.wrapHContent = function (htmlContent) {
+        const dom = new JSDOM(htmlContent);
+        const document = dom.window.document;
+        
+        let nodes = Array.from(document.body.childNodes); // Convert NodeList to Array for easier manipulation
+        let newContent = document.createDocumentFragment(); // Create a document fragment to hold the new structure
+
+        let currentH2Div = null;
+        let currentH3Div = null;
+
+        nodes.forEach(node => {
+            if (node.nodeType === dom.window.Node.ELEMENT_NODE) {
+                if (node.tagName.toLowerCase() === 'h2') {
+                    // When an <h2> is found, close the current <div> (if any) and start a new one
+                    if (currentH2Div) {
+                        newContent.appendChild(currentH2Div);
+                    }
+                    currentH2Div = document.createElement('div');
+                    currentH2Div.id = makeAnchorIdFriendly(node.textContent.trim()); // Set the id to the anchor-friendly text content of the <h2>
+                    currentH2Div.appendChild(node); // Move the <h2> into the new <div>
+                    currentH3Div = null; // Reset currentH3Div
+                } else if (node.tagName.toLowerCase() === 'h3') {
+                    // When an <h3> is found, close the current <div> (if any) and start a new one
+                    if (currentH3Div) {
+                        currentH2Div.appendChild(currentH3Div);
+                    }
+                    currentH3Div = document.createElement('div');
+                    currentH3Div.id = makeAnchorIdFriendly(node.textContent.trim()); // Set the id to the anchor-friendly text content of the <h3>
+                    currentH3Div.appendChild(node); // Move the <h3> into the new <div>
+                } else if (currentH3Div) {
+                    // Append any other nodes to the current <h3> <div> if it exists
+                    currentH3Div.appendChild(node);
+                } else if (currentH2Div) {
+                    // Append any other nodes to the current <h2> <div> if no current <h3> <div> exists
+                    currentH2Div.appendChild(node);
+                } else {
+                    // If there is no current <h2> or <h3> <div>, append the node directly to the fragment
+                    newContent.appendChild(node);
+                }
+            } else if (currentH3Div) {
+                // Append any text nodes to the current <h3> <div> if it exists
+                currentH3Div.appendChild(node);
+            } else if (currentH2Div) {
+                // Append any text nodes to the current <h2> <div> if it exists
+                currentH2Div.appendChild(node);
+            } else {
+                // If there is no current <h2> or <h3> <div>, append the node directly to the fragment
+                newContent.appendChild(node);
+            }
+        });
+
+        // Append the last <h3> <div> if any
+        if (currentH3Div) {
+            currentH2Div.appendChild(currentH3Div);
+        }
+
+        // Append the last <h2> <div> if any
+        if (currentH2Div) {
+            newContent.appendChild(currentH2Div);
+        }
+
+        // Replace the old body content with the new content
+        document.body.innerHTML = '';
+        document.body.appendChild(newContent);
+
+        // Serialize the document back to HTML and return
+        const outputHtml = dom.serialize();
+        return outputHtml;
+    };
+
+
+    exports.getIDDivs = function(html_body) {
+        const $ = cheerio.load(html_body, {
+            decodeEntities: false
+        });
+
+        const divs = [];
+        
+        $('div').each(function(i, element){
+            if ($(this).attr('id') && $(this).attr('id').startsWith('hb-doc-anchor-')) {
+                divs.push({id: $(this).attr('id'), html: $(this).html(), text: $(this).text()})
+            }
+        });
+        return divs;
+    };
+
     exports.getHTMLFrontmatterHeader = function (html_body) {
         let response = {
             fm_header: '',

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 (async function () {
    'use strict';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.17.33",
+  "version": "0.18.0",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -37,29 +37,26 @@
   "dependencies": {
     "american-british-english-translator": "^0.2.1",
     "archiver": "7.0.1",
-    "axios": "^1.3.2",
-    "axios-retry": "^3.5.0",
-    "better-sqlite3": "^9.4.0",
-    "body-parser": "^1.20.1",
+    "axios": "^1.7.2",
+    "axios-retry": "^4.4.1",
+    "better-sqlite3": "^11.1.2",
     "cheerio": "^1.0.0-rc.12",
-    "cookie-parser": "^1.4.6",
-    "dree": "^3.4.2",
-    "express": "^4.18.2",
-    "fs-extra": "^11.1.0",
-    "html-entities": "^2.4.0",
-    "html-to-text": "^8.2.1",
+    "dree": "^5.0.7",
+    "express": "^4.19.2",
+    "fs-extra": "^11.2.0",
+    "html-entities": "^2.5.2",
+    "html-to-text": "^9.0.5",
     "js-yaml": "^4.1.0",
-    "markdown-it": "^13.0.1",
-    "markdown-it-container": "^3.0.0",
-    "markdown-it-front-matter": "^0.2.3",
+    "jsdom": "^24.1.0",
+    "markdown-it": "14.1.0",
+    "markdown-it-container": "^4.0.0",
+    "markdown-it-front-matter": "^0.2.4",
     "mime-types": "^2.1.35",
-    "multer": "^1.4.5-lts.1",
     "prompt": "^1.3.0",
-    "puppeteer": "22.8.2",
-    "retry": "^0.13.1",
-    "stream": "0.0.2",
+    "puppeteer": "^22.12.1",
+    "stream": "0.0.3",
     "true-case-path": "^2.2.1",
     "words-count": "^2.0.2",
-    "xml-formatter": "^3.6.0"
+    "xml-formatter": "^3.6.2"
   }
 }