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

package/dist/index.d.cts

@@ -281,6 +281,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 +298,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 +496,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 +754,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

@@ -281,6 +281,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 +298,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 +496,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 +754,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

@@ -315,17 +315,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 +353,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) => {
@@ -744,7 +753,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 +778,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 +798,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 +1032,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 +1119,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 +1132,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 +1179,7 @@ function createRemoteDispatcher(port) {
 		}
 	};
 	return {
-		dispatch(action) {
+		dispatch(action, dispatchOptions) {
 			const id = nextId++;
 			return new Promise((resolve, reject) => {
 				pending.set(id, {
@@ -1172,7 +1190,8 @@ function createRemoteDispatcher(port) {
 					jsonrpc: JSONRPC_VERSION,
 					id,
 					method: action.kind,
-					params: action
+					params: action,
+					...dispatchOptions?.origin === void 0 ? {} : { origin: dispatchOptions.origin }
 				});
 			});
 		},