hdoc-tools 0.19.7 → 0.20.0

package/hdoc-module.js

@@ -1,723 +1,708 @@
-(function () {
-  "use strict";
-
-  const axios = require("axios"),
-    axiosRetry = require("axios-retry").default,
-    cheerio = require("cheerio"),
-    fs = require("fs"),
-    https = require("https"),
-    htmlentities = require("html-entities"),
-    html2text = require("html-to-text"),
-    { JSDOM } = require("jsdom"),
-    path = require("path"),
-    wordsCount = require("words-count").default;
-
-  let includesCache = {},
-    agent = new https.Agent({
-      rejectUnauthorized: false,
-    }),
-    retried = false;
-
-  axiosRetry(axios, {
-    retries: 5,
-    shouldResetTimeout: true,
-    retryCondition: (error) => {
-      return !error.response.status;
-    },
-    onRetry: (retryCount, error, requestConfig) => {
-      retried = true;
-      console.info(
-        `\n[WARNING] API call failed - ${error.message}\nEndpoint: ${requestConfig.url}\nRetrying: ${retryCount}`
-      );
-    },
-  });
-
-  exports.content_type_for_ext = function (ext) {
-    switch (ext) {
-      case ".z":
-        return "application/x-compress";
-      case ".tgz":
-        return "application/x-compressed";
-      case ".gz":
-        return "application/x-gzip";
-      case ".zip":
-        return "application/x-zip-compressed";
-      case ".xml":
-        return "application/xml";
-      case ".bmp":
-        return "image/bmp";
-      case ".gif":
-        return "image/gif";
-      case ".jpg":
-        return "image/jpeg";
-      case ".png":
-        return "image/png";
-      case ".tiff":
-        return "image/tiff";
-      case ".ico":
-        return "image/x-icon";
-      case ".png":
-        return "image/png";
-      case ".svg":
-        return "image/svg+xml";
-      case ".css":
-        return "text/css";
-      case ".htm":
-      case ".html":
-        return "text/html";
-      case ".txt":
-        return "text/plain";
-      case ".md":
-        return "text/plain";
-      case ".json":
-        return "application/json";
-      case ".js":
-        return "application/javascript";
-      default:
-        return "application/octet-stream";
-    }
-  };
-
-  exports.valid_url = function (url) {
-    const stringIsAValidUrl = (s) => {
-      try {
-        const url_obj = new URL(s);
-        return url_obj;
-      } catch (err) {
-        return false;
-      }
-    };
-    return stringIsAValidUrl(url);
-  };
-
-  exports.expand_variables = function (text, docId = "") {
-    if (docId !== "") {
-      text = text.replaceAll("{{DOC_ID}}", docId);
-    }
-    text = text.replaceAll("{{BUILD_NUMBER}}", "0");
-
-    let build_date = new Date().toISOString();
-    build_date = build_date.replace("T", " ");
-    build_date = build_date.substring(0, 19);
-    text = text.replaceAll("{{BUILD_DATE}}", build_date);
-    return text;
-  };
-
-  exports.process_includes = async function (file_path, body, source_path) {
-    let response = {
-      body: "",
-      found: 0,
-      success: 0,
-      failed: 0,
-      included: [],
-      errors: [],
-    };
-
-    // Search body for INCLUDEs
-    const regexp = /\[\[INCLUDE .*]]/g;
-    const body_array = [...body.matchAll(regexp)];
-
-    for (let i = 0; i < body_array.length; i++) {
-      response.found++;
-
-      // Extract include data from array
-      const include_value = body_array[i][0];
-
-      let link;
-      try {
-        link = include_value.split(" ")[1];
-        link = link.substring(0, link.length - 2);
-      } catch (e) {
-        response.failed++;
-        response.errors.push(
-          `Error parsing INCLUDE [${include_value}] from [${file_path}]: ${err}`
-        );
-        continue;
-      }
-
-      if (
-        (link.startsWith("http://") || link.startsWith("https://")) &&
-        includesCache[link] !== undefined
-      ) {
-        console.log(`Serving From Cache: ${link}`);
-        body = body.replace(include_value, includesCache[link]);
-        response.success++;
-        continue;
-      }
-
-      // Validate link in INCLUDE
-      let file_content;
-      if (link.startsWith("http://") || link.startsWith("https://")) {
-        // Remote content to include
-        try {
-          new URL(link);
-        } catch (e) {
-          response.failed++;
-          response.errors.push(
-            `Error validating INCLUDE link [${link}] from [${file_path}]: ${e}`
-          );
-          continue;
-        }
-
-        try {
-          const file_response = await axios.get(link);
-          if (retried) {
-            retried = false;
-            console.log(`API call retry success!`);
-          }
-          if (file_response.status === 200) {
-            file_content = file_response.data;
-          } else {
-            throw `Unexpected Status ${file_response.status}`;
-          }
-        } catch (e) {
-          response.failed++;
-          response.errors.push(
-            `Error getting INCLUDE link content [${link}] from [${file_path}]: ${e}`
-          );
-          continue;
-        }
-        console.log(`Included From Remote Source: ${link}`);
-      } else {
-        // Local content to include
-        try {
-          file_content = fs.readFileSync(path.join(source_path, link), "utf8");
-        } catch (e) {
-          response.failed++;
-          response.errors.push(
-            `Error getting INCLUDE file [${link}] from [${file_path}]: ${e}`
-          );
-          continue;
-        }
-        console.log(`Included From Local Source: ${link}`);
-      }
-      response.success++;
-      includesCache[link] = file_content;
-      body = body.replace(include_value, file_content);
-    }
-    response.body = body;
-    return response;
-  };
-
-  // Takes html, returns the first heading detected in the order provided in h_to_search
-  // Looks for h1 tags first, then hX, hY, hZ in order
-  exports.getFirstHTMLHeading = function (html_body, h_to_search = ["h1"]) {
-    const $ = cheerio.load(html_body);
-    for (let i = 0; i < h_to_search.length; i++) {
-      let heading = $(h_to_search[i])
-        .map(function (i) {
-          return $(this);
-        })
-        .get();
-      if (heading.length > 0) {
-        return heading[0];
-      }
-    }
-    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 <h2> div (if any) and start a new one
-          if (currentH2Div) {
-            if (currentH3Div) {
-              currentH2Div.appendChild(currentH3Div);
-              currentH3Div = null;
-            }
-            newContent.appendChild(currentH2Div);
-          }
-          currentH2Div = document.createElement("div");
-          currentH2Div.id = makeAnchorIdFriendly(node.textContent.trim());
-          currentH2Div.appendChild(node);
-        } else if (node.tagName.toLowerCase() === "h3") {
-          // When an <h3> is found, close the current <h3> div (if any) and start a new one
-          if (currentH3Div) {
-            if (currentH2Div) {
-              currentH2Div.appendChild(currentH3Div);
-            } else {
-              newContent.appendChild(currentH3Div);
-            }
-          }
-          currentH3Div = document.createElement("div");
-          currentH3Div.id = makeAnchorIdFriendly(node.textContent.trim());
-          currentH3Div.appendChild(node);
-        } else {
-          if (currentH3Div) {
-            currentH3Div.appendChild(node);
-          } else if (currentH2Div) {
-            currentH2Div.appendChild(node);
-          } else {
-            newContent.appendChild(node);
-          }
-        }
-      } else {
-        if (currentH3Div) {
-          currentH3Div.appendChild(node);
-        } else if (currentH2Div) {
-          currentH2Div.appendChild(node);
-        } else {
-          newContent.appendChild(node);
-        }
-      }
-    });
-
-    // Append the last <h3> div if any
-    if (currentH3Div) {
-      if (currentH2Div) {
-        currentH2Div.appendChild(currentH3Div);
-      } else {
-        newContent.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 save it to a new file (for example: 'output.html')
-    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: "",
-      fm_properties: {},
-    };
-    const $ = cheerio.load(html_body, {
-      decodeEntities: false,
-    });
-    if (
-      $._root &&
-      $._root.children &&
-      $._root.children instanceof Array &&
-      $._root.children.length > 0
-    ) {
-      $._root.children.forEach(function (child) {
-        if (
-          child.type === "comment" &&
-          child.data &&
-          child.data.startsWith("[[FRONTMATTER")
-        ) {
-          // We have a Frontmatter header - return each property in an array
-          const fm_properties = child.data.split(/\r?\n/);
-          for (let i = 0; i < fm_properties.length; i++) {
-            if (fm_properties[i].includes(":")) {
-              const property_details = fm_properties[i].split(/:(.*)/s);
-              if (property_details.length > 1) {
-                let prop_val = property_details[1].trim();
-                if (/^".*"$/.test(prop_val)) {
-                  prop_val = prop_val.substring(1, prop_val.length - 1);
-                }
-                if (property_details[0].trim().toLowerCase() === "title") {
-                  prop_val = htmlentities.decode(prop_val);
-                }
-                response.fm_properties[
-                  property_details[0].trim().toLowerCase()
-                ] = prop_val;
-              }
-            }
-          }
-
-          // And return the header as a whole so it can be easily replaced
-          response.fm_header = child.data;
-        }
-      });
-    }
-
-    return response;
-  };
-
-  exports.truncate_string = function (str, n, useWordBoundary) {
-    if (str.length <= n) {
-      return str;
-    }
-    const subString = str.slice(0, n - 1);
-    return (
-      (useWordBoundary
-        ? subString.slice(0, subString.lastIndexOf(" "))
-        : subString) + "…"
-    );
-  };
-
-  exports.get_html_read_time = function (html) {
-    // Get word count
-    const text = html2text.convert(html, {
-      wordwrap: null,
-    });
-    const word_count = wordsCount(text);
-    if (word_count === 0) return 0;
-
-    // Calculate the read time - divide the word count by 200
-    let read_time = Math.round(word_count / 200);
-    if (read_time === 0) read_time = 1;
-    return read_time;
-  };
-
-  exports.get_github_api_path = function (repo, relative_path) {
-    if (repo) {
-      repo = repo.endsWith("/") ? repo.slice(0, -1) : repo;
-      let github_paths = {};
-      github_paths.api_path = repo.replace(
-        "https://github.com/",
-        "https://api.github.com/repos/"
-      );
-      github_paths.api_path +=
-        "/commits?path=" +
-        encodeURIComponent(
-          "/" + relative_path.replace("\\\\", "/").replace("\\", "/")
-        );
-      github_paths.edit_path =
-        repo +
-        "/blob/main/" +
-        relative_path.replace("\\\\", "/").replace("\\", "/");
-      return github_paths;
-    }
-    return "";
-  };
-
-  const get_github_contributors_path = function (repo) {
-    repo = repo.endsWith("/") ? repo.slice(0, -1) : repo;
-    let github_paths = {};
-    github_paths.api_path = repo.replace(
-      "https://github.com/",
-      "https://api.github.com/repos/"
-    );
-    github_paths.api_path += "/contributors";
-    return github_paths;
-  };
-
-  exports.get_github_contributors = async function (
-    github_url,
-    github_api_token,
-    repo
-  ) {
-    let response = {
-      success: false,
-      error: "",
-      contributors: [],
-      contributor_count: 0,
-      last_commit_date: "",
-    };
-    let contributors = {};
-
-    let request_options = {
-      headers: {
-        "User-Agent": "HornbillDocsBuild",
-        "Cache-Control": "no-cache",
-        Host: "api.github.com",
-        Accept: "application/json",
-      },
-      timeout: 5000,
-    };
-    if (github_api_token !== "") {
-      request_options.headers.authorization = `Bearer ${github_api_token}`;
-    }
-    let github_response;
-    try {
-      github_response = await axios.get(github_url, request_options);
-      if (retried) {
-        retried = false;
-        console.log(`API call retry success!`);
-      }
-    } catch (err) {
-      if (err.response) {
-        if (err.response.status !== 403 && err.response.status !== 401) {
-          response.error = err;
-          return response;
-        } else {
-          github_response = err.response;
-        }
-      } else {
-        response.error = `Unexpected response from GitHub for [${github_url}:\n${JSON.stringify(
-          err
-        )}]`;
-      }
-    }
-    if (github_response.status === 200) {
-      response.success = true;
-      let commits = github_response.data;
-      commits.forEach(function (commit) {
-        if (
-          commit.committer &&
-          commit.committer.type &&
-          commit.committer.type.toLowerCase() === "user" &&
-          commit.committer.login.toLowerCase() !== "web-flow"
-        ) {
-          if (!contributors[commit.committer.id]) {
-            response.contributor_count++;
-            contributors[commit.committer.id] = {
-              login: commit.committer.login,
-              avatar_url: commit.committer.avatar_url,
-              html_url: commit.committer.html_url,
-              name: commit.commit.committer.name,
-            };
-          }
-          if (response.last_commit_date !== "") {
-            const new_commit_date = new Date(commit.commit.committer.date);
-            const exist_commit_date = new Date(response.last_commit_date);
-            if (new_commit_date > exist_commit_date)
-              response.last_commit_date = commit.commit.committer.date;
-          } else {
-            response.last_commit_date = commit.commit.committer.date;
-          }
-        } else if (commit.author && commit.author.id) {
-          if (!contributors[commit.author.id]) {
-            response.contributor_count++;
-            contributors[commit.author.id] = {
-              login: commit.author.login,
-              avatar_url: commit.author.avatar_url,
-              html_url: commit.author.html_url,
-              name: commit.commit.author.name,
-            };
-          }
-          if (response.last_commit_date !== "") {
-            const new_commit_date = new Date(commit.commit.author.date);
-            const exist_commit_date = new Date(response.last_commit_date);
-            if (new_commit_date > exist_commit_date)
-              response.last_commit_date = commit.commit.author.date;
-          } else {
-            response.last_commit_date = commit.commit.author.date;
-          }
-        }
-      });
-      for (const key in contributors) {
-        if (contributors.hasOwnProperty(key)) {
-          response.contributors.push(contributors[key]);
-        }
-      }
-    } else if (github_response.status === 403) {
-      // Private repo, fine-grained permissions don't yet support getting commits without content, get list from meta permissions
-      const contrib_url = get_github_contributors_path(repo).api_path;
-      try {
-        github_response = await axios.get(contrib_url, request_options);
-        if (retried) {
-          retried = false;
-          console.log(`API call retry success!`);
-        }
-      } catch (err) {
-        if (err.response && err.response.status) {
-          if (err.response.status !== 200) {
-            response.error = err;
-            return response;
-          }
-        } else {
-          response.error = `Unexpected response from GitHub for [${contrib_url}:\n${JSON.stringify(
-            err
-          )}]`;
-        }
-      }
-      if (github_response.status === 200) {
-        response.success = true;
-        let commits = github_response.data;
-        commits.forEach(function (commit) {
-          if (
-            commit.type &&
-            commit.type.toLowerCase() === "user" &&
-            commit.login.toLowerCase() !== "web-flow"
-          ) {
-            if (!contributors[commit.id]) {
-              response.contributor_count++;
-              contributors[commit.id] = {
-                login: commit.login,
-                avatar_url: commit.avatar_url,
-                html_url: commit.html_url,
-                name: commit.name ? commit.name : commit.login,
-              };
-            }
-            if (
-              response.last_commit_date !== "" &&
-              response.last_commit_date !== "No Commit Date Available"
-            ) {
-              const new_commit_date = new Date(commit.date);
-              const exist_commit_date = new Date(response.last_commit_date);
-              if (new_commit_date > exist_commit_date)
-                response.last_commit_date = commit.date;
-            } else {
-              response.last_commit_date = commit.date
-                ? commit.date
-                : "No Commit Date Available";
-            }
-          }
-        });
-        for (const key in contributors) {
-          if (contributors.hasOwnProperty(key)) {
-            response.contributors.push(contributors[key]);
-          }
-        }
-      }
-    } else {
-      response.error = `Unexpected Status: ${github_response.status}.`;
-    }
-    return response;
-  };
-
-  exports.strip_drafts = function (nav_items) {
-    let return_nav = nav_items;
-    recurse_nav(return_nav);
-    return return_nav;
-  };
-
-  const recurse_nav = function (nav_items) {
-    for (const key in nav_items) {
-      if (nav_items[key].draft) {
-        nav_items.splice(key, 1);
-        recurse_nav(nav_items);
-      } else if (nav_items[key].items) {
-        recurse_nav(nav_items[key].items);
-      }
-    }
-  };
-
-  exports.build_breadcrumbs = function (nav_items) {
-    let response = {
-      bc: {},
-      errors: [],
-    };
-    const buildBreadcrumb = (items, parentLinks) => {
-      // Process parent links
-      let parentlink = true;
-      if (parentLinks.length > 0) {
-        if (parentLinks[0].link === undefined || parentLinks[0].link === "")
-          parentlink = false;
-
-        for (let i = 1; i < 10; i++) {
-          if (
-            parentLinks[i] &&
-            parentLinks[i].link === undefined &&
-            items.length > 0 &&
-            items[0].link
-          ) {
-            parentLinks[i].link = items[0].link;
-          } 
-        }
-      }
-
-      // Loop through items, build breadcrumb
-      for (let i = 0; i < items.length; i++) {
-        if (!items[i].text) {
-          response.errors.push(
-            `The following Nav Item is missing its text property: ${JSON.stringify(
-              items[i]
-            )}`
-          );
-        }
-
-        if (!items[i].link && !items[i].items) {
-          response.errors.push(
-            `The following Nav Item has no link or items property: ${JSON.stringify(
-              items[i]
-            )}`
-          );
-        }
-        const item = items[i];
-        if (!parentlink && item.link) {
-          parentLinks[0].link = item.link;
-          parentlink = true;
-        }
-        const { text, link, items: subItems } = item;
-        const breadcrumb = [...parentLinks, { text, link }];
-
-        if (link) {
-          response.bc[link] = breadcrumb;
-        }
-
-        if (subItems) {
-          buildBreadcrumb(subItems, breadcrumb);
-        }
-      }
-    };
-
-    buildBreadcrumb(nav_items, []);
-    return response;
-  };
-
-  exports.load_product_families = async function () {
-    let response = {
-      success: false,
-      prod_families: {},
-      prods_supported: [],
-      errors: "",
-    };
-    const prod_families_url = "https://docs.hornbill.com/_books/products.json";
-    for (let i = 1; i < 4; i++) {
-      try {
-        const prods = await axios.get(prod_families_url, {
-          httpsAgent: agent,
-          timeout: 5000,
-        });
-        if (prods.status === 200) {
-          response.prod_families = prods.data;
-          response.prods_supported = [];
-          for (let i = 0; i < response.prod_families.products.length; i++) {
-            response.prods_supported.push(
-              response.prod_families.products[i].id
-            );
-          }
-          response.success = true;
-          break;
-        } else {
-          throw `Unexpected status - ${prods.status} ${prods.statusText}`;
-        }
-      } catch (e) {
-        if (response.errors === "")
-          response.errors = `Request to ${prod_families_url} failed:`;
-        response.errors += `\nAttempt ${i} - Error returning product families: ${e}`;
-        // Wait 2 seconds and try again
-        await new Promise((r) => setTimeout(r, 2000));
-      }
-    }
-    return response;
-  };
-})();
+(() => {
+	const axios = require("axios");
+	const axiosRetry = require("axios-retry").default;
+	const cheerio = require("cheerio");
+	const fs = require("node:fs");
+	const https = require("node:https");
+	const htmlentities = require("html-entities");
+	const html2text = require("html-to-text");
+	const { JSDOM } = require("jsdom");
+	const path = require("node:path");
+	const wordsCount = require("words-count").default;
+
+	const includesCache = {};
+	const agent = new https.Agent({
+		rejectUnauthorized: false,
+	});
+
+	let retried = false;
+
+	axiosRetry(axios, {
+		retries: 5,
+		shouldResetTimeout: true,
+		retryCondition: (error) => {
+			return !error.response.status;
+		},
+		onRetry: (retryCount, error, requestConfig) => {
+			retried = true;
+			console.info(
+				`\n[WARNING] API call failed - ${error.message}\nEndpoint: ${requestConfig.url}\nRetrying: ${retryCount}`,
+			);
+		},
+	});
+
+	exports.content_type_for_ext = (ext) => {
+		switch (ext) {
+			case ".z":
+				return "application/x-compress";
+			case ".tgz":
+				return "application/x-compressed";
+			case ".gz":
+				return "application/x-gzip";
+			case ".zip":
+				return "application/x-zip-compressed";
+			case ".xml":
+				return "application/xml";
+			case ".bmp":
+				return "image/bmp";
+			case ".gif":
+				return "image/gif";
+			case ".jpg":
+				return "image/jpeg";
+			case ".png":
+				return "image/png";
+			case ".tiff":
+				return "image/tiff";
+			case ".ico":
+				return "image/x-icon";
+			case ".svg":
+				return "image/svg+xml";
+			case ".css":
+				return "text/css";
+			case ".htm":
+			case ".html":
+				return "text/html";
+			case ".txt":
+				return "text/plain";
+			case ".md":
+				return "text/plain";
+			case ".json":
+				return "application/json";
+			case ".js":
+				return "application/javascript";
+			default:
+				return "application/octet-stream";
+		}
+	};
+
+	exports.valid_url = (url) => {
+		const stringIsAValidUrl = (s) => {
+			try {
+				const url_obj = new URL(s);
+				return url_obj;
+			} catch (err) {
+				return false;
+			}
+		};
+		return stringIsAValidUrl(url);
+	};
+
+	exports.expand_variables = (text, docId = "") => {
+		let clean_text = text;
+		if (docId !== "") {
+			clean_text = clean_text.replaceAll("{{DOC_ID}}", docId);
+		}
+		clean_text = clean_text.replaceAll("{{BUILD_NUMBER}}", "0");
+
+		let build_date = new Date().toISOString();
+		build_date = build_date.replace("T", " ");
+		build_date = build_date.substring(0, 19);
+		clean_text = clean_text.replaceAll("{{BUILD_DATE}}", build_date);
+		return clean_text;
+	};
+
+	exports.process_includes = async (file_path, body, source_path) => {
+		const response = {
+			body: body,
+			found: 0,
+			success: 0,
+			failed: 0,
+			included: [],
+			errors: [],
+		};
+
+		// Search body for INCLUDEs
+		const regexp = /\[\[INCLUDE .*]]/g;
+		const body_array = [...response.body.matchAll(regexp)];
+
+		for (let i = 0; i < body_array.length; i++) {
+			response.found++;
+
+			// Extract include data from array
+			const include_value = body_array[i][0];
+
+			let link;
+			try {
+				link = include_value.split(" ")[1];
+				link = link.substring(0, link.length - 2);
+			} catch (e) {
+				response.failed++;
+				response.errors.push(
+					`Error parsing INCLUDE [${include_value}] from [${file_path}]: ${err}`,
+				);
+				continue;
+			}
+
+			if (
+				(link.startsWith("http://") || link.startsWith("https://")) &&
+				includesCache[link] !== undefined
+			) {
+				console.log(`Serving From Cache: ${link}`);
+				response.body = response.body.replace(
+					include_value,
+					includesCache[link],
+				);
+				response.success++;
+				continue;
+			}
+
+			// Validate link in INCLUDE
+			let file_content;
+			if (link.startsWith("http://") || link.startsWith("https://")) {
+				// Remote content to include
+				try {
+					new URL(link);
+				} catch (e) {
+					response.failed++;
+					response.errors.push(
+						`Error validating INCLUDE link [${link}] from [${file_path}]: ${e}`,
+					);
+					continue;
+				}
+
+				try {
+					const file_response = await axios.get(link);
+					if (retried) {
+						retried = false;
+						console.log("API call retry success!");
+					}
+					if (file_response.status === 200) {
+						file_content = file_response.data;
+					} else {
+						throw `Unexpected Status ${file_response.status}`;
+					}
+				} catch (e) {
+					response.failed++;
+					response.errors.push(
+						`Error getting INCLUDE link content [${link}] from [${file_path}]: ${e}`,
+					);
+					continue;
+				}
+				console.log(`Included From Remote Source: ${link}`);
+			} else {
+				// Local content to include
+				try {
+					file_content = fs.readFileSync(path.join(source_path, link), "utf8");
+				} catch (e) {
+					response.failed++;
+					response.errors.push(
+						`Error getting INCLUDE file [${link}] from [${file_path}]: ${e}`,
+					);
+					continue;
+				}
+				console.log(`Included From Local Source: ${link}`);
+			}
+			response.success++;
+			includesCache[link] = file_content;
+			response.body = response.body.replace(include_value, file_content);
+		}
+		return response;
+	};
+
+	// Takes html, returns the first heading detected in the order provided in h_to_search
+	// Looks for h1 tags first, then hX, hY, hZ in order
+	exports.getFirstHTMLHeading = (html_body, h_to_search = ["h1"]) => {
+		const $ = cheerio.load(html_body);
+		for (let i = 0; i < h_to_search.length; i++) {
+			const heading = $(h_to_search[i])
+				.map(function (i) {
+					return $(this);
+				})
+				.get();
+			if (heading.length > 0) {
+				return heading[0];
+			}
+		}
+		return false;
+	};
+
+	const makeAnchorIdFriendly = (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 = (htmlContent) => {
+		const dom = new JSDOM(htmlContent);
+		const document = dom.window.document;
+
+		const nodes = Array.from(document.body.childNodes); // Convert NodeList to Array for easier manipulation
+		const newContent = document.createDocumentFragment(); // Create a document fragment to hold the new structure
+
+		let currentH2Div = null;
+		let currentH3Div = null;
+
+		for (const node of nodes) {
+			if (node.nodeType === dom.window.Node.ELEMENT_NODE) {
+				if (node.tagName.toLowerCase() === "h2") {
+					// When an <h2> is found, close the current <h2> div (if any) and start a new one
+					if (currentH2Div) {
+						if (currentH3Div) {
+							currentH2Div.appendChild(currentH3Div);
+							currentH3Div = null;
+						}
+						newContent.appendChild(currentH2Div);
+					}
+					currentH2Div = document.createElement("div");
+					currentH2Div.id = makeAnchorIdFriendly(node.textContent.trim());
+					currentH2Div.appendChild(node);
+				} else if (node.tagName.toLowerCase() === "h3") {
+					// When an <h3> is found, close the current <h3> div (if any) and start a new one
+					if (currentH3Div) {
+						if (currentH2Div) {
+							currentH2Div.appendChild(currentH3Div);
+						} else {
+							newContent.appendChild(currentH3Div);
+						}
+					}
+					currentH3Div = document.createElement("div");
+					currentH3Div.id = makeAnchorIdFriendly(node.textContent.trim());
+					currentH3Div.appendChild(node);
+				} else {
+					if (currentH3Div) {
+						currentH3Div.appendChild(node);
+					} else if (currentH2Div) {
+						currentH2Div.appendChild(node);
+					} else {
+						newContent.appendChild(node);
+					}
+				}
+			} else {
+				if (currentH3Div) {
+					currentH3Div.appendChild(node);
+				} else if (currentH2Div) {
+					currentH2Div.appendChild(node);
+				} else {
+					newContent.appendChild(node);
+				}
+			}
+		}
+
+		// Append the last <h3> div if any
+		if (currentH3Div) {
+			if (currentH2Div) {
+				currentH2Div.appendChild(currentH3Div);
+			} else {
+				newContent.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 save it to a new file (for example: 'output.html')
+		const outputHtml = dom.serialize();
+		return outputHtml;
+	};
+
+	exports.getIDDivs = (html_body) => {
+		const $ = cheerio.load(html_body, {
+			decodeEntities: false,
+		});
+
+		const divs = [];
+
+		$("div").each(function (i, element) {
+			if ($(this).attr("id")?.startsWith("hb-doc-anchor-")) {
+				divs.push({
+					id: $(this).attr("id"),
+					html: $(this).html(),
+					text: $(this).text(),
+				});
+			}
+		});
+		return divs;
+	};
+
+	exports.getHTMLFrontmatterHeader = (html_body) => {
+		const response = {
+			fm_header: "",
+			fm_properties: {},
+		};
+		const $ = cheerio.load(html_body, {
+			decodeEntities: false,
+		});
+		if (
+			$._root?.children &&
+			Array.isArray($._root.children) &&
+			$._root.children.length > 0
+		) {
+			for (const child of $._root.children) {
+				if (
+					child.type === "comment" &&
+					child.data &&
+					child.data.startsWith("[[FRONTMATTER")
+				) {
+					// We have a Frontmatter header - return each property in an array
+					const fm_properties = child.data.split(/\r?\n/);
+					for (let i = 0; i < fm_properties.length; i++) {
+						if (fm_properties[i].includes(":")) {
+							const property_details = fm_properties[i].split(/:(.*)/s);
+							if (property_details.length > 1) {
+								let prop_val = property_details[1].trim();
+								if (/^".*"$/.test(prop_val)) {
+									prop_val = prop_val.substring(1, prop_val.length - 1);
+								}
+								if (property_details[0].trim().toLowerCase() === "title") {
+									prop_val = htmlentities.decode(prop_val);
+								}
+								response.fm_properties[
+									property_details[0].trim().toLowerCase()
+								] = prop_val;
+							}
+						}
+					}
+
+					// And return the header as a whole so it can be easily replaced
+					response.fm_header = child.data;
+				}
+			}
+		}
+
+		return response;
+	};
+
+	exports.truncate_string = (str, n, useWordBoundary) => {
+		if (str.length <= n) {
+			return str;
+		}
+		const subString = str.slice(0, n - 1);
+		return `${
+			useWordBoundary
+				? subString.slice(0, subString.lastIndexOf(" "))
+				: subString
+		}…`;
+	};
+
+	exports.get_html_read_time = (html) => {
+		// Get word count
+		const text = html2text.convert(html, {
+			wordwrap: null,
+		});
+		const word_count = wordsCount(text);
+		if (word_count === 0) return 0;
+
+		// Calculate the read time - divide the word count by 200
+		let read_time = Math.round(word_count / 200);
+		if (read_time === 0) read_time = 1;
+		return read_time;
+	};
+
+	exports.get_github_api_path = (repo, relative_path) => {
+		if (repo) {
+			const clean_repo = repo.endsWith("/") ? repo.slice(0, -1) : repo;
+			const github_paths = {};
+			github_paths.api_path = clean_repo.replace(
+				"https://github.com/",
+				"https://api.github.com/repos/",
+			);
+			github_paths.api_path += `/commits?path=${encodeURIComponent(
+				`/${relative_path.replace("\\\\", "/").replace("\\", "/")}`,
+			)}`;
+			github_paths.edit_path = `${repo}/blob/main/${relative_path.replace("\\\\", "/").replace("\\", "/")}`;
+			return github_paths;
+		}
+		return "";
+	};
+
+	const get_github_contributors_path = (repo) => {
+		const clean_repo = repo.endsWith("/") ? repo.slice(0, -1) : repo;
+		const github_paths = {};
+		github_paths.api_path = clean_repo.replace(
+			"https://github.com/",
+			"https://api.github.com/repos/",
+		);
+		github_paths.api_path += "/contributors";
+		return github_paths;
+	};
+
+	exports.get_github_contributors = async (
+		github_url,
+		github_api_token,
+		repo,
+	) => {
+		const response = {
+			success: false,
+			error: "",
+			contributors: [],
+			contributor_count: 0,
+			last_commit_date: "",
+		};
+		const contributors = {};
+
+		const request_options = {
+			headers: {
+				"User-Agent": "HornbillDocsBuild",
+				"Cache-Control": "no-cache",
+				Host: "api.github.com",
+				Accept: "application/json",
+			},
+			timeout: 5000,
+		};
+		if (github_api_token !== "") {
+			request_options.headers.authorization = `Bearer ${github_api_token}`;
+		}
+		let github_response;
+		try {
+			github_response = await axios.get(github_url, request_options);
+			if (retried) {
+				retried = false;
+				console.log("API call retry success!");
+			}
+		} catch (err) {
+			if (err.response) {
+				if (err.response.status !== 403 && err.response.status !== 401) {
+					response.error = err;
+					return response;
+				}
+				github_response = err.response;
+			} else {
+				response.error = `Unexpected response from GitHub for [${github_url}:\n${JSON.stringify(
+					err,
+				)}]`;
+			}
+		}
+		if (github_response.status === 200) {
+			response.success = true;
+			const commits = github_response.data;
+			for (const commit of commits) {
+				if (
+					commit.committer?.type &&
+					commit.committer.type.toLowerCase() === "user" &&
+					commit.committer.login.toLowerCase() !== "web-flow"
+				) {
+					if (!contributors[commit.committer.id]) {
+						response.contributor_count++;
+						contributors[commit.committer.id] = {
+							login: commit.committer.login,
+							avatar_url: commit.committer.avatar_url,
+							html_url: commit.committer.html_url,
+							name: commit.commit.committer.name,
+						};
+					}
+					if (response.last_commit_date !== "") {
+						const new_commit_date = new Date(commit.commit.committer.date);
+						const exist_commit_date = new Date(response.last_commit_date);
+						if (new_commit_date > exist_commit_date)
+							response.last_commit_date = commit.commit.committer.date;
+					} else {
+						response.last_commit_date = commit.commit.committer.date;
+					}
+				} else if (commit.author?.id) {
+					if (!contributors[commit.author.id]) {
+						response.contributor_count++;
+						contributors[commit.author.id] = {
+							login: commit.author.login,
+							avatar_url: commit.author.avatar_url,
+							html_url: commit.author.html_url,
+							name: commit.commit.author.name,
+						};
+					}
+					if (response.last_commit_date !== "") {
+						const new_commit_date = new Date(commit.commit.author.date);
+						const exist_commit_date = new Date(response.last_commit_date);
+						if (new_commit_date > exist_commit_date)
+							response.last_commit_date = commit.commit.author.date;
+					} else {
+						response.last_commit_date = commit.commit.author.date;
+					}
+				}
+			}
+			for (const key in contributors) {
+				if (Object.hasOwn(contributors, key)) {
+					response.contributors.push(contributors[key]);
+				}
+			}
+		} else if (github_response.status === 403) {
+			// Private repo, fine-grained permissions don't yet support getting commits without content, get list from meta permissions
+			const contrib_url = get_github_contributors_path(repo).api_path;
+			try {
+				github_response = await axios.get(contrib_url, request_options);
+				if (retried) {
+					retried = false;
+					console.log("API call retry success!");
+				}
+			} catch (err) {
+				if (err.response?.status) {
+					if (err.response.status !== 200) {
+						response.error = err;
+						return response;
+					}
+				} else {
+					response.error = `Unexpected response from GitHub for [${contrib_url}:\n${JSON.stringify(
+						err,
+					)}]`;
+				}
+			}
+			if (github_response.status === 200) {
+				response.success = true;
+				const commits = github_response.data;
+				for (const commit of commits) {
+					if (
+						commit.type &&
+						commit.type.toLowerCase() === "user" &&
+						commit.login.toLowerCase() !== "web-flow"
+					) {
+						if (!contributors[commit.id]) {
+							response.contributor_count++;
+							contributors[commit.id] = {
+								login: commit.login,
+								avatar_url: commit.avatar_url,
+								html_url: commit.html_url,
+								name: commit.name ? commit.name : commit.login,
+							};
+						}
+						if (
+							response.last_commit_date !== "" &&
+							response.last_commit_date !== "No Commit Date Available"
+						) {
+							const new_commit_date = new Date(commit.date);
+							const exist_commit_date = new Date(response.last_commit_date);
+							if (new_commit_date > exist_commit_date)
+								response.last_commit_date = commit.date;
+						} else {
+							response.last_commit_date = commit.date
+								? commit.date
+								: "No Commit Date Available";
+						}
+					}
+				}
+				for (const key in contributors) {
+					if (Object.hasOwn(contributors, key)) {
+						response.contributors.push(contributors[key]);
+					}
+				}
+			}
+		} else {
+			response.error = `Unexpected Status: ${github_response.status}.`;
+		}
+		return response;
+	};
+
+	exports.strip_drafts = (nav_items) => {
+		const return_nav = nav_items;
+		recurse_nav(return_nav);
+		return return_nav;
+	};
+
+	const recurse_nav = (nav_items) => {
+		for (const key in nav_items) {
+			if (nav_items[key].draft) {
+				nav_items.splice(key, 1);
+				recurse_nav(nav_items);
+			} else if (nav_items[key].items) {
+				recurse_nav(nav_items[key].items);
+			}
+		}
+	};
+
+	exports.build_breadcrumbs = (nav_items) => {
+		const response = {
+			bc: {},
+			errors: [],
+		};
+		const buildBreadcrumb = (items, parentLinks) => {
+			// Process parent links
+			let parentlink = true;
+			if (parentLinks.length > 0) {
+				if (parentLinks[0].link === undefined || parentLinks[0].link === "")
+					parentlink = false;
+
+				for (let i = 1; i < 10; i++) {
+					if (
+						parentLinks[i] &&
+						parentLinks[i].link === undefined &&
+						items.length > 0 &&
+						items[0].link
+					) {
+						parentLinks[i].link = items[0].link;
+					}
+				}
+			}
+
+			// Loop through items, build breadcrumb
+			for (let i = 0; i < items.length; i++) {
+				if (!items[i].text) {
+					response.errors.push(
+						`The following Nav Item is missing its text property: ${JSON.stringify(
+							items[i],
+						)}`,
+					);
+				}
+
+				if (!items[i].link && !items[i].items) {
+					response.errors.push(
+						`The following Nav Item has no link or items property: ${JSON.stringify(
+							items[i],
+						)}`,
+					);
+				}
+				const item = items[i];
+				if (!parentlink && item.link) {
+					parentLinks[0].link = item.link;
+					parentlink = true;
+				}
+				const { text, link, items: subItems } = item;
+				const breadcrumb = [...parentLinks, { text, link }];
+
+				if (link) {
+					response.bc[link] = breadcrumb;
+				}
+
+				if (subItems) {
+					buildBreadcrumb(subItems, breadcrumb);
+				}
+			}
+		};
+
+		buildBreadcrumb(nav_items, []);
+		return response;
+	};
+
+	exports.load_product_families = async () => {
+		const response = {
+			success: false,
+			prod_families: {},
+			prods_supported: [],
+			errors: "",
+		};
+		const prod_families_url = "https://docs.hornbill.com/_books/products.json";
+		for (let i = 1; i < 4; i++) {
+			try {
+				const prods = await axios.get(prod_families_url, {
+					httpsAgent: agent,
+					timeout: 5000,
+				});
+				if (prods.status === 200) {
+					response.prod_families = prods.data;
+					response.prods_supported = [];
+					for (let i = 0; i < response.prod_families.products.length; i++) {
+						response.prods_supported.push(
+							response.prod_families.products[i].id,
+						);
+					}
+					response.success = true;
+					break;
+				}
+				throw `Unexpected status - ${prods.status} ${prods.statusText}`;
+			} catch (e) {
+				if (response.errors === "")
+					response.errors = `Request to ${prod_families_url} failed:`;
+				response.errors += `\nAttempt ${i} - Error returning product families: ${e}`;
+				// Wait 2 seconds and try again
+				await new Promise((r) => setTimeout(r, 2000));
+			}
+		}
+		return response;
+	};
+})();