payment-kit 1.13.39 → 1.13.40

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

@@ -1,7 +1,7 @@
 /* eslint-disable consistent-return */
 import { getUrl } from '@blocklet/sdk/lib/component';
 import userMiddleware from '@blocklet/sdk/lib/middlewares/user';
-import { Request, Response, Router } from 'express';
+import { NextFunction, Request, Response, Router } from 'express';
 import cloneDeep from 'lodash/cloneDeep';
 import merge from 'lodash/merge';
 import omit from 'lodash/omit';
@@ -32,14 +32,15 @@ import {
   isLineItemAligned,
 } from '../libs/session';
 import { createCodeGenerator, formatMetadata } from '../libs/util';
-import type { TPaymentCurrency } from '../store/models';
+import type { TPriceExpanded, TProductExpanded } from '../store/models';
 import { CheckoutSession } from '../store/models/checkout-session';
 import { Customer } from '../store/models/customer';
-import { PaymentCurrency } from '../store/models/payment-currency';
+import { PaymentCurrency, TPaymentCurrency } from '../store/models/payment-currency';
 import { PaymentIntent } from '../store/models/payment-intent';
 import { PaymentLink } from '../store/models/payment-link';
 import { PaymentMethod } from '../store/models/payment-method';
 import { Price } from '../store/models/price';
+import { Product } from '../store/models/product';
 import { SetupIntent } from '../store/models/setup-intent';
 import { Subscription } from '../store/models/subscription';
 import { SubscriptionItem } from '../store/models/subscription-item';
@@ -91,6 +92,7 @@ export const formatCheckoutSession = async (payload: any, throwOnEmptyItems = tr
       },
       payment_intent_data: {},
       submit_type: 'pay',
+      cross_sell_behavior: 'auto',
     },
     pick(payload, [
       'currency_id',
@@ -98,6 +100,7 @@ export const formatCheckoutSession = async (payload: any, throwOnEmptyItems = tr
       'line_items',
       'allow_promotion_codes',
       'consent_collection',
+      'cross_sell_behavior',
       'custom_fields',
       'customer_creation',
       'invoice_creation',
@@ -193,6 +196,81 @@ export async function getCheckoutSessionAmounts(checkoutSession: CheckoutSession
   };
 }
 
+export async function ensureCheckoutSessionOpen(req: Request, res: Response, next: NextFunction) {
+  const doc = await CheckoutSession.findByPk(req.params.id);
+
+  if (!doc) {
+    return res.status(404).json({ error: 'Checkout session not found' });
+  }
+  if (doc.status === 'complete') {
+    return res.status(403).json({ error: 'Checkout session completed' });
+  }
+  if (doc.status === 'expired') {
+    return res.status(403).json({ error: 'Checkout session already expired' });
+  }
+
+  req.doc = doc;
+
+  next();
+}
+
+export async function getCrossSellItem(checkoutSession: CheckoutSession) {
+  // FIXME: perhaps we can support cross sell even if the current session have multiple items
+  if (checkoutSession.line_items.length > 1) {
+    return { error: 'Cross sell not supported for checkoutSession with multiple line items' };
+  }
+
+  const items = await Price.expand(checkoutSession.line_items, { upsell: false });
+  const item = items.find(
+    (x) => x.upsell_price?.product?.cross_sell?.cross_sells_to_id || x.price.product.cross_sell?.cross_sells_to_id
+  );
+  if (!item) {
+    return { error: 'Cross sell not configured for all line item products' };
+  }
+
+  const to = (await Product.expand(
+    item.upsell_price?.product?.cross_sell.cross_sells_to_id || item.price.product.cross_sell.cross_sells_to_id
+  )) as TProductExpanded;
+  if (!to) {
+    return { error: 'Cross sell configure not valid anymore' };
+  }
+
+  const from = item.upsell_price || item.price;
+
+  const toCrossSellProduct = (price: TPriceExpanded) => ({
+    ...price,
+    product: omit(to, ['prices', 'default_price', 'cross_sell']),
+  });
+
+  // one_time can only cross sell to one_time
+  if (from.type === 'one_time') {
+    const oneTime = to.prices.find((x) => x.type === 'one_time');
+    if (oneTime) {
+      return toCrossSellProduct(oneTime);
+    }
+  }
+
+  // recurring can cross sell to matching recurring or one_time
+  if (from.type === 'recurring') {
+    const recurring = to.prices.find(
+      (x) =>
+        x.type === 'recurring' &&
+        x.recurring?.interval === from.recurring?.interval &&
+        x.recurring?.interval_count === from.recurring?.interval_count
+    );
+    if (recurring) {
+      return toCrossSellProduct(recurring);
+    }
+
+    const oneTime = to.prices.find((x) => x.type === 'one_time');
+    if (oneTime) {
+      return toCrossSellProduct(oneTime);
+    }
+  }
+
+  return { error: 'Cross sell not suitable' };
+}
+
 // create checkout session
 router.post('/', auth, async (req, res) => {
   const raw: Partial<CheckoutSession> = await formatCheckoutSession(req.body);
@@ -324,22 +402,23 @@ router.get('/retrieve/:id', user, async (req, res) => {
 });
 
 // submit order
-router.put('/:id/submit', user, async (req, res) => {
+router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
   try {
     if (!req.user) {
       return res.status(403).json({ error: 'Please login to continue' });
     }
 
-    // validate session
-    const checkoutSession = await CheckoutSession.findByPk(req.params.id);
-    if (!checkoutSession) {
-      return res.status(404).json({ error: 'Checkout session not found' });
-    }
-    if (checkoutSession.status === 'complete') {
-      return res.status(403).json({ error: 'Checkout session completed' });
-    }
-    if (checkoutSession.status === 'expired') {
-      return res.status(403).json({ error: 'Checkout session expired' });
+    const checkoutSession = req.doc as CheckoutSession;
+
+    // validate cross sell
+    if (checkoutSession.cross_sell_behavior === 'required') {
+      if (checkoutSession.line_items.some((x) => x.cross_sell) === false) {
+        const result = await getCrossSellItem(checkoutSession);
+        // @ts-ignore
+        if (result.id) {
+          return res.status(400).json({ error: 'Please select cross sell product to continue' });
+        }
+      }
     }
 
     // validate payment settings
@@ -694,19 +773,10 @@ router.put('/:id/submit', user, async (req, res) => {
 });
 
 // upsell
-router.put('/:id/upsell', user, async (req, res) => {
+router.put('/:id/upsell', user, ensureCheckoutSessionOpen, async (req, res) => {
   try {
     // validate session
-    const checkoutSession = await CheckoutSession.findByPk(req.params.id);
-    if (!checkoutSession) {
-      return res.status(404).json({ error: 'Checkout session not found' });
-    }
-    if (checkoutSession.status === 'complete') {
-      return res.status(403).json({ error: 'Checkout session completed' });
-    }
-    if (checkoutSession.status === 'expired') {
-      return res.status(403).json({ error: 'Checkout session expired' });
-    }
+    const checkoutSession = req.doc as CheckoutSession;
 
     if (checkoutSession.line_items) {
       // validate line items
@@ -749,19 +819,10 @@ router.put('/:id/upsell', user, async (req, res) => {
   }
 });
 
-router.put('/:id/downsell', user, async (req, res) => {
+router.put('/:id/downsell', user, ensureCheckoutSessionOpen, async (req, res) => {
   try {
     // validate session
-    const checkoutSession = await CheckoutSession.findByPk(req.params.id);
-    if (!checkoutSession) {
-      return res.status(404).json({ error: 'Checkout session not found' });
-    }
-    if (checkoutSession.status === 'complete') {
-      return res.status(403).json({ error: 'Checkout session completed' });
-    }
-    if (checkoutSession.status === 'expired') {
-      return res.status(403).json({ error: 'Checkout session expired' });
-    }
+    const checkoutSession = req.doc as CheckoutSession;
 
     // validate from
     const from = await Price.findByPk(req.body.from);
@@ -793,22 +854,97 @@ router.put('/:id/downsell', user, async (req, res) => {
 });
 
 // eslint-disable-next-line consistent-return
-router.put('/:id/expire', auth, async (req, res) => {
-  const doc = await CheckoutSession.findByPk(req.params.id);
+router.put('/:id/expire', auth, ensureCheckoutSessionOpen, async (req, res) => {
+  const doc = req.doc as CheckoutSession;
 
-  if (!doc) {
-    return res.status(404).json({ error: 'Checkout session not found' });
-  }
-  if (doc.status === 'complete') {
-    return res.status(403).json({ error: 'Checkout session completed' });
+  await doc.update({ status: 'expired', expires_at: dayjs().unix() });
+
+  res.json(doc);
+});
+
+// Return the expanded price to cross-sell-to for the checkout session
+router.get('/:id/cross-sell', user, ensureCheckoutSessionOpen, async (req, res) => {
+  try {
+    const checkoutSession = req.doc as CheckoutSession;
+    const result = await getCrossSellItem(checkoutSession);
+    // @ts-ignore
+    return res.status(result.error ? 400 : 200).json(result);
+  } catch (err) {
+    console.error(err);
+    res.status(500).json({ error: err.message });
   }
-  if (doc.status === 'expired') {
-    return res.status(403).json({ error: 'Checkout session already expired' });
+});
+
+router.put('/:id/cross-sell', user, ensureCheckoutSessionOpen, async (req, res) => {
+  try {
+    const checkoutSession = req.doc as CheckoutSession;
+    if (!req.body.to) {
+      return res.status(400).json({ error: 'Cross sell item is required' });
+    }
+
+    const result = await getCrossSellItem(checkoutSession);
+    // @ts-ignore
+    if (result.error) {
+      return res.status(400).json(result);
+    }
+
+    // @ts-ignore
+    const to = result as TPriceExpanded;
+    if (to.id !== req.body.to) {
+      return res.status(400).json({ error: 'Cross sell item does not match' });
+    }
+
+    if (checkoutSession.line_items) {
+      const index = checkoutSession.line_items.findIndex((x) => x.upsell_price_id === to.id);
+      if (index > -1) {
+        return res.status(400).json({ error: 'Cross sell item already exist' });
+      }
+
+      const items = cloneDeep(checkoutSession.line_items);
+      items.push({
+        price_id: to.id,
+        quantity: 1,
+        cross_sell: true,
+      });
+      await checkoutSession.update({ line_items: items });
+      logger.info('CheckoutSession updated on add cross-sell', { id: req.params.id, crossSell: to.id });
+
+      // recalculate amount
+      await checkoutSession.update(await getCheckoutSessionAmounts(checkoutSession));
+    }
+
+    const items = await Price.expand(checkoutSession.line_items, { upsell: true });
+    res.json({ ...checkoutSession.toJSON(), line_items: items });
+  } catch (err) {
+    console.error(err);
+    res.status(500).json({ error: err.message });
   }
+});
 
-  await doc.update({ status: 'expired', expires_at: dayjs().unix() });
+router.delete('/:id/cross-sell', user, ensureCheckoutSessionOpen, async (req, res) => {
+  try {
+    const checkoutSession = req.doc as CheckoutSession;
+    if (checkoutSession.line_items) {
+      const index = checkoutSession.line_items.findIndex((x) => x.cross_sell);
+      if (index === -1) {
+        return res.status(400).json({ error: 'Cross sell item not exist' });
+      }
 
-  res.json(doc);
+      const items = cloneDeep(checkoutSession.line_items);
+      items.splice(index, 1);
+      await checkoutSession.update({ line_items: items });
+      logger.info('CheckoutSession updated on remove cross-sell', { id: req.params.id });
+
+      // recalculate amount
+      await checkoutSession.update(await getCheckoutSessionAmounts(checkoutSession));
+    }
+
+    const items = await Price.expand(checkoutSession.line_items, { upsell: true });
+    res.json({ ...checkoutSession.toJSON(), line_items: items });
+  } catch (err) {
+    console.error(err);
+    res.status(500).json({ error: err.message });
+  }
 });
 
 export default router;

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

@@ -44,6 +44,7 @@ const formatBeforeSave = (payload: any) => {
         factory: '',
       },
       submit_type: 'pay',
+      cross_sell_behavior: 'auto',
     },
     pick(payload, [
       'name',
@@ -60,6 +61,7 @@ const formatBeforeSave = (payload: any) => {
       'submit_type',
       'subscription_data',
       'nft_mint_settings',
+      'cross_sell_behavior',
       'metadata',
     ])
   );

package/api/src/routes/pricing-table.ts

@@ -6,6 +6,7 @@ import uniq from 'lodash/uniq';
 import { Op, WhereOptions } from 'sequelize';
 
 import { checkPassportForPricingTable } from '../integrations/blocklet/passport';
+import logger from '../libs/logger';
 import { authenticate } from '../libs/security';
 import { isLineItemCurrencyAligned } from '../libs/session';
 import { formatMetadata } from '../libs/util';
@@ -68,21 +69,23 @@ const formatPricingTable = (payload: any) => {
           factory: '',
         },
         submit_type: 'auto',
+        cross_sell_behavior: 'auto',
       },
       pick(x, [
-        'product_id',
-        'price_id',
-        'is_highlight',
-        'highlight_text',
         'adjustable_quantity',
         'after_completion',
         'allow_promotion_codes',
+        'billing_address_collection',
         'consent_collection',
+        'cross_sell_behavior',
         'custom_fields',
+        'highlight_text',
+        'is_highlight',
+        'nft_mint_settings',
         'phone_number_collection',
-        'billing_address_collection',
+        'price_id',
+        'product_id',
         'submit_type',
-        'nft_mint_settings',
         'subscription_data',
       ])
     );
@@ -330,6 +333,7 @@ router.post('/:id/checkout/:priceId', async (req, res) => {
       'phone_number_collection',
       'billing_address_collection',
       'submit_type',
+      'cross_sell_behavior',
       'nft_mint_settings',
       'subscription_data',
     ]),
@@ -347,6 +351,19 @@ router.post('/:id/checkout/:priceId', async (req, res) => {
   if (req.query.redirect) {
     raw.success_url = req.query.redirect as string;
     raw.cancel_url = req.query.redirect as string;
+    logger.info('use redirect from query when checkout from pricing table', { v: raw.success_url });
+  }
+  if (req.query.cross_sell_behavior) {
+    raw.cross_sell_behavior = req.query.cross_sell_behavior as string;
+    logger.info('use cross_sell_behavior from query when checkout from pricing table', { v: raw.cross_sell_behavior });
+  }
+  if (req.query.nft_mint_factory) {
+    raw.nft_mint_settings = {
+      enabled: true,
+      behavior: 'per_checkout_session',
+      factory: req.query.nft_mint_factory as string,
+    };
+    logger.info('use nft_mint_settings from query when checkout from pricing table', { v: raw.nft_mint_settings });
   }
 
   const session = await CheckoutSession.create(raw as any);

package/api/src/routes/products.ts

@@ -140,46 +140,9 @@ router.get('/', auth, async (req, res) => {
   res.json({ count, list });
 });
 
-export async function getExpandedProduct(id: string) {
-  const product = await Product.findOne({
-    where: { id },
-    include: [
-      { model: Price, as: 'prices', include: [{ model: PaymentCurrency, as: 'currency' }] },
-      { model: Price, as: 'default_price' },
-    ],
-  });
-
-  if (product) {
-    const doc = product.toJSON();
-    const currencies = await PaymentCurrency.findAll();
-    // @ts-ignore
-    for (const price of doc.prices) {
-      if (Array.isArray(price.currency_options)) {
-        price.currency_options.forEach((x: any) => {
-          x.currency = currencies.find((c) => c.id === x.currency_id);
-        });
-        const base = price.currency_options.find((x: any) => x.currency_id === price.currency_id);
-        if (!base) {
-          price.currency_options.unshift(
-            pick(price, ['currency_id', 'unit_amount', 'tiers', 'custom_unit_amount', 'currency'])
-          );
-        }
-      } else {
-        price.currency_options = [
-          pick(price, ['currency_id', 'unit_amount', 'tiers', 'custom_unit_amount', 'currency']),
-        ];
-      }
-    }
-
-    return doc;
-  }
-
-  return null;
-}
-
 // get product detail
 router.get('/:id', auth, async (req, res) => {
-  res.json(await getExpandedProduct(req.params.id as string));
+  res.json(await Product.expand(req.params.id as string));
 });
 
 // update product
@@ -205,13 +168,14 @@ router.put('/:id', auth, async (req, res) => {
     'features',
     'nft_factory',
     'metadata',
+    'cross_sell',
   ]);
   if (updates.metadata) {
     updates.metadata = formatMetadata(updates.metadata);
   }
   await product.update(updates);
 
-  return res.json(await getExpandedProduct(req.params.id as string));
+  return res.json(await Product.expand(req.params.id as string));
 });
 
 // archive
@@ -228,7 +192,7 @@ router.put('/:id/archive', auth, async (req, res) => {
   await product.update({ active: !product.active });
 
   // FIXME: deactivate payment-links, pricing-tables
-  return res.json(await getExpandedProduct(req.params.id as string));
+  return res.json(await Product.expand(req.params.id as string));
 });
 
 // delete product

package/api/src/routes/redirect.ts

@@ -1,3 +1,5 @@
+import qs from 'querystring';
+
 import { getUrl } from '@blocklet/sdk/lib/component';
 import { Router } from 'express';
 
@@ -6,10 +8,10 @@ const router = Router();
 router.get('/checkout/:entryId', (req, res) => {
   const { entryId } = req.params;
   if (entryId.startsWith('plink_')) {
-    return res.redirect(getUrl(`/checkout/pay/${entryId}?redirect=${req.query.redirect || ''}`));
+    return res.redirect(getUrl(`/checkout/pay/${entryId}?${qs.stringify(req.query as any)}`));
   }
   if (entryId.startsWith('prctbl_')) {
-    return res.redirect(getUrl(`/checkout/pricing-table/${entryId}?redirect=${req.query.redirect || ''}`));
+    return res.redirect(getUrl(`/checkout/pricing-table/${entryId}?${qs.stringify(req.query as any)}`));
   }
 
   return res.redirect(getUrl('/'));

package/api/src/store/migrations/20231030-crosssell.ts

@@ -0,0 +1,23 @@
+import { DataTypes } from 'sequelize';
+
+import type { Migration } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await context.addColumn('products', 'cross_sell', { type: DataTypes.JSON, allowNull: true });
+  await context.addColumn('checkout_sessions', 'cross_sell_behavior', {
+    type: DataTypes.ENUM('auto', 'required'),
+    defaultValue: 'auto',
+  });
+  await context.addColumn('payment_links', 'cross_sell_behavior', {
+    type: DataTypes.ENUM('auto', 'required'),
+    defaultValue: 'auto',
+  });
+  await context.bulkUpdate('checkout_sessions', { cross_sell_behavior: 'auto' }, {});
+  await context.bulkUpdate('payment_links', { cross_sell_behavior: 'auto' }, {});
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('products', 'cross_sell');
+  await context.removeColumn('checkout_sessions', 'cross_sell_behavior');
+  await context.removeColumn('payment_links', 'cross_sell_behavior');
+};

package/api/src/store/models/checkout-session.ts

@@ -184,6 +184,8 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
   declare nft_mint_settings?: NftMintSettings;
   declare nft_mint_details?: NftMintDetails;
 
+  declare cross_sell_behavior?: LiteralUnion<'auto' | 'required', string>;
+
   // FIXME: Only exist on creation
   // declare discounts?: {
   //   coupon?: string;
@@ -266,11 +268,6 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
       type: DataTypes.ENUM('paid', 'unpaid', 'no_payment_required'),
       allowNull: false,
     },
-    nft_mint_status: {
-      type: DataTypes.ENUM('disabled', 'pending', 'minted', 'sent', 'error'),
-      defaultValue: 'disabled',
-      allowNull: false,
-    },
     line_items: {
       type: DataTypes.JSON,
       allowNull: false,
@@ -399,6 +396,11 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
           type: DataTypes.JSON,
           allowNull: true,
         },
+        nft_mint_status: {
+          type: DataTypes.ENUM('disabled', 'pending', 'minted', 'sent', 'error'),
+          defaultValue: 'disabled',
+          allowNull: false,
+        },
         nft_mint_settings: {
           type: DataTypes.JSON,
           allowNull: true,
@@ -407,6 +409,10 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
           type: DataTypes.JSON,
           allowNull: true,
         },
+        cross_sell_behavior: {
+          type: DataTypes.ENUM('auto', 'required'),
+          defaultValue: 'auto',
+        },
       },
       {
         sequelize,

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

@@ -97,7 +97,15 @@ export type TPriceExpanded = TPrice & {
 
 export type TLineItemExpanded = LineItem & { price: TPriceExpanded; upsell_price: TPriceExpanded };
 
-export type TProductExpanded = TProduct & { object: 'price'; prices: TPrice[]; default_price: TPrice };
+export type TProductExpanded = TProduct & {
+  object: 'price';
+  prices: TPriceExpanded[];
+  default_price: TPriceExpanded;
+  cross_sell?: {
+    cross_sells_to: TProductExpanded;
+    cross_sells_to_id: string;
+  };
+};
 
 export type TPaymentLinkExpanded = TPaymentLink & { object: 'payment_link'; line_items: TLineItemExpanded[] };
 

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

@@ -73,6 +73,8 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
 
   declare nft_mint_settings?: NftMintSettings;
 
+  declare cross_sell_behavior?: LiteralUnion<'auto' | 'required', string>;
+
   declare metadata?: Record<string, any>;
 
   // TODO: following fields not supported
@@ -199,6 +201,10 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
           type: DataTypes.JSON,
           allowNull: true,
         },
+        cross_sell_behavior: {
+          type: DataTypes.ENUM('auto', 'required'),
+          defaultValue: 'auto',
+        },
       },
       {
         sequelize,

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

@@ -160,10 +160,6 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
       type: DataTypes.JSON,
       defaultValue: [],
     },
-    upsell: {
-      type: DataTypes.JSON,
-      allowNull: true,
-    },
     created_at: {
       type: DataTypes.DATE,
       defaultValue: DataTypes.NOW,
@@ -181,21 +177,30 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
 
   // eslint-disable-next-line @typescript-eslint/no-shadow
   public static initialize(sequelize: any) {
-    this.init(Price.GENESIS_ATTRIBUTES, {
-      sequelize,
-      modelName: 'Price',
-      tableName: 'prices',
-      createdAt: 'created_at',
-      updatedAt: 'updated_at',
-      hooks: {
-        afterCreate: (model: Price, options) =>
-          createEvent('Price', 'price.created', model, options).catch(console.error),
-        afterUpdate: (model: Price, options) =>
-          createEvent('Price', 'price.updated', model, options).catch(console.error),
-        afterDestroy: (model: Price, options) =>
-          createEvent('Price', 'price.deleted', model, options).catch(console.error),
+    this.init(
+      {
+        ...Price.GENESIS_ATTRIBUTES,
+        upsell: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
       },
-    });
+      {
+        sequelize,
+        modelName: 'Price',
+        tableName: 'prices',
+        createdAt: 'created_at',
+        updatedAt: 'updated_at',
+        hooks: {
+          afterCreate: (model: Price, options) =>
+            createEvent('Price', 'price.created', model, options).catch(console.error),
+          afterUpdate: (model: Price, options) =>
+            createEvent('Price', 'price.updated', model, options).catch(console.error),
+          afterDestroy: (model: Price, options) =>
+            createEvent('Price', 'price.deleted', model, options).catch(console.error),
+        },
+      }
+    );
   }
 
   public static associate(models: any) {