@antelopejs/interface-dms 0.3.5 → 0.4.0

package/dist/base/types/custom-button.d.ts

@@ -1,24 +1,70 @@
 import type { ButtonPermission, ComponentFilterContext } from "../../component";
 import type { MaybePromise } from "../../types";
 import type { ActionTarget, ActionTargetSerialized } from "./action-target";
+import type { ActionConfirm, ActionConfirmSerialized } from "./confirm-dialog";
 import type { ButtonVariant } from "./button";
-export type ButtonColor = "primary" | "secondary" | "success" | "error" | "warning" | "info" | "neutral";
+import type { Tone } from "./tone";
+/** The `color` of a button or an action: one of the semantic tones. */
+export type ButtonColor = Tone;
+/** Where a table's button is drawn: its toolbar, or its page's header. */
+export type ButtonPlacement = "toolbar" | "header";
+/** Why a button cannot be pressed right now. */
 export interface CustomButtonUnavailability {
+    /**
+     * Shown next to the disabled button: what blocks it, and how to lift the
+     * block when the user can. A `$`-prefixed value resolves as an i18n key.
+     */
     reason: string;
 }
+/**
+ * Decides, per request, whether a button can be pressed. Runs server-side
+ * while the page layout is filtered, so the button reaches the client already
+ * disabled. Returning `undefined` leaves it enabled.
+ *
+ * It only shapes the UI: whatever the button triggers must still refuse the
+ * operation on its own.
+ */
 export type CustomButtonAvailability = (context: ComponentFilterContext) => MaybePromise<CustomButtonUnavailability | undefined>;
 export interface CustomButton {
+    /**
+     * Names the button so a quick action can press it (`type: "button"`); the
+     * action then inherits the button's `permission`. Unique within its table.
+     */
     id?: string;
     label: string;
     icon?: string;
     variant?: ButtonVariant;
     color?: ButtonColor;
     target: ActionTarget;
+    /** Asked before the button's target runs: a fixed dialog, or `{ from }`. */
+    confirm?: ActionConfirm;
+    /**
+     * Gate the button behind a permission: one of the owning table's actions by
+     * name (e.g. `"add"`) — in a page header (`DefaultLayout({ headerActions
+     * })`), an action of the page, relative to its permission id — or an
+     * `Action` of any component (e.g. another table's `add`). The button is
+     * stripped from the served options when the caller lacks the permission.
+     */
     permission?: ButtonPermission;
+    /** Absolute permission id the button requires; wins over `permission`. */
+    permissionId?: string;
+    /**
+     * Disables the button for a request it answers with a reason. A button the
+     * caller lacks the permission for is stripped before this runs.
+     */
     availability?: CustomButtonAvailability;
+    /**
+     * Where the button is drawn: in the table's toolbar (the default), or in
+     * the header of the page carrying the table, which the server adds it to —
+     * the table still runs it. Either way a quick action can press it by `id`.
+     */
+    placement?: ButtonPlacement;
 }
-export interface CustomButtonSerialized extends Omit<CustomButton, "target" | "permission" | "availability"> {
+export interface CustomButtonSerialized extends Omit<CustomButton, "target" | "permission" | "permissionId" | "availability" | "confirm"> {
     target: ActionTargetSerialized;
+    confirm?: ActionConfirmSerialized;
+    /** Set when the button's `availability` refused this request. */
     disabled?: boolean;
+    /** The reason `availability` gave, shown next to the disabled button. */
     disabledReason?: string;
 }

package/dist/base/types/enum-option.d.ts

@@ -1 +1,10 @@
+/**
+ * An enum option as a page may carry it: the member, or the value it stands for.
+ *
+ * A page is a file a developer types as much as one the builder writes, and what
+ * the builder writes is a literal — `"md"`, never `Size.medium`, since nothing
+ * in a serialized option says which enum a value came from. TypeScript refuses a
+ * plain string where a string enum is expected, so an option declared over one
+ * accepts both spellings; the option's schema validates the value either way.
+ */
 export type EnumOption<T extends string> = T | `${T}`;

package/dist/base/types/error.d.ts

@@ -1,5 +1,14 @@
+/**
+ * Error with a message property
+ */
 export interface ErrorWithMessage {
     message: string;
 }
+/**
+ * Type guard to check if an error has a message
+ */
 export declare function isErrorWithMessage(error: unknown): error is ErrorWithMessage;
+/**
+ * Get error message from unknown error
+ */
 export declare function getErrorMessage(error: unknown): string;

package/dist/base/types/error.js

@@ -2,10 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isErrorWithMessage = isErrorWithMessage;
 exports.getErrorMessage = getErrorMessage;
-const type_check_1 = require("../../utils/type-check");
+const type_check_1 = require("../../utils/internal/type-check");
+/**
+ * Type guard to check if an error has a message
+ */
 function isErrorWithMessage(error) {
     return (0, type_check_1.isObject)(error) && !(0, type_check_1.isNull)(error) && "message" in error;
 }
+/**
+ * Get error message from unknown error
+ */
 function getErrorMessage(error) {
     if (isErrorWithMessage(error)) {
         return error.message;

package/dist/base/types/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/base/types/error.ts"],"names":[],"mappings":";;AAYA,gDAEC;AAKD,0CAKC;AAxBD,uDAA0D;AAY1D,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,OAAO,IAAA,qBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,IAAA,mBAAM,EAAC,KAAK,CAAC,IAAI,SAAS,IAAI,KAAK,CAAC;AACjE,CAAC;AAKD,SAAgB,eAAe,CAAC,KAAc;IAC5C,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/base/types/error.ts"],"names":[],"mappings":";;AAYA,gDAEC;AAKD,0CAKC;AAxBD,gEAAmE;AASnE;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,OAAO,IAAA,qBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,IAAA,mBAAM,EAAC,KAAK,CAAC,IAAI,SAAS,IAAI,KAAK,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC5C,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/dist/base/types/export-status.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Export status enum
+ */
 export declare enum ExportStatus {
     pending = "pending",
     completed = "completed",

package/dist/base/types/export-status.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExportStatus = void 0;
+/**
+ * Export status enum
+ */
 var ExportStatus;
 (function (ExportStatus) {
     ExportStatus["pending"] = "pending";

package/dist/base/types/export-status.js.map

@@ -1 +1 @@
-{"version":3,"file":"export-status.js","sourceRoot":"","sources":["../../../src/base/types/export-status.ts"],"names":[],"mappings":";;;AAGA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;AACnB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}
+{"version":3,"file":"export-status.js","sourceRoot":"","sources":["../../../src/base/types/export-status.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;AACnB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}

package/dist/base/types/field-config.d.ts

@@ -5,6 +5,9 @@ export interface ListableConfig {
     select?: boolean;
     export?: boolean;
 }
+/**
+ * Field metadata from DataAPIMeta
+ */
 export interface FieldMetadata {
     mandatory?: Set<FormMode>;
     mode?: AccessMode;

package/dist/base/types/form-mode.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Form mode types
+ */
 export declare enum FormMode {
     new = "new",
     edit = "edit",

package/dist/base/types/form-mode.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormMode = void 0;
+/**
+ * Form mode types
+ */
 var FormMode;
 (function (FormMode) {
     FormMode["new"] = "new";

package/dist/base/types/form-mode.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-mode.js","sourceRoot":"","sources":["../../../src/base/types/form-mode.ts"],"names":[],"mappings":";;;AAGA,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB"}
+{"version":3,"file":"form-mode.js","sourceRoot":"","sources":["../../../src/base/types/form-mode.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB"}

package/dist/base/types/form-values.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Valid default values for form fields and columns
+ */
 export type DefaultValue = string | number | boolean | Date | null | DefaultValue[];
+/**
+ * Valid form field values
+ */
 export type FormFieldValue = string | number | boolean | Date | null | FormFieldValue[];

package/dist/base/types/guards.d.ts

@@ -1,4 +1,5 @@
 import type { RequestContext } from "@antelopejs/interface-api";
+/** Loaded model before response field selection; treat current as read-only. */
 export interface GetGuardArgs<T extends Record<string, unknown> = Record<string, unknown>> {
     id: string;
     current: T;
@@ -8,21 +9,50 @@ export interface EditGuardArgs<T extends Record<string, unknown> = Record<string
     body: Partial<T>;
     current: T;
 }
+/**
+ * What a delete, archive or restore guard receives: the rows, and the values
+ * of the fields its confirmation asked (`confirm.fields`), such as where to
+ * move what the rows take with them. `values` is unset when the request
+ * carried no body: no confirmation with fields was answered.
+ */
 export interface DeleteGuardArgs {
     ids: string[];
+    values?: Record<string, unknown>;
 }
+/** What an archive or restore guard receives; see {@link DeleteGuardArgs}. */
 export interface BulkGuardArgs {
     ids: string[];
+    values?: Record<string, unknown>;
 }
 export interface NewGuardArgs<T extends Record<string, unknown> = Record<string, unknown>> {
     body: Partial<T>;
 }
-export type GuardFn<TArgs> = (this: unknown, ctx: RequestContext, args: TArgs) => void | Promise<void>;
+/**
+ * Work a mutating guard hands back, run once the write it guarded succeeded:
+ * the guard knows the row as it was, this knows it was written — a
+ * notification comparing the two belongs here. It runs in the same request,
+ * on the same instance; a failure is logged and never fails the request, the
+ * write being done.
+ */
+export type AfterWrite = () => void | Promise<void>;
+/**
+ * Throws to refuse the action. A mutating guard (`edit`, `delete`, `archive`,
+ * `restore`, `new`) may return an {@link AfterWrite}; what `get` returns is
+ * ignored. It runs with the data controller instance as `this`
+ * (`TController`), so a guard written as a `function` reaches its models.
+ */
+export type GuardFn<TArgs, TController = unknown> = (this: TController, ctx: RequestContext, args: TArgs) => void | AfterWrite | Promise<void | AfterWrite>;
+/**
+ * The guards of a table view. `T` is its data controller instance — the type
+ * `TableView()` infers from the controller — so it types both the row a
+ * guard reads and the `this` it runs with.
+ */
 export interface TableViewGuards<T extends Record<string, unknown> = Record<string, unknown>> {
-    get?: GuardFn<GetGuardArgs<T>>;
-    edit?: GuardFn<EditGuardArgs<T>>;
-    delete?: GuardFn<DeleteGuardArgs>;
-    archive?: GuardFn<BulkGuardArgs>;
-    restore?: GuardFn<BulkGuardArgs>;
-    new?: GuardFn<NewGuardArgs<T>>;
+    /** Runs after view authorization and loading, before response and presence acquisition. Not used by exports. */
+    get?: GuardFn<GetGuardArgs<T>, T>;
+    edit?: GuardFn<EditGuardArgs<T>, T>;
+    delete?: GuardFn<DeleteGuardArgs, T>;
+    archive?: GuardFn<BulkGuardArgs, T>;
+    restore?: GuardFn<BulkGuardArgs, T>;
+    new?: GuardFn<NewGuardArgs<T>, T>;
 }

package/dist/base/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "./base-component-props";
 export * from "./button";
 export * from "./color";
 export * from "./component-input";
+export * from "./confirm-dialog";
 export * from "./custom-button";
 export * from "./enum-option";
 export * from "./error";
@@ -14,4 +15,5 @@ export * from "./json";
 export * from "./orientation";
 export * from "./readonly-behavior";
 export * from "./size";
+export * from "./tone";
 export * from "./watch";

package/dist/base/types/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./base-component-props"), exports);
 __exportStar(require("./button"), exports);
 __exportStar(require("./color"), exports);
 __exportStar(require("./component-input"), exports);
+__exportStar(require("./confirm-dialog"), exports);
 __exportStar(require("./custom-button"), exports);
 __exportStar(require("./enum-option"), exports);
 __exportStar(require("./error"), exports);
@@ -30,5 +31,6 @@ __exportStar(require("./json"), exports);
 __exportStar(require("./orientation"), exports);
 __exportStar(require("./readonly-behavior"), exports);
 __exportStar(require("./size"), exports);
+__exportStar(require("./tone"), exports);
 __exportStar(require("./watch"), exports);
 //# sourceMappingURL=index.js.map

package/dist/base/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/base/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,2CAAyB;AACzB,0CAAwB;AACxB,oDAAkC;AAClC,kDAAgC;AAChC,gDAA8B;AAC9B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,8CAA4B;AAC5B,gDAA8B;AAC9B,yCAAuB;AACvB,yCAAuB;AACvB,gDAA8B;AAC9B,sDAAoC;AACpC,yCAAuB;AACvB,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/base/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,2CAAyB;AACzB,0CAAwB;AACxB,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,gDAA8B;AAC9B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,8CAA4B;AAC5B,gDAA8B;AAC9B,yCAAuB;AACvB,yCAAuB;AACvB,gDAA8B;AAC9B,sDAAoC;AACpC,yCAAuB;AACvB,yCAAuB;AACvB,0CAAwB"}

package/dist/base/types/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/base/types/internal/action-target.js

@@ -0,0 +1,16 @@
+"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") {
+        return { ...target, component: target.component.serializeSync() };
+    }
+    return target;
+}
+//# sourceMappingURL=action-target.js.map

package/dist/base/types/internal/action-target.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-target.js","sourceRoot":"","sources":["../../../../src/base/types/internal/action-target.ts"],"names":[],"mappings":";;AAQA,sDAOC;AAbD;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,MAAoB;IAEpB,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACxD,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/base/types/json.d.ts

@@ -1,4 +1,10 @@
+/**
+ * JSON primitive values
+ */
 export type JsonPrimitive = string | number | boolean | null;
+/**
+ * Recursive type for JSON-serializable values
+ */
 export type JsonValue = JsonPrimitive | JsonValue[] | {
     [key: string]: JsonValue;
 };

package/dist/base/types/orientation.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Generic orientation enum
+ */
 export declare enum AxeOrientation {
     horizontal = "horizontal",
     vertical = "vertical"

package/dist/base/types/orientation.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AxeOrientation = void 0;
+/**
+ * Generic orientation enum
+ */
 var AxeOrientation;
 (function (AxeOrientation) {
     AxeOrientation["horizontal"] = "horizontal";

package/dist/base/types/orientation.js.map

@@ -1 +1 @@
-{"version":3,"file":"orientation.js","sourceRoot":"","sources":["../../../src/base/types/orientation.ts"],"names":[],"mappings":";;;AAGA,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,2CAAyB,CAAA;IACzB,uCAAqB,CAAA;AACvB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB"}
+{"version":3,"file":"orientation.js","sourceRoot":"","sources":["../../../src/base/types/orientation.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,2CAAyB,CAAA;IACzB,uCAAqB,CAAA;AACvB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB"}

package/dist/base/types/readonly-behavior.d.ts

@@ -1,11 +1,20 @@
+/**
+ * Readonly behavior for different modes
+ */
 export declare enum ReadonlyBehaviorType {
     disabled = "disabled",
     hidden = "hidden",
     default = "default"
 }
+/**
+ * Readonly behavior configuration
+ */
 export interface ReadonlyBehaviorConfig {
     new?: ReadonlyBehaviorType;
     edit?: ReadonlyBehaviorType;
     view?: ReadonlyBehaviorType;
 }
+/**
+ * Readonly behavior type (enum or config object)
+ */
 export type ReadonlyBehavior = ReadonlyBehaviorType | ReadonlyBehaviorConfig;

package/dist/base/types/readonly-behavior.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadonlyBehaviorType = void 0;
+/**
+ * Readonly behavior for different modes
+ */
 var ReadonlyBehaviorType;
 (function (ReadonlyBehaviorType) {
     ReadonlyBehaviorType["disabled"] = "disabled";

package/dist/base/types/readonly-behavior.js.map

@@ -1 +1 @@
-{"version":3,"file":"readonly-behavior.js","sourceRoot":"","sources":["../../../src/base/types/readonly-behavior.ts"],"names":[],"mappings":";;;AAGA,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;AACrB,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B"}
+{"version":3,"file":"readonly-behavior.js","sourceRoot":"","sources":["../../../src/base/types/readonly-behavior.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;IACrB,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;AACrB,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B"}

package/dist/base/types/row-action.d.ts

@@ -1,4 +1,8 @@
+import type { ButtonPermission } from "../../component";
 import type { ActionTarget, ActionTargetSerialized } from "./action-target";
+import type { ButtonVariant } from "./button";
+import type { ActionConfirm, ActionConfirmSerialized } from "./confirm-dialog";
+import type { ButtonColor, ButtonPlacement } from "./custom-button";
 import type { AnyFieldRule, FieldRule } from "./row-action-operators";
 export type FieldEqualsRule<T extends Record<string, unknown> = Record<string, unknown>> = FieldRule<T, "equals">;
 export type FieldNotEqualsRule<T extends Record<string, unknown> = Record<string, unknown>> = FieldRule<T, "notEquals">;
@@ -15,24 +19,131 @@ export type NotRule<T extends Record<string, unknown> = Record<string, unknown>>
 };
 export type LogicalRule<T extends Record<string, unknown> = Record<string, unknown>> = AndRule<T> | OrRule<T> | NotRule<T>;
 export type RowActionRule<T extends Record<string, unknown> = Record<string, unknown>> = AnyFieldRule<T> | LogicalRule<T>;
+/** A built-in row action of a table view, configured. */
 export interface RowActionConfig<T extends Record<string, unknown> = Record<string, unknown>> {
     isEnabled?: boolean;
     isVisible?: boolean;
     rule?: RowActionRule<T>;
+    /** Label in place of the built-in one ("Change roles"). `$`: i18n key. */
+    label?: string;
+    /** Icon in place of the built-in one. */
+    icon?: string;
+    /**
+     * Asked before the action runs: a fixed dialog, or `{ from }`, a URL
+     * (`{id}` and the row's fields are filled in) answering the dialog the
+     * server words for that row — what it takes with it, or why it cannot go.
+     * Delete and archive ask a generic confirmation without it; a `from`
+     * dialog applies to one row, several rows at once keep the generic one.
+     */
+    confirm?: ActionConfirm;
+}
+/** A built-in row action as it reaches the client. */
+export interface RowActionConfigSerialized extends Omit<RowActionConfig, "confirm"> {
+    confirm?: ActionConfirmSerialized;
+    successMessage?: string;
+    placement?: ButtonPlacement;
+}
+/** The built-in add action: where its button is drawn, besides the rest. */
+export interface AddRowActionConfig<T extends Record<string, unknown> = Record<string, unknown>> extends RowActionConfig<T> {
+    /**
+     * The table's toolbar (the default), or the header of its page, which the
+     * server adds the button to.
+     */
+    placement?: ButtonPlacement;
+}
+/**
+ * Delete, archive or restore: a built-in action that runs on the selected
+ * rows too, and reports what it did.
+ */
+export interface BulkRowActionConfig<T extends Record<string, unknown> = Record<string, unknown>> extends RowActionConfig<T> {
+    /**
+     * Toast once the action succeeded, receiving `{ count }`. `$`-prefixed: an
+     * i18n key.
+     */
+    successMessage?: string;
+}
+/** How a custom row action runs on several rows at once. */
+export interface CustomRowActionBulkOptions {
+    /**
+     * Also offered once the user picks "Select all N matching": the target
+     * then receives the table's current filters and search instead of ids,
+     * and the route finds the rows itself (`resolveBulkRowIds`).
+     */
+    allMatching?: true;
 }
+/**
+ * A custom row action offered on the selection bar: `true` for the selected
+ * rows, `{ allMatching: true }` for every row the table's filters match too.
+ */
+export type CustomRowActionBulk = true | CustomRowActionBulkOptions;
 export interface CustomRowAction<T extends Record<string, unknown> = Record<string, unknown>> {
     label: string;
     icon?: string;
     target: ActionTarget;
+    /**
+     * Asked before the action runs, whatever its target: a fixed dialog (its
+     * texts receive the row's fields as parameters, "Remove {name}?"), or
+     * `{ from }`, a URL (`{id}` and the row's fields are filled in) answering
+     * the dialog the server words for the row.
+     */
+    confirm?: ActionConfirm;
     rule?: RowActionRule<T>;
     isVisible?: boolean;
+    /**
+     * Makes this action the target of a row click, ahead of the built-in
+     * `edit`/`details` fallbacks. The first flagged action whose `rule` accepts
+     * the row wins.
+     */
     isDefault?: boolean;
+    /**
+     * Gate the action behind a permission, like a custom button: a string
+     * names one of the table's actions (e.g. `"edit"`), an `Action` any
+     * component's. The action is stripped for a caller without it.
+     *
+     * It only hides the action: the route its target calls must check the
+     * permission itself.
+     */
+    permission?: ButtonPermission;
+    /** Absolute permission id the action requires; wins over `permission`. */
+    permissionId?: string;
+    /** Color of the action: an inline button, or a menu entry. */
+    color?: ButtonColor;
+    /** Variant of an inline (`isVisible`) button. Defaults to `ghost`. */
+    variant?: ButtonVariant;
+    /** An inline (`isVisible`) button shows its label next to its icon. */
+    showLabel?: boolean;
+    /**
+     * Offers the action on the selection bar, for the selected rows: an `api`
+     * or `exportJob` target receives their `ids` as a repeated query parameter
+     * (`?ids=a&ids=b`), a page or external URL too, a drawer or modal
+     * component a `selection` prop. With `{ allMatching: true }`, "Select all
+     * N matching" sends `allMatching=true` and the table's filters and search
+     * instead. A fixed confirmation receives `{ count }`.
+     */
+    bulk?: CustomRowActionBulk;
+    /**
+     * The drawer or modal the action opens is reflected in the URL
+     * (`?record=<id>`, `?<tableId>.record=<id>` on a page with several table
+     * views): a link or a reload opens it again on that row.
+     */
+    deepLink?: boolean;
 }
 export interface CustomRowActionSerialized {
     label: string;
     icon?: string;
     target: ActionTargetSerialized;
+    confirm?: ActionConfirmSerialized;
     rule?: RowActionRule;
     isVisible?: boolean;
+    /**
+     * Makes this action the target of a row click, ahead of the built-in
+     * `edit`/`details` fallbacks. The first flagged action whose `rule` accepts
+     * the row wins.
+     */
     isDefault?: boolean;
+    color?: ButtonColor;
+    variant?: ButtonVariant;
+    showLabel?: boolean;
+    bulk?: CustomRowActionBulk;
+    deepLink?: boolean;
 }

package/dist/base/types/size.d.ts

@@ -5,6 +5,7 @@ export declare enum Size {
     large = "lg",
     huge = "xl"
 }
+/** The size tokens a component option accepts. */
 export declare const SIZES: readonly ["xs", "sm", "md", "lg", "xl"];
 export type SizeValue = Size | (string & {});
 export type ModalSize = "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl";

package/dist/base/types/size.js

@@ -9,5 +9,9 @@ var Size;
     Size["large"] = "lg";
     Size["huge"] = "xl";
 })(Size || (exports.Size = Size = {}));
+// Spelled out rather than derived from `Size`: a string-enum member is not
+// assignable to a string literal, so `Object.values(Size)` would not give
+// z.enum() the literal tuple it needs.
+/** The size tokens a component option accepts. */
 exports.SIZES = ["xs", "sm", "md", "lg", "xl"];
 //# sourceMappingURL=size.js.map

package/dist/base/types/size.js.map

@@ -1 +1 @@
-{"version":3,"file":"size.js","sourceRoot":"","sources":["../../../src/base/types/size.ts"],"names":[],"mappings":";;;AAAA,IAAY,IAMX;AAND,WAAY,IAAI;IACd,mBAAW,CAAA;IACX,oBAAY,CAAA;IACZ,qBAAa,CAAA;IACb,oBAAY,CAAA;IACZ,mBAAW,CAAA;AACb,CAAC,EANW,IAAI,oBAAJ,IAAI,QAMf;AAMY,QAAA,KAAK,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC"}
+{"version":3,"file":"size.js","sourceRoot":"","sources":["../../../src/base/types/size.ts"],"names":[],"mappings":";;;AAAA,IAAY,IAMX;AAND,WAAY,IAAI;IACd,mBAAW,CAAA;IACX,oBAAY,CAAA;IACZ,qBAAa,CAAA;IACb,oBAAY,CAAA;IACZ,mBAAW,CAAA;AACb,CAAC,EANW,IAAI,oBAAJ,IAAI,QAMf;AAED,2EAA2E;AAC3E,0EAA0E;AAC1E,uCAAuC;AACvC,kDAAkD;AACrC,QAAA,KAAK,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC"}

package/dist/base/types/tone.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The semantic tones of the dashboard, the colour names of Nuxt UI. A clickable
+ * thing (a button, a row action, a tab) takes one as its `color`; a thing that
+ * shows a state (a pill, an icon well, a banner, a meter, a notification) as its
+ * `tone`. A block that supports fewer narrows the union with `Extract<>`.
+ */
+export declare const TONES: readonly ["neutral", "primary", "secondary", "success", "warning", "error", "info"];
+export type Tone = (typeof TONES)[number];
+/**
+ * The tones of an icon well: the semantic ones plus `muted`, the quiet well
+ * of a settings row or a status strip cell.
+ */
+export declare const ICON_TONES: readonly ["neutral", "primary", "secondary", "success", "warning", "error", "info", "muted"];
+export type IconTone = (typeof ICON_TONES)[number];

package/dist/base/types/tone.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ICON_TONES = exports.TONES = void 0;
+/**
+ * The semantic tones of the dashboard, the colour names of Nuxt UI. A clickable
+ * thing (a button, a row action, a tab) takes one as its `color`; a thing that
+ * shows a state (a pill, an icon well, a banner, a meter, a notification) as its
+ * `tone`. A block that supports fewer narrows the union with `Extract<>`.
+ */
+exports.TONES = [
+    "neutral",
+    "primary",
+    "secondary",
+    "success",
+    "warning",
+    "error",
+    "info",
+];
+/**
+ * The tones of an icon well: the semantic ones plus `muted`, the quiet well
+ * of a settings row or a status strip cell.
+ */
+exports.ICON_TONES = [...exports.TONES, "muted"];
+//# sourceMappingURL=tone.js.map

package/dist/base/types/tone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tone.js","sourceRoot":"","sources":["../../../src/base/types/tone.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACU,QAAA,KAAK,GAAG;IACnB,SAAS;IACT,SAAS;IACT,WAAW;IACX,SAAS;IACT,SAAS;IACT,OAAO;IACP,MAAM;CACE,CAAC;AAIX;;;GAGG;AACU,QAAA,UAAU,GAAG,CAAC,GAAG,aAAK,EAAE,OAAO,CAAU,CAAC"}

package/dist/client-base-url.d.ts

@@ -1 +1,9 @@
+/**
+ * The public origin the dashboard is served from.
+ *
+ * It comes from the DMS configuration, and from the dev server override, so the
+ * module owns it: anything building an absolute link -- an export mail, an
+ * invitation -- asks for it rather than reading a value this package would have
+ * to hold and every consumer would have to keep in sync.
+ */
 export declare const GetClientBaseUrl: () => Promise<string | undefined>;

package/dist/client-base-url.js

@@ -2,5 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetClientBaseUrl = void 0;
 const interface_core_1 = require("@antelopejs/interface-core");
+/**
+ * The public origin the dashboard is served from.
+ *
+ * It comes from the DMS configuration, and from the dev server override, so the
+ * module owns it: anything building an absolute link -- an export mail, an
+ * invitation -- asks for it rather than reading a value this package would have
+ * to hold and every consumer would have to keep in sync.
+ */
 exports.GetClientBaseUrl = (0, interface_core_1.InterfaceFunction)();
 //# sourceMappingURL=client-base-url.js.map

package/dist/client-base-url.js.map

@@ -1 +1 @@
-{"version":3,"file":"client-base-url.js","sourceRoot":"","sources":["../src/client-base-url.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAUlD,QAAA,gBAAgB,GAAG,IAAA,kCAAiB,GAA4B,CAAC"}
+{"version":3,"file":"client-base-url.js","sourceRoot":"","sources":["../src/client-base-url.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAE/D;;;;;;;GAOG;AACU,QAAA,gBAAgB,GAAG,IAAA,kCAAiB,GAA4B,CAAC"}