gemcap-be-common 1.2.1 → 1.2.3

package/models/LoanTransaction.model.ts

@@ -0,0 +1,218 @@
+import mongoose, { Document, Model } from 'mongoose';
+
+import { ILoanProductDoc } from './LoanProducts.model';
+import { MODEL_NAMES } from './_models';
+import { ELogActionType, ELogType } from './UserLog.model';
+import { IBankDoc } from './Banks.model';
+import { DeletedRecord } from './DeletedRecords.model';
+import { createLog, getLogChanges } from '../db';
+
+export enum ELoanTransactionTypes {
+  COLLECTION = 'COLLECTION',
+  DISBURSEMENT = 'DISBURSEMENT',
+  ADJUSTMENT = 'ADJUSTMENT'
+}
+
+export const LOAN_TRANSACTION_DOWNLOAD_FIELDS = [
+  'date',
+  'amount',
+  'description',
+  'reference',
+  'customerId',
+  'transactionType',
+];
+
+export const LOAN_TRANSACTION_FIELDS = [
+  '_id',
+  'date',
+  'effectiveDate',
+  'productId',
+  'amount',
+  'description',
+  'reference',
+  'customerId',
+  'bankId',
+  'transactionType',
+  'balance',
+  'floatedBalance',
+  'loanPaymentId',
+  'userId',
+];
+
+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>;
+}
+
+const LoanTransactionSchema = new mongoose.Schema<ILoanTransaction, ILoanTransactionModel>(
+  {
+    userId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 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.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.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.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 DeletedRecord({
+    collection: 'loan_transactions',
+    recordId: id,
+    record: foundDoc,
+  });
+  await deletedRecord.save();
+
+  await createLog({
+    action: ELogActionType.DELETE,
+    logType: ELogType.LOAN_TRANSACTION,
+    userId: userId,
+    recordCollection: 'loan_transactions',
+    recordId: id,
+    details: {},
+  });
+
+  return this.findByIdAndDelete(id);
+};
+
+
+LoanTransactionSchema.pre(/^(save)/, async function() {
+  const myDoc: any = this;
+  await createLog({
+    action: ELogActionType.CREATE,
+    logType: ELogType.LOAN_TRANSACTION,
+    userId: myDoc.userId,
+    recordCollection: 'loan_transactions',
+    recordId: myDoc._id,
+    details: {},
+  });
+});
+
+LoanTransactionSchema.pre(/^(updateOne|updateMany|findOneAndUpdate)/, async function() {
+  const myDoc: any = 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 = getLogChanges(oldDoc, update);
+    }
+    await createLog({
+      action: ELogActionType.EDIT,
+      logType: ELogType.LOAN_TRANSACTION,
+      userId: update.userId,
+      recordCollection: 'loan_transactions',
+      recordId: conditions._id,
+      details: {
+        changes,
+      },
+    });
+  }
+});
+
+export const LoanTransaction: ILoanTransactionModel = mongoose.model<ILoanTransactionDoc, ILoanTransactionModel>('loan_transactions', LoanTransactionSchema);

package/models/MicroserviceTask.model.d.ts

@@ -23,8 +23,7 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 import mongoose, { Document } from 'mongoose';
-import { EMicroserviceTaskStatuses } from '../enums';
-import { EMicroserviceTask } from '../enums/microservice-task.enum';
+import { EMicroserviceTask, EMicroserviceTaskStatuses } from '../enums';
 export interface IMicroserviceTask {
     cmd: EMicroserviceTask;
     params: any;

package/models/MicroserviceTask.model.ts

@@ -1,7 +1,6 @@
 import mongoose, { Document } from 'mongoose';
 
-import { EMicroserviceTaskStatuses } from '../enums';
-import { EMicroserviceTask } from '../enums/microservice-task.enum';
+import { EMicroserviceTask, EMicroserviceTaskStatuses } from '../enums';
 
 const mongooseLeanId = require('../plugins/id.plugin');
 

package/models/PostponedTransactions.model.d.ts

@@ -0,0 +1,39 @@
+/// <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 { ILoanTransactionDoc } from './LoanTransaction.model';
+export interface IPostponedTransaction {
+    postponedToDate: string;
+    transactionId: mongoose.Types.ObjectId;
+    productId: mongoose.Types.ObjectId;
+}
+export interface IPostponedTransactionDoc extends Document, IPostponedTransaction {
+}
+export interface IPostponedTransactionWithTransaction extends IPostponedTransactionDoc {
+    transaction: ILoanTransactionDoc;
+}
+export declare const PostponedTransaction: mongoose.Model<IPostponedTransactionDoc, {}, {}, {}, mongoose.Document<unknown, {}, IPostponedTransactionDoc> & IPostponedTransactionDoc & {
+    _id: mongoose.Types.ObjectId;
+}, any>;

package/models/PostponedTransactions.model.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostponedTransaction = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const PostponedTransactionSchema = new mongoose_1.default.Schema({
+    postponedToDate: {
+        type: String,
+        required: true,
+    },
+    transactionId: {
+        type: mongoose_1.default.Types.ObjectId,
+        ref: 'loan_transactions',
+        required: true,
+    },
+    productId: {
+        type: mongoose_1.default.Types.ObjectId,
+        ref: 'loan_products',
+        required: true,
+    },
+    __v: {
+        type: Number,
+        select: false
+    },
+}, { timestamps: false });
+exports.PostponedTransaction = mongoose_1.default.model('postponed_transactions', PostponedTransactionSchema);

package/models/PostponedTransactions.model.ts

@@ -0,0 +1,42 @@
+import mongoose, { Document } from 'mongoose';
+
+import { ILoanTransactionDoc } from './LoanTransaction.model';
+
+export interface IPostponedTransaction {
+  postponedToDate: string;
+  transactionId: mongoose.Types.ObjectId;
+  productId: mongoose.Types.ObjectId;
+}
+
+export interface IPostponedTransactionDoc extends Document, IPostponedTransaction {
+}
+
+export interface IPostponedTransactionWithTransaction extends IPostponedTransactionDoc {
+  transaction: ILoanTransactionDoc
+}
+
+const PostponedTransactionSchema = new mongoose.Schema(
+  {
+    postponedToDate: {
+      type: String,
+      required: true,
+    },
+    transactionId: {
+      type: mongoose.Types.ObjectId,
+      ref: 'loan_transactions',
+      required: true,
+    },
+    productId: {
+      type: mongoose.Types.ObjectId,
+      ref: 'loan_products',
+      required: true,
+    },
+    __v: {
+      type: Number,
+      select: false
+    },
+  },
+  { timestamps: false }
+);
+
+export const PostponedTransaction = mongoose.model<IPostponedTransactionDoc>('postponed_transactions', PostponedTransactionSchema);

package/models/UserLog.model.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/models" />
+/// <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, { Model } from 'mongoose';
+export declare enum ELogType {
+    TRANSACTIONS_UPLOAD = "TRANSACTIONS_UPLOAD",
+    COLLATERAL_UPLOAD = "COLLATERAL_UPLOAD",
+    LOAN_TRANSACTION = "LOAN_TRANSACTION"
+}
+export declare enum ELogActionType {
+    UPLOAD = "UPLOAD",
+    CREATE = "CREATE",
+    EDIT = "EDIT",
+    DELETE = "DELETE"
+}
+export interface IUserLog {
+    _id?: mongoose.Types.ObjectId;
+    logType: ELogType;
+    userId: mongoose.Types.ObjectId;
+    timestamp: Date;
+    action: ELogActionType;
+    recordId: mongoose.Schema.Types.ObjectId;
+    recordCollection: string;
+    details: any;
+}
+export interface IUserLogWithLookup extends IUserLog {
+    record?: any;
+}
+type UserLogModel = Model<IUserLog, {}, {}>;
+export declare const UserLog: UserLogModel;
+export {};

package/models/UserLog.model.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserLog = exports.ELogActionType = exports.ELogType = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+var ELogType;
+(function (ELogType) {
+    ELogType["TRANSACTIONS_UPLOAD"] = "TRANSACTIONS_UPLOAD";
+    ELogType["COLLATERAL_UPLOAD"] = "COLLATERAL_UPLOAD";
+    ELogType["LOAN_TRANSACTION"] = "LOAN_TRANSACTION";
+})(ELogType || (exports.ELogType = ELogType = {}));
+var ELogActionType;
+(function (ELogActionType) {
+    ELogActionType["UPLOAD"] = "UPLOAD";
+    ELogActionType["CREATE"] = "CREATE";
+    ELogActionType["EDIT"] = "EDIT";
+    ELogActionType["DELETE"] = "DELETE";
+})(ELogActionType || (exports.ELogActionType = ELogActionType = {}));
+const UserLogSchema = new mongoose_1.default.Schema({
+    logType: {
+        type: String,
+        enum: Object.values(ELogType),
+        required: true,
+    },
+    userId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.users,
+        required: true,
+    },
+    timestamp: {
+        type: Date,
+        required: true,
+    },
+    action: {
+        type: String,
+        enum: Object.values(ELogActionType),
+        required: true,
+    },
+    recordId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+    },
+    recordCollection: {
+        type: String,
+    },
+    details: {
+        type: mongoose_1.default.Schema.Types.Mixed,
+        required: true,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: false },
+});
+exports.UserLog = mongoose_1.default.model('user_logs', UserLogSchema);

package/models/UserLog.model.ts

@@ -0,0 +1,72 @@
+import mongoose, { Model } from 'mongoose';
+
+import { MODEL_NAMES } from './_models';
+
+export enum ELogType {
+  TRANSACTIONS_UPLOAD = 'TRANSACTIONS_UPLOAD',
+  COLLATERAL_UPLOAD = 'COLLATERAL_UPLOAD',
+  LOAN_TRANSACTION = 'LOAN_TRANSACTION',
+}
+
+export enum ELogActionType {
+  UPLOAD = 'UPLOAD',
+  CREATE = 'CREATE',
+  EDIT = 'EDIT',
+  DELETE = 'DELETE',
+}
+
+export interface IUserLog {
+  _id?: mongoose.Types.ObjectId;
+  logType: ELogType;
+  userId: mongoose.Types.ObjectId;
+  timestamp: Date;
+  action: ELogActionType;
+  recordId: mongoose.Schema.Types.ObjectId;
+  recordCollection: string;
+  details: any;
+}
+
+export interface IUserLogWithLookup extends IUserLog {
+  record?: any;
+}
+
+type UserLogModel = Model<IUserLog, {}, {}>;
+
+const UserLogSchema = new mongoose.Schema<IUserLog, UserLogModel>(
+  {
+    logType: {
+      type: String,
+      enum: Object.values(ELogType),
+      required: true,
+    },
+    userId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.users,
+      required: true,
+    },
+    timestamp: {
+      type: Date,
+      required: true,
+    },
+    action: {
+      type: String,
+      enum: Object.values(ELogActionType),
+      required: true,
+    },
+    recordId: {
+      type: mongoose.Schema.Types.ObjectId,
+    },
+    recordCollection: {
+      type: String,
+    },
+    details: {
+      type: mongoose.Schema.Types.Mixed,
+      required: true,
+    },
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: false },
+  },
+);
+
+export const UserLog = mongoose.model<IUserLog, UserLogModel>('user_logs', UserLogSchema);

package/models/Yield.model.d.ts

@@ -0,0 +1,46 @@
+/// <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 Joi from 'joi';
+import mongoose, { Model } from 'mongoose';
+import { ISelectedMonth } from '../helpers';
+export declare const yieldParamsValidationSchema: Joi.ObjectSchema<IYieldParams>;
+export interface IYieldParams {
+    periodStart?: ISelectedMonth;
+    periodEnd?: ISelectedMonth;
+    forLifetime?: boolean;
+    ignoreOldData?: boolean;
+}
+export interface IYieldData {
+    _id?: mongoose.Types.ObjectId;
+    chargeId: mongoose.Types.ObjectId;
+    year: number;
+    month: number;
+    total: number;
+    averageBalance: number;
+    percent: number;
+}
+type IYieldDataModel = Model<IYieldData, {}, {}>;
+export declare const YieldData: IYieldDataModel;
+export {};

package/models/Yield.model.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YieldData = exports.yieldParamsValidationSchema = void 0;
+const joi_1 = __importDefault(require("joi"));
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+exports.yieldParamsValidationSchema = joi_1.default.object({
+    periodStart: joi_1.default.object({
+        month: joi_1.default.number().integer().min(1).max(12),
+        year: joi_1.default.number().integer().min(1900).max(9999),
+    }),
+    periodEnd: joi_1.default.object({
+        month: joi_1.default.number().integer().min(1).max(12),
+        year: joi_1.default.number().integer().min(1900).max(9999),
+    }),
+    forLifetime: joi_1.default.boolean(),
+    ignoreOldData: joi_1.default.boolean(),
+});
+const YieldDataSchema = new mongoose_1.default.Schema({
+    chargeId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.loanCharges,
+        required: true,
+    },
+    year: {
+        type: Number,
+        required: true,
+    },
+    month: {
+        type: Number,
+        required: true,
+    },
+    total: {
+        type: Number,
+    },
+    averageBalance: {
+        type: Number,
+    },
+    percent: {
+        type: Number,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+});
+exports.YieldData = mongoose_1.default.model(_models_1.MODEL_NAMES.yieldData, YieldDataSchema);