payment-kit 1.13.15

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

@@ -0,0 +1,75 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+
+// eslint-disable-next-line prettier/prettier
+export class Job extends Model<InferAttributes<Job>, InferCreationAttributes<Job>> {
+  declare id: CreationOptional<string>;
+
+  declare queue: string;
+  declare job: any;
+  declare retry_count: number;
+  declare delay?: number;
+  declare will_run_at?: number;
+  declare cancelled?: boolean;
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(30),
+      primaryKey: true,
+      allowNull: false,
+    },
+    queue: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    job: {
+      type: DataTypes.JSON,
+      allowNull: false,
+    },
+    retry_count: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    delay: {
+      type: DataTypes.INTEGER,
+      defaultValue: -1,
+    },
+    will_run_at: {
+      type: DataTypes.INTEGER,
+      defaultValue: -1,
+    },
+    cancelled: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    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(Job.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Job',
+      tableName: 'jobs',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate() {
+    // Do nothing
+  }
+}
+
+export type TJob = InferAttributes<Job>;

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

@@ -0,0 +1,139 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import {
+  CreationOptional,
+  DataTypes,
+  FindOptions,
+  InferAttributes,
+  InferCreationAttributes,
+  Model,
+  Op,
+} from 'sequelize';
+
+import { createIdGenerator } from '../../libs/util';
+
+const nextId = createIdGenerator('pc', 12);
+
+// eslint-disable-next-line prettier/prettier
+export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, InferCreationAttributes<PaymentCurrency>> {
+  // Unique identifier for the object.
+  declare id: CreationOptional<string>;
+  declare payment_method_id: string;
+
+  declare active: boolean;
+  declare livemode: boolean;
+  declare locked: boolean;
+  declare is_base_currency: boolean;
+
+  declare name: string;
+  declare description: string;
+  declare logo: string;
+  declare symbol: string;
+  declare decimal: number;
+
+  declare minimum_payment_amount: string;
+  declare maximum_payment_amount: string;
+
+  // Contract address to interact with
+  declare contract?: string;
+  declare metadata: Record<string, any>;
+
+  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,
+    },
+    active: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    locked: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    is_base_currency: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    payment_method_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    name: {
+      type: DataTypes.STRING(64),
+      allowNull: false,
+    },
+    description: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    logo: {
+      type: DataTypes.STRING(512),
+      allowNull: false,
+    },
+    symbol: {
+      type: DataTypes.STRING(16),
+      allowNull: false,
+      unique: true,
+    },
+    decimal: {
+      type: DataTypes.NUMBER,
+      defaultValue: 2,
+    },
+    minimum_payment_amount: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    maximum_payment_amount: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    contract: {
+      type: DataTypes.STRING(256),
+      allowNull: true,
+    },
+    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(PaymentCurrency.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'PaymentCurrency',
+      tableName: 'payment_currencies',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate() {}
+
+  public static findByPkOrSymbol(id: string, options: FindOptions<PaymentCurrency> = {}) {
+    return this.findOne({
+      where: { [Op.or]: [{ id }, { symbol: id }] },
+      ...options,
+    });
+  }
+}
+
+export type TPaymentCurrency = InferAttributes<PaymentCurrency>;

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

@@ -0,0 +1,282 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+/* eslint-disable @typescript-eslint/indent */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+
+import { createEvent, createStatusEvent } from '../../libs/audit';
+import { createIdGenerator } from '../../libs/util';
+import type { PaymentError } from './types';
+
+const nextId = createIdGenerator('pi', 24);
+
+// @link https://stripe.com/docs/api/payment_intents
+// eslint-disable-next-line prettier/prettier
+export class PaymentIntent extends Model<InferAttributes<PaymentIntent>, InferCreationAttributes<PaymentIntent>> {
+  // Unique identifier for the object.
+  declare id: CreationOptional<string>;
+
+  declare livemode: boolean;
+  declare description: string;
+
+  declare amount: string;
+  declare amount_received?: string;
+  declare amount_capturable?: string;
+  declare amount_details?: {
+    tip: string;
+  };
+
+  // Payment currency id
+  declare currency_id: string;
+  // ID of the Customer this PaymentIntent belongs to, if one exists
+  declare customer_id?: string;
+  declare payment_method_id: string;
+  declare invoice_id?: string;
+  // The latest charge created by this payment intent.
+  declare last_charge?: string;
+
+  // The payment error encountered in the previous PaymentIntent confirmation
+  declare last_payment_error?: PaymentError;
+
+  declare metadata?: Record<string, any>;
+
+  declare receipt_email?: string;
+
+  declare statement_descriptor: string;
+  declare statement_descriptor_suffix?: string;
+
+  declare status: LiteralUnion<
+    | 'requires_payment_method'
+    | 'requires_confirmation'
+    | 'requires_action'
+    | 'processing'
+    | 'requires_capture'
+    | 'canceled'
+    | 'succeeded',
+    string
+  >;
+
+  declare canceled_at?: number;
+  declare cancellation_reason?: LiteralUnion<
+    | 'abandoned'
+    | 'duplicate'
+    | 'requested_by_customer'
+    | 'fraudulent'
+    | 'failed_invoice'
+    | 'void_invoice'
+    | 'automatic',
+    string
+  >;
+
+  declare capture_method: LiteralUnion<'automatic' | 'manual', string>;
+  declare confirmation_method: LiteralUnion<'automatic' | 'manual', string>;
+
+  declare payment_method_types: string[];
+
+  declare review?: string;
+
+  // 3rd party payment tx hash
+  declare payment_details?: {
+    tx_hash?: string;
+    payer?: string;
+  };
+
+  declare setup_future_usage: LiteralUnion<'off_session' | 'on_session', string>;
+
+  // TODO: following fields not supported yet
+  // automatic_payment_methods
+  // client_secret
+  // next_action
+  // shipping
+  // application
+  // application_fee_amount
+  // on_behalf_of
+  // payment_method_options
+  // processing
+  // transfer_data
+  // transfer_group
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(30),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    amount: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    amount_received: {
+      type: DataTypes.STRING(32),
+      default: '0',
+    },
+    amount_capturable: {
+      type: DataTypes.STRING(32),
+      default: '0',
+    },
+    amount_details: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    currency_id: {
+      type: DataTypes.STRING(16),
+      allowNull: false,
+    },
+    customer_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    description: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    last_payment_error: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    last_charge: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    invoice_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    payment_method_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    receipt_email: {
+      type: DataTypes.STRING(255),
+      allowNull: true,
+    },
+    statement_descriptor: {
+      type: DataTypes.STRING(32),
+      allowNull: true,
+    },
+    statement_descriptor_suffix: {
+      type: DataTypes.STRING(32),
+      allowNull: true,
+    },
+    status: {
+      type: DataTypes.ENUM(
+        'requires_payment_method',
+        'requires_confirmation',
+        'requires_action',
+        'processing',
+        'requires_capture',
+        'canceled',
+        'succeeded'
+      ),
+      allowNull: false,
+    },
+    canceled_at: {
+      type: DataTypes.DATE,
+      allowNull: true,
+    },
+    cancellation_reason: {
+      type: DataTypes.ENUM(
+        'abandoned',
+        'duplicate',
+        'requested_by_customer',
+        'fraudulent',
+        'failed_invoice',
+        'void_invoice',
+        'automatic'
+      ),
+      allowNull: true,
+    },
+    capture_method: {
+      type: DataTypes.ENUM('automatic', 'manual'),
+    },
+    confirmation_method: {
+      type: DataTypes.ENUM('automatic', 'manual'),
+    },
+    payment_method_types: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    review: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    payment_details: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    setup_future_usage: {
+      type: DataTypes.ENUM('on_session', 'off_session'),
+      allowNull: false,
+    },
+    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(PaymentIntent.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'PaymentIntent',
+      tableName: 'payment_intents',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+      hooks: {
+        afterCreate: (model: PaymentIntent, options) =>
+          createEvent('PaymentIntent', 'payment_intent.created', model, options).catch(console.error),
+        afterUpdate: (model: PaymentIntent, options) =>
+          createStatusEvent(
+            'PaymentIntent',
+            'payment_intent',
+            {
+              requires_action: 'requires_action',
+              processing: 'processing',
+              canceled: 'canceled',
+              succeeded: 'succeeded',
+            },
+            model,
+            options
+          ),
+        afterDestroy: (model: PaymentIntent, options) =>
+          createEvent('PaymentIntent', 'payment_intent.deleted', model, options).catch(console.error),
+      },
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'paymentCurrency',
+    });
+    this.hasOne(models.PaymentMethod, {
+      sourceKey: 'payment_method_id',
+      foreignKey: 'id',
+      as: 'paymentMethod',
+    });
+    this.hasOne(models.Customer, {
+      sourceKey: 'customer_id',
+      foreignKey: 'id',
+      as: 'customer',
+    });
+  }
+}
+
+export type TPaymentIntent = InferAttributes<PaymentIntent>;

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

@@ -0,0 +1,219 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+
+import { createEvent } from '../../libs/audit';
+import { createIdGenerator } from '../../libs/util';
+import type { AfterPayment, CustomField, LineItem } from './types';
+
+const nextId = createIdGenerator('plink', 24);
+
+// @link https://stripe.com/docs/api/payment_links/payment_links
+export class PaymentLink extends Model<InferAttributes<PaymentLink>, InferCreationAttributes<PaymentLink>> {
+  // Unique identifier for the object.
+  declare id: CreationOptional<string>;
+
+  // Whether the PaymentLink is currently available for purchase.
+  declare active: boolean;
+  declare livemode: boolean;
+
+  declare name: string;
+
+  // The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
+  declare line_items: LineItem[];
+
+  // Payment currency id
+  declare currency_id: string;
+
+  // The specified behavior after the purchase is complete.
+  declare after_completion?: AfterPayment;
+
+  // Enables user redeemable promotion codes.
+  declare allow_promotion_codes: boolean;
+
+  declare consent_collection?: {
+    promotions?: LiteralUnion<'auto' | 'none', string>;
+    terms_of_service?: LiteralUnion<'required' | 'none', string>;
+  };
+
+  // Collect additional information from your customer using custom fields. Up to 2 fields are supported.
+  declare custom_fields: CustomField[];
+  declare custom_text?: {
+    shipping_address?: string;
+    submit?: string;
+  };
+
+  declare customer_creation: LiteralUnion<'if_required' | 'always', string>;
+
+  // Generate a post-purchase Invoice for one-time payments.
+  declare invoice_creation?: {
+    enabled: boolean;
+    invoice_data?: any;
+  };
+
+  // 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;
+  };
+
+  // Configuration for collecting the customer’s billing address.
+  declare billing_address_collection?: LiteralUnion<'auto' | 'required', string>;
+
+  // Describes the type of transaction being performed in order to customize relevant text
+  declare submit_type: LiteralUnion<'auto' | 'book' | 'donate' | 'pay', string>;
+
+  // When creating a subscription, the specified configuration data will be used.
+  declare subscription_data?: {
+    description: string;
+    trial_period_days: number;
+  };
+
+  declare metadata?: Record<string, any>;
+
+  // TODO: following fields not supported
+  // application_fee_amount
+  // application_fee_percent
+  // transfer_data
+  // automatic_tax
+  // tax_id_collection
+  // consent_collection
+  // on_behalf_of
+  // payment_intent_data
+  // payment_method_collection
+  // shipping_address_collection
+  // 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(30),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    active: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    line_items: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    name: {
+      type: DataTypes.STRING(255),
+      allowNull: true,
+    },
+    currency_id: {
+      type: DataTypes.STRING(16),
+      allowNull: true,
+    },
+    after_completion: {
+      type: DataTypes.JSON,
+      defaultValue: {
+        type: 'hosted_confirmation',
+      },
+    },
+    allow_promotion_codes: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    consent_collection: {
+      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,
+    },
+    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,
+    },
+    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(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),
+      },
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'currency',
+    });
+  }
+}
+
+export type TPaymentLink = InferAttributes<PaymentLink>;