@miragon/design-iq-validator 5.6.0 → 5.8.0

package/README.md

@@ -25,25 +25,28 @@ so each refusal is an ERROR (`team-topology/schema`, `context-map/schema`,
   every id starting with `__implicitroot`, and `assoc_<annotation id>` in a Team Topology;
 - in all three notations, an id that names a built-in JavaScript object property such as
   `constructor`, `toString` or `__proto__`: the canvas keeps its elements in a plain object and
-  cannot import it. The Team Topology and Context Map schema models still take these ids, so the
-  validator refuses them itself, under the same rule;
+  cannot import it;
+- in a Team Topology whose `version` is not 1, a file without `version` included: an interaction
+  without `position` or `size`, at the missing field (`interactions.0.size`). Opened anyway, it
+  would drop out of the file with the next save. A version 1 file still loses its edge
+  interactions, which have no geometry;
 - in a Context Map: a JSON list instead of an object, a `version` newer than 1, coordinates or
-  sizes beyond 1,000,000;
+  sizes beyond 1,000,000, and a repeated id at the path of the repeat, e.g.
+  `contexts.2.id: duplicate id "a"; ids must be unique across contexts and relationships`;
 - in a Value Chain: keys other than `x`, `y`, `width`, `height` in `bounds` and other than `x`,
-  `y` in a waypoint, coordinates beyond ±1e9, and a `__proto__` key anywhere.
+  `y` in a waypoint, coordinates beyond ±1e9, a `__proto__` key anywhere, and nesting deeper than
+  100 levels;
+- in a Team Topology and a Context Map: a document nested too deep for the schema model's
+  serializer, which every canvas save runs, as `(root): could not be checked: …`.
 
 A Context Map's strategic-DDD rules (`validateDocument`, e.g. `protect-or-conform`,
 `endpoints-on-map`) are WARNs, `context-map/semantics`, with the rule named at the end of the
-message: the canvas opens such a map and marks the finding. A repeated id is the exception: the
-canvas refuses it, so it is an ERROR (`context-map/schema`) at the path of the repeat, e.g.
-`contexts.2.id: Duplicate id "a". (unique-ids)`.
+message: the canvas opens such a map and marks the finding.
 
-Paths count in the document as the schema model reads it. A Team Topology drops a legacy
-interaction without `position` or `size` before the check, so the index of a later interaction
-counts without it. Some rules only run once the document's shape is valid: the id rules of a Team
-Topology and a Value Chain, and in a Context Map the repeated ids and the strategic-DDD rules.
-Fixing the reported errors can therefore bring up further ones, so check again until the file is
-clean.
+Paths count in the file, a Team Topology's interactions included. Some rules only run once the
+document's shape is valid: the id rules of a Team Topology and a Value Chain, and a Context Map's
+strategic-DDD rules. Fixing the reported errors can therefore bring up further ones, so check
+again until the file is clean.
 
 ## Usage
 

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { o as runCli } from "./validate-BqkEd0ma.js";
+import { o as runCli } from "./validate-CUTctX4d.js";
 //#region src/cli.ts
 /**
 * CLI entry for the platform validator. A dedicated entry file (instead of an

package/dist/{content-CE4SulnP.js → content-B0u0kwZN.js}

@@ -1 +1 @@
-export { t as CONTENT_CONFIG_FILE, i as contentConfigConflict, a as discoverModels, o as legacyContentConfigFile, s as loadContentConfig } from "./content-Bu1bNrez.js";
+export { t as CONTENT_CONFIG_FILE, i as contentConfigConflict, a as discoverModels, o as legacyContentConfigFile, s as loadContentConfig } from "./content-DfRb_tAL.js";

package/dist/{content-Bu1bNrez.js → content-DfRb_tAL.js}

@@ -535,6 +535,7 @@ function extractWardley(raw) {
 		edges
 	};
 }
+const TT_EDGE_INTERACTIONS_VERSION = 1;
 function extractTeamTopology(raw) {
 	const data = JSON.parse(raw);
 	const list = (v) => Array.isArray(v) ? v : [];
@@ -544,7 +545,8 @@ function extractTeamTopology(raw) {
 		name: n.label ?? n.name,
 		extra: n.description ? { description: n.description } : void 0
 	}));
-	const interactions = list(data.interactions).filter((i) => i !== null && typeof i === "object" && "position" in i && "size" in i).map((i) => ({
+	const placed = (i) => "position" in i && "size" in i;
+	const interactions = list(data.interactions).filter((i) => i !== null && typeof i === "object").filter((i) => data.version !== TT_EDGE_INTERACTIONS_VERSION || placed(i)).map((i) => ({
 		id: i.id,
 		type: "interaction",
 		name: i.label,

package/dist/{validate-BqkEd0ma.js → validate-CUTctX4d.js}

@@ -1,8 +1,8 @@
-import { _ as byId, c as resolveContentConfigFile, d as extractModelGraph, f as parseXml, g as byExtension, h as kindOf, l as XMLValidator, m as requirementHref, p as readBpmn, r as CONTENT_CONFIG_NAMES, u as asArray } from "./content-Bu1bNrez.js";
+import { _ as byId, c as resolveContentConfigFile, d as extractModelGraph, f as parseXml, g as byExtension, h as kindOf, l as XMLValidator, m as requirementHref, p as readBpmn, r as CONTENT_CONFIG_NAMES, u as asArray } from "./content-DfRb_tAL.js";
 import { readFileSync } from "node:fs";
 import { relative, resolve } from "node:path";
-import { parseDocumentText, validateDocument } from "@miragon/context-maps-schema-model";
-import { parseDocument } from "@miragon/team-topologies-schema-model";
+import { parseDocumentText, serializeDocumentText, validateDocument } from "@miragon/context-maps-schema-model";
+import { parseDocument, serializeDocument } from "@miragon/team-topologies-schema-model";
 import { documentIssues } from "@miragon/value-chain-schema-model";
 //#region ../notations/refs.ts
 const REF_EMITTERS = { bpmn: (graph) => {
@@ -479,11 +479,23 @@ const MERMAID_DIAGRAM_TYPES = [
 	"railroad-beta",
 	"railroad-ebnf-beta",
 	"railroad-abnf-beta",
-	"railroad-peg-beta"
+	"railroad-peg-beta",
+	"usecase-beta",
+	"agentflow-beta"
 ];
 const FRONT_MATTER = /^([^\S\n\r]*)-{3}\s*[\n\r](.*?)[\n\r]\1-{3}\s*[\n\r]+/s;
 const DIRECTIVE = /%{2}{\s*(?:(\w+)\s*:|(\w+))\s*(?:(\w+)|((?:(?!}%{2}).|\r?\n)*))?\s*(?:}%{2})?/gi;
 const COMMENT_LINE = /^\s*%%(?!{)[^\n]+\n?/gm;
+/**
+* The diagram types whose parser reads the comment lines too: their db sets
+* preserveCommentsWhenParsing (src/Diagram.ts), so their errors count those
+* lines. mermaid's detectors for them (src/diagrams/eventmodeling/detector.ts,
+* src/diagrams/agentflow/afDetector.ts), against the header line.
+*/
+const KEEPS_COMMENTS = /^(?:eventmodeling|agentflow-beta\b)/;
+/** mermaid's default maxTextSize, which apps/web keeps (a secure key): past
+*  it, mermaid parses even those types without their comment lines */
+const MAX_TEXT_SIZE = 5e4;
 /** a header keyword, followed by the end of the line, a space, ":" or ";" */
 const HEADER = new RegExp(`^(?:${MERMAID_DIAGRAM_TYPES.map((t) => t.replace(/[.*+?^${}()|[\]\\-]/g, "\\$&")).join("|")})(?=$|[\\s:;])`);
 /** mermaid's cleanupText: line breaks to \n, tag attributes single-quoted;
@@ -491,11 +503,34 @@ const HEADER = new RegExp(`^(?:${MERMAID_DIAGRAM_TYPES.map((t) => t.replace(/[.*
 function cleanup(source) {
 	return source.replace(/\r\n?/g, "\n").replace(/<(\w+)([^>]*)>/g, (_tag, name, attrs) => `<${name}${attrs.replace(/="([^"]*)"/g, "='$1'")}>`);
 }
+/** the first line that is neither blank nor a bare `%%` comment (mermaid's
+*  type detection skips those too), -1 when there is none */
+function headerIndex(lines) {
+	return lines.findIndex((l) => l.trim() !== "" && !l.trim().startsWith("%%"));
+}
+/** mermaid's preprocess (src/preprocess.ts), step by step */
+function preprocess(source) {
+	const text = cleanup(source);
+	const frontMatter = FRONT_MATTER.exec(text)?.[0] ?? "";
+	const body = text.slice(frontMatter.length);
+	const withComments = body.replace(DIRECTIVE, "");
+	const cleaned = withComments.replace(COMMENT_LINE, "").trimStart();
+	const cleanedLines = cleaned.split("\n");
+	const header = cleanedLines[headerIndex(cleanedLines)]?.trim() ?? "";
+	const keepsComments = KEEPS_COMMENTS.test(header) && withComments.length <= MAX_TEXT_SIZE;
+	return {
+		text,
+		frontMatterLines: frontMatter.split("\n").length - 1,
+		body,
+		keepsComments,
+		code: keepsComments ? withComments : cleaned
+	};
+}
 /** The text mermaid's diagram parser reads: the source after mermaid's
-*  preprocess (front matter, directives and comment lines removed, leading
-*  whitespace trimmed). */
+*  preprocess, its front matter and directives removed and, for all but the
+*  KEEPS_COMMENTS types, its comment lines and leading whitespace too. */
 function mermaidCode(source) {
-	return cleanup(source).replace(FRONT_MATTER, "").replace(DIRECTIVE, "").replace(COMMENT_LINE, "").trimStart();
+	return preprocess(source).code;
 }
 /**
 * The 1-based source line of the 1-based line `codeLine` of mermaidCode(source).
@@ -503,18 +538,32 @@ function mermaidCode(source) {
 * that spans lines), so the code is the source's lines in order: each code
 * line is matched to the next source line with the same text. A line the
 * preprocess rewrote matches nothing and takes the next line; a line past the
-* end clamps to the last one.
+* end clamps to the last one. Code that kept its comment lines lost no line
+* but the front matter's and a directive's inner line breaks, so its lines
+* are counted instead: matching by text would take a line a directive
+* emptied for a later blank line.
 */
 function mermaidSourceLine(source, codeLine) {
-	const cleaned = cleanup(source);
-	const sourceLines = cleaned.split("\n").map((l) => l.trim());
-	const codeLines = mermaidCode(source).split("\n");
-	let next = (cleaned.match(FRONT_MATTER)?.[0] ?? "").split("\n").length - 1;
+	const { text, frontMatterLines, body, keepsComments, code } = preprocess(source);
+	const sourceLines = text.split("\n").map((l) => l.trim());
+	if (keepsComments) {
+		const joined = /* @__PURE__ */ new Set();
+		for (const directive of body.matchAll(DIRECTIVE)) for (let i = directive.index; i < directive.index + directive[0].length; i++) if (body[i] === "\n") joined.add(i);
+		let line = frontMatterLines;
+		for (let i = 0, breaks = 0; i < body.length && breaks < codeLine - 1; i++) {
+			if (body[i] !== "\n") continue;
+			line++;
+			if (!joined.has(i)) breaks++;
+		}
+		return Math.min(line, sourceLines.length - 1) + 1;
+	}
+	const codeLines = code.split("\n");
+	let next = frontMatterLines;
 	let at = next;
 	for (let i = 0; i < Math.min(codeLine, codeLines.length); i++) {
-		const text = codeLines[i].trim();
+		const lineText = codeLines[i].trim();
 		let k = next;
-		while (k < sourceLines.length && sourceLines[k] !== text) k++;
+		while (k < sourceLines.length && sourceLines[k] !== lineText) k++;
 		at = k < sourceLines.length ? k : next;
 		next = at + 1;
 	}
@@ -528,7 +577,7 @@ function mermaidSourceLine(source, codeLine) {
 */
 function mermaidHeader(source) {
 	const lines = mermaidCode(source).split("\n");
-	const index = lines.findIndex((l) => l.trim() !== "" && !l.trim().startsWith("%%"));
+	const index = headerIndex(lines);
 	if (index < 0) return void 0;
 	const text = lines[index].trim();
 	return {
@@ -868,91 +917,32 @@ const schemaError = (ruleId, file) => (issue) => ({
 	file,
 	message: `${issuePath(issue.path)}: ${issue.message}`
 });
-/**
-* The ids a Team Topology or Context Map canvas cannot hold although its
-* schema model takes them: diagram-js keeps its elements in a plain object,
-* so an id that names a built-in object property ("constructor",
-* "__proto__") reads as already added and the import fails. The Value Chain
-* schema model refuses these ids itself; the other two do not yet.
-*/
-function builtInPropertyIds(collections) {
-	return Object.entries(collections).flatMap(([collection, elements]) => (Array.isArray(elements) ? elements : []).flatMap((element, index) => {
-		const id = element?.id;
-		return typeof id === "string" && Object.hasOwn(Object.prototype, id) ? [{
-			path: [
-				collection,
-				index,
-				"id"
-			],
-			message: `the id "${id}" is reserved: it names a built-in property of JavaScript objects`
-		}] : [];
-	}));
-}
-/**
-* The context-map rules the canvas enforces itself: its importer refuses a
-* repeated id (CmImporter.assertImportable), so the file does not open. The
-* other strategic-DDD rules are advisory there: the canvas opens the map and
-* marks the finding, so a save must not refuse it either.
-*/
-const CONTEXT_MAP_REFUSED_RULES = /* @__PURE__ */ new Set(["unique-ids"]);
-/** the path of every repeated id, in the order validateDocument's unique-ids
-*  rule reports them (contexts, then relationships): its findings name no
-*  position, and an agent must know which of two entries to change */
-function repeatedIdPaths({ contexts, relationships }) {
-	const seen = /* @__PURE__ */ new Set();
-	return Object.entries({
-		contexts,
-		relationships
-	}).flatMap(([collection, elements]) => elements.flatMap(({ id }, index) => {
-		const repeated = seen.has(id);
-		seen.add(id);
-		return repeated ? [issuePath([
-			collection,
-			index,
-			"id"
-		])] : [];
-	}));
-}
 function checkTeamTopology(raw, file) {
 	const parsed = parseDocument(JSON.parse(raw));
 	if (!parsed.ok) return parsed.issues.map(schemaError("team-topology/schema", file));
-	const { nodes, interactions, flows, annotations } = parsed.document;
-	return builtInPropertyIds({
-		nodes,
-		interactions,
-		flows,
-		annotations
-	}).map(schemaError("team-topology/schema", file));
+	serializeDocument(parsed.document);
+	return [];
 }
+/**
+* The schema model refuses what the canvas cannot draw (a repeated or
+* reserved id among them), the rest of its strategic-DDD rules are
+* advisory: the canvas opens the map and marks the finding, so a save must
+* not refuse it either.
+*/
 function checkContextMap(raw, file) {
 	const parsed = parseDocumentText(raw);
-	const issues = parsed.ok ? [] : parsed.issues ?? [{
+	if (!parsed.ok) return (parsed.issues ?? [{
 		path: [],
 		message: parsed.error
-	}];
-	if (issues.some(({ path }) => path.length === 0 || path[0] === "version")) return issues.map(schemaError("context-map/schema", file));
-	const { contexts, relationships } = JSON.parse(raw);
-	const schemaFindings = [...issues, ...builtInPropertyIds({
-		contexts,
-		relationships
-	})].map(schemaError("context-map/schema", file));
-	if (!parsed.ok) return schemaFindings;
-	const repeatedIds = repeatedIdPaths(parsed.document);
-	const subject = (finding) => {
-		const path = finding.rule === "unique-ids" ? repeatedIds.shift() : void 0;
-		if (path) return `${path}: `;
-		return finding.relationshipId === void 0 ? "" : `relationship "${finding.relationshipId}": `;
-	};
+	}]).map(schemaError("context-map/schema", file));
+	serializeDocumentText(parsed.document);
 	const { errors, warnings } = validateDocument(parsed.document);
-	return [...schemaFindings, ...[...errors, ...warnings].map((finding) => {
-		const refused = CONTEXT_MAP_REFUSED_RULES.has(finding.rule);
-		return {
-			severity: refused ? "ERROR" : "WARN",
-			ruleId: refused ? "context-map/schema" : "context-map/semantics",
-			file,
-			message: `${subject(finding)}${finding.message} (${finding.rule})`
-		};
-	})];
+	return [...errors, ...warnings].map((finding) => ({
+		severity: "WARN",
+		ruleId: "context-map/semantics",
+		file,
+		message: `${finding.relationshipId === void 0 ? "" : `relationship "${finding.relationshipId}": `}${finding.message} (${finding.rule})`
+	}));
 }
 function checkValueChain(raw, file) {
 	return documentIssues(JSON.parse(raw)).map(schemaError("value-chain/schema", file));
@@ -1063,7 +1053,7 @@ async function runCli() {
 	/** optional single-model filter (a model file stem) */
 	const only = argv[0];
 	const rel = (p) => p.startsWith("/") ? relative(ROOT, p) : p;
-	const { CONTENT_CONFIG_FILE, contentConfigConflict, discoverModels, legacyContentConfigFile, loadContentConfig } = await import("./content-CE4SulnP.js");
+	const { CONTENT_CONFIG_FILE, contentConfigConflict, discoverModels, legacyContentConfigFile, loadContentConfig } = await import("./content-B0u0kwZN.js");
 	const cfg = loadContentConfig(ROOT);
 	if (!cfg) {
 		console.error(notContentRepoError(ROOT));

package/dist/validate.js

@@ -1 +1 @@
-export { t as checkBpmnXml, n as checkDmnXml, r as checkModel, i as checkModelBaseline, a as checkSchemaModel, o as runCli } from "./validate-BqkEd0ma.js";
+export { t as checkBpmnXml, n as checkDmnXml, r as checkModel, i as checkModelBaseline, a as checkSchemaModel, o as runCli } from "./validate-CUTctX4d.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miragon/design-iq-validator",
-  "version": "5.6.0",
+  "version": "5.8.0",
   "type": "module",
   "description": "Platform-owned validator for designIQ content repos — designiq.yml discovery, BPMN/DMN structure and diagram coverage, cross-model references, the schema check of Team Topologies, Context Maps and Value Chains, and a parse check for every other notation. Runs against any checkout via --root; never executes content-repo code.",
   "license": "MIT",
@@ -32,11 +32,11 @@
   "publishConfig": {
     "access": "public"
   },
-  "//": "fast-xml-parser stays a RUNTIME dependency although src/ no longer imports it directly: tsdown inlines @designiq/notations (whose extract.ts imports it) but keeps npm deps external, so the published dist/ resolves it from here. Removing it breaks the npm artifact at import time while the workspace keeps working. zod is a RUNTIME dependency for the same reason: src/ never imports it, but the team-topologies and context-maps schema models take it as a peer, and the published package is what provides it.",
+  "//": "fast-xml-parser stays a RUNTIME dependency although src/ no longer imports it directly: tsdown inlines @designiq/notations (whose extract.ts imports it) but keeps npm deps external, so the published dist/ resolves it from here. Removing it breaks the npm artifact at import time while the workspace keeps working. zod is a RUNTIME dependency for the same reason: src/ never imports it, but the team-topologies, context-maps and value-chain schema models take it as a peer, and the published package is what provides it.",
   "dependencies": {
-    "@miragon/context-maps-schema-model": "0.3.0",
-    "@miragon/team-topologies-schema-model": "0.11.2",
-    "@miragon/value-chain-schema-model": "0.5.0",
+    "@miragon/context-maps-schema-model": "0.4.0",
+    "@miragon/team-topologies-schema-model": "0.12.0",
+    "@miragon/value-chain-schema-model": "0.6.0",
     "fast-xml-parser": "5.11.2",
     "yaml": "2.9.1",
     "zod": "4.6.7"