hdoc-tools 0.11.7 → 0.11.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hornbill Docs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/hdoc-build-db.js

@@ -1,153 +1,153 @@
-(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: [
-            'resource_url UNINDEXED',
-            'book_id',
-            'book_audience UNINDEXED',
-            'book_tags',
-            'doc_title',
-            'doc_content',
-            'doc_preview UNINDEXED',
-            'doc_family_id',
-            'doc_md5_hash UNINDEXED',
-            'doc_lastmod'
-        ],
-        hdoc_meta: [
-            'resource_url',
-            'book_id',
-            'contributor_count INTEGER UNINDEXED',
-            'edit_url UNINDEXED',
-            'last_commit UNINDEXED',
-            'pdf_size INTEGER UNINDEXED'
-        ],
-        hdoc_contributors: [
-            'resource_url',
-            'book_id',
-            '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('\nPerforming 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 = async 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 = [];
-
-        let indexPromises = [];
-        for (let i = 0; i < index_records.length; i++) {
-            indexPromises.push(index_records[i]);
-        }
-        await Promise.all(indexPromises.map(async (file) => {
-            let index_path_name = file.relative_path.replace('\\', '/');
-            index_path_name = '/' + index_path_name.replace(path.extname(file.relative_path), '');
-            const index_vals = [
-                index_path_name,
-                doc_id,
-                book_config.audience.join(','),
-                book_config.tags.join(','),
-                file.index_html.fm_props.title,
-                file.index_html.text,
-                file.index_html.preview,
-                book_config.productFamily,
-                file.md5,
-                file.lastmod
-            ];
-            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}/${file.index_html.fm_props.title}: ${index_response.error}`);
-            } else {
-                // Now add metadata
-                const meta_vals = [
-                    index_path_name,
-                    doc_id,
-                    file.metadata.contributor_count,
-                    file.metadata.edit_url,
-                    file.metadata.last_commit,
-                    file.pdf_size
-                ];
-                const meta_response = await 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}/${file.index_html.fm_props.title}: ${meta_response.error}`);
-                } else {
-                    if (verbose) {
-                        console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.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 < file.contributors.length; j++) {
-                        const contrib_vals = [
-                            index_path_name,
-                            doc_id,
-                            file.contributors[j].login,
-                            file.contributors[j].name,
-                            file.contributors[j].avatar_url,
-                            file.contributors[j].html_url
-                        ];
-                        const cont_response = await 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}/${file.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: ${response.index_success_count} document index records created.`);
-        return response;
-    };
+(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: [
+            'resource_url UNINDEXED',
+            'book_id',
+            'book_audience UNINDEXED',
+            'book_tags',
+            'doc_title',
+            'doc_content',
+            'doc_preview UNINDEXED',
+            'doc_family_id',
+            'doc_md5_hash UNINDEXED',
+            'doc_lastmod'
+        ],
+        hdoc_meta: [
+            'resource_url',
+            'book_id',
+            'contributor_count INTEGER UNINDEXED',
+            'edit_url UNINDEXED',
+            'last_commit UNINDEXED',
+            'pdf_size INTEGER UNINDEXED'
+        ],
+        hdoc_contributors: [
+            'resource_url',
+            'book_id',
+            '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('\nPerforming 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 = async 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 = [];
+
+        let indexPromises = [];
+        for (let i = 0; i < index_records.length; i++) {
+            indexPromises.push(index_records[i]);
+        }
+        await Promise.all(indexPromises.map(async (file) => {
+            let index_path_name = file.relative_path.replace('\\', '/');
+            index_path_name = '/' + index_path_name.replace(path.extname(file.relative_path), '');
+            const index_vals = [
+                index_path_name,
+                doc_id,
+                book_config.audience.join(','),
+                book_config.tags.join(','),
+                file.index_html.fm_props.title,
+                file.index_html.text,
+                file.index_html.preview,
+                book_config.productFamily,
+                file.md5,
+                file.lastmod
+            ];
+            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}/${file.index_html.fm_props.title}: ${index_response.error}`);
+            } else {
+                // Now add metadata
+                const meta_vals = [
+                    index_path_name,
+                    doc_id,
+                    file.metadata.contributor_count,
+                    file.metadata.edit_url,
+                    file.metadata.last_commit,
+                    file.pdf_size
+                ];
+                const meta_response = await 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}/${file.index_html.fm_props.title}: ${meta_response.error}`);
+                } else {
+                    if (verbose) {
+                        console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.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 < file.contributors.length; j++) {
+                        const contrib_vals = [
+                            index_path_name,
+                            doc_id,
+                            file.contributors[j].login,
+                            file.contributors[j].name,
+                            file.contributors[j].avatar_url,
+                            file.contributors[j].html_url
+                        ];
+                        const cont_response = await 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}/${file.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: ${response.index_success_count} document index records created.`);
+        return response;
+    };
 })();