@jigs.design/compiler 0.3.1 → 0.3.2

package/dist/check-code.d.ts

@@ -44,5 +44,14 @@ export interface DataRead {
   places: Array<Place | null>;
   procedure: string;
 }
+/**
+ * The top-level fields of each procedure's data a document reads, by
+ * procedure: `orders.data.total` and `data["total"]` read `total`. `"all"`
+ * when the data, or the handle, is used whole: aliased, spread, passed on,
+ * read with a computed key, or anything else that is not a chain of
+ * written-out fields. So a caller that trims a procedure's data to these
+ * fields changes nothing the document sees.
+ */
+export type DataFields = Readonly<Record<string, ReadonlyArray<string> | "all">>;
 //#endregion
 export {};

package/dist/check-code.js

@@ -280,6 +280,17 @@ function readBody(statements, define, outer) {
 function checkCode(tree, defines, pageStatements, findings, hoists, dropped = /* @__PURE__ */ new Set()) {
 	const procedures = [];
 	const reads = [];
+	const dataFields = /* @__PURE__ */ new Map();
+	/** Records that `procedure`'s data is read at `field`, or whole. */
+	const readField = (procedure, field) => {
+		const known = dataFields.get(procedure);
+		if (known === "all") return;
+		if (field === "all") {
+			dataFields.set(procedure, "all");
+			return;
+		}
+		dataFields.set(procedure, /* @__PURE__ */ new Set([...known ?? [], field]));
+	};
 	const report = (place, code, message, fix) => {
 		const finding = {
 			code,
@@ -350,6 +361,15 @@ function checkCode(tree, defines, pageStatements, findings, hoists, dropped = /*
 				procedure: source.procedure
 			});
 		}
+		const chainAt = new Map(facts.chains.map((entry) => [`${entry.object}@${entry.offset}`, entry]));
+		for (const { name, offset } of facts.references) {
+			const source = shadowed(name) ? void 0 : body.sources.get(name);
+			if (source === void 0) continue;
+			const path = chainAt.get(`${name}@${offset}`)?.path ?? [];
+			if (source.field === "data") readField(source.procedure, path[0] ?? "all");
+			else if (path[0] === "data") readField(source.procedure, path[1] ?? "all");
+			else if (path.length === 0) readField(source.procedure, "all");
+		}
 		for (const issue of facts.issues) report(placeAt(issue.offset, issue.end), issue.code, issue.message);
 		const seen = /* @__PURE__ */ new Set();
 		const callsFetch = facts.calls.some((call) => call.callee === "fetch");
@@ -570,6 +590,7 @@ function checkCode(tree, defines, pageStatements, findings, hoists, dropped = /*
 		checkBody(def.statements, def.body, body, props);
 	}
 	return {
+		fields: Object.fromEntries([...dataFields].map(([procedure, read]) => [procedure, read === "all" ? "all" : [...read].toSorted()])),
 		procedures: procedures.toSorted((a, b) => a.line - b.line),
 		reads
 	};

package/dist/compile.d.ts

@@ -2,7 +2,7 @@ import { OffsetMap } from "./offsets.js";
 import { ExprNode, PropValue, Statement, TextNode } from "./ast.js";
 import { CompileCatalog } from "./spec.js";
 import { ProgramOutput } from "./codegen.js";
-import { DataRead, ProcedureUse } from "./check-code.js";
+import { DataFields, DataRead, ProcedureUse } from "./check-code.js";
 import { Diagnostic, Severity } from "@jigs.design/protocol";
 //#region src/compile.d.ts
 type DiagnosticCode = "coerced" | "handle_field" | "hook_placement" | "invalid_control" | "invalid_define" | "invalid_expression" | "invalid_literal" | "invalid_statement" | "missing_declarations" | "missing_prop" | "mutate_in_render" | "outer_reference" | "query_options" | "repaired" | "shadows_library" | "unclosed" | "undefined_compare" | "undefined_reference" | "unexpected_children" | "unknown_component" | "unknown_prop" | "unstable_input" | "unsupported_syntax" | "use_before_declare";
@@ -145,6 +145,11 @@ export interface CompileOptions {
 export interface CompileResult {
   defines: ReadonlyArray<CompiledDefine>;
   diagnostics: Array<Diagnostic$1>;
+  /**
+   * The top-level fields of each procedure's data the document and its
+   * defines read, or `"all"` where the data is used whole (`DataFields`).
+   */
+  fields: DataFields;
   /** The jigs this document was compiled against. */
   library: ReadonlyMap<string, CompiledDefine>;
   output: ProgramOutput;

package/dist/compile.js

@@ -850,6 +850,7 @@ function compileDocument(source, library, components) {
 	findings.sort((a, b) => a.line - b.line);
 	return {
 		defines: docDefines,
+		fields: uses.fields,
 		findings,
 		library,
 		output: generated.output,
@@ -958,6 +959,7 @@ function compileJigs(source, options) {
 	if (problems(fixed.findings) !== problems(result.findings) - covered) return withDiagnostics(result, source, result.findings);
 	return withDiagnostics({
 		...fixed,
+		fields: result.fields,
 		procedures: result.procedures,
 		reads: result.reads
 	}, source, result.findings.map((finding) => finding.fix !== void 0 && patched.applied.has(finding.fix) ? {

package/dist/index.d.ts

@@ -3,10 +3,10 @@ import { JigsNode, Statement } from "./ast.js";
 import { CompileCatalog, ComponentSpec, PropSpec } from "./spec.js";
 import { ProgramOutput } from "./codegen.js";
 import { CompileOptions, CompileResult, CompiledDefine, Diagnostic, Jig, Library, Program, RenderNode, compileJigs, compileLibrary } from "./compile.js";
-import { DataRead, ELEMENT, ProcedureUse } from "./check-code.js";
+import { DataFields, DataRead, ELEMENT, ProcedureUse } from "./check-code.js";
 import { Hoisted, hoistDeclarations } from "./hoist.js";
 import { parseJigs } from "./parse.js";
 import { nearest } from "./suggest.js";
 import { jigSignature } from "./signature.js";
 import { Edit, EditFailure, EditFailureReason, SEARCH_MARKER, applyEdits, editBreakage, isEditReply, parseEdits } from "./patch.js";
-export { type CompileCatalog, type CompileOptions, type CompileResult, type CompiledDefine, type ComponentSpec, type DataRead, type Diagnostic, ELEMENT, type Edit, type EditFailure, type EditFailureReason, type Hoisted, type Jig, type JigsNode, type Library, type ProcedureUse, type Program, type ProgramOutput, type PropSpec, type RenderNode, SEARCH_MARKER, type Statement, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, hoistDeclarations, isEditReply, jigSignature, lineAt, nearest, parseEdits, parseJigs, rangeIn, spanIn };
+export { type CompileCatalog, type CompileOptions, type CompileResult, type CompiledDefine, type ComponentSpec, type DataFields, type DataRead, type Diagnostic, ELEMENT, type Edit, type EditFailure, type EditFailureReason, type Hoisted, type Jig, type JigsNode, type Library, type ProcedureUse, type Program, type ProgramOutput, type PropSpec, type RenderNode, SEARCH_MARKER, type Statement, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, hoistDeclarations, isEditReply, jigSignature, lineAt, nearest, parseEdits, parseJigs, rangeIn, spanIn };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/compiler",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Today's Jigs compiler: parser, checker against a catalog, code generator, jig libraries, and the edit helpers. The v2 rewrite replaces it.",
   "license": "MIT",
   "repository": {
@@ -26,6 +26,6 @@
   },
   "dependencies": {
     "acorn": "8.19.0",
-    "@jigs.design/protocol": "0.3.1"
+    "@jigs.design/protocol": "0.3.2"
   }
 }