payment-kit 1.13.136 → 1.13.138

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

@@ -84,7 +84,7 @@ export class SubscriptionSucceededEmailTemplate
 
         return Boolean(
           ['disabled', 'minted', 'sent', 'error'].includes(checkoutSession?.nft_mint_status as string) &&
-            invoice?.payment_intent_id
+            (invoice?.payment_intent_id || (invoice && +invoice.total === 0))
         );
       },
       { timeout: 1000 * 10, interval: 1000 }
@@ -108,7 +108,8 @@ export class SubscriptionSucceededEmailTemplate
       },
     });
 
-    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(subscription.created_at);
 
@@ -130,8 +131,16 @@ export class SubscriptionSucceededEmailTemplate
     // @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 viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: invoice.id,
+      userDid,
+      locale,
+    });
 
     const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
     const txHash: string | undefined =
@@ -143,7 +152,7 @@ export class SubscriptionSucceededEmailTemplate
       productName,
       at,
 
-      userDid: customer.did,
+      userDid,
       nftMintItem,
       chainHost,
       paymentInfo,

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

@@ -90,7 +90,8 @@ export class SubscriptionTrailStartEmailTemplate
       },
     });
 
-    const locale = await getUserLocale(customer.did);
+    const userDid: string = customer.did;
+    const locale = await getUserLocale(userDid);
     const productName = await getMainProductName(subscription.id);
     const subscriptionTrialEnd: string = formatTime((subscription.trail_end as number) * 1000);
 
@@ -111,8 +112,16 @@ export class SubscriptionTrailStartEmailTemplate
       }
     );
 
-    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,
+    });
 
     return {
       locale,
@@ -121,7 +130,7 @@ export class SubscriptionTrailStartEmailTemplate
 
       nftMintItem,
       chainHost,
-      userDid: customer.did,
+      userDid,
       paymentInfo,
       currentPeriodStart,
       currentPeriodEnd,

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

@@ -70,13 +70,13 @@ export class SubscriptionTrailWilEndEmailTemplate
       },
     })) as PaymentCurrency;
 
-    const locale = await getUserLocale(customer.did);
+    const userDid = customer.did;
+    const locale = await getUserLocale(userDid);
     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).split(' ').join('');
 
-    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);
@@ -88,7 +88,11 @@ export class SubscriptionTrailWilEndEmailTemplate
       }
     );
 
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl(subscription.id, locale);
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
 
     return {
       locale,

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

@@ -0,0 +1,261 @@
+/* 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 {
+  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 SubscriptionUpgradedEmailTemplateOptions {
+  subscriptionId: string;
+}
+
+interface SubscriptionUpgradedEmailTemplateContext {
+  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 SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<SubscriptionUpgradedEmailTemplateContext> {
+  options: SubscriptionUpgradedEmailTemplateOptions;
+
+  constructor(options: SubscriptionUpgradedEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionUpgradedEmailTemplateContext> {
+    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
+    if (!subscription) {
+      throw new Error(`Subscription not found: ${this.options.subscriptionId}`);
+    }
+    if (subscription.status !== 'active') {
+      throw new Error(`Subscription not active: ${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 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 userDid: string = customer.did;
+    const locale = await getUserLocale(userDid);
+    const productName = await getMainProductName(subscription.id);
+    const at: string = formatTime(subscription.created_at);
+
+    const paymentInfo: string = `${fromUnitToToken(paymentIntent?.amount, 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);
+    // @ts-expect-error
+    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: invoice.id,
+      userDid,
+      locale,
+    });
+
+    // @ts-expect-error
+    const txHash: string | undefined = paymentIntent?.payment_details?.[paymentMethod.type]?.tx_hash;
+    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash, 'tx');
+
+    return {
+      locale,
+      productName,
+      at,
+
+      userDid,
+      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.subscriptionUpgraded.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: `${translate('notification.subscriptionUpgraded.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,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

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

@@ -0,0 +1,225 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } from '@ocap/util';
+import type { ManipulateType } from 'dayjs';
+
+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 { getCustomerInvoicePageUrl } from '../../invoice';
+import logger from '../../logger';
+import { getMainProductName } from '../../product';
+import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { formatTime } from '../../time';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface SubscriptionWillCanceledEmailTemplateOptions {
+  subscriptionId: string;
+  willCancelValue: number;
+  willCancelUnit: ManipulateType;
+  required?: false | true;
+}
+
+interface SubscriptionWillCanceledEmailTemplateContext {
+  locale: string;
+  productName: string;
+  at: string;
+  willCancelDuration: string;
+
+  userDid: string;
+  paymentInfo: string;
+
+  viewSubscriptionLink: string;
+  viewInvoiceLink: string;
+}
+
+export class SubscriptionWillCanceledEmailTemplate
+  implements BaseEmailTemplate<SubscriptionWillCanceledEmailTemplateContext>
+{
+  options: SubscriptionWillCanceledEmailTemplateOptions;
+
+  constructor(options: SubscriptionWillCanceledEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<SubscriptionWillCanceledEmailTemplateContext> {
+    if (!this.options.required) {
+      logger.error('SubscriptionWillCanceledEmailTemplate: This execution will be skipped', this.options);
+      throw new Error('SubscriptionWillCanceledEmailTemplate: This execution will be skipped');
+    }
+
+    const subscription: Subscription | null = await Subscription.findByPk(this.options.subscriptionId);
+    if (!subscription) {
+      throw new Error(`Subscription(${this.options.subscriptionId}) not found`);
+    }
+    if (subscription.status !== 'past_due') {
+      throw new Error(`Subscription(${this.options.subscriptionId}) status(${subscription.status}) must be past_due`);
+    }
+
+    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 userDid = customer.did;
+    const locale = await getUserLocale(userDid);
+    const productName = await getMainProductName(subscription.id);
+    const at: string = formatTime(invoice.period_end * 1000);
+    const willCancelDuration: string =
+      locale === 'en' ? this.getWillCancelDuration(locale) : this.getWillCancelDuration(locale).split(' ').join('');
+
+    const paymentInfo: string = `${fromUnitToToken(+invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
+
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+    const viewInvoiceLink = getCustomerInvoicePageUrl({
+      invoiceId: invoice.id,
+      userDid,
+      locale,
+      action: 'pay',
+    });
+
+    return {
+      locale,
+      productName,
+      at,
+      willCancelDuration,
+
+      userDid,
+      paymentInfo,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+    };
+  }
+
+  getWillCancelDuration(locale: string): string {
+    if (this.options.willCancelUnit === 'M') {
+      if (this.options.willCancelValue > 1) {
+        return `${this.options.willCancelValue} ${translate('notification.common.months', locale)}`;
+      }
+
+      return `${this.options.willCancelValue} ${translate('notification.common.month', locale)}`;
+    }
+    if (this.options.willCancelUnit === 'd') {
+      if (this.options.willCancelValue > 1) {
+        return `${this.options.willCancelValue} ${translate('notification.common.days', locale)}`;
+      }
+      return `${this.options.willCancelValue} ${translate('notification.common.day', locale)}`;
+    }
+
+    if (this.options.willCancelUnit === 'm') {
+      if (this.options.willCancelValue > 1) {
+        return `${this.options.willCancelValue} ${translate('notification.common.minutes', locale)}`;
+      }
+      return `${this.options.willCancelValue} ${translate('notification.common.minute', locale)}`;
+    }
+
+    return `${this.options.willCancelValue} ${this.options.willCancelUnit}`;
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType | null> {
+    const {
+      locale,
+      productName,
+      at,
+      willCancelDuration,
+
+      userDid,
+      paymentInfo,
+
+      viewSubscriptionLink,
+      viewInvoiceLink,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: `${translate('notification.subscriptWillCanceled.title', locale, {
+        productName: `(${productName})`,
+      })}`,
+      body: translate('notification.subscriptWillCanceled.body', locale, {
+        productName,
+        willCancelDuration,
+        at,
+      }),
+      // @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.subscriptWillCanceled.renewAmount', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: paymentInfo,
+              },
+            },
+          ].filter(Boolean),
+        },
+      ].filter(Boolean),
+      // @ts-ignore
+      actions: [
+        viewSubscriptionLink && {
+          name: 'viewSubscription',
+          title: translate('notification.common.viewSubscription', locale),
+          link: viewSubscriptionLink,
+        },
+        viewInvoiceLink && {
+          name: 'viewInvoice',
+          title: translate('notification.common.renewNow', locale),
+          link: viewInvoiceLink,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}

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

@@ -2,6 +2,7 @@
 /* eslint-disable @typescript-eslint/indent */
 import { fromUnitToToken } from '@ocap/util';
 import type { ManipulateType } from 'dayjs';
+import dayjs from 'dayjs';
 import prettyMsI18n from 'pretty-ms-i18n';
 
 import { getUserLocale } from '../../../integrations/blocklet/notification';
@@ -57,6 +58,9 @@ export class SubscriptionWillRenewEmailTemplate
     if (subscription.isScheduledToCancel()) {
       throw new Error(`Subscription is scheduled to cancel: ${this.options.subscriptionId}`);
     }
+    if (await this.subscriptionIsRenewed(subscription)) {
+      throw new Error(`The subscription(${this.options.subscriptionId}) has been renewed`);
+    }
 
     const customer = await Customer.findByPk(subscription.customer_id);
     if (!customer) {
@@ -70,13 +74,13 @@ export class SubscriptionWillRenewEmailTemplate
       },
     })) as PaymentCurrency;
 
-    const locale = await getUserLocale(customer.did);
+    const userDid = customer.did;
+    const locale = await getUserLocale(userDid);
     const productName = await getMainProductName(subscription.id);
     const at: string = formatTime(invoice.period_end * 1000);
     const willRenewDuration: string =
       locale === 'en' ? this.getWillRenewDuration(locale) : this.getWillRenewDuration(locale).split(' ').join('');
 
-    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(invoice.period_start * 1000);
@@ -88,7 +92,11 @@ export class SubscriptionWillRenewEmailTemplate
       }
     );
 
-    const viewSubscriptionLink = getCustomerSubscriptionPageUrl(subscription.id, locale);
+    const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
 
     return {
       locale,
@@ -107,6 +115,25 @@ export class SubscriptionWillRenewEmailTemplate
     };
   }
 
+  /**
+   * @see https://github.com/blocklet/payment-kit/issues/307
+   * @description 该订阅已经在指定期限内续费过了吗?
+   * @param {Subscription} subscription
+   * @return {*}  {Promise<void>}
+   * @memberof SubscriptionWillRenewEmailTemplate
+   */
+  // eslint-disable-next-line require-await
+  async subscriptionIsRenewed(subscription: Subscription): Promise<boolean> {
+    // @note: 为了最精确的验证，这里的期限 this.options.willRenewValue 还要 + 1,如果没有订阅没有续费,那么 expectedCurrentPeriodEnd 一定是大于 currentPeriodEnd
+    const expectedCurrentPeriodEnd: number = dayjs()
+      .add(this.options.willRenewValue + 1, this.options.willRenewUnit)
+      .toDate()
+      .getTime();
+    const currentPeriodEnd: number = subscription.current_period_end * 1000;
+
+    return currentPeriodEnd > expectedCurrentPeriodEnd;
+  }
+
   getWillRenewDuration(locale: string): string {
     if (this.options.willRenewUnit === 'M') {
       if (this.options.willRenewValue > 1) {

package/api/src/libs/product.ts

@@ -38,3 +38,27 @@ export async function getMainProductName(subscriptionId: string): Promise<string
 
   return product.name;
 }
+
+export async function getMainProductNameByCheckoutSession(checkoutSession: CheckoutSession): Promise<string> {
+  const priceId: string = checkoutSession?.line_items.find((x) => !x.cross_sell)?.price_id as string;
+
+  if (!priceId) {
+    throw new Error(`PriceId can't be found by checkoutSession(${checkoutSession.id})`);
+  }
+
+  const price = await Price.findByPk(priceId, {
+    attributes: ['product_id'],
+  });
+
+  if (!price) {
+    throw new Error(`Price can't be found by priceId(${priceId})`);
+  }
+
+  const product = await Product.findByPk(price?.product_id);
+
+  if (!product) {
+    throw new Error(`Product can't be found by productId(${price?.product_id})`);
+  }
+
+  return product.name;
+}