@jigs.design/host 0.3.0 → 0.3.1

package/dist/host.js

@@ -36,8 +36,8 @@ function defineHost(definition) {
 	for (const [name, procedure] of Object.entries(procedures)) {
 		if (!PROCEDURE_NAME.test(name)) throw new Error(`Procedure name "${name}" must be an identifier: letters, digits and underscores, starting with a letter`);
 		if (procedure.input !== void 0) checkJsonSchema(`The input of "${name}"`, procedure.input);
-		if (procedure.output !== void 0) checkJsonSchema(`The output of "${name}"`, procedure.output);
-		if (procedure.kind !== "action" && procedure.projection !== void 0) checkJsonSchema(`The projection of "${name}"`, procedure.projection.schema);
+		if (procedure.output !== void 0) checkJsonSchema(procedure.kind === "data" ? `The schema of "${name}"` : `The output of "${name}"`, procedure.output);
+		if ((procedure.kind === "query" || procedure.kind === "mutation") && procedure.projection !== void 0) checkJsonSchema(`The projection of "${name}"`, procedure.projection.schema);
 		if (procedure.kind === "mutation") {
 			if (!isCallPolicy(procedure.policy)) throw new Error(`"${name}" has policy ${JSON.stringify(procedure.policy)}: write "allow", "confirm" or "deny"`);
 			if (procedure.policy === "confirm" && procedure.confirm === void 0) throw new Error(`"${name}" asks for confirmation but has no confirm message: give it confirm: (input) => text`);

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { DesignGuidance, GuidanceInput, SituationDefinition, situation } from "./guidance.js";
 import { Catalog, CatalogProps, ComponentDefinition, ComponentDesign, ComponentNamed, PropDefinition, PropDefinitions, PropsOf, block, boolean, componentSchema, defineCatalog, defineComponent, handler, image, inline, link, list, none, number, oneOf, string } from "./catalog.js";
-import { ActionDefinition, CallPolicy, InputOf, InvalidationScope, InvalidationScopes, MutationDefinition, OutputOf, ProcedureDefinition, Procedures, Projection, QueryDefinition, action, dataSchema, isCallPolicy, mutation, query } from "./procedures.js";
+import { ActionDefinition, CallPolicy, DataDefinition, InputOf, InvalidationScope, InvalidationScopes, MutationDefinition, OutputOf, ProcedureDefinition, Procedures, Projection, QueryDefinition, action, data, dataSchema, isCallPolicy, mutation, query } from "./procedures.js";
 import { DefineName, JigDefinition, PageName, jig } from "./jigs.js";
 import { ActionEvent, Host, PagePolicy, PolicyDirectives, contentSecurityPolicy, defineHost } from "./host.js";
-export { type ActionDefinition, type ActionEvent, type CallPolicy, type Catalog, type CatalogProps, type ComponentDefinition, type ComponentDesign, type ComponentNamed, type DefineName, type DesignGuidance, type GuidanceInput, type Host, type InputOf, type InvalidationScope, type InvalidationScopes, type JigDefinition, type MutationDefinition, type OutputOf, type PageName, type PagePolicy, type PolicyDirectives, type ProcedureDefinition, type Procedures, type Projection, type PropDefinition, type PropDefinitions, type PropsOf, type QueryDefinition, type SituationDefinition, action, block, boolean, componentSchema, contentSecurityPolicy, dataSchema, defineCatalog, defineComponent, defineHost, handler, image, inline, isCallPolicy, jig, link, list, mutation, none, number, oneOf, query, situation, string };
+export { type ActionDefinition, type ActionEvent, type CallPolicy, type Catalog, type CatalogProps, type ComponentDefinition, type ComponentDesign, type ComponentNamed, type DataDefinition, type DefineName, type DesignGuidance, type GuidanceInput, type Host, type InputOf, type InvalidationScope, type InvalidationScopes, type JigDefinition, type MutationDefinition, type OutputOf, type PageName, type PagePolicy, type PolicyDirectives, type ProcedureDefinition, type Procedures, type Projection, type PropDefinition, type PropDefinitions, type PropsOf, type QueryDefinition, type SituationDefinition, action, block, boolean, componentSchema, contentSecurityPolicy, data, dataSchema, defineCatalog, defineComponent, defineHost, handler, image, inline, isCallPolicy, jig, link, list, mutation, none, number, oneOf, query, situation, string };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { situation } from "./guidance.js";
 import { block, boolean, componentSchema, defineCatalog, defineComponent, handler, image, inline, link, list, none, number, oneOf, string } from "./catalog.js";
-import { action, dataSchema, isCallPolicy, mutation, query } from "./procedures.js";
+import { action, data, dataSchema, isCallPolicy, mutation, query } from "./procedures.js";
 import { contentSecurityPolicy, defineHost } from "./host.js";
 import { jig } from "./jigs.js";
-export { action, block, boolean, componentSchema, contentSecurityPolicy, dataSchema, defineCatalog, defineComponent, defineHost, handler, image, inline, isCallPolicy, jig, link, list, mutation, none, number, oneOf, query, situation, string };
+export { action, block, boolean, componentSchema, contentSecurityPolicy, data, dataSchema, defineCatalog, defineComponent, defineHost, handler, image, inline, isCallPolicy, jig, link, list, mutation, none, number, oneOf, query, situation, string };

package/dist/procedures.d.ts

@@ -76,12 +76,25 @@ export interface ActionDefinition<TInput extends z.ZodType | undefined = z.ZodTy
   kind: "action";
   output: undefined;
 }
-export type ProcedureDefinition = ActionDefinition | MutationDefinition | QueryDefinition;
+/**
+ * Data the embedding page supplies when it shows the view, read with
+ * `useQuery` like a query that takes no input. The server never runs it and
+ * refuses it on the wire; the page passes the value to `JigsView` as `data`
+ * and replaces it there, so nothing refetches it.
+ */
+export interface DataDefinition<TOutput extends z.ZodType = z.ZodType> {
+  description: string;
+  input: undefined;
+  kind: "data";
+  /** The shape the page provides; the prompt shows it as `Data:`, as a query's output. */
+  output: TOutput;
+}
+export type ProcedureDefinition = ActionDefinition | DataDefinition | MutationDefinition | QueryDefinition;
 export type Procedures = Readonly<Record<string, ProcedureDefinition>>;
 /**
  * The schema of what a procedure's views read: its projection's when it has
- * one, else its output; `undefined` for an action or a procedure with no
- * output. The prompt shows it, and the member check reads against it.
+ * one, else its output (a provided slot's schema); `undefined` for an
+ * action or a procedure with no output. The prompt shows it, and the member check reads against it.
  */
 export declare function dataSchema(procedure: ProcedureDefinition): z.ZodType | undefined;
 /** What `run` receives for a procedure: the parsed input, or `undefined` when it takes none. */
@@ -144,5 +157,15 @@ export declare function action<TInput extends z.ZodType | undefined = undefined>
   description: string;
   input?: TInput;
 }): ActionDefinition<NoInfer<TInput>>;
+/**
+ * A provided slot: data the page supplies per view, such as rows an agent
+ * already holds, in the shape `schema` describes. It takes no input and has
+ * no `run`. A host can later make it a `query()` of the same name and
+ * schema without changing a stored program.
+ */
+export declare function data<TSchema extends z.ZodType>(definition: {
+  description: string;
+  schema: TSchema;
+}): DataDefinition<TSchema>;
 //#endregion
 export {};

package/dist/procedures.js

@@ -10,11 +10,15 @@ function isCallPolicy(policy) {
 }
 /**
 * The schema of what a procedure's views read: its projection's when it has
-* one, else its output; `undefined` for an action or a procedure with no
-* output. The prompt shows it, and the member check reads against it.
+* one, else its output (a provided slot's schema); `undefined` for an
+* action or a procedure with no output. The prompt shows it, and the member check reads against it.
 */
 function dataSchema(procedure) {
-	return procedure.kind === "action" ? void 0 : procedure.projection?.schema ?? procedure.output;
+	switch (procedure.kind) {
+		case "action": return;
+		case "data": return procedure.output;
+		default: return procedure.projection?.schema ?? procedure.output;
+	}
 }
 function query(definition) {
 	const input = definition.input;
@@ -57,5 +61,19 @@ function action(definition) {
 		output: void 0
 	};
 }
+/**
+* A provided slot: data the page supplies per view, such as rows an agent
+* already holds, in the shape `schema` describes. It takes no input and has
+* no `run`. A host can later make it a `query()` of the same name and
+* schema without changing a stored program.
+*/
+function data(definition) {
+	return {
+		description: definition.description,
+		input: void 0,
+		kind: "data",
+		output: definition.schema
+	};
+}
 //#endregion
-export { action, dataSchema, isCallPolicy, mutation, query };
+export { action, data, dataSchema, isCallPolicy, mutation, query };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/host",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Define a host: the catalog a spec may draw, the procedures it may call, and the image hosts.",
   "license": "MIT",
   "repository": {
@@ -25,7 +25,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@jigs.design/protocol": "0.3.0"
+    "@jigs.design/protocol": "0.3.1"
   },
   "peerDependencies": {
     "zod": "^4.0.0"