gemcap-be-common 1.2.140 → 1.3.0

package/services/reports/investor-summary.service.d.ts

@@ -0,0 +1,28 @@
+import { ReportsService } from '../reports.service';
+import { LoanChargesService } from '../loan-charges.service';
+export interface IInvestorSummaryDataRow {
+    clientName: string;
+    productName: string;
+    maturityDate: string;
+    commitmentAmount: number;
+    balanceEnd: number;
+    participationBalanceEnd: number;
+    companyExposure: number;
+    netAvailable: number;
+    collectionsBetweenStartEnd: number;
+    disbursementsBetweenStartEnd: number;
+    netRevolverAvailability: number;
+    ARNet: number;
+    inventoryNet: number;
+    otherCollateral: number;
+    otherReservesAndAdjustments: number;
+    totalRevolver: number;
+    collectionsBetweenBeginningEnd: number;
+    disbursementsBetweenBeginningEnd: number;
+}
+export declare class InvestorSummaryService {
+    private readonly loanChargesService;
+    private readonly reportsService;
+    constructor(loanChargesService: LoanChargesService, reportsService: ReportsService);
+    getInvestorSummaryData(borrowerIds: string[], start: Date, end: Date): Promise<IInvestorSummaryDataRow[]>;
+}

package/services/reports/investor-summary.service.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvestorSummaryService = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const decimal_js_1 = __importDefault(require("decimal.js"));
+const dayjs_1 = __importDefault(require("dayjs"));
+const date_helper_1 = require("../../helpers/date.helper");
+const Borrower_model_1 = require("../../models/Borrower.model");
+const LoanTransaction_model_1 = require("../../models/LoanTransaction.model");
+const loan_types_enum_1 = require("../../enums/loan-types.enum");
+const getFirstTransactionDate = async (productId, transactionType) => {
+    const firstDocs = await LoanTransaction_model_1.LoanTransaction
+        .find({ productId: new mongoose_1.default.Types.ObjectId(productId), transactionType: transactionType })
+        .sort('date')
+        .limit(1)
+        .lean();
+    if (!firstDocs.length) {
+        return new Date();
+    }
+    return firstDocs[0].date;
+};
+const getCollectionBetweenDates = async (productId, start, end, transactionType) => {
+    const collections = await LoanTransaction_model_1.LoanTransaction.aggregate([{
+            $match: {
+                date: { $gte: start, $lte: end },
+                productId: new mongoose_1.default.Types.ObjectId(productId),
+                transactionType: transactionType,
+            },
+        }]);
+    return collections.reduce((sum, collection) => new decimal_js_1.default(collection.amount).abs().add(sum).toNumber(), 0);
+};
+const emptySummary = {
+    ARAdvanceRate: 0,
+    ARGross: 0,
+    ARNet: 0,
+    ARReserves: 0,
+    NAISC: '',
+    bootCollateral: 0,
+    borrowerName: '',
+    collateralAdjustments: 0,
+    commitment: 0,
+    equipmentCollateral: 0,
+    intellectualProperty: 0,
+    inventoryAdvanceRate: 0,
+    inventoryGrossValue: 0,
+    inventoryNet: 0,
+    inventoryReserves: 0,
+    loanBalanceRevolver: 0,
+    loanTermBalance: 0,
+    maturityDate: undefined,
+    netRevolverAvailability: 0,
+    netTermAvailability: 0,
+    otherReserves: 0,
+    participantBalance: 0,
+    productCode: '',
+    productType: '',
+    realEstate: 0,
+    startDate: undefined,
+    termLoanReserves: 0,
+    totalCollateral: 0,
+};
+class InvestorSummaryService {
+    loanChargesService;
+    reportsService;
+    constructor(loanChargesService, reportsService) {
+        this.loanChargesService = loanChargesService;
+        this.reportsService = reportsService;
+    }
+    async getInvestorSummaryData(borrowerIds, start, end) {
+        const data = [];
+        const borrowerSummaries = await this.reportsService.generateBankPortfolioSummary(borrowerIds, end);
+        await Promise.all(borrowerIds.map(async (borrowerId) => {
+            const borrower = await Borrower_model_1.BorrowerModel.findById(borrowerId).lean();
+            const borrowerProducts = await this.loanChargesService.getLoanProducts(borrowerId);
+            await Promise.all(borrowerProducts.filter((product) => !product.isParticipant).map(async (product) => {
+                const productId = product._id.toString();
+                const isRevolver = product.type === loan_types_enum_1.ELoanTypes.REVOLVER;
+                const { balance: balanceEnd } = await this.loanChargesService.getLoanProductBalance(productId, end);
+                const collectionsBetweenStartEnd = await getCollectionBetweenDates(productId, start, end, LoanTransaction_model_1.ELoanTransactionTypes.COLLECTION);
+                const disbursementsBetweenStartEnd = await getCollectionBetweenDates(productId, start, end, LoanTransaction_model_1.ELoanTransactionTypes.DISBURSEMENT);
+                const collectionsBeginning = await getFirstTransactionDate(productId, LoanTransaction_model_1.ELoanTransactionTypes.COLLECTION);
+                const disbursementBeginning = await getFirstTransactionDate(productId, LoanTransaction_model_1.ELoanTransactionTypes.COLLECTION);
+                const collectionsBetweenBeginningEnd = await getCollectionBetweenDates(productId, collectionsBeginning, end, LoanTransaction_model_1.ELoanTransactionTypes.COLLECTION);
+                const disbursementsBetweenBeginningEnd = await getCollectionBetweenDates(productId, disbursementBeginning, end, LoanTransaction_model_1.ELoanTransactionTypes.DISBURSEMENT);
+                const participationBalanceEnd = await this.loanChargesService.getParticipationBalance(product.code, end);
+                const companyExposure = new decimal_js_1.default(balanceEnd).sub(participationBalanceEnd).toNumber();
+                const productSummary = borrowerSummaries.find((summary) => summary.productCode === product.code) || emptySummary;
+                const netRevolverAvailability = productSummary.netRevolverAvailability;
+                const ARNet = productSummary.ARNet;
+                const inventoryNet = productSummary.inventoryNet;
+                const otherCollateral = new decimal_js_1.default(productSummary.equipmentCollateral).add(productSummary.intellectualProperty).add(productSummary.realEstate).add(productSummary.bootCollateral).toNumber();
+                const otherReserves = isRevolver ? productSummary.otherReserves : 0;
+                const collateralAdjustments = isRevolver ? await this.reportsService.getCollateralAdjustmentsForLastSignedBBC(borrowerId, end) : 0;
+                const otherReservesAndAdjustments = new decimal_js_1.default(otherReserves).add(collateralAdjustments).toNumber();
+                const totalRevolver = new decimal_js_1.default(productSummary.totalCollateral).add(productSummary.equipmentCollateral).add(productSummary.intellectualProperty).toNumber();
+                const netAvailable = new decimal_js_1.default(inventoryNet).add(ARNet).add(otherCollateral).add(otherReservesAndAdjustments).minus(balanceEnd).toNumber();
+                const newRow = {
+                    clientName: borrower.name,
+                    productName: product.name,
+                    maturityDate: (0, dayjs_1.default)(product.maturityDate).format(date_helper_1.defaultDateFormat),
+                    commitmentAmount: product.commitment,
+                    balanceEnd,
+                    participationBalanceEnd,
+                    companyExposure,
+                    netAvailable,
+                    collectionsBetweenStartEnd,
+                    disbursementsBetweenStartEnd,
+                    netRevolverAvailability,
+                    ARNet,
+                    inventoryNet,
+                    otherCollateral,
+                    otherReservesAndAdjustments,
+                    totalRevolver,
+                    collectionsBetweenBeginningEnd,
+                    disbursementsBetweenBeginningEnd,
+                };
+                data.push(newRow);
+            }));
+        }));
+        return data
+            .sort((a, b) => {
+            const borrowerComparison = a.clientName.localeCompare(b.clientName);
+            if (borrowerComparison !== 0) {
+                return borrowerComparison;
+            }
+            else {
+                return a.productName.localeCompare(b.productName);
+            }
+        });
+    }
+    ;
+}
+exports.InvestorSummaryService = InvestorSummaryService;

package/services/reports/investor-summary.service.ts

@@ -0,0 +1,159 @@
+import mongoose from 'mongoose';
+import Decimal from 'decimal.js';
+import dayjs from 'dayjs';
+
+import { defaultDateFormat } from '../../helpers/date.helper';
+import { BorrowerModel } from '../../models/Borrower.model';
+import { ELoanTransactionTypes, ILoanTransactionDoc, LoanTransaction } from '../../models/LoanTransaction.model';
+import { ELoanTypes } from '../../enums/loan-types.enum';
+import { IBankReportData, ReportsService } from '../reports.service';
+import { LoanChargesService } from '../loan-charges.service';
+
+export interface IInvestorSummaryDataRow {
+  clientName: string;
+  productName: string;
+  maturityDate: string;
+  commitmentAmount: number;
+  balanceEnd: number;
+  participationBalanceEnd: number;
+  companyExposure: number;
+  netAvailable: number;
+  collectionsBetweenStartEnd: number;
+  disbursementsBetweenStartEnd: number;
+  netRevolverAvailability: number;
+  ARNet: number;
+  inventoryNet: number;
+  otherCollateral: number;
+  otherReservesAndAdjustments: number;
+  totalRevolver: number;
+  collectionsBetweenBeginningEnd: number;
+  disbursementsBetweenBeginningEnd: number;
+}
+
+const getFirstTransactionDate = async (productId: string, transactionType: ELoanTransactionTypes) => {
+  const firstDocs = await LoanTransaction
+    .find({ productId: new mongoose.Types.ObjectId(productId), transactionType: transactionType })
+    .sort('date')
+    .limit(1)
+    .lean();
+  if (!firstDocs.length) {
+    return new Date();
+  }
+  return firstDocs[0].date;
+};
+
+const getCollectionBetweenDates = async (productId: string, start: Date, end: Date, transactionType: ELoanTransactionTypes) => {
+  const collections = await LoanTransaction.aggregate<ILoanTransactionDoc>([{
+    $match: {
+      date: { $gte: start, $lte: end },
+      productId: new mongoose.Types.ObjectId(productId),
+      transactionType: transactionType,
+    },
+  }]);
+  return collections.reduce((sum, collection) => new Decimal(collection.amount).abs().add(sum).toNumber(), 0);
+};
+
+const emptySummary: IBankReportData = {
+  ARAdvanceRate: 0,
+  ARGross: 0,
+  ARNet: 0,
+  ARReserves: 0,
+  NAISC: '',
+  bootCollateral: 0,
+  borrowerName: '',
+  collateralAdjustments: 0,
+  commitment: 0,
+  equipmentCollateral: 0,
+  intellectualProperty: 0,
+  inventoryAdvanceRate: 0,
+  inventoryGrossValue: 0,
+  inventoryNet: 0,
+  inventoryReserves: 0,
+  loanBalanceRevolver: 0,
+  loanTermBalance: 0,
+  maturityDate: undefined,
+  netRevolverAvailability: 0,
+  netTermAvailability: 0,
+  otherReserves: 0,
+  participantBalance: 0,
+  productCode: '',
+  productType: '',
+  realEstate: 0,
+  startDate: undefined,
+  termLoanReserves: 0,
+  totalCollateral: 0,
+};
+
+
+export class InvestorSummaryService {
+
+  constructor(
+    private readonly loanChargesService: LoanChargesService,
+    private readonly reportsService: ReportsService,
+  ) {
+  }
+
+  async getInvestorSummaryData(borrowerIds: string[], start: Date, end: Date) {
+    const data: IInvestorSummaryDataRow[] = [];
+    const borrowerSummaries = await this.reportsService.generateBankPortfolioSummary(borrowerIds, end);
+    await Promise.all(borrowerIds.map(async (borrowerId) => {
+      const borrower = await BorrowerModel.findById(borrowerId).lean();
+      const borrowerProducts = await this.loanChargesService.getLoanProducts(borrowerId);
+      await Promise.all(borrowerProducts.filter((product) => !product.isParticipant).map(async (product) => {
+        const productId = product._id.toString();
+        const isRevolver = product.type === ELoanTypes.REVOLVER;
+        const { balance: balanceEnd } = await this.loanChargesService.getLoanProductBalance(productId, end);
+        const collectionsBetweenStartEnd = await getCollectionBetweenDates(productId, start, end, ELoanTransactionTypes.COLLECTION);
+        const disbursementsBetweenStartEnd = await getCollectionBetweenDates(productId, start, end, ELoanTransactionTypes.DISBURSEMENT);
+        const collectionsBeginning = await getFirstTransactionDate(productId, ELoanTransactionTypes.COLLECTION);
+        const disbursementBeginning = await getFirstTransactionDate(productId, ELoanTransactionTypes.COLLECTION);
+        const collectionsBetweenBeginningEnd = await getCollectionBetweenDates(productId, collectionsBeginning, end, ELoanTransactionTypes.COLLECTION);
+        const disbursementsBetweenBeginningEnd = await getCollectionBetweenDates(productId, disbursementBeginning, end, ELoanTransactionTypes.DISBURSEMENT);
+        const participationBalanceEnd = await this.loanChargesService.getParticipationBalance(product.code, end);
+        const companyExposure = new Decimal(balanceEnd).sub(participationBalanceEnd).toNumber();
+
+        const productSummary = borrowerSummaries.find((summary) => summary.productCode === product.code) || emptySummary;
+        const netRevolverAvailability = productSummary.netRevolverAvailability;
+        const ARNet = productSummary.ARNet;
+        const inventoryNet = productSummary.inventoryNet;
+        const otherCollateral = new Decimal(productSummary.equipmentCollateral).add(productSummary.intellectualProperty).add(productSummary.realEstate).add(productSummary.bootCollateral).toNumber();
+        const otherReserves = isRevolver ? productSummary.otherReserves : 0;
+        const collateralAdjustments = isRevolver ? await this.reportsService.getCollateralAdjustmentsForLastSignedBBC(borrowerId, end) : 0;
+        const otherReservesAndAdjustments = new Decimal(otherReserves).add(collateralAdjustments).toNumber();
+        const totalRevolver = new Decimal(productSummary.totalCollateral).add(productSummary.equipmentCollateral).add(productSummary.intellectualProperty).toNumber();
+        const netAvailable = new Decimal(inventoryNet).add(ARNet).add(otherCollateral).add(otherReservesAndAdjustments).minus(balanceEnd).toNumber();
+        const newRow: IInvestorSummaryDataRow = {
+          clientName: borrower.name,
+          productName: product.name,
+          maturityDate: dayjs(product.maturityDate).format(defaultDateFormat),
+          commitmentAmount: product.commitment,
+          balanceEnd,
+          participationBalanceEnd,
+          companyExposure,
+          netAvailable,
+          collectionsBetweenStartEnd,
+          disbursementsBetweenStartEnd,
+          netRevolverAvailability,
+          ARNet,
+          inventoryNet,
+          otherCollateral,
+          otherReservesAndAdjustments,
+          totalRevolver,
+          collectionsBetweenBeginningEnd,
+          disbursementsBetweenBeginningEnd,
+        };
+        data.push(newRow);
+      }));
+    }));
+    return data
+      .sort((a, b) => {
+        const borrowerComparison = a.clientName.localeCompare(b.clientName);
+        if (borrowerComparison !== 0) {
+          return borrowerComparison;
+        } else {
+          return a.productName.localeCompare(b.productName);
+        }
+      });
+  };
+
+}

package/services/reports.service.d.ts

@@ -0,0 +1,126 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose" />
+/// <reference types="mongoose/types/inferschematype" />
+import { ELedgerReportType } from '../db/loan-statement.db';
+import { InvestorSummaryService } from './reports/investor-summary.service';
+import { AvailabilityService } from './availability.service';
+import { BorrowerService } from './borrowers.service';
+import { CollateralAdjustmentsService } from './collateral-adjustments.service';
+import { CollateralsService } from './collaterals.service';
+import { EquipmentService } from './equipment.service';
+import { LoanChargesService } from './loan-charges.service';
+import { LoanTransactionsService } from './loan-transactions.service';
+import { SignsService } from './signs.service';
+import { UploadsService } from './uploads.service';
+export interface IBankReportData {
+    borrowerId?: string;
+    borrowerName: string;
+    productCode: string;
+    productType: string;
+    commitment: number;
+    startDate: Date;
+    maturityDate: Date;
+    inventoryGrossValue: number;
+    inventoryAdvanceRate: number;
+    inventoryReserves: number;
+    inventoryNet: number;
+    ARGross: number;
+    ARAdvanceRate: number;
+    ARReserves: number;
+    ARNet: number;
+    otherReserves: number;
+    collateralAdjustments: number;
+    totalCollateral: number;
+    loanBalanceRevolver: number;
+    netRevolverAvailability: number;
+    equipmentCollateral: number;
+    intellectualProperty: number;
+    realEstate: number;
+    bootCollateral: number;
+    termLoanReserves: number;
+    loanTermBalance: number;
+    netTermAvailability: number;
+    participantBalance: number;
+    NAISC: string;
+}
+interface IReportDataItem {
+    name: string;
+    grossValue: number;
+    advanceRate: number;
+    netValue: number;
+}
+interface ISummaryReportDataGroup {
+    NAISCCode: string;
+    isExternalAppraisal: boolean;
+    isCompliant: boolean;
+    productCode: string;
+    items: IReportDataItem[];
+}
+interface ISummaryReportData {
+    borrowerName: string;
+    bbcDate: Date;
+    revolverDataGroup: ISummaryReportDataGroup;
+    termDataGroup: ISummaryReportDataGroup;
+}
+export declare class ReportsService {
+    private readonly availabilityService;
+    private readonly borrowerService;
+    private readonly collateralAdjustmentsService;
+    private readonly collateralsService;
+    private readonly equipmentService;
+    private readonly loanChargesService;
+    private readonly loanTransactionsService;
+    private readonly signsService;
+    private readonly uploadsService;
+    private readonly investorSummaryService;
+    margin: number;
+    constructor(availabilityService: AvailabilityService, borrowerService: BorrowerService, collateralAdjustmentsService: CollateralAdjustmentsService, collateralsService: CollateralsService, equipmentService: EquipmentService, loanChargesService: LoanChargesService, loanTransactionsService: LoanTransactionsService, signsService: SignsService, uploadsService: UploadsService, investorSummaryService: InvestorSummaryService);
+    getCollateralAdjustmentsForLastSignedBBC(borrowerId: string, date: Date): Promise<number>;
+    private getProductBalances;
+    getBorrowerAndProducts(borrowerId: string, date: Date, useSignedBBC?: boolean, requireBBC?: boolean): Promise<{
+        borrower: import("mongoose").Document<unknown, {}, import("../models/Borrower.model").IBorrowerDocument> & import("../models/Borrower.model").IBorrowerDocument & {
+            _id: import("mongoose").Types.ObjectId;
+        };
+        latestBBC: import("../models/BBCDate.model").IBBCDateDoc;
+        summaries: import("./availability.service").IAvailabilityFullSummary;
+        products: import("../models/LoanProducts.model").ILoanProductView[];
+    }>;
+    generatePortfolioSummary(borrowerIds: string[], date: Date): Promise<{
+        [borrowerId: string]: ISummaryReportData;
+    }>;
+    getPortfolioSummaryExcel(borrowerIds: string[], date: Date): Promise<any>;
+    generateBankPortfolioSummary(borrowerIds: string[], date: Date, { useSignedBBC, useStoredBalance, }?: {
+        useSignedBBC: boolean;
+        useStoredBalance: boolean;
+    }): Promise<IBankReportData[]>;
+    getBalancesCollateralReportExcel(borrowerIds: string[], date: Date): Promise<any>;
+    getLedger(productIds: string[], startDate: Date, endDate: Date, reportType: ELedgerReportType, showFloatedBalance?: boolean): Promise<{
+        [productId: string]: import("../db/reports.db").ILedgerReportRow[];
+    }>;
+    getInvestorSummaryReport(selectedBorrowerIds: string[], start: Date, end: Date): Promise<{
+        report: any[][];
+    }[]>;
+}
+export {};