shutro-erp 0.3.3 → 0.3.5

package/dist/reporting/routes.js

@@ -6,9 +6,11 @@
  * - `POST /api/v1/models/:model/export/xlsx`      a list as a formatted XLSX (needs `export`; audited)
  */
 import { audit, HttpProblem, publicApiModels, } from '../server/index.js';
+import { renderPdf } from './documents.js';
 import { ReportError, runReport, } from './pivot.js';
 import { moneyFormat, workbook } from './xlsx.js';
 const LIST_XLSX_LIMIT = 100_000;
+const LIST_PDF_LIMIT = 2000;
 const search = (env, model, query) => env.model(model).search(query);
 function bad(detail) {
     return new HttpProblem(400, 'invalid-report', 'Invalid report', detail);
@@ -220,91 +222,34 @@ export function registerReportRoutes(context) {
         const limit = raw['limit'] === undefined ? LIST_XLSX_LIMIT : Number(raw['limit']);
         if (!Number.isInteger(limit) || limit < 1 || limit > LIST_XLSX_LIMIT)
             throw bad(`limit must be 1–${LIST_XLSX_LIMIT}.`);
-        const sheet = await request.env(async (env) => {
-            env.access.check(model.name, 'export');
-            const fields = (keys.length > 0
-                ? keys
-                : model.fields
-                    .filter((f) => f.stored &&
-                    f.kind !== 'binary' &&
-                    f.kind !== 'one2many' &&
-                    f.kind !== 'many2many')
-                    .map((f) => f.key))
-                .map((k) => model.byKey.get(k))
-                .filter((f) => f !== undefined && env.access.canField(model.name, f.key, 'read'));
-            const found = await search(env, model.name, {
-                ...(where === undefined ? {} : { where }),
-                order: ['id asc'],
-                limit,
-            });
-            const loaded = found.length === 0
-                ? []
-                : (await found.load(['id', ...fields.map((f) => f?.key)])).read(fields.map((f) => f?.key));
-            // many2one columns show names, not ids.
-            const names = new Map();
-            for (const f of fields)
-                if (f?.kind === 'many2one' && f.target !== null) {
-                    const ids = [
-                        ...new Set(loaded.map((r) => r[f.key]).filter((v) => typeof v === 'number')),
-                    ];
-                    names.set(f.key, ids.length === 0 ? new Map() : await displayNames(env, f.target, ids));
-                }
-            await audit(env, {
-                kind: 'data.export',
-                summary: `Exported ${loaded.length} ${model.name} record(s) as xlsx.`,
-                targetModel: model.name,
-                details: { fields: fields.map((f) => f?.key), count: loaded.length, filter: where ?? null },
-                ip: request.ip,
-            });
-            const header = fields.map((f) => f?.label ?? '');
-            const body = loaded.map((r) => fields.map((f) => {
-                if (f === undefined)
-                    return null;
-                const v = r[f.key];
-                if (v === null || v === undefined)
-                    return null;
-                switch (f.kind) {
-                    case 'many2one':
-                        return names.get(f.key)?.get(v) ?? `#${String(v)}`;
-                    case 'decimal':
-                    case 'float':
-                        return { decimal: String(v) };
-                    case 'monetary': {
-                        const m = (typeof v.toJSON === 'function'
-                            ? v.toJSON()
-                            : v);
-                        return {
-                            decimal: String(m.amount ?? v),
-                            format: moneyFormat(String(m.currency ?? '')),
-                        };
-                    }
-                    case 'date':
-                        return new Date(`${String(v).slice(0, 10)}T00:00:00Z`);
-                    case 'datetime':
-                        return v instanceof Date ? v : new Date(String(v));
-                    case 'selection':
-                    case 'state':
-                        return f.options?.find(([value]) => value === v)?.[1] ?? String(v);
-                    case 'boolean':
-                        return v === true;
-                    case 'integer':
-                    case 'bigint':
-                        return Number(v);
-                    default:
-                        return String(v);
-                }
-            }));
-            return {
-                name: model.label,
-                rows: [header, ...body],
-                widths: fields.map((f) => Math.min(48, Math.max(10, (f?.label.length ?? 10) + 4))),
-            };
-        });
+        const sheet = await request.env((env) => listSheet(env, model, keys, where, limit, request.ip, 'xlsx'));
         await reply
             .type('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
             .header('content-disposition', `attachment; filename="${model.name}.xlsx"`)
             .send(workbook([sheet]));
     });
+    // RFC 0022 §3.5: a list printed as PDF — the columns shown, the filter, up to LIST_PDF_LIMIT rows.
+    app.post('/api/v1/models/:model/export/pdf', async (request, reply) => {
+        const model = modelOf(request.params);
+        const raw = bodyOf(request);
+        const keys = strings(raw['fields'], 'fields');
+        const where = raw['filter'];
+        const limit = raw['limit'] === undefined ? LIST_PDF_LIMIT : Number(raw['limit']);
+        if (!Number.isInteger(limit) || limit < 1 || limit > LIST_PDF_LIMIT)
+            throw bad(`limit must be 1–${LIST_PDF_LIMIT}.`);
+        const sheet = await request.env((env) => listSheet(env, model, keys, where, limit, request.ip, 'pdf'));
+        const lang = String(request.headers['accept-language'] ?? 'en').slice(0, 2);
+        const html = listHtml(sheet, { lang, dir: lang === 'ar' || lang === 'he' ? 'rtl' : 'ltr' });
+        const pdf = await renderPdf(html, {
+            paper: 'A4',
+            orientation: (sheet.rows[0]?.length ?? 0) > 6 ? 'landscape' : 'portrait',
+            blocks: [],
+        });
+        await reply
+            .type('application/pdf')
+            .header('content-disposition', `attachment; filename="${model.name}.pdf"`)
+            .send(pdf);
+    });
 }
 function csvCell(value) {
     let t = value;
@@ -312,3 +257,116 @@ function csvCell(value) {
         t = `'${t}`;
     return /[",\r\n]/.test(t) ? `"${t.replaceAll('"', '""')}"` : t;
 }
+/** The rows of a list for an export: the columns the user may read, many2one names, typed cells; audited. */
+async function listSheet(env, model, keys, where, limit, ip, format) {
+    env.access.check(model.name, 'export');
+    const fields = (keys.length > 0
+        ? keys
+        : model.fields
+            .filter((f) => f.stored && f.kind !== 'binary' && f.kind !== 'one2many' && f.kind !== 'many2many')
+            .map((f) => f.key))
+        .map((k) => model.byKey.get(k))
+        .filter((f) => f !== undefined && env.access.canField(model.name, f.key, 'read'));
+    const found = await search(env, model.name, {
+        ...(where === undefined ? {} : { where }),
+        order: ['id asc'],
+        limit,
+    });
+    const loaded = found.length === 0
+        ? []
+        : (await found.load(['id', ...fields.map((f) => f?.key)])).read(fields.map((f) => f?.key));
+    // many2one columns show names, not ids.
+    const names = new Map();
+    for (const f of fields)
+        if (f?.kind === 'many2one' && f.target !== null) {
+            const ids = [
+                ...new Set(loaded.map((r) => r[f.key]).filter((v) => typeof v === 'number')),
+            ];
+            names.set(f.key, ids.length === 0 ? new Map() : await displayNames(env, f.target, ids));
+        }
+    await audit(env, {
+        kind: 'data.export',
+        summary: `Exported ${loaded.length} ${model.name} record(s) as ${format}.`,
+        targetModel: model.name,
+        details: { fields: fields.map((f) => f?.key), count: loaded.length, filter: where ?? null },
+        ip,
+    });
+    const header = fields.map((f) => f?.label ?? '');
+    const body = loaded.map((r) => fields.map((f) => {
+        if (f === undefined)
+            return null;
+        const v = r[f.key];
+        if (v === null || v === undefined)
+            return null;
+        switch (f.kind) {
+            case 'many2one':
+                return names.get(f.key)?.get(v) ?? `#${String(v)}`;
+            case 'decimal':
+            case 'float':
+                return { decimal: String(v) };
+            case 'monetary': {
+                const m = (typeof v.toJSON === 'function'
+                    ? v.toJSON()
+                    : v);
+                return {
+                    decimal: String(m.amount ?? v),
+                    format: moneyFormat(String(m.currency ?? '')),
+                };
+            }
+            case 'date':
+                return new Date(`${String(v).slice(0, 10)}T00:00:00Z`);
+            case 'datetime':
+                return v instanceof Date ? v : new Date(String(v));
+            case 'selection':
+            case 'state':
+                return f.options?.find(([value]) => value === v)?.[1] ?? String(v);
+            case 'boolean':
+                return v === true;
+            case 'integer':
+            case 'bigint':
+                return Number(v);
+            default:
+                return String(v);
+        }
+    }));
+    return {
+        name: model.label,
+        rows: [header, ...body],
+        widths: fields.map((f) => Math.min(48, Math.max(10, (f?.label.length ?? 10) + 4))),
+    };
+}
+const escapeHtml = (text) => text.replace(/[&<>"']/g, (c) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&#39;' })[c] ?? c);
+/** A cell as text on paper. */
+function cellText(cell) {
+    if (cell === null)
+        return '';
+    if (cell instanceof Date)
+        return cell.toISOString().slice(0, 10);
+    if (typeof cell === 'boolean')
+        return cell ? '✓' : '';
+    if (typeof cell === 'object')
+        return 'decimal' in cell ? cell.decimal : cell.text;
+    return String(cell);
+}
+/** A list as a printable page: the title, the count, a table with the header on every page. */
+function listHtml(sheet, options) {
+    const [header = [], ...body] = sheet.rows;
+    const numeric = header.map((_, i) => body.every((row) => {
+        const c = row[i];
+        return (c === null ||
+            c === undefined ||
+            typeof c === 'number' ||
+            (typeof c === 'object' && 'decimal' in c));
+    }));
+    const th = header.map((h) => `<th>${escapeHtml(cellText(h))}</th>`).join('');
+    const tr = body
+        .map((row) => `<tr>${row.map((c, i) => `<td${numeric[i] ? ' class="n"' : ''}>${escapeHtml(cellText(c))}</td>`).join('')}</tr>`)
+        .join('\n');
+    return `<!doctype html><html lang="${escapeHtml(options.lang)}" dir="${options.dir}"><head><meta charset="utf-8"><title>${escapeHtml(sheet.name)}</title><style>
+body{font:10pt/1.4 "Inter","Noto Sans Bengali",system-ui,sans-serif;color:#111;margin:0}
+h1{font-size:14pt;margin:0 0 2mm}p{margin:0 0 4mm;color:#555}
+table{width:100%;border-collapse:collapse}thead{display:table-header-group}
+th,td{padding:1.2mm 2mm;border-bottom:0.2mm solid #ccc;text-align:start;vertical-align:top}
+th{font-weight:600;background:#f3f4f6}td.n,th.n{text-align:end;font-variant-numeric:tabular-nums}
+tr{break-inside:avoid}</style></head><body><h1>${escapeHtml(sheet.name)}</h1><p>${body.length}</p><table><thead><tr>${th}</tr></thead><tbody>${tr}</tbody></table></body></html>`;
+}

package/dist/reporting/web/DashboardView.d.ts

@@ -20,4 +20,15 @@ export interface Card {
     readonly w: 3 | 4 | 6 | 12;
 }
 export declare function measureOf(text: string): MeasureSpec;
+export declare function Records({ model, domain, onClose, }: {
+    readonly model: string;
+    readonly domain: Condition;
+    readonly onClose: () => void;
+}): ReactElement;
+export declare function CardFrame({ card, editing, onRemove, onDrill, }: {
+    readonly card: Card;
+    readonly editing: boolean;
+    readonly onRemove: () => void;
+    readonly onDrill: (domain: Condition) => void;
+}): ReactElement;
 export declare function DashboardView(_props: ViewProps): ReactElement;

package/dist/reporting/web/DashboardView.js

@@ -25,7 +25,7 @@ function thisMonth() {
     const to = new Date(Date.UTC(now.getFullYear(), now.getMonth() + 1, 1));
     return { from: from.toISOString().slice(0, 10), to: to.toISOString().slice(0, 10) };
 }
-function Records({ model, domain, onClose, }) {
+export function Records({ model, domain, onClose, }) {
     const { api } = useKosh();
     const { t } = useTranslation('reporting');
     const rows = useQuery({
@@ -90,7 +90,7 @@ const SPAN = {
     6: 'lg:col-span-6',
     12: 'lg:col-span-12',
 };
-function CardFrame({ card, editing, onRemove, onDrill, }) {
+export function CardFrame({ card, editing, onRemove, onDrill, }) {
     const { t } = useTranslation('reporting');
     const drag = useDraggable({ id: card.id, disabled: !editing });
     const drop = useDroppable({ id: card.id });

package/dist/reporting/web/DesignerView.js

@@ -21,6 +21,7 @@ const KINDS = [
     'divider',
     'pageBreak',
     'signature',
+    'qr',
 ];
 function newBlock(kind, n) {
     const id = `${kind}_${n}`;
@@ -39,6 +40,8 @@ function newBlock(kind, n) {
             return { kind, id, left: [], right: [] };
         case 'signature':
             return { kind, id, labels: ['Prepared by', 'Approved by'] };
+        case 'qr':
+            return { kind, id, bind: 'name' };
         default:
             return { kind, id };
     }
@@ -52,6 +55,8 @@ function BlockEditor({ block, onChange, }) {
             return (_jsxs("div", { className: "grid gap-2", children: [text(t('designer.text'), block.text, (v) => onChange({ ...block, text: v })), _jsx(Select, { label: "Level", value: String(block.level ?? 1), options: ['1', '2', '3'].map((l) => ({ value: l, label: `H${l}` })), onChange: (v) => onChange({ ...block, level: Number(v) }) })] }));
         case 'text':
             return text(t('designer.text'), block.text, (v) => onChange({ ...block, text: v }), true);
+        case 'qr':
+            return (_jsxs("div", { className: "grid gap-2", children: [text(t('designer.bind'), block.bind, (v) => onChange({ ...block, bind: v })), text(t('designer.label'), block.label ?? '', (v) => onChange({ ...block, label: v === '' ? undefined : v }))] }));
         case 'field':
             return (_jsxs("div", { className: "grid gap-2", children: [text(t('designer.bind'), block.bind, (v) => onChange({ ...block, bind: v })), text(t('designer.label'), block.label ?? '', (v) => onChange({ ...block, label: v === '' ? undefined : v }))] }));
         case 'fields':

package/dist/reporting/web/Overview.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An app's overview page (RFC 0022 §3.2): the cards its manifest declared — KPIs with their change against the
+ * previous period, charts, small pivots, top records — opened by the app's first menu. The cards come from the
+ * overview route; each one queries the reports as the user (their rights and record rules apply), and a chart point
+ * or a pivot row opens the records behind it. Read-only: the layout belongs to the app (personal layouts: step 3).
+ */
+import { type PageProps } from '../../ui/index.js';
+import { type ReactElement } from 'react';
+export declare function Overview({ app }: PageProps): ReactElement;

package/dist/reporting/web/Overview.js

@@ -0,0 +1,53 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * An app's overview page (RFC 0022 §3.2): the cards its manifest declared — KPIs with their change against the
+ * previous period, charts, small pivots, top records — opened by the app's first menu. The cards come from the
+ * overview route; each one queries the reports as the user (their rights and record rules apply), and a chart point
+ * or a pivot row opens the records behind it. Read-only: the layout belongs to the app (personal layouts: step 3).
+ */
+import { Alert, Button, Spinner, useKosh } from '../../ui/index.js';
+import { useQuery } from '@tanstack/react-query';
+import { useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { CardFrame, Records } from './DashboardView.js';
+export function Overview({ app }) {
+    const { api, uid } = useKosh();
+    const { t } = useTranslation('reporting');
+    const [drill, setDrill] = useState(null);
+    // RFC 0022 step 3: the cards a person hid, kept in their browser (like a list's columns).
+    const hiddenKey = `kosh.overview.${uid}.${app ?? ''}`;
+    const [hidden, setHidden] = useState(() => {
+        try {
+            const raw = localStorage.getItem(hiddenKey);
+            return raw === null ? [] : JSON.parse(raw);
+        }
+        catch {
+            return [];
+        }
+    });
+    const [editing, setEditing] = useState(false);
+    const hide = (ids) => {
+        setHidden(ids);
+        try {
+            localStorage.setItem(hiddenKey, JSON.stringify(ids));
+        }
+        catch {
+            // storage unavailable: the choice lasts for the page
+        }
+    };
+    const overview = useQuery({
+        queryKey: ['overview', app],
+        queryFn: () => api.call('GET', `/api/v1/reports/overview?app=${encodeURIComponent(app ?? '')}`),
+        enabled: app !== undefined,
+    });
+    if (overview.isError)
+        return _jsx(Alert, { children: overview.error.message });
+    if (overview.data === undefined)
+        return _jsx(Spinner, { label: t('overview') });
+    return (_jsxs("div", { className: "grid gap-3", children: [_jsxs("div", { className: "flex flex-wrap items-center gap-2", children: [_jsx("h2", { className: "text-base font-semibold", children: `${overview.data.label} · ${t('overview')}` }), _jsxs("div", { className: "ms-auto flex items-center gap-2", children: [hidden.length === 0 ? null : (_jsx(Button, { size: "sm", variant: "ghost", onClick: () => hide([]), children: t('showAllCards', { count: hidden.length }) })), _jsx(Button, { size: "sm", onClick: () => setEditing((e) => !e), children: editing ? t('done') : t('customise') })] })] }), _jsx("div", { className: "grid grid-cols-12 gap-3", children: overview.data.cards
+                    .filter((card) => editing || !hidden.includes(card.id))
+                    .map((card) => (_jsx(CardFrame, { card: card, editing: editing && !hidden.includes(card.id), onRemove: () => hide([...hidden, card.id]), onDrill: (domain) => setDrill({
+                        model: card.model,
+                        domain: card.filter === undefined ? domain : { and: [card.filter, domain] },
+                    }) }, card.id))) }), drill === null ? null : (_jsx(Records, { model: drill.model, domain: drill.domain, onClose: () => setDrill(null) }))] }));
+}

package/dist/reporting/web/index.d.ts

@@ -17,6 +17,7 @@ export { GanttView, windowOf } from './GanttView.js';
 export { chartData, GraphView, ReportChart, type ReportChartProps } from './GraphView.js';
 export { HierarchyView } from './HierarchyView.js';
 export { DEFAULT_MAP_STYLE, MapView } from './MapView.js';
+export { Overview } from './Overview.js';
 export { PivotView } from './PivotView.js';
 export { SpreadsheetView } from './SpreadsheetView.js';
 /** Registers the report views (and their messages in `i18n`, when given). */

package/dist/reporting/web/index.js

@@ -15,6 +15,7 @@ import { GraphView } from './GraphView.js';
 import { HierarchyView } from './HierarchyView.js';
 import { MapView } from './MapView.js';
 import { messages } from './messages.js';
+import { Overview } from './Overview.js';
 import { PivotView } from './PivotView.js';
 import { SpreadsheetView } from './SpreadsheetView.js';
 export { CalendarView, gridDays } from './CalendarView.js';
@@ -27,6 +28,7 @@ export { GanttView, windowOf } from './GanttView.js';
 export { chartData, GraphView, ReportChart } from './GraphView.js';
 export { HierarchyView } from './HierarchyView.js';
 export { DEFAULT_MAP_STYLE, MapView } from './MapView.js';
+export { Overview } from './Overview.js';
 export { PivotView } from './PivotView.js';
 export { SpreadsheetView } from './SpreadsheetView.js';
 /** Registers the report views (and their messages in `i18n`, when given). */
@@ -43,7 +45,8 @@ export function registerReportingWeb(registry, i18n) {
         .registerView('dashboard', DashboardView)
         .registerView('designer', DesignerView)
         .registerComponent('reporting.Documents', Documents)
-        .registerComponent('reporting.ScheduleOutputs', ScheduleOutputs);
+        .registerComponent('reporting.ScheduleOutputs', ScheduleOutputs)
+        .registerPage('reporting.Overview', Overview);
     if (i18n !== undefined)
         addMessages(i18n, 'reporting', messages);
     return registry;

package/dist/reporting/web/messages.js

@@ -33,6 +33,10 @@ export const messages = {
         churn: 'Closed',
         newSheet: 'New spreadsheet',
         newDashboard: 'New dashboard',
+        overview: 'Overview',
+        customise: 'Customise',
+        showAllCards_one: 'Show the {{count}} hidden card',
+        showAllCards_other: 'Show the {{count}} hidden cards',
         name: 'Name',
         save: 'Save',
         saved: 'Saved',
@@ -87,6 +91,7 @@ export const messages = {
                 divider: 'Divider',
                 pageBreak: 'Page break',
                 signature: 'Signatures',
+                qr: 'QR code',
             },
         },
     },
@@ -112,6 +117,10 @@ export const messages = {
         next: 'পরের',
         newSheet: 'নতুন স্প্রেডশিট',
         newDashboard: 'নতুন ড্যাশবোর্ড',
+        overview: 'সারসংক্ষেপ',
+        customise: 'সাজান',
+        showAllCards_one: 'লুকানো {{count}}টি কার্ড দেখান',
+        showAllCards_other: 'লুকানো {{count}}টি কার্ড দেখান',
         name: 'নাম',
         save: 'সংরক্ষণ',
         addCard: 'কার্ড যোগ করুন',

package/dist/sale_account/.kosh/bindings.js

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: b268ad86cd210c36
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 6e014c4aaba6871d
 // Bindings of module `sale_account`: import the definition API from here to get types scoped to what it can see.
 export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
 import { definitions } from '../../server/orm.js';