Files
accounted/lib/utils.ts
T
Jakob Wennberg 16fbcefbbc feat(invariants): shared format contracts + upgrade-path CI (#1364)
* feat(invariants): centralise shared format contracts, reconcile the org-number paths

The same format rules were written out independently across the codebase, and
where they disagreed the disagreement was invisible until a filing failed.

Worst case, now fixed: four Skatteverket- and Bolagsverket-bound export paths
each had their own idea of a valid organisationsnummer.

  lib/skatteverket/format.ts      strip '-' only      threw on any input with a space
  lib/salary/ku/ku10-generator.ts replace('-', '')    first hyphen only, spaces survived
  lib/salary/agi/xml-generator.ts strip non-digits    stray letters passed the length check
  lib/bokslut/ixbrl/validate      /^\d{6}-?\d{4}$/    rejected the 12-digit form, no Luhn

A company stored with a space or in 12-digit form could file AGI all year and
then fail at the arsredovisning deadline with a message that did not say why.

lib/invariants/ now owns account number, ISO date, four-digit fiscal year and
org number, each with the rationale recorded next to the rule. normalizeOrgNumber
moves here from lib/company-lookup/ and isSaneDateString from lib/utils.ts; both
old paths re-export, so no caller changes. lib/api/schemas.ts builds its
primitives on the module, so ~100 schemas inherit any correction.

The arsredovisning check-digit verdict is a warn, not an error: a wrong Luhn
digit is almost certainly a typo worth surfacing, but whether every org number
Bolagsverket accepts satisfies Luhn is a Swedish domain question we have not
verified against a primary source, and an error there blocks Skicka in. We do
not block a statutory filing on an unverified assumption.

KU10 still passes a 12-digit stored org number through unfolded. That is
pre-existing, and whether the KU10 schema wants 10 or 12 digits is not covered
by the swedish-payroll skill, so it is pinned by a test rather than changed
silently.

Guard 8 (hand-rolled-invariant) tracks the remaining 114 inline copies as a
ratchet that may only go down, same mechanism as the roundOre guard.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* test(ci): add an upgrade-path job that applies new migrations against real data

The pg-real job applies all 548 migrations to an EMPTY database. Empty means
zero rows, so a migration that adds a NOT NULL, adds a CHECK, creates a unique
index or backfills passes trivially in CI and can still fail on production,
where the rows exist. CI proved that a fresh install works; nothing proved that
an existing install upgrades.

The new pg-upgrade job: apply the schema as it stands at the merge base, seed a
small real company (three posted verifikat, balanced lines, one ore-level
amount), then apply ONLY the migrations this PR adds, then assert the data
survived (entries still posted, lines intact, ledger still balances, ore
unchanged, voucher numbers sequential). A PR with no migration no-ops.

Verified locally against supabase/postgres:15.8.1.060 rather than assumed, with
three deliberately bad migrations:

  rescale money on posted lines   empty: would pass   seeded: ERROR (immutability trigger)
  CHECK violating the ore row     empty: exit 0       seeded: exit 3
  NOT NULL on a populated column  empty: exit 0       seeded: exit 3

Base migrations are read out of the merge-base git tree, not the working tree,
so a PR that edits an already-shipped migration still gets the original applied
and the edit surfaces as a failure here.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* docs: record the invariants and upgrade-CI decisions

Two entries covering what this PR changes and, more importantly, the calls that
are not obvious from the diff: why the arsredovisning check-digit verdict is a
warning rather than an error, why KU10's 12-digit passthrough is pinned instead
of fixed, and why the ROT/RUT brf org-number schemas stay on their own rule.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* docs(test): mark the upgrade fixture as CI-only, never a production template

The fixture writes posted journal_entries and their lines directly, bypassing
the engine and the atomic commit RPC. That is the only way to hand a migration
pre-existing posted rows to break, and it is safe against a throwaway CI
database, but it reads like a sanctioned pattern to anyone who finds it later.

Says so explicitly, with the reason it is confined here (no voucher sequence to
keep gapless, no retention obligation on a database destroyed with the job) and
a pointer back to Hard Rule 2 for anything touching a real database.

Raised by the Swedish compliance review bot on #1364.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-03 16:30:14 +02:00

201 lines
8.2 KiB
TypeScript

import { clsx, type ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"
import { format as formatDateFns, parseISO, isValid } from "date-fns"
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs))
}
/**
* Shown by the date formatters when handed an Invalid Date. We fail closed:
* render a neutral placeholder rather than the raw malformed string: so a
* corrupted value is never surfaced to the UI, and never throws either. After
* the server validation + DB CHECK landed, a bad date shouldn't reach here at
* all; this is the last-resort guard.
*/
const INVALID_DATE_PLACEHOLDER = '-'
/**
* Money with a currency symbol, sv-SE grouping: `1234.5` -> `1 234,50 kr`.
*
* `currency` defaults to SEK and stays sv-SE in both locales: that is a Swedish
* accounting convention, not a UI string (.claude/rules/i18n.md), and the
* single-argument form is the correct call on the hundreds of values that ARE
* kronor (ledger amounts, KPI aggregates, salary, tax).
*
* What the default cannot know is that the number came off a record carrying
* its own currency. `formatCurrency(invoice.total)` on a 1 000 EUR invoice
* prints "1 000,00 kr", and nothing downstream can tell that apart from a real
* SEK total. So: pass `record.currency` whenever the record has one, or format
* the kronor twin (`total_sek` / `amount_sek`). Journal entry line amounts are
* always SEK already (lib/bookkeeping/ledger-line-amount.ts).
*
* scripts/checks/format-currency-sek-label.mjs fails CI on a new single-argument
* call whose value is read off a record the same file reads `.currency` from.
*/
export function formatCurrency(
amount: number,
currency?: string | null,
options?: { minimumFractionDigits?: number; maximumFractionDigits?: number },
): string {
// A `= 'SEK'` default only covers undefined. `transactions.currency` is a
// nullable column whose NULL is legacy for the 'SEK' default (see migration
// 20260726100000), yet the Transaction type declares it required, so a NULL
// reached Intl unguarded: `currency: null` throws RangeError and a single
// legacy row blanked the whole transactions list into the error boundary.
const code = currency || 'SEK'
return new Intl.NumberFormat('sv-SE', {
style: 'currency',
currency: code,
minimumFractionDigits: options?.minimumFractionDigits ?? 0,
maximumFractionDigits: options?.maximumFractionDigits ?? 2,
}).format(amount)
}
export function formatDate(date: Date | string): string {
// parseISO interprets bare 'yyyy-MM-dd' as local midnight, not UTC midnight.
// Using new Date() would shift the displayed day by one in timezones west of
// UTC for bare date strings: that's an off-by-one we don't want for
// accounting data.
const d = typeof date === 'string' ? parseISO(date) : date
// A malformed value (e.g. a 6-digit year fat-fingered into a native
// <input type="date">, stored by Postgres as year 202403) yields an Invalid
// Date, and date-fns `format` THROWS a RangeError on that. One bad row must
// never crash an entire route via the error boundary: degrade to the raw
// input instead.
if (!isValid(d)) return INVALID_DATE_PLACEHOLDER
return formatDateFns(d, 'yyyy-MM-dd')
}
/**
* True when `s` is a real, in-range calendar date in `YYYY-MM-DD` form.
*
* The shape check (4-digit year) is what stops the native <input type="date">
* 6-digit-year corruption ('202403-02-05'); the parse + range check also
* rejects impossible dates (2024-13-40) and absurd years. The ONE authoritative
* date rule shared by the client form and the server-side
* CreateTransactionSchema, so the two validation layers can never drift.
*
* Implementation lives in `lib/invariants/iso-date.ts` alongside the other
* shared format contracts; re-exported here because this is where callers have
* always imported it from.
*/
export { isSaneDateString } from '@/lib/invariants/iso-date'
/**
* Date + time for audit / metadata displays: `2026-05-11 14:30`. ISO-ordered
* and locale-independent (sortable, unambiguous), matching `formatDate`'s
* accounting convention. Use for "created at" / "last synced" timestamps. For
* date-only accounting values use `formatDate`; for friendly long-form metadata
* dates use `formatDateLong`.
*/
export function formatDateTime(date: Date | string): string {
const d = typeof date === 'string' ? parseISO(date) : date
if (!isValid(d)) return INVALID_DATE_PLACEHOLDER
return formatDateFns(d, 'yyyy-MM-dd HH:mm')
}
/**
* Bare amount with sv-SE grouping and exactly two decimals, no currency symbol:
* `1234.5` → `1 234,50`. Use in table cells / inputs where the column header or
* surrounding context already conveys "kr" and `formatCurrency`'s symbol would
* be noise. Stays sv-SE in both locales (Swedish accounting convention, not a
* UI string): same rule as `formatCurrency`. When you need the SEK symbol, use
* `formatCurrency`.
*/
export function formatAmount(amount: number): string {
return new Intl.NumberFormat('sv-SE', {
minimumFractionDigits: 2,
maximumFractionDigits: 2,
}).format(amount)
}
/**
* Whole-krona amount, no decimals, sv-SE grouping: `1234.56` → `1 235`. For
* compact KPI tiles and rounded summaries.
*
* NOTE: not for statutory output. INK2 / NE-bilaga / SRU require *truncation*
* (`Math.trunc`) per SFL 22:1, not rounding: use the dedicated SRU formatter
* for those surfaces.
*/
export function formatWholeKr(amount: number): string {
return new Intl.NumberFormat('sv-SE', {
minimumFractionDigits: 0,
maximumFractionDigits: 0,
}).format(amount)
}
/**
* Long-form date for metadata/audit contexts (e.g. "9 maj 2026" / "May 9, 2026").
* Use formatDate for transaction/voucher/invoice dates that need to align in tables.
*
* The locale arg is the UI language ('sv' | 'en'); default 'sv' keeps existing
* server-side callers (logs, audit) Swedish without churn. For client UI use
* the useFormat() hook which pulls the active locale from next-intl.
*/
export function formatDateLong(date: Date | string, locale: string = 'sv'): string {
const d = typeof date === 'string' ? parseISO(date) : date
if (!isValid(d)) return INVALID_DATE_PLACEHOLDER
const intlLocale = locale === 'en' ? 'en-US' : 'sv-SE'
return d.toLocaleDateString(intlLocale, {
day: 'numeric',
month: 'short',
year: 'numeric',
})
}
/**
* Today's date in Europe/Stockholm, labelled for the bookkeeping agent's system
* prompt: e.g. "2026-05-27 (onsdag)".
*
* Date granularity (no clock time) is deliberate: the agent system prompt is
* cached (cache_control ttl=1h) and this string sits inside the cached prefix,
* so a full timestamp would bust the cache on every request while the value
* actually changes at most once a day. Stockholm time zone: not the server's
* UTC: so "idag" is right for Swedish users near midnight, where a UTC date can
* read a day behind.
*/
export function swedishToday(now: Date = new Date()): string {
const date = new Intl.DateTimeFormat('sv-SE', {
timeZone: 'Europe/Stockholm',
year: 'numeric',
month: '2-digit',
day: '2-digit',
}).format(now)
const weekday = new Intl.DateTimeFormat('sv-SE', {
timeZone: 'Europe/Stockholm',
weekday: 'long',
}).format(now)
return `${date} (${weekday})`
}
export function formatOrgNumber(orgNumber: string): string {
// Format Swedish org number: XXXXXX-XXXX
const cleaned = orgNumber.replace(/\D/g, '')
if (cleaned.length === 10) {
return `${cleaned.slice(0, 6)}-${cleaned.slice(6)}`
}
return orgNumber
}
export function getCompanyDisplayName(settings: { company_name?: string | null }): string {
return settings.company_name?.trim() || ''
}
export function getCompanyPrimaryName(settings: { company_name?: string | null }): string {
return settings.company_name?.trim() || ''
}
export function generateInvoiceNumber(): string {
const year = new Date().getFullYear()
const random = Math.floor(Math.random() * 10000).toString().padStart(4, '0')
return `${year}-${random}`
}
// Shared FX-rate validator: keeps UI, RPC (>= 100000 / <= 0), and the
// invoices/supplier_invoices CHECK constraints in sync. Single source
// of truth for the 0 < rate < 100000 bound.
export function isValidExchangeRate(rate: number | null | undefined): rate is number {
return rate != null && rate > 0 && rate < 100000
}