@jigs.design/client 0.3.4 → 0.3.5

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { CallReply, HeadersOption, HttpTransportOptions, Transport, TransportError, httpTransport } from "./transport.js";
 import { ClientOptions, ConfirmFunction, JigsClient, PageData, PageResult, createJigsClient } from "./client.js";
-import { ActionCall, ActionHandler, ViewController, ViewIssue, ViewStatus, createViewController, missingComponents } from "./view/controller.js";
+import { ActionCall, ActionHandler, MutationEvent, MutationHandler, ViewController, ViewIssue, ViewStatus, createViewController, missingComponents } from "./view/controller.js";
 import { Diagnostic, Invalidation, JigsErrorCode, JigsErrorData, Message, PageProps, PageReply, Program, PushEvent, SessionBody, SessionEvent, Severity, Span } from "@jigs.design/protocol";
-export { type ActionCall, type ActionHandler, type CallReply, type ClientOptions, type ConfirmFunction, type Diagnostic, type HeadersOption, type HttpTransportOptions, type Invalidation, type JigsClient, type JigsErrorCode, type JigsErrorData, type Message, type PageData, type PageProps, type PageReply, type PageResult, type Program, type PushEvent, type SessionBody, type SessionEvent, type Severity, type Span, type Transport, TransportError, type ViewController, type ViewIssue, type ViewStatus, createJigsClient, createViewController, httpTransport, missingComponents };
+export { type ActionCall, type ActionHandler, type CallReply, type ClientOptions, type ConfirmFunction, type Diagnostic, type HeadersOption, type HttpTransportOptions, type Invalidation, type JigsClient, type JigsErrorCode, type JigsErrorData, type Message, type MutationEvent, type MutationHandler, type PageData, type PageProps, type PageReply, type PageResult, type Program, type PushEvent, type SessionBody, type SessionEvent, type Severity, type Span, type Transport, TransportError, type ViewController, type ViewIssue, type ViewStatus, createJigsClient, createViewController, httpTransport, missingComponents };

package/dist/view/controller.d.ts

@@ -1,5 +1,5 @@
 import { ConfirmFunction, JigsClient } from "../client.js";
-import { JsonValue, Program, PropSchema, RuntimeError, WireArg } from "@jigs.design/protocol";
+import { JsonValue, MutationResult, Program, PropSchema, RuntimeError, WireArg } from "@jigs.design/protocol";
 import { TreeNode, TreeStore } from "@jigs.design/runtime";
 //#region src/view/controller.d.ts
 /** What the view shows beside the tree: a snapshot, replaced on each change. */
@@ -40,6 +40,16 @@ export interface ActionCall {
  * `error`.
  */
 export type ActionHandler = (action: ActionCall) => unknown;
+/** A mutation the program ran, once the server answered it. */
+export interface MutationEvent {
+  /** What the program passed, which the server checked on a success. */
+  input: unknown;
+  name: string;
+  /** What the program's handle got; a `DECLINED` error when the user said no. */
+  result: MutationResult;
+}
+/** Hears each mutation the program ran, after the program got its result. */
+export type MutationHandler = (mutation: MutationEvent) => void;
 /**
  * The page side of one view, for any renderer: it owns the sandbox frame and
  * the tree, and routes the program's queries, mutations and actions. Call
@@ -101,6 +111,13 @@ export interface ViewController {
   setData: (values: Readonly<Record<string, JsonValue>> | undefined) => void;
   /** Replaces what each new issue is given to; `undefined` stops reporting. */
   setIssueHandler: (handler: ((issue: ViewIssue) => void) | undefined) => void;
+  /**
+   * Replaces what hears each mutation the program ran once it settled, for
+   * a page that tells someone, such as the chat model, what the user
+   * changed. Actions are not reported: the action handler has them.
+   * `undefined` stops reporting.
+   */
+  setMutationHandler: (handler: MutationHandler | undefined) => void;
   /**
    * Components the program uses that the registry lacks, as issues to
    * report; `missingComponents` lists them.

package/dist/view/controller.js

@@ -115,6 +115,7 @@ function createViewController(client) {
 	let startup = null;
 	let actionHandler;
 	let confirmHandler;
+	let mutationHandler;
 	/**
 	* Aborts the confirmations the program on screen asked for, so a question
 	* still showing cannot run a mutation for a program that is gone.
@@ -361,15 +362,19 @@ function createViewController(client) {
 				input: result.data,
 				name: call.name
 			}) : result).then((result) => {
-				if (started === generation) {
-					seq++;
-					post({
-						id: call.id,
-						result,
-						seq,
-						type: "mutation"
-					});
-				}
+				if (started !== generation) return;
+				seq++;
+				post({
+					id: call.id,
+					result,
+					seq,
+					type: "mutation"
+				});
+				if (kind === "mutation") mutationHandler?.({
+					input: call.input,
+					name: call.name,
+					result
+				});
 			});
 		}
 	};
@@ -541,6 +546,9 @@ function createViewController(client) {
 		setIssueHandler: (handler) => {
 			issueHandler = handler;
 		},
+		setMutationHandler: (handler) => {
+			mutationHandler = handler;
+		},
 		setUnregistered: (issues) => {
 			unregistered = issues;
 			announce();
@@ -581,6 +589,7 @@ function createViewController(client) {
 			latestDocument = void 0;
 			actionHandler = void 0;
 			confirmHandler = void 0;
+			mutationHandler = void 0;
 			provided = /* @__PURE__ */ new Map();
 			withdrawConfirmations();
 			dropObservers();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/client",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "createJigsClient: the browser's transport and query cache. No React.",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@tanstack/query-core": "5.104.4",
-    "@jigs.design/protocol": "0.3.4",
-    "@jigs.design/runtime": "0.3.4"
+    "@jigs.design/protocol": "0.3.5",
+    "@jigs.design/runtime": "0.3.5"
   }
 }