payment-kit 1.14.36 → 1.14.37

package/api/src/integrations/stripe/resource.ts

@@ -204,7 +204,7 @@ export async function ensureStripeSubscription(
   currency: PaymentCurrency,
   items: TLineItemExpanded[],
   trialInDays: number = 0,
-  trialEnds: number = 0
+  trialEnd: number = 0
 ) {
   const client = method.getStripeClient();
 
@@ -255,8 +255,8 @@ export async function ensureStripeSubscription(
 
     if (trialInDays) {
       props.trial_period_days = trialInDays;
-    } else if (trialEnds) {
-      props.trial_end = trialEnds;
+    } else if (trialEnd) {
+      props.trial_end = trialEnd;
     }
 
     stripeSubscription = await client.subscriptions.create(props);

package/api/src/libs/subscription.ts

@@ -2,6 +2,7 @@
 import component from '@blocklet/sdk/lib/component';
 import { BN } from '@ocap/util';
 import isEmpty from 'lodash/isEmpty';
+import trim from 'lodash/trim';
 import pick from 'lodash/pick';
 import type { LiteralUnion } from 'type-fest';
 import { withQuery } from 'ufo';
@@ -18,6 +19,7 @@ import {
   PriceRecurring,
   Refund,
   Subscription,
+  SubscriptionData,
   SubscriptionItem,
   SubscriptionUpdateItem,
   TLineItemExpanded,
@@ -147,7 +149,7 @@ export function getSubscriptionCreateSetup(
   items: TLineItemExpanded[],
   currencyId: string,
   trialInDays = 0,
-  trialEnds = 0
+  trialEnd = 0
 ) {
   let setup = new BN(0);
 
@@ -170,18 +172,18 @@ export function getSubscriptionCreateSetup(
   const recurring = (item?.upsell_price || item?.price)?.recurring as PriceRecurring;
   const cycle = getRecurringPeriod(recurring);
 
-  let trialStart = 0;
-  let trialEnd = 0;
-  if (+trialEnds && trialEnds > now) {
-    trialStart = now;
-    trialEnd = trialEnds;
+  let trialStartAt = 0;
+  let trialEndAt = 0;
+  if (+trialEnd && trialEnd > now) {
+    trialStartAt = now;
+    trialEndAt = trialEnd;
   } else if (trialInDays) {
-    trialStart = now;
-    trialEnd = dayjs().add(trialInDays, 'day').unix();
+    trialStartAt = now;
+    trialEndAt = dayjs().add(trialInDays, 'day').unix();
   }
 
-  const periodStart = trialStart || now;
-  const periodEnd = trialEnd || dayjs().add(cycle, 'millisecond').unix();
+  const periodStart = trialStartAt || now;
+  const periodEnd = trialEndAt || dayjs().add(cycle, 'millisecond').unix();
 
   return {
     recurring,
@@ -190,8 +192,8 @@ export function getSubscriptionCreateSetup(
       anchor: periodEnd,
     },
     trial: {
-      start: trialStart,
-      end: trialEnd,
+      start: trialStartAt,
+      end: trialEndAt,
     },
     period: {
       start: periodStart,
@@ -787,3 +789,19 @@ export async function checkRemainingStake(
     revoked,
   };
 }
+
+// trialing can be customized with currency_id list
+export function getSubscriptionTrialSetup(data: Partial<SubscriptionData>, currencyId: string) {
+  let trialInDays = Number(data?.trial_period_days || 0);
+  let trialEnd = Number(data?.trial_end || 0);
+  const trialCurrencyIds = (data?.trial_currency || '').split(',').map(trim).filter(Boolean);
+  if (trialCurrencyIds.length > 0 && trialCurrencyIds.includes(currencyId) === false) {
+    trialEnd = 0;
+    trialInDays = 0;
+  }
+
+  return {
+    trialInDays,
+    trialEnd,
+  };
+}

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

@@ -42,6 +42,7 @@ import {
   getDaysUntilCancel,
   getDaysUntilDue,
   getSubscriptionCreateSetup,
+  getSubscriptionTrialSetup,
 } from '../libs/subscription';
 import { CHECKOUT_SESSION_TTL, formatAmountPrecisionLimit, formatMetadata, getDataObjectFromQuery } from '../libs/util';
 import { invoiceQueue } from '../queues/invoice';
@@ -249,8 +250,8 @@ export async function getCheckoutSessionAmounts(checkoutSession: CheckoutSession
   const now = dayjs().unix();
   const items = await Price.expand(checkoutSession.line_items);
   const trialInDays = Number(checkoutSession.subscription_data?.trial_period_days || 0);
-  const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
-  const amount = getCheckoutAmount(items, checkoutSession.currency_id, trialInDays > 0 || trialEnds > now);
+  const trialEnd = Number(checkoutSession.subscription_data?.trial_end || 0);
+  const amount = getCheckoutAmount(items, checkoutSession.currency_id, trialInDays > 0 || trialEnd > now);
   return {
     amount_subtotal: amount.subtotal,
     amount_total: amount.total,
@@ -574,11 +575,16 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
     // always update payment amount in case currency has changed
     const now = dayjs().unix();
     const lineItems = await Price.expand(checkoutSession.line_items, { product: true, upsell: true });
-    const trialInDays = Number(checkoutSession.subscription_data?.trial_period_days || 0);
-    const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
+
+    // trialing can be customized with currency_id list
+    const { trialEnd, trialInDays } = getSubscriptionTrialSetup(
+      checkoutSession.subscription_data as any,
+      paymentCurrency.id
+    );
+
     const billingThreshold = Number(checkoutSession.subscription_data?.billing_threshold_amount || 0);
     const minStakeAmount = Number(checkoutSession.subscription_data?.min_stake_amount || 0);
-    const amount = getCheckoutAmount(lineItems, paymentCurrency.id, trialInDays > 0 || trialEnds > now);
+    const amount = getCheckoutAmount(lineItems, paymentCurrency.id, trialInDays > 0 || trialEnd > now);
     await checkoutSession.update({
       amount_subtotal: amount.subtotal,
       amount_total: amount.total,
@@ -770,7 +776,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
             .status(403)
             .json({ code: 'SUBSCRIPTION_INVALID', error: 'Checkout session subscription status unexpected' });
         }
-        const setup = getSubscriptionCreateSetup(lineItems, paymentCurrency.id, trialInDays, trialEnds);
+        const setup = getSubscriptionCreateSetup(lineItems, paymentCurrency.id, trialInDays, trialEnd);
         subscription = await subscription.update({
           currency_id: paymentCurrency.id,
           customer_id: customer.id,
@@ -813,7 +819,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
         const recoveredFrom = recoveredFromId ? await Subscription.findByPk(recoveredFromId) : null;
 
         // FIXME: @wangshijun respect all checkoutSession.subscription_data fields
-        const setup = getSubscriptionCreateSetup(lineItems, paymentCurrency.id, trialInDays, trialEnds);
+        const setup = getSubscriptionCreateSetup(lineItems, paymentCurrency.id, trialInDays, trialEnd);
         subscription = await Subscription.create({
           livemode: !!checkoutSession.livemode,
           currency_id: paymentCurrency.id,
@@ -887,7 +893,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
       lineItems,
       checkoutSession.mode,
       paymentCurrency.id,
-      trialInDays > 0 || trialEnds > now
+      trialInDays > 0 || trialEnd > now
     );
     const paymentSettings = {
       payment_method_types: checkoutSession.payment_method_types,
@@ -964,7 +970,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           paymentCurrency,
           lineItems,
           trialInDays,
-          trialEnds
+          trialEnd
         );
         if (stripeSubscription && subscription?.payment_details?.stripe?.subscription_id === stripeSubscription.id) {
           if (['active', 'trialing'].includes(stripeSubscription.status) && subscription.status === 'incomplete') {

package/api/src/routes/connect/setup.ts

@@ -3,6 +3,7 @@ import type { CallbackArgs } from '../../libs/auth';
 import dayjs from '../../libs/dayjs';
 import logger from '../../libs/logger';
 import { isDelegationSufficientForPayment } from '../../libs/payment';
+import { getSubscriptionTrialSetup } from '../../libs/subscription';
 import { getFastCheckoutAmount } from '../../libs/session';
 import { getTxMetadata } from '../../libs/util';
 import { invoiceQueue } from '../../queues/invoice';
@@ -39,9 +40,13 @@ export default {
     const claims: { [type: string]: [string, object] } = {};
     const now = dayjs().unix();
     const items = checkoutSession.line_items as TLineItemExpanded[];
-    const trialInDays = Number(checkoutSession.subscription_data?.trial_period_days || 0);
-    const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
-    const trialing = trialInDays > 0 || trialEnds > now;
+
+    const { trialEnd, trialInDays } = getSubscriptionTrialSetup(
+      checkoutSession.subscription_data as any,
+      paymentCurrency.id
+    );
+
+    const trialing = trialInDays > 0 || trialEnd > now;
     const billingThreshold = Number(checkoutSession.subscription_data?.billing_threshold_amount || 0);
     const minStakeAmount = Number(checkoutSession.subscription_data?.min_stake_amount || 0);
     const fastCheckoutAmount = getFastCheckoutAmount(items, checkoutSession.mode, paymentCurrency.id, trialing);

package/api/src/routes/connect/subscribe.ts

@@ -3,6 +3,7 @@ import type { CallbackArgs } from '../../libs/auth';
 import dayjs from '../../libs/dayjs';
 import logger from '../../libs/logger';
 import { isDelegationSufficientForPayment } from '../../libs/payment';
+import { getSubscriptionTrialSetup } from '../../libs/subscription';
 import { getFastCheckoutAmount } from '../../libs/session';
 import { getTxMetadata } from '../../libs/util';
 import { invoiceQueue } from '../../queues/invoice';
@@ -40,9 +41,11 @@ export default {
     const claims: { [type: string]: [string, object] } = {};
     const now = dayjs().unix();
     const items = checkoutSession.line_items as TLineItemExpanded[];
-    const trialInDays = Number(checkoutSession.subscription_data?.trial_period_days || 0);
-    const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
-    const trialing = trialInDays > 0 || trialEnds > now;
+    const { trialEnd, trialInDays } = getSubscriptionTrialSetup(
+      checkoutSession.subscription_data as any,
+      paymentCurrency.id
+    );
+    const trialing = trialInDays > 0 || trialEnd > now;
     const billingThreshold = Number(checkoutSession.subscription_data?.billing_threshold_amount || 0);
     const minStakeAmount = Number(checkoutSession.subscription_data?.min_stake_amount || 0);
     const fastCheckoutAmount = getFastCheckoutAmount(items, checkoutSession.mode, paymentCurrency.id, trialing);

package/api/src/routes/subscriptions.ts

@@ -1644,7 +1644,7 @@ router.put('/:id/slash-stake', auth, async (req, res) => {
     });
     return res.json(result);
   } catch (err) {
-    logger.error('subscription slash stake failed', { subscription: subscription.id, error: err.message });
+    logger.error('subscription slash stake failed', { subscription: subscription.id, error: err });
     return res.status(400).json({ error: err.message });
   }
 });

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

@@ -367,6 +367,7 @@ export type SubscriptionData = {
   metadata?: Record<string, any>;
   recovered_from?: string;
   trial_end?: number;
+  trial_currency?: string;
 };
 
 // Very similar to PaymentLink

package/api/tests/libs/subscription.spec.ts

@@ -7,6 +7,7 @@ import {
   getMinRetryMail,
   getSubscriptionCreateSetup,
   getSubscriptionStakeSetup,
+  getSubscriptionTrialSetup,
   shouldCancelSubscription,
 } from '../../src/libs/subscription';
 
@@ -183,7 +184,7 @@ describe('getSubscriptionCreateSetup', () => {
     );
   });
 
-  it('should trialEnds overwrite trialInDays', () => {
+  it('should trialEnd overwrite trialInDays', () => {
     const items = [
       {
         price: { type: 'recurring', currency_options: currencies, recurring: { interval: 'day', interval_count: '1' } },
@@ -200,7 +201,7 @@ describe('getSubscriptionCreateSetup', () => {
     );
   });
 
-  it('should calculate trial period when only trialEnds is provided', () => {
+  it('should calculate trial period when only trialEnd is provided', () => {
     const items = [
       {
         price: { type: 'recurring', currency_options: currencies, recurring: { interval: 'day', interval_count: '1' } },
@@ -371,8 +372,8 @@ describe('getSubscriptionStakeSetup', () => {
 
   it('should calculate staking for recurring metered price type when billingThreshold is 0 #1', () => {
     const result = getSubscriptionStakeSetup(items.slice(2, 3), 'usd', '10');
-    expect(result.licensed.toString()).toBe('0');
-    expect(result.metered.toString()).toBe('10');
+    expect(result.licensed.toString()).toBe('10');
+    expect(result.metered.toString()).toBe('0');
   });
 
   it('should calculate staking for recurring metered price type when billingThreshold is 0 #2', () => {
@@ -383,7 +384,30 @@ describe('getSubscriptionStakeSetup', () => {
 
   it('should calculate staking for recurring metered price type when billingThreshold is greater than 0', () => {
     const result = getSubscriptionStakeSetup(items, 'usd', '10');
-    expect(result.licensed.toString()).toBe('2');
-    expect(result.metered.toString()).toBe('10');
+    expect(result.licensed.toString()).toBe('10');
+    expect(result.metered.toString()).toBe('0');
+  });
+});
+
+describe('getSubscriptionTrialSetup', () => {
+  it('should return trialInDays and trialEnd when data is provided', () => {
+    const data: any = { trial_period_days: '10', trial_end: '20', trial_currency: 'USD,EUR' };
+    const currencyId = 'USD';
+    const result = getSubscriptionTrialSetup(data, currencyId);
+    expect(result).toEqual({ trialInDays: 10, trialEnd: 20 });
+  });
+
+  it('should set trialInDays and trialEnd to 0 if currencyId is not in the trialCurrencyIds list', () => {
+    const data: any = { trial_period_days: '10', trial_end: '20', trial_currency: 'USD,EUR' };
+    const currencyId = 'JPY'; // currency code not included in the trialCurrencyIds list
+    const result = getSubscriptionTrialSetup(data, currencyId);
+    expect(result).toEqual({ trialInDays: 0, trialEnd: 0 });
+  });
+
+  it('should set trialInDays and trialEnd to 0 when values are not provided', () => {
+    const data: any = {};
+    const currencyId = 'USD';
+    const result = getSubscriptionTrialSetup(data, currencyId);
+    expect(result).toEqual({ trialInDays: 0, trialEnd: 0 });
   });
 });

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.14.36
+version: 1.14.37
 logo: logo.png
 files:
   - dist
@@ -39,7 +39,6 @@ interfaces:
           profileFields:
             - fullName
             - email
-            - phone
             - avatar
           allowSwitchProfile: true
           ignoreUrls:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.14.36",
+  "version": "1.14.37",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -52,7 +52,7 @@
     "@arcblock/validator": "^1.18.132",
     "@blocklet/js-sdk": "1.16.30",
     "@blocklet/logger": "1.16.30",
-    "@blocklet/payment-react": "1.14.36",
+    "@blocklet/payment-react": "1.14.37",
     "@blocklet/sdk": "1.16.30",
     "@blocklet/ui-react": "^2.10.23",
     "@blocklet/uploader": "^0.1.27",
@@ -119,7 +119,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.30",
     "@arcblock/eslint-config-ts": "^0.3.2",
-    "@blocklet/payment-types": "1.14.36",
+    "@blocklet/payment-types": "1.14.37",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -161,5 +161,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "927e39d554524434d20f22a950eec503166ae529"
+  "gitHead": "645ae0bdbab463eec878af0521eb982b51499639"
 }