payment-kit 1.15.4 → 1.15.5

package/api/src/index.ts

@@ -37,6 +37,7 @@ import setupHandlers from './routes/connect/setup';
 import subscribeHandlers from './routes/connect/subscribe';
 import { initialize } from './store/models';
 import { sequelize } from './store/sequelize';
+import { initUserHandler } from './integrations/blocklet/user';
 
 dotenv.config();
 
@@ -131,4 +132,6 @@ export const server = app.listen(port, (err?: any) => {
   initEventBroadcast();
 
   initResourceHandler();
+
+  initUserHandler();
 });

package/api/src/integrations/blocklet/user.ts

@@ -0,0 +1,30 @@
+import { Customer } from '@api/store/models';
+import notification from '@blocklet/sdk/service/notification';
+
+import logger from '../../libs/logger';
+
+const handleUserUpdate = async ({ user }: { user: any }) => {
+  logger.info('user Updated', {
+    did: user.did,
+    updated_at: user.updatedAt,
+  });
+  const customer = await Customer.findOne({
+    where: {
+      did: user.did,
+    },
+  });
+  if (customer) {
+    const now = Math.floor(Date.now() / 1000);
+    await customer.update({
+      name: user.fullName,
+      email: user.email,
+      phone: user.phone,
+      last_sync_at: now,
+    });
+    logger.info(`customer info updated: ${customer.did}`);
+  }
+};
+
+export function initUserHandler() {
+  notification.on('user.updated', handleUserUpdate);
+}

package/api/src/libs/invoice.ts

@@ -2,7 +2,10 @@ import { component } from '@blocklet/sdk';
 import type { LiteralUnion } from 'type-fest';
 import { withQuery } from 'ufo';
 
+import { Invoice, InvoiceItem, PaymentCurrency, Price, Product } from '@api/store/models';
+import { fromUnitToToken } from '@ocap/util';
 import { getConnectQueryParam } from './util';
+import { expandLineItems } from './session';
 
 export function getCustomerInvoicePageUrl({
   invoiceId,
@@ -23,3 +26,41 @@ export function getCustomerInvoicePageUrl({
     })
   );
 }
+
+export async function getOneTimeProductInfo(invoiceId: string, paymentCurrency: PaymentCurrency) {
+  try {
+    const doc = await Invoice.findOne({
+      where: { id: invoiceId },
+      include: [{ model: InvoiceItem, as: 'lines' }],
+    });
+    if (!doc) {
+      throw new Error(`Invoice not found in ${invoiceId}`);
+    }
+    const json = doc.toJSON();
+    const products = (await Product.findAll()).map((x) => x.toJSON());
+    const prices = (await Price.findAll()).map((x) => x.toJSON());
+    // @ts-ignore
+    expandLineItems(json.lines, products, prices);
+    const oneTimePaymentInfo: Array<{
+      productName: string;
+      paymentInfo: string;
+      quantity: number;
+    }> = [];
+    // @ts-ignore
+    (json.lines || []).forEach((x) => {
+      const { recurring, product } = x.price;
+      if (!recurring) {
+        // it's one-time product
+        oneTimePaymentInfo.push({
+          productName: product?.name,
+          paymentInfo: `${fromUnitToToken(x.amount, paymentCurrency.decimal)} ${paymentCurrency.symbol}`,
+          quantity: x.quantity,
+        });
+      }
+    });
+    return oneTimePaymentInfo;
+  } catch (err) {
+    console.error(err);
+    return [];
+  }
+}

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

@@ -5,6 +5,7 @@ import isEmpty from 'lodash/isEmpty';
 import pWaitFor from 'p-wait-for';
 import type { LiteralUnion } from 'type-fest';
 
+import { joinURL } from 'ufo';
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
 import {
@@ -21,7 +22,7 @@ import { PaymentCurrency } from '../../../store/models/payment-currency';
 import { getCustomerInvoicePageUrl } from '../../invoice';
 import logger from '../../logger';
 import { formatTime } from '../../time';
-import { getExplorerLink } from '../../util';
+import { getCustomerProfileUrl, getExplorerLink } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 import { blocklet } from '../../auth';
 
@@ -37,7 +38,14 @@ interface CustomerRewardSucceededEmailTemplateContext {
   chainHost: string | undefined;
   userDid: string;
   paymentInfo: string;
-  rewardDetail: string;
+  rewardDetail:
+    | {
+        url: string;
+        title: string;
+        appDID: string;
+        logo?: string;
+      }[]
+    | null;
   donationSettings: DonationSettings;
 
   viewInvoiceLink: string;
@@ -117,7 +125,7 @@ export class CustomerRewardSucceededEmailTemplate
         `Payment intent cannot be found for checkoutSession.payment_intent_id${checkoutSession!.payment_intent_id}`
       );
     }
-    const rewardDetail: string = await this.getRewardDetail({
+    const rewardDetail = await this.getRewardDetail({
       paymentIntent,
       paymentCurrency,
       locale,
@@ -173,10 +181,18 @@ export class CustomerRewardSucceededEmailTemplate
     paymentIntent: PaymentIntent;
     paymentCurrency: PaymentCurrency;
     locale: LiteralUnion<'zh' | 'en', string>;
-  }): Promise<string> {
+  }): Promise<
+    | {
+        url: string;
+        title: string;
+        appDID: string;
+        logo?: string;
+      }[]
+    | null
+  > {
     if (isEmpty(paymentIntent.beneficiaries)) {
       logger.warn('Payment intent not available', { paymentIntentId: paymentIntent.id });
-      return '';
+      return null;
     }
 
     const promises = paymentIntent.beneficiaries!.map((x: PaymentBeneficiary) => {
@@ -185,16 +201,22 @@ export class CustomerRewardSucceededEmailTemplate
     const users = await Promise.all(promises);
     if (!users.length) {
       logger.warn('No users found for payment intent', { paymentIntentId: paymentIntent.id });
-      return '';
+      return null;
     }
-    const rewardDetail: string = paymentIntent
-      .beneficiaries!.map((x: PaymentBeneficiary, index: number) => {
-        return translate('notification.customerRewardSucceeded.received', locale, {
-          address: `${users[index]?.user?.fullName || ''} ( ${x.address} )`,
+    const rewardDetail = paymentIntent.beneficiaries!.map((x: PaymentBeneficiary, index: number) => {
+      return {
+        url: getCustomerProfileUrl({ userDid: x.address, locale }),
+        title: translate('notification.customerRewardSucceeded.received', locale, {
+          address: users[index]?.user?.fullName || x.address,
           amount: `${fromUnitToToken(x.share, paymentCurrency.decimal)} ${paymentCurrency.symbol}`,
-        });
-      })
-      .join('\r\n');
+        }),
+        logo:
+          process.env.BLOCKLET_APP_URL && users[index]?.user?.avatar
+            ? joinURL(process.env.BLOCKLET_APP_URL, users[index]?.user?.avatar as string)
+            : '',
+        appDID: x.address,
+      };
+    });
 
     return rewardDetail;
   }
@@ -274,15 +296,14 @@ export class CustomerRewardSucceededEmailTemplate
                 text: translate('notification.common.rewardDetail', locale),
               },
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: `${rewardDetail}`,
-              },
-            },
           ].filter(Boolean),
         },
+        ...(rewardDetail
+          ? rewardDetail.map((x) => ({
+              type: 'dapp',
+              data: x,
+            }))
+          : []),
       ].filter(Boolean),
       // @ts-ignore
       actions: [

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

@@ -78,6 +78,9 @@ export class SubscriptionRenewFailedEmailTemplate
       throw new Error(`Subscription not found: ${this.options.invoice.subscription_id}`);
     }
 
+    if (subscription.isImmutable()) {
+      throw new Error(`Cannot renew an immutable subscription: ${subscription.id}`);
+    }
     const customer = await Customer.findByPk(subscription.customer_id);
     if (!customer) {
       throw new Error(`Customer not found: ${subscription.customer_id}`);
@@ -188,7 +191,6 @@ export class SubscriptionRenewFailedEmailTemplate
       body: `${translate('notification.subscriptionRenewFailed.body', locale, {
         at,
         productName,
-        reason: `<span style="color: red;">${reason}</span>`,
       })}`,
       // @ts-expect-error
       attachments: [
@@ -240,6 +242,22 @@ export class SubscriptionRenewFailedEmailTemplate
                 text: paymentInfo,
               },
             },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.failReason', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#FF0000',
+                text: reason,
+              },
+            },
             {
               type: 'text',
               data: {

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

@@ -1,9 +1,10 @@
 /* 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 isEmpty from 'lodash/isEmpty';
 
+import { getPaymentAmountForCycleSubscription } from '@api/libs/payment';
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
 import {
@@ -16,7 +17,7 @@ import {
 } from '../../../store/models';
 import { Invoice } from '../../../store/models/invoice';
 import { PaymentCurrency } from '../../../store/models/payment-currency';
-import { getCustomerInvoicePageUrl } from '../../invoice';
+import { getCustomerInvoicePageUrl, getOneTimeProductInfo } from '../../invoice';
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
@@ -27,6 +28,12 @@ export interface SubscriptionSucceededEmailTemplateOptions {
   subscriptionId: string;
 }
 
+interface OneTimeProductInfo {
+  paymentInfo: string;
+  productName: string;
+  quantity: number;
+}
+
 interface SubscriptionSucceededEmailTemplateContext {
   locale: string;
   productName: string;
@@ -41,6 +48,7 @@ interface SubscriptionSucceededEmailTemplateContext {
   viewSubscriptionLink: string;
   viewInvoiceLink: string;
   viewTxHashLink: string | undefined;
+  oneTimeProductInfo?: Array<OneTimeProductInfo>;
 }
 
 export class SubscriptionSucceededEmailTemplate
@@ -90,12 +98,7 @@ export class SubscriptionSucceededEmailTemplate
       { timeout: 1000 * 10, interval: 1000 }
     );
 
-    const invoice = (await Invoice.findOne({
-      where: {
-        subscription_id: subscription.id,
-      },
-      order: [['created_at', 'ASC']],
-    })) as Invoice;
+    const invoice = (await Invoice.findByPk(subscription.latest_invoice_id)) as Invoice;
     const paymentCurrency = (await PaymentCurrency.findOne({
       where: {
         id: subscription.currency_id,
@@ -113,7 +116,10 @@ export class SubscriptionSucceededEmailTemplate
     const productName = await getMainProductName(subscription.id);
     const at: string = formatTime(subscription.created_at);
 
-    const paymentInfo: string = `${fromUnitToToken(invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+    const oneTimeProductInfo = await getOneTimeProductInfo(subscription.latest_invoice_id as string, paymentCurrency);
+    const paymentAmount = await getPaymentAmountForCycleSubscription(subscription, paymentCurrency);
+
+    const paymentInfo: string = `${paymentAmount} ${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']
@@ -169,9 +175,76 @@ export class SubscriptionSucceededEmailTemplate
       viewSubscriptionLink,
       viewInvoiceLink,
       viewTxHashLink,
+      oneTimeProductInfo,
     };
   }
 
+  getOneTimeProductTemplate(oneTimeProductInfo: Array<OneTimeProductInfo>, locale: string = 'en') {
+    return [
+      {
+        type: 'divider',
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: translate('notification.common.expandPayment', locale),
+        },
+      },
+      {
+        type: 'section',
+        fields: (oneTimeProductInfo || []).flatMap((x: any) => [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.product', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: x?.productName,
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.paymentAmount', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: x?.paymentInfo,
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.paymentQuantity', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: translate('notification.common.qty', locale, {
+                count: x.quantity,
+              }),
+            },
+          },
+        ]),
+      },
+    ];
+  }
   async getTemplate(): Promise<BaseEmailTemplateType> {
     const {
       locale,
@@ -187,7 +260,9 @@ export class SubscriptionSucceededEmailTemplate
       viewSubscriptionLink,
       viewInvoiceLink,
       viewTxHashLink,
+      oneTimeProductInfo,
     } = await this.getContext();
+    const hasOneTimeProduct = !isEmpty(oneTimeProductInfo);
 
     const template: BaseEmailTemplateType = {
       title: `${translate('notification.subscriptionSucceed.title', locale, {
@@ -207,6 +282,13 @@ export class SubscriptionSucceededEmailTemplate
               did: nftMintItem.address,
             },
           },
+        hasOneTimeProduct && {
+          type: 'text',
+          data: {
+            type: 'plain',
+            text: translate('notification.common.subscribeProduct', locale),
+          },
+        },
         {
           type: 'section',
           fields: [
@@ -272,6 +354,9 @@ export class SubscriptionSucceededEmailTemplate
             },
           ].filter(Boolean),
         },
+        ...(hasOneTimeProduct
+          ? this.getOneTimeProductTemplate(oneTimeProductInfo as Array<OneTimeProductInfo>, locale)
+          : []),
       ].filter(Boolean),
       // @ts-ignore
       actions: [

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

@@ -4,11 +4,12 @@ import { fromUnitToToken, toDid } from '@ocap/util';
 import pWaitFor from 'p-wait-for';
 import prettyMsI18n from 'pretty-ms-i18n';
 
+import isEmpty from 'lodash/isEmpty';
 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 { getCustomerInvoicePageUrl, getOneTimeProductInfo } from '../../invoice';
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
@@ -18,6 +19,12 @@ export interface SubscriptionTrialStartEmailTemplateOptions {
   subscriptionId: string;
 }
 
+interface OneTimeProductInfo {
+  paymentInfo: string;
+  productName: string;
+  quantity: number;
+}
+
 interface SubscriptionTrialStartEmailTemplateContext {
   locale: string;
   productName: string;
@@ -33,6 +40,7 @@ interface SubscriptionTrialStartEmailTemplateContext {
 
   viewSubscriptionLink: string;
   viewInvoiceLink: string;
+  oneTimeProductInfo?: Array<OneTimeProductInfo>;
 }
 
 export class SubscriptionTrialStartEmailTemplate
@@ -81,6 +89,8 @@ export class SubscriptionTrialStartEmailTemplate
       },
     })) as PaymentCurrency;
 
+    const oneTimeProductInfo = await getOneTimeProductInfo(subscription.latest_invoice_id as string, paymentCurrency);
+
     const checkoutSession = await CheckoutSession.findOne({
       where: {
         subscription_id: subscription.id,
@@ -99,7 +109,7 @@ export class SubscriptionTrialStartEmailTemplate
     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 = `${fromUnitToToken(invoice?.total || '0', paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+    const paymentInfo: string = `${fromUnitToToken('0', paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
     const currentPeriodStart: string = formatTime((subscription.trial_start as number) * 1000);
     const currentPeriodEnd: string = formatTime((subscription.trial_end as number) * 1000);
     const duration: string = prettyMsI18n(
@@ -135,9 +145,77 @@ export class SubscriptionTrialStartEmailTemplate
 
       viewSubscriptionLink,
       viewInvoiceLink,
+      oneTimeProductInfo,
     };
   }
 
+  getOneTimeProductTemplate(oneTimeProductInfo: Array<OneTimeProductInfo>, locale: string = 'en') {
+    return [
+      {
+        type: 'divider',
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: translate('notification.common.expandPayment', locale),
+        },
+      },
+      {
+        type: 'section',
+        fields: (oneTimeProductInfo || []).flatMap((x: any) => [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.product', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: x?.productName,
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.paymentAmount', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: x?.paymentInfo,
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.paymentQuantity', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: translate('notification.common.qty', locale, {
+                count: x.quantity,
+              }),
+            },
+          },
+        ]),
+      },
+    ];
+  }
+
   async getTemplate(): Promise<BaseEmailTemplateType> {
     const {
       locale,
@@ -147,15 +225,16 @@ export class SubscriptionTrialStartEmailTemplate
       nftMintItem,
       chainHost,
       userDid,
-      paymentInfo,
       currentPeriodStart,
       currentPeriodEnd,
       duration,
 
       viewSubscriptionLink,
       viewInvoiceLink,
+      oneTimeProductInfo,
     } = await this.getContext();
 
+    const hasOneTimeProduct = !isEmpty(oneTimeProductInfo);
     const template: BaseEmailTemplateType = {
       title: `${translate('notification.subscriptionTrialStart.title', locale, {
         productName,
@@ -175,6 +254,13 @@ export class SubscriptionTrialStartEmailTemplate
               did: nftMintItem.address,
             },
           },
+        hasOneTimeProduct && {
+          type: 'text',
+          data: {
+            type: 'plain',
+            text: translate('notification.common.trialProduct', locale),
+          },
+        },
         {
           type: 'section',
           fields: [
@@ -208,21 +294,6 @@ export class SubscriptionTrialStartEmailTemplate
                 text: productName,
               },
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.paymentAmount', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: paymentInfo,
-              },
-            },
             {
               type: 'text',
               data: {
@@ -255,6 +326,9 @@ export class SubscriptionTrialStartEmailTemplate
             },
           ].filter(Boolean),
         },
+        ...(hasOneTimeProduct
+          ? this.getOneTimeProductTemplate(oneTimeProductInfo as Array<OneTimeProductInfo>, locale)
+          : []),
       ].filter(Boolean),
       // @ts-ignore
       actions: [