@protobase/schema 0.28.1 → 0.28.2

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, RecordMode, RecordWhen, RelatedColumnModel, RelatedModel, RelatedPresentation, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, TabItemModel, TabModel, TimelineView, 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, RecordWhen, RelatedColumnModel, RelatedModel, RelatedPresentation, ResourceModel, SaveFeedback, SaveSearchModel, SearchMatch, SearchResultModel, SearchesOfModel, SectionModel, SectionPresentation, ShowWhen, SignInPromptModel, SignInViewModel, SortSpec, Span, StatusTone, TabItemModel, TabModel, TimelineView, 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";
@@ -43,4 +43,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 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 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 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 TimelineView, 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 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 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 TimelineView, 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/layout.d.ts

@@ -1,4 +1,4 @@
-import { CardPhotosModel, HelpWhen, LayoutItemModel, RecordWhen, RelatedModel, SectionPresentation, ShowWhen } from "./model.js";
+import { CardPhotosModel, HelpWhen, LayoutItemModel, RecordChartRange, RecordWhen, RelatedModel, SectionPresentation, ShowWhen } from "./model.js";
 import { Ref } from "./refs.js";
 import { ComponentRef, ViewProps } from "./view-displays.js";
 //#region src/layout.d.ts
@@ -61,7 +61,7 @@ export declare const layout: {
   }) => 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
+   * charts, 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).
    */
@@ -80,6 +80,22 @@ export declare const layout: {
     sidebar?: boolean;
     when?: ShowWhen;
   }) => LayoutItemModel;
+  /**
+   * Line graphs of numeric fields of the records of `resource` that point at this one through `field`, such as a
+   * machine's metric samples, over their timestamp `at`: per minute over the last hour, per 5 minutes over the last day
+   * and per hour over the last week, the average or the maximum of each bucket, opening on `range` (default `1h`). A
+   * bucket without a sample is a gap. Throws without a series. See
+   * [Charts of related records](website/src/content/docs/reference/ui-config.mdx#charts-of-related-records).
+   */
+  chart: (title: string, o: {
+    resource: string;
+    field: string;
+    at: string;
+    series: string[];
+    range?: RecordChartRange;
+    help?: string;
+    when?: ShowWhen;
+  }) => LayoutItemModel;
   /**
    * The record's changes, newest first: who made each, when, and the fields before and after, only those the user may
    * read. `limit` changes show before Show more (default 10). Needs `.history()` on the resource; a view without a

package/dist/layout.js

@@ -77,7 +77,7 @@ const layout = {
 	},
 	/**
 	* 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
+	* charts, 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).
 	*/
@@ -111,6 +111,27 @@ const layout = {
 		...o.when !== void 0 && { when: o.when }
 	}),
 	/**
+	* Line graphs of numeric fields of the records of `resource` that point at this one through `field`, such as a
+	* machine's metric samples, over their timestamp `at`: per minute over the last hour, per 5 minutes over the last day
+	* and per hour over the last week, the average or the maximum of each bucket, opening on `range` (default `1h`). A
+	* bucket without a sample is a gap. Throws without a series. See
+	* [Charts of related records](website/src/content/docs/reference/ui-config.mdx#charts-of-related-records).
+	*/
+	chart: (title, o) => {
+		if (o.series.length === 0) throw new Error(`l.chart "${title}" needs at least one series`);
+		return {
+			kind: "chart",
+			title,
+			resource: o.resource,
+			field: o.field,
+			at: o.at,
+			series: [...o.series],
+			...o.range !== void 0 && { range: o.range },
+			...o.help !== void 0 && { help: o.help },
+			...o.when !== void 0 && { when: o.when }
+		};
+	},
+	/**
 	* The record's changes, newest first: who made each, when, and the fields before and after, only those the user may
 	* read. `limit` changes show before Show more (default 10). Needs `.history()` on the resource; a view without a
 	* layout shows it last by itself. See [Record history](website/src/content/docs/reference/history.mdx).

package/dist/model.d.ts

@@ -806,6 +806,34 @@ export type MapSectionModel = {
   /** Whether it shows on the form, the read view or both. */
   when?: ShowWhen;
 };
+/** How far back a record chart reaches, ending now: the last hour, day or week. */
+export type RecordChartRange = '1h' | '24h' | '7d';
+/**
+ * Line graphs of numeric fields of the records of `resource` that point at the record through `field`, over their
+ * timestamp `at`: the average or the maximum of each per minute over the last hour, per 5 minutes over the last day
+ * and per hour over the last week, read through the aggregate API with the caller's access. A bucket without a sample
+ * is a gap. See [Charts of related records](website/src/content/docs/reference/ui-config.mdx#charts-of-related-records).
+ */
+export type RecordChartModel = {
+  /** A chart of related records. */
+  kind: 'chart';
+  /** The section's title. */
+  title: string;
+  /** The resource whose records it charts. */
+  resource: string;
+  /** The filterable relation on `resource` that holds this record's key. */
+  field: string;
+  /** The filterable timestamp field of `resource` the records are placed by. */
+  at: string;
+  /** The numeric fields of `resource` it draws, one line each. */
+  series: string[];
+  /** The range it opens on; `1h` when omitted. */
+  range?: RecordChartRange;
+  /** A line under the title. */
+  help?: string;
+  /** Whether it shows on the form, the read view or both. */
+  when?: ShowWhen;
+};
 /**
  * The record's changes, newest first, with who made each and the fields before and after: only fields the caller may
  * read. Needs `.history()` on the resource. See [Record history](website/src/content/docs/reference/history.mdx).
@@ -862,7 +890,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 | TabModel;
+} | RelatedModel | GroupModel | CustomSectionModel | MapSectionModel | RecordChartModel | 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. */
@@ -888,7 +916,7 @@ export type TabModel = {
   items: TabItemModel[];
 };
 /** An item a tab may hold: any of the main column. */
-export type TabItemModel = SectionModel | RelatedModel | GroupModel | CustomSectionModel | MapSectionModel | GalleryModel | HistorySectionModel | CommentsSectionModel;
+export type TabItemModel = SectionModel | RelatedModel | GroupModel | CustomSectionModel | MapSectionModel | RecordChartModel | 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/package.json

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