Fdawgs · Fdawgs · Sep 3, 2023 · Sep 3, 2023 · Sep 3, 2023 · Sep 3, 2023
diff --git a/package.json b/package.json
@@ -64,13 +64,12 @@
 			"SUPPRESS_SUPPORT": 1
 		},
 		"ignore": [
-			"src/temp",
-			"test_resources"
+			"src/temp"
 		],
 		"verbose": true,
 		"watch": [
 			".env",
-			"src"
+			"src/**/!(*.test).*"
 		]
 	},
 	"devDependencies": {

diff --git a/scripts/license-checker.js b/scripts/license-checker.js
@@ -5,6 +5,8 @@
 
 const { promisify } = require("node:util");
 const { init } = require("license-checker");
+/** @type {string[]} */
+// @ts-ignore: module is a JSON file
 const copyLeftLicenses = require("spdx-copyleft");
 const path = require("upath");
 
@@ -20,7 +22,7 @@ async function checkLicenses() {
 
 	/**
 	 * List of deprecated copyleft license identifiers
-	 * @see https://spdx.org/licenses/
+	 * @see {@link https://spdx.org/licenses/ | SPDX License List}
 	 */
 	const deprecatedLicenseList = [
 		"AGPL-1.0",

diff --git a/src/config/index.js b/src/config/index.js
@@ -153,8 +153,8 @@ async function getConfig() {
 			// The maximum payload, in bytes, the server is allowed to accept
 			bodyLimit: env.REQ_BODY_MAX_BYTES || 10485760,
 			/**
-			 * See https://fastify.io/docs/latest/Reference/Logging/
-			 * and https://getpino.io/#/docs/api for logger options
+			 * @see {@link https://fastify.io/docs/latest/Reference/Logging | Fastify logging}
+			 * @see {@link https://getpino.io/#/docs/api | Pino API}
 			 */
 			logger: {
 				formatters: {
@@ -330,23 +330,6 @@ async function getConfig() {
 				],
 			},
 		},
-		htmltidy: {
-			/**
-			 * Refer to http://api.html-tidy.org/tidy/tidylib_api_5.6.0/tidy_quickref.html for tidy options
-			 *
-			 * The following options have been turned on:
-			 * - bare (remove Microsoft specific HTML and replace `&nbsp;` with spaces)
-			 * - clean (replace legacy HTML tags)
-			 * - dropProprietaryAttributes (remove proprietary attributes, such as Microsoft data binding attributes)
-			 * - escapeCdata (convert <![CDATA[]]> sections to normal text)
-			 * - sortAttributes (sort attributes in element in ascending alphabetic sort)
-			 */
-			bare: true,
-			clean: true,
-			dropProprietaryAttributes: true,
-			escapeCdata: true,
-			sortAttributes: "alpha",
-		},
 		poppler: {
 			binPath: env.POPPLER_BINARY_PATH
 				? path.normalizeSafe(env.POPPLER_BINARY_PATH)
@@ -415,7 +398,9 @@ async function getConfig() {
 	if (env.LOG_ROTATION_FILENAME) {
 		const logFile = path.normalizeTrim(env.LOG_ROTATION_FILENAME);
 
-		// Rotation options: https://github.com/rogerc/file-stream-rotator/#options
+		/**
+		 * @see {@link https://github.com/rogerc/file-stream-rotator/#options | File stream rotator options}
+		 */
 		config.fastifyInit.logger.stream = getStream({
 			audit_file: path.joinSafe(path.dirname(logFile), ".audit.json"),
 			date_format: env.LOG_ROTATION_DATE_FORMAT || "YYYY-MM-DD",

diff --git a/src/plugins/docx-to-html/index.js b/src/plugins/docx-to-html/index.js
@@ -29,10 +29,12 @@ async function plugin(server) {
 			const { value } = await convertToHtml(req.body);
 
 			/**
-			 * Mammoth does not wrap the results inside <html> and <body> tags itself.
+			 * Mammoth does not wrap the results inside <html> and <body> tags itself, so
+			 * do that here.
+			 *
 			 * `fixUtf8` function replaces most common incorrectly converted
 			 * Windows-1252 to UTF-8 results with HTML equivalents.
-			 * Refer to https://i18nqa.com/debug/utf8-debug.html for more info
+			 * @see {@link https://i18nqa.com/debug/utf8-debug.html | UTF-8 Encoding Debugging Chart}
 			 */
 			req.conversionResults.body = new JSDOM(
 				`<!DOCTYPE html>

diff --git a/src/plugins/pdf-to-html/index.js b/src/plugins/pdf-to-html/index.js
@@ -170,7 +170,7 @@ async function plugin(server, options) {
 		/**
 		 * `fixUtf8` function replaces most common incorrectly converted
 		 * Windows-1252 to UTF-8 results with HTML equivalents.
-		 * Refer to https://i18nqa.com/debug/utf8-debug.html for more info
+		 * @see {@link https://i18nqa.com/debug/utf8-debug.html | UTF-8 Encoding Debugging Chart}
 		 */
 		req.conversionResults.body = fixUtf8(dom.serialize());
 		res.type(

diff --git a/src/plugins/pdf-to-txt/index.js b/src/plugins/pdf-to-txt/index.js
@@ -230,7 +230,7 @@ async function plugin(server, options) {
 				/**
 				 * `fixUtf8` function replaces most common incorrectly converted
 				 * Windows-1252 to UTF-8 results with HTML equivalents.
-				 * Refer to https://i18nqa.com/debug/utf8-debug.html for more info
+				 * @see {@link https://i18nqa.com/debug/utf8-debug.html | UTF-8 Encoding Debugging Chart}
 				 */
 				req.conversionResults.body = fixUtf8(dom.serialize());
 			}

diff --git a/src/plugins/rtf-to-html/index.js b/src/plugins/rtf-to-html/index.js
@@ -158,7 +158,7 @@ async function plugin(server, options) {
 			/**
 			 * `fixUtf8` function replaces most common incorrectly converted
 			 * Windows-1252 to UTF-8 results with HTML equivalents.
-			 * Refer to https://i18nqa.com/debug/utf8-debug.html for more info
+			 * @see {@link https://i18nqa.com/debug/utf8-debug.html | UTF-8 Encoding Debugging Chart}
 			 */
 			req.conversionResults.body = fixUtf8(dom.serialize());
 		} catch (err) {

diff --git a/src/plugins/shared-schemas/index.js b/src/plugins/shared-schemas/index.js
@@ -12,7 +12,7 @@ async function plugin(server) {
 	/**
 	 * NOTE: `.definition()` definitions have been replaced with `.prop()` properties, and
 	 * `.id()` ids removed due to definitions breaking in v4.12.1 of fastify-swagger.
-	 * See https://github.com/fastify/fastify-swagger/issues/524
+	 * @see {@link https://github.com/fastify/fastify-swagger/issues/524 | fastify-swagger Issue #524}
 	 */
 
 	// Response schemas

diff --git a/src/plugins/tidy-css/index.js b/src/plugins/tidy-css/index.js
@@ -63,7 +63,7 @@ async function plugin(server) {
 			/**
 			 * Font family names containing any non-alphabetical characters
 			 * other than hyphens should be quoted.
-			 * See https://w3.org/TR/css-fonts-4/#family-name-syntax
+			 * @see {@link https://w3.org/TR/css-fonts-4/#family-name-syntax | Syntax of <family-name>}
 			 */
 			if (styleRule.style["font-family"]) {
 				const fonts = styleRule.style["font-family"].split(",");

diff --git a/src/plugins/tidy-html/index.js b/src/plugins/tidy-html/index.js
@@ -18,13 +18,12 @@ const tidyP = promisify(tidy);
  */
 async function plugin(server) {
 	/**
-	 * Refer to https://api.html-tidy.org/tidy/tidylib_api_5.8.0/tidy_quickref.html for tidy options
-	 *
 	 * The following options have been turned on:
-	 * - bare (replace smart quotes and em dashes with ASCII and replace `&nbsp;` with spaces)
+	 * - bare (remove Microsoft specific HTML and replace `&nbsp;` with spaces)
 	 * - clean (replace legacy HTML tags)
 	 * - dropProprietaryAttributes (remove proprietary attributes, such as Microsoft data binding attributes)
 	 * - escapeCdata (convert <![CDATA[]]> sections to normal text)
+	 * @see {@link https://api.html-tidy.org/tidy/tidylib_api_5.8.0/tidy_quickref.html | HTMLTidy2 options}
 	 */
 	const htmlTidyConfig = {
 		bare: true,
@@ -33,7 +32,9 @@ async function plugin(server) {
 		escapeCdata: true,
 	};
 
-	// Refer to https://github.com/terser/html-minifier-terser#options-quick-reference for options
+	/**
+	 * @see {@link https://github.com/terser/html-minifier-terser#options-quick-reference | HTMLMinifier options}
+	 */
 	const htmlMinifyConfig = {
 		collapseWhitespace: true,
 		decodeEntities: true,

diff --git a/src/routes/admin/healthcheck/schema.js b/src/routes/admin/healthcheck/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["System administration"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const healthcheckGetSchema = {
 	tags,

diff --git a/src/routes/doc/txt/schema.js b/src/routes/doc/txt/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["DOC", "DOT"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
  * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docToTxtPostSchema = {
 	tags,

diff --git a/src/routes/docs/index.html b/src/routes/docs/index.html
@@ -21,7 +21,10 @@
 	</head>
 	<body>
 		<script>
-			// Redoc no longer supports IE, see https://github.com/Redocly/redoc/issues/1936
+			/**
+			 * @description Detect IE and display message if detected.
+			 * @see {@link https://github.com/Redocly/redoc/issues/1936 | Redoc Issue #1936}
+			 */
 			if (window.document.documentMode) {
 				var p = document.createElement("p");
 				p.innerHTML =

diff --git a/src/routes/docs/openapi/schema.js b/src/routes/docs/openapi/schema.js
@@ -3,11 +3,10 @@
 const S = require("fluent-json-schema").default;
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docsOpenapiGetSchema = {
 	hide: true,

diff --git a/src/routes/docs/route.test.js.snap b/src/routes/docs/route.test.js.snap
@@ -24,7 +24,10 @@ exports[`Docs route GET requests Returns HTML 1`] = `
 	</head>
 	<body>
 		<script>
-			// Redoc no longer supports IE, see https://github.com/Redocly/redoc/issues/1936
+			/**
+			 * @description Detect IE and display message if detected.
+			 * @see {@link https://github.com/Redocly/redoc/issues/1936 | Redoc Issue #1936}
+			 */
 			if (window.document.documentMode) {
 				var p = document.createElement("p");
 				p.innerHTML =

diff --git a/src/routes/docs/schema.js b/src/routes/docs/schema.js
@@ -3,11 +3,10 @@
 const S = require("fluent-json-schema").default;
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docsGetSchema = {
 	hide: true,

diff --git a/src/routes/docx/html/schema.js b/src/routes/docx/html/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["DOCM", "DOCX", "DOTM", "DOTX"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docxToHtmlPostSchema = {
 	tags,

diff --git a/src/routes/docx/txt/schema.js b/src/routes/docx/txt/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["DOCM", "DOCX", "DOTM", "DOTX"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
  * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docxToTxtPostSchema = {
 	tags,

diff --git a/src/routes/html/txt/schema.js b/src/routes/html/txt/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["HTML"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
  * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const htmlToTxtPostSchema = {
 	tags,

diff --git a/src/routes/pdf/html/schema.js b/src/routes/pdf/html/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["PDF"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const pdfToHtmlPostSchema = {
 	tags,

diff --git a/src/routes/pdf/txt/schema.js b/src/routes/pdf/txt/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["PDF"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const pdfToTxtPostSchema = {
 	tags,

diff --git a/src/routes/rtf/html/schema.js b/src/routes/rtf/html/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["RTF"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const rtfToHtmlPostSchema = {
 	tags,

diff --git a/src/routes/rtf/txt/schema.js b/src/routes/rtf/txt/schema.js
@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["RTF"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const rtfToTxtPostSchema = {
 	tags,

diff --git a/src/server.js b/src/server.js
@@ -53,7 +53,10 @@ async function plugin(server, config) {
 		// Opt-out of Google's Topics advertising-surveillance API
 		.register(flocOff)
 
-		// Use Helmet to set response security headers: https://helmetjs.github.io/
+		/**
+		 * Use Helmet to set response security headers.
+		 * @see {@link https://helmetjs.github.io | Helmet}
+		 */
 		.register(helmet, config.helmet)
 
 		// Utility functions and error handlers
@@ -116,7 +119,7 @@ async function plugin(server, config) {
 		/**
 		 * Encapsulate plugins and routes into a secured child context, so that admin and
 		 * docs routes do not inherit the bearer token auth plugin.
-		 * See https://fastify.io/docs/latest/Reference/Encapsulation/ for more info
+		 * @see {@link https://fastify.io/docs/latest/Reference/Encapsulation | Fastify Encapsulation}
 		 */
 		.register(async (securedContext) => {
 			if (config.bearerTokenAuthKeys) {

diff --git a/src/server.test.js b/src/server.test.js
@@ -1086,8 +1086,8 @@ describe("Server deployment", () => {
 						"Docsmith | Documentation"
 					);
 					/**
-					 * Checks redoc has not rendered an error component:
-					 * https://github.com/Redocly/redoc/blob/main/src/components/ErrorBoundary.tsx
+					 * Checks redoc has not rendered an error component.
+					 * @see {@link https://github.com/Redocly/redoc/blob/main/src/components/ErrorBoundary.tsx | Redoc ErrorBoundary component}
 					 */
 					const heading = page.locator("h1 >> nth=0");
 					await heading.waitFor();

diff --git a/src/server.test.js.snap b/src/server.test.js.snap
@@ -24,7 +24,10 @@ exports[`Server deployment API documentation Content /docs route Returns HTML 1`
 	</head>
 	<body>
 		<script>
-			// Redoc no longer supports IE, see https://github.com/Redocly/redoc/issues/1936
+			/**
+			 * @description Detect IE and display message if detected.
+			 * @see {@link https://github.com/Redocly/redoc/issues/1936 | Redoc Issue #1936}
+			 */
 			if (window.document.documentMode) {
 				var p = document.createElement("p");
 				p.innerHTML =