@protobase/server 0.19.12 → 0.19.14

package/dist/check-views.js

@@ -3,6 +3,7 @@ import { cardPhotosErrors } from "./view-card-photos.js";
 import { cardFavoriteErrors, favoriteOwnerErrors } from "./view-card-favorite.js";
 import { saveSearchErrors, searchesOfErrors } from "./view-saved-search.js";
 import { mapDisplayErrors, mapErrors } from "./view-map.js";
+import { relatedColumnErrors } from "./view-related-column.js";
 import { addressErrors, addressPlaceholders, displayFields, fieldRefsIn, hrefField, hrefPlaceholders, linkActionError } from "@protobase/schema/internal";
 //#region src/check-views.ts
 const linkFields = (run) => run?.kind !== "link" ? [] : "to" in run ? addressPlaceholders(run.to) : hrefPlaceholders(run.href);
@@ -79,6 +80,11 @@ const sharedPhotosErrors = (view) => {
 	const same = (a, b) => a.resource === b.resource && a.field === b.field && a.image === b.image && a.sort === b.sort;
 	return shown.filter(({ photos }) => !same(photos, shown[0].photos)).map(({ name }) => `display "${name}" photos: the list's records load with one set of photos, so name those of display "${shown[0].name}"`);
 };
+const relatedColumnsErrors = (view, model, models) => (view.list?.relatedColumns ?? []).flatMap((column) => [
+	...Object.hasOwn(model.fields, column.name) ? [`"${column.name}" is a field of ${model.name}`] : [],
+	...view.list.columns.includes(column.name) ? [] : ["it is not among the list's columns"],
+	...relatedColumnErrors(column, view.resource, models)
+].map((error) => `related column "${column.name}": ${error}`));
 const galleryErrors = (item, resource, model, models) => {
 	const image = item.image === void 0 ? void 0 : model.fields[item.image];
 	return [...image && image.type !== "file" ? [`"${item.image}" is not a file field`] : [], ...item.photos ? cardPhotosErrors(item.photos, resource, models).map((error) => `photos: ${error}`) : []];
@@ -92,7 +98,7 @@ const listOfErrors = (model, name, models) => {
 * 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 or colours values its enum does not have, shows a field with a field type of
 * `fieldTypes` (each with the storage types it shows) that does not show it,
-* has a related section, a cards display's or gallery's photos or a cards display's favorite button, a `listOf`, a "Save search" button or a
+* has a related section or related list column, a cards display's or gallery's photos or a cards display's favorite button, a `listOf`, a "Save search" button or a
 * `searchesOf` that do not fit the resources, cards
 * displays of one list that name different photos, a map that cannot show the
 * record's position or a map display that cannot find the records in its view, a link to an address the app does not have, or a create page that is not one of `pages`.
@@ -103,7 +109,7 @@ const checkViews = (registry, views, pages = [], fieldTypes = {}) => {
 	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}`) : []);
+		const related = [...view.layout.flatMap((item) => item.kind === "related" ? relatedErrors(item, view.resource, models).map((error) => `related "${item.title}": ${error}`) : []), ...relatedColumnsErrors(view, model, models)];
 		const photos = [
 			...(view.list?.displays ?? []).flatMap((display) => display.kind === "cards" && display.photos ? cardPhotosErrors(display.photos, view.resource, models).map((error) => `display "${display.name}" photos: ${error}`) : []),
 			...sharedPhotosErrors(view),

package/dist/view-access.js

@@ -2,6 +2,7 @@ import { relatedErrors } from "./view-related.js";
 import { cardPhotosErrors } from "./view-card-photos.js";
 import { cardFavoriteErrors } from "./view-card-favorite.js";
 import { searchesOfFor } from "./view-saved-search.js";
+import { relatedColumnErrors } from "./view-related-column.js";
 import { resolveFieldPath } from "@protobase/layout";
 import { addressErrors, hrefPlaceholders, navRecentErrors, pruneByShape, shapes, tableDisplay } from "@protobase/schema/internal";
 //#region src/view-access.ts
@@ -22,20 +23,26 @@ const pruneGallery = (item, resource, model, models) => {
 		kind: "gallery",
 		title: item.title,
 		...image !== void 0 && { image },
-		...photos && { photos }
+		...photos && { photos },
+		...item.when !== void 0 && { when: item.when }
 	};
 };
-const keepDefault = ({ default: opens, displays, ...list }) => {
+const tidyList = (model) => ({ default: opens, displays, columns, relatedColumns, ...list }) => {
 	const shown = displays && displays.length > 0 ? displays : void 0;
 	const kept = opens === tableDisplay || shown?.some((display) => display.name === opens);
+	const related = relatedColumns && relatedColumns.length > 0 ? relatedColumns : void 0;
+	const visible = columns.filter((name) => Object.hasOwn(model.fields, name) || related?.some((column) => column.name === name));
 	return {
 		...list,
+		columns: visible,
+		...related && { relatedColumns: related },
 		...shown && { displays: shown },
 		...opens !== void 0 && kept && { default: opens }
 	};
 };
-const listShape = (resource, models, prompted) => shapes.object({
-	columns: shapes.list(shapes.field),
+const listShape = (resource, model, models, prompted) => shapes.object({
+	columns: shapes.data,
+	relatedColumns: shapes.list(shapes.map((column) => relatedColumnErrors(column, resource, models).length === 0 ? column : void 0)),
 	sort: shapes.list(shapes.tuple(shapes.field, shapes.data)),
 	search: shapes.list(shapes.field),
 	displays: shapes.list(shapes.oneOf({
@@ -81,7 +88,7 @@ const listShape = (resource, models, prompted) => shapes.object({
 		}, { requires: ["props"] })
 	})),
 	default: shapes.data
-}, { after: keepDefault });
+}, { after: tidyList(model) });
 const widgetShape = shapes.oneOf({
 	range: shapes.object({
 		kind: shapes.data,
@@ -115,11 +122,13 @@ const layoutShape = (resource, model, models) => shapes.oneOf({
 		help: shapes.data,
 		helpWhen: shapes.data,
 		presentation: shapes.data,
+		when: shapes.data,
 		fields: shapes.list(shapes.field, { nonEmpty: true })
 	}, { requires: ["fields"] }),
 	sidebar: shapes.object({
 		kind: shapes.data,
-		fields: shapes.list(shapes.field, { nonEmpty: true })
+		fields: shapes.list(shapes.field, { nonEmpty: true }),
+		when: shapes.data
 	}, { requires: ["fields"] }),
 	related: shapes.map((item) => pruneRelated(item, resource, models)),
 	custom: shapes.object({
@@ -127,6 +136,7 @@ const layoutShape = (resource, model, models) => shapes.oneOf({
 		component: shapes.data,
 		title: shapes.data,
 		sidebar: shapes.data,
+		when: shapes.data,
 		props: shapes.refs
 	}, { requires: ["props"] }),
 	map: shapes.object({
@@ -135,7 +145,8 @@ const layoutShape = (resource, model, models) => shapes.oneOf({
 		latitude: shapes.field,
 		longitude: shapes.field,
 		zoom: shapes.data,
-		sidebar: shapes.data
+		sidebar: shapes.data,
+		when: shapes.data
 	}, { requires: ["latitude", "longitude"] }),
 	gallery: shapes.map((item) => pruneGallery(item, resource, model, models))
 });
@@ -178,7 +189,7 @@ const viewShape = (resource, model, models, prompted) => shapes.object({
 	icon: shapes.data,
 	help: shapes.data,
 	fields: shapes.keys(),
-	list: listShape(resource, models, prompted),
+	list: listShape(resource, model, models, prompted),
 	filters: shapes.list(widgetShape),
 	layout: shapes.list(layoutShape(resource, model, models)),
 	chart: shapes.object({
@@ -201,7 +212,7 @@ const viewShape = (resource, model, models, prompted) => shapes.object({
 /**
 * 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, maps, galleries 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
+* actions that set or read one, and the sidebar's `recent` group. Nothing in it may name a hidden field. Related sections, related list columns
 * and links are checked against `models`, the caller's view of every resource, and so are `searchesOf`, cards' favorite
 * buttons and the "Save search" button; the buttons stay for a visitor when their resource is one of `prompted`, those
 * that ask the visitor to sign in.

package/dist/view-related-column.js

@@ -0,0 +1,25 @@
+import { relatedErrors } from "./view-related.js";
+//#region src/view-related-column.ts
+const statusErrors = (target, name) => {
+	const field = Object.hasOwn(target.fields, name) ? target.fields[name] : void 0;
+	if (!field) return [`status: unknown field "${name}" on ${target.name}`];
+	if (field.type !== "enum") return [`status: "${name}" on ${target.name} is not an enum field`];
+	return field.sensitive ? [`status: "${name}" on ${target.name} is sensitive, so it cannot be shown`] : [];
+};
+/**
+* What is wrong with a related records column of the list of `resource`, against these models; empty when it can be
+* shown. It finds its records as a related section does. Against the full models it checks the config; against a
+* caller's models, whether that caller can use it.
+*/
+const relatedColumnErrors = (column, resource, models) => {
+	const { name: _, label: __, status, ...match } = column;
+	const errors = relatedErrors({
+		kind: "related",
+		title: column.name,
+		...match
+	}, resource, models);
+	const target = models[column.resource];
+	return target ? [...errors, ...statusErrors(target, status)] : errors;
+};
+//#endregion
+export { relatedColumnErrors };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.19.12",
+  "version": "0.19.14",
   "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.19.12",
-    "@protobase/query": "0.19.12",
-    "@protobase/schema": "0.19.12",
+    "@protobase/layout": "0.19.14",
+    "@protobase/query": "0.19.14",
+    "@protobase/schema": "0.19.14",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",