payment-kit 1.19.0 → 1.19.1

package/api/src/libs/notification/template/customer-credit-grant-granted.ts

@@ -0,0 +1,149 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { fromUnitToToken } from '@ocap/util';
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { CreditGrant, Customer, PaymentCurrency } from '../../../store/models';
+import { formatTime } from '../../time';
+import { getCustomerIndexUrl } from '../../util';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface CustomerCreditGrantGrantedEmailTemplateOptions {
+  creditGrantId: string;
+}
+
+interface CustomerCreditGrantGrantedEmailTemplateContext {
+  locale: string;
+  userDid: string;
+  currencySymbol: string;
+  grantedAmount: string;
+  expiresAt?: string;
+  neverExpires: boolean;
+  at: string;
+}
+
+export class CustomerCreditGrantGrantedEmailTemplate
+  implements BaseEmailTemplate<CustomerCreditGrantGrantedEmailTemplateContext>
+{
+  options: CustomerCreditGrantGrantedEmailTemplateOptions;
+
+  constructor(options: CustomerCreditGrantGrantedEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<CustomerCreditGrantGrantedEmailTemplateContext> {
+    const creditGrant = await CreditGrant.findByPk(this.options.creditGrantId);
+    if (!creditGrant) {
+      throw new Error(`CreditGrant not found: ${this.options.creditGrantId}`);
+    }
+
+    const customer = await Customer.findByPk(creditGrant.customer_id);
+    if (!customer) {
+      throw new Error(`Customer not found: ${creditGrant.customer_id}`);
+    }
+
+    const paymentCurrency = await PaymentCurrency.findByPk(creditGrant.currency_id);
+    if (!paymentCurrency) {
+      throw new Error(`PaymentCurrency not found: ${creditGrant.currency_id}`);
+    }
+
+    const userDid = customer.did;
+    const locale = await getUserLocale(userDid);
+    const currencySymbol = paymentCurrency.symbol;
+    const at = formatTime(Date.now());
+
+    const neverExpires = !creditGrant.expires_at;
+    const expiresAt = creditGrant.expires_at ? formatTime(creditGrant.expires_at * 1000) : undefined;
+
+    return {
+      locale,
+      userDid,
+      currencySymbol,
+      grantedAmount: `${fromUnitToToken(creditGrant.amount.toString(), paymentCurrency.decimal)} ${currencySymbol}`,
+      expiresAt,
+      neverExpires,
+      at,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
+    const { locale, userDid, grantedAmount, expiresAt, neverExpires, at } = context;
+
+    // 构建字段
+    const 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.creditGrantGranted.grantedCredit', locale),
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: `${grantedAmount}`,
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: '#9397A1',
+          text: translate('notification.creditGrantGranted.validUntil', locale),
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: neverExpires
+            ? translate('notification.creditGrantGranted.neverExpires', locale)
+            : (expiresAt as string),
+        },
+      },
+    ];
+
+    const template: BaseEmailTemplateType = {
+      title: translate('notification.creditGrantGranted.title', locale),
+      body: neverExpires
+        ? translate('notification.creditGrantGranted.bodyNoExpire', locale, { grantedAmount, at })
+        : translate('notification.creditGrantGranted.body', locale, { grantedAmount, at, expiresAt }),
+      attachments: [
+        {
+          type: 'section',
+          fields,
+        },
+      ],
+      actions: [
+        {
+          name: translate('notification.common.viewCreditGrant', locale),
+          title: translate('notification.common.viewCreditGrant', locale),
+          link: getCustomerIndexUrl({
+            locale,
+            userDid,
+          }),
+        },
+      ], // 可以根据需要添加操作按钮
+    };
+
+    return template;
+  }
+}

package/api/src/libs/notification/template/customer-credit-grant-low-balance.ts

@@ -0,0 +1,151 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { BN, fromUnitToToken } from '@ocap/util';
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { CreditGrant, Customer, PaymentCurrency } from '../../../store/models';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { getCustomerIndexUrl } from '../../util';
+
+export interface CustomerCreditGrantLowBalanceEmailTemplateOptions {
+  creditGrantId: string;
+}
+
+interface CustomerCreditGrantLowBalanceEmailTemplateContext {
+  locale: string;
+  userDid: string;
+  currencySymbol: string;
+  availableAmount: string;
+  totalGrantedAmount: string;
+  lowBalancePercentage: string;
+}
+
+export class CustomerCreditGrantLowBalanceEmailTemplate
+  implements BaseEmailTemplate<CustomerCreditGrantLowBalanceEmailTemplateContext>
+{
+  options: CustomerCreditGrantLowBalanceEmailTemplateOptions;
+
+  constructor(options: CustomerCreditGrantLowBalanceEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<CustomerCreditGrantLowBalanceEmailTemplateContext> {
+    const creditGrant = await CreditGrant.findByPk(this.options.creditGrantId);
+    if (!creditGrant) {
+      throw new Error(`CreditGrant not found: ${this.options.creditGrantId}`);
+    }
+
+    const customer = await Customer.findByPk(creditGrant.customer_id);
+    if (!customer) {
+      throw new Error(`Customer not found: ${creditGrant.customer_id}`);
+    }
+
+    const paymentCurrency = await PaymentCurrency.findByPk(creditGrant.currency_id);
+    if (!paymentCurrency) {
+      throw new Error(`PaymentCurrency not found: ${creditGrant.currency_id}`);
+    }
+
+    const userDid = customer.did;
+    const locale = await getUserLocale(userDid);
+    const currencySymbol = paymentCurrency.symbol;
+
+    // 计算百分比
+    const available = new BN(creditGrant.remaining_amount);
+    const total = new BN(creditGrant.amount);
+    const percentage = total.gt(0) ? available.mul(new BN(100)).div(total).toString() : '0';
+
+    return {
+      locale,
+      userDid,
+      currencySymbol,
+      availableAmount: `${fromUnitToToken(available.toString(), paymentCurrency.decimal)} ${currencySymbol}`,
+      totalGrantedAmount: `${fromUnitToToken(total.toString(), paymentCurrency.decimal)} ${currencySymbol}`,
+      lowBalancePercentage: `${percentage}%`,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
+    const { locale, userDid, availableAmount, totalGrantedAmount, lowBalancePercentage } = context;
+
+    // 构建字段
+    const 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.creditInsufficient.availableCredit', locale),
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: '#FF6600', // 橙色警告
+          text: `${availableAmount} (${lowBalancePercentage})`,
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: '#9397A1',
+          text: translate('notification.creditGrantLowBalance.totalGrantedCredit', locale),
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: `${totalGrantedAmount}`,
+        },
+      },
+    ];
+
+    // 构建操作按钮
+    const actions = [
+      {
+        name: translate('notification.common.viewCreditGrant', locale),
+        title: translate('notification.common.viewCreditGrant', locale),
+        link: getCustomerIndexUrl({
+          locale,
+          userDid,
+        }),
+      },
+    ];
+
+    const template: BaseEmailTemplateType = {
+      title: translate('notification.creditGrantLowBalance.title', locale),
+      body: translate('notification.creditGrantLowBalance.body', locale, {
+        availableAmount,
+        totalGrantedAmount,
+      }),
+      attachments: [
+        {
+          type: 'section',
+          fields,
+        },
+      ],
+      // @ts-ignore
+      actions,
+    };
+
+    return template;
+  }
+}

package/api/src/libs/notification/template/customer-credit-insufficient.ts

@@ -0,0 +1,254 @@
+/* eslint-disable @typescript-eslint/brace-style */
+/* eslint-disable @typescript-eslint/indent */
+import { BN, fromUnitToToken } from '@ocap/util';
+import { getUserLocale } from '../../../integrations/blocklet/notification';
+import { translate } from '../../../locales';
+import { Customer, PaymentCurrency, Subscription } from '../../../store/models';
+import { getMainProductName } from '../../product';
+import { getCustomerSubscriptionPageUrl } from '../../subscription';
+import { formatTime } from '../../time';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+
+export interface CustomerCreditInsufficientEmailTemplateOptions {
+  customerId: string;
+  currencyId: string;
+  meterEventName: string;
+  requiredAmount: string;
+  availableAmount: string;
+  pendingAmount: string;
+  subscriptionId?: string;
+}
+
+interface CustomerCreditInsufficientEmailTemplateContext {
+  locale: string;
+  userDid: string;
+  currencySymbol: string;
+  meterEventName: string;
+  requiredAmount: string;
+  availableAmount: string;
+  isExhausted: boolean;
+  productName?: string;
+  viewSubscriptionLink?: string;
+  at: string;
+}
+
+export class CustomerCreditInsufficientEmailTemplate
+  implements BaseEmailTemplate<CustomerCreditInsufficientEmailTemplateContext>
+{
+  options: CustomerCreditInsufficientEmailTemplateOptions;
+
+  constructor(options: CustomerCreditInsufficientEmailTemplateOptions) {
+    this.options = options;
+  }
+
+  async getContext(): Promise<CustomerCreditInsufficientEmailTemplateContext> {
+    const customer = await Customer.findByPk(this.options.customerId);
+    if (!customer) {
+      throw new Error(`Customer not found: ${this.options.customerId}`);
+    }
+
+    const paymentCurrency = await PaymentCurrency.findByPk(this.options.currencyId);
+    if (!paymentCurrency) {
+      throw new Error(`PaymentCurrency not found: ${this.options.currencyId}`);
+    }
+
+    const userDid = customer.did;
+    const locale = await getUserLocale(userDid);
+    const currencySymbol = paymentCurrency.symbol;
+    const at = formatTime(Date.now());
+
+    // 检查是否完全耗尽（可用额度为0或负数）
+    const isExhausted = new BN(this.options.availableAmount).lte(0);
+
+    // 如果有订阅ID，获取订阅信息
+    let productName: string | undefined;
+    let viewSubscriptionLink: string | undefined;
+
+    if (this.options.subscriptionId) {
+      const subscription = await Subscription.findByPk(this.options.subscriptionId);
+      if (subscription) {
+        productName = await getMainProductName(subscription.id);
+        viewSubscriptionLink = getCustomerSubscriptionPageUrl({
+          subscriptionId: subscription.id,
+          locale,
+          userDid,
+        });
+      }
+    }
+
+    return {
+      locale,
+      userDid,
+      currencySymbol,
+      meterEventName: this.options.meterEventName,
+      requiredAmount: `${fromUnitToToken(this.options.requiredAmount, paymentCurrency.decimal)} ${currencySymbol}`,
+      availableAmount: `${fromUnitToToken(this.options.availableAmount, paymentCurrency.decimal)} ${currencySymbol}`,
+      isExhausted,
+      productName,
+      viewSubscriptionLink,
+      at,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
+    const {
+      locale,
+      userDid,
+      meterEventName,
+      requiredAmount,
+      availableAmount,
+      isExhausted,
+      productName,
+      viewSubscriptionLink,
+    } = context;
+
+    // 构建基础字段
+    const baseFields = [
+      {
+        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: locale === 'zh' ? '服务项目' : 'Service',
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          text: meterEventName,
+        },
+      },
+    ];
+
+    // 产品信息字段（如果有订阅）
+    const productFields = productName
+      ? [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.common.product', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: productName,
+            },
+          },
+        ]
+      : [];
+
+    // 额度信息字段
+    const creditFields = [
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: '#9397A1',
+          text: translate('notification.creditInsufficient.availableCredit', locale),
+        },
+      },
+      {
+        type: 'text',
+        data: {
+          type: 'plain',
+          color: isExhausted ? '#FF0000' : '#333333',
+          text: `${availableAmount}`,
+        },
+      },
+    ];
+
+    // 所需额度字段（仅在未完全耗尽时显示）
+    const requiredCreditFields = !isExhausted
+      ? [
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              color: '#9397A1',
+              text: translate('notification.creditInsufficient.requiredCredit', locale),
+            },
+          },
+          {
+            type: 'text',
+            data: {
+              type: 'plain',
+              text: `${requiredAmount}`,
+            },
+          },
+        ]
+      : [];
+
+    // 构建操作按钮
+    const actions = [
+      viewSubscriptionLink && {
+        name: translate('notification.common.viewSubscription', locale),
+        title: translate('notification.common.viewSubscription', locale),
+        link: viewSubscriptionLink,
+      },
+    ].filter(Boolean);
+
+    // 构建标题和正文
+    let title: string;
+    let body: string;
+
+    if (isExhausted) {
+      title = translate('notification.creditInsufficient.exhaustedTitle', locale);
+      if (productName) {
+        body = translate('notification.creditInsufficient.exhaustedBodyWithSubscription', locale, {
+          subscriptionName: productName,
+        });
+      } else {
+        body = translate('notification.creditInsufficient.exhaustedBodyWithoutSubscription', locale);
+      }
+    } else {
+      title = translate('notification.creditInsufficient.title', locale);
+      if (productName) {
+        body = translate('notification.creditInsufficient.bodyWithSubscription', locale, {
+          availableAmount,
+
+          subscriptionName: productName,
+        });
+      } else {
+        body = translate('notification.creditInsufficient.bodyWithoutSubscription', locale, {
+          availableAmount,
+        });
+      }
+    }
+
+    const template: BaseEmailTemplateType = {
+      title,
+      body,
+      attachments: [
+        {
+          type: 'section',
+          fields: [...baseFields, ...productFields, ...creditFields, ...requiredCreditFields].filter(Boolean),
+        },
+      ],
+      // @ts-ignore
+      actions,
+    };
+
+    return template;
+  }
+}