payment-kit 1.13.15

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

@@ -0,0 +1,199 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import padStart from 'lodash/padStart';
+import {
+  CreationOptional,
+  DataTypes,
+  FindOptions,
+  InferAttributes,
+  InferCreationAttributes,
+  Model,
+  Op,
+} from 'sequelize';
+
+import { createEvent } from '../../libs/audit';
+import { createIdGenerator } from '../../libs/util';
+import type { CustomerAddress, CustomerShipping } from './types';
+
+const nextId = createIdGenerator('cus', 14);
+
+// eslint-disable-next-line prettier/prettier
+export class Customer extends Model<InferAttributes<Customer>, InferCreationAttributes<Customer>> {
+  declare id: CreationOptional<string>;
+  declare livemode: boolean;
+
+  declare did: string;
+  declare description: string;
+  declare name: string;
+  declare email: string;
+  declare phone: string;
+
+  declare address?: CustomerAddress;
+  declare shipping?: CustomerShipping;
+
+  declare balance?: string;
+  declare currency_id?: string;
+  declare delinquent: boolean;
+  declare discount_id?: string;
+
+  declare metadata: Record<string, any>;
+
+  declare invoice_credit_balance?: any;
+  declare invoice_prefix?: string;
+  declare invoice_settings?: {
+    custom_fields?: {
+      name: string;
+      value: string;
+    }[];
+    default_payment_method?: string;
+    footer?: string;
+  };
+  declare next_invoice_sequence?: number;
+
+  // TODO: following fields not supported
+  // declare preferred_locales?: string[];
+  // declare tax_exempt?: LiteralUnion<'exempt' | 'none' | 'reverse', string>;
+  // declare tax_ids?: any;
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(18),
+      primaryKey: true,
+      allowNull: false,
+      defaultValue: nextId,
+    },
+    livemode: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    did: {
+      type: DataTypes.STRING(40),
+      allowNull: false,
+    },
+    address: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    description: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    name: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    email: {
+      type: DataTypes.STRING(128),
+      allowNull: true,
+    },
+    phone: {
+      type: DataTypes.STRING(32),
+      allowNull: true,
+    },
+    shipping: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    balance: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    currency_id: {
+      type: DataTypes.STRING(15),
+      allowNull: true,
+    },
+    delinquent: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    discount_id: {
+      type: DataTypes.STRING(32),
+      allowNull: true,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    invoice_credit_balance: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    invoice_prefix: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    invoice_settings: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    next_invoice_sequence: {
+      type: DataTypes.NUMBER,
+      defaultValue: 1,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  public async getInvoiceNumber() {
+    const sequence = this.next_invoice_sequence || 1;
+    await this.increment('next_invoice_sequence', { by: 1 });
+    return `${this.invoice_prefix}-${padStart(sequence.toString(), 4, '0')}`;
+  }
+
+  public static initialize(sequelize: any) {
+    this.init(Customer.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Customer',
+      tableName: 'customers',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+      hooks: {
+        afterCreate: (model: Customer, options) =>
+          createEvent('Customer', 'customer.created', model, options).catch(console.error),
+        afterUpdate: (model: Customer, options) =>
+          createEvent('Customer', 'customer.updated', model, options).catch(console.error),
+        afterDestroy: (model: Customer, options) =>
+          createEvent('Customer', 'customer.deleted', model, options).catch(console.error),
+      },
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'currency',
+    });
+    this.hasMany(models.PaymentIntent, {
+      foreignKey: 'customer_id',
+      as: 'payments',
+    });
+    this.hasMany(models.Subscription, {
+      foreignKey: 'customer_id',
+      as: 'subscriptions',
+    });
+    this.hasMany(models.Invoice, {
+      foreignKey: 'customer_id',
+      as: 'invoices',
+    });
+  }
+
+  public static findByPkOrDid(id: string, options: FindOptions<Customer> = {}) {
+    return this.findOne({
+      where: { [Op.or]: [{ id }, { did: id }] },
+      ...options,
+    });
+  }
+}
+
+export type TCustomer = InferAttributes<Customer>;

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

@@ -0,0 +1,116 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+
+import { createCodeGenerator } from '../../libs/util';
+
+const nextId = createCodeGenerator('', 8);
+
+// @link https://stripe.com/docs/api/discounts
+// eslint-disable-next-line prettier/prettier
+export class Discount extends Model<InferAttributes<Discount>, InferCreationAttributes<Discount>> {
+  declare id: CreationOptional<string>;
+  declare livemode: boolean;
+
+  declare coupon_id: string;
+  declare promotion_code_id?: string;
+  declare customer_id: string;
+  declare subscription_id?: string;
+  declare checkout_session_id?: string;
+  declare invoice_id?: string;
+  declare invoice_item_id?: string;
+
+  declare start: number;
+  declare end: number;
+
+  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,
+    },
+    coupon_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    customer_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    promotion_code_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    checkout_session_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    invoice_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    invoice_item_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    start: {
+      type: DataTypes.DATE,
+      allowNull: false,
+    },
+    end: {
+      type: DataTypes.DATE,
+      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(Discount.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Discount',
+      tableName: 'discounts',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  // FIXME:
+  public static associate(models: any) {
+    this.hasOne(models.Customer, {
+      sourceKey: 'customer_id',
+      foreignKey: 'id',
+      as: 'customer',
+    });
+    this.hasOne(models.Coupon, {
+      sourceKey: 'coupon_id',
+      foreignKey: 'id',
+      as: 'coupon',
+    });
+  }
+}
+
+export type TDiscount = InferAttributes<Discount>;

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

@@ -0,0 +1,111 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+
+import { createIdGenerator } from '../../libs/util';
+import type { EventType } from './types';
+
+const nextId = createIdGenerator('evt', 24);
+
+// eslint-disable-next-line prettier/prettier
+export class Event extends Model<InferAttributes<Event>, InferCreationAttributes<Event>> {
+  declare id: CreationOptional<string>;
+
+  declare livemode: boolean;
+
+  declare type: EventType;
+  declare api_version: string;
+
+  declare data: Record<string, any>;
+
+  // the object that this event belongs to
+  declare object_type: string;
+  declare object_id: string;
+
+  declare request: {
+    id: string;
+    idempotency_key: string;
+  };
+
+  // Number of webhooks that have yet to be successfully delivered
+  declare pending_webhooks: number;
+
+  declare metadata: Record<string, any>;
+
+  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,
+    },
+    type: {
+      type: DataTypes.STRING(64),
+      allowNull: false,
+    },
+    api_version: {
+      type: DataTypes.STRING(16),
+      allowNull: false,
+    },
+    object_type: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    object_id: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    data: {
+      type: DataTypes.JSON,
+      allowNull: false,
+    },
+    request: {
+      type: DataTypes.JSON,
+      allowNull: false,
+    },
+    pending_webhooks: {
+      type: DataTypes.NUMBER,
+      allowNull: 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(Event.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Event',
+      tableName: 'events',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasMany(models.WebhookAttempt, {
+      sourceKey: 'id',
+      foreignKey: 'event_id',
+      as: 'webhookAttempts',
+    });
+  }
+}
+
+export type TEvent = InferAttributes<Event>;

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

@@ -0,0 +1,165 @@
+import { CheckoutSession, TCheckoutSession } from './checkout-session';
+import { Coupon } from './coupon';
+import { Customer, TCustomer } from './customer';
+import { Discount } from './discount';
+import { Event, TEvent } from './event';
+import { Invoice, TInvoice } from './invoice';
+import { InvoiceItem, TInvoiceItem } from './invoice-item';
+import { Job } from './job';
+import { PaymentCurrency, TPaymentCurrency } from './payment-currency';
+import { PaymentIntent, TPaymentIntent } from './payment-intent';
+import { PaymentLink, TPaymentLink } from './payment-link';
+import { PaymentMethod, TPaymentMethod } from './payment-method';
+import { Price, TPrice } from './price';
+import { Product, TProduct } from './product';
+import { PromotionCode } from './promotion-code';
+import { SetupIntent, TSetupIntent } from './setup-intent';
+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 { TWebhookAttempt, WebhookAttempt } from './webhook-attempt';
+import { TWebhookEndpoint, WebhookEndpoint } from './webhook-endpoint';
+
+const models = {
+  CheckoutSession,
+  Coupon,
+  Customer,
+  Discount,
+  Event,
+  Invoice,
+  InvoiceItem,
+  PaymentCurrency,
+  PaymentIntent,
+  PaymentLink,
+  PaymentMethod,
+  Price,
+  Product,
+  PromotionCode,
+  SetupIntent,
+  Subscription,
+  SubscriptionItem,
+  SubscriptionSchedule,
+  UsageRecord,
+  WebhookEndpoint,
+  WebhookAttempt,
+  Job,
+};
+
+export function initialize(sequelize: any) {
+  Object.values(models).forEach((model) => {
+    model.initialize(sequelize);
+  });
+  Object.values(models).forEach((model) => {
+    model.associate(models);
+  });
+}
+
+export default models;
+
+export * from './checkout-session';
+export * from './coupon';
+export * from './customer';
+export * from './discount';
+export * from './event';
+export * from './invoice';
+export * from './invoice-item';
+export * from './job';
+export * from './payment-currency';
+export * from './payment-intent';
+export * from './payment-link';
+export * from './payment-method';
+export * from './price';
+export * from './product';
+export * from './promotion-code';
+export * from './subscription';
+export * from './subscription-item';
+export * from './subscription-schedule';
+export * from './usage-record';
+export * from './webhook-attempt';
+export * from './webhook-endpoint';
+export * from './types';
+
+export type TPriceExpanded = TPrice & { product: TProduct; currency: TPaymentCurrency };
+
+export type TLineItemExpanded = LineItem & { price: TPriceExpanded };
+
+export type TProductExpanded = TProduct & { prices: TPrice[]; default_price: TPrice };
+
+export type TPaymentLinkExpanded = TPaymentLink & { line_items: TLineItemExpanded[] };
+
+export type TPaymentMethodExpanded = TPaymentMethod & { payment_currencies: TPaymentCurrency[] };
+
+export type TCheckoutSessionExpanded = TCheckoutSession & {
+  line_items: TLineItemExpanded[];
+  payment_link?: TPaymentLink;
+  payment_intent?: TPaymentIntent;
+  subscription?: TSubscription;
+  currency: TPaymentCurrency;
+};
+
+export type TPaymentIntentExpanded = TPaymentIntent & {
+  customer: TCustomer;
+  paymentCurrency: TPaymentCurrency;
+  paymentMethod: TPaymentMethod;
+  checkoutSession?: TCheckoutSession;
+  subscription?: TSubscription;
+  invoice?: TInvoice;
+};
+
+export type TSubscriptionExpanded = TSubscription & {
+  customer: TCustomer;
+  paymentCurrency: TPaymentCurrency;
+  paymentMethod: TPaymentMethod;
+  items: TSubscriptionItemExpanded[];
+};
+
+export type TSubscriptionItemExpanded = TSubscriptionItem & {
+  price: TPriceExpanded;
+};
+
+export type TCustomerExpanded = TCustomer & {
+  payments: TPaymentIntent[];
+  subscriptions: TSubscription[];
+  invoices: TInvoice[];
+};
+
+export type TInvoiceExpanded = TInvoice & {
+  customer: TCustomer;
+  paymentCurrency: TPaymentCurrency;
+  paymentMethod: TPaymentMethod;
+  paymentIntent: TPaymentIntent;
+  subscription?: TSubscription;
+  lines: TInvoiceItemExpanded[];
+};
+
+export type TInvoiceItemExpanded = TInvoiceItem & {
+  price: TPriceExpanded;
+};
+
+export type TEventExpanded = TEvent & {
+  webhooks: TWebhookEndpointExpanded[];
+};
+
+export type TWebhookAttemptExpanded = TWebhookAttempt & {
+  event: TEvent;
+  endpoint: TWebhookEndpoint;
+};
+
+export type TWebhookEndpointExpanded = TWebhookEndpoint & {
+  attempts: TWebhookAttemptExpanded[];
+};
+
+export type TUsageRecordSummary = {
+  livemode: boolean;
+  invoice_id: string;
+  subscription_item_id: string;
+  total_usage: number;
+  period: {
+    start: number;
+    end: number;
+  };
+};
+
+export type TSetupIntentExpanded = TSetupIntent & {};