payment-kit 1.13.246 → 1.13.247

package/api/src/libs/subscription.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-await-in-loop */
 import component from '@blocklet/sdk/lib/component';
 import { BN } from '@ocap/util';
 import type { LiteralUnion } from 'type-fest';
@@ -7,11 +8,13 @@ import {
   Customer,
   Invoice,
   InvoiceItem,
+  PaymentCurrency,
   Price,
   PriceRecurring,
   Subscription,
   SubscriptionItem,
   TLineItemExpanded,
+  UsageRecord,
 } from '../store/models';
 import dayjs from './dayjs';
 import logger from './logger';
@@ -377,3 +380,50 @@ export async function expandSubscriptionItems(subscriptionId: string) {
   const items = await SubscriptionItem.findAll({ where: { subscription_id: subscriptionId } });
   return Price.expand(items.map((x) => x.toJSON()));
 }
+
+export async function getUpcomingInvoiceAmount(subscriptionId: string) {
+  const subscription = await Subscription.findByPk(subscriptionId);
+  if (!subscription) {
+    throw new Error('Subscription not found');
+  }
+
+  if (subscription.isActive() === false) {
+    throw new Error('Subscription not active, so usage check is skipped');
+  }
+
+  const currency = await PaymentCurrency.findByPk(subscription.currency_id);
+
+  const items = await SubscriptionItem.findAll({ where: { subscription_id: subscriptionId } });
+  const expanded = await Price.expand(items.map((x) => x.toJSON()));
+
+  let amount = new BN(0);
+  for (const item of expanded) {
+    const price = getSubscriptionItemPrice(item);
+    if (price.type === 'recurring') {
+      const unit = getPriceUintAmountByCurrency(price, subscription.currency_id);
+      if (price.recurring?.usage_type === 'licensed') {
+        amount = amount.add(new BN(unit).mul(new BN(item.quantity)));
+      }
+      if (price.recurring?.usage_type === 'metered') {
+        const rawQuantity = await UsageRecord.getSummary({
+          // @ts-ignore
+          id: item?.id as string,
+          start: subscription.current_period_start,
+          end: subscription.current_period_end,
+          method: price.recurring?.aggregate_usage as any,
+          dryRun: true,
+        });
+        // @ts-ignore
+        const quantity = price.transformQuantity(rawQuantity);
+        amount = amount.add(new BN(unit).mul(new BN(quantity)));
+      }
+    }
+  }
+
+  return {
+    amount: amount.toString(),
+    start: subscription.current_period_start,
+    end: subscription.current_period_end,
+    currency,
+  };
+}

package/api/src/routes/subscriptions.ts

@@ -12,7 +12,12 @@ import logger from '../libs/logger';
 import { isDelegationSufficientForPayment } from '../libs/payment';
 import { authenticate } from '../libs/security';
 import { expandLineItems, getFastCheckoutAmount, isLineItemAligned } from '../libs/session';
-import { createProration, getSubscriptionCreateSetup, getSubscriptionRefundSetup } from '../libs/subscription';
+import {
+  createProration,
+  getSubscriptionCreateSetup,
+  getSubscriptionRefundSetup,
+  getUpcomingInvoiceAmount,
+} from '../libs/subscription';
 import { MAX_SUBSCRIPTION_ITEM_COUNT, formatMetadata } from '../libs/util';
 import { invoiceQueue } from '../queues/invoice';
 import { addSubscriptionJob, subscriptionQueue } from '../queues/subscription';
@@ -1469,4 +1474,15 @@ router.get('/:id/summary', authPortal, async (req, res) => {
   }
 });
 
+// Get upcoming invoice amount
+router.get('/:id/upcoming', authPortal, async (req, res) => {
+  try {
+    const result = await getUpcomingInvoiceAmount(req.params.id as string);
+    return res.json(result);
+  } catch (err) {
+    console.error(err);
+    return res.json({ error: err.message });
+  }
+});
+
 export default router;

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.246",
+  "version": "1.13.247",
   "scripts": {
     "dev": "cross-env COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev --open",
     "eject": "vite eject",
@@ -51,7 +51,7 @@
     "@arcblock/ux": "^2.9.77",
     "@arcblock/validator": "^1.18.116",
     "@blocklet/logger": "1.16.26",
-    "@blocklet/payment-react": "1.13.246",
+    "@blocklet/payment-react": "1.13.247",
     "@blocklet/sdk": "1.16.26",
     "@blocklet/ui-react": "^2.9.77",
     "@blocklet/uploader": "^0.1.6",
@@ -116,7 +116,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.26",
     "@arcblock/eslint-config-ts": "^0.3.0",
-    "@blocklet/payment-types": "1.13.246",
+    "@blocklet/payment-types": "1.13.247",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -155,5 +155,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "2d37d4058cf3b15568f5c49457c32e7bf29b8359"
+  "gitHead": "517ee5ea4b2af99ce581dc74904ef30b08cbd32e"
 }

package/src/components/subscription/metrics.tsx

@@ -1,6 +1,7 @@
 import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
-import { formatTime } from '@blocklet/payment-react';
+import { api, formatBNStr, formatTime } from '@blocklet/payment-react';
 import type { TSubscriptionExpanded } from '@blocklet/payment-types';
+import { useRequest } from 'ahooks';
 
 import InfoMetric from '../info-metric';
 
@@ -8,8 +9,14 @@ type Props = {
   subscription: TSubscriptionExpanded;
 };
 
+const fetchUpcoming = (id: string): Promise<{ amount: string }> => {
+  return api.get(`/api/subscriptions/${id}/upcoming`).then((res) => res.data);
+};
+
 export default function SubscriptionMetrics({ subscription }: Props) {
   const { t } = useLocaleContext();
+  const { data: upcoming } = useRequest(() => fetchUpcoming(subscription.id));
+
   let scheduleToCancelTime = 0;
   if (['active', 'trialing', 'past_due'].includes(subscription.status) && subscription.cancel_at) {
     scheduleToCancelTime = subscription.cancel_at * 1000;
@@ -31,6 +38,15 @@ export default function SubscriptionMetrics({ subscription }: Props) {
           divider
         />
       )}
+      {upcoming && upcoming.amount !== '0' && (
+        <InfoMetric
+          label={t('admin.subscription.nextInvoiceAmount')}
+          value={`${formatBNStr(upcoming.amount, subscription.paymentCurrency.decimal)} ${
+            subscription.paymentCurrency.symbol
+          } (${t('common.estimated')})`}
+          divider
+        />
+      )}
       {scheduleToCancelTime > 0 && (
         <InfoMetric label={t('admin.subscription.cancel.schedule')} value={formatTime(scheduleToCancelTime)} divider />
       )}

package/src/locales/en.tsx

@@ -4,6 +4,7 @@ export default flat({
   common: {
     redirecting: 'Redirecting...',
     title: 'Name',
+    estimated: 'Estimated',
     metadata: {
       label: 'Metadata',
       add: 'Add more metadata',
@@ -384,6 +385,7 @@ export default flat({
       discount: 'Discount',
       startedAt: 'Started',
       nextInvoice: 'Next Invoice',
+      nextInvoiceAmount: 'Next Invoice Amount',
       itemId: 'Subscription Item ID',
       update: 'Update subscription',
       resume: 'Resume payment collection',

package/src/locales/zh.tsx

@@ -4,6 +4,7 @@ export default flat({
   common: {
     redirecting: '跳转中...',
     title: '名称',
+    estimated: '预估',
     metadata: {
       label: '元数据',
       add: '添加更多元数据',
@@ -375,7 +376,8 @@ export default flat({
       trialEnd: '试用期结束于{date}',
       discount: '折扣',
       startedAt: '开始于',
-      nextInvoice: '下一张账单',
+      nextInvoice: '下次账单时间',
+      nextInvoiceAmount: '下次账单金额',
       itemId: '订阅项目ID',
       update: '更新订阅',
       resume: '恢复付款',