feat(reports): saved-template store + CRUD + dialog integration (phase C)
Saves rep-configured export setups so a "Monthly board report" or
"Weekly pipeline review" template only has to be assembled once.
Schema (migration 0079_report_templates.sql + drizzle entry):
- report_templates: id, port_id, kind, name, description, config
(jsonb), created_by, created_at, updated_at.
- Sibling-name uniqueness scoped (port_id, kind, LOWER(name)) so
Port A and Port B can both have "Quarterly review" without
colliding, and two different KINDS in the same port can share a
name (a clients "Quarterly review" + an interests "Quarterly
review" coexist).
- port_id FK cascades on delete; templates evaporate with the
parent port. No cross-port enumeration risk since every query
filters by port_id.
Service (src/lib/services/report-templates.service.ts):
- createReportTemplate / listReportTemplates / getReportTemplate /
updateReportTemplate / deleteReportTemplate.
- Audit-logs every write with old/new values for the rename case.
- Surfaces sibling-name collisions as ConflictError with a
rep-readable message ('A "Monthly board report" template
already exists for the dashboard kind').
Routes:
- GET /api/v1/reports/templates?kind=clients
- POST /api/v1/reports/templates
- GET /api/v1/reports/templates/[id]
- PATCH /api/v1/reports/templates/[id]
- DELETE /api/v1/reports/templates/[id]
All gated on `reports.export` — same permission as generating
reports lets the rep manage the templates that drive them.
POST cross-validates that `body.kind === body.config.kind` so a
rep can't sneak a dashboard config into a clients template and
confuse the rendering path at use time.
UI:
- SavedTemplatesPicker reusable component — dropdown of templates
for this port + kind, inline "Save as template" toggle that
expands to a name input + Save button, delete button next to
the picker once a template is selected.
- Wired into both ExportDashboardPdfButton + ExportListPdfButton.
Applying a saved template hydrates the dialog's form (selected
widgets / filters / title) from the saved config.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 20:46:52 +02:00
|
|
|
import { NextResponse } from 'next/server';
|
|
|
|
|
import { z } from 'zod';
|
|
|
|
|
|
|
|
|
|
import { withAuth, withPermission } from '@/lib/api/helpers';
|
|
|
|
|
import { parseBody } from '@/lib/api/route-helpers';
|
|
|
|
|
import { errorResponse } from '@/lib/errors';
|
|
|
|
|
import { createReportTemplate, listReportTemplates } from '@/lib/services/report-templates.service';
|
|
|
|
|
|
|
|
|
|
const createBodySchema = z.object({
|
feat(reports-overhaul): sales + operational + custom reports, templates, schedules, exports
End-to-end reports build covering Phases 1, 2, 5, 6, 7 of Initiative 1
in docs/launch-readiness.md. Phases 3 (Marketing) + 4 (Financial)
remain deferred per the gap audit at the bottom of that doc.
Highlights:
- Sales performance report: 7 KPI tiles, pipeline funnel + stage
velocity + win-rate-over-time + source conversion + rep leaderboard
charts, deal-heat section, 5 detail tables, stage / lead-cat /
outcome filters.
- Operational report: 7 KPIs, 7 charts (heatmap, status mix, tenancy
churn, tenure histogram, signing box plot, occupancy by area, docs
in pipeline), 4 tables. Module-OFF banner when tenancies disabled.
- Custom (ad-hoc) builder v1: 4 entities (clients, interests, berths,
tenancies), column-whitelist composer, date filter, CSV download,
save-as-template. Registry-only extension path for the remaining 6
entities documented at src/lib/reports/custom/registry.ts.
- Templates: load / modify / save / save-as on Sales / Operational /
Custom. ?templateId= URL deep-link hydration via useRef guard.
Active-template badge clears when the user drives view-state via
wrapped setters; raw setters used on template apply so the badge
survives.
- Scheduled runs: BullMQ poll fires due schedules, mints report_runs,
renders, optionally emails. Recipients optional (zero-recipient
schedules archive without sending). PDF-only output for v1.
Schedule dialog re-mounts via key prop on schedule.id transitions
to avoid setState-in-effect reset patterns.
- Server-side PDF endpoint + shared payload renderer
(lib/pdf/reports/payload-report.tsx) so client + scheduler share
one rendering path.
- Shared currency formatter (lib/reports/format-currency.ts)
consolidates 5 duplicated formatMoney helpers; fixes hardcoded
'USD' in detail tables; pre-formats money rows so PDF export
(which strips column.format callbacks at the JSON boundary)
renders consistently with CSV / XLSX.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-27 22:41:53 +02:00
|
|
|
// 'sales' + 'operational' don't go through /api/v1/reports/generate;
|
|
|
|
|
// they're standalone report pages with their own routes. The config
|
|
|
|
|
// for these kinds is a thin view-state snapshot (date range +
|
|
|
|
|
// filters) that the report client applies on load. 'custom' is the
|
|
|
|
|
// ad-hoc composer's saved config — entity + columns + filter.
|
feat(reports): Financial report (Initiative 1 Phase 4)
Builds the Financial report on the canonical payments + expenses tables
(the CRM records money received; it does not invoice — invoices module
is off, dev DB has zero invoice rows). The invoice-centric spec is
reframed onto the payments model: "outstanding AR" → expected-deposit
shortfall on active deals; "AR aging" → outstanding deposits bucketed by
deal age.
Service (financial.service.ts):
- 7 KPIs: revenue collected (net of refunds), deposits, balance,
pipeline expected, outstanding deposits, expenses, net contribution
- 6 chart datasets: revenue by month (deposit/balance), collection
funnel (EOI→deposit→contract→won), expected-deposit aging, cash flow
(inflow vs outflow), expense breakdown by category
- 4 tables: outstanding deposits, recent payments, refund log, expense
ledger
- every money figure normalised to port currency via a shared
resolvePortCurrency/normalizeAmount helper (new reports/currency.ts)
UI (financial-report-client.tsx): KPI strip + recharts (stacked bar /
horizontal bar / line / donut) + month/quarter/year toggle + branded
empty states; DateRangePicker + Templates + Export wired. Un-hidden the
Financial card on the reports landing.
Plumbing: added '1y' (trailing 12mo) preset to the shared range system
(financial trends want a year); added 'financial'/'marketing' to the
report-template kind enum for template parity.
TDD: 6 financial-math unit tests (aging buckets, month keys/range, net
contribution). tsc clean; full unit suite green except pre-existing
Redis/storage-dependent integration tests. Browser-verified against live
data: API 200, KPIs correct ($5,849 expenses / -$5,849 net, $0 revenue
correct given 0 payment rows), expense ledger + breakdown populate,
payment-derived sections show graceful empty states.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-02 00:43:36 +02:00
|
|
|
kind: z.enum([
|
|
|
|
|
'dashboard',
|
|
|
|
|
'clients',
|
|
|
|
|
'berths',
|
|
|
|
|
'interests',
|
|
|
|
|
'sales',
|
|
|
|
|
'operational',
|
|
|
|
|
'financial',
|
|
|
|
|
'marketing',
|
|
|
|
|
'custom',
|
|
|
|
|
]),
|
feat(reports): saved-template store + CRUD + dialog integration (phase C)
Saves rep-configured export setups so a "Monthly board report" or
"Weekly pipeline review" template only has to be assembled once.
Schema (migration 0079_report_templates.sql + drizzle entry):
- report_templates: id, port_id, kind, name, description, config
(jsonb), created_by, created_at, updated_at.
- Sibling-name uniqueness scoped (port_id, kind, LOWER(name)) so
Port A and Port B can both have "Quarterly review" without
colliding, and two different KINDS in the same port can share a
name (a clients "Quarterly review" + an interests "Quarterly
review" coexist).
- port_id FK cascades on delete; templates evaporate with the
parent port. No cross-port enumeration risk since every query
filters by port_id.
Service (src/lib/services/report-templates.service.ts):
- createReportTemplate / listReportTemplates / getReportTemplate /
updateReportTemplate / deleteReportTemplate.
- Audit-logs every write with old/new values for the rename case.
- Surfaces sibling-name collisions as ConflictError with a
rep-readable message ('A "Monthly board report" template
already exists for the dashboard kind').
Routes:
- GET /api/v1/reports/templates?kind=clients
- POST /api/v1/reports/templates
- GET /api/v1/reports/templates/[id]
- PATCH /api/v1/reports/templates/[id]
- DELETE /api/v1/reports/templates/[id]
All gated on `reports.export` — same permission as generating
reports lets the rep manage the templates that drive them.
POST cross-validates that `body.kind === body.config.kind` so a
rep can't sneak a dashboard config into a clients template and
confuse the rendering path at use time.
UI:
- SavedTemplatesPicker reusable component — dropdown of templates
for this port + kind, inline "Save as template" toggle that
expands to a name input + Save button, delete button next to
the picker once a template is selected.
- Wired into both ExportDashboardPdfButton + ExportListPdfButton.
Applying a saved template hydrates the dialog's form (selected
widgets / filters / title) from the saved config.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 20:46:52 +02:00
|
|
|
name: z.string().min(1).max(120),
|
|
|
|
|
description: z.string().max(400).nullable().optional(),
|
|
|
|
|
// Config is the raw discriminated-union payload; the
|
|
|
|
|
// /api/v1/reports/generate route re-validates at use time, so we
|
|
|
|
|
// accept it as `record` here without imposing the full union shape.
|
|
|
|
|
config: z.record(z.string(), z.unknown()),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* GET /api/v1/reports/templates?kind=clients
|
|
|
|
|
* List saved templates for the active port, optionally filtered to
|
|
|
|
|
* one kind. Used by the Export dialog's saved-templates dropdown.
|
|
|
|
|
*
|
|
|
|
|
* POST /api/v1/reports/templates
|
|
|
|
|
* Persist a template. The dialog calls this when the rep ticks
|
|
|
|
|
* "Save as template" while configuring an export.
|
|
|
|
|
*
|
chore(autonomous-session): consolidate uncommitted work from prior session
Bundles the prior autonomous-session output that was sitting unstaged:
- Em-dash sweep across src/ + tests/ (en-dash/em-dash to hyphen, ~2280 instances)
- country-flag-icons rollout (CountryFlag component, replaces emoji glyphs that
never rendered on Windows; lazy-loads the 3x2 SVG index as a single chunk
after the per-subpath dynamic-import approach silently failed in webpack)
- Admin IA Phase 1+2: 7-domain regroup, 41 to 38 pages, /admin/berths index,
redirects (ocr to ai, reports to dashboard, invitations to users),
docs/admin-ia-proposal.md
- Per-template email tester (registry + endpoint + UI on Email admin page)
- Cancel-document mode picker (delete-from-Documenso vs keep-for-audit)
- Dashboard PDF report: 25 widgets, SVG charts, date-range picker, 11 resolvers
- Customize-widgets per-region sortables at xl+ (charts/rails/feed); single
flat sortable below xl when the layout stacks; per-viewport saved orders
- Audit doc updates capturing each shipped item
- Lint fixes: react-compiler immutability in DonutChart (reduce instead of
let-reassign), set-state-in-effect disables in CountryFlag and
UploadForSigning preview-bytes effect, unused 'confirm' destructures in
interest contract + reservation tabs, unescaped apostrophe in test-template
card copy
2026-05-23 00:52:59 +02:00
|
|
|
* Both gated on `reports.export` - the same permission that lets
|
feat(reports): saved-template store + CRUD + dialog integration (phase C)
Saves rep-configured export setups so a "Monthly board report" or
"Weekly pipeline review" template only has to be assembled once.
Schema (migration 0079_report_templates.sql + drizzle entry):
- report_templates: id, port_id, kind, name, description, config
(jsonb), created_by, created_at, updated_at.
- Sibling-name uniqueness scoped (port_id, kind, LOWER(name)) so
Port A and Port B can both have "Quarterly review" without
colliding, and two different KINDS in the same port can share a
name (a clients "Quarterly review" + an interests "Quarterly
review" coexist).
- port_id FK cascades on delete; templates evaporate with the
parent port. No cross-port enumeration risk since every query
filters by port_id.
Service (src/lib/services/report-templates.service.ts):
- createReportTemplate / listReportTemplates / getReportTemplate /
updateReportTemplate / deleteReportTemplate.
- Audit-logs every write with old/new values for the rename case.
- Surfaces sibling-name collisions as ConflictError with a
rep-readable message ('A "Monthly board report" template
already exists for the dashboard kind').
Routes:
- GET /api/v1/reports/templates?kind=clients
- POST /api/v1/reports/templates
- GET /api/v1/reports/templates/[id]
- PATCH /api/v1/reports/templates/[id]
- DELETE /api/v1/reports/templates/[id]
All gated on `reports.export` — same permission as generating
reports lets the rep manage the templates that drive them.
POST cross-validates that `body.kind === body.config.kind` so a
rep can't sneak a dashboard config into a clients template and
confuse the rendering path at use time.
UI:
- SavedTemplatesPicker reusable component — dropdown of templates
for this port + kind, inline "Save as template" toggle that
expands to a name input + Save button, delete button next to
the picker once a template is selected.
- Wired into both ExportDashboardPdfButton + ExportListPdfButton.
Applying a saved template hydrates the dialog's form (selected
widgets / filters / title) from the saved config.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 20:46:52 +02:00
|
|
|
* the rep generate reports also lets them save templates.
|
|
|
|
|
*/
|
|
|
|
|
export const GET = withAuth(
|
|
|
|
|
withPermission('reports', 'export', async (req, ctx) => {
|
|
|
|
|
try {
|
|
|
|
|
const url = new URL(req.url);
|
|
|
|
|
const kind = url.searchParams.get('kind') ?? undefined;
|
|
|
|
|
const rows = await listReportTemplates(ctx.portId, kind ?? undefined);
|
|
|
|
|
return NextResponse.json({ data: rows });
|
|
|
|
|
} catch (error) {
|
|
|
|
|
return errorResponse(error);
|
|
|
|
|
}
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
export const POST = withAuth(
|
|
|
|
|
withPermission('reports', 'export', async (req, ctx) => {
|
|
|
|
|
try {
|
|
|
|
|
const body = await parseBody(req, createBodySchema);
|
|
|
|
|
// Cross-validate that the config's discriminator matches the
|
|
|
|
|
// outer `kind`. Without this, a rep could save a clients-kind
|
|
|
|
|
// template with a dashboard config and confuse the rendering
|
|
|
|
|
// path at use time.
|
|
|
|
|
const configKind = (body.config as { kind?: unknown }).kind;
|
|
|
|
|
if (configKind !== body.kind) {
|
|
|
|
|
return NextResponse.json(
|
|
|
|
|
{ error: `config.kind must equal "${body.kind}"` },
|
|
|
|
|
{ status: 400 },
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
const row = await createReportTemplate({
|
|
|
|
|
portId: ctx.portId,
|
|
|
|
|
kind: body.kind,
|
|
|
|
|
name: body.name,
|
|
|
|
|
description: body.description ?? null,
|
|
|
|
|
config: body.config,
|
|
|
|
|
meta: {
|
|
|
|
|
userId: ctx.userId,
|
|
|
|
|
portId: ctx.portId,
|
|
|
|
|
ipAddress: ctx.ipAddress,
|
|
|
|
|
userAgent: ctx.userAgent,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
return NextResponse.json({ data: row });
|
|
|
|
|
} catch (error) {
|
|
|
|
|
return errorResponse(error);
|
|
|
|
|
}
|
|
|
|
|
}),
|
|
|
|
|
);
|