* feat(dimensions): PR4 reports — dimension-filtered P&L everywhere + Resultat per projekt/kostnadsställe The Project P&L milestone of the dimensions plan (dev_docs §7 PR4). One choke point lights up everything: generateTrialBalance gains options.dimensions (SIE dim → code map) pushed down as jsonb containment (dimensions @>, served by idx_jel_dimensions_gin) on both line queries, with company-wide opening balances dropped when filtered (they cannot be dimension-scoped; P&L-safe by whitelist). Resultatrapport, resultaträkning, huvudbok, monthly-breakdown and the TB drill-down inherit the filter; the KPI route filters only its P&L-side inputs (income statement, months, expense composition) — never cash/VAT. New report lib/reports/dimension-pnl.ts — "Resultat per projekt/ kostnadsställe" (Fortnox Resultatrapport projekt): value-as-column matrix over one dimension with an explicit "(Utan dimension)" bucket computed as the residual against the same trial-balance pass resultatrapport uses, so every row and the Totalt column reconcile with the unfiltered resultatrapport by construction. Registered in REPORT_CATALOG (visible only when dimensions_enabled), slug-routed view + xlsx export. UI: DimensionFilter (dimension + value picker, persistent "Filtrerad — ej fullständig rapport" chip) mounts in FocusedReport for catalog entries flagged dimensions: true; huvudbok rows show line dim codes. Statutory exclusion pinned by TEST, not convention: lib/reports/__tests__/dimension-statutory-guard.test.ts fails if the filter parser leaks into balance sheet, balansrapport, kassaflöde, VAT, SIE or full-archive routes/generators, or if the catalog whitelist widens. MCP: new gnubok_get_dimension_pnl (reports:read); dimensions filter arg on get_trial_balance/get_income_statement/get_general_ledger with resolve-don't-select (names → registry codes, resolution echoes); query_journal totals fixed to aggregate the FULL match set (was silently slice-scoped while claiming otherwise) with an honest totals_scope field, plus group_by / group_by_dimension aggregation. Also: voucher-detail dim-6 badge now uses the registry name instead of the non-standard "PR" abbreviation (#859 review follow-up). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix(dimensions): address #862 review — export disclosure, prior-column suppression, period-label honesty, route hardening - Filtered XLSX/PDF exports now carry the partial-view disclosure past the file boundary (BFNAR 2013:2): filename suffix (-dim6-p001), a "Filtrerad … — ej fullständig rapport" row on every sheet, and a header note/title line in the PDFs. - Resultatrapport drops the prior-year column when a dimension filter is active — project codes are time-limited under K2/K3, so "this code last year" may be a different project (same rule as narrowed date ranges). - dimension-pnl no longer accepts fromDate: the matrix is cumulative from period_start by design (closing-balance semantics), and the period label now states exactly that instead of echoing a lower bound that was never applied. Routes/MCP tool updated to toDate-only. - dimension-pnl routes 404 on an unknown/foreign period id and cap dim_no to 4 digits (matching the MCP tool's PostgREST-path guard, which the generator now also enforces itself). - Statutory-guard test's generateTrialBalance call-site scan is paren-aware instead of a 300-char window; added fully-untagged and injection-guard test cases. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
147 lines
5.5 KiB
TypeScript
147 lines
5.5 KiB
TypeScript
/**
|
|
* Dimensions PR4 — gnubok_get_dimension_pnl MCP surface tests.
|
|
*
|
|
* Covers registration (schema conventions + scope map) and the execute path:
|
|
* default-period lookup, explicit period + date-window passthrough, and the
|
|
* sie_dim_no guard. The matrix math itself is covered by the generator's own
|
|
* tests in lib/reports/__tests__/ — here generateDimensionPnl is mocked.
|
|
*/
|
|
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
|
import { createQueuedMockSupabase } from '@/tests/helpers'
|
|
import { TOOL_SCOPE_MAP } from '@/lib/auth/api-keys'
|
|
import { generateDimensionPnl } from '@/lib/reports/dimension-pnl'
|
|
import { tools } from '../server'
|
|
|
|
vi.mock('@/lib/reports/dimension-pnl', () => ({
|
|
generateDimensionPnl: vi.fn(),
|
|
}))
|
|
|
|
const tool = tools.find((t) => t.name === 'gnubok_get_dimension_pnl')!
|
|
const mockGenerate = vi.mocked(generateDimensionPnl)
|
|
|
|
function makeReport() {
|
|
return {
|
|
dimension: { sie_dim_no: '6', name: 'Projekt' },
|
|
columns: [
|
|
{ code: 'P001', name: 'Villa Almgren takrenovering' },
|
|
{ code: null, name: null },
|
|
],
|
|
groups: [
|
|
{
|
|
class: 3,
|
|
class_label: '3 Rörelsens inkomster/intäkter',
|
|
rows: [
|
|
{ account_number: '3010', account_name: 'Försäljning', values: [1000, 250], total: 1250 },
|
|
],
|
|
subtotals: [1000, 250],
|
|
subtotal_total: 1250,
|
|
},
|
|
],
|
|
net_per_column: [1000, 250],
|
|
net_total: 1250,
|
|
period: { start: '2026-01-01', end: '2026-12-31' },
|
|
}
|
|
}
|
|
|
|
beforeEach(() => {
|
|
vi.clearAllMocks()
|
|
})
|
|
|
|
// ── Registration ─────────────────────────────────────────────────────────────
|
|
|
|
describe('gnubok_get_dimension_pnl — registration', () => {
|
|
it('is registered, read-only, and mapped to reports:read (unmapped = any key)', () => {
|
|
expect(tool).toBeDefined()
|
|
expect(tool.annotations).toEqual({
|
|
readOnlyHint: true,
|
|
destructiveHint: false,
|
|
idempotentHint: true,
|
|
openWorldHint: false,
|
|
})
|
|
expect(TOOL_SCOPE_MAP.gnubok_get_dimension_pnl).toBe('reports:read')
|
|
})
|
|
|
|
it('declares a strict inputSchema and a tight description', () => {
|
|
const input = tool.inputSchema as { additionalProperties?: boolean; required?: string[] }
|
|
expect(input.additionalProperties).toBe(false)
|
|
expect(input.required).toEqual(['sie_dim_no'])
|
|
expect(tool.description.length).toBeLessThanOrEqual(280)
|
|
})
|
|
|
|
it('mirrors the DimensionPnlReport contract in its outputSchema', () => {
|
|
const output = tool.outputSchema as { required?: string[]; properties?: Record<string, unknown> }
|
|
expect(output.required).toEqual(['dimension', 'columns', 'groups', 'net_per_column', 'net_total'])
|
|
expect(output.properties?.period).toBeDefined()
|
|
})
|
|
})
|
|
|
|
// ── Execute ──────────────────────────────────────────────────────────────────
|
|
|
|
describe('gnubok_get_dimension_pnl — execute', () => {
|
|
it('passes an explicit period + date window straight to the generator (no period lookup)', async () => {
|
|
const { supabase } = createQueuedMockSupabase()
|
|
const report = makeReport()
|
|
mockGenerate.mockResolvedValueOnce(report as never)
|
|
|
|
const result = await tool.execute(
|
|
{ sie_dim_no: '6', period_id: 'fp-1', to_date: '2026-03-31' },
|
|
'company-1',
|
|
'user-1',
|
|
supabase as never,
|
|
)
|
|
|
|
expect(mockGenerate).toHaveBeenCalledWith(supabase, 'company-1', 'fp-1', '6', {
|
|
toDate: '2026-03-31',
|
|
})
|
|
expect(result).toEqual(report)
|
|
// Explicit period_id → no fiscal_periods default lookup.
|
|
expect(supabase.from).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('defaults to the most recent fiscal period when period_id is omitted', async () => {
|
|
const { supabase, enqueue } = createQueuedMockSupabase()
|
|
enqueue({ data: { id: 'fp-latest', name: '2026' }, error: null }) // fiscal_periods lookup
|
|
mockGenerate.mockResolvedValueOnce(makeReport() as never)
|
|
|
|
await tool.execute({ sie_dim_no: '1' }, 'company-1', 'user-1', supabase as never)
|
|
|
|
expect(supabase.from).toHaveBeenCalledWith('fiscal_periods')
|
|
expect(mockGenerate).toHaveBeenCalledWith(supabase, 'company-1', 'fp-latest', '1', {
|
|
toDate: undefined,
|
|
})
|
|
})
|
|
|
|
it('errors when no fiscal period exists', async () => {
|
|
const { supabase, enqueue } = createQueuedMockSupabase()
|
|
enqueue({ data: null, error: null })
|
|
|
|
await expect(
|
|
tool.execute({ sie_dim_no: '6' }, 'company-1', 'user-1', supabase as never),
|
|
).rejects.toThrow(/No fiscal periods found/)
|
|
expect(mockGenerate).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('rejects a non-numeric sie_dim_no before touching the database', async () => {
|
|
const { supabase } = createQueuedMockSupabase()
|
|
|
|
for (const bad of ['projekt', '', '0', '6; drop']) {
|
|
await expect(
|
|
tool.execute({ sie_dim_no: bad }, 'company-1', 'user-1', supabase as never),
|
|
).rejects.toThrow(/positive SIE dimension number/)
|
|
}
|
|
expect(supabase.from).not.toHaveBeenCalled()
|
|
expect(mockGenerate).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('accepts a numeric sie_dim_no by coercing it to string (lenient hosts)', async () => {
|
|
const { supabase } = createQueuedMockSupabase()
|
|
mockGenerate.mockResolvedValueOnce(makeReport() as never)
|
|
|
|
await tool.execute({ sie_dim_no: 6, period_id: 'fp-1' }, 'company-1', 'user-1', supabase as never)
|
|
|
|
expect(mockGenerate).toHaveBeenCalledWith(supabase, 'company-1', 'fp-1', '6', {
|
|
toDate: undefined,
|
|
})
|
|
})
|
|
})
|