@protobase/server 0.10.0 → 0.11.0

package/dist/check-views.js

@@ -1,5 +1,7 @@
 import { relatedErrors } from "./view-related.js";
+import { addressErrors, addressPlaceholders, appHrefError, displayFields, fieldRefsIn, hrefPlaceholders } from "@protobase/schema";
 //#region src/check-views.ts
+const linkFields = (run) => run?.kind !== "link" ? [] : "to" in run ? addressPlaceholders(run.to) : hrefPlaceholders(run.href);
 const sensitiveErrors = (view, model) => {
 	const sensitive = (name) => Boolean(model.fields[name]?.sensitive);
 	return [
@@ -10,11 +12,12 @@ const sensitiveErrors = (view, model) => {
 			...(view.list?.sort ?? []).map(([name]) => name),
 			...view.list?.search ?? []
 		]],
+		["a list display", (view.list?.displays ?? []).flatMap(displayFields)],
 		["a filter", view.filters.map((widget) => widget.field)],
 		["the chart", view.chart ? [view.chart.field] : []],
 		["the sidebar", view.layout.flatMap((item) => item.kind === "sidebar" ? item.fields : [])],
 		["the recent records", view.nav?.recent ? [view.nav.recent.status] : []],
-		["an action", view.actions.flatMap((action) => action.run?.kind === "update" ? Object.keys(action.run.values) : action.run?.kind === "link" ? [...action.run.href.matchAll(/\{(\w+)\}/g)].map((match) => match[1]) : [])]
+		["an action", view.actions.flatMap((action) => action.run?.kind === "update" ? Object.keys(action.run.values) : linkFields(action.run))]
 	].flatMap(([place, names]) => [...new Set(names.filter(sensitive))].map((name) => `sensitive field "${name}" cannot be in ${place}`));
 };
 const valueLabelErrors = (view, model) => Object.entries(view.fields).flatMap(([name, hints]) => {
@@ -23,20 +26,40 @@ const valueLabelErrors = (view, model) => Object.entries(view.fields).flatMap(([
 	if (field?.type !== "enum") return [`value labels of "${name}" need an enum field`];
 	return Object.keys(hints.valueLabels).filter((value) => !field.enumValues?.includes(value)).map((value) => `value label "${value}" is not a value of "${name}"`);
 });
+const linkErrors = (view, model, models, pages) => view.actions.flatMap(({ name, run }) => {
+	if (run?.kind !== "link") return [];
+	if ("href" in run) {
+		const error = appHrefError(run.href);
+		return error ? [`action "${name}": ${error}`] : [];
+	}
+	return addressErrors(run.to, {
+		models,
+		pages,
+		source: model
+	}).map((error) => `action "${name}": ${error}`);
+});
+const unknownFieldErrors = (view, model) => {
+	const unknown = (names, what) => names.filter((name) => !Object.hasOwn(model.fields, name)).map((name) => `${what} names field "${name}", which ${model.name} does not have`);
+	return [...(view.list?.displays ?? []).flatMap((display) => unknown(displayFields(display), `display "${display.name}"`)), ...view.layout.flatMap((item) => item.kind === "custom" ? unknown(fieldRefsIn(item.props), `custom section ${item.component}`) : [])];
+};
 /**
-* Fails at startup when a view uses a sensitive field where it would show empty, labels values its enum does not have,
-* or has a related section that does not fit the resources.
+* Fails at startup when a view uses a sensitive field where it would show empty, a display or custom section names a
+* field the resource does not have, labels values its enum does not have,
+* has a related section that does not fit the resources, or a link to an address the app does not have.
 */
-const checkViews = (registry, views) => {
+const checkViews = (registry, views, pages = []) => {
 	const models = Object.fromEntries(registry.entries.map((entry) => [entry.name, entry.model]));
+	const pageNames = new Set(pages);
 	const problems = views.flatMap((view) => {
 		const model = models[view.resource];
 		if (!model) return [];
 		const related = view.layout.flatMap((item) => item.kind === "related" ? relatedErrors(item, view.resource, models).map((error) => `related "${item.title}": ${error}`) : []);
 		return [
 			...sensitiveErrors(view, model),
+			...unknownFieldErrors(view, model),
 			...valueLabelErrors(view, model),
-			...related
+			...related,
+			...linkErrors(view, model, models, pageNames)
 		].map((problem) => `View "${view.resource}": ${problem}`);
 	});
 	if (problems.length > 0) throw new Error(`The views do not match the resources:\n${problems.map((problem) => `  - ${problem}`).join("\n")}`);

package/dist/create-admin.js

@@ -50,7 +50,7 @@ const createAdmin = ({ resources: appResources, views: appViews = [], pages = []
 	checkShell(registry, viewModels, userMenuModel, pageModels.map((entry) => entry.name));
 	const bottomBarModels = bottomBars.map((bar) => bar.toBottomBarModel());
 	checkBottomBars(registry, bottomBarModels, pageModels.map((entry) => entry.name), declaredRoles(auth, options.roles));
-	checkViews(registry, viewModels);
+	checkViews(registry, viewModels, pageModels.map((entry) => entry.name));
 	checkPages(pageModels, {
 		models: Object.fromEntries(registry.entries.map((entry) => [entry.name, entry.model])),
 		actions: (resource) => new Set(viewModels.filter((view) => view.resource === resource).flatMap((view) => view.actions.map((action) => action.name)))

package/dist/view-access.js

@@ -1,6 +1,6 @@
 import { relatedErrors } from "./view-related.js";
 import { resolveFieldPath } from "@protobase/layout";
-import { navRecentErrors } from "@protobase/schema";
+import { addressErrors, hrefPlaceholders, navRecentErrors, pruneByShape, shapes, tableDisplay } from "@protobase/schema";
 //#region src/view-access.ts
 const pruneRelated = (item, resource, models) => {
 	const { columns, ...rest } = item;
@@ -9,46 +9,145 @@ const pruneRelated = (item, resource, models) => {
 		...rest,
 		columns: visible
 	} : rest;
-	return relatedErrors(narrowed, resource, models).length === 0 ? [narrowed] : [];
+	return relatedErrors(narrowed, resource, models).length === 0 ? narrowed : void 0;
 };
+const keepDefault = ({ default: opens, displays, ...list }) => {
+	const shown = displays && displays.length > 0 ? displays : void 0;
+	const kept = opens === tableDisplay || shown?.some((display) => display.name === opens);
+	return {
+		...list,
+		...shown && { displays: shown },
+		...opens !== void 0 && kept && { default: opens }
+	};
+};
+const listShape = shapes.object({
+	columns: shapes.list(shapes.field),
+	sort: shapes.list(shapes.tuple(shapes.field, shapes.data)),
+	search: shapes.list(shapes.field),
+	displays: shapes.list(shapes.oneOf({
+		cards: shapes.object({
+			kind: shapes.data,
+			name: shapes.data,
+			label: shapes.data,
+			icon: shapes.data,
+			title: shapes.field,
+			subtitle: shapes.field,
+			badge: shapes.field,
+			meta: shapes.list(shapes.field)
+		}),
+		custom: shapes.object({
+			kind: shapes.data,
+			name: shapes.data,
+			label: shapes.data,
+			icon: shapes.data,
+			component: shapes.data,
+			fields: shapes.list(shapes.field),
+			props: shapes.refs
+		}, { requires: ["props"] })
+	})),
+	default: shapes.data
+}, { after: keepDefault });
+const widgetShape = shapes.oneOf({
+	range: shapes.object({
+		kind: shapes.data,
+		field: shapes.field,
+		histogram: shapes.data
+	}, { requires: ["field"] }),
+	facets: shapes.object({
+		kind: shapes.data,
+		field: shapes.field,
+		search: shapes.data
+	}, { requires: ["field"] }),
+	dateRange: shapes.object({
+		kind: shapes.data,
+		field: shapes.field,
+		presets: shapes.data
+	}, { requires: ["field"] }),
+	toggle: shapes.object({
+		kind: shapes.data,
+		field: shapes.field
+	}, { requires: ["field"] })
+});
+const layoutShape = (resource, models) => shapes.oneOf({
+	section: shapes.object({
+		kind: shapes.data,
+		title: shapes.data,
+		help: shapes.data,
+		fields: shapes.list(shapes.field, { nonEmpty: true })
+	}, { requires: ["fields"] }),
+	sidebar: shapes.object({
+		kind: shapes.data,
+		fields: shapes.list(shapes.field, { nonEmpty: true })
+	}, { requires: ["fields"] }),
+	related: shapes.map((item) => pruneRelated(item, resource, models)),
+	custom: shapes.object({
+		kind: shapes.data,
+		component: shapes.data,
+		title: shapes.data,
+		sidebar: shapes.data,
+		props: shapes.refs
+	}, { requires: ["props"] })
+});
+const linkShape = (model, models) => shapes.map((run) => {
+	return ("to" in run ? addressErrors(run.to, {
+		models,
+		source: model
+	}).length === 0 : hrefPlaceholders(run.href).every((name) => Object.hasOwn(model.fields, name))) ? run : void 0;
+});
+const actionShape = (model, models) => shapes.object({
+	name: shapes.data,
+	label: shapes.data,
+	icon: shapes.data,
+	confirm: shapes.data,
+	bulk: shapes.data,
+	run: shapes.oneOf({
+		update: shapes.object({
+			kind: shapes.data,
+			values: shapes.keys({ all: true })
+		}, { requires: ["values"] }),
+		delete: shapes.data,
+		link: linkShape(model, models)
+	})
+}, { requires: ["run"] });
+const viewShape = (resource, model, models) => shapes.object({
+	resource: shapes.data,
+	roles: shapes.data,
+	title: shapes.field,
+	searchResult: shapes.object({
+		title: shapes.list(shapes.field, { nonEmpty: true }),
+		subtitle: shapes.field
+	}),
+	nav: shapes.object({
+		hidden: shapes.data,
+		group: shapes.data,
+		order: shapes.data,
+		recent: shapes.map((recent) => navRecentErrors(recent, model).length === 0 ? recent : void 0)
+	}),
+	names: shapes.data,
+	icon: shapes.data,
+	help: shapes.data,
+	fields: shapes.keys(),
+	list: listShape,
+	filters: shapes.list(widgetShape),
+	layout: shapes.list(layoutShape(resource, models)),
+	chart: shapes.object({
+		field: shapes.field,
+		range: shapes.data,
+		granularity: shapes.data
+	}, { requires: ["field"] }),
+	saveFeedback: shapes.data,
+	actions: shapes.list(actionShape(model, models))
+});
 /**
-* The view with every reference to a field the caller cannot read removed: columns, sort, search, field labels,
-* filter widgets, layout, chart, title, search result, the update actions that set one, and the sidebar's `recent` group
-* when its status, filter or order uses a hidden field. Nothing in it may name a hidden field. Related sections are checked against
-* `models`, the caller's view of every resource.
+* The view with every reference to a field the caller cannot read removed: list columns, sort, search and displays,
+* field hints, filter widgets, record sections and custom components' props, the chart, title and search result, the
+* actions that set or read one, and the sidebar's `recent` group. Nothing in it may name a hidden field. Related sections
+* and links are checked against `models`, the caller's view of every resource.
 */
 const pruneView = (view, model, models) => {
-	const visible = (name) => Object.hasOwn(model.fields, name);
-	const { title, chart, list, nav, searchResult, ...rest } = view;
-	const { recent, ...placement } = nav ?? {};
-	const resultTitle = searchResult?.title?.filter(visible);
-	const subtitle = searchResult?.subtitle;
-	return {
-		...rest,
-		...searchResult && { searchResult: {
-			...resultTitle?.length && { title: resultTitle },
-			...subtitle !== void 0 && visible(subtitle) && { subtitle }
-		} },
-		...nav && { nav: recent && navRecentErrors(recent, model).length === 0 ? nav : placement },
-		...title !== void 0 && visible(title) && { title },
-		...chart && visible(chart.field) && { chart },
-		...list && { list: {
-			columns: list.columns.filter(visible),
-			...list.sort && { sort: list.sort.filter(([name]) => visible(name)) },
-			...list.search && { search: list.search.filter(visible) }
-		} },
-		fields: Object.fromEntries(Object.entries(view.fields).filter(([name]) => visible(name))),
-		filters: view.filters.filter((widget) => visible(widget.field)),
-		actions: view.actions.filter((action) => action.run?.kind !== "update" || Object.keys(action.run.values).every(visible)),
-		layout: view.layout.flatMap((item) => {
-			if (item.kind === "related") return pruneRelated(item, view.resource, models);
-			const fields = item.fields.filter(visible);
-			return fields.length > 0 ? [{
-				...item,
-				fields
-			}] : [];
-		})
-	};
+	const pruned = pruneByShape(view, viewShape(view.resource, model, models), (name) => Object.hasOwn(model.fields, name));
+	if (!pruned) throw new Error(`The view of ${view.resource} is not an object`);
+	return pruned;
 };
 //#endregion
 export { pruneView };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -30,9 +30,9 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
-    "@protobase/layout": "0.10.0",
-    "@protobase/query": "0.10.0",
-    "@protobase/schema": "0.10.0",
+    "@protobase/layout": "0.11.0",
+    "@protobase/query": "0.11.0",
+    "@protobase/schema": "0.11.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@simplewebauthn/server": "^13.3.1",
     "better-auth": "^1.7.7",