payment-kit 1.18.56 → 1.19.1

package/api/src/libs/notification/template/subscription-trial-will-end.ts

@@ -2,19 +2,14 @@
 /* eslint-disable @typescript-eslint/indent */
 import { fromUnitToToken } from '@ocap/util';
 import type { ManipulateType } from 'dayjs';
-import prettyMsI18n from 'pretty-ms-i18n';
 
 import { getTokenByAddress } from '../../../integrations/arcblock/stake';
-import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { Customer, PaymentMethod, Subscription, PaymentCurrency } from '../../../store/models';
 import { PaymentDetail } from '../../payment';
-import { getMainProductName } from '../../product';
-import { getCustomerSubscriptionPageUrl, getPaymentAmountForCycleSubscription } from '../../subscription';
-import { formatTime, getPrettyMsI18nLocale, getSimplifyDuration } from '../../time';
-import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { getPaymentAmountForCycleSubscription } from '../../subscription';
+import { formatTime, getSimplifyDuration } from '../../time';
 import dayjs from '../../dayjs';
-import { getSubscriptionNotificationCustomActions } from '../../util';
+import { BaseSubscriptionEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionTrialWillEndEmailTemplateOptions {
   subscriptionId: string;
@@ -23,38 +18,36 @@ export interface SubscriptionTrialWillEndEmailTemplateOptions {
   required?: false | true;
 }
 
-interface SubscriptionTrialWilEndEmailTemplateContext {
+interface SubscriptionTrialWillEndEmailTemplateContext {
   locale: string;
   productName: string;
   at: string;
   willEndDuration: string;
   paymentDetail: PaymentDetail;
-
   userDid: string;
   paymentInfo: string;
   currentPeriodStart: string;
   currentPeriodEnd: string;
   duration: string;
-
   viewSubscriptionLink: string;
-  paymentMethod: PaymentMethod | null;
   customActions: any[];
+  isCreditSubscription: boolean;
+  isStripe: boolean;
 }
 
-export class SubscriptionTrialWilEndEmailTemplate
-  implements BaseEmailTemplate<SubscriptionTrialWilEndEmailTemplateContext>
-{
+export class SubscriptionTrialWillEndEmailTemplate extends BaseSubscriptionEmailTemplate<SubscriptionTrialWillEndEmailTemplateContext> {
   options: SubscriptionTrialWillEndEmailTemplateOptions;
 
   constructor(options: SubscriptionTrialWillEndEmailTemplateOptions) {
+    super();
     this.options = options;
   }
 
-  async getContext(): Promise<SubscriptionTrialWilEndEmailTemplateContext> {
-    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
-    if (!subscription) {
-      throw new Error(`Subscription not found: ${this.options.subscriptionId}`);
-    }
+  async getContext(): Promise<SubscriptionTrialWillEndEmailTemplateContext> {
+    // 获取基础订阅数据
+    const basicData = await this.getSubscriptionBasicData(this.options.subscriptionId);
+    const { subscription, userDid, locale, productName, paymentCurrency, isCreditSubscription } = basicData;
+
     if (subscription.status !== 'trialing') {
       throw new Error(`Subscription not trialing: ${this.options.subscriptionId}`);
     }
@@ -62,61 +55,51 @@ export class SubscriptionTrialWilEndEmailTemplate
       throw new Error(`Subscription is scheduled to cancel: ${this.options.subscriptionId}`);
     }
 
-    const customer = await Customer.findByPk(subscription.customer_id);
-    if (!customer) {
-      throw new Error(`Customer not found: ${subscription.customer_id}`);
+    if (!subscription.trial_end) {
+      throw new Error(`Subscription has no trial end: ${subscription.id}`);
     }
 
-    // const invoice = (await Invoice.findByPk(subscription.latest_invoice_id)) as Invoice;
-    const paymentCurrency = (await PaymentCurrency.findOne({
-      where: {
-        id: subscription.currency_id,
-      },
-    })) as PaymentCurrency;
-
-    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(paymentCurrency.payment_method_id);
+    // 获取支付信息
+    const paymentInfoResult = await this.getPaymentInfo(subscription, paymentCurrency, isCreditSubscription);
+    const { paymentMethod } = paymentInfoResult;
 
     if (!paymentMethod) {
       throw new Error(`Payment method not found: ${paymentCurrency.payment_method_id}`);
     }
 
-    const userDid = customer.did;
-    const locale = await getUserLocale(userDid);
-    const productName = await getMainProductName(subscription.id);
-    if (!subscription.trial_end) {
-      throw new Error(`Subscription has no trial end: ${subscription.id}`);
-    }
-
-    const at: string = formatTime((subscription.trial_end as number) * 1000);
+    // 获取链接
+    const links = this.generateSubscriptionLinks(
+      subscription,
+      locale,
+      userDid,
+      'customer.subscription.trial_will_end',
+      undefined,
+      isCreditSubscription
+    );
 
-    const willEndDuration: string = getSimplifyDuration((subscription.trial_end! - dayjs().unix()) * 1000, locale);
+    // 计算时间信息
+    const at = formatTime((subscription.trial_end as number) * 1000);
+    const willEndDuration = getSimplifyDuration((subscription.trial_end! - dayjs().unix()) * 1000, locale);
 
+    // 获取支付详情
     const paymentAmount = await getPaymentAmountForCycleSubscription(subscription, paymentCurrency);
     const paymentDetail = { price: paymentAmount, balance: 0, symbol: paymentCurrency.symbol };
-    // @ts-ignore
-    const paymentAddress = subscription.payment_details?.[paymentMethod.type]?.payer ?? undefined;
-    const balance = await getTokenByAddress(paymentAddress, paymentMethod, paymentCurrency);
-    paymentDetail.balance = +fromUnitToToken(balance, paymentCurrency.decimal);
 
-    const paymentInfo: string = `${paymentAmount} ${paymentCurrency.symbol}`;
-    const currentPeriodStart: string = formatTime((subscription.trial_start as number) * 1000);
-    const currentPeriodEnd: string = formatTime((subscription.trial_end as number) * 1000);
-    const duration: string = prettyMsI18n(
-      new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
-      {
-        locale: getPrettyMsI18nLocale(locale),
-      }
-    );
+    // 获取余额信息（非 Stripe 支付方式）
+    const isStripe = paymentMethod?.type === 'stripe';
+    if (!isStripe && !isCreditSubscription) {
+      // @ts-ignore
+      const paymentAddress = subscription.payment_details?.[paymentMethod.type]?.payer ?? undefined;
+      const balance = await getTokenByAddress(paymentAddress, paymentMethod, paymentCurrency);
+      paymentDetail.balance = +fromUnitToToken(balance, paymentCurrency.decimal);
+    }
 
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
-      subscriptionId: subscription.id,
-      locale,
-      userDid,
-    });
+    const paymentInfo = `${paymentAmount} ${paymentCurrency.symbol}`;
 
-    const customActions = getSubscriptionNotificationCustomActions(
-      subscription,
-      'customer.subscription.trial_will_end',
+    // 计算周期信息
+    const periodInfo = this.formatSubscriptionPeriod(
+      subscription.trial_start as number,
+      subscription.trial_end as number,
       locale
     );
 
@@ -126,169 +109,158 @@ export class SubscriptionTrialWilEndEmailTemplate
       at,
       willEndDuration,
       paymentDetail,
-
       userDid,
       paymentInfo,
-      currentPeriodStart,
-      currentPeriodEnd,
-      duration,
-
-      viewSubscriptionLink,
-      paymentMethod,
-      customActions,
+      currentPeriodStart: periodInfo.currentPeriodStart,
+      currentPeriodEnd: periodInfo.currentPeriodEnd,
+      duration: periodInfo.duration,
+      viewSubscriptionLink: links.viewSubscriptionLink,
+      customActions: links.customActions,
+      isCreditSubscription,
+      isStripe,
     };
   }
 
   async getTemplate(): Promise<BaseEmailTemplateType | null> {
+    const context = await this.getContext();
     const {
       locale,
       productName,
       at,
       willEndDuration,
       paymentDetail,
-
       userDid,
       paymentInfo,
       currentPeriodStart,
       currentPeriodEnd,
       duration,
-      paymentMethod,
       viewSubscriptionLink,
       customActions,
-    } = await this.getContext();
+      isCreditSubscription,
+      isStripe,
+    } = context;
 
     // 如果当前时间大于试用结束时间，那么不发送通知
     if (dayjs().utc().isAfter(dayjs.utc(at))) {
       return null;
     }
 
-    const canPay: boolean = paymentDetail.balance >= paymentDetail.price;
+    const canPay = paymentDetail.balance >= paymentDetail.price;
     if (canPay && !this.options.required) {
-      // 当余额足够支付并且本封邮件不是必须发送时,可以不发送邮件
       return null;
     }
 
-    const isStripe = paymentMethod?.type === 'stripe';
+    // 构建字段
+    const commonFields = this.buildCommonFields(userDid, productName, locale);
 
-    const template: BaseEmailTemplateType = {
-      title: `${translate('notification.subscriptionTrialWillEnd.title', locale, {
-        productName,
-        willEndDuration,
-      })}`,
-      body:
-        canPay || isStripe
-          ? `${translate('notification.subscriptionTrialWillEnd.body', locale, {
-              at,
-              productName,
-              willEndDuration,
-            })}`
-          : `${translate('notification.subscriptionTrialWillEnd.unableToPayBody', locale, {
-              at,
-              productName,
-              willEndDuration,
-              balance: `${paymentDetail.balance} ${paymentDetail.symbol}`,
-              price: `${paymentDetail.price} ${paymentDetail.symbol}`,
-            })}`,
-      // @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 paymentAmountFields = 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,
             },
+          },
+        ];
+
+    // 余额不足提醒字段
+    const insufficientBalanceFields =
+      !canPay && !isStripe && !isCreditSubscription
+        ? [
             {
               type: 'text',
               data: {
                 type: 'plain',
                 color: '#9397A1',
-                text: translate('notification.common.paymentAmount', locale),
+                text: translate('notification.common.balanceReminder', locale),
               },
             },
             {
               type: 'text',
               data: {
                 type: 'plain',
-                text: paymentInfo,
+                color: '#FF0000',
+                text: translate('notification.subscriptionTrialWillEnd.unableToPayReason', locale, {
+                  balance: `${paymentDetail.balance} ${paymentDetail.symbol}`,
+                  price: `${paymentDetail.price} ${paymentDetail.symbol}`,
+                }),
               },
             },
-            ...(!canPay && !isStripe
-              ? [
-                  {
-                    type: 'text',
-                    data: {
-                      type: 'plain',
-                      color: '#9397A1',
-                      text: translate('notification.common.balanceReminder', locale),
-                    },
-                  },
-                  {
-                    type: 'text',
-                    data: {
-                      type: 'plain',
-                      color: '#FF0000',
-                      text: translate('notification.subscriptionTrialWillEnd.unableToPayReason', locale, {
-                        balance: `${paymentDetail.balance} ${paymentDetail.symbol}`,
-                        price: `${paymentDetail.price} ${paymentDetail.symbol}`,
-                      }),
-                    },
-                  },
-                ]
-              : []),
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.trialPeriod', locale),
-              },
+          ]
+        : [];
+
+    // 试用期字段
+    const trialPeriodFields = isCreditSubscription
+      ? []
+      : [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.trialPeriod', locale),
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
-              },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
             },
-          ].filter(Boolean),
-        },
-      ].filter(Boolean),
-      // @ts-ignore
-      actions: [
+          },
+        ];
+
+    // 构建操作按钮
+    const actions = [
+      {
+        name: translate('notification.common.viewSubscription', locale),
+        title: translate('notification.common.viewSubscription', locale),
+        link: viewSubscriptionLink,
+      },
+      ...customActions,
+    ].filter(Boolean);
+
+    const template: BaseEmailTemplateType = {
+      title: translate('notification.subscriptionTrialWillEnd.title', locale, {
+        productName,
+        willEndDuration,
+      }),
+      body:
+        canPay || isStripe
+          ? translate('notification.subscriptionTrialWillEnd.body', locale, {
+              at,
+              productName,
+              willEndDuration,
+            })
+          : translate('notification.subscriptionTrialWillEnd.unableToPayBody', locale, {
+              at,
+              productName,
+              willEndDuration,
+              balance: `${paymentDetail.balance} ${paymentDetail.symbol}`,
+              price: `${paymentDetail.price} ${paymentDetail.symbol}`,
+            }),
+      // @ts-expect-error
+      attachments: [
         {
-          name: translate('notification.common.viewSubscription', locale),
-          title: translate('notification.common.viewSubscription', locale),
-          link: viewSubscriptionLink,
+          type: 'section',
+          fields: [...commonFields, ...paymentAmountFields, ...insufficientBalanceFields, ...trialPeriodFields].filter(
+            Boolean
+          ),
         },
-        ...customActions,
       ].filter(Boolean),
+      // @ts-ignore
+      actions,
     };
 
     return template;