hdoc-tools 0.17.28 → 0.17.30

package/hdoc-build.js

@@ -1,5 +1,3 @@
-const { extension } = require("mime-types");
-
 (function () {
   "use strict";
 
@@ -19,6 +17,7 @@ const { extension } = require("mime-types");
     xmlFormat = require("xml-formatter");
 
   const h_tags_to_search = ["h1", "h2", "h3"],
+    image_extensions = [ 'png', 'svg', 'jpg' ],
     doc_header_template_path = path.join(
       __dirname,
       "templates",
@@ -1030,11 +1029,14 @@ const { extension } = require("mime-types");
   // File scan callback for filename validation
   const filename_validation_callback = function (element) {
     if (element.relativePath.startsWith('_inline/')) return;
+    if (element.name.toLowerCase() === '.ds_store') return;
     if (element.name === 'article_ext.md' || element.name === 'description_ext.md') return;
+    if (image_extensions.includes(element.extension)) return;
     const file_no_ext = element.name.replace(`.${element.extension}`, '');
     if (!file_no_ext.match(regex_filename)) errors_filename.push(element.relativePath);
   };
 
+
   const dreeOptions = {
     hash: true,
     extensions: ["md", "html", "htm"],
@@ -1210,10 +1212,14 @@ const { extension } = require("mime-types");
     }
     fs.mkdirSync(work_path);
 
+    const file_filter = (src) => {
+      return !src.toLowerCase().endsWith('.ds_store');
+    };
+
     // Copy files from book into _work-doc_id folder
     console.log(`Copying content into work folder...`);
     try {
-      fs.copySync(path.join(source_path, doc_id), work_path_content);
+      fs.copySync(path.join(source_path, doc_id), work_path_content, { filter: file_filter });
     } catch (e) {
       console.error("Error copying from source_path:\n", e);
       process.exit(1);

package/hdoc-serve.js

@@ -48,7 +48,12 @@
       const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
 
       // Load the hdocbook config  file
-      hdocbook_project = require(hdocbook_project_config_path);
+      try {
+         hdocbook_project = require(hdocbook_project_config_path);
+      } catch (e) {
+         console.log(`\nFailed to load hdocbook-project.json:\n${e}\n`);
+         process.exit(1);
+      }
 
       // Get the ID of the hdocbook we are serving
       docId = hdocbook_project.docId;
@@ -78,7 +83,12 @@
       const hdocbook_path = path.join(source_path, docId, 'hdocbook.json');
 
       // Pull in the book config file
-      hdocbook_config = require(hdocbook_path);
+      try {
+         hdocbook_config = require(hdocbook_path);
+      } catch (e) {
+         console.log(`\nFailed to load hdocbook.json:\n${e}\n`);
+         process.exit(1);
+      }
 
       app.get('/_books/library.json', function (req, res) {
          let library = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.17.28",
+  "version": "0.17.30",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {

package/ui/content/invalid-hdocbook-json.html

@@ -0,0 +1,6 @@
+<h1>FAILED TO LOAD HDOC MENU</h1>
+<div class="alert alert-danger" role="alert">
+    <strong>Warning!</strong>
+    <p><strong>hdoc serve</strong> has failed to load the book navigation. This is due to invalid JSON in the <code>hdocbook.json</code> file in your book.</p>
+    <p>Please fix the broken JSON, then refresh your browser to reload the book.</p>
+</div>

package/ui/content/invalid-hdocbook-json.md

@@ -0,0 +1,7 @@
+<h1>FAILED TO LOAD HDOC MENU</h1>
+<div class="alert alert-danger" role="alert">
+    <p><code>hdoc serve</code> has failed to load the book navigation. This is due to invalid JSON in the <code>hdocbook.json</code> file in your book.</p>
+    <p>Please fix the broken JSON, then refresh your browser to reload the book.</p>
+    <p>{{docApp.error}}</p>
+    </div>
+</div>

package/ui/index.html

@@ -138,6 +138,7 @@
 
                 <h2 class="title">{{docApp.title}}</h2>
                 <h6 class="description">{{docApp.description}}</h6>
+               
                 <!-- could generate nav bar based on library settings -->
                 <!--
                     <ul class="nav-bar-nav-list">
@@ -240,59 +241,69 @@
                     <div v-show="!docApp.showInlineDocumentsMarkup" class="injected-document-container hb-container-horizontal">
 
                         <div class="injected-document-content">
-                            <div class="document-header">
-
-                                <!-- breadcrumb-->
-                                <div class="hb-container-horizontal">
-                                    <div class="hb-center-v hb-container-expand">
-                                        <ul class="ps-0 nav-bar-nav-list noeffects after-fslash  overflow-ellipsis">
-                                            <li class="mt-0  nav-bar-item"
-                                                v-for="(crumb,$index) in docApp.bookBreadCrumb">
-                                                <a class="ps-0 pe-0 text-decoration-none"
-                                                    v-bind:href="crumb.link">{{crumb.title}}</a>
-                                            </li>
-                                        </ul>
+                            <div v-if="docApp.error === ''">
+                                <div class="document-header">
+
+                                    <!-- breadcrumb-->
+                                    <div class="hb-container-horizontal">
+                                        <div class="hb-center-v hb-container-expand">
+                                            <ul class="ps-0 nav-bar-nav-list noeffects after-fslash  overflow-ellipsis">
+                                                <li class="mt-0  nav-bar-item"
+                                                    v-for="(crumb,$index) in docApp.bookBreadCrumb">
+                                                    <a class="ps-0 pe-0 text-decoration-none"
+                                                        v-bind:href="crumb.link">{{crumb.title}}</a>
+                                                </li>
+                                            </ul>
+                                        </div>
+                                        <div class="toolbar-right hb-center-v">
+
+                                            <a class="toolbar-action" v-bind:href="docApp.documentGithubUrl"
+                                                target="_blank">
+                                                <i class="bi bi-pencil"></i>
+                                            </a>
+
+                                            <a class="toolbar-action">
+                                                <i class="bi bi-three-dots-vertical"></i>
+                                            </a>
+                                        </div>
                                     </div>
-                                    <div class="toolbar-right hb-center-v">
 
-                                        <a class="toolbar-action" v-bind:href="docApp.documentGithubUrl"
-                                            target="_blank">
-                                            <i class="bi bi-pencil"></i>
-                                        </a>
-
-                                        <a class="toolbar-action">
-                                            <i class="bi bi-three-dots-vertical"></i>
-                                        </a>
+                                    <div class="document-title"></div>
+
+                                    <!-- doc frontmatter info -->
+                                    <div class="hb-container-horizontal">
+                                        <div class="hb-center-v hb-container-expand">
+                                            <ul
+                                                class="ps-0 nav-bar-nav-list noeffects after-bullets  overflow-ellipsis text-light-2">
+                                                <li class="ps-0 mt-0 nav-bar-item">
+                                                    Article
+                                                </li>
+                                                <li class="ps-0 mt-0 nav-bar-item">
+                                                    YYYY-MM-DD
+                                                </li>
+                                                <li class="ps-0 mt-0 nav-bar-item">
+                                                    (n) minutes to read
+                                                </li>
+                                                <li class="ps-0 mt-0 nav-bar-item">
+                                                    <a class="link c-pointer">(n) contributors</a>
+                                                </li>
+                                            </ul>
+                                        </div>
+                                        <div class="toolbar-right hb-center-v">
+                                        </div>
                                     </div>
-                                </div>
 
-                                <div class="document-title"></div>
-
-                                <!-- doc frontmatter info -->
-                                <div class="hb-container-horizontal">
-                                    <div class="hb-center-v hb-container-expand">
-                                        <ul
-                                            class="ps-0 nav-bar-nav-list noeffects after-bullets  overflow-ellipsis text-light-2">
-                                            <li class="ps-0 mt-0 nav-bar-item">
-                                                Article
-                                            </li>
-                                            <li class="ps-0 mt-0 nav-bar-item">
-                                                YYYY-MM-DD
-                                            </li>
-                                            <li class="ps-0 mt-0 nav-bar-item">
-                                                (n) minutes to read
-                                            </li>
-                                            <li class="ps-0 mt-0 nav-bar-item">
-                                                <a class="link c-pointer">(n) contributors</a>
-                                            </li>
-                                        </ul>
-                                    </div>
-                                    <div class="toolbar-right hb-center-v">
-                                    </div>
                                 </div>
+                                <div class="document-body"></div>
+                            </div>
 
+                            <div v-if="docApp.error !== ''">
+                                <div class="alert alert-danger" role="alert">
+                                    <h1>Book Navigation Render Failed!</h1>
+                                    <p>This is likely due to invalid JSON in the <strong>hdocbook.json</strong> file in your book. Please fix the error below, then refresh your browser to reload the book.</p>
+                                    <p><code>{{docApp.error}}</code></p>
+                                </div>
                             </div>
-                            <div class="document-body"></div>
 
                         </div>
 

package/ui/js/doc.hornbill.js

@@ -246,10 +246,9 @@ function generateTableOfContentsFromDoc() {
 }
 
 
-function loadContentUrl(linkRef, fromPageRefresh, fromPopState) {
+function loadContentUrl(linkRef, fromPageRefresh, fromPopState, fromBook = true) {
     //-- clear table of contents
     view.docApp.tableOfContents = [];
-
     if (linkRef.indexOf(window.location.origin + "/") === 0) {
         linkRef = linkRef.replace(window.location.origin + "/", "");
     }
@@ -260,15 +259,17 @@ function loadContentUrl(linkRef, fromPageRefresh, fromPopState) {
     linkRef = removeStartingSlash(linkRef);
 
     //-- update url in browser
-    setBrowserViewUrl(linkRef, {}, fromPageRefresh, fromPopState);
-
+    if (fromBook) setBrowserViewUrl(linkRef, {}, fromPageRefresh, fromPopState);
     //-- destroy any existing content children and events properly
     jqContentContainer.empty();
     jqDocumentHeader.find(".document-title").empty();
-
+    
     //-- for now just load whatever the href prop is (we can add actions to perform specific processing and then load content based on element atts etc)
     let frontmatterData = {};
-    let booksLinkRef = linkRef.includes('_books/') ? linkRef : "_books/" + linkRef;
+    let booksLinkRef = linkRef;
+    if (fromBook) {
+        booksLinkRef = linkRef.includes('_books/') ? linkRef : "_books/" + linkRef;
+    }
     fetch(booksLinkRef).then(response => {
         if (response.headers.has("X-frontmatter")) {
             frontmatterData = response.headers.get("X-frontmatter");
@@ -333,7 +334,6 @@ function loadContentUrl(linkRef, fromPageRefresh, fromPopState) {
             });
         });
 
-
         //-- do any code highlighting
         if (hljs) {
             document.querySelectorAll('pre code').forEach((el) => {
@@ -372,8 +372,7 @@ function loadContentUrl(linkRef, fromPageRefresh, fromPopState) {
 
 
         setGitHubBookUrl(linkRef);
-
-
+        
         //-- make sure selected link parents are set to .expand=true
         if (expandNavParentSectionBySelectedLinkHref(linkRef)) {
             view.updateCounter++;
@@ -381,7 +380,7 @@ function loadContentUrl(linkRef, fromPageRefresh, fromPopState) {
                 //-- find any navigation links that match url and highlight
                 //                listenForHrefClicks();
                 highlightNavigationLinkFromUrl(linkRef);
-
+                
                 //-- scroll to element that match hash (if have one)
                 if (document.location.hash) {
                     let gotoEle = getAnchorFromHash(document.location.hash);
@@ -390,7 +389,7 @@ function loadContentUrl(linkRef, fromPageRefresh, fromPopState) {
             });
             view.$forceUpdate();
         }
-
+        
         listenForHrefClicks();
     });
 }
@@ -547,11 +546,11 @@ async function fetchJsonFile(strFilePath) {
 
 
 //-- THE INIT APP CALLED FROM index.html
-$(".document-body").attr("v-pre", "");
+//$(".document-body").attr("v-pre", "");
 
 var view = new Vue({
     el: '#vDocDevApp',
-    data: { userSession: {}, updateCounter: 0, bookId: "", docApp: {inlinePopupDocumentHref:"",showInlineDocumentsMarkup:false, keepTocLayout: false, book: {}, navSections: [], inlineDocumentItems:[], tableOfContents: [], bookBreadCrumb: [] } },
+    data: { userSession: {}, updateCounter: 0, bookId: "", docApp: {error: "", inlinePopupDocumentHref:"",showInlineDocumentsMarkup:false, keepTocLayout: false, book: {}, navSections: [], inlineDocumentItems:[], tableOfContents: [], bookBreadCrumb: [] } },
     methods: docAppMethods,
     directives: {
         somedirectivename: {
@@ -603,33 +602,6 @@ async function intialiseApp() {
     //jqContentContainer = $(".injected-document-content");
     jqLeftNav = $("#DocSidebarNav");
 
-
-    //-- get session info
-    /*
-    let dummyResponse = {
-        "type": "user",
-        "userId": "doom-guy",
-        "userName": "Doom Guy",
-        "email": "doomguy@hornbill.com",
-        "profileImage": "https://www.writeups.org/wp-content/uploads/Doomguy-doom-portrait-featured-sprite.jpg",
-        "issuerDomain": ".hornbill.com",
-        "issuerInstance": "hornbill",
-        "validUntil": "2023-07-30 06:33:49Z"
-    }
-    dummyResponse.expiresDateTime = new Date(dummyResponse.validUntil).toLocaleDateString() + ' ' + new Date(dummyResponse.validUntil).toLocaleTimeString();
-    */
-
-    fetchJsonFile("_api/session/").then(function (sessionData) {
-        hslDocLog.log("Hornbill docs get session data response", sessionData)
-        if (sessionData && sessionData.type === "user") {
-            hslDocLog.log("Hornbill docs set session set expires date time to browser locale")
-            sessionData.expiresDateTime = new Date(sessionData.validUntil).toLocaleDateString() + ' ' + new Date(sessionData.validUntil).toLocaleTimeString();
-            hslDocLog.log("Hornbill docs update vue session object model", sessionData);
-            view.setSessionInfo(sessionData);
-        }
-    });
-
-    //-- eof session stuff
     await fetchJsonFile("_books/library.json").then(function (data) {
 
         // Get docbook library list
@@ -674,12 +646,15 @@ async function intialiseApp() {
 
                 }
                 else {
-                    hslDocLog.log("initial first view link to laod is not present");
+                    hslDocLog.log("initial first view link to load is not present");
                 }
 
                 $(".hb-hidden").removeClass("hb-hidden");
 
             }, 200);
+        }).catch(function (data) {
+            view.docApp.error = data;
+            $(".hb-hidden").removeClass("hb-hidden");
         });
     });
 }