invoice.ts

/**
 *  SudoSOS back-end API service.
 *  Copyright (C) 2024  Study association GEWIS
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 *  @license
 */

/**
 * This is the module page of invoicing.
 *
 * ```ts
 * const invoice = await this.manager.findOne(Invoice, {
 *    where: { id: invoiceId }, relations: ['transfer', 'transfer.from',
 *   'invoiceStatus', 'invoiceStatus.changedBy']
 * });
 * ```
 *
 * @module invoicing
 * @mergeTarget
 */

import {
  Column,
  Entity, JoinColumn, ManyToOne, OneToMany, OneToOne, ManyToMany, JoinTable,
} from 'typeorm';
import BaseEntity from '../base-entity';
import User from '../user/user';
import Transfer from '../transactions/transfer';
// eslint-disable-next-line import/no-cycle
import InvoiceStatus from './invoice-status';
import InvoicePdf from '../file/invoice-pdf';
import SubTransactionRow from '../transactions/sub-transaction-row';
import { INVOICE_PDF_LOCATION } from '../../files/storage';
import { PdfAble } from '../file/pdf-able';
import InvoicePdfService from '../../service/pdf/invoice-pdf-service';


@Entity()
export default class Invoice extends PdfAble(BaseEntity) {

  /**
   * The ID of the account for whom the invoice is
   */
  @Column({ nullable: false })
  public toId: number;

  /**
   * The account for whom the invoice is
   */
  @ManyToOne(() => User, { nullable: false })
  public to: User;

  /**
   * The transfer entity representing the invoice.
   */
  @OneToOne(() => Transfer, {
    nullable: false,
  })
  @JoinColumn()
  public transfer: Transfer;

  /**
   * The status history of the invoice
   */
  @OneToMany(() => InvoiceStatus,
    (invoiceStatus) => invoiceStatus.invoice,
    { cascade: true })
  public invoiceStatus: InvoiceStatus[];

  /**
   * Name of the addressed
   */
  @Column()
  public addressee: string;

  /**
   * Special attention to the addressee
   */
  @Column({ nullable: true, default: '' })
  public attention: string;

  /**
   * The description of the invoice
   */
  @Column({ nullable: true, default: '' })
  public description: string;

  /**
   * The ID of the PDF file
   */
  @Column({ nullable: true })
  public pdfId?: number;

  /**
   * The PDF file
   *
   * onDelete: 'CASCADE' is not possible here, because removing the
   * pdf from the database will not remove it from storage
   */
  @OneToOne(() => InvoicePdf, { nullable: true, onDelete: 'RESTRICT' })
  @JoinColumn()
  public pdf?: InvoicePdf;

  /**
   * The reference of the invoice
   */
  @Column()
  public reference: string;

  /**
   * Street to use on the invoice
   */
  @Column()
  public street: string;

  /**
   * Postal code to use on the invoice
   */
  @Column()
  public postalCode:string;

  /**
   * City to use on the invoice
   */
  @Column()
  public city: string;

  /**
   * Country to use on the invoice
   */
  @Column()
  public country: string;

  @Column({ nullable: true })
  public creditTransferId?: number;

  /**
   * If this invoice is deleted, this will be credit transfer.
   */
  @OneToOne(() => Transfer, { nullable: true })
  @JoinColumn()
  public creditTransfer?: Transfer;

  /**
   * Date of the invoice
   */
  @Column({
    type: 'datetime',
    default: () => 'CURRENT_TIMESTAMP',
  })
  public date: Date;

  @OneToMany(() => SubTransactionRow, (row) => row.invoice, { cascade: false })
  public subTransactionRows: SubTransactionRow[];

  @ManyToMany(() => SubTransactionRow, { cascade: false })
  @JoinTable()
  public subTransactionRowsDeletedInvoice: SubTransactionRow[];

  pdfService = new InvoicePdfService(INVOICE_PDF_LOCATION);

  async getOwner(): Promise<User> {
    return this.to;
  }
}