@protobase/schema 0.13.4 → 0.14.0

package/dist/view.js

@@ -1,18 +1,25 @@
 import { createRefs, ref } from "./refs.js";
-import { displayErrors, displayFields, displays } from "./view-displays.js";
 import { navRecentErrors } from "./nav-recent.js";
 import { actions } from "./view-actions.js";
+import { displayErrors, displayFields, displays } from "./view-displays.js";
 import { FieldView } from "./view-field.js";
 import { widgets } from "./view-widgets.js";
 //#region src/view.ts
+/**
+* A view of a resource, as `view(...)` starts it: how the admin shows it. Each method returns a new view, so one view
+* can build on another. See [UI config](website/src/content/docs/reference/ui-config.mdx).
+*/
 var ViewBuilder = class ViewBuilder {
 	state;
+	/** @internal */
 	constructor(state) {
 		this.state = state;
 	}
+	/** What a record and the records are called, such as "New repair" and "Repairs"; the resource name in words by default. */
 	names(names) {
 		return this.next({ names });
 	}
+	/** An icon name carried in `/meta`, for apps that draw their own shell; the admin picks sidebar icons by resource name. */
 	icon(icon) {
 		return this.next({ icon });
 	}
@@ -36,13 +43,15 @@ var ViewBuilder = class ViewBuilder {
 			...subtitle && { subtitle: subtitle.name }
 		} });
 	}
-	/** Where the resource sits in the sidebar; `recent` lists a few of its records under the entry (see https://docs.protobase.net/reference/sidebar/). */
+	/** Where the resource sits in the sidebar; `recent` lists a few of its records under the entry (see [Sidebar](website/src/content/docs/reference/sidebar.md#recent-records)). */
 	nav(nav) {
 		return this.next({ nav });
 	}
+	/** A line under the list's title. */
 	help(help) {
 		return this.next({ help });
 	}
+	/** Hints per field, such as `{ total: r.total.prefix('€').decimals(2) }`; calls add up. */
 	fields(build) {
 		const built = build(createRefs((name) => new FieldView(name)));
 		const fields = Object.fromEntries(Object.values(built).map((v) => [v.name, v.props]));
@@ -68,12 +77,21 @@ var ViewBuilder = class ViewBuilder {
 		if (errors.length > 0) throw new Error(`View "${this.state.resource}": ${errors.join("; ")}`);
 		return this.next({ list });
 	}
+	/**
+	* The filter widgets above the list, in order, each on a `.filterable()` field: `w.facets`, `w.dateRange`, `w.range`,
+	* `w.toggle` and `w.flags`. Together they write the list's `?filter=`.
+	*/
 	filters(build) {
 		return this.next({ filters: build(this.refs(), widgets) });
 	}
+	/**
+	* The record page, as items of `l` in order: sections, sidebar cards, related records, maps and custom components.
+	* Without it the page shows one section with every field.
+	*/
 	layout(build) {
 		return this.next({ layout: build(this.refs()) });
 	}
+	/** A chart of records per `granularity` over a date or timestamp `field` above the list, following its filters. */
 	chart(build) {
 		const { field, range, granularity } = build(this.refs());
 		return this.next({ chart: {
@@ -82,9 +100,14 @@ var ViewBuilder = class ViewBuilder {
 			granularity
 		} });
 	}
+	/** Where the record page shows that it saved: a toast (the default) or the Save button. */
 	saveFeedback(saveFeedback) {
 		return this.next({ saveFeedback });
 	}
+	/**
+	* The named actions of the record page's action rail, which composed pages can put on buttons too: `a.update`,
+	* `a.remove` and `a.link` need no code, `a.action` runs a handler the app registers.
+	*/
 	actions(build) {
 		return this.next({ actions: build(actions) });
 	}
@@ -115,6 +138,20 @@ var ViewBuilder = class ViewBuilder {
 		});
 	}
 };
+/**
+* Starts the view of a resource: how the admin shows it. Pass the resource's type, so every field reference (`r.status`)
+* is checked against it. See [UI config](website/src/content/docs/reference/ui-config.mdx).
+*
+* @example
+* ```ts
+* import { view } from '@protobase/schema'
+* import type { repairs } from './data'
+*
+* export const repairsView = view<typeof repairs>('repairs')
+*   .names({ singular: 'Repair', plural: 'Repairs' })
+*   .list((r) => ({ columns: [r.number, r.status, r.booked_on], sort: [[r.booked_on, 'desc']] }))
+* ```
+*/
 const view = (resource) => new ViewBuilder({
 	resource,
 	fields: {},

package/dist/webhooks/webhook-resources.js

@@ -1,7 +1,7 @@
 import { f } from "../fields.js";
 import { resource } from "../resource.js";
-import { layout } from "../layout.js";
 import { view } from "../view.js";
+import { layout } from "../layout.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({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.13.4",
+  "version": "0.14.0",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {
@@ -15,7 +15,8 @@
     "node": ">=22.12.0"
   },
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./internal": "./dist/internal.js"
   },
   "types": "./dist/index.d.ts",
   "files": [