gemcap-be-common 1.0.6 → 1.0.7

package/package.json

@@ -1,18 +1,20 @@
 {
   "name": "gemcap-be-common",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "",
   "main": "index.js",
   "scripts": {
     "lib:build": "npx tsc",
     "lib:publish": "npm publish"
   },
-  "author": "",
+  "author": "Nick Elovsky",
   "license": "ISC",
   "dependencies": {
+    "express": "^4.18.2",
     "mongoose": "^6.10.5"
   },
   "devDependencies": {
+    "@types/express": "^4.17.17",
     "typescript": "^5.1.6"
   }
 }

package/src/enums/collaterals.enum.ts

@@ -0,0 +1,8 @@
+export enum ECollaterals {
+  INVENTORY = 'INVENTORY',
+  RECEIVABLE = 'RECEIVABLE',
+  ACCOUNT_PAYABLE = 'ACCOUNT_PAYABLE',
+  OTHER = 'OTHER',
+  CASH = 'CASH',
+  BANKS = 'BANKS',
+}

package/src/enums/data-types.enum.ts

@@ -0,0 +1,5 @@
+export enum EDataTypes {
+  STRING = 'string',
+  NUMBER = 'number',
+  DATE = 'date',
+}

package/src/enums/equipment-types.enum.ts

@@ -0,0 +1,6 @@
+export enum EEquipmentTypes {
+  EQUIPMENT = 'EQUIPMENT',
+  INTELLECTUAL_PROPERTY = 'INTELLECTUAL_PROPERTY',
+  REAL_ESTATE = 'REAL_ESTATE',
+  BOOT_COLLATERAL = 'BOOT_COLLATERAL',
+}

package/src/enums/item-progress-status.enum.ts

@@ -0,0 +1,5 @@
+export enum EItemProgressStatus {
+  IN_REVIEW = 'IN_REVIEW',
+  OVERDUE = 'OVERDUE',
+  DUE = 'DUE',
+}

package/src/enums/loan-charge-type.enum.ts

@@ -0,0 +1,8 @@
+export enum ELoanChargeType {
+  INTEREST_FEE = 'INTEREST_FEE',
+  ADMIN_FEE = 'ADMIN_FEE',
+  UNUSED_LINE_FEE = 'UNUSED_LINE_FEE',
+  ANNUAL_LINE_FEE = 'ANNUAL_LINE_FEE',
+  WIRE_FEE = 'WIRE_FEE',
+  OTHER = 'OTHER',
+}

package/src/enums/loan-types.enum.ts

@@ -0,0 +1,21 @@
+export enum ELoanTypes {
+  REVOLVER = 'REVOLVER',
+  TERM = 'TERM',
+}
+
+
+export enum EChargeFrequencies {
+  DAILY = 'DAILY',
+  MONTHLY = 'MONTHLY',
+  ANNUAL = 'ANNUAL',
+  DISBURSEMENT = 'DISBURSEMENT',
+}
+
+export enum EChargeCalculationBasis {
+  DAILY_BALANCE = 'DAILY_BALANCE',
+  AVERAGE_MONTHLY_BALANCE = 'AVERAGE_MONTHLY_BALANCE',
+  UNUSED_AMOUNT = 'UNUSED_AMOUNT',
+  COMMITMENT = 'COMMITMENT',
+  DISBURSEMENT_AMOUNT = 'DISBURSEMENT_AMOUNT',
+  ONE_TIME = 'ONE_TIME',
+}

package/src/enums/modules.enum.ts

@@ -0,0 +1,12 @@
+export enum EModules {
+  ACCOUNTING = 'accounting',
+  ADMIN = 'admin',
+  ANALYSIS = 'analysis',
+  AUTH = 'auth',
+  AVAILABILITY = 'availability',
+  BBC = 'bbc',
+  BORROWERS = 'borrowers',
+  COMPLIANCE = 'compliance',
+  LOAN_CHARGES = 'loan-charges',
+  LOAN_DETAILS = 'loan-details',
+}

package/src/enums/reserve-types.enum.ts

@@ -0,0 +1,10 @@
+export enum EReserveTypes {
+  RENT = 'RENT',
+  PAYROLL = 'PAYROLL',
+  INSURANCE = 'INSURANCE',
+  TAX = 'TAX',
+  INVENTORY = 'INVENTORY',
+  RECEIVABLES = 'RECEIVABLES',
+  EQUIPMENT = 'EQUIPMENT',
+  OTHER = 'OTHER',
+}

package/src/enums/upload-types.enum.ts

@@ -0,0 +1,4 @@
+export enum EUploadTypes {
+  BBC = 'BBC',
+  BANKS = 'BANKS',
+}

package/src/enums/user-types.enum.ts

@@ -0,0 +1,7 @@
+export enum EUserRoles {
+  ADMIN = 'admin',
+  USER = 'user',
+  USER_EXTERNAL = 'user-external',
+  READ_ONLY = 'read-only',
+  RESTRICTED = 'restricted',
+}

package/src/enums/validators.enums.ts

@@ -0,0 +1,7 @@
+export enum EValidators {
+  NOT_EMPTY,
+  IS_NUMBER,
+  NUMBER_GT_NULL,
+  NUMBER_GTE_NULL,
+  IS_DATE,
+}

package/src/interfaces/custom-row.interface.ts

@@ -0,0 +1,13 @@
+import { EValidators } from '../enums/validators.enums';
+import { EDataTypes } from '../enums/data-types.enum';
+
+export interface ICustomRow {
+  db_title: string;
+  title: string;
+  required: boolean;
+  hidden?: boolean;
+  items: Array<string | number>;
+  validators?: EValidators[];
+  isDate?: boolean;
+  dataType?: EDataTypes;
+}

package/src/interfaces/cync-loan-data.interface.ts

@@ -0,0 +1,23 @@
+export interface ILoanData {
+  clientId: string;
+  clientName: string;
+  loanSignedDate: string;
+  creditCeilingMax: number;
+  outstandingLoanBalance: number;
+  interestBalance: number;
+  feeBalance: number;
+  interestAccrued: number;
+  feeAccrued: number;
+}
+
+export interface IInquiryData {
+  clientId: string;
+  loanId: string;
+  date: string;
+  disbursement: number;
+  collections: string;
+  revolverBalance: number;
+  termBalance: number;
+  collateralName: string;
+  collateralBalance: number;
+}

package/src/interfaces/email-addresses.interface.ts

@@ -0,0 +1,11 @@
+import { IEmailRecipient, IEmailRecipientDocument } from '../models/ComplianceItem.model';
+
+export interface IGroupedEmailsUpdate {
+  _id: string;
+  isEmailingActive: boolean;
+  mainEmails: IEmailRecipient[];
+  financialEmails: IEmailRecipient[];
+  groupedEmails: {
+    [itemId: string]: IEmailRecipientDocument[]
+  },
+}

package/src/interfaces/email.interface.ts

@@ -0,0 +1,6 @@
+export interface IEmail {
+  addresses: string[];
+  subject: string;
+  text: string;
+  customData?: any;
+}

package/src/interfaces/group.interface.ts

@@ -0,0 +1,11 @@
+import mongoose from 'mongoose';
+
+export interface IBorrowerGroup {
+  groupName: string;
+  borrowerId: mongoose.Schema.Types.ObjectId;
+  items: string[];
+}
+
+export interface IBorrowerGroupWithId extends IBorrowerGroup {
+  _id?: string;
+}

package/src/interfaces/keycloak-role.interface.ts

@@ -0,0 +1,16 @@
+export interface IKeycloakRole {
+  clientRole: boolean;
+  composite: boolean;
+  containerId: string;
+  description: string;
+  id: string;
+  name: string;
+}
+
+export interface IKeycloakRoleWithRepresentation extends IKeycloakRole {
+  representation: string;
+}
+
+export interface IGroupedKeycloakRoles {
+  [module: string]: IKeycloakRoleWithRepresentation[];
+}

package/src/interfaces/keycloak-user.interface.ts

@@ -0,0 +1,29 @@
+import { IGroupedKeycloakRoles } from './keycloak-role.interface';
+
+export interface IKeycloakUser {
+  id: string;
+  username: string;
+  firstName: string;
+  lastName: string;
+  enabled: boolean;
+  email: string;
+  emailVerified: boolean;
+  access: {
+    manageGroupMembership: boolean;
+    view: boolean;
+    mapRoles: boolean;
+    impersonate: boolean,
+    manage: boolean
+  };
+  impersonate: boolean;
+  manage: boolean;
+  manageGroupMembership: boolean;
+  mapRoles: boolean;
+  view: boolean;
+  createdTimestamp: number;
+  disableableCredentialTypes: any[];
+  notBefore: number;
+  requiredActions: any[];
+  totp: boolean;
+  roles?: IGroupedKeycloakRoles;
+}

package/src/interfaces/multer.interface.ts

@@ -0,0 +1,19 @@
+import { Request } from 'express';
+
+export interface IMulterFile {
+  fieldname: string;
+  originalname: string;
+  encoding: string;
+  mimetype: string;
+  buffer?: Buffer;
+  filename?: string;
+  path?: string;
+  size: number;
+}
+
+export interface IRequestForMulter extends Request {
+  files: IMulterFile[];
+  uuid: string;
+  folder: string;
+  params: any;
+}

package/src/interfaces/plaid-data.interface.ts

@@ -0,0 +1,62 @@
+export interface IPlaidBalance {
+  available: number;
+  current: number;
+  iso_currency_code: string;
+  limit: number;
+  unofficial_currency_code: string;
+}
+
+export interface IPlaidAccount {
+  account_id: string;
+  mask: string;
+  name: string;
+  official_name: string;
+  subtype: string;
+  type: string;
+}
+
+export type PlaidAccount = IPlaidAccount & { balances: IPlaidBalance };
+
+export interface IPlaidTransaction {
+  account_id: string;
+  account_owner: any;
+  amount: number;
+  authorized_date: string;
+  authorized_datetime: string;
+  category: string[];
+  category_id: string;
+  check_number: any;
+  date: string;
+  datetime: string;
+  iso_currency_code: string;
+  location: {
+    address: string,
+    city: string,
+    country: string,
+    lat: number,
+    lon: number,
+    postal_code: string,
+    region: string;
+    store_number: string;
+  };
+  merchant_name: string;
+  name: string;
+  payment_channel: string;
+  payment_meta: {
+    by_order_of: any;
+    payee: any;
+    payer: any;
+    payment_method: any;
+    payment_processor: any;
+    ppd_id: any;
+    reason: any;
+    reference_number: any;
+  };
+  pending: boolean;
+  pending_transaction_id: any;
+  personal_finance_category: any;
+  transaction_code: any;
+  transaction_id: string;
+  transaction_type: string;
+  unofficial_currency_code: string;
+}

package/src/interfaces/query.interface.ts

@@ -0,0 +1,12 @@
+import { ECollaterals } from '../enums/collaterals.enum';
+
+export interface IQueryDescription {
+  type: ECollaterals;
+  name: string;
+  title: string;
+  queryOnStartApiRoute: string;
+  queryApiRoute: string;
+  params: {
+    bbcDateId: string
+  };
+}

package/src/interfaces/result.interface.ts

@@ -0,0 +1,4 @@
+export interface IResult {
+  message: string;
+  success: boolean;
+}

package/src/interfaces/upload-data.interface.ts

@@ -0,0 +1,16 @@
+import { IPaginatorOptions } from './collaterals.interface';
+
+export interface IUploadData {
+  borrowerId: string;
+  bbcDate: Date;
+  uploadUser: string;
+  fileHash: string;
+  fileName: string;
+  sheetName: string;
+}
+
+export interface IUploadedDataView {
+  totalItems: number;
+  items: {}[];
+  paginatorOptions: IPaginatorOptions;
+}

package/src/models/ComplianceItem.model.ts

@@ -0,0 +1,81 @@
+import mongoose, { Document } from 'mongoose';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export interface IEmailRecipient {
+  email: string;
+  title?: string;
+  isActive: boolean;
+}
+
+export interface IEmailRecipientDocument extends IEmailRecipient, Document {
+}
+
+export interface IComplianceItem {
+  name: string;
+  importanceScore: number;
+  notificationDays: number;
+  multiplier: number;
+}
+
+export interface IBorrowerItem {
+  item: IComplianceItemDocument;
+  startDate: Date;
+  frequency: string;
+  instances: IBorrowerItemInstanceDocument[];
+  emailAddresses: IEmailRecipientDocument[];
+}
+
+export interface IComplianceFile {
+  _id?: string;
+  fileId: string;
+  name: string;
+  isFileNew?: boolean;
+  uploadedAt?: Date;
+  uploadedBy?: string;
+}
+
+export interface IBorrowerItemInstance {
+  nextDate: Date;
+  submittedDate: Date;
+  status: string;
+  files?: IComplianceFile[];
+}
+
+
+export interface IBorrowerItemInstanceDocument extends IBorrowerItemInstance, Document {
+}
+
+export interface IComplianceItemDocument extends IComplianceItem, Document {
+}
+
+export interface IBorrowerItemDocument extends IBorrowerItem, Document {
+}
+
+const ComplianceItemSchema = new mongoose.Schema(
+  {
+    name: {
+      type: String,
+      trim: true,
+      required: true,
+    },
+    importanceScore: {
+      type: Number,
+      required: true,
+    },
+    notificationDays: {
+      type: Number,
+      required: true,
+    },
+    multiplier: {
+      type: Number,
+      required: true,
+    },
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true }
+);
+
+ComplianceItemSchema.plugin(mongooseLeanId);
+
+export default mongoose.model<IComplianceItemDocument>('complianceItems', ComplianceItemSchema);

package/src/models/InventoryAvailability.model.ts

@@ -1,7 +1,7 @@
 import mongoose from 'mongoose';
 
 import { IInventoryItemDocWithCalculation } from './InventoryItem.model';
-import { EInventoryAvailabilityResults } from '../enum/inventory-availability-results.enum';
+import { EInventoryAvailabilityResults } from '../enums/inventory-availability-results.enum';
 import { IPaginatorOptions } from '../interfaces/collaterals.interface';
 
 const mongooseLeanId = require('../plugins/id.plugin');