payment-kit 1.19.0 → 1.19.2

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

@@ -1,18 +1,14 @@
 /* eslint-disable @typescript-eslint/brace-style */
 /* eslint-disable @typescript-eslint/indent */
-import prettyMsI18n from 'pretty-ms-i18n';
-
 import { Op } from 'sequelize';
-import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { Customer, PaymentMethod, Refund, Subscription } from '../../../store/models';
+import { PaymentMethod, Refund } from '../../../store/models';
 import { Invoice } from '../../../store/models/invoice';
 import { PaymentCurrency } from '../../../store/models/payment-currency';
-import { getMainProductName } from '../../product';
-import { getCustomerSubscriptionPageUrl, getSubscriptionStakeCancellation } from '../../subscription';
-import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
-import { formatCurrencyInfo, getSubscriptionNotificationCustomActions } from '../../util';
+import { getSubscriptionStakeCancellation } from '../../subscription';
+import { formatTime } from '../../time';
+import { formatCurrencyInfo } from '../../util';
+import { BaseSubscriptionEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionCanceledEmailTemplateOptions {
   subscriptionId: string;
@@ -22,7 +18,6 @@ interface SubscriptionCanceledEmailTemplateContext {
   locale: string;
   productName: string;
   at: string;
-
   chainHost: string | undefined;
   userDid: string;
   paymentInfo: string;
@@ -30,263 +25,259 @@ interface SubscriptionCanceledEmailTemplateContext {
   currentPeriodEnd: string;
   duration: string;
   cancellationReason: string;
-
   viewSubscriptionLink: string;
   customActions: any[];
+  isCreditSubscription: boolean;
 }
 
-export class SubscriptionCanceledEmailTemplate implements BaseEmailTemplate<SubscriptionCanceledEmailTemplateContext> {
+export class SubscriptionCanceledEmailTemplate extends BaseSubscriptionEmailTemplate<SubscriptionCanceledEmailTemplateContext> {
   options: SubscriptionCanceledEmailTemplateOptions;
 
   constructor(options: SubscriptionCanceledEmailTemplateOptions) {
+    super();
     this.options = options;
   }
 
   async getContext(): Promise<SubscriptionCanceledEmailTemplateContext> {
-    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
-    if (!subscription) {
-      throw new Error(`Subscription(${this.options.subscriptionId}) not found`);
-    }
+    // 获取基础订阅数据
+    const basicData = await this.getSubscriptionBasicData(this.options.subscriptionId);
+    const { subscription, userDid, locale, productName, paymentCurrency, isCreditSubscription } = basicData;
+
     if (subscription.status !== 'canceled') {
       throw new Error(`Subscription(${this.options.subscriptionId}) status(${subscription.status}) must be canceled`);
     }
 
-    const customer = await Customer.findByPk(subscription.customer_id);
-    if (!customer) {
-      throw new Error(`Customer(${subscription.customer_id}) not found`);
-    }
+    // 获取发票和支付信息
+    let invoice = null;
 
-    const invoice = await Invoice.findOne({
-      where: {
-        id: subscription.latest_invoice_id,
-      },
-      include: [{ model: PaymentCurrency, as: 'paymentCurrency' }],
-    });
-    if (!invoice) {
-      throw new Error(`Invoice(${subscription.latest_invoice_id}) not found`);
+    let paymentMethod = await PaymentMethod.findByPk(subscription.default_payment_method_id);
+    if (!paymentMethod) {
+      throw new Error(`PaymentMethod not found for subscription: ${subscription.id}`);
     }
-    const paymentCurrency = (await PaymentCurrency.findOne({
-      where: {
-        id: subscription.currency_id,
-      },
-    })) as PaymentCurrency;
-
-    const userDid: string = customer.did;
-    const locale = await getUserLocale(userDid);
-    const productName = await getMainProductName(subscription.id);
-    const at: string = formatTime(subscription.canceled_at * 1000);
-    const currentPeriodStart: string = formatTime(invoice.period_start * 1000);
-    const currentPeriodEnd: string = formatTime(invoice.period_end * 1000);
-    const duration: string = prettyMsI18n(
-      new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
-      {
-        locale: getPrettyMsI18nLocale(locale),
-      }
-    );
-    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
-
-    // @ts-ignore
-    const paymentInfo: string = formatCurrencyInfo(invoice.total, invoice?.paymentCurrency, paymentMethod);
 
-    const customerCancelRequest = subscription.cancelation_details?.reason === 'cancellation_requested';
-    let cancellationReason = '';
-    const { stakeEnough, stakeReturn, stakeSlash, hasStake } = await getSubscriptionStakeCancellation(
-      subscription,
-      paymentMethod!,
-      paymentCurrency
-    );
-    if (customerCancelRequest) {
-      // cancel request from customer
-      cancellationReason = translate('notification.subscriptionCanceled.customerCanceled', locale);
-      if (stakeReturn && hasStake && stakeEnough) {
-        cancellationReason = translate('notification.subscriptionCanceled.customerCanceledAndStakeReturned', locale);
-      }
-    } else {
-      // default admin cancel
-      const refund = await Refund.findOne({
-        where: {
-          subscription_id: subscription.id,
-          type: 'refund',
-          status: {
-            [Op.not]: 'canceled',
-          },
-        },
+    if (!isCreditSubscription && subscription.latest_invoice_id) {
+      invoice = await Invoice.findOne({
+        where: { id: subscription.latest_invoice_id },
+        include: [{ model: PaymentCurrency, as: 'paymentCurrency' }],
       });
-      const conditions = [
-        {
-          condition: refund && stakeSlash,
-          key: 'notification.subscriptionCanceled.adminCanceledAndRefundedAndStakeSlashed',
-        },
-        {
-          condition: refund && stakeReturn,
-          key: 'notification.subscriptionCanceled.adminCanceledAndRefundedAndStakeReturned',
-        },
-        { condition: refund, key: 'notification.subscriptionCanceled.adminCanceledAndRefunded' },
-        { condition: stakeReturn, key: 'notification.subscriptionCanceled.adminCanceledAndStakeReturned' },
-      ];
-      const matchedCondition = conditions.find((item) => item.condition);
-      if (matchedCondition) {
-        cancellationReason = translate(matchedCondition.key, locale);
+      if (!invoice) {
+        throw new Error(`Invoice(${subscription.latest_invoice_id}) not found`);
+      }
+      if (invoice.default_payment_method_id !== paymentMethod.id) {
+        paymentMethod = await PaymentMethod.findByPk(invoice.default_payment_method_id);
       }
     }
 
-    if (subscription.cancelation_details?.reason === 'payment_failed') {
-      cancellationReason = translate('notification.subscriptionCanceled.paymentFailed', locale);
-    }
-
-    if (subscription.cancelation_details?.reason === 'stake_revoked') {
-      cancellationReason = translate('notification.subscriptionCanceled.stakeRevoked', locale);
-    }
-
-    // @ts-expect-error
-    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
-      subscriptionId: subscription.id,
+    // 获取链接
+    const links = this.generateSubscriptionLinks(
+      subscription,
       locale,
       userDid,
-    });
-
-    const customActions = getSubscriptionNotificationCustomActions(
-      subscription,
       'customer.subscription.deleted',
-      locale
+      invoice?.id,
+      isCreditSubscription
     );
 
+    const at = formatTime(subscription.canceled_at * 1000);
+
+    const periodInfo = isCreditSubscription
+      ? this.formatSubscriptionPeriod(subscription.current_period_start, subscription.current_period_end, locale)
+      : this.formatSubscriptionPeriod(invoice!.period_start, invoice!.period_end, locale);
+
+    const paymentInfo = isCreditSubscription ? '' : formatCurrencyInfo(invoice!.total, paymentCurrency, paymentMethod);
+
+    const cancellationReason = await this.getCancellationReason(subscription, paymentMethod!, paymentCurrency, locale);
+
+    // @ts-expect-error
+    const chainHost = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
+
     return {
       locale,
       productName,
       at,
-
       userDid,
       chainHost,
       paymentInfo,
-      currentPeriodStart,
-      currentPeriodEnd,
-      duration,
+      currentPeriodStart: periodInfo.currentPeriodStart,
+      currentPeriodEnd: periodInfo.currentPeriodEnd,
+      duration: periodInfo.duration,
       cancellationReason,
-
-      viewSubscriptionLink,
-      customActions,
+      viewSubscriptionLink: links.viewSubscriptionLink,
+      customActions: links.customActions,
+      isCreditSubscription,
     };
   }
 
+  private async getCancellationReason(
+    subscription: any,
+    paymentMethod: PaymentMethod,
+    paymentCurrency: any,
+    locale: string
+  ): Promise<string> {
+    const customerCancelRequest = subscription.cancelation_details?.reason === 'cancellation_requested';
+
+    // 特殊取消原因处理
+    if (subscription.cancelation_details?.reason === 'payment_failed') {
+      return translate('notification.subscriptionCanceled.paymentFailed', locale);
+    }
+
+    if (subscription.cancelation_details?.reason === 'stake_revoked') {
+      return translate('notification.subscriptionCanceled.stakeRevoked', locale);
+    }
+
+    const { stakeEnough, stakeReturn, stakeSlash, hasStake } = await getSubscriptionStakeCancellation(
+      subscription,
+      paymentMethod,
+      paymentCurrency
+    );
+
+    if (customerCancelRequest) {
+      // 客户主动取消
+      if (stakeReturn && hasStake && stakeEnough) {
+        return translate('notification.subscriptionCanceled.customerCanceledAndStakeReturned', locale);
+      }
+      return translate('notification.subscriptionCanceled.customerCanceled', locale);
+    }
+
+    // 管理员取消 - 检查退款情况
+    const refund = await Refund.findOne({
+      where: {
+        subscription_id: subscription.id,
+        type: 'refund',
+        status: { [Op.not]: 'canceled' },
+      },
+    });
+
+    const conditions = [
+      {
+        condition: refund && stakeSlash,
+        key: 'notification.subscriptionCanceled.adminCanceledAndRefundedAndStakeSlashed',
+      },
+      {
+        condition: refund && stakeReturn,
+        key: 'notification.subscriptionCanceled.adminCanceledAndRefundedAndStakeReturned',
+      },
+      { condition: refund, key: 'notification.subscriptionCanceled.adminCanceledAndRefunded' },
+      { condition: stakeReturn, key: 'notification.subscriptionCanceled.adminCanceledAndStakeReturned' },
+    ];
+
+    const matchedCondition = conditions.find((item) => item.condition);
+    return matchedCondition ? translate(matchedCondition.key, locale) : '';
+  }
+
   async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
     const {
       locale,
       productName,
       at,
-
       userDid,
       paymentInfo,
       currentPeriodStart,
       currentPeriodEnd,
       duration,
       cancellationReason,
-
       viewSubscriptionLink,
       customActions,
-    } = await this.getContext();
+      isCreditSubscription,
+    } = context;
+
+    // 构建字段
+    const commonFields = this.buildCommonFields(userDid, productName, locale);
+
+    // 支付金额字段
+    const paymentAmountFields = isCreditSubscription
+      ? []
+      : [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.paymentAmount', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: paymentInfo,
+            },
+          },
+        ];
+
+    // 有效期字段
+    const validityPeriodFields = isCreditSubscription
+      ? []
+      : [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.validityPeriod', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
+            },
+          },
+        ];
+
+    // 取消原因字段
+    const cancellationReasonFields = [
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: '#9397A1',
+          text: translate('notification.common.cancellationReason', locale),
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: cancellationReason,
+        },
+      },
+    ];
+
+    // 构建操作按钮
+    const actions = [
+      viewSubscriptionLink && {
+        name: translate('notification.common.viewSubscription', locale),
+        title: translate('notification.common.viewSubscription', locale),
+        link: viewSubscriptionLink,
+      },
+      ...customActions,
+    ].filter(Boolean);
 
     const template: BaseEmailTemplateType = {
-      title: `${translate('notification.subscriptionCanceled.title', locale, {
+      title: translate('notification.subscriptionCanceled.title', locale, {
         productName,
-      })}`,
-      body: `${translate('notification.subscriptionCanceled.body', locale, {
+      }),
+      body: translate('notification.subscriptionCanceled.body', locale, {
         at,
         productName,
-      })}`,
+      }),
       // @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),
-              },
-            },
-            {
-              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})`,
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.cancellationReason', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: cancellationReason,
-              },
-            },
+            ...commonFields,
+            ...paymentAmountFields,
+            ...validityPeriodFields,
+            ...cancellationReasonFields,
           ].filter(Boolean),
         },
       ].filter(Boolean),
       // @ts-ignore
-      actions: [
-        viewSubscriptionLink && {
-          name: translate('notification.common.viewSubscription', locale),
-          title: translate('notification.common.viewSubscription', locale),
-          link: viewSubscriptionLink,
-        },
-        ...customActions,
-      ].filter(Boolean),
+      actions,
     };
 
     return template;