diff --git a/CHANGES.md b/CHANGES.md index 7539f2e..155d501 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,7 @@ # Changes ## Unreleased +- Billing: CSV export of a tenant's invoices at `GET /billing/invoices.csv?tenant=&from=&to=¤cy=`. ## 3.2.0 - Returns: partial refunds. diff --git a/src/modules/billing/formatters.js b/src/modules/billing/formatters.js index f64ce28..872b710 100644 --- a/src/modules/billing/formatters.js +++ b/src/modules/billing/formatters.js @@ -1,5 +1,23 @@ import { formatCents } from '../../lib/money.js'; +import { isoDate } from '../../lib/time.js'; export function formatInvoice(inv) { return { ...inv, total: formatCents(inv.total) }; } + +export const INVOICE_CSV_COLUMNS = ['id', 'date', 'customer', 'subtotal', 'discount', 'tax', 'total', 'currency']; + +// RFC 4180: quote fields containing a comma, double quote, CR or LF; double inner quotes. +export function csvField(value) { + const s = value === null || value === undefined ? '' : String(value); + return /[",\r\n]/.test(s) ? `"${s.replace(/"/g, '""')}"` : s; +} + +export function formatInvoicesCsv(invoices) { + const rows = invoices.map((i) => [ + i.id, isoDate(i.date), i.customer, + formatCents(i.subtotal), formatCents(i.discount), formatCents(i.tax), formatCents(i.total), + i.currency, + ]); + return [INVOICE_CSV_COLUMNS, ...rows].map((r) => r.map(csvField).join(',')).join('\n') + '\n'; +} 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..17485a7 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; + const d = new Date(`${v}T00:00:00Z`); + if (!/^\d{4}-\d{2}-\d{2}$/.test(v) || Number.isNaN(d.getTime()) || d.toISOString().slice(0, 10) !== v) { + throw new ValidationError(`${key} must be a date (YYYY-MM-DD)`); + } + return v; +} + +// Invoices for the CSV export: tenant required, from/to optional and inclusive, +// sorted by date then id. 404 only when the tenant has no invoices at all. +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('invoices for tenant ' + tenant); + const cmp = (a, b) => (a < b ? -1 : a > b ? 1 : 0); + 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..6df3c19 100644 --- a/tests/billing.test.js +++ b/tests/billing.test.js @@ -1,6 +1,7 @@ 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, csvField } from '../src/modules/billing/index.js'; +import { createApp } from '../src/server.js'; test('billing: prices lines with discount and tax', () => { const p = priceLines([{ unitCents: 1000, qty: 2 }], { discountCode: 'save10', region: 'US' }); @@ -17,3 +18,57 @@ test('billing: invoices', () => { assert.equal(listInvoices({ tenantId: 'globex' }).length, 1); assert.throws(() => getInvoice('inv_9999'), /not found/); }); + +const HEADER = 'id,date,customer,subtotal,discount,tax,total,currency'; +const csv = (qs) => createApp().handle('GET', '/billing/invoices.csv' + qs); +const ids = (body) => body.trimEnd().split('\n').slice(1).map((l) => l.split(',')[0]); + +test('billing csv: full export, sorted, quoted, money formatted', async () => { + const r = await csv('?tenant=acme'); + assert.equal(r.status, 200); + assert.equal(r.headers['content-type'], 'text/csv'); + assert.equal(r.body, [ + HEADER, + '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') + '\n'); +}); + +test('billing csv: from/to are optional and inclusive', async () => { + assert.deepEqual(ids((await csv('?tenant=acme&from=2026-09-15&to=2026-09-15')).body), ['inv_0002', 'inv_0003']); + assert.deepEqual(ids((await csv('?tenant=acme&from=2026-09-15')).body), ['inv_0002', 'inv_0003', 'inv_0004']); + assert.deepEqual(ids((await csv('?tenant=acme&to=2026-09-02')).body), ['inv_0006', 'inv_0001']); +}); + +test('billing csv: optional currency filter', async () => { + assert.deepEqual(ids((await csv('?tenant=acme¤cy=EUR')).body), ['inv_0003']); + assert.deepEqual(ids((await csv('?tenant=acme¤cy=USD&from=2026-09-15')).body), ['inv_0002', 'inv_0004']); + assert.equal((await csv('?tenant=acme¤cy=GBP')).body, HEADER + '\n'); + assert.equal((await csv('?tenant=acme¤cy=JPY')).status, 400); + assert.equal((await csv('?tenant=acme¤cy=usd')).status, 400); + assert.equal((await csv('?tenant=acme¤cy=')).status, 400); +}); + +test('billing csv: header only when nothing matches', async () => { + const r = await csv('?tenant=acme&from=2030-01-01'); + assert.equal(r.status, 200); + assert.equal(r.body, HEADER + '\n'); +}); + +test('billing csv: errors', async () => { + assert.equal((await csv('')).status, 400); + assert.equal((await csv('?tenant=')).status, 400); + assert.equal((await csv('?tenant=nobody')).status, 404); + assert.equal((await csv('?tenant=acme&from=garbage')).status, 400); + assert.equal((await csv('?tenant=acme&to=2026-02-30')).status, 400); +}); + +test('billing csv: field quoting', () => { + assert.equal(csvField('plain'), 'plain'); + assert.equal(csvField('a\nb'), '"a\nb"'); + assert.equal(csvField('a\r\nb'), '"a\r\nb"'); + assert.equal(csvField('say "hi"'), '"say ""hi"""'); +});