@nest-my-admin/core 0.3.2 → 0.5.0

package/dist/dashboard/dashboard.service.js

@@ -0,0 +1,80 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from '@nestjs/common';
+import { ADMIN_OPTIONS } from '../constants.js';
+import { AdminBadRequestError, AdminNotFoundError } from '../errors.js';
+import { resolveText } from '../i18n/localized-text.js';
+import { AdminPolicy } from '../policy/admin-policy.service.js';
+import { WidgetRegistry } from './widget-registry.js';
+const PERIODS = ['day', 'week', 'month', 'year', 'range'];
+const MAX_SPAN_MS = 366 * 24 * 60 * 60 * 1000;
+/** The dashboard (spec §5.8): the widgets a user may see, and each one's data for a period. */
+let DashboardService = class DashboardService {
+    widgets;
+    policy;
+    options;
+    constructor(widgets, policy, options) {
+        this.widgets = widgets;
+        this.policy = policy;
+        this.options = options;
+    }
+    visible(ctx) {
+        const perms = this.policy.permissionsOf(ctx);
+        return this.widgets.list().filter((widget) => perms.can(widget.code));
+    }
+    /** Whether the user has a dashboard at all (`meta.dashboard`). */
+    has(ctx) {
+        return this.visible(ctx).length > 0;
+    }
+    layout(ctx) {
+        const locale = ctx.locale ?? this.options.locale;
+        return { widgets: this.visible(ctx).map((widget) => ({ name: widget.name, type: widget.type, title: resolveText(widget.title, locale, this.options.locale), size: widget.size })) };
+    }
+    /** One widget's data: 404 for a widget the user may not see (or that does not exist), 400 for a bad period. */
+    async load(name, query, ctx) {
+        const widget = this.visible(ctx).find((candidate) => candidate.name === name);
+        if (!widget)
+            throw new AdminNotFoundError(`Unknown widget "${name}"`);
+        return widget.source.load(parsePeriod(query), ctx);
+    }
+};
+DashboardService = __decorate([
+    Injectable(),
+    __param(2, Inject(ADMIN_OPTIONS)),
+    __metadata("design:paramtypes", [WidgetRegistry,
+        AdminPolicy, Object])
+], DashboardService);
+export { DashboardService };
+/** The period from the query: a known kind, instants in order, at most 366 days (the comparison window too). */
+export function parsePeriod(query) {
+    const period = query.get('period') ?? '';
+    if (!PERIODS.includes(period))
+        throw new AdminBadRequestError(`period must be one of ${PERIODS.join(', ')}`);
+    const instant = (key) => {
+        const raw = query.get(key);
+        const time = raw ? Date.parse(raw) : Number.NaN;
+        if (Number.isNaN(time))
+            throw new AdminBadRequestError(`${key} must be an ISO date and time`);
+        return { raw: new Date(time).toISOString(), time };
+    };
+    const from = instant('from');
+    const to = instant('to');
+    const previousFrom = instant('previousFrom');
+    const previousTo = instant('previousTo');
+    if (from.time >= to.time || previousFrom.time >= previousTo.time)
+        throw new AdminBadRequestError('a period starts before it ends');
+    if (to.time - from.time > MAX_SPAN_MS || previousTo.time - previousFrom.time > MAX_SPAN_MS)
+        throw new AdminBadRequestError('a period spans at most 366 days');
+    return { period: period, from: from.raw, to: to.raw, previousFrom: previousFrom.raw, previousTo: previousTo.raw };
+}
+//# sourceMappingURL=dashboard.service.js.map

package/dist/dashboard/dashboard.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboard.service.js","sourceRoot":"","sources":["../../src/dashboard/dashboard.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAyB,MAAM,sBAAsB,CAAC;AAE7E,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC1D,MAAM,WAAW,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE9C,+FAA+F;AAExF,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAER,OAAO;IACP,MAAM;IACiB,OAAO;IAHjD,YACmB,OAAuB,EACvB,MAAmB,EACI,OAA6B;uBAFpD,OAAO;sBACP,MAAM;uBACiB,OAAO;IAC9C,CAAC;IAEI,OAAO,CAAC,GAAiB;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,kEAAkE;IAClE,GAAG,CAAC,GAAiB;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,GAAiB;QACtB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACjD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;IACtL,CAAC;IAED,+GAA+G;IAC/G,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,KAAsB,EAAE,GAAiB;QAChE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC9E,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,kBAAkB,CAAC,mBAAmB,IAAI,GAAG,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IACrD,CAAC;CACF,CAAA;AA5BY,gBAAgB;IAD5B,UAAU,EAAE;IAKR,WAAA,MAAM,CAAC,aAAa,CAAC,CAAA;qCAFI,cAAc;QACf,WAAW;GAH3B,gBAAgB,CA4B5B;;AAED,gHAAgH;AAChH,MAAM,UAAU,WAAW,CAAC,KAAsB;IAChD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,oBAAoB,CAAC,yBAAyB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7G,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;QAChD,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,oBAAoB,CAAC,GAAG,GAAG,+BAA+B,CAAC,CAAC;QAC9F,OAAO,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC;IACrD,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACzC,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,IAAI,YAAY,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI;QAAE,MAAM,IAAI,oBAAoB,CAAC,gCAAgC,CAAC,CAAC;IACnI,IAAI,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,WAAW,IAAI,UAAU,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,GAAG,WAAW;QAAE,MAAM,IAAI,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;IAC9J,OAAO,EAAE,MAAM,EAAE,MAAgC,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,YAAY,EAAE,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC;AAC9I,CAAC"}

package/dist/dashboard/widget-registry.d.ts

@@ -0,0 +1,22 @@
+import { type OnModuleInit } from '@nestjs/common';
+import { DiscoveryService } from '@nestjs/core';
+import { type AdminWidgetDefinition, type AdminWidgetSource } from '../decorators/admin-widget.js';
+export interface RegisteredWidget extends AdminWidgetDefinition {
+    className: string;
+    source: AdminWidgetSource;
+    order: number;
+    size: 1 | 2 | 3 | 4;
+    /** The permission that shows it (`dashboard.<name>` unless the widget names one). */
+    code: string;
+}
+/** The dashboard's widgets (`@AdminWidget` providers), checked at module init and kept in order. */
+export declare class WidgetRegistry implements OnModuleInit {
+    private readonly discovery;
+    private widgets;
+    constructor(discovery: DiscoveryService);
+    onModuleInit(): void;
+    list(): RegisteredWidget[];
+    find(name: string): RegisteredWidget | undefined;
+    /** Every widget permission code (for role checks and the role editor's catalog). */
+    codes(): string[];
+}

package/dist/dashboard/widget-registry.js

@@ -0,0 +1,77 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Injectable } from '@nestjs/common';
+import { DiscoveryService } from '@nestjs/core';
+import { getAdminWidgetDefinition } from '../decorators/admin-widget.js';
+const TYPES = ['stat', 'chart', 'table', 'progress', 'list'];
+/** The dashboard's widgets (`@AdminWidget` providers), checked at module init and kept in order. */
+let WidgetRegistry = class WidgetRegistry {
+    discovery;
+    widgets = [];
+    constructor(discovery) {
+        this.discovery = discovery;
+    }
+    onModuleInit() {
+        const seen = new Set();
+        const out = [];
+        for (const wrapper of this.discovery.getProviders()) {
+            const metatype = wrapper.metatype;
+            if (typeof metatype !== 'function')
+                continue;
+            const definition = getAdminWidgetDefinition(metatype);
+            if (!definition)
+                continue;
+            const instance = wrapper.instance;
+            const fail = (message) => {
+                throw new Error(`${metatype.name}: @AdminWidget("${definition.name}"): ${message}`);
+            };
+            if (!wrapper.isDependencyTreeStatic() || !instance)
+                fail('widgets must be singleton-scoped providers');
+            if (seen.has(instance))
+                continue;
+            seen.add(instance);
+            if (typeof definition.name !== 'string' || !/^[a-z0-9][a-z0-9_-]*$/i.test(definition.name))
+                fail('the name must be letters, digits, - and _');
+            if (out.some((widget) => widget.name === definition.name))
+                fail('the name is used twice');
+            if (!TYPES.includes(definition.type))
+                fail(`unknown type "${String(definition.type)}" (use ${TYPES.join(', ')})`);
+            const size = definition.size ?? 1;
+            if (![1, 2, 3, 4].includes(size))
+                fail('size is 1, 2, 3 or 4 columns');
+            const order = definition.order ?? 100;
+            if (!Number.isFinite(order))
+                fail('order must be a finite number');
+            if (typeof instance.load !== 'function')
+                fail('a widget needs load(params, ctx)');
+            const code = definition.permission ?? `dashboard.${definition.name}`;
+            if (!/^[a-z0-9][a-z0-9_.-]*$/i.test(code) || code.includes('*'))
+                fail(`permission "${code}" must be a permission code`);
+            out.push({ ...definition, className: metatype.name, source: instance, order, size, code });
+        }
+        this.widgets = out.sort((a, b) => a.order - b.order || a.name.localeCompare(b.name));
+    }
+    list() {
+        return this.widgets;
+    }
+    find(name) {
+        return this.widgets.find((widget) => widget.name === name);
+    }
+    /** Every widget permission code (for role checks and the role editor's catalog). */
+    codes() {
+        return [...new Set(this.widgets.map((widget) => widget.code))];
+    }
+};
+WidgetRegistry = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [DiscoveryService])
+], WidgetRegistry);
+export { WidgetRegistry };
+//# sourceMappingURL=widget-registry.js.map

package/dist/dashboard/widget-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget-registry.js","sourceRoot":"","sources":["../../src/dashboard/widget-registry.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAqB,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAsD,MAAM,+BAA+B,CAAC;AAE7H,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAW7D,oGAAoG;AAE7F,IAAM,cAAc,GAApB,MAAM,cAAc;IAGI,SAAS;IAF9B,OAAO,GAAuB,EAAE,CAAC;IAEzC,YAA6B,SAA2B;yBAA3B,SAAS;IAAqB,CAAC;IAE5D,YAAY;QACV,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,MAAM,GAAG,GAAuB,EAAE,CAAC;QACnC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,IAAI,OAAO,QAAQ,KAAK,UAAU;gBAAE,SAAS;YAC7C,MAAM,UAAU,GAAG,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YACtD,IAAI,CAAC,UAAU;gBAAE,SAAS;YAC1B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAkD,CAAC;YAC5E,MAAM,IAAI,GAAG,CAAC,OAAe,EAAS,EAAE;gBACtC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,IAAI,mBAAmB,UAAU,CAAC,IAAI,OAAO,OAAO,EAAE,CAAC,CAAC;YACtF,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,4CAA4C,CAAC,CAAC;YACvG,IAAI,IAAI,CAAC,GAAG,CAAC,QAAS,CAAC;gBAAE,SAAS;YAClC,IAAI,CAAC,GAAG,CAAC,QAAS,CAAC,CAAC;YACpB,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,IAAI,CAAC,2CAA2C,CAAC,CAAC;YAC9I,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC;gBAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC1F,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,IAAI,CAAC,iBAAiB,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClH,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC;YAClC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAAE,IAAI,CAAC,8BAA8B,CAAC,CAAC;YACvE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,IAAI,GAAG,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;YACnE,IAAI,OAAO,QAAS,CAAC,IAAI,KAAK,UAAU;gBAAE,IAAI,CAAC,kCAAkC,CAAC,CAAC;YACnF,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,IAAI,aAAa,UAAU,CAAC,IAAI,EAAE,CAAC;YACrE,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,IAAI,CAAC,eAAe,IAAI,6BAA6B,CAAC,CAAC;YACxH,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAA6B,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAClH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,oFAAoF;IACpF,KAAK;QACH,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjE,CAAC;CACF,CAAA;AA/CY,cAAc;IAD1B,UAAU,EAAE;qCAI6B,gBAAgB;GAH7C,cAAc,CA+C1B"}

package/dist/decorators/admin-action.d.ts

@@ -4,8 +4,18 @@ import { type LocalizedText } from '../i18n/localized-text.js';
 import { type DtoForm } from '../schema/dto-form.js';
 import type { DtoClass } from '../schema/dto-fields.js';
 export interface AdminActionOptions {
-    /** `'Mark shipped'` or `{ en: 'Mark shipped', fa: 'ارسال شد' }`. Defaults to the humanized method name. */
-    label?: LocalizedText;
+    /**
+     * `'Mark shipped'` or `{ en: 'Mark shipped', fa: 'ارسال شد' }`. Defaults to the humanized method name. A label per
+     * record: `{ static, for }`, where `for(record)` names the action for that record («انتقال به آماده ارسال») or
+     * returns `null` to hide it there (a run is then refused too); `static` names it where no record is at hand (bulk
+     * menus, the role editor, the audit log).
+     */
+    label?: LocalizedText | {
+        static: LocalizedText;
+        for: (record: any) => LocalizedText | null;
+    };
+    /** The record's next step: a filled button, last in the record's header. One per resource, record actions without `input`. */
+    primary?: boolean;
     /**
      * `record` (default): the method is `(record, input, ctx)` and runs on a record the user may view and update
      * (the detail page; a list selection too with `bulk`). `resource`: the method is `(input, ctx)` and runs once,
@@ -43,6 +53,9 @@ export interface ActionDefinition extends AdminActionOptions {
 export interface RegisteredAction {
     name: string;
     label: LocalizedText;
+    /** The per-record label (`label.for`): `null` hides the action on that record. */
+    labelFor?: (record: any) => LocalizedText | null;
+    primary: boolean;
     target: 'record' | 'resource';
     bulk: boolean;
     atomic: boolean;

package/dist/decorators/admin-action.js

@@ -60,8 +60,21 @@ export function resolveActions(resourceClass, reserved, fail) {
         const { confirm, input, icon, label } = definition;
         if (confirm !== undefined && typeof confirm !== 'boolean' && !isText(confirm))
             fail(`${where}: confirm must be true, false or a text`);
-        if (label !== undefined && !isText(label))
+        const perRecord = typeof label === 'object' && label !== null && 'for' in label;
+        if (perRecord) {
+            const { static: fixed, for: labelFor } = label;
+            if (typeof labelFor !== 'function')
+                fail(`${where}: label.for must be a function (record) => text | null`);
+            if (fixed === undefined || !isText(fixed))
+                fail(`${where}: a per-record label needs \`static\`, the label where no record is at hand (bulk menus, roles, the audit log)`);
+        }
+        else if (label !== undefined && !isText(label))
             fail(`${where}: label must be a text`);
+        const primary = definition.primary === true;
+        if (primary && target !== 'record')
+            fail(`${where}: \`primary\` is a record's next step; resource actions cannot be primary`);
+        if (primary && input !== undefined)
+            fail(`${where}: a primary action runs in one click, so it takes no \`input\``);
         if (icon !== undefined && typeof icon !== 'string')
             fail(`${where}: icon must be an icon name`);
         let form;
@@ -77,7 +90,9 @@ export function resolveActions(resourceClass, reserved, fail) {
         }
         actions.set(name, {
             name,
-            label: label ?? humanize(name),
+            label: perRecord ? label.static : (label ?? humanize(name)),
+            ...(perRecord ? { labelFor: label.for } : {}),
+            primary,
             target,
             bulk,
             atomic,
@@ -87,6 +102,9 @@ export function resolveActions(resourceClass, reserved, fail) {
             ...(input ? { input, form } : {}),
         });
     }
+    const primaries = [...actions.values()].filter((action) => action.primary);
+    if (primaries.length > 1)
+        fail(`@AdminAction: only one action can be \`primary\` (${primaries.map((action) => action.name).join(', ')})`);
     // A rule under a name nothing checks would silently never apply.
     for (const rule of getCanRuleNames(resourceClass)) {
         if (rule === 'update' || rule === 'delete')
@@ -115,6 +133,7 @@ export function toActionSchema(action, locale, defaultLocale) {
         atomic: action.atomic,
         ...(confirm !== undefined ? { confirm: confirm === true ? true : resolveText(confirm, locale, defaultLocale) } : {}),
         variant: action.variant,
+        ...(action.primary ? { primary: true } : {}),
         ...(action.icon ? { icon: action.icon } : {}),
         ...(action.form ? { input: localizeDtoForm(action.form, locale, defaultLocale) } : {}),
     };

package/dist/decorators/admin-action.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-action.js","sourceRoot":"","sources":["../../src/decorators/admin-action.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAsB,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAgB,MAAM,uBAAuB,CAAC;AAEpF,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAuDnD;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,OAAO,GAAuB,EAAE;IAC1D,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC7B,IAAI,OAAO,WAAW,KAAK,QAAQ;YAAE,MAAM,IAAI,SAAS,CAAC,wDAAwD,CAAC,CAAC;QACnH,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,MAAM,SAAS,GAAI,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAkD,IAAI,EAAE,CAAC;QAC7H,0DAA0D;QAC1D,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IAC5H,CAAC,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,UAAU,CAAC,aAAuB;IAChD,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAE,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,aAAa,CAAkD,IAAI,EAAE,CAAC,CAAC,CAAC;AACrJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC9E,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,aAAuB,EAAE,QAA2B,EAAE,IAAgC;IACnH,MAAM,OAAO,GAAG,IAAI,GAAG,EAA4B,CAAC;IACpD,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC5D,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;QAC5B,MAAM,KAAK,GAAG,iBAAiB,IAAI,GAAG,CAAC;QACvC,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,+BAA+B,IAAI,gCAAgC,CAAC,CAAC;QACjH,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,gCAAgC,IAAI,kCAAkC,CAAC,CAAC;QAClH,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,GAAG,KAAK,mFAAmF,CAAC,CAAC;QACjL,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,IAAI,QAAQ,CAAC;QAC7C,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,UAAU;YAAE,IAAI,CAAC,GAAG,KAAK,yCAAyC,CAAC,CAAC;QAC1G,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,SAAS,CAAC;QAChD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,aAAa;YAAE,IAAI,CAAC,GAAG,KAAK,8CAA8C,CAAC,CAAC;QACrH,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC;QAC1C,IAAI,MAAM,KAAK,UAAU,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,kDAAkD,CAAC,CAAC;QAChH,IAAI,MAAM,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,GAAG,KAAK,mCAAmC,CAAC,CAAC;QACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;QACnD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,yCAAyC,CAAC,CAAC;QACvI,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,wBAAwB,CAAC,CAAC;QAClF,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAC;QAChG,IAAI,IAAyB,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,OAAO,KAAK,KAAK,UAAU;gBAAE,IAAI,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAC;YAC7E,IAAI,GAAG,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,WAAW,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC;YACtG,gFAAgF;YAChF,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3C,IAAI,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;oBAAE,IAAI,CAAC,GAAG,KAAK,kBAAkB,KAAK,eAAe,OAAO,CAAC,MAAM,wDAAwD,CAAC,CAAC;YAChL,CAAC;QACH,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;YAChB,IAAI;YACJ,KAAK,EAAE,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC;YAC9B,MAAM;YACN,IAAI;YACJ,MAAM;YACN,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAClE,OAAO;YACP,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IACD,iEAAiE;IACjE,KAAK,MAAM,IAAI,IAAI,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC;QAClD,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ;YAAE,SAAS;QACrD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,cAAc,IAAI,4BAA4B,UAAU,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7H,IAAI,MAAO,CAAC,MAAM,KAAK,UAAU;YAAE,IAAI,CAAC,cAAc,IAAI,QAAQ,IAAI,yCAAyC,CAAC,CAAC;IACnH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC3C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AAChJ,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,cAAc,CAAC,MAAwB,EAAE,MAAc,EAAE,aAAqB;IAC5F,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC;QACvD,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpH,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"admin-action.js","sourceRoot":"","sources":["../../src/decorators/admin-action.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAsB,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAgB,MAAM,uBAAuB,CAAC;AAEpF,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAiEnD;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,OAAO,GAAuB,EAAE;IAC1D,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC7B,IAAI,OAAO,WAAW,KAAK,QAAQ;YAAE,MAAM,IAAI,SAAS,CAAC,wDAAwD,CAAC,CAAC;QACnH,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,MAAM,SAAS,GAAI,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAkD,IAAI,EAAE,CAAC;QAC7H,0DAA0D;QAC1D,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IAC5H,CAAC,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,UAAU,CAAC,aAAuB;IAChD,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAE,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,aAAa,CAAkD,IAAI,EAAE,CAAC,CAAC,CAAC;AACrJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC9E,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,aAAuB,EAAE,QAA2B,EAAE,IAAgC;IACnH,MAAM,OAAO,GAAG,IAAI,GAAG,EAA4B,CAAC;IACpD,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC5D,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;QAC5B,MAAM,KAAK,GAAG,iBAAiB,IAAI,GAAG,CAAC;QACvC,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,+BAA+B,IAAI,gCAAgC,CAAC,CAAC;QACjH,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,gCAAgC,IAAI,kCAAkC,CAAC,CAAC;QAClH,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,GAAG,KAAK,mFAAmF,CAAC,CAAC;QACjL,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,IAAI,QAAQ,CAAC;QAC7C,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,UAAU;YAAE,IAAI,CAAC,GAAG,KAAK,yCAAyC,CAAC,CAAC;QAC1G,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,SAAS,CAAC;QAChD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,aAAa;YAAE,IAAI,CAAC,GAAG,KAAK,8CAA8C,CAAC,CAAC;QACrH,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC;QAC1C,IAAI,MAAM,KAAK,UAAU,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,kDAAkD,CAAC,CAAC;QAChH,IAAI,MAAM,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,GAAG,KAAK,mCAAmC,CAAC,CAAC;QACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;QACnD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,yCAAyC,CAAC,CAAC;QACvI,MAAM,SAAS,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,IAAI,KAAK,CAAC;QAChF,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAiD,CAAC;YAC3F,IAAI,OAAO,QAAQ,KAAK,UAAU;gBAAE,IAAI,CAAC,GAAG,KAAK,wDAAwD,CAAC,CAAC;YAC3G,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAAE,IAAI,CAAC,GAAG,KAAK,gHAAgH,CAAC,CAAC;QAC5K,CAAC;aAAM,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,wBAAwB,CAAC,CAAC;QACzF,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC;QAC5C,IAAI,OAAO,IAAI,MAAM,KAAK,QAAQ;YAAE,IAAI,CAAC,GAAG,KAAK,2EAA2E,CAAC,CAAC;QAC9H,IAAI,OAAO,IAAI,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,GAAG,KAAK,gEAAgE,CAAC,CAAC;QACnH,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAC;QAChG,IAAI,IAAyB,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,OAAO,KAAK,KAAK,UAAU;gBAAE,IAAI,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAC;YAC7E,IAAI,GAAG,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,WAAW,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC;YACtG,gFAAgF;YAChF,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3C,IAAI,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;oBAAE,IAAI,CAAC,GAAG,KAAK,kBAAkB,KAAK,eAAe,OAAO,CAAC,MAAM,wDAAwD,CAAC,CAAC;YAChL,CAAC;QACH,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;YAChB,IAAI;YACJ,KAAK,EAAE,SAAS,CAAC,CAAC,CAAE,KAAmC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,KAAmC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzH,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAG,KAA4D,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrG,OAAO;YACP,MAAM;YACN,IAAI;YACJ,MAAM;YACN,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAClE,OAAO;YACP,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,SAAS,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;QAAE,IAAI,CAAC,qDAAqD,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1I,iEAAiE;IACjE,KAAK,MAAM,IAAI,IAAI,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC;QAClD,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ;YAAE,SAAS;QACrD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,cAAc,IAAI,4BAA4B,UAAU,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7H,IAAI,MAAO,CAAC,MAAM,KAAK,UAAU;YAAE,IAAI,CAAC,cAAc,IAAI,QAAQ,IAAI,yCAAyC,CAAC,CAAC;IACnH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC3C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AAChJ,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,cAAc,CAAC,MAAwB,EAAE,MAAc,EAAE,aAAqB;IAC5F,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3B,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC;QACvD,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpH,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvF,CAAC;AACJ,CAAC"}

package/dist/decorators/admin-field.d.ts

@@ -1,7 +1,8 @@
 import 'reflect-metadata';
 import type { LocalizedText } from '../i18n/localized-text.js';
+import type { AdminCurrency } from '../schema/currency.js';
 /** Inputs and displays the UI has (spec §5.6). */
-export declare const WIDGETS: readonly ['text', 'textarea', 'number', 'money', 'switch', 'checkbox', 'select', 'radio', 'date', 'datetime', 'json', 'color', 'badge', 'slug', 'password', 'email', 'url', 'file', 'image', 'richtext'];
+export declare const WIDGETS: readonly ['text', 'textarea', 'number', 'money', 'switch', 'checkbox', 'select', 'radio', 'date', 'datetime', 'json', 'color', 'badge', 'slug', 'password', 'email', 'url', 'file', 'image', 'richtext', 'stepper'];
 export type WidgetName = (typeof WIDGETS)[number];
 /** Colours a badge value can take; the UI maps them to its palette in light and dark themes. */
 export declare const BADGE_COLORS: readonly ['gray', 'red', 'amber', 'green', 'blue', 'purple', 'pink'];
@@ -31,10 +32,29 @@ export interface AdminFieldOptions {
     showIf?: Record<string, ShowIfValue | ShowIfValue[]>;
     /** Shown on edit forms but never written by update. */
     readonly?: boolean;
+    /** `stepper`: the steps in order (default: the enum's order). */
+    steps?: string[];
+    /** `stepper`: values that are not steps (cancelled): shown as a badge, with no current step. */
+    exclude?: string[];
+    /**
+     * `stepper`: when each step was reached, from a child resource logging the changes (one row per change: `value` is
+     * the value reached, `at` when; `where` narrows to this field's rows when the log holds several fields).
+     */
+    history?: {
+        inline: abstract new (...args: any[]) => unknown;
+        value: string;
+        at: string;
+        where?: Record<string, string>;
+    };
+    /** A soft warning under the input while the field is empty (an image without alt text): it never stops a save. */
+    warnIf?: {
+        empty: true;
+        message: LocalizedText;
+    };
     /** The `slug` widget fills itself from this field until someone edits it. */
     slugFrom?: string;
-    /** Currency code shown with the `money` widget (display only). */
-    currency?: string;
+    /** The unit shown with the `money` widget (display only): a code such as `USD`, or a unit and its position. Wins over the global `currency`. */
+    currency?: string | AdminCurrency;
     /** `file` and `image` widgets: type, size and visibility limits; `richtext`: `maxBytes` and `visibility` of editor images. */
     file?: FileFieldOptions;
     /** `file` and `image` widgets on a json column: a list of files instead of one. */

package/dist/decorators/admin-field.js

@@ -3,7 +3,7 @@ import { ADMIN_FIELD_METADATA } from '../constants.js';
 /** Inputs and displays the UI has (spec §5.6). */
 export const WIDGETS = [
     'text', 'textarea', 'number', 'money', 'switch', 'checkbox', 'select', 'radio', 'date', 'datetime', 'json', 'color',
-    'badge', 'slug', 'password', 'email', 'url', 'file', 'image', 'richtext',
+    'badge', 'slug', 'password', 'email', 'url', 'file', 'image', 'richtext', 'stepper',
 ];
 /** Colours a badge value can take; the UI maps them to its palette in light and dark themes. */
 export const BADGE_COLORS = ['gray', 'red', 'amber', 'green', 'blue', 'purple', 'pink'];

package/dist/decorators/admin-field.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-field.js","sourceRoot":"","sources":["../../src/decorators/admin-field.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAGvD,kDAAkD;AAClD,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO;IACnH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU;CAChE,CAAC;AAGX,gGAAgG;AAChG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AAwDjG,gHAAgH;AAChH,MAAM,UAAU,UAAU,CAAC,OAA0B;IACnD,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,MAAM,SAAS,GAAI,OAAO,CAAC,WAAW,CAAC,oBAAoB,EAAE,KAAK,CAAmD,IAAI,EAAE,CAAC;QAC5H,OAAO,CAAC,cAAc,CAAC,oBAAoB,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IAC5I,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAA4B;IAC/D,OAAO,CAAC,MAAM,IAAK,OAAO,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAmD,CAAC,IAAI,EAAE,CAAC;AAChI,CAAC"}
+{"version":3,"file":"admin-field.js","sourceRoot":"","sources":["../../src/decorators/admin-field.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAIvD,kDAAkD;AAClD,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO;IACnH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS;CAC3E,CAAC;AAGX,gGAAgG;AAChG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AAmEjG,gHAAgH;AAChH,MAAM,UAAU,UAAU,CAAC,OAA0B;IACnD,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,MAAM,SAAS,GAAI,OAAO,CAAC,WAAW,CAAC,oBAAoB,EAAE,KAAK,CAAmD,IAAI,EAAE,CAAC;QAC5H,OAAO,CAAC,cAAc,CAAC,oBAAoB,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IAC5I,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAA4B;IAC/D,OAAO,CAAC,MAAM,IAAK,OAAO,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAmD,CAAC,IAAI,EAAE,CAAC;AAChI,CAAC"}

package/dist/decorators/admin-print.d.ts

@@ -0,0 +1,35 @@
+import 'reflect-metadata';
+import type { PrintSchema } from '../contract.js';
+import { type LocalizedText } from '../i18n/localized-text.js';
+/** Paper sizes by name; any other string is used as the CSS `@page { size }` value. */
+export declare const PAPERS: Record<string, string>;
+export interface AdminPrintOptions {
+    /** `'Invoice'` or `{ en: 'Invoice', fa: 'فاکتور' }`. Defaults to the humanized method name. */
+    label?: LocalizedText;
+    icon?: string;
+    /** `A4` (default), `A5`, `label` (100×150 mm) or a CSS `@page` size such as `'80mm 200mm'`. */
+    paper?: string;
+    /** Also offered on a list selection: one page per record, up to 100. */
+    bulk?: boolean;
+}
+/** A print template checked at boot. */
+export interface RegisteredPrint {
+    name: string;
+    label: LocalizedText;
+    icon?: string;
+    /** The CSS `@page` size. */
+    size: string;
+    bulk: boolean;
+}
+/**
+ * A print template of a resource (an invoice, a shipping label): the method `(records, ctx)` returns the body HTML of
+ * the printed page, one or more records (`bulk`). Build it with the `html` tag, which escapes every value. The admin
+ * wraps it in a page sized for `paper` that prints itself. Printing needs `{resource}.view`, the user's row scopes and
+ * `{resource}.print.{name}`; each printed record is written to the audit log. Throw an `HttpException` to refuse.
+ */
+export declare function AdminPrint(options?: AdminPrintOptions): MethodDecorator;
+/** Boot checks of a resource class's print templates; `taken` are names already in use (base methods, actions). */
+export declare function resolvePrints(resourceClass: Function, taken: readonly string[], fail: (message: string) => never): Map<string, RegisteredPrint>;
+/** The permission code of a print template. */
+export declare const printCode: (resource: string, name: string) => string;
+export declare function toPrintSchema(print: RegisteredPrint, locale: string, defaultLocale: string): PrintSchema;

package/dist/decorators/admin-print.js

@@ -0,0 +1,53 @@
+import 'reflect-metadata';
+import { ADMIN_PRINTS_METADATA } from '../constants.js';
+import { resolveText } from '../i18n/localized-text.js';
+import { humanize } from '../schema/humanize.js';
+/** Paper sizes by name; any other string is used as the CSS `@page { size }` value. */
+export const PAPERS = { A4: 'A4', A5: 'A5', label: '100mm 150mm' };
+/**
+ * A print template of a resource (an invoice, a shipping label): the method `(records, ctx)` returns the body HTML of
+ * the printed page, one or more records (`bulk`). Build it with the `html` tag, which escapes every value. The admin
+ * wraps it in a page sized for `paper` that prints itself. Printing needs `{resource}.view`, the user's row scopes and
+ * `{resource}.print.{name}`; each printed record is written to the audit log. Throw an `HttpException` to refuse.
+ */
+export function AdminPrint(options = {}) {
+    return (target, propertyKey) => {
+        if (typeof propertyKey !== 'string')
+            throw new TypeError('@AdminPrint must decorate a method with a string name');
+        const owner = target.constructor;
+        const inherited = Reflect.getMetadata(ADMIN_PRINTS_METADATA, owner) ?? {};
+        Reflect.defineMetadata(ADMIN_PRINTS_METADATA, { ...inherited, [propertyKey]: { ...options, name: propertyKey } }, owner);
+    };
+}
+/** Boot checks of a resource class's print templates; `taken` are names already in use (base methods, actions). */
+export function resolvePrints(resourceClass, taken, fail) {
+    const prints = new Map();
+    const declared = Reflect.getMetadata(ADMIN_PRINTS_METADATA, resourceClass) ?? {};
+    for (const definition of Object.values(declared)) {
+        const { name } = definition;
+        const where = `@AdminPrint "${name}"`;
+        if (taken.includes(name))
+            fail(`${where}: the name is taken (a base method or an action); give the method another name`);
+        if (!/^[a-z][a-z0-9_]*$/i.test(name))
+            fail(`${where}: the method name must be a word (letters, digits, _)`);
+        const paper = definition.paper ?? 'A4';
+        if (typeof paper !== 'string' || !/^[a-z0-9 .]+$/i.test(paper))
+            fail(`${where}: paper must be A4, A5, label or a CSS page size`);
+        if (definition.icon !== undefined && typeof definition.icon !== 'string')
+            fail(`${where}: icon must be an icon name`);
+        prints.set(name, {
+            name,
+            label: definition.label ?? humanize(name),
+            ...(definition.icon ? { icon: definition.icon } : {}),
+            size: PAPERS[paper] ?? paper,
+            bulk: definition.bulk === true,
+        });
+    }
+    return prints;
+}
+/** The permission code of a print template. */
+export const printCode = (resource, name) => `${resource}.print.${name}`;
+export function toPrintSchema(print, locale, defaultLocale) {
+    return { name: print.name, label: resolveText(print.label, locale, defaultLocale), bulk: print.bulk, ...(print.icon ? { icon: print.icon } : {}) };
+}
+//# sourceMappingURL=admin-print.js.map

package/dist/decorators/admin-print.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-print.js","sourceRoot":"","sources":["../../src/decorators/admin-print.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,WAAW,EAAsB,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,uFAAuF;AACvF,MAAM,CAAC,MAAM,MAAM,GAA2B,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;AAsB3F;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,OAAO,GAAsB,EAAE;IACxD,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC7B,IAAI,OAAO,WAAW,KAAK,QAAQ;YAAE,MAAM,IAAI,SAAS,CAAC,uDAAuD,CAAC,CAAC;QAClH,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,MAAM,SAAS,GAAI,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,KAAK,CAAsE,IAAI,EAAE,CAAC;QAChJ,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IAC3H,CAAC,CAAC;AACJ,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,aAAa,CAAC,aAAuB,EAAE,KAAwB,EAAE,IAAgC;IAC/G,MAAM,MAAM,GAAG,IAAI,GAAG,EAA2B,CAAC;IAClD,MAAM,QAAQ,GAAI,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,aAAa,CAAsE,IAAI,EAAE,CAAC;IACvJ,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;QAC5B,MAAM,KAAK,GAAG,gBAAgB,IAAI,GAAG,CAAC;QACtC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,gFAAgF,CAAC,CAAC;QACzH,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,uDAAuD,CAAC,CAAC;QAC5G,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC;QACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,IAAI,CAAC,GAAG,KAAK,kDAAkD,CAAC,CAAC;QACjI,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,GAAG,KAAK,6BAA6B,CAAC,CAAC;QACtH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE;YACf,IAAI;YACJ,KAAK,EAAE,UAAU,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC;YACzC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK;YAC5B,IAAI,EAAE,UAAU,CAAC,IAAI,KAAK,IAAI;SAC/B,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,+CAA+C;AAC/C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,IAAY,EAAU,EAAE,CAAC,GAAG,QAAQ,UAAU,IAAI,EAAE,CAAC;AAEjG,MAAM,UAAU,aAAa,CAAC,KAAsB,EAAE,MAAc,EAAE,aAAqB;IACzF,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AACrJ,CAAC"}

package/dist/decorators/admin-resource.d.ts

@@ -14,6 +14,13 @@ export interface AdminResourceOptions {
      * (A group lists its resources first, then its settings pages.)
      */
     order?: number;
+    /**
+     * Whether the resource has its own entry in the sidebar, home, group pages, palette and global search. Default
+     * `true`, except for a resource another resource edits inline (`{ inline: ThisAdmin }` in a form layout): those are
+     * edited on their parent's page and default to `false`. Either way the resource keeps its URLs, permissions,
+     * history and audit entries.
+     */
+    nav?: boolean;
     /**
      * The record's display name in lists, pickers and headers: a column name, or a function of the entity.
      * Functions see columns (relations only when the loader joined them). Default: the first string column called

package/dist/decorators/admin-resource.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-resource.js","sourceRoot":"","sources":["../../src/decorators/admin-resource.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAwC1D,mGAAmG;AACnG,MAAM,UAAU,aAAa,CAAC,MAAgB,EAAE,OAAO,GAAyB,EAAE;IAChF,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,MAAM,UAAU,GAA4B,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC;QACnE,OAAO,CAAC,cAAc,CAAC,uBAAuB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACpE,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAgB;IACzD,OAAO,OAAO,CAAC,cAAc,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AACjE,CAAC"}
+{"version":3,"file":"admin-resource.js","sourceRoot":"","sources":["../../src/decorators/admin-resource.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AA+C1D,mGAAmG;AACnG,MAAM,UAAU,aAAa,CAAC,MAAgB,EAAE,OAAO,GAAyB,EAAE;IAChF,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,MAAM,UAAU,GAA4B,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC;QACnE,OAAO,CAAC,cAAc,CAAC,uBAAuB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACpE,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAgB;IACzD,OAAO,OAAO,CAAC,cAAc,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AACjE,CAAC"}

package/dist/decorators/admin-widget.d.ts

@@ -0,0 +1,27 @@
+import 'reflect-metadata';
+import type { WidgetData, WidgetParams, WidgetType } from '../contract.js';
+import type { LocalizedText } from '../i18n/localized-text.js';
+import type { AdminContext } from '../resource/admin-context.js';
+export interface AdminWidgetOptions {
+    type: WidgetType;
+    title: LocalizedText;
+    /** Lower comes first on the dashboard. Default 100. */
+    order?: number;
+    /** Columns it spans on the desktop grid (4 columns; phones show one). Default 1. */
+    size?: 1 | 2 | 3 | 4;
+    /** The permission that shows it. Default `dashboard.<name>`; widgets may share one. */
+    permission?: string;
+}
+/**
+ * What a dashboard widget class implements: its data for a period (spec §5.8). Return the shape of its `type`:
+ * `stat`, `chart`, `table`, `progress` or `list` (`WidgetData`). The admin checks the permission and the period first.
+ */
+export interface AdminWidgetSource {
+    load(params: WidgetParams, ctx: AdminContext): Promise<WidgetData>;
+}
+export interface AdminWidgetDefinition extends AdminWidgetOptions {
+    name: string;
+}
+/** A dashboard widget: a provider whose `load` answers its data. The dashboard replaces the home page once one exists. */
+export declare function AdminWidget(name: string, options: AdminWidgetOptions): ClassDecorator;
+export declare function getAdminWidgetDefinition(target: Function): AdminWidgetDefinition | undefined;

package/dist/decorators/admin-widget.js

@@ -0,0 +1,14 @@
+import 'reflect-metadata';
+import { Injectable } from '@nestjs/common';
+import { ADMIN_WIDGET_METADATA } from '../constants.js';
+/** A dashboard widget: a provider whose `load` answers its data. The dashboard replaces the home page once one exists. */
+export function AdminWidget(name, options) {
+    return (target) => {
+        Reflect.defineMetadata(ADMIN_WIDGET_METADATA, { ...options, name }, target);
+        Injectable()(target);
+    };
+}
+export function getAdminWidgetDefinition(target) {
+    return Reflect.getOwnMetadata(ADMIN_WIDGET_METADATA, target);
+}
+//# sourceMappingURL=admin-widget.js.map

package/dist/decorators/admin-widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-widget.js","sourceRoot":"","sources":["../../src/decorators/admin-widget.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AA4BxD,0HAA0H;AAC1H,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,OAA2B;IACnE,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAkC,EAAE,MAAM,CAAC,CAAC;QAC5G,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAAgB;IACvD,OAAO,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAC/D,CAAC"}

package/dist/export/export-cells.d.ts

@@ -0,0 +1,8 @@
+import type { FieldSchema } from '../contract.js';
+import type { Cell } from './xlsx.js';
+/**
+ * One exported cell from a serialized record value (`serializeRecord`): numbers stay numbers, enums show their labels,
+ * relations their titles, booleans yes/no in `locale`, dates real dates. `offset` (minutes east of UTC) shifts
+ * date-times to the exporter's clock, since a spreadsheet cell has no time zone.
+ */
+export declare function toCell(value: unknown, field: FieldSchema, locale: string, offset: number): Cell;

package/dist/export/export-cells.js

@@ -0,0 +1,45 @@
+const YES_NO = { en: ['Yes', 'No'], fa: ['بله', 'خیر'] };
+/** A decimal or bigint string as a number when a double holds it exactly, else the text. */
+function numeric(text) {
+    if (!/^-?\d+(\.\d+)?$/.test(text))
+        return text;
+    const digits = text.replace(/^-/, '').replace('.', '').replace(/^0+/, '');
+    return digits.length <= 15 ? Number(text) : text;
+}
+/**
+ * One exported cell from a serialized record value (`serializeRecord`): numbers stay numbers, enums show their labels,
+ * relations their titles, booleans yes/no in `locale`, dates real dates. `offset` (minutes east of UTC) shifts
+ * date-times to the exporter's clock, since a spreadsheet cell has no time zone.
+ */
+export function toCell(value, field, locale, offset) {
+    if (value === null || value === undefined)
+        return null;
+    if (field.type === 'relation') {
+        const refs = (Array.isArray(value) ? value : [value]);
+        return refs.map((ref) => ref.title ?? String(ref.id)).join(locale.startsWith('fa') ? '، ' : ', ');
+    }
+    switch (field.type) {
+        case 'number':
+            return typeof value === 'number' ? value : String(value);
+        case 'decimal':
+        case 'bigint':
+            return numeric(String(value));
+        case 'boolean': {
+            const [yes, no] = YES_NO[locale.split('-')[0]] ?? YES_NO.en;
+            return value ? yes : no;
+        }
+        case 'enum':
+            return field.enumLabels?.[String(value)] ?? String(value);
+        case 'date': {
+            const date = new Date(`${String(value).slice(0, 10)}T00:00:00Z`);
+            return Number.isNaN(date.getTime()) ? String(value) : { date, time: false };
+        }
+        case 'datetime': {
+            const date = new Date(String(value));
+            return Number.isNaN(date.getTime()) ? String(value) : { date: new Date(date.getTime() + offset * 60_000), time: true };
+        }
+        default:
+            return typeof value === 'object' ? JSON.stringify(value) : String(value);
+    }
+}
+//# sourceMappingURL=export-cells.js.map

package/dist/export/export-cells.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-cells.js","sourceRoot":"","sources":["../../src/export/export-cells.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,GAAqC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;AAE3F,4FAA4F;AAC5F,SAAS,OAAO,CAAC,IAAY;IAC3B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,KAAc,EAAE,KAAkB,EAAE,MAAc,EAAE,MAAc;IACvF,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACvD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAkB,CAAC;QACvE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACpG,CAAC;IACD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ;YACX,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3D,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,KAAK,SAAS,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,MAAM,CAAC,EAAG,CAAC;YAC9D,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1B,CAAC;QACD,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5D,KAAK,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC;YACjE,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC9E,CAAC;QACD,KAAK,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACzH,CAAC;QACD;YACE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC"}