gemcap-be-common 1.1.102 → 1.2.2

package/models/LoanCharges.model.js

@@ -0,0 +1,207 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoanCharge = exports.defaultChargeList = exports.chargeViewValidationSchema = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const joi_1 = __importDefault(require("joi"));
+const enums_1 = require("../enums");
+const _models_1 = require("./_models");
+exports.chargeViewValidationSchema = joi_1.default.object({
+    valid: joi_1.default.boolean(),
+    _id: joi_1.default.string(),
+    active: joi_1.default.boolean(),
+    name: joi_1.default.string().required(),
+    code: joi_1.default.string().required(),
+    PLCode: joi_1.default.string().required(),
+    productId: joi_1.default.string().required(),
+    percent: joi_1.default.number().required().min(0),
+    minimumAmount: joi_1.default.number().required().min(0),
+    frequency: joi_1.default.string().required().valid(...Object.keys(enums_1.EChargeFrequencies)),
+    applyFrom: joi_1.default.date().required(),
+    calculationBasis: joi_1.default.string().required().valid(...Object.keys(enums_1.EChargeCalculationBasis)),
+    chargeType: joi_1.default.string().required().valid(...Object.keys(enums_1.ELoanChargeType)),
+    includeInYield: joi_1.default.boolean().required(),
+});
+exports.defaultChargeList = [
+    {
+        _id: null,
+        active: true,
+        name: 'Interest',
+        code: enums_1.ELoanChargeType.INTEREST_FEE,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.INTEREST_FEE,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.DAILY,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.DAILY_BALANCE,
+        includeInYield: false,
+    },
+    {
+        _id: null,
+        active: true,
+        name: 'Admin Fees',
+        code: enums_1.ELoanChargeType.ADMIN_FEE,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.ADMIN_FEE,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.MONTHLY,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.AVERAGE_MONTHLY_BALANCE,
+        includeInYield: false,
+    },
+    {
+        _id: null,
+        active: true,
+        name: 'Unused Line Fee',
+        code: enums_1.ELoanChargeType.UNUSED_LINE_FEE,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.UNUSED_LINE_FEE,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.DAILY,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.UNUSED_AMOUNT,
+        includeInYield: false,
+    },
+    {
+        _id: null,
+        active: true,
+        name: 'Annual Line Fee',
+        code: enums_1.ELoanChargeType.ANNUAL_LINE_FEE,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.ANNUAL_LINE_FEE,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.ANNUAL,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.COMMITMENT,
+        includeInYield: false,
+    },
+    {
+        _id: null,
+        active: true,
+        name: 'Wire Fee',
+        code: enums_1.ELoanChargeType.WIRE_FEE,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.WIRE_FEE,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.DISBURSEMENT,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.DISBURSEMENT_AMOUNT,
+        includeInYield: false,
+    },
+    {
+        _id: null,
+        active: true,
+        name: 'Forbearance',
+        code: enums_1.ELoanChargeType.OTHER,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.OTHER,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.ONE_TIME,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.FIXED,
+        includeInYield: false,
+    },
+    {
+        _id: null,
+        active: true,
+        name: 'Overline/Over-advance',
+        code: enums_1.ELoanChargeType.OTHER,
+        PLCode: '',
+        chargeType: enums_1.ELoanChargeType.OTHER,
+        productId: null,
+        percent: 0,
+        minimumAmount: 0,
+        frequency: enums_1.EChargeFrequencies.ONE_TIME,
+        applyFrom: null,
+        calculationBasis: enums_1.EChargeCalculationBasis.FIXED,
+        includeInYield: false,
+    },
+];
+const LoanChargeSchema = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.borrowers,
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+    active: {
+        type: Boolean,
+        required: true,
+    },
+    name: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    code: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    PLCode: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    productId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.loanProducts,
+        required: true,
+    },
+    percent: {
+        type: Number,
+        required: true,
+    },
+    minimumAmount: {
+        type: Number,
+        required: true,
+    },
+    frequency: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    applyFrom: {
+        type: Date,
+        required: true,
+    },
+    calculationBasis: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    chargeType: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    includeInYield: {
+        type: Boolean,
+        required: true,
+    },
+    deletedAt: {
+        type: Date,
+    },
+    paymentOrder: {
+        type: Number,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+exports.LoanCharge = mongoose_1.default.model(_models_1.MODEL_NAMES.loanCharges, LoanChargeSchema);

package/models/LoanCharges.model.ts

@@ -0,0 +1,238 @@
+import mongoose, { Document } from 'mongoose';
+import Joi from 'joi';
+
+import { EChargeCalculationBasis, EChargeFrequencies, ELoanChargeType } from '../enums';
+import { MODEL_NAMES } from './_models';
+
+
+export const chargeViewValidationSchema = Joi.object<ILoanChargeView & { valid: boolean }>({
+  valid: Joi.boolean(),
+  _id: Joi.string(),
+  active: Joi.boolean(),
+  name: Joi.string().required(),
+  code: Joi.string().required(),
+  PLCode: Joi.string().required(),
+  productId: Joi.string().required(),
+  percent: Joi.number().required().min(0),
+  minimumAmount: Joi.number().required().min(0),
+  frequency: Joi.string().required().valid(...Object.keys(EChargeFrequencies)),
+  applyFrom: Joi.date().required(),
+  calculationBasis: Joi.string().required().valid(...Object.keys(EChargeCalculationBasis)),
+  chargeType: Joi.string().required().valid(...Object.keys(ELoanChargeType)),
+  includeInYield: Joi.boolean().required(),
+});
+
+export interface ILoanCharge {
+  borrowerId: mongoose.Types.ObjectId;
+  order: number;
+  active: boolean;
+  name: string;
+  code: string;
+  PLCode: string,
+  productId: mongoose.Types.ObjectId;
+  percent: number;
+  minimumAmount: number;
+  frequency: EChargeFrequencies;
+  applyFrom: Date;
+  calculationBasis: EChargeCalculationBasis;
+  chargeType: ELoanChargeType;
+  deletedAt?: Date;
+  paymentOrder?: number;
+  includeInYield: boolean;
+}
+
+export interface ILoanChargeWithId extends ILoanCharge {
+  _id: mongoose.Types.ObjectId;
+}
+
+export type ILoanChargeView = Omit<ILoanChargeWithId, 'borrowerId' | 'order'>
+
+export interface ILoanChargeDoc extends ILoanCharge, Document {
+}
+
+export const defaultChargeList: ILoanChargeView[] = [
+  {
+    _id: null,
+    active: true,
+    name: 'Interest',
+    code: ELoanChargeType.INTEREST_FEE,
+    PLCode: '',
+    chargeType: ELoanChargeType.INTEREST_FEE,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.DAILY,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.DAILY_BALANCE,
+    includeInYield: false,
+  },
+  {
+    _id: null,
+    active: true,
+    name: 'Admin Fees',
+    code: ELoanChargeType.ADMIN_FEE,
+    PLCode: '',
+    chargeType: ELoanChargeType.ADMIN_FEE,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.MONTHLY,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.AVERAGE_MONTHLY_BALANCE,
+    includeInYield: false,
+  },
+  {
+    _id: null,
+    active: true,
+    name: 'Unused Line Fee',
+    code: ELoanChargeType.UNUSED_LINE_FEE,
+    PLCode: '',
+    chargeType: ELoanChargeType.UNUSED_LINE_FEE,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.DAILY,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.UNUSED_AMOUNT,
+    includeInYield: false,
+  },
+  {
+    _id: null,
+    active: true,
+    name: 'Annual Line Fee',
+    code: ELoanChargeType.ANNUAL_LINE_FEE,
+    PLCode: '',
+    chargeType: ELoanChargeType.ANNUAL_LINE_FEE,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.ANNUAL,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.COMMITMENT,
+    includeInYield: false,
+  },
+  {
+    _id: null,
+    active: true,
+    name: 'Wire Fee',
+    code: ELoanChargeType.WIRE_FEE,
+    PLCode: '',
+    chargeType: ELoanChargeType.WIRE_FEE,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.DISBURSEMENT,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.DISBURSEMENT_AMOUNT,
+    includeInYield: false,
+  },
+  {
+    _id: null,
+    active: true,
+    name: 'Forbearance',
+    code: ELoanChargeType.OTHER,
+    PLCode: '',
+    chargeType: ELoanChargeType.OTHER,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.ONE_TIME,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.FIXED,
+    includeInYield: false,
+  },
+  {
+    _id: null,
+    active: true,
+    name: 'Overline/Over-advance',
+    code: ELoanChargeType.OTHER,
+    PLCode: '',
+    chargeType: ELoanChargeType.OTHER,
+    productId: null,
+    percent: 0,
+    minimumAmount: 0,
+    frequency: EChargeFrequencies.ONE_TIME,
+    applyFrom: null,
+    calculationBasis: EChargeCalculationBasis.FIXED,
+    includeInYield: false,
+  },
+];
+
+const LoanChargeSchema = new mongoose.Schema(
+  {
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.borrowers,
+      required: true,
+    },
+    order: {
+      type: Number,
+      required: true,
+    },
+    active: {
+      type: Boolean,
+      required: true,
+    },
+    name: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    code: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    PLCode: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    productId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.loanProducts,
+      required: true,
+    },
+    percent: {
+      type: Number,
+      required: true,
+    },
+    minimumAmount: {
+      type: Number,
+      required: true,
+    },
+    frequency: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    applyFrom: {
+      type: Date,
+      required: true,
+    },
+    calculationBasis: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    chargeType: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    includeInYield: {
+      type: Boolean,
+      required: true,
+    },
+    deletedAt: {
+      type: Date,
+    },
+    paymentOrder: {
+      type: Number,
+    },
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true },
+);
+
+export const LoanCharge = mongoose.model<ILoanChargeDoc>(MODEL_NAMES.loanCharges, LoanChargeSchema);

package/models/LoanProducts.model.d.ts

@@ -0,0 +1,60 @@
+/// <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/types/inferschematype" />
+import mongoose, { Document } from 'mongoose';
+import { ELoanTypes } from '../enums';
+export interface ILoanProduct {
+    borrowerId: mongoose.Types.ObjectId;
+    order: number;
+    active: boolean;
+    code: string;
+    masterCode: string;
+    name: string;
+    type: ELoanTypes;
+    startDate: Date;
+    maturityDate: Date;
+    commitment: number;
+    isBalanceActual: boolean;
+    isFloatedBalanceActual: boolean;
+    isParticipant: boolean;
+    minPercent: number;
+    maxPercent: number;
+    prepaymentDate?: Date;
+    prepaymentTerms?: string;
+    settlementCode: string;
+    isDefaultPaymentOrder: boolean;
+}
+export interface ILoanProductWithId extends ILoanProduct {
+    _id: mongoose.Types.ObjectId;
+}
+export type ILoanProductView = Omit<ILoanProductWithId, 'borrowerId' | 'order'>;
+export interface ILoanProductViewWithBalances extends ILoanProductView {
+    balance: number;
+    floatedBalance: number;
+}
+export interface ILoanProductDoc extends ILoanProduct, Document {
+}
+export declare const LoanProduct: mongoose.Model<ILoanProductDoc, {}, {}, {}, mongoose.Document<unknown, {}, ILoanProductDoc> & ILoanProductDoc & {
+    _id: mongoose.Types.ObjectId;
+}, any>;

package/models/LoanProducts.model.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoanProduct = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+const LoanProductSchema = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'borrowers',
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+    active: {
+        type: Boolean,
+        required: true,
+    },
+    code: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    masterCode: {
+        type: String,
+        trim: true,
+    },
+    name: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    type: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    startDate: {
+        type: Date,
+        required: true,
+    },
+    maturityDate: {
+        type: Date,
+        required: true,
+    },
+    commitment: {
+        type: Number,
+        required: true,
+    },
+    isBalanceActual: {
+        type: Boolean,
+        required: true,
+        default: true,
+    },
+    isFloatedBalanceActual: {
+        type: Boolean,
+        required: true,
+        default: true,
+    },
+    isParticipant: {
+        type: Boolean,
+        required: true,
+    },
+    minPercent: {
+        type: Number,
+        required: false,
+    },
+    maxPercent: {
+        type: Number,
+        required: false,
+    },
+    prepaymentDate: {
+        type: Date,
+    },
+    prepaymentTerms: {
+        type: String,
+        trim: true,
+    },
+    settlementCode: {
+        type: String,
+        trim: true,
+    },
+    isDefaultPaymentOrder: {
+        type: Boolean,
+        required: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+exports.LoanProduct = mongoose_1.default.model(_models_1.MODEL_NAMES.loanProducts, LoanProductSchema);