@antelopejs/interface-dms 0.3.5 → 0.4.0

package/dist/base/table-view.d.ts

@@ -1,12 +1,40 @@
-export { authorizeAction, GATE_BYPASSABLE_ACTIONS } from "./table-view/auth";
-export { archiveRows, countWithSearch, downloadExport, fetchRowForGuard, getExportStatus, listWithSearch, restoreRows, startExport, validateRowsAgainstRule, } from "./table-view/data-functions";
+/**
+ * Public entry of the table-view component, split by concern under
+ * `./table-view/`:
+ *
+ * - `options` — the consumer-facing option types and their serialized forms
+ * - `meta` — `TableViewMeta` and the column declaration decorators
+ * - `data-functions` — the interface functions the data implementation
+ *   provides (search, export, archive, guard fetches)
+ * - `realtime` — the topics of a table view and the mutation listeners a
+ *   module may add
+ * - `routes` — the assembled `TableViewRoutes` a data controller mounts
+ * - `factory` — the `TableView()` builder that ties it all together
+ * - `resource-form` — the `ResourceForm()` block over a resource
+ *
+ * The plumbing behind them lives under `./table-view/internal/` and is not
+ * re-exported here: row rule validation (`row-rules`), consumer guards
+ * (`guards`), staged uploads (`files`), per-action permission checks
+ * (`auth`), the realtime route wrappers (`realtime`), serialization and form
+ * pages (`factory-helpers`), declaration checks (`validation`), filter tabs
+ * (`tabs`), what one request is served (`request-filter`), the one TableView
+ * writing through a controller (`writer`) and the forms over a resource
+ * (`resource-form`).
+ */
+export { archiveRows, BULK_ALL_MATCHING_KEY, countWithSearch, MAX_BULK_MATCHING_ROWS, resolveBulkRowIds, summarizeWithSearch, downloadExport, fetchRowForGuard, getExportStatus, listWithSearch, restoreRows, startExport, validateRowsAgainstRule, } from "./table-view/data-functions";
+export * from "./table-view/column-display";
 export { TableView } from "./table-view/factory";
+export { WritingTableViewConflictError } from "./table-view/writer";
 export { TableViewEvents, TableViewFunctions, } from "./table-view/factory-helpers";
-export { ArchiveField, Column, ColumnGroup, type ColumnGroupConfig, type ColumnOptions, Exported, Select, TableViewMeta, } from "./table-view/meta";
-export { DEFAULT_ROW_ID_FIELD, type FormContainer, type FormContainerPageConfig, KANBAN_DISPLAY_ID, type KanbanOptions, type KanbanOptionsSerialized, type QueryParamFilter, type QueryParamFilters, type RouteParamFilter, type RouteParamFilters, TABLE_DISPLAY_ID, type TableViewDisplayCapabilities, type TableViewDisplayOption, type TableViewDisplayOptionSerialized, type TableViewOptions, type TableViewOptionsSerialized, type TableViewRowActionOptions, type TableViewRowActionOptionsSerialized, type TableViewTab, type TableViewTabFilter, } from "./table-view/options";
+export { ArchiveField, Column, ColumnGroup, type ColumnGroupConfig, type ColumnOptions, Exported, Select, type TableViewAccess, TableViewMeta, } from "./table-view/meta";
+export { CARDS_DISPLAY_ID, DEFAULT_ROW_ID_FIELD, GROUPED_DISPLAY_ID, MAX_TABLE_PAGE_SIZE, type FormContainer, type FormContainerPageConfig, type FormContainerPages, type FormContainerPageTexts, type GroupedOptions, KANBAN_DISPLAY_ID, type KanbanOptions, type KanbanOptionsSerialized, type QueryParamFilter, type QueryParamFilters, type RouteParamFilter, type RouteParamFilters, TABLE_DISPLAY_ID, type TableViewCardOptions, type TableViewCardOptionsSerialized, type TableViewDisplayCapabilities, type TableViewDisplayOption, type TableViewDisplayOptionSerialized, type TableViewExpandableBehavior, type TableViewExpandableComponent, type TableViewExpandableField, type TableViewExpandableFields, type TableViewExpandableOptions, type TableViewExpandableSerialized, type TableViewExpandedDefault, type TableViewEmptyState, type TableViewEmptyStates, type TableViewEmptyStateSerialized, type TableViewEmptyStatesSerialized, type TableViewFooterOptions, type TableViewFooterSerialized, type TableViewFooterSummary, type TableViewFooterSummarySerialized, type TableViewSummaryFormat, type TableViewSummaryOperation, type TableViewLayout, type TableViewQuickFilter, type TableViewQuickFilterMode, type TableViewOptions, type TableViewOptionsSerialized, type TableViewPaginationMode, type TableViewReorderOptions, type TableViewRowActionOptions, type TableViewRowActionOptionsSerialized, type TableViewTab, type TableViewTabFilter, type TableViewTabSerialized, type TableViewColumnsState, type TableViewDensity, type TableViewGroupBy, type TableViewSort, type TableViewView, type TableViewViewSerialized, type TableViewViewsLayout, type TableViewViewsOptions, type TableViewViewsSerialized, type TableViewViewState, } from "./table-view/options";
+export { TABLE_VIEW_TAB_QUERY_KEY, TABLE_VIEW_VIEW_QUERY_KEY, tableViewLink, type TableViewLinkTarget, } from "./table-view/views";
 export { internal, type RealtimeMutationContext, type RealtimeMutationEventType, type RealtimePresenceActor, type RealtimePresenceContext, registerRealtimeMutationListener, tableViewPresenceTopic, tableViewRowTopic, unregisterRealtimeMutationListener, } from "./table-view/realtime";
-export { ResourceForm, resourceForm, ROUTE_PARAM_ROW_ID, stampAttachmentFields, } from "./table-view/resource-form";
+export { ResourceForm, ROUTE_PARAM_ROW_ID } from "./table-view/resource-form";
 export { TableViewRoutes } from "./table-view/routes";
+export { tableViewFromSource, type TableViewSourceCapabilities, type TableViewSourceColumn, type TableViewSourceOptions, type TableViewSourceSerialized, } from "./table-view/source";
 export * from "./table-view/schema";
 export type { BulkGuardArgs, DeleteGuardArgs, EditGuardArgs, GuardFn, NewGuardArgs, TableViewGuards, } from "./types/guards";
-export type { RowActionRule } from "./types/row-action";
+export type { BulkRowActionConfig, CustomRowActionBulk, CustomRowActionBulkOptions, RowActionConfig, RowActionConfigSerialized, RowActionRule, } from "./types/row-action";
+export type { ActionConfirm, ActionConfirmSerialized, ConfirmDialog, ConfirmDialogFrom, ConfirmDialogImpact, ConfirmDialogSerialized, } from "./types/confirm-dialog";
+export { serializeConfirmDialog } from "./confirm-dialog";

package/dist/base/table-view.js

@@ -1,4 +1,27 @@
 "use strict";
+/**
+ * Public entry of the table-view component, split by concern under
+ * `./table-view/`:
+ *
+ * - `options` — the consumer-facing option types and their serialized forms
+ * - `meta` — `TableViewMeta` and the column declaration decorators
+ * - `data-functions` — the interface functions the data implementation
+ *   provides (search, export, archive, guard fetches)
+ * - `realtime` — the topics of a table view and the mutation listeners a
+ *   module may add
+ * - `routes` — the assembled `TableViewRoutes` a data controller mounts
+ * - `factory` — the `TableView()` builder that ties it all together
+ * - `resource-form` — the `ResourceForm()` block over a resource
+ *
+ * The plumbing behind them lives under `./table-view/internal/` and is not
+ * re-exported here: row rule validation (`row-rules`), consumer guards
+ * (`guards`), staged uploads (`files`), per-action permission checks
+ * (`auth`), the realtime route wrappers (`realtime`), serialization and form
+ * pages (`factory-helpers`), declaration checks (`validation`), filter tabs
+ * (`tabs`), what one request is served (`request-filter`), the one TableView
+ * writing through a controller (`writer`) and the forms over a resource
+ * (`resource-form`).
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,13 +37,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableViewRoutes = exports.stampAttachmentFields = exports.ROUTE_PARAM_ROW_ID = exports.resourceForm = exports.ResourceForm = exports.unregisterRealtimeMutationListener = exports.tableViewRowTopic = exports.tableViewPresenceTopic = exports.registerRealtimeMutationListener = exports.internal = exports.TABLE_DISPLAY_ID = exports.KANBAN_DISPLAY_ID = exports.DEFAULT_ROW_ID_FIELD = exports.TableViewMeta = exports.Select = exports.Exported = exports.ColumnGroup = exports.Column = exports.ArchiveField = exports.TableViewFunctions = exports.TableViewEvents = exports.TableView = exports.validateRowsAgainstRule = exports.startExport = exports.restoreRows = exports.listWithSearch = exports.getExportStatus = exports.fetchRowForGuard = exports.downloadExport = exports.countWithSearch = exports.archiveRows = exports.GATE_BYPASSABLE_ACTIONS = exports.authorizeAction = void 0;
-var auth_1 = require("./table-view/auth");
-Object.defineProperty(exports, "authorizeAction", { enumerable: true, get: function () { return auth_1.authorizeAction; } });
-Object.defineProperty(exports, "GATE_BYPASSABLE_ACTIONS", { enumerable: true, get: function () { return auth_1.GATE_BYPASSABLE_ACTIONS; } });
+exports.serializeConfirmDialog = exports.tableViewFromSource = exports.TableViewRoutes = exports.ROUTE_PARAM_ROW_ID = exports.ResourceForm = exports.unregisterRealtimeMutationListener = exports.tableViewRowTopic = exports.tableViewPresenceTopic = exports.registerRealtimeMutationListener = exports.internal = exports.tableViewLink = exports.TABLE_VIEW_VIEW_QUERY_KEY = exports.TABLE_VIEW_TAB_QUERY_KEY = exports.TABLE_DISPLAY_ID = exports.KANBAN_DISPLAY_ID = exports.MAX_TABLE_PAGE_SIZE = exports.GROUPED_DISPLAY_ID = exports.DEFAULT_ROW_ID_FIELD = exports.CARDS_DISPLAY_ID = exports.TableViewMeta = exports.Select = exports.Exported = exports.ColumnGroup = exports.Column = exports.ArchiveField = exports.TableViewFunctions = exports.TableViewEvents = exports.WritingTableViewConflictError = exports.TableView = exports.validateRowsAgainstRule = exports.startExport = exports.restoreRows = exports.listWithSearch = exports.getExportStatus = exports.fetchRowForGuard = exports.downloadExport = exports.summarizeWithSearch = exports.resolveBulkRowIds = exports.MAX_BULK_MATCHING_ROWS = exports.countWithSearch = exports.BULK_ALL_MATCHING_KEY = exports.archiveRows = void 0;
 var data_functions_1 = require("./table-view/data-functions");
 Object.defineProperty(exports, "archiveRows", { enumerable: true, get: function () { return data_functions_1.archiveRows; } });
+Object.defineProperty(exports, "BULK_ALL_MATCHING_KEY", { enumerable: true, get: function () { return data_functions_1.BULK_ALL_MATCHING_KEY; } });
 Object.defineProperty(exports, "countWithSearch", { enumerable: true, get: function () { return data_functions_1.countWithSearch; } });
+Object.defineProperty(exports, "MAX_BULK_MATCHING_ROWS", { enumerable: true, get: function () { return data_functions_1.MAX_BULK_MATCHING_ROWS; } });
+Object.defineProperty(exports, "resolveBulkRowIds", { enumerable: true, get: function () { return data_functions_1.resolveBulkRowIds; } });
+Object.defineProperty(exports, "summarizeWithSearch", { enumerable: true, get: function () { return data_functions_1.summarizeWithSearch; } });
 Object.defineProperty(exports, "downloadExport", { enumerable: true, get: function () { return data_functions_1.downloadExport; } });
 Object.defineProperty(exports, "fetchRowForGuard", { enumerable: true, get: function () { return data_functions_1.fetchRowForGuard; } });
 Object.defineProperty(exports, "getExportStatus", { enumerable: true, get: function () { return data_functions_1.getExportStatus; } });
@@ -28,8 +52,11 @@ Object.defineProperty(exports, "listWithSearch", { enumerable: true, get: functi
 Object.defineProperty(exports, "restoreRows", { enumerable: true, get: function () { return data_functions_1.restoreRows; } });
 Object.defineProperty(exports, "startExport", { enumerable: true, get: function () { return data_functions_1.startExport; } });
 Object.defineProperty(exports, "validateRowsAgainstRule", { enumerable: true, get: function () { return data_functions_1.validateRowsAgainstRule; } });
+__exportStar(require("./table-view/column-display"), exports);
 var factory_1 = require("./table-view/factory");
 Object.defineProperty(exports, "TableView", { enumerable: true, get: function () { return factory_1.TableView; } });
+var writer_1 = require("./table-view/writer");
+Object.defineProperty(exports, "WritingTableViewConflictError", { enumerable: true, get: function () { return writer_1.WritingTableViewConflictError; } });
 var factory_helpers_1 = require("./table-view/factory-helpers");
 Object.defineProperty(exports, "TableViewEvents", { enumerable: true, get: function () { return factory_helpers_1.TableViewEvents; } });
 Object.defineProperty(exports, "TableViewFunctions", { enumerable: true, get: function () { return factory_helpers_1.TableViewFunctions; } });
@@ -41,9 +68,16 @@ Object.defineProperty(exports, "Exported", { enumerable: true, get: function ()
 Object.defineProperty(exports, "Select", { enumerable: true, get: function () { return meta_1.Select; } });
 Object.defineProperty(exports, "TableViewMeta", { enumerable: true, get: function () { return meta_1.TableViewMeta; } });
 var options_1 = require("./table-view/options");
+Object.defineProperty(exports, "CARDS_DISPLAY_ID", { enumerable: true, get: function () { return options_1.CARDS_DISPLAY_ID; } });
 Object.defineProperty(exports, "DEFAULT_ROW_ID_FIELD", { enumerable: true, get: function () { return options_1.DEFAULT_ROW_ID_FIELD; } });
+Object.defineProperty(exports, "GROUPED_DISPLAY_ID", { enumerable: true, get: function () { return options_1.GROUPED_DISPLAY_ID; } });
+Object.defineProperty(exports, "MAX_TABLE_PAGE_SIZE", { enumerable: true, get: function () { return options_1.MAX_TABLE_PAGE_SIZE; } });
 Object.defineProperty(exports, "KANBAN_DISPLAY_ID", { enumerable: true, get: function () { return options_1.KANBAN_DISPLAY_ID; } });
 Object.defineProperty(exports, "TABLE_DISPLAY_ID", { enumerable: true, get: function () { return options_1.TABLE_DISPLAY_ID; } });
+var views_1 = require("./table-view/views");
+Object.defineProperty(exports, "TABLE_VIEW_TAB_QUERY_KEY", { enumerable: true, get: function () { return views_1.TABLE_VIEW_TAB_QUERY_KEY; } });
+Object.defineProperty(exports, "TABLE_VIEW_VIEW_QUERY_KEY", { enumerable: true, get: function () { return views_1.TABLE_VIEW_VIEW_QUERY_KEY; } });
+Object.defineProperty(exports, "tableViewLink", { enumerable: true, get: function () { return views_1.tableViewLink; } });
 var realtime_1 = require("./table-view/realtime");
 Object.defineProperty(exports, "internal", { enumerable: true, get: function () { return realtime_1.internal; } });
 Object.defineProperty(exports, "registerRealtimeMutationListener", { enumerable: true, get: function () { return realtime_1.registerRealtimeMutationListener; } });
@@ -52,10 +86,12 @@ Object.defineProperty(exports, "tableViewRowTopic", { enumerable: true, get: fun
 Object.defineProperty(exports, "unregisterRealtimeMutationListener", { enumerable: true, get: function () { return realtime_1.unregisterRealtimeMutationListener; } });
 var resource_form_1 = require("./table-view/resource-form");
 Object.defineProperty(exports, "ResourceForm", { enumerable: true, get: function () { return resource_form_1.ResourceForm; } });
-Object.defineProperty(exports, "resourceForm", { enumerable: true, get: function () { return resource_form_1.resourceForm; } });
 Object.defineProperty(exports, "ROUTE_PARAM_ROW_ID", { enumerable: true, get: function () { return resource_form_1.ROUTE_PARAM_ROW_ID; } });
-Object.defineProperty(exports, "stampAttachmentFields", { enumerable: true, get: function () { return resource_form_1.stampAttachmentFields; } });
 var routes_1 = require("./table-view/routes");
 Object.defineProperty(exports, "TableViewRoutes", { enumerable: true, get: function () { return routes_1.TableViewRoutes; } });
+var source_1 = require("./table-view/source");
+Object.defineProperty(exports, "tableViewFromSource", { enumerable: true, get: function () { return source_1.tableViewFromSource; } });
 __exportStar(require("./table-view/schema"), exports);
+var confirm_dialog_1 = require("./confirm-dialog");
+Object.defineProperty(exports, "serializeConfirmDialog", { enumerable: true, get: function () { return confirm_dialog_1.serializeConfirmDialog; } });
 //# sourceMappingURL=table-view.js.map

package/dist/base/table-view.js.map

@@ -1 +1 @@
-{"version":3,"file":"table-view.js","sourceRoot":"","sources":["../../src/base/table-view.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAwBA,0CAA6E;AAApE,uGAAA,eAAe,OAAA;AAAE,+GAAA,uBAAuB,OAAA;AACjD,8DAUqC;AATnC,6GAAA,WAAW,OAAA;AACX,iHAAA,eAAe,OAAA;AACf,gHAAA,cAAc,OAAA;AACd,kHAAA,gBAAgB,OAAA;AAChB,iHAAA,eAAe,OAAA;AACf,gHAAA,cAAc,OAAA;AACd,6GAAA,WAAW,OAAA;AACX,6GAAA,WAAW,OAAA;AACX,yHAAA,uBAAuB,OAAA;AAEzB,gDAAiD;AAAxC,oGAAA,SAAS,OAAA;AAClB,gEAGsC;AAFpC,kHAAA,eAAe,OAAA;AACf,qHAAA,kBAAkB,OAAA;AAEpB,0CAS2B;AARzB,oGAAA,YAAY,OAAA;AACZ,8FAAA,MAAM,OAAA;AACN,mGAAA,WAAW,OAAA;AAGX,gGAAA,QAAQ,OAAA;AACR,8FAAA,MAAM,OAAA;AACN,qGAAA,aAAa,OAAA;AAEf,gDAqB8B;AApB5B,+GAAA,oBAAoB,OAAA;AAGpB,4GAAA,iBAAiB,OAAA;AAOjB,2GAAA,gBAAgB,OAAA;AAWlB,kDAU+B;AAT7B,oGAAA,QAAQ,OAAA;AAKR,4HAAA,gCAAgC,OAAA;AAChC,kHAAA,sBAAsB,OAAA;AACtB,6GAAA,iBAAiB,OAAA;AACjB,8HAAA,kCAAkC,OAAA;AAEpC,4DAKoC;AAJlC,6GAAA,YAAY,OAAA;AACZ,6GAAA,YAAY,OAAA;AACZ,mHAAA,kBAAkB,OAAA;AAClB,sHAAA,qBAAqB,OAAA;AAEvB,8CAAsD;AAA7C,yGAAA,eAAe,OAAA;AACxB,sDAAoC"}
+{"version":3,"file":"table-view.js","sourceRoot":"","sources":["../../src/base/table-view.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;;;;;;;;AAEH,8DAcqC;AAbnC,6GAAA,WAAW,OAAA;AACX,uHAAA,qBAAqB,OAAA;AACrB,iHAAA,eAAe,OAAA;AACf,wHAAA,sBAAsB,OAAA;AACtB,mHAAA,iBAAiB,OAAA;AACjB,qHAAA,mBAAmB,OAAA;AACnB,gHAAA,cAAc,OAAA;AACd,kHAAA,gBAAgB,OAAA;AAChB,iHAAA,eAAe,OAAA;AACf,gHAAA,cAAc,OAAA;AACd,6GAAA,WAAW,OAAA;AACX,6GAAA,WAAW,OAAA;AACX,yHAAA,uBAAuB,OAAA;AAEzB,8DAA4C;AAC5C,gDAAiD;AAAxC,oGAAA,SAAS,OAAA;AAClB,8CAAoE;AAA3D,uHAAA,6BAA6B,OAAA;AACtC,gEAGsC;AAFpC,kHAAA,eAAe,OAAA;AACf,qHAAA,kBAAkB,OAAA;AAEpB,0CAU2B;AATzB,oGAAA,YAAY,OAAA;AACZ,8FAAA,MAAM,OAAA;AACN,mGAAA,WAAW,OAAA;AAGX,gGAAA,QAAQ,OAAA;AACR,8FAAA,MAAM,OAAA;AAEN,qGAAA,aAAa,OAAA;AAEf,gDA8D8B;AA7D5B,2GAAA,gBAAgB,OAAA;AAChB,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAClB,8GAAA,mBAAmB,OAAA;AAMnB,4GAAA,iBAAiB,OAAA;AAOjB,2GAAA,gBAAgB,OAAA;AA8ClB,4CAK4B;AAJ1B,iHAAA,wBAAwB,OAAA;AACxB,kHAAA,yBAAyB,OAAA;AACzB,sGAAA,aAAa,OAAA;AAGf,kDAU+B;AAT7B,oGAAA,QAAQ,OAAA;AAKR,4HAAA,gCAAgC,OAAA;AAChC,kHAAA,sBAAsB,OAAA;AACtB,6GAAA,iBAAiB,OAAA;AACjB,8HAAA,kCAAkC,OAAA;AAEpC,4DAA8E;AAArE,6GAAA,YAAY,OAAA;AAAE,mHAAA,kBAAkB,OAAA;AACzC,8CAAsD;AAA7C,yGAAA,eAAe,OAAA;AACxB,8CAM6B;AAL3B,6GAAA,mBAAmB,OAAA;AAMrB,sDAAoC;AAyBpC,mDAA0D;AAAjD,wHAAA,sBAAsB,OAAA"}

package/dist/base/tenant-export-archive.d.ts

@@ -1,3 +1,11 @@
+/**
+ * The tenant data export contract.
+ *
+ * Assembling the archive is DMS behaviour -- it walks the registered
+ * contributors, streams their entries into a ZIP and hands the result to the
+ * export engine -- so the module implements it and this file declares the
+ * entry points a caller needs.
+ */
 import type { RequestContext } from "@antelopejs/interface-api";
 import type { User } from "../auth/db";
 import type { ExportJobResultSummary, ExportJobTicket } from "./export-jobs";
@@ -5,6 +13,7 @@ export declare const TENANT_EXPORT_EXTENSION = "zip";
 export declare const TENANT_EXPORT_CONTENT_TYPE = "application/zip";
 export interface BuildTenantExportArchiveOptions {
     tenantId: string;
+    /** Scratch file the ZIP is written to, typically the export job's local path. */
     localPath: string;
     signal: AbortSignal;
     reportProgress?: (progress: number) => Promise<void>;
@@ -15,8 +24,20 @@ export interface StartTenantExportJobOptions {
     scope: string;
     filename: string;
     delivery?: string;
+    /** Client-side path a delivered link points to, required by email delivery. */
     deliveryPath?: string;
     maxExecutionTimeMs?: number;
 }
+/**
+ * Assembles a tenant's data export as a ZIP holding `manifest.json`, one
+ * `modules/<moduleId>.json` per JSON contribution and the heavy entries each
+ * contributor streamed in. A failing contributor is recorded in the manifest
+ * and yields a partial archive rather than failing the export.
+ */
 export declare const buildTenantExportArchive: (options: BuildTenantExportArchiveOptions) => Promise<ExportJobResultSummary>;
+/**
+ * Runs {@link buildTenantExportArchive} as a background export job. The job is
+ * retained until expiry: its archive is reachable from a delivered link and
+ * from the job history long after the first download.
+ */
 export declare const startTenantExportJob: (options: StartTenantExportJobOptions) => Promise<ExportJobTicket>;

package/dist/base/tenant-export-archive.js

@@ -4,6 +4,17 @@ exports.startTenantExportJob = exports.buildTenantExportArchive = exports.TENANT
 const interface_core_1 = require("@antelopejs/interface-core");
 exports.TENANT_EXPORT_EXTENSION = "zip";
 exports.TENANT_EXPORT_CONTENT_TYPE = "application/zip";
+/**
+ * Assembles a tenant's data export as a ZIP holding `manifest.json`, one
+ * `modules/<moduleId>.json` per JSON contribution and the heavy entries each
+ * contributor streamed in. A failing contributor is recorded in the manifest
+ * and yields a partial archive rather than failing the export.
+ */
 exports.buildTenantExportArchive = (0, interface_core_1.InterfaceFunction)();
+/**
+ * Runs {@link buildTenantExportArchive} as a background export job. The job is
+ * retained until expiry: its archive is reachable from a delivered link and
+ * from the job history long after the first download.
+ */
 exports.startTenantExportJob = (0, interface_core_1.InterfaceFunction)();
 //# sourceMappingURL=tenant-export-archive.js.map

package/dist/base/tenant-export-archive.js.map

@@ -1 +1 @@
-{"version":3,"file":"tenant-export-archive.js","sourceRoot":"","sources":["../../src/base/tenant-export-archive.ts"],"names":[],"mappings":";;;AASA,+DAA+D;AAIlD,QAAA,uBAAuB,GAAG,KAAK,CAAC;AAChC,QAAA,0BAA0B,GAAG,iBAAiB,CAAC;AA2B/C,QAAA,wBAAwB,GACnC,IAAA,kCAAiB,GAEd,CAAC;AAOO,QAAA,oBAAoB,GAC/B,IAAA,kCAAiB,GAEd,CAAC"}
+{"version":3,"file":"tenant-export-archive.js","sourceRoot":"","sources":["../../src/base/tenant-export-archive.ts"],"names":[],"mappings":";;;AASA,+DAA+D;AAIlD,QAAA,uBAAuB,GAAG,KAAK,CAAC;AAChC,QAAA,0BAA0B,GAAG,iBAAiB,CAAC;AAqB5D;;;;;GAKG;AACU,QAAA,wBAAwB,GACnC,IAAA,kCAAiB,GAEd,CAAC;AAEN;;;;GAIG;AACU,QAAA,oBAAoB,GAC/B,IAAA,kCAAiB,GAEd,CAAC"}

package/dist/base/top-list-card.d.ts

@@ -32,14 +32,31 @@ export interface TopListCardProps extends BaseComponentProps {
     rankColor?: ChartColorValue;
     showDelta?: boolean;
     showSparkline?: boolean;
+    /** Draws a proportional bar under each row, scaled to the largest value. */
+    showBar?: boolean;
     sparklineAccent?: ChartColorValue | "auto";
     invert?: boolean;
     badgeColor?: ChartColorValue;
     maxHeight?: string;
     staticItems?: TopListItem[];
     emptyLabel?: string;
+    /**
+     * How many placeholder rows the card draws while `fetchUrl` loads: the
+     * length the route answers (its "top N"), so a short list keeps its height
+     * when the rows land.
+     *
+     * Optional. Defaults to 10, which fills the default `maxHeight`.
+     */
+    skeletonCount?: 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 `TopListCard()`. 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 TopListCard(options?: TopListCardProps): ComponentBuilder<TopListCardProps>;
+/** The options `TopListCard` accepts. */
 export declare const TopListCardSchema: z.ZodObject<{
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
@@ -52,6 +69,7 @@ export declare const TopListCardSchema: z.ZodObject<{
     highlightTopN: z.ZodOptional<z.ZodNumber>;
     rankColor: z.ZodOptional<z.ZodType<ChartColorValue, z.ZodTypeDef, ChartColorValue>>;
     showDelta: z.ZodOptional<z.ZodBoolean>;
+    showBar: z.ZodOptional<z.ZodBoolean>;
     showSparkline: z.ZodOptional<z.ZodBoolean>;
     sparklineAccent: z.ZodOptional<z.ZodType<"auto" | ChartColorValue, z.ZodTypeDef, "auto" | ChartColorValue>>;
     invert: z.ZodOptional<z.ZodBoolean>;
@@ -82,35 +100,38 @@ export declare const TopListCardSchema: z.ZodObject<{
         id: string | number;
         description?: string | undefined;
         icon?: string | undefined;
+        to?: string | undefined;
         avatar?: {
             src: string;
             alt?: string | undefined;
         } | undefined;
-        delta?: number | null | undefined;
         sparkline?: number[] | undefined;
-        to?: string | undefined;
+        delta?: number | null | undefined;
     }, {
         value: number;
         title: string;
         id: string | number;
         description?: string | undefined;
         icon?: string | undefined;
+        to?: string | undefined;
         avatar?: {
             src: string;
             alt?: string | undefined;
         } | undefined;
-        delta?: number | null | undefined;
         sparkline?: number[] | undefined;
-        to?: string | undefined;
+        delta?: number | null | undefined;
     }>, "many">>;
     emptyLabel: z.ZodOptional<z.ZodString>;
+    skeletonCount: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     title: string;
     description?: string | undefined;
     fetchUrl?: string | undefined;
     fetchUrlMethod?: HttpMethod | undefined;
+    maxHeight?: string | undefined;
+    skeletonCount?: number | 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;
@@ -119,21 +140,21 @@ export declare const TopListCardSchema: z.ZodObject<{
     showRank?: boolean | undefined;
     highlightTopN?: number | undefined;
     rankColor?: ChartColorValue | undefined;
+    showBar?: boolean | undefined;
     badgeColor?: ChartColorValue | undefined;
-    maxHeight?: string | undefined;
     staticItems?: {
         value: number;
         title: string;
         id: string | number;
         description?: string | undefined;
         icon?: string | undefined;
+        to?: string | undefined;
         avatar?: {
             src: string;
             alt?: string | undefined;
         } | undefined;
-        delta?: number | null | undefined;
         sparkline?: number[] | undefined;
-        to?: string | undefined;
+        delta?: number | null | undefined;
     }[] | undefined;
     emptyLabel?: string | undefined;
 }, {
@@ -141,8 +162,10 @@ export declare const TopListCardSchema: z.ZodObject<{
     description?: string | undefined;
     fetchUrl?: string | undefined;
     fetchUrlMethod?: HttpMethod | undefined;
+    maxHeight?: string | undefined;
+    skeletonCount?: number | 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;
@@ -151,21 +174,21 @@ export declare const TopListCardSchema: z.ZodObject<{
     showRank?: boolean | undefined;
     highlightTopN?: number | undefined;
     rankColor?: ChartColorValue | undefined;
+    showBar?: boolean | undefined;
     badgeColor?: ChartColorValue | undefined;
-    maxHeight?: string | undefined;
     staticItems?: {
         value: number;
         title: string;
         id: string | number;
         description?: string | undefined;
         icon?: string | undefined;
+        to?: string | undefined;
         avatar?: {
             src: string;
             alt?: string | undefined;
         } | undefined;
-        delta?: number | null | undefined;
         sparkline?: number[] | undefined;
-        to?: string | undefined;
+        delta?: number | null | undefined;
     }[] | undefined;
     emptyLabel?: string | undefined;
 }>;

package/dist/base/top-list-card.js

@@ -9,6 +9,12 @@ const chart_1 = require("./chart");
 const http_1 = require("./types/http");
 const TOP_LIST_CARD_COMPONENT_NAME = "dms-top-list-card";
 const DEFAULT_ICON = "i-ph-list-numbers";
+/**
+ * `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 `TopListCard()`. 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 TopListCard(options) {
     return new component_1.ComponentBuilder(TOP_LIST_CARD_COMPONENT_NAME)
         .options({ ...options })
@@ -28,6 +34,7 @@ const TopListItemSchema = zod_1.z.object({
     avatar: zod_1.z.object({ src: zod_1.z.string(), alt: zod_1.z.string().optional() }).optional(),
     to: (0, block_registry_1.ui)(zod_1.z.string().optional(), { widget: "url" }),
 });
+/** The options `TopListCard` accepts. */
 exports.TopListCardSchema = zod_1.z.object({
     title: (0, block_registry_1.ui)(zod_1.z.string().describe("Card heading."), {
         label: "Title",
@@ -79,6 +86,11 @@ exports.TopListCardSchema = zod_1.z.object({
         group: "appearance",
         widget: "switch",
     }),
+    showBar: (0, block_registry_1.ui)(zod_1.z.boolean().optional(), {
+        label: "Show bar",
+        group: "appearance",
+        widget: "switch",
+    }),
     showSparkline: (0, block_registry_1.ui)(zod_1.z.boolean().optional(), {
         label: "Show sparkline",
         group: "appearance",
@@ -112,6 +124,18 @@ exports.TopListCardSchema = zod_1.z.object({
         label: "Empty message",
         group: "content",
     }),
+    skeletonCount: (0, block_registry_1.ui)(zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe("Placeholder rows drawn while the data source loads."), {
+        label: "Loading placeholders",
+        group: "data",
+        widget: "number",
+        min: 1,
+        advanced: true,
+    }),
 });
 (0, block_registry_1.RegisterBlockType)({
     type: "TopListCard",

package/dist/base/top-list-card.js.map

@@ -1 +1 @@
-{"version":3,"file":"top-list-card.js","sourceRoot":"","sources":["../../src/base/top-list-card.ts"],"names":[],"mappings":";;;AAiEA,kCASC;AA1ED,4CAAgD;AAChD,6BAAwB;AACxB,qDAK0B;AAC1B,mCAKiB;AAEjB,uCAA0C;AAyC1C,MAAM,4BAA4B,GAAG,mBAAmB,CAAC;AACzD,MAAM,YAAY,GAAG,mBAAmB,CAAC;AAQzC,SAAgB,WAAW,CACzB,OAA0B;IAE1B,OAAO,IAAI,4BAAgB,CAAmB,4BAA4B,CAAC;SACxE,OAAO,CAAC,EAAE,GAAG,OAAO,EAAsB,CAAC;SAC3C,IAAI,CAAC;QACJ,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,UAAU;QAClC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAC;AACP,CAAC;AAED,MAAM,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IACnD,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5E,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;CACjD,CAAwC,CAAC;AAG7B,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,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,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC,EAAE;QAC3E,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,OAAO;QACtB,YAAY,EAAE,aAAa;KAC5B,CAAC;IACF,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,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,UAAU;KAClB,CAAC;IACF,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,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,YAAY;KACpB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,aAAa,EAAE,IAAA,mBAAE,EACf,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,EAC3E,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,EAAE,CAC1E;IACD,SAAS,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAmB,CAAC,QAAQ,EAAE,EAAE;QACxD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,OAAO;KAChB,CAAC;IACF,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,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACjC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,UAAU,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAmB,CAAC,QAAQ,EAAE,EAAE;QACzD,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,OAAO;KAChB,CAAC;IACF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;KACpB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,UAAU,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACpC,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,SAAS;KACjB,CAAC;CACH,CAA6C,CAAC;AAE/C,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,aAAa;IACnB,aAAa,EAAE,4BAA4B;IAC3C,MAAM,EAAE,yBAAiB;IACzB,IAAI,EAAE;QACJ,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,+CAA+C;QAC5D,KAAK,EAAE,eAAe;KACvB;CACF,CAAC,CAAC"}
+{"version":3,"file":"top-list-card.js","sourceRoot":"","sources":["../../src/base/top-list-card.ts"],"names":[],"mappings":";;;AA2EA,kCASC;AApFD,4CAAgD;AAChD,6BAAwB;AACxB,qDAK0B;AAC1B,mCAKiB;AAEjB,uCAA0C;AAmD1C,MAAM,4BAA4B,GAAG,mBAAmB,CAAC;AACzD,MAAM,YAAY,GAAG,mBAAmB,CAAC;AAEzC;;;;;GAKG;AACH,SAAgB,WAAW,CACzB,OAA0B;IAE1B,OAAO,IAAI,4BAAgB,CAAmB,4BAA4B,CAAC;SACxE,OAAO,CAAC,EAAE,GAAG,OAAO,EAAsB,CAAC;SAC3C,IAAI,CAAC;QACJ,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,UAAU;QAClC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAC;AACP,CAAC;AAED,MAAM,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IACnD,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5E,EAAE,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;CACjD,CAAwC,CAAC;AAE1C,yCAAyC;AAC5B,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC,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,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,UAAU;KACnB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC,EAAE;QAC3E,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,OAAO;QACtB,YAAY,EAAE,aAAa;KAC5B,CAAC;IACF,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,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACrC,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,UAAU;KAClB,CAAC;IACF,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,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACtC,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,YAAY;KACpB,CAAC;IACF,QAAQ,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,aAAa,EAAE,IAAA,mBAAE,EACf,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC,EAC3E,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,EAAE,CAC1E;IACD,SAAS,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAmB,CAAC,QAAQ,EAAE,EAAE;QACxD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,OAAO;KAChB,CAAC;IACF,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,OAAO,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClC,KAAK,EAAE,UAAU;QACjB,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,EAAC,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE;QACjC,KAAK,EAAE,kBAAkB;QACzB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,UAAU,EAAE,IAAA,mBAAE,EAAC,IAAA,6BAAY,GAAmB,CAAC,QAAQ,EAAE,EAAE;QACzD,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,OAAO;KAChB,CAAC;IACF,SAAS,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACnC,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,YAAY;KACpB,CAAC;IACF,WAAW,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrD,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,MAAM;KACf,CAAC;IACF,UAAU,EAAE,IAAA,mBAAE,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;QACpC,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,SAAS;KACjB,CAAC;IACF,aAAa,EAAE,IAAA,mBAAE,EACf,OAAC;SACE,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,qDAAqD,CAAC,EAClE;QACE,KAAK,EAAE,sBAAsB;QAC7B,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,QAAQ;QAChB,GAAG,EAAE,CAAC;QACN,QAAQ,EAAE,IAAI;KACf,CACF;CACF,CAA6C,CAAC;AAE/C,IAAA,kCAAiB,EAAC;IAChB,IAAI,EAAE,aAAa;IACnB,aAAa,EAAE,4BAA4B;IAC3C,MAAM,EAAE,yBAAiB;IACzB,IAAI,EAAE;QACJ,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,+CAA+C;QAC5D,KAAK,EAAE,eAAe;KACvB;CACF,CAAC,CAAC"}

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

@@ -18,16 +18,29 @@ export type ActionTarget = {
     type: "external";
     url: string;
     newTab?: boolean;
+} | {
+    type: "quickAction";
+    /**
+     * Key of the quick action to run: `category:id`, or the bare id when no
+     * other category uses it. The action is left out for users the quick
+     * action is not served to.
+     */
+    id: string;
 } | {
     type: "api";
     url: string;
     method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    /**
+     * JSON body sent with the request. The values of the action's confirm
+     * `fields` are merged into it, the input winning.
+     */
+    body?: Record<string, unknown>;
+    /**
+     * Field of the JSON response copied to the clipboard on success (a
+     * share link, a token).
+     */
+    copy?: string;
     successMessage: string;
-    confirm?: {
-        title: string;
-        description: string;
-        confirmColor?: "primary" | "error" | "warning";
-    };
 } | {
     type: "exportJob";
     url: string;
@@ -43,11 +56,6 @@ export type ActionTarget = {
         errorTitle?: string;
         retry?: string;
     };
-    confirm?: {
-        title: string;
-        description: string;
-        confirmColor?: "primary" | "error" | "warning";
-    };
 };
 export type ActionTargetSerialized = {
     type: "drawer";
@@ -67,16 +75,29 @@ export type ActionTargetSerialized = {
     type: "external";
     url: string;
     newTab?: boolean;
+} | {
+    type: "quickAction";
+    /**
+     * Key of the quick action to run: `category:id`, or the bare id when no
+     * other category uses it. The action is left out for users the quick
+     * action is not served to.
+     */
+    id: string;
 } | {
     type: "api";
     url: string;
     method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    /**
+     * JSON body sent with the request. The values of the action's confirm
+     * `fields` are merged into it, the input winning.
+     */
+    body?: Record<string, unknown>;
+    /**
+     * Field of the JSON response copied to the clipboard on success (a
+     * share link, a token).
+     */
+    copy?: string;
     successMessage: string;
-    confirm?: {
-        title: string;
-        description: string;
-        confirmColor?: "primary" | "error" | "warning";
-    };
 } | {
     type: "exportJob";
     url: string;
@@ -92,9 +113,4 @@ export type ActionTargetSerialized = {
         errorTitle?: string;
         retry?: string;
     };
-    confirm?: {
-        title: string;
-        description: string;
-        confirmColor?: "primary" | "error" | "warning";
-    };
 };

package/dist/base/types/component-input.d.ts

@@ -1,2 +1,5 @@
 import type { Component } from "../../component";
+/**
+ * Component or 'noInput' literal
+ */
 export type ComponentOrNoInput<T = undefined> = Component<T> | "noInput";

package/dist/base/types/confirm-dialog.d.ts

@@ -0,0 +1,69 @@
+import type { Component, ComponentInfoSerialized } from "../../component";
+import type { FormField, FormFieldSerialized } from "../form-types";
+import type { ButtonColor } from "./custom-button";
+/** One dependent a confirmed action affects, listed in its dialog. */
+export interface ConfirmDialogImpact {
+    icon: string;
+    /** `$`-prefixed: an i18n key, receiving the dialog's `params`. */
+    label: string;
+    count?: number | string;
+}
+/**
+ * The dialog an action asks in before it runs, the same for every action:
+ * built-in (delete, archive, edit…) and custom, whatever its target. Texts
+ * are i18n keys (with `$`) or literals, both interpolated with `params` —
+ * and, on a row action, with the row's fields ("Remove {name}?").
+ */
+export interface ConfirmDialog {
+    title: string;
+    description?: string;
+    /** Values the texts are interpolated with, besides the row's fields. */
+    params?: Record<string, unknown>;
+    /** Header icon. */
+    icon?: string;
+    /** Color of the confirm button and the header icon well. */
+    color?: ButtonColor;
+    /** Text of the confirm button. */
+    confirmLabel?: string;
+    /** Text of the cancel button. */
+    cancelLabel?: string;
+    /** What the action takes with it, listed above the buttons. */
+    impact?: ConfirmDialogImpact[];
+    /**
+     * The action cannot run (the last owner, a locked row): the dialog only
+     * explains why, with a close button.
+     */
+    blocked?: boolean;
+    /** Text the user must type to confirm (type-to-confirm). */
+    confirmText?: string;
+    /**
+     * Fields the user fills in before confirming. Their values are sent with
+     * the action's request — merged into an `api` target's `body`, the input
+     * winning — and a field error the server answers shows under its field.
+     */
+    fields?: FormField[];
+    /**
+     * Escape hatch: a frontend component drawn in the dialog's body, resolved
+     * by name from the global registry.
+     */
+    component?: Component;
+}
+/**
+ * A confirmation the server words for the row an action targets: a URL
+ * answering a {@link ConfirmDialogSerialized}. On a row action, built-in or
+ * custom, `{id}` is filled in with the row's id (read through the table's
+ * `rowIdKey`) and `{<field>}` with any of the row's fields; a bulk custom
+ * action appends its selection to the query instead.
+ */
+export interface ConfirmDialogFrom {
+    from: string;
+}
+/** The confirmation of an action: a fixed dialog, or one the server words. */
+export type ActionConfirm = ConfirmDialog | ConfirmDialogFrom;
+/** A confirmation dialog as it reaches the client. */
+export interface ConfirmDialogSerialized extends Omit<ConfirmDialog, "fields" | "component"> {
+    fields?: FormFieldSerialized[];
+    component?: ComponentInfoSerialized;
+}
+/** The confirmation of an action as it reaches the client. */
+export type ActionConfirmSerialized = ConfirmDialogSerialized | ConfirmDialogFrom;

package/dist/base/types/confirm-dialog.js

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

package/dist/base/types/confirm-dialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirm-dialog.js","sourceRoot":"","sources":["../../../src/base/types/confirm-dialog.ts"],"names":[],"mappings":""}