@marinoscar/platform-web 0.0.0-stage → 0.1.0-next.4

package/dist/exports/ui/ExportsList.d.ts

@@ -0,0 +1,65 @@
+import { type ReactElement } from 'react';
+import type { ExportSourceDescriptor, ExportView } from '@marinoscar/platform-contract/exports';
+import type { PageSlot, SlotTableColumn, TableSlots } from '../../core/index.js';
+/**
+ * One column of the exports list: an id, a header (the accessible name of what
+ * it draws), its placement and how to draw it for one export.
+ *
+ * @stability experimental
+ */
+export interface ExportsListColumn extends SlotTableColumn<ExportView> {
+    /** `'trailing'` draws the column in the right-hand group, before Download; otherwise `priority` places it. */
+    placement?: 'trailing';
+}
+/**
+ * What the `RowActions` slot receives: the export of the row.
+ *
+ * @stability experimental
+ */
+export interface ExportsListRowActionsProps {
+    /** The export the controls are drawn for. */
+    row: ExportView;
+}
+/**
+ * The slots of {@link ExportsList}: `Columns` and `RowActions` of the
+ * packaged-page table contract (`TableSlots`).
+ *
+ * @extensionPoint slot
+ * @stability experimental
+ */
+export interface ExportsListSlots extends Pick<TableSlots<ExportView, ExportsListColumn>, 'Columns'> {
+    /** Extra per-export controls, drawn after Download. Receives the export. */
+    RowActions?: PageSlot<ExportsListRowActionsProps>;
+}
+/**
+ * Props of {@link ExportsList}.
+ *
+ * @stability experimental
+ */
+export interface ExportsListProps {
+    /** The exports, newest first (`useExports().exports`). */
+    exports: readonly ExportView[];
+    /** The sources, to show their labels (`useExportSources().sources`); the id otherwise. */
+    sources?: readonly ExportSourceDescriptor[];
+    /** Starts a download from a fresh signed URL. Default: navigate to it. */
+    onDownload?: (url: string, view: ExportView) => void;
+    /** Add columns or per-export actions; see {@link ExportsListSlots}. */
+    slots?: ExportsListSlots;
+}
+/**
+ * The list of exports. See the file header.
+ *
+ * @param props - see {@link ExportsListProps}.
+ * @returns the list.
+ *
+ * @example
+ * ```tsx
+ * const { exports } = useExports();
+ * <ExportsList exports={exports} sources={sources} />
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export declare function ExportsList(props: ExportsListProps): ReactElement;
+//# sourceMappingURL=ExportsList.d.ts.map

package/dist/exports/ui/ExportsList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportsList.d.ts","sourceRoot":"","sources":["../../../src/exports/ui/ExportsList.tsx"],"names":[],"mappings":"AAmBA,OAAO,EAA+B,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AAEvF,OAAO,KAAK,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAEhG,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjF;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe,CAAC,UAAU,CAAC;IACpE,8GAA8G;IAC9G,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,6CAA6C;IAC7C,GAAG,EAAE,UAAU,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAClG,4EAA4E;IAC5E,UAAU,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IAC/B,0FAA0F;IAC1F,OAAO,CAAC,EAAE,SAAS,sBAAsB,EAAE,CAAC;IAC5C,0EAA0E;IAC1E,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;IACrD,uEAAuE;IACvE,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAwDD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,YAAY,CA2EjE"}

package/dist/exports/ui/ExportsList.js

@@ -0,0 +1,120 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+// =============================================================================
+// ExportsList (issue #744): the caller's recent exports
+// =============================================================================
+//
+// One row per export: what, in which format, the status IN WORDS, when, the
+// size, and Download while ready. Download asks the API for the export again
+// (`GET /api/exports/:id`) to get a FRESH signed URL, because the URL lives
+// for a few minutes only and the list never carries one.
+//
+// SLOTS (PP-14.20), named as the packaged-page table contract names them:
+// `Columns` receives the list's columns and returns the ones to draw, and
+// `RowActions` adds controls after Download. A column is placed by its
+// `priority` (`primary`: the title; `secondary`: the line under it, joined by
+// middots; `detail`: a full-width line below), or `placement: 'trailing'`
+// (the right-hand group, before Download). With no slot the list draws the
+// base columns, which is exactly the markup it always had.
+// =============================================================================
+import { Alert, Box, Button, Chip, List, ListItem, ListItemText, Stack, Typography } from '@mui/material';
+import { Fragment, useMemo, useState } from 'react';
+import { exportStatusLabel, formatExportSize } from '../headless/client.js';
+import { useExportsClient } from '../headless/hooks.js';
+const STATUS_COLOR = {
+    pending: 'default',
+    running: 'info',
+    ready: 'success',
+    expired: 'warning',
+    failed: 'error',
+};
+function defaultDownload(url) {
+    window.location.assign(url);
+}
+/** The list's own columns: the title, the line under it, and the status chip. */
+function baseColumns(sources) {
+    return [
+        {
+            id: 'export',
+            label: 'Export',
+            priority: 'primary',
+            render: (view) => `${sources.find((source) => source.id === view.source)?.label ?? view.source} (${view.format.toUpperCase()})`,
+        },
+        { id: 'created', label: 'Started', priority: 'secondary', render: (view) => new Date(view.createdAt).toLocaleString() },
+        { id: 'size', label: 'Size', priority: 'secondary', render: (view) => formatExportSize(view.sizeBytes) },
+        { id: 'error', label: 'Error', priority: 'secondary', render: (view) => view.error },
+        {
+            id: 'status',
+            label: 'Status',
+            priority: 'secondary',
+            placement: 'trailing',
+            render: (view) => (_jsx(Chip, { size: "small", label: exportStatusLabel(view.status), color: STATUS_COLOR[view.status], variant: "outlined" })),
+        },
+    ];
+}
+/** What a column drew for one export, without the empty ones. */
+function drawn(columns, view) {
+    return columns
+        .map((column) => column.render?.(view))
+        .filter((node) => node !== null && node !== undefined && node !== false && node !== '');
+}
+/** Strings join into one string (the markup the list always had); nodes are separated. */
+function joined(parts, separator) {
+    if (parts.every((part) => typeof part === 'string' || typeof part === 'number'))
+        return parts.join(separator);
+    return parts.map((part, index) => (_jsxs(Fragment, { children: [index > 0 ? separator : null, part] }, index)));
+}
+/**
+ * The list of exports. See the file header.
+ *
+ * @param props - see {@link ExportsListProps}.
+ * @returns the list.
+ *
+ * @example
+ * ```tsx
+ * const { exports } = useExports();
+ * <ExportsList exports={exports} sources={sources} />
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export function ExportsList(props) {
+    const { exports, sources = [], onDownload = defaultDownload, slots } = props;
+    const client = useExportsClient();
+    const base = useMemo(() => baseColumns(sources), [sources]);
+    const ColumnsSlot = slots?.Columns;
+    const columns = useMemo(() => (ColumnsSlot ? ColumnsSlot(base) : base), [base, ColumnsSlot]);
+    const RowActions = slots?.RowActions;
+    const primaryColumns = columns.filter((column) => column.placement !== 'trailing' && column.priority === 'primary');
+    const secondaryColumns = columns.filter((column) => column.placement !== 'trailing' && column.priority === 'secondary');
+    const detailColumns = columns.filter((column) => column.placement !== 'trailing' && column.priority === 'detail');
+    const trailingColumns = columns.filter((column) => column.placement === 'trailing');
+    const [busy, setBusy] = useState(null);
+    const [error, setError] = useState(null);
+    async function download(view) {
+        setBusy(view.id);
+        setError(null);
+        try {
+            const fresh = await client.get(view.id);
+            if (fresh.status === 'ready' && fresh.download)
+                onDownload(fresh.download.url, fresh);
+            else
+                setError('This export is no longer available. Start a new one.');
+        }
+        catch {
+            setError('The download could not be started. Please try again.');
+        }
+        finally {
+            setBusy(null);
+        }
+    }
+    if (exports.length === 0) {
+        return _jsx(Typography, { color: "text.secondary", children: "You have not exported anything yet." });
+    }
+    return (_jsxs(Box, { children: [error ? (_jsx(Alert, { severity: "error", sx: { mb: 2 }, children: error })) : null, _jsx(List, { "aria-label": "Your exports", disablePadding: true, children: exports.map((view) => {
+                    const label = sources.find((source) => source.id === view.source)?.label ?? view.source;
+                    const detail = drawn(detailColumns, view);
+                    return (_jsxs(ListItem, { divider: true, sx: { flexWrap: 'wrap', gap: 1, px: 0 }, children: [_jsx(ListItemText, { primary: joined(drawn(primaryColumns, view), ' '), secondary: joined(drawn(secondaryColumns, view), ' · '), sx: { minWidth: 0, flex: '1 1 14rem' } }), _jsxs(Stack, { direction: "row", spacing: 1, sx: { alignItems: 'center' }, children: [trailingColumns.map((column) => (_jsx(Fragment, { children: column.render?.(view) }, column.id))), view.status === 'ready' ? (_jsx(Button, { variant: "outlined", size: "small", onClick: () => void download(view), disabled: busy === view.id, "aria-label": `Download ${label} (${view.format.toUpperCase()})`, sx: { minHeight: 44 }, children: "Download" })) : null, RowActions ? _jsx(RowActions, { row: view }) : null] }), detail.length > 0 ? _jsx(Box, { sx: { flexBasis: '100%', minWidth: 0 }, children: joined(detail, ' · ') }) : null] }, view.id));
+                }) })] }));
+}
+//# sourceMappingURL=ExportsList.js.map

package/dist/exports/ui/ExportsList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportsList.js","sourceRoot":"","sources":["../../../src/exports/ui/ExportsList.tsx"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,wDAAwD;AACxD,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,6EAA6E;AAC7E,4EAA4E;AAC5E,yDAAyD;AACzD,EAAE;AACF,0EAA0E;AAC1E,0EAA0E;AAC1E,uEAAuE;AACvE,8EAA8E;AAC9E,0EAA0E;AAC1E,2EAA2E;AAC3E,2DAA2D;AAC3D,gFAAgF;AAEhF,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC1G,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAqC,MAAM,OAAO,CAAC;AAMvF,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAmDxD,MAAM,YAAY,GAAuF;IACvG,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,MAAM;IACf,KAAK,EAAE,SAAS;IAChB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,OAAO;CAChB,CAAC;AAEF,SAAS,eAAe,CAAC,GAAW;IAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED,iFAAiF;AACjF,SAAS,WAAW,CAAC,OAA0C;IAC7D,OAAO;QACL;YACE,EAAE,EAAE,QAAQ;YACZ,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,SAAS;YACnB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG;SAChI;QACD,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,EAAE;QACvH,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QACxG,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE;QACpF;YACE,EAAE,EAAE,QAAQ;YACZ,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,WAAW;YACrB,SAAS,EAAE,UAAU;YACrB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAChB,KAAC,IAAI,IAAC,IAAI,EAAC,OAAO,EAAC,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAC,UAAU,GAAG,CAClH;SACF;KACF,CAAC;AACJ,CAAC;AAED,iEAAiE;AACjE,SAAS,KAAK,CAAC,OAAqC,EAAE,IAAgB;IACpE,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;SACtC,MAAM,CAAC,CAAC,IAAI,EAA6D,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;AACvJ,CAAC;AAED,0FAA0F;AAC1F,SAAS,MAAM,CAAC,KAA2B,EAAE,SAAiB;IAC5D,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9G,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAChC,MAAC,QAAQ,eACN,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAC5B,IAAI,KAFQ,KAAK,CAGT,CACZ,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,EAAE,UAAU,GAAG,eAAe,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAC7E,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,KAAK,EAAE,OAAO,CAAC;IACnC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;IAC7F,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC;IACrC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;IACpH,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,CAAC,CAAC;IACxH,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;IAClH,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,KAAK,UAAU,CAAC,CAAC;IACpF,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IACtD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAExD,KAAK,UAAU,QAAQ,CAAC,IAAgB;QACtC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,QAAQ,CAAC,IAAI,CAAC,CAAC;QACf,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACxC,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,IAAI,KAAK,CAAC,QAAQ;gBAAE,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;;gBACjF,QAAQ,CAAC,sDAAsD,CAAC,CAAC;QACxE,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,CAAC,sDAAsD,CAAC,CAAC;QACnE,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAC,UAAU,IAAC,KAAK,EAAC,gBAAgB,oDAAiD,CAAC;IAC7F,CAAC;IAED,OAAO,CACL,MAAC,GAAG,eACD,KAAK,CAAC,CAAC,CAAC,CACP,KAAC,KAAK,IAAC,QAAQ,EAAC,OAAO,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,YAClC,KAAK,GACA,CACT,CAAC,CAAC,CAAC,IAAI,EACR,KAAC,IAAI,kBAAY,cAAc,EAAC,cAAc,kBAC3C,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBACpB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC;oBACxF,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;oBAC1C,OAAO,CACL,MAAC,QAAQ,IAAe,OAAO,QAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,aACrE,KAAC,YAAY,IACX,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,EACjD,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,EACvD,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,GACtC,EACF,MAAC,KAAK,IAAC,SAAS,EAAC,KAAK,EAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,aAC5D,eAAe,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAC/B,KAAC,QAAQ,cAAkB,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,IAAjC,MAAM,CAAC,EAAE,CAAoC,CAC7D,CAAC,EACD,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CACzB,KAAC,MAAM,IACL,OAAO,EAAC,UAAU,EAClB,IAAI,EAAC,OAAO,EACZ,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,EAClC,QAAQ,EAAE,IAAI,KAAK,IAAI,CAAC,EAAE,gBACd,YAAY,KAAK,KAAK,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,EAC9D,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,yBAGd,CACV,CAAC,CAAC,CAAC,IAAI,EACP,UAAU,CAAC,CAAC,CAAC,KAAC,UAAU,IAAC,GAAG,EAAE,IAAI,GAAI,CAAC,CAAC,CAAC,IAAI,IACxC,EACP,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAC,GAAG,IAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,YAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAO,CAAC,CAAC,CAAC,IAAI,KAxBzF,IAAI,CAAC,EAAE,CAyBX,CACZ,CAAC;gBACJ,CAAC,CAAC,GACG,IACH,CACP,CAAC;AACJ,CAAC"}

package/dist/exports/ui/copy.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The user settings card's title and the page heading.
+ *
+ * @stability experimental
+ */
+export declare const DATA_EXPORT_TITLE = "Download your data";
+/**
+ * The card's description and the page's lead.
+ *
+ * @stability experimental
+ */
+export declare const DATA_EXPORT_DESCRIPTION = "Export a copy of what this application stores about you, as JSON, CSV or an Excel workbook. Files are kept for a few days.";
+/**
+ * The route of the page.
+ *
+ * @stability experimental
+ */
+export declare const DATA_EXPORT_PATH = "/settings/data-export";
+//# sourceMappingURL=copy.d.ts.map

package/dist/exports/ui/copy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy.d.ts","sourceRoot":"","sources":["../../../src/exports/ui/copy.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,+HAC0F,CAAC;AAE/H;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,0BAA0B,CAAC"}

package/dist/exports/ui/copy.js

@@ -0,0 +1,20 @@
+// The exports UI's copy (issue #744), in one place so a fork rewords it once.
+/**
+ * The user settings card's title and the page heading.
+ *
+ * @stability experimental
+ */
+export const DATA_EXPORT_TITLE = 'Download your data';
+/**
+ * The card's description and the page's lead.
+ *
+ * @stability experimental
+ */
+export const DATA_EXPORT_DESCRIPTION = 'Export a copy of what this application stores about you, as JSON, CSV or an Excel workbook. Files are kept for a few days.';
+/**
+ * The route of the page.
+ *
+ * @stability experimental
+ */
+export const DATA_EXPORT_PATH = '/settings/data-export';
+//# sourceMappingURL=copy.js.map

package/dist/exports/ui/copy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy.js","sourceRoot":"","sources":["../../../src/exports/ui/copy.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAClC,4HAA4H,CAAC;AAE/H;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,uBAAuB,CAAC"}

package/dist/exports/ui/index.d.ts

@@ -0,0 +1,9 @@
+export { DATA_EXPORT_DESCRIPTION, DATA_EXPORT_PATH, DATA_EXPORT_TITLE } from './copy.js';
+export { DataExportPage } from './DataExportPage.js';
+export type { DataExportPageProps, DataExportPageSlots } from './DataExportPage.js';
+export { ExportDialog } from './ExportDialog.js';
+export type { ExportDialogProps, ExportFormSlotProps } from './ExportDialog.js';
+export { ExportsList } from './ExportsList.js';
+export type { ExportsListColumn, ExportsListProps, ExportsListRowActionsProps, ExportsListSlots } from './ExportsList.js';
+export { dataExportSettingsPage } from './settings-pages.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/exports/ui/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/exports/ui/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,YAAY,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC1H,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/exports/ui/index.js

@@ -0,0 +1,9 @@
+// `@marinoscar/platform-web/exports/ui`: the export dialog, the list of
+// exports, the "Download your data" page and its settings card, built on
+// `/exports/headless` (issue #744). Documented in ../README.md.
+export { DATA_EXPORT_DESCRIPTION, DATA_EXPORT_PATH, DATA_EXPORT_TITLE } from './copy.js';
+export { DataExportPage } from './DataExportPage.js';
+export { ExportDialog } from './ExportDialog.js';
+export { ExportsList } from './ExportsList.js';
+export { dataExportSettingsPage } from './settings-pages.js';
+//# sourceMappingURL=index.js.map

package/dist/exports/ui/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/exports/ui/index.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,yEAAyE;AACzE,gEAAgE;AAEhE,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/exports/ui/settings-pages.d.ts

@@ -0,0 +1,17 @@
+import type { PlatformSettingsPage } from '../../core/index.js';
+/**
+ * "Download your data" as a packaged user settings page: no permission
+ * (every role holds `user_settings:read`, the exact string the API enforces
+ * for the `user-data` source).
+ *
+ * @example
+ * ```tsx
+ * // apps/web/src/config/userSettingsSections.tsx (the "Your data" group)
+ * { ...dataExportSettingsPage.card, Icon: dataExportSettingsPage.Icon },
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export declare const dataExportSettingsPage: PlatformSettingsPage<never>;
+//# sourceMappingURL=settings-pages.d.ts.map

package/dist/exports/ui/settings-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-pages.d.ts","sourceRoot":"","sources":["../../../src/exports/ui/settings-pages.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAIhE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB,EAAE,oBAAoB,CAAC,KAAK,CAS9D,CAAC"}

package/dist/exports/ui/settings-pages.js

@@ -0,0 +1,28 @@
+import DownloadOutlinedIcon from '@mui/icons-material/DownloadOutlined';
+import { DATA_EXPORT_DESCRIPTION, DATA_EXPORT_PATH, DATA_EXPORT_TITLE } from './copy.js';
+import { DataExportPage } from './DataExportPage.js';
+/**
+ * "Download your data" as a packaged user settings page: no permission
+ * (every role holds `user_settings:read`, the exact string the API enforces
+ * for the `user-data` source).
+ *
+ * @example
+ * ```tsx
+ * // apps/web/src/config/userSettingsSections.tsx (the "Your data" group)
+ * { ...dataExportSettingsPage.card, Icon: dataExportSettingsPage.Icon },
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export const dataExportSettingsPage = {
+    id: 'data-export',
+    card: {
+        title: DATA_EXPORT_TITLE,
+        description: DATA_EXPORT_DESCRIPTION,
+        path: DATA_EXPORT_PATH,
+    },
+    Icon: DownloadOutlinedIcon,
+    Page: DataExportPage,
+};
+//# sourceMappingURL=settings-pages.js.map

package/dist/exports/ui/settings-pages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-pages.js","sourceRoot":"","sources":["../../../src/exports/ui/settings-pages.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,sCAAsC,CAAC;AAGxE,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAgC;IACjE,EAAE,EAAE,aAAa;IACjB,IAAI,EAAE;QACJ,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,uBAAuB;QACpC,IAAI,EAAE,gBAAgB;KACvB;IACD,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,cAAc;CACrB,CAAC"}

package/dist/host/headless/contract.d.ts

@@ -0,0 +1,328 @@
+/**
+ * Which of the three layers decided `enabled`. Reported, never inferred.
+ *
+ * @stability experimental
+ */
+export type MaintenanceSource = 'env' | 'memory' | 'persisted';
+/**
+ * An override held in the API process only (the database restore's swap
+ * window). `message` and `allowAdmins` are optional on it because the caller
+ * that installs one usually has nothing to say about them.
+ *
+ * @stability experimental
+ */
+export interface MaintenanceOverride {
+    /** Whether the override opens a window. */
+    enabled: boolean;
+    /** The message shown to blocked users, when the override supplies one. */
+    message?: string;
+    /** Whether administrators pass the window, when the override says. */
+    allowAdmins?: boolean;
+}
+/**
+ * The stored `maintenance` namespace of the system settings document.
+ *
+ * @stability experimental
+ */
+export interface MaintenancePolicy {
+    /** Whether the window is open. */
+    enabled: boolean;
+    /** The message shown to blocked users. */
+    message: string;
+    /** Whether administrators may keep using the application during the window. */
+    allowAdmins: boolean;
+    /** ISO-8601 time the window opened, stamped by the API; `null` when closed. */
+    startedAt: string | null;
+    /** The user who opened the window, stamped by the API; `null` when closed. */
+    startedById: string | null;
+}
+/**
+ * The effective state, plus every contributing layer, separately.
+ *
+ * `layers` is the reason the admin page exists as more than a switch: an
+ * operator asking "I turned it off and it is still on" needs to be shown that
+ * `MAINTENANCE_MODE=true` is in the environment and outranks the row they just
+ * wrote. Rendering only `enabled` would make that invisible from the UI in
+ * exactly the way it would have been invisible from the API without this block.
+ *
+ * @stability experimental
+ */
+export interface MaintenanceStatus extends MaintenancePolicy {
+    /** The layer that decided `enabled`. */
+    source: MaintenanceSource;
+    /** Each contributing layer, separately, highest priority first. */
+    layers: {
+        /** The `MAINTENANCE_MODE` environment variable. */
+        env: {
+            /** Whether the variable is set at all. */
+            present: boolean;
+            /** `null` means the variable is unset, or set to something that is neither `'true'` nor `'false'`. */
+            enabled: boolean | null;
+        };
+        /** The in-memory override (the database restore's swap window). */
+        memory: {
+            /** Whether an override is installed in this API process. */
+            present: boolean;
+            /** The override itself, or `null` when none is installed. */
+            override: MaintenanceOverride | null;
+        };
+        /** The stored `maintenance` namespace of the system settings document. */
+        persisted: {
+            /** `false` means the row could not be read and `value` is the last known state. */
+            readable: boolean;
+            /** The stored policy. */
+            value: MaintenancePolicy;
+        };
+    };
+}
+/**
+ * The `PUT` body. `enabled` is the only required field, exactly as in
+ * `updateMaintenanceSchema`.
+ *
+ * `startedAt` / `startedById` are ABSENT on purpose and must stay absent: the
+ * API stamps them itself and refuses to take them from a caller, because an
+ * audit trail the audited party can dictate is not one.
+ *
+ * @stability experimental
+ */
+export interface UpdateMaintenanceInput {
+    /** Open (`true`) or close (`false`) the window. */
+    enabled: boolean;
+    /** The message shown to blocked users (1 to 1000 characters). */
+    message?: string;
+    /** Whether administrators may keep using the application during the window. */
+    allowAdmins?: boolean;
+}
+/**
+ * The API process's own version. Always known; never read from disk.
+ *
+ * @stability experimental
+ */
+export interface AboutApi {
+    /** The API process's own version. */
+    version: string;
+    /**
+     * `DEPLOYMENT_MODE` as the API parsed it at startup (#685): `self-hosted`,
+     * `saas` (in-app database restore is disabled) or the id of a mode the app
+     * registered. Optional: an older API omits it.
+     */
+    deploymentMode?: 'self-hosted' | 'saas' | (string & {});
+}
+/** @stability experimental */
+export interface AboutApp {
+    /** The application's name, as the deploy recorded it. */
+    name: string | null;
+    /** The application's version, as the deploy recorded it. */
+    version: string | null;
+    /** The commit actually deployed — the single most useful field on the page. */
+    commitSha: string | null;
+    /** The branch or tag the deploy was taken from. */
+    ref: string | null;
+}
+/** @stability experimental */
+export interface AboutDeployedBy {
+    /** Which client wrote the document, e.g. `appctl`. */
+    cli: string | null;
+    /** The deploy client's version. */
+    version: string | null;
+}
+/**
+ * How far behind the remote this deployment was AT `checkedAt`.
+ *
+ * ⚠ COPIED FROM THE DOCUMENT, NEVER REFRESHED — the API performs no network
+ * I/O for this endpoint at all. The number is as old as `checkedAt` says it is,
+ * which is why the page must never render one without the other.
+ *
+ * @stability experimental
+ */
+export interface AboutRemote {
+    /** How many commits behind the remote the deployment was at `checkedAt`. */
+    commitsBehind: number | null;
+    /** ISO-8601 time the remote was last compared. */
+    checkedAt: string | null;
+}
+/**
+ * The deploy run that wrote the document.
+ *
+ * `outcome: 'failure'` beside a COMPLETE document is the third render state —
+ * see `ui/about-page.tsx`. `failedStep` names where it stopped, and
+ * `completed` still lists every step that really ran.
+ *
+ * @stability experimental
+ */
+export interface AboutRun {
+    /** The steps that really ran, in order. */
+    completed: string[];
+    /** The step the run stopped at; `null` for a run that did not fail. */
+    failedStep: string | null;
+    /** `failure` beside a complete document is the third render state. */
+    outcome: 'success' | 'failure' | null;
+}
+/**
+ * A liveness fact from the same indicator `GET /api/health/ready` uses.
+ *
+ * @stability experimental
+ */
+export interface AboutDatabase {
+    /** `up` when the probe answered. */
+    status: string;
+    /** How long the probe took, e.g. `4ms`. */
+    responseTime: string;
+}
+/**
+ * Which `appctl deploy` subcommand wrote a record (issue #392).
+ *
+ * @stability experimental
+ */
+export type DeployCommand = 'install' | 'update';
+/**
+ * The reverse proxy in front of this deployment, as the deploy recorded it
+ * (issue #392). Every field may be `null` — an older record, or a value the
+ * CLI could not determine.
+ *
+ * @stability experimental
+ */
+export interface AboutProxy {
+    /** Whether the proxy is a bundled container or the host's. */
+    mode: 'container' | 'host' | null;
+    /** The proxy container's name, when it is one. */
+    container: string | null;
+    /** ISO-8601. When the TLS certificate the proxy serves expires. */
+    certificateExpiresAt: string | null;
+}
+/**
+ * The host the deploy ran on, captured AT DEPLOY TIME (issue #392) — not live.
+ * `capturedAt` says how old it is.
+ *
+ * @stability experimental
+ */
+export interface AboutHost {
+    /** The host's name. */
+    hostname: string | null;
+    /** The operating system. */
+    os: string | null;
+    /** The kernel version. */
+    kernel: string | null;
+    /** The CPU architecture. */
+    arch: string | null;
+    /** The number of CPUs. */
+    cpus: number | null;
+    /** Installed memory, in bytes. */
+    memoryBytes: number | null;
+    /** The Docker version. */
+    dockerVersion: string | null;
+    /** The Docker Compose version. */
+    composeVersion: string | null;
+    /** ISO-8601 time the facts were captured (they are not live). */
+    capturedAt: string | null;
+}
+/**
+ * One successful deploy, newest first, capped at 20 by the writer (issue #392).
+ *
+ * @stability experimental
+ */
+export interface AboutHistoryEntry {
+    /** ISO-8601 finish time. */
+    at: string;
+    /** Which `appctl deploy` subcommand ran. */
+    command: DeployCommand;
+    /** The commit deployed. */
+    commitSha: string | null;
+    /** The commit it replaced; `null` for a first install. */
+    previousCommitSha: string | null;
+    /** The branch or tag the deploy was taken from. */
+    ref: string | null;
+    /** How long the run took; `null` when unmeasured. */
+    durationMs: number | null;
+    /** The deploy client's version. */
+    cliVersion: string | null;
+    /** History holds successful runs only. */
+    outcome: 'success';
+}
+/**
+ * Live facts about the API process itself — never read from disk (issue #392).
+ *
+ * @stability experimental
+ */
+export interface AboutRuntime {
+    /** ISO-8601 time this API process started. */
+    processStartedAt: string | null;
+    /** The Node.js version of this API process. */
+    nodeVersion: string | null;
+    /** `NODE_ENV` of this API process. */
+    environment: string | null;
+}
+/**
+ * `ok` — a document was read. `absent` — nothing there. `invalid` — unusable.
+ *
+ * @stability experimental
+ */
+export type DeployInfoStatus = 'ok' | 'absent' | 'invalid';
+/**
+ * One group of facts the app contributed to the report
+ * (`registerAboutContributor` on the API), shown as its own section.
+ *
+ * @stability experimental
+ */
+export interface AboutExtra {
+    /** The contributor's id. */
+    id: string;
+    /** The section heading. */
+    label: string;
+    /** The facts, name to value. */
+    facts: Record<string, string | number | boolean>;
+}
+/** @stability experimental */
+export interface AboutResponse {
+    /** The API process's own version and deployment mode. */
+    api: AboutApi;
+    /** Whether a deploy document was read, absent, or unusable. */
+    deployInfoStatus: DeployInfoStatus;
+    /**
+     * The exact path the API read.
+     *
+     * Always present, INCLUDING on `ok`. On `absent` it is the only actionable
+     * fact the response carries, and the reason the copy around it can stay
+     * truthful — see the page.
+     */
+    deployInfoPath: string;
+    /** Why the document is `invalid`. `null` for `ok` and for `absent`. */
+    deployInfoError: string | null;
+    /** The application as the deploy recorded it; `null` when no document was read. */
+    app: AboutApp | null;
+    /** ISO-8601 time of the first install. */
+    installedAt: string | null;
+    /** ISO-8601 time of the last update. */
+    updatedAt: string | null;
+    /** The client that wrote the document. */
+    deployedBy: AboutDeployedBy | null;
+    /** The domain the deployment serves. */
+    domain: string | null;
+    /** How far behind the remote the deployment was, as last checked. */
+    remote: AboutRemote | null;
+    /** The deploy run that wrote the document. */
+    run: AboutRun | null;
+    /** Which subcommand wrote the document last. */
+    lastCommand?: DeployCommand | null;
+    /** The port the deployment binds. */
+    bindPort?: number | null;
+    /** The reverse proxy in front of the deployment. */
+    proxy?: AboutProxy | null;
+    /** The host the deploy ran on, captured at deploy time. */
+    host?: AboutHost | null;
+    /** Successful runs, newest first, at most 20. */
+    history?: AboutHistoryEntry[] | null;
+    /** Live facts about the API process; never read from disk. */
+    runtime?: AboutRuntime | null;
+    /** `null` PLUS `databaseError`, never a 503. A fact to display, not a page error. */
+    database: AboutDatabase | null;
+    /** Why the database probe failed; `null` when it answered. */
+    databaseError: string | null;
+    /**
+     * Groups of facts the app contributed with `registerAboutContributor`, in
+     * registration order. Absent when none is registered (and from an older API);
+     * the page renders each as an extra section after the database.
+     */
+    extras?: AboutExtra[];
+}
+//# sourceMappingURL=contract.d.ts.map