payment-kit 1.13.301 → 1.13.302

package/api/src/queues/payment.ts

@@ -38,6 +38,21 @@ type PaymentJob = {
   retryOnError?: boolean;
 };
 
+async function updateQuantitySold(checkoutSession: CheckoutSession) {
+  const updatePromises = checkoutSession.line_items.map((item) => {
+    const priceId = item.upsell_price_id || item.price_id;
+    return Price.increment({ quantity_sold: Number(item.quantity) }, { where: { id: priceId } }).catch((err) => {
+      logger.error('Update quantity_sold failed', {
+        error: err,
+        priceId,
+        checkoutSessionId: checkoutSession.id,
+      });
+    });
+  });
+
+  await Promise.all(updatePromises);
+}
+
 export const handlePaymentSucceed = async (paymentIntent: PaymentIntent) => {
   // FIXME: @wangshijun we should check stripe payment here before
 
@@ -194,6 +209,12 @@ export const handlePaymentSucceed = async (paymentIntent: PaymentIntent) => {
   if (invoice.checkout_session_id) {
     const checkoutSession = await CheckoutSession.findByPk(invoice.checkout_session_id);
     if (checkoutSession && checkoutSession.status === 'open') {
+      updateQuantitySold(checkoutSession).catch((err) => {
+        logger.error('Updating quantity_sold for line items failed', {
+          error: err,
+          checkoutSessionId: checkoutSession.id,
+        });
+      });
       await checkoutSession.update({
         status: 'complete',
         payment_status: 'paid',

package/api/src/routes/checkout-sessions.ts

@@ -77,6 +77,52 @@ const getPaymentTypes = async (items: any[]) => {
   return methods.map((x) => x.type);
 };
 
+export async function validateInventory(line_items: LineItem[], includePendingQuantity = false) {
+  const checks = line_items.map(async (item) => {
+    const priceId = item.price_id;
+    const quantity = Number(item.quantity || 0);
+
+    const price = await Price.findOne({ where: { id: priceId } });
+
+    let delta = quantity;
+
+    if (!price) {
+      throw new Error(`Price not found for priceId: ${priceId}`);
+    }
+
+    if (!price.quantity_available) {
+      // if quantity_available equal to 0 , we assume it's unlimited
+      return true;
+    }
+
+    if (Number(price.quantity_limit_per_checkout) > 0 && quantity > Number(price.quantity_limit_per_checkout)) {
+      throw new Error(`Can not exceed per checkout quantity for price: ${priceId}`);
+    }
+
+    delta += price.quantity_sold;
+    if (includePendingQuantity) {
+      const checkoutSessions = await CheckoutSession.findAll({
+        where: {
+          status: 'open',
+        },
+        attributes: ['line_items'],
+      });
+      const pendingQuantity = checkoutSessions.reduce((acc, session: any) => {
+        const lineItems = session.line_items || [];
+        const sessionQuantity = lineItems
+          .filter((lineItem: any) => lineItem.priceId === priceId)
+          .reduce((total: number, lineItem: any) => total + Number(lineItem.quantity), 0);
+        return acc + sessionQuantity;
+      }, 0);
+      delta += pendingQuantity;
+    }
+    if (delta > Number(price.quantity_available)) {
+      throw new Error(`Can not exceed available quantity for price: ${priceId}`);
+    }
+  });
+  await Promise.all(checks);
+}
+
 export const formatCheckoutSession = async (payload: any, throwOnEmptyItems = true) => {
   const raw: Partial<CheckoutSession> = Object.assign(
     {
@@ -288,6 +334,14 @@ router.post('/', auth, async (req, res) => {
   const raw: Partial<CheckoutSession> = await formatCheckoutSession(req.body);
   raw.livemode = !!req.livemode;
   raw.created_via = req.user?.via as string;
+  if (raw.line_items) {
+    try {
+      await validateInventory(raw.line_items, true);
+    } catch (err) {
+      logger.error('validateInventory failed', { error: err, line_items: raw.line_items });
+      return res.status(400).json({ error: err.message });
+    }
+  }
 
   const doc = await CheckoutSession.create(raw as any);
 
@@ -460,7 +514,18 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
     }
 
     const checkoutSession = req.doc as CheckoutSession;
-
+    if (checkoutSession.line_items) {
+      try {
+        await validateInventory(checkoutSession.line_items);
+      } catch (err) {
+        logger.error('validateInventory failed', {
+          error: err,
+          line_items: checkoutSession.line_items,
+          checkoutSessionId: checkoutSession.id,
+        });
+        return res.status(400).json({ error: err.message });
+      }
+    }
     // validate cross sell
     if (checkoutSession.cross_sell_behavior === 'required') {
       if (checkoutSession.line_items.some((x) => x.cross_sell) === false) {

package/api/src/routes/prices.ts

@@ -167,16 +167,28 @@ export async function createPrice(payload: any) {
   return getExpandedPrice(price.id as string);
 }
 
+const priceQuantitySchema = Joi.object({
+  quantity_available: Joi.number().integer().min(0).optional().default(0),
+  quantity_limit_per_checkout: Joi.number().integer().min(0).optional().default(0),
+});
+
 // FIXME: @wangshijun use schema validation
 // create price
 // eslint-disable-next-line consistent-return
 router.post('/', auth, async (req, res) => {
   try {
+    const { error } = priceQuantitySchema.validate(
+      pick(req.body, ['quantity_available', 'quantity_limit_per_checkout'])
+    );
+    if (error) {
+      return res.status(400).json({ error: `Price create request invalid: ${error.message}` });
+    }
     const result = await createPrice({
       ...req.body,
       livemode: !!req.livemode,
       currency_id: req.body.currency_id || req.currency.id,
       created_via: req.user?.via as string,
+      quantity_sold: 0,
     });
 
     res.json(result);
@@ -231,6 +243,11 @@ router.get('/:id/upsell', auth, async (req, res) => {
 // update price
 // FIXME: upsell validate https://stripe.com/docs/payments/checkout/upsells
 router.put('/:id', auth, async (req, res) => {
+  const quantityKeys = ['quantity_available', 'quantity_limit_per_checkout'];
+  const { error } = priceQuantitySchema.validate(pick(req.body, quantityKeys));
+  if (error) {
+    return res.status(400).json({ error: `Price update request invalid: ${error.message}` });
+  }
   const doc = await Price.findByPkOrLookupKey(req.params.id as string);
 
   if (!doc) {
@@ -241,13 +258,18 @@ router.put('/:id', auth, async (req, res) => {
     return res.status(403).json({ error: 'price archived' });
   }
 
+  if (Number(req.body.quantity_available) > 0 && Number(req.body.quantity_available) < Number(doc.quantity_sold)) {
+    // 可售数量不得小于已售数量
+    return res.status(400).json({ error: 'the available quantity cannot be less than the quantity sold' });
+  }
+
   const locked = doc.locked && process.env.PAYMENT_CHANGE_LOCKED_PRICE !== '1';
   const updates: Partial<Price> = Price.formatBeforeSave(
     pick(
       req.body,
       locked
-        ? ['nickname', 'description', 'metadata', 'currency_options', 'upsell']
-        : ['type', 'model', 'active', 'livemode', 'nickname', 'recurring', 'description', 'tiers', 'unit_amount', 'transform_quantity', 'metadata', 'lookup_key', 'currency_options', 'upsell'] // prettier-ignore
+        ? ['nickname', 'description', 'metadata', 'currency_options', 'upsell', ...quantityKeys]
+        : ['type', 'model', 'active', 'livemode', 'nickname', 'recurring', 'description', 'tiers', 'unit_amount', 'transform_quantity', 'metadata', 'lookup_key', 'currency_options', 'upsell', ...quantityKeys] // prettier-ignore
     )
   );
 

package/api/src/store/migrations/20240715-price-quantity.ts

@@ -0,0 +1,41 @@
+/* eslint-disable no-await-in-loop */
+import { DataTypes } from 'sequelize';
+
+import { Migration, safeApplyColumnChanges } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await safeApplyColumnChanges(context, {
+    prices: [
+      {
+        name: 'quantity_available',
+        field: {
+          type: DataTypes.INTEGER,
+          defaultValue: 0,
+          allowNull: false,
+        },
+      },
+      {
+        name: 'quantity_sold',
+        field: {
+          type: DataTypes.INTEGER,
+          defaultValue: 0,
+          allowNull: false,
+        },
+      },
+      {
+        name: 'quantity_limit_per_checkout',
+        field: {
+          type: DataTypes.INTEGER,
+          defaultValue: 0,
+          allowNull: false,
+        },
+      },
+    ],
+  });
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('prices', 'quantity_available');
+  await context.removeColumn('prices', 'quantity_sold');
+  await context.removeColumn('prices', 'quantity_limit_per_checkout');
+};

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

@@ -90,6 +90,13 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
   declare created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
   declare updated_at: CreationOptional<Date>;
 
+  // Quantity available for purchase,  0 means no limit
+  declare quantity_available: number;
+  // Quantity has been sold
+  declare quantity_sold: number;
+  // Quantity limit per checkout, 0 means no limit
+  declare quantity_limit_per_checkout: number;
+
   public static readonly GENESIS_ATTRIBUTES = {
     id: {
       type: DataTypes.STRING(32),
@@ -187,6 +194,21 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
           type: DataTypes.JSON,
           allowNull: true,
         },
+        quantity_available: {
+          type: DataTypes.INTEGER,
+          defaultValue: 0,
+          allowNull: false,
+        },
+        quantity_sold: {
+          type: DataTypes.INTEGER,
+          defaultValue: 0,
+          allowNull: false,
+        },
+        quantity_limit_per_checkout: {
+          type: DataTypes.INTEGER,
+          defaultValue: 0,
+          allowNull: false,
+        },
       },
       {
         sequelize,
@@ -280,6 +302,18 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
       );
     }
 
+    if (price.quantity_available) {
+      price.quantity_available = Number(price.quantity_available);
+    }
+
+    if (price.quantity_limit_per_checkout) {
+      price.quantity_limit_per_checkout = Number(price.quantity_limit_per_checkout);
+    }
+
+    if (price.quantity_sold) {
+      price.quantity_sold = Number(price.quantity_sold);
+    }
+
     return price;
   }
 

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.301",
+  "version": "1.13.302",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -52,7 +52,7 @@
     "@arcblock/validator": "^1.18.124",
     "@blocklet/js-sdk": "1.16.28",
     "@blocklet/logger": "1.16.28",
-    "@blocklet/payment-react": "1.13.301",
+    "@blocklet/payment-react": "1.13.302",
     "@blocklet/sdk": "1.16.28",
     "@blocklet/ui-react": "^2.10.3",
     "@blocklet/uploader": "^0.1.18",
@@ -118,7 +118,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.28",
     "@arcblock/eslint-config-ts": "^0.3.2",
-    "@blocklet/payment-types": "1.13.301",
+    "@blocklet/payment-types": "1.13.302",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -160,5 +160,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "51232b3901a744f8340c345dc738552f9df899a2"
+  "gitHead": "366468bdbb1c5e8837a3baff852067fa041609a1"
 }

package/scripts/sdk.js

@@ -17,13 +17,13 @@ const payment = require('@blocklet/payment-js').default;
   // });
   // console.log('refundResult', refundResult);
 
-  const refund = await payment.refunds.retrieve('re_loHv143R78cSe38uGjxRBsfv');
-  console.log('🚀 ~ refund:', refund);
+  // const refund = await payment.refunds.retrieve('re_loHv143R78cSe38uGjxRBsfv');
+  // console.log('🚀 ~ refund:', refund);
 
-  const refunds = await payment.refunds.list({
-    invoice_id: 'in_EidRR3yL3PL5tnOgd17eyGJr',
-  });
-  console.log('🚀 ~ refunds:', refunds);
+  // const refunds = await payment.refunds.list({
+  //   invoice_id: paymentIntent.invoice_id,
+  // });
+  // console.log('🚀 ~ refunds:', refunds);
 
   // const customRefundResult = await payment.refunds.create({
   //   amount: '0.001',
@@ -37,5 +37,44 @@ const payment = require('@blocklet/payment-js').default;
   // });
   // console.log('🚀 ~ customRefundResult:', customRefundResult);
 
+  // const price = await payment.prices.create({
+  //   locked: false,
+  //   model: 'standard',
+  //   billing_scheme: '',
+  //   currency_id: 'pc_aW2zy2y8yoi7',
+  //   nickname: '',
+  //   type: 'recurring',
+  //   unit_amount: '0.001',
+  //   lookup_key: '',
+  //   recurring: {
+  //     interval_config: 'month_1',
+  //     interval: 'month',
+  //     interval_count: 1,
+  //     usage_type: 'licensed',
+  //     aggregate_usage: 'sum',
+  //   },
+  //   transform_quantity: { divide_by: 1, round: 'up' },
+  //   tiers: [],
+  //   metadata: [],
+  //   custom_unit_amount: null,
+  //   currency_options: [],
+  //   tiers_mode: null,
+  //   quantity_available: 10,
+  //   quantity_limit_per_checkout: '2',
+  //   product_id: 'prod_fSuzmRV137Qxmt',
+  // });
+  // console.log('🚀 ~ price:', price);
+
+  // const checkoutSession = await payment.checkout.sessions.create({
+  //   success_url:
+  //     'https://bbqa2t5pfyfroyobmzknmktshckzto4btkfagxyjqwy.did.abtnet.io/store/api/payment/success?redirect=https://bbqa2t5pfyfroyobmzknmktshckzto4btkfagxyjqwy.did.abtnet.io/maker/mint/z3CtLCSchoZj4H5gqwyATSAEdvfd1m88VnDUZ',
+  //   cancel_url:
+  //     'https://bbqa2t5pfyfroyobmzknmktshckzto4btkfagxyjqwy.did.abtnet.io/store/api/payment/cancel?redirect=https://bbqa2t5pfyfroyobmzknmktshckzto4btkfagxyjqwy.did.abtnet.io/maker/mint/z3CtLCSchoZj4H5gqwyATSAEdvfd1m88VnDUZ',
+  //   mode: 'payment',
+  //   line_items: [{ price_id: 'price_wc1WPJy7FrbX1CBPJj7zuIys', quantity: 2 }],
+  //   metadata: { factoryAddress: 'z3CtLCSchoZj4H5gqwyATSAEdvfd1m88VnDUZ', quantity: 2 },
+  //   expires_at: 1721121607,
+  // });
+  // console.log('checkoutSession', checkoutSession);
   process.exit(0);
 })();

package/src/components/price/form.tsx

@@ -34,7 +34,7 @@ export type Price = Omit<InferFormType<TPriceExpanded>, 'product_id' | 'object'>
   };
 };
 
-export const DEFAULT_PRICE: Omit<Price, 'product' | 'currency'> = {
+export const DEFAULT_PRICE: Omit<Price, 'product' | 'currency' | 'quantity_sold'> = {
   locked: false,
   model: 'standard',
   billing_scheme: '',
@@ -59,6 +59,8 @@ export const DEFAULT_PRICE: Omit<Price, 'product' | 'currency'> = {
   custom_unit_amount: null,
   currency_options: [],
   tiers_mode: null,
+  quantity_available: 0,
+  quantity_limit_per_checkout: 0,
 };
 
 type PriceFormProps = {
@@ -92,6 +94,7 @@ export default function PriceForm({ prefix, simple }: PriceFormProps) {
   const isCustomInterval = useWatch({ control, name: getFieldName('recurring.interval_config') }) === 'month_2';
   const model = useWatch({ control, name: getFieldName('model') });
   const positive = (v: number) => v >= 0;
+  const quantityPositive = (v: number | undefined) => !v || v.toString().match(/^(0|[1-9]\d*)$/);
 
   const basePaymentMethod = settings.paymentMethods.find((x) =>
     x.payment_currencies.some((c) => c.id === settings.baseCurrency.id)
@@ -365,6 +368,42 @@ export default function PriceForm({ prefix, simple }: PriceFormProps) {
       {!simple && (
         <Collapse trigger={t('admin.price.additional')} expanded={isLocked}>
           <Stack spacing={2} alignItems="flex-start">
+            <Controller
+              name={getFieldName('quantity_available')}
+              control={control}
+              render={({ field }) => (
+                <Box>
+                  <FormLabel>{t('admin.price.quantityAvailable.label')}</FormLabel>
+                  <TextField
+                    {...field}
+                    size="small"
+                    sx={{ width: INPUT_WIDTH }}
+                    type="number"
+                    placeholder={t('admin.price.quantityAvailable.placeholder')}
+                    error={!quantityPositive(field.value)}
+                    helperText={!quantityPositive(field.value) && t('admin.price.quantity.tip')}
+                  />
+                </Box>
+              )}
+            />
+            <Controller
+              name={getFieldName('quantity_limit_per_checkout')}
+              control={control}
+              render={({ field }) => (
+                <Box>
+                  <FormLabel>{t('admin.price.quantityLimitPerCheckout.label')}</FormLabel>
+                  <TextField
+                    {...field}
+                    size="small"
+                    sx={{ width: INPUT_WIDTH }}
+                    type="number"
+                    placeholder={t('admin.price.quantityLimitPerCheckout.placeholder')}
+                    error={!quantityPositive(field.value)}
+                    helperText={!quantityPositive(field.value) && t('admin.price.quantity.tip')}
+                  />
+                </Box>
+              )}
+            />
             <Controller
               name={getFieldName('nickname')}
               control={control}

package/src/components/product/edit-price.tsx

@@ -5,6 +5,7 @@ import { Button, CircularProgress, Stack } from '@mui/material';
 import { fromUnitToToken } from '@ocap/util';
 import { cloneDeep, isEmpty } from 'lodash';
 import type { EventHandler } from 'react';
+import Toast from '@arcblock/ux/lib/Toast';
 import { FormProvider, useForm } from 'react-hook-form';
 
 import { getPricingModel } from '../../libs/util';
@@ -48,6 +49,13 @@ export default function EditPrice({
   const { handleSubmit, reset } = methods;
   const onSubmit = () => {
     handleSubmit(async (formData: any) => {
+      if (
+        Number(formData.quantity_available) > 0 &&
+        Number(formData.quantity_available) < Number(formData.quantity_sold)
+      ) {
+        Toast.warning(t('admin.price.quantityAvailable.valid'));
+        return;
+      }
       await onSave(formData);
       reset();
       onCancel(null);

package/src/locales/en.tsx

@@ -165,6 +165,27 @@ export default flat({
         to: 'Upsells to',
         tip: '',
       },
+      quantity: {
+        tip: 'Quantity must be equal or greater than 0',
+      },
+      quantityAvailable: {
+        label: 'Available quantity',
+        placeholder: '0 means unlimited',
+        format: 'Available {num} pieces',
+        noLimit: 'No limit on available quantity',
+        valid: 'Available quantity must be greater than or equal to sold quantity',
+      },
+      quantitySold: {
+        label: 'Sold quantity',
+        format: 'Sold {num} pieces',
+      },
+      quantityLimitPerCheckout: {
+        label: 'Limit per checkout quantity',
+        placeholder: '0 means unlimited',
+        format: 'Limit {num} pieces per checkout',
+        noLimit: 'No limit on quantity per checkout',
+      },
+      inventory: 'Inventory Settings',
     },
     coupon: {
       create: 'Create Coupon',

package/src/locales/zh.tsx

@@ -161,6 +161,27 @@ export default flat({
         to: '可升级至',
         tip: '',
       },
+      quantity: {
+        tip: '数量必须是自然数',
+      },
+      quantityAvailable: {
+        label: '可售数量',
+        placeholder: '0表示无限制',
+        format: '可售{num}件',
+        noLimit: '不限制可售数量',
+        valid: '可售数量不得少于已售数量',
+      },
+      quantitySold: {
+        label: '已售数量',
+        format: '已售{num}件',
+      },
+      quantityLimitPerCheckout: {
+        label: '单次购买最大数量',
+        placeholder: '0表示无限制',
+        format: '单次最多购买{num}件',
+        noLimit: '不限制单次购买数量',
+      },
+      inventory: '库存设置',
     },
     coupon: {
       create: '创建优惠券',

package/src/pages/admin/products/prices/actions.tsx

@@ -35,6 +35,10 @@ export default function PriceActions({ data, onChange, variant, setAsDefault }:
   });
 
   const onEditPrice = async (updates: TPrice) => {
+    if (Number(updates.quantity_available) > 0 && Number(updates.quantity_available) < Number(updates.quantity_sold)) {
+      Toast.warning(t('admin.price.quantityAvailable.valid'));
+      return;
+    }
     try {
       setState({ loading: true });
       await api.put(`/api/prices/${data.id}`, updates).then((res) => res.data);

package/src/pages/admin/products/prices/list.tsx

@@ -71,6 +71,26 @@ export default function PricesList({ product, onChange }: { product: Product; on
         },
       },
     },
+    {
+      label: t('admin.price.inventory'),
+      name: 'id',
+      options: {
+        sort: false,
+        customBodyRenderLite: (_: any, index: number) => {
+          const price = product.prices[index] as any;
+          let additional = '';
+          if (price.nickname) {
+            additional = `${price.nickname}：`;
+          }
+          additional += `${price.quantity_available ? t('admin.price.quantityAvailable.format', { num: price.quantity_available }) : t('admin.price.quantityAvailable.noLimit')}`;
+          additional += ` / ${t('admin.price.quantitySold.format', {
+            num: price.quantity_sold,
+          })}`;
+          additional += ` / ${price.quantity_limit_per_checkout ? t('admin.price.quantityLimitPerCheckout.format', { num: price.quantity_limit_per_checkout }) : t('admin.price.quantityLimitPerCheckout.noLimit')}`;
+          return additional;
+        },
+      },
+    },
     {
       label: t('common.actions'),
       name: 'id',