hdoc-tools 0.11.6 → 0.11.7

package/hdoc-module.js

@@ -1,391 +1,391 @@
-(function () {
-    'use strict';
-
-    const axios = require('axios'),
-        cheerio = require('cheerio'),
-        html2text = require('html-to-text'),
-        https = require('https'),
-        wordsCount = require('words-count').default;
-
-    let includesCache = {},
-        agent = new https.Agent({
-            rejectUnauthorized: false
-        });
-
-    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) {
-        let response = {
-            body: '',
-            found: 0,
-            success: 0,
-            failed: 0,
-            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 (includesCache[link] !== undefined) {
-                console.log(`Serving From Cache: ${link}`);
-                body = body.replace(include_value, includesCache[link]);
-                continue;
-            }
-
-            // Validate link in INCLUDE
-            try {
-                new URL(link);
-            } catch (err) {
-                response.failed++;
-                response.errors.push(`Error validating INCLUDE link [${link}] from [${file_path}]: ${e}`);
-                continue;
-            }
-
-            let file_content;
-            try {
-                const file_response = await axios.get(link);
-                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;
-            }
-            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;
-    };
-
-    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);
-                                }
-                                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=/' + relative_path.replace('\\\\', '/').replace('\\', '/');
-            github_paths.edit_path = repo + '/blob/main/' + relative_path.replace('\\\\', '/').replace('\\', '/');
-            return github_paths;
-        }
-        return '';
-    };
-
-    exports.get_github_contributors = async function (github_url, github_api_token) {
-        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'
-            }
-        };
-        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);
-        } catch (err) {
-            response.error = err;
-            return response;
-        }
-
-        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;
-                    }
-                }
-            });
-            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) {
-        const bc = {};
-        const buildBreadcrumb = (items, parentLinks) => {
-
-            // Process parent links
-            let parentlink = true;
-            if (parentLinks.length > 0) {
-                if (parentLinks[0].link === undefined || parentLinks[0].link === '') parentlink = false;
-                if (parentLinks[1] && parentLinks[1].link === undefined && items.length > 0 && items[0].link) {
-                    parentLinks[1].link = items[0].link;
-                }
-                if (parentLinks[2] && parentLinks[2].link === undefined && items.length > 0 && items[0].link) {
-                    parentLinks[2].link = items[0].link;
-                }
-            }
-
-            // Loop through items, build breadcrumb
-            for (let i = 0; i < items.length; 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) {
-                    bc[link] = breadcrumb;
-                }
-
-                if (subItems) {
-                    buildBreadcrumb(subItems, breadcrumb);
-                }
-            }
-        };
-
-        buildBreadcrumb(nav_items, []);
-        return bc;
-    };
-
-    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;
-    };
+(function () {
+    'use strict';
+
+    const axios = require('axios'),
+        cheerio = require('cheerio'),
+        html2text = require('html-to-text'),
+        https = require('https'),
+        wordsCount = require('words-count').default;
+
+    let includesCache = {},
+        agent = new https.Agent({
+            rejectUnauthorized: false
+        });
+
+    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) {
+        let response = {
+            body: '',
+            found: 0,
+            success: 0,
+            failed: 0,
+            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 (includesCache[link] !== undefined) {
+                console.log(`Serving From Cache: ${link}`);
+                body = body.replace(include_value, includesCache[link]);
+                continue;
+            }
+
+            // Validate link in INCLUDE
+            try {
+                new URL(link);
+            } catch (err) {
+                response.failed++;
+                response.errors.push(`Error validating INCLUDE link [${link}] from [${file_path}]: ${e}`);
+                continue;
+            }
+
+            let file_content;
+            try {
+                const file_response = await axios.get(link);
+                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;
+            }
+            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;
+    };
+
+    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);
+                                }
+                                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=/' + relative_path.replace('\\\\', '/').replace('\\', '/');
+            github_paths.edit_path = repo + '/blob/main/' + relative_path.replace('\\\\', '/').replace('\\', '/');
+            return github_paths;
+        }
+        return '';
+    };
+
+    exports.get_github_contributors = async function (github_url, github_api_token) {
+        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'
+            }
+        };
+        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);
+        } catch (err) {
+            response.error = err;
+            return response;
+        }
+
+        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;
+                    }
+                }
+            });
+            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) {
+        const bc = {};
+        const buildBreadcrumb = (items, parentLinks) => {
+
+            // Process parent links
+            let parentlink = true;
+            if (parentLinks.length > 0) {
+                if (parentLinks[0].link === undefined || parentLinks[0].link === '') parentlink = false;
+                if (parentLinks[1] && parentLinks[1].link === undefined && items.length > 0 && items[0].link) {
+                    parentLinks[1].link = items[0].link;
+                }
+                if (parentLinks[2] && parentLinks[2].link === undefined && items.length > 0 && items[0].link) {
+                    parentLinks[2].link = items[0].link;
+                }
+            }
+
+            // Loop through items, build breadcrumb
+            for (let i = 0; i < items.length; 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) {
+                    bc[link] = breadcrumb;
+                }
+
+                if (subItems) {
+                    buildBreadcrumb(subItems, breadcrumb);
+                }
+            }
+        };
+
+        buildBreadcrumb(nav_items, []);
+        return bc;
+    };
+
+    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;
+    };
 })();