@istar-ts/actions 0.15.0 → 0.15.1

package/dist/index.d.cts

@@ -810,6 +810,20 @@ export interface MirrorStoreOptions<EK extends string = ElementKind, LK extends
   readonly historyLimit?: number;
   /** Hears a failed update (a transport fault, a file that doesn't parse). Default: ignored. */
   readonly onError?: (error: unknown) => void;
+  /**
+   * Shown until the remote's first `requestModel` answers, instead of an empty model (a parsed
+   * model, or a piStar file parsed the same way as a pushed one — see `metamodelFor`). Replaced
+   * once the remote answers, unless its model is equal.
+   */
+  readonly initial?: IstarModel<EK, LK> | PistarFile;
+  /**
+   * The metamodel a pushed or re-requested file is read with, resolved per file (e.g. by its
+   * `tool`, with `detectFramework`) instead of the fixed `metamodel`. Keeps the mirror itself
+   * dialect-agnostic: a host whose remote may switch a mirror's root metamodel (an iStar mirror
+   * shown a KAOS file after `store.replace`) passes this instead of `metamodel`. Default:
+   * every file is read with `metamodel` (today's behaviour).
+   */
+  readonly metamodelFor?: (file: PistarFile) => Metamodel<EK, LK>;
 }
 /**
  * A `ModelStore` whose model is the remote's. Reading (`getModel`, `subscribe`, `canLink`) works
@@ -919,6 +933,19 @@ export declare function createRemoteDispatcher<EK extends string = ElementKind,
 } = {
   readonly data: unknown;
 }>(port: MessagePortLike<E>): ActionDispatcher<EK, LK>;
+/**
+ * `dispatcher` as a `StoreActionDispatcher`, for a consumer that asks for its dirty state (a GLSP
+ * session over a host's dispatcher, `@istar-ts/glsp`'s `IstarSharedModel`). A dispatcher that has
+ * `isDirty` is returned as is (with a no-op `dispose` if it has none); one that doesn't (a
+ * `createRemoteDispatcher`, a mirror's) is wrapped, its dirty state tracked from the
+ * `setDirtyState` notifications it relays from then on: clean until the first one, since a remote
+ * dispatcher doesn't publish the state it had before. `dispose` stops tracking and never disposes
+ * the dispatcher itself, which stays its owner's (#249).
+ */
+export declare function withDirtyState<EK extends string = ElementKind, LK extends string = LinkKind>(dispatcher: ActionDispatcher<EK, LK> & {
+  isDirty?(): boolean;
+  dispose?(): void;
+}): StoreActionDispatcher<EK, LK>;
 //#endregion
 //#region src/index.d.ts
 /** Version of the action protocol this package speaks. */

package/dist/index.d.ts

@@ -810,6 +810,20 @@ export interface MirrorStoreOptions<EK extends string = ElementKind, LK extends
   readonly historyLimit?: number;
   /** Hears a failed update (a transport fault, a file that doesn't parse). Default: ignored. */
   readonly onError?: (error: unknown) => void;
+  /**
+   * Shown until the remote's first `requestModel` answers, instead of an empty model (a parsed
+   * model, or a piStar file parsed the same way as a pushed one — see `metamodelFor`). Replaced
+   * once the remote answers, unless its model is equal.
+   */
+  readonly initial?: IstarModel<EK, LK> | PistarFile;
+  /**
+   * The metamodel a pushed or re-requested file is read with, resolved per file (e.g. by its
+   * `tool`, with `detectFramework`) instead of the fixed `metamodel`. Keeps the mirror itself
+   * dialect-agnostic: a host whose remote may switch a mirror's root metamodel (an iStar mirror
+   * shown a KAOS file after `store.replace`) passes this instead of `metamodel`. Default:
+   * every file is read with `metamodel` (today's behaviour).
+   */
+  readonly metamodelFor?: (file: PistarFile) => Metamodel<EK, LK>;
 }
 /**
  * A `ModelStore` whose model is the remote's. Reading (`getModel`, `subscribe`, `canLink`) works
@@ -919,6 +933,19 @@ export declare function createRemoteDispatcher<EK extends string = ElementKind,
 } = {
   readonly data: unknown;
 }>(port: MessagePortLike<E>): ActionDispatcher<EK, LK>;
+/**
+ * `dispatcher` as a `StoreActionDispatcher`, for a consumer that asks for its dirty state (a GLSP
+ * session over a host's dispatcher, `@istar-ts/glsp`'s `IstarSharedModel`). A dispatcher that has
+ * `isDirty` is returned as is (with a no-op `dispose` if it has none); one that doesn't (a
+ * `createRemoteDispatcher`, a mirror's) is wrapped, its dirty state tracked from the
+ * `setDirtyState` notifications it relays from then on: clean until the first one, since a remote
+ * dispatcher doesn't publish the state it had before. `dispose` stops tracking and never disposes
+ * the dispatcher itself, which stays its owner's (#249).
+ */
+export declare function withDirtyState<EK extends string = ElementKind, LK extends string = LinkKind>(dispatcher: ActionDispatcher<EK, LK> & {
+  isDirty?(): boolean;
+  dispose?(): void;
+}): StoreActionDispatcher<EK, LK>;
 //#endregion
 //#region src/index.d.ts
 /** Version of the action protocol this package speaks. */

package/dist/index.js

@@ -1249,10 +1249,19 @@ const parseWith = parsePistar;
 function createMirrorStore(remote, options = {}) {
 	const r = remote;
 	const metamodel = options.metamodel;
+	const metamodelFor = options.metamodelFor;
 	const limit = options.historyLimit ?? 100;
 	const onError = options.onError ?? (() => {});
 	const listeners = /* @__PURE__ */ new Set();
-	let model = metamodel ? createEmptyModel(void 0, { metamodel }) : createEmptyModel();
+	const parseFile = (file) => {
+		const base = metamodelFor ? metamodelFor(file) : metamodel;
+		return parseWith(file, {
+			...base ? { metamodel: base } : {},
+			...options.fileMetamodel ? { fileMetamodel: true } : {}
+		});
+	};
+	const initial = options.initial;
+	let model = (initial === void 0 ? void 0 : initial.elements instanceof Map ? initial : parseFile(initial)) ?? (metamodel ? createEmptyModel(void 0, { metamodel }) : createEmptyModel());
 	/** The last file's `"metamodel"` block, as JSON; `undefined` before the first file. */
 	let block;
 	let undoDepth = 0;
@@ -1264,11 +1273,9 @@ function createMirrorStore(remote, options = {}) {
 	let disposed = false;
 	const parse = (file) => {
 		const nextBlock = JSON.stringify(file[FILE_METAMODEL_KEY] ?? null);
-		if (nextBlock === block) return inheritMetamodel(model, parseWith(file, { metamodel: metamodelOf(model) }));
-		const parsed = parseWith(file, {
-			...metamodel ? { metamodel } : {},
-			...options.fileMetamodel ? { fileMetamodel: true } : {}
-		});
+		const root = metamodelFor?.(file);
+		if (nextBlock === block && (!metamodelFor || root === metamodelOf(model))) return inheritMetamodel(model, parseWith(file, { metamodel: metamodelOf(model) }));
+		const parsed = parseFile(file);
 		block = nextBlock;
 		return parsed;
 	};
@@ -1518,11 +1525,44 @@ function createRemoteDispatcher(port) {
 		}
 	};
 }
+/**
+* `dispatcher` as a `StoreActionDispatcher`, for a consumer that asks for its dirty state (a GLSP
+* session over a host's dispatcher, `@istar-ts/glsp`'s `IstarSharedModel`). A dispatcher that has
+* `isDirty` is returned as is (with a no-op `dispose` if it has none); one that doesn't (a
+* `createRemoteDispatcher`, a mirror's) is wrapped, its dirty state tracked from the
+* `setDirtyState` notifications it relays from then on: clean until the first one, since a remote
+* dispatcher doesn't publish the state it had before. `dispose` stops tracking and never disposes
+* the dispatcher itself, which stays its owner's (#249).
+*/
+function withDirtyState(dispatcher) {
+	const own = dispatcher.isDirty;
+	if (typeof own === "function") {
+		if (typeof dispatcher.dispose === "function") return dispatcher;
+		return {
+			dispatch: (action, options) => dispatcher.dispatch(action, options),
+			subscribe: (listener) => dispatcher.subscribe(listener),
+			isDirty: () => own.call(dispatcher),
+			dispose: () => void 0
+		};
+	}
+	let dirty = false;
+	const unsubscribe = dispatcher.subscribe((action) => {
+		if (action.kind === "setDirtyState") dirty = action.isDirty;
+	});
+	return {
+		dispatch: (action, options) => dispatcher.dispatch(action, options),
+		subscribe: (listener) => dispatcher.subscribe(listener),
+		isDirty: () => dirty,
+		dispose: () => {
+			unsubscribe();
+		}
+	};
+}
 //#endregion
 //#region src/index.ts
 /** Version of the action protocol this package speaks. */
 const ACTIONS_PROTOCOL_VERSION = "0.0.0";
 //#endregion
-export { ACTIONS_PROTOCOL_VERSION, HANDLED_ACTION_KINDS, connectDispatcher, contextActionsFor, contextText, createActionDispatcher, createMirrorStore, createRemoteDispatcher, diagnosticToMarker, hostToolContext, injectCreatedIds, isOperation, isRequestAction, markerToDiagnostic, metamodelContext, metamodelContextProvider, metamodelContextText, paletteFromMetamodel, readOnlyDispatcher, typeHintsFor };
+export { ACTIONS_PROTOCOL_VERSION, HANDLED_ACTION_KINDS, connectDispatcher, contextActionsFor, contextText, createActionDispatcher, createMirrorStore, createRemoteDispatcher, diagnosticToMarker, hostToolContext, injectCreatedIds, isOperation, isRequestAction, markerToDiagnostic, metamodelContext, metamodelContextProvider, metamodelContextText, paletteFromMetamodel, readOnlyDispatcher, typeHintsFor, withDirtyState };
 
 //# sourceMappingURL=index.js.map