payment-kit 1.13.248 → 1.13.249

package/api/src/libs/notification/template/customer-reward-succeeded.ts

@@ -0,0 +1,297 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } from '@ocap/util';
+import isEmpty from 'lodash/isEmpty';
+import pWaitFor from 'p-wait-for';
+import type { LiteralUnion } from 'type-fest';
+
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import {
+  CheckoutSession,
+  Customer,
+  DonationSettings,
+  NftMintItem,
+  PaymentBeneficiary,
+  PaymentIntent,
+  PaymentLink,
+  PaymentMethod,
+} from '../../../store/models';
+import { PaymentCurrency } from '../../../store/models/payment-currency';
+import { getCustomerInvoicePageUrl } from '../../invoice';
+import logger from '../../logger';
+import { formatTime } from '../../time';
+import { getExplorerLink } from '../../util';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface CustomerRewardSucceededEmailTemplateOptions {
+  checkoutSessionId: string;
+}
+
+interface CustomerRewardSucceededEmailTemplateContext {
+  locale: string;
+  at: string;
+
+  nftMintItem: NftMintItem | undefined;
+  chainHost: string | undefined;
+  userDid: string;
+  paymentInfo: string;
+  rewardDetail: string;
+  donationSettings: DonationSettings;
+
+  viewInvoiceLink: string;
+  viewTxHashLink: string;
+}
+
+/**
+ * @see https://github.com/blocklet/payment-kit/issues/236#issue-2007698930
+ * @description
+ * @export
+ * @class CustomerRewardSucceededEmailTemplate
+ * @implements {BaseEmailTemplate<CustomerRewardSucceededEmailTemplateContext>}
+ */
+export class CustomerRewardSucceededEmailTemplate
+  implements BaseEmailTemplate<CustomerRewardSucceededEmailTemplateContext>
+{
+  options: CustomerRewardSucceededEmailTemplateOptions;
+
+  constructor(options: CustomerRewardSucceededEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<CustomerRewardSucceededEmailTemplateContext> {
+    const cs: CheckoutSession | null = await CheckoutSession.findByPk(this.options.checkoutSessionId);
+    if (!cs) {
+      throw new Error(`CheckoutSession(${this.options.checkoutSessionId}) not found`);
+    }
+    if (cs.mode !== 'payment') {
+      throw new Error(`CheckoutSession(${this.options.checkoutSessionId}) mode must be payment`);
+    }
+
+    const customer = await Customer.findByPk(cs.customer_id);
+    if (!customer) {
+      throw new Error(`Customer not found: ${cs.customer_id}`);
+    }
+
+    await pWaitFor(
+      async () => {
+        const checkoutSession = await CheckoutSession.findOne({
+          where: {
+            id: cs.id,
+          },
+        });
+
+        return Boolean(['disabled', 'minted', 'sent', 'error'].includes(checkoutSession?.nft_mint_status as string));
+      },
+      { timeout: 1000 * 10, interval: 1000 }
+    );
+
+    const checkoutSession = (await CheckoutSession.findByPk(cs.id)) as CheckoutSession;
+    if (!checkoutSession.payment_link_id) {
+      throw new Error(`Payment link cannot be found for checkoutSession: ${cs.id}`);
+    }
+
+    const paymentLink = await PaymentLink.findByPk(checkoutSession.payment_link_id);
+    if (!paymentLink) {
+      throw new Error(`Payment link cannot be found for payment_link_id(${checkoutSession.payment_link_id})`);
+    }
+    if (paymentLink.submit_type !== 'donate') {
+      throw new Error(`Payment link submit_type(${paymentLink.submit_type}) must be donate`);
+    }
+
+    const paymentCurrency = (await PaymentCurrency.findOne({
+      where: {
+        id: checkoutSession.currency_id,
+      },
+    })) as PaymentCurrency;
+
+    const userDid: string = customer.did;
+    const locale = await getUserLocale(userDid);
+    const at: string = formatTime(checkoutSession.created_at);
+
+    const paymentInfo: string = `${fromUnitToToken(checkoutSession?.amount_total, paymentCurrency.decimal)} ${
+      paymentCurrency.symbol
+    }`;
+    const paymentIntent = await PaymentIntent.findByPk(checkoutSession!.payment_intent_id);
+    if (!paymentIntent) {
+      throw new Error(
+        `Payment intent cannot be found for checkoutSession.payment_intent_id${checkoutSession!.payment_intent_id}`
+      );
+    }
+    const rewardDetail: string = this.getRewardDetail({
+      paymentIntent,
+      paymentCurrency,
+      locale,
+    });
+    const donationSettings: DonationSettings = paymentLink.donation_settings as DonationSettings;
+
+    const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
+    const nftMintItem: NftMintItem | undefined = hasNft
+      ? // @ts-expect-error
+        checkoutSession?.nft_mint_details?.[paymentMethod.type]
+      : undefined;
+
+    const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(paymentIntent!.payment_method_id);
+    // @ts-expect-error
+    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: checkoutSession.invoice_id!,
+      userDid,
+      locale,
+    });
+
+    // @ts-expect-error
+    const txHash: string | undefined = paymentIntent?.payment_details?.[paymentMethod.type]?.tx_hash;
+    const viewTxHashLink: string =
+      (txHash &&
+        getExplorerLink({
+          type: 'tx',
+          did: txHash,
+          chainHost,
+        })) ||
+      '';
+
+    return {
+      locale,
+      at,
+
+      userDid,
+      nftMintItem,
+      chainHost,
+      paymentInfo,
+      rewardDetail,
+      donationSettings,
+
+      viewInvoiceLink,
+      viewTxHashLink,
+    };
+  }
+  getRewardDetail({
+    paymentIntent,
+    paymentCurrency,
+    locale,
+  }: {
+    paymentIntent: PaymentIntent;
+    paymentCurrency: PaymentCurrency;
+    locale: LiteralUnion<'zh' | 'en', string>;
+  }): string {
+    if (isEmpty(paymentIntent.beneficiaries)) {
+      logger.warn('Payment intent not available', { paymentIntentId: paymentIntent.id });
+      return '';
+    }
+
+    const rewardDetail: string = paymentIntent
+      .beneficiaries!.map((x: PaymentBeneficiary) => {
+        return translate('notification.customerRewardSucceeded.received', locale, {
+          address: `${x.address}`,
+          amount: `${fromUnitToToken(x.share, paymentCurrency.decimal)} ${paymentCurrency.symbol}`,
+        });
+      })
+      .join('\r\n');
+
+    return rewardDetail;
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      at,
+      nftMintItem,
+      chainHost,
+      userDid,
+      paymentInfo,
+      rewardDetail,
+      donationSettings,
+
+      viewInvoiceLink,
+      viewTxHashLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.customerRewardSucceeded.title', locale, {
+        amount: paymentInfo,
+      })}`,
+      body: `${translate('notification.customerRewardSucceeded.body', locale, {
+        at,
+        amount: paymentInfo,
+        subject: `<${donationSettings.title}(link:${donationSettings.reference})>`,
+      })}`,
+      // @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.rewardAmount', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${paymentInfo}`,
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.rewardDetail', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${rewardDetail}`,
+              },
+            },
+          ].filter(Boolean),
+        },
+      ].filter(Boolean),
+      // @ts-ignore
+      actions: [
+        viewInvoiceLink && {
+          name: translate('notification.common.viewInvoice', locale),
+          title: translate('notification.common.viewInvoice', locale),
+          link: viewInvoiceLink,
+        },
+        viewTxHashLink && {
+          name: translate('notification.common.viewTxHash', locale),
+          title: translate('notification.common.viewTxHash', locale),
+          link: viewTxHashLink,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

package/api/src/libs/notification/template/one-time-payment-succeeded.ts

@@ -5,7 +5,14 @@ import pWaitFor from 'p-wait-for';
 
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { CheckoutSession, Customer, NftMintItem, PaymentIntent, PaymentMethod } from '../../../store/models';
+import {
+  CheckoutSession,
+  Customer,
+  NftMintItem,
+  PaymentIntent,
+  PaymentLink,
+  PaymentMethod,
+} from '../../../store/models';
 import { PaymentCurrency } from '../../../store/models/payment-currency';
 import { getMainProductNameByCheckoutSession } from '../../product';
 import { formatTime } from '../../time';
@@ -75,6 +82,14 @@ export class OneTimePaymentSucceededEmailTemplate
     );
 
     const checkoutSession = (await CheckoutSession.findByPk(cs.id)) as CheckoutSession;
+    const paymentLink = await PaymentLink.findByPk(checkoutSession.payment_link_id);
+    if (!paymentLink) {
+      throw new Error(`Payment link cannot be found for payment_link_id(${checkoutSession.payment_link_id})`);
+    }
+    if (paymentLink.submit_type !== 'auto') {
+      throw new Error(`Payment link submit_type(${paymentLink.submit_type}) must be auto`);
+    }
+
     const paymentCurrency = (await PaymentCurrency.findOne({
       where: {
         id: checkoutSession.currency_id,

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

@@ -11,7 +11,7 @@ import { Customer, Invoice, PaymentMethod, Subscription } from '../../../store/m
 import { PaymentCurrency } from '../../../store/models/payment-currency';
 import { PaymentDetail, getPaymentDetail } from '../../payment';
 import { getMainProductName } from '../../product';
-import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { getCustomerSubscriptionPageUrl, getUpcomingInvoiceAmount } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
 import { getExplorerLink } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
@@ -84,7 +84,11 @@ export class SubscriptionWillRenewEmailTemplate
       locale === 'en' ? this.getWillRenewDuration(locale) : this.getWillRenewDuration(locale).split(' ').join('');
 
     const paymentDetail: PaymentDetail = await getPaymentDetail(userDid, invoice);
-    const paymentInfo: string = `${fromUnitToToken(+invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+    const upcomingInvoiceAmount = await getUpcomingInvoiceAmount(subscription.id);
+    const paymentInfo: string = `${fromUnitToToken(
+      +upcomingInvoiceAmount.amount,
+      upcomingInvoiceAmount.currency?.decimal
+    )} ${paymentCurrency.symbol}`;
     const currentPeriodStart: string = formatTime(invoice.period_start * 1000);
     const currentPeriodEnd: string = formatTime(invoice.period_end * 1000);
     const duration: string = prettyMsI18n(
@@ -248,6 +252,21 @@ export class SubscriptionWillRenewEmailTemplate
                 text: productName,
               },
             },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.currentBalance', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${paymentDetail.balance} ${paymentDetail.symbol}`,
+              },
+            },
             {
               type: 'text',
               data: {

package/api/src/locales/en.ts

@@ -26,6 +26,10 @@ export default flat({
       cancellationReason: 'Cancellation reason',
       renewNow: 'Pay now',
       immediateRecharge: 'Immediate recharge',
+      amount: 'Amount',
+      rewardAmount: 'Reward amount',
+      rewardDetail: 'Reward detail',
+      currentBalance: 'Current balance',
     },
 
     sendTo: 'Sent to',
@@ -62,16 +66,16 @@ export default flat({
     },
 
     subscriptionWillRenew: {
-      title: '{productName} will be deducted automatically',
-      body: 'Your {productName} subscription has {willRenewDuration} until the next deduction. Your current balance is {balance}, please ensure that your account balance is sufficient so that the deduction is automatically completed after the maturity ({at}). I wish you all the best! ',
+      title: '{productName} automatic payment reminder',
+      body: 'Your subscription to {productName} is scheduled for automatic payment on {at}({willRenewDuration} later). If you have any questions or need assistance, please feel free to contact us.',
       unableToPayBody:
-        'Your {productName} subscription has {willRenewDuration} until the next deduction. <span style="color: red;" > Your current balance is {balance}, less than {price}</span>, please ensure that your account balance is sufficient so that the deduction will be completed automatically after the expiration ({at}). I wish you all the best! ',
-      renewAmount: 'deduction amount ',
+        'Your subscription to {productName} is scheduled for automatic payment on {at}({willRenewDuration} later). <span style="color: red;">Your current balance is {balance}, which is less than {price}, please ensure that your account has enough balance to avoid payment failure.</span> If you have any questions or need assistance, please feel free to contact us.',
+      renewAmount: 'Payment Amount',
     },
 
     subscriptionRenewed: {
       title: '{productName} payment successful',
-      body: 'Payment for your subscription {productName} is successfully collected on {at}. Thank you for your continued support and trust, I wish you a happy use! ',
+      body: 'Payment for your subscription {productName} is successfully collected on {at}. Thanks for your continued support and trust, we wish you a pleasant journey when using this service!',
       noExpenseIncurred: 'No expenses incurred during the service ',
     },
 
@@ -99,6 +103,12 @@ export default flat({
       body: 'Your subscription to {productName} has been successfully refunded on {at}, with a refund amount of {refundInfo}. If you have any questions, please feel free to contact us.',
     },
 
+    customerRewardSucceeded: {
+      title: 'Thanks for your reward of {amount}',
+      body: 'Thanks for your reward on {at} for {subject}, the amount of reward is {amount}. Your support is our driving force, thanks for your generous support!',
+      received: '{address} has received {amount}',
+    },
+
     subscriptWillCanceled: {
       title: '{productName} subscription is about to be automatically cancelled ',
       body: 'Your subscription {productName} will be automatically unsubscribed by the system after {at} (after {willCancelDuration}) due to a long period of failure to automatically complete the deduction. Please handle the problem of charge deduction manually in time, so as not to affect the use. If you have any questions, please feel free to contact us. ',

package/api/src/locales/zh.ts

@@ -26,6 +26,10 @@ export default flat({
       cancellationReason: '取消原因',
       renewNow: '立即付款',
       immediateRecharge: '立即充值',
+      amount: '金额',
+      rewardAmount: '打赏金额',
+      rewardDetail: '打赏详情',
+      currentBalance: '当前余额',
     },
 
     sendTo: '发送给',
@@ -62,10 +66,10 @@ export default flat({
     },
 
     subscriptionWillRenew: {
-      title: '{productName} 即将自动完成扣费',
-      body: '您订阅的 {productName} 距离下一次扣费还有 {willRenewDuration}。您的当前余额为 {balance}，请确保您的账户余额充足，以便在到期后({at})自动完成扣费。祝您一切顺利！',
+      title: '{productName} 自动扣费提醒',
+      body: '您订阅的 {productName} 将在 {at}({willRenewDuration}后) 发起自动扣费。若有任何疑问或需要帮助，请随时与我们联系。',
       unableToPayBody:
-        '您订阅的 {productName} 距离下一次扣费还有 {willRenewDuration}。<span style="color: red;">您的当前余额为 {balance}，不足 {price}</span>，请确保您的账户余额充足，以便在到期后({at})自动完成扣费。祝您一切顺利！',
+        '您订阅的 {productName} 将在 {at}({willRenewDuration}后) 发起自动扣费。<span style="color: red;">您的当前余额为 {balance}，不足 {price}</span>，请确保您的账户余额充足，避免扣费失败。若有任何疑问或需要帮助，请随时与我们联系。',
       renewAmount: '扣费金额',
     },
 
@@ -97,6 +101,12 @@ export default flat({
       body: '您订阅的 {productName} 在 {at} 已退款成功，退款金额为 {refundInfo}。如有任何疑问，请随时与我们联系。',
     },
 
+    customerRewardSucceeded: {
+      title: '感谢您打赏的 {amount}',
+      body: '感谢您于 {at} 在 {subject} 下的打赏，打赏金额为 {amount}。您的支持是我们前行的动力，谢谢您的大力支持！',
+      received: '{address} 收到了 {amount}',
+    },
+
     subscriptWillCanceled: {
       title: '{productName} 订阅即将自动取消',
       body: '由于长时间未能自动完成扣费，您订阅的 {productName} 将于 {at} ({willCancelDuration}后) 被系统自动取消订阅。请您及时手动处理扣费问题，以免影响使用。如有任何疑问，请随时与我们联系。',

package/api/src/queues/notification.ts

@@ -3,6 +3,10 @@ import { events } from '../libs/event';
 import logger from '../libs/logger';
 import { Notification } from '../libs/notification';
 import type { BaseEmailTemplate } from '../libs/notification/template/base';
+import {
+  CustomerRewardSucceededEmailTemplate,
+  CustomerRewardSucceededEmailTemplateOptions,
+} from '../libs/notification/template/customer-reward-succeeded';
 import {
   OneTimePaymentSucceededEmailTemplate,
   OneTimePaymentSucceededEmailTemplateOptions,
@@ -48,7 +52,7 @@ import {
   SubscriptionWillRenewEmailTemplateOptions,
 } from '../libs/notification/template/subscription-will-renew';
 import createQueue from '../libs/queue';
-import { CheckoutSession, EventType, Invoice, Refund, Subscription } from '../store/models';
+import { CheckoutSession, EventType, Invoice, PaymentLink, Refund, Subscription } from '../store/models';
 
 export type NotificationQueueJobOptions = any;
 
@@ -56,7 +60,8 @@ export type NotificationQueueJobType =
   | EventType
   | 'customer.subscription.will_renew'
   | 'customer.subscription.trial_will_end'
-  | 'customer.subscription.will_canceled';
+  | 'customer.subscription.will_canceled'
+  | 'customer.reward.succeeded';
 
 export type NotificationQueueJob = {
   type: NotificationQueueJobType;
@@ -97,6 +102,9 @@ function getNotificationTemplate(job: NotificationQueueJob): BaseEmailTemplate {
   if (job.type === 'refund.succeeded') {
     return new SubscriptionRefundSucceededEmailTemplate(job.options as SubscriptionRefundSucceededEmailTemplateOptions);
   }
+  if (job.type === 'customer.reward.succeeded') {
+    return new CustomerRewardSucceededEmailTemplate(job.options as CustomerRewardSucceededEmailTemplateOptions);
+  }
 
   throw new Error(`Unknown job type: ${job.type}`);
 }
@@ -160,8 +168,22 @@ export async function startNotificationQueue() {
   });
 
   // 一次性购买成功
-  events.on('checkout.session.completed', (checkoutSession: CheckoutSession) => {
+  events.on('checkout.session.completed', async (checkoutSession: CheckoutSession) => {
     if (checkoutSession.mode === 'payment') {
+      const paymentLink = await PaymentLink.findByPk(checkoutSession.payment_link_id);
+      if (paymentLink?.submit_type === 'donate') {
+        notificationQueue.push({
+          id: `customer.reward.succeeded.${checkoutSession.id}`,
+          job: {
+            type: 'customer.reward.succeeded',
+            options: {
+              checkoutSessionId: checkoutSession.id,
+            },
+          },
+        });
+        return;
+      }
+
       notificationQueue.push({
         id: `checkout.session.completed.${checkoutSession.id}`,
         job: {

package/blocklet.yml

@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/payment-kit.git
 specVersion: 1.2.8
-version: 1.13.247
+version: 1.13.249
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "payment-kit",
-  "version": "1.13.248",
+  "version": "1.13.249",
   "scripts": {
-    "dev": "cross-env COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev --open",
+    "dev": "blocklet dev --open",
     "eject": "vite eject",
     "lint": "tsc --noEmit && eslint src api/src --ext .mjs,.js,.jsx,.ts,.tsx",
     "lint:fix": "npm run lint -- --fix",
@@ -51,7 +51,7 @@
     "@arcblock/ux": "^2.9.77",
     "@arcblock/validator": "^1.18.116",
     "@blocklet/logger": "1.16.26",
-    "@blocklet/payment-react": "1.13.248",
+    "@blocklet/payment-react": "1.13.249",
     "@blocklet/sdk": "1.16.26",
     "@blocklet/ui-react": "^2.9.77",
     "@blocklet/uploader": "^0.1.6",
@@ -116,7 +116,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.26",
     "@arcblock/eslint-config-ts": "^0.3.0",
-    "@blocklet/payment-types": "1.13.248",
+    "@blocklet/payment-types": "1.13.249",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -155,5 +155,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "7d3aeec451e759eef8b676a11041ff9c5b7cd92d"
+  "gitHead": "8d7617c2a9cb318f4e161163f44de29abf99c150"
 }