@jigs.design/host 0.3.5 → 0.3.7

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, 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 { DefineName, DefineScan, JigDefinition, PageName, jig, scanDefine } 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 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 };
+export { type ActionDefinition, type ActionEvent, type CallPolicy, type Catalog, type CatalogProps, type ComponentDefinition, type ComponentDesign, type ComponentNamed, type DataDefinition, type DefineName, type DefineScan, 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, scanDefine, situation, string };

package/dist/index.js

@@ -2,5 +2,5 @@ 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, 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, data, dataSchema, defineCatalog, defineComponent, defineHost, handler, image, inline, isCallPolicy, jig, link, list, mutation, none, number, oneOf, query, situation, string };
+import { jig, scanDefine } from "./jigs.js";
+export { action, block, boolean, componentSchema, contentSecurityPolicy, data, dataSchema, defineCatalog, defineComponent, defineHost, handler, image, inline, isCallPolicy, jig, link, list, mutation, none, number, oneOf, query, scanDefine, situation, string };

package/dist/jigs.d.ts

@@ -33,6 +33,27 @@ export type DefineName<TSource extends string> = TSource extends `${string}<defi
 export type PageName<TJigs extends ReadonlyArray<JigDefinition>> = Extract<TJigs[number], {
   page: true;
 }>["name"];
+/**
+ * What `scanDefine` read: the name of the one `<define>` a source is, or why
+ * it is not one: `"document"` when the source is not one `<define>` and
+ * nothing else, `"name"` when the define's name is not a literal tag name
+ * (with `name` when it is a literal of another shape).
+ */
+export type DefineScan = {
+  message: string;
+  name?: string;
+  reason: "document" | "name";
+} | {
+  name: string;
+};
+/**
+ * The name of the one top-level `<define>` that `source` is, with nothing
+ * else but whitespace and a leading pragma line, read the way `jig()` and
+ * the compiler read it, or why it is not one. Never throws: for a source a
+ * user wrote, such as a saved tag. A scan, not a parse: the compiler checks
+ * the source again.
+ */
+export declare function scanDefine(source: string): DefineScan;
 /**
  * A jig whose source is one `<define>`: named by it. A `description` makes
  * it a tag the model may write; `page: true` makes it a page the product

package/dist/jigs.js

@@ -73,17 +73,38 @@ function defineStart(source) {
 	if (start === void 0 || starts.length > 1 || close === -1 || source.slice(pragma, start).trim() !== "" || source.slice(close + 9).trim() !== "") return null;
 	return start;
 }
-/** The name of a define jig, read the way the compiler reads it. */
-function defineName(source, start) {
+/**
+* The name of the one top-level `<define>` that `source` is, with nothing
+* else but whitespace and a leading pragma line, read the way `jig()` and
+* the compiler read it, or why it is not one. Never throws: for a source a
+* user wrote, such as a saved tag. A scan, not a parse: the compiler checks
+* the source again.
+*/
+function scanDefine(source) {
+	const start = defineStart(source);
+	if (start === null) return {
+		message: "The source is not one <define> and nothing else",
+		reason: "document"
+	};
 	const name = nameAttribute(source, start);
-	if (name === null) throw new Error("A jig's <define> needs a literal name, e.g. <define name=\"orderRow\">");
-	if (!TAG_NAME.test(name)) throw new Error(`Jig name "${name}" must start with a lowercase letter and use letters and digits only`);
-	return name;
+	if (name === null) return {
+		message: "A jig's <define> needs a literal name, e.g. <define name=\"orderRow\">",
+		reason: "name"
+	};
+	if (!TAG_NAME.test(name)) return {
+		message: `Jig name "${name}" must start with a lowercase letter and use letters and digits only`,
+		name,
+		reason: "name"
+	};
+	return { name };
 }
 function jig(definition) {
-	const start = defineStart(definition.source);
-	if (start === null) return documentJig(definition);
-	const name = defineName(definition.source, start);
+	const scanned = scanDefine(definition.source);
+	if ("reason" in scanned) {
+		if (scanned.reason === "document") return documentJig(definition);
+		throw new Error(scanned.message);
+	}
+	const { name } = scanned;
 	if (definition.name !== void 0) throw new Error(`Jig "${name}" has a <define>, which names it: remove name: "${definition.name}"`);
 	const page = definition.page ?? false;
 	const tag = definition.description !== void 0;
@@ -114,4 +135,4 @@ function documentJig(definition) {
 	};
 }
 //#endregion
-export { jig };
+export { jig, scanDefine };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/host",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "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.5"
+    "@jigs.design/protocol": "0.3.7"
   },
   "peerDependencies": {
     "zod": "^4.0.0"