@protobase/schema 0.8.2 → 0.10.0

package/dist/access/resolve.d.ts

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

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

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

package/dist/bottom-bar-errors.js

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

package/dist/bottom-bar.d.ts

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

package/dist/bottom-bar.js

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -9,12 +9,15 @@ import { createWhere, where } from "./filter/where.js";
 import { accessWarnings, checkRecord, fieldsUsedBy, resolveAccess } from "./access/resolve.js";
 import { checkEventFilter } from "./events/event-models.js";
 import { resource } from "./resource.js";
+import { layout } from "./layout.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { view } from "./view.js";
+import { webhookResources } from "./webhooks/webhook-resources.js";
 import { enumLabel } from "./enum-label.js";
 import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { userMenu } from "./user-menu.js";
-import { layout } from "./layout.js";
+import { bottomBar, bottomBarFor, maxBottomBarItems } from "./bottom-bar.js";
+import { bottomBarErrors } from "./bottom-bar-errors.js";
 import { decodeKey, encodeKey, keyTypes } from "./keys.js";
 import { rule } from "./access/rule.js";
 import { defineRoles } from "./access/roles.js";
@@ -22,4 +25,4 @@ import { pickView } from "./access/pick-view.js";
 import { restrictModel } from "./access/restrict.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { accessWarnings, applyAssistantEvent, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, where };
+export { accessWarnings, applyAssistantEvent, bottomBar, bottomBarErrors, bottomBarFor, checkEventFilter, checkFilter, checkOrderBy, checkRecord, checkedAccept, checkedProvider, createWhere, decodeKey, defaultRecentLimit, defineRoles, emptyAssistantState, encodeKey, enumLabel, evaluateFilter, f, fieldsUsedBy, keyTypes, layout as l, matchedSearchField, matchesSearch, maxBottomBarItems, navRecentErrors, parseFilter, parseOrderBy, parseSize, pickView, printFilter, printOrderBy, readEventStream, resolveAccess, resource, restrictModel, rule, searchTerms, statusTones, termMatches, userMenu, view, webhookResources, where };

package/dist/menu-href.js

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

package/dist/model.d.ts

@@ -218,6 +218,29 @@ export type UserMenuItemModel = {
 export type UserMenuModel = {
   items: UserMenuItemModel[];
 };
+/** A tab of a bottom bar on phones: icon above an explicit label. */
+export type BottomBarItemModel = {
+  kind: 'resource';
+  resource: string;
+  label: string;
+  icon?: string;
+} | {
+  kind: 'page';
+  page: string;
+  label: string;
+  icon?: string;
+} | {
+  kind: 'link';
+  label: string;
+  href: string;
+  icon?: string;
+};
+/** A bottom bar for the users holding one of `roles`; `label` names it in the role view switcher. */
+export type BottomBarModel = {
+  label: string;
+  roles: string[];
+  items: BottomBarItemModel[];
+};
 /**
  * The title replaces `title` in search results; `subtitle` is the second line unless the search matched another search
  * field, which then shows instead. Without a subtitle, the first search field not in the title is the default.

package/dist/user-menu.js

@@ -1,3 +1,4 @@
+import { isMenuHref } from "./menu-href.js";
 //#region src/user-menu.ts
 const items = {
 	/** Opens the resource's list. A resource in the user menu is left out of the sidebar. */
@@ -14,7 +15,7 @@ const items = {
 	}),
 	/** An address outside the admin, opened in a new tab: `https:`, `http:` or `mailto:`. */
 	link: (label, href, options = {}) => {
-		if (!/^(https?:\/\/|mailto:)/i.test(href)) throw new Error(`User menu link "${label}": href must start with https://, http:// or mailto:`);
+		if (!isMenuHref(href)) throw new Error(`User menu link "${label}": href must start with https://, http:// or mailto:`);
 		return {
 			kind: "link",
 			label,

package/dist/webhooks/webhook-resources.d.ts

@@ -0,0 +1,113 @@
+import { Field } from "../field.js";
+import { Ref } from "../refs.js";
+import { ResourceBuilder } from "../resource.js";
+import { ViewBuilder } from "../view.js";
+import "../index.js";
+//#region src/webhooks/webhook-resources.d.ts
+/**
+ * The resources and views `webhooks()` adds to an app, over the tables and the view of `schema`: Webhook subscriptions,
+ * Webhook deliveries and, with `deliveryLog`, Webhook delivery log. Config only; the server delivers.
+ */
+export declare const webhookResources: (schema: string, { deliveryLog }?: {
+  deliveryLog?: boolean;
+}) => {
+  webhookDeliveryLog?: ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_id: Field<string>;
+    readonly event_type: Field<string>;
+    readonly status: Field<"failed" | "delivered">;
+    readonly attempt: Field<number>;
+    readonly status_code: Field<number | null>;
+    readonly response: Field<string | null>;
+    readonly duration_ms: Field<number>;
+    readonly at: Field<string>;
+  }, Ref<"id", string>> | undefined;
+  webhookDeliveryLogView?: ViewBuilder<ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_id: Field<string>;
+    readonly event_type: Field<string>;
+    readonly status: Field<"failed" | "delivered">;
+    readonly attempt: Field<number>;
+    readonly status_code: Field<number | null>;
+    readonly response: Field<string | null>;
+    readonly duration_ms: Field<number>;
+    readonly at: Field<string>;
+  }, Ref<"id", string>>> | undefined;
+  webhookSubscriptions: ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly name: Field<string>;
+    readonly events: Field<string>;
+    readonly url: Field<string>;
+    readonly filter: Field<string | null>;
+    readonly headers: Field<import("zod").JSONType>;
+    readonly payload: Field<"full" | "thin">;
+    readonly enabled: Field<boolean>;
+    readonly secret: Field<string>;
+    readonly previous_secret: null;
+    readonly previous_secret_until: null;
+    readonly tenant_id: Field<string | null>;
+    readonly owner_id: Field<string | null>;
+    readonly disabled_reason: Field<string | null>;
+    readonly last_success_at: Field<string | null>;
+    readonly failing_since: Field<string | null>;
+    readonly created_at: Field<string>;
+    readonly updated_at: Field<string>;
+    readonly rotate_secret: Field<boolean>;
+    readonly send_test: Field<boolean>;
+    readonly resend_failed: Field<boolean>;
+  }, Ref<"id", string>>;
+  webhookSubscriptionsView: ViewBuilder<ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly name: Field<string>;
+    readonly events: Field<string>;
+    readonly url: Field<string>;
+    readonly filter: Field<string | null>;
+    readonly headers: Field<import("zod").JSONType>;
+    readonly payload: Field<"full" | "thin">;
+    readonly enabled: Field<boolean>;
+    readonly secret: Field<string>;
+    readonly previous_secret: null;
+    readonly previous_secret_until: null;
+    readonly tenant_id: Field<string | null>;
+    readonly owner_id: Field<string | null>;
+    readonly disabled_reason: Field<string | null>;
+    readonly last_success_at: Field<string | null>;
+    readonly failing_since: Field<string | null>;
+    readonly created_at: Field<string>;
+    readonly updated_at: Field<string>;
+    readonly rotate_secret: Field<boolean>;
+    readonly send_test: Field<boolean>;
+    readonly resend_failed: Field<boolean>;
+  }, Ref<"id", string>>>;
+  webhookDeliveries: ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_type: Field<string>;
+    readonly event_id: Field<string>;
+    readonly status: Field<"waiting" | "failed">;
+    readonly attempt: Field<number>;
+    readonly next_attempt: Field<string | null>;
+    readonly last_error: Field<string | null>;
+    readonly created_at: Field<string>;
+    readonly resend: Field<boolean>;
+  }, Ref<"id", string>>;
+  webhookDeliveriesView: ViewBuilder<ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_type: Field<string>;
+    readonly event_id: Field<string>;
+    readonly status: Field<"waiting" | "failed">;
+    readonly attempt: Field<number>;
+    readonly next_attempt: Field<string | null>;
+    readonly last_error: Field<string | null>;
+    readonly created_at: Field<string>;
+    readonly resend: Field<boolean>;
+  }, Ref<"id", string>>>;
+};
+//#endregion

package/dist/webhooks/webhook-resources.js

@@ -0,0 +1,211 @@
+import { f } from "../fields.js";
+import { resource } from "../resource.js";
+import { layout } from "../layout.js";
+import { view } from "../view.js";
+//#region src/webhooks/webhook-resources.ts
+/** Webhook subscriptions: a row per subscription someone made in the admin app, scoped to their tenant. */
+const subscriptionsResource = (schema) => resource("webhook_subscriptions").table(`${schema}.subscriptions`).fields({
+	id: f.uuid().readOnly().dbDefault(),
+	name: f.text().min(1).max(100).filterable().sortable(),
+	events: f.text().min(1).max(2e3),
+	url: f.text().max(2e3).regex(/^https?:\/\/[^\s/]+/, "Use an http:// or https:// URL"),
+	filter: f.text().optional().max(2e3),
+	headers: f.json().optional(),
+	payload: f.enum(["full", "thin"]).default("full"),
+	enabled: f.boolean().default(true).filterable(),
+	secret: f.text().sensitive().readOnly().dbDefault(),
+	previous_secret: null,
+	previous_secret_until: null,
+	tenant_id: f.text().optional().readOnly(),
+	owner_id: f.text().optional().readOnly().dbDefault(),
+	disabled_reason: f.text().optional().readOnly(),
+	last_success_at: f.timestamp().optional().readOnly().sortable(),
+	failing_since: f.timestamp().optional().readOnly(),
+	created_at: f.timestamp().readOnly().dbDefault().sortable(),
+	updated_at: f.timestamp().readOnly().dbDefault(),
+	rotate_secret: f.boolean().default(false),
+	send_test: f.boolean().default(false),
+	resend_failed: f.boolean().default(false)
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).owner((r) => r.owner_id).search((r) => [r.name, r.url]);
+const subscriptionsView = view("webhook_subscriptions").names({
+	singular: "Webhook subscription",
+	plural: "Webhook subscriptions"
+}).icon("webhook").title((r) => r.name).help("Sends the app's events to a URL as they happen, signed with Standard Webhooks. It delivers as its owner: only the records and fields they may read.").fields((r) => ({
+	events: r.events.help("Event names separated by spaces, such as orders.created, or orders.* for every event of a resource"),
+	url: r.url.label("URL"),
+	filter: r.filter.help("Only records that match, in the language of filters: status = \"paid\""),
+	headers: r.headers.help("Extra request headers, as a JSON object"),
+	payload: r.payload.help("Thin leaves the records out: the receiver reads them through the API").valueLabels({
+		full: "Full",
+		thin: "Thin"
+	}),
+	secret: r.secret.help("Receivers check the webhook-signature header with it"),
+	disabled_reason: r.disabled_reason.label("Disabled because"),
+	last_success_at: r.last_success_at.label("Last success"),
+	failing_since: r.failing_since.label("Failing since")
+})).list((r) => ({
+	columns: [
+		r.name,
+		r.events,
+		r.url,
+		r.enabled,
+		r.last_success_at
+	],
+	sort: [[r.created_at, "desc"]]
+})).layout((r) => [
+	layout.section("Subscription", [
+		r.name,
+		r.events,
+		r.url,
+		r.filter,
+		r.payload,
+		r.headers,
+		r.enabled
+	]),
+	layout.section("Signing", [r.secret]),
+	layout.sidebar([
+		r.last_success_at,
+		r.failing_since,
+		r.disabled_reason,
+		r.created_at
+	]),
+	layout.related("Waiting and failed deliveries", {
+		resource: "webhook_deliveries",
+		field: "subscription_id",
+		columns: [
+			"event_type",
+			"status",
+			"attempt",
+			"next_attempt",
+			"last_error"
+		]
+	})
+]).actions((a) => [
+	a.update("send_test", {
+		label: "Send test event",
+		icon: "send",
+		set: { send_test: true }
+	}),
+	a.update("resend_failed", {
+		label: "Resend failed",
+		icon: "rotate-ccw",
+		set: { resend_failed: true },
+		confirm: "Try every failed delivery of this subscription once more?"
+	}),
+	a.update("rotate_secret", {
+		label: "Rotate secret",
+		icon: "key-round",
+		set: { rotate_secret: true },
+		confirm: "Make a new secret? The old one keeps signing too for 24 hours."
+	}),
+	a.update("disable", {
+		label: "Disable",
+		icon: "pause",
+		set: { enabled: false }
+	})
+]);
+/** The deliveries of webhook subscriptions that wait for a retry or failed for good: delivery jobs, not a table. */
+const deliveriesResource = (schema) => resource("webhook_deliveries").table(`${schema}.deliveries`).fields({
+	id: f.uuid().readOnly(),
+	subscription_id: f.relation("webhook_subscriptions").readOnly().filterable(),
+	tenant_id: f.text().optional().readOnly(),
+	event_type: f.text().readOnly().filterable().sortable(),
+	event_id: f.text().readOnly().filterable(),
+	status: f.enum(["waiting", "failed"]).readOnly().filterable(),
+	attempt: f.integer().readOnly(),
+	next_attempt: f.timestamp().optional().readOnly().sortable(),
+	last_error: f.text().optional().readOnly(),
+	created_at: f.timestamp().readOnly().sortable(),
+	resend: f.boolean()
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).access({
+	create: () => false,
+	delete: () => false
+});
+const deliveriesView = view("webhook_deliveries").names({
+	singular: "Webhook delivery",
+	plural: "Webhook deliveries"
+}).icon("send").title((r) => r.event_type).help("Deliveries that wait for their next try or failed for good. A delivery leaves the list once it succeeds.").fields((r) => ({
+	event_type: r.event_type.label("Event"),
+	event_id: r.event_id.label("Event id").format("code"),
+	next_attempt: r.next_attempt.label("Next try"),
+	last_error: r.last_error.label("Last error"),
+	attempt: r.attempt.label("Tries")
+})).list((r) => ({
+	columns: [
+		r.event_type,
+		r.subscription_id,
+		r.status,
+		r.attempt,
+		r.next_attempt,
+		r.last_error
+	],
+	sort: [[r.created_at, "desc"]]
+})).layout((r) => [layout.section("Delivery", [
+	r.subscription_id,
+	r.event_type,
+	r.event_id,
+	r.last_error
+]), layout.sidebar([
+	r.status,
+	r.attempt,
+	r.next_attempt,
+	r.created_at
+])]).actions((a) => [a.update("resend", {
+	label: "Resend",
+	icon: "rotate-ccw",
+	set: { resend: true },
+	confirm: "Try this delivery once more, from now?"
+})]);
+/** Every try of every webhook subscription's deliveries, for 30 days (`deliveryLog: true`). */
+const deliveryLogResource = (schema) => resource("webhook_delivery_log").table(`${schema}.delivery_log`).fields({
+	id: f.bigint().readOnly(),
+	subscription_id: f.relation("webhook_subscriptions").readOnly().filterable(),
+	tenant_id: f.text().optional().readOnly(),
+	event_id: f.text().readOnly().filterable(),
+	event_type: f.text().readOnly().filterable().sortable(),
+	status: f.enum(["delivered", "failed"]).readOnly().filterable(),
+	attempt: f.integer().readOnly(),
+	status_code: f.integer().optional().readOnly().filterable(),
+	response: f.text().optional().readOnly(),
+	duration_ms: f.integer().readOnly(),
+	at: f.timestamp().readOnly().filterable().sortable()
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).access({
+	create: () => false,
+	update: () => false,
+	delete: () => false
+});
+const deliveryLogView = view("webhook_delivery_log").names({
+	singular: "Webhook delivery log entry",
+	plural: "Webhook delivery log"
+}).icon("scroll-text").title((r) => r.event_type).fields((r) => ({
+	event_type: r.event_type.label("Event"),
+	status_code: r.status_code.label("Status code"),
+	duration_ms: r.duration_ms.label("Duration (ms)"),
+	at: r.at.label("When")
+})).list((r) => ({
+	columns: [
+		r.at,
+		r.event_type,
+		r.subscription_id,
+		r.status,
+		r.status_code,
+		r.duration_ms
+	],
+	sort: [[r.at, "desc"]]
+}));
+/**
+* The resources and views `webhooks()` adds to an app, over the tables and the view of `schema`: Webhook subscriptions,
+* Webhook deliveries and, with `deliveryLog`, Webhook delivery log. Config only; the server delivers.
+*/
+const webhookResources = (schema, { deliveryLog = false } = {}) => ({
+	webhookSubscriptions: subscriptionsResource(schema),
+	webhookSubscriptionsView: subscriptionsView,
+	webhookDeliveries: deliveriesResource(schema),
+	webhookDeliveriesView: deliveriesView,
+	...deliveryLog && {
+		webhookDeliveryLog: deliveryLogResource(schema),
+		webhookDeliveryLogView: deliveryLogView
+	}
+});
+//#endregion
+export { webhookResources };

package/package.json

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