payment-kit 1.18.17 → 1.18.19

package/api/src/libs/subscription.ts

@@ -1563,3 +1563,119 @@ export async function getSubscriptionUnpaidInvoicesCount(subscription: Subscript
     return 0;
   }
 }
+
+/**
+ * Calculate recommended recharge amount for subscription cycles
+ * @param subscriptions List of subscriptions
+ * @param currencyId Currency ID
+ * @returns {amount: string, cycle: number, desc: string, interval: string} Recommended amount and cycle info
+ */
+export function calculateRecommendedRechargeAmount(subscriptions: any[], currencyId: string) {
+  if (!subscriptions || subscriptions.length === 0) {
+    return { amount: '0', cycle: 0, desc: 'no subscription', interval: '' };
+  }
+
+  type IntervalType = 'hour' | 'day' | 'month' | 'year';
+
+  // Group subscriptions by billing interval
+  const intervalSubscriptions: Record<IntervalType, any[]> = {
+    hour: [],
+    day: [],
+    month: [],
+    year: [],
+  };
+
+  // Classify subscriptions by interval
+  subscriptions.forEach((subscription) => {
+    if (!subscription.items?.length) return;
+
+    subscription.items.forEach((item: any) => {
+      const { price } = item;
+      if (price?.type === 'recurring' && price.recurring?.interval) {
+        const interval = price.recurring.interval as IntervalType;
+        if (Object.keys(intervalSubscriptions).includes(interval)) {
+          intervalSubscriptions[interval].push({ subscription, item, price });
+        }
+      }
+    });
+  });
+
+  const hasHourly = intervalSubscriptions.hour.length > 0;
+  const hasDaily = intervalSubscriptions.day.length > 0;
+  const hasMonthly = intervalSubscriptions.month.length > 0;
+  const hasYearly = intervalSubscriptions.year.length > 0;
+
+  // Determine recommended cycle based on subscription intervals
+  let recommendedInterval = '';
+  let cycleInSeconds = 0;
+  let desc = '';
+
+  if (hasMonthly) {
+    recommendedInterval = 'month';
+    cycleInSeconds = 30 * 24 * 60 * 60;
+    desc = 'monthly';
+  } else if ((hasHourly || hasDaily) && !hasYearly) {
+    recommendedInterval = 'week';
+    cycleInSeconds = 7 * 24 * 60 * 60;
+    desc = 'weekly';
+  } else if ((hasDaily || hasHourly) && hasYearly) {
+    recommendedInterval = 'month';
+    cycleInSeconds = 30 * 24 * 60 * 60;
+    desc = 'monthly';
+  } else if (hasYearly) {
+    recommendedInterval = 'year';
+    cycleInSeconds = 365 * 24 * 60 * 60;
+    desc = 'yearly';
+  }
+
+  let totalAmount = new BN(0);
+
+  // Calculate amount based on recommended cycle
+  subscriptions.forEach((subscription) => {
+    if (!subscription.items?.length) return;
+
+    subscription.items.forEach((item: any) => {
+      const { price } = item;
+      if (!price) return;
+
+      const unitAmount = getPriceUintAmountByCurrency(price, currencyId);
+      const quantity = item.quantity || 1;
+      let itemAmount = new BN(unitAmount).mul(new BN(quantity));
+
+      if (price.type === 'recurring' && price.recurring?.interval) {
+        const { interval } = price.recurring;
+        const intervalCount = price.recurring.interval_count || 1;
+
+        // Apply period conversion calculation
+        if (recommendedInterval === 'month') {
+          if (interval === 'hour') {
+            itemAmount = itemAmount.mul(new BN(720)).div(new BN(intervalCount));
+          } else if (interval === 'day') {
+            itemAmount = itemAmount.mul(new BN(30)).div(new BN(intervalCount));
+          } else if (interval === 'month') {
+            itemAmount = itemAmount.div(new BN(intervalCount));
+          } else if (interval === 'year') {
+            itemAmount = itemAmount.div(new BN(12 * intervalCount));
+          }
+        } else if (recommendedInterval === 'week') {
+          if (interval === 'hour') {
+            itemAmount = itemAmount.mul(new BN(168)).div(new BN(intervalCount));
+          } else if (interval === 'day') {
+            itemAmount = itemAmount.mul(new BN(7)).div(new BN(intervalCount));
+          }
+        }
+
+        totalAmount = totalAmount.add(itemAmount);
+      } else if (price.type === 'one_time') {
+        totalAmount = totalAmount.add(itemAmount);
+      }
+    });
+  });
+
+  return {
+    amount: totalAmount.toString(),
+    cycle: cycleInSeconds,
+    desc,
+    interval: recommendedInterval,
+  };
+}

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

@@ -46,10 +46,12 @@ import {
   formatAmountPrecisionLimit,
   formatMetadata,
   getDataObjectFromQuery,
+  getUserOrAppInfo,
   isUserInBlocklist,
 } from '../libs/util';
 import {
   Invoice,
+  PaymentBeneficiary,
   SetupIntent,
   Subscription,
   SubscriptionItem,
@@ -501,6 +503,11 @@ export async function ensureCheckoutSessionOpen(req: Request, res: Response, nex
   next();
 }
 
+const getBeneficiaryName = async (beneficiary: PaymentBeneficiary) => {
+  if (!beneficiary) return '';
+  return beneficiary.name || (await getUserOrAppInfo(beneficiary.address || ''))?.name || beneficiary.address;
+};
+
 export async function getCrossSellItem(checkoutSession: CheckoutSession) {
   // FIXME: perhaps we can support cross sell even if the current session have multiple items
   if (checkoutSession.line_items.length > 1) {
@@ -624,12 +631,32 @@ export async function startCheckoutSessionFromPaymentLink(id: string, req: Reque
         payment: 'Thanks for your purchase',
         subscription: 'Thanks for your subscribing',
         setup: 'Thanks for your subscribing',
-        donate: 'Thanks for for your tip',
+        donate: 'Thanks for your tip',
       };
       const mode = link.submit_type === 'donate' ? 'donate' : raw.mode;
       raw.payment_intent_data = {
         description: descriptions[mode || 'payment'],
       };
+      if (mode === 'donate') {
+        const beneficiaries = link.donation_settings?.beneficiaries || [];
+
+        if (beneficiaries.length > 0) {
+          // sort beneficiaries by share, the first one is the main beneficiary
+          const sortedBeneficiaries = [...beneficiaries].sort((a, b) => {
+            // Plain JavaScript comparison without using BN methods
+            return Number(b.share) - Number(a.share);
+          });
+          const mainBeneficiary = sortedBeneficiaries[0];
+          const userName = await getBeneficiaryName(mainBeneficiary as PaymentBeneficiary);
+
+          raw.payment_intent_data.description =
+            beneficiaries.length === 1
+              ? `Tip to ${userName}`
+              : `Tip to ${userName} and ${beneficiaries.length - 1} others`;
+        } else {
+          raw.payment_intent_data.description = 'Thanks for your tip';
+        }
+      }
     }
     if (link.after_completion?.redirect?.url) {
       raw.success_url = link.after_completion?.redirect?.url;

package/api/src/routes/customers.ts

@@ -22,7 +22,7 @@ import {
   Subscription,
   SubscriptionItem,
 } from '../store/models';
-import { getSubscriptionPaymentAddress } from '../libs/subscription';
+import { getSubscriptionPaymentAddress, calculateRecommendedRechargeAmount } from '../libs/subscription';
 import { expandLineItems } from '../libs/session';
 
 const router = Router();
@@ -272,12 +272,16 @@ router.get('/recharge', sessionMiddleware(), async (req, res) => {
       return payerAddress === customer.did;
     });
 
+    // Calculate recommended recharge cycle and amount
+    const recommendedRecharge = calculateRecommendedRechargeAmount(relatedSubscriptions, paymentCurrency.id);
+
     return res.json({
       currency: {
         ...paymentCurrency.toJSON(),
         paymentMethod,
       },
       relatedSubscriptions,
+      recommendedRecharge,
     });
   } catch (err) {
     logger.error('Error getting balance recharge info', err);

package/api/src/store/migrations/20250318-donate-invoice.ts

@@ -0,0 +1,45 @@
+import { QueryTypes } from 'sequelize';
+import { Migration } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  try {
+    await context.sequelize.query(
+      "UPDATE payment_intents SET description = 'Thanks for your tip' WHERE description = 'Thanks for for your tip'",
+      { type: QueryTypes.UPDATE }
+    );
+
+    await context.sequelize.query(
+      `UPDATE payment_intents SET description = 'Thanks for your tip' 
+       WHERE description = 'Thanks for your support'        
+       AND id IN (
+         SELECT payment_intent_id FROM checkout_sessions 
+         WHERE submit_type = 'donate' AND payment_intent_id IS NOT NULL
+       )`,
+      { type: QueryTypes.UPDATE }
+    );
+
+    await context.sequelize.query(
+      `UPDATE invoices SET description = 'Thanks for your tip' 
+       WHERE (description = 'Thanks for your support' OR description = 'Thanks for for your tip')
+       AND payment_intent_id IN (
+         SELECT payment_intent_id FROM checkout_sessions 
+         WHERE submit_type = 'donate' AND payment_intent_id IS NOT NULL
+       )`,
+      { type: QueryTypes.UPDATE }
+    );
+
+    await context.sequelize.query(
+      `UPDATE payouts SET description = 'Thanks for your tip' 
+       WHERE (description = 'Thanks for your support' OR description = 'Thanks for for your tip')
+       AND payment_intent_id IN (
+         SELECT payment_intent_id FROM checkout_sessions 
+         WHERE submit_type = 'donate' AND payment_intent_id IS NOT NULL
+       )`,
+      { type: QueryTypes.UPDATE }
+    );
+  } catch (error) {
+    console.error('Failed to update donation invoice descriptions', error);
+  }
+};
+
+export const down = async () => {};

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

@@ -11,6 +11,7 @@ import {
   shouldCancelSubscription,
   getSubscriptionStakeAmountSetup,
   checkUsageReportEmpty,
+  calculateRecommendedRechargeAmount,
 } from '../../src/libs/subscription';
 import { PaymentMethod, Subscription, SubscriptionItem, UsageRecord, Price } from '../../src/store/models';
 
@@ -565,3 +566,313 @@ describe('checkUsageReportEmpty', () => {
     expect(result).toBe(false);
   });
 });
+
+describe('calculateRecommendedRechargeAmount', () => {
+  // 测试空订阅列表
+  it('should return zero amount for empty subscriptions', () => {
+    const result = calculateRecommendedRechargeAmount([], 'usd');
+    expect(result).toEqual({ amount: '0', cycle: 0, desc: 'no subscription', interval: '' });
+  });
+
+  // 测试只有按小时订阅
+  it('should recommend weekly cycle for hourly subscriptions', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 2,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'hour', interval_count: 1 },
+              unit_amount: '10',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(7 * 24 * 60 * 60); // 一周的秒数
+    expect(result.desc).toBe('weekly');
+    expect(result.interval).toBe('week');
+    // 每小时10，一周168小时，两个单位，总计 10 * 168 * 2 = 3360
+    expect(result.amount).toBe('3360');
+  });
+
+  // 测试只有按天订阅
+  it('should recommend weekly cycle for daily subscriptions', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'day', interval_count: 1 },
+              unit_amount: '100',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(7 * 24 * 60 * 60);
+    expect(result.desc).toBe('weekly');
+    expect(result.interval).toBe('week');
+    // 每天100，一周7天，总计 100 * 7 = 700
+    expect(result.amount).toBe('700');
+  });
+
+  // 测试只有按月订阅
+  it('should recommend monthly cycle for monthly subscriptions', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'month', interval_count: 1 },
+              unit_amount: '500',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(30 * 24 * 60 * 60);
+    expect(result.desc).toBe('monthly');
+    expect(result.interval).toBe('month');
+    expect(result.amount).toBe('500');
+  });
+
+  // 测试中间档金额计算 (4x)
+  it('should calculate the medium preset amount correctly (4x)', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'month', interval_count: 1 },
+              unit_amount: '500',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.amount).toBe('500');
+
+    // 在UI中，我们应用Math.ceil(500 * 4) = 2000作为中间档预设值
+    const baseAmount = result.amount;
+    const mediumPresetAmount = Math.ceil(Number(baseAmount) * 4).toString();
+    expect(mediumPresetAmount).toBe('2000');
+  });
+
+  // 测试高档金额计算 (8x)
+  it('should calculate the high preset amount correctly (8x)', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'month', interval_count: 1 },
+              unit_amount: '500',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+
+    // 在UI中，我们应用Math.ceil(500 * 8) = 4000作为高档预设值
+    const baseAmount = result.amount;
+    const highPresetAmount = Math.ceil(Number(baseAmount) * 8).toString();
+    expect(highPresetAmount).toBe('4000');
+  });
+
+  // 测试前端默认选择中间档
+  it('should select medium preset by default in the UI', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'month', interval_count: 1 },
+              unit_amount: '500',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    const baseAmount = result.amount;
+
+    // 验证前端默认选择的中间档金额是基础金额的4倍
+    const defaultSelectedAmount = Math.ceil(Number(baseAmount) * 4).toString();
+    expect(defaultSelectedAmount).toBe('2000');
+  });
+
+  // 测试只有按年订阅
+  it('should recommend yearly cycle for yearly subscriptions', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'year', interval_count: 1 },
+              unit_amount: '1200',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(365 * 24 * 60 * 60);
+    expect(result.desc).toBe('yearly');
+    expect(result.amount).toBe('1200');
+  });
+
+  // 测试混合按小时和按年的订阅
+  it('should recommend monthly cycle for mixed hourly and yearly subscriptions', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'hour', interval_count: 1 },
+              unit_amount: '5',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'year', interval_count: 1 },
+              unit_amount: '1200',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(30 * 24 * 60 * 60);
+    expect(result.desc).toBe('monthly');
+    // 每小时5，一个月约720小时 + 年费1200/12个月
+    // 5 * 720 + 1200/12 = 3600 + 100 = 3700
+    expect(result.amount).toBe('3700');
+  });
+
+  // 测试混合小时、月、年的复杂订阅
+  it('should handle complex subscription combinations', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 2,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'hour', interval_count: 1 },
+              unit_amount: '5',
+              currency_id: 'usd',
+            },
+          },
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'month', interval_count: 1 },
+              unit_amount: '200',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'year', interval_count: 1 },
+              unit_amount: '1200',
+              currency_id: 'usd',
+            },
+          },
+          {
+            quantity: 1,
+            price: {
+              type: 'one_time',
+              unit_amount: '50',
+              currency_id: 'usd',
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(30 * 24 * 60 * 60);
+    expect(result.desc).toBe('monthly');
+    // 每小时5×2数量=10，一个月约720小时 + 每月200 + 年费1200/12个月 + 一次性费用50
+    // 10 * 720 + 200 + 1200/12 + 50 = 7200 + 200 + 100 + 50 = 7550
+    expect(result.amount).toBe('7550');
+  });
+
+  // 测试不同货币的处理
+  it('should handle currency options', () => {
+    const subscriptions = [
+      {
+        items: [
+          {
+            quantity: 1,
+            price: {
+              type: 'recurring',
+              recurring: { interval: 'month', interval_count: 1 },
+              currency_id: 'eth',
+              currency_options: [
+                { currency_id: 'usd', unit_amount: '300' },
+                { currency_id: 'btc', unit_amount: '0.01' },
+              ],
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = calculateRecommendedRechargeAmount(subscriptions, 'usd');
+    expect(result.cycle).toBe(30 * 24 * 60 * 60);
+    expect(result.desc).toBe('monthly');
+    expect(result.amount).toBe('300');
+  });
+});

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.18.17",
+  "version": "1.18.19",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -46,18 +46,18 @@
     "@abtnode/cron": "^1.16.40",
     "@arcblock/did": "^1.19.15",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@arcblock/did-connect": "^2.12.25",
+    "@arcblock/did-connect": "^2.12.36",
     "@arcblock/did-util": "^1.19.15",
     "@arcblock/jwt": "^1.19.15",
-    "@arcblock/ux": "^2.12.25",
+    "@arcblock/ux": "^2.12.36",
     "@arcblock/validator": "^1.19.15",
     "@blocklet/js-sdk": "^1.16.40",
     "@blocklet/logger": "^1.16.40",
-    "@blocklet/payment-react": "1.18.17",
+    "@blocklet/payment-react": "1.18.19",
     "@blocklet/sdk": "^1.16.40",
-    "@blocklet/ui-react": "^2.12.25",
-    "@blocklet/uploader": "^0.1.76",
-    "@blocklet/xss": "^0.1.28",
+    "@blocklet/ui-react": "^2.12.36",
+    "@blocklet/uploader": "^0.1.79",
+    "@blocklet/xss": "^0.1.30",
     "@mui/icons-material": "^5.16.6",
     "@mui/lab": "^5.0.0-alpha.173",
     "@mui/material": "^5.16.6",
@@ -121,7 +121,7 @@
   "devDependencies": {
     "@abtnode/types": "^1.16.40",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.18.17",
+    "@blocklet/payment-types": "1.18.19",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -167,5 +167,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "9d43381dd3744506455547260f5e621c6ad88e8f"
+  "gitHead": "eabd58598ad349a5177dca2e6302c82117d9b687"
 }

package/src/components/currency.tsx

@@ -1,15 +1,22 @@
-import { Avatar, Stack, Typography } from '@mui/material';
+import { Avatar, Stack, Typography, SxProps } from '@mui/material';
 
 type Props = {
   logo: string;
   name: string;
+  sx?: SxProps;
 };
 
-export default function Currency({ logo, name }: Props) {
+export default function Currency({ logo, name, sx }: Props) {
   return (
-    <Stack direction="row" alignItems="center" spacing={0.5}>
+    <Stack direction="row" alignItems="center" spacing={0.5} sx={sx}>
       <Avatar src={logo} alt={name} sx={{ width: 20, height: 20 }} />
-      <Typography color="text.primary">{name}</Typography>
+      <Typography color="text.primary" className="currency-name">
+        {name}
+      </Typography>
     </Stack>
   );
 }
+
+Currency.defaultProps = {
+  sx: {},
+};