@istar-ts/actions 0.15.0-beta.3 → 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;

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;

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, {
@@ -581,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");
 		}
 	};
@@ -593,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 });
 	};