payment-kit 1.13.150 → 1.13.152

package/api/src/libs/notification/template/subscription-refund-succeeded.ts

@@ -76,7 +76,7 @@ export class SubscriptionRefundSucceededEmailTemplate
     const productName = await getMainProductName(refund.subscription_id!);
     const at: string = formatTime(refund.created_at);
 
-    const paymentInfo: string = `${fromUnitToToken(paymentIntent?.amount, paymentCurrency.decimal)} ${
+    const paymentInfo: string = `${fromUnitToToken(paymentIntent?.amount_received || '0', paymentCurrency.decimal)} ${
       paymentCurrency.symbol
     }`;
     const refundInfo: string = `${fromUnitToToken(refund.amount, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;

package/api/src/queues/invoice.ts

@@ -78,6 +78,20 @@ export const handleInvoice = async (job: InvoiceJob) => {
       }
     }
 
+    if (invoice.payment_intent_id) {
+      const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
+      if (
+        paymentIntent &&
+        ['requires_action', 'requires_capture', 'requires_payment_method'].includes(paymentIntent.status)
+      ) {
+        await paymentIntent.update({
+          amount_received: '0',
+          status: 'succeeded',
+        });
+        logger.info('invoice payment intent updated', paymentIntent.id);
+      }
+    }
+
     return;
   }
 

package/api/src/queues/refund.ts

@@ -195,6 +195,7 @@ export const refundQueue = createQueue<RefundJob>({
 
 export const startRefundQueue = async () => {
   events.on('refund.created', (refund: Refund) => {
+    logger.info('schedule refund', { id: refund.id });
     refundQueue.push({ id: refund.id, job: { refundId: refund.id } });
   });
 

package/api/src/routes/checkout-sessions.ts

@@ -82,7 +82,7 @@ export const formatCheckoutSession = async (payload: any, throwOnEmptyItems = tr
         terms_of_service: 'none',
       },
       invoice_creation: {
-        enabled: false,
+        enabled: true,
       },
       phone_number_collection: {
         enabled: false,
@@ -504,6 +504,14 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
 
       await customer.update(updates);
     }
+    const canMakeNewPurchase = await customer.canMakeNewPurchase(checkoutSession.invoice_id);
+    if (!canMakeNewPurchase) {
+      return res.status(403).json({
+        code: 'CUSTOMER_LIMITED',
+        error: 'Customer can not make new purchase, maybe you have unpaid invoices from previous purchases',
+      });
+    }
+
     await checkoutSession.update({ customer_id: customer.id, customer_did: req.user.did });
 
     // payment intent is only created when checkout session is in payment mode

package/api/src/routes/connect/shared.ts

@@ -532,6 +532,7 @@ export async function ensureInvoiceForCollect(invoiceId: string) {
     throw new Error(`Payment intent already canceled for invoice ${invoiceId}`);
   }
   if (paymentIntent.status === 'succeeded') {
+    await invoice.update({ status: 'paid' });
     throw new Error(`Payment intent already succeeded for invoice ${invoiceId}`);
   }
 

package/api/src/routes/customers.ts

@@ -102,7 +102,12 @@ router.get('/me', user(), async (req, res) => {
 
   try {
     const doc = await Customer.findByPkOrDid(req.user.did as string);
-    res.json(doc);
+    if (!doc) {
+      res.status(404).json({ error: 'Customer not found' });
+    } else {
+      const summary = await doc.getSummary();
+      res.json({ ...doc.toJSON(), summary });
+    }
   } catch (err) {
     console.error(err);
     res.json(null);
@@ -119,6 +124,22 @@ router.get('/:id', auth, async (req, res) => {
   }
 });
 
+router.get('/:id/summary', auth, async (req, res) => {
+  try {
+    const doc = await Customer.findByPkOrDid(req.params.id as string);
+    if (!doc) {
+      res.status(404).json({ error: 'Customer not found' });
+      return;
+    }
+
+    const result = await doc.getSummary();
+    res.json(result);
+  } catch (err) {
+    console.error(err);
+    res.json(null);
+  }
+});
+
 // eslint-disable-next-line consistent-return
 router.put('/:id', authPortal, async (req, res) => {
   try {

package/api/src/routes/refunds.ts

@@ -22,11 +22,15 @@ const paginationSchema = Joi.object<{
   pageSize: number;
   livemode?: boolean;
   status?: string;
+  invoice_id: string;
+  subscription_id: string;
 }>({
   page: Joi.number().integer().min(1).default(1),
   pageSize: Joi.number().integer().min(1).max(100).default(20),
   livemode: Joi.boolean().empty(''),
   status: Joi.string().empty(''),
+  invoice_id: Joi.string().empty(''),
+  subscription_id: Joi.string().empty(''),
 });
 router.get('/', auth, async (req, res) => {
   const { page, pageSize, livemode, status, ...query } = await paginationSchema.validateAsync(req.query, {
@@ -38,6 +42,14 @@ router.get('/', auth, async (req, res) => {
   if (typeof livemode === 'boolean') {
     where.livemode = livemode;
   }
+
+  if (query.invoice_id) {
+    where.invoice_id = query.invoice_id;
+  }
+
+  if (query.subscription_id) {
+    where.subscription_id = query.subscription_id;
+  }
   if (status) {
     where.status = status
       .split(',')
@@ -60,6 +72,7 @@ router.get('/', auth, async (req, res) => {
     include: [
       { model: Customer, as: 'customer' },
       { model: PaymentCurrency, as: 'paymentCurrency' },
+      { model: PaymentMethod, as: 'paymentMethod' },
       // { model: PaymentIntent, as: 'paymentIntent' },
       // { model: Invoice, as: 'invoice' },
       // { model: Subscription, as: 'subscription' },
@@ -76,6 +89,7 @@ router.get('/:id', auth, async (req, res) => {
       { model: Customer, as: 'customer' },
       { model: PaymentCurrency, as: 'paymentCurrency' },
       { model: PaymentIntent, as: 'paymentIntent' },
+      { model: PaymentMethod, as: 'paymentMethod' },
       { model: Invoice, as: 'invoice' },
       { model: Subscription, as: 'subscription' },
     ],

package/api/src/routes/subscriptions.ts

@@ -312,6 +312,7 @@ router.put('/:id/cancel', authPortal, async (req, res) => {
         reason: 'requested_by_admin',
         currency_id: subscription.currency_id,
         customer_id: subscription.customer_id,
+        payment_method_id: subscription.default_payment_method_id,
         payment_intent_id: result.lastInvoice.payment_intent_id as string,
         invoice_id: result.lastInvoice.id,
         subscription_id: subscription.id,
@@ -329,7 +330,7 @@ router.put('/:id/cancel', authPortal, async (req, res) => {
           unused_period_end: subscription.current_period_end,
         },
       });
-      logger.info('subscription cancel refund done', {
+      logger.info('subscription cancel refund created', {
         ...req.params,
         ...req.body,
         ...pick(result, ['total', 'unused']),

package/api/src/store/migrations/20240225-refund-ext.ts

@@ -0,0 +1,22 @@
+/* eslint-disable no-await-in-loop */
+import { DataTypes } from 'sequelize';
+
+import { Migration, safeApplyColumnChanges } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await safeApplyColumnChanges(context, {
+    refunds: [
+      {
+        name: 'payment_method_id',
+        field: {
+          type: DataTypes.STRING(30),
+          allowNull: true,
+        },
+      },
+    ],
+  });
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('refunds', 'payment_method_id');
+};

package/api/src/store/models/customer.ts

@@ -154,6 +154,27 @@ export class Customer extends Model<InferAttributes<Customer>, InferCreationAttr
     return `${this.invoice_prefix}-${padStart(sequence.toString(), 4, '0')}`;
   }
 
+  public async getSummary() {
+    const { PaymentIntent, Refund, Invoice } = this.sequelize.models;
+    const [paid, due, refunded] = await Promise.all([
+      // @ts-ignore
+      PaymentIntent!.getPaidAmountByCustomer(this.id),
+      // @ts-ignore
+      Invoice!.getUncollectibleAmountByCustomer(this.id),
+      // @ts-ignore
+      Refund!.getRefundAmountByCustomer(this.id),
+    ]);
+
+    return { paid, due, refunded };
+  }
+
+  public async canMakeNewPurchase(excludedInvoiceId: string = '') {
+    const { Invoice } = this.sequelize.models;
+    // @ts-ignore
+    const result = await Invoice!.getUncollectibleAmountByCustomer(this.id, excludedInvoiceId);
+    return Object.entries(result).every(([, amount]) => new BN(amount).lte(new BN(0)));
+  }
+
   public getBalanceToApply(currencyId: string, amount: string) {
     const tokens = this.token_balance || {};
     const balance = tokens[currencyId] || '0';

package/api/src/store/models/index.ts

@@ -230,7 +230,7 @@ export type TPricingTableExpanded = TPricingTable & {
 export type TRefundExpanded = TRefund & {
   customer: TCustomer;
   paymentCurrency: TPaymentCurrency;
-  paymentMethod?: TPaymentMethod;
+  paymentMethod: TPaymentMethod;
   paymentIntent: TPaymentIntent;
   invoice?: TInvoice;
   subscription?: TSubscription;

package/api/src/store/models/invoice.ts

@@ -1,6 +1,15 @@
 /* eslint-disable @typescript-eslint/indent */
 /* eslint-disable @typescript-eslint/lines-between-class-members */
-import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import { BN } from '@ocap/util';
+import {
+  CreationOptional,
+  DataTypes,
+  InferAttributes,
+  InferCreationAttributes,
+  Model,
+  Op,
+  WhereOptions,
+} from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 
 import { createEvent, createStatusEvent } from '../../libs/audit';
@@ -9,6 +18,7 @@ import type {
   CustomerAddress,
   CustomerShipping,
   DiscountAmount,
+  GroupedBN,
   PaymentError,
   PaymentSettings,
   SimpleCustomField,
@@ -511,6 +521,32 @@ export class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttrib
   public isImmutable() {
     return ['paid', 'void'].includes(this.status);
   }
+
+  public static async getUncollectibleAmountByCustomer(
+    customerId: string,
+    excludedInvoiceId?: string
+  ): Promise<GroupedBN> {
+    const where: WhereOptions<Invoice> = {
+      status: 'uncollectible',
+      customer_id: customerId,
+      amount_remaining: { [Op.gt]: '0' },
+    };
+    if (excludedInvoiceId) {
+      where.id = { [Op.not]: excludedInvoiceId };
+    }
+    const invoices = await Invoice.findAll({ where });
+
+    return invoices.reduce((acc: GroupedBN, invoice) => {
+      const key = invoice.currency_id;
+      if (!acc[key]) {
+        acc[key] = '0';
+      }
+
+      acc[key] = new BN(acc[key]).add(new BN(invoice.amount_remaining)).toString();
+
+      return acc;
+    }, {});
+  }
 }
 
 export type TInvoice = InferAttributes<Invoice>;

package/api/src/store/models/payment-intent.ts

@@ -1,11 +1,12 @@
 /* eslint-disable @typescript-eslint/lines-between-class-members */
 /* eslint-disable @typescript-eslint/indent */
-import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import { BN } from '@ocap/util';
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model, Op } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 
 import { createEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { PaymentDetails, PaymentError } from './types';
+import type { GroupedBN, PaymentDetails, PaymentError } from './types';
 
 export const nextPaymentIntentId = createIdGenerator('pi', 24);
 
@@ -280,6 +281,27 @@ export class PaymentIntent extends Model<InferAttributes<PaymentIntent>, InferCr
   public isImmutable() {
     return ['canceled', 'succeeded'].includes(this.status);
   }
+
+  public static async getPaidAmountByCustomer(customerId: string): Promise<GroupedBN> {
+    const payments = await PaymentIntent.findAll({
+      where: {
+        status: 'succeeded',
+        customer_id: customerId,
+        amount_received: { [Op.gt]: '0' },
+      },
+    });
+
+    return payments.reduce((acc: GroupedBN, payment) => {
+      const key = payment.currency_id;
+      if (!acc[key]) {
+        acc[key] = '0';
+      }
+
+      acc[key] = new BN(acc[key]).add(new BN(payment.amount_received)).toString();
+
+      return acc;
+    }, {});
+  }
 }
 
 export type TPaymentIntent = InferAttributes<PaymentIntent>;

package/api/src/store/models/refund.ts

@@ -1,11 +1,12 @@
 /* eslint-disable @typescript-eslint/lines-between-class-members */
 /* eslint-disable @typescript-eslint/indent */
-import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import { BN } from '@ocap/util';
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model, Op } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 
 import { createEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { PaymentDetails, PaymentError } from './types';
+import type { GroupedBN, PaymentDetails, PaymentError } from './types';
 
 export const nextRefundId = createIdGenerator('re', 24);
 
@@ -25,6 +26,7 @@ export class Refund extends Model<InferAttributes<Refund>, InferCreationAttribut
   declare currency_id: string;
   declare customer_id: string;
   declare payment_intent_id: string;
+  declare payment_method_id: string;
   declare invoice_id?: string;
   declare subscription_id?: string;
 
@@ -173,21 +175,30 @@ export class Refund extends Model<InferAttributes<Refund>, InferCreationAttribut
   };
 
   public static initialize(sequelize: any) {
-    this.init(Refund.GENESIS_ATTRIBUTES, {
-      sequelize,
-      modelName: 'Refund',
-      tableName: 'refunds',
-      createdAt: 'created_at',
-      updatedAt: 'updated_at',
-      hooks: {
-        afterCreate: (model: Refund, options) =>
-          createEvent('Refund', 'refund.created', model, options).catch(console.error),
-        afterUpdate: (model: Refund, options) =>
-          createStatusEvent('Refund', 'refund', { canceled: 'canceled', succeeded: 'succeeded' }, model, options),
-        afterDestroy: (model: Refund, options) =>
-          createEvent('Refund', 'refund.deleted', model, options).catch(console.error),
+    this.init(
+      {
+        ...Refund.GENESIS_ATTRIBUTES,
+        payment_method_id: {
+          type: DataTypes.STRING(30),
+          allowNull: true,
+        },
       },
-    });
+      {
+        sequelize,
+        modelName: 'Refund',
+        tableName: 'refunds',
+        createdAt: 'created_at',
+        updatedAt: 'updated_at',
+        hooks: {
+          afterCreate: (model: Refund, options) =>
+            createEvent('Refund', 'refund.created', model, options).catch(console.error),
+          afterUpdate: (model: Refund, options) =>
+            createStatusEvent('Refund', 'refund', { canceled: 'canceled', succeeded: 'succeeded' }, model, options),
+          afterDestroy: (model: Refund, options) =>
+            createEvent('Refund', 'refund.deleted', model, options).catch(console.error),
+        },
+      }
+    );
   }
 
   public static associate(models: any) {
@@ -206,6 +217,11 @@ export class Refund extends Model<InferAttributes<Refund>, InferCreationAttribut
       foreignKey: 'id',
       as: 'paymentIntent',
     });
+    this.hasOne(models.PaymentMethod, {
+      sourceKey: 'payment_method_id',
+      foreignKey: 'id',
+      as: 'paymentMethod',
+    });
     this.hasOne(models.Invoice, {
       sourceKey: 'invoice_id',
       foreignKey: 'id',
@@ -221,6 +237,27 @@ export class Refund extends Model<InferAttributes<Refund>, InferCreationAttribut
   public isImmutable() {
     return ['canceled', 'succeeded'].includes(this.status);
   }
+
+  public static async getRefundAmountByCustomer(customerId: string, status: string = 'succeeded'): Promise<GroupedBN> {
+    const refunds = await Refund.findAll({
+      where: {
+        status,
+        customer_id: customerId,
+        amount: { [Op.gt]: '0' },
+      },
+    });
+
+    return refunds.reduce((acc: GroupedBN, refund) => {
+      const key = refund.currency_id;
+      if (!acc[key]) {
+        acc[key] = '0';
+      }
+
+      acc[key] = new BN(acc[key]).add(new BN(refund.amount)).toString();
+
+      return acc;
+    }, {});
+  }
 }
 
 export type TRefund = InferAttributes<Refund>;

package/api/src/store/models/types.ts

@@ -1,6 +1,8 @@
 /* eslint-disable @typescript-eslint/indent */
 import type { LiteralUnion } from 'type-fest';
 
+export type GroupedBN = { [currencyId: string]: string };
+
 export type Pagination<T = any> = T & {
   // offset based
   page?: number;

package/blocklet.yml

@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/payment-kit.git
 specVersion: 1.2.8
-version: 1.13.150
+version: 1.13.152
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.150",
+  "version": "1.13.152",
   "scripts": {
     "dev": "cross-env COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev --open",
     "eject": "vite eject",
@@ -50,7 +50,7 @@
     "@arcblock/jwt": "^1.18.110",
     "@arcblock/ux": "^2.9.29",
     "@blocklet/logger": "1.16.23",
-    "@blocklet/payment-react": "1.13.150",
+    "@blocklet/payment-react": "1.13.152",
     "@blocklet/sdk": "1.16.23",
     "@blocklet/ui-react": "^2.9.29",
     "@blocklet/uploader": "^0.0.73",
@@ -110,7 +110,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.23",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@blocklet/payment-types": "1.13.150",
+    "@blocklet/payment-types": "1.13.152",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -149,5 +149,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "b65548baa2ab6bd40aec35b2a6594bfe6dbb7ee9"
+  "gitHead": "5d6d2b6a8c0422e1055ddcec4e3179fd734cdbc5"
 }

package/src/app.tsx

@@ -21,6 +21,7 @@ const CheckoutPage = React.lazy(() => import('./pages/checkout'));
 const AdminPage = React.lazy(() => import('./pages/admin'));
 const CustomerHome = React.lazy(() => import('./pages/customer/index'));
 const CustomerInvoice = React.lazy(() => import('./pages/customer/invoice'));
+const CustomerInvoicePastDue = React.lazy(() => import('./pages/customer/invoice/past-due'));
 const CustomerSubscriptionDetail = React.lazy(() => import('./pages/customer/subscription/detail'));
 const CustomerSubscriptionUpdate = React.lazy(() => import('./pages/customer/subscription/update'));
 
@@ -79,6 +80,15 @@ function App() {
                 }
               />
               <Route key="subscription-embed" path="/customer/embed/subscription" element={<MiniInvoiceList />} />,
+              <Route
+                key="customer-due"
+                path="/customer/invoice/past-due"
+                element={
+                  <Layout>
+                    <CustomerInvoicePastDue />
+                  </Layout>
+                }
+              />
               <Route
                 key="customer-invoice"
                 path="/customer/invoice/:id"

package/src/components/balance-list.tsx

@@ -0,0 +1,43 @@
+import { formatAmount, usePaymentContext } from '@blocklet/payment-react';
+import type { GroupedBN } from '@blocklet/payment-types';
+import { Stack, Typography } from '@mui/material';
+import flatten from 'lodash/flatten';
+import isEmpty from 'lodash/isEmpty';
+
+type Props = {
+  data?: GroupedBN;
+};
+
+export default function BalanceList(props: Props) {
+  const { settings } = usePaymentContext();
+  const currencies = flatten(settings.paymentMethods.map((method) => method.payment_currencies));
+
+  if (isEmpty(props.data)) {
+    return <Typography>None</Typography>;
+  }
+
+  return (
+    <Stack direction="column" alignItems="flex-start" sx={{ width: '100%' }}>
+      {Object.entries(props.data).map(([currencyId, amount]) => {
+        const currency = currencies.find((c) => c.id === currencyId);
+        if (!currency) {
+          return null;
+        }
+        return (
+          <Stack key={currencyId} sx={{ width: '100%' }} direction="row" spacing={1}>
+            <Typography sx={{ flex: 1 }} color="text.primary">
+              {formatAmount(amount, currency.decimal)}
+            </Typography>
+            <Typography sx={{ width: '32px' }} color="text.secondary">
+              {currency.symbol}
+            </Typography>
+          </Stack>
+        );
+      })}
+    </Stack>
+  );
+}
+
+BalanceList.defaultProps = {
+  data: {},
+};

package/src/components/info-metric.tsx

@@ -12,7 +12,7 @@ export default function InfoMetric(props: Props) {
   return (
     <>
       <Stack direction="column" alignItems="flex-start">
-        <Typography variant="body1" mb={1} color="text.secondary">
+        <Typography component="div" variant="body1" mb={1} color="text.secondary">
           {props.label}
           {!!props.tip && (
             <Tooltip title={props.tip}>
@@ -20,7 +20,7 @@ export default function InfoMetric(props: Props) {
             </Tooltip>
           )}
         </Typography>
-        <Typography variant="body1" color="text.primary">
+        <Typography component="div" variant="body1" color="text.primary" sx={{ width: '100%' }}>
           {props.value}
         </Typography>
       </Stack>

package/src/components/invoice/table.tsx

@@ -62,7 +62,7 @@ export default function InvoiceTable({ invoice, simple }: Props) {
             </TableCell>
           )}
         </TableRow>
-        {invoice.period_end && invoice.period_start && (
+        {invoice.period_end > 0 && invoice.period_start > 0 && (
           <TableRow sx={{ borderBottom: '1px solid #eee' }}>
             <TableCell align="left" colSpan={simple ? 4 : 5}>
               <Typography component="span" variant="body1" color="text.secondary">

package/src/components/payment-intent/list.tsx

@@ -108,7 +108,7 @@ export default function PaymentList({ customer_id, invoice_id, features }: ListP
           const item = data.list[index] as TPaymentIntentExpanded;
           return (
             <Typography component="strong" fontWeight={600}>
-              {fromUnitToToken(item?.amount, item?.paymentCurrency.decimal)}&nbsp;
+              {fromUnitToToken(item?.amount_received, item?.paymentCurrency.decimal)}&nbsp;
               {item?.paymentCurrency.symbol}
             </Typography>
           );

package/src/components/payment-link/after-pay.tsx

@@ -70,25 +70,6 @@ export default function AfterPay() {
           )}
         />
       )}
-      <Typography variant="h6" sx={{ fontWeight: 600 }}>
-        {t('admin.invoices')}
-      </Typography>
-      <Controller
-        name="invoice_creation.enabled"
-        control={control}
-        render={({ field }) => (
-          <FormControlLabel
-            control={
-              <Checkbox
-                checked={getValues().invoice_creation.enabled}
-                {...field}
-                onChange={(_, checked) => setValue(field.name, checked)}
-              />
-            }
-            label={t('admin.paymentLink.createInvoice')}
-          />
-        )}
-      />
       <Controller
         name="nft_mint_settings.enabled"
         control={control}