@istar-ts/actions 0.15.0-beta.2 → 0.15.0-beta.4

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",
@@ -276,6 +278,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, {
@@ -316,17 +323,25 @@ function createActionDispatcher(store, options = {}) {
 	const listeners = /* @__PURE__ */ new Set();
 	let saved = s.getModel();
 	let dirty = false;
+	/**
+	* The origin of the dispatch currently applying synchronously (set by `dispatch`, around the
+	* synchronous part of `run`): what the store's subscription below echoes on
+	* `sourceModelChanged`/`setDirtyState`. `undefined` for a change not caused by a dispatch (a
+	* host's direct `store.load`) or once `run`'s synchronous part has returned.
+	*/
+	let currentOrigin;
 	const emit = (action) => {
 		for (const listener of listeners) listener(action);
 	};
-	const updateDirty = (reason) => {
+	const updateDirty = (reason, origin) => {
 		const next = s.getModel() !== saved;
 		if (next === dirty) return;
 		dirty = next;
 		emit({
 			kind: "setDirtyState",
 			isDirty: next,
-			reason
+			reason,
+			...origin === void 0 ? {} : { origin }
 		});
 	};
 	const REASONS = {
@@ -346,9 +361,10 @@ function createActionDispatcher(store, options = {}) {
 			...options.sendModel ? {
 				canUndo: s.canUndo(),
 				canRedo: s.canRedo()
-			} : {}
+			} : {},
+			...currentOrigin === void 0 ? {} : { origin: currentOrigin }
 		});
-		updateDirty(REASONS[event.source]);
+		updateDirty(REASONS[event.source], currentOrigin);
 	});
 	const requireElement = (id) => s.getModel().elements.get(id) ?? reject(`unknown element "${id}"`, id, "unknown-element");
 	const runGuards = (operation, warnings) => {
@@ -573,6 +589,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");
 		}
 	};
@@ -585,7 +643,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 });
 	};
@@ -745,7 +804,7 @@ function createActionDispatcher(store, options = {}) {
 			default: return;
 		}
 	};
-	const run = async (action) => {
+	const run = async (action, origin) => {
 		if (isOperation(action)) return runOperation(action);
 		if (isRequestAction(action)) return {
 			ok: true,
@@ -770,7 +829,7 @@ function createActionDispatcher(store, options = {}) {
 				const model = s.getModel();
 				await options.save((0, _istar_ts_core.toPistarObject)(model, { saveDate: /* @__PURE__ */ new Date() }), action);
 				saved = model;
-				updateDirty("save");
+				updateDirty("save", origin);
 				return {
 					ok: true,
 					createdIds: []
@@ -790,9 +849,17 @@ function createActionDispatcher(store, options = {}) {
 		}
 	};
 	return {
-		async dispatch(action) {
+		async dispatch(action, dispatchOptions) {
+			const origin = dispatchOptions?.origin;
+			currentOrigin = origin;
+			let pending;
+			try {
+				pending = run(action, origin);
+			} finally {
+				currentOrigin = void 0;
+			}
 			try {
-				return await run(action);
+				return await pending;
 			} catch (error) {
 				if (error instanceof Rejection) return {
 					ok: false,
@@ -1016,8 +1083,8 @@ function createMirrorStore(remote, options = {}) {
 	return {
 		ready,
 		dispatcher: {
-			async dispatch(action) {
-				const result = await r.dispatch(action);
+			async dispatch(action, options) {
+				const result = await r.dispatch(action, options);
 				await tail;
 				return result;
 			},
@@ -1103,8 +1170,9 @@ function connectDispatcher(port, dispatcher) {
 	port.onmessage = (ev) => {
 		const message = ev.data;
 		if (!isRecord(message) || message.jsonrpc !== JSONRPC_VERSION) return;
-		const { id, method, params } = message;
+		const { id, method, params, origin } = message;
 		const hasId = isJsonRpcId(id);
+		const dispatchOptions = typeof origin === "string" ? { origin } : void 0;
 		if (typeof method !== "string" || method.length === 0) {
 			if (hasId) port.postMessage(errorMessage(id, -32601, "method not found"));
 			return;
@@ -1115,10 +1183,10 @@ function connectDispatcher(port, dispatcher) {
 		}
 		const action = params;
 		if (!hasId) {
-			dispatcher.dispatch(action);
+			dispatcher.dispatch(action, dispatchOptions);
 			return;
 		}
-		dispatcher.dispatch(action).then((result) => {
+		dispatcher.dispatch(action, dispatchOptions).then((result) => {
 			port.postMessage({
 				jsonrpc: JSONRPC_VERSION,
 				id,
@@ -1162,7 +1230,7 @@ function createRemoteDispatcher(port) {
 		}
 	};
 	return {
-		dispatch(action) {
+		dispatch(action, dispatchOptions) {
 			const id = nextId++;
 			return new Promise((resolve, reject) => {
 				pending.set(id, {
@@ -1173,7 +1241,8 @@ function createRemoteDispatcher(port) {
 					jsonrpc: JSONRPC_VERSION,
 					id,
 					method: action.kind,
-					params: action
+					params: action,
+					...dispatchOptions?.origin === void 0 ? {} : { origin: dispatchOptions.origin }
 				});
 			});
 		},