pr_01m47d24b0e6n91zwymwxg0vpx/apps/sudo/app/lib/ledgers.ts

137 lines5,587 bytesCodeBlame
1/**
2 * The Invoices and Audit log pages' arithmetic and wording: filters read
3 * from the address, totals, links from billing's account ids to sudo's
4 * pages, and paging. No Workers imports, so it can be tested under Node.
5 */
6import type { AdminAction, InvoiceSummary } from "@g1t/contracts";
7
8// --- Invoices -----------------------------------------------------------------
9
10export const INVOICE_STATUSES = ["open", "overdue", "failed", "paid", "void"] as const;
11export type InvoiceStatusFilter = (typeof INVOICE_STATUSES)[number];
12
13export function parseInvoiceStatus(value: string | null): InvoiceStatusFilter | null {
14 return INVOICE_STATUSES.find((status) => status === value) ?? null;
15}
16
17/** A month as `<input type="month">` sends it: `2026-10`. */
18export function parseMonth(value: string | null): string | null {
19 if (!value || !/^\d{4}-(0[1-9]|1[0-2])$/.test(value)) return null;
20 return value;
21}
22
23/** Not paid and not void: what is still owed. */
24export function isOutstanding(status: string): boolean {
25 return status === "open" || status === "overdue" || status === "failed";
26}
27
28export type InvoiceTotals = { count: number; amountMicros: number; paidMicros: number; outstandingMicros: number; outstanding: number };
29
30export function invoiceTotals(invoices: Pick<InvoiceSummary, "amountMicros" | "status">[]): InvoiceTotals {
31 const totals: InvoiceTotals = { count: invoices.length, amountMicros: 0, paidMicros: 0, outstandingMicros: 0, outstanding: 0 };
32 for (const invoice of invoices) {
33 if (invoice.status === "void") continue;
34 totals.amountMicros += invoice.amountMicros;
35 if (invoice.status === "paid") totals.paidMicros += invoice.amountMicros;
36 if (isOutstanding(invoice.status)) {
37 totals.outstandingMicros += invoice.amountMicros;
38 totals.outstanding += 1;
39 }
40 }
41 return totals;
42}
43
44/** A link to the invoices list with these filters; the defaults are left out. */
45export function invoicesHref({ status, month }: { status?: string | null; month?: string | null }): string {
46 const params = new URLSearchParams();
47 if (status) params.set("status", status);
48 if (month) params.set("month", month);
49 const query = params.toString();
50 return query ? `/invoices?${query}` : "/invoices";
51}
52
53/** Only https links to Stripe are followed. */
54export function safeUrl(url: string | null | undefined): string | null {
55 return url && url.startsWith("https://") ? url : null;
56}
57
58// --- Accounts -------------------------------------------------------------------
59
60const SLUG = /^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$/;
61const ENTERPRISE = /^ent_[a-z0-9_-]{1,80}$/;
62
63/**
64 * The sudo page for one of billing's account ids: `ws_<slug>` is the
65 * workspace's, `ent_…` the enterprise's. Null for anything else, such as
66 * Stripe's own lines.
67 */
68export function accountPath(account: string | null | undefined): string | null {
69 const id = (account ?? "").trim().toLowerCase();
70 if (ENTERPRISE.test(id)) return `/enterprises/${encodeURIComponent(id)}`;
71 if (id.startsWith("ws_") && SLUG.test(id.slice(3))) return `/workspaces/${encodeURIComponent(id.slice(3))}`;
72 return null;
73}
74
75/** What to call an account: a workspace by its slug, an enterprise by its name when known. */
76export function accountName(account: string, names: Map<string, string> = new Map()): string {
77 if (names.has(account)) return names.get(account) as string;
78 if (account.startsWith("ws_")) return account.slice(3);
79 if (ENTERPRISE.test(account)) return "an enterprise";
80 return account;
81}
82
83// --- Audit ----------------------------------------------------------------------
84
85/** Each kind of change, as staff read it. */
86export const AUDIT_ACTIONS: Record<string, string> = {
87 terms: "Terms changed",
88 create: "Enterprise created",
89 attach: "Workspace added",
90 detach: "Workspace removed",
91 credit: "Credit issued",
92 billing_link: "Billing link made",
93 billing_email: "Invoice email set",
94 invoice: "Invoice sent",
95 dispute: "Payment disputed",
96 sales: "Sales record changed",
97 note: "Sales note added",
98 stripe: "From Stripe",
99 webhook: "Stripe webhook registered",
100};
101
102export function actionLabel(action: string): string {
103 return AUDIT_ACTIONS[action] ?? action.replace(/_/g, " ").replace(/^./, (char) => char.toUpperCase());
104}
105
106export const AUDIT_PAGE = 100;
107
108/** Where the next, older page starts: after the last line, if this page was full. */
109export function olderBefore(actions: Pick<AdminAction, "createdAt">[], page = AUDIT_PAGE): string | null {
110 return actions.length >= page ? (actions.at(-1)?.createdAt ?? null) : null;
111}
112
113/** A staff email filter: lowercased, at most one address's length. */
114export function parseBy(value: string | null): string | null {
115 const by = (value ?? "").trim().toLowerCase();
116 return by && by.length <= 254 && !/\s/.test(by) ? by : null;
117}
118
119export function parseAction(value: string | null): string | null {
120 const action = (value ?? "").trim();
121 return /^[a-z_]{1,40}$/.test(action) ? action : null;
122}
123
124/** An RFC 3339 time to page from. */
125export function parseBefore(value: string | null): string | null {
126 if (!value || value.length > 40 || Number.isNaN(new Date(value).getTime())) return null;
127 return value;
128}
129
130export function auditHref({ by, action, before }: { by?: string | null; action?: string | null; before?: string | null }): string {
131 const params = new URLSearchParams();
132 if (by) params.set("by", by);
133 if (action) params.set("action", action);
134 if (before) params.set("before", before);
135 const query = params.toString();
136 return query ? `/audit?${query}` : "/audit";
137}