gemcap-be-common 1.2.140 → 1.3.0

package/models/CustomerAPGroup.model.ts

@@ -0,0 +1,31 @@
+import mongoose, { Document } from 'mongoose';
+
+import { IBorrowerGroup } from '../interfaces/group.interface';
+import { MODEL_NAMES } from './_models';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+interface ICustomerAPGroupDocument extends IBorrowerGroup, Document {
+}
+
+const CustomerAPGroupSchema = new mongoose.Schema(
+  {
+    groupName: {
+      type: String,
+      trim: true,
+      required: true,
+    },
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.complianceItems,
+      required: true,
+    },
+    items: [String],
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true }
+);
+
+CustomerAPGroupSchema.plugin(mongooseLeanId);
+
+export default mongoose.model<ICustomerAPGroupDocument>(MODEL_NAMES.customerAPGroups, CustomerAPGroupSchema);

package/models/Equipment.model.d.ts

@@ -0,0 +1,53 @@
+/// <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';
+export interface IEquipmentSummaryItem {
+    amount: number;
+    advanceRate: number;
+    availability: number;
+}
+export interface IEquipmentSummary {
+    [summaryField: string]: IEquipmentSummaryItem;
+}
+export interface IEquipmentItem {
+    active: boolean;
+    inventoryName: string;
+    type: string;
+    amount: number;
+    advanceRate: number;
+    productId: mongoose.Types.ObjectId;
+}
+export interface IEquipment {
+    borrowerId: mongoose.Types.ObjectId;
+    date: Date;
+    items: IEquipmentItem[];
+    summary: IEquipmentSummary;
+}
+export interface IEquipmentDoc extends IEquipment, Document {
+}
+declare const _default: mongoose.Model<IEquipmentDoc, {}, {}, {}, mongoose.Document<unknown, {}, IEquipmentDoc> & IEquipmentDoc & {
+    _id: mongoose.Types.ObjectId;
+}, any>;
+export default _default;

package/models/Equipment.model.js

@@ -0,0 +1,140 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongoose_1 = __importDefault(require("mongoose"));
+const equipment_types_enum_1 = require("../enums/equipment-types.enum");
+const _models_1 = require("./_models");
+const mongooseLeanId = require('../plugins/id.plugin');
+const EquipmentSchema = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.borrowers,
+        required: true,
+    },
+    date: {
+        type: Date,
+        required: true,
+    },
+    summary: {
+        [equipment_types_enum_1.EEquipmentTypes.EQUIPMENT]: {
+            amount: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+        },
+        [equipment_types_enum_1.EEquipmentTypes.REAL_ESTATE]: {
+            amount: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+        },
+        [equipment_types_enum_1.EEquipmentTypes.BOOT_COLLATERAL]: {
+            amount: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+        },
+        netTotal: {
+            amount: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+        },
+        [equipment_types_enum_1.EEquipmentTypes.INTELLECTUAL_PROPERTY]: {
+            amount: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+        },
+        grossTotal: {
+            amount: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+        },
+    },
+    items: [
+        {
+            active: {
+                type: Boolean,
+                required: true,
+            },
+            inventoryName: {
+                type: String,
+                trim: true,
+                required: true,
+            },
+            type: {
+                type: String,
+                required: true,
+                trim: true,
+            },
+            amount: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: false,
+            },
+            productId: {
+                type: mongoose_1.default.Types.ObjectId,
+                ref: _models_1.MODEL_NAMES.loanProducts,
+                required: false,
+            }
+        },
+    ],
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+EquipmentSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model(_models_1.MODEL_NAMES.equipment, EquipmentSchema);

package/models/Equipment.model.ts

@@ -0,0 +1,172 @@
+import mongoose, { Document } from 'mongoose';
+
+import { EEquipmentTypes } from '../enums/equipment-types.enum';
+import { MODEL_NAMES } from './_models';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export interface IEquipmentSummaryItem {
+  amount: number;
+  advanceRate: number;
+  availability: number;
+}
+
+export interface IEquipmentSummary {
+  [summaryField: string]: IEquipmentSummaryItem
+}
+
+export interface IEquipmentItem {
+  active: boolean;
+  inventoryName: string;
+  type: string;
+  amount: number;
+  advanceRate: number;
+  productId: mongoose.Types.ObjectId;
+}
+
+export interface IEquipment {
+  borrowerId: mongoose.Types.ObjectId;
+  date: Date;
+  items: IEquipmentItem[];
+  summary: IEquipmentSummary;
+}
+
+export interface IEquipmentDoc extends IEquipment, Document {
+}
+
+const EquipmentSchema = new mongoose.Schema(
+  {
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.borrowers,
+      required: true,
+    },
+    date: {
+      type: Date,
+      required: true,
+    },
+    summary: {
+      [EEquipmentTypes.EQUIPMENT]: {
+        amount: {
+          type: Number,
+          required: true,
+        },
+        availability: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: true,
+        },
+      },
+      [EEquipmentTypes.REAL_ESTATE]: {
+        amount: {
+          type: Number,
+          required: true,
+        },
+        availability: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: true,
+        },
+      },
+      [EEquipmentTypes.BOOT_COLLATERAL]: {
+        amount: {
+          type: Number,
+          required: true,
+        },
+        availability: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: true,
+        },
+      },
+      netTotal: {
+        amount: {
+          type: Number,
+          required: true,
+        },
+        availability: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: true,
+        },
+      },
+      [EEquipmentTypes.INTELLECTUAL_PROPERTY]: {
+        amount: {
+          type: Number,
+          required: true,
+        },
+        availability: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: true,
+        },
+      },
+      grossTotal: {
+        amount: {
+          type: Number,
+          required: true,
+        },
+        availability: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: true,
+        },
+      },
+    },
+    items: [
+      {
+        active: {
+          type: Boolean,
+          required: true,
+        },
+        inventoryName: {
+          type: String,
+          trim: true,
+          required: true,
+        },
+        type: {
+          type: String,
+          required: true,
+          trim: true,
+        },
+        amount: {
+          type: Number,
+          required: true,
+        },
+        advanceRate: {
+          type: Number,
+          required: false,
+        },
+        productId: {
+          type: mongoose.Types.ObjectId,
+          ref: MODEL_NAMES.loanProducts,
+          required: false,
+        }
+      },
+    ],
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true }
+);
+
+EquipmentSchema.plugin(mongooseLeanId);
+
+export default mongoose.model<IEquipmentDoc>(MODEL_NAMES.equipment, EquipmentSchema);

package/models/FinancialCompliance.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 { IEmailRecipient } from './ComplianceItem.model';
+export interface IFinancialComplianceSettings {
+    invoiceSentDate: Date;
+    dueDate: Date;
+    stopFundingDate: Date;
+    managementEmails?: IEmailRecipient[];
+    financialEmails?: IEmailRecipient[];
+}
+export interface IFinancialComplianceSettingsDocument extends IFinancialComplianceSettings, Document {
+}
+declare const _default: mongoose.Model<IFinancialComplianceSettingsDocument, {}, {}, {}, mongoose.Document<unknown, {}, IFinancialComplianceSettingsDocument> & IFinancialComplianceSettingsDocument & {
+    _id: mongoose.Types.ObjectId;
+}, any>;
+export default _default;

package/models/FinancialCompliance.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 });
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+const mongooseLeanId = require('../plugins/id.plugin');
+const FinancialComplianceSettingsSchema = new mongoose_1.default.Schema({
+    isDeleted: {
+        type: Boolean,
+        default: false
+    },
+    invoiceSentDate: {
+        type: Date,
+        required: false,
+        default: null,
+    },
+    dueDate: {
+        type: Date,
+        required: false,
+        default: null,
+    },
+    stopFundingDate: {
+        type: Date,
+        required: false,
+        default: null,
+    },
+    managementEmails: [{
+            email: {
+                type: String,
+                trim: true,
+                required: false,
+            },
+            title: {
+                type: String,
+                trim: true,
+                required: false,
+            },
+            isActive: {
+                type: Boolean,
+                required: false,
+            }
+        }],
+    financialEmails: [{
+            email: {
+                type: String,
+                trim: true,
+                required: false,
+            },
+            title: {
+                type: String,
+                trim: true,
+                required: false,
+            },
+            isActive: {
+                type: Boolean,
+                required: false,
+            }
+        }],
+    __v: { type: Number, select: false },
+});
+FinancialComplianceSettingsSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model(_models_1.MODEL_NAMES.financialComplianceSettings, FinancialComplianceSettingsSchema);

package/models/FinancialCompliance.model.ts

@@ -0,0 +1,78 @@
+import mongoose, { Document } from 'mongoose';
+
+import { IEmailRecipient } from './ComplianceItem.model';
+import { MODEL_NAMES } from './_models';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export interface IFinancialComplianceSettings {
+  invoiceSentDate: Date;
+  dueDate: Date;
+  stopFundingDate: Date;
+  managementEmails?: IEmailRecipient[];
+  financialEmails?: IEmailRecipient[];
+}
+
+export interface IFinancialComplianceSettingsDocument extends IFinancialComplianceSettings, Document {
+}
+
+const FinancialComplianceSettingsSchema = new mongoose.Schema(
+  {
+    isDeleted: {
+      type: Boolean,
+      default: false
+    },
+    invoiceSentDate: {
+      type: Date,
+      required: false,
+      default: null,
+    },
+    dueDate: {
+      type: Date,
+      required: false,
+      default: null,
+    },
+    stopFundingDate: {
+      type: Date,
+      required: false,
+      default: null,
+    },
+    managementEmails: [{
+      email: {
+        type: String,
+        trim: true,
+        required: false,
+      },
+      title: {
+        type: String,
+        trim: true,
+        required: false,
+      },
+      isActive: {
+        type: Boolean,
+        required: false,
+      }
+    }],
+    financialEmails: [{
+      email: {
+        type: String,
+        trim: true,
+        required: false,
+      },
+      title: {
+        type: String,
+        trim: true,
+        required: false,
+      },
+      isActive: {
+        type: Boolean,
+        required: false,
+      }
+    }],
+    __v: { type: Number, select: false },
+  }
+);
+
+FinancialComplianceSettingsSchema.plugin(mongooseLeanId);
+
+export default mongoose.model<IFinancialComplianceSettingsDocument>(MODEL_NAMES.financialComplianceSettings, FinancialComplianceSettingsSchema);

package/models/FinancialComplianceBorrower.model.d.ts

@@ -0,0 +1,58 @@
+/// <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 { IBorrowerDocument } from './Borrower.model';
+import { IEmailRecipient } from './ComplianceItem.model';
+export interface IFinancialComplianceBorrowerSettings {
+    invoiceSentDate: Date;
+    dueDate: Date;
+    stopFundingDate: Date;
+    lastReminderSentAt: Date;
+    accountClearedDate: Date;
+    amountOwed: number;
+    addToLoan: boolean;
+    willPayIn: boolean;
+    transferDone: boolean;
+    amountReceived: number;
+    balanceOutstanding: number;
+    reminderCounter: number;
+}
+export interface IFinancialComplianceBorrower extends IFinancialComplianceBorrowerSettings {
+    borrower: IBorrowerDocument;
+}
+export interface IFinancialComplianceBorrowerDocument extends IFinancialComplianceBorrower, Document {
+}
+export interface IFinancialComplianceBorrowerDocumentWithEmailingStatus extends IFinancialComplianceBorrowerDocument {
+    isEmailingActive: boolean;
+    isDailyTransactionsEmailingActive: boolean;
+}
+export interface IFinancialComplianceBorrowerDocumentWithMails extends IFinancialComplianceBorrowerDocument {
+    mainEmails: IEmailRecipient[];
+    financialEmails: IEmailRecipient[];
+}
+declare const _default: mongoose.Model<IFinancialComplianceBorrowerDocument, {}, {}, {}, mongoose.Document<unknown, {}, IFinancialComplianceBorrowerDocument> & IFinancialComplianceBorrowerDocument & {
+    _id: mongoose.Types.ObjectId;
+}, any>;
+export default _default;