payment-kit 1.19.0 → 1.19.1

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

@@ -4,17 +4,10 @@ import { fromUnitToToken } from '@ocap/util';
 import type { ManipulateType } from 'dayjs';
 
 import dayjs from '../../dayjs';
-import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { Customer, Invoice, PaymentMethod, Subscription } from '../../../store/models';
-import { PaymentCurrency } from '../../../store/models/payment-currency';
-import { getCustomerInvoicePageUrl } from '../../invoice';
-import logger from '../../logger';
-import { getMainProductName } from '../../product';
-import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { Invoice, PaymentCurrency, PaymentMethod } from '../../../store/models';
 import { formatTime, getSimplifyDuration } from '../../time';
-import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
-import { getSubscriptionNotificationCustomActions } from '../../util';
+import { BaseSubscriptionEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionWillCanceledEmailTemplateOptions {
   subscriptionId: string;
@@ -29,35 +22,32 @@ interface SubscriptionWillCanceledEmailTemplateContext {
   at: string;
   cancelReason: string;
   body: string;
-
   userDid: string;
   paymentInfo: string;
-
   viewSubscriptionLink: string;
-  viewInvoiceLink: string;
+  viewInvoiceLink?: string;
   customActions: any[];
   needRenew: boolean;
+  isCreditSubscription: boolean;
 }
 
-export class SubscriptionWillCanceledEmailTemplate
-  implements BaseEmailTemplate<SubscriptionWillCanceledEmailTemplateContext>
-{
+export class SubscriptionWillCanceledEmailTemplate extends BaseSubscriptionEmailTemplate<SubscriptionWillCanceledEmailTemplateContext> {
   options: SubscriptionWillCanceledEmailTemplateOptions;
 
   constructor(options: SubscriptionWillCanceledEmailTemplateOptions) {
+    super();
     this.options = options;
   }
 
   async getContext(): Promise<SubscriptionWillCanceledEmailTemplateContext> {
     if (!this.options.required) {
-      logger.error('SubscriptionWillCanceledEmailTemplate: This execution will be skipped', this.options);
       throw new Error('SubscriptionWillCanceledEmailTemplate: This execution will be skipped');
     }
 
-    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, isCreditSubscription } = basicData;
+
     if (subscription.isImmutable()) {
       throw new Error(`Subscription(${this.options.subscriptionId}) is immutable, no need to send notification`);
     }
@@ -73,15 +63,9 @@ export class SubscriptionWillCanceledEmailTemplate
       throw new Error(`Subscription(${this.options.subscriptionId}) is already canceled, no need to send notification`);
     }
 
-    const customer = await Customer.findByPk(subscription.customer_id);
-    if (!customer) {
-      throw new Error(`Customer not found: ${subscription.customer_id}`);
-    }
-
+    // 获取发票和支付信息
     const invoice = await Invoice.findOne({
-      where: {
-        id: subscription.latest_invoice_id,
-      },
+      where: { id: subscription.latest_invoice_id },
       include: [
         { model: PaymentCurrency, as: 'paymentCurrency' },
         { model: PaymentMethod, as: 'paymentMethod' },
@@ -91,15 +75,24 @@ export class SubscriptionWillCanceledEmailTemplate
       throw new Error(`Invoice(${subscription.latest_invoice_id}) not found`);
     }
 
-    const userDid = customer.did;
-    const locale = await getUserLocale(userDid);
-    const productName = await getMainProductName(subscription.id);
-    const at: string = formatTime(cancelAt * 1000);
-    const willCancelDuration: string = getSimplifyDuration((cancelAt - now) * 1000, locale);
+    // 获取链接
+    const links = this.generateSubscriptionLinks(
+      subscription,
+      locale,
+      userDid,
+      'customer.subscription.will_canceled',
+      subscription.latest_invoice_id,
+      isCreditSubscription
+    );
+
+    // 计算时间和取消原因
+    const at = formatTime(cancelAt * 1000);
+    const willCancelDuration = getSimplifyDuration((cancelAt - now) * 1000, locale);
+
     // @ts-ignore
-    const paymentInfo: string = `${fromUnitToToken(+invoice.total, invoice?.paymentCurrency?.decimal)} ${invoice?.paymentCurrency?.symbol}${invoice?.paymentMethod ? `(${invoice?.paymentMethod.name})` : ''}`;
+    const paymentInfo = `${fromUnitToToken(+invoice.total, invoice?.paymentCurrency?.decimal)} ${invoice?.paymentCurrency?.symbol}${invoice?.paymentMethod ? `(${invoice?.paymentMethod.name})` : ''}`;
 
-    let body: string = translate('notification.subscriptWillCanceled.body', locale, {
+    let body = translate('notification.subscriptWillCanceled.body', locale, {
       productName,
       willCancelDuration,
       at,
@@ -119,6 +112,7 @@ export class SubscriptionWillCanceledEmailTemplate
         canceled_at: formatTime(subscription.canceled_at ? subscription.canceled_at * 1000 : dayjs().unix()),
       }
     );
+
     if (subscription.status === 'past_due' || subscription.cancelation_details?.reason === 'payment_failed') {
       body = translate('notification.subscriptWillCanceled.pastDue', locale, {
         productName,
@@ -128,41 +122,24 @@ export class SubscriptionWillCanceledEmailTemplate
       needRenew = true;
     }
 
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
-      subscriptionId: subscription.id,
-      locale,
-      userDid,
-    });
-    const viewInvoiceLink = getCustomerInvoicePageUrl({
-      invoiceId: invoice.id,
-      userDid,
-      locale,
-      action: 'pay',
-    });
-
-    const customActions = getSubscriptionNotificationCustomActions(
-      subscription,
-      'customer.subscription.will_canceled',
-      locale
-    );
     return {
       locale,
       productName,
       at,
       body,
       cancelReason,
-
       userDid,
       paymentInfo,
-
-      viewSubscriptionLink,
-      viewInvoiceLink,
-      customActions,
+      viewSubscriptionLink: links.viewSubscriptionLink,
+      viewInvoiceLink: links.viewInvoiceLink,
+      customActions: links.customActions,
       needRenew,
+      isCreditSubscription,
     };
   }
 
   async getTemplate(): Promise<BaseEmailTemplateType | null> {
+    const context = await this.getContext();
     const {
       locale,
       productName,
@@ -172,109 +149,91 @@ export class SubscriptionWillCanceledEmailTemplate
       needRenew,
       userDid,
       paymentInfo,
-
       viewSubscriptionLink,
       viewInvoiceLink,
       customActions,
-    } = await this.getContext();
+      isCreditSubscription,
+    } = context;
 
     // 如果当前时间大于订阅终止时间，那么不发送通知
     if (dayjs().utc().isAfter(dayjs.utc(at))) {
       return null;
     }
 
-    const template: BaseEmailTemplateType = {
-      title: `${translate('notification.subscriptWillCanceled.title', locale, {
-        productName,
-      })}`,
-      body,
-      // @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,
-              },
-            },
-            ...(needRenew
-              ? [
-                  {
-                    type: 'text',
-                    data: {
-                      type: 'plain',
-                      color: '#9397A1',
-                      text: translate('notification.common.paymentAmount', locale),
-                    },
-                  },
-                  {
-                    type: 'text',
-                    data: {
-                      type: 'plain',
-                      text: paymentInfo,
-                    },
-                  },
-                ]
-              : []),
+    // 构建字段
+    const commonFields = this.buildCommonFields(userDid, productName, locale);
+
+    // 支付金额字段（仅在需要续费时显示）
+    const paymentAmountFields =
+      needRenew && !isCreditSubscription
+        ? [
             {
               type: 'text',
               data: {
                 type: 'plain',
                 color: '#9397A1',
-                text: translate('notification.subscriptWillCanceled.cancelReason', locale),
+                text: translate('notification.common.paymentAmount', locale),
               },
             },
             {
               type: 'text',
               data: {
                 type: 'plain',
-                text: cancelReason,
+                text: paymentInfo,
               },
             },
-          ].filter(Boolean),
+          ]
+        : [];
+
+    // 取消原因字段
+    const cancelReasonFields = [
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: '#9397A1',
+          text: translate('notification.subscriptWillCanceled.cancelReason', locale),
         },
-      ].filter(Boolean),
-      // @ts-ignore
-      actions: [
-        viewSubscriptionLink && {
-          name: translate('notification.common.viewSubscription', locale),
-          title: translate('notification.common.viewSubscription', locale),
-          link: viewSubscriptionLink,
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: cancelReason,
+        },
+      },
+    ];
+
+    // 构建操作按钮
+    const actions = [
+      viewSubscriptionLink && {
+        name: translate('notification.common.viewSubscription', locale),
+        title: translate('notification.common.viewSubscription', locale),
+        link: viewSubscriptionLink,
+      },
+      viewInvoiceLink &&
+        needRenew && {
+          name: translate('notification.common.renewNow', locale),
+          title: translate('notification.common.renewNow', locale),
+          link: viewInvoiceLink,
+        },
+      ...customActions,
+    ].filter(Boolean);
+
+    const template: BaseEmailTemplateType = {
+      title: translate('notification.subscriptWillCanceled.title', locale, {
+        productName,
+      }),
+      body,
+      // @ts-expect-error
+      attachments: [
+        {
+          type: 'section',
+          fields: [...commonFields, ...paymentAmountFields, ...cancelReasonFields].filter(Boolean),
         },
-        viewInvoiceLink &&
-          needRenew && {
-            name: translate('notification.common.renewNow', locale),
-            title: translate('notification.common.renewNow', locale),
-            link: viewInvoiceLink,
-          },
-        ...customActions,
       ].filter(Boolean),
+      // @ts-ignore
+      actions,
     };
 
     return template;