@schalkneethling/miyagi-core 4.4.0 → 4.4.2

package/lib/validator/schemas.js

@@ -1,5 +1,6 @@
 // @ts-check
 
+import path from "path";
 import deepMerge from "deepmerge";
 
 const DEFAULT_SCHEMA_VALIDATION_MODE = "collect-all";
@@ -18,6 +19,38 @@ export function getSchemaValidationMode() {
 	return mode;
 }
 
+/**
+ * Resolves global schema definitions from the root of the components folder.
+ * The file must have the same name as configured in `files.schema` (JSON or YAML)
+ * and contain an array of JSON Schema definition objects.
+ * @returns {Array<{schema: object, globalSchemaFile: string}>}
+ */
+function loadGlobalSchemas() {
+	const { components, files } = global.config;
+
+	if (!components?.folder || !files?.schema) {
+		return [];
+	}
+
+	const schemaFileName = `${files.schema.name}.${files.schema.extension}`;
+	const globalSchemaFile = path.join(
+		process.cwd(),
+		components.folder,
+		schemaFileName,
+	);
+
+	const content = global.state?.fileContents?.[globalSchemaFile];
+	if (!content) {
+		return [];
+	}
+
+	const defs = Array.isArray(content) ? content : [content];
+
+	return defs
+		.filter((def) => def && typeof def === "object")
+		.map((schema) => ({ schema: structuredClone(schema), globalSchemaFile }));
+}
+
 /**
  * @param {object} options
  * @param {Array<object>} [options.components]
@@ -38,6 +71,31 @@ export function validateSchemas({ components } = {}) {
 		),
 	);
 
+	// Register global schema definitions before compiling component schemas so
+	// that component $ref entries targeting global $id values can resolve.
+	for (const [index, { schema, globalSchemaFile }] of loadGlobalSchemas().entries()) {
+		if (!schema.$id) {
+			schema.$id = `miyagi-global:${index}`;
+		}
+		try {
+			validator.addSchema(schema);
+			validSchemas.push({
+				component: "$global",
+				schemaFile: globalSchemaFile,
+				schema,
+			});
+		} catch (error) {
+			errors.push(
+				buildSchemaValidationError({
+					error,
+					component: "$global",
+					schemaFile: globalSchemaFile,
+					rawSchema: schema,
+				}),
+			);
+		}
+	}
+
 	let pendingSchemas = componentRoutes
 		.map((component, index) => {
 			// Absolute schema file path.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@schalkneethling/miyagi-core",
-	"version": "4.4.0",
+	"version": "4.4.2",
 	"description": "miyagi is a component development tool for JavaScript template engines.",
 	"main": "index.js",
 	"author": "Schalk Neethling <schalkneethling@duck.com>, Michael Großklaus <mail@mgrossklaus.de> (https://www.mgrossklaus.de)",