hdoc-tools 0.8.22 → 0.8.23

package/hdoc-build-db.js

@@ -0,0 +1,141 @@
+(function () {
+    'use strict';
+
+    const   path = require('path'),
+            hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
+            database = require('better-sqlite3');
+
+    const db_schema = {
+        hdoc_index: [
+            'relative_url UNINDEXED',
+            'book_id',
+            'book_audience UNINDEXED',
+            'book_tags',
+            'doc_title',
+            'doc_content',
+            'doc_preview UNINDEXED',
+            'doc_family_id'
+        ],
+        hdoc_meta: [
+            'doc_id INTEGER',
+            'contributor_count INTEGER UNINDEXED',
+            'edit_url UNINDEXED',
+            'last_commit UNINDEXED'
+        ],
+        hdoc_contributors: [
+            'doc_id INTEGER',
+            'login',
+            'name',
+            'avatar UNINDEXED',
+            'url UNINDEXED'
+        ]
+    };
+
+    exports.create_table = function (db, table, cols, virtual, fts5) {
+        const table_created = hdoc_index.create_table(db, table, cols, virtual, fts5);
+        if (table_created !== null) {
+            return `\nError creating table: ${table_created}`;
+        } else {
+            console.log(`\nTable created: ${table}`);
+        }
+        return null;
+    };
+
+    exports.create_db = function (db_path, doc_id) {
+        let response = {
+            error: null,
+            db: null
+        };
+        console.log('Performing SQlite index creation...');
+        let db_name = path.join(db_path, doc_id, 'index.db');
+        response.db = new database(db_name);
+        response.db.pragma('encoding="UTF-8"');
+        console.log(`\nDatabase created: ${db_name}`);
+
+        // Create tables
+        for (const key in db_schema) {
+            if (db_schema.hasOwnProperty(key)) {
+                const virtual = key === 'hdoc_index' ? true : false;
+                const fts5 = key === 'hdoc_index' ? true : false;
+                const table_created_error = this.create_table(response.db, key, db_schema[key], virtual, fts5);
+                if (table_created_error !== null) {
+                    console.log(table_created_error);
+                }
+            }
+        }
+        return response;
+    };
+
+    exports.populate_index = function (db, doc_id, book_config, index_records, verbose = false) {
+        let response = {
+            success: false,
+            index_success_count: 0,
+            error: ''
+        };
+
+        if (!book_config.tags) book_config.tags = [];
+
+        for (let i = 0; i < index_records.length; i++) {
+            let index_path_name = index_records[i].relative_path.replace('\\', '/').replace(`${doc_id}/`, '');
+            index_path_name = index_path_name.replace(path.extname(index_records[i].relative_path), '');
+            const index_vals = [
+                index_path_name,
+                doc_id,
+                book_config.audience.join(','),
+                book_config.tags.join(','),
+                index_records[i].index_html.fm_props.title,
+                index_records[i].index_html.text,
+                index_records[i].index_html.preview,
+                book_config.productFamily
+            ];
+            const index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
+            if (!index_response.success) {
+                console.log(`Index record creation failed - ${doc_id}/${index_records[i].index_html.fm_props.title}: ${index_response.error}`);
+                continue;
+            }
+
+            // Now add metadata
+            const meta_vals = [
+                parseInt(index_response.row_id, 10),
+                index_records[i].metadata.contributor_count,
+                index_records[i].metadata.edit_url,
+                index_records[i].metadata.last_commit
+            ];
+            const meta_response = hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
+            if (!meta_response.success) {
+                console.log(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${index_records[i].index_html.fm_props.title}: ${meta_response.error}`);
+                continue;
+            }
+            if (verbose) {
+                console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${index_records[i].index_html.fm_props.title}`);
+                console.log(`Inserted index metadata record for index ID: ${meta_response.row_id}`);
+            }
+
+            // Now add contributor records
+            for (let j = 0; j < index_records[i].contributors.length; j++) {
+                const contrib_vals = [
+                    parseInt(index_response.row_id, 10),
+                    index_records[i].contributors[j].login,
+                    index_records[i].contributors[j].name,
+                    index_records[i].contributors[j].avatar_url,
+                    index_records[i].contributors[j].html_url
+                ];
+                const cont_response = hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
+                if (!cont_response.success) {
+                    console.log(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${index_records[i].index_html.fm_props.title}: ${cont_response.error}`);
+                    continue;
+                }
+                if (verbose) {
+                    console.log(`Inserted document contributor recordL ${cont_response.row_id}`);
+                }   
+            }
+
+            response.index_success_count++;
+            
+        }
+        response.success = true;
+        console.log(`\nIndex Build Complete:`);
+        console.log(`${response.index_success_count} document index records created.`);
+        return response;
+    };
+})();

package/hdoc-build.js

@@ -37,7 +37,7 @@
         static_html_files = [],
         work_path_content = '';
 
-    const transform_static_html = function (file_path) {
+    const transform_static_html = async function (file_path) {
         if (fs.existsSync(file_path.path)) {
             // Load HTML file
             let html_txt = fs.readFileSync(file_path.path, 'utf8');
@@ -211,7 +211,7 @@
         }
     };
 
-    const transform_markdown_and_save_html = function (file_path) {
+    const transform_markdown_and_save_html = async function (file_path) {
         conversion_attempted++;
         if (fs.existsSync(file_path.path)) {
             // Load markdown file
@@ -603,7 +603,7 @@
         //console.log(JSON.stringify(bc, null, 2));
     };
 
-    exports.run = function (source_path, verbose, github_api_token) {
+    exports.run = async function (source_path, verbose, github_api_token) {
         if (github_api_token !== '') {
             git_token = github_api_token;
         }
@@ -669,14 +669,14 @@
         dree.scan(work_path, dreeOptions, build_file_callback);
 
         // Work through MD files and convert to HTML
-        md_files.forEach(function (md_file) {
-            transform_markdown_and_save_html(md_file);
-        });
-
+        for (let i = 0; i < md_files.length; i++) {
+            await transform_markdown_and_save_html(md_files[i]);
+        }
+        
         // Work through Static HTML files and add Frontmatter tags
-        static_html_files.forEach(function (static_html_file) {
-            transform_static_html(static_html_file);
-        });
+        for (let i = 0; i < static_html_files.length; i++) {
+            await transform_static_html(static_html_files[i]);
+        }
 
         // Output to console
         console.log(`                MD files found: ${conversion_attempted}`);

package/hdoc.js

@@ -1,6 +1,6 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
-(function () {
+(async function () {
    'use strict';
 
    const preRun = require('./validateNodeVer.js'),
@@ -71,7 +71,7 @@
       server.run(ui_path, source_path);
    } else if (command == 'build') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      builder.run(source_path, verbose, git_token);
+      await builder.run(source_path, verbose, git_token);
    } else if (command == 'stats') {
       const stats = require(path.join(__dirname, 'hdoc-stats.js'));
       stats.run(ui_path, source_path, verbose);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.8.22",
+  "version": "0.8.23",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -10,6 +10,7 @@
     "hdoc.js",
     "hdoc-db.js",
     "hdoc-build.js",
+    "hdoc-build-db.js",
     "hdoc-help.js",
     "hdoc-init.js",
     "hdoc-module.js",