payment-kit 1.13.25 → 1.13.27

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

@@ -11,9 +11,18 @@ import {
 } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 
-import { createStatusEvent } from '../../libs/audit';
+import { createCustomEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { CurrencyConversion, CustomField, CustomerDetail, InvoiceData, LineItem, PaymentDetails } from './types';
+import type {
+  CurrencyConversion,
+  CustomField,
+  CustomerDetail,
+  InvoiceData,
+  LineItem,
+  NftMintDetails,
+  NftMintSettings,
+  PaymentDetails,
+} from './types';
 
 const nextId = createIdGenerator('cs', 58);
 
@@ -162,13 +171,24 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
   // 3rd party payment tx hash
   declare payment_details?: PaymentDetails;
 
+  // A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
+  declare payment_intent_data?: {
+    description?: string;
+    statement_descriptor?: string;
+    metadata?: Record<string, any>;
+  };
+
+  // Whether should we mint an nft to the customer on checkout complete
+  // Will use setting from payment method
+  declare nft_mint_status: LiteralUnion<'disabled' | 'pending' | 'minted' | 'sent' | 'error', string>;
+  declare nft_mint_settings?: NftMintSettings;
+  declare nft_mint_details?: NftMintDetails;
+
   // FIXME: Only exist on creation
   // declare discounts?: {
   //   coupon?: string;
   //   promotion_code?: string;
   // };
-  // A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
-  // declare payment_intent_data?: any;
 
   // TODO: following fields not supported yet
   // automatic_tax
@@ -236,12 +256,19 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
     },
     mode: {
       type: DataTypes.ENUM('payment', 'setup', 'subscription'),
+      allowNull: false,
     },
     status: {
       type: DataTypes.ENUM('complete', 'open', 'expired'),
+      allowNull: false,
     },
     payment_status: {
       type: DataTypes.ENUM('paid', 'unpaid', 'no_payment_required'),
+      allowNull: false,
+    },
+    nft_mint_status: {
+      type: DataTypes.ENUM('disabled', 'pending', 'minted', 'sent', 'error'),
+      allowNull: false,
     },
     line_items: {
       type: DataTypes.JSON,
@@ -364,24 +391,53 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
   };
 
   public static initialize(sequelize: any) {
-    this.init(CheckoutSession.GENESIS_ATTRIBUTES, {
-      sequelize,
-      modelName: 'CheckoutSession',
-      tableName: 'checkout_sessions',
-      createdAt: 'created_at',
-      updatedAt: 'updated_at',
-      hooks: {
-        afterUpdate: (model: CheckoutSession, options) => {
-          createStatusEvent(
-            'CheckoutSession',
-            'checkout.session',
-            { complete: 'completed', expired: 'expired' },
-            model,
-            options
-          ).catch(console.error);
+    this.init(
+      {
+        ...CheckoutSession.GENESIS_ATTRIBUTES,
+        payment_intent_data: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
+        nft_mint_settings: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
+        nft_mint_details: {
+          type: DataTypes.JSON,
+          allowNull: true,
         },
       },
-    });
+      {
+        sequelize,
+        modelName: 'CheckoutSession',
+        tableName: 'checkout_sessions',
+        createdAt: 'created_at',
+        updatedAt: 'updated_at',
+        hooks: {
+          afterUpdate: (model: CheckoutSession, options) => {
+            createStatusEvent(
+              'CheckoutSession',
+              'checkout.session',
+              { complete: 'completed', expired: 'expired' },
+              model,
+              options
+            ).catch(console.error);
+            createCustomEvent(
+              'CheckoutSession',
+              'checkout.session',
+              (current, previous) => {
+                if (previous.nft_mint_status === 'pending' && current.nft_mint_status === 'minted') {
+                  return 'nft_minted';
+                }
+                return '';
+              },
+              model,
+              options
+            ).catch(console.error);
+          },
+        },
+      }
+    );
   }
 
   public static associate(models: any) {

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

@@ -173,6 +173,7 @@ export class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttrib
     },
     collection_method: {
       type: DataTypes.ENUM('charge_automatically', 'send_invoice'),
+      allowNull: false,
     },
     currency_id: {
       type: DataTypes.STRING(15),
@@ -204,6 +205,7 @@ export class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttrib
     },
     status: {
       type: DataTypes.ENUM('draft', 'open', 'void', 'paid', 'uncollectible'),
+      allowNull: false,
     },
     checkout_session_id: {
       type: DataTypes.STRING(64),

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

@@ -196,9 +196,11 @@ export class PaymentIntent extends Model<InferAttributes<PaymentIntent>, InferCr
     },
     capture_method: {
       type: DataTypes.ENUM('automatic', 'manual'),
+      allowNull: false,
     },
     confirmation_method: {
       type: DataTypes.ENUM('automatic', 'manual'),
+      allowNull: false,
     },
     payment_method_types: {
       type: DataTypes.JSON,

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

@@ -4,7 +4,7 @@ import type { LiteralUnion } from 'type-fest';
 
 import { createEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { AfterPayment, CustomField, LineItem } from './types';
+import type { AfterPayment, CustomField, LineItem, NftMintSettings } from './types';
 
 const nextId = createIdGenerator('plink', 24);
 
@@ -71,6 +71,8 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
     trial_period_days: number;
   };
 
+  declare nft_mint_settings?: NftMintSettings;
+
   declare metadata?: Record<string, any>;
 
   // TODO: following fields not supported
@@ -190,21 +192,30 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
   };
 
   public static initialize(sequelize: any) {
-    this.init(PaymentLink.GENESIS_ATTRIBUTES, {
-      sequelize,
-      modelName: 'PaymentLink',
-      tableName: 'payment_links',
-      createdAt: 'created_at',
-      updatedAt: 'updated_at',
-      hooks: {
-        afterCreate: (model: PaymentLink, options) =>
-          createEvent('PaymentLink', 'payment_link.created', model, options).catch(console.error),
-        afterUpdate: (model: PaymentLink, options) =>
-          createEvent('PaymentLink', 'payment_link.updated', model, options).catch(console.error),
-        afterDestroy: (model: PaymentLink, options) =>
-          createEvent('PaymentLink', 'payment_link.deleted', model, options).catch(console.error),
+    this.init(
+      {
+        ...PaymentLink.GENESIS_ATTRIBUTES,
+        nft_mint_settings: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
       },
-    });
+      {
+        sequelize,
+        modelName: 'PaymentLink',
+        tableName: 'payment_links',
+        createdAt: 'created_at',
+        updatedAt: 'updated_at',
+        hooks: {
+          afterCreate: (model: PaymentLink, options) =>
+            createEvent('PaymentLink', 'payment_link.created', model, options).catch(console.error),
+          afterUpdate: (model: PaymentLink, options) =>
+            createEvent('PaymentLink', 'payment_link.updated', model, options).catch(console.error),
+          afterDestroy: (model: PaymentLink, options) =>
+            createEvent('PaymentLink', 'payment_link.deleted', model, options).catch(console.error),
+        },
+      }
+    );
   }
 
   public static associate(models: any) {

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

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/lines-between-class-members */
 import security from '@blocklet/sdk/lib/security';
+import OcapClient from '@ocap/client';
 import cloneDeep from 'lodash/cloneDeep';
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import Stripe from 'stripe';
@@ -12,6 +13,7 @@ import type { PaymentMethodSettings } from './types';
 const nextId = createIdGenerator('pm', 24);
 
 const stripeClients = new Map<string, Stripe>();
+const ocapClients = new Map<string, OcapClient>();
 
 // eslint-disable-next-line prettier/prettier
 export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCreationAttributes<PaymentMethod>> {
@@ -162,7 +164,7 @@ export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCr
     return tmp;
   }
 
-  getStripe() {
+  getStripeClient() {
     if (this.type !== 'stripe') {
       throw new Error('payment method is not stripe');
     }
@@ -181,6 +183,25 @@ export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCr
     return client as Stripe;
   }
 
+  getOcapClient() {
+    if (this.type !== 'arcblock') {
+      throw new Error('payment method is not arcblock');
+    }
+    if (!this.settings.arcblock) {
+      throw new Error('payment method config insufficient to create ocap client');
+    }
+
+    const host = this.settings.arcblock?.api_host;
+    const cached = ocapClients.has(host);
+    if (!cached) {
+      const created = new OcapClient(host);
+      ocapClients.set(host, created);
+      return created;
+    }
+
+    return ocapClients.get(host) as OcapClient;
+  }
+
   public static async supportAutoCharge(id: string) {
     const method = await PaymentMethod.findByPk(id);
     return method && ['arcblock', 'ethereum'].includes(method.type);

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

@@ -103,9 +103,11 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
     },
     type: {
       type: DataTypes.ENUM('one_time', 'recurring'),
+      allowNull: false,
     },
     billing_scheme: {
       type: DataTypes.ENUM('per_unit', 'tiered'),
+      allowNull: false,
     },
     unit_amount: {
       type: DataTypes.STRING(32),

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

@@ -3,7 +3,7 @@
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 
-import { createEvent, createStatusEvent } from '../../libs/audit';
+import { createCustomEvent, createEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
 import type { PaymentDetails, PaymentSettings, PriceRecurring } from './types';
 
@@ -188,6 +188,7 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
     },
     collection_method: {
       type: DataTypes.ENUM('charge_automatically', 'send_invoice'),
+      allowNull: false,
     },
     days_until_due: {
       type: DataTypes.NUMBER,
@@ -269,12 +270,13 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
           createEvent('Subscription', 'customer.subscription.created', model, options).catch(console.error),
         afterUpdate: (model: Subscription, options) => {
           createEvent('Subscription', 'customer.subscription.updated', model, options).catch(console.error);
-          createStatusEvent('Subscription', 'customer.subscription', { canceled: 'canceled' }, model, options).catch(
+          createStatusEvent('Subscription', 'customer.subscription', { canceled: 'deleted' }, model, options).catch(
+            console.error
+          );
+          createCustomEvent('Subscription', 'customer.subscription', getSubscriptionEventType, model, options).catch(
             console.error
           );
         },
-        afterDestroy: (model: Subscription, options) =>
-          createEvent('Subscription', 'customer.subscription.deleted', model, options).catch(console.error),
       },
     });
   }
@@ -303,3 +305,23 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
 }
 
 export type TSubscription = InferAttributes<Subscription>;
+
+export function getSubscriptionEventType(current: TSubscription, previous: Partial<TSubscription>) {
+  if (current.pause_collection && !previous.pause_collection) {
+    return 'paused';
+  }
+  if (!current.pause_collection && previous.pause_collection) {
+    return 'resumed';
+  }
+  if (
+    current.status === 'active' &&
+    current.current_period_end &&
+    current.current_period_end !== previous.current_period_end &&
+    current.current_period_start &&
+    current.current_period_start !== previous.current_period_start
+  ) {
+    return 'renewed';
+  }
+
+  return '';
+}

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

@@ -152,7 +152,12 @@ export type LineItem = {
   // tax_rates?: any;
 };
 
-export type InvoiceData = Record<string, any>;
+export type InvoiceData = {
+  description?: string;
+  footer?: string;
+  metadata?: Record<string, any>;
+  custom_fields?: SimpleCustomField[];
+};
 
 // @see https://stripe.com/docs/currencies/conversions
 // If presentment currency is different from settlement currency, this is the exchange rate snapshot used.
@@ -262,6 +267,28 @@ export type PaymentDetails = {
   };
 };
 
+export type NftMintSettings = {
+  enabled: boolean;
+  behavior?: LiteralUnion<'per_customer' | 'per_checkout_session', string>;
+  factory?: string;
+  inputs?: Record<string, string>;
+};
+
+export type NftMintDetails = {
+  arcblock?: {
+    tx_hash?: string;
+    address: string;
+    owner: string;
+    error?: string;
+  };
+  ethereum?: {
+    tx_hash?: string;
+    address: string;
+    owner: string;
+    error?: string;
+  };
+};
+
 // Very similar to PaymentLink
 export type PricingTableItem = {
   price_id: string;
@@ -306,6 +333,8 @@ export type PricingTableItem = {
     description: string;
     trial_period_days: number;
   };
+
+  nft_mint_settings?: NftMintSettings;
 };
 
 export type BrandSettings = {
@@ -346,6 +375,7 @@ export type EventType = LiteralUnion<
   | 'charge.updated'
   | 'checkout.session.async_payment_failed'
   | 'checkout.session.async_payment_succeeded'
+  | 'checkout.session.nft_minted'
   | 'checkout.session.completed'
   | 'checkout.session.expired'
   | 'coupon.created'
@@ -370,6 +400,7 @@ export type EventType = LiteralUnion<
   | 'customer.subscription.pending_update_applied'
   | 'customer.subscription.pending_update_expired'
   | 'customer.subscription.resumed'
+  | 'customer.subscription.renewed'
   | 'customer.subscription.trial_will_end'
   | 'customer.subscription.updated'
   | 'customer.tax_id.created'

package/api/third.d.ts

@@ -1,5 +1,7 @@
 declare module 'vite-plugin-blocklet';
 
+declare module '@blocklet/sdk/service/notification';
+
 declare module 'express-history-api-fallback';
 
 declare module 'express-async-errors';

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.25",
+  "version": "1.13.27",
   "scripts": {
     "dev": "blocklet dev",
     "eject": "vite eject",
@@ -45,8 +45,8 @@
     "@arcblock/did-connect": "^2.7.28",
     "@arcblock/did-util": "^1.18.92",
     "@arcblock/ux": "^2.7.28",
-    "@blocklet/logger": "^1.16.16",
-    "@blocklet/sdk": "^1.16.16",
+    "@blocklet/logger": "1.16.17-beta-703fb879",
+    "@blocklet/sdk": "1.16.17-beta-703fb879",
     "@blocklet/ui-react": "^2.7.28",
     "@blocklet/uploader": "^0.0.26",
     "@mui/icons-material": "^5.14.13",
@@ -54,6 +54,7 @@
     "@mui/material": "^5.14.13",
     "@mui/styles": "^5.14.13",
     "@mui/system": "^5.14.13",
+    "@ocap/asset": "^1.18.92",
     "@ocap/client": "^1.18.92",
     "@ocap/mcrypto": "^1.18.92",
     "@ocap/util": "^1.18.92",
@@ -99,9 +100,10 @@
     "validator": "^13.11.0"
   },
   "devDependencies": {
+    "@abtnode/types": "1.16.17-beta-703fb879",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.25",
+    "@did-pay/types": "1.13.27",
     "@types/cookie-parser": "^1.4.4",
     "@types/cors": "^2.8.14",
     "@types/dotenv-flow": "^3.3.1",
@@ -138,5 +140,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "4032a368047c93d3fc52ecbaa4cf37221924f45c"
+  "gitHead": "7f11915be75b7419085508377566b02495b423a1"
 }

package/src/components/customer/actions.tsx

@@ -8,7 +8,7 @@ import api from '../../libs/api';
 import { formatError } from '../../libs/util';
 import Actions from '../actions';
 import ClickBoundary from '../click-boundary';
-import ConfirmDialog from '../confirm';
+import EditCustomer from './edit';
 
 type Props = {
   data: TCustomerExpanded;
@@ -27,12 +27,12 @@ export default function CustomerActions({ data, onChange, variant }: Props) {
     loading: false,
   });
 
-  const onRefund = async () => {
+  const onUpdateInfo = async (updates: TCustomerExpanded) => {
     try {
       setState({ loading: true });
-      await api.put(`/api/customers/${data.id}/archive`).then((res) => res.data);
+      await api.put(`/api/customers/${data.id}`, updates).then((res) => res.data);
       Toast.success(t('common.saved'));
-      onChange(state.action);
+      onChange('update');
     } catch (err) {
       console.error(err);
       Toast.error(formatError(err));
@@ -46,27 +46,25 @@ export default function CustomerActions({ data, onChange, variant }: Props) {
       <Actions
         variant={variant}
         actions={[
-          {
-            label: t('admin.payments'),
-            handler: () => setState({ action: 'refund' }),
-            color: 'primary',
-            disabled: true,
-          },
+          // {
+          //   label: t('admin.payments'),
+          //   handler: () => setState({ action: 'refund' }),
+          //   color: 'primary',
+          //   disabled: true,
+          // },
           {
             label: t('admin.customer.edit'),
             handler: () => setState({ action: 'edit' }),
             color: 'primary',
-            disabled: true,
           },
         ]}
       />
-      {state.action === 'refund' && (
-        <ConfirmDialog
-          onConfirm={onRefund}
-          onCancel={() => setState({ action: '' })}
-          title={t('admin.customer.refund')}
-          message={t('admin.customer.refundTip')}
+      {state.action === 'edit' && (
+        <EditCustomer
+          data={data}
           loading={state.loading}
+          onSave={onUpdateInfo}
+          onCancel={() => setState({ action: '' })}
         />
       )}
     </ClickBoundary>

package/src/components/customer/form.tsx

@@ -64,7 +64,7 @@ export default function CustomerForm() {
         }}
       />
 
-      <Typography component="h6" sx={{ mb: 1, color: 'text.primary', fontWeight: 600 }}>
+      <Typography component="h6" sx={{ pt: 2, color: 'text.primary', fontWeight: 600 }}>
         {t('checkout.billing.required')}
       </Typography>
       <Controller

package/src/components/invoice/list.tsx

@@ -94,11 +94,12 @@ export default function InvoiceList({ customer_id, subscription_id, features, st
       label: t('common.amount'),
       name: 'total',
       width: 60,
+      align: 'right',
       options: {
         customBodyRenderLite: (_: string, index: number) => {
           const item = data.list[index];
           return (
-            <Typography component="span">
+            <Typography component="strong" fontWeight={600}>
               {fromUnitToToken(item?.total, item?.paymentCurrency.decimal)}&nbsp;
               {item?.paymentCurrency.symbol}
             </Typography>

package/src/components/passport/actions.tsx

@@ -0,0 +1,62 @@
+import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
+import Toast from '@arcblock/ux/lib/Toast';
+import { useSetState } from 'ahooks';
+
+import api from '../../libs/api';
+import { formatError } from '../../libs/util';
+import Actions from '../actions';
+import ClickBoundary from '../click-boundary';
+import ConfirmDialog from '../confirm';
+
+type Props = {
+  data: any;
+  variant?: string;
+};
+
+PassportActions.defaultProps = {
+  variant: 'compact',
+};
+
+export default function PassportActions(props: Props) {
+  const { t } = useLocaleContext();
+
+  const [state, setState] = useSetState({
+    action: '',
+    loading: false,
+  });
+
+  const onUnassign = async () => {
+    try {
+      setState({ loading: true });
+      await api.delete(`/api/passports/assign/${props.data.name}`).then((res) => res.data);
+      Toast.success(t('common.saved'));
+    } catch (err) {
+      console.error(err);
+      Toast.error(formatError(err));
+    } finally {
+      setState({ loading: false, action: '' });
+    }
+  };
+
+  const actions = [
+    {
+      label: t('admin.passport.unassign'),
+      handler: () => setState({ action: 'unassign' }),
+      color: 'error',
+    },
+  ];
+
+  return (
+    <ClickBoundary>
+      <Actions variant={props.variant} actions={actions} />
+      {state.action === 'unassign' && (
+        <ConfirmDialog
+          onConfirm={onUnassign}
+          onCancel={() => setState({ action: '' })}
+          title={t('admin.passport.unassign')}
+          message={t('admin.passport.unassignTip')}
+        />
+      )}
+    </ClickBoundary>
+  );
+}