payment-kit 1.13.15

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

@@ -0,0 +1,185 @@
+/* eslint-disable @typescript-eslint/indent */
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+
+import { createIdGenerator } from '../../libs/util';
+import type { DiscountAmount } from './types';
+
+const nextId = createIdGenerator('ii', 24);
+
+export type InvoiceLineItem = {
+  id: string;
+};
+
+// @link https://stripe.com/docs/api/invoiceitems
+// eslint-disable-next-line prettier/prettier
+export class InvoiceItem extends Model<InferAttributes<InvoiceItem>, InferCreationAttributes<InvoiceItem>> {
+  declare id: CreationOptional<string>;
+  declare livemode: boolean;
+
+  declare amount: string;
+  declare quantity: number;
+  declare description: string;
+  declare period?: {
+    start: number;
+    end: number;
+  };
+
+  declare currency_id: string;
+  declare customer_id: string;
+  declare price_id: string;
+  declare invoice_id: string;
+  declare subscription_id?: string;
+  declare subscription_item_id?: string;
+  declare test_clock_id?: string;
+
+  declare discountable: boolean;
+  declare discount_amounts: DiscountAmount[];
+  declare discounts: string[];
+
+  declare proration: boolean;
+  declare proration_details: any;
+
+  declare metadata: Record<string, any>;
+
+  // TODO: following fields not supported
+  // tax_amounts: any;
+  // tax_rates: any;
+  // unit_amount_excluding_tax: string;
+
+  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,
+    },
+    quantity: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    description: {
+      type: DataTypes.STRING(256),
+      allowNull: false,
+    },
+    period: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    customer_id: {
+      type: DataTypes.STRING(18),
+      allowNull: false,
+    },
+    currency_id: {
+      type: DataTypes.STRING(15),
+      allowNull: false,
+    },
+    price_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    invoice_id: {
+      type: DataTypes.STRING(30),
+      allowNull: false,
+    },
+    subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    subscription_item_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    discountable: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    // Dynamically generated?
+    discount_amounts: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    discounts: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    proration: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    proration_details: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    metadata: {
+      type: DataTypes.JSON,
+      defaultValue: {},
+    },
+    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(InvoiceItem.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'InvoiceItem',
+      tableName: 'invoice_items',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static associate(models: any) {
+    this.hasOne(models.PaymentCurrency, {
+      sourceKey: 'currency_id',
+      foreignKey: 'id',
+      as: 'currency',
+    });
+    this.hasOne(models.Customer, {
+      sourceKey: 'customer_id',
+      foreignKey: 'id',
+      as: 'customer',
+    });
+    this.hasOne(models.Price, {
+      sourceKey: 'price_id',
+      foreignKey: 'id',
+      as: 'price',
+    });
+    this.hasOne(models.Invoice, {
+      sourceKey: 'invoice_id',
+      foreignKey: 'id',
+      as: 'invoice',
+    });
+    this.hasOne(models.Subscription, {
+      sourceKey: 'subscription_id',
+      foreignKey: 'id',
+      as: 'subscription',
+    });
+    this.hasOne(models.SubscriptionItem, {
+      sourceKey: 'subscription_item_id',
+      foreignKey: 'id',
+      as: 'subscriptionItem',
+    });
+  }
+}
+
+export type TInvoiceItem = InferAttributes<InvoiceItem>;

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

@@ -0,0 +1,492 @@
+/* eslint-disable @typescript-eslint/indent */
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+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 {
+  CustomerAddress,
+  CustomerShipping,
+  DiscountAmount,
+  PaymentError,
+  PaymentSettings,
+  SimpleCustomField,
+} from './types';
+
+const nextId = createIdGenerator('in', 24);
+
+// eslint-disable-next-line prettier/prettier
+export class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttributes<Invoice>> {
+  declare id: CreationOptional<string>;
+
+  // A unique, identifying string that appears on emails sent to the customer for this invoice
+  declare number: string;
+
+  declare livemode: boolean;
+  declare description?: string;
+  declare statement_descriptor: string;
+  declare period_end: number;
+  declare period_start: number;
+
+  declare auto_advance: boolean;
+  // Whether payment was successfully collected for this invoice
+  declare paid: boolean;
+  // Returns true if the invoice was manually marked paid
+  declare paid_out_of_band: boolean;
+
+  declare status: LiteralUnion<'draft' | 'open' | 'void' | 'paid' | 'uncollectible', string>;
+  declare collection_method: LiteralUnion<'charge_automatically' | 'send_invoice', string>;
+  declare billing_reason: LiteralUnion<
+    | 'subscription_create'
+    | 'subscription_cycle'
+    | 'subscription_update'
+    | 'subscription_threshold'
+    | 'subscription'
+    | 'manual'
+    | 'upcoming',
+    string
+  >;
+
+  declare currency_id: string;
+  declare customer_id: string;
+  declare payment_intent_id?: string;
+  declare subscription_id?: string;
+  declare checkout_session_id?: string;
+  declare quote_id?: string;
+  declare charge_id?: string;
+
+  declare subscription_details?: any;
+  declare subscription_proration_date?: number;
+
+  declare subtotal: string;
+  declare subtotal_excluding_tax: string;
+  declare tax: string;
+  declare total: string;
+  declare amount_due: string;
+  declare amount_paid: string;
+  declare amount_remaining: string;
+  declare amount_shipping: string;
+
+  declare ending_balance: string;
+  declare starting_balance: string;
+
+  declare attempt_count: number;
+  declare attempted: boolean;
+  declare next_payment_attempt?: number;
+
+  declare custom_fields?: SimpleCustomField[];
+  declare customer_address?: CustomerAddress;
+  declare customer_email?: string;
+  declare customer_name?: string;
+  declare customer_phone?: string;
+  declare customer_shipping?: CustomerShipping;
+
+  declare discounts?: string[];
+  declare total_discount_amounts?: DiscountAmount[];
+
+  declare due_date?: number;
+  declare effective_at?: number;
+
+  declare footer?: string;
+
+  declare from_invoice?: any;
+
+  declare account_country?: string;
+  declare account_name?: string;
+  declare hosted_invoice_url?: string;
+
+  // The link to download the PDF for the invoice
+  declare invoice_pdf?: string;
+  declare last_finalization_error?: PaymentError;
+  declare latest_revision?: string;
+
+  declare payment_settings?: PaymentSettings;
+  declare default_payment_method_id: string;
+
+  declare post_payment_credit_notes_amount?: string;
+  declare pre_payment_credit_notes_amount?: string;
+
+  declare rendering_options?: any;
+
+  declare status_transitions?: {
+    finalized_at?: number;
+    marked_uncollectible_at?: number;
+    paid_at?: number;
+    voided_at?: number;
+  };
+
+  declare test_clock_id?: string;
+
+  declare threshold_reason?: any;
+
+  declare webhooks_delivered_at?: number;
+
+  // This is the transaction number that appears on email receipts sent for this invoice.
+  declare receipt_number?: string;
+
+  declare metadata?: Record<string, any>;
+
+  // TODO: following fields not supported
+  // account_tax_ids
+  // application
+  // application_fee_amount
+  // automatic_tax
+  // customer_tax_exempt
+  // customer_tax_ids
+  // default_tax_rates
+  // on_behalf_of
+  // shipping_cost
+  // shipping_details
+  // total_tax_amounts
+  // transfer_data
+
+  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,
+    },
+    auto_advance: {
+      type: DataTypes.BOOLEAN,
+      allowNull: false,
+    },
+    account_country: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    account_name: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    charge_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    collection_method: {
+      type: DataTypes.ENUM('charge_automatically', 'send_invoice'),
+    },
+    currency_id: {
+      type: DataTypes.STRING(15),
+      allowNull: false,
+    },
+    customer_id: {
+      type: DataTypes.STRING(18),
+      allowNull: false,
+    },
+    description: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    hosted_invoice_url: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    payment_intent_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    period_end: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    period_start: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    status: {
+      type: DataTypes.ENUM('draft', 'open', 'void', 'paid', 'uncollectible'),
+    },
+    checkout_session_id: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    subscription_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    subscription_details: {
+      type: DataTypes.JSON,
+      defaultValue: {},
+    },
+    subscription_proration_date: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    total: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    subtotal: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    subtotal_excluding_tax: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    tax: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    amount_due: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    amount_paid: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    amount_remaining: {
+      type: DataTypes.STRING(32),
+      allowNull: false,
+    },
+    amount_shipping: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    attempt_count: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    attempted: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    next_payment_attempt: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    billing_reason: {
+      type: DataTypes.ENUM(
+        'subscription_create',
+        'subscription_cycle',
+        'subscription_update',
+        'subscription_threshold',
+        'subscription',
+        'manual',
+        'upcoming'
+      ),
+    },
+    custom_fields: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    customer_address: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    customer_name: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    customer_email: {
+      type: DataTypes.STRING(128),
+      allowNull: true,
+    },
+    customer_phone: {
+      type: DataTypes.STRING(32),
+      allowNull: true,
+    },
+    customer_shipping: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    default_payment_method_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    discounts: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    due_date: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    effective_at: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+    },
+    ending_balance: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    footer: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    from_invoice_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    invoice_pdf: {
+      type: DataTypes.STRING(512),
+      allowNull: true,
+    },
+    last_finalization_error: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    latest_revision: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    number: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    paid: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    paid_out_of_band: {
+      type: DataTypes.BOOLEAN,
+      defaultValue: false,
+    },
+    payment_settings: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    post_payment_credit_notes_amount: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    pre_payment_credit_notes_amount: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    quote_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    receipt_number: {
+      type: DataTypes.STRING(64),
+      allowNull: true,
+    },
+    days_until_due: {
+      type: DataTypes.NUMBER,
+      allowNull: true,
+    },
+    rendering_options: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    starting_balance: {
+      type: DataTypes.STRING(32),
+      defaultValue: '0',
+    },
+    statement_descriptor: {
+      type: DataTypes.STRING(64),
+      allowNull: false,
+    },
+    status_transitions: {
+      type: DataTypes.JSON,
+      defaultValue: {},
+    },
+    test_clock_id: {
+      type: DataTypes.STRING(30),
+      allowNull: true,
+    },
+    threshold_reason: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
+    total_discount_amounts: {
+      type: DataTypes.JSON,
+      defaultValue: [],
+    },
+    webhooks_delivered_at: {
+      type: DataTypes.INTEGER,
+      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(Invoice.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Invoice',
+      tableName: 'invoices',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+      hooks: {
+        afterCreate: (model: Invoice, options) =>
+          createEvent('Invoice', 'invoice.created', model, options).catch(console.error),
+        afterUpdate: (model: Invoice, options) => {
+          createEvent('Invoice', 'invoice.updated', model, options).catch(console.error);
+          createStatusEvent(
+            'Invoice',
+            'invoice',
+            { open: 'finalized', void: 'voided', paid: 'paid', uncollectible: 'marked_uncollectible' },
+            model,
+            options
+          ).catch(console.error);
+        },
+        afterDestroy: (model: Invoice, options) =>
+          createEvent('Invoice', 'invoice.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: 'default_payment_method_id',
+      foreignKey: 'id',
+      as: 'paymentMethod',
+    });
+    this.hasOne(models.Customer, {
+      sourceKey: 'customer_id',
+      foreignKey: 'id',
+      as: 'customer',
+    });
+    this.hasOne(models.PaymentIntent, {
+      sourceKey: 'payment_intent_id',
+      foreignKey: 'id',
+      as: 'paymentIntent',
+    });
+    this.hasOne(models.Subscription, {
+      sourceKey: 'subscription_id',
+      foreignKey: 'id',
+      as: 'subscription',
+    });
+    this.hasOne(models.SubscriptionItem, {
+      sourceKey: 'id',
+      foreignKey: 'subscription_id',
+      as: 'subscriptionItem',
+    });
+    this.hasMany(models.InvoiceItem, {
+      sourceKey: 'id',
+      foreignKey: 'invoice_id',
+      as: 'lines',
+    });
+  }
+}
+
+export type TInvoice = InferAttributes<Invoice>;