✨ server: add account statement

Author: aguxez

.changeset/fine-houses-invite.md

@@ -0,0 +1,5 @@
+---
+"@exactly/server": patch
+---
+
+✨ add account statement

server/api/activity.ts

@@ -51,10 +51,11 @@ import chain, {
 } from "@exactly/common/generated/chain";
 import { decodeWithdraw } from "@exactly/common/ProposalType";
 import { Address, Hash, type Hex } from "@exactly/common/validation";
-import { effectiveRate, WAD } from "@exactly/lib";
+import { effectiveRate, MATURITY_INTERVAL, WAD } from "@exactly/lib";
 
 import database, { cards, credentials, transactions } from "../database";
 import auth from "../middleware/auth";
+import AccountStatement from "../utils/AccountStatement";
 import { collectors as cryptomateCollectors } from "../utils/cryptomate";
 import { declineMessage, collectors as pandaCollectors } from "../utils/panda";
 import publicClient from "../utils/publicClient";
@@ -82,6 +83,16 @@ export default new Hono().get(
   async (c) => {
     const { include, maturity } = c.req.valid("query");
     if (maturity !== undefined && maturity > 864e10) return c.json({ code: "invalid maturity" }, 400);
+    const pdf =
+      accepts(c, {
+        header: "Accept",
+        supports: ["application/json", "application/pdf"],
+        default: "application/json",
+      }) === "application/pdf";
+    const accountPdf = pdf && include === undefined;
+    const eventMaturity = accountPdf ? undefined : maturity;
+    if (pdf && include !== undefined && maturity === undefined)
+      return c.json({ code: "maturity required for filtered pdf" }, 400);
     function ignore(type: InferInput<typeof ActivityTypes>) {
       return include && (Array.isArray(include) ? !include.includes(type) : include !== type);
     }
@@ -94,7 +105,7 @@ export default new Hono().get(
         cards: {
           columns: { id: true, lastFour: true },
           with: { transactions: { columns: { hashes: true, payload: true } } },
-          limit: ignore("card") || maturity !== undefined ? 0 : undefined,
+          limit: ignore("card") || eventMaturity !== undefined ? 0 : undefined,
         },
       },
     });
@@ -119,7 +130,6 @@ export default new Hono().get(
             .then((logs) => new Set(logs.map(({ args }) => args.plugin.toLowerCase() as Hex)))
         : Promise.resolve(forbid(new Set<Hex>())),
     ]);
-
     const market = (address: Hex) => {
       const found = markets.get(address.toLowerCase() as Hex);
       if (!found) throw new Error("market not found");
@@ -170,7 +180,7 @@ export default new Hono().get(
         ? []
         : repayPromise.then((logs) =>
             logs
-              .filter(({ args }) => maturity === undefined || Number(args.maturity) === maturity)
+              .filter(({ args }) => eventMaturity === undefined || Number(args.maturity) === eventMaturity)
               .map((log) =>
                 parse(RepayActivity, {
                   ...log,
@@ -265,7 +275,7 @@ export default new Hono().get(
     );
     const timestamps = new Map(blocks.map(({ number: block, timestamp }) => [block, timestamp]));
     const purchases =
-      !ignore("card") && borrows && maturity !== undefined
+      !ignore("card") && borrows && maturity !== undefined && !accountPdf
         ? await (() => {
             const hashes = borrows
               .entries()
@@ -286,13 +296,6 @@ export default new Hono().get(
           })()
         : credential.cards;
 
-    const accept = accepts(c, {
-      header: "Accept",
-      supports: maturity === undefined ? ["application/json"] : ["application/json", "application/pdf"],
-      default: "application/json",
-    });
-    const pdf = accept === "application/pdf";
-
     const response = [
       ...purchases.flatMap(({ id: cardId, lastFour, transactions: txs }) =>
         txs.map(({ hashes, payload }) => {
@@ -303,16 +306,18 @@ export default new Hono().get(
               const b = borrows?.get(h as Hash);
               if (!b) return null;
               const filtered =
-                maturity === undefined ? b.events : b.events.filter(({ maturity: m }) => Number(m) === maturity);
+                eventMaturity === undefined
+                  ? b.events
+                  : b.events.filter(({ maturity: m }) => Number(m) === eventMaturity);
               if (filtered.length === 0) return null;
               return {
-                events: maturity !== undefined && b.events.length > 1 ? b.events : filtered,
+                events: eventMaturity !== undefined && b.events.length > 1 ? b.events : filtered,
                 timestamp: b.blockNumber && timestamps.get(b.blockNumber),
               };
             }),
           });
           if (panda.success) {
-            if (maturity === undefined || pdf) return { ...panda.output, cardId, lastFour };
+            if (eventMaturity === undefined || pdf) return { ...panda.output, cardId, lastFour };
             const operations: typeof panda.output.operations = [];
             for (const operation of panda.output.operations) {
               if (!("borrow" in operation)) continue;
@@ -363,11 +368,11 @@ export default new Hono().get(
           const hash = hashes[0];
           const borrow = borrows?.get(hash as Hash);
           const filtered =
-            maturity === undefined || !borrow
+            eventMaturity === undefined || !borrow
               ? borrow?.events
-              : borrow.events.filter(({ maturity: m }) => Number(m) === maturity);
-          if (maturity !== undefined && borrow && filtered?.length === 0) return;
-          const events = !borrow || maturity === undefined || borrow.events.length <= 1 ? filtered : borrow.events;
+              : borrow.events.filter(({ maturity: m }) => Number(m) === eventMaturity);
+          if (eventMaturity !== undefined && borrow && filtered?.length === 0) return;
+          const events = !borrow || eventMaturity === undefined || borrow.events.length <= 1 ? filtered : borrow.events;
           const cryptomate = safeParse(
             { 0: DebitActivity, 1: CreditActivity }[events?.length ?? 0] ?? InstallmentsActivity,
             {
@@ -378,7 +383,7 @@ export default new Hono().get(
             },
           );
           if (cryptomate.success) {
-            if (maturity === undefined || pdf) return { ...cryptomate.output, cardId, lastFour };
+            if (eventMaturity === undefined || pdf) return { ...cryptomate.output, cardId, lastFour };
             if (!borrow) return;
             if (borrow.events.length <= 1) return { ...cryptomate.output, cardId, lastFour };
             if (!("borrow" in cryptomate.output) || !("installments" in cryptomate.output.borrow))
@@ -432,6 +437,125 @@ export default new Hono().get(
       .filter(<T>(value: T | undefined): value is T => value !== undefined)
       .toSorted((a, b) => b.timestamp.localeCompare(a.timestamp) || b.id.localeCompare(a.id));
 
+    if (accountPdf) {
+      const maturityDate = maturity === undefined ? undefined : new Date(maturity * 1000);
+      const mask = (address: Address) => `${address.slice(0, 6)}...${address.slice(-6)}`;
+      const items = response
+        .flatMap((item): (typeof response)[number][] => {
+          if (item.type !== "panda") return [item];
+          const refunds = item.operations.filter(({ usdAmount }) => usdAmount < 0);
+          if (refunds.length === 0) return [item];
+          const charges = item.operations.filter(({ usdAmount }) => usdAmount >= 0);
+          const chargeUsdAmount = charges.reduce((sum, { usdAmount }) => sum + usdAmount, 0);
+          const chargeAmount = charges.reduce((sum, { amount }) => sum + amount, 0);
+          return [
+            ...(chargeUsdAmount > 0
+              ? [{ ...item, amount: chargeAmount, operations: charges, usdAmount: chargeUsdAmount }]
+              : []),
+            ...refunds.map((operation, index) => {
+              const n = index + Number(chargeUsdAmount > 0);
+              return {
+                ...item,
+                ...(n > 0 && { id: `${item.id}:${n}` }),
+                amount: operation.amount,
+                operations: [operation],
+                timestamp: operation.timestamp,
+                usdAmount: operation.usdAmount,
+              };
+            }),
+          ];
+        })
+        .filter(
+          (item) =>
+            (item.type !== "panda" || item.status === "settled" || item.usdAmount < 0) &&
+            (maturity === undefined ||
+              (Date.parse(item.timestamp) / 1000 > maturity - MATURITY_INTERVAL &&
+                Date.parse(item.timestamp) / 1000 <= maturity)),
+        );
+      return c.body(
+        new Uint8Array(
+          await renderToBuffer(
+            AccountStatement({
+              account: mask(account),
+              activities: items.map((item) => {
+                if ("merchant" in item) {
+                  const movement = {
+                    id: item.id,
+                    timestamp: item.timestamp,
+                    amount: -item.usdAmount,
+                    title: item.merchant.name,
+                  };
+                  if (-item.usdAmount > 0) return { ...movement, detail: `Refund – Card **** ${item.lastFour}` };
+                  if (item.type === "panda" ? item.operations.some(({ mode }) => mode > 0) : item.mode > 0)
+                    return { ...movement, detail: `Credit purchase – Card **** ${item.lastFour}` };
+                  return { ...movement, detail: `Debit purchase – Card **** ${item.lastFour}` };
+                }
+                switch (item.type) {
+                  case "received":
+                    return {
+                      id: item.id,
+                      timestamp: item.timestamp,
+                      amount: item.usdAmount,
+                      title: "Funds added",
+                      detail: `${item.amount} ${item.currency}`,
+                    };
+                  case "repay":
+                    return {
+                      id: item.id,
+                      timestamp: item.timestamp,
+                      amount: -item.usdAmount,
+                      title: "Debt payment",
+                      detail: `${item.amount} ${item.currency}`,
+                    };
+                  case "sent":
+                    return {
+                      id: item.id,
+                      timestamp: item.timestamp,
+                      amount: -item.usdAmount,
+                      title: `Sent to ${mask(item.receiver)}`,
+                      detail: `${item.amount} ${item.currency}`,
+                    };
+                  default:
+                    throw new Error("unsupported activity type", { cause: item });
+                }
+              }),
+              cards: [
+                ...Map.groupBy(
+                  items.filter((item) => "merchant" in item),
+                  ({ cardId }) => cardId,
+                ),
+              ].map(([cardId, cardItems]) => ({
+                ...cardItems.reduce(
+                  (summary, item) => ({
+                    amount:
+                      summary.amount +
+                      (item.usdAmount > 0 &&
+                      (item.type === "panda" ? item.operations.every(({ mode }) => mode <= 0) : item.mode <= 0)
+                        ? item.usdAmount
+                        : 0),
+                    lastFour: item.lastFour,
+                  }),
+                  { amount: 0, lastFour: "" },
+                ),
+                cardId,
+              })),
+              period:
+                maturityDate === undefined
+                  ? undefined
+                  : new Intl.DateTimeFormat("en-US", {
+                      day: "numeric",
+                      month: "short",
+                      timeZone: "UTC",
+                      year: "numeric",
+                    }).formatRange(new Date(maturityDate.getTime() - MATURITY_INTERVAL * 1000), maturityDate),
+            }),
+          ),
+        ),
+        200,
+        { "content-type": "application/pdf" },
+      );
+    }
+
     if (maturity !== undefined && pdf) {
       const purchasesByCard = Map.groupBy(
         response.flatMap((item) => {
@@ -465,30 +589,37 @@ export default new Hono().get(
         }),
         ({ cardId }) => cardId,
       );
-      const statement = {
-        account: `${account.slice(0, 6)}...${account.slice(-6)}`,
-        maturity,
-        cards: purchases
-          .filter(({ id }) => purchasesByCard.has(id))
-          .toSorted((a, b) => (a.id < b.id ? -1 : a.id > b.id ? 1 : 0))
-          .map(({ id, lastFour }) => ({
-            id,
-            lastFour,
-            purchases: (purchasesByCard.get(id) ?? []).map(({ cardId: _, ...rest }) => rest),
-          })),
-        payments: response
-          .filter((item) => item.type === "repay")
-          .filter((repay) => repay.currency === market(marketUSDCAddress).symbol)
-          .map(({ id, timestamp, amount, positionAmount }) => ({
-            id,
-            timestamp,
-            amount,
-            positionAmount,
-          })),
-      };
-      return c.body(new Uint8Array(await renderToBuffer(Statement(statement))), 200, {
-        "content-type": "application/pdf",
-      });
+      return c.body(
+        new Uint8Array(
+          await renderToBuffer(
+            Statement({
+              account: `${account.slice(0, 6)}...${account.slice(-6)}`,
+              maturity,
+              cards: purchases
+                .filter(({ id }) => purchasesByCard.has(id))
+                .toSorted((a, b) => (a.id < b.id ? -1 : a.id > b.id ? 1 : 0))
+                .map(({ id, lastFour }) => ({
+                  id,
+                  lastFour,
+                  purchases: (purchasesByCard.get(id) ?? []).map(({ cardId: _, ...rest }) => rest),
+                })),
+              payments: response
+                .filter((item) => item.type === "repay")
+                .filter((repay) => repay.currency === market(marketUSDCAddress).symbol)
+                .map(({ id, timestamp, amount, positionAmount }) => ({
+                  id,
+                  timestamp,
+                  amount,
+                  positionAmount,
+                })),
+            }),
+          ),
+        ),
+        200,
+        {
+          "content-type": "application/pdf",
+        },
+      );
     }
     return c.json(response, 200);
   },