payment-kit 1.13.17 → 1.13.19

package/api/src/routes/webhook-endpoints.ts

@@ -30,15 +30,15 @@ router.post('/', auth, async (req, res) => {
 
 const schema = Joi.object<{
   page: number;
-  size: number;
+  pageSize: number;
   livemode?: boolean;
 }>({
   page: Joi.number().integer().min(1).default(1),
-  size: Joi.number().integer().min(1).max(100).default(20),
+  pageSize: Joi.number().integer().min(1).max(100).default(20),
   livemode: Joi.boolean().empty(''),
 });
 router.get('/', auth, async (req, res) => {
-  const { page, size, ...query } = await schema.validateAsync(req.query, { stripUnknown: true });
+  const { page, pageSize, ...query } = await schema.validateAsync(req.query, { stripUnknown: true });
   const where: WhereOptions<WebhookEndpoint> = {};
 
   if (typeof query.livemode === 'boolean') {
@@ -49,8 +49,8 @@ router.get('/', auth, async (req, res) => {
     const { rows: list, count } = await WebhookEndpoint.findAndCountAll({
       where,
       order: [['created_at', 'DESC']],
-      offset: (page - 1) * size,
-      limit: size,
+      offset: (page - 1) * pageSize,
+      limit: pageSize,
       include: [],
     });
 

package/api/src/store/migrations/20230905-genesis.ts

@@ -7,9 +7,9 @@ export const up: Migration = async ({ context: queryInterface }) => {
   await queryInterface.createTable('customers', models.Customer.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('discounts', models.Discount.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('events', models.Event.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('jobs', models.Job.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('invoices', models.Invoice.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('invoice_items', models.InvoiceItem.GENESIS_ATTRIBUTES);
+  await queryInterface.createTable('jobs', models.Job.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('payment_currencies', models.PaymentCurrency.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('payment_intents', models.PaymentIntent.GENESIS_ATTRIBUTES);
   await queryInterface.createTable('payment_links', models.PaymentLink.GENESIS_ATTRIBUTES);
@@ -32,9 +32,9 @@ export const down: Migration = async ({ context: queryInterface }) => {
   await queryInterface.dropTable('customers');
   await queryInterface.dropTable('discounts');
   await queryInterface.dropTable('events');
-  await queryInterface.dropTable('jobs');
   await queryInterface.dropTable('invoices');
   await queryInterface.dropTable('invoice_items');
+  await queryInterface.dropTable('jobs');
   await queryInterface.dropTable('payment_currencies');
   await queryInterface.dropTable('payment_intents');
   await queryInterface.dropTable('payment_links');

package/api/src/store/migrations/20230911-seeding.ts

@@ -1,3 +1,4 @@
+import { getUrl } from '@blocklet/sdk/lib/component';
 import { fromTokenToUnit } from '@ocap/util';
 import Sequelize from 'sequelize';
 
@@ -15,7 +16,7 @@ const mainId = genPaymentMethodId();
 const betaId = genPaymentMethodId();
 const now = new Date();
 
-const logo = 'https://new.arcblock.io/.well-known/service/blocklet/logo?imageFilter=resize&w=80';
+const logo = getUrl('/methods/arcblock.png');
 
 const paymentCurrencies = [
   {
@@ -60,7 +61,7 @@ const paymentCurrencies = [
     id: marsId,
     active: true,
     livemode: false,
-    locked: true,
+    locked: false,
     is_base_currency: false,
     payment_method_id: betaId,
     name: 'RollupTestToken',
@@ -79,7 +80,7 @@ const paymentCurrencies = [
     id: play3Id,
     active: true,
     livemode: false,
-    locked: true,
+    locked: false,
     is_base_currency: false,
     payment_method_id: betaId,
     name: 'Playground Token',

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

@@ -13,7 +13,7 @@ import type { LiteralUnion } from 'type-fest';
 
 import { createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { CurrencyConversion, CustomField, CustomerDetail, InvoiceData, LineItem } from './types';
+import type { CurrencyConversion, CustomField, CustomerDetail, InvoiceData, LineItem, PaymentDetails } from './types';
 
 const nextId = createIdGenerator('cs', 58);
 
@@ -31,6 +31,10 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
   // ID of the invoice created by the Checkout Session, if it exists.
   declare invoice_id?: string;
 
+  // customer id for the Checkout Session, if it exists.
+  declare customer_id?: string;
+  declare customer_did?: string;
+
   // The ID of the Payment Link that created this Session.
   declare payment_link_id?: string;
 
@@ -125,7 +129,7 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
   };
 
   // The list of payment method types that customers can use
-  declare payment_method_types?: string[];
+  declare payment_method_types: string[];
 
   // Controls phone number collection settings during checkout.
   declare phone_number_collection?: {
@@ -156,10 +160,7 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
   };
 
   // 3rd party payment tx hash
-  declare payment_details?: {
-    tx_hash?: string;
-    payer?: string;
-  };
+  declare payment_details?: PaymentDetails;
 
   // FIXME: Only exist on creation
   // declare discounts?: {
@@ -209,6 +210,14 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
       type: DataTypes.STRING(30),
       allowNull: true,
     },
+    customer_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    customer_did: {
+      type: DataTypes.STRING(40),
+      allowNull: true,
+    },
     payment_link_id: {
       type: DataTypes.STRING(30),
       allowNull: true,
@@ -375,7 +384,6 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
     });
   }
 
-  // FIXME:
   public static associate(models: any) {
     this.hasOne(models.PaymentCurrency, {
       sourceKey: 'currency_id',

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

@@ -18,7 +18,7 @@ import { Subscription, TSubscription } from './subscription';
 import { SubscriptionItem, TSubscriptionItem } from './subscription-item';
 import { SubscriptionSchedule } from './subscription-schedule';
 import type { LineItem } from './types';
-import { UsageRecord } from './usage-record';
+import { TUsageRecord, UsageRecord } from './usage-record';
 import { TWebhookAttempt, WebhookAttempt } from './webhook-attempt';
 import { TWebhookEndpoint, WebhookEndpoint } from './webhook-endpoint';
 
@@ -73,6 +73,7 @@ export * from './payment-method';
 export * from './price';
 export * from './product';
 export * from './promotion-code';
+export * from './setup-intent';
 export * from './subscription';
 export * from './subscription-item';
 export * from './subscription-schedule';
@@ -81,25 +82,33 @@ export * from './webhook-attempt';
 export * from './webhook-endpoint';
 export * from './types';
 
-export type TPriceExpanded = TPrice & { product: TProduct; currency: TPaymentCurrency };
+export type TPriceExpanded = TPrice & { object: 'price'; product: TProduct; currency: TPaymentCurrency };
 
 export type TLineItemExpanded = LineItem & { price: TPriceExpanded };
 
-export type TProductExpanded = TProduct & { prices: TPrice[]; default_price: TPrice };
+export type TProductExpanded = TProduct & { object: 'price'; prices: TPrice[]; default_price: TPrice };
 
-export type TPaymentLinkExpanded = TPaymentLink & { line_items: TLineItemExpanded[] };
+export type TPaymentLinkExpanded = TPaymentLink & { object: 'payment_link'; line_items: TLineItemExpanded[] };
 
-export type TPaymentMethodExpanded = TPaymentMethod & { payment_currencies: TPaymentCurrency[] };
+export type TPaymentMethodExpanded = TPaymentMethod & {
+  object: 'payment_method';
+  payment_currencies: TPaymentCurrency[];
+};
+
+export type TPaymentCurrencyExpanded = TPaymentCurrency & {
+  object: 'payment_currency';
+};
 
 export type TCheckoutSessionExpanded = TCheckoutSession & {
+  object: 'checkout_session';
   line_items: TLineItemExpanded[];
   payment_link?: TPaymentLink;
   payment_intent?: TPaymentIntent;
   subscription?: TSubscription;
-  currency: TPaymentCurrency;
 };
 
 export type TPaymentIntentExpanded = TPaymentIntent & {
+  object: 'payment_intent';
   customer: TCustomer;
   paymentCurrency: TPaymentCurrency;
   paymentMethod: TPaymentMethod;
@@ -109,6 +118,7 @@ export type TPaymentIntentExpanded = TPaymentIntent & {
 };
 
 export type TSubscriptionExpanded = TSubscription & {
+  object: 'subscription';
   customer: TCustomer;
   paymentCurrency: TPaymentCurrency;
   paymentMethod: TPaymentMethod;
@@ -116,16 +126,19 @@ export type TSubscriptionExpanded = TSubscription & {
 };
 
 export type TSubscriptionItemExpanded = TSubscriptionItem & {
+  object: 'subscription';
   price: TPriceExpanded;
 };
 
 export type TCustomerExpanded = TCustomer & {
+  object: 'subscription';
   payments: TPaymentIntent[];
   subscriptions: TSubscription[];
   invoices: TInvoice[];
 };
 
 export type TInvoiceExpanded = TInvoice & {
+  object: 'invoice';
   customer: TCustomer;
   paymentCurrency: TPaymentCurrency;
   paymentMethod: TPaymentMethod;
@@ -135,23 +148,32 @@ export type TInvoiceExpanded = TInvoice & {
 };
 
 export type TInvoiceItemExpanded = TInvoiceItem & {
+  object: 'invoice_item';
   price: TPriceExpanded;
 };
 
 export type TEventExpanded = TEvent & {
+  object: 'event';
   webhooks: TWebhookEndpointExpanded[];
 };
 
 export type TWebhookAttemptExpanded = TWebhookAttempt & {
+  object: 'webhook_attempt';
   event: TEvent;
   endpoint: TWebhookEndpoint;
 };
 
 export type TWebhookEndpointExpanded = TWebhookEndpoint & {
+  object: 'webhook_endpoint';
   attempts: TWebhookAttemptExpanded[];
 };
 
+export type TUsageRecordExpanded = TUsageRecord & {
+  object: 'usage_record';
+};
+
 export type TUsageRecordSummary = {
+  object: 'usage_record_summary';
   livemode: boolean;
   invoice_id: string;
   subscription_item_id: string;
@@ -162,4 +184,6 @@ export type TUsageRecordSummary = {
   };
 };
 
-export type TSetupIntentExpanded = TSetupIntent & {};
+export type TSetupIntentExpanded = TSetupIntent & {
+  object: 'setup_intent';
+};

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

@@ -386,7 +386,7 @@ export class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttrib
     },
     statement_descriptor: {
       type: DataTypes.STRING(64),
-      allowNull: false,
+      allowNull: true,
     },
     status_transitions: {
       type: DataTypes.JSON,

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

@@ -5,7 +5,7 @@ import type { LiteralUnion } from 'type-fest';
 
 import { createEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { PaymentError } from './types';
+import type { PaymentDetails, PaymentError } from './types';
 
 const nextId = createIdGenerator('pi', 24);
 
@@ -75,10 +75,7 @@ export class PaymentIntent extends Model<InferAttributes<PaymentIntent>, InferCr
   declare review?: string;
 
   // 3rd party payment tx hash
-  declare payment_details?: {
-    tx_hash?: string;
-    payer?: string;
-  };
+  declare payment_details?: PaymentDetails;
 
   declare setup_future_usage: LiteralUnion<'off_session' | 'on_session', string>;
 

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

@@ -94,7 +94,7 @@ export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreati
 
   public static readonly GENESIS_ATTRIBUTES = {
     id: {
-      type: DataTypes.STRING(30),
+      type: DataTypes.STRING(40),
       primaryKey: true,
       allowNull: false,
       defaultValue: nextId,

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

@@ -1,34 +1,17 @@
 /* eslint-disable @typescript-eslint/lines-between-class-members */
+import security from '@blocklet/sdk/lib/security';
+import cloneDeep from 'lodash/cloneDeep';
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import Stripe from 'stripe';
 import type { LiteralUnion } from 'type-fest';
 
-import { createIdGenerator } from '../../libs/util';
+import { STRIPE_API_VERSION, createIdGenerator } from '../../libs/util';
 import { sequelize } from '../sequelize';
+import type { PaymentMethodSettings } from './types';
 
 const nextId = createIdGenerator('pm', 24);
 
-type StripeConfig = {
-  publishable_key: string;
-  secret_key: string;
-};
-
-type ArcblockConfig = {
-  chain_id: string;
-  api_host: string;
-  explorer_host: string;
-};
-
-type EthereumConfig = {
-  chain_id: number;
-  api_host: string;
-  explorer_host: string;
-};
-
-type BitcoinConfig = {
-  chain_id: number;
-  api_host: string;
-  explorer_host: string;
-};
+const stripeClients = new Map<string, Stripe>();
 
 // eslint-disable-next-line prettier/prettier
 export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCreationAttributes<PaymentMethod>> {
@@ -56,12 +39,7 @@ export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCr
   };
 
   // Extra settings to make the payment method work
-  declare settings: {
-    stripe?: StripeConfig;
-    arcblock?: ArcblockConfig;
-    ethereum?: EthereumConfig;
-    bitcoin?: BitcoinConfig;
-  };
+  declare settings: PaymentMethodSettings;
 
   // What features are supported
   declare features: {
@@ -73,7 +51,6 @@ export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCr
   declare metadata: Record<string, any>;
 
   declare created_at: CreationOptional<Date>;
-
   declare updated_at: CreationOptional<Date>;
 
   public static readonly GENESIS_ATTRIBUTES = {
@@ -157,12 +134,56 @@ export class PaymentMethod extends Model<InferAttributes<PaymentMethod>, InferCr
     });
   }
 
-  public static expand(livemode?: boolean) {
+  public static expand(livemode?: boolean, conditions: Record<string, any> = {}) {
     return PaymentMethod.findAll({
-      where: { livemode: !!livemode },
+      where: { livemode: !!livemode, active: true, ...conditions },
       order: [['created_at', 'DESC']],
       include: [{ model: sequelize.models.PaymentCurrency, as: 'payment_currencies' }],
-    });
+    }).then((methods) => methods.map((x) => x.toJSON()));
+  }
+
+  public static encryptSettings(settings: PaymentMethodSettings) {
+    const tmp = cloneDeep(settings);
+    if (tmp.stripe) {
+      tmp.stripe.secret_key = security.encrypt(tmp.stripe.secret_key);
+      tmp.stripe.webhook_signing_secret = security.encrypt(tmp.stripe.webhook_signing_secret);
+    }
+
+    return tmp;
+  }
+
+  public static decryptSettings(settings: PaymentMethodSettings) {
+    const tmp = cloneDeep(settings);
+    if (tmp.stripe) {
+      tmp.stripe.secret_key = security.decrypt(tmp.stripe.secret_key);
+      tmp.stripe.webhook_signing_secret = security.decrypt(tmp.stripe.webhook_signing_secret);
+    }
+
+    return tmp;
+  }
+
+  getStripe() {
+    if (this.type !== 'stripe') {
+      throw new Error('payment method is not stripe');
+    }
+    if (!this.settings.stripe) {
+      throw new Error('payment method config insufficient');
+    }
+
+    if (stripeClients.has(this.id)) {
+      return stripeClients.get(this.id) as Stripe;
+    }
+
+    const settings = PaymentMethod.decryptSettings(this.settings);
+    const client = new Stripe(settings.stripe?.secret_key as string, { apiVersion: STRIPE_API_VERSION });
+    stripeClients.set(this.id, client);
+
+    return client as Stripe;
+  }
+
+  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

@@ -1,4 +1,6 @@
+import { fromTokenToUnit } from '@ocap/util';
 import isEmpty from 'lodash/isEmpty';
+import omit from 'lodash/omit';
 import {
   CreationOptional,
   DataTypes,
@@ -13,7 +15,8 @@ import type { LiteralUnion } from 'type-fest';
 import { createEvent } from '../../libs/audit';
 import { createIdGenerator, formatMetadata } from '../../libs/util';
 import { sequelize } from '../sequelize';
-import type { CustomUnitAmount, LineItem, PriceRecurring, PriceTier, TransformQuantity } from './types';
+import type { TPaymentCurrency } from './payment-currency';
+import type { CustomUnitAmount, LineItem, PriceCurrency, PriceRecurring, PriceTier, TransformQuantity } from './types';
 
 const nextId = createIdGenerator('price', 24);
 
@@ -26,7 +29,7 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
   declare product_id: string;
 
   // A brief description of the price, hidden from customers.
-  declare nickname?: string;
+  declare nickname: string | null;
 
   // Whether the price can be used for new purchases.
   declare active: boolean;
@@ -43,31 +46,30 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
   declare unit_amount: string;
 
   // The recurring components of a price such as interval and usage_type.
-  declare recurring?: PriceRecurring;
+  declare recurring: PriceRecurring | null;
 
   // Defines if the tiering price should be graduated or volume based.
-  declare tiers_mode?: LiteralUnion<'graduated' | 'volume', string>;
+  declare tiers_mode: LiteralUnion<'graduated' | 'volume', string> | null;
 
   // Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered
-  declare tiers?: PriceTier[];
+  declare tiers: PriceTier[] | null;
 
   // When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
-  declare custom_unit_amount?: CustomUnitAmount;
+  declare custom_unit_amount: CustomUnitAmount | null;
 
   // A lookup key used to retrieve prices dynamically from a static string
-  declare lookup_key?: string;
+  declare lookup_key: string | null;
 
   // Set of key-value pairs that you can attach to an object.
   declare metadata: Record<string, any>;
 
-  declare transform_quantity?: TransformQuantity;
+  declare transform_quantity: TransformQuantity | null;
 
   // Payment currency id
   declare currency_id: string;
+  declare currency_options: PriceCurrency[];
 
-  declare upsell?: {
-    upsells_to_id: string;
-  };
+  declare upsell?: { upsells_to_id: string } | null;
 
   declare created_at: CreationOptional<Date>;
   declare created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
@@ -140,6 +142,10 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
     currency_id: {
       type: DataTypes.STRING(16),
     },
+    currency_options: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
     created_at: {
       type: DataTypes.DATE,
       defaultValue: DataTypes.NOW,
@@ -201,13 +207,12 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
 
   public static format(price: Partial<TPrice & { model: string }>) {
     if (price.type === 'recurring') {
-      if (price.recurring) {
-        price.recurring.usage_type = price.recurring?.metered ? 'metered' : 'licensed';
-      } else {
+      if (!price.recurring) {
         throw new Error('recurring config is required for recurring prices');
       }
+      price.recurring.interval_count = Number(price.recurring.interval_count);
     } else {
-      price.recurring = undefined;
+      price.recurring = null;
     }
 
     if (price.model && ['graduated', 'volume'].includes(price.model)) {
@@ -218,11 +223,11 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
       }
     } else {
       price.billing_scheme = 'per_unit';
-      delete price.tiers;
+      price.tiers = null;
     }
 
     if (price.model !== 'package') {
-      delete price.transform_quantity;
+      price.transform_quantity = null;
     }
 
     price.metadata = formatMetadata(price.metadata);
@@ -230,6 +235,23 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
     return price;
   }
 
+  public static formatCurrencies(options: PriceCurrency[], currencies: TPaymentCurrency[]) {
+    return options.map((x) => {
+      const currency = currencies.find((c) => c.id === x.currency_id);
+      if (!currency) {
+        throw new Error(`currency ${x.currency_id} used in price not found or inactive`);
+      }
+
+      return omit(
+        {
+          ...x,
+          unit_amount: fromTokenToUnit(x.unit_amount, currency.decimal).toString(),
+        },
+        ['currency']
+      ) as any;
+    });
+  }
+
   public static async expand(items: LineItem[], deep: boolean = true): Promise<(LineItem & { price: TPrice })[]> {
     const priceIds: string[] = items.map((i) => i.price_id);
     const prices = await Price.findAll({
@@ -237,6 +259,19 @@ export class Price extends Model<InferAttributes<Price>, InferCreationAttributes
       include: deep ? [{ model: sequelize.models.Product, as: 'product' }] : [],
     });
 
+    prices.forEach((x) => {
+      if (!x.currency_options || x.currency_options?.length === 0) {
+        x.currency_options = [
+          {
+            currency_id: x.currency_id,
+            unit_amount: x.unit_amount,
+            tiers: null,
+            custom_unit_amount: null,
+          },
+        ];
+      }
+    });
+
     return items.map((x) => ({
       ...x,
       price: prices.find((p) => p.id === x.price_id),

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

@@ -9,7 +9,6 @@ const nextId = createIdGenerator('prod', 14);
 
 export type ProductFeature = { name: string };
 
-// FIXME: default_price_id is not implemented
 // @link https://stripe.com/docs/api/products
 export class Product extends Model<InferAttributes<Product>, InferCreationAttributes<Product>> {
   // Unique identifier for the object.
@@ -52,9 +51,7 @@ export class Product extends Model<InferAttributes<Product>, InferCreationAttrib
   // declare shippable?: boolean;
 
   declare created_at: CreationOptional<Date>;
-
   declare created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
-
   declare updated_at: CreationOptional<Date>;
 
   public static readonly GENESIS_ATTRIBUTES = {

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

@@ -5,10 +5,11 @@ import type { LiteralUnion } from 'type-fest';
 
 import { createEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
-import type { PaymentSettings, PriceRecurring } from './types';
+import type { PaymentDetails, PaymentSettings, PriceRecurring } from './types';
 
 const nextId = createIdGenerator('sub', 24);
 
+// FIXME: subscription settings https://dashboard.stripe.com/settings/billing/automatic
 // eslint-disable-next-line prettier/prettier
 export class Subscription extends Model<InferAttributes<Subscription>, InferCreationAttributes<Subscription>> {
   declare id: CreationOptional<string>;
@@ -97,10 +98,7 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
   };
 
   // 3rd party payment tx hash
-  declare payment_details?: {
-    tx_hash?: string;
-    payer?: string;
-  };
+  declare payment_details?: PaymentDetails;
 
   // TODO: following fields not supported
   // application