@istar-ts/core 0.11.0 → 0.12.0

package/README.md

@@ -304,6 +304,15 @@ toPistar(extended); // writes the "metamodel" block
   into a store (`store.load` or `store.replace`) to keep editing.
 - `pistarType` works as for any extension, so `istar.<Name>` types on disk still read.
 
+## Diagnostics
+
+`GoalDiagnostic` (`{ elementId, key?, severity, message, source?, range?, code?, data? }`) is the
+data shape for findings about elements and links. Analysers publish them per source to a
+`createDiagnosticsStore()`; `getAll()` returns the union of every source, deduplicated by
+`(elementId, key, message)`. `fromLspDiagnostics` and `fromNodeIdDiagnostics` adapt LSP and MutRoSe
+diagnostics. Diagnostics are never part of the model and never serialized. `@istar-ts/react`
+shows them as badges and in the inspector (see its README).
+
 ## Credits
 
 The metamodel, link constraints, element shapes, and file format are derived from

package/dist/index.cjs

@@ -2027,12 +2027,183 @@ function validateModelProperties(model, schemas) {
 	return issues;
 }
 //#endregion
+//#region src/diagnostics.ts
+/** Most severe first. */
+const DIAGNOSTIC_SEVERITIES = [
+	"error",
+	"warning",
+	"info",
+	"hint"
+];
+const RANK = {
+	error: 0,
+	warning: 1,
+	info: 2,
+	hint: 3
+};
+/** Negative when `a` is more severe than `b`. */
+function compareSeverity(a, b) {
+	return RANK[a] - RANK[b];
+}
+/** The most severe severity in a list (what a badge shows), or `undefined` if it is empty. */
+function worstDiagnosticSeverity(diagnostics) {
+	let worst;
+	for (const d of diagnostics ?? []) {
+		if (worst === void 0 || RANK[d.severity] < RANK[worst]) worst = d.severity;
+		if (worst === "error") break;
+	}
+	return worst;
+}
+function identity(d) {
+	return `${d.elementId}\u0000${d.key ?? ""}\u0000${d.message}`;
+}
+/**
+* The union of several lists, in order, without duplicates: diagnostics with the same
+* `(elementId, key, message)` count once, keeping the first one's position and the most severe
+* severity among them.
+*/
+function mergeDiagnostics(lists) {
+	const result = [];
+	const index = /* @__PURE__ */ new Map();
+	for (const list of lists) for (const d of list ?? []) {
+		const id = identity(d);
+		const at = index.get(id);
+		if (at === void 0) {
+			index.set(id, result.length);
+			result.push(d);
+		} else if (RANK[d.severity] < RANK[result[at].severity]) result[at] = {
+			...result[at],
+			severity: d.severity
+		};
+	}
+	return result;
+}
+/** Diagnostics by element (or link) id, each list in the input order. */
+function groupDiagnostics(diagnostics) {
+	const map = /* @__PURE__ */ new Map();
+	for (const d of diagnostics ?? []) {
+		const list = map.get(d.elementId);
+		if (list) list.push(d);
+		else map.set(d.elementId, [d]);
+	}
+	return map;
+}
+const NONE = [];
+function createDiagnosticsStore() {
+	const bySource = /* @__PURE__ */ new Map();
+	const listeners = /* @__PURE__ */ new Set();
+	let merged = NONE;
+	const changed = () => {
+		merged = bySource.size === 0 ? NONE : mergeDiagnostics(bySource.values());
+		for (const listener of listeners) listener();
+	};
+	return {
+		publish(source, diagnostics) {
+			if (diagnostics.length === 0) {
+				if (bySource.delete(source)) changed();
+				return;
+			}
+			bySource.set(source, diagnostics.map((d) => d.source === void 0 ? {
+				...d,
+				source
+			} : d));
+			changed();
+		},
+		clear(source) {
+			if (source === void 0) {
+				if (bySource.size === 0) return;
+				bySource.clear();
+			} else if (!bySource.delete(source)) return;
+			changed();
+		},
+		sources: () => [...bySource.keys()],
+		get: (source) => bySource.get(source) ?? NONE,
+		getAll: () => merged,
+		subscribe(listener) {
+			listeners.add(listener);
+			return () => listeners.delete(listener);
+		}
+	};
+}
+const LSP_SEVERITIES = [
+	"error",
+	"warning",
+	"info",
+	"hint"
+];
+function anchorOf(data) {
+	if (typeof data !== "object" || data === null) return {};
+	const record = data;
+	const elementId = typeof record.elementId === "string" ? record.elementId : typeof record.nodeId === "string" ? record.nodeId : void 0;
+	return {
+		...elementId ? { elementId } : {},
+		...typeof record.key === "string" ? { key: record.key } : {}
+	};
+}
+function convertLsp(d, options) {
+	const anchor = anchorOf(d.data);
+	const elementId = anchor.elementId ?? options.elementIdFor?.(d);
+	if (!elementId) return void 0;
+	const base = options.severityNumbering === "vscode" ? 0 : 1;
+	const severity = d.severity === void 0 ? "error" : LSP_SEVERITIES[d.severity - base] ?? "error";
+	const code = typeof d.code === "object" ? d.code.value : d.code;
+	return {
+		elementId,
+		...anchor.key !== void 0 ? { key: anchor.key } : {},
+		severity,
+		message: typeof d.message === "string" ? d.message : d.message.value,
+		...d.source !== void 0 ? { source: d.source } : {},
+		...d.range ? { range: d.range } : {},
+		...code !== void 0 ? { code: String(code) } : {},
+		...d.data !== void 0 ? { data: d.data } : {}
+	};
+}
+/**
+* One LSP diagnostic anchored by `data.elementId` (or `data.nodeId`), or `undefined` when it
+* names no element. For range-anchored diagnostics use `fromLspDiagnostics` with `elementIdFor`.
+*/
+function fromLspDiagnostic(diagnostic) {
+	return convertLsp(diagnostic, {});
+}
+/** LSP diagnostics as goal diagnostics; those that can't be anchored to an element are dropped. */
+function fromLspDiagnostics(diagnostics, options = {}) {
+	const result = [];
+	for (const d of diagnostics) {
+		const converted = convertLsp(d, options);
+		if (converted) result.push(converted);
+	}
+	return result;
+}
+/** One `{ nodeId, severity, message }` diagnostic, or `undefined` without a `nodeId`. */
+function fromNodeIdDiagnostic(diagnostic) {
+	const { nodeId, severity, ...rest } = diagnostic;
+	if (!nodeId) return void 0;
+	return {
+		...rest,
+		elementId: nodeId,
+		severity: Object.hasOwn(RANK, severity) ? severity : "info"
+	};
+}
+/**
+* `{ nodeId, severity, message }` diagnostics (MutRoSe) as goal diagnostics, dropping those
+* without a node: `store.publish('mutrose', fromNodeIdDiagnostics(message.diagnostics))`.
+*/
+function fromNodeIdDiagnostics(diagnostics) {
+	const result = [];
+	for (const d of diagnostics) {
+		const converted = fromNodeIdDiagnostic(d);
+		if (converted) result.push(converted);
+	}
+	return result;
+}
+//#endregion
 exports.ACTOR_KINDS = ACTOR_KINDS;
 exports.ACTOR_LINK_KINDS = ACTOR_LINK_KINDS;
 exports.CONTRIBUTION_LABELS = CONTRIBUTION_LABELS;
 exports.DEFAULT_DIAGRAM = DEFAULT_DIAGRAM;
 exports.DEFAULT_ELEMENT_SIZE = DEFAULT_ELEMENT_SIZE;
 exports.DEPENDENCY_LINK_KINDS = DEPENDENCY_LINK_KINDS;
+exports.DIAGNOSTIC_SEVERITIES = DIAGNOSTIC_SEVERITIES;
 exports.ELEMENT_KINDS = ELEMENT_KINDS;
 exports.FILE_METAMODEL_KEY = FILE_METAMODEL_KEY;
 exports.ISTAR_2_0 = ISTAR_2_0;
@@ -2054,7 +2225,9 @@ exports.addElement = addElement;
 exports.boolean = boolean;
 exports.canLink = canLink;
 exports.childrenOf = childrenOf;
+exports.compareSeverity = compareSeverity;
 exports.connect = connect;
+exports.createDiagnosticsStore = createDiagnosticsStore;
 exports.createEmptyModel = createEmptyModel;
 exports.createModelStore = createModelStore;
 exports.defaultIdGenerator = defaultIdGenerator;
@@ -2071,7 +2244,12 @@ exports.enumOf = enumOf;
 exports.extendMetamodel = extendMetamodel;
 exports.fileMetamodelExtension = fileMetamodelExtension;
 exports.fileMetamodelOf = fileMetamodelOf;
+exports.fromLspDiagnostic = fromLspDiagnostic;
+exports.fromLspDiagnostics = fromLspDiagnostics;
+exports.fromNodeIdDiagnostic = fromNodeIdDiagnostic;
+exports.fromNodeIdDiagnostics = fromNodeIdDiagnostics;
 exports.getSourceLayout = getSourceLayout;
+exports.groupDiagnostics = groupDiagnostics;
 exports.hostMetamodelOf = hostMetamodelOf;
 exports.inheritMetamodel = inheritMetamodel;
 exports.inheritSourceLayout = inheritSourceLayout;
@@ -2091,6 +2269,7 @@ exports.isNodeKindIn = isNodeKindIn;
 exports.isNodeLinkKind = isNodeLinkKind;
 exports.linkKindDefinition = linkKindDefinition;
 exports.linksOf = linksOf;
+exports.mergeDiagnostics = mergeDiagnostics;
 exports.metamodelOf = metamodelOf;
 exports.moveElement = moveElement;
 exports.nestElement = nestElement;
@@ -2112,5 +2291,6 @@ exports.validateModel = validateModel;
 exports.validateModelProperties = validateModelProperties;
 exports.withFileMetamodel = withFileMetamodel;
 exports.withMetamodel = withMetamodel;
+exports.worstDiagnosticSeverity = worstDiagnosticSeverity;
 
 //# sourceMappingURL=index.cjs.map