Skip to content

g1t/apps/sudo/app/lib/review.ts

54 lines2,987 bytesCodeBlame
1/**
2 * What a billing form posts back: an error for one section, a change to
3 * confirm, or a result to show once (a Stripe billing link, an invoice).
4 * Shared by the workspace and enterprise pages.
5 */
6import type { BillingLink, EnterpriseInvoice, Terms } from "@g1t/contracts";
7
8export type Review =
9 | { intent: "terms"; before: Terms; after: Terms; fields: Record<string, string> }
10 | { intent: "attach"; workspace: string; targetName: string; fields: Record<string, string> }
11 | { intent: "detach"; workspace: string; from: string; fields: Record<string, string> }
12 | { intent: "billing-link"; workspace: string; fields: Record<string, string> }
13 | { intent: "billing-email"; name: string; before: string | null; after: string; fields: Record<string, string> }
14 | { intent: "invoice"; name: string; email: string | null; workspaces: number; fields: Record<string, string> };
15
16export type ActionData =
17 | { error: string; section: string; values?: Record<string, string> }
18 | { review: Review }
19 | { link: BillingLink; workspace: string }
20 | { invoice: EnterpriseInvoice };
21
22export type SectionError = { error: string; values?: Record<string, string> } | null;
23
24/** The flash messages a change redirects back with (`?done=`). */
25export const DONE: Record<string, string> = {
26 terms: "Terms saved. They apply to charges from now on.",
27 allowances: "Plan, pools and caps saved. They apply from now on.",
28 attach: "Workspace moved onto the enterprise.",
29 detach: "Workspace moved off the enterprise. It pays for itself again.",
30 credit: "Credit given. It is on the balance and the statement, and the owners were emailed.",
31 revoked: "What was left of the credit was taken back. It is on the statement and in the audit log.",
32 reset: "Billing reset. The workspace starts again as a new customer, and the costs analysis ran again, so every figure is fresh.",
33 "reset-stale": "Billing reset. The workspace starts again as a new customer; the costs analysis did not finish, so press Run the analysis now on Costs & margin.",
34 created: "Enterprise created.",
35 "billing-email": "Saved where the enterprise's invoices go.",
36 "billing-address": "Billing address saved on its Stripe customer. Its invoices are taxed from it.",
37 sales: "Sales record saved.",
38 note: "Note added.",
39 payment: "Payment recorded. It is on the workspace's statement and counts toward its limit.",
40 approved: "Approved. The owner is told in the app and by email.",
41 declined: "Declined. The owner is told why, in the app and by email.",
42 goodwill: "Goodwill credit given. It is on the statement and in the audit log.",
43};
44
45/** The `?done=` key, if it is one sudo knows. */
46export function doneKey(url: string): string | null {
47 const done = new URL(url).searchParams.get("done");
48 return done && DONE[done] ? done : null;
49}
50
51export function doneMessage(url: string): string | null {
52 const done = new URL(url).searchParams.get("done");
53 return done && DONE[done] ? DONE[done] : null;
54}