diff --git a/CHANGES.md b/CHANGES.md index 7539f2e..4a5c9ef 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,7 @@ # Changes ## Unreleased +- Billing: CSV invoice export (GET /billing/invoices.csv), filterable by tenant, date range and currency. ## 3.2.0 - Returns: partial refunds. diff --git a/src/lib/csv.js b/src/lib/csv.js new file mode 100644 index 0000000..5792911 --- /dev/null +++ b/src/lib/csv.js @@ -0,0 +1,9 @@ +// RFC 4180 field quoting. Lines end with "\n", including the last one. +export function csvField(v) { + const s = String(v ?? ''); + return /[",\r\n]/.test(s) ? `"${s.replace(/"/g, '""')}"` : s; +} + +export function toCsv(header, rows) { + return [header, ...rows].map((r) => r.map(csvField).join(',')).join('\n') + '\n'; +} diff --git a/src/modules/billing/formatters.js b/src/modules/billing/formatters.js index f64ce28..e986a90 100644 --- a/src/modules/billing/formatters.js +++ b/src/modules/billing/formatters.js @@ -1,5 +1,16 @@ import { formatCents } from '../../lib/money.js'; +import { toCsv } from '../../lib/csv.js'; export function formatInvoice(inv) { return { ...inv, total: formatCents(inv.total) }; } + +const CSV_HEADER = ['id', 'date', 'customer', 'subtotal', 'discount', 'tax', 'total', 'currency']; + +export function formatInvoicesCsv(invoices) { + return toCsv(CSV_HEADER, invoices.map((i) => [ + i.id, i.date, i.customer, + formatCents(i.subtotal), formatCents(i.discount), formatCents(i.tax), formatCents(i.total), + i.currency, + ])); +} diff --git a/src/modules/billing/routes.js b/src/modules/billing/routes.js index 0ac3d5c..e57b9ef 100644 --- a/src/modules/billing/routes.js +++ b/src/modules/billing/routes.js @@ -1,8 +1,9 @@ -import { ok, wrap } from '../../lib/http.js'; -import { getInvoice, listInvoices } from './service.js'; -import { formatInvoice } from './formatters.js'; +import { ok, text, wrap } from '../../lib/http.js'; +import { exportInvoices, getInvoice, listInvoices } from './service.js'; +import { formatInvoice, formatInvoicesCsv } from './formatters.js'; export const routes = [ ['GET', '/billing/invoices', wrap(async (req) => ok(listInvoices(req.query).map(formatInvoice)))], + ['GET', '/billing/invoices.csv', wrap(async (req) => text(formatInvoicesCsv(exportInvoices(req.query)), 'text/csv'))], ['GET', '/billing/invoices/:id', wrap(async (req) => ok(formatInvoice(getInvoice(req.params.id))))], ]; diff --git a/src/modules/billing/service.js b/src/modules/billing/service.js index d84492f..73d9ca4 100644 --- a/src/modules/billing/service.js +++ b/src/modules/billing/service.js @@ -1,4 +1,7 @@ -import { NotFoundError } from '../../lib/errors.js'; +import { NotFoundError, ValidationError } from '../../lib/errors.js'; +import { requireString } from '../../lib/validate.js'; +import { inRange } from '../../lib/time.js'; +import { validateCurrency } from './validators.js'; import { discountFor } from './discounts.js'; import { taxFor } from './tax.js'; import { TAX_REGION } from './constants.js'; @@ -21,3 +24,28 @@ export function getInvoice(id) { export function listInvoices({ tenantId } = {}) { return allInvoices().filter((i) => !tenantId || i.tenantId === tenantId); } + +function optionalDate(query, key) { + const v = query?.[key]; + if (v === undefined || v === '') return undefined; + if (!/^\d{4}-\d{2}-\d{2}$/.test(v) || Number.isNaN(Date.parse(v)) || new Date(v).toISOString().slice(0, 10) !== v) { + throw new ValidationError(`${key} must be a date in YYYY-MM-DD format`); + } + return v; +} + +const cmp = (a, b) => (a < b ? -1 : a > b ? 1 : 0); + +// Invoices for the `tenant` query param, optionally limited to an inclusive from/to range, +// sorted by date then id. A tenant with no invoices at all is a 404. +export function exportInvoices(query = {}) { + const tenant = requireString(query, 'tenant'); + const from = optionalDate(query, 'from'); + const to = optionalDate(query, 'to'); + const currency = query.currency === undefined ? undefined : validateCurrency(query); + const all = listInvoices({ tenantId: tenant }); + if (all.length === 0) throw new NotFoundError('tenant ' + tenant); + return all + .filter((i) => inRange(i.date, from, to) && (!currency || i.currency === currency)) + .sort((a, b) => cmp(a.date, b.date) || cmp(a.id, b.id)); +} diff --git a/tests/billing.test.js b/tests/billing.test.js index 445b393..83386b2 100644 --- a/tests/billing.test.js +++ b/tests/billing.test.js @@ -1,6 +1,6 @@ import { test } from 'node:test'; import assert from 'node:assert/strict'; -import { priceLines, getInvoice, listInvoices, discountFor } from '../src/modules/billing/index.js'; +import { priceLines, getInvoice, listInvoices, discountFor, exportInvoices } from '../src/modules/billing/index.js'; test('billing: prices lines with discount and tax', () => { const p = priceLines([{ unitCents: 1000, qty: 2 }], { discountCode: 'save10', region: 'US' }); @@ -17,3 +17,19 @@ test('billing: invoices', () => { assert.equal(listInvoices({ tenantId: 'globex' }).length, 1); assert.throws(() => getInvoice('inv_9999'), /not found/); }); + +test('billing: exportInvoices sorts, filters inclusively and distinguishes 404/400', () => { + assert.deepEqual(exportInvoices({ tenant: 'acme' }).map((i) => i.id), + ['inv_0006', 'inv_0001', 'inv_0002', 'inv_0003', 'inv_0004']); + assert.deepEqual(exportInvoices({ tenant: 'acme', from: '2026-09-15', to: '2026-10-01' }).map((i) => i.id), + ['inv_0002', 'inv_0003', 'inv_0004']); + assert.deepEqual(exportInvoices({ tenant: 'acme', from: '2030-01-01' }), []); + assert.deepEqual(exportInvoices({ tenant: 'acme', currency: 'EUR' }).map((i) => i.id), ['inv_0003']); + assert.deepEqual(exportInvoices({ tenant: 'acme', currency: 'GBP' }), []); + assert.throws(() => exportInvoices({ tenant: 'acme', currency: 'JPY' }), /currency must be one of/); + assert.throws(() => exportInvoices({ tenant: 'acme', currency: '' }), /currency must be one of/); + assert.throws(() => exportInvoices({ tenant: 'nope' }), /not found/); + assert.throws(() => exportInvoices({}), /tenant is required/); + assert.throws(() => exportInvoices({ tenant: 'acme', from: 'garbage' }), /YYYY-MM-DD/); + assert.throws(() => exportInvoices({ tenant: 'acme', to: '2026-02-31' }), /YYYY-MM-DD/); +}); diff --git a/tests/lib.test.js b/tests/lib.test.js index a03e86e..1cd0f3b 100644 --- a/tests/lib.test.js +++ b/tests/lib.test.js @@ -2,6 +2,16 @@ import { test } from 'node:test'; import assert from 'node:assert/strict'; import { formatCents, percentOf } from '../src/lib/money.js'; import { inRange, isoDate } from '../src/lib/time.js'; +import { csvField, toCsv } from '../src/lib/csv.js'; + +test('csv: quotes fields per RFC 4180 and ends with a newline', () => { + assert.equal(csvField('plain'), 'plain'); + assert.equal(csvField('a,b'), '"a,b"'); + assert.equal(csvField('say "hi"'), '"say ""hi"""'); + assert.equal(csvField('a\nb'), '"a\nb"'); + assert.equal(toCsv(['x', 'y'], []), 'x,y\n'); + assert.equal(toCsv(['x', 'y'], [['1', 'a,b']]), 'x,y\n1,"a,b"\n'); +}); test('lib: money', () => { assert.equal(formatCents(105), '1.05'); diff --git a/tests/server.test.js b/tests/server.test.js index e836eaa..e57f3aa 100644 --- a/tests/server.test.js +++ b/tests/server.test.js @@ -17,3 +17,29 @@ test('server: invoice route and 404s', async () => { assert.equal((await app.handle('GET', '/billing/invoices/nope')).status, 404); assert.equal((await app.handle('GET', '/nothing')).status, 404); }); + +test('server: invoices.csv export', async () => { + const app = createApp(); + const r = await app.handle('GET', '/billing/invoices.csv?tenant=acme'); + assert.equal(r.status, 200); + assert.equal(r.headers['content-type'], 'text/csv'); + assert.equal(r.body, [ + 'id,date,customer,subtotal,discount,tax,total,currency', + 'inv_0006,2026-08-31,Blue Fern Ltd,30.00,0.00,2.10,32.10,USD', + 'inv_0001,2026-09-02,Blue Fern Ltd,120.00,12.00,7.56,115.56,USD', + 'inv_0002,2026-09-15,"Smith, Jones & Co",49.99,0.00,3.50,53.49,USD', + 'inv_0003,2026-09-15,"The ""Quick"" Shop",200.00,5.00,39.00,234.00,EUR', + 'inv_0004,2026-10-01,Ortega Freight,1.05,0.00,0.07,1.12,USD', + '', + ].join('\n')); + const empty = await app.handle('GET', '/billing/invoices.csv?tenant=acme&from=2030-01-01'); + assert.equal(empty.status, 200); + assert.equal(empty.body, 'id,date,customer,subtotal,discount,tax,total,currency\n'); + const eur = await app.handle('GET', '/billing/invoices.csv?tenant=acme¤cy=EUR'); + assert.equal(eur.body.trimEnd().split('\n').length, 2); + assert.match(eur.body, /inv_0003/); + assert.equal((await app.handle('GET', '/billing/invoices.csv?tenant=acme¤cy=JPY')).status, 400); + assert.equal((await app.handle('GET', '/billing/invoices.csv')).status, 400); + assert.equal((await app.handle('GET', '/billing/invoices.csv?tenant=nope')).status, 404); + assert.equal((await app.handle('GET', '/billing/invoices.csv?tenant=acme&to=bad')).status, 400); +});