@protobase/schema 0.55.5 → 0.55.7

package/dist/app-address.d.ts

@@ -31,6 +31,8 @@ export declare const addressWords: {
   readonly open: "open";
   /** A record page's shown tab, by title. */
   readonly tab: "tab";
+  /** A record's standard page, `standard=true`, on a view whose record page is a component of the app's own. */
+  readonly standard: "standard";
 };
 /** 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;

package/dist/app-address.js

@@ -30,7 +30,9 @@ const addressWords = {
 	/** A record page's open collapsed group, by title, once per group. */
 	open: "open",
 	/** A record page's shown tab, by title. */
-	tab: "tab"
+	tab: "tab",
+	/** A record's standard page, `standard=true`, on a view whose record page is a component of the app's own. */
+	standard: "standard"
 };
 const listWords = [
 	"list",
@@ -87,6 +89,7 @@ const recordQuery = (address) => {
 	if (address.edit) query.set(addressWords.edit, "true");
 	for (const title of address.open ?? []) query.append(addressWords.open, title);
 	if (address.tab) query.set(addressWords.tab, address.tab);
+	if (address.standard) query.set(addressWords.standard, "true");
 	const text = query.toString();
 	return text ? `?${text}` : "";
 };
@@ -139,13 +142,15 @@ const readAppPath = (pathAndQuery, pages) => {
 	if (second !== void 0) {
 		const open = [...new Set(url.searchParams.getAll(addressWords.open).filter((title) => title !== ""))];
 		const tab = url.searchParams.get(addressWords.tab) || void 0;
+		const standard = url.searchParams.get(addressWords.standard) === "true";
 		return {
 			kind: "record",
 			resource: first,
 			key: second,
 			...url.searchParams.get(addressWords.edit) === "true" && { edit: true },
 			...open.length > 0 && { open },
-			...tab && { tab }
+			...tab && { tab },
+			...standard && { standard }
 		};
 	}
 	const params = url.searchParams;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Rollup, RollupCount, RollupFn, RollupSource, RollupValue } from "./computed/rollup.js";
 import { FileOptions, FileProcessor, FileProcessorInput, ImageFormat, ImageVariant, ImageVariantOptions, imageFormats } from "./files/file-options.js";
-import { ActionInputKind, ActionInputModel, ActionModel, ActionRun, AppAddress, BadgeShape, BottomBarItemModel, BottomBarModel, CalendarView, CardFavoriteModel, CardPhotosModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CommentsSectionModel, CompareOp, CreateModel, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, ExportModel, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FieldWidgetModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, FormModel, GalleryModel, GroupChartModel, GroupItemModel, GroupModel, HelpWhen, HistorySectionModel, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListDragModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, NamedListModel, NavModel, NavRecentModel, NowValue, OrderByItem, ParentAccess, ParentModel, PeriodChartModel, PositionAfterModel, RecordChartModel, RecordChartRange, RecordMode, RecordWhen, RelatedColumnModel, RelatedModel, RelatedPresentation, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, TabItemModel, TabModel, TimelineView, TitleFromModel, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
+import { ActionInputKind, ActionInputModel, ActionModel, ActionRun, AppAddress, BadgeShape, BottomBarItemModel, BottomBarModel, CalendarView, CardFavoriteModel, CardPhotosModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CommentsSectionModel, CompareOp, CreateModel, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, ExportModel, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FieldWidgetModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, FormModel, GalleryModel, GroupChartModel, GroupItemModel, GroupModel, HelpWhen, HistorySectionModel, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListDragModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, NamedListModel, NavModel, NavRecentModel, NowValue, OrderByItem, ParentAccess, ParentModel, PeriodChartModel, PositionAfterModel, RecordChartModel, RecordChartRange, RecordMode, RecordPageModel, RecordWhen, RelatedColumnModel, RelatedModel, RelatedPresentation, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, TabItemModel, TabModel, TimelineView, TitleFromModel, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
 import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./access/types.js";
 import { Encrypted, encrypted } from "./encrypted-value.js";
 import { AnyField, Constraint, Field, FieldMeta, FieldTypeDef } from "./field.js";
@@ -47,4 +47,4 @@ import { AccessSource, ResolveOptions, ResolvedAccess, RowFilterOperation, acces
 import { restrictModel } from "./access/restrict.js";
 import "./access/index.js";
 import { AssistantAction, AssistantActionRequest, AssistantCardPart, AssistantDiff, AssistantEvent, AssistantMessage, AssistantMessageRequest, AssistantPart, AssistantState, AssistantStep, AssistantStepState, AssistantTablePart, AssistantTextPart, AssistantTone, AssistantWidgetPart } from "./assistant/protocol.js";
-export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionInputKind, type ActionInputModel, type ActionModel, type ActionRun, type AnyField, type AppAddress, type ArgumentSpec, type ArgumentType, type ArgumentsSpec, 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 BadgeShape, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type CalendarView, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartInput, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CommentsSectionModel, type CompareOp, type ComponentRef, type ComputedReveal, type ConnectAddress, type Constraint, type CreateModel, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, type DurationLiteral, type DurationUnit, type Encrypted, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type ExactCapability, type ExportModel, type Field, type FieldAccess, type FieldFormat, type FieldMeta, type FieldModel, type FieldPath, type FieldRefValue, type FieldRefs, type FieldRule, type FieldType, type FieldTypeDef, type FieldView, type FieldViewModel, type FieldViews, type FieldWidgetModel, type FieldsInput, type FileField, type FileFieldModel, type FileOptions, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type FormAddress, type FormInput, type FormModel, type GalleryModel, type Grant, type GroupChartInput, type GroupChartModel, type GroupItemModel, type GroupModel, type HeldCapability, type HelpWhen, type HistorySectionModel, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListColumn, type ListDisplayModel, type ListDragModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NamedListModel, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type ParentAccess, type ParentModel, type PeriodChartInput, type PeriodChartModel, type PositionAfterModel, type RecordChartModel, type RecordChartRange, type RecordKey, type RecordMode, type RecordOf, type RecordWhen, type Ref, type Refs, type RelatedColumnModel, type RelatedModel, type RelatedPresentation, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RevealCaller, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type Rollup, type RollupCount, type RollupFn, type RollupSource, type RollupValue, type RowFilterOperation, type Rule, type SaveFeedback, type SaveSearchModel, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SearchesOfModel, type SectionModel, type SectionPresentation, type ShowWhen, type SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, type TabItemModel, type TabModel, type TenantOptions, type TimelineView, type TitleFromModel, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, argumentsSchema, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, connectParams, connectPath, connectRoute, createWhere, defineRoles, encrypted, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, fitsKeyType, formPath, formRoute, imageFormats, isRecordCondition, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readConnectAddress, readFormAddress, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };
+export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionInputKind, type ActionInputModel, type ActionModel, type ActionRun, type AnyField, type AppAddress, type ArgumentSpec, type ArgumentType, type ArgumentsSpec, 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 BadgeShape, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type CalendarView, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardFavoriteModel, type CardPhotosModel, type ChartGranularity, type ChartInput, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CommentsSectionModel, type CompareOp, type ComponentRef, type ComputedReveal, type ConnectAddress, type Constraint, type CreateModel, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, type DurationLiteral, type DurationUnit, type Encrypted, type EvaluateOptions, type EventActor, type EventContext, type EventHelpers, type EventMatch, type EventModel, type EventOperation, type EventSpec, type ExactCapability, type ExportModel, type Field, type FieldAccess, type FieldFormat, type FieldMeta, type FieldModel, type FieldPath, type FieldRefValue, type FieldRefs, type FieldRule, type FieldType, type FieldTypeDef, type FieldView, type FieldViewModel, type FieldViews, type FieldWidgetModel, type FieldsInput, type FileField, type FileFieldModel, type FileOptions, type FileProcessor, type FileProcessorInput, type FilterError, type FilterErrorCode, type FilterExpr, type FilterLayout, type FilterLimits, type FilterOf, type FilterParse, type FilterValue, type FilterWidgetModel, type FormAddress, type FormInput, type FormModel, type GalleryModel, type Grant, type GroupChartInput, type GroupChartModel, type GroupItemModel, type GroupModel, type HeldCapability, type HelpWhen, type HistorySectionModel, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListColumn, type ListDisplayModel, type ListDragModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NamedListModel, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type ParentAccess, type ParentModel, type PeriodChartInput, type PeriodChartModel, type PositionAfterModel, type RecordChartModel, type RecordChartRange, type RecordKey, type RecordMode, type RecordOf, type RecordPageModel, type RecordWhen, type Ref, type Refs, type RelatedColumnModel, type RelatedModel, type RelatedPresentation, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RevealCaller, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type Rollup, type RollupCount, type RollupFn, type RollupSource, type RollupValue, type RowFilterOperation, type Rule, type SaveFeedback, type SaveSearchModel, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SearchesOfModel, type SectionModel, type SectionPresentation, type ShowWhen, type SignInAddress, type SignInPromptModel, type SignInStep, type SignInViewModel, type SortSpec, type Span, type StatusTone, type TabItemModel, type TabModel, type TenantOptions, type TimelineView, type TitleFromModel, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, argumentsSchema, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, connectParams, connectPath, connectRoute, createWhere, defineRoles, encrypted, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, fitsKeyType, formPath, formRoute, imageFormats, isRecordCondition, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readConnectAddress, readFormAddress, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };

package/dist/model.d.ts

@@ -275,6 +275,11 @@ export type AppAddress = {
   open?: readonly string[];
   /** The title of the record page's tab shown; the first tab when omitted. */
   tab?: string;
+  /**
+   * The record's standard page, with its form, related records, Edit and Delete, on a view whose record page is a
+   * component of the app's own (`.record({ component })`). A view without one ignores it.
+   */
+  standard?: boolean;
 } | {
   /** The form for a new record. */
   kind: 'create';
@@ -1312,6 +1317,8 @@ export type ViewModel = {
   export?: false | ExportModel;
   /** The page that creates the resource's records, in place of the create form. */
   create?: CreateModel;
+  /** The component of the app's own that is the whole record page, in place of the standard one. */
+  record?: RecordPageModel;
   /** Public forms that create its records for people without an account, each at `/-/forms/<name>`. */
   forms?: FormModel[];
   /** Other lists of the resource, each with its own sidebar entry and address. */
@@ -1364,6 +1371,11 @@ export type CreateModel = {
   /** The composed page shown at `/<resource>/new`, which the list's New button opens. */
   page: string;
 };
+/** The record page as a component of the app's own (`.record(...)`), filling the content area. */
+export type RecordPageModel = {
+  /** The component, by the name `protobase.ui.tsx` exports it under. */
+  component: string;
+};
 /** The list page's Export (`.export(...)`): how many rows a file may hold. */
 export type ExportModel = {
   /** The most rows one file holds; the rows after them are left out, and the export says so. */

package/dist/view.d.ts

@@ -4,7 +4,7 @@ import { actions } from "./view-actions.js";
 import { ChartInput } from "./view-chart.js";
 import { FormInput } from "./view-form.js";
 import { ListColumn, columns } from "./view-columns.js";
-import { displays } from "./view-displays.js";
+import { ComponentRef, displays } from "./view-displays.js";
 import { FieldView } from "./view-field.js";
 import { widgets } from "./view-widgets.js";
 //#region src/view.d.ts
@@ -193,6 +193,17 @@ export declare class ViewBuilder<R extends {
    * [Create pages](website/src/content/docs/reference/ui-config.mdx#create-pages).
    */
   create(options: CreateModel): ViewBuilder<R>;
+  /**
+   * The record page at `/<resource>/<key>` is `component`, a component of the app's own declared with `component(...)`
+   * and exported from `protobase.ui.tsx`, filling the content area beside the sidebar and under the top bar, where the
+   * page does not scroll. It reads the record with `useLayoutRecord()`. The standard record page stays at the record's
+   * address with `standard: true`, which the component links to; it shows instead while the component is missing or
+   * when it throws. Throws when `component` is a built-in block. See
+   * [Full-area record pages](website/src/content/docs/reference/ui-config.mdx#full-area-record-pages).
+   */
+  record(options: {
+    component: ComponentRef<never>;
+  }): ViewBuilder<R>;
   /**
    * This resource holds saved searches of `resource`, which a list page saves with `.saveSearch(...)`: its list page
    * shows each of the user's searches with its filters, its `controls` to change in place, the records it finds (with

package/dist/view.js

@@ -8,7 +8,7 @@ import { actions } from "./view-actions.js";
 import { chartModel } from "./view-chart.js";
 import { formModel } from "./view-form.js";
 import { columns, isListColumn } from "./view-columns.js";
-import { boardErrors, datesErrors, displayErrors, displayFields, displays } from "./view-displays.js";
+import { boardErrors, customComponent, datesErrors, displayErrors, displayFields, displays } from "./view-displays.js";
 import { FieldView } from "./view-field.js";
 import { widgets } from "./view-widgets.js";
 //#region src/view.ts
@@ -280,6 +280,18 @@ var ViewBuilder = class ViewBuilder {
 		return this.next({ create: { ...options } });
 	}
 	/**
+	* The record page at `/<resource>/<key>` is `component`, a component of the app's own declared with `component(...)`
+	* and exported from `protobase.ui.tsx`, filling the content area beside the sidebar and under the top bar, where the
+	* page does not scroll. It reads the record with `useLayoutRecord()`. The standard record page stays at the record's
+	* address with `standard: true`, which the component links to; it shows instead while the component is missing or
+	* when it throws. Throws when `component` is a built-in block. See
+	* [Full-area record pages](website/src/content/docs/reference/ui-config.mdx#full-area-record-pages).
+	*/
+	record(options) {
+		const record = { component: customComponent(options.component, "record component") };
+		return this.next({ record });
+	}
+	/**
 	* This resource holds saved searches of `resource`, which a list page saves with `.saveSearch(...)`: its list page
 	* shows each of the user's searches with its filters, its `controls` to change in place, the records it finds (with
 	* `unseen`, newest first, those new since the user last opened its results marked) and a link to all of them. Throws in

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.55.5",
+  "version": "0.55.7",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {