@protobase/schema 0.9.0 → 0.11.0

package/dist/access/resolve.d.ts

@@ -18,6 +18,7 @@ export type ResolveOptions = {
    */
   roles?: {
     can: (capability: any) => Rule;
+    definitions?: Record<string, unknown>;
   };
   /**
    * Overrides what an operation without a rule does. Without `roles` the default is `allow`,

package/dist/address-errors.d.ts

@@ -0,0 +1,16 @@
+import { AppAddress, ResourceModel } from "./model.js";
+//#region src/address-errors.d.ts
+export type AddressCheck = {
+  /** The resources; against a caller's restricted models, the check says whether that caller can follow the link. */
+  models: Record<string, ResourceModel>;
+  /** The composed pages; without them a page's name is not checked. */
+  pages?: ReadonlySet<string>;
+  /** The resource of the record the link sits on, whose fields its `{field}` placeholders name. */
+  source?: ResourceModel;
+};
+/**
+ * What is wrong with a link's address against these models: an unknown resource or page, a `{field}` the record it sits
+ * on does not have, or a filter or order naming fields the resource does not have. Empty when it can be followed.
+ */
+export declare const addressErrors: (to: AppAddress, { models, pages, source }: AddressCheck) => string[];
+//#endregion

package/dist/address-errors.js

@@ -0,0 +1,59 @@
+import { parseFilter } from "./filter/parse.js";
+import { checkFilter } from "./filter/check.js";
+import { checkOrderBy, parseOrderBy } from "./filter/order-by.js";
+import { addressPlaceholders } from "./address-template.js";
+//#region src/address-errors.ts
+const nameErrors = [
+	"unknown-field",
+	"not-filterable",
+	"not-sortable",
+	"unsupported-traversal",
+	"invalid-traversal"
+];
+const withSamples = (filter) => filter.replace(/(["']?)\{[A-Za-z_][A-Za-z0-9_]*\}\1/g, (_, quote) => quote ? `${quote}x${quote}` : "0");
+const filterErrors = (model, filter) => {
+	const parsed = parseFilter(withSamples(filter));
+	if (!parsed.ok) return parsed.errors.map((error) => `filter: ${error.message}`);
+	if (!parsed.ast) return [];
+	const checked = checkFilter(model, parsed.ast);
+	return checked.ok ? [] : checked.errors.filter((error) => nameErrors.includes(error.code)).map((error) => `filter: ${error.message}`);
+};
+const orderErrors = (model, orderBy) => {
+	if (addressPlaceholders({
+		kind: "list",
+		resource: model.name,
+		orderBy
+	}).length > 0) return [];
+	const parsed = parseOrderBy(orderBy);
+	if (!parsed.ok) return parsed.errors.map((error) => `orderBy: ${error.message}`);
+	const checked = checkOrderBy(model, parsed.items);
+	return checked.ok ? [] : checked.errors.map((error) => `orderBy: ${error.message}`);
+};
+/**
+* What is wrong with a link's address against these models: an unknown resource or page, a `{field}` the record it sits
+* on does not have, or a filter or order naming fields the resource does not have. Empty when it can be followed.
+*/
+const addressErrors = (to, { models, pages, source }) => {
+	const placeholders = addressPlaceholders(to).flatMap((name) => {
+		if (!source) return [`"{${name}}" takes a value from the record, but the link sits on none`];
+		return Object.hasOwn(source.fields, name) ? [] : [`"{${name}}" is not a field of ${source.name}`];
+	});
+	switch (to.kind) {
+		case "page": return pages && !pages.has(to.page) ? [`unknown page "${to.page}"`] : [];
+		case "list":
+		case "record":
+		case "create": {
+			const target = Object.hasOwn(models, to.resource) ? models[to.resource] : void 0;
+			if (!target) return [`unknown resource "${to.resource}"`];
+			if (to.kind !== "list") return placeholders;
+			return [
+				...placeholders,
+				...to.filter ? filterErrors(target, to.filter) : [],
+				...to.orderBy ? orderErrors(target, to.orderBy) : []
+			];
+		}
+		default: return [`an address's kind is list, record, create or page, not "${String(to.kind)}"`];
+	}
+};
+//#endregion
+export { addressErrors };

package/dist/address-template.d.ts

@@ -0,0 +1,16 @@
+import { AppAddress } from "./model.js";
+//#region src/address-template.d.ts
+/** The fields whose values a link's address takes from the record, from its `{field}` placeholders. */
+export declare const addressPlaceholders: (to: AppAddress) => string[];
+/** The fields an href takes from the record, from its `{field}` placeholders. */
+export declare const hrefPlaceholders: (href: string) => string[];
+/** `to` with every `{field}` in its key, filter and order replaced by the record's value; a missing value becomes empty. */
+export declare const fillAddress: (to: AppAddress, record?: Record<string, unknown>) => AppAddress;
+/**
+ * Whether an href leaves the app: it starts with a scheme (`https:`, `mailto:`) or `//`. A path inside the app is an
+ * address, given as `to`, so that it is written one way everywhere.
+ */
+export declare const leavesApp: (href: string) => boolean;
+/** Why an href cannot be a link's `href`: it points inside the app, which takes an address in `to`. */
+export declare const appHrefError: (href: string) => string | undefined;
+//#endregion

package/dist/address-template.js

@@ -0,0 +1,38 @@
+//#region src/address-template.ts
+const placeholder = /\{([A-Za-z_][A-Za-z0-9_]*)\}/g;
+const names = (text) => [...text.matchAll(placeholder)].map((match) => match[1]);
+const templated = (to) => {
+	if (to.kind === "record") return (Array.isArray(to.key) ? to.key : [to.key]).filter((part) => typeof part === "string");
+	if (to.kind === "list") return [to.filter, to.orderBy].filter((part) => part !== void 0);
+	return [];
+};
+/** The fields whose values a link's address takes from the record, from its `{field}` placeholders. */
+const addressPlaceholders = (to) => [...new Set(templated(to).flatMap(names))];
+/** The fields an href takes from the record, from its `{field}` placeholders. */
+const hrefPlaceholders = (href) => [...new Set(names(href))];
+const fill = (text, record) => text.replace(placeholder, (_, name) => record[name] === null || record[name] === void 0 ? "" : String(record[name]));
+/** `to` with every `{field}` in its key, filter and order replaced by the record's value; a missing value becomes empty. */
+const fillAddress = (to, record = {}) => {
+	if (to.kind === "record") {
+		const part = (value) => typeof value === "string" ? fill(value, record) : value;
+		return {
+			...to,
+			key: Array.isArray(to.key) ? to.key.map(part) : part(to.key)
+		};
+	}
+	if (to.kind !== "list") return to;
+	return {
+		...to,
+		...to.filter !== void 0 && { filter: fill(to.filter, record) },
+		...to.orderBy !== void 0 && { orderBy: fill(to.orderBy, record) }
+	};
+};
+/**
+* Whether an href leaves the app: it starts with a scheme (`https:`, `mailto:`) or `//`. A path inside the app is an
+* address, given as `to`, so that it is written one way everywhere.
+*/
+const leavesApp = (href) => /^([a-z][a-z0-9+.-]*:|\/\/)/i.test(href);
+/** Why an href cannot be a link's `href`: it points inside the app, which takes an address in `to`. */
+const appHrefError = (href) => leavesApp(href) ? void 0 : `href "${href}" points inside the app; give the link \`to\` instead, an address such as { kind: 'record', resource: 'orders', key: '{order_id}' }`;
+//#endregion
+export { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp };

package/dist/app-address.d.ts

@@ -0,0 +1,26 @@
+import { AppAddress } from "./model.js";
+//#region src/app-address.d.ts
+/**
+ * The words of the app's addresses. Only `appPath` and `readAppPath` write and read them, so the shape of an address
+ * changes in this module alone.
+ */
+export declare const addressWords: {
+  /** A list's filter (AIP-160), as the list API takes it. */
+  readonly filter: "filter";
+  /** A list's order (AIP-132). */
+  readonly orderBy: "order_by";
+  /** The list display shown, when it is not the view's default. */
+  readonly display: "display";
+  /** Where a list's filters sit: `bar` (the default) or `panel`. */
+  readonly filterLayout: "layout";
+  /** The second path segment that opens a resource's create form instead of a record. */
+  readonly create: "new";
+};
+/** The path of `address` below `basePath` (such as `/admin`), every name and key encoded the one way the app reads them. */
+export declare const appPath: (address: AppAddress, basePath?: string) => string;
+/**
+ * The address `pathAndQuery` (below the base path) shows, or `undefined` for anything else: the root, the app's own
+ * pages under `/-/`, or a path that is not one. A first segment in `pages` is a composed page, otherwise a resource.
+ */
+export declare const readAppPath: (pathAndQuery: string, pages: ReadonlySet<string>) => AppAddress | undefined;
+//#endregion

package/dist/app-address.js

@@ -0,0 +1,90 @@
+import { encodeKey } from "./keys.js";
+//#region src/app-address.ts
+/**
+* The words of the app's addresses. Only `appPath` and `readAppPath` write and read them, so the shape of an address
+* changes in this module alone.
+*/
+const addressWords = {
+	/** A list's filter (AIP-160), as the list API takes it. */
+	filter: "filter",
+	/** A list's order (AIP-132). */
+	orderBy: "order_by",
+	/** The list display shown, when it is not the view's default. */
+	display: "display",
+	/** Where a list's filters sit: `bar` (the default) or `panel`. */
+	filterLayout: "layout",
+	/** The second path segment that opens a resource's create form instead of a record. */
+	create: "new"
+};
+const listWords = [
+	"display",
+	"filter",
+	"orderBy",
+	"filterLayout"
+];
+const listQuery = (address) => {
+	const query = new URLSearchParams();
+	for (const name of listWords) {
+		const value = address[name];
+		if (value !== void 0 && value !== "") query.set(addressWords[name], value);
+	}
+	const text = query.toString();
+	return text ? `?${text}` : "";
+};
+/** The path of `address` below `basePath` (such as `/admin`), every name and key encoded the one way the app reads them. */
+const appPath = (address, basePath = "") => {
+	switch (address.kind) {
+		case "page": return `${basePath}/${encodeURIComponent(address.page)}`;
+		case "create": return `${basePath}/${encodeURIComponent(address.resource)}/${addressWords.create}`;
+		case "record": return `${basePath}/${encodeURIComponent(address.resource)}/${encodeURIComponent(encodeKey(address.key))}`;
+		case "list": return `${basePath}/${encodeURIComponent(address.resource)}${listQuery(address)}`;
+	}
+};
+const decodeSegments = (pathname) => {
+	try {
+		return pathname.split("/").filter(Boolean).map(decodeURIComponent);
+	} catch (error) {
+		if (error instanceof URIError) return void 0;
+		throw error;
+	}
+};
+const filterLayout = (value) => value === "bar" || value === "panel" ? value : void 0;
+/**
+* The address `pathAndQuery` (below the base path) shows, or `undefined` for anything else: the root, the app's own
+* pages under `/-/`, or a path that is not one. A first segment in `pages` is a composed page, otherwise a resource.
+*/
+const readAppPath = (pathAndQuery, pages) => {
+	const url = new URL(pathAndQuery, "http://app");
+	const segments = decodeSegments(url.pathname);
+	if (!segments || segments.length === 0 || segments.length > 2) return void 0;
+	const [first, second] = segments;
+	if (first === "-") return void 0;
+	if (pages.has(first)) return second === void 0 ? {
+		kind: "page",
+		page: first
+	} : void 0;
+	if (second === addressWords.create) return {
+		kind: "create",
+		resource: first
+	};
+	if (second !== void 0) return {
+		kind: "record",
+		resource: first,
+		key: second
+	};
+	const params = url.searchParams;
+	const display = params.get(addressWords.display) || void 0;
+	const filter = params.get(addressWords.filter) || void 0;
+	const orderBy = params.get(addressWords.orderBy) || void 0;
+	const layout = filterLayout(params.get(addressWords.filterLayout));
+	return {
+		kind: "list",
+		resource: first,
+		...display && { display },
+		...filter && { filter },
+		...orderBy && { orderBy },
+		...layout && { filterLayout: layout }
+	};
+};
+//#endregion
+export { addressWords, appPath, readAppPath };

package/dist/bottom-bar-errors.d.ts

@@ -0,0 +1,14 @@
+import { BottomBarModel } from "./model.js";
+//#region src/bottom-bar-errors.d.ts
+/** What the bottom bars may name. Without `roles` (an app whose roles are not declared) any role is accepted. */
+export type BottomBarNames = {
+  resources: readonly string[];
+  pages: readonly string[];
+  roles?: readonly string[];
+};
+/**
+ * Why the bottom bars do not fit the app, as messages; empty when they do. Pure, so it can run wherever the config is
+ * known: at startup today, when a bundle is built later.
+ */
+export declare const bottomBarErrors: (bars: BottomBarModel[], names: BottomBarNames) => string[];
+//#endregion

package/dist/bottom-bar-errors.js

@@ -0,0 +1,33 @@
+import "./bottom-bar.js";
+//#region src/bottom-bar-errors.ts
+const itemErrors = (item, names) => {
+	if (item.kind === "resource" && !names.resources.includes(item.resource)) return [`resource "${item.resource}" does not exist`];
+	if (item.kind === "page" && !names.pages.includes(item.page)) return [`page "${item.page}" does not exist`];
+	return [];
+};
+const barErrors = (bar, names) => {
+	const unknownRoles = names.roles ? bar.roles.filter((role) => !names.roles.includes(role)) : [];
+	return [
+		...bar.roles.length === 0 ? ["needs at least one role"] : [],
+		...unknownRoles.map((role) => `role "${role}" is not one of the roles: ${names.roles.join(", ")}`),
+		...bar.items.length === 0 ? ["needs at least one item"] : [],
+		...bar.items.length > 4 ? [`has ${bar.items.length} items; at most 4 fit beside "More"`] : [],
+		...bar.items.flatMap((item) => itemErrors(item, names))
+	].map((error) => `Bottom bar "${bar.label}": ${error}`);
+};
+const overlapErrors = (bars) => bars.flatMap((bar, index) => {
+	const earlier = bars.slice(0, index);
+	const sameLabel = earlier.some((other) => other.label === bar.label) ? [`Two bottom bars are labelled "${bar.label}"; give each its own label`] : [];
+	const shared = bar.roles.flatMap((role) => {
+		const other = earlier.find((candidate) => candidate.roles.includes(role));
+		return other ? [`Bottom bars "${other.label}" and "${bar.label}" both name role "${role}"; a role belongs to one bottom bar`] : [];
+	});
+	return [...sameLabel, ...shared];
+});
+/**
+* Why the bottom bars do not fit the app, as messages; empty when they do. Pure, so it can run wherever the config is
+* known: at startup today, when a bundle is built later.
+*/
+const bottomBarErrors = (bars, names) => [...bars.flatMap((bar) => barErrors(bar, names)), ...overlapErrors(bars)];
+//#endregion
+export { bottomBarErrors };

package/dist/bottom-bar.d.ts

@@ -0,0 +1,35 @@
+import { BottomBarItemModel, BottomBarModel } from "./model.js";
+//#region src/bottom-bar.d.ts
+/** The tabs beside the last one, "More", which opens the sidebar: five tabs in all, as on iOS. */
+export declare const maxBottomBarItems = 4;
+declare const items: {
+  /** Opens the resource's list. */
+  resource: (resource: string, options: {
+    label: string;
+    icon?: string;
+  }) => BottomBarItemModel;
+  /** Opens a composed page (`page()` from @protobase/layout). */
+  page: (page: string, options: {
+    label: string;
+    icon?: string;
+  }) => BottomBarItemModel;
+  /** An address outside the admin, opened in a new tab: `https:`, `http:` or `mailto:`. */
+  link: (label: string, href: string, options?: {
+    icon?: string;
+  }) => BottomBarItemModel;
+};
+/** What the server needs from a `bottomBar(...)` export of the config module. */
+export type BottomBarSource = {
+  toBottomBarModel(): BottomBarModel;
+};
+/**
+ * Tabs at the bottom of the screen on phones, for the users holding one of `roles`. Export one per group of roles; a
+ * role belongs to one bottom bar. `label` names the bar where someone with several switches between them.
+ */
+export declare const bottomBar: (options: {
+  label: string;
+  roles: string[];
+}, build: (m: typeof items) => BottomBarItemModel[]) => BottomBarSource;
+/** The bottom bar of someone working as `role`: the one that names it, since a role belongs to one bar. */
+export declare const bottomBarFor: (bars: readonly BottomBarModel[], role: string | undefined) => BottomBarModel | undefined;
+//#endregion

package/dist/bottom-bar.js

@@ -0,0 +1,44 @@
+import { isMenuHref } from "./menu-href.js";
+//#region src/bottom-bar.ts
+/** The tabs beside the last one, "More", which opens the sidebar: five tabs in all, as on iOS. */
+const maxBottomBarItems = 4;
+const items = {
+	/** Opens the resource's list. */
+	resource: (resource, options) => ({
+		kind: "resource",
+		resource,
+		...options
+	}),
+	/** Opens a composed page (`page()` from @protobase/layout). */
+	page: (page, options) => ({
+		kind: "page",
+		page,
+		...options
+	}),
+	/** An address outside the admin, opened in a new tab: `https:`, `http:` or `mailto:`. */
+	link: (label, href, options = {}) => {
+		if (!isMenuHref(href)) throw new Error(`Bottom bar link "${label}": href must start with https://, http:// or mailto:`);
+		return {
+			kind: "link",
+			label,
+			href,
+			...options
+		};
+	}
+};
+/**
+* Tabs at the bottom of the screen on phones, for the users holding one of `roles`. Export one per group of roles; a
+* role belongs to one bottom bar. `label` names the bar where someone with several switches between them.
+*/
+const bottomBar = (options, build) => {
+	const model = {
+		label: options.label,
+		roles: [...options.roles],
+		items: build(items)
+	};
+	return { toBottomBarModel: () => structuredClone(model) };
+};
+/** The bottom bar of someone working as `role`: the one that names it, since a role belongs to one bar. */
+const bottomBarFor = (bars, role) => role === void 0 ? void 0 : bars.find((bar) => bar.roles.includes(role));
+//#endregion
+export { bottomBar, bottomBarFor, maxBottomBarItems };

package/dist/field-ref.d.ts

@@ -0,0 +1,19 @@
+import { JsonValue } from "./model.js";
+//#region src/field-ref.d.ts
+/**
+ * A field named inside free-form data, such as a custom component's props: `{ $field: 'status' }`, or a path through
+ * relations (`plan.name`) on a page. Marked, so that the walker leaving out hidden fields finds it wherever it is.
+ */
+export type FieldRefValue = {
+  readonly $field: string;
+};
+/** A field reference for a layout's custom component props, such as `<UsageChart field={fieldRef('total')} />`. */
+export declare const fieldRef: (path: string) => FieldRefValue;
+export declare const isFieldRef: (value: unknown) => value is FieldRefValue;
+/** Props as a view stores them: every `r.field` in them, at any depth, becomes a field reference. */
+export declare const markFieldRefs: (value: unknown) => JsonValue;
+/** Props as a custom component gets them: every field reference as its field's name. */
+export declare const unmarkFieldRefs: <T>(value: T) => T;
+/** Every field the value names through field references, at any depth. */
+export declare const fieldRefsIn: (value: unknown) => string[];
+//#endregion

package/dist/field-ref.js

@@ -0,0 +1,29 @@
+import { isRef } from "./refs.js";
+//#region src/field-ref.ts
+/** A field reference for a layout's custom component props, such as `<UsageChart field={fieldRef('total')} />`. */
+const fieldRef = (path) => ({ $field: path });
+const isFieldRef = (value) => typeof value === "object" && value !== null && !Array.isArray(value) && Object.keys(value).length === 1 && typeof value.$field === "string";
+const isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** Props as a view stores them: every `r.field` in them, at any depth, becomes a field reference. */
+const markFieldRefs = (value) => {
+	if (isRef(value)) return fieldRef(value.name);
+	if (Array.isArray(value)) return value.map(markFieldRefs);
+	if (isObject(value)) return Object.fromEntries(Object.entries(value).map(([name, entry]) => [name, markFieldRefs(entry)]));
+	return value;
+};
+/** Props as a custom component gets them: every field reference as its field's name. */
+const unmarkFieldRefs = (value) => {
+	if (isFieldRef(value)) return value.$field;
+	if (Array.isArray(value)) return value.map(unmarkFieldRefs);
+	if (isObject(value)) return Object.fromEntries(Object.entries(value).map(([name, entry]) => [name, unmarkFieldRefs(entry)]));
+	return value;
+};
+/** Every field the value names through field references, at any depth. */
+const fieldRefsIn = (value) => {
+	if (isFieldRef(value)) return [value.$field];
+	if (Array.isArray(value)) return value.flatMap(fieldRefsIn);
+	if (isObject(value)) return Object.values(value).flatMap(fieldRefsIn);
+	return [];
+};
+//#endregion
+export { fieldRef, fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ActionModel, ActionRun, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterOf, FilterValue, FilterWidgetModel, KeyValue, LayoutItemModel, ListModel, ListQuery, Literal, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SearchMatch, SearchResultModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
+import { ActionModel, ActionRun, AppAddress, BottomBarItemModel, BottomBarModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListModel, ListQuery, Literal, NavModel, NavRecentModel, NowValue, OrderByItem, RelatedModel, ResourceModel, SaveFeedback, SearchMatch, SearchResultModel, SortSpec, Span, StatusTone, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
 import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./access/types.js";
 import { FileProcessor, FileProcessorInput, checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
 import { Field } from "./field.js";
@@ -8,14 +8,22 @@ import { EventActor, EventContext, EventHelpers, EventMatch, EventSpec } from ".
 import { InferRecord, RecordKey } from "./resource-types.js";
 import { resource } from "./resource.js";
 import { checkEventFilter } from "./events/event-models.js";
+import { ComponentRef, ViewProps, displayFields, tableDisplay } from "./view-displays.js";
 import { view } from "./view.js";
 import { webhookResources } from "./webhooks/webhook-resources.js";
+import { FieldRefValue, fieldRef, fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
+import { PropShapes, RefShape, pruneByShape, shapes } from "./ref-shape.js";
 import { enumLabel } from "./enum-label.js";
 import { SearchTerm, matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { UserMenuSource, userMenu } from "./user-menu.js";
+import { BottomBarSource, bottomBar, bottomBarFor, maxBottomBarItems } from "./bottom-bar.js";
+import { BottomBarNames, bottomBarErrors } from "./bottom-bar-errors.js";
 import { layout } from "./layout.js";
 import { KeyType, decodeKey, encodeKey, keyTypes } from "./keys.js";
+import { addressWords, appPath, readAppPath } from "./app-address.js";
+import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
+import { AddressCheck, addressErrors } from "./address-errors.js";
 import { FilterLimits, FilterParse, parseFilter } from "./filter/parse.js";
 import { CheckResult, checkFilter } from "./filter/check.js";
 import { EvaluateOptions, evaluateFilter } from "./filter/evaluate.js";
@@ -33,4 +41,4 @@ import "./access/index.js";
 import { AssistantAction, AssistantActionRequest, AssistantCardPart, AssistantDiff, AssistantEvent, AssistantMessage, AssistantMessageRequest, AssistantPart, AssistantState, AssistantStep, AssistantStepState, AssistantTablePart, AssistantTextPart, AssistantTone, AssistantWidgetPart } from "./assistant/protocol.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, type AssistantAction, type AssistantActionRequest, type AssistantCardPart, type AssistantDiff, type AssistantEvent, type AssistantMessage, type AssistantMessageRequest, type AssistantPart, type AssistantState, type AssistantStep, type AssistantStepState, type AssistantTablePart, type AssistantTextPart, type AssistantTone, type AssistantWidgetPart, type Capability, type CapabilityAction, type CapabilityScope, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type DatePreset, type DurationLiteral, type DurationUnit, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type Field, type FieldAccess, type FieldFormat, type FieldModel, type FieldPath, type FieldRule, type FieldType, type FieldViewModel, type FileField, type FileFieldModel, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type InferRecord, type KeyType, type KeyValue, type LayoutItemModel, type ListModel, type ListQuery, type Literal, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type RecordKey, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SearchMatch, type SearchResultModel, type SearchTerm, type SortSpec, type Span, type StatusTone, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type ViewModel, accessWarnings, applyAssistantEvent, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, webhookResources, where };
+export { type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, type AddressCheck, type AppAddress, type AssistantAction, type AssistantActionRequest, type AssistantCardPart, type AssistantDiff, type AssistantEvent, type AssistantMessage, type AssistantMessageRequest, type AssistantPart, type AssistantState, type AssistantStep, type AssistantStepState, type AssistantTablePart, type AssistantTextPart, type AssistantTone, type AssistantWidgetPart, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type Capability, type CapabilityAction, type CapabilityScope, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type CustomSectionModel, type DatePreset, type DurationLiteral, type DurationUnit, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type Field, type FieldAccess, type FieldFormat, type FieldModel, type FieldPath, type FieldRefValue, type FieldRule, type FieldType, type FieldViewModel, type FileField, type FileFieldModel, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type InferRecord, type JsonValue, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PropShapes, type RecordKey, type RefShape, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SearchMatch, type SearchResultModel, type SearchTerm, type SortSpec, type Span, type StatusTone, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type ViewModel, type ViewProps, accessWarnings, addressErrors, addressPlaceholders, addressWords, appHrefError, appPath, applyAssistantEvent, bottomBar, bottomBarErrors, bottomBarFor, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, displayFields, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldRef, fieldRefsIn, fieldsUsedBy, fillAddress, hrefPlaceholders, isFieldRef, keyTypes, layout as l, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, pruneByShape, readAppPath, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };

package/dist/index.js

@@ -9,18 +9,26 @@ import { createWhere, where } from "./filter/where.js";
 import { accessWarnings, checkRecord, fieldsUsedBy, resolveAccess } from "./access/resolve.js";
 import { checkEventFilter } from "./events/event-models.js";
 import { resource } from "./resource.js";
+import { fieldRef, fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
+import { displayFields, tableDisplay } from "./view-displays.js";
 import { layout } from "./layout.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
+import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
 import { view } from "./view.js";
 import { webhookResources } from "./webhooks/webhook-resources.js";
+import { pruneByShape, shapes } from "./ref-shape.js";
 import { enumLabel } from "./enum-label.js";
 import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { userMenu } from "./user-menu.js";
+import { bottomBar, bottomBarFor, maxBottomBarItems } from "./bottom-bar.js";
+import { bottomBarErrors } from "./bottom-bar-errors.js";
 import { decodeKey, encodeKey, keyTypes } from "./keys.js";
+import { addressWords, appPath, readAppPath } from "./app-address.js";
+import { addressErrors } from "./address-errors.js";
 import { rule } from "./access/rule.js";
 import { defineRoles } from "./access/roles.js";
 import { pickView } from "./access/pick-view.js";
 import { restrictModel } from "./access/restrict.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { accessWarnings, applyAssistantEvent, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, webhookResources, where };
+export { accessWarnings, addressErrors, addressPlaceholders, addressWords, appHrefError, appPath, applyAssistantEvent, bottomBar, bottomBarErrors, bottomBarFor, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, displayFields, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldRef, fieldRefsIn, fieldsUsedBy, fillAddress, hrefPlaceholders, isFieldRef, keyTypes, layout as l, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, pruneByShape, readAppPath, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };

package/dist/layout.d.ts

@@ -1,5 +1,6 @@
 import { LayoutItemModel, RelatedModel } from "./model.js";
 import { Ref } from "./refs.js";
+import { ComponentRef, ViewProps } from "./view-displays.js";
 //#region src/layout.d.ts
 export declare const layout: {
   section: (title: string, fields: Ref[], o?: {
@@ -8,5 +9,15 @@ export declare const layout: {
   sidebar: (fields: Ref[]) => LayoutItemModel;
   /** A table of the records of another resource that point at this one, directly or through a join table. */
   related: (title: string, o: Omit<RelatedModel, "kind" | "title">) => LayoutItemModel;
+  /**
+   * A component of the project, registered in `protobase.ui.tsx` under its name, drawn where it is listed: in the main
+   * column, or in the sidebar with `sidebar: true`. The record page stays around it, with its title, breadcrumbs,
+   * actions and save; the component reads the record with `useLayoutRecord()`.
+   */
+  custom: <P extends object>(component: ComponentRef<P>, o?: {
+    title?: string;
+    props?: ViewProps<P>;
+    sidebar?: boolean;
+  }) => LayoutItemModel;
 };
 //#endregion

package/dist/layout.js

@@ -1,3 +1,5 @@
+import { markFieldRefs } from "./field-ref.js";
+import { customComponent } from "./view-displays.js";
 //#region src/layout.ts
 const layout = {
 	section: (title, fields, o = {}) => ({
@@ -15,6 +17,18 @@ const layout = {
 		kind: "related",
 		title,
 		...structuredClone(o)
+	}),
+	/**
+	* A component of the project, registered in `protobase.ui.tsx` under its name, drawn where it is listed: in the main
+	* column, or in the sidebar with `sidebar: true`. The record page stays around it, with its title, breadcrumbs,
+	* actions and save; the component reads the record with `useLayoutRecord()`.
+	*/
+	custom: (component, o = {}) => ({
+		kind: "custom",
+		component: customComponent(component, "l.custom"),
+		...o.title !== void 0 && { title: o.title },
+		...o.props && { props: markFieldRefs(o.props) },
+		...o.sidebar && { sidebar: true }
 	})
 };
 //#endregion

package/dist/menu-href.js

@@ -0,0 +1,5 @@
+//#region src/menu-href.ts
+/** Where a menu link may point: a web or mail address outside the admin, never `javascript:` or a path inside it. */
+const isMenuHref = (href) => /^(https?:\/\/|mailto:)/i.test(href);
+//#endregion
+export { isMenuHref };