hdoc-tools 0.9.53 → 0.9.55

package/hdoc-build.js

@@ -203,11 +203,7 @@
                     delete contributors.success;
                     delete contributors.error;
                     contributors.editPath = github_paths.edit_path;
-                    try {
-                        fs.writeFileSync(target_file, JSON.stringify(contributors, null, 2));
-                    } catch (err) {
-                        console.log('Error writing:', target_file, '\n', err);
-                    }
+
                 }
                 fm_headers.push({
                     id: 'edit-path',
@@ -229,7 +225,7 @@
 
             let doc_header = '';
             let pdf_header = '';
-            if (hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
+            if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
@@ -439,7 +435,7 @@
 
             let doc_header = '';
             let pdf_header = '';
-            if (hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
+            if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
@@ -633,7 +629,7 @@
             process.exit(1);
         }
 
-        if (hdocbook_config.publicSource.endsWith('.git')) hdocbook_config.publicSource = hdocbook_config.publicSource.substring(0, hdocbook_config.publicSource.length - 4);
+        if (hdocbook_config.publicSource && hdocbook_config.publicSource.endsWith('.git')) hdocbook_config.publicSource = hdocbook_config.publicSource.substring(0, hdocbook_config.publicSource.length - 4);
 
         console.log(`Loading product families...`);
         const prods = await hdoc.load_product_families();

package/hdoc-module.js

@@ -222,12 +222,15 @@
     };
 
     exports.get_github_api_path = function (repo, relative_path) {
-        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;
+        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) {

package/hdoc-stats.js

@@ -1,31 +1,31 @@
 
 (function () {
     'use strict';
-    
+
     // Required modules
     // /const { STATUS_CODES } = require('http');
     const fs = require('fs'),
-    path = require('path'),
-    dree = require('dree'),
-    html2text = require('html-to-text'),
-    wordsCount = require('words-count').default;  
-    
+        path = require('path'),
+        dree = require('dree'),
+        html2text = require('html-to-text'),
+        wordsCount = require('words-count').default;
+
     // Regex to remove Hornbill-specific tags 
     const hbMDTagRegex = /(:{3}[ ]note)|(:{3}[ ]tip)|(:{3}[ ]important)|(:{3}[ ]caution)|(:{3}[ ]warning)|(:{3})/g;
-    
+
     let stats = {
         totalMDFiles: 0,
         totalStaticHTMLFiles: 0,
         totalWordCount: 0,
         mdFiles: {},
-        staticHTMLFiles: {} 
+        staticHTMLFiles: {}
     };
 
     let markdownFiles = [];
 
     // File callback for scan 
-    const fileCallback = function(element) {
-        if (element.extension === 'md' ) {
+    const fileCallback = function (element) {
+        if (element.extension === 'md') {
             markdownFiles.push(element);
             stats.totalMDFiles++;
         } else {
@@ -51,7 +51,7 @@
     const dreeOptions = {
         descendants: true,
         depth: 10,
-        extensions: ['md','html','htm'],
+        extensions: ['md', 'html', 'htm'],
         hash: false,
         normalize: true,
         size: true,
@@ -60,8 +60,8 @@
         symbolicLinks: false
     };
 
-    exports.run = function(ui_path, source_path, verbose = false) {
-        
+    exports.run = function (ui_path, source_path, verbose = false) {
+
         // GERRY: The stats here are needed to support content development. The idea is to count all of the ]
         // words in a HDocBook so we know the size of the book, this helps with 3rd party involvement where
         // we generally need to know the word count of the content in order to get a quote for things like
@@ -69,12 +69,12 @@
         //
         // For each .md file, and for each static .HTML file (that is html files that we have not generated) we
         // should do a word count, excluding MD or HTML tags
-        
+
         // STEVE: Get the docId (book root) from the hdocbook-project.json
         // From there, loop through looking for:
         // * HTML files without a matching MD, and word count those
         // * MD files, and word count those
-        
+
 
         console.log('Hornbill HDocBook Stats : verbose=' + verbose, '\r\n');
 
@@ -112,7 +112,7 @@
 
             // Scan content path directory, send file info to callback for processing
             dree.scan(bookPath, dreeOptions, fileCallback);
-            markdownFiles.forEach(function(element){
+            markdownFiles.forEach(function (element) {
                 // Load markdown file
                 let md_txt = fs.readFileSync(element.path, 'utf8');
 
@@ -120,7 +120,7 @@
                 const text = html2text.convert(html_txt, {
                     wordwrap: null
                 });
-                
+
                 // Do the wordcount and add to status
                 const wordCount = wordsCount(text);
                 stats.totalWordCount += wordCount;

package/hdoc-validate.js

@@ -29,6 +29,19 @@
         exclude_spellcheck = {},
         exclude_h1_count = {};
 
+    const excludeLink = async function (url) {
+        if (exclude_links[url]) return true;
+
+        for (let key in exclude_links) {
+            if (key.endsWith('*')) {
+                key = key.substring(0, key.length - 1);
+                if (url.startsWith(key)) return true;
+            }
+        }
+
+        return false;
+    };
+
     const spellcheckContent = async function (sourceFile, excludes) {
         let spelling_errors = {};
         let words = [];
@@ -168,7 +181,7 @@
                 messages[htmlFile.relativePath].push(`Link is a properly formatted external URL: ${links[i]}`);
 
                 // Skip if it's the auto-generated edit url, as these could be part of a private repo which would return a 404
-                if (links[i] === hdoc.get_github_api_path(hdocbook_config.publicSource, htmlFile.relativePath).edit_path.replace(path.extname(htmlFile.relativePath), '.md')) {
+                if (hdocbook_config.publicSource !== undefined && links[i] === hdoc.get_github_api_path(hdocbook_config.publicSource, htmlFile.relativePath).edit_path.replace(path.extname(htmlFile.relativePath), '.md')) {
                     continue;
                 }
 
@@ -177,9 +190,11 @@
                 }
 
                 // Skip if the link is excluded in the project config
-                if (exclude_links[links[i]]) {
+                if (excludeLink(links[i])) {
+                    messages[htmlFile.relativePath].push(`Skipping link validation for: ${links[i]}`);
                     continue;
                 }
+
                 if (links[i].toLowerCase().includes('docs.hornbill.com') || links[i].toLowerCase().includes('docs-internal.hornbill.com')) {
                     errors[htmlFile.relativePath].push(`Links to Hornbill Docs should rooted and not fully-qualified: ${links[i]}`);
                     continue;
@@ -359,6 +374,20 @@
                 val_prod_error += `\n  - ${prods_supported[i]}`
             }
             meta_errors.push(val_prod_error)
+        }
+
+        if (hdocbook_config.publicSource && hdocbook_config.publicSource !== '') {
+            // Validate publicSource
+            if (hdocbook_config.publicSource.toLowerCase() === '--publicsource--') {
+                meta_errors.push(`Value for publicSource in book metadata is set to its default template value`);
+            } else {
+                // Check URL exists
+                if (!hdocbook_config.publicSource.startsWith('https://github.com') && !hdocbook_config.publicSource.startsWith('https://api.github.com')) {
+                    meta_errors.push(`Value for publicSource in book metadata is not a recognised GitHub URL: ${hdocbook_config.publicSource}`);
+                } else {
+                    // 
+                }
+            }
 
         }
 

package/package.json

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

package/ui/css/images/person-circle-white.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="#ffffff" class="bi bi-person-circle" viewBox="0 0 16 16">
+  <path d="M11 6a3 3 0 1 1-6 0 3 3 0 0 1 6 0z"/>
+  <path fill-rule="evenodd" d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8zm8-7a7 7 0 0 0-5.468 11.37C3.242 11.226 4.805 10 8 10s4.757 1.225 5.468 2.37A7 7 0 0 0 8 1z"/>
+</svg>

package/ui/css/images/person-circle.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-person-circle" viewBox="0 0 16 16">
+  <path d="M11 6a3 3 0 1 1-6 0 3 3 0 0 1 6 0z"/>
+  <path fill-rule="evenodd" d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8zm8-7a7 7 0 0 0-5.468 11.37C3.242 11.226 4.805 10 8 10s4.757 1.225 5.468 2.37A7 7 0 0 0 8 1z"/>
+</svg>

package/ui/css/theme-default/styles/htldoc.layouts.css

@@ -202,13 +202,57 @@
 {
   padding:10px;
   border: 1px solid  var(--htl-c-divider-light);  
+  border-color: var(--htl-c-divider-light)!important;
   border-top-width: 0px;
 }
 
+.lh-normal
+{
+  line-height:normal;
+}
+.lh-3
+{
+  line-height:3;
+}
+.fs-12
+{
+  font-size:12px;
+}
+/* user profile stuff */
+.dark .userprofile
+{
+  background-color: var(--htl-c-bg);
+  
+}
+
+.dark .userprofile .dropdown-menu
+{
+  background-color: var(--htl-c-bg);
+  border-color: var(--htl-c-divider-light)!important;
+}
+
+.userprofile .dropdown-menu
+{
+  min-width:max-content;
+  color:inherit;
+}
+
+.userprofile .dropdown-toggle::after
+{
+  display:none;
+}
+.userprofile .svg-prof
+{
+  border-radius: 50%;
+}
+.dark .userprofile .svg-prof
+{
+  /*filter: invert(2);*/
+  
+}
 
 /* theme switcher */
 .theme-switch {
-  margin-top:60%;
   position:relative;
   display: inline-block;
   width: 30px;

package/ui/index.html

@@ -13,7 +13,9 @@
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="description" content="Internal documentation for the Hornbill ESP Platform">
 
-    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.9.1/font/bootstrap-icons.css">
+    
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.5/font/bootstrap-icons.css">
+
     <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
     <script src="https://code.jquery.com/jquery-3.6.1.min.js" integrity="sha256-o88AwQnZB+VDvE9tvIXrMQaPlFFSUTR+nldQm1LuPXQ=" crossorigin="anonymous"></script>
     <script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.9.2/dist/umd/popper.min.js" integrity="sha384-IQsoLXl5PILFhosVNubq5LC7Qb9DXgDA9i+tQ8Zj3iwWAwPtgFTxbJ8NT4GN1R8p" crossorigin="anonymous"></script>
@@ -146,13 +148,43 @@
                     -->
                 </div>
                 <div class="toolbar-right hb-center-v">
-                    <!-- theme switch -->
-                    <label class="theme-switch" >
-                        <input class="theme-switch-checkbox" type="checkbox" v-on:change="switchViewTheme()">
-                        <span class="slider round">
+                    
+                        <!-- theme switch -->
+                        <label class="theme-switch" >
+                            <input class="theme-switch-checkbox" type="checkbox" v-on:change="switchViewTheme()">
+                            <span class="slider round">
+                            </span>
+                        </label>
+                </div>
+                <div v-if="docApp.userSession" class="toolbar-right hb-center-v">
+                    <!-- user info -->
+                    <div class="userprofile dropdown">
+                        <span class="dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                            <img class="svg-prof" v-bind:src="docApp.userSession.profileImage"  style="width:32;height:32;"></img>
                         </span>
-                    </label>
+                        <ul class="dropdown-menu p-0">
+
+                            
 
+                            <div class="panel-header border-0 position-relative">
+                                <div class="position-relative">
+                                    <div class="text-center fw-bolder lh-3">{{docApp.userSession.userId}}</div>    
+                                    <div style="height:20px"></div>    
+                                </div>
+                                <div class="position-absolute top-100 start-50 translate-middle">
+                                    <img class="svg-prof" v-bind:src="docApp.userSession.profileImage"  style="width:64px;height:64px;"></img>
+                                </div>
+                            </div>
+                            <div class="panel-content border-0 border-top p-3 pt-5 fw-light lh-normal">
+                                <div class="text-center fw-bolder p-1">{{docApp.userSession.userName}}</div>
+                                <div class="text-center fw-bolder p-1 fs-12">{{docApp.userSession.email}}</div>
+                            </div>                                
+                            <div class="panel-content p-3 border-0 border-top fw-light lh-normal">
+                                <div class="lh-normal fs-12"><i class="bi bi-database-lock"></i> <span style="display:inline-block;width:48px">Issuer</span> : {{docApp.userSession.issuerInstance}}</div>
+                                <div class="lh-normal fs-12" v-bind:title="docApp.userSession.expiresDateTime"><i class="bi bi-hourglass-split"></i> <span style="display:inline-block;width:48px">Expires</span> : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}</div>
+                            </div>
+                        </ul>
+                    </div>					
                 </div>
         </div>
 

package/ui/js/doc.hornbill.js

@@ -8,6 +8,11 @@ var jqLeftNav = null;
 var global = {stateParams:{},lastLayoutClass:""};    
 
 var docAppMethods = {
+    setSessionInfo:function(info)
+    {
+        let self = this;
+        self.docApp.userSession = info;
+    },
     switchViewTheme:function()
     {
         if(ThemePreference)document.documentElement.classList.remove(ThemePreference);
@@ -151,12 +156,12 @@ function highlightNavigationLinkFromUrl(matchLinkHref)
         }
         catch(e)
         {
-            //console.log("BAD navigation menu item found",el);
+            //hslDocLog.log("BAD navigation menu item found",el);
         }
 
         if(checkUrl)
         {
-            //console.log(checkUrl.pathname,matchLinkHref)
+            //hslDocLog.log(checkUrl.pathname,matchLinkHref)
             let testCurrPath = removeStartingSlash(checkUrl.pathname);
             if(testCurrPath===matchLinkHref)
             {
@@ -200,7 +205,7 @@ function getAnchorFromHash(strHash,strHasClass)
     }
     catch(e)
     {
-        console.log("Get document anchor element by hash failed ["+strHash+"]",e);
+        hslDocLog.log("Get document anchor element by hash failed ["+strHash+"]",e);
         return null;
     }
 
@@ -356,7 +361,7 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
         }
         else
         {
-            console.log("code highlighting js could not be loaded. code block highlighting will not be enabled");
+            hslDocLog.log("code highlighting js could not be loaded. code block highlighting will not be enabled");
         }
         
         //-- show copy button by any code blocks
@@ -578,7 +583,7 @@ $(".document-body").attr("v-pre","");
 
 var view = new Vue({
     el: '#vDocDevApp',
-    data: {updateCounter:0,bookId:"", docApp:{keepTocLayout:false,book:{},navSections:[],tableOfContents:[],bookBreadCrumb:[]}},
+    data: {userSession:{},updateCounter:0,bookId:"", docApp:{keepTocLayout:false,book:{},navSections:[],tableOfContents:[],bookBreadCrumb:[]}},
     methods:docAppMethods,
     directives: {
        somedirectivename: {
@@ -607,6 +612,24 @@ Vue.component('nav-section-component', {
  });
 
 
+ var hslDocLog={
+    _entry:[],
+    log:function(strMessage,varData)
+    {
+        if(varData!==undefined) console.log(strMessage,varData)
+        else  console.log(strMessage);
+
+        this._entry.push({msg:strMessage,data:varData})
+    },
+    dump:function()
+    {
+        for(let x=0;x<this._entry.length;x++)
+        {
+            console.log(this._entry[x].msg,this._entry[x].data || null);
+        }
+    }
+}
+
 async function intialiseApp() {
 
     // set theme switch
@@ -617,6 +640,33 @@ 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
@@ -652,7 +702,7 @@ async function intialiseApp() {
                 }
                 else
                 {
-                    console.log("initial first view link to laod is not present");
+                    hslDocLog.log("initial first view link to laod is not present");
                 }
 
                 $(".hb-hidden").removeClass("hb-hidden");