Files
accounted/components/common/FiscalYearSelector.tsx
T
Jakob Wennberg 9a56b7aff9 perf(bookkeeping): fiscal-year pickers and cash accounts read the session cache (#1934)
First consumer migration onto lib/reference-data. FyPicker and
FiscalYearSelector (14 consumer surfaces, 47 fiscal-period fetch sites
before this series) now read useFiscalPeriods(); with the layout seed the
restore of the persisted scope runs in the first effect tick and onReady
fires on mount instead of after a round trip. Their restore rules are
extracted into a pure resolveInitialFiscalScope() (lib/reference-data/
fiscal-scope.ts) so the two pickers cannot drift apart again, and the
restore runs once per company load, not on every background revalidation.

- /reports: the static catalog renders immediately; only the "no fiscal
  year" empty state waits for the picker (previously six skeleton bars
  until /api/bookkeeping/fiscal-periods resolved).
- JournalEntryList (/bookkeeping): resolves its initial scope from the
  cached list instead of its own fetch; the saved-scope shortcut still
  unblocks the entries fetch first when nothing is cached, and resolution
  is guarded to once per company so a revalidation can never snap a
  deep-link "all years" visit back to the stored year.
- /transactions: the account chooser reads useCashAccounts({ enabledOnly })
  (seeded) instead of fetching /api/cash-accounts on every visit; the bank
  sync button invalidates that entry after a sync.
- STORAGE_KEY_PREFIX / ALL_YEARS_VALUE move to a dependency-free
  fiscal-year-storage.ts (re-exported from FiscalYearSelector) so lib/ code
  can import them without a React component.

raw-reference-fetch ratchet: 55 -> 51 files.

Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-26 14:24:24 +02:00

183 lines
6.8 KiB
TypeScript

'use client'
import { useEffect, useMemo, useRef } from 'react'
import { useTranslations } from 'next-intl'
import { Label } from '@/components/ui/label'
import { Badge } from '@/components/ui/badge'
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue,
} from '@/components/ui/select'
import { Lock } from 'lucide-react'
import { useCompany } from '@/contexts/CompanyContext'
import { STORAGE_KEY_PREFIX, ALL_YEARS_VALUE } from '@/components/common/fiscal-year-storage'
import { useFiscalPeriods } from '@/lib/reference-data/hooks'
import { prepareFiscalPeriods, resolveInitialFiscalScope } from '@/lib/reference-data/fiscal-scope'
import type { FiscalPeriod } from '@/types'
// Re-exported so other surfaces (e.g. JournalEntryList's filter dialog) can
// read and write the same persisted selection without duplicating the magic
// string. The values live in fiscal-year-storage.ts (dependency-free).
export { STORAGE_KEY_PREFIX, ALL_YEARS_VALUE }
interface Props {
/**
* Current selection. `null` means "all years": no filter applied.
*/
value: string | null
/**
* Called with the selected period id (or null for "all years"). The second
* arg is the matching FiscalPeriod object so callers can read period_start
* / period_end without an extra fetch.
*/
onChange: (periodId: string | null, period?: FiscalPeriod | null) => void
/**
* If true, include an "Alla räkenskapsår" option that clears the filter.
* Pages that require a specific period (e.g. Reports) should pass false.
*/
includeAllOption?: boolean
/**
* Optional label above the select. Pass null to render without a label.
*/
label?: string | null
/**
* If true, only show periods whose start date is on or before today.
* Matches the Reports-page filter.
*/
hideFuturePeriods?: boolean
/**
* Called once after the initial period fetch completes. Useful for callers
* that want to suppress a skeleton until the selector is ready.
*/
onReady?: () => void
className?: string
/** Server-loaded periods for the first render, scoped to initialCompanyId. */
initialPeriods?: FiscalPeriod[]
initialCompanyId?: string | null
}
/**
* Shared fiscal-year (räkenskapsår) selector.
*
* Loads periods for the active company, persists the last selection per
* company in localStorage, and renders the same Select used elsewhere in the
* app so the UX is consistent across Bookkeeping, Reports, etc.
*
* The component is controlled: the caller owns the selected period id and
* threads it into whichever queries need scoping.
*/
export function FiscalYearSelector({
value,
onChange,
includeAllOption = true,
label,
hideFuturePeriods = false,
onReady,
className,
initialPeriods,
initialCompanyId,
}: Props) {
const { company } = useCompany()
const t = useTranslations('fiscal_year')
// Session-cached and seeded by the dashboard layout (see FyPicker): the
// restore runs in the first effect tick on a normal visit, no round trip.
const { periods: cachedPeriods, isLoading } = useFiscalPeriods()
const canUseInitialPeriods = initialCompanyId === company?.id && initialPeriods !== undefined
const periods = useMemo(
() => prepareFiscalPeriods(canUseInitialPeriods ? initialPeriods : cachedPeriods, hideFuturePeriods),
[canUseInitialPeriods, initialPeriods, cachedPeriods, hideFuturePeriods],
)
const loaded = canUseInitialPeriods || !isLoading
const restoredForRef = useRef<string | null>(null)
const effectiveLabel = label === null ? null : (label ?? t('label'))
useEffect(() => {
if (!company?.id) {
// Fire onReady so consumers don't stall in a loading state while the
// company context hydrates. The effect re-runs once company.id arrives.
onReady?.()
return
}
if (!loaded || restoredForRef.current === company.id) return
restoredForRef.current = company.id
// Restore last selection (only if caller hasn't already set a value).
if (value === null && typeof window !== 'undefined') {
const stored = window.localStorage.getItem(STORAGE_KEY_PREFIX + company.id)
const pick = resolveInitialFiscalScope(periods, stored, { includeAllOption })
if (pick) onChange(pick.periodId, pick.period)
}
onReady?.()
// onReady/onChange are lifecycle callbacks that fire once per load, not
// again when the parent re-creates them. `value` is read once at restore.
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [company?.id, loaded, periods])
const handleChange = (next: string) => {
const nextPeriodId = next === ALL_YEARS_VALUE ? null : next
if (company?.id && typeof window !== 'undefined') {
window.localStorage.setItem(
STORAGE_KEY_PREFIX + company.id,
nextPeriodId ?? ALL_YEARS_VALUE,
)
}
const nextPeriod = nextPeriodId ? periods.find((p) => p.id === nextPeriodId) ?? null : null
onChange(nextPeriodId, nextPeriod)
}
const selectValue = value ?? (includeAllOption ? ALL_YEARS_VALUE : '')
// Surface lock status for the currently-selected period. Browsing locked
// years is read-only and allowed (BFL 7:1 requires access to historical
// data), but the user should see clearly that they're looking at a
// closed/locked year so the absence of write controls feels intentional.
const selectedPeriod = value ? periods.find((p) => p.id === value) : null
const lockState: 'locked' | 'closed' | null = selectedPeriod?.locked_at
? 'locked'
: selectedPeriod?.is_closed
? 'closed'
: null
return (
<div className={className}>
{effectiveLabel && <Label>{effectiveLabel}</Label>}
<div className={`flex items-center gap-2 ${effectiveLabel ? 'mt-1' : ''}`}>
<Select
value={selectValue}
onValueChange={handleChange}
disabled={!loaded || periods.length === 0}
>
<SelectTrigger className="w-full sm:w-[280px]">
<SelectValue placeholder={loaded ? t('placeholder') : t('loading')} />
</SelectTrigger>
<SelectContent>
{includeAllOption && (
<SelectItem value={ALL_YEARS_VALUE}>{t('all_years')}</SelectItem>
)}
{periods.map((p) => (
<SelectItem key={p.id} value={p.id}>
{p.name} ({p.period_start} till {p.period_end})
{p.locked_at ? t('suffix_locked') : p.is_closed ? t('suffix_closed') : ''}
</SelectItem>
))}
</SelectContent>
</Select>
{lockState && (
<Badge
variant="outline"
className="gap-1 text-xs font-normal shrink-0"
title={lockState === 'locked' ? t('tooltip_locked') : t('tooltip_closed')}
>
<Lock className="h-3 w-3" />
{lockState === 'locked' ? t('badge_locked') : t('badge_closed')}
</Badge>
)}
</div>
</div>
)
}