payment-kit 1.13.15

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

@@ -0,0 +1,145 @@
+import { fromTokenToUnit } from '@ocap/util';
+import Sequelize from 'sequelize';
+
+import { createIdGenerator } from '../../libs/util';
+import type { Migration } from '../migrate';
+
+const genPaymentMethodId = createIdGenerator('pm', 24);
+const genPaymentCurrencyId = createIdGenerator('pc', 12);
+
+const abtId = genPaymentCurrencyId();
+const tbaId = genPaymentCurrencyId();
+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 paymentCurrencies = [
+  {
+    id: abtId,
+    active: true,
+    livemode: true,
+    locked: true,
+    is_base_currency: true,
+    payment_method_id: mainId,
+    name: 'Native ABT',
+    description: 'ABT on ArcBlock main chain',
+    logo,
+    symbol: 'ABT',
+    decimal: 18,
+    minimum_payment_amount: fromTokenToUnit(0.1, 18).toString(), // 0.1 token
+    maximum_payment_amount: fromTokenToUnit(100000000, 18).toString(), // 0.1 billion
+    contract: 'z35nNRvYxBoHitx9yZ5ATS88psfShzPPBLxYD',
+    metadata: {},
+    created_at: now,
+    updated_at: now,
+  },
+  {
+    id: tbaId,
+    active: true,
+    livemode: false,
+    locked: true,
+    is_base_currency: true,
+    payment_method_id: betaId,
+    name: 'Test ABT',
+    description: 'ABT on ArcBlock beta chain',
+    logo,
+    symbol: 'TBA',
+    decimal: 18,
+    minimum_payment_amount: fromTokenToUnit(0.1, 18).toString(), // 0.1 token
+    maximum_payment_amount: fromTokenToUnit(100000000, 18).toString(), // 0.1 billion
+    contract: 'z35n6UoHSi9MED4uaQy6ozFgKPaZj2UKrurBG',
+    metadata: {},
+    created_at: now,
+    updated_at: now,
+  },
+];
+
+const paymentMethods = [
+  {
+    id: mainId,
+    active: true,
+    livemode: true,
+    locked: true,
+    type: 'arcblock',
+    name: 'ArcBlock Main',
+    description: 'Process payments with tokens on ArcBlock main chain',
+    logo,
+    default_currency_id: abtId,
+    confirmation: {
+      type: 'immediate',
+    },
+    settings: {
+      arcblock: {
+        chain_id: 'main',
+        api_host: 'https://main.abtnetwork.io/api/',
+        explorer_host: 'https://main.abtnetwork.io/explorer/',
+      },
+    },
+    features: {
+      recurring: true,
+      refund: true,
+      dispute: true,
+    },
+    metadata: {},
+    created_at: now,
+    updated_at: now,
+  },
+  {
+    id: betaId,
+    active: true,
+    livemode: false,
+    locked: true,
+    type: 'arcblock',
+    name: 'ArcBlock Beta',
+    description: 'Process payments with tokens on ArcBlock beta chain, just for test purpose',
+    logo,
+    default_currency_id: tbaId,
+    confirmation: {
+      type: 'immediate',
+    },
+    settings: {
+      arcblock: {
+        chain_id: 'beta',
+        api_host: 'https://beta.abtnetwork.io/api/',
+        explorer_host: 'https://beta.abtnetwork.io/explorer/',
+      },
+    },
+    features: {
+      recurring: true,
+      refund: true,
+      dispute: true,
+    },
+    metadata: {},
+    created_at: now,
+    updated_at: now,
+  },
+];
+
+export const up: Migration = async ({ context: queryInterface }) => {
+  await queryInterface.bulkInsert(
+    'payment_methods',
+    paymentMethods,
+    {},
+    {
+      confirmation: { type: new Sequelize.JSON() },
+      settings: { type: new Sequelize.JSON() },
+      features: { type: new Sequelize.JSON() },
+      metadata: { type: new Sequelize.JSON() },
+    }
+  );
+  await queryInterface.bulkInsert(
+    'payment_currencies',
+    paymentCurrencies,
+    {},
+    {
+      metadata: { type: new Sequelize.JSON() },
+    }
+  );
+};
+
+export const down: Migration = async ({ context: queryInterface }) => {
+  await queryInterface.bulkDelete('payment_methods', {});
+  await queryInterface.bulkDelete('payment_currencies', {});
+};

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

@@ -0,0 +1,395 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+/* eslint-disable @typescript-eslint/indent */
+import {
+  CreationOptional,
+  DataTypes,
+  FindOptions,
+  InferAttributes,
+  InferCreationAttributes,
+  Model,
+  Op,
+} from 'sequelize';
+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';
+
+const nextId = createIdGenerator('cs', 58);
+
+// @link https://stripe.com/docs/api/checkout/sessions
+// eslint-disable-next-line prettier/prettier
+export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, InferCreationAttributes<CheckoutSession>> {
+  // Unique identifier for the object.
+  declare id: CreationOptional<string>;
+  declare livemode: boolean;
+  declare client_reference_id?: string;
+
+  // ID of the payment currency
+  declare currency_id: string;
+
+  // ID of the invoice created by the Checkout Session, if it exists.
+  declare invoice_id?: string;
+
+  // The ID of the Payment Link that created this Session.
+  declare payment_link_id?: string;
+
+  // The ID of the subscription for Checkout Sessions in subscription mode.
+  declare subscription_id?: string;
+
+  // The ID of the original expired Checkout Session that triggered the recovery flow.
+  declare recovered_from?: string;
+
+  // The ID of the PaymentIntent for Checkout Sessions in payment mode.
+  declare payment_intent_id?: string;
+
+  // The ID of the SetupIntent for Checkout Sessions in setup mode.
+  declare setup_intent_id?: string;
+
+  // Pass subscription if the Checkout Session includes at least one recurring item.
+  declare mode: LiteralUnion<'payment' | 'setup' | 'subscription', string>;
+
+  declare status: LiteralUnion<'complete' | 'open' | 'expired', string>;
+  declare payment_status: LiteralUnion<'paid' | 'unpaid' | 'no_payment_required', string>;
+
+  declare line_items: LineItem[];
+
+  // Total of all items before discounts or taxes are applied.
+  declare amount_subtotal: string;
+  // Total of all items after discounts and taxes are applied.
+  declare amount_total: string;
+  // Tax and discount details for the computed total amount.
+  declare total_details?: {
+    amount_discount?: string;
+    amount_shipping?: string;
+    amount_tax?: string;
+    breakdown?: {
+      discounts?: {
+        amount?: string;
+        discount?: string;
+      }[];
+      taxes?: {
+        amount?: string;
+        rate?: string;
+      }[];
+    };
+  };
+
+  declare url?: string;
+  declare cancel_url?: string;
+  declare success_url?: string;
+
+  declare currency_conversion?: CurrencyConversion;
+
+  // customer_email field on creation is stored here?
+  declare customer_details?: CustomerDetail;
+  declare customer_creation: LiteralUnion<'if_required' | 'always', string>;
+  declare customer_update?: {
+    address: LiteralUnion<'auto' | 'never', string>;
+    name: LiteralUnion<'auto' | 'never', string>;
+    shipping: LiteralUnion<'auto' | 'never', string>;
+  };
+
+  // When set, provides configuration for actions to take if this Checkout Session expires
+  declare after_expiration?: {
+    recovery: {
+      enabled: boolean;
+      allow_promotion_codes?: boolean;
+    };
+  };
+
+  declare allow_promotion_codes?: boolean;
+
+  declare consent_collection?: {
+    promotions?: LiteralUnion<'auto' | 'none', string>;
+    terms_of_service?: LiteralUnion<'required' | 'none', string>;
+  };
+  declare consent?: {
+    promotions?: LiteralUnion<'opt_in', string>;
+    terms_of_service?: LiteralUnion<'accepted', string>;
+  };
+
+  declare custom_fields?: CustomField[];
+  declare custom_text?: {
+    shipping_address?: string;
+    submit?: string;
+  };
+
+  // By default, this value is 24 hours from creation.
+  declare expires_at: number;
+
+  // Generate a post-purchase Invoice for one-time payments.
+  declare invoice_creation?: {
+    enabled: boolean;
+    invoice_data?: InvoiceData;
+  };
+
+  // The list of payment method types that customers can use
+  declare payment_method_types?: string[];
+
+  // Controls phone number collection settings during checkout.
+  declare phone_number_collection?: {
+    enabled: boolean;
+  };
+
+  // Describes the type of transaction being performed in order to customize relevant text
+  declare submit_type: LiteralUnion<'auto' | 'book' | 'donate' | 'pay', string>;
+
+  declare metadata?: Record<string, any>;
+
+  // Configuration for collecting the customer’s billing address.
+  declare billing_address_collection?: LiteralUnion<'auto' | 'required', string>;
+
+  // When creating a subscription, the specified configuration data will be used.
+  declare subscription_data?: {
+    description: string;
+    trial_period_days: number;
+    billing_cycle_anchor?: number;
+    metadata?: Record<string, any>;
+    proration_behavior?: LiteralUnion<'create_prorations' | 'none', string>;
+    trial_end?: number;
+    trial_settings?: {
+      end_behavior: {
+        missing_payment_method: LiteralUnion<'cancel' | 'pause' | 'create_invoice', string>;
+      };
+    };
+  };
+
+  // 3rd party payment tx hash
+  declare payment_details?: {
+    tx_hash?: string;
+    payer?: string;
+  };
+
+  // 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
+  // locale --> auto selected
+  // payment_method_collection // FIXME:
+  // payment_method_options
+  // setup_intent_data
+  // shipping_address_collection
+  // shipping_options
+  // tax_id_collection
+  // shipping_cost
+  // shipping_details
+  // shipping_options
+
+  declare created_at: CreationOptional<Date>;
+  declare created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(64),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    client_reference_id: {
+      type: DataTypes.STRING(128),
+      allowNull: true,
+    },
+    currency_id: {
+      type: DataTypes.STRING(15),
+      allowNull: false,
+    },
+    invoice_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    payment_link_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    recovered_from: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    payment_intent_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    mode: {
+      type: DataTypes.ENUM('payment', 'setup', 'subscription'),
+    },
+    status: {
+      type: DataTypes.ENUM('complete', 'open', 'expired'),
+    },
+    payment_status: {
+      type: DataTypes.ENUM('paid', 'unpaid', 'no_payment_required'),
+    },
+    line_items: {
+      type: DataTypes.JSON,
+      allowNull: false,
+    },
+    amount_subtotal: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    amount_total: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    total_details: {
+      type: DataTypes.JSON,
+      allowNull: false,
+    },
+    url: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    cancel_url: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    success_url: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    currency_conversion: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    after_expiration: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    allow_promotion_codes: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    consent_collection: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    consent: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    custom_fields: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    custom_text: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    customer_creation: {
+      type: DataTypes.ENUM('if_required', 'always'),
+      allowNull: false,
+    },
+    customer_update: {
+      type: DataTypes.JSON,
+      defaultValue: {
+        address: 'never',
+        name: 'never',
+        shipping: 'never',
+      },
+    },
+    expires_at: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    invoice_creation: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    payment_method_types: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    phone_number_collection: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    billing_address_collection: {
+      type: DataTypes.ENUM('auto', 'required'),
+      defaultValue: 'auto',
+      allowNull: false,
+    },
+    submit_type: {
+      type: DataTypes.ENUM('auto', 'book', 'donate', 'pay'),
+      allowNull: false,
+    },
+    subscription_data: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    payment_details: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    created_via: {
+      type: DataTypes.ENUM('api', 'dashboard', 'portal'),
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  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);
+        },
+      },
+    });
+  }
+
+  // FIXME:
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'currency',
+    });
+  }
+
+  public static findByPkOrClientRefId(id: string, options: FindOptions<CheckoutSession> = {}) {
+    return this.findOne({
+      where: { [Op.or]: [{ id }, { client_reference_id: id }] },
+      ...options,
+    });
+  }
+}
+
+export type TCheckoutSession = InferAttributes<CheckoutSession>;

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

@@ -0,0 +1,137 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+
+import { createCodeGenerator } from '../../libs/util';
+
+const nextId = createCodeGenerator('', 8);
+
+// eslint-disable-next-line prettier/prettier
+export class Coupon extends Model<InferAttributes<Coupon>, InferCreationAttributes<Coupon>> {
+  declare id: CreationOptional<string>;
+  declare livemode: boolean;
+
+  declare amount_off: string;
+  declare percent_off: number;
+
+  declare currency_id: string;
+
+  declare duration: LiteralUnion<'forever' | 'once' | 'repeating', string>;
+
+  declare duration_in_months: number;
+
+  declare name: string;
+
+  declare metadata: Record<string, any>;
+
+  declare applies_to?: {
+    products: string[];
+  };
+
+  declare currency_options?: Record<string, number>;
+
+  declare max_redemptions?: number;
+
+  declare redeem_by?: Date;
+
+  declare times_redeemed?: number;
+
+  declare valid?: boolean;
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(15),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    amount_off: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    percent_off: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    currency_id: {
+      type: DataTypes.STRING(15),
+      allowNull: false,
+    },
+    duration: {
+      type: DataTypes.ENUM('forever', 'once', 'repeating'),
+    },
+    duration_in_months: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    name: {
+      type: DataTypes.STRING(64),
+      allowNull: false,
+    },
+    applies_to: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    currency_options: {
+      type: DataTypes.JSON,
+      defaultValue: {},
+    },
+    max_redemptions: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    redeem_by: {
+      type: DataTypes.DATE,
+      allowNull: true,
+    },
+    times_redeemed: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    valid: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  public static initialize(sequelize: any) {
+    this.init(Coupon.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Coupon',
+      tableName: 'coupons',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'currency',
+    });
+  }
+}
+
+export type TCoupon = InferAttributes<Coupon>;