payment-kit 1.13.136 → 1.13.138

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

@@ -0,0 +1,241 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } from '@ocap/util';
+import prettyMsI18n from 'pretty-ms-i18n';
+
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { Customer, PaymentMethod, Refund, Subscription } from '../../../store/models';
+import { Invoice } from '../../../store/models/invoice';
+import { PaymentCurrency } from '../../../store/models/payment-currency';
+import logger from '../../logger';
+import { getMainProductName } from '../../product';
+import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { formatTime, getPrettyMsI18nLocale } from '../../time';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface SubscriptionCanceledEmailTemplateOptions {
+  subscriptionId: string;
+}
+
+interface SubscriptionCanceledEmailTemplateContext {
+  locale: string;
+  productName: string;
+  at: string;
+
+  chainHost: string | undefined;
+  userDid: string;
+  paymentInfo: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  duration: string;
+  cancellationReason: string;
+
+  viewSubscriptionLink: string;
+}
+
+export class SubscriptionCanceledEmailTemplate implements BaseEmailTemplate<SubscriptionCanceledEmailTemplateContext> {
+  options: SubscriptionCanceledEmailTemplateOptions;
+
+  constructor(options: SubscriptionCanceledEmailTemplateOptions) {
+    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`);
+    }
+    if (subscription.status !== 'canceled') {
+      throw new Error(`Subscription(${this.options.subscriptionId}) status(${subscription.status}) must be canceled`);
+    }
+    if (subscription.cancelation_details?.reason !== 'payment_disputed') {
+      // 非管理员取消的订阅不需要发送邮件
+      logger.error(
+        `Subscription(${this.options.subscriptionId}) cancelation reason must be payment_disputed`,
+        subscription.cancelation_details
+      );
+      throw new Error(`Subscription(${this.options.subscriptionId}) cancelation reason must be payment_disputed`);
+    }
+
+    const customer = await Customer.findByPk(subscription.customer_id);
+    if (!customer) {
+      throw new Error(`Customer(${subscription.customer_id}) not found`);
+    }
+
+    const invoice = (await Invoice.findByPk(subscription.latest_invoice_id)) as Invoice;
+    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 paymentInfo: string = `${fromUnitToToken(invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+    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 refund = await Refund.findOne({
+      where: {
+        subscription_id: subscription.id,
+      },
+    });
+    const cancellationReason = refund
+      ? translate('notification.subscriptionCanceled.adminCanceledAndRefunded', locale)
+      : translate('notification.subscriptionCanceled.adminCanceled', locale);
+
+    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
+    // @ts-expect-error
+    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+
+    return {
+      locale,
+      productName,
+      at,
+
+      userDid,
+      chainHost,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      cancellationReason,
+
+      viewSubscriptionLink,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      productName,
+      at,
+
+      userDid,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      cancellationReason,
+
+      viewSubscriptionLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptionCanceled.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: `${translate('notification.subscriptionCanceled.body', locale, {
+        at,
+        productName: `(${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.paymentInfo', 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,
+              },
+            },
+          ].filter(Boolean),
+        },
+      ].filter(Boolean),
+      // @ts-ignore
+      actions: [
+        viewSubscriptionLink && {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewSubscription', locale),
+          link: viewSubscriptionLink,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

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

@@ -0,0 +1,286 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } from '@ocap/util';
+import prettyMsI18n from 'pretty-ms-i18n';
+
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { Customer, PaymentIntent, PaymentMethod, Refund } from '../../../store/models';
+import { Invoice } from '../../../store/models/invoice';
+import { PaymentCurrency } from '../../../store/models/payment-currency';
+import { getCustomerInvoicePageUrl } from '../../invoice';
+import { getMainProductName } from '../../product';
+import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { formatTime, getPrettyMsI18nLocale } from '../../time';
+import { getExplorerLink } from '../../util';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface SubscriptionRefundSucceededEmailTemplateOptions {
+  refundId: string;
+}
+
+interface SubscriptionRefundSucceededEmailTemplateContext {
+  locale: string;
+  productName: string;
+  at: string;
+
+  chainHost: string | undefined;
+  userDid: string;
+  paymentInfo: string;
+  refundInfo: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  duration: string;
+  unusedPeriodStart: string;
+  unusedPeriodEnd: string;
+  unusedDuration: string;
+
+  viewSubscriptionLink: string;
+  viewInvoiceLink: string;
+  viewTxHashLink: string | undefined;
+}
+
+export class SubscriptionRefundSucceededEmailTemplate
+  implements BaseEmailTemplate<SubscriptionRefundSucceededEmailTemplateContext>
+{
+  options: SubscriptionRefundSucceededEmailTemplateOptions;
+
+  constructor(options: SubscriptionRefundSucceededEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionRefundSucceededEmailTemplateContext> {
+    const refund: Refund | null = await Refund.findByPk(this.options.refundId);
+    if (!refund) {
+      throw new Error(`Refund not found: ${this.options.refundId}`);
+    }
+    if (refund.status !== 'succeeded') {
+      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 invoice = (await Invoice.findByPk(refund.invoice_id)) as Invoice;
+    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 paymentInfo: string = `${fromUnitToToken(paymentIntent?.amount, paymentCurrency.decimal)} ${
+      paymentCurrency.symbol
+    }`;
+    const refundInfo: string = `${fromUnitToToken(refund.amount, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+
+    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 unusedPeriodStart: string = formatTime(refund!.metadata!.unused_period_start! * 1000);
+    const unusedPeriodEnd: string = formatTime(refund!.metadata!.unused_period_end! * 1000);
+    const unusedDuration: string = prettyMsI18n(
+      new Date(unusedPeriodEnd).getTime() - new Date(unusedPeriodStart).getTime(),
+      {
+        locale: getPrettyMsI18nLocale(locale),
+      }
+    );
+
+    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
+    // @ts-expect-error
+    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: refund.id,
+      locale,
+      userDid,
+    });
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: invoice.id,
+      userDid,
+      locale,
+    });
+
+    // @ts-expect-error
+    const txHash: string | undefined = refund?.payment_details?.[paymentMethod.type]?.tx_hash;
+    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash as string, 'tx');
+
+    return {
+      locale,
+      productName,
+      at,
+
+      userDid,
+      chainHost,
+      paymentInfo,
+      refundInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      unusedPeriodStart,
+      unusedPeriodEnd,
+      unusedDuration,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+      viewTxHashLink,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      productName,
+      at,
+
+      userDid,
+      paymentInfo,
+      refundInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      unusedPeriodStart,
+      unusedPeriodEnd,
+      unusedDuration,
+
+      viewSubscriptionLink,
+      viewTxHashLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptionRefundSucceeded.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: `${translate('notification.subscriptionRefundSucceeded.body', locale, {
+        at,
+        productName: `(${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),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: productName,
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.paymentInfo', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: paymentInfo,
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.refundAmount', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: refundInfo,
+              },
+            },
+            {
+              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.refundPeriod', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${unusedPeriodStart} ~ ${unusedPeriodEnd}(${unusedDuration})`,
+              },
+            },
+          ].filter(Boolean),
+        },
+      ].filter(Boolean),
+      // @ts-ignore
+      actions: [
+        {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewSubscription', locale),
+          link: viewSubscriptionLink,
+        },
+        viewTxHashLink && {
+          name: 'viewTxHash',
+          title: translate('notification.common.viewTxHash', locale),
+          link: viewTxHashLink as string,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

package/api/src/libs/notification/template/subscription-renew-failed.ts

@@ -97,10 +97,11 @@ export class SubscriptionRenewFailedEmailTemplate
       },
     });
 
-    const locale = await getUserLocale(customer.did);
+    const userDid: string = customer.did;
+    const locale = await getUserLocale(userDid);
     const productName = await getMainProductName(subscription.id);
     const at: string = formatTime(Date.now());
-    const reason: string = await this.getReason(customer.did, invoice, locale);
+    const reason: string = await this.getReason(userDid, invoice, locale);
 
     const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
     const nftMintItem: NftMintItem | undefined = hasNft
@@ -109,6 +110,7 @@ export class SubscriptionRenewFailedEmailTemplate
     const paymentInfo: string = `${fromUnitToToken(invoice.amount_remaining, paymentCurrency.decimal)} ${
       paymentCurrency.symbol
     }`;
+
     const currentPeriodStart: string = formatTime(invoice.period_start * 1000);
     const currentPeriodEnd: string = formatTime(invoice.period_end * 1000);
     const duration: string = prettyMsI18n(
@@ -121,8 +123,17 @@ export class SubscriptionRenewFailedEmailTemplate
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
     const chainHost: string | undefined =
       paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.api_host;
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl(subscription.id, locale);
-    const viewInvoiceLink = getCustomerInvoicePageUrl(invoice.id, locale, 'pay');
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: invoice.id,
+      userDid,
+      locale,
+      action: 'pay',
+    });
     const txHash: string | undefined =
       paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
     const viewTxHashLink: string | undefined = hasNft && txHash ? getExplorerLink(chainHost, txHash, 'tx') : undefined;
@@ -134,7 +145,7 @@ export class SubscriptionRenewFailedEmailTemplate
       reason,
 
       nftMintItem,
-      userDid: customer.did,
+      userDid,
       paymentInfo,
       currentPeriodStart,
       currentPeriodEnd,
@@ -263,7 +274,7 @@ export class SubscriptionRenewFailedEmailTemplate
           link: viewSubscriptionLink,
         },
         {
-          name: 'viewSubscription',
+          name: 'viewInvoice',
           title: translate('notification.subscriptionRenewFailed.renewNow', locale),
           link: viewInvoiceLink,
         },

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

@@ -35,6 +35,12 @@ interface SubscriptionRenewedEmailTemplateContext {
   nftMintItem: NftMintItem | undefined;
   userDid: string;
   paymentInfo: string;
+  /**
+   * @description 支付金额
+   * @type {number}
+   * @memberof SubscriptionRenewedEmailTemplateContext
+   */
+  amountPaid: number;
   currentPeriodStart: string;
   currentPeriodEnd: string;
   duration: string;
@@ -82,8 +88,8 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
         subscription_id: subscription.id,
       },
     });
-
-    const locale = await getUserLocale(customer.did);
+    const userDid: string = customer.did;
+    const locale = await getUserLocale(userDid);
     const productName = await getMainProductName(subscription.id);
     const at: string = formatTime(Date.now());
 
@@ -91,6 +97,7 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
     const nftMintItem: NftMintItem | undefined = hasNft
       ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
       : undefined;
+    const amountPaid = +fromUnitToToken(invoice.amount_paid, paymentCurrency.decimal);
     const paymentInfo: string = `${fromUnitToToken(invoice.amount_paid, paymentCurrency.decimal)} ${
       paymentCurrency.symbol
     }`;
@@ -106,8 +113,16 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
     const chainHost: string | undefined =
       paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.api_host;
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl(subscription.id, locale);
-    const viewInvoiceLink = getCustomerInvoicePageUrl(invoice.id, locale);
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: invoice.id,
+      userDid,
+      locale,
+    });
     const txHash: string | undefined =
       paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
     const viewTxHashLink: string | undefined = hasNft && txHash ? getExplorerLink(chainHost, txHash, 'tx') : undefined;
@@ -118,8 +133,9 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
       at,
 
       nftMintItem,
-      userDid: customer.did,
+      userDid,
       paymentInfo,
+      amountPaid,
       currentPeriodStart,
       currentPeriodEnd,
       duration,
@@ -138,6 +154,7 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
       nftMintItem,
       userDid,
       paymentInfo,
+      amountPaid,
       currentPeriodStart,
       currentPeriodEnd,
       duration,
@@ -201,7 +218,11 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
               type: 'text',
               data: {
                 type: 'plain',
-                text: paymentInfo,
+                text: `${paymentInfo}${
+                  amountPaid === 0
+                    ? ` (${translate('notification.subscriptionRenewed.noExpenseIncurred', locale)})`
+                    : ''
+                }`,
               },
             },
             {