@onboardingiq/delivery-model-validator 0.0.1 → 0.1.0

package/dist/validateDeliveryModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateDeliveryModel.d.ts","sourceRoot":"","sources":["../src/validateDeliveryModel.ts"],"names":[],"mappings":"AAKA,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AA0BF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAmKF,wBAAsB,2BAA2B,CAAC,MAAM,EAAE;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAyL3C"}
+{"version":3,"file":"validateDeliveryModel.d.ts","sourceRoot":"","sources":["../src/validateDeliveryModel.ts"],"names":[],"mappings":"AAgBA,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AA0BF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AA+NF,wBAAsB,2BAA2B,CAAC,MAAM,EAAE;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAmO3C"}

package/dist/validateDeliveryModel.js

@@ -8,6 +8,15 @@ const promises_1 = require("node:fs/promises");
 const node_path_1 = __importDefault(require("node:path"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const gray_matter_1 = __importDefault(require("gray-matter"));
+const VALID_CANON_ASSET_TYPES = [
+    "Framework",
+    "Checklist",
+    "SOP",
+    "Guide",
+    "Reference",
+    "Template",
+];
+const VALID_CANON_ASSET_TYPES_LABEL = VALID_CANON_ASSET_TYPES.join(", ");
 function phaseSummary(phases) {
     if (!Array.isArray(phases))
         return [];
@@ -22,6 +31,32 @@ function phaseSummary(phases) {
         };
     });
 }
+function describeValueType(value) {
+    if (value === null)
+        return "null";
+    if (Array.isArray(value))
+        return "array";
+    if (typeof value === "object")
+        return "object";
+    return typeof value;
+}
+/** Required non-empty string from frontmatter; pushes precise errors and returns null on failure. */
+function pushRequiredString(errors, filePath, entity, field, value) {
+    if (value === undefined || value === null) {
+        errors.push(`${entity} ${filePath}: missing required field: ${field}`);
+        return null;
+    }
+    if (typeof value !== "string") {
+        errors.push(`${entity} ${filePath}: field ${field} must be a non-empty string (got ${describeValueType(value)})`);
+        return null;
+    }
+    const trimmed = value.trim();
+    if (!trimmed) {
+        errors.push(`${entity} ${filePath}: field ${field} must be non-empty`);
+        return null;
+    }
+    return trimmed;
+}
 function asNonEmptyString(value) {
     if (typeof value !== "string")
         return null;
@@ -59,8 +94,9 @@ async function parseTasks(tasksRoot, debug) {
     try {
         files = (await walkFiles(tasksRoot)).filter((file) => file.toLowerCase().endsWith(".md"));
     }
-    catch {
-        taskErrors.push(`Tasks directory not found: ${tasksRoot}`);
+    catch (error) {
+        const message = error instanceof Error ? error.message : "unknown error";
+        taskErrors.push(`Unable to read tasks directory ${tasksRoot}: ${message}`);
         return { taskCount: 0, tasks, taskErrors };
     }
     debugLog(debug, "[git-validate] tasks discovered", { taskCount: files.length, tasksRoot });
@@ -68,20 +104,25 @@ async function parseTasks(tasksRoot, debug) {
         try {
             const raw = await (0, promises_1.readFile)(filePath, "utf8");
             const frontmatter = (0, gray_matter_1.default)(raw).data;
-            const id = asNonEmptyString(frontmatter.id);
-            const title = asNonEmptyString(frontmatter.title);
-            const phase = asNonEmptyString(frontmatter.phase);
+            const id = pushRequiredString(taskErrors, filePath, "Task", "id", frontmatter.id);
+            const title = pushRequiredString(taskErrors, filePath, "Task", "title", frontmatter.title);
+            const phase = pushRequiredString(taskErrors, filePath, "Task", "phase", frontmatter.phase);
             const canonRefs = [];
             const canonField = frontmatter.canon;
             if (canonField !== undefined) {
                 if (!Array.isArray(canonField)) {
-                    taskErrors.push(`Task ${filePath} has invalid canon field: expected array`);
+                    taskErrors.push(`Task ${filePath}: field canon must be an array`);
                 }
                 else {
                     for (const item of canonField) {
                         const ref = asNonEmptyString(item);
                         if (!ref) {
-                            taskErrors.push(`Task ${filePath} has invalid canon entry: expected non-empty string`);
+                            if (typeof item === "string" && !item.trim()) {
+                                taskErrors.push(`Task ${filePath}: field canon must contain only non-empty strings`);
+                            }
+                            else {
+                                taskErrors.push(`Task ${filePath}: field canon must contain only non-empty strings (got ${describeValueType(item)})`);
+                            }
                         }
                         else {
                             canonRefs.push(ref);
@@ -89,12 +130,6 @@ async function parseTasks(tasksRoot, debug) {
                     }
                 }
             }
-            if (!id)
-                taskErrors.push(`Task ${filePath} is missing required field: id`);
-            if (!title)
-                taskErrors.push(`Task ${filePath} is missing required field: title`);
-            if (!phase)
-                taskErrors.push(`Task ${filePath} is missing required field: phase`);
             tasks.push({ id, title, phase, canonRefs, filePath });
         }
         catch (error) {
@@ -102,11 +137,15 @@ async function parseTasks(tasksRoot, debug) {
             taskErrors.push(`Task ${filePath} parse failed: ${message}`);
         }
     }
-    const duplicateTaskIds = duplicateValues(tasks.map((task) => task.id).filter((id) => Boolean(id)));
+    const duplicateTaskIds = duplicateValues(tasks.map((task) => task.id).filter((tid) => Boolean(tid)));
     if (duplicateTaskIds.length > 0) {
         debugLog(debug, "[git-validate] duplicate task ids", { duplicateTaskIds });
         for (const duplicateId of duplicateTaskIds) {
-            taskErrors.push(`Duplicate task id found: ${duplicateId}`);
+            const paths = tasks
+                .filter((task) => task.id === duplicateId)
+                .map((task) => task.filePath)
+                .sort();
+            taskErrors.push(`Duplicate task id "${duplicateId}" in files: ${paths.join(", ")}`);
         }
     }
     return { taskCount: files.length, tasks, taskErrors };
@@ -116,10 +155,11 @@ async function parseCanon(canonRoot, debug) {
     const canonAssets = [];
     let files = [];
     try {
-        files = await walkFiles(canonRoot);
+        files = (await walkFiles(canonRoot)).filter((file) => file.toLowerCase().endsWith(".md"));
     }
-    catch {
-        canonErrors.push(`Canon directory not found: ${canonRoot}`);
+    catch (error) {
+        const message = error instanceof Error ? error.message : "unknown error";
+        canonErrors.push(`Unable to read canon directory ${canonRoot}: ${message}`);
         return { canonCount: 0, canonAssets, canonErrors };
     }
     debugLog(debug, "[git-validate] canon discovered", { canonCount: files.length, canonRoot });
@@ -127,18 +167,29 @@ async function parseCanon(canonRoot, debug) {
         try {
             const raw = await (0, promises_1.readFile)(filePath, "utf8");
             const frontmatter = (0, gray_matter_1.default)(raw).data;
-            const id = asNonEmptyString(frontmatter.id);
-            const title = asNonEmptyString(frontmatter.title);
-            const summary = asNonEmptyString(frontmatter.summary);
-            const assetType = asNonEmptyString(frontmatter.asset_type);
-            if (!id)
-                canonErrors.push(`Canon ${filePath} is missing required field: id`);
-            if (!title)
-                canonErrors.push(`Canon ${filePath} is missing required field: title`);
-            if (!summary)
-                canonErrors.push(`Canon ${filePath} is missing required field: summary`);
-            if (!assetType)
-                canonErrors.push(`Canon ${filePath} is missing required field: asset_type`);
+            const id = pushRequiredString(canonErrors, filePath, "Canon", "id", frontmatter.id);
+            const title = pushRequiredString(canonErrors, filePath, "Canon", "title", frontmatter.title);
+            const summary = pushRequiredString(canonErrors, filePath, "Canon", "summary", frontmatter.summary);
+            let assetType = null;
+            const rawAssetType = frontmatter.asset_type;
+            if (rawAssetType === undefined || rawAssetType === null) {
+                canonErrors.push(`Canon ${filePath}: missing required field: asset_type`);
+            }
+            else if (typeof rawAssetType !== "string") {
+                canonErrors.push(`Canon ${filePath}: field asset_type must be a non-empty string (got ${describeValueType(rawAssetType)})`);
+            }
+            else {
+                const trimmed = rawAssetType.trim();
+                if (!trimmed) {
+                    canonErrors.push(`Canon ${filePath}: field asset_type must be non-empty`);
+                }
+                else if (!VALID_CANON_ASSET_TYPES.includes(trimmed)) {
+                    canonErrors.push(`Canon ${filePath}: field asset_type has invalid value "${trimmed}" (valid: ${VALID_CANON_ASSET_TYPES_LABEL})`);
+                }
+                else {
+                    assetType = trimmed;
+                }
+            }
             canonAssets.push({ id, title, summary, assetType, filePath });
         }
         catch (error) {
@@ -146,11 +197,15 @@ async function parseCanon(canonRoot, debug) {
             canonErrors.push(`Canon ${filePath} parse failed: ${message}`);
         }
     }
-    const duplicateCanonIds = duplicateValues(canonAssets.map((asset) => asset.id).filter((id) => Boolean(id)));
+    const duplicateCanonIds = duplicateValues(canonAssets.map((asset) => asset.id).filter((cid) => Boolean(cid)));
     if (duplicateCanonIds.length > 0) {
         debugLog(debug, "[git-validate] duplicate canon ids", { duplicateCanonIds });
         for (const duplicateId of duplicateCanonIds) {
-            canonErrors.push(`Duplicate canon id found: ${duplicateId}`);
+            const paths = canonAssets
+                .filter((asset) => asset.id === duplicateId)
+                .map((asset) => asset.filePath)
+                .sort();
+            canonErrors.push(`Duplicate canon id "${duplicateId}" in files: ${paths.join(", ")}`);
         }
     }
     return { canonCount: files.length, canonAssets, canonErrors };
@@ -215,7 +270,7 @@ async function validateDeliveryModelAtPath(params) {
             canonCount: 0,
             taskErrors,
             canonErrors,
-            errors: [`model-spec.yaml parse failed: ${message}`],
+            errors: [`model-spec.yaml parse failed at ${modelSpecPath}: ${message}`],
             warnings,
         };
     }
@@ -249,6 +304,28 @@ async function validateDeliveryModelAtPath(params) {
             ? spec.type
             : null;
     const phases = phaseSummary(spec.phases);
+    let tasksDirOk = false;
+    try {
+        const tasksStat = await (0, promises_1.stat)(tasksRoot);
+        tasksDirOk = tasksStat.isDirectory();
+        if (!tasksDirOk) {
+            errors.push(`tasks/ must exist and be a directory: ${tasksRoot}`);
+        }
+    }
+    catch {
+        errors.push(`tasks/ must exist and be a directory: ${tasksRoot}`);
+    }
+    let canonDirOk = false;
+    try {
+        const canonStat = await (0, promises_1.stat)(canonRoot);
+        canonDirOk = canonStat.isDirectory();
+        if (!canonDirOk) {
+            errors.push(`canon/ must exist and be a directory: ${canonRoot}`);
+        }
+    }
+    catch {
+        errors.push(`canon/ must exist and be a directory: ${canonRoot}`);
+    }
     if (!modelId)
         errors.push("model-spec.yaml is missing required field: id");
     if (!version)
@@ -268,7 +345,7 @@ async function validateDeliveryModelAtPath(params) {
     if (duplicatePhaseIds.length > 0) {
         debugLog(debug, "[git-validate] duplicate phase ids", { duplicatePhaseIds });
         for (const duplicateId of duplicatePhaseIds) {
-            errors.push(`Duplicate phase id found: ${duplicateId}`);
+            errors.push(`Duplicate phase id "${duplicateId}"`);
         }
     }
     const duplicatePhaseSequences = duplicateValues(phases
@@ -281,23 +358,37 @@ async function validateDeliveryModelAtPath(params) {
             errors.push(`Duplicate phase sequence found: ${duplicateSequence}`);
         }
     }
-    const { taskCount, tasks, taskErrors: parsedTaskErrors } = await parseTasks(tasksRoot, debug);
-    const { canonCount, canonAssets, canonErrors: parsedCanonErrors } = await parseCanon(canonRoot, debug);
-    taskErrors.push(...parsedTaskErrors);
-    canonErrors.push(...parsedCanonErrors);
-    const validPhaseIds = new Set(phases.map((phase) => phase.id).filter((id) => Boolean(id)));
+    let taskCount = 0;
+    let tasks = [];
+    if (tasksDirOk) {
+        const parsed = await parseTasks(tasksRoot, debug);
+        taskCount = parsed.taskCount;
+        tasks = parsed.tasks;
+        taskErrors.push(...parsed.taskErrors);
+    }
+    let canonCount = 0;
+    let canonAssets = [];
+    if (canonDirOk) {
+        const parsed = await parseCanon(canonRoot, debug);
+        canonCount = parsed.canonCount;
+        canonAssets = parsed.canonAssets;
+        canonErrors.push(...parsed.canonErrors);
+    }
+    const validPhaseList = phases.map((phase) => phase.id).filter((id) => Boolean(id));
+    const validPhaseIds = new Set(validPhaseList);
+    const validPhasesLabel = validPhaseList.length > 0 ? validPhaseList.join(", ") : "(none defined in model-spec.yaml)";
     const validCanonIds = new Set(canonAssets.map((asset) => asset.id).filter((id) => Boolean(id)));
     const invalidPhaseRefs = [];
     const brokenCanonRefs = [];
     for (const task of tasks) {
         if (task.phase && !validPhaseIds.has(task.phase)) {
-            invalidPhaseRefs.push(`${task.id ?? task.filePath} -> ${task.phase}`);
-            taskErrors.push(`Task ${task.id ?? task.filePath} references unknown phase: ${task.phase}`);
+            invalidPhaseRefs.push(`${task.filePath} -> ${task.phase}`);
+            taskErrors.push(`Task ${task.filePath}: field phase has invalid value "${task.phase}" (valid phases: ${validPhasesLabel})`);
         }
         for (const canonRef of task.canonRefs) {
             if (!validCanonIds.has(canonRef)) {
-                brokenCanonRefs.push(`${task.id ?? task.filePath} -> ${canonRef}`);
-                taskErrors.push(`Task ${task.id ?? task.filePath} references unknown canon id: ${canonRef}`);
+                brokenCanonRefs.push(`${task.filePath} -> ${canonRef}`);
+                taskErrors.push(`Task ${task.filePath}: field canon references unknown canon id "${canonRef}"`);
             }
         }
     }
@@ -334,7 +425,10 @@ function debugLog(enabled, ...args) {
     }
     catch (error) {
         // If output is being piped and the reader closes early (e.g. `| head`), ignore EPIPE.
-        if (typeof error === "object" && error && error.code === "EPIPE")
+        if (typeof error === "object" &&
+            error &&
+            "code" in error &&
+            error.code === "EPIPE")
             return;
         throw error;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onboardingiq/delivery-model-validator",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Local validation CLI for OnboardingIQ delivery model repositories (model-spec, phases, tasks, canon).",
   "license": "UNLICENSED",
   "type": "commonjs",
@@ -14,6 +14,7 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
       "require": "./dist/index.js"
     }
   },