@protobase/schema 0.22.8 → 0.22.10

package/dist/app-address.d.ts

@@ -27,6 +27,8 @@ export declare const addressWords: {
   readonly edit: "edit";
   /** A record page's open collapsed group, by title, once per group. */
   readonly open: "open";
+  /** A record page's shown tab, by title. */
+  readonly tab: "tab";
 };
 /** 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

@@ -26,7 +26,9 @@ const addressWords = {
 	/** A record's form, `edit=true`, on a view whose record page opens as a read view or locked. */
 	edit: "edit",
 	/** A record page's open collapsed group, by title, once per group. */
-	open: "open"
+	open: "open",
+	/** A record page's shown tab, by title. */
+	tab: "tab"
 };
 const listWords = [
 	"list",
@@ -81,6 +83,7 @@ const recordQuery = (address) => {
 	const query = new URLSearchParams();
 	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);
 	const text = query.toString();
 	return text ? `?${text}` : "";
 };
@@ -130,12 +133,14 @@ 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;
 		return {
 			kind: "record",
 			resource: first,
 			key: second,
 			...url.searchParams.get(addressWords.edit) === "true" && { edit: true },
-			...open.length > 0 && { open }
+			...open.length > 0 && { open },
+			...tab && { tab }
 		};
 	}
 	const params = url.searchParams;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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, ListModel, ListQuery, Literal, MapSectionModel, MapView, NamedListModel, NavModel, NavRecentModel, NowValue, OrderByItem, PeriodChartModel, RecordMode, RecordWhen, RelatedColumnModel, RelatedModel, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, 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, ListModel, ListQuery, Literal, MapSectionModel, MapView, NamedListModel, NavModel, NavRecentModel, NowValue, OrderByItem, PeriodChartModel, RecordMode, RecordWhen, RelatedColumnModel, RelatedModel, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, TabItemModel, TabModel, UserMenuItemModel, UserMenuModel, ViewModel } from "./model.js";
 import { AccessAction, AccessContext, AccessFn, AccessResult, AccessUser, FieldAccess, FieldRule } from "./access/types.js";
 import { AnyField, Constraint, Field, FieldMeta, FieldTypeDef } from "./field.js";
 import { RelationField } from "./relation-field.js";
@@ -42,4 +42,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 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 Constraint, type CreateModel, 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 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 ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NamedListModel, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PeriodChartInput, type PeriodChartModel, type RecordKey, type RecordMode, type RecordOf, type RecordWhen, type Ref, type Refs, type RelatedColumnModel, 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 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 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, fitsKeyType, formPath, formRoute, imageFormats, isRecordCondition, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, 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 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 Constraint, type CreateModel, 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 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 ListModel, type ListQuery, type Literal, type MapSectionModel, type MapView, type NamedListModel, type NavModel, type NavRecentModel, type NowValue, type OrderByCheck, type OrderByItem, type OrderByParse, type PeriodChartInput, type PeriodChartModel, type RecordKey, type RecordMode, type RecordOf, type RecordWhen, type Ref, type Refs, type RelatedColumnModel, 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 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 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, fitsKeyType, formPath, formRoute, imageFormats, isRecordCondition, keyTypes, layout as l, maxBottomBarItems, parseFilter, parseOrderBy, pickView, printFilter, printOrderBy, readAppPath, readFormAddress, readSignInAddress, resolveAccess, resource, restrictModel, rule, signInParams, signInPath, signInRoute, signInSteps, userMenu, view, where };

package/dist/internal.js

@@ -3,6 +3,7 @@ import { promptError, promptFields, renderPrompt } from "./ai-prompt.js";
 import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
 import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { checkEventFilter } from "./events/event-models.js";
+import { layoutItems } from "./layout-items.js";
 import { viewOfList } from "./named-list.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { actionInputErrors, shownInputs } from "./action-inputs.js";
@@ -19,5 +20,4 @@ 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";
-import { layoutItems } from "./layout-items.js";
 export { actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, calendarErrors, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, layoutItems, leavesApp, linkActionError, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/layout-items.d.ts

@@ -1,5 +1,5 @@
 import { LayoutItemModel } from "./model.js";
 //#region src/layout-items.d.ts
-/** The layout's items with every group's items in its place, for code that looks for sections and related tables wherever they sit. */
+/** The layout's items with every tab's and group's items in its place, for code that looks for items wherever they sit. */
 export declare const layoutItems: (layout: readonly LayoutItemModel[]) => LayoutItemModel[];
 //#endregion

package/dist/layout-items.js

@@ -1,5 +1,5 @@
 //#region src/layout-items.ts
-/** The layout's items with every group's items in its place, for code that looks for sections and related tables wherever they sit. */
-const layoutItems = (layout) => layout.flatMap((item) => item.kind === "group" ? item.items : [item]);
+/** The layout's items with every tab's and group's items in its place, for code that looks for items wherever they sit. */
+const layoutItems = (layout) => layout.flatMap((item) => item.kind === "group" || item.kind === "tab" ? layoutItems(item.items) : [item]);
 //#endregion
 export { layoutItems };

package/dist/layout.d.ts

@@ -59,6 +59,13 @@ export declare const layout: {
     collapsed?: boolean;
     when?: RecordWhen;
   }) => LayoutItemModel;
+  /**
+   * A tab of the record page holding main-column items: sections, groups, related tables, custom components, maps,
+   * galleries, history and comments. A view's tabs stand together and show as one strip, the first tab open unless the
+   * address names another; items before and after them show on every tab. Throws on a sidebar item or another tab. See
+   * [Tabs](website/src/content/docs/reference/ui-config.mdx#tabs).
+   */
+  tab: (title: string, items: LayoutItemModel[]) => 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

@@ -75,6 +75,21 @@ const layout = {
 			...o.when !== void 0 && { when: o.when }
 		};
 	},
+	/**
+	* A tab of the record page holding main-column items: sections, groups, related tables, custom components, maps,
+	* galleries, history and comments. A view's tabs stand together and show as one strip, the first tab open unless the
+	* address names another; items before and after them show on every tab. Throws on a sidebar item or another tab. See
+	* [Tabs](website/src/content/docs/reference/ui-config.mdx#tabs).
+	*/
+	tab: (title, items) => {
+		const wrong = items.find((item) => item.kind === "sidebar" || item.kind === "tab" || (item.kind === "custom" || item.kind === "map") && item.sidebar);
+		if (wrong) throw new Error(`l.tab "${title}" holds main-column items, not ${wrong.kind === "sidebar" || wrong.kind === "tab" ? wrong.kind : `a sidebar ${wrong.kind}`}`);
+		return {
+			kind: "tab",
+			title,
+			items
+		};
+	},
 	/** A table of the records of another resource that point at this one, directly or through a join table. */
 	related: (title, o) => ({
 		kind: "related",

package/dist/model.d.ts

@@ -222,6 +222,8 @@ export type AppAddress = {
   edit?: boolean;
   /** The titles of the record page's collapsed groups that are open. */
   open?: readonly string[];
+  /** The title of the record page's tab shown; the first tab when omitted. */
+  tab?: string;
 } | {
   /** The form for a new record. */
   kind: 'create';
@@ -754,7 +756,7 @@ export type LayoutItemModel = SectionModel | {
   fields: string[];
   /** Whether it shows on the form, the read view or both, or a condition on the saved record that it shows while it holds. */
   when?: RecordWhen;
-} | RelatedModel | GroupModel | CustomSectionModel | MapSectionModel | GalleryModel | HistorySectionModel | CommentsSectionModel;
+} | RelatedModel | GroupModel | CustomSectionModel | MapSectionModel | GalleryModel | HistorySectionModel | CommentsSectionModel | TabModel;
 /** A titled group of sections and related tables on the record page, closed until opened with `collapsed`; see [Groups](website/src/content/docs/reference/ui-config.mdx#groups). */
 export type GroupModel = {
   /** A group of sections and related tables. */
@@ -770,6 +772,17 @@ export type GroupModel = {
 };
 /** An item a group may hold. */
 export type GroupItemModel = SectionModel | RelatedModel;
+/** A tab of the record page, holding main-column items; a view's tabs stand together as one strip. See [Tabs](website/src/content/docs/reference/ui-config.mdx#tabs). */
+export type TabModel = {
+  /** A tab of the record page. */
+  kind: 'tab';
+  /** Its label, unique among the view's tabs: the address names the open tab by it. */
+  title: string;
+  /** The main-column items it shows, in order. */
+  items: TabItemModel[];
+};
+/** An item a tab may hold: any of the main column. */
+export type TabItemModel = SectionModel | RelatedModel | GroupModel | CustomSectionModel | MapSectionModel | GalleryModel | HistorySectionModel | CommentsSectionModel;
 /**
  * A record's photos as tiles in the main column under `title`, one large and the next few smaller, opening a lightbox
  * that steps through them all: first the record's own file field `image`, then the `image` of the records of

package/dist/view.js

@@ -1,5 +1,6 @@
 import { createRefs, ref } from "./refs.js";
 import { formNamePattern } from "./form-address.js";
+import { layoutItems } from "./layout-items.js";
 import { isMenuHref } from "./menu-href.js";
 import { viewOfList } from "./named-list.js";
 import { navRecentErrors } from "./nav-recent.js";
@@ -301,12 +302,23 @@ var ViewBuilder = class ViewBuilder {
 		const clash = resource ? list?.relatedColumns?.find((column) => Object.hasOwn(resource.fields, column.name)) : void 0;
 		if (clash) throw new Error(`View "${this.state.resource}": related column "${clash.name}" has the name of a field of the resource`);
 		const groupTitles = /* @__PURE__ */ new Set();
-		for (const item of this.state.layout) {
+		const tabs = this.state.layout.flatMap((item, index) => item.kind === "tab" ? [{
+			item,
+			index
+		}] : []);
+		const apart = tabs.find((tab, at) => at > 0 && tab.index !== tabs[at - 1].index + 1);
+		if (apart) throw new Error(`View "${this.state.resource}": tabs stand together, and "${apart.item.title}" is apart from the others`);
+		const tabTitles = /* @__PURE__ */ new Set();
+		for (const { item } of tabs) {
+			if (tabTitles.has(item.title)) throw new Error(`View "${this.state.resource}": two tabs are titled "${item.title}"`);
+			tabTitles.add(item.title);
+		}
+		for (const item of this.state.layout.flatMap((item) => item.kind === "tab" ? item.items : [item])) {
 			if (item.kind !== "group") continue;
 			if (groupTitles.has(item.title)) throw new Error(`View "${this.state.resource}": two groups are titled "${item.title}"`);
 			groupTitles.add(item.title);
 		}
-		for (const item of resource ? this.state.layout : []) {
+		for (const item of resource ? layoutItems(this.state.layout) : []) {
 			if (item.kind !== "gallery" || item.image === void 0) continue;
 			if (!Object.hasOwn(resource.fields, item.image)) throw new Error(`View "${this.state.resource}": gallery "${item.title}" names field "${item.image}", which the resource does not have`);
 			if (resource.fields[item.image].type !== "file") throw new Error(`View "${this.state.resource}": gallery "${item.title}" shows "${item.image}" as its image, which is not a file field`);

package/package.json

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