hdoc-tools 0.61.0 → 0.62.0

package/hdoc-validate-config.js

@@ -1,355 +1,355 @@
-(() => {
-	const path = require("node:path");
-	const regex_doc_id = /^[a-z][a-z0-9-]+$/;
-	const regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/;
-
-	const hdocbook_schema = require(path.join(__dirname, "schemas", "hdocbook.schema.json"));
-	const valid_audience = hdocbook_schema.properties.audience.items.enum;
-	const valid_product_families = hdocbook_schema.properties.productFamily.enum;
-	const valid_book_types = hdocbook_schema.properties.bookType.enum;
-
-	const project_schema = require(path.join(__dirname, "schemas", "hdocbook-project.schema.json"));
-	const project_top_keys = Object.keys(project_schema.properties);
-	const project_pdf_keys = Object.keys(project_schema.properties.pdfGeneration.properties);
-	const project_validation_keys = Object.keys(project_schema.properties.validation.properties);
-	const project_redirect_keys = Object.keys(project_schema.properties.redirects.items.properties);
-	const project_ai_keys = Object.keys(project_schema.properties.ai.properties);
-	const redirect_valid_codes = project_schema.properties.redirects.items.properties.code.enum;
-
-	// Reports any keys in obj that are not in the allowed set.
-	const check_extra_keys = (obj, allowed, path, file, errors) => {
-		for (const key of Object.keys(obj)) {
-			if (!allowed.includes(key)) {
-				errors.push(`${file}: "${path ? path + '.' : ''}${key}" is not a recognised property`);
-			}
-		}
-	};
-
-	const validate_nav_item = (item, path, errors, depth) => {
-		if (typeof item !== 'object' || Array.isArray(item) || item === null) {
-			errors.push(`hdocbook.json: "${path}" must be an object`);
-			return;
-		}
-		check_extra_keys(item, ['text', 'link', 'expand', 'draft', 'items', 'id'], path, 'hdocbook.json', errors);
-		if (!item.text || typeof item.text !== 'string') {
-			errors.push(`hdocbook.json: "${path}.text" is required and must be a non-empty string`);
-		}
-		if (item.id !== undefined && typeof item.id !== 'string') {
-			errors.push(`hdocbook.json: "${path}.id" must be a string`);
-		}
-		if (item.link !== undefined && typeof item.link !== 'string') {
-			errors.push(`hdocbook.json: "${path}.link" must be a string`);
-		}
-		if (item.expand !== undefined && typeof item.expand !== 'boolean') {
-			errors.push(`hdocbook.json: "${path}.expand" must be a boolean`);
-		}
-		if (item.draft !== undefined && typeof item.draft !== 'boolean') {
-			errors.push(`hdocbook.json: "${path}.draft" must be a boolean`);
-		}
-		if (item.items !== undefined) {
-			if (!Array.isArray(item.items)) {
-				errors.push(`hdocbook.json: "${path}.items" must be an array`);
-			} else if (depth >= 5) {
-				errors.push(`hdocbook.json: "${path}.items" exceeds the maximum navigation nesting depth of 5 levels`);
-			} else {
-				for (let i = 0; i < item.items.length; i++) {
-					validate_nav_item(item.items[i], `${path}.items[${i}]`, errors, depth + 1);
-				}
-			}
-		}
-	};
-
-	// Validates the structure of hdocbook-project.json
-	const validate_project = (config) => {
-		const errors = [];
-		const file = 'hdocbook-project.json';
-
-		check_extra_keys(config, project_top_keys, '', file, errors);
-
-		if (!config.docId || typeof config.docId !== 'string') {
-			errors.push(`${file}: "docId" is required and must be a string`);
-		} else if (!regex_doc_id.test(config.docId)) {
-			errors.push(`${file}: "docId" must use kebab-case (lowercase letters, numbers, hyphens): "${config.docId}"`);
-		}
-
-		if (config.pdfGeneration !== undefined) {
-			if (typeof config.pdfGeneration !== 'object' || Array.isArray(config.pdfGeneration)) {
-				errors.push(`${file}: "pdfGeneration" must be an object`);
-			} else {
-				check_extra_keys(config.pdfGeneration, project_pdf_keys, 'pdfGeneration', file, errors);
-				if (config.pdfGeneration.enable === undefined) {
-					errors.push(`${file}: "pdfGeneration.enable" is required`);
-				} else if (typeof config.pdfGeneration.enable !== 'boolean') {
-					errors.push(`${file}: "pdfGeneration.enable" must be a boolean`);
-				}
-				if (config.pdfGeneration.exclude_paths !== undefined) {
-					if (!Array.isArray(config.pdfGeneration.exclude_paths)) {
-						errors.push(`${file}: "pdfGeneration.exclude_paths" must be an array`);
-					} else {
-						for (let i = 0; i < config.pdfGeneration.exclude_paths.length; i++) {
-							if (typeof config.pdfGeneration.exclude_paths[i] !== 'string') {
-								errors.push(`${file}: "pdfGeneration.exclude_paths[${i}]" must be a string`);
-							}
-						}
-					}
-				}
-			}
-		}
-
-		if (config.validation !== undefined) {
-			if (typeof config.validation !== 'object' || Array.isArray(config.validation)) {
-				errors.push(`${file}: "validation" must be an object`);
-			} else {
-				check_extra_keys(config.validation, project_validation_keys, 'validation', file, errors);
-				if (config.validation.exclude_links !== undefined) {
-					if (!Array.isArray(config.validation.exclude_links)) {
-						errors.push(`${file}: "validation.exclude_links" must be an array`);
-					} else {
-						for (let i = 0; i < config.validation.exclude_links.length; i++) {
-							if (typeof config.validation.exclude_links[i] !== 'string') {
-								errors.push(`${file}: "validation.exclude_links[${i}]" must be a string`);
-							}
-						}
-					}
-				}
-				if (config.validation.exclude_spellcheck !== undefined) {
-					if (!Array.isArray(config.validation.exclude_spellcheck)) {
-						errors.push(`${file}: "validation.exclude_spellcheck" must be an array`);
-					} else {
-						for (let i = 0; i < config.validation.exclude_spellcheck.length; i++) {
-							const item = config.validation.exclude_spellcheck[i];
-							if (typeof item !== 'object' || Array.isArray(item) || item === null) {
-								errors.push(`${file}: "validation.exclude_spellcheck[${i}]" must be an object`);
-							} else {
-								check_extra_keys(item, ['document_path', 'words'], `validation.exclude_spellcheck[${i}]`, file, errors);
-								if (!item.document_path || typeof item.document_path !== 'string') {
-									errors.push(`${file}: "validation.exclude_spellcheck[${i}].document_path" is required and must be a non-empty string`);
-								}
-								if (!Array.isArray(item.words)) {
-									errors.push(`${file}: "validation.exclude_spellcheck[${i}].words" is required and must be an array`);
-								} else {
-									for (let j = 0; j < item.words.length; j++) {
-										if (typeof item.words[j] !== 'string') {
-											errors.push(`${file}: "validation.exclude_spellcheck[${i}].words[${j}]" must be a string`);
-										}
-									}
-								}
-							}
-						}
-					}
-				}
-				if (config.validation.exclude_h1_count !== undefined) {
-					if (!Array.isArray(config.validation.exclude_h1_count)) {
-						errors.push(`${file}: "validation.exclude_h1_count" must be an array`);
-					} else {
-						for (let i = 0; i < config.validation.exclude_h1_count.length; i++) {
-							if (typeof config.validation.exclude_h1_count[i] !== 'string') {
-								errors.push(`${file}: "validation.exclude_h1_count[${i}]" must be a string`);
-							}
-						}
-					}
-				}
-				if (config.validation.external_link_warnings !== undefined &&
-					typeof config.validation.external_link_warnings !== 'boolean') {
-					errors.push(`${file}: "validation.external_link_warnings" must be a boolean`);
-				}
-				if (config.validation.spellcheckDictionary !== undefined) {
-					if (!Array.isArray(config.validation.spellcheckDictionary)) {
-						errors.push(`${file}: "validation.spellcheckDictionary" must be an array`);
-					} else {
-						for (let i = 0; i < config.validation.spellcheckDictionary.length; i++) {
-							if (typeof config.validation.spellcheckDictionary[i] !== 'string') {
-								errors.push(`${file}: "validation.spellcheckDictionary[${i}]" must be a string`);
-							}
-						}
-					}
-				}
-			}
-		}
-
-		if (config.ai !== undefined) {
-			if (typeof config.ai !== 'object' || Array.isArray(config.ai) || config.ai === null) {
-				errors.push(`${file}: "ai" must be an object`);
-			} else {
-				check_extra_keys(config.ai, project_ai_keys, 'ai', file, errors);
-				if (config.ai.model !== undefined && typeof config.ai.model !== 'string') {
-					errors.push(`${file}: "ai.model" must be a string`);
-				}
-				if (config.ai.maxTokens !== undefined && !Number.isInteger(config.ai.maxTokens)) {
-					errors.push(`${file}: "ai.maxTokens" must be an integer`);
-				}
-			}
-		}
-
-		if (config.redirects !== undefined) {
-			if (!Array.isArray(config.redirects)) {
-				errors.push(`${file}: "redirects" must be an array`);
-			} else {
-				for (let i = 0; i < config.redirects.length; i++) {
-					const r = config.redirects[i];
-					if (typeof r !== 'object' || Array.isArray(r) || r === null) {
-						errors.push(`${file}: "redirects[${i}]" must be an object`);
-					} else {
-						check_extra_keys(r, project_redirect_keys, `redirects[${i}]`, file, errors);
-						if (!r.url || typeof r.url !== 'string') {
-							errors.push(`${file}: "redirects[${i}].url" is required and must be a non-empty string`);
-						}
-						if (r.code === undefined) {
-							errors.push(`${file}: "redirects[${i}].code" is required`);
-						} else if (!redirect_valid_codes.includes(r.code)) {
-							errors.push(`${file}: "redirects[${i}].code" must be ${redirect_valid_codes.join(', ')} (got ${r.code})`);
-						}
-						if (r.location !== undefined && typeof r.location !== 'string') {
-							errors.push(`${file}: "redirects[${i}].location" must be a string`);
-						}
-						if (r.skip_location_validation !== undefined && typeof r.skip_location_validation !== 'boolean') {
-							errors.push(`${file}: "redirects[${i}].skip_location_validation" must be a boolean`);
-						}
-					}
-				}
-			}
-		}
-
-		return errors;
-	};
-
-	// Validates the structure of hdocbook.json
-	const validate_book = (config, expected_doc_id) => {
-		const errors = [];
-		const file = 'hdocbook.json';
-
-		check_extra_keys(config,
-			['docId', 'title', 'description', 'publicSource', 'version', 'productFamily', 'bookType',
-			 'coverImage', 'tags', 'audience', 'languages', 'readingTime', 'navigation', 'inline'],
-			'', file, errors);
-
-		if (!config.docId || typeof config.docId !== 'string') {
-			errors.push(`${file}: "docId" is required and must be a string`);
-		} else {
-			if (!regex_doc_id.test(config.docId)) {
-				errors.push(`${file}: "docId" must use kebab-case (lowercase letters, numbers, hyphens): "${config.docId}"`);
-			}
-			if (expected_doc_id && config.docId !== expected_doc_id) {
-				errors.push(`${file}: "docId" value "${config.docId}" does not match the folder name and the docId in hdocbook-project.json ("${expected_doc_id}")`);
-			}
-		}
-
-		if (!config.title || typeof config.title !== 'string') {
-			errors.push(`${file}: "title" is required and must be a non-empty string`);
-		}
-
-		if (!config.version || typeof config.version !== 'string') {
-			errors.push(`${file}: "version" is required and must be a string`);
-		} else if (!regex_version.test(config.version)) {
-			errors.push(`${file}: "version" must be in X.Y.Z format (got "${config.version}")`);
-		}
-
-		if (!config.productFamily || typeof config.productFamily !== 'string') {
-			errors.push(`${file}: "productFamily" is required and must be a string`);
-		} else if (!valid_product_families.includes(config.productFamily)) {
-			errors.push(`${file}: "productFamily" value "${config.productFamily}" is not recognised. Valid values: ${valid_product_families.join(', ')}`);
-		}
-
-		if (!config.audience || !Array.isArray(config.audience) || config.audience.length === 0) {
-			errors.push(`${file}: "audience" is required and must be a non-empty array`);
-		} else {
-			for (let i = 0; i < config.audience.length; i++) {
-				if (typeof config.audience[i] !== 'string') {
-					errors.push(`${file}: "audience[${i}]" must be a string`);
-				} else if (!valid_audience.includes(config.audience[i])) {
-					errors.push(`${file}: "audience[${i}]" value "${config.audience[i]}" is not recognised. Valid values: ${valid_audience.join(', ')}`);
-				}
-			}
-		}
-
-		if (!config.navigation || typeof config.navigation !== 'object' || Array.isArray(config.navigation)) {
-			errors.push(`${file}: "navigation" is required and must be an object`);
-		} else {
-			check_extra_keys(config.navigation, ['items'], 'navigation', file, errors);
-			if (!Array.isArray(config.navigation.items)) {
-				errors.push(`${file}: "navigation.items" is required and must be an array`);
-			} else if (config.navigation.items.length === 0) {
-				errors.push(`${file}: "navigation.items" must not be empty`);
-			} else {
-				for (let i = 0; i < config.navigation.items.length; i++) {
-					validate_nav_item(config.navigation.items[i], `navigation.items[${i}]`, errors, 1);
-				}
-			}
-		}
-
-		if (config.description !== undefined && typeof config.description !== 'string') {
-			errors.push(`${file}: "description" must be a string`);
-		}
-
-		if (config.publicSource !== undefined && config.publicSource !== '') {
-			if (typeof config.publicSource !== 'string') {
-				errors.push(`${file}: "publicSource" must be a string`);
-			} else if (config.publicSource.toLowerCase() === '--publicsource--') {
-				errors.push(`${file}: "publicSource" is still set to its default template value`);
-			} else if (
-				!config.publicSource.startsWith('https://github.com') &&
-				!config.publicSource.startsWith('https://api.github.com')
-			) {
-				errors.push(`${file}: "publicSource" must be a GitHub URL starting with https://github.com or https://api.github.com (got "${config.publicSource}")`);
-			}
-		}
-
-		if (config.bookType !== undefined && !valid_book_types.includes(config.bookType)) {
-			errors.push(`${file}: "bookType" must be an integer, one of: ${valid_book_types.join(', ')} (0=document, 1=api_ref, 2=db_ref, 3=etl_ref, 4=mcp_ref)`);
-		}
-
-		if (config.coverImage !== undefined && typeof config.coverImage !== 'string') {
-			errors.push(`${file}: "coverImage" must be a string`);
-		}
-
-		if (config.tags !== undefined) {
-			if (!Array.isArray(config.tags)) {
-				errors.push(`${file}: "tags" must be an array`);
-			} else {
-				for (let i = 0; i < config.tags.length; i++) {
-					if (typeof config.tags[i] !== 'string') {
-						errors.push(`${file}: "tags[${i}]" must be a string`);
-					}
-				}
-			}
-		}
-
-		if (config.languages !== undefined) {
-			if (!Array.isArray(config.languages)) {
-				errors.push(`${file}: "languages" must be an array`);
-			} else {
-				for (let i = 0; i < config.languages.length; i++) {
-					if (typeof config.languages[i] !== 'string') {
-						errors.push(`${file}: "languages[${i}]" must be a string`);
-					}
-				}
-			}
-		}
-
-		if (config.inline !== undefined) {
-			if (!Array.isArray(config.inline)) {
-				errors.push(`${file}: "inline" must be an array`);
-			} else {
-				for (let i = 0; i < config.inline.length; i++) {
-					const item = config.inline[i];
-					if (typeof item !== 'object' || Array.isArray(item) || item === null) {
-						errors.push(`${file}: "inline[${i}]" must be an object`);
-					} else {
-						check_extra_keys(item, ['title', 'link'], `inline[${i}]`, file, errors);
-						if (!item.title || typeof item.title !== 'string') {
-							errors.push(`${file}: "inline[${i}].title" is required and must be a non-empty string`);
-						}
-						if (!item.link || typeof item.link !== 'string') {
-							errors.push(`${file}: "inline[${i}].link" is required and must be a non-empty string`);
-						}
-					}
-				}
-			}
-		}
-
-		return errors;
-	};
-
-	exports.validate_project = validate_project;
-	exports.validate_book = validate_book;
-})();
+(() => {
+	const path = require("node:path");
+	const regex_doc_id = /^[a-z][a-z0-9-]+$/;
+	const regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/;
+
+	const hdocbook_schema = require(path.join(__dirname, "schemas", "hdocbook.schema.json"));
+	const valid_audience = hdocbook_schema.properties.audience.items.enum;
+	const valid_product_families = hdocbook_schema.properties.productFamily.enum;
+	const valid_book_types = hdocbook_schema.properties.bookType.enum;
+
+	const project_schema = require(path.join(__dirname, "schemas", "hdocbook-project.schema.json"));
+	const project_top_keys = Object.keys(project_schema.properties);
+	const project_pdf_keys = Object.keys(project_schema.properties.pdfGeneration.properties);
+	const project_validation_keys = Object.keys(project_schema.properties.validation.properties);
+	const project_redirect_keys = Object.keys(project_schema.properties.redirects.items.properties);
+	const project_ai_keys = Object.keys(project_schema.properties.ai.properties);
+	const redirect_valid_codes = project_schema.properties.redirects.items.properties.code.enum;
+
+	// Reports any keys in obj that are not in the allowed set.
+	const check_extra_keys = (obj, allowed, path, file, errors) => {
+		for (const key of Object.keys(obj)) {
+			if (!allowed.includes(key)) {
+				errors.push(`${file}: "${path ? path + '.' : ''}${key}" is not a recognised property`);
+			}
+		}
+	};
+
+	const validate_nav_item = (item, path, errors, depth) => {
+		if (typeof item !== 'object' || Array.isArray(item) || item === null) {
+			errors.push(`hdocbook.json: "${path}" must be an object`);
+			return;
+		}
+		check_extra_keys(item, ['text', 'link', 'expand', 'draft', 'items', 'id'], path, 'hdocbook.json', errors);
+		if (!item.text || typeof item.text !== 'string') {
+			errors.push(`hdocbook.json: "${path}.text" is required and must be a non-empty string`);
+		}
+		if (item.id !== undefined && typeof item.id !== 'string') {
+			errors.push(`hdocbook.json: "${path}.id" must be a string`);
+		}
+		if (item.link !== undefined && typeof item.link !== 'string') {
+			errors.push(`hdocbook.json: "${path}.link" must be a string`);
+		}
+		if (item.expand !== undefined && typeof item.expand !== 'boolean') {
+			errors.push(`hdocbook.json: "${path}.expand" must be a boolean`);
+		}
+		if (item.draft !== undefined && typeof item.draft !== 'boolean') {
+			errors.push(`hdocbook.json: "${path}.draft" must be a boolean`);
+		}
+		if (item.items !== undefined) {
+			if (!Array.isArray(item.items)) {
+				errors.push(`hdocbook.json: "${path}.items" must be an array`);
+			} else if (depth >= 5) {
+				errors.push(`hdocbook.json: "${path}.items" exceeds the maximum navigation nesting depth of 5 levels`);
+			} else {
+				for (let i = 0; i < item.items.length; i++) {
+					validate_nav_item(item.items[i], `${path}.items[${i}]`, errors, depth + 1);
+				}
+			}
+		}
+	};
+
+	// Validates the structure of hdocbook-project.json
+	const validate_project = (config) => {
+		const errors = [];
+		const file = 'hdocbook-project.json';
+
+		check_extra_keys(config, project_top_keys, '', file, errors);
+
+		if (!config.docId || typeof config.docId !== 'string') {
+			errors.push(`${file}: "docId" is required and must be a string`);
+		} else if (!regex_doc_id.test(config.docId)) {
+			errors.push(`${file}: "docId" must use kebab-case (lowercase letters, numbers, hyphens): "${config.docId}"`);
+		}
+
+		if (config.pdfGeneration !== undefined) {
+			if (typeof config.pdfGeneration !== 'object' || Array.isArray(config.pdfGeneration)) {
+				errors.push(`${file}: "pdfGeneration" must be an object`);
+			} else {
+				check_extra_keys(config.pdfGeneration, project_pdf_keys, 'pdfGeneration', file, errors);
+				if (config.pdfGeneration.enable === undefined) {
+					errors.push(`${file}: "pdfGeneration.enable" is required`);
+				} else if (typeof config.pdfGeneration.enable !== 'boolean') {
+					errors.push(`${file}: "pdfGeneration.enable" must be a boolean`);
+				}
+				if (config.pdfGeneration.exclude_paths !== undefined) {
+					if (!Array.isArray(config.pdfGeneration.exclude_paths)) {
+						errors.push(`${file}: "pdfGeneration.exclude_paths" must be an array`);
+					} else {
+						for (let i = 0; i < config.pdfGeneration.exclude_paths.length; i++) {
+							if (typeof config.pdfGeneration.exclude_paths[i] !== 'string') {
+								errors.push(`${file}: "pdfGeneration.exclude_paths[${i}]" must be a string`);
+							}
+						}
+					}
+				}
+			}
+		}
+
+		if (config.validation !== undefined) {
+			if (typeof config.validation !== 'object' || Array.isArray(config.validation)) {
+				errors.push(`${file}: "validation" must be an object`);
+			} else {
+				check_extra_keys(config.validation, project_validation_keys, 'validation', file, errors);
+				if (config.validation.exclude_links !== undefined) {
+					if (!Array.isArray(config.validation.exclude_links)) {
+						errors.push(`${file}: "validation.exclude_links" must be an array`);
+					} else {
+						for (let i = 0; i < config.validation.exclude_links.length; i++) {
+							if (typeof config.validation.exclude_links[i] !== 'string') {
+								errors.push(`${file}: "validation.exclude_links[${i}]" must be a string`);
+							}
+						}
+					}
+				}
+				if (config.validation.exclude_spellcheck !== undefined) {
+					if (!Array.isArray(config.validation.exclude_spellcheck)) {
+						errors.push(`${file}: "validation.exclude_spellcheck" must be an array`);
+					} else {
+						for (let i = 0; i < config.validation.exclude_spellcheck.length; i++) {
+							const item = config.validation.exclude_spellcheck[i];
+							if (typeof item !== 'object' || Array.isArray(item) || item === null) {
+								errors.push(`${file}: "validation.exclude_spellcheck[${i}]" must be an object`);
+							} else {
+								check_extra_keys(item, ['document_path', 'words'], `validation.exclude_spellcheck[${i}]`, file, errors);
+								if (!item.document_path || typeof item.document_path !== 'string') {
+									errors.push(`${file}: "validation.exclude_spellcheck[${i}].document_path" is required and must be a non-empty string`);
+								}
+								if (!Array.isArray(item.words)) {
+									errors.push(`${file}: "validation.exclude_spellcheck[${i}].words" is required and must be an array`);
+								} else {
+									for (let j = 0; j < item.words.length; j++) {
+										if (typeof item.words[j] !== 'string') {
+											errors.push(`${file}: "validation.exclude_spellcheck[${i}].words[${j}]" must be a string`);
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+				if (config.validation.exclude_h1_count !== undefined) {
+					if (!Array.isArray(config.validation.exclude_h1_count)) {
+						errors.push(`${file}: "validation.exclude_h1_count" must be an array`);
+					} else {
+						for (let i = 0; i < config.validation.exclude_h1_count.length; i++) {
+							if (typeof config.validation.exclude_h1_count[i] !== 'string') {
+								errors.push(`${file}: "validation.exclude_h1_count[${i}]" must be a string`);
+							}
+						}
+					}
+				}
+				if (config.validation.external_link_warnings !== undefined &&
+					typeof config.validation.external_link_warnings !== 'boolean') {
+					errors.push(`${file}: "validation.external_link_warnings" must be a boolean`);
+				}
+				if (config.validation.spellcheckDictionary !== undefined) {
+					if (!Array.isArray(config.validation.spellcheckDictionary)) {
+						errors.push(`${file}: "validation.spellcheckDictionary" must be an array`);
+					} else {
+						for (let i = 0; i < config.validation.spellcheckDictionary.length; i++) {
+							if (typeof config.validation.spellcheckDictionary[i] !== 'string') {
+								errors.push(`${file}: "validation.spellcheckDictionary[${i}]" must be a string`);
+							}
+						}
+					}
+				}
+			}
+		}
+
+		if (config.ai !== undefined) {
+			if (typeof config.ai !== 'object' || Array.isArray(config.ai) || config.ai === null) {
+				errors.push(`${file}: "ai" must be an object`);
+			} else {
+				check_extra_keys(config.ai, project_ai_keys, 'ai', file, errors);
+				if (config.ai.model !== undefined && typeof config.ai.model !== 'string') {
+					errors.push(`${file}: "ai.model" must be a string`);
+				}
+				if (config.ai.maxTokens !== undefined && !Number.isInteger(config.ai.maxTokens)) {
+					errors.push(`${file}: "ai.maxTokens" must be an integer`);
+				}
+			}
+		}
+
+		if (config.redirects !== undefined) {
+			if (!Array.isArray(config.redirects)) {
+				errors.push(`${file}: "redirects" must be an array`);
+			} else {
+				for (let i = 0; i < config.redirects.length; i++) {
+					const r = config.redirects[i];
+					if (typeof r !== 'object' || Array.isArray(r) || r === null) {
+						errors.push(`${file}: "redirects[${i}]" must be an object`);
+					} else {
+						check_extra_keys(r, project_redirect_keys, `redirects[${i}]`, file, errors);
+						if (!r.url || typeof r.url !== 'string') {
+							errors.push(`${file}: "redirects[${i}].url" is required and must be a non-empty string`);
+						}
+						if (r.code === undefined) {
+							errors.push(`${file}: "redirects[${i}].code" is required`);
+						} else if (!redirect_valid_codes.includes(r.code)) {
+							errors.push(`${file}: "redirects[${i}].code" must be ${redirect_valid_codes.join(', ')} (got ${r.code})`);
+						}
+						if (r.location !== undefined && typeof r.location !== 'string') {
+							errors.push(`${file}: "redirects[${i}].location" must be a string`);
+						}
+						if (r.skip_location_validation !== undefined && typeof r.skip_location_validation !== 'boolean') {
+							errors.push(`${file}: "redirects[${i}].skip_location_validation" must be a boolean`);
+						}
+					}
+				}
+			}
+		}
+
+		return errors;
+	};
+
+	// Validates the structure of hdocbook.json
+	const validate_book = (config, expected_doc_id) => {
+		const errors = [];
+		const file = 'hdocbook.json';
+
+		check_extra_keys(config,
+			['docId', 'title', 'description', 'publicSource', 'version', 'productFamily', 'bookType',
+			 'coverImage', 'tags', 'audience', 'languages', 'readingTime', 'navigation', 'inline'],
+			'', file, errors);
+
+		if (!config.docId || typeof config.docId !== 'string') {
+			errors.push(`${file}: "docId" is required and must be a string`);
+		} else {
+			if (!regex_doc_id.test(config.docId)) {
+				errors.push(`${file}: "docId" must use kebab-case (lowercase letters, numbers, hyphens): "${config.docId}"`);
+			}
+			if (expected_doc_id && config.docId !== expected_doc_id) {
+				errors.push(`${file}: "docId" value "${config.docId}" does not match the folder name and the docId in hdocbook-project.json ("${expected_doc_id}")`);
+			}
+		}
+
+		if (!config.title || typeof config.title !== 'string') {
+			errors.push(`${file}: "title" is required and must be a non-empty string`);
+		}
+
+		if (!config.version || typeof config.version !== 'string') {
+			errors.push(`${file}: "version" is required and must be a string`);
+		} else if (!regex_version.test(config.version)) {
+			errors.push(`${file}: "version" must be in X.Y.Z format (got "${config.version}")`);
+		}
+
+		if (!config.productFamily || typeof config.productFamily !== 'string') {
+			errors.push(`${file}: "productFamily" is required and must be a string`);
+		} else if (!valid_product_families.includes(config.productFamily)) {
+			errors.push(`${file}: "productFamily" value "${config.productFamily}" is not recognised. Valid values: ${valid_product_families.join(', ')}`);
+		}
+
+		if (!config.audience || !Array.isArray(config.audience) || config.audience.length === 0) {
+			errors.push(`${file}: "audience" is required and must be a non-empty array`);
+		} else {
+			for (let i = 0; i < config.audience.length; i++) {
+				if (typeof config.audience[i] !== 'string') {
+					errors.push(`${file}: "audience[${i}]" must be a string`);
+				} else if (!valid_audience.includes(config.audience[i])) {
+					errors.push(`${file}: "audience[${i}]" value "${config.audience[i]}" is not recognised. Valid values: ${valid_audience.join(', ')}`);
+				}
+			}
+		}
+
+		if (!config.navigation || typeof config.navigation !== 'object' || Array.isArray(config.navigation)) {
+			errors.push(`${file}: "navigation" is required and must be an object`);
+		} else {
+			check_extra_keys(config.navigation, ['items'], 'navigation', file, errors);
+			if (!Array.isArray(config.navigation.items)) {
+				errors.push(`${file}: "navigation.items" is required and must be an array`);
+			} else if (config.navigation.items.length === 0) {
+				errors.push(`${file}: "navigation.items" must not be empty`);
+			} else {
+				for (let i = 0; i < config.navigation.items.length; i++) {
+					validate_nav_item(config.navigation.items[i], `navigation.items[${i}]`, errors, 1);
+				}
+			}
+		}
+
+		if (config.description !== undefined && typeof config.description !== 'string') {
+			errors.push(`${file}: "description" must be a string`);
+		}
+
+		if (config.publicSource !== undefined && config.publicSource !== '') {
+			if (typeof config.publicSource !== 'string') {
+				errors.push(`${file}: "publicSource" must be a string`);
+			} else if (config.publicSource.toLowerCase() === '--publicsource--') {
+				errors.push(`${file}: "publicSource" is still set to its default template value`);
+			} else if (
+				!config.publicSource.startsWith('https://github.com') &&
+				!config.publicSource.startsWith('https://api.github.com')
+			) {
+				errors.push(`${file}: "publicSource" must be a GitHub URL starting with https://github.com or https://api.github.com (got "${config.publicSource}")`);
+			}
+		}
+
+		if (config.bookType !== undefined && !valid_book_types.includes(config.bookType)) {
+			errors.push(`${file}: "bookType" must be an integer, one of: ${valid_book_types.join(', ')} (0=document, 1=api_ref, 2=db_ref, 3=etl_ref, 4=mcp_ref)`);
+		}
+
+		if (config.coverImage !== undefined && typeof config.coverImage !== 'string') {
+			errors.push(`${file}: "coverImage" must be a string`);
+		}
+
+		if (config.tags !== undefined) {
+			if (!Array.isArray(config.tags)) {
+				errors.push(`${file}: "tags" must be an array`);
+			} else {
+				for (let i = 0; i < config.tags.length; i++) {
+					if (typeof config.tags[i] !== 'string') {
+						errors.push(`${file}: "tags[${i}]" must be a string`);
+					}
+				}
+			}
+		}
+
+		if (config.languages !== undefined) {
+			if (!Array.isArray(config.languages)) {
+				errors.push(`${file}: "languages" must be an array`);
+			} else {
+				for (let i = 0; i < config.languages.length; i++) {
+					if (typeof config.languages[i] !== 'string') {
+						errors.push(`${file}: "languages[${i}]" must be a string`);
+					}
+				}
+			}
+		}
+
+		if (config.inline !== undefined) {
+			if (!Array.isArray(config.inline)) {
+				errors.push(`${file}: "inline" must be an array`);
+			} else {
+				for (let i = 0; i < config.inline.length; i++) {
+					const item = config.inline[i];
+					if (typeof item !== 'object' || Array.isArray(item) || item === null) {
+						errors.push(`${file}: "inline[${i}]" must be an object`);
+					} else {
+						check_extra_keys(item, ['title', 'link'], `inline[${i}]`, file, errors);
+						if (!item.title || typeof item.title !== 'string') {
+							errors.push(`${file}: "inline[${i}].title" is required and must be a non-empty string`);
+						}
+						if (!item.link || typeof item.link !== 'string') {
+							errors.push(`${file}: "inline[${i}].link" is required and must be a non-empty string`);
+						}
+					}
+				}
+			}
+		}
+
+		return errors;
+	};
+
+	exports.validate_project = validate_project;
+	exports.validate_book = validate_book;
+})();