payment-kit 1.15.16 → 1.15.18

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

@@ -21,7 +21,7 @@ import { getCustomerInvoicePageUrl, getOneTimeProductInfo } from '../../invoice'
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import { getExplorerLink } from '../../util';
+import { getExplorerLink, getSubscriptionNotificationCustomActions } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionSucceededEmailTemplateOptions {
@@ -49,6 +49,7 @@ interface SubscriptionSucceededEmailTemplateContext {
   viewInvoiceLink: string;
   viewTxHashLink: string | undefined;
   oneTimeProductInfo?: Array<OneTimeProductInfo>;
+  customActions: any[];
 }
 
 export class SubscriptionSucceededEmailTemplate
@@ -159,6 +160,12 @@ export class SubscriptionSucceededEmailTemplate
         chainHost,
       });
 
+    const customActions = getSubscriptionNotificationCustomActions(
+      subscription,
+      'customer.subscription.started',
+      locale
+    );
+
     return {
       locale,
       productName,
@@ -176,6 +183,7 @@ export class SubscriptionSucceededEmailTemplate
       viewInvoiceLink,
       viewTxHashLink,
       oneTimeProductInfo,
+      customActions,
     };
   }
 
@@ -261,6 +269,7 @@ export class SubscriptionSucceededEmailTemplate
       viewInvoiceLink,
       viewTxHashLink,
       oneTimeProductInfo,
+      customActions,
     } = await this.getContext();
     const hasOneTimeProduct = !isEmpty(oneTimeProductInfo);
 
@@ -375,6 +384,7 @@ export class SubscriptionSucceededEmailTemplate
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink as string,
         },
+        ...customActions,
       ].filter(Boolean),
     };
 

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

@@ -14,6 +14,7 @@ import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { getSubscriptionNotificationCustomActions } from '../../util';
 
 export interface SubscriptionTrialStartEmailTemplateOptions {
   subscriptionId: string;
@@ -41,6 +42,7 @@ interface SubscriptionTrialStartEmailTemplateContext {
   viewSubscriptionLink: string;
   viewInvoiceLink: string;
   oneTimeProductInfo?: Array<OneTimeProductInfo>;
+  customActions: any[];
 }
 
 export class SubscriptionTrialStartEmailTemplate
@@ -130,6 +132,12 @@ export class SubscriptionTrialStartEmailTemplate
       locale,
     });
 
+    const customActions = getSubscriptionNotificationCustomActions(
+      subscription,
+      'customer.subscription.trial_start',
+      locale
+    );
+
     return {
       locale,
       productName,
@@ -146,6 +154,7 @@ export class SubscriptionTrialStartEmailTemplate
       viewSubscriptionLink,
       viewInvoiceLink,
       oneTimeProductInfo,
+      customActions,
     };
   }
 
@@ -232,6 +241,7 @@ export class SubscriptionTrialStartEmailTemplate
       viewSubscriptionLink,
       viewInvoiceLink,
       oneTimeProductInfo,
+      customActions,
     } = await this.getContext();
 
     const hasOneTimeProduct = !isEmpty(oneTimeProductInfo);
@@ -342,6 +352,7 @@ export class SubscriptionTrialStartEmailTemplate
           title: translate('notification.common.viewInvoice', locale),
           link: viewInvoiceLink,
         },
+        ...customActions,
       ].filter(Boolean),
     };
 

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

@@ -13,6 +13,8 @@ import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import dayjs from '../../dayjs';
+import { getSubscriptionNotificationCustomActions } from '../../util';
 
 export interface SubscriptionTrialWillEndEmailTemplateOptions {
   subscriptionId: string;
@@ -36,6 +38,7 @@ interface SubscriptionTrialWilEndEmailTemplateContext {
 
   viewSubscriptionLink: string;
   paymentMethod: PaymentMethod | null;
+  customActions: any[];
 }
 
 export class SubscriptionTrialWilEndEmailTemplate
@@ -104,6 +107,12 @@ export class SubscriptionTrialWilEndEmailTemplate
       userDid,
     });
 
+    const customActions = getSubscriptionNotificationCustomActions(
+      subscription,
+      'customer.subscription.trial_will_end',
+      locale
+    );
+
     return {
       locale,
       productName,
@@ -119,6 +128,7 @@ export class SubscriptionTrialWilEndEmailTemplate
 
       viewSubscriptionLink,
       paymentMethod,
+      customActions,
     };
   }
 
@@ -162,8 +172,14 @@ export class SubscriptionTrialWilEndEmailTemplate
       duration,
       paymentMethod,
       viewSubscriptionLink,
+      customActions,
     } = await this.getContext();
 
+    // 如果当前时间大于试用结束时间，那么不发送通知
+    if (dayjs().utc().isAfter(dayjs.utc(at))) {
+      return null;
+    }
+
     const canPay: boolean = paymentDetail.balance >= paymentDetail.price;
     if (canPay && !this.options.required) {
       // 当余额足够支付并且本封邮件不是必须发送时,可以不发送邮件
@@ -289,6 +305,7 @@ export class SubscriptionTrialWilEndEmailTemplate
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
+        ...customActions,
       ].filter(Boolean),
     };
 

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

@@ -19,7 +19,7 @@ import { getCustomerInvoicePageUrl } from '../../invoice';
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import { getExplorerLink } from '../../util';
+import { getExplorerLink, getSubscriptionNotificationCustomActions } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionUpgradedEmailTemplateOptions {
@@ -40,6 +40,8 @@ interface SubscriptionUpgradedEmailTemplateContext {
   viewSubscriptionLink: string;
   viewInvoiceLink: string;
   viewTxHashLink: string | undefined;
+  skipInvoice: boolean;
+  customActions: any[];
 }
 
 export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<SubscriptionUpgradedEmailTemplateContext> {
@@ -54,7 +56,7 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
     if (!subscription) {
       throw new Error(`Subscription not found: ${this.options.subscriptionId}`);
     }
-    if (subscription.status !== 'active') {
+    if (!subscription.isActive()) {
       throw new Error(`Subscription not active: ${this.options.subscriptionId}`);
     }
 
@@ -63,7 +65,10 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
       throw new Error(`Customer not found: ${subscription.customer_id}`);
     }
 
-    const invoice = (await Invoice.findByPk(subscription.latest_invoice_id)) as Invoice;
+    // invoice应该是最新的subscription_update invoice
+    const invoiceId = subscription.pending_update?.updates?.latest_invoice_id || subscription.latest_invoice_id;
+    const invoice = (await Invoice.findByPk(invoiceId)) as Invoice;
+    const skipInvoice = subscription.status === 'trialing' || invoice.billing_reason !== 'subscription_update';
     const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
     const paymentCurrency = (await PaymentCurrency.findOne({
       where: {
@@ -90,8 +95,12 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
     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 currentPeriodStart: string = formatTime(
+      skipInvoice ? subscription.current_period_start * 1000 : invoice.period_start * 1000
+    );
+    const currentPeriodEnd: string = formatTime(
+      skipInvoice ? subscription.current_period_end * 1000 : invoice.period_end * 1000
+    );
     const duration: string = prettyMsI18n(
       new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
       {
@@ -123,6 +132,12 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
         chainHost,
       });
 
+    const customActions = getSubscriptionNotificationCustomActions(
+      subscription,
+      'customer.subscription.upgraded',
+      locale
+    );
+
     return {
       locale,
       productName,
@@ -139,6 +154,8 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
       viewSubscriptionLink,
       viewInvoiceLink,
       viewTxHashLink,
+      skipInvoice,
+      customActions,
     };
   }
 
@@ -157,6 +174,8 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
       viewSubscriptionLink,
       viewInvoiceLink,
       viewTxHashLink,
+      skipInvoice,
+      customActions,
     } = await this.getContext();
 
     const template: BaseEmailTemplateType = {
@@ -210,21 +229,25 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
                 text: productName,
               },
             },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                color: '#9397A1',
-                text: translate('notification.common.paymentAmount', locale),
-              },
-            },
-            {
-              type: 'text',
-              data: {
-                type: 'plain',
-                text: paymentInfo,
-              },
-            },
+            ...(skipInvoice
+              ? []
+              : [
+                  {
+                    type: 'text',
+                    data: {
+                      type: 'plain',
+                      color: '#9397A1',
+                      text: translate('notification.common.paymentAmount', locale),
+                    },
+                  },
+                  {
+                    type: 'text',
+                    data: {
+                      type: 'plain',
+                      text: paymentInfo,
+                    },
+                  },
+                ]),
             {
               type: 'text',
               data: {
@@ -250,16 +273,18 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
-        {
+        !skipInvoice && {
           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,
-        },
+        !skipInvoice &&
+          viewTxHashLink && {
+            name: translate('notification.common.viewTxHash', locale),
+            title: translate('notification.common.viewTxHash', locale),
+            link: viewTxHashLink,
+          },
+        ...customActions,
       ].filter(Boolean),
     };
 

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

@@ -3,6 +3,7 @@
 import { fromUnitToToken } from '@ocap/util';
 import type { ManipulateType } from 'dayjs';
 
+import dayjs from '../../dayjs';
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
 import { Customer, Invoice, Subscription } from '../../../store/models';
@@ -13,6 +14,7 @@ import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime } from '../../time';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { getSubscriptionNotificationCustomActions } from '../../util';
 
 export interface SubscriptionWillCanceledEmailTemplateOptions {
   subscriptionId: string;
@@ -32,6 +34,7 @@ interface SubscriptionWillCanceledEmailTemplateContext {
 
   viewSubscriptionLink: string;
   viewInvoiceLink: string;
+  customActions: any[];
 }
 
 export class SubscriptionWillCanceledEmailTemplate
@@ -90,6 +93,11 @@ export class SubscriptionWillCanceledEmailTemplate
       action: 'pay',
     });
 
+    const customActions = getSubscriptionNotificationCustomActions(
+      subscription,
+      'customer.subscription.will_canceled',
+      locale
+    );
     return {
       locale,
       productName,
@@ -101,6 +109,7 @@ export class SubscriptionWillCanceledEmailTemplate
 
       viewSubscriptionLink,
       viewInvoiceLink,
+      customActions,
     };
   }
 
@@ -141,8 +150,14 @@ export class SubscriptionWillCanceledEmailTemplate
 
       viewSubscriptionLink,
       viewInvoiceLink,
+      customActions,
     } = await this.getContext();
 
+    // 如果当前时间大于订阅终止时间，那么不发送通知
+    if (dayjs().utc().isAfter(dayjs.utc(at))) {
+      return null;
+    }
+
     const template: BaseEmailTemplateType = {
       title: `${translate('notification.subscriptWillCanceled.title', locale, {
         productName,
@@ -217,6 +232,7 @@ export class SubscriptionWillCanceledEmailTemplate
           title: translate('notification.common.renewNow', locale),
           link: viewInvoiceLink,
         },
+        ...customActions,
       ].filter(Boolean),
     };
 

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

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/brace-style */
 /* eslint-disable @typescript-eslint/indent */
 import type { ManipulateType } from 'dayjs';
-import dayjs from 'dayjs';
 import prettyMsI18n from 'pretty-ms-i18n';
 import type { LiteralUnion } from 'type-fest';
 
 import { fromUnitToToken } from '@ocap/util';
+import dayjs from '../../dayjs';
 import { getTokenSummaryByDid } from '../../../integrations/arcblock/stake';
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
@@ -22,7 +22,7 @@ import { getPaymentAmountForCycleSubscription, type PaymentDetail } from '../../
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import { getExplorerLink } from '../../util';
+import { getExplorerLink, getSubscriptionNotificationCustomActions } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionWillRenewEmailTemplateOptions {
@@ -49,6 +49,7 @@ interface SubscriptionWillRenewEmailTemplateContext {
   viewSubscriptionLink: string;
   addFundsLink: string;
   paymentMethod: PaymentMethod | null;
+  customActions: any[];
 }
 
 export class SubscriptionWillRenewEmailTemplate
@@ -145,6 +146,11 @@ export class SubscriptionWillRenewEmailTemplate
       },
     })!;
 
+    const customActions = getSubscriptionNotificationCustomActions(
+      subscription,
+      'customer.subscription.will_renew',
+      locale
+    );
     return {
       locale,
       productName,
@@ -162,6 +168,7 @@ export class SubscriptionWillRenewEmailTemplate
       viewSubscriptionLink,
       addFundsLink,
       paymentMethod,
+      customActions,
     };
   }
   async getPaymentCategory({ subscriptionId }: { subscriptionId: string }): Promise<{
@@ -249,8 +256,13 @@ export class SubscriptionWillRenewEmailTemplate
       viewSubscriptionLink,
       addFundsLink,
       paymentMethod,
+      customActions,
     } = await this.getContext();
 
+    // 如果当前时间大于预计扣费时间，那么不发送通知
+    if (dayjs().utc().isAfter(dayjs.utc(at))) {
+      return null;
+    }
     const canPay: boolean = paymentDetail.balance >= paymentDetail.price;
     if (canPay) {
       // 当余额足够支付并且本封邮件不是必须发送时,可以不发送邮件
@@ -260,7 +272,6 @@ export class SubscriptionWillRenewEmailTemplate
       // 如果预估的价格是 0 并且货币不是 USD，那么直接不发送
       return null;
     }
-
     const isStripe = paymentMethod?.type === 'stripe';
     const template: BaseEmailTemplateType = {
       title: `${translate('notification.subscriptionWillRenew.title', locale, {
@@ -420,6 +431,7 @@ export class SubscriptionWillRenewEmailTemplate
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
+        ...customActions,
       ].filter(Boolean),
     };
 

package/api/src/libs/notification/template/usage-report-empty.ts

@@ -0,0 +1,158 @@
+import { getOwnerDid } from '@api/libs/util';
+import prettyMsI18n from 'pretty-ms-i18n';
+import { translate } from '../../../locales';
+import { Subscription } from '../../../store/models';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { formatTime, getPrettyMsI18nLocale } from '../../time';
+import { getMainProductName } from '../../product';
+import { checkUsageReportEmpty, getAdminSubscriptionPageUrl } from '../../subscription';
+
+export interface UsageReportEmptyEmailTemplateOptions {
+  subscriptionId: string;
+  usageReportStart: number;
+  usageReportEnd: number;
+}
+
+interface UsageReportEmptyEmailTemplateContext {
+  locale: string;
+  userDid: string;
+  productName: string;
+  subscriptionId: string;
+  currentPeriodStart: string;
+  currentPeriodEnd: string;
+  viewSubscriptionLink: string;
+  duration: string;
+}
+
+export class UsageReportEmptyEmailTemplate implements BaseEmailTemplate<UsageReportEmptyEmailTemplateContext> {
+  options: UsageReportEmptyEmailTemplateOptions;
+
+  constructor(options: UsageReportEmptyEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<UsageReportEmptyEmailTemplateContext> {
+    const { usageReportStart, usageReportEnd, subscriptionId } = this.options;
+    const subscription: Subscription | null = await Subscription.findByPk(subscriptionId);
+    if (!subscription) {
+      throw new Error(`Subscription not found: ${subscriptionId}`);
+    }
+    const userDid = await getOwnerDid();
+    if (!userDid) {
+      throw new Error('get owner did failed');
+    }
+    const usageReportEmpty = await checkUsageReportEmpty(subscription, usageReportStart, usageReportEnd);
+    if (!usageReportEmpty) {
+      throw new Error('Usage report is not empty, no need to send email');
+    }
+    const locale = await getUserLocale(userDid);
+    const productName = await getMainProductName(subscription.id);
+    const currentPeriodStart = formatTime(subscription.current_period_start * 1000);
+    const currentPeriodEnd = formatTime(subscription.current_period_end * 1000);
+    const duration: string = prettyMsI18n(
+      new Date(currentPeriodEnd).getTime() - new Date(currentPeriodStart).getTime(),
+      {
+        locale: getPrettyMsI18nLocale(locale),
+      }
+    );
+    const viewSubscriptionLink = getAdminSubscriptionPageUrl({
+      subscriptionId: subscription.id,
+      locale,
+      userDid,
+    });
+    return {
+      userDid,
+      locale,
+      productName,
+      subscriptionId: subscription.id,
+      currentPeriodStart,
+      currentPeriodEnd,
+      viewSubscriptionLink,
+      duration,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const {
+      locale,
+      productName,
+      subscriptionId,
+      currentPeriodStart,
+      currentPeriodEnd,
+      viewSubscriptionLink,
+      duration,
+    } = await this.getContext();
+
+    const template: BaseEmailTemplateType = {
+      title: translate('notification.usageReportEmpty.title', locale, {
+        productName,
+      }),
+      body: translate('notification.usageReportEmpty.body', locale, {
+        productName,
+      }),
+      attachments: [
+        {
+          type: 'section',
+          fields: [
+            {
+              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.subscriptionId', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: subscriptionId,
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                color: '#9397A1',
+                text: translate('notification.common.validityPeriod', locale),
+              },
+            },
+            {
+              type: 'text',
+              data: {
+                type: 'plain',
+                text: `${currentPeriodStart} ~ ${currentPeriodEnd}(${duration})`,
+              },
+            },
+          ].filter(Boolean),
+        },
+      ],
+      // @ts-ignore
+      actions: [
+        {
+          name: translate('notification.common.viewSubscription', locale),
+          title: translate('notification.common.viewSubscription', locale),
+          link: viewSubscriptionLink,
+        },
+      ].filter(Boolean),
+    };
+
+    return template;
+  }
+}