Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Format amount and earnings in commissions export (#3722)

Pedro Ladeira343ec5f0d592
diff --git a/apps/web/lib/analytics/events-export-helpers.ts b/apps/web/lib/analytics/events-export-helpers.ts
index e17812463e..45a303b353 100644
--- a/apps/web/lib/analytics/events-export-helpers.ts
+++ b/apps/web/lib/analytics/events-export-helpers.ts
@@ -1,3 +1,4 @@
+import { formatMoneyCentsForExport } from "@/lib/api/utils/format-money-cents-for-export";
import { ClickEvent, LeadEvent, SaleEvent } from "@/lib/types";
import { COUNTRIES } from "@dub/utils";
@@ -28,6 +29,12 @@ export const eventsExportColumnAccessors = {
r.customer.name + (r.customer.email ? ` <${r.customer.email}>` : ""),
invoiceId: (r: Row) => ("sale" in r ? r.sale.invoiceId : ""),
saleAmount: (r: Row) =>
- "sale" in r ? "$" + (r.sale.amount / 100).toFixed(2) : "",
+ "sale" in r
+ ? formatMoneyCentsForExport(
+ r.sale.amount,
+ r.sale.currency,
+ `event ${r.eventId}`,
+ )
+ : "",
clickId: (r: ClickEvent) => r.click.id,
};
diff --git a/apps/web/lib/analytics/get-events.ts b/apps/web/lib/analytics/get-events.ts
index d58669cf00..bbbf71d01f 100644
--- a/apps/web/lib/analytics/get-events.ts
+++ b/apps/web/lib/analytics/get-events.ts
@@ -227,6 +227,7 @@ export const getEvents = async (params: EventsFilters) => {
amount: evt.saleAmount,
invoiceId: evt.invoice_id,
paymentProcessor: evt.payment_processor,
+ currency: evt.currency,
},
}
: {}),
diff --git a/apps/web/lib/api/commissions/format-commissions-for-export.ts b/apps/web/lib/api/commissions/format-commissions-for-export.ts
index a7cf11d7b4..6c03e5fe32 100644
--- a/apps/web/lib/api/commissions/format-commissions-for-export.ts
+++ b/apps/web/lib/api/commissions/format-commissions-for-export.ts
@@ -1,3 +1,4 @@
+import { formatMoneyCentsForExport } from "@/lib/api/utils/format-money-cents-for-export";
import { COMMISSION_EXPORT_COLUMNS } from "@/lib/zod/schemas/commissions";
import * as z from "zod/v4";
import { getCommissions } from "./get-commissions";
@@ -23,6 +24,11 @@ const COLUMN_TYPE_SCHEMAS = {
.nullable()
.default(0)
.transform((value) => value || 0),
+ money: z
+ .string()
+ .nullable()
+ .default("")
+ .transform((value) => value || ""),
date: z.date().transform((date) => date?.toISOString() || ""),
string: z
.string()
@@ -36,24 +42,42 @@ export function formatCommissionsForExport(
commissions: Awaited<ReturnType<typeof getCommissions>>,
columns: string[],
): Record<string, any>[] {
- const formattedCommissions = commissions.map((commission) => ({
- ...commission,
- customerName: commission.customer?.name || "",
- customerEmail: commission.customer?.email || "",
- customerExternalId: commission.customer?.externalId || "",
- partnerName: commission.partner?.name || "",
- partnerEmail: commission.partner?.email || "",
- partnerTenantId: commission.programEnrollment?.tenantId || "",
- }));
-
- // Sort columns by their order
- const sortedColumns = columns.sort(
+ const sortedColumns = [...columns].sort(
(a, b) =>
(COLUMN_LOOKUP.get(a)?.order || 999) -
(COLUMN_LOOKUP.get(b)?.order || 999),
);
- // Build column schemas
+ const formattedCommissions = commissions.map((commission) => {
+ const row: Record<string, unknown> = {
+ ...commission,
+ customerName: commission.customer?.name || "",
+ customerEmail: commission.customer?.email || "",
+ customerExternalId: commission.customer?.externalId || "",
+ partnerName: commission.partner?.name || "",
+ partnerEmail: commission.partner?.email || "",
+ partnerTenantId: commission.programEnrollment?.tenantId || "",
+ };
+
+ for (const col of sortedColumns) {
+ const columnInfo = COLUMN_LOOKUP.get(col);
+ if (columnInfo?.type !== "money") {
+ continue;
+ }
+
+ const cents = commission[col as "amount" | "earnings"];
+ if (typeof cents === "number") {
+ row[col] = formatMoneyCentsForExport(
+ cents,
+ commission.currency,
+ `commission ${commission.id}`,
+ );
+ }
+ }
+
+ return row;
+ });
+
const columnSchemas: Record<string, z.ZodTypeAny> = {};
for (const column of sortedColumns) {
@@ -63,7 +87,8 @@ export function formatCommissionsForExport(
continue;
}
- columnSchemas[column] = COLUMN_TYPE_SCHEMAS[columnInfo.type];
+ columnSchemas[column] =
+ COLUMN_TYPE_SCHEMAS[columnInfo.type as keyof typeof COLUMN_TYPE_SCHEMAS];
}
return z.array(z.object(columnSchemas)).parse(formattedCommissions);
diff --git a/apps/web/lib/api/links/format-links-for-export.ts b/apps/web/lib/api/links/format-links-for-export.ts
index 986b8a3c69..f5d964f301 100644
--- a/apps/web/lib/api/links/format-links-for-export.ts
+++ b/apps/web/lib/api/links/format-links-for-export.ts
@@ -1,3 +1,4 @@
+import { formatMoneyCentsForExport } from "@/lib/api/utils/format-money-cents-for-export";
import { exportLinksColumns } from "@/lib/zod/schemas/links";
import { linkConstructor } from "@dub/utils";
import { transformLink } from "./utils";
@@ -19,7 +20,7 @@ export function formatLinksForExport(
exportLinksColumns.some((c) => c.id === column),
);
- const sortedColumns = columns.sort(
+ const sortedColumns = [...columns].sort(
(a, b) => (columnMap[a]?.order || 999) - (columnMap[b]?.order || 999),
);
@@ -41,7 +42,13 @@ export function formatLinksForExport(
const { label, transform } = columnMap[column];
- if (transform) {
+ if (column === "saleAmount") {
+ result[label] = formatMoneyCentsForExport(
+ Number(value ?? 0),
+ "USD",
+ `link ${link.id}`,
+ );
+ } else if (transform) {
result[label] = transform(value);
} else {
result[label] = value;
diff --git a/apps/web/lib/api/partners/format-partners-for-export.ts b/apps/web/lib/api/partners/format-partners-for-export.ts
index 18f66686a3..348cc0bc56 100644
--- a/apps/web/lib/api/partners/format-partners-for-export.ts
+++ b/apps/web/lib/api/partners/format-partners-for-export.ts
@@ -1,5 +1,7 @@
+import { formatMoneyCentsForExport } from "@/lib/api/utils/format-money-cents-for-export";
import { polyfillSocialMediaFields } from "@/lib/social-utils";
import { exportPartnerColumns } from "@/lib/zod/schemas/partners";
+import { toCentsNumber } from "@dub/utils";
import * as z from "zod/v4";
const columnIdToLabel = exportPartnerColumns.reduce(
@@ -14,6 +16,13 @@ const numericColumns = exportPartnerColumns
.filter((column) => column.numeric)
.map((column) => column.id);
+/** Stored in cents; exported as formatted currency strings. */
+const numericCentsMoneyColumns = new Set([
+ "totalSaleAmount",
+ "totalCommissions",
+ "netRevenue",
+]);
+
const dateColumns = ["createdAt", "payoutsEnabledAt"];
// Formats partners for CSV export with proper column ordering, type coercion, and date handling
@@ -30,20 +39,20 @@ export function formatPartnersForExport(
{} as Record<string, number>,
);
- const sortedColumns = columns.sort(
+ const sortedColumns = [...columns].sort(
(a, b) => (columnOrderMap[a] || 999) - (columnOrderMap[b] || 999),
);
// Create schema for validation
const schemaFields: Record<string, any> = {};
sortedColumns.forEach((column) => {
- if (numericColumns.includes(column)) {
- schemaFields[columnIdToLabel[column]] = z.coerce
- .number()
- .optional()
- .default(0);
+ const label = columnIdToLabel[column];
+ if (numericCentsMoneyColumns.has(column)) {
+ schemaFields[label] = z.string().optional().default("");
+ } else if (numericColumns.includes(column)) {
+ schemaFields[label] = z.coerce.number().optional().default(0);
} else {
- schemaFields[columnIdToLabel[column]] = z.string().optional().default("");
+ schemaFields[label] = z.string().optional().default("");
}
});
@@ -59,10 +68,18 @@ export function formatPartnersForExport(
};
sortedColumns.forEach((column) => {
- let value = partner[column] || "";
+ let value = partner[column] ?? "";
- // Handle date fields - convert to ISO string format
- if (dateColumns.includes(column) && value instanceof Date) {
+ if (numericCentsMoneyColumns.has(column)) {
+ value =
+ value === "" || value == null
+ ? ""
+ : formatMoneyCentsForExport(
+ Number(toCentsNumber(value as number | bigint)),
+ "USD",
+ `partner ${partner.id}`,
+ );
+ } else if (dateColumns.includes(column) && value instanceof Date) {
value = value.toISOString();
}
diff --git a/apps/web/lib/api/utils/format-money-cents-for-export.ts b/apps/web/lib/api/utils/format-money-cents-for-export.ts
new file mode 100644
index 0000000000..3b2573aa64
--- /dev/null
+++ b/apps/web/lib/api/utils/format-money-cents-for-export.ts
@@ -0,0 +1,28 @@
+import { currencyFormatter } from "@dub/utils";
+
+/**
+ * Formats cents for CSV export using the same rules as the dashboard (`currencyFormatter`).
+ * Intl.NumberFormat throws RangeError for invalid ISO currency codes; callers may pass free-form DB strings.
+ */
+export function formatMoneyCentsForExport(
+ cents: number,
+ currency: string | null | undefined,
+ contextId: string,
+): string {
+ const code = (currency ?? "").trim() || "USD";
+ try {
+ return currencyFormatter(cents, { currency: code });
+ } catch (error) {
+ const isRangeError = error instanceof RangeError;
+ console.warn(
+ `[formatMoneyCentsForExport] currency format failed for ${contextId} (currency=${JSON.stringify(currency)}, isRangeError=${isRangeError}); falling back.`,
+ error,
+ );
+ try {
+ return currencyFormatter(cents, { currency: "USD" });
+ } catch {
+ const safe = Number.isFinite(cents) ? cents : 0;
+ return (safe / 100).toFixed(2);
+ }
+ }
+}
diff --git a/apps/web/lib/customers/api/format-customers-export.ts b/apps/web/lib/customers/api/format-customers-export.ts
index 83d4dd6b30..8cf99714d8 100644
--- a/apps/web/lib/customers/api/format-customers-export.ts
+++ b/apps/web/lib/customers/api/format-customers-export.ts
@@ -1,3 +1,4 @@
+import { formatMoneyCentsForExport } from "@/lib/api/utils/format-money-cents-for-export";
import {
CUSTOMER_EXPORT_COLUMNS,
CUSTOMER_EXPORT_DEFAULT_COLUMNS,
@@ -46,7 +47,11 @@ export function formatCustomersForExport(
stripeCustomerId: c.stripeCustomerId ?? "",
country: c.country ?? "",
sales: c.sales ?? 0,
- saleAmount: toCentsNumber(c.saleAmount ?? 0),
+ saleAmount: formatMoneyCentsForExport(
+ toCentsNumber(c.saleAmount ?? 0),
+ "USD",
+ `customer ${c.id}`,
+ ),
createdAt: dateToIso(c.createdAt),
firstSaleAt: dateToIso(c.firstSaleAt),
subscriptionCanceledAt: dateToIso(c.subscriptionCanceledAt),
diff --git a/apps/web/lib/zod/schemas/commissions.ts b/apps/web/lib/zod/schemas/commissions.ts
index 74bd5ab852..3c18f5a221 100644
--- a/apps/web/lib/zod/schemas/commissions.ts
+++ b/apps/web/lib/zod/schemas/commissions.ts
@@ -324,8 +324,8 @@ export const createClawbackSchema = z.object({
export const COMMISSION_EXPORT_COLUMNS = [
{ id: "id", label: "ID", type: "string", default: true },
{ id: "type", label: "Type", type: "string", default: true },
- { id: "amount", label: "Amount", type: "number", default: true },
- { id: "earnings", label: "Earnings", type: "number", default: true },
+ { id: "amount", label: "Amount", type: "money", default: true },
+ { id: "earnings", label: "Earnings", type: "money", default: true },
{ id: "currency", label: "Currency", type: "string", default: true },
{ id: "status", label: "Status", type: "string", default: true },
{ id: "invoiceId", label: "Invoice ID", type: "string", default: true },
diff --git a/apps/web/lib/zod/schemas/sales.ts b/apps/web/lib/zod/schemas/sales.ts
index 8c4b266651..a19a504288 100644
--- a/apps/web/lib/zod/schemas/sales.ts
+++ b/apps/web/lib/zod/schemas/sales.ts
@@ -162,6 +162,10 @@ export const saleEventSchemaTBEndpoint = z.object({
qr: z.number().nullable(),
ip: z.string().nullable(),
metadata: z.string().nullish(),
+ currency: z
+ .string()
+ .default("usd")
+ .transform((val) => val.toLowerCase()),
});
// response from dub api
@@ -176,6 +180,7 @@ export const saleEventResponseSchema = z
amount: true,
invoiceId: true,
paymentProcessor: true,
+ currency: true,
}),
metadata: z.any().nullish(),
// nested objects