hdoc-tools 0.8.40 → 0.8.41

package/hdoc-build-pdf.js

@@ -1,13 +1,13 @@
 (function () {
     'use strict';
 
-    const cheerio = require('cheerio'),
+    const axios = require('axios'),
+        cheerio = require('cheerio'),
         dree = require('dree'),
         fs = require('fs-extra'),
         mime = require('mime-types'),
         path = require('path'),
         puppeteer = require('puppeteer'),
-        request = require('sync-request'),
         hdoc = require(path.join(__dirname, 'hdoc-module.js'));
 
     const dree_options = {
@@ -67,15 +67,15 @@
             if (hdoc.valid_url(imgs[i])) {
                 // External Link
                 try {
-                    const file_response = request('GET', imgs[i]);
-                    if (file_response.statusCode === 200) {
-                        const image_buffer = file_response.getBody();
+                    const file_response = await axios.get(imgs[i]);
+                    if (file_response.status === 200) {
+                        const image_buffer = file_response.data;
                         const mime_type = mime.lookup(imgs[i]);
                         let image_b64 = image_buffer.toString("base64");
                         image_b64 = `data:${mime_type};base64,${image_b64}`;
                         html_source = html_source.replace(imgs[i], image_b64);
                     } else {
-                        throw `Unexpected Status ${file_response.statusCode}`;
+                        throw `Unexpected Status ${file_response.status}`;
                     }
                 } catch (err) {
                     console.log(`Error downloading external source [${imgs[i]}] - ${err}`);

package/hdoc-build.js

@@ -12,7 +12,7 @@
         hdoc_build_db = require(path.join(__dirname, 'hdoc-build-db.js')),
         hdoc_build_pdf = require(path.join(__dirname, 'hdoc-build-pdf.js')),
         hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
-        zipper = require('zip-local');
+        {zip} = require('zip-a-folder');
 
     const h_tags_to_search = ['h1', 'h2', 'h3'],
         doc_header_template_path = path.join(__dirname, 'templates', 'doc-header.html'),
@@ -262,7 +262,7 @@
             let md_txt = hdoc.expand_variables(fs.readFileSync(file_path.path, 'utf8'));
 
             // Pull in external includes
-            const includes_processed = hdoc.process_includes(file_path.path, md_txt);
+            const includes_processed = await hdoc.process_includes(file_path.path, md_txt);
             md_txt = includes_processed.body;
             includes_found += includes_processed.found;
             includes_success += includes_processed.success;
@@ -375,7 +375,7 @@
             if (hdocbook_config.publicSource && hdocbook_config.publicSource !== '' && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
 
                 const github_paths = hdoc.get_github_api_path(hdocbook_config.publicSource, file_path.relativePath);
-                const contributors = hdoc.get_github_contributors(github_paths.api_path, git_token);
+                const contributors = await hdoc.get_github_contributors(github_paths.api_path, git_token);
 
                 if (!contributors.success) {
                     console.log(`Error retrieving contributors from Github: ${contributors.error}`);
@@ -716,6 +716,28 @@
             process.exit(1);
         }
 
+        // Ccreate MD5 hash of content before build
+        dree.scan(work_path_content, md5DreeOptions, hash_callback);
+        let concat_hash = '|';
+        for (let i = 0; i < built_file_hashes.length; i++) {
+            concat_hash += built_file_hashes[i].path + ':' + built_file_hashes[i].hash + '|';
+        }
+        if (concat_hash === '|') {
+            console.log('No hash of content has been returned.');
+            process.exit(1);
+        }
+
+        // Create hash and write file
+        const hash = crypto.createHash("md5").update(concat_hash).digest("hex");
+        const checksum_path = path.join(work_path_content, 'checksum.md5');
+        try {
+            fs.writeFileSync(checksum_path, hash);
+            console.log('\nHash file creation success:', checksum_path);
+        } catch (e) {
+            console.log('\nError creating', checksum_path, ':', e);
+            process.exit(1);
+        }
+
         // Load document header templates
         try {
             doc_header_template = fs.readFileSync(doc_header_template_path, 'utf8');
@@ -768,6 +790,16 @@
             process.exit(1);
         }
 
+        // Add book read timing to the hdocbook.json
+        hdocbook_config.readingTime = Math.ceil(book_read_time + ((book_read_time / 100) * 10));
+        try {
+            fs.writeFileSync(work_hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
+            console.log('\nhdocbook.json update success:', work_hdocbook_path);
+        } catch (e) {
+            console.log('\nError creating', work_hdocbook_path, ':', e);
+            process.exit(1);
+        }
+
         // Build the index
         // Create the DB and tables
         let db = hdoc_build_db.create_db(work_path, doc_id);
@@ -782,41 +814,9 @@
             process.exit(1);
         }
 
-        // Now create MD5 hash of built content
-        dree.scan(work_path_content, md5DreeOptions, hash_callback);
-        let concat_hash = '|';
-        for (let i = 0; i < built_file_hashes.length; i++) {
-            concat_hash += built_file_hashes[i].path + ':' + built_file_hashes[i].hash + '|';
-        }
-        if (concat_hash === '|') {
-            console.log('No hash of content has been returned.');
-            process.exit(1);
-        }
-
-        const hash = crypto.createHash("md5").update(concat_hash).digest("hex");
-        const checksum_path = path.join(work_path_content, 'checksum.md5');
-        try {
-            fs.writeFileSync(checksum_path, hash);
-            console.log('\nHash file creation success:', checksum_path);
-        } catch (e) {
-            console.log('\nError creating', checksum_path, ':', e);
-            process.exit(1);
-        }
-
-
-        // Add book read timing to the hdocbook.json
-        hdocbook_config.readingTime = Math.ceil(book_read_time + ((book_read_time / 100) * 10));
-        try {
-            fs.writeFileSync(work_hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
-            console.log('\nhdocbook.json update success:', work_hdocbook_path);
-        } catch (e) {
-            console.log('\nError creating', work_hdocbook_path, ':', e);
-            process.exit(1);
-        }
-
         try {
             const zip_path = path.join(work_path, doc_id + '.zip');
-            zipper.sync.zip(work_path_content).compress().save(zip_path);
+            await zip(work_path_content, zip_path);
             console.log(`\nZIP Creation Success: ${zip_path}\n`);
             console.log('  Build Started:', build_start_dt);
             console.log(`Build Completed: ${new Date().toLocaleString()}\n`);

package/hdoc-module.js

@@ -1,9 +1,9 @@
 (function () {
     'use strict';
 
-    const   cheerio = require('cheerio'),
+    const   axios = require('axios'),
+            cheerio = require('cheerio'),
             html2text = require('html-to-text'),
-            request = require('sync-request'),
             wordsCount = require('words-count').default;
 
     let includesCache = {};
@@ -81,7 +81,7 @@
     };
 
 
-    exports.process_includes = function (file_path, body) {
+    exports.process_includes = async function (file_path, body) {
         let response = {
             body: '',
             found: 0,
@@ -127,11 +127,11 @@
 
             let file_content;
             try {
-                const file_response = request('GET', link);
-                if (file_response.statusCode === 200) {
-                    file_content = file_response.getBody('UTF8');
+                const file_response = await axios.get(link);
+                if (file_response.status === 200) {
+                    file_content = file_response.data;
                 } else {
-                    throw `Unexpected Status ${file_response.statusCode}`;
+                    throw `Unexpected Status ${file_response.status}`;
                 }
             } catch (e) {
                 response.failed++;
@@ -222,7 +222,7 @@
         return github_paths;
     };
 
-    exports.get_github_contributors = function(github_url, github_api_token) {
+    exports.get_github_contributors = async function(github_url, github_api_token) {
         let response = {
             success: false,
             error: '',
@@ -244,12 +244,17 @@
         if (github_api_token !== '') {
             request_options.headers.authorization = `Bearer ${github_api_token}`;
         }
-        const github_response = request('GET', github_url, request_options);
+        let github_response;
+        try {
+            github_response = await axios.get(github_url, request_options);
+        } catch (err) {
+            response.error = err;
+            return response;
+        }
 
-        if (github_response.statusCode === 200) {
+        if (github_response.status === 200) {
             response.success = true;
-            let commits = github_response.getBody('UTF8');
-            commits = JSON.parse(commits);
+            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]) {
@@ -276,7 +281,7 @@
                 }
             }
         } else {
-            response.error = `Unexpected Status ${github_response.statusCode}. ${JSON.parse(github_response.body.toString('utf8')).message}`;
+            response.error = `Unexpected Status: ${github_response.status}.`;
         }
         return response;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.8.40",
+  "version": "0.8.41",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -49,8 +49,7 @@
     "prompt": "^1.3.0",
     "puppeteer": "^19.6.0",
     "stream": "0.0.2",
-    "sync-request": "^6.1.0",
     "words-count": "^2.0.2",
-    "zip-local": "^0.3.5"
+    "zip-a-folder": "^1.1.5"
   }
 }