@usethrottle/auth 0.7.0 → 0.9.0

package/dist/index.d.cts

@@ -164,6 +164,18 @@ interface Invoice {
     sourceType: string | null;
     /** Frozen at issue — the lines actually billed, not the order's lines today. */
     lineItems: InvoiceLineItem[];
+    /**
+     * Set when the invoice bills less than the order: the order total its lines
+     * add up to. `total` is then the amount due (Net-N invoice) or the amount
+     * paid (a deposit receipt). Null when the invoice bills the whole order.
+     */
+    orderTotal: number | null;
+    /** Net-N invoices: paid on the order before this invoice (e.g. a deposit). */
+    amountPaid: number | null;
+    /** Net-N invoices: waived by a comp. */
+    compWaived: number | null;
+    /** Deposit receipts: the balance still due, billed on the Net-N invoice. */
+    balanceDue: number | null;
     /** Resolved on the detail read only; null on list rows and when the hop fails. */
     orderId: string | null;
     orderNumber: string | null;
@@ -180,6 +192,21 @@ interface Subscription {
     totalPayments: number | null;
     paymentsMade: number;
     completedAt: string | null;
+    /** Installment plans only: every payment in order; dueAt is an estimate. */
+    paymentSchedule?: Array<{
+        index: number;
+        amount: number;
+        discount: number;
+        net: number;
+        intervalUnit: string | null;
+        intervalCount: number | null;
+        status: 'paid' | 'due' | 'upcoming';
+        dueAt: string | null;
+    }> | null;
+    /** Installment plans only: the sum of every payment's net amount. */
+    scheduleTotal?: number | null;
+    /** Installment plans only: what the next payment will charge; null once complete. */
+    nextPaymentAmount?: number | null;
     amount: number;
     quantity: number;
     currency: string;

package/dist/index.d.ts

@@ -164,6 +164,18 @@ interface Invoice {
     sourceType: string | null;
     /** Frozen at issue — the lines actually billed, not the order's lines today. */
     lineItems: InvoiceLineItem[];
+    /**
+     * Set when the invoice bills less than the order: the order total its lines
+     * add up to. `total` is then the amount due (Net-N invoice) or the amount
+     * paid (a deposit receipt). Null when the invoice bills the whole order.
+     */
+    orderTotal: number | null;
+    /** Net-N invoices: paid on the order before this invoice (e.g. a deposit). */
+    amountPaid: number | null;
+    /** Net-N invoices: waived by a comp. */
+    compWaived: number | null;
+    /** Deposit receipts: the balance still due, billed on the Net-N invoice. */
+    balanceDue: number | null;
     /** Resolved on the detail read only; null on list rows and when the hop fails. */
     orderId: string | null;
     orderNumber: string | null;
@@ -180,6 +192,21 @@ interface Subscription {
     totalPayments: number | null;
     paymentsMade: number;
     completedAt: string | null;
+    /** Installment plans only: every payment in order; dueAt is an estimate. */
+    paymentSchedule?: Array<{
+        index: number;
+        amount: number;
+        discount: number;
+        net: number;
+        intervalUnit: string | null;
+        intervalCount: number | null;
+        status: 'paid' | 'due' | 'upcoming';
+        dueAt: string | null;
+    }> | null;
+    /** Installment plans only: the sum of every payment's net amount. */
+    scheduleTotal?: number | null;
+    /** Installment plans only: what the next payment will charge; null once complete. */
+    nextPaymentAmount?: number | null;
     amount: number;
     quantity: number;
     currency: string;

package/dist/react/components/index.cjs

@@ -1209,6 +1209,12 @@ var enUS = {
     viewSubscription: "View subscription",
     payButton: "Pay this invoice",
     billedTo: "Billed to",
+    /** Shown when an invoice bills less than the order, matching the PDF. */
+    orderTotal: "Order total",
+    amountPaid: "Amount paid",
+    waived: "Waived",
+    amountDue: "Amount due",
+    balanceDue: "Balance due",
     /** Display copy for `invoice.status` — the wire values are paid|open|void. */
     statusLabels: { paid: "Paid", open: "Open", void: "Void" },
     downloadUnavailable: "This invoice is not available to download right now."
@@ -1228,6 +1234,11 @@ var enUS = {
     cancelledOn: "Cancelled on",
     trialEnds: "Trial ends",
     installmentProgress: "Payment {paid} of {total}",
+    installmentTotal: "{amount} total",
+    installmentNext: "Next {amount} on {date}",
+    /** Spec §5: a varied schedule's dated list; dates are estimates, hence "~". */
+    upcomingPayments: "Upcoming payments",
+    upcomingPayment: "{amount} \xB7 ~{date}",
     cancelButton: "Cancel",
     cancelAtPeriodEnd: "Cancel at period end",
     cancelNow: "Cancel immediately",
@@ -4219,6 +4230,9 @@ function InvoiceDetail(props) {
     /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(PanelState, { resource, isEmpty: (i) => i === null, emptyTitle: t.invoices.empty, skeletonRows: 4, children: (invoice) => {
       const money = (v) => formatMoney(v, invoice.currency, locale);
       const lines = invoice.lineItems ?? [];
+      const partOfOrder = invoice.orderTotal != null;
+      const isDepositReceipt = partOfOrder && invoice.balanceDue != null;
+      const headlineLabel = !partOfOrder ? t.invoices.total : isDepositReceipt ? t.invoices.amountPaid : t.invoices.amountDue;
       return /* @__PURE__ */ (0, import_jsx_runtime41.jsxs)("div", { ...a.el("invoiceDetail.layout", "throttle-detail"), children: [
         /* @__PURE__ */ (0, import_jsx_runtime41.jsxs)("div", { ...a.el("invoiceDetail.main", "throttle-detail__main"), children: [
           /* @__PURE__ */ (0, import_jsx_runtime41.jsxs)("div", { className: "throttle-detail__section", children: [
@@ -4252,10 +4266,14 @@ function InvoiceDetail(props) {
         ] }),
         /* @__PURE__ */ (0, import_jsx_runtime41.jsxs)("aside", { ...a.el("invoiceDetail.rail", "throttle-detail__rail"), children: [
           /* @__PURE__ */ (0, import_jsx_runtime41.jsxs)("div", { className: "throttle-detail__section", children: [
-            /* @__PURE__ */ (0, import_jsx_runtime41.jsx)("span", { className: "throttle-detail__label", children: t.invoices.total }),
+            /* @__PURE__ */ (0, import_jsx_runtime41.jsx)("span", { className: "throttle-detail__label", children: headlineLabel }),
             /* @__PURE__ */ (0, import_jsx_runtime41.jsx)("span", { className: "throttle-detail__headline", children: money(invoice.total) })
           ] }),
           /* @__PURE__ */ (0, import_jsx_runtime41.jsxs)("div", { ...a.el("invoiceDetail.totals", "throttle-totals"), children: [
+            partOfOrder ? /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(Line2, { label: t.invoices.orderTotal, value: money(invoice.orderTotal) }) : null,
+            partOfOrder && invoice.amountPaid ? /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(Line2, { label: t.invoices.amountPaid, value: `-${money(invoice.amountPaid)}` }) : null,
+            partOfOrder && invoice.compWaived ? /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(Line2, { label: t.invoices.waived, value: `-${money(invoice.compWaived)}` }) : null,
+            isDepositReceipt && invoice.balanceDue ? /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(Line2, { label: t.invoices.balanceDue, value: money(invoice.balanceDue) }) : null,
             invoice.dueAt ? /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(Line2, { label: t.invoices.due, value: formatDate(invoice.dueAt, locale) }) : null,
             invoice.periodStart && invoice.periodEnd ? /* @__PURE__ */ (0, import_jsx_runtime41.jsx)(
               Line2,
@@ -4414,6 +4432,18 @@ function isIntervalUnit(value) {
   return typeof value === "string" && INTERVAL_UNITS.includes(value);
 }
 
+// ../core-cadence/src/schedule.ts
+function isVariedSchedule(rows) {
+  if (!rows || rows.length === 0) return false;
+  return rows.some(
+    (r, i) => r.discount !== 0 || r.amount !== rows[0].amount || i > 1 && (r.intervalUnit !== rows[1].intervalUnit || r.intervalCount !== rows[1].intervalCount)
+  );
+}
+function upcomingSchedulePayments(rows) {
+  if (!rows || !isVariedSchedule(rows)) return [];
+  return rows.filter((r) => r.status !== "paid" && r.dueAt != null);
+}
+
 // ../core-cadence/src/labels.ts
 var NAMED_NOUN = {
   weekly: "week",
@@ -4429,6 +4459,10 @@ function cadenceNoun(cadence) {
   }
   return cadence.interval;
 }
+function scheduleDeal(sub) {
+  if (!sub.paymentSchedule || sub.scheduleTotal == null || !isVariedSchedule(sub.paymentSchedule)) return null;
+  return { total: sub.scheduleTotal, payments: sub.paymentSchedule.length };
+}
 
 // src/react/components/account/SubscriptionsPanel.tsx
 var import_jsx_runtime43 = require("react/jsx-runtime");
@@ -4455,7 +4489,20 @@ function SubscriptionsPanel(props) {
       await run(fn);
     })();
   };
-  const priceLabel = (sub) => `${formatMoney(sub.amount, sub.currency, locale)} / ${cadenceNoun(sub)}${sub.quantity > 1 ? ` \xD7 ${sub.quantity}` : ""}`;
+  const priceLabel = (sub) => {
+    const deal = scheduleDeal(sub);
+    return deal ? t.subscriptions.installmentTotal.replace("{amount}", formatMoney(deal.total, sub.currency, locale)) : `${formatMoney(sub.amount, sub.currency, locale)} / ${cadenceNoun(sub)}${sub.quantity > 1 ? ` \xD7 ${sub.quantity}` : ""}`;
+  };
+  const nextPaymentLabel = (sub) => {
+    if (!isVariedSchedule(sub.paymentSchedule) || !sub.paymentSchedule || sub.nextPaymentAmount == null) return null;
+    const upcoming = sub.paymentSchedule.find((r) => r.status !== "paid");
+    return t.subscriptions.installmentNext.replace("{amount}", formatMoney(sub.nextPaymentAmount, sub.currency, locale)).replace("{date}", formatDate(upcoming?.dueAt ?? sub.currentPeriodEnd, locale));
+  };
+  const upcomingList = (sub) => {
+    const upcoming = upcomingSchedulePayments(sub.paymentSchedule);
+    if (upcoming.length === 0) return null;
+    return /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("ul", { className: "throttle-muted", "aria-label": t.subscriptions.upcomingPayments, children: upcoming.map((r) => /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("li", { children: t.subscriptions.upcomingPayment.replace("{amount}", formatMoney(r.net, sub.currency, locale)).replace("{date}", formatDate(r.dueAt, locale)) }, r.dueAt)) });
+  };
   const renewsLabel = (sub) => formatDate(
     sub.status === "completed" ? sub.completedAt ?? sub.currentPeriodEnd : sub.status === "cancelled" ? sub.cancelledAt ?? sub.currentPeriodEnd : sub.currentPeriodEnd,
     locale
@@ -4537,7 +4584,9 @@ function SubscriptionsPanel(props) {
             columns: [
               { key: "plan", label: t.subscriptions.columnPlan, render: (sub) => /* @__PURE__ */ (0, import_jsx_runtime43.jsxs)(import_jsx_runtime43.Fragment, { children: [
                 sub.planName ?? sub.planReference,
-                sub.totalPayments != null ? /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("div", { className: "throttle-muted", children: t.subscriptions.installmentProgress.replace("{paid}", String(Math.min(sub.paymentsMade ?? 0, sub.totalPayments))).replace("{total}", String(sub.totalPayments)) }) : null
+                sub.totalPayments != null ? /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("div", { className: "throttle-muted", children: t.subscriptions.installmentProgress.replace("{paid}", String(Math.min(sub.paymentsMade ?? 0, sub.totalPayments))).replace("{total}", String(sub.totalPayments)) }) : null,
+                nextPaymentLabel(sub) ? /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("div", { className: "throttle-muted", children: nextPaymentLabel(sub) }) : null,
+                upcomingList(sub)
               ] }) },
               { key: "price", label: t.subscriptions.columnPrice, render: (sub) => /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("span", { className: "throttle-table__money", children: priceLabel(sub) }) },
               { key: "renews", label: t.subscriptions.columnRenews, render: (sub) => renewsLabel(sub) },
@@ -4555,12 +4604,9 @@ function SubscriptionsPanel(props) {
               /* @__PURE__ */ (0, import_jsx_runtime43.jsx)(StatusBadge, { status: sub.status, labels: t.subscriptions.statusLabels })
             ] }),
             sub.totalPayments != null ? /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("div", { className: "throttle-muted", children: t.subscriptions.installmentProgress.replace("{paid}", String(Math.min(sub.paymentsMade ?? 0, sub.totalPayments))).replace("{total}", String(sub.totalPayments)) }) : null,
-            /* @__PURE__ */ (0, import_jsx_runtime43.jsxs)("p", { className: "throttle-muted", children: [
-              formatMoney(sub.amount, sub.currency, locale),
-              " / ",
-              cadenceNoun(sub),
-              sub.quantity > 1 ? ` \xD7 ${sub.quantity}` : ""
-            ] }),
+            nextPaymentLabel(sub) ? /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("div", { className: "throttle-muted", children: nextPaymentLabel(sub) }) : null,
+            upcomingList(sub),
+            /* @__PURE__ */ (0, import_jsx_runtime43.jsx)("p", { className: "throttle-muted", children: priceLabel(sub) }),
             sub.status === "completed" ? /* @__PURE__ */ (0, import_jsx_runtime43.jsxs)("p", { className: "throttle-muted", children: [
               t.subscriptions.statusLabels.completed,
               " ",