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

package/dist/index.d.cts

@@ -2,6 +2,10 @@ import { AnyIstarModel, AnyMetamodel, AnyPaletteDescription, CustomProperties, D
 //#region src/actions.d.ts
 /** GLSP's custom arguments: a flat map of primitives. */
 export type Args = Readonly<Record<string, string | number | boolean>>;
+/** A value that survives a JSON round trip, for `istar.updateModelExtra`'s `set`. */
+export type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
+  readonly [key: string]: JsonValue;
+};
 export interface Point {
   readonly x: number;
   readonly y: number;
@@ -243,8 +247,35 @@ export interface SetFileMetamodelOperation extends Operation {
   readonly kind: "istar.setFileMetamodel";
   readonly block: FileMetamodel | null;
 }
+/**
+ * Sets, removes or reads back the model's own top-level keys that core keeps in `model.extra`
+ * (e.g. a dialect's `metamodelVersion`): `set`'s keys are written (other extra keys and their
+ * order are kept; a new key is appended where `toPistar` would place it), `remove`'s keys are
+ * deleted. `tool` sets (or, with `null`, removes) the model's own `tool` field in the same undo
+ * step — `set`/`remove` reject it, and every key core models itself (`actors`, `orphans`,
+ * `dependencies`, `links`, `display`, `istar`, `saveDate`, `diagram`), and `"metamodel"` (use
+ * `istar.setFileMetamodel` for that one). One undo step.
+ */
+export interface UpdateModelExtraOperation extends Operation {
+  readonly kind: "istar.updateModelExtra";
+  readonly set?: Readonly<Record<string, JsonValue>>;
+  readonly remove?: readonly string[];
+  readonly tool?: string | null;
+}
+/**
+ * Replaces the whole model from a piStar save file, as one undo step: ids, order and extra keys
+ * come from `model`, so a parse → `toPistar` round trip is byte-identical to it. Parsed with
+ * `parsePistar` under the dispatcher's own metamodel (`fileMetamodel` as in `parsePistar`); a
+ * parse error rejects with a typed diagnostic, the model untouched. Pre-guards and postGuards
+ * run against this operation, the model before and the model after, like any other operation.
+ */
+export interface ReplaceModelOperation extends Operation {
+  readonly kind: "istar.replaceModel";
+  readonly model: PistarFile;
+  readonly fileMetamodel?: boolean;
+}
 /** Every operation, keyed by `kind`. */
-export type IstarOperation<EK extends string = ElementKind, LK extends string = LinkKind> = CreateNodeOperation<EK> | CreateEdgeOperation<EK, LK> | DeleteElementOperation | ChangeBoundsOperation | ChangeContainerOperation | ReconnectEdgeOperation | ApplyLabelEditOperation | CompoundOperation<EK, LK> | AddLegOperation | RemoveLegOperation | SetCollapsedOperation | UpdateDiagramOperation | UpdatePropertiesOperation | UpdateDisplayOperation | SetLinkValueOperation | UpdateLinkDisplayOperation | ChangeLinkKindOperation<LK> | SetFileMetamodelOperation;
+export type IstarOperation<EK extends string = ElementKind, LK extends string = LinkKind> = CreateNodeOperation<EK> | CreateEdgeOperation<EK, LK> | DeleteElementOperation | ChangeBoundsOperation | ChangeContainerOperation | ReconnectEdgeOperation | ApplyLabelEditOperation | CompoundOperation<EK, LK> | AddLegOperation | RemoveLegOperation | SetCollapsedOperation | UpdateDiagramOperation | UpdatePropertiesOperation | UpdateDisplayOperation | SetLinkValueOperation | UpdateLinkDisplayOperation | ChangeLinkKindOperation<LK> | SetFileMetamodelOperation | UpdateModelExtraOperation | ReplaceModelOperation;
 export interface RequestModelAction extends RequestAction {
   readonly kind: "requestModel";
   readonly options?: Args;
@@ -281,6 +312,11 @@ export interface ModelSourceChangedAction extends Action {
    * created with `sendModel`). An iStar extra; a mirror uses this to know the exact state.
    */
   readonly canRedo?: boolean;
+  /**
+   * The `origin` the causing `dispatch` was given, echoed back; absent for a change with none
+   * (a host's direct `store.load`, for instance). See `ActionDispatcher.dispatch`.
+   */
+  readonly origin?: string;
 }
 /** Saves the model through the host's `save` callback. */
 export interface SaveModelAction extends Action {
@@ -293,6 +329,8 @@ export interface SetDirtyStateAction extends Action {
   readonly kind: "setDirtyState";
   readonly isDirty: boolean;
   readonly reason?: DirtyStateChangeReason;
+  /** The `origin` of the dispatch that caused this dirty-state change, echoed back; see `ModelSourceChangedAction.origin`. */
+  readonly origin?: string;
 }
 export interface UndoAction extends Action {
   readonly kind: "glspUndo";
@@ -489,8 +527,31 @@ export type ActionListener<EK extends string = ElementKind, LK extends string =
  * Sends actions and hears what the other side sends back. Implemented in-process by
  * `createActionDispatcher`; a transport implements it over a message port.
  */
+/** `dispatch`'s second argument. */
+export interface DispatchOptions {
+  /**
+   * Echoed back as `origin` on every `ModelSourceChangedAction` and `SetDirtyStateAction` this
+   * dispatch causes (each change of a compound, both events of an undo or redo), so a listener
+   * can tell which surface or client made a change without tracking it itself. Carried through
+   * `createRemoteDispatcher`/`connectDispatcher` and by `createMirrorStore`'s dispatcher, so it
+   * survives a round trip to a remote host. Optional: a change with no origin (a host's direct
+   * `store.load`, for instance) has none.
+   */
+  readonly origin?: string;
+}
 export interface ActionDispatcher<EK extends string = ElementKind, LK extends string = LinkKind> {
-  dispatch<A extends IstarAction<EK, LK>>(action: A): Promise<ActionResult<ResponseFor<A>>>;
+  /**
+   * For a **local** dispatcher (`createActionDispatcher`), an operation, `glspUndo`/`glspRedo`,
+   * and the guards and postGuards around them, are applied to the store and every listener
+   * (`subscribe`, the store's own) is notified synchronously, before this call's promise is
+   * created to resolve — only `saveModel` awaits. Code that needs to see the result of an action
+   * before its own next statement (not just before `await dispatch(...)` resolves) can rely on
+   * this for a local dispatcher; it does **not** hold across a `createRemoteDispatcher`/
+   * `connectDispatcher` transport or a `createMirrorStore` mirror, where a change always arrives
+   * after a message round trip. Use `origin` ({@link DispatchOptions}) instead where that
+   * portability matters — it is carried through both.
+   */
+  dispatch<A extends IstarAction<EK, LK>>(action: A, options?: DispatchOptions): Promise<ActionResult<ResponseFor<A>>>;
   /**
    * Hears the actions the dispatcher sends: `ModelSourceChangedAction` after every model change,
    * `SetDirtyStateAction` when the dirty state flips, and the notifications dispatched to it.
@@ -724,6 +785,8 @@ export interface JsonRpcRequest {
   readonly id: JsonRpcId;
   readonly method: string;
   readonly params?: unknown;
+  /** The dispatch's `origin` (`DispatchOptions.origin`), carried to the server's `dispatch`. */
+  readonly origin?: string;
 }
 /** A subscriber event, sent with no `id`: it expects no response. */
 export interface JsonRpcNotification {

package/dist/index.d.ts

@@ -2,6 +2,10 @@ import { AnyIstarModel, AnyMetamodel, AnyPaletteDescription, CustomProperties, D
 //#region src/actions.d.ts
 /** GLSP's custom arguments: a flat map of primitives. */
 export type Args = Readonly<Record<string, string | number | boolean>>;
+/** A value that survives a JSON round trip, for `istar.updateModelExtra`'s `set`. */
+export type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
+  readonly [key: string]: JsonValue;
+};
 export interface Point {
   readonly x: number;
   readonly y: number;
@@ -243,8 +247,35 @@ export interface SetFileMetamodelOperation extends Operation {
   readonly kind: "istar.setFileMetamodel";
   readonly block: FileMetamodel | null;
 }
+/**
+ * Sets, removes or reads back the model's own top-level keys that core keeps in `model.extra`
+ * (e.g. a dialect's `metamodelVersion`): `set`'s keys are written (other extra keys and their
+ * order are kept; a new key is appended where `toPistar` would place it), `remove`'s keys are
+ * deleted. `tool` sets (or, with `null`, removes) the model's own `tool` field in the same undo
+ * step — `set`/`remove` reject it, and every key core models itself (`actors`, `orphans`,
+ * `dependencies`, `links`, `display`, `istar`, `saveDate`, `diagram`), and `"metamodel"` (use
+ * `istar.setFileMetamodel` for that one). One undo step.
+ */
+export interface UpdateModelExtraOperation extends Operation {
+  readonly kind: "istar.updateModelExtra";
+  readonly set?: Readonly<Record<string, JsonValue>>;
+  readonly remove?: readonly string[];
+  readonly tool?: string | null;
+}
+/**
+ * Replaces the whole model from a piStar save file, as one undo step: ids, order and extra keys
+ * come from `model`, so a parse → `toPistar` round trip is byte-identical to it. Parsed with
+ * `parsePistar` under the dispatcher's own metamodel (`fileMetamodel` as in `parsePistar`); a
+ * parse error rejects with a typed diagnostic, the model untouched. Pre-guards and postGuards
+ * run against this operation, the model before and the model after, like any other operation.
+ */
+export interface ReplaceModelOperation extends Operation {
+  readonly kind: "istar.replaceModel";
+  readonly model: PistarFile;
+  readonly fileMetamodel?: boolean;
+}
 /** Every operation, keyed by `kind`. */
-export type IstarOperation<EK extends string = ElementKind, LK extends string = LinkKind> = CreateNodeOperation<EK> | CreateEdgeOperation<EK, LK> | DeleteElementOperation | ChangeBoundsOperation | ChangeContainerOperation | ReconnectEdgeOperation | ApplyLabelEditOperation | CompoundOperation<EK, LK> | AddLegOperation | RemoveLegOperation | SetCollapsedOperation | UpdateDiagramOperation | UpdatePropertiesOperation | UpdateDisplayOperation | SetLinkValueOperation | UpdateLinkDisplayOperation | ChangeLinkKindOperation<LK> | SetFileMetamodelOperation;
+export type IstarOperation<EK extends string = ElementKind, LK extends string = LinkKind> = CreateNodeOperation<EK> | CreateEdgeOperation<EK, LK> | DeleteElementOperation | ChangeBoundsOperation | ChangeContainerOperation | ReconnectEdgeOperation | ApplyLabelEditOperation | CompoundOperation<EK, LK> | AddLegOperation | RemoveLegOperation | SetCollapsedOperation | UpdateDiagramOperation | UpdatePropertiesOperation | UpdateDisplayOperation | SetLinkValueOperation | UpdateLinkDisplayOperation | ChangeLinkKindOperation<LK> | SetFileMetamodelOperation | UpdateModelExtraOperation | ReplaceModelOperation;
 export interface RequestModelAction extends RequestAction {
   readonly kind: "requestModel";
   readonly options?: Args;
@@ -281,6 +312,11 @@ export interface ModelSourceChangedAction extends Action {
    * created with `sendModel`). An iStar extra; a mirror uses this to know the exact state.
    */
   readonly canRedo?: boolean;
+  /**
+   * The `origin` the causing `dispatch` was given, echoed back; absent for a change with none
+   * (a host's direct `store.load`, for instance). See `ActionDispatcher.dispatch`.
+   */
+  readonly origin?: string;
 }
 /** Saves the model through the host's `save` callback. */
 export interface SaveModelAction extends Action {
@@ -293,6 +329,8 @@ export interface SetDirtyStateAction extends Action {
   readonly kind: "setDirtyState";
   readonly isDirty: boolean;
   readonly reason?: DirtyStateChangeReason;
+  /** The `origin` of the dispatch that caused this dirty-state change, echoed back; see `ModelSourceChangedAction.origin`. */
+  readonly origin?: string;
 }
 export interface UndoAction extends Action {
   readonly kind: "glspUndo";
@@ -489,8 +527,31 @@ export type ActionListener<EK extends string = ElementKind, LK extends string =
  * Sends actions and hears what the other side sends back. Implemented in-process by
  * `createActionDispatcher`; a transport implements it over a message port.
  */
+/** `dispatch`'s second argument. */
+export interface DispatchOptions {
+  /**
+   * Echoed back as `origin` on every `ModelSourceChangedAction` and `SetDirtyStateAction` this
+   * dispatch causes (each change of a compound, both events of an undo or redo), so a listener
+   * can tell which surface or client made a change without tracking it itself. Carried through
+   * `createRemoteDispatcher`/`connectDispatcher` and by `createMirrorStore`'s dispatcher, so it
+   * survives a round trip to a remote host. Optional: a change with no origin (a host's direct
+   * `store.load`, for instance) has none.
+   */
+  readonly origin?: string;
+}
 export interface ActionDispatcher<EK extends string = ElementKind, LK extends string = LinkKind> {
-  dispatch<A extends IstarAction<EK, LK>>(action: A): Promise<ActionResult<ResponseFor<A>>>;
+  /**
+   * For a **local** dispatcher (`createActionDispatcher`), an operation, `glspUndo`/`glspRedo`,
+   * and the guards and postGuards around them, are applied to the store and every listener
+   * (`subscribe`, the store's own) is notified synchronously, before this call's promise is
+   * created to resolve — only `saveModel` awaits. Code that needs to see the result of an action
+   * before its own next statement (not just before `await dispatch(...)` resolves) can rely on
+   * this for a local dispatcher; it does **not** hold across a `createRemoteDispatcher`/
+   * `connectDispatcher` transport or a `createMirrorStore` mirror, where a change always arrives
+   * after a message round trip. Use `origin` ({@link DispatchOptions}) instead where that
+   * portability matters — it is carried through both.
+   */
+  dispatch<A extends IstarAction<EK, LK>>(action: A, options?: DispatchOptions): Promise<ActionResult<ResponseFor<A>>>;
   /**
    * Hears the actions the dispatcher sends: `ModelSourceChangedAction` after every model change,
    * `SetDirtyStateAction` when the dirty state flips, and the notifications dispatched to it.
@@ -724,6 +785,8 @@ export interface JsonRpcRequest {
   readonly id: JsonRpcId;
   readonly method: string;
   readonly params?: unknown;
+  /** The dispatch's `origin` (`DispatchOptions.origin`), carried to the server's `dispatch`. */
+  readonly origin?: string;
 }
 /** A subscriber event, sent with no `id`: it expects no response. */
 export interface JsonRpcNotification {

package/dist/index.js

@@ -1,4 +1,4 @@
-import { DIAGNOSTIC_SEVERITIES, FILE_METAMODEL_KEY, LINK_SELECTOR, MetamodelError, ModelOperationError, canLink, connectResultToDiagnostic, createEmptyModel, dependencyEnds, effectiveLinkKind, elementBehavesLike, inheritMetamodel, inheritSourceLayout, linkBehavesLike, metamodelOf, parsePistar, toPistarObject, validateModel, validateModelProperties, withFileMetamodel } from "@istar-ts/core";
+import { DIAGNOSTIC_SEVERITIES, FILE_METAMODEL_KEY, LINK_SELECTOR, MetamodelError, ModelOperationError, PistarParseError, TOP_LEVEL_KEYS, canLink, connectResultToDiagnostic, createEmptyModel, dependencyEnds, effectiveLinkKind, elementBehavesLike, hostMetamodelOf, inheritMetamodel, inheritSourceLayout, linkBehavesLike, metamodelOf, parsePistar, toPistarObject, validateModel, validateModelProperties, withFileMetamodel } from "@istar-ts/core";
 //#region src/actions.ts
 const OPERATION_KIND_LIST = [
 	"createNode",
@@ -18,7 +18,9 @@ const OPERATION_KIND_LIST = [
 	"istar.setLinkValue",
 	"istar.updateLinkDisplay",
 	"istar.changeLinkKind",
-	"istar.setFileMetamodel"
+	"istar.setFileMetamodel",
+	"istar.updateModelExtra",
+	"istar.replaceModel"
 ];
 const REQUEST_KIND_LIST = [
 	"requestModel",
@@ -275,6 +277,11 @@ function rejectCheck(check, endpoints) {
 function metaOf(model) {
 	return 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([...TOP_LEVEL_KEYS, FILE_METAMODEL_KEY]);
 /** A model with `links` changed, as the core operations derive one. */
 function withLinks(model, links) {
 	return inheritMetamodel(model, inheritSourceLayout(model, {
@@ -315,17 +322,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 = {
@@ -345,9 +360,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) => {
@@ -572,6 +588,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 === 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(inheritMetamodel(model, inheritSourceLayout(model, next)));
+				return;
+			}
+			case "istar.replaceModel": {
+				const host = hostMetamodelOf(model) ?? meta;
+				let next;
+				try {
+					next = parsePistar(operation.model, {
+						metamodel: host,
+						fileMetamodel: operation.fileMetamodel ?? false
+					});
+				} catch (error) {
+					if (error instanceof PistarParseError) reject(error.message, "", "parse-error");
+					throw error;
+				}
+				s.replace(next);
+				return;
+			}
 			default: reject(`unknown operation "${operation.kind}"`, "", "unknown-action");
 		}
 	};
@@ -584,7 +642,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 });
 	};
@@ -744,7 +803,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,
@@ -769,7 +828,7 @@ function createActionDispatcher(store, options = {}) {
 				const model = s.getModel();
 				await options.save(toPistarObject(model, { saveDate: /* @__PURE__ */ new Date() }), action);
 				saved = model;
-				updateDirty("save");
+				updateDirty("save", origin);
 				return {
 					ok: true,
 					createdIds: []
@@ -789,9 +848,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,
@@ -1015,8 +1082,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;
 			},
@@ -1102,8 +1169,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;
@@ -1114,10 +1182,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,
@@ -1161,7 +1229,7 @@ function createRemoteDispatcher(port) {
 		}
 	};
 	return {
-		dispatch(action) {
+		dispatch(action, dispatchOptions) {
 			const id = nextId++;
 			return new Promise((resolve, reject) => {
 				pending.set(id, {
@@ -1172,7 +1240,8 @@ function createRemoteDispatcher(port) {
 					jsonrpc: JSONRPC_VERSION,
 					id,
 					method: action.kind,
-					params: action
+					params: action,
+					...dispatchOptions?.origin === void 0 ? {} : { origin: dispatchOptions.origin }
 				});
 			});
 		},