@protobase/layout 0.21.9 → 0.21.11

package/dist/check-condition.d.ts

@@ -0,0 +1,11 @@
+import { ResourceModel } from "@protobase/schema";
+//#region src/check-condition.d.ts
+type Models = Record<string, ResourceModel>;
+/**
+ * What a `when` condition names that the models do not have: a syntax error, a resource it counts that is not one, a
+ * field path of `resource`, the record around it, that does not resolve. Without a record, it can only count records.
+ */
+export declare const conditionProblems: (when: string, resource: string | undefined, models: Models) => string[];
+/** Whether a caller whose `models` are all they may see can evaluate the condition: it parses and every name it uses is theirs. */
+export declare const conditionReadable: (when: string, resource: string | undefined, models: Models) => boolean;
+//#endregion

package/dist/check-condition.js

@@ -0,0 +1,31 @@
+import { countedResource, parseCondition } from "./condition.js";
+import { resolveFieldPath } from "./field-path.js";
+//#region src/check-condition.ts
+const countedBy = (models, resource, path) => countedResource(path, (first) => Object.hasOwn((resource === void 0 ? void 0 : models[resource])?.fields ?? {}, first));
+/**
+* What a `when` condition names that the models do not have: a syntax error, a resource it counts that is not one, a
+* field path of `resource`, the record around it, that does not resolve. Without a record, it can only count records.
+*/
+const conditionProblems = (when, resource, models) => {
+	const parsed = parseCondition(when);
+	if (!parsed.ok) return [`"when" is not a valid condition: ${parsed.message}`];
+	return parsed.paths.flatMap((name) => {
+		const counted = countedBy(models, resource, name);
+		if (counted !== void 0) return models[counted] ? [] : [`"when" counts "${counted}", which is not a resource`];
+		if (resource === void 0) return [`"when" names "${name}", but outside a record it can only count records, as "<resource>.count"`];
+		const resolved = resolveFieldPath(models, resource, name);
+		return resolved.ok ? [] : [resolved.message];
+	});
+};
+/** Whether a caller whose `models` are all they may see can evaluate the condition: it parses and every name it uses is theirs. */
+const conditionReadable = (when, resource, models) => {
+	const parsed = parseCondition(when);
+	if (!parsed.ok) return false;
+	return parsed.paths.every((name) => {
+		const counted = countedBy(models, resource, name);
+		if (counted !== void 0) return Boolean(models[counted]);
+		return resource !== void 0 && resolveFieldPath(models, resource, name).ok;
+	});
+};
+//#endregion
+export { conditionProblems, conditionReadable };

package/dist/check-page.js

@@ -1,8 +1,8 @@
 import { dataProps } from "./node.js";
-import { countedResource, parseCondition } from "./condition.js";
 import { walkTree } from "./walk.js";
 import { chartProblems } from "./check-chart.js";
 import { resolveFieldPath } from "./field-path.js";
+import { conditionProblems } from "./check-condition.js";
 import { checkFilter, checkOrderBy, parseFilter, parseOrderBy } from "@protobase/schema";
 import { addressErrors, fieldRefsIn } from "@protobase/schema/internal";
 //#region src/check-page.ts
@@ -78,19 +78,7 @@ const nodeProblems = (node, scope, { models, actions, pages }) => {
 				source: linkSource(models, scope)
 			}).map((error) => `to: ${error}`));
 			break;
-		case "Show": {
-			const parsed = parseCondition(String(node.props.when));
-			if (!parsed.ok) break;
-			const record = scope.record && scope.resource !== void 0 ? models[scope.resource] : void 0;
-			for (const name of parsed.paths) {
-				const counted = countedResource(name, (first) => Boolean(record && Object.hasOwn(record.fields, first)));
-				if (counted !== void 0) {
-					if (!models[counted]) problems.push(`"when" counts "${counted}", which is not a resource`);
-				} else if (record) path(name);
-				else problems.push(`"when" names "${name}", but outside a record it can only count records, as "<resource>.count"`);
-			}
-			break;
-		}
+		case "Show": problems.push(...conditionProblems(String(node.props.when), scope.record ? scope.resource : void 0, models));
 	}
 	return problems;
 };

package/dist/index.d.ts

@@ -4,9 +4,10 @@ import { ComponentOptions, component } from "./component.js";
 import { PageDefinition, PageModel, PageOptions, isPageDefinition, page } from "./page.js";
 import { Location, walkTree } from "./walk.js";
 import { checkPages } from "./check-page.js";
+import { conditionProblems, conditionReadable } from "./check-condition.js";
 import { prunePage } from "./prune-page.js";
 import { countedResource, evaluateCondition, parseCondition } from "./condition.js";
 import { PathStep, resolveFieldPath } from "./field-path.js";
 import { jsx_runtime_d_exports } from "./jsx-runtime.js";
 import { FieldRefValue, fieldRef } from "@protobase/schema";
-export { Action, type ActionProps, type Block, type ButtonVariant, Card, type CardProps, CardRow, type CardRowProps, Chart, type ChartBucket, type ChartProps, type ChartType, type ComponentOptions, type DataProps, type Elements, Field, type FieldProps, type FieldRefValue, Grid, type GridProps, type GridSpan, type LayoutChild, type LayoutChildren, type LayoutNode, type LayoutValue, Link, type LinkProps, type Location, ModalForm, type ModalFormProps, Page, type PageDefinition, type PageModel, type PageOptions, type PageProps, type PathStep, Progress, type ProgressProps, RecordCard, type RecordCardProps, RecordRow, type RecordRowProps, Show, type ShowProps, Stat, type StatProps, Table, type TableProps, checkPages, component, countedResource, evaluateCondition, fieldRef, isLayoutNode, isPageDefinition, jsx_runtime_d_exports as jsxRuntime, page, parseCondition, prunePage, resolveFieldPath, walkTree };
+export { Action, type ActionProps, type Block, type ButtonVariant, Card, type CardProps, CardRow, type CardRowProps, Chart, type ChartBucket, type ChartProps, type ChartType, type ComponentOptions, type DataProps, type Elements, Field, type FieldProps, type FieldRefValue, Grid, type GridProps, type GridSpan, type LayoutChild, type LayoutChildren, type LayoutNode, type LayoutValue, Link, type LinkProps, type Location, ModalForm, type ModalFormProps, Page, type PageDefinition, type PageModel, type PageOptions, type PageProps, type PathStep, Progress, type ProgressProps, RecordCard, type RecordCardProps, RecordRow, type RecordRowProps, Show, type ShowProps, Stat, type StatProps, Table, type TableProps, checkPages, component, conditionProblems, conditionReadable, countedResource, evaluateCondition, fieldRef, isLayoutNode, isPageDefinition, jsx_runtime_d_exports as jsxRuntime, page, parseCondition, prunePage, resolveFieldPath, walkTree };

package/dist/index.js

@@ -5,8 +5,9 @@ import { countedResource, evaluateCondition, parseCondition } from "./condition.
 import { walkTree } from "./walk.js";
 import { isPageDefinition, page } from "./page.js";
 import { resolveFieldPath } from "./field-path.js";
+import { conditionProblems, conditionReadable } from "./check-condition.js";
 import { checkPages } from "./check-page.js";
 import { prunePage } from "./prune-page.js";
 import { jsx_runtime_exports } from "./jsx-runtime.js";
 import { fieldRef } from "@protobase/schema";
-export { Action, Card, CardRow, Chart, Field, Grid, Link, ModalForm, Page, Progress, RecordCard, RecordRow, Show, Stat, Table, checkPages, component, countedResource, evaluateCondition, fieldRef, isLayoutNode, isPageDefinition, jsx_runtime_exports as jsxRuntime, page, parseCondition, prunePage, resolveFieldPath, walkTree };
+export { Action, Card, CardRow, Chart, Field, Grid, Link, ModalForm, Page, Progress, RecordCard, RecordRow, Show, Stat, Table, checkPages, component, conditionProblems, conditionReadable, countedResource, evaluateCondition, fieldRef, isLayoutNode, isPageDefinition, jsx_runtime_exports as jsxRuntime, page, parseCondition, prunePage, resolveFieldPath, walkTree };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/layout",
-  "version": "0.21.9",
+  "version": "0.21.11",
   "description": "Composed pages for Protobase, written as JSX that compiles to plain data, with its JSX runtime.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,7 +31,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@protobase/schema": "0.21.9",
+    "@protobase/schema": "0.21.11",
     "aip-parsers": "^1.0.0"
   }
 }