@istar-ts/actions 0.15.0-beta.3 → 0.15.0-beta.5

package/dist/index.cjs

@@ -19,7 +19,9 @@ const OPERATION_KIND_LIST = [
 	"istar.setLinkValue",
 	"istar.updateLinkDisplay",
 	"istar.changeLinkKind",
-	"istar.setFileMetamodel"
+	"istar.setFileMetamodel",
+	"istar.updateModelExtra",
+	"istar.replaceModel"
 ];
 const REQUEST_KIND_LIST = [
 	"requestModel",
@@ -64,6 +66,141 @@ function isRequestAction(action) {
 	return REQUEST_KINDS.has(action.kind);
 }
 //#endregion
+//#region src/created-ids.ts
+/** How many new element ids, then new link ids, `operation` creates, mirroring the dispatcher's
+* `createdIds` diff (`dispatcher.ts`) and `connect`/`addDependency`/`addLeg`
+* (`packages/core/src/operations.ts`). */
+function countCreatedIds(operation, model) {
+	switch (operation.kind) {
+		case "createNode": return {
+			elements: 1,
+			links: 0
+		};
+		case "createEdge": {
+			const metamodel = (0, _istar_ts_core.metamodelOf)(model);
+			const definition = metamodel.links.get(operation.elementTypeId);
+			if (definition?.category === "dependency") return {
+				elements: 1,
+				links: 2
+			};
+			if (definition?.parts && !targetIsHub(operation, model, metamodel)) return {
+				elements: 1,
+				links: 2
+			};
+			return {
+				elements: 0,
+				links: 1
+			};
+		}
+		case "istar.addLeg": return {
+			elements: 0,
+			links: 1
+		};
+		case "compound": {
+			let elements = 0;
+			let links = 0;
+			for (const child of operation.operationList) {
+				const counts = countCreatedIds(child, model);
+				elements += counts.elements;
+				links += counts.links;
+			}
+			return {
+				elements,
+				links
+			};
+		}
+		default: return {
+			elements: 0,
+			links: 0
+		};
+	}
+}
+function targetIsHub(operation, model, metamodel) {
+	const targetKind = model.elements.get(operation.targetElementId)?.kind;
+	return targetKind !== void 0 && metamodel.elements.get(targetKind)?.role === "hub";
+}
+/** `operation` with ids from `elementIds`/`linkIds` (consumed in model order) injected as the
+* explicit ids its creates take, so a dispatcher that applies it against the same model state
+* creates the same ids. */
+function withCreatedIds(operation, elementIds, linkIds, model) {
+	switch (operation.kind) {
+		case "createNode": {
+			const id = elementIds.shift();
+			return id === void 0 ? operation : {
+				...operation,
+				args: {
+					...operation.args,
+					id
+				}
+			};
+		}
+		case "createEdge": {
+			const metamodel = (0, _istar_ts_core.metamodelOf)(model);
+			const definition = metamodel.links.get(operation.elementTypeId);
+			if (definition?.category === "dependency") {
+				const dependumId = elementIds.shift();
+				const linkIds2 = [linkIds.shift(), linkIds.shift()];
+				if (dependumId === void 0 || linkIds2[0] === void 0 || linkIds2[1] === void 0) return operation;
+				return {
+					...operation,
+					args: {
+						...operation.args,
+						dependum: {
+							...operation.args?.dependum,
+							id: dependumId
+						},
+						linkIds: linkIds2
+					}
+				};
+			}
+			if (definition?.parts && !targetIsHub(operation, model, metamodel)) {
+				const hubId = elementIds.shift();
+				const legId = linkIds.shift();
+				const endId = linkIds.shift();
+				return hubId === void 0 || legId === void 0 || endId === void 0 ? operation : {
+					...operation,
+					args: {
+						...operation.args,
+						id: hubId,
+						legId,
+						endId
+					}
+				};
+			}
+			const id = linkIds.shift();
+			return id === void 0 ? operation : {
+				...operation,
+				args: {
+					...operation.args,
+					id
+				}
+			};
+		}
+		case "istar.addLeg": {
+			const id = linkIds.shift();
+			return id === void 0 ? operation : {
+				...operation,
+				args: {
+					...operation.args,
+					id
+				}
+			};
+		}
+		case "compound": return {
+			...operation,
+			operationList: operation.operationList.map((child) => withCreatedIds(child, elementIds, linkIds, model))
+		};
+		default: return operation;
+	}
+}
+/** `operation`, with `createdIds` (an accepted result's) injected as explicit ids. */
+function injectCreatedIds(operation, createdIds, model) {
+	const counts = countCreatedIds(operation, model);
+	const elementIds = createdIds.slice(0, counts.elements);
+	const linkIds = createdIds.slice(counts.elements, counts.elements + counts.links);
+	return withCreatedIds(operation, [...elementIds], [...linkIds], model);
+}
+//#endregion
 //#region src/hints.ts
 /**
 * What a client can know before it asks: type hints from the metamodel, and the palette as
@@ -276,6 +413,11 @@ function rejectCheck(check, endpoints) {
 function metaOf(model) {
 	return (0, _istar_ts_core.metamodelOf)(model);
 }
+/**
+* Keys `istar.updateModelExtra`'s `set`/`remove` must not touch: every key core models itself
+* (`TOP_LEVEL_KEYS`, which includes `tool`), and `"metamodel"` (`istar.setFileMetamodel`'s own).
+*/
+const RESERVED_EXTRA_KEYS = /* @__PURE__ */ new Set([..._istar_ts_core.TOP_LEVEL_KEYS, _istar_ts_core.FILE_METAMODEL_KEY]);
 /** A model with `links` changed, as the core operations derive one. */
 function withLinks(model, links) {
 	return (0, _istar_ts_core.inheritMetamodel)(model, (0, _istar_ts_core.inheritSourceLayout)(model, {
@@ -582,6 +724,48 @@ function createActionDispatcher(store, options = {}) {
 				s.replace(next);
 				return;
 			}
+			case "istar.updateModelExtra": {
+				const { set, remove, tool } = operation;
+				for (const key of [...Object.keys(set ?? {}), ...remove ?? []]) {
+					if (!RESERVED_EXTRA_KEYS.has(key)) continue;
+					if (key === "tool") reject(`"tool" is a modelled field: set it with this operation's own "tool"`, "", "reserved-key");
+					if (key === _istar_ts_core.FILE_METAMODEL_KEY) reject(`"${key}" is set with istar.setFileMetamodel, not updateModelExtra`, "", "reserved-key");
+					reject(`"${key}" is modelled by the file itself and cannot be an extra key`, "", "reserved-key");
+				}
+				let withTool = model;
+				if (tool === null) {
+					const { tool: _tool, ...rest } = withTool;
+					withTool = rest;
+				} else if (tool !== void 0) withTool = {
+					...withTool,
+					tool
+				};
+				const extra = { ...withTool.extra };
+				if (set) for (const [key, value] of Object.entries(set)) extra[key] = value;
+				if (remove) for (const key of remove) delete extra[key];
+				const { extra: _extra, ...rest } = withTool;
+				const next = {
+					...rest,
+					...Object.keys(extra).length > 0 ? { extra } : {}
+				};
+				s.replace((0, _istar_ts_core.inheritMetamodel)(model, (0, _istar_ts_core.inheritSourceLayout)(model, next)));
+				return;
+			}
+			case "istar.replaceModel": {
+				const host = (0, _istar_ts_core.hostMetamodelOf)(model) ?? meta;
+				let next;
+				try {
+					next = (0, _istar_ts_core.parsePistar)(operation.model, {
+						metamodel: host,
+						fileMetamodel: operation.fileMetamodel ?? false
+					});
+				} catch (error) {
+					if (error instanceof _istar_ts_core.PistarParseError) reject(error.message, "", "parse-error");
+					throw error;
+				}
+				s.replace(next);
+				return;
+			}
 			default: reject(`unknown operation "${operation.kind}"`, "", "unknown-action");
 		}
 	};
@@ -594,7 +778,8 @@ function createActionDispatcher(store, options = {}) {
 		for (const [key, value] of Object.entries(properties)) if (value === null) delete next[key];
 		else if (typeof value === "string") next[key] = value;
 		else reject(`the value of "${key}" must be a string or null`, id, "invalid-value");
-		const customProperties = Object.keys(next).length > 0 ? next : null;
+		if (Object.keys(next).length === 0 && owner.customProperties === void 0) return;
+		const customProperties = next;
 		if (model.elements.has(id)) s.updateElement(id, { customProperties });
 		else s.updateLink(id, { customProperties });
 	};
@@ -1217,6 +1402,7 @@ exports.createMirrorStore = createMirrorStore;
 exports.createRemoteDispatcher = createRemoteDispatcher;
 exports.diagnosticToMarker = diagnosticToMarker;
 exports.hostToolContext = hostToolContext;
+exports.injectCreatedIds = injectCreatedIds;
 exports.isOperation = isOperation;
 exports.isRequestAction = isRequestAction;
 exports.markerToDiagnostic = markerToDiagnostic;