payment-kit 1.19.0 → 1.19.1

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

@@ -1,17 +1,12 @@
 /* eslint-disable @typescript-eslint/brace-style */
 /* eslint-disable @typescript-eslint/indent */
-import prettyMsI18n from 'pretty-ms-i18n';
-
-import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { Customer, PaymentIntent, PaymentMethod, Refund, Subscription } from '../../../store/models';
+import { PaymentIntent, PaymentMethod, Refund, Subscription } from '../../../store/models';
 import { Invoice } from '../../../store/models/invoice';
 import { PaymentCurrency } from '../../../store/models/payment-currency';
-import { getMainProductName } from '../../product';
-import { getCustomerSubscriptionPageUrl } from '../../subscription';
-import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import { formatCurrencyInfo, getExplorerLink, getSubscriptionNotificationCustomActions } from '../../util';
-import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { formatTime } from '../../time';
+import { formatCurrencyInfo, getExplorerLink } from '../../util';
+import { BaseSubscriptionEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionRefundSucceededEmailTemplateOptions {
   refundId: string;
@@ -21,7 +16,6 @@ interface SubscriptionRefundSucceededEmailTemplateContext {
   locale: string;
   productName: string;
   at: string;
-
   chainHost: string | undefined;
   userDid: string;
   paymentInfo: string;
@@ -32,24 +26,23 @@ interface SubscriptionRefundSucceededEmailTemplateContext {
   unusedPeriodStart?: string;
   unusedPeriodEnd?: string;
   unusedDuration: string;
-
   viewSubscriptionLink: string;
   viewTxHashLink: string | undefined;
   refund: Refund;
   customActions: any[];
+  isCreditSubscription: boolean;
 }
 
-export class SubscriptionRefundSucceededEmailTemplate
-  implements BaseEmailTemplate<SubscriptionRefundSucceededEmailTemplateContext>
-{
+export class SubscriptionRefundSucceededEmailTemplate extends BaseSubscriptionEmailTemplate<SubscriptionRefundSucceededEmailTemplateContext> {
   options: SubscriptionRefundSucceededEmailTemplateOptions;
 
   constructor(options: SubscriptionRefundSucceededEmailTemplateOptions) {
+    super();
     this.options = options;
   }
 
   async getContext(): Promise<SubscriptionRefundSucceededEmailTemplateContext> {
-    const refund: Refund | null = await Refund.findByPk(this.options.refundId);
+    const refund = await Refund.findByPk(this.options.refundId);
     if (!refund) {
       throw new Error(`Refund not found: ${this.options.refundId}`);
     }
@@ -57,69 +50,80 @@ export class SubscriptionRefundSucceededEmailTemplate
       throw new Error(`Refund not succeeded: ${this.options.refundId}`);
     }
 
-    const customer = await Customer.findByPk(refund.customer_id);
-    if (!customer) {
-      throw new Error(`Customer not found: ${refund.customer_id}`);
-    }
+    // 获取基础订阅数据
+    const basicData = await this.getSubscriptionBasicData(refund.subscription_id!);
+    const { userDid, locale, productName, isCreditSubscription } = basicData;
 
+    // 获取支付相关信息
     const paymentIntent = await PaymentIntent.findByPk(refund.payment_intent_id);
-    const paymentCurrency = (await PaymentCurrency.findOne({
-      where: {
-        id: refund.currency_id,
-      },
-    })) as PaymentCurrency;
-
-    const userDid: string = customer.did;
-    const locale = await getUserLocale(userDid);
-    const productName = await getMainProductName(refund.subscription_id!);
-    const at: string = formatTime(refund.created_at);
+    const paymentCurrency = await PaymentCurrency.findByPk(refund.currency_id);
+    if (!paymentCurrency) {
+      throw new Error(`PaymentCurrency not found: ${refund.currency_id}`);
+    }
 
+    // 获取发票和周期信息
     let invoice = null;
     let currentPeriodStart;
     let currentPeriodEnd;
-    let duration;
+    let duration = '';
     let unusedPeriodStart;
     let unusedPeriodEnd;
-    let unusedDuration;
+    let unusedDuration = '';
+
     if (refund.type === 'refund') {
-      invoice = (await Invoice.findByPk(refund.invoice_id)) as Invoice;
-      currentPeriodStart = formatTime(invoice.period_start * 1000);
-      currentPeriodEnd = formatTime(invoice.period_end * 1000);
-      duration = prettyMsI18n(new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(), {
-        locale: getPrettyMsI18nLocale(locale),
-      });
+      invoice = await Invoice.findByPk(refund.invoice_id);
+      if (invoice) {
+        const periodInfo = this.formatSubscriptionPeriod(invoice.period_start, invoice.period_end, locale);
+        currentPeriodStart = periodInfo.currentPeriodStart;
+        currentPeriodEnd = periodInfo.currentPeriodEnd;
+        duration = periodInfo.duration;
 
-      if (refund?.metadata?.unused_period_start && refund?.metadata?.unused_period_end) {
-        unusedPeriodStart = formatTime(refund!.metadata!.unused_period_start! * 1000);
-        unusedPeriodEnd = formatTime(refund!.metadata!.unused_period_end! * 1000);
-        unusedDuration = prettyMsI18n(new Date(unusedPeriodEnd).getTime() - new Date(unusedPeriodStart).getTime(), {
-          locale: getPrettyMsI18nLocale(locale),
-        });
+        // 处理未使用期间
+        if (refund?.metadata?.unused_period_start && refund?.metadata?.unused_period_end) {
+          const unusedPeriodInfo = this.formatSubscriptionPeriod(
+            refund.metadata.unused_period_start,
+            refund.metadata.unused_period_end,
+            locale
+          );
+          unusedPeriodStart = unusedPeriodInfo.currentPeriodStart;
+          unusedPeriodEnd = unusedPeriodInfo.currentPeriodEnd;
+          unusedDuration = unusedPeriodInfo.duration;
+        }
       }
     }
 
-    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(
-      refund.payment_method_id || invoice?.default_payment_method_id
-    );
+    // 获取支付方式
+    const paymentMethod = await PaymentMethod.findByPk(refund.payment_method_id || invoice?.default_payment_method_id);
 
-    const paymentInfo: string = formatCurrencyInfo(
-      paymentIntent?.amount_received || '0',
-      paymentCurrency,
-      paymentMethod
-    );
-    const refundInfo: string = formatCurrencyInfo(refund.amount, paymentCurrency, paymentMethod);
+    // 格式化支付和退款信息
+    const paymentInfo = formatCurrencyInfo(paymentIntent?.amount_received || '0', paymentCurrency, paymentMethod);
+    const refundInfo = formatCurrencyInfo(refund.amount, paymentCurrency, paymentMethod);
 
-    // @ts-expect-error
-    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
-      subscriptionId: refund.subscription_id!,
-      locale,
-      userDid,
-    });
+    // 获取链接
+    let customActions: any[] = [];
+    let viewSubscriptionLink = '';
+    if (refund?.subscription_id) {
+      const subscription = await Subscription.findByPk(refund.subscription_id);
+      if (subscription) {
+        const links = this.generateSubscriptionLinks(
+          subscription,
+          locale,
+          userDid,
+          'refund.succeeded',
+          undefined,
+          isCreditSubscription
+        );
+        viewSubscriptionLink = links.viewSubscriptionLink;
+        customActions = links.customActions;
+      }
+    }
 
+    // 获取交易哈希链接
+    // @ts-expect-error
+    const chainHost = paymentMethod?.settings?.[paymentMethod?.type]?.api_host;
     // @ts-expect-error
-    const txHash: string | undefined = refund?.payment_details?.[paymentMethod.type]?.tx_hash;
-    const viewTxHashLink: string | undefined =
+    const txHash = refund?.payment_details?.[paymentMethod?.type]?.tx_hash;
+    const viewTxHashLink =
       txHash &&
       getExplorerLink({
         type: 'tx',
@@ -127,17 +131,12 @@ export class SubscriptionRefundSucceededEmailTemplate
         chainHost,
       });
 
-    let customActions: any[] = [];
-    if (refund?.subscription_id) {
-      const subscription = await Subscription.findByPk(refund.subscription_id);
-      customActions = getSubscriptionNotificationCustomActions(subscription!, 'refund.succeeded', locale);
-    }
+    const at = formatTime(refund.created_at);
 
     return {
       locale,
       productName,
       at,
-
       userDid,
       chainHost,
       paymentInfo,
@@ -148,20 +147,20 @@ export class SubscriptionRefundSucceededEmailTemplate
       unusedPeriodStart,
       unusedPeriodEnd,
       unusedDuration,
-
       viewSubscriptionLink,
       viewTxHashLink,
       refund,
       customActions,
+      isCreditSubscription,
     };
   }
 
   async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
     const {
       locale,
       productName,
       at,
-
       userDid,
       paymentInfo,
       refundInfo,
@@ -171,217 +170,196 @@ export class SubscriptionRefundSucceededEmailTemplate
       unusedPeriodStart,
       unusedPeriodEnd,
       unusedDuration,
-
       viewSubscriptionLink,
       viewTxHashLink,
       refund,
-    } = await this.getContext();
+      isCreditSubscription,
+    } = context;
 
+    // 如果是质押返还类型，使用特殊模板
     if (refund.type === 'stake_return') {
-      return {
-        title: `${translate('notification.subscriptionStakeReturnSucceeded.title', locale, {
-          productName,
-        })}`,
-        body: `${translate('notification.subscriptionStakeReturnSucceeded.body', locale, {
-          at,
-          productName,
-          refundInfo,
-        })}`,
-        attachments: [
-          {
-            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.returnAmount', locale),
-                },
-              },
-              {
-                type: 'text',
-                data: {
-                  type: 'plain',
-                  text: refundInfo,
-                },
-              },
-            ],
-          },
-        ],
-        // @ts-ignore
-        actions: [
-          {
-            name: translate('notification.common.viewSubscription', locale),
-            title: translate('notification.common.viewSubscription', locale),
-            link: viewSubscriptionLink,
-          },
-          viewTxHashLink && {
-            name: translate('notification.common.viewTxHash', locale),
-            title: translate('notification.common.viewTxHash', locale),
-            link: viewTxHashLink as string,
-          },
-        ].filter(Boolean),
-      };
+      return this.getStakeReturnTemplate(context);
     }
 
-    const template: BaseEmailTemplateType = {
-      title: `${translate('notification.subscriptionRefundSucceeded.title', locale, {
-        productName,
-      })}`,
-      body: `${translate('notification.subscriptionRefundSucceeded.body', locale, {
-        at,
-        productName,
-        refundInfo,
-      })}`,
-      // @ts-expect-error
-      attachments: [
-        {
-          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),
-              },
+    // 构建字段
+    const commonFields = this.buildCommonFields(userDid, productName, locale);
+
+    // 支付和退款金额字段
+    const amountFields = isCreditSubscription
+      ? []
+      : [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.paymentAmount', locale),
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: productName,
-              },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: paymentInfo,
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.paymentAmount', locale),
-              },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.refundAmount', locale),
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: paymentInfo,
-              },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: refundInfo,
             },
+          },
+        ];
+
+    // 有效期字段
+    const validityPeriodFields =
+      currentPeriodStart && currentPeriodEnd && !isCreditSubscription
+        ? [
             {
               type: 'text',
               data: {
                 type: 'plain',
                 color: '#9397A1',
-                text: translate('notification.common.refundAmount', locale),
+                text: translate('notification.common.validityPeriod', locale),
               },
             },
             {
               type: 'text',
               data: {
                 type: 'plain',
-                text: refundInfo,
+                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
               },
             },
+          ]
+        : [];
+
+    // 退款期间字段
+    const refundPeriodFields =
+      unusedPeriodStart && unusedPeriodEnd && unusedDuration && !isCreditSubscription
+        ? [
             {
               type: 'text',
               data: {
                 type: 'plain',
                 color: '#9397A1',
-                text: translate('notification.common.validityPeriod', locale),
+                text: translate('notification.common.refundPeriod', locale),
               },
             },
             {
               type: 'text',
               data: {
                 type: 'plain',
-                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
+                text: `${unusedPeriodStart} ~ ${unusedPeriodEnd}(${unusedDuration})`,
               },
             },
+          ]
+        : [];
 
-            ...(unusedPeriodStart && unusedPeriodEnd && unusedDuration
-              ? [
-                  {
-                    type: 'text',
-                    data: {
-                      type: 'plain',
-                      color: '#9397A1',
-                      text: translate('notification.common.refundPeriod', locale),
-                    },
-                  },
-                  {
-                    type: 'text',
-                    data: {
-                      type: 'plain',
-                      text: `${unusedPeriodStart} ~ ${unusedPeriodEnd}(${unusedDuration})`,
-                    },
-                  },
-                ]
-              : []),
-          ].filter(Boolean),
-        },
-      ].filter(Boolean),
-      // @ts-ignore
-      actions: [
+    // 构建操作按钮
+    const actions = [
+      {
+        name: translate('notification.common.viewSubscription', locale),
+        title: translate('notification.common.viewSubscription', locale),
+        link: viewSubscriptionLink,
+      },
+      viewTxHashLink && {
+        name: translate('notification.common.viewTxHash', locale),
+        title: translate('notification.common.viewTxHash', locale),
+        link: viewTxHashLink,
+      },
+    ].filter(Boolean);
+
+    const template: BaseEmailTemplateType = {
+      title: translate('notification.subscriptionRefundSucceeded.title', locale, {
+        productName,
+      }),
+      body: translate('notification.subscriptionRefundSucceeded.body', locale, {
+        at,
+        productName,
+        refundInfo,
+      }),
+      // @ts-expect-error
+      attachments: [
         {
-          name: translate('notification.common.viewSubscription', locale),
-          title: translate('notification.common.viewSubscription', locale),
-          link: viewSubscriptionLink,
-        },
-        viewTxHashLink && {
-          name: translate('notification.common.viewTxHash', locale),
-          title: translate('notification.common.viewTxHash', locale),
-          link: viewTxHashLink as string,
+          type: 'section',
+          fields: [...commonFields, ...amountFields, ...validityPeriodFields, ...refundPeriodFields].filter(Boolean),
         },
       ].filter(Boolean),
+      // @ts-ignore
+      actions,
     };
 
     return template;
   }
+
+  private getStakeReturnTemplate(context: SubscriptionRefundSucceededEmailTemplateContext): BaseEmailTemplateType {
+    const { locale, productName, at, userDid, refundInfo, viewSubscriptionLink, viewTxHashLink, isCreditSubscription } =
+      context;
+
+    // 构建字段
+    const commonFields = this.buildCommonFields(userDid, productName, locale);
+
+    // 返还金额字段
+    const returnAmountFields = isCreditSubscription
+      ? []
+      : [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.returnAmount', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: refundInfo,
+            },
+          },
+        ];
+
+    // 构建操作按钮
+    const actions = [
+      {
+        name: translate('notification.common.viewSubscription', locale),
+        title: translate('notification.common.viewSubscription', locale),
+        link: viewSubscriptionLink,
+      },
+      viewTxHashLink && {
+        name: translate('notification.common.viewTxHash', locale),
+        title: translate('notification.common.viewTxHash', locale),
+        link: viewTxHashLink,
+      },
+    ].filter(Boolean);
+
+    return {
+      title: translate('notification.subscriptionStakeReturnSucceeded.title', locale, {
+        productName,
+      }),
+      body: translate('notification.subscriptionStakeReturnSucceeded.body', locale, {
+        at,
+        productName,
+        refundInfo,
+      }),
+      attachments: [
+        {
+          type: 'section',
+          fields: [...commonFields, ...returnAmountFields].filter(Boolean),
+        },
+      ],
+      // @ts-ignore
+      actions,
+    };
+  }
 }