@protobase/schema 0.13.4 → 0.14.0

package/dist/filter/where.d.ts

@@ -2,57 +2,118 @@ import { FilterExpr, FilterValue } from "../model.js";
 import { Field } from "../field.js";
 import { RecordOf } from "../resource-types.js";
 //#region src/filter/where.d.ts
+/** @inline */
 type Scalar = string | number | boolean;
+/** @inline */
 type Source = {
+  /** The resource's fields, as `resource(...)` declares them. */
   readonly $fields: unknown;
 };
+/** @inline */
 type Fields<R extends Source> = keyof RecordOf<R['$fields']> & string;
+/** @inline */
 type Value<R extends Source, K extends Fields<R>> = Extract<NonNullable<RecordOf<R['$fields']>[K]>, Scalar> | FilterValue;
+/** @inline */
 type Anything = {
+  /** Any fields: names and values are not checked. */
   readonly $fields: Record<string, Field<any>>;
 };
+/**
+ * Builds filters in code, for the client and the UI, as `where` does, with field names and values typed against the
+ * resource `R`: `createWhere<typeof orders>().eq('status', 'paid')`. A filter it builds prints as filter text with
+ * `printFilter`.
+ */
 export declare const createWhere: <R extends Source = Anything>() => {
+  /** The field equals the value: `status = "paid"`. */
   eq: <K extends Fields<R>>(name: K, value: Value<R, K>) => FilterExpr;
+  /** The field differs from the value: `status != "paid"`. */
   ne: <K extends Fields<R>>(name: K, value: Value<R, K>) => FilterExpr;
+  /** The field is below the value: `total < 100`. */
   lt: <K extends Fields<R>>(name: K, value: Value<R, K>) => FilterExpr;
+  /** The field is at most the value: `total <= 100`. */
   lte: <K extends Fields<R>>(name: K, value: Value<R, K>) => FilterExpr;
+  /** The field is above the value: `total > 100`. */
   gt: <K extends Fields<R>>(name: K, value: Value<R, K>) => FilterExpr;
+  /** The field is at least the value: `total >= 100`. */
   gte: <K extends Fields<R>>(name: K, value: Value<R, K>) => FilterExpr;
+  /** The field lies from `low` to `high`, both included. */
   between: <K extends Fields<R>>(name: K, low: Value<R, K>, high: Value<R, K>) => FilterExpr;
+  /** A JSON field holds the value, as a key or an element: `tags:"urgent"`. */
   has: <K extends Fields<R>>(name: K, value: Scalar) => FilterExpr;
+  /** The field has a value, a JSON field one other than `null`: `field:*`. */
   present: <K extends Fields<R>>(name: K) => FilterExpr;
+  /** The field equals one of the values: `in(status, "paid", "sent")`. */
   in: <K extends Fields<R>>(name: K, values: Extract<NonNullable<RecordOf<R["$fields"]>[K]>, Scalar>[]) => FilterExpr;
+  /** The field has no value: `isNull(field)`. */
   isNull: <K extends Fields<R>>(name: K) => FilterExpr;
+  /** Every word of the text appears, ignoring case, in one of the resource's search fields: `search("text")`. */
   search: (text: string) => FilterExpr;
+  /** The text field is close to the text by trigram similarity, typos included: `similar(field, "text")`. */
   similar: <K extends Fields<R>>(name: K, text: string) => FilterExpr;
+  /** The text field matches the regular expression, ignoring case: `regex(field, "pattern")`. */
   regex: <K extends Fields<R>>(name: K, pattern: string) => FilterExpr;
+  /** Every filter holds; one filter is returned as it is, none throws. */
   and: (...args: FilterExpr[]) => FilterExpr;
+  /** At least one filter holds; one filter is returned as it is, none throws. */
   or: (...args: FilterExpr[]) => FilterExpr;
+  /** The filter does not hold. */
   not: (arg: FilterExpr) => FilterExpr;
+  /** The current time, as a value to compare with: `now()`. */
   now: () => FilterValue;
+  /** A time the duration before now, such as `ago('7d')` for `now() - 7d`; units are `s`, `m`, `h`, `d` and `w`. */
   ago: (duration: string) => FilterValue;
+  /** A time the duration after now, such as `fromNow('1h')` for `now() + 1h`. */
   fromNow: (duration: string) => FilterValue;
 };
+/**
+ * Builds a filter in code instead of writing filter text, for any resource; `createWhere` checks names and values
+ * against one. The [Filters](website/src/content/docs/reference/api.md#filters) of the API take what it builds.
+ *
+ * @example
+ * ```ts
+ * where.and(where.eq('status', 'paid'), where.gte('created_at', where.ago('30d')))
+ * ```
+ */
 export declare const where: {
+  /** The field equals the value: `status = "paid"`. */
   eq: <K extends string>(name: K, value: any) => FilterExpr;
+  /** The field differs from the value: `status != "paid"`. */
   ne: <K extends string>(name: K, value: any) => FilterExpr;
+  /** The field is below the value: `total < 100`. */
   lt: <K extends string>(name: K, value: any) => FilterExpr;
+  /** The field is at most the value: `total <= 100`. */
   lte: <K extends string>(name: K, value: any) => FilterExpr;
+  /** The field is above the value: `total > 100`. */
   gt: <K extends string>(name: K, value: any) => FilterExpr;
+  /** The field is at least the value: `total >= 100`. */
   gte: <K extends string>(name: K, value: any) => FilterExpr;
+  /** The field lies from `low` to `high`, both included. */
   between: <K extends string>(name: K, low: any, high: any) => FilterExpr;
+  /** A JSON field holds the value, as a key or an element: `tags:"urgent"`. */
   has: <K extends string>(name: K, value: Scalar) => FilterExpr;
+  /** The field has a value, a JSON field one other than `null`: `field:*`. */
   present: <K extends string>(name: K) => FilterExpr;
+  /** The field equals one of the values: `in(status, "paid", "sent")`. */
   in: <K extends string>(name: K, values: any[]) => FilterExpr;
+  /** The field has no value: `isNull(field)`. */
   isNull: <K extends string>(name: K) => FilterExpr;
+  /** Every word of the text appears, ignoring case, in one of the resource's search fields: `search("text")`. */
   search: (text: string) => FilterExpr;
+  /** The text field is close to the text by trigram similarity, typos included: `similar(field, "text")`. */
   similar: <K extends string>(name: K, text: string) => FilterExpr;
+  /** The text field matches the regular expression, ignoring case: `regex(field, "pattern")`. */
   regex: <K extends string>(name: K, pattern: string) => FilterExpr;
+  /** Every filter holds; one filter is returned as it is, none throws. */
   and: (...args: FilterExpr[]) => FilterExpr;
+  /** At least one filter holds; one filter is returned as it is, none throws. */
   or: (...args: FilterExpr[]) => FilterExpr;
+  /** The filter does not hold. */
   not: (arg: FilterExpr) => FilterExpr;
+  /** The current time, as a value to compare with: `now()`. */
   now: () => FilterValue;
+  /** A time the duration before now, such as `ago('7d')` for `now() - 7d`; units are `s`, `m`, `h`, `d` and `w`. */
   ago: (duration: string) => FilterValue;
+  /** A time the duration after now, such as `fromNow('1h')` for `now() + 1h`. */
   fromNow: (duration: string) => FilterValue;
 };
 //#endregion

package/dist/filter/where.js

@@ -38,6 +38,11 @@ const group = (kind, args) => {
 		span
 	};
 };
+/**
+* Builds filters in code, for the client and the UI, as `where` does, with field names and values typed against the
+* resource `R`: `createWhere<typeof orders>().eq('status', 'paid')`. A filter it builds prints as filter text with
+* `printFilter`.
+*/
 const createWhere = () => {
 	const compare = (op) => (name, value) => ({
 		kind: "compare",
@@ -55,67 +60,96 @@ const createWhere = () => {
 		span
 	});
 	return {
+		/** The field equals the value: `status = "paid"`. */
 		eq: compare("="),
+		/** The field differs from the value: `status != "paid"`. */
 		ne: compare("!="),
+		/** The field is below the value: `total < 100`. */
 		lt: compare("<"),
+		/** The field is at most the value: `total <= 100`. */
 		lte: compare("<="),
+		/** The field is above the value: `total > 100`. */
 		gt: compare(">"),
+		/** The field is at least the value: `total >= 100`. */
 		gte: compare(">="),
+		/** The field lies from `low` to `high`, both included. */
 		between: (name, low, high) => group("and", [compare(">=")(name, low), compare("<=")(name, high)]),
+		/** A JSON field holds the value, as a key or an element: `tags:"urgent"`. */
 		has: (name, value) => ({
 			kind: "has",
 			field: field(name),
 			value: literal(value),
 			span
 		}),
+		/** The field has a value, a JSON field one other than `null`: `field:*`. */
 		present: (name) => ({
 			kind: "present",
 			field: field(name),
 			span
 		}),
+		/** The field equals one of the values: `in(status, "paid", "sent")`. */
 		in: (name, values) => ({
 			kind: "in",
 			field: field(name),
 			values: values.map(literal),
 			span
 		}),
+		/** The field has no value: `isNull(field)`. */
 		isNull: (name) => ({
 			kind: "isNull",
 			field: field(name),
 			span
 		}),
+		/** Every word of the text appears, ignoring case, in one of the resource's search fields: `search("text")`. */
 		search: (text) => ({
 			kind: "search",
 			text,
 			span
 		}),
+		/** The text field is close to the text by trigram similarity, typos included: `similar(field, "text")`. */
 		similar: (name, text) => ({
 			kind: "similar",
 			field: field(name),
 			text,
 			span
 		}),
+		/** The text field matches the regular expression, ignoring case: `regex(field, "pattern")`. */
 		regex: (name, pattern) => ({
 			kind: "regex",
 			field: field(name),
 			pattern,
 			span
 		}),
+		/** Every filter holds; one filter is returned as it is, none throws. */
 		and: (...args) => group("and", args),
+		/** At least one filter holds; one filter is returned as it is, none throws. */
 		or: (...args) => group("or", args),
+		/** The filter does not hold. */
 		not: (arg) => ({
 			kind: "not",
 			arg,
 			span
 		}),
+		/** The current time, as a value to compare with: `now()`. */
 		now: () => ({
 			kind: "now",
 			span
 		}),
+		/** A time the duration before now, such as `ago('7d')` for `now() - 7d`; units are `s`, `m`, `h`, `d` and `w`. */
 		ago: offset("-"),
+		/** A time the duration after now, such as `fromNow('1h')` for `now() + 1h`. */
 		fromNow: offset("+")
 	};
 };
+/**
+* Builds a filter in code instead of writing filter text, for any resource; `createWhere` checks names and values
+* against one. The [Filters](website/src/content/docs/reference/api.md#filters) of the API take what it builds.
+*
+* @example
+* ```ts
+* where.and(where.eq('status', 'paid'), where.gte('created_at', where.ago('30d')))
+* ```
+*/
 const where = createWhere();
 //#endregion
 export { createWhere, where };

package/dist/index.d.ts

@@ -1,31 +1,25 @@
-import { FileProcessor, FileProcessorInput, ImageFormat, ImageVariant, ImageVariantOptions, checkedAccept, checkedProvider, imageFormats, parseSize } from "./files/file-options.js";
+import { FileOptions, FileProcessor, FileProcessorInput, ImageFormat, ImageVariant, ImageVariantOptions, imageFormats } from "./files/file-options.js";
 import { ActionModel, ActionRun, AppAddress, BadgeShape, BottomBarItemModel, BottomBarModel, CardPhotosModel, ChartGranularity, ChartModel, ChartRange, CheckedFilter, CompareOp, CustomSectionModel, DatePreset, DurationLiteral, DurationUnit, EventModel, EventOperation, FieldFormat, FieldModel, FieldPath, FieldType, FieldViewModel, FieldWidgetModel, FileFieldModel, FilterError, FilterErrorCode, FilterExpr, FilterLayout, FilterOf, FilterValue, FilterWidgetModel, JsonValue, KeyValue, LayoutItemModel, ListDisplayModel, ListModel, ListQuery, Literal, MapSectionModel, MapView, 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 { Field } from "./field.js";
+import { AnyField, Constraint, Field, FieldMeta, FieldTypeDef } from "./field.js";
+import { RelationField } from "./relation-field.js";
 import { FileField } from "./file-field.js";
 import { f } from "./fields.js";
-import { EventActor, EventContext, EventHelpers, EventMatch, EventSpec } from "./events/event-helpers.js";
-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 { FieldRefs, FieldsInput, Ref, Refs } from "./refs.js";
+import { CreatedOptions, DeletedOptions, EventActor, EventContext, EventHelpers, EventMatch, EventSpec, UndeletedOptions, UpdatedOptions } from "./events/event-helpers.js";
+import { Access, InferRecord, Issue, KeyOf, KeyRefs, RecordKey, RecordOf } from "./resource-types.js";
+import { ResourceBuilder, SearchRef, SearchRefs, Validator, resource } from "./resource.js";
+import { ComponentRef, ViewProps } from "./view-displays.js";
+import { FieldView } from "./view-field.js";
+import { FieldViews, ViewBuilder, view } from "./view.js";
+import { FieldRefValue, fieldRef } from "./field-ref.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 { BottomBarSource, bottomBar, 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 { KeyType, keyTypes } from "./keys.js";
 import { addressWords, appPath, readAppPath } from "./app-address.js";
-import { PluginHost, PluginRequirement, inRange, pluginProblem } from "./plugin-version.js";
-import { redactSecrets } from "./redact-secrets.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,8 +27,8 @@ import { printFilter } from "./filter/print.js";
 import { OrderByCheck, OrderByParse, checkOrderBy, parseOrderBy, printOrderBy } from "./filter/order-by.js";
 import { createWhere, where } from "./filter/where.js";
 import "./filter/index.js";
-import { Capability, CapabilityAction, CapabilityScope } from "./access/capability.js";
-import { CapabilityLimit, RoleEntry, anonymousRole } from "./access/role-entry.js";
+import { Capability, CapabilityAction, CapabilityScope, Grant } from "./access/capability.js";
+import { CapabilityLimit, HeldCapability, RoleEntry, anonymousRole } from "./access/role-entry.js";
 import { Rule, rule } from "./access/rule.js";
 import { RoleLimit, Roles, RolesOptions, defineRoles } from "./access/roles.js";
 import { pickView } from "./access/pick-view.js";
@@ -42,6 +36,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";
-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 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 BadgeShape, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardPhotosModel, 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 FieldWidgetModel, 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 ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type JsonValue, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PluginHost, type PluginRequirement, type PropShapes, type RecordKey, type RefShape, type RelatedModel, type ResolveOptions, type ResolvedAccess, type ResourceModel, type RoleEntry, type RoleLimit, 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, anonymousRole, 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, imageFormats, inRange, isFieldRef, keyTypes, layout as l, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, pluginProblem, printFilter, printOrderBy, pruneByShape, readAppPath, readEventStream, redactSecrets, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };
+export { type Access, type AccessAction, type AccessContext, type AccessFn, type AccessResult, type AccessSource, type AccessUser, type ActionModel, type ActionRun, type AnyField, 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 BadgeShape, type BottomBarItemModel, type BottomBarModel, type BottomBarNames, type BottomBarSource, type Capability, type CapabilityAction, type CapabilityLimit, type CapabilityScope, type CardPhotosModel, type ChartGranularity, type ChartModel, type ChartRange, type CheckResult, type CheckedFilter, type CompareOp, type ComponentRef, type Constraint, type CreatedOptions, type CustomSectionModel, type DatePreset, type DeletedOptions, 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 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 Grant, type HeldCapability, type ImageFormat, type ImageVariant, type ImageVariantOptions, type InferRecord, type Issue, type JsonValue, type KeyOf, type KeyRefs, type KeyType, type KeyValue, type LayoutItemModel, type ListDisplayModel, type ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type RecordKey, type RecordOf, type Ref, type Refs, type RelatedModel, type RelationField, type ResolveOptions, type ResolvedAccess, type ResourceBuilder, type ResourceModel, type RoleEntry, type RoleLimit, type Roles, type RolesOptions, type RowFilterOperation, type Rule, type SaveFeedback, type SearchMatch, type SearchRef, type SearchRefs, type SearchResultModel, type SortSpec, type Span, type StatusTone, type UndeletedOptions, type UpdatedOptions, type UserMenuItemModel, type UserMenuModel, type UserMenuSource, type Validator, type ViewBuilder, type ViewModel, type ViewProps, accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, resolveAccess, resource, restrictModel, rule, userMenu, view, where };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { checkedAccept, checkedProvider, imageFormats, parseSize } from "./files/file-options.js";
+import { imageFormats } from "./files/file-options.js";
 import { f } from "./fields.js";
 import { parseFilter } from "./filter/parse.js";
 import { checkFilter } from "./filter/check.js";
@@ -8,30 +8,18 @@ import { checkOrderBy, parseOrderBy, printOrderBy } from "./filter/order-by.js";
 import { createWhere, where } from "./filter/where.js";
 import { anonymousRole } from "./access/role-entry.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 { fieldRef } from "./field-ref.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 { bottomBar, maxBottomBarItems } from "./bottom-bar.js";
 import { bottomBarErrors } from "./bottom-bar-errors.js";
-import { decodeKey, encodeKey, keyTypes } from "./keys.js";
+import { layout } from "./layout.js";
+import { keyTypes } from "./keys.js";
 import { addressWords, appPath, readAppPath } from "./app-address.js";
-import { inRange, pluginProblem } from "./plugin-version.js";
-import { redactSecrets } from "./redact-secrets.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, addressErrors, addressPlaceholders, addressWords, anonymousRole, 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, imageFormats, inRange, isFieldRef, keyTypes, layout as l, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, pluginProblem, printFilter, printOrderBy, pruneByShape, readAppPath, readEventStream, redactSecrets, resolveAccess, resource, restrictModel, rule, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, userMenu, view, webhookResources, where };
+export { accessWarnings, addressWords, anonymousRole, appPath, bottomBar, bottomBarErrors, checkFilter, checkOrderBy, checkRecord, createWhere, defineRoles, enumLabel, evaluateFilter, f, fieldRef, fieldsUsedBy, imageFormats, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, resolveAccess, resource, restrictModel, rule, userMenu, view, where };

package/dist/internal.d.ts

@@ -0,0 +1,17 @@
+import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
+import { displayFields, tableDisplay } from "./view-displays.js";
+import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
+import { bottomBarFor } from "./bottom-bar.js";
+import { decodeKey, encodeKey } from "./keys.js";
+import { checkEventFilter } from "./events/event-models.js";
+import { webhookResources } from "./webhooks/webhook-resources.js";
+import { PropShapes, RefShape, pruneByShape, shapes } from "./ref-shape.js";
+import { SearchTerm, matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
+import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
+import { PluginHost, PluginRequirement, inRange, pluginProblem } from "./plugin-version.js";
+import { redactSecrets } from "./redact-secrets.js";
+import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
+import { AddressCheck, addressErrors } from "./address-errors.js";
+import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
+import { readEventStream } from "./assistant/event-stream.js";
+export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };

package/dist/internal.js

@@ -0,0 +1,17 @@
+import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
+import { checkEventFilter } from "./events/event-models.js";
+import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
+import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
+import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
+import { displayFields, tableDisplay } from "./view-displays.js";
+import { bottomBarFor } from "./bottom-bar.js";
+import { decodeKey, encodeKey } from "./keys.js";
+import { webhookResources } from "./webhooks/webhook-resources.js";
+import { pruneByShape, shapes } from "./ref-shape.js";
+import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
+import { inRange, pluginProblem } from "./plugin-version.js";
+import { redactSecrets } from "./redact-secrets.js";
+import { addressErrors } from "./address-errors.js";
+import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
+import { readEventStream } from "./assistant/event-stream.js";
+export { addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };

package/dist/keys.d.ts

@@ -1,5 +1,6 @@
 import { FieldType, KeyValue, ResourceModel } from "./model.js";
 //#region src/keys.d.ts
+/** The field types a primary key part may have: `integer`, `bigint`, `uuid` or `text`. */
 export type KeyType = Extract<FieldType, 'integer' | 'bigint' | 'uuid' | 'text'>;
 export declare const encodeKey: (key: KeyValue | readonly KeyValue[]) => string;
 export declare const decodeKey: (encoded: string, types: readonly KeyType[]) => string | number | (string | number)[];

package/dist/layout.d.ts

@@ -2,10 +2,25 @@ import { LayoutItemModel, RelatedModel } from "./model.js";
 import { Ref } from "./refs.js";
 import { ComponentRef, ViewProps } from "./view-displays.js";
 //#region src/layout.d.ts
+/**
+ * The items of a record page, for a view's `.layout((r) => [...])`, exported as `l`. See
+ * [The record page](website/src/content/docs/reference/ui-config.mdx#the-record-page).
+ *
+ * @example
+ * ```ts
+ * view<typeof repairs>('repairs').layout((r) => [
+ *   l.section('Repair', [r.bike, r.problem, r.status]),
+ *   l.sidebar([r.booked_on, r.estimate]),
+ *   l.related('Parts used', { resource: 'repair_parts', field: 'repair_id' }),
+ * ])
+ * ```
+ */
 export declare const layout: {
+  /** A titled group of fields in the main column, editable where the user may write; `help` is a line under the title. */
   section: (title: string, fields: Ref[], o?: {
     help?: string;
   }) => LayoutItemModel;
+  /** A read-only summary card of fields beside the main column. */
   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;

package/dist/layout.js

@@ -1,13 +1,28 @@
 import { markFieldRefs } from "./field-ref.js";
 import { customComponent } from "./view-displays.js";
 //#region src/layout.ts
+/**
+* The items of a record page, for a view's `.layout((r) => [...])`, exported as `l`. See
+* [The record page](website/src/content/docs/reference/ui-config.mdx#the-record-page).
+*
+* @example
+* ```ts
+* view<typeof repairs>('repairs').layout((r) => [
+*   l.section('Repair', [r.bike, r.problem, r.status]),
+*   l.sidebar([r.booked_on, r.estimate]),
+*   l.related('Parts used', { resource: 'repair_parts', field: 'repair_id' }),
+* ])
+* ```
+*/
 const layout = {
+	/** A titled group of fields in the main column, editable where the user may write; `help` is a line under the title. */
 	section: (title, fields, o = {}) => ({
 		kind: "section",
 		title,
 		fields: fields.map((ref) => ref.name),
 		...o.help !== void 0 && { help: o.help }
 	}),
+	/** A read-only summary card of fields beside the main column. */
 	sidebar: (fields) => ({
 		kind: "sidebar",
 		fields: fields.map((ref) => ref.name)