gemcap-be-common 1.1.102 → 1.2.2

package/models/LoanProducts.model.ts

@@ -0,0 +1,130 @@
+import mongoose, { Document } from 'mongoose';
+
+import { MODEL_NAMES } from './_models';
+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 {
+}
+
+const LoanProductSchema = new mongoose.Schema(
+  {
+    borrowerId: {
+      type: mongoose.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 },
+);
+
+export const LoanProduct = mongoose.model<ILoanProductDoc>(MODEL_NAMES.loanProducts, LoanProductSchema);

package/models/LoanStatementTransaction.model.d.ts

@@ -0,0 +1,50 @@
+/// <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 { ILoanChargeDoc } from './LoanCharges.model';
+export declare const LOAN_STATEMENT_TRANSACTION_FIELDS: string[];
+export interface ILoanStatementTransaction {
+    order: number;
+    date: Date;
+    chargeId: mongoose.Types.ObjectId;
+    amount: number;
+    amountPaid?: number;
+    balance?: number;
+    isSystem: boolean;
+    memo: string;
+    settlementCode?: string;
+    userId?: mongoose.Types.ObjectId;
+    isEditable?: boolean;
+}
+export interface ILoanStatementTransactionWithId extends ILoanStatementTransaction {
+    _id: mongoose.Types.ObjectId;
+}
+export interface ILoanStatementTransactionDocWithCharge extends ILoanStatementTransactionDoc {
+    charge: ILoanChargeDoc;
+}
+export type ILoanStatementTransactionView = Omit<ILoanStatementTransactionWithId, 'order'>;
+export interface ILoanStatementTransactionDoc extends ILoanStatementTransaction, Document {
+}
+export declare const LoanStatementTransactionModel: mongoose.Model<ILoanStatementTransactionDoc>;

package/models/LoanStatementTransaction.model.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoanStatementTransactionModel = exports.LOAN_STATEMENT_TRANSACTION_FIELDS = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+exports.LOAN_STATEMENT_TRANSACTION_FIELDS = [
+    '_id',
+    'date',
+    'chargeId',
+    'amount',
+    'amountPaid',
+    'balance',
+    'isSystem',
+    'memo',
+    'userId',
+];
+const LoanStatementSchema = new mongoose_1.default.Schema({
+    order: {
+        type: Number,
+        required: true,
+        default: 0,
+    },
+    date: {
+        type: Date,
+        required: true,
+    },
+    chargeId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'loan_charges',
+        required: true,
+    },
+    amount: {
+        type: Number,
+        required: true,
+    },
+    amountPaid: {
+        type: Number,
+        required: false,
+    },
+    balance: {
+        type: Number,
+        required: false,
+    },
+    isSystem: {
+        type: Boolean,
+        default: true,
+    },
+    memo: {
+        type: String,
+    },
+    settlementCode: {
+        type: String,
+    },
+    userId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.users,
+        required: false,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+exports.LoanStatementTransactionModel = mongoose_1.default.model('loan_statements', LoanStatementSchema);

package/models/LoanStatementTransaction.model.ts

@@ -0,0 +1,94 @@
+import mongoose, { Document } from 'mongoose';
+
+import { ILoanChargeDoc } from './LoanCharges.model';
+import { MODEL_NAMES } from './_models';
+
+
+export const LOAN_STATEMENT_TRANSACTION_FIELDS = [
+  '_id',
+  'date',
+  'chargeId',
+  'amount',
+  'amountPaid',
+  'balance',
+  'isSystem',
+  'memo',
+  'userId',
+];
+
+export interface ILoanStatementTransaction {
+  order: number;
+  date: Date;
+  chargeId: mongoose.Types.ObjectId;
+  amount: number;
+  amountPaid?: number;
+  balance?: number;
+  isSystem: boolean;
+  memo: string;
+  settlementCode?: string;
+  userId?: mongoose.Types.ObjectId;
+  isEditable?: boolean;
+}
+
+export interface ILoanStatementTransactionWithId extends ILoanStatementTransaction {
+  _id: mongoose.Types.ObjectId;
+}
+
+export interface ILoanStatementTransactionDocWithCharge extends ILoanStatementTransactionDoc {
+  charge: ILoanChargeDoc;
+}
+
+export type ILoanStatementTransactionView = Omit<ILoanStatementTransactionWithId, 'order'>
+
+export interface ILoanStatementTransactionDoc extends ILoanStatementTransaction, Document {
+}
+
+const LoanStatementSchema = new mongoose.Schema(
+  {
+    order: {
+      type: Number,
+      required: true,
+      default: 0,
+    },
+    date: {
+      type: Date,
+      required: true,
+    },
+    chargeId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'loan_charges',
+      required: true,
+    },
+    amount: {
+      type: Number,
+      required: true,
+    },
+    amountPaid: {
+      type: Number,
+      required: false,
+    },
+    balance: {
+      type: Number,
+      required: false,
+    },
+    isSystem: {
+      type: Boolean,
+      default: true,
+    },
+    memo: {
+      type: String,
+    },
+    settlementCode: {
+      type: String,
+    },
+    userId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.users,
+      required: false,
+    },
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true },
+);
+
+export const LoanStatementTransactionModel: mongoose.Model<ILoanStatementTransactionDoc> = mongoose.model<ILoanStatementTransactionDoc>('loan_statements', LoanStatementSchema);

package/models/LoanTransaction.model.d.ts

@@ -0,0 +1,76 @@
+/// <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, Model } from 'mongoose';
+import { ILoanProductDoc } from './LoanProducts.model';
+import { IBankDoc } from './Banks.model';
+export declare enum ELoanTransactionTypes {
+    COLLECTION = "COLLECTION",
+    DISBURSEMENT = "DISBURSEMENT",
+    ADJUSTMENT = "ADJUSTMENT"
+}
+export declare const LOAN_TRANSACTION_DOWNLOAD_FIELDS: string[];
+export declare const LOAN_TRANSACTION_FIELDS: string[];
+export interface ILoanTransactionUpload {
+    date: Date;
+    ledgerAccountCode: string;
+    amount: number;
+    description: string;
+    reference: string;
+    customerId: string;
+    bankAccountNumber: string;
+    transactionType: ELoanTransactionTypes;
+}
+export interface ILoanTransaction {
+    order?: number;
+    date: Date;
+    effectiveDate: Date;
+    productId: mongoose.Types.ObjectId;
+    amount: number;
+    description: string;
+    reference: string;
+    customerId: string;
+    bankId: mongoose.Types.ObjectId;
+    transactionType: ELoanTransactionTypes;
+    balance: number;
+    floatedBalance: number;
+    loanPaymentId?: mongoose.Types.ObjectId;
+    userId?: mongoose.Types.ObjectId;
+}
+export interface ILoanTransactionDocWithProduct extends ILoanTransactionDoc {
+    product: ILoanProductDoc;
+}
+export interface ILoanTransactionWithId extends ILoanTransaction {
+    _id: mongoose.Types.ObjectId;
+}
+export type ILoanTransactionView = Omit<ILoanTransactionWithId, 'order'>;
+export type ILoanTransactionViewWithBank = ILoanTransactionView & {
+    bank: IBankDoc;
+};
+export interface ILoanTransactionDoc extends ILoanTransaction, Document {
+}
+export interface ILoanTransactionModel extends Model<ILoanTransaction> {
+    findByIdAndDeleteWithUserId(id: string, userId: string): Promise<void>;
+}
+export declare const LoanTransaction: ILoanTransactionModel;

package/models/LoanTransaction.model.js

@@ -0,0 +1,160 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoanTransaction = exports.LOAN_TRANSACTION_FIELDS = exports.LOAN_TRANSACTION_DOWNLOAD_FIELDS = exports.ELoanTransactionTypes = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+const UserLog_model_1 = require("./UserLog.model");
+const DeletedRecords_model_1 = require("./DeletedRecords.model");
+const db_1 = require("../db");
+var ELoanTransactionTypes;
+(function (ELoanTransactionTypes) {
+    ELoanTransactionTypes["COLLECTION"] = "COLLECTION";
+    ELoanTransactionTypes["DISBURSEMENT"] = "DISBURSEMENT";
+    ELoanTransactionTypes["ADJUSTMENT"] = "ADJUSTMENT";
+})(ELoanTransactionTypes || (exports.ELoanTransactionTypes = ELoanTransactionTypes = {}));
+exports.LOAN_TRANSACTION_DOWNLOAD_FIELDS = [
+    'date',
+    'amount',
+    'description',
+    'reference',
+    'customerId',
+    'transactionType',
+];
+exports.LOAN_TRANSACTION_FIELDS = [
+    '_id',
+    'date',
+    'effectiveDate',
+    'productId',
+    'amount',
+    'description',
+    'reference',
+    'customerId',
+    'bankId',
+    'transactionType',
+    'balance',
+    'floatedBalance',
+    'loanPaymentId',
+    'userId',
+];
+const LoanTransactionSchema = new mongoose_1.default.Schema({
+    userId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.users,
+        required: false,
+    },
+    order: {
+        type: Number,
+        required: true,
+        default: 0,
+    },
+    date: {
+        type: Date,
+        required: true,
+    },
+    effectiveDate: {
+        type: Date,
+        required: true,
+    },
+    productId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'loan_products',
+        required: true,
+    },
+    amount: {
+        type: Number,
+        required: true,
+    },
+    description: {
+        type: String,
+        trim: true,
+    },
+    reference: {
+        type: String,
+        trim: true,
+    },
+    customerId: {
+        type: String,
+        trim: true,
+    },
+    bankId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'banks',
+        required: false,
+    },
+    transactionType: {
+        type: String,
+        enum: Object.values(ELoanTransactionTypes),
+        required: true,
+    },
+    balance: {
+        type: Number,
+    },
+    floatedBalance: {
+        type: Number,
+    },
+    loanPaymentId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'loan_payments',
+    },
+}, { timestamps: true });
+LoanTransactionSchema.statics.findByIdAndDeleteWithUserId = async function (id, userId) {
+    const foundDoc = await this.findById(id).lean();
+    if (!foundDoc) {
+        return this.findByIdAndDelete(id);
+    }
+    const deletedRecord = new DeletedRecords_model_1.DeletedRecord({
+        collection: 'loan_transactions',
+        recordId: id,
+        record: foundDoc,
+    });
+    await deletedRecord.save();
+    await (0, db_1.createLog)({
+        action: UserLog_model_1.ELogActionType.DELETE,
+        logType: UserLog_model_1.ELogType.LOAN_TRANSACTION,
+        userId: userId,
+        recordCollection: 'loan_transactions',
+        recordId: id,
+        details: {},
+    });
+    return this.findByIdAndDelete(id);
+};
+LoanTransactionSchema.pre(/^(save)/, async function () {
+    const myDoc = this;
+    await (0, db_1.createLog)({
+        action: UserLog_model_1.ELogActionType.CREATE,
+        logType: UserLog_model_1.ELogType.LOAN_TRANSACTION,
+        userId: myDoc.userId,
+        recordCollection: 'loan_transactions',
+        recordId: myDoc._id,
+        details: {},
+    });
+});
+LoanTransactionSchema.pre(/^(updateOne|updateMany|findOneAndUpdate)/, async function () {
+    const myDoc = this;
+    const update = myDoc._update;
+    const conditions = myDoc._conditions;
+    if (update
+        && update.hasOwnProperty('userId')
+        && conditions
+        && conditions.hasOwnProperty('_id')) {
+        const oldDoc = await myDoc.model.findById(conditions._id);
+        let changes = {};
+        if (oldDoc) {
+            changes = (0, db_1.getLogChanges)(oldDoc, update);
+        }
+        await (0, db_1.createLog)({
+            action: UserLog_model_1.ELogActionType.EDIT,
+            logType: UserLog_model_1.ELogType.LOAN_TRANSACTION,
+            userId: update.userId,
+            recordCollection: 'loan_transactions',
+            recordId: conditions._id,
+            details: {
+                changes,
+            },
+        });
+    }
+});
+exports.LoanTransaction = mongoose_1.default.model('loan_transactions', LoanTransactionSchema);