@jigs.design/server 0.3.2 → 0.3.4

package/dist/compile.js

@@ -3,7 +3,7 @@ import { JigsCompileError, JigsError, fatalDiagnostics } from "./errors.js";
 import { inputDiagnostics } from "./inputs.js";
 import { outputDiagnostics } from "./outputs.js";
 import { splitPragma, versionDiagnostics } from "./pragma.js";
-import { compileJigs, compileLibrary, spanIn } from "@jigs.design/compiler";
+import { compileJigs, compileLibrary, nearest, spanIn } from "@jigs.design/compiler";
 import { TOOL_RESULTS } from "@jigs.design/prompt";
 import { componentSchema } from "@jigs.design/host";
 import { PROGRAM_FORMAT } from "@jigs.design/protocol";
@@ -69,6 +69,18 @@ const KIND_NAMES = {
 function hookFor(kind) {
 	return kind === "query" || kind === "data" ? "useQuery" : "useMutation";
 }
+/**
+* The host's name nearest to `name`, for an unknown one: one `hook` can
+* read first, so the fix is a rename and not a second error, else any.
+*/
+function nearestProcedure(host, name, hook) {
+	const names = Object.keys(host.procedures);
+	const fitting = names.filter((entry) => {
+		const procedure = host.procedures[entry];
+		return procedure !== void 0 && hookFor(procedure.kind) === hook;
+	});
+	return nearest(name, fitting, 1)[0] ?? nearest(name, names, 1)[0];
+}
 function procedureDiagnostics(host, source, uses) {
 	const diagnostics = [];
 	const report = (use, code, message) => {
@@ -95,7 +107,8 @@ function procedureDiagnostics(host, source, uses) {
 		}
 		const procedure = Object.hasOwn(host.procedures, use.name) ? host.procedures[use.name] : void 0;
 		if (procedure === void 0) {
-			report(use, "unknown_procedure", `"${use.name}" is not a query, mutation, action or provided data on this host; its handle reports UNKNOWN_PROCEDURE`);
+			const near = nearestProcedure(host, use.name, use.hook);
+			report(use, "unknown_procedure", `"${use.name}" is not a query, mutation, action or provided data on this host; its handle reports UNKNOWN_PROCEDURE${near === void 0 ? "" : `. Did you mean "${near}"?`}`);
 			continue;
 		}
 		const expected = hookFor(procedure.kind);

package/dist/core.js

@@ -26,7 +26,17 @@ const COMPILER_PROBE = `{@body const [count, setCount] = useState(0)}
 **done**
 </if>`;
 /** What `resolvePage` must return, checked, since a plain-JavaScript one may not. */
-const savedPageSchema = z.object({ source: z.string() });
+const savedPageSchema = z.object({
+	data: z.record(z.string(), z.json()).optional(),
+	source: z.string()
+});
+/**
+* The most JSON a saved page's `data` may be, in characters, the order of
+* `MAX_CONTENT`: the app stored it, so past it the page is `INTERNAL`.
+*/
+const MAX_PAGE_DATA = 256e3;
+/** What a page without provided data carries: one object, shared and frozen. */
+const NO_DATA = Object.freeze({});
 /** The strict rule: an error or warning diagnostic throws. */
 function strictly(subject, compiled) {
 	const fatal = fatalDiagnostics(compiled.diagnostics);
@@ -414,11 +424,13 @@ function createJigsServer(options) {
 		const subject = `Jig "${entry.name}"`;
 		if (entry.kind === "document") startupPages.set(entry.name, {
 			...strictly(subject, compileStored(entry.source)),
+			data: NO_DATA,
 			origin: "shipped",
 			source: entry.source
 		});
 		else if (!checker.needsProps(entry.name)) startupPages.set(entry.name, {
 			...strictly(subject, compileDefine(entry.name, {})),
+			data: NO_DATA,
 			origin: "shipped",
 			source: checker.pageBody(entry.name, {})
 		});
@@ -432,6 +444,7 @@ function createJigsServer(options) {
 		const compiled = await cached("page", body, () => compileDefine(entry.name, props));
 		return {
 			...strictly(`Page "${entry.name}"`, compiled),
+			data: NO_DATA,
 			origin: "shipped",
 			source: body
 		};
@@ -443,7 +456,10 @@ function createJigsServer(options) {
 		});
 		return new JigsError("INTERNAL", INTERNAL_MESSAGE);
 	};
-	/** The source `resolvePage` finds for `call.ctx`, checked; null when it finds none. */
+	/**
+	* The page `resolvePage` finds for `call.ctx`, checked: its source and
+	* the data it keeps (empty without). Null when it finds none.
+	*/
 	const savedSource = async (name, props, lookup) => {
 		if (options.resolvePage === void 0) return null;
 		let found;
@@ -458,21 +474,26 @@ function createJigsServer(options) {
 		}
 		if (found === null) return null;
 		const checked = savedPageSchema.safeParse(found);
-		if (!checked.success) throw internal(/* @__PURE__ */ new Error(`resolvePage returned ${String(found)} for "${name}"; return { source } or null`), name);
-		const source = checked.data.source;
-		if (source.length > 2e5) throw internal(/* @__PURE__ */ new Error(`The source resolvePage returned for "${name}" is longer than ${MAX_CONTENT} characters`), name);
+		if (!checked.success) throw internal(/* @__PURE__ */ new Error(`resolvePage returned ${String(found)} for "${name}"; return { source, data? } or null`), name);
+		const { data } = checked.data;
+		if (checked.data.source.length > 2e5) throw internal(/* @__PURE__ */ new Error(`The source resolvePage returned for "${name}" is longer than ${MAX_CONTENT} characters`), name);
+		if (data !== void 0 && JSON.stringify(data).length > MAX_PAGE_DATA) throw internal(/* @__PURE__ */ new Error(`The data resolvePage returned for "${name}" is longer than ${MAX_PAGE_DATA} characters of JSON`), name);
 		noProps(name, props);
-		return source;
+		return {
+			data: data ?? NO_DATA,
+			source: checked.data.source
+		};
 	};
 	/** A page `resolvePage` finds for `call.ctx`, compiled leniently unless `strict`. */
 	const savedPage = async (name, props, lookup) => {
-		const source = await savedSource(name, props, lookup);
-		if (source === null) return null;
-		const compiled = await compileCached(source);
+		const saved = await savedSource(name, props, lookup);
+		if (saved === null) return null;
+		const compiled = await compileCached(saved.source);
 		return {
 			...lookup.strict === true ? strictly(`Page "${name}"`, compiled) : compiled,
+			data: saved.data,
 			origin: "saved",
-			source
+			source: saved.source
 		};
 	};
 	const resolve = async (name, props = {}, lookup) => {
@@ -526,6 +547,7 @@ function createJigsServer(options) {
 		} else try {
 			const resolved = await page(name, props, context);
 			outcome = resolved === null ? { error: notFound } : {
+				data: resolved.data,
 				diagnostics: resolved.diagnostics,
 				program: resolved.program,
 				version
@@ -560,7 +582,10 @@ function createJigsServer(options) {
 	*/
 	const pageSource = async (name, props, context) => {
 		const entry = jigsByName.get(name);
-		if (entry === void 0) return savedSource(name, props, context);
+		if (entry === void 0) {
+			const saved = await savedSource(name, props, context);
+			return saved === null ? null : saved.source;
+		}
 		const shippedName = name;
 		if (!entry.page || !pageAllowed(context.ctx, shippedName, props)) return null;
 		if (entry.kind === "document") {

package/dist/types.d.ts

@@ -289,8 +289,15 @@ export interface ErrorInfo {
    */
   type: "call" | "chat" | "events" | "page" | "session";
 }
-/** A page `resolvePage` found: the source as the app stored it. */
+/** A page `resolvePage` found: the source as the app stored it, and what it reads. */
 export interface SavedPage {
+  /**
+   * Provided data the page is drawn with, by slot: what the app kept with
+   * it, such as the tool results a chat block had. Fixed to the page: it
+   * travels beside the program and is cached with it. Not parsed against
+   * the slots' schemas; `jigs.data` checks a value before it is stored.
+   */
+  data?: Readonly<Record<string, JsonValue>>;
   /** The source, with its pragma line when the app kept it. */
   source: string;
 }
@@ -298,6 +305,7 @@ export interface SavedPage {
  * Finds a page the host does not ship, by name, for the caller `ctx` names.
  * `null` is "no such page for this caller". Runs on every request for the
  * name; cache in it if the store is slow. Throw a `JigsError` to refuse.
+ * `data` is optional: the provided slots the page keeps, as JSON.
  */
 export type PageResolver<TContext> = (name: string, call: {
   ctx: TContext;
@@ -602,6 +610,13 @@ export interface ChatTurn {
 export interface ResolvedPage {
   /** The design checks' advice, numbered like `diagnostics`. */
   advice: ReadonlyArray<Advice>;
+  /**
+   * Provided data the page is drawn with, by slot: what `resolvePage`
+   * returned beside the source. Empty for a shipped page, whose route
+   * supplies its slots. Pass it to the view with the app's own slots:
+   * `data={{ ...page.data, ...own }}`.
+   */
+  data: Readonly<Record<string, JsonValue>>;
   /**
    * Never an error or warning for a shipped page, or a saved one compiled
    * with `strict`. A saved page is lenient by default: these say what
@@ -703,8 +718,8 @@ export interface JigsServer<TContext, TPageName extends string = never> {
   /**
    * The start of `prompt(mode)` that is the same on every turn: the
    * language and the catalog, before the instructions and procedures. Mark
-   * it for a provider's prompt cache (`cachedInstructions` in
-   * `@jigs.design/ai-sdk`).
+   * it, and the end of the prompt, for a provider's prompt cache
+   * (`cachedInstructions` in `@jigs.design/ai-sdk`).
    */
   promptPrefix: (mode?: PromptMode) => string;
   /** Changes whenever the compiler, the runtime or the host does. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/server",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "createJigsServer: checks and streams programs, runs procedures, and serves the sandbox frame.",
   "license": "MIT",
   "repository": {
@@ -29,11 +29,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@jigs.design/compiler": "0.3.2",
-    "@jigs.design/prompt": "0.3.2",
-    "@jigs.design/host": "0.3.2",
-    "@jigs.design/protocol": "0.3.2",
-    "@jigs.design/runtime": "0.3.2"
+    "@jigs.design/compiler": "0.3.4",
+    "@jigs.design/host": "0.3.4",
+    "@jigs.design/prompt": "0.3.4",
+    "@jigs.design/runtime": "0.3.4",
+    "@jigs.design/protocol": "0.3.4"
   },
   "peerDependencies": {
     "zod": "^4.0.0"