payment-kit 1.19.0 → 1.19.2

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

@@ -1,28 +1,15 @@
 /* eslint-disable @typescript-eslint/brace-style */
 /* eslint-disable @typescript-eslint/indent */
 import pWaitFor from 'p-wait-for';
-import prettyMsI18n from 'pretty-ms-i18n';
 import isEmpty from 'lodash/isEmpty';
 
-import { getPaymentAmountForCycleSubscription, getCustomerSubscriptionPageUrl } from '../../subscription';
-import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { getPaymentAmountForCycleSubscription } from '../../subscription';
 import { translate } from '../../../locales';
-import {
-  CheckoutSession,
-  Customer,
-  NftMintItem,
-  PaymentIntent,
-  PaymentMethod,
-  Subscription,
-  PaymentCurrency,
-  Invoice,
-  NFTMintChainType,
-} from '../../../store/models';
-import { getCustomerInvoicePageUrl, getOneTimeProductInfo } from '../../invoice';
-import { getMainProductName } from '../../product';
-import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import { formatCurrencyInfo, getExplorerLink, getSubscriptionNotificationCustomActions } from '../../util';
-import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { CheckoutSession, NftMintItem, PaymentIntent, Invoice, NFTMintChainType } from '../../../store/models';
+import { getOneTimeProductInfo } from '../../invoice';
+import { formatTime } from '../../time';
+import { formatCurrencyInfo, getExplorerLink } from '../../util';
+import { BaseSubscriptionEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionSucceededEmailTemplateOptions {
   subscriptionId: string;
@@ -50,37 +37,31 @@ interface SubscriptionSucceededEmailTemplateContext {
   viewTxHashLink: string | undefined;
   oneTimeProductInfo?: Array<OneTimeProductInfo>;
   customActions: any[];
+  isCreditSubscription: boolean;
 }
 
-export class SubscriptionSucceededEmailTemplate
-  implements BaseEmailTemplate<SubscriptionSucceededEmailTemplateContext>
-{
+export class SubscriptionSucceededEmailTemplate extends BaseSubscriptionEmailTemplate<SubscriptionSucceededEmailTemplateContext> {
   options: SubscriptionSucceededEmailTemplateOptions;
 
   constructor(options: SubscriptionSucceededEmailTemplateOptions) {
+    super();
     this.options = options;
   }
 
   async getContext(): Promise<SubscriptionSucceededEmailTemplateContext> {
-    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
-    if (!subscription) {
-      throw new Error(`Subscription not found: ${this.options.subscriptionId}`);
-    }
+    // 获取基础订阅数据
+    const basicData = await this.getSubscriptionBasicData(this.options.subscriptionId);
+    const { subscription, userDid, locale, productName, paymentCurrency, isCreditSubscription } = basicData;
+
     if (subscription.status !== 'active') {
       throw new Error(`Subscription not active: ${this.options.subscriptionId}`);
     }
 
-    const customer = await Customer.findByPk(subscription.customer_id);
-    if (!customer) {
-      throw new Error(`Customer not found: ${subscription.customer_id}`);
-    }
-
+    // 等待相关数据准备就绪
     await pWaitFor(
       async () => {
         const invoice = await Invoice.findOne({
-          where: {
-            subscription_id: subscription.id,
-          },
+          where: { subscription_id: subscription.id },
           order: [['created_at', 'ASC']],
         });
         const checkoutSession = await CheckoutSession.findBySubscriptionId(subscription.id);
@@ -94,95 +75,81 @@ export class SubscriptionSucceededEmailTemplate
     );
 
     const invoice = (await Invoice.findByPk(subscription.latest_invoice_id)) as Invoice;
-    const paymentCurrency = (await PaymentCurrency.findOne({
-      where: {
-        id: subscription.currency_id,
-      },
-    })) as PaymentCurrency;
 
-    const checkoutSession = await CheckoutSession.findBySubscriptionId(subscription.id);
+    // 获取支付信息
+    const paymentInfoResult = await this.getPaymentInfo(
+      subscription,
+      paymentCurrency,
+      isCreditSubscription,
+      invoice?.id
+    );
+
+    // 获取链接
+    const links = this.generateSubscriptionLinks(
+      subscription,
+      locale,
+      userDid,
+      'customer.subscription.started',
+      invoice?.id,
+      isCreditSubscription
+    );
 
-    const userDid: string = customer.did;
-    const locale = await getUserLocale(userDid);
-    const productName = await getMainProductName(subscription.id);
-    const at: string = formatTime(subscription.created_at);
+    // 获取 NFT 信息
+    const nftInfo = await this.getNftMintInfo(subscription.id);
 
+    // 获取一次性产品信息
     const oneTimeProductInfo = await getOneTimeProductInfo(subscription.latest_invoice_id as string, paymentCurrency);
-    const paymentAmount = await getPaymentAmountForCycleSubscription(subscription, paymentCurrency);
 
-    const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
-    const nftMintItem: NftMintItem | undefined = hasNft
-      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
-      : undefined;
-    const currentPeriodStart: string = formatTime((subscription.current_period_start || invoice.period_start) * 1000);
-    const currentPeriodEnd: string = formatTime((subscription.current_period_end || invoice.period_end) * 1000);
-    const duration: string = prettyMsI18n(
-      new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
-      {
-        locale: getPrettyMsI18nLocale(locale),
-      }
+    // 计算支付金额和时间信息
+    const paymentAmount = await getPaymentAmountForCycleSubscription(subscription, paymentCurrency);
+    const formattedPaymentInfo = formatCurrencyInfo(
+      paymentAmount,
+      paymentCurrency,
+      paymentInfoResult.paymentMethod,
+      true
     );
 
-    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
-    const paymentInfo: string = formatCurrencyInfo(paymentAmount, paymentCurrency, paymentMethod, true);
-
-    // @FIXME: 获取 chainHost 困难的一批?
-    const chainHost: string | undefined =
-      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.api_host;
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
-      subscriptionId: subscription.id,
-      locale,
-      userDid,
-    });
-    const viewInvoiceLink = getCustomerInvoicePageUrl({
-      invoiceId: invoice.id,
-      userDid,
-      locale,
-    });
+    const periodInfo = this.formatSubscriptionPeriod(
+      subscription.current_period_start || invoice.period_start,
+      subscription.current_period_end || invoice.period_end,
+      locale
+    );
 
+    // 获取交易哈希链接
+    const checkoutSession = await CheckoutSession.findBySubscriptionId(subscription.id);
     const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
     const txHash: string | undefined =
       paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.tx_hash;
-    const viewTxHashLink: string | undefined =
-      txHash &&
-      getExplorerLink({
-        type: 'tx',
-        did: txHash,
-        chainHost,
-      });
 
-    const customActions = getSubscriptionNotificationCustomActions(
-      subscription,
-      'customer.subscription.started',
-      locale
-    );
+    const chainHost: string | undefined =
+      paymentInfoResult.paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
+        ?.api_host;
+
+    const viewTxHashLink: string | undefined = txHash && getExplorerLink({ type: 'tx', did: txHash, chainHost });
 
     return {
       locale,
       productName,
-      at,
-
+      at: formatTime(subscription.created_at),
       userDid,
-      nftMintItem,
+      nftMintItem: nftInfo.nftMintItem,
       chainHost,
-      paymentInfo,
-      currentPeriodStart,
-      currentPeriodEnd,
-      duration,
-
-      viewSubscriptionLink,
-      viewInvoiceLink,
+      paymentInfo: formattedPaymentInfo,
+      currentPeriodStart: periodInfo.currentPeriodStart,
+      currentPeriodEnd: periodInfo.currentPeriodEnd,
+      duration: periodInfo.duration,
+      viewSubscriptionLink: links.viewSubscriptionLink,
+      viewInvoiceLink: links.viewInvoiceLink!,
       viewTxHashLink,
       oneTimeProductInfo,
-      customActions,
+      customActions: links.customActions,
+      isCreditSubscription,
     };
   }
 
-  getOneTimeProductTemplate(oneTimeProductInfo: Array<OneTimeProductInfo>, locale: string = 'en') {
+  private getOneTimeProductTemplate(oneTimeProductInfo: Array<OneTimeProductInfo>, locale: string = 'en') {
     return [
-      {
-        type: 'divider',
-      },
+      { type: 'divider' },
       {
         type: 'text',
         data: {
@@ -203,10 +170,7 @@ export class SubscriptionSucceededEmailTemplate
           },
           {
             type: 'text',
-            data: {
-              type: 'plain',
-              text: x?.productName,
-            },
+            data: { type: 'plain', text: x?.productName },
           },
           {
             type: 'text',
@@ -218,10 +182,7 @@ export class SubscriptionSucceededEmailTemplate
           },
           {
             type: 'text',
-            data: {
-              type: 'plain',
-              text: x?.paymentInfo,
-            },
+            data: { type: 'plain', text: x?.paymentInfo },
           },
           {
             type: 'text',
@@ -235,16 +196,16 @@ export class SubscriptionSucceededEmailTemplate
             type: 'text',
             data: {
               type: 'plain',
-              text: translate('notification.common.qty', locale, {
-                count: x.quantity,
-              }),
+              text: translate('notification.common.qty', locale, { count: x.quantity }),
             },
           },
         ]),
       },
     ];
   }
+
   async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
     const {
       locale,
       productName,
@@ -261,26 +222,41 @@ export class SubscriptionSucceededEmailTemplate
       viewTxHashLink,
       oneTimeProductInfo,
       customActions,
-    } = await this.getContext();
+      isCreditSubscription,
+    } = context;
+
     const hasOneTimeProduct = !isEmpty(oneTimeProductInfo);
 
+    // 构建基础字段
+    const commonFields = this.buildCommonFields(userDid, productName, locale);
+    const paymentFields = this.buildPaymentField(paymentInfo, locale, isCreditSubscription);
+    const periodFields = this.buildPeriodField(
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      locale,
+      isCreditSubscription
+    );
+
+    // 构建操作按钮
+    const actions = this.buildCommonActions(viewSubscriptionLink, viewInvoiceLink, locale, isCreditSubscription, [
+      viewTxHashLink && {
+        name: translate('notification.common.viewTxHash', locale),
+        title: translate('notification.common.viewTxHash', locale),
+        link: viewTxHashLink as string,
+      },
+      ...customActions,
+    ]);
+
     const template: BaseEmailTemplateType = {
-      title: `${translate('notification.subscriptionSucceed.title', locale, {
-        productName,
-      })}`,
-      body: `${translate('notification.subscriptionSucceed.body', locale, {
-        at,
-        productName,
-      })}`,
+      title: translate('notification.subscriptionSucceed.title', locale, { productName }),
+      body: translate('notification.subscriptionSucceed.body', locale, { at, productName }),
       // @ts-expect-error
       attachments: [
         nftMintItem &&
           chainHost && {
             type: 'asset',
-            data: {
-              chainHost,
-              did: nftMintItem.address,
-            },
+            data: { chainHost, did: nftMintItem.address },
           },
         hasOneTimeProduct && {
           type: 'text',
@@ -291,92 +267,14 @@ export class SubscriptionSucceededEmailTemplate
         },
         {
           type: 'section',
-          fields: [
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.account', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: userDid,
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.product', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: productName,
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.paymentAmount', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: paymentInfo,
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.validityPeriod', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
-              },
-            },
-          ].filter(Boolean),
+          fields: [...commonFields, ...paymentFields, ...periodFields].filter(Boolean),
         },
         ...(hasOneTimeProduct
           ? this.getOneTimeProductTemplate(oneTimeProductInfo as Array<OneTimeProductInfo>, locale)
           : []),
       ].filter(Boolean),
       // @ts-ignore
-      actions: [
-        {
-          name: translate('notification.common.viewSubscription', locale),
-          title: translate('notification.common.viewSubscription', locale),
-          link: viewSubscriptionLink,
-        },
-        {
-          name: translate('notification.common.viewInvoice', locale),
-          title: translate('notification.common.viewInvoice', locale),
-          link: viewInvoiceLink,
-        },
-        viewTxHashLink && {
-          name: translate('notification.common.viewTxHash', locale),
-          title: translate('notification.common.viewTxHash', locale),
-          link: viewTxHashLink as string,
-        },
-        ...customActions,
-      ].filter(Boolean),
+      actions: actions.filter(Boolean),
     };
 
     return template;