@protobase/schema 0.22.0 → 0.22.2

package/dist/internal.d.ts

@@ -12,10 +12,11 @@ import { SearchTerm, matchedSearchField, matchesSearch, searchTerms, termMatches
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { PluginHost, PluginRequirement, inRange, pluginProblem } from "./plugin-version.js";
 import { redactSecrets } from "./redact-secrets.js";
+import { updateSetErrors, updateValues } from "./update-set.js";
 import { addressPlaceholders, appHrefError, fillAddress, hrefField, hrefPlaceholders, leavesApp, linkActionError } from "./address-template.js";
 import { promptError, promptFields, renderPrompt } from "./ai-prompt.js";
 import { AddressCheck, 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 { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, 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, webhookResources };
+export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, 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, webhookResources };

package/dist/internal.js

@@ -5,6 +5,7 @@ import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./s
 import { checkEventFilter } from "./events/event-models.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { actionInputErrors, shownInputs } from "./action-inputs.js";
+import { updateSetErrors, updateValues } from "./update-set.js";
 import { chartFields, isGroupChart } from "./view-chart.js";
 import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
 import { boardErrors, calendarErrors, cardPhotoLimit, displayFields, tableDisplay } from "./view-displays.js";
@@ -18,4 +19,4 @@ 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, webhookResources };
+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, webhookResources };

package/dist/model.d.ts

@@ -603,6 +603,7 @@ export type FilterWidgetModel = {
 /**
  * Records of another resource on the record page: those whose `field` holds this record's key or, with `through`,
  * those whose `field` holds one of the `key` values of the `through` records that point at this record (a join table).
+ * With `from`, those whose `field` holds the value of that field of this record.
  * See [Related records](website/src/content/docs/reference/ui-config.mdx#related-records).
  */
 export type RelatedModel = {
@@ -614,8 +615,10 @@ export type RelatedModel = {
   help?: string;
   /** The resource whose records it lists. */
   resource: string;
-  /** The filterable field of `resource` matched against this record's key, or with `through` against the join records' keys. */
+  /** The filterable field of `resource` matched against this record's key, or with `through` against the join records' keys, or with `from` against that field's value. */
   field: string;
+  /** A field of this record whose value `field` is matched against instead of its key; not with `through`. */
+  from?: string;
   /** The join records between this record and the listed ones. */
   through?: {
     /** The join resource. */
@@ -822,7 +825,7 @@ export type SaveFeedback = 'toast' | 'button';
 export type ActionRun = {
   /** Updates the record. */
   kind: 'update';
-  /** The fields it sets, by name. */
+  /** The fields it sets, by name; a value that is exactly `{input}` is that input's answer. */
   values: Record<string, unknown>;
 } | {
   /** Deletes the record, soft deleting when the resource does. */
@@ -865,7 +868,7 @@ export type ActionModel = {
   bulk: boolean;
   /** What it does; without it the app runs the handler registered under `name`. */
   run?: ActionRun;
-  /** What the button asks for in a dialog before the handler runs, which gets the answers as `values` (`a.action`'s `inputs`). */
+  /** What the button asks for in a dialog before the action runs: a handler gets the answers as `values`, an update writes them through `set`. */
   inputs?: ActionInputModel[];
 };
 /**

package/dist/update-set.d.ts

@@ -0,0 +1,12 @@
+import { ActionInputModel } from "./model.js";
+//#region src/update-set.d.ts
+/** Why an update's `set` cannot be used: a value that is exactly `{name}` must name one of the inputs the action asks for. */
+export declare const updateSetErrors: (set: Record<string, unknown>, inputs?: ActionInputModel[]) => string[];
+/**
+ * The fields an update writes: a literal as it is, a value that is exactly `{input}` as that input's answer. A field whose
+ * input was hidden has no answer in `values` and is left out, so it keeps what it holds.
+ */
+export declare const updateValues: (set: Record<string, unknown>, values: Record<string, unknown>) => {
+  [k: string]: unknown;
+};
+//#endregion

package/dist/update-set.js

@@ -0,0 +1,19 @@
+import { hrefField } from "./address-template.js";
+//#region src/update-set.ts
+/** Why an update's `set` cannot be used: a value that is exactly `{name}` must name one of the inputs the action asks for. */
+const updateSetErrors = (set, inputs = []) => Object.entries(set).flatMap(([field, value]) => {
+	const input = typeof value === "string" ? hrefField(value) : void 0;
+	if (input === void 0 || inputs.some((entry) => entry.name === input)) return [];
+	return [`set "${field}" names input "${input}", which it does not ask for`];
+});
+/**
+* The fields an update writes: a literal as it is, a value that is exactly `{input}` as that input's answer. A field whose
+* input was hidden has no answer in `values` and is left out, so it keeps what it holds.
+*/
+const updateValues = (set, values) => Object.fromEntries(Object.entries(set).flatMap(([field, value]) => {
+	const input = typeof value === "string" ? hrefField(value) : void 0;
+	if (input === void 0) return [[field, value]];
+	return Object.hasOwn(values, input) ? [[field, values[input]]] : [];
+}));
+//#endregion
+export { updateSetErrors, updateValues };

package/dist/view-actions.d.ts

@@ -7,21 +7,26 @@ type ActionOptions = {
   icon?: string;
   confirm?: string;
 };
+/** @inline */
+type InputsOption = {
+  inputs?: (i: typeof inputs) => ActionInputModel[];
+};
 export declare const actions: {
   /**
    * An action the app implements: it runs the handler registered under `name`. With `inputs`, such as
    * `(i) => [i.text('reason', { label: 'Reason' })]`, the button first asks for them in a dialog, and the handler gets the
    * answers as `values`.
    */
-  action: (name: string, o: ActionOptions & {
+  action: (name: string, o: ActionOptions & InputsOption & {
     bulk?: boolean;
-    inputs?: (i: typeof inputs) => ActionInputModel[];
   }) => ActionModel;
   /**
    * Sets fields of the record, as one update with its ETag, for example `{ status: 'paid' }`. It is not offered on a
-   * record that holds these values already.
+   * record that holds these values already. With `inputs`, the button first asks for them in a dialog, and a `set` value
+   * that is exactly `'{name}'` is written as that input's answer, with no handler code:
+   * `a.update('answer', { label: 'Answer', inputs: (i) => [i.text('answer', { label: 'Answer', multiline: true })], set: { answer: '{answer}' } })`.
    */
-  update: (name: string, o: ActionOptions & {
+  update: (name: string, o: ActionOptions & InputsOption & {
     set: Record<string, unknown>;
   }) => ActionModel;
   /** Deletes the record (soft delete when the resource has one). */

package/dist/view-actions.js

@@ -1,6 +1,7 @@
 import { linkActionError } from "./address-template.js";
 import { promptError } from "./ai-prompt.js";
 import { actionInputErrors, inputs } from "./action-inputs.js";
+import { updateSetErrors } from "./update-set.js";
 //#region src/view-actions.ts
 const named = (name, o) => ({
 	name,
@@ -9,33 +10,42 @@ const named = (name, o) => ({
 	...o.icon !== void 0 && { icon: o.icon },
 	...o.confirm !== void 0 && { confirm: o.confirm }
 });
+const builtInputs = (name, option) => {
+	if (!option) return {};
+	const built = option(inputs);
+	const errors = actionInputErrors(built);
+	if (errors.length > 0) throw new Error(`Action "${name}": ${errors.join("; ")}`);
+	return { inputs: built };
+};
 const actions = {
 	/**
 	* An action the app implements: it runs the handler registered under `name`. With `inputs`, such as
 	* `(i) => [i.text('reason', { label: 'Reason' })]`, the button first asks for them in a dialog, and the handler gets the
 	* answers as `values`.
 	*/
-	action: (name, o) => {
-		if (!o.inputs) return named(name, o);
-		const built = o.inputs(inputs);
-		const errors = actionInputErrors(built);
+	action: (name, o) => ({
+		...named(name, o),
+		...builtInputs(name, o.inputs)
+	}),
+	/**
+	* Sets fields of the record, as one update with its ETag, for example `{ status: 'paid' }`. It is not offered on a
+	* record that holds these values already. With `inputs`, the button first asks for them in a dialog, and a `set` value
+	* that is exactly `'{name}'` is written as that input's answer, with no handler code:
+	* `a.update('answer', { label: 'Answer', inputs: (i) => [i.text('answer', { label: 'Answer', multiline: true })], set: { answer: '{answer}' } })`.
+	*/
+	update: (name, o) => {
+		const built = builtInputs(name, o.inputs);
+		const errors = updateSetErrors(o.set, built.inputs);
 		if (errors.length > 0) throw new Error(`Action "${name}": ${errors.join("; ")}`);
 		return {
 			...named(name, o),
-			inputs: built
+			...built,
+			run: {
+				kind: "update",
+				values: o.set
+			}
 		};
 	},
-	/**
-	* Sets fields of the record, as one update with its ETag, for example `{ status: 'paid' }`. It is not offered on a
-	* record that holds these values already.
-	*/
-	update: (name, o) => ({
-		...named(name, o),
-		run: {
-			kind: "update",
-			values: o.set
-		}
-	}),
 	/** Deletes the record (soft delete when the resource has one). */
 	remove: (name, o) => ({
 		...named(name, o),

package/package.json

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