hdoc-tools 0.30.0 → 0.32.0

package/custom_modules/tips.js

@@ -26,6 +26,11 @@
 						class: "bi bi-megaphone",
 						title: "Important",
 					};
+				case "info":
+					return {
+						class: "bi bi-info-circle",
+						title: "Information",
+					};
 				case "caution":
 					return {
 						class: "bi bi-x-circle",
@@ -77,6 +82,7 @@
 			setupContainer("note");
 			setupContainer("tip");
 			setupContainer("important");
+			setupContainer("info");
 			setupContainer("caution");
 			setupContainer("warning");
 

package/hdoc-build.js

@@ -60,6 +60,7 @@
 	let conversion_failed = 0;
 	let doc_header_template = "";
 	let doc_header_template_non_git = "";
+	let github_repo_details = {};
 	let global_source_path = "";
 	let pdf_created = 0;
 	let pdf_enable = false;
@@ -306,7 +307,8 @@
 					hdocbook_config.publicSource,
 					file_path.relativePath,
 				);
-				const contributors = hdoc.get_github_contributors(
+				
+				const contributors = await hdoc.get_github_contributors(
 					github_paths.api_path,
 					git_token,
 				);
@@ -1184,6 +1186,18 @@
 			prods_supported = prods.prods_supported;
 		}
 
+		const clean_repo = hdocbook_config.publicSource.endsWith("/") ? hdocbook_config.publicSource.slice(0, -1) : hdocbook_config.publicSource;
+		const api_path = clean_repo.replace(
+			"https://github.com/",
+			"https://api.github.com/repos/",
+		);
+
+		// Get github repo details
+		github_repo_details = await hdoc.get_github_repo_details( api_path, git_token ); 
+		if (github_repo_details.success) {
+			console.warn(`Unable to retrieve GitHub Repository details: ${github_repo_details.error}`);
+		}
+		
 		if (!validate) {
 			console.log("Caching CSS for PDF generation...");
 			const css_files = [
@@ -1394,6 +1408,7 @@
 			gen_exclude,
 			redirects,
 			draft_links,
+			github_repo_details.data.private,
 		);
 		if (!validation_success) {
 			const end_time = Date.now();

package/hdoc-module.js

@@ -434,6 +434,60 @@
 		return github_paths;
 	};
 
+	exports.get_github_repo_details = async (
+		github_url,
+		github_api_token,
+	) => {
+		const response = {
+			success: false,
+			error: "",
+			data: {},
+			private: false
+		};
+		const request_options = {
+			headers: {
+				"User-Agent": "HornbillDocsBuild",
+				"Cache-Control": "no-cache",
+				Host: "api.github.com",
+				Accept: "application/json",
+			},
+			timeout: 5000,
+		};
+		if (github_api_token !== "") {
+			request_options.headers.authorization = `Bearer ${github_api_token}`;
+		}
+
+		let github_response;
+		try {
+			github_response = await axios.get(github_url, request_options);
+			if (retried) {
+				retried = false;
+				console.log("API call retry success!");
+			}
+		} catch (err) {
+			if (err.response) {
+				if (err.response.status !== 403 && err.response.status !== 401) {
+					response.error = err;
+					return response;
+				}
+				github_response = err.response;
+			} else {
+				response.error = `Unexpected response from GitHub for [${github_url}:\n${JSON.stringify(
+					err,
+				)}]`;
+			}
+		}
+		if (github_response.status === 200) {
+			response.success = true;
+			response.data = github_response.data;
+			response.private = github_response.data.private;
+		} else {
+			// Is it a 404 or 403?
+			response.error = `${github_response.status} : ${data.message}`;
+		}
+		return response;
+	};
+
 	exports.get_github_contributors = async (
 		github_url,
 		github_api_token,

package/hdoc-validate.js

@@ -28,6 +28,7 @@ const e = require("express");
 	const md_to_validate = [];
 	const exclude_links = {};
 	const exclude_spellcheck = {};
+	let private_repo = false;
 	let redirects = {};
 	const exclude_h1_count = {};
 	const exclude_spellcheck_output = [];
@@ -545,6 +546,17 @@ const e = require("express");
 					continue;
 				}
 
+				if ( 
+					links[i].toLowerCase().includes("docs-internal.hornbill.com") &&
+					markdown_paths.relativePath.includes('/_inline/') &&
+					!private_repo
+				) {
+					// Is the parent book in a public repo? If so, flag this as an error.
+					const error_message = processErrorMessage(`Hornbill docs-internal links should not be used in public book inline content: ${links[i]}`, markdown_paths.relativePath, markdown_content, links[i]);
+					errors[htmlFile.relativePath].push( error_message );
+					continue;
+				}
+
 				try {
 					await axios({
 						url: links[i],
@@ -810,9 +822,11 @@ const e = require("express");
 		gen_exclude,
 		gen_redirects,
 		draft_links,
+		is_private,
 	) => {
 		console.log("Performing Validation and Building SEO Link List...");
 		redirects = gen_redirects;
+		private_repo = is_private;
 
 		// Get a list of HTML files in source_path
 		dree.scan(source_path, dreeOptions, fileContentCallback);

package/package.json

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

package/templates/pdf/css/hdocs-pdf.css

@@ -212,13 +212,22 @@ video {
 }
 
 .hdoc-alert.alert-icon-important {
+  border-color: var(--htl-custom-block-important-border);
+  color: var(--htl-custom-block-important-text);
+  background-color: var(--htl-custom-block-important-bg);
+}
+
+.hdoc-alert.alert-icon-important code {
+  background-color: var(--htl-custom-block-important-code-bg);
+}
+
+.hdoc-alert.alert-icon-info {
   border-color: var(--htl-custom-block-info-border);
   color: var(--htl-custom-block-info-text);
   background-color: var(--htl-custom-block-info-bg);
-
 }
 
-.hdoc-alert.alert-icon-important code {
+.hdoc-alert.alert-icon-info code {
   background-color: var(--htl-custom-block-info-code-bg);
 }
 

package/templates/pdf/css/vars.css

@@ -310,14 +310,18 @@
  * Component: Custom Block
  * -------------------------------------------------------------------------- */
 
-:root {
+ :root {
   --htl-custom-block-code-font-size: var(--htl-default-font-size);
 
-  --htl-custom-block-info-border: rgba(23, 23, 23, 0.5);
-  --htl-custom-block-info-text: #171717;
-  --htl-custom-block-info-bg: #d7eaf8;
-  --htl-custom-block-info-code-bg: var(--htl-c-gray-light-4);
+  --htl-custom-block-important-border: var(--htl-c-indigo-dark);
+  --htl-custom-block-important-text: var(--htl-c-indigo-dark);
+  --htl-custom-block-important-bg: var(--htl-c-indigo-lighter);
+  --htl-custom-block-important-code-bg: var(--htl-custom-block-important-bg);
 
+  --htl-custom-block-info-border: var(--htl-c-blue-dimm-1);
+  --htl-custom-block-info-text: var(--htl-c-blue-darker);
+  --htl-custom-block-info-bg: var(--htl-c-blue-dimm-3);
+  --htl-custom-block-info-code-bg: var(--htl-custom-block-info-bg);
 
   --htl-custom-block-tip-border: var(--htl-c-green-dimm-1);
   --htl-custom-block-tip-text: var(--htl-c-green-darker);
@@ -346,6 +350,13 @@
   --htl-custom-block-details-bg: var(--htl-c-black-mute);
   --htl-custom-block-details-code-bg: var(--htl-c-gray-dark-4);
 
+  --htl-custom-block-important-border: var(--htl-c-indigo-lighter);
+  --htl-custom-block-important-bg: var(--htl-c-indigo-dark);
+  --htl-custom-block-important-text: var(--htl-c-indigo-lighter);
+
+  --htl-custom-block-info-text: var(--htl-c-blue);
+  --htl-custom-block-info-bg: var(--htl-c-blue-dimm-3);
+
   --htl-custom-block-tip-border: var(--htl-c-green-dimm-2);
   --htl-custom-block-tip-text: var(--htl-c-green-light);
 

package/ui/css/theme-default/styles/components/htl-doc.css

@@ -796,13 +796,22 @@
 }
 
 .HTL-doc .hdoc-alert.alert-icon-important {
+  border-color: var(--htl-custom-block-important-border);
+  color: var(--htl-custom-block-important-text);
+  background-color: var(--htl-custom-block-important-bg);
+}
+
+.HTL-doc .hdoc-alert.alert-icon-important code {
+  background-color: var(--htl-custom-block-important-code-bg);
+}
+
+.HTL-doc .hdoc-alert.alert-icon-info {
   border-color: var(--htl-custom-block-info-border);
   color: var(--htl-custom-block-info-text);
   background-color: var(--htl-custom-block-info-bg);
-
 }
 
-.HTL-doc .hdoc-alert.alert-icon-important code {
+.HTL-doc .hdoc-alert.alert-icon-info code {
   background-color: var(--htl-custom-block-info-code-bg);
 }
 

package/ui/css/theme-default/styles/vars.css

@@ -313,10 +313,15 @@
 :root {
   --htl-custom-block-code-font-size: var(--htl-default-font-size);
 
-  --htl-custom-block-info-border: rgba(23, 23, 23, 0.5);
-  --htl-custom-block-info-text: #171717;
-  --htl-custom-block-info-bg: #d7eaf8;
-  --htl-custom-block-info-code-bg: var(--htl-c-gray-light-4);
+  --htl-custom-block-important-border: var(--htl-c-indigo-dark);
+  --htl-custom-block-important-text: var(--htl-c-indigo-dark);
+  --htl-custom-block-important-bg: var(--htl-c-indigo-lighter);
+  --htl-custom-block-important-code-bg: var(--htl-custom-block-important-bg);
+
+  --htl-custom-block-info-border: var(--htl-c-blue-dimm-1);
+  --htl-custom-block-info-text: var(--htl-c-blue-darker);
+  --htl-custom-block-info-bg: var(--htl-c-blue-dimm-3);
+  --htl-custom-block-info-code-bg: var(--htl-custom-block-info-bg);
 
   --htl-custom-block-tip-border: var(--htl-c-green-dimm-1);
   --htl-custom-block-tip-text: var(--htl-c-green-darker);
@@ -345,6 +350,13 @@
   --htl-custom-block-details-bg: var(--htl-c-black-mute);
   --htl-custom-block-details-code-bg: var(--htl-c-gray-dark-4);
 
+  --htl-custom-block-important-border: var(--htl-c-indigo-lighter);
+  --htl-custom-block-important-bg: var(--htl-c-indigo-dark);
+  --htl-custom-block-important-text: var(--htl-c-indigo-lighter);
+
+  --htl-custom-block-info-text: var(--htl-c-blue);
+  --htl-custom-block-info-bg: var(--htl-c-blue-dimm-3);
+
   --htl-custom-block-tip-border: var(--htl-c-green-dimm-2);
   --htl-custom-block-tip-text: var(--htl-c-green-light);