payment-kit 1.13.64 → 1.13.66

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

@@ -0,0 +1,267 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { toDid } from '@ocap/util';
+import pWaitFor from 'p-wait-for';
+import prettyMsI18n from 'pretty-ms-i18n';
+
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { CheckoutSession, Customer, Invoice, NftMintItem, PaymentMethod, Subscription } from '../../../store/models';
+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 type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface SubscriptionTrailStartEmailTemplateOptions {
+  subscriptionId: string;
+}
+
+interface SubscriptionTrailStartEmailTemplateContext {
+  locale: string;
+  productName: string;
+  subscriptionTrialEnd: string;
+
+  nftMintItem: NftMintItem | undefined;
+  chainHost: string | undefined;
+  userDid: string;
+  paymentInfo: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  duration: string;
+
+  viewSubscriptionLink: string;
+  viewInvoiceLink: string;
+}
+
+export class SubscriptionTrailStartEmailTemplate
+  implements BaseEmailTemplate<SubscriptionTrailStartEmailTemplateContext>
+{
+  options: SubscriptionTrailStartEmailTemplateOptions;
+
+  constructor(options: SubscriptionTrailStartEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionTrailStartEmailTemplateContext> {
+    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
+    if (!subscription) {
+      throw new Error(`Subscription not found: ${this.options.subscriptionId}`);
+    }
+
+    const customer = await Customer.findByPk(subscription.customer_id);
+    if (!customer) {
+      throw new Error(`Customer not found: ${subscription.customer_id}`);
+    }
+
+    await pWaitFor(
+      async () => {
+        const checkoutSession = await CheckoutSession.findOne({
+          where: {
+            subscription_id: subscription.id,
+          },
+        });
+
+        return ['minted', 'sent', 'error'].includes(checkoutSession?.nft_mint_status as string);
+      },
+      { timeout: 1000 * 10, interval: 1000 }
+    );
+
+    const invoice: Invoice = (await Invoice.findOne({
+      where: {
+        subscription_id: subscription.id,
+        total: 0,
+      },
+    })) as Invoice;
+
+    const paymentCurrency = (await PaymentCurrency.findOne({
+      where: {
+        id: subscription.currency_id,
+      },
+    })) as PaymentCurrency;
+
+    const checkoutSession = await CheckoutSession.findOne({
+      where: {
+        subscription_id: subscription.id,
+      },
+    });
+
+    const locale = await getUserLocale(customer.did);
+    const productName = await getMainProductName(subscription.id);
+    const subscriptionTrialEnd: string = formatTime((subscription.trail_end as number) * 1000);
+
+    const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
+    const nftMintItem: NftMintItem | undefined = hasNft
+      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
+      : undefined;
+    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 paymentInfo: string = `0 ${paymentCurrency.symbol}`;
+    const currentPeriodStart: string = formatTime((subscription.trail_start as number) * 1000);
+    const currentPeriodEnd: string = formatTime((subscription.trail_end as number) * 1000);
+    const duration: string = prettyMsI18n(
+      new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
+      {
+        locale: getPrettyMsI18nLocale(locale),
+      }
+    );
+
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl(subscription.id, locale);
+    const viewInvoiceLink = getCustomerInvoicePageUrl(invoice.id, locale);
+
+    return {
+      locale,
+      productName,
+      subscriptionTrialEnd,
+
+      nftMintItem,
+      chainHost,
+      userDid: customer.did,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      productName,
+      subscriptionTrialEnd,
+
+      nftMintItem,
+      chainHost,
+      userDid,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptionTrialStart.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: `${translate('notification.subscriptionTrialStart.body', locale, {
+        subscriptionTrialEnd,
+        productName: `(${productName})`,
+        trialDuration: duration,
+      })}`,
+      // @ts-expect-error
+      attachments: [
+        nftMintItem &&
+          chainHost && {
+            type: 'asset',
+            data: {
+              chainHost,
+              did: nftMintItem.address,
+            },
+          },
+        {
+          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.trialPeriod', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
+              },
+            },
+            nftMintItem && {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.nftAddress', locale),
+              },
+            },
+            nftMintItem && {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: toDid(nftMintItem.address),
+              },
+            },
+          ].filter(Boolean),
+        },
+      ].filter(Boolean),
+      // @ts-ignore
+      actions: [
+        {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewSubscription', locale),
+          link: viewSubscriptionLink,
+        },
+        {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewInvoice', locale),
+          link: viewInvoiceLink,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

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

@@ -0,0 +1,250 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } from '@ocap/util';
+import type { ManipulateType } from 'dayjs';
+import prettyMsI18n from 'pretty-ms-i18n';
+
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { Customer, Invoice, Subscription } from '../../../store/models';
+import { PaymentCurrency } from '../../../store/models/payment-currency';
+import { PaymentDetail, getPaymentDetail } from '../../payment';
+import { getMainProductName } from '../../product';
+import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { formatTime, getPrettyMsI18nLocale } from '../../time';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface SubscriptionTrialWillEndEmailTemplateOptions {
+  subscriptionId: string;
+  willRenewValue: number;
+  willRenewUnit: ManipulateType;
+  required?: false | true;
+}
+
+interface SubscriptionTrailWilEndEmailTemplateContext {
+  locale: string;
+  productName: string;
+  at: string;
+  willRenewDuration: string;
+  paymentDetail: PaymentDetail;
+
+  userDid: string;
+  paymentInfo: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  duration: string;
+
+  viewSubscriptionLink: string;
+}
+
+export class SubscriptionTrailWilEndEmailTemplate
+  implements BaseEmailTemplate<SubscriptionTrailWilEndEmailTemplateContext>
+{
+  options: SubscriptionTrialWillEndEmailTemplateOptions;
+
+  constructor(options: SubscriptionTrialWillEndEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionTrailWilEndEmailTemplateContext> {
+    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
+    if (!subscription) {
+      throw new Error(`Subscription not found: ${this.options.subscriptionId}`);
+    }
+
+    const customer = await Customer.findByPk(subscription.customer_id);
+    if (!customer) {
+      throw new Error(`Customer not found: ${subscription.customer_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 locale = await getUserLocale(customer.did);
+    const productName = await getMainProductName(subscription.id);
+    const at: string = formatTime((subscription.trail_end as number) * 1000);
+    const willRenewDuration: string =
+      locale === 'en' ? this.getWillRenewDuration(locale) : this.getWillRenewDuration(locale).replaceAll(' ', '');
+
+    const userDid = customer.did;
+    const paymentDetail: PaymentDetail = await getPaymentDetail(userDid, invoice);
+    const paymentInfo: string = `${fromUnitToToken(+invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+    const currentPeriodStart: string = formatTime((subscription.trail_start as number) * 1000);
+    const currentPeriodEnd: string = formatTime((subscription.trail_end as number) * 1000);
+    const duration: string = prettyMsI18n(
+      new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
+      {
+        locale: getPrettyMsI18nLocale(locale),
+      }
+    );
+
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl(subscription.id, locale);
+
+    return {
+      locale,
+      productName,
+      at,
+      willRenewDuration,
+      paymentDetail,
+
+      userDid,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+
+      viewSubscriptionLink,
+    };
+  }
+
+  getWillRenewDuration(locale: string): string {
+    if (this.options.willRenewUnit === 'M') {
+      if (this.options.willRenewValue > 1) {
+        return `${this.options.willRenewValue} ${translate('notification.common.months', locale)}`;
+      }
+
+      return `${this.options.willRenewValue} ${translate('notification.common.month', locale)}`;
+    }
+    if (this.options.willRenewUnit === 'd') {
+      if (this.options.willRenewValue > 1) {
+        return `${this.options.willRenewValue} ${translate('notification.common.days', locale)}`;
+      }
+      return `${this.options.willRenewValue} ${translate('notification.common.day', locale)}`;
+    }
+
+    if (this.options.willRenewUnit === 'm') {
+      if (this.options.willRenewValue > 1) {
+        return `${this.options.willRenewValue} ${translate('notification.common.minutes', locale)}`;
+      }
+      return `${this.options.willRenewValue} ${translate('notification.common.minute', locale)}`;
+    }
+
+    return `${this.options.willRenewValue} ${this.options.willRenewUnit}`;
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType | null> {
+    const {
+      locale,
+      productName,
+      at,
+      willRenewDuration,
+      paymentDetail,
+
+      userDid,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+
+      viewSubscriptionLink,
+    } = await this.getContext();
+
+    const canPay: boolean = paymentDetail.balance >= paymentDetail.price;
+    if (canPay && !this.options.required) {
+      // 当余额足够支付并且本封邮件不是必须发送时,可以不发送邮件
+      return null;
+    }
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptionTrialWillEnd.title', locale, {
+        productName: `(${productName})`,
+        willRenewDuration,
+      })}`,
+      body: canPay
+        ? `${translate('notification.subscriptionTrialWillEnd.body', locale, {
+            at,
+            productName: `(${productName})`,
+            willRenewDuration,
+          })}`
+        : `${translate('notification.subscriptionTrialWillEnd.unableToPayBody', locale, {
+            at,
+            productName: `(${productName})`,
+            willRenewDuration,
+            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),
+              },
+            },
+            {
+              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.trialPeriod', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
+              },
+            },
+          ].filter(Boolean),
+        },
+      ].filter(Boolean),
+      // @ts-ignore
+      actions: [
+        {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewSubscription', locale),
+          link: viewSubscriptionLink,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}