payment-kit 1.13.95 → 1.13.97

package/api/src/libs/product.ts

@@ -1,6 +1,15 @@
-import { CheckoutSession, Price, Product } from '../store/models';
+import isEmpty from 'lodash/isEmpty';
+
+import { CheckoutSession, Price, Product, Subscription } from '../store/models';
 
 export async function getMainProductName(subscriptionId: string): Promise<string> {
+  const subscription = await Subscription.findByPk(subscriptionId);
+
+  // @see: https://github.com/ArcBlock/did-spaces/issues/962#issuecomment-1880549421
+  if (subscription && !isEmpty(subscription.description)) {
+    return subscription.description!;
+  }
+
   const checkoutSession = await CheckoutSession.findOne({
     where: {
       subscription_id: subscriptionId,

package/api/src/routes/subscriptions.ts

@@ -37,6 +37,7 @@ import type { LineItem, SubscriptionUpdateItem } from '../store/models/types';
 import { UsageRecord } from '../store/models/usage-record';
 import { sequelize } from '../store/sequelize';
 import { ensureInvoiceAndItems } from './connect/shared';
+import { createUsageRecordQueryFn } from './usage-records';
 
 const router = Router();
 const auth = authenticate<Subscription>({ component: true, roles: ['owner', 'admin'] });
@@ -1068,4 +1069,9 @@ router.delete('/:id', auth, async (req, res) => {
   return res.json(doc);
 });
 
+// Get usage records
+router.get('/:id/usage-records', authPortal, (req, res) => {
+  createUsageRecordQueryFn(req.doc)(req, res);
+});
+
 export default router;

package/api/src/routes/usage-records.ts

@@ -1,5 +1,5 @@
 /* eslint-disable consistent-return */
-import { Router } from 'express';
+import { Request, Response, Router } from 'express';
 import Joi from 'joi';
 import pick from 'lodash/pick';
 import { Op } from 'sequelize';
@@ -121,34 +121,38 @@ router.get('/summary', auth, async (req, res) => {
   }
 });
 
-router.get('/', auth, async (req, res) => {
-  const { page, pageSize, ...query } = await schema.validateAsync(req.query, { stripUnknown: true });
+export function createUsageRecordQueryFn(doc?: Subscription) {
+  return async (req: Request, res: Response) => {
+    const { page, pageSize, ...query } = await schema.validateAsync(req.query, { stripUnknown: true });
 
-  try {
-    const item = await SubscriptionItem.findByPk(query.subscription_item_id);
-    if (!item) {
-      return res.status(400).json({ error: `SubscriptionItem not found: ${query.subscription_item_id}` });
-    }
-    const subscription = await Subscription.findByPk(item.subscription_id);
-    if (!subscription) {
-      return res.status(400).json({ error: `Subscription not found: ${item.subscription_id}` });
-    }
+    try {
+      const item = await SubscriptionItem.findByPk(query.subscription_item_id);
+      if (!item) {
+        return res.status(400).json({ error: `SubscriptionItem not found: ${query.subscription_item_id}` });
+      }
+      const subscription = doc || (await Subscription.findByPk(item.subscription_id));
+      if (!subscription) {
+        return res.status(400).json({ error: `Subscription not found: ${item.subscription_id}` });
+      }
 
-    const { rows: list, count } = await UsageRecord.findAndCountAll({
-      where: {
-        subscription_item_id: query.subscription_item_id,
-        timestamp: { [Op.gte]: subscription.current_period_start, [Op.lt]: subscription.current_period_end },
-      },
-      order: [['created_at', 'DESC']],
-      offset: (page - 1) * pageSize,
-      limit: pageSize,
-    });
+      const { rows: list, count } = await UsageRecord.findAndCountAll({
+        where: {
+          subscription_item_id: query.subscription_item_id,
+          timestamp: { [Op.gte]: subscription.current_period_start, [Op.lt]: subscription.current_period_end },
+        },
+        order: [['created_at', 'DESC']],
+        offset: (page - 1) * pageSize,
+        limit: pageSize,
+      });
+
+      res.json({ count, list });
+    } catch (err) {
+      console.error(err);
+      res.json({ count: 0, list: [] });
+    }
+  };
+}
 
-    res.json({ count, list });
-  } catch (err) {
-    console.error(err);
-    res.json({ count: 0, list: [] });
-  }
-});
+router.get('/', auth, createUsageRecordQueryFn());
 
 export default router;

package/api/tests/libs/session.spec.ts

@@ -1,8 +1,10 @@
+import dayjs from '../../src/libs/dayjs';
 import {
   getCheckoutMode,
   getPriceCurrencyOptions,
   getPriceUintAmountByCurrency,
   getRecurringPeriod,
+  getSubscriptionCreateSetup,
 } from '../../src/libs/session';
 import type { TLineItemExpanded } from '../../src/store/models';
 
@@ -60,6 +62,7 @@ describe('getPriceCurrencyOptions', () => {
     expect(result).toEqual([{ currency_id: 'usd', unit_amount: 1000, tiers: null, custom_unit_amount: null }]);
   });
 });
+
 describe('getPriceUintAmountByCurrency', () => {
   it('should return the unit_amount of the matching currency_id in currency_options', () => {
     const price = {
@@ -96,6 +99,7 @@ describe('getPriceUintAmountByCurrency', () => {
     expect(result).toBe(1000);
   });
 });
+
 describe('getRecurringPeriod', () => {
   it('should return the correct period in milliseconds when interval is "hour"', () => {
     const recurring = { interval: 'hour', interval_count: '1' };
@@ -133,3 +137,78 @@ describe('getRecurringPeriod', () => {
     expect(result).toBe(0);
   });
 });
+
+describe('getSubscriptionCreateSetup', () => {
+  const currencies = [
+    {
+      currency_id: 'usd',
+      unit_amount: '1',
+    },
+  ];
+
+  it('should calculate setup for recurring licensed price type', () => {
+    const items = [
+      {
+        price: { type: 'one_time', currency_options: currencies },
+        quantity: 1,
+      },
+      {
+        price: {
+          type: 'recurring',
+          currency_options: currencies,
+          recurring: { interval: 'day', interval_count: '1', usage_type: 'licensed' },
+        },
+        quantity: 2,
+      },
+    ];
+    const result = getSubscriptionCreateSetup(items as any, 'usd');
+    expect(result.amount.setup).toBe('3');
+  });
+
+  it('should not calculate setup for recurring metered price type', () => {
+    const items = [
+      {
+        price: { type: 'one_time', currency_options: currencies },
+        quantity: 1,
+      },
+      {
+        price: {
+          type: 'recurring',
+          currency_options: currencies,
+          recurring: { interval: 'day', interval_count: '1', usage_type: 'metered' },
+        },
+        quantity: 2,
+      },
+    ];
+    const result = getSubscriptionCreateSetup(items as any, 'usd');
+    expect(result.amount.setup).toBe('1');
+  });
+
+  it('should calculate cycle duration for recurring price type', () => {
+    const items = [
+      {
+        price: { type: 'recurring', currency_options: currencies, recurring: { interval: 'day', interval_count: '1' } },
+        quantity: 2,
+      },
+    ];
+    const result = getSubscriptionCreateSetup(items as any, 'usd');
+    expect(result.cycle.duration).toBe(24 * 60 * 60 * 1000);
+  });
+
+  it('should calculate trial period when trialInDays is provided', () => {
+    const items = [
+      {
+        price: { type: 'recurring', currency_options: currencies, recurring: { interval: 'day', interval_count: '1' } },
+        quantity: 2,
+      },
+    ];
+    const result = getSubscriptionCreateSetup(items as any, 'usd', 7);
+    const now = dayjs().unix();
+    expect(result.trail.start).toBe(now);
+    expect(result.trail.end).toBe(
+      dayjs()
+        .add(7 * 24 * 60 * 60 * 1000, 'millisecond')
+        .unix()
+    );
+  });
+});

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.95
+version: 1.13.97
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.95",
+  "version": "1.13.97",
   "scripts": {
     "dev": "COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev",
     "eject": "vite eject",
@@ -110,7 +110,7 @@
     "@abtnode/types": "1.16.21",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.95",
+    "@did-pay/types": "1.13.97",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -149,5 +149,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "7cdc672350689926b95a75edc7db8e08007ab6dd"
+  "gitHead": "f9ca9bf2030d0a2552b71c66470cbaf3964df0f8"
 }

package/src/components/invoice/table.tsx

@@ -19,8 +19,8 @@ InvoiceTable.defaultProps = {
 
 export function getAppliedBalance(invoice: TInvoiceExpanded) {
   if (invoice.paymentMethod.type === 'stripe') {
-    const starting = toBN(invoice.starting_balance);
-    const ending = toBN(invoice.ending_balance);
+    const starting = toBN(invoice.starting_balance || '0');
+    const ending = toBN(invoice.ending_balance || '0');
     return ending.sub(starting).toString();
   }
 

package/src/components/portal/subscription/list.tsx

@@ -48,7 +48,7 @@ export default function CurrentSubscriptions({ id, onChange, onClickSubscription
   }
 
   if (data && data.list.length === 0) {
-    return <Typography color="text.secondary">{t('customer.subscription.empty')}</Typography>;
+    return <Typography color="text.secondary">{t('customer.subscriptions.empty')}</Typography>;
   }
 
   const hasMore = data && data.list.length < data.count;

package/src/components/subscription/items/index.tsx

@@ -32,7 +32,8 @@ export default function SubscriptionItemList({ data, currency, mode }: ListProps
           return (
             <Stack>
               <Typography color="text.primary" fontWeight={600}>
-                {item?.price.product.name} - {item?.price_id}
+                {item?.price.product.name}
+                {mode === 'customer' ? '' : ` - ${item?.price_id}`}
               </Typography>
               <Typography color="text.secondary">
                 {formatPrice(item.price, currency, item?.price.product.unit_label)}
@@ -58,7 +59,11 @@ export default function SubscriptionItemList({ data, currency, mode }: ListProps
       options: {
         customBodyRenderLite: (_: string, index: number) => {
           const item = data[index] as TSubscriptionItemExpanded;
-          return item.price.recurring?.usage_type === 'metered' ? <UsageRecords id={item.id} /> : item.quantity;
+          return item.price.recurring?.usage_type === 'metered' ? (
+            <UsageRecords subscriptionId={item.subscription_id} id={item.id} />
+          ) : (
+            item.quantity
+          );
         },
       },
     },

package/src/components/subscription/items/usage-records.tsx

@@ -9,13 +9,17 @@ import { formatToDatetime } from '../../../libs/util';
 import ConfirmDialog from '../../confirm';
 import Table from '../../table';
 
-const fetchData = (id: string): Promise<{ list: TUsageRecord[]; count: number }> => {
-  return api.get(`/api/usage-records?subscription_item_id=${id}&pageSize=100`).then((res) => res.data);
+const fetchData = (subscriptionId: string, id: string): Promise<{ list: TUsageRecord[]; count: number }> => {
+  return api
+    .get(`/api/subscriptions/${subscriptionId}/usage-records?subscription_item_id=${id}&pageSize=100`)
+    .then((res) => res.data);
 };
 
-export function UsageRecordDialog(props: { id: string; onConfirm: any }) {
+export function UsageRecordDialog(props: { subscriptionId: string; id: string; onConfirm: any }) {
   const { t } = useLocaleContext();
-  const { loading, error, data } = useRequest(() => fetchData(props.id), { refreshDeps: [props.id] });
+  const { loading, error, data } = useRequest(() => fetchData(props.subscriptionId, props.id), {
+    refreshDeps: [props.subscriptionId, props.id],
+  });
 
   if (error) {
     return (
@@ -84,7 +88,7 @@ export function UsageRecordDialog(props: { id: string; onConfirm: any }) {
   );
 }
 
-export default function UsageRecords({ id }: { id: string }) {
+export default function UsageRecords({ subscriptionId, id }: { subscriptionId: string; id: string }) {
   const { t } = useLocaleContext();
   const [open, setOpen] = useState(false);
   return (
@@ -92,7 +96,7 @@ export default function UsageRecords({ id }: { id: string }) {
       <Button size="small" variant="text" color="info" onClick={() => setOpen(true)}>
         {t('admin.subscription.usage.view')}
       </Button>
-      {open && <UsageRecordDialog id={id} onConfirm={() => setOpen(false)} />}
+      {open && <UsageRecordDialog subscriptionId={subscriptionId} id={id} onConfirm={() => setOpen(false)} />}
     </Box>
   );
 }

package/src/pages/customer/index.tsx

@@ -13,6 +13,7 @@ import InfoRow from '../../components/info-row';
 import CustomerInvoiceList from '../../components/portal/invoice/list';
 import CurrentSubscriptions from '../../components/portal/subscription/list';
 import SectionHeader from '../../components/section/header';
+import { useSessionContext } from '../../contexts/session';
 import api from '../../libs/api';
 import { formatError } from '../../libs/util';
 
@@ -22,14 +23,16 @@ const fetchData = (): Promise<TCustomerExpanded> => {
 
 export default function CustomerHome() {
   const { t } = useLocaleContext();
-  const [state, setState] = useSetState({
-    editing: false,
-    loading: false,
-  });
+  const { events } = useSessionContext();
+  const [state, setState] = useSetState({ editing: false, loading: false });
   const navigate = useNavigate();
 
   const { loading, error, data, runAsync } = useRequest(fetchData);
 
+  events.once('switch-did', () => {
+    runAsync().catch(console.error);
+  });
+
   if (error) {
     return <Alert severity="error">{formatError(error)}</Alert>;
   }

package/src/pages/customer/subscription/detail.tsx

@@ -117,7 +117,7 @@ export default function CustomerSubscriptionDetail() {
       </Box>
 
       <Box className="section">
-        <SectionHeader title={t('admin.product.pricing')} mb={0} />
+        <SectionHeader title={t('admin.products')} mb={0} />
         <Box className="section-body">
           <SubscriptionItemList data={data.items} currency={data.paymentCurrency} mode="customer" />
         </Box>