@protobase/schema 0.26.6 → 0.26.8

package/dist/internal.d.ts

@@ -1,5 +1,6 @@
 import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.js";
 import { actionInputErrors, shownInputs } from "./action-inputs.js";
+import { actionConditionError } from "./view-actions.js";
 import { chartFields, isGroupChart } from "./view-chart.js";
 import { boardErrors, cardPhotoLimit, datesErrors, displayFields, tableDisplay } from "./view-displays.js";
 import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
@@ -22,4 +23,4 @@ import { readEventStream } from "./assistant/event-stream.js";
 import { layoutItems } from "./layout-items.js";
 import { viewOfList } from "./named-list.js";
 import { Locale, isLocale, locales, pickLocale } from "./locale.js";
-export { type AddressCheck, type FormulaNode, type Locale, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseFormula, parseSize, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { type AddressCheck, type FormulaNode, type Locale, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseFormula, parseSize, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -9,6 +9,7 @@ import { viewOfList } from "./named-list.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { actionInputErrors, shownInputs } from "./action-inputs.js";
 import { updateSetErrors, updateValues } from "./update-set.js";
+import { actionConditionError } from "./view-actions.js";
 import { chartFields, isGroupChart } from "./view-chart.js";
 import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
 import { boardErrors, cardPhotoLimit, datesErrors, displayFields, tableDisplay } from "./view-displays.js";
@@ -22,4 +23,4 @@ import { addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
 import { isLocale, locales, pickLocale } from "./locale.js";
-export { actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseFormula, parseSize, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, boardErrors, bottomBarFor, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, isGroupChart, isLocale, layoutItems, leavesApp, linkActionError, locales, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseFormula, parseSize, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, readEventStream, redactSecrets, renderPrompt, searchTerms, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/model.d.ts

@@ -968,14 +968,27 @@ export type ActionModel = {
   /** The button's label. */
   label: string;
   /**
-   * The button's icon: `ban`, `bath`, `bed`, `bell`, `bookmark`, `calendar`, `door-open`, `external-link`, `file-text`, `heart`,
-   * `house`, `key`, `land-plot`, `leaf`, `ruler`, `send`, `tag` or `wallet`; another name shows a lightning bolt.
+   * The button's icon: `archive`, `arrow-right-left`, `ban`, `bath`, `bed`, `bell`, `bookmark`, `calendar`, `camera`, `copy`, `cpu`,
+   * `door-open`, `download`, `external-link`, `file-text`, `hard-drive`, `heart`, `house`, `key`, `land-plot`, `leaf`, `memory`,
+   * `network`, `play`, `plug`, `power`, `restart`, `ruler`, `send`, `server`, `stop`, `tag`, `terminal`, `upload`, `wallet` or
+   * `wrench`; another name shows a lightning bolt.
    */
   icon?: string;
   /** The question the button asks before it runs the action. */
   confirm?: string;
-  /** Whether the action is meant for several records at once (`a.action`'s `bulk`). */
+  /** Whether the action is offered for the rows selected in the list, running on each it applies to (`bulk`). */
   bulk: boolean;
+  /**
+   * An AIP-160 condition over the record's own fields, as `status = 'running'`, for the records the action applies to.
+   * It only decides what the buttons show; the API's access rules decide what may run.
+   */
+  when?: string;
+  /** What the button does on a record `when` does not hold for: it is left out, or shown disabled with `reason`. */
+  otherwise?: 'hide' | 'disable';
+  /** Why the button is disabled on a record `when` does not hold for, shown to the user. */
+  reason?: string;
+  /** `danger` draws an action that destroys or interrupts something, such as Force off, in red. */
+  variant?: 'danger';
   /** 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 action runs: a handler gets the answers as `values`, an update writes them through `set`. */

package/dist/view-actions.d.ts

@@ -1,12 +1,23 @@
 import { ActionInputModel, ActionModel, AppAddress } from "./model.js";
 import { inputs } from "./action-inputs.js";
 //#region src/view-actions.d.ts
-/** @inline */
+/**
+ * A button's label, icon and question, and the records it applies to: `when`, an AIP-160 condition over the record's own
+ * fields such as `status = 'running'`, leaves the button out on a record it does not hold for, or with
+ * `otherwise: 'disable'` shows it disabled with `reason`. `variant: 'danger'` draws it in red.
+ * @inline
+ */
 type ActionOptions = {
   label: string;
   icon?: string;
   confirm?: string;
+  when?: string;
+  otherwise?: 'hide' | 'disable';
+  reason?: string;
+  variant?: 'danger';
 };
+/** What is wrong with an action's `when`, `otherwise` and `reason`: a fallback needs a condition, and a disabled button says why. */
+export declare const actionConditionError: (o: Pick<ActionOptions, "when" | "otherwise" | "reason">) => "\"otherwise\" and \"reason\" need a \"when\" condition" | "\"when\" is empty" | "a button disabled by \"when\" needs a \"reason\"" | "\"reason\" shows only with otherwise: 'disable'" | undefined;
 /** @inline */
 type InputsOption = {
   inputs?: (i: typeof inputs) => ActionInputModel[];
@@ -15,7 +26,7 @@ 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`.
+   * answers as `values`. With `bulk` and no `inputs`, the list offers it for the selected rows too, and runs the handler on each it applies to.
    */
   action: (name: string, o: ActionOptions & InputsOption & {
     bulk?: boolean;
@@ -25,9 +36,11 @@ export declare const actions: {
    * 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}' } })`.
+   * With `bulk` and no `inputs`, the list offers it for the selected rows too, and updates each it applies to.
    */
   update: (name: string, o: ActionOptions & InputsOption & {
     set: Record<string, unknown>;
+    bulk?: boolean;
   }) => ActionModel;
   /** Deletes the record (soft delete when the resource has one). */
   remove: (name: string, o: ActionOptions) => ActionModel;
@@ -43,6 +56,11 @@ export declare const actions: {
   } | {
     href: string;
   })) => ActionModel;
+  /**
+   * Has the model write the `writes` field of the record from `prompt`, `{field}` replaced by the record's values, as the
+   * user who clicks; see [AI fields and actions](website/src/content/docs/reference/ai.mdx). The prompt may name the
+   * field it writes, to rewrite or translate it in place.
+   */
   ai: (name: string, o: ActionOptions & {
     prompt: string;
     writes: string;

package/dist/view-actions.js

@@ -3,13 +3,30 @@ 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,
-	label: o.label,
-	bulk: o.bulk ?? false,
-	...o.icon !== void 0 && { icon: o.icon },
-	...o.confirm !== void 0 && { confirm: o.confirm }
-});
+/** What is wrong with an action's `when`, `otherwise` and `reason`: a fallback needs a condition, and a disabled button says why. */
+const actionConditionError = (o) => {
+	if (o.when === void 0) return o.otherwise !== void 0 || o.reason !== void 0 ? "\"otherwise\" and \"reason\" need a \"when\" condition" : void 0;
+	if (o.when.trim() === "") return "\"when\" is empty";
+	if (o.otherwise === "disable") return o.reason ? void 0 : "a button disabled by \"when\" needs a \"reason\"";
+	return o.reason === void 0 ? void 0 : "\"reason\" shows only with otherwise: 'disable'";
+};
+const named = (name, o) => {
+	const error = actionConditionError(o);
+	if (error) throw new Error(`Action "${name}": ${error}`);
+	return {
+		name,
+		label: o.label,
+		bulk: o.bulk ?? false,
+		...o.icon !== void 0 && { icon: o.icon },
+		...o.confirm !== void 0 && { confirm: o.confirm },
+		...o.when !== void 0 && { when: o.when },
+		...o.otherwise === "disable" && {
+			otherwise: o.otherwise,
+			reason: o.reason
+		},
+		...o.variant !== void 0 && { variant: o.variant }
+	};
+};
 const builtInputs = (name, option) => {
 	if (!option) return {};
 	const built = option(inputs);
@@ -21,7 +38,7 @@ 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`.
+	* answers as `values`. With `bulk` and no `inputs`, the list offers it for the selected rows too, and runs the handler on each it applies to.
 	*/
 	action: (name, o) => ({
 		...named(name, o),
@@ -32,6 +49,7 @@ const actions = {
 	* 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}' } })`.
+	* With `bulk` and no `inputs`, the list offers it for the selected rows too, and updates each it applies to.
 	*/
 	update: (name, o) => {
 		const built = builtInputs(name, o.inputs);
@@ -76,6 +94,11 @@ const actions = {
 			}
 		};
 	},
+	/**
+	* Has the model write the `writes` field of the record from `prompt`, `{field}` replaced by the record's values, as the
+	* user who clicks; see [AI fields and actions](website/src/content/docs/reference/ai.mdx). The prompt may name the
+	* field it writes, to rewrite or translate it in place.
+	*/
 	ai: (name, o) => {
 		const error = promptError(o.prompt) ?? (o.writes === "" ? "it writes no field" : void 0);
 		if (error) throw new Error(`Action "${name}": ${error}`);
@@ -90,4 +113,4 @@ const actions = {
 	}
 };
 //#endregion
-export { actions };
+export { actionConditionError, actions };

package/package.json

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