payment-kit 1.19.5 → 1.19.6

package/api/src/hooks/pre-start.ts

@@ -6,8 +6,6 @@ import { ensurePaymentStats } from '../crons/payment-stat';
 import { initPaywallResources } from '../libs/resource';
 import { initialize } from '../store/models';
 import { sequelize } from '../store/sequelize';
-import { syncCurrencyLogo } from '../crons/currency';
-import { ensureCreateOverdraftProtectionPrices } from '../libs/overdraft-protection';
 
 dotenv.config({ silent: true });
 
@@ -16,8 +14,6 @@ dotenv.config({ silent: true });
     initialize(sequelize);
     await initPaywallResources();
     await ensurePaymentStats();
-    await syncCurrencyLogo();
-    await ensureCreateOverdraftProtectionPrices();
     process.exit(0);
   } catch (err) {
     console.error('pre-start error', err);

package/api/src/index.ts

@@ -7,7 +7,6 @@ import cookieParser from 'cookie-parser';
 import cors from 'cors';
 import dotenv from 'dotenv-flow';
 import express, { ErrorRequestHandler } from 'express';
-
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { xss } from '@blocklet/xss';
 import { csrf } from '@blocklet/sdk/lib/middlewares';
@@ -47,13 +46,14 @@ import { initialize } from './store/models';
 import { sequelize } from './store/sequelize';
 import { initUserHandler } from './integrations/blocklet/user';
 import { startUploadBillingInfoListener } from './queues/space';
+import { syncCurrencyLogo } from './crons/currency';
+import { ensureCreateOverdraftProtectionPrices } from './libs/overdraft-protection';
 
 dotenv.config();
 
 initialize(sequelize);
 
 export const app = express();
-
 setupAccessLogger(app);
 app.set('trust proxy', true);
 app.use(cookieParser());
@@ -112,6 +112,8 @@ export const server = app.listen(port, (err?: any) => {
   if (err) throw err;
   logger.info(`> payment-kit ready on ${port}`);
 
+  syncCurrencyLogo();
+  ensureCreateOverdraftProtectionPrices();
   startPaymentQueue().then(() => logger.info('payment queue started'));
   startInvoiceQueue().then(() => logger.info('invoice queue started'));
   startSubscriptionQueue().then(() => logger.info('subscription queue started'));

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

@@ -5,7 +5,7 @@ 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 { formatNumber, getCustomerIndexUrl } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface CustomerCreditGrantGrantedEmailTemplateOptions {
@@ -59,7 +59,7 @@ export class CustomerCreditGrantGrantedEmailTemplate
       locale,
       userDid,
       currencySymbol,
-      grantedAmount: `${fromUnitToToken(creditGrant.amount.toString(), paymentCurrency.decimal)} ${currencySymbol}`,
+      grantedAmount: `${formatNumber(fromUnitToToken(creditGrant.amount.toString(), paymentCurrency.decimal))} ${currencySymbol}`,
       expiresAt,
       neverExpires,
       at,

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

@@ -5,7 +5,7 @@ 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';
+import { formatNumber, getCustomerIndexUrl } from '../../util';
 
 export interface CustomerCreditGrantLowBalanceEmailTemplateOptions {
   creditGrantId: string;
@@ -58,8 +58,8 @@ export class CustomerCreditGrantLowBalanceEmailTemplate
       locale,
       userDid,
       currencySymbol,
-      availableAmount: `${fromUnitToToken(available.toString(), paymentCurrency.decimal)} ${currencySymbol}`,
-      totalGrantedAmount: `${fromUnitToToken(total.toString(), paymentCurrency.decimal)} ${currencySymbol}`,
+      availableAmount: `${formatNumber(fromUnitToToken(available.toString(), paymentCurrency.decimal))} ${currencySymbol}`,
+      totalGrantedAmount: `${formatNumber(fromUnitToToken(total.toString(), paymentCurrency.decimal))} ${currencySymbol}`,
       lowBalancePercentage: `${percentage}%`,
     };
   }

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

@@ -8,10 +8,12 @@ import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime } from '../../time';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
+import { formatNumber, getCustomerIndexUrl } from '../../util';
 
 export interface CustomerCreditInsufficientEmailTemplateOptions {
   customerId: string;
   currencyId: string;
+  meterName: string;
   meterEventName: string;
   requiredAmount: string;
   availableAmount: string;
@@ -24,6 +26,7 @@ interface CustomerCreditInsufficientEmailTemplateContext {
   userDid: string;
   currencySymbol: string;
   meterEventName: string;
+  meterName: string;
   requiredAmount: string;
   availableAmount: string;
   isExhausted: boolean;
@@ -80,9 +83,10 @@ export class CustomerCreditInsufficientEmailTemplate
       locale,
       userDid,
       currencySymbol,
+      meterName: this.options.meterName,
       meterEventName: this.options.meterEventName,
-      requiredAmount: `${fromUnitToToken(this.options.requiredAmount, paymentCurrency.decimal)} ${currencySymbol}`,
-      availableAmount: `${fromUnitToToken(this.options.availableAmount, paymentCurrency.decimal)} ${currencySymbol}`,
+      requiredAmount: `${formatNumber(fromUnitToToken(this.options.requiredAmount, paymentCurrency.decimal))} ${currencySymbol}`,
+      availableAmount: `${formatNumber(fromUnitToToken(this.options.availableAmount, paymentCurrency.decimal))} ${currencySymbol}`,
       isExhausted,
       productName,
       viewSubscriptionLink,
@@ -95,7 +99,7 @@ export class CustomerCreditInsufficientEmailTemplate
     const {
       locale,
       userDid,
-      meterEventName,
+      meterName,
       requiredAmount,
       availableAmount,
       isExhausted,
@@ -132,7 +136,7 @@ export class CustomerCreditInsufficientEmailTemplate
         type: 'text',
         data: {
           type: 'plain',
-          text: meterEventName,
+          text: meterName,
         },
       },
     ];
@@ -206,6 +210,14 @@ export class CustomerCreditInsufficientEmailTemplate
         title: translate('notification.common.viewSubscription', locale),
         link: viewSubscriptionLink,
       },
+      {
+        name: translate('notification.common.viewCreditGrant', locale),
+        title: translate('notification.common.viewCreditGrant', locale),
+        link: getCustomerIndexUrl({
+          locale,
+          userDid,
+        }),
+      },
     ].filter(Boolean);
 
     // 构建标题和正文

package/api/src/libs/queue/index.ts

@@ -284,7 +284,6 @@ export default function createQueue<T = any>({ name, onJob, options = defaults }
         Job.initialize(sequelize);
       }
       const jobs = await store.getJobs();
-      logger.info(`${name} jobs to populate`, { count: jobs.length });
       jobs.forEach((x) => {
         if (x.job && x.id) {
           push({ job: x.job, id: x.id, persist: false });

package/api/src/libs/util.ts

@@ -13,6 +13,8 @@ import axios from 'axios';
 import { ethers } from 'ethers';
 import { fromUnitToToken } from '@ocap/util';
 import get from 'lodash/get';
+import numbro from 'numbro';
+import { trimEnd } from 'lodash';
 import dayjs from './dayjs';
 import { blocklet, wallet } from './auth';
 import type { PaymentCurrency, PaymentMethod, Subscription } from '../store/models';
@@ -579,3 +581,25 @@ export function getExplorerTxUrl({
   }
   return joinURL(explorerHost, '/tx', txHash);
 }
+
+export function formatNumber(
+  n: number | string,
+  precision: number = 6,
+  trim: boolean = true,
+  thousandSeparated: boolean = true
+) {
+  if (!n || n === '0') {
+    return '0';
+  }
+  const num = numbro(n);
+  const options = {
+    thousandSeparated,
+    ...((precision || precision === 0) && { mantissa: precision }),
+  };
+  const result = num.format(options);
+  if (!trim) {
+    return result;
+  }
+  const [left, right] = result.split('.');
+  return right ? [left, trimEnd(right, '0')].filter(Boolean).join('.') : left;
+}

package/api/src/queues/credit-consume.ts

@@ -226,6 +226,7 @@ async function consumeAvailableCredits(
       await createEvent('Customer', 'customer.credit.insufficient', context.customer, {
         metadata: {
           meter_event_id: context.meterEvent.id,
+          meter_name: context.meter.name,
           meter_event_name: context.meterEvent.event_name,
           required_amount: remainingToConsume.toString(),
           available_amount: totalAvailable.toString(),
@@ -262,6 +263,7 @@ async function consumeAvailableCredits(
     await createEvent('Customer', 'customer.credit.insufficient', context.customer, {
       metadata: {
         meter_event_id: context.meterEvent.id,
+        meter_name: context.meter.name,
         meter_event_name: context.meterEvent.event_name,
         required_amount: remainingToConsume.toString(),
         available_amount: '0',

package/api/src/queues/notification.ts

@@ -605,7 +605,8 @@ export async function startNotificationQueue() {
       {
         customerId: customer.id,
         currencyId: metadata.currency_id,
-        meterEventName: metadata.meter_event_name || 'Service',
+        meterName: metadata.meter_name || 'Service',
+        meterEventName: metadata.meter_event_name,
         requiredAmount: metadata.required_amount,
         availableAmount: metadata.available_amount,
         pendingAmount: metadata.pending_amount || '0',
@@ -613,7 +614,7 @@ export async function startNotificationQueue() {
       },
       [customer.id, metadata.currency_id, metadata.subscription_id],
       true,
-      600
+      24 * 3600 // 1天
     );
   });
 }

package/api/src/routes/credit-grants.ts

@@ -73,7 +73,11 @@ router.get('/', authMine, async (req, res) => {
     const { page, pageSize, ...query } = await listSchema.validateAsync(req.query, { stripUnknown: true });
     const where = getWhereFromKvQuery(query.q);
     if (query.customer_id) {
-      where.customer_id = query.customer_id;
+      const customer = await Customer.findByPkOrDid(query.customer_id);
+      if (!customer) {
+        throw new Error(`Customer ${query.customer_id} not found`);
+      }
+      where.customer_id = customer.id;
     }
     if (query.currency_id) {
       where.currency_id = query.currency_id;
@@ -182,16 +186,20 @@ router.post('/', auth, async (req, res) => {
 
     let customer = await Customer.findByPkOrDid(req.body.customer_id);
     if (!customer) {
-      const { user: userInfo } = await blocklet.getUser(req.body.customer_id);
+      if (req.body.customer_id.startsWith('cus_')) {
+        return res.status(404).json({ error: `Customer ${req.body.customer_id} not found` });
+      }
+      const did = req.body.customer_id;
+      const { user: userInfo } = await blocklet.getUser(did);
       if (!userInfo) {
-        return res.status(404).json({ error: `User ${req.body.customer_id} not found` });
+        return res.status(404).json({ error: `User ${did} not found` });
       }
       customer = await Customer.create({
         livemode: true,
-        did: userInfo.did,
-        name: userInfo.fullName,
-        email: userInfo.email || '',
-        phone: userInfo.phone || '',
+        did: userInfo?.did || did,
+        name: userInfo?.fullName || did,
+        email: userInfo?.email || '',
+        phone: userInfo?.phone || '',
         address: Customer.formatAddressFromUser(userInfo),
         description: userInfo.remark || '',
         metadata: {},

package/api/src/routes/customers.ts

@@ -384,37 +384,38 @@ router.get('/:id', auth, async (req, res) => {
   try {
     const doc = await Customer.findByPkOrDid(req.params.id as string);
     if (doc) {
-      res.json(doc);
-    } else {
-      if (req.body.create) {
-        if (!req.user) {
-          return res.status(403).json({ error: 'Unauthorized' });
-        }
-        const { user } = await blocklet.getUser(req.params.id);
-        if (!user) {
-          return res.status(404).json({ error: 'User not found' });
-        }
-        const customer = await Customer.create({
-          livemode: true,
-          did: user.did,
-          name: user.fullName,
-          email: user.email,
-          phone: user.phone,
-          address: Customer.formatAddressFromUser(user),
-          description: user.remark,
-          metadata: {},
-          balance: '0',
-          next_invoice_sequence: 1,
-          delinquent: false,
-          invoice_prefix: Customer.getInvoicePrefix(),
-        });
-        logger.info('customer created', {
-          customerId: customer.id,
-          did: customer.did,
-        });
-        return res.json(customer);
+      return res.json(doc);
+    }
+    if (req.body.create) {
+      if (!req.user) {
+        return res.status(403).json({ error: 'Unauthorized' });
+      }
+      if (req.params.id.startsWith('cus_')) {
+        return res.status(404).json({ error: 'Customer not found' });
+      }
+      const { user } = await blocklet.getUser(req.params.id);
+      if (!user) {
+        return res.status(404).json({ error: 'User not found' });
       }
-      return res.status(404).json(null);
+      const customer = await Customer.create({
+        livemode: true,
+        did: user?.did || req.params.id,
+        name: user?.fullName ?? req.params.id,
+        email: user?.email ?? '',
+        phone: user?.phone ?? '',
+        address: Customer.formatAddressFromUser(user),
+        description: user?.remark ?? '',
+        metadata: {},
+        balance: '0',
+        next_invoice_sequence: 1,
+        delinquent: false,
+        invoice_prefix: Customer.getInvoicePrefix(),
+      });
+      logger.info('customer created', {
+        customerId: customer.id,
+        did: customer.did,
+      });
+      return res.json(customer);
     }
     return res.status(404).json(null);
   } catch (err) {

package/api/src/routes/payment-links.ts

@@ -52,6 +52,7 @@ const formatBeforeSave = (payload: any) => {
       payment_intent_data: null,
       donation_settings: null,
       enable_subscription_grouping: false,
+      lookup_key: null,
     },
     pick(payload, [
       'name',
@@ -73,6 +74,7 @@ const formatBeforeSave = (payload: any) => {
       'donation_settings',
       'metadata',
       'enable_subscription_grouping',
+      'lookup_key',
     ])
   );
 
@@ -150,11 +152,12 @@ export async function createPaymentLink(payload: any) {
     raw.invoice_creation = { enabled: true };
   }
 
-  return PaymentLink.create(raw as PaymentLink);
+  return PaymentLink.insert(raw as PaymentLink);
 }
 
 const PaymentLinkCreateSchema = Joi.object({
-  name: Joi.string().optional(),
+  name: Joi.string().max(255).empty('').optional(),
+  lookup_key: Joi.string().max(128).empty('').optional(),
   line_items: Joi.array()
     .items(
       Joi.object({
@@ -272,7 +275,7 @@ router.get('/', auth, async (req, res) => {
 });
 
 router.get('/:id', auth, async (req, res) => {
-  const doc = await PaymentLink.findByPk(req.params.id);
+  const doc = await PaymentLink.findByPkOrLookupKey(req.params.id || '');
 
   if (doc) {
     // @ts-ignore

package/api/src/store/migrations/20250725-add-lookup-key-to-link.ts

@@ -0,0 +1,21 @@
+import { DataTypes } from 'sequelize';
+
+import { Migration, safeApplyColumnChanges } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await safeApplyColumnChanges(context, {
+    payment_links: [
+      {
+        name: 'lookup_key',
+        field: {
+          type: DataTypes.STRING(128),
+          allowNull: true,
+        },
+      },
+    ],
+  });
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('payment_links', 'lookup_key');
+};

package/api/src/store/models/customer.ts

@@ -308,12 +308,12 @@ export class Customer extends Model<InferAttributes<Customer>, InferCreationAttr
 
   public static formatAddressFromUser(user: any, customer?: Customer) {
     return {
-      country: user.address?.country || customer?.address?.country || '',
-      state: user.address?.province || customer?.address?.state || '',
-      city: user.address?.city || customer?.address?.city || '',
-      line1: user.address?.line1 || customer?.address?.line1 || '',
-      line2: user.address?.line2 || customer?.address?.line2 || '',
-      postal_code: user.address?.postalCode || customer?.address?.postal_code || '',
+      country: user?.address?.country || customer?.address?.country || '',
+      state: user?.address?.province || customer?.address?.state || '',
+      city: user?.address?.city || customer?.address?.city || '',
+      line1: user?.address?.line1 || customer?.address?.line1 || '',
+      line2: user?.address?.line2 || customer?.address?.line2 || '',
+      postal_code: user?.address?.postalCode || customer?.address?.postal_code || '',
     };
   }
 

package/api/src/store/models/payment-link.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/lines-between-class-members */
-import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model, Op } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 
 import { createEvent } from '../../libs/audit';
@@ -89,6 +89,9 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
 
   declare enable_subscription_grouping?: boolean;
 
+  // A lookup key used to retrieve payment links dynamically from a static string
+  declare lookup_key: string | null;
+
   // TODO: following fields not supported
   // application_fee_amount
   // application_fee_percent
@@ -224,6 +227,10 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
           type: DataTypes.BOOLEAN,
           defaultValue: false,
         },
+        lookup_key: {
+          type: DataTypes.STRING(128),
+          allowNull: true,
+        },
       },
       {
         sequelize,
@@ -250,6 +257,27 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
       as: 'currency',
     });
   }
+
+  public static async insert(paymentLink: InferCreationAttributes<PaymentLink>) {
+    if (paymentLink.lookup_key) {
+      const exist = await this.count({ where: { lookup_key: paymentLink.lookup_key } });
+      if (exist) {
+        throw new Error('lookup_key already exists');
+      }
+    }
+
+    return this.create(paymentLink);
+  }
+
+  public static findByPkOrLookupKey(id: string, options: any = {}) {
+    if (!id) {
+      throw new Error('id is required');
+    }
+    return this.findOne({
+      where: { [Op.or]: [{ id }, { lookup_key: id }] },
+      ...options,
+    });
+  }
 }
 
 export type TPaymentLink = InferAttributes<PaymentLink>;

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.19.5
+version: 1.19.6
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.19.5",
+  "version": "1.19.6",
   "scripts": {
     "dev": "blocklet dev --open",
     "lint": "tsc --noEmit && eslint src api/src --ext .mjs,.js,.jsx,.ts,.tsx",
@@ -44,30 +44,30 @@
   },
   "dependencies": {
     "@abtnode/cron": "^1.16.46",
-    "@arcblock/did": "^1.20.15",
+    "@arcblock/did": "^1.21.0",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@arcblock/did-connect": "^3.0.26",
-    "@arcblock/did-util": "^1.20.15",
-    "@arcblock/jwt": "^1.20.15",
-    "@arcblock/ux": "^3.0.26",
-    "@arcblock/validator": "^1.20.15",
-    "@blocklet/did-space-js": "^1.1.6",
+    "@arcblock/did-connect": "^3.0.32",
+    "@arcblock/did-util": "^1.21.0",
+    "@arcblock/jwt": "^1.21.0",
+    "@arcblock/ux": "^3.0.32",
+    "@arcblock/validator": "^1.21.0",
+    "@blocklet/did-space-js": "^1.1.8",
     "@blocklet/js-sdk": "^1.16.46",
     "@blocklet/logger": "^1.16.46",
-    "@blocklet/payment-react": "1.19.5",
+    "@blocklet/payment-react": "1.19.6",
     "@blocklet/sdk": "^1.16.46",
-    "@blocklet/ui-react": "^3.0.26",
+    "@blocklet/ui-react": "^3.0.32",
     "@blocklet/uploader": "^0.2.4",
     "@blocklet/xss": "^0.2.2",
     "@mui/icons-material": "^7.1.2",
     "@mui/lab": "7.0.0-beta.14",
     "@mui/material": "^7.1.2",
     "@mui/system": "^7.1.1",
-    "@ocap/asset": "^1.20.15",
-    "@ocap/client": "^1.20.15",
-    "@ocap/mcrypto": "^1.20.15",
-    "@ocap/util": "^1.20.15",
-    "@ocap/wallet": "^1.20.15",
+    "@ocap/asset": "^1.21.0",
+    "@ocap/client": "^1.21.0",
+    "@ocap/mcrypto": "^1.21.0",
+    "@ocap/util": "^1.21.0",
+    "@ocap/wallet": "^1.21.0",
     "@stripe/react-stripe-js": "^2.9.0",
     "@stripe/stripe-js": "^2.4.0",
     "ahooks": "^3.8.5",
@@ -97,6 +97,7 @@
     "morgan": "^1.10.0",
     "mui-daterange-picker": "^1.0.5",
     "nanoid": "^3.3.11",
+    "numbro": "^2.5.0",
     "p-all": "3.0.0",
     "p-wait-for": "^3.2.0",
     "pretty-ms-i18n": "^1.0.3",
@@ -122,7 +123,7 @@
   "devDependencies": {
     "@abtnode/types": "^1.16.46",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.19.5",
+    "@blocklet/payment-types": "1.19.6",
     "@types/cookie-parser": "^1.4.9",
     "@types/cors": "^2.8.19",
     "@types/debug": "^4.1.12",
@@ -168,5 +169,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "b2cb3888b7efa2cc71591f75240616c36e945b09"
+  "gitHead": "d062db562d215b8ef5485b3f291d7e4f994093be"
 }

package/src/pages/customer/index.tsx

@@ -488,7 +488,6 @@ export default function CustomerHome() {
         </Box>
         <CreditOverview customerId={data?.id || ''} settings={settings} />
       </Box>
-      <Divider />
     </ConditionalSection>
   );
 
@@ -586,6 +585,7 @@ export default function CustomerHome() {
         {SummaryCard}
         {SummaryCard && <Divider />}
         {CreditCard}
+        {CreditCard && <Divider />}
         {SubscriptionCard}
         {SubscriptionCard && <Divider />}
         {InvoiceCard}