@antelopejs/interface-dms 0.3.5 → 0.4.0

package/dist/base/internal/query-response.d.ts

@@ -0,0 +1,24 @@
+import type { SeriesMeasure, SeriesPoint } from "../query-response";
+/**
+ * The figure a card shows above its chart, or nothing when there is none.
+ *
+ * Unmeasured groups are dropped rather than read as zero: a minimum or an
+ * average taken over invented zeroes is wrong in a way no reader can see. With
+ * nothing left to measure the answer is `undefined`, and every caller leaves the
+ * field out of its response instead of writing a figure the query never gave.
+ *
+ * Counts and sums add up; a minimum or a maximum over groups is the minimum or
+ * maximum of the group figures. An average is the average of the group averages,
+ * which is not the average over all the rows — the two differ whenever the groups
+ * are not the same size, and computing the real one would mean a second query.
+ * Said here because a card showing it should not imply otherwise.
+ *
+ * @internal
+ */
+export declare function headline(points: SeriesPoint[], measure?: SeriesMeasure): number | undefined;
+/**
+ * What the calculation actually measured, unmeasured groups dropped.
+ *
+ * @internal
+ */
+export declare function measuredValues(points: SeriesPoint[]): number[];

package/dist/base/internal/query-response.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.headline = headline;
+exports.measuredValues = measuredValues;
+const DEFAULT_MEASURE = "sum";
+const total = (values) => values.reduce((running, value) => running + value, 0);
+const HEADLINE_BY_MEASURE = {
+    count: total,
+    sum: total,
+    avg: (values) => total(values) / values.length,
+    min: (values) => Math.min(...values),
+    max: (values) => Math.max(...values),
+};
+/**
+ * The figure a card shows above its chart, or nothing when there is none.
+ *
+ * Unmeasured groups are dropped rather than read as zero: a minimum or an
+ * average taken over invented zeroes is wrong in a way no reader can see. With
+ * nothing left to measure the answer is `undefined`, and every caller leaves the
+ * field out of its response instead of writing a figure the query never gave.
+ *
+ * Counts and sums add up; a minimum or a maximum over groups is the minimum or
+ * maximum of the group figures. An average is the average of the group averages,
+ * which is not the average over all the rows — the two differ whenever the groups
+ * are not the same size, and computing the real one would mean a second query.
+ * Said here because a card showing it should not imply otherwise.
+ *
+ * @internal
+ */
+function headline(points, measure = DEFAULT_MEASURE) {
+    const values = measuredValues(points);
+    if (values.length === 0) {
+        return undefined;
+    }
+    return HEADLINE_BY_MEASURE[measure](values);
+}
+/**
+ * What the calculation actually measured, unmeasured groups dropped.
+ *
+ * @internal
+ */
+function measuredValues(points) {
+    return points
+        .map((point) => point.y)
+        .filter((value) => value !== null);
+}
+//# sourceMappingURL=query-response.js.map

package/dist/base/internal/query-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-response.js","sourceRoot":"","sources":["../../../src/base/internal/query-response.ts"],"names":[],"mappings":";;AAgCA,4BASC;AAOD,wCAIC;AAlDD,MAAM,eAAe,GAAkB,KAAK,CAAC;AAE7C,MAAM,KAAK,GAAG,CAAC,MAAgB,EAAU,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC;AAExD,MAAM,mBAAmB,GACvB;IACE,KAAK,EAAE,KAAK;IACZ,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM;IAC9C,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;IACpC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;CACrC,CAAC;AAEJ;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,QAAQ,CACtB,MAAqB,EACrB,UAAyB,eAAe;IAExC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,MAAqB;IAClD,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;SACvB,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;AACxD,CAAC"}

package/dist/base/internal/searchable.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Whether a controller declares `@Searchable` fields to search in.
+ *
+ * @internal
+ */
+export declare function hasSearchableFields(controller: new (...args: unknown[]) => unknown): boolean;

package/dist/base/internal/searchable.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasSearchableFields = hasSearchableFields;
+const interface_core_1 = require("@antelopejs/interface-core");
+const searchable_1 = require("../searchable");
+/**
+ * Whether a controller declares `@Searchable` fields to search in.
+ *
+ * @internal
+ */
+function hasSearchableFields(controller) {
+    return (Object.keys((0, interface_core_1.GetMetadata)(controller, searchable_1.SearchableMeta).getSearchableFields())
+        .length > 0);
+}
+//# sourceMappingURL=searchable.js.map

package/dist/base/internal/searchable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchable.js","sourceRoot":"","sources":["../../../src/base/internal/searchable.ts"],"names":[],"mappings":";;AAQA,kDAOC;AAfD,+DAAyD;AACzD,8CAA+C;AAE/C;;;;GAIG;AACH,SAAgB,mBAAmB,CACjC,UAA+C;IAE/C,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,IAAA,4BAAW,EAAC,UAAU,EAAE,2BAAc,CAAC,CAAC,mBAAmB,EAAE,CAAC;SACvE,MAAM,GAAG,CAAC,CACd,CAAC;AACJ,CAAC"}

package/dist/base/key-value-list.d.ts

@@ -0,0 +1,160 @@
+import { ComponentBuilder } from "../component";
+import { z } from "zod";
+import { type BlockItemsSource } from "./display";
+import { type Tone } from "./types/tone";
+import type { BaseComponentProps } from "./types";
+/**
+ * How a value is drawn: `text` plain, `status` a tinted pill, `money` a
+ * currency amount, `date` a localized date, `link` an accent link, `mono` an
+ * identifier or a figure in the mono font.
+ */
+export declare const KEY_VALUE_TYPES: readonly ["text", "status", "money", "date", "link", "mono"];
+export type KeyValueType = (typeof KEY_VALUE_TYPES)[number];
+/** One label / value row. */
+export interface KeyValueListItem {
+    /** Stable key; the position is used without one. */
+    id?: string;
+    /** `$`-prefixed for an i18n key. */
+    label: string;
+    /** Raw value: an ISO date for `date`, a number for `money`. */
+    value?: string | number | null;
+    type?: KeyValueType;
+    /** Route, `#anchor` or URL the value links to. */
+    to?: string;
+    /** Text colour, or the pill tone of a `status` value. */
+    tone?: Tone;
+    /** Dim note after the value. */
+    detail?: string;
+    /** ISO 4217 code of a `money` value; overrides the list's `currency`. */
+    currency?: string;
+}
+/** The options `KeyValueList` takes. */
+export interface KeyValueListProps extends BaseComponentProps, BlockItemsSource {
+    items?: KeyValueListItem[];
+    /** Tighter rows, for side panels. */
+    dense?: boolean;
+    /** Columns on wide screens (1–3). */
+    columns?: number;
+    /** Default ISO 4217 code of `money` values. */
+    currency?: string;
+    /** Eyebrow title of the card head. */
+    title?: string;
+    /** Card surface around the list; turn it off inside a `Card` block. */
+    card?: boolean;
+}
+/**
+ * KeyValueList — label / value rows (an account summary, a record's facts, a
+ * recap), each value drawn by its type.
+ *
+ * `options` is optional because a page is written as it is built: the editor
+ * places a block before anything is configured, and writes that as the bare
+ * call `KeyValueList()`.
+ *
+ * @example
+ * ```typescript
+ * KeyValueList({
+ *   title: "Subscription",
+ *   items: [
+ *     { label: "Plan", value: "Business" },
+ *     { label: "Status", value: "Past due", type: "status", tone: "error" },
+ *     { label: "Next invoice", value: 588, type: "money" },
+ *   ],
+ * })
+ * ```
+ */
+export declare function KeyValueList(options?: KeyValueListProps): ComponentBuilder<KeyValueListProps>;
+/** The options `KeyValueList` accepts. */
+export declare const KeyValueListSchema: z.ZodObject<{
+    fetchUrl: z.ZodOptional<z.ZodString>;
+    fetchUrlMethod: z.ZodOptional<z.ZodNativeEnum<typeof import("./types").HttpMethod>>;
+    empty: z.ZodOptional<z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        description?: string | undefined;
+    }, {
+        title: string;
+        description?: string | undefined;
+    }>>;
+    skeletonCount: z.ZodOptional<z.ZodNumber>;
+    title: z.ZodOptional<z.ZodString>;
+    items: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        label: z.ZodString;
+        value: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>;
+        type: z.ZodOptional<z.ZodEnum<["text", "status", "money", "date", "link", "mono"]>>;
+        to: z.ZodOptional<z.ZodString>;
+        tone: z.ZodOptional<z.ZodEnum<["primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral", ...("primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral")[]]>>;
+        detail: z.ZodOptional<z.ZodString>;
+        currency: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        type?: "link" | "date" | "status" | "text" | "mono" | "money" | undefined;
+        value?: string | number | null | undefined;
+        id?: string | undefined;
+        to?: string | undefined;
+        detail?: string | undefined;
+        tone?: "primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral" | undefined;
+        currency?: string | undefined;
+    }, {
+        label: string;
+        type?: "link" | "date" | "status" | "text" | "mono" | "money" | undefined;
+        value?: string | number | null | undefined;
+        id?: string | undefined;
+        to?: string | undefined;
+        detail?: string | undefined;
+        tone?: "primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral" | undefined;
+        currency?: string | undefined;
+    }>, "many">>;
+    card: z.ZodDefault<z.ZodBoolean>;
+    dense: z.ZodOptional<z.ZodBoolean>;
+    columns: z.ZodDefault<z.ZodNumber>;
+    currency: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    card: boolean;
+    columns: number;
+    items?: {
+        label: string;
+        type?: "link" | "date" | "status" | "text" | "mono" | "money" | undefined;
+        value?: string | number | null | undefined;
+        id?: string | undefined;
+        to?: string | undefined;
+        detail?: string | undefined;
+        tone?: "primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral" | undefined;
+        currency?: string | undefined;
+    }[] | undefined;
+    title?: string | undefined;
+    fetchUrl?: string | undefined;
+    fetchUrlMethod?: import("./types").HttpMethod | undefined;
+    currency?: string | undefined;
+    empty?: {
+        title: string;
+        description?: string | undefined;
+    } | undefined;
+    skeletonCount?: number | undefined;
+    dense?: boolean | undefined;
+}, {
+    items?: {
+        label: string;
+        type?: "link" | "date" | "status" | "text" | "mono" | "money" | undefined;
+        value?: string | number | null | undefined;
+        id?: string | undefined;
+        to?: string | undefined;
+        detail?: string | undefined;
+        tone?: "primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral" | undefined;
+        currency?: string | undefined;
+    }[] | undefined;
+    title?: string | undefined;
+    fetchUrl?: string | undefined;
+    fetchUrlMethod?: import("./types").HttpMethod | undefined;
+    card?: boolean | undefined;
+    columns?: number | undefined;
+    currency?: string | undefined;
+    empty?: {
+        title: string;
+        description?: string | undefined;
+    } | undefined;
+    skeletonCount?: number | undefined;
+    dense?: boolean | undefined;
+}>;

package/dist/base/key-value-list.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyValueListSchema = exports.KEY_VALUE_TYPES = void 0;
+exports.KeyValueList = KeyValueList;
+const component_1 = require("../component");
+const zod_1 = require("zod");
+const block_registry_1 = require("./block-registry");
+const display_1 = require("./display");
+const display_2 = require("./internal/display");
+const tone_1 = require("./types/tone");
+/**
+ * How a value is drawn: `text` plain, `status` a tinted pill, `money` a
+ * currency amount, `date` a localized date, `link` an accent link, `mono` an
+ * identifier or a figure in the mono font.
+ */
+exports.KEY_VALUE_TYPES = [
+    "text",
+    "status",
+    "money",
+    "date",
+    "link",
+    "mono",
+];
+const KEY_VALUE_LIST_COMPONENT_NAME = "dms-key-value-list-block";
+const KEY_VALUE_LIST_ICON = "i-ph-list-dashes";
+const KEY_VALUE_LIST_DEFAULTS = { card: true, columns: 1 };
+/**
+ * KeyValueList — label / value rows (an account summary, a record's facts, a
+ * recap), each value drawn by its type.
+ *
+ * `options` is optional because a page is written as it is built: the editor
+ * places a block before anything is configured, and writes that as the bare
+ * call `KeyValueList()`.
+ *
+ * @example
+ * ```typescript
+ * KeyValueList({
+ *   title: "Subscription",
+ *   items: [
+ *     { label: "Plan", value: "Business" },
+ *     { label: "Status", value: "Past due", type: "status", tone: "error" },
+ *     { label: "Next invoice", value: 588, type: "money" },
+ *   ],
+ * })
+ * ```
+ */
+function KeyValueList(options) {
+    return new component_1.ComponentBuilder(KEY_VALUE_LIST_COMPONENT_NAME)
+        .options({ ...KEY_VALUE_LIST_DEFAULTS, ...options })
+        .meta({
+        name: options?.title || "Key / value list",
+        icon: KEY_VALUE_LIST_ICON,
+    });
+}
+const KeyValueListItemSchema = zod_1.z.object({
+    id: (0, block_registry_1.ui)(zod_1.z.string().optional(), { label: "Key", advanced: true }),
+    label: (0, block_registry_1.ui)(zod_1.z.string(), { label: "Label" }),
+    value: (0, block_registry_1.ui)(zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).nullable().optional(), {
+        label: "Value",
+    }),
+    type: (0, block_registry_1.ui)(zod_1.z.enum(exports.KEY_VALUE_TYPES).optional(), {
+        label: "Type",
+        widget: "select",
+    }),
+    to: (0, block_registry_1.ui)(zod_1.z.string().optional(), { label: "Link", widget: "url" }),
+    tone: (0, block_registry_1.ui)((0, display_2.toneEnum)(tone_1.TONES).optional(), {
+        label: "Tone",
+        widget: "select",
+    }),
+    detail: (0, block_registry_1.ui)(zod_1.z.string().optional(), { label: "Detail" }),
+    currency: (0, block_registry_1.ui)(zod_1.z.string().optional(), { label: "Currency", advanced: true }),
+});
+/** The options `KeyValueList` accepts. */
+exports.KeyValueListSchema = zod_1.z.object({
+    title: (0, block_registry_1.ui)(zod_1.z.string().optional().describe("Eyebrow title of the card."), {
+        label: "Title",
+        group: "content",
+    }),
+    items: (0, block_registry_1.ui)(zod_1.z.array(KeyValueListItemSchema).optional().describe("The rows, in order."), { label: "Rows", group: "content" }),
+    card: (0, display_1.blockCardOption)(KEY_VALUE_LIST_DEFAULTS.card),
+    dense: (0, block_registry_1.ui)(zod_1.z.boolean().optional().describe("Tighter rows."), {
+        label: "Dense",
+        group: "appearance",
+        widget: "switch",
+    }),
+    columns: (0, block_registry_1.ui)(zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .max(3)
+        .default(KEY_VALUE_LIST_DEFAULTS.columns)
+        .describe("Columns on wide screens."), { label: "Columns", group: "layout", widget: "number", min: 1, max: 3 }),
+    currency: (0, block_registry_1.ui)(zod_1.z.string().optional().describe("Default ISO code of money values."), { label: "Currency", group: "appearance" }),
+    ...(0, display_1.blockItemsSourceOptions)(),
+});
+(0, block_registry_1.RegisterBlockType)({
+    type: "KeyValueList",
+    componentName: KEY_VALUE_LIST_COMPONENT_NAME,
+    schema: exports.KeyValueListSchema,
+    meta: {
+        name: "Key / value list",
+        icon: KEY_VALUE_LIST_ICON,
+        description: "Label and value rows, each value drawn by its type.",
+        group: "content",
+    },
+});
+//# sourceMappingURL=key-value-list.js.map

package/dist/base/key-value-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-value-list.js","sourceRoot":"","sources":["../../src/base/key-value-list.ts"],"names":[],"mappings":";;;AAuFA,oCASC;AAhGD,4CAAgD;AAChD,6BAAwB;AACxB,qDAA+E;AAC/E,uCAImB;AACnB,gDAA8C;AAC9C,uCAAgD;AAGhD;;;;GAIG;AACU,QAAA,eAAe,GAAG;IAC7B,MAAM;IACN,QAAQ;IACR,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;CACE,CAAC;AAuCX,MAAM,6BAA6B,GAAG,0BAA0B,CAAC;AACjE,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAC/C,MAAM,uBAAuB,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAW,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,YAAY,CAC1B,OAA2B;IAE3B,OAAO,IAAI,4BAAgB,CAAoB,6BAA6B,CAAC;SAC1E,OAAO,CAAC,EAAE,GAAG,uBAAuB,EAAE,GAAG,OAAO,EAAE,CAAC;SACnD,IAAI,CAAC;QACJ,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,kBAAkB;QAC1C,IAAI,EAAE,mBAAmB;KAC1B,CAAC,CAAC;AACP,CAAC;AAED,MAAM,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC/D,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACzC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE;QACjE,KAAK,EAAE,OAAO;KACf,CAAC;IACF,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC3C,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC/D,IAAI,EAAE,IAAA,mBAAE,EAAC,IAAA,kBAAQ,EAAC,YAAK,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IACtD,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;CAC3E,CAA6C,CAAC;AAE/C,0CAA0C;AAC7B,QAAA,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE;QACtE,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,KAAK,EAAE,IAAA,mBAAE,EACP,OAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAC1E,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CACpC;IACD,IAAI,EAAE,IAAA,yBAAe,EAAC,uBAAuB,CAAC,IAAI,CAAC;IACnD,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;QAC1D,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,OAAO,EAAE,IAAA,mBAAE,EACT,OAAC;SACE,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,uBAAuB,CAAC,OAAO,CAAC;SACxC,QAAQ,CAAC,0BAA0B,CAAC,EACvC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CACxE;IACD,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC,EACnE,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,CAC3C;IACD,GAAG,IAAA,iCAAuB,GAAE;CAC7B,CAA8C,CAAC;AAEhD,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,cAAc;IACpB,aAAa,EAAE,6BAA6B;IAC5C,MAAM,EAAE,0BAAkB;IAC1B,IAAI,EAAE;QACJ,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,qDAAqD;QAClE,KAAK,EAAE,SAAS;KACjB;CACF,CAAC,CAAC"}

package/dist/base/kpi-card.d.ts

@@ -5,6 +5,7 @@ import type { BaseComponentProps, EnumOption } from "./types";
 import { HttpMethod } from "./types/http";
 export interface KpiCardProps extends BaseComponentProps {
     title: string;
+    /** "stat" = compact DMS look: mono uppercase label, bare icon. */
     variant?: "default" | "stat";
     description?: string;
     icon?: string;
@@ -23,7 +24,14 @@ export interface KpiCardProps extends BaseComponentProps {
     staticDelta?: number;
     staticSparkline?: number[];
 }
+/**
+ * `options` is optional because a page is written as it is built: the editor
+ * places a block before anything is configured, and writes that as the bare
+ * call `KpiCard()`. A page under construction has to compile — it is typechecked
+ * on every edit — so a block with nothing set yet has to be a legal call.
+ */
 export declare function KpiCard(options?: KpiCardProps): ComponentBuilder<KpiCardProps>;
+/** The options `KpiCard` accepts. */
 export declare const KpiCardSchema: z.ZodObject<{
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
@@ -46,11 +54,11 @@ export declare const KpiCardSchema: z.ZodObject<{
     title: string;
     description?: string | undefined;
     icon?: string | undefined;
+    variant?: "default" | "stat" | undefined;
     fetchUrl?: string | undefined;
     fetchUrlMethod?: HttpMethod | undefined;
-    variant?: "default" | "stat" | undefined;
     periodScope?: string | undefined;
-    valueFormat?: "number" | "currency" | "percent" | "compact" | undefined;
+    valueFormat?: "number" | "compact" | "percent" | "currency" | undefined;
     currencyCode?: string | undefined;
     showDelta?: boolean | undefined;
     showSparkline?: boolean | undefined;
@@ -64,11 +72,11 @@ export declare const KpiCardSchema: z.ZodObject<{
     title: string;
     description?: string | undefined;
     icon?: string | undefined;
+    variant?: "default" | "stat" | undefined;
     fetchUrl?: string | undefined;
     fetchUrlMethod?: HttpMethod | undefined;
-    variant?: "default" | "stat" | undefined;
     periodScope?: string | undefined;
-    valueFormat?: "number" | "currency" | "percent" | "compact" | undefined;
+    valueFormat?: "number" | "compact" | "percent" | "currency" | undefined;
     currencyCode?: string | undefined;
     showDelta?: boolean | undefined;
     showSparkline?: boolean | undefined;

package/dist/base/kpi-card.js

@@ -8,6 +8,12 @@ const block_registry_1 = require("./block-registry");
 const chart_1 = require("./chart");
 const http_1 = require("./types/http");
 const KPI_CARD_COMPONENT_NAME = "dms-kpi-card";
+/**
+ * `options` is optional because a page is written as it is built: the editor
+ * places a block before anything is configured, and writes that as the bare
+ * call `KpiCard()`. A page under construction has to compile — it is typechecked
+ * on every edit — so a block with nothing set yet has to be a legal call.
+ */
 function KpiCard(options) {
     return new component_1.ComponentBuilder(KPI_CARD_COMPONENT_NAME)
         .options({ ...options })
@@ -16,6 +22,7 @@ function KpiCard(options) {
         icon: options?.icon || "i-ph-trend-up",
     });
 }
+/** The options `KpiCard` accepts. */
 exports.KpiCardSchema = zod_1.z.object({
     title: (0, block_registry_1.ui)(zod_1.z.string().describe("Card heading."), {
         label: "Title",

package/dist/base/kpi-card.js.map

@@ -1 +1 @@
-{"version":3,"file":"kpi-card.js","sourceRoot":"","sources":["../../src/base/kpi-card.ts"],"names":[],"mappings":";;;AA+CA,0BASC;AAxDD,4CAAgD;AAChD,6BAAwB;AACxB,qDAK0B;AAC1B,mCAKiB;AAEjB,uCAA0C;AAwB1C,MAAM,uBAAuB,GAAG,cAAc,CAAC;AAQ/C,SAAgB,OAAO,CACrB,OAAsB;IAEtB,OAAO,IAAI,4BAAgB,CAAe,uBAAuB,CAAC;SAC/D,OAAO,CAAC,EAAE,GAAG,OAAO,EAAkB,CAAC;SACvC,IAAI,CAAC;QACJ,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,UAAU;QAClC,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,eAAe;KACvC,CAAC,CAAC;AACP,CAAC;AAGY,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;QAC9C,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC,EACjE,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,CAC/D;IACD,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAAE;QAC3E,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,OAAO,EAAE,IAAA,mBAAE,EACT,OAAC;SACE,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACzB,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC,EACnD,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,CAC/D;IACD,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC,EACtE;QACE,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,OAAO;QACtB,YAAY,EAAE,aAAa;KAC5B,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC;SACE,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC,EAC1D,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,CAC7C;IACD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,qBAAa,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChD,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EACd,OAAC;SACE,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,4CAA4C,CAAC,EACzD,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,CAC3C;IACD,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACpC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,aAAa,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACxC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAA4B,CAAC,QAAQ,EAAE,EAAE;QACvE,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,OAAO;KAChB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EACR,OAAC;SACE,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,4CAA4C,CAAC,EACzD,EAAE,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CACnE;IACD,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC,EACzE,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CAC/D;IACD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClD,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;KACf,CAAC;CACH,CAAyC,CAAC;AAE3C,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,SAAS;IACf,aAAa,EAAE,uBAAuB;IACtC,MAAM,EAAE,qBAAa;IACrB,IAAI,EAAE;QACJ,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,eAAe;KACvB;CACF,CAAC,CAAC"}
+{"version":3,"file":"kpi-card.js","sourceRoot":"","sources":["../../src/base/kpi-card.ts"],"names":[],"mappings":";;;AA+CA,0BASC;AAxDD,4CAAgD;AAChD,6BAAwB;AACxB,qDAK0B;AAC1B,mCAKiB;AAEjB,uCAA0C;AAwB1C,MAAM,uBAAuB,GAAG,cAAc,CAAC;AAE/C;;;;;GAKG;AACH,SAAgB,OAAO,CACrB,OAAsB;IAEtB,OAAO,IAAI,4BAAgB,CAAe,uBAAuB,CAAC;SAC/D,OAAO,CAAC,EAAE,GAAG,OAAO,EAAkB,CAAC;SACvC,IAAI,CAAC;QACJ,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,UAAU;QAClC,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,eAAe;KACvC,CAAC,CAAC;AACP,CAAC;AAED,qCAAqC;AACxB,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;QAC9C,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC,EACjE,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,CAC/D;IACD,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAAE;QAC3E,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,OAAO,EAAE,IAAA,mBAAE,EACT,OAAC;SACE,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACzB,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC,EACnD,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,CAC/D;IACD,QAAQ,EAAE,IAAA,mBAAE,EACV,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC,EACtE;QACE,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,OAAO;QACtB,YAAY,EAAE,aAAa;KAC5B,CACF;IACD,cAAc,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,UAAU,CAAC,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;QACtD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC;SACE,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC,EAC1D,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,CAC7C;IACD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,IAAI,CAAC,qBAAa,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChD,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,WAAW;KACpB,CAAC;IACF,YAAY,EAAE,IAAA,mBAAE,EACd,OAAC;SACE,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,4CAA4C,CAAC,EACzD,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,CAC3C;IACD,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACpC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,aAAa,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACxC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAA4B,CAAC,QAAQ,EAAE,EAAE;QACvE,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,OAAO;KAChB,CAAC;IACF,MAAM,EAAE,IAAA,mBAAE,EACR,OAAC;SACE,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,4CAA4C,CAAC,EACzD,EAAE,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CACnE;IACD,YAAY,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EACb,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC,EACzE,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CAC/D;IACD,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,eAAe,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClD,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;KACf,CAAC;CACH,CAAyC,CAAC;AAE3C,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,SAAS;IACf,aAAa,EAAE,uBAAuB;IACtC,MAAM,EAAE,qBAAa;IACrB,IAAI,EAAE;QACJ,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,eAAe;KACvB;CACF,CAAC,CAAC"}

package/dist/base/layouts.d.ts

@@ -1,9 +1,44 @@
 import type { ComponentInfo } from "../component";
+import type { CustomButton } from "./types/custom-button";
 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"`.
+     */
+    headerActions?: CustomButton[];
 }
 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/base/layouts.js

@@ -2,19 +2,53 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultLayout = DefaultLayout;
 exports.FormPageLayout = FormPageLayout;
+exports.SettingsLayout = SettingsLayout;
 exports.EmptyLayout = EmptyLayout;
-function DefaultLayout(options) {
-    return {
-        componentName: "dms-default-layout",
-        options: {
-            fullWidth: true,
-            ...options,
-        },
+const confirm_dialog_1 = require("./internal/confirm-dialog");
+const action_target_1 = require("./types/internal/action-target");
+// A button without an id is keyed by its place in the header.
+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",

package/dist/base/layouts.js.map

@@ -1 +1 @@
-{"version":3,"file":"layouts.js","sourceRoot":"","sources":["../../src/base/layouts.ts"],"names":[],"mappings":";;AAsBA,sCAQC;AAMD,wCAIC;AAED,kCAKC;AAzBD,SAAgB,aAAa,CAAC,OAA8B;IAC1D,OAAO;QACL,aAAa,EAAE,oBAAoB;QACnC,OAAO,EAAE;YACP,SAAS,EAAE,IAAI;YACf,GAAG,OAAO;SACX;KACF,CAAC;AACJ,CAAC;AAMD,SAAgB,cAAc,CAC5B,OAAiD;IAEjD,OAAO,aAAa,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;AACzD,CAAC;AAED,SAAgB,WAAW;IACzB,OAAO;QACL,aAAa,EAAE,kBAAkB;QACjC,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC"}
+{"version":3,"file":"layouts.js","sourceRoot":"","sources":["../../src/base/layouts.ts"],"names":[],"mappings":";;AAmEA,sCAKC;AAMD,wCAIC;AAQD,wCAIC;AAED,kCAKC;AApGD,8DAAmE;AACnE,kEAAuE;AAoCvE,8DAA8D;AAC9D,MAAM,uBAAuB,GAAG,SAAS,CAAC;AAE1C,SAAS,mBAAmB,CAC1B,MAAoB,EACpB,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"}