@antelopejs/interface-dms 0.9.1 → 0.10.0

package/dist/component-options/data-type.js

@@ -0,0 +1,146 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterDataCompareMode = exports.RegisterDataType = exports.DataType = void 0;
+exports.CreateDataType = CreateDataType;
+exports.getDataTypeId = getDataTypeId;
+exports.serializeType = serializeType;
+const node_assert_1 = __importDefault(require("node:assert"));
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const dataCompareModes = {};
+const dataCompareModesMetadata = new Map();
+const dataTypes = {};
+const dataTypesReverse = new WeakMap();
+class DataType {
+    compareModes;
+    defaultCompareMode;
+    options;
+    constructor(compareModes = [], defaultCompareMode, 
+    // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Published data-type options are interpreted by application-defined subclasses.
+    options) {
+        this.compareModes = compareModes;
+        this.defaultCompareMode = defaultCompareMode;
+        this.options = options;
+    }
+    // oxlint-disable-next-line eslint/max-params -- Data-type implementations and callers share this positional filter contract.
+    filter(context, proxy, key, value, mode, 
+    // oxlint-disable-next-line anti-slop/no-unsafe-dictionary-type -- Published comparator rows belong to application schemas, not a fixed interface model.
+    row) {
+        const compareMode = dataCompareModes[mode];
+        if (!compareMode)
+            return false;
+        return compareMode.filter(context, proxy, key, value, row);
+    }
+    /**
+     * Returns filters components for this data type.
+     * This component is used in filters for filtering values of this data type.
+     * Must include a 'default' component, and can optionally include
+     * mode-specific components for different compare modes.
+     * Override this method in subclasses for custom filter components per mode.
+     *
+     * @returns A record of filter components with at least a 'default' key
+     */
+    filterComponents() {
+        return {
+            default: this.defaultInputComponent(),
+        };
+    }
+    /**
+     * Returns the form input component for this data type.
+     * This component is used in forms for editing values of this data type.
+     *
+     * @returns The input component for this data type
+     */
+    inputComponent() {
+        return this.defaultInputComponent();
+    }
+    /**
+     * The input component a value of this type is described with where
+     * nothing is entered through it: a table column's type, whose cells, cards
+     * and quick filters read its options, and a read-only form field. Defaults
+     * to {@link inputComponent}; a type whose input carries what only an
+     * editable control uses (a relation's inline "add" form) leaves it out, so
+     * a page does not ship it once per column.
+     *
+     * @returns The input component, without what only editing uses
+     */
+    describedInputComponent() {
+        return this.inputComponent();
+    }
+}
+exports.DataType = DataType;
+/**
+ * Register a new data type
+ * @param id - The id of the data type
+ * @returns The data type class decorator
+ */
+exports.RegisterDataType = (0, decorators_1.MakeClassDecorator)((target, id) => {
+    dataTypes[id] = target;
+    dataTypesReverse.set(target, id);
+});
+/**
+ * Register a new data compare mode
+ * @param id - The id of the data compare mode
+ * @param noInput - Whether this compare mode requires no input (default: false)
+ * @returns The data compare mode class decorator
+ */
+exports.RegisterDataCompareMode = (0, decorators_1.MakeClassDecorator)((target, id, noInput = false) => {
+    const instance = new target();
+    dataCompareModes[id] = instance;
+    dataCompareModesMetadata.set(target, {
+        id,
+        instance,
+        noInput,
+    });
+});
+/**
+ * Create a new data type instance
+ * @param id - The id of the data type
+ * @param options - The options for the data type
+ * @returns The data type instance
+ */
+// oxlint-disable-next-line anti-slop/no-unknown-parameters -- Published factory forwards options to the registered application class, which owns their interpretation.
+function CreateDataType(id, options) {
+    const cls = dataTypes[id];
+    (0, node_assert_1.default)(cls, `Unknown type ${id}`);
+    return new cls(options);
+}
+/**
+ * Get the ID of a DataType instance
+ */
+function getDataTypeId(instance) {
+    return dataTypesReverse.get(Object.getPrototypeOf(instance).constructor);
+}
+function serializeType(instance) {
+    if (instance) {
+        const id = getDataTypeId(instance);
+        if (id) {
+            const compareModes = instance.compareModes
+                .map((modeClass) => dataCompareModesMetadata.get(modeClass)?.id)
+                .filter((modeId) => Boolean(modeId));
+            const defaultCompareMode = instance.defaultCompareMode
+                ? dataCompareModesMetadata.get(instance.defaultCompareMode)?.id
+                : undefined;
+            const inputComponents = instance.filterComponents();
+            const filteredInputComponents = {
+                ...inputComponents,
+            };
+            instance.compareModes.forEach((modeClass) => {
+                const metadata = dataCompareModesMetadata.get(modeClass);
+                if (metadata?.noInput) {
+                    filteredInputComponents[metadata.id] = "noInput";
+                }
+            });
+            return {
+                id,
+                compareModes,
+                defaultCompareMode,
+                filterComponents: filteredInputComponents,
+                inputComponent: instance.describedInputComponent(),
+            };
+        }
+    }
+}
+//# sourceMappingURL=data-type.js.map

package/dist/component-options/data-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-type.js","sourceRoot":"","sources":["../../src/component-options/data-type.ts"],"names":[],"mappings":";;;;;;AAiLA,wCAIC;AAKD,sCAEC;AAUD,sCAmCC;AAzOD,8DAAiC;AAEjC,sEAI+C;AAgB/C,MAAM,gBAAgB,GAAoC,EAAE,CAAC;AAC7D,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAGrC,CAAC;AACJ,MAAM,SAAS,GAAoC,EAAE,CAAC;AACtD,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAA2B,CAAC;AAchE,MAAsB,QAAQ;IAEV;IACA;IAEA;IAJlB,YACkB,eAAyC,EAAE,EAC3C,kBAA2C;IAC3D,iJAAiJ;IACjI,OAAiC;QAHjC,iBAAY,GAAZ,YAAY,CAA+B;QAC3C,uBAAkB,GAAlB,kBAAkB,CAAyB;QAE3C,YAAO,GAAP,OAAO,CAA0B;IAChD,CAAC;IAEJ,6HAA6H;IACtH,MAAM,CACX,OAAuB,EACvB,KAA0B,EAC1B,GAAW,EACX,KAAa,EACb,IAAY;IACZ,wJAAwJ;IACxJ,GAAwC;QAExC,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW;YAAE,OAAO,KAAK,CAAC;QAC/B,OAAO,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAUD;;;;;;;;OAQG;IACI,gBAAgB;QAGrB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,qBAAqB,EAAE;SACtC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;;OASG;IACI,uBAAuB;QAC5B,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;CAwBF;AA9FD,4BA8FC;AAED;;;;GAIG;AACU,QAAA,gBAAgB,GAC3B,IAAA,+BAAkB,EAAC,CAAC,MAAM,EAAE,EAAU,EAAE,EAAE;IACxC,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;IACvB,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC,CAAC;AAEL;;;;;GAKG;AACU,QAAA,uBAAuB,GAGU,IAAA,+BAAkB,EAC9D,CAAC,MAAM,EAAE,EAAU,EAAE,UAAmB,KAAK,EAAE,EAAE;IAC/C,MAAM,QAAQ,GAAG,IAAI,MAAM,EAAE,CAAC;IAC9B,gBAAgB,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;IAChC,wBAAwB,CAAC,GAAG,CAAC,MAAM,EAAE;QACnC,EAAE;QACF,QAAQ;QACR,OAAO;KACR,CAAC,CAAC;AACL,CAAC,CACF,CAAC;AAEF;;;;;GAKG;AACH,uKAAuK;AACvK,SAAgB,cAAc,CAAC,EAAU,EAAE,OAAiB;IAC1D,MAAM,GAAG,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAA,qBAAM,EAAC,GAAG,EAAE,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAClC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAC,QAAkB;IAC9C,OAAO,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3E,CAAC;AAUD,SAAgB,aAAa,CAC3B,QAAmB;IAEnB,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,EAAE,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,EAAE,EAAE,CAAC;YACP,MAAM,YAAY,GAAG,QAAQ,CAAC,YAAY;iBACvC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;iBAC/D,MAAM,CAAC,CAAC,MAAM,EAAoB,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAEzD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,kBAAkB;gBACpD,CAAC,CAAC,wBAAwB,CAAC,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,EAAE;gBAC/D,CAAC,CAAC,SAAS,CAAC;YAEd,MAAM,eAAe,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;YACpD,MAAM,uBAAuB,GAA2C;gBACtE,GAAG,eAAe;aACnB,CAAC;YAEF,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,wBAAwB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACzD,IAAI,QAAQ,EAAE,OAAO,EAAE,CAAC;oBACtB,uBAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;gBACnD,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,EAAE;gBACF,YAAY;gBACZ,kBAAkB;gBAClB,gBAAgB,EAAE,uBAAuB;gBACzC,cAAc,EAAE,QAAQ,CAAC,uBAAuB,EAAE;aACnD,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/component-options/form-field.d.ts

@@ -0,0 +1,88 @@
+import type { ComponentInfoSerialized } from "../component";
+import type { Tone } from "../tones";
+import type { DataType } from "./data-type";
+/**
+ * Valid default values for form fields and columns
+ */
+export type DefaultValue = string | number | boolean | Date | null | DefaultValue[];
+/** A pill shown beside a read-only field's value. */
+export interface FormFieldBadge {
+    /** i18n key or literal. */
+    label: string;
+    tone: Tone;
+}
+/** A link shown beside a read-only field's value: where it is changed. */
+export interface FormFieldLink {
+    /** i18n key or literal. */
+    label: string;
+    /** Takes the page URL tokens (`{{params.X}}`, `{{query.X}}`). */
+    to: string;
+}
+/** A field shown, not edited, with what tells why or where to change it. */
+export interface FormFieldReadonly {
+    badge?: FormFieldBadge;
+    link?: FormFieldLink;
+}
+/**
+ * Holds while another field of the same form holds one of the values `in`
+ * lists (a select's or status's value, a boolean; `null` for an empty
+ * field), compared as is: `{ field: "stage", in: ["lost"] }`.
+ */
+export interface FieldCondition {
+    field: string;
+    in: readonly unknown[];
+}
+export interface FormField {
+    id: string;
+    label?: string;
+    description?: string;
+    /** A grey help line under the control (i18n key or literal). */
+    hint?: string;
+    type: DataType;
+    inputComponent?: ComponentInfoSerialized;
+    disabled?: boolean;
+    /**
+     * The value is shown, not edited: `true`, or with a pill (`badge`) and a
+     * link to where it is changed (`link`).
+     */
+    readonly?: boolean | FormFieldReadonly;
+    /**
+     * A form creating a record leaves out a read-only field (`disabled` or
+     * `readonly`) that holds nothing yet, a value the server sets once the
+     * record exists: `true` shows it empty all the same.
+     */
+    showEmptyOnCreate?: boolean;
+    required?: boolean;
+    /** The value of a new record: the field starts with it. */
+    defaultValue?: DefaultValue;
+    /**
+     * `defaultValue` is the module's default for a setting, not only a new
+     * record's starting value: while the field holds something else, it shows
+     * "Module default: X" with "Use default", which puts it back. Off unless
+     * set, so a record form (a table view's) never presents a column's initial
+     * value as a default the user strayed from.
+     */
+    offersDefault?: boolean;
+    localized?: boolean;
+    /**
+     * The language a localized field falls back to (its `@Localized`
+     * `fallbackLocale`): a value in any language requires one in this one.
+     */
+    fallbackLocale?: string;
+    /**
+     * Shown only while the condition holds, from the moment the form opens:
+     * hidden, the field is neither required nor sent. A table view's data
+     * routes hold to it as well (see `ColumnOptions.visibleWhen`).
+     */
+    visibleWhen?: FieldCondition;
+    /**
+     * Shown read-only while the condition holds, from the moment the form
+     * opens: its value is not sent. A table view's data routes hold to it as
+     * well (see `ColumnOptions.disabledWhen`).
+     */
+    disabledWhen?: FieldCondition;
+}
+export interface FormFieldSerialized extends Omit<FormField, "type" | "inputComponent"> {
+    component: ComponentInfoSerialized;
+    type: string;
+}

package/dist/component-options/form-field.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=form-field.js.map

package/dist/component-options/form-field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-field.js","sourceRoot":"","sources":["../../src/component-options/form-field.ts"],"names":[],"mappings":""}

package/dist/component-options/internal/action-target.d.ts

@@ -0,0 +1,8 @@
+import type { ActionTarget, ActionTargetSerialized } from "../action-target";
+/**
+ * An action target as the options carry it: a component target is serialized,
+ * every other kind is plain data already.
+ *
+ * @internal
+ */
+export declare function serializeActionTarget(target: ActionTarget): ActionTargetSerialized;

package/dist/component-options/internal/action-target.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeActionTarget = serializeActionTarget;
+/**
+ * An action target as the options carry it: a component target is serialized,
+ * every other kind is plain data already.
+ *
+ * @internal
+ */
+function serializeActionTarget(target) {
+    if (target.type === "drawer" ||
+        target.type === "modal" ||
+        target.type === "sidePanel") {
+        return { ...target, component: target.component.serializeSync() };
+    }
+    return target;
+}
+//# sourceMappingURL=action-target.js.map

package/dist/component-options/internal/action-target.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-target.js","sourceRoot":"","sources":["../../../src/component-options/internal/action-target.ts"],"names":[],"mappings":";;AAQA,sDAWC;AAjBD;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,MAAoB;IAEpB,IACE,MAAM,CAAC,IAAI,KAAK,QAAQ;QACxB,MAAM,CAAC,IAAI,KAAK,OAAO;QACvB,MAAM,CAAC,IAAI,KAAK,WAAW,EAC3B,CAAC;QACD,OAAO,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,CAAC;IACpE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/component-options/internal/button-availability.d.ts

@@ -0,0 +1,17 @@
+import type { ComponentFilterContext } from "../../component";
+import type { CustomButtonAvailability, CustomButtonSerialized } from "../button";
+/**
+ * What a button served to one request carries of its availability.
+ *
+ * @internal
+ */
+export type AvailabilityFields = Pick<CustomButtonSerialized, "id" | "label" | "disabled" | "disabledReason">;
+/**
+ * A served button, disabled with its reason when its `availability` refuses
+ * the request, `undefined` when it hides the button. A resolver that throws
+ * leaves the button enabled: the operation behind it still refuses on its
+ * own, and failing the layout would take the page down.
+ *
+ * @internal
+ */
+export declare function applyButtonAvailability<T extends AvailabilityFields>(availability: CustomButtonAvailability | undefined, serialized: T, context: ComponentFilterContext): Promise<T | undefined>;

package/dist/component-options/internal/button-availability.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyButtonAvailability = applyButtonAvailability;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const isHidden = (answer) => answer.hidden === true;
+/**
+ * A served button, disabled with its reason when its `availability` refuses
+ * the request, `undefined` when it hides the button. A resolver that throws
+ * leaves the button enabled: the operation behind it still refuses on its
+ * own, and failing the layout would take the page down.
+ *
+ * @internal
+ */
+async function applyButtonAvailability(availability, serialized, context) {
+    if (!availability)
+        return serialized;
+    try {
+        const unavailability = await availability(context);
+        if (!unavailability)
+            return serialized;
+        if (isHidden(unavailability))
+            return undefined;
+        return {
+            ...serialized,
+            disabled: true,
+            disabledReason: unavailability.reason,
+        };
+    }
+    catch (error) {
+        logging_1.Logging.Error(`[dms] availability of button "${serialized.id ?? serialized.label}" could not be resolved:`, error);
+        return serialized;
+    }
+}
+//# sourceMappingURL=button-availability.js.map

package/dist/component-options/internal/button-availability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"button-availability.js","sourceRoot":"","sources":["../../../src/component-options/internal/button-availability.ts"],"names":[],"mappings":";;AA+BA,0DAsBC;AArDD,gEAA6D;AAmB7D,MAAM,QAAQ,GAAG,CACf,MAAgE,EAClC,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC;AAE1D;;;;;;;GAOG;AACI,KAAK,UAAU,uBAAuB,CAC3C,YAAkD,EAClD,UAAa,EACb,OAA+B;IAE/B,IAAI,CAAC,YAAY;QAAE,OAAO,UAAU,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc;YAAE,OAAO,UAAU,CAAC;QACvC,IAAI,QAAQ,CAAC,cAAc,CAAC;YAAE,OAAO,SAAS,CAAC;QAC/C,OAAO;YACL,GAAG,UAAU;YACb,QAAQ,EAAE,IAAI;YACd,cAAc,EAAE,cAAc,CAAC,MAAM;SACtC,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CACX,iCAAiC,UAAU,CAAC,EAAE,IAAI,UAAU,CAAC,KAAK,0BAA0B,EAC5F,KAAK,CACN,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC;AACH,CAAC"}

package/dist/component-options/internal/confirm-dialog.d.ts

@@ -0,0 +1,13 @@
+import type { ActionConfirm, ActionConfirmSerialized, ConfirmDialogFrom } from "../confirm-dialog";
+/**
+ * Whether a confirmation is worded by the server (`{ from }`).
+ *
+ * @internal
+ */
+export declare function isConfirmFrom(confirm: ActionConfirm | ActionConfirmSerialized): confirm is ConfirmDialogFrom;
+/**
+ * An action's confirmation as its options carry it.
+ *
+ * @internal
+ */
+export declare function serializeActionConfirm(confirm: ActionConfirm | undefined): ActionConfirmSerialized | undefined;

package/dist/component-options/internal/confirm-dialog.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isConfirmFrom = isConfirmFrom;
+exports.serializeActionConfirm = serializeActionConfirm;
+const confirm_dialog_1 = require("../confirm-dialog");
+/**
+ * Whether a confirmation is worded by the server (`{ from }`).
+ *
+ * @internal
+ */
+function isConfirmFrom(confirm) {
+    return "from" in confirm;
+}
+/**
+ * An action's confirmation as its options carry it.
+ *
+ * @internal
+ */
+function serializeActionConfirm(confirm) {
+    if (!confirm)
+        return undefined;
+    return isConfirmFrom(confirm) ? confirm : (0, confirm_dialog_1.serializeConfirmDialog)(confirm);
+}
+//# sourceMappingURL=confirm-dialog.js.map

package/dist/component-options/internal/confirm-dialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirm-dialog.js","sourceRoot":"","sources":["../../../src/component-options/internal/confirm-dialog.ts"],"names":[],"mappings":";;AAYA,sCAIC;AAOD,wDAKC;AAvBD,sDAA2D;AAE3D;;;;GAIG;AACH,SAAgB,aAAa,CAC3B,OAAgD;IAEhD,OAAO,MAAM,IAAI,OAAO,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,OAAkC;IAElC,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,uCAAsB,EAAC,OAAO,CAAC,CAAC;AAC5E,CAAC"}

package/dist/component-options/internal/form-field.d.ts

@@ -0,0 +1,7 @@
+import type { FormField, FormFieldSerialized } from "../form-field";
+/**
+ * A form field as the client reads it: its data type reduced to an id.
+ *
+ * @internal
+ */
+export declare function serializeFormField(field: FormField): FormFieldSerialized;

package/dist/component-options/internal/form-field.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeFormField = serializeFormField;
+const data_type_1 = require("../data-type");
+/**
+ * A form field as the client reads it: its data type reduced to an id.
+ *
+ * @internal
+ */
+function serializeFormField(field) {
+    const typeId = (0, data_type_1.getDataTypeId)(field.type) || "unknown";
+    return {
+        id: field.id,
+        label: field.label,
+        description: field.description,
+        hint: field.hint,
+        component: field.inputComponent || field.type.inputComponent(),
+        disabled: field.disabled,
+        readonly: field.readonly,
+        showEmptyOnCreate: field.showEmptyOnCreate,
+        type: typeId,
+        required: field.required,
+        defaultValue: field.defaultValue,
+        offersDefault: field.offersDefault,
+        localized: field.localized,
+        visibleWhen: field.visibleWhen,
+        disabledWhen: field.disabledWhen,
+        fallbackLocale: field.fallbackLocale,
+    };
+}
+//# sourceMappingURL=form-field.js.map

package/dist/component-options/internal/form-field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-field.js","sourceRoot":"","sources":["../../../src/component-options/internal/form-field.ts"],"names":[],"mappings":";;AAQA,gDAqBC;AA7BD,4CAA6C;AAG7C;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,KAAgB;IACjD,MAAM,MAAM,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;IAEtD,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,SAAS,EAAE,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE;QAC9D,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;QAC1C,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,cAAc,EAAE,KAAK,CAAC,cAAc;KACrC,CAAC;AACJ,CAAC"}

package/dist/component-options/internal/page-layout.d.ts

@@ -0,0 +1,71 @@
+import type { ButtonPermission } from "../../component";
+import type { ActionTargetSerialized } from "../action-target";
+import type { CustomButtonAvailability, CustomButtonSerialized } from "../button";
+import type { DefaultLayoutOptions } from "../page-layout";
+/**
+ * A button of the page header as the layout serves it, right of the title.
+ * One the layout declares (`DefaultLayout({ headerActions })`) carries its
+ * `target`; one a component of the page places in the header (a table view's
+ * `placement: "header"` button or add) names that component, which runs it.
+ *
+ * @internal
+ */
+export interface PageHeaderButtonSerialized extends Omit<CustomButtonSerialized, "id" | "target"> {
+    /** Key of the button in the header. */
+    id: string;
+    target?: ActionTargetSerialized;
+    /** The component of the page the button belongs to, which runs it. */
+    componentId?: string;
+    /** Id of that component's button; absent for its built-in add action. */
+    buttonId?: string;
+    /** Place among the header's buttons (`PageHeaderButton.order`). */
+    order?: number;
+}
+/**
+ * A header button as the layout holds it until a request is served: its
+ * permission and availability are resolved per request, then dropped.
+ * @internal
+ */
+export interface PageHeaderButtonDeclared extends PageHeaderButtonSerialized {
+    /** Acts on the page's record (`PageHeaderButton.requiresRecord`). */
+    requiresRecord?: boolean;
+    permission?: ButtonPermission;
+    permissionId?: string;
+    availability?: CustomButtonAvailability;
+}
+/**
+ * The options a page layout serializes, its header buttons held as declared.
+ *
+ * @internal
+ */
+export interface DefaultLayoutSerializedOptions extends Omit<DefaultLayoutOptions, "headerActions"> {
+    headerActions?: PageHeaderButtonDeclared[];
+    /**
+     * The page query the header buttons were served for, set only when one of
+     * them declares an `availability` or the layout reads a `record`: the
+     * header asks for its buttons again when the page URL's query no longer
+     * matches it.
+     */
+    headerActionsQuery?: Readonly<Record<string, string>>;
+    /** The route parameters (`:id`) of the page URL, likewise. */
+    headerActionsParams?: Readonly<Record<string, string>>;
+    /**
+     * How the layout's `record` was read for the page URL it was served for,
+     * set only when the layout reads one: the page leaves for its list once
+     * a record it showed is `missing`.
+     */
+    recordStatus?: PageRecordStatus;
+}
+/**
+ * How the page's record was read for one request: `found`, `missing` when its
+ * loader answered none (not found, not the caller's), `error` when it threw.
+ * The frontend takes a record going from `found` to `missing` for one that
+ * was deleted.
+ */
+export type PageRecordStatus = "found" | "missing" | "error";
+/**
+ * The frontend component `TableView` emits.
+ *
+ * @internal
+ */
+export declare const TABLE_VIEW_COMPONENT_NAME = "dms-table-view";

package/dist/component-options/internal/page-layout.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TABLE_VIEW_COMPONENT_NAME = void 0;
+/**
+ * The frontend component `TableView` emits.
+ *
+ * @internal
+ */
+exports.TABLE_VIEW_COMPONENT_NAME = "dms-table-view";
+//# sourceMappingURL=page-layout.js.map

package/dist/component-options/internal/page-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-layout.js","sourceRoot":"","sources":["../../../src/component-options/internal/page-layout.ts"],"names":[],"mappings":";;;AA+EA;;;;GAIG;AACU,QAAA,yBAAyB,GAAG,gBAAgB,CAAC"}

package/dist/component-options/page-layout.d.ts

@@ -0,0 +1,80 @@
+import type { ComponentFilterContext, ComponentInfo } from "../component";
+import type { MaybePromise } from "../types";
+import type { CustomButton } from "./button";
+/** A button of the page header: a `CustomButton` that may say where it goes. */
+export interface PageHeaderButton extends CustomButton {
+    /**
+     * Place among the header's buttons, smallest first; defaults to `0`. The
+     * header sorts the buttons the layout serves and the actions a Vue
+     * component of the page adds (`usePageHeaderActions(render, { order })`)
+     * together; at an equal order the served buttons come first, in the order
+     * declared. A table view's buttons placed in the header (`placement:
+     * "header"`) take `0`.
+     */
+    order?: number;
+    /**
+     * The button acts on the record the page shows (the layout's `record`): it
+     * is left out of a page whose record was not found. A target naming
+     * `{{record.X}}` implies it.
+     */
+    requiresRecord?: boolean;
+}
+/**
+ * Reads the record a page shows, each time its layout is served: the page
+ * URL names it (`context.params`, `context.query`), for the caller
+ * (`context.user`, `context.tenantId`). Answers `undefined` when there is
+ * none to show (not found, not the caller's).
+ *
+ * @example ({ params }) => GetModel(SiteModel).get(params?.id ?? "")
+ */
+export type PageRecordLoader = (context: ComponentFilterContext) => MaybePromise<Record<string, unknown> | undefined>;
+export interface DefaultLayoutOptions {
+    /**
+     * Content spans the whole panel. Defaults to `true`: dashboard pages are
+     * full-width unless they opt out. Set to `false` for pages that only hold a
+     * form, where a constrained column stays readable.
+     */
+    fullWidth?: boolean;
+    hideHeader?: boolean;
+    /**
+     * The page fills the height of the dashboard panel instead of growing with
+     * its content, for a page built around one tool that scrolls inside itself:
+     * a file explorer, a data grid, a canvas. The page header keeps its height
+     * and the last component of the page takes the rest: give its root
+     * `flex-1 min-h-0` and let an element inside it scroll. The page stops
+     * shrinking at a minimum height, below which the panel scrolls again.
+     * Defaults to `false`.
+     */
+    fillHeight?: boolean;
+    /**
+     * Buttons right of the page title, in order: the same buttons as a table's
+     * toolbar — a link (`page` or `external` target), a quick action
+     * (`quickAction`), a drawer, a modal, an API call or an export, with their
+     * confirmation and availability. A string `permission` names an action of
+     * the page, relative to its permission id; `permissionId` is an absolute
+     * one. A table view's own buttons join them with `placement: "header"`.
+     * An `availability` disables a button for one request, or hides it.
+     */
+    headerActions?: PageHeaderButton[];
+    /**
+     * The record the page shows, read on the server with the layout: the
+     * header buttons acting on it (`requiresRecord`, or a `{{record.X}}` in
+     * their target) are left out without it, and every `availability` of the
+     * page reads it as `context.record`.
+     */
+    record?: PageRecordLoader;
+}
+export declare function DefaultLayout(options?: DefaultLayoutOptions): ComponentInfo;
+/**
+ * Standard dashboard frame for a page that holds nothing but a form: keeps the
+ * constrained, readable content column instead of the full-width default.
+ */
+export declare function FormPageLayout(options?: Omit<DefaultLayoutOptions, "fullWidth">): ComponentInfo;
+/**
+ * Dashboard frame of the settings area: the settings navigation next to the
+ * page, in the one column width every settings page shares. Declared by
+ * `settingsCategory`, so its pages and sub-categories get it without naming
+ * it; a settings page declared with a layout of its own opts out.
+ */
+export declare function SettingsLayout(options?: Omit<DefaultLayoutOptions, "fullWidth">): ComponentInfo;
+export declare function EmptyLayout(): ComponentInfo;

package/dist/component-options/page-layout.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLayout = DefaultLayout;
+exports.FormPageLayout = FormPageLayout;
+exports.SettingsLayout = SettingsLayout;
+exports.EmptyLayout = EmptyLayout;
+const confirm_dialog_1 = require("./internal/confirm-dialog");
+const action_target_1 = require("./internal/action-target");
+const HEADER_BUTTON_ID_PREFIX = "header-";
+function declareHeaderButton(button, index) {
+    const { id, target, confirm, placement: _placement, ...rest } = button;
+    const declared = {
+        ...rest,
+        id: id ?? `${HEADER_BUTTON_ID_PREFIX}${index}`,
+        target: (0, action_target_1.serializeActionTarget)(target),
+    };
+    if (confirm)
+        declared.confirm = (0, confirm_dialog_1.serializeActionConfirm)(confirm);
+    return declared;
+}
+function dashboardLayout(componentName, options) {
+    const { headerActions, ...rest } = options;
+    const layoutOptions = rest;
+    if (headerActions) {
+        layoutOptions.headerActions = headerActions.map(declareHeaderButton);
+    }
+    return { componentName, options: layoutOptions };
+}
+function DefaultLayout(options) {
+    return dashboardLayout("dms-default-layout", {
+        fullWidth: true,
+        ...options,
+    });
+}
+/**
+ * Standard dashboard frame for a page that holds nothing but a form: keeps the
+ * constrained, readable content column instead of the full-width default.
+ */
+function FormPageLayout(options) {
+    return DefaultLayout({ ...options, fullWidth: false });
+}
+/**
+ * Dashboard frame of the settings area: the settings navigation next to the
+ * page, in the one column width every settings page shares. Declared by
+ * `settingsCategory`, so its pages and sub-categories get it without naming
+ * it; a settings page declared with a layout of its own opts out.
+ */
+function SettingsLayout(options) {
+    return dashboardLayout("dms-settings-layout", { ...options });
+}
+function EmptyLayout() {
+    return {
+        componentName: "dms-empty-layout",
+        options: {},
+    };
+}
+//# sourceMappingURL=page-layout.js.map

package/dist/component-options/page-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-layout.js","sourceRoot":"","sources":["../../src/component-options/page-layout.ts"],"names":[],"mappings":";;AA2GA,sCAKC;AAMD,wCAIC;AAQD,wCAIC;AAED,kCAKC;AA3ID,8DAAmE;AACnE,4DAAiE;AA4EjE,MAAM,uBAAuB,GAAG,SAAS,CAAC;AAE1C,SAAS,mBAAmB,CAC1B,MAAwB,EACxB,KAAa;IAEb,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACvE,MAAM,QAAQ,GAA6B;QACzC,GAAG,IAAI;QACP,EAAE,EAAE,EAAE,IAAI,GAAG,uBAAuB,GAAG,KAAK,EAAE;QAC9C,MAAM,EAAE,IAAA,qCAAqB,EAAC,MAAM,CAAC;KACtC,CAAC;IACF,IAAI,OAAO;QAAE,QAAQ,CAAC,OAAO,GAAG,IAAA,uCAAsB,EAAC,OAAO,CAAC,CAAC;IAChE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,eAAe,CACtB,aAAqB,EACrB,OAA6B;IAE7B,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,aAAa,GAAmC,IAAI,CAAC;IAC3D,IAAI,aAAa,EAAE,CAAC;QAClB,aAAa,CAAC,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;AACnD,CAAC;AAED,SAAgB,aAAa,CAAC,OAA8B;IAC1D,OAAO,eAAe,CAAC,oBAAoB,EAAE;QAC3C,SAAS,EAAE,IAAI;QACf,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAC5B,OAAiD;IAEjD,OAAO,aAAa,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,OAAiD;IAEjD,OAAO,eAAe,CAAC,qBAAqB,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,SAAgB,WAAW;IACzB,OAAO;QACL,aAAa,EAAE,kBAAkB;QACjC,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC"}