payment-kit 1.13.65 → 1.13.66

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

@@ -0,0 +1,259 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken, toDid } from '@ocap/util';
+import prettyMsI18n from 'pretty-ms-i18n';
+
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import {
+  CheckoutSession,
+  Customer,
+  Invoice,
+  NftMintItem,
+  PaymentIntent,
+  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 { getExplorerLink } from '../../util';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface SubscriptionRenewedEmailTemplateOptions {
+  subscriptionId: string;
+  invoiceId?: string;
+}
+
+interface SubscriptionRenewedEmailTemplateContext {
+  locale: string;
+  productName: string;
+  at: string;
+
+  nftMintItem: NftMintItem | undefined;
+  userDid: string;
+  paymentInfo: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  duration: string;
+
+  viewSubscriptionLink: string;
+  viewInvoiceLink: string;
+  viewTxHashLink: string | undefined;
+}
+
+export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<SubscriptionRenewedEmailTemplateContext> {
+  options: SubscriptionRenewedEmailTemplateOptions;
+
+  constructor(options: SubscriptionRenewedEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionRenewedEmailTemplateContext> {
+    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 = (
+      this.options.invoiceId
+        ? await Invoice.findByPk(this.options.invoiceId)
+        : await Invoice.findByPk(subscription.latest_invoice_id)
+    ) as Invoice;
+    const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
+    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 at: string = formatTime(Date.now());
+
+    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 paymentInfo: string = `${fromUnitToToken(invoice.amount_paid, 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 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 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;
+
+    return {
+      locale,
+      productName,
+      at,
+
+      nftMintItem,
+      userDid: customer.did,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+      viewTxHashLink,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      productName,
+      at,
+      nftMintItem,
+      userDid,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      viewSubscriptionLink,
+      viewInvoiceLink,
+      viewTxHashLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptionRenewed.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: `${translate('notification.subscriptionRenewed.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})`,
+              },
+            },
+            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,
+        },
+        viewTxHashLink && {
+          name: 'viewTxHash',
+          title: translate('notification.common.viewTxHash', locale),
+          link: viewTxHashLink as string,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

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

@@ -0,0 +1,279 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } 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,
+  NftMintItem,
+  PaymentIntent,
+  PaymentMethod,
+  Subscription,
+} 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 SubscriptionSucceededEmailTemplateOptions {
+  subscriptionId: string;
+}
+
+interface SubscriptionSucceededEmailTemplateContext {
+  locale: string;
+  productName: string;
+  at: string;
+  nftMintItem: NftMintItem | undefined;
+  chainHost: string | undefined;
+  userDid: string;
+  paymentInfo: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  duration: string;
+  viewSubscriptionLink: string;
+  viewInvoiceLink: string;
+  viewTxHashLink: string | undefined;
+}
+
+export class SubscriptionSucceededEmailTemplate
+  implements BaseEmailTemplate<SubscriptionSucceededEmailTemplateContext>
+{
+  options: SubscriptionSucceededEmailTemplateOptions;
+
+  constructor(options: SubscriptionSucceededEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionSucceededEmailTemplateContext> {
+    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, invoice] = await Promise.all([
+          CheckoutSession.findOne({
+            where: {
+              subscription_id: subscription.id,
+            },
+          }),
+          Invoice.findOne({
+            where: {
+              subscription_id: subscription.id,
+            },
+            order: [['created_at', 'ASC']],
+          }),
+        ]);
+
+        return Boolean(
+          ['minted', 'sent', 'error'].includes(checkoutSession?.nft_mint_status as string) && invoice?.payment_intent_id
+        );
+      },
+      { timeout: 1000 * 10, interval: 1000 }
+    );
+
+    const invoice = (await Invoice.findOne({
+      where: {
+        subscription_id: subscription.id,
+      },
+      order: [['created_at', 'ASC']],
+    })) 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 at: string = formatTime(subscription.created_at);
+
+    const paymentInfo: string = `${fromUnitToToken(invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+    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 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);
+    // @FIXME: 获取 chainHost 困难的一批?
+    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 paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
+    const txHash: string | undefined =
+      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
+    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash as string, 'tx');
+
+    return {
+      locale,
+      productName,
+      at,
+
+      userDid: customer.did,
+      nftMintItem,
+      chainHost,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+      viewTxHashLink,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      productName,
+      at,
+      nftMintItem,
+      chainHost,
+      userDid,
+      paymentInfo,
+      currentPeriodStart,
+      currentPeriodEnd,
+      duration,
+      viewSubscriptionLink,
+      viewInvoiceLink,
+      viewTxHashLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptionSucceed.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: `${translate('notification.subscriptionSucceed.body', locale, {
+        at,
+        productName: `(${productName})`,
+      })}`,
+      // @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.validityPeriod', 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,
+        },
+        {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewInvoice', locale),
+          link: viewInvoiceLink,
+        },
+        viewTxHashLink && {
+          name: 'viewTxHash',
+          title: translate('notification.common.viewTxHash', locale),
+          link: viewTxHashLink as string,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}