gemcap-be-common 1.5.129 → 1.5.130

package/db/brokers.db.d.ts

@@ -1,13 +1,4 @@
 /// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/document" />
-/// <reference types="mongoose/types/models" />
-/// <reference types="mongoose/types/collection" />
-/// <reference types="mongoose/types/connection" />
-/// <reference types="mongoose/types/query" />
-/// <reference types="mongoose/types/error" />
-/// <reference types="mongoose/types/populate" />
-/// <reference types="mongoose/types/utility" />
-/// <reference types="mongoose/types/schemaoptions" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -35,166 +26,23 @@
 import mongoose from 'mongoose';
 import { ILedgerDataRow } from './reports.db';
 import { ILoanProductDoc } from '../models/LoanProducts.model';
-import { IProductBrokerDocWithBroker } from '../models/ProductBroker.model';
-export declare const getProductBrokers: (productId: string) => Promise<IProductBrokerDocWithBroker[]>;
+import { IProductBrokerDocWithLoanBroker } from '../models/ProductBroker.model';
+export declare const getProductBrokers: (productId: string) => Promise<IProductBrokerDocWithLoanBroker[]>;
 export declare const enrichWithBrokers: (transactions: ILedgerDataRow[], product: ILoanProductDoc) => Promise<ILedgerDataRow[]>;
-export declare const getBorrowerBrokers: (borrowerId: string) => Promise<(mongoose.FlattenMaps<import("../models/ProductBroker.model").IProductBrokerDoc> & Required<{
+export declare const getBorrowerBrokers: (borrowerId: string) => Promise<(mongoose.FlattenMaps<import("../models/ProductBroker.model").IProductBroker> & {
     _id: mongoose.Types.ObjectId;
-}>)[]>;
-export declare const getAllProductBrokers: () => Promise<(mongoose.FlattenMaps<import("../models/ProductBroker.model").IProductBrokerDoc> & Required<{
+})[]>;
+export declare const getAllProductBrokers: () => Promise<(mongoose.FlattenMaps<import("../models/ProductBroker.model").IProductBroker> & {
     _id: mongoose.Types.ObjectId;
-}>)[]>;
+})[]>;
 export declare const getAllLoanBrokers: () => Promise<{
     emails: mongoose.FlattenMaps<import("../models/LoanBroker.model").ILoanBrokerEmail>[];
+    uiId: string;
     order: number;
     active: boolean;
     name: string;
-    _id: any;
-    __v?: any;
-    $assertPopulated: <Paths = {}>(path: string | string[], values?: Partial<Paths>) => Omit<import("../models/LoanBroker.model").ILoanBrokerDoc, keyof Paths> & Paths;
-    $clone: () => import("../models/LoanBroker.model").ILoanBrokerDoc;
-    $getAllSubdocs: () => mongoose.Document<any, any, any>[];
-    $ignore: (path: string) => void;
-    $isDefault: (path: string) => boolean;
-    $isDeleted: (val?: boolean) => boolean;
-    $getPopulatedDocs: () => mongoose.Document<any, any, any>[];
-    $inc: (path: string | string[], val?: number) => import("../models/LoanBroker.model").ILoanBrokerDoc;
-    $isEmpty: (path: string) => boolean;
-    $isValid: (path: string) => boolean;
-    $locals: mongoose.FlattenMaps<Record<string, unknown>>;
-    $markValid: (path: string) => void;
-    $model: {
-        <ModelType = mongoose.Model<unknown, {}, {}, {}, mongoose.Document<unknown, {}, unknown> & Required<{
-            _id: unknown;
-        }>, any>>(name: string): ModelType;
-        <ModelType_1 = mongoose.Model<any, {}, {}, {}, any, any>>(): ModelType_1;
-    };
-    $op: "save" | "validate" | "remove";
-    $session: (session?: mongoose.mongo.ClientSession) => mongoose.mongo.ClientSession;
-    $set: {
-        (path: string | Record<string, any>, val: any, type: any, options?: mongoose.DocumentSetOptions): import("../models/LoanBroker.model").ILoanBrokerDoc;
-        (path: string | Record<string, any>, val: any, options?: mongoose.DocumentSetOptions): import("../models/LoanBroker.model").ILoanBrokerDoc;
-        (value: string | Record<string, any>): import("../models/LoanBroker.model").ILoanBrokerDoc;
-    };
-    $where: mongoose.FlattenMaps<Record<string, unknown>>;
-    baseModelName?: string;
-    collection: mongoose.Collection<mongoose.mongo.BSON.Document>;
-    db: mongoose.FlattenMaps<mongoose.Connection>;
-    deleteOne: (options?: mongoose.QueryOptions<unknown>) => any;
-    depopulate: (path?: string | string[]) => import("../models/LoanBroker.model").ILoanBrokerDoc;
-    directModifiedPaths: () => string[];
-    equals: (doc: mongoose.Document<any, any, any>) => boolean;
-    errors?: mongoose.Error.ValidationError;
-    get: {
-        <T extends string | number | symbol>(path: T, type?: any, options?: any): any;
-        (path: string, type?: any, options?: any): any;
-    };
-    getChanges: () => mongoose.UpdateQuery<import("../models/LoanBroker.model").ILoanBrokerDoc>;
-    id?: any;
-    increment: () => import("../models/LoanBroker.model").ILoanBrokerDoc;
-    init: (obj: mongoose.AnyObject, opts?: mongoose.AnyObject) => import("../models/LoanBroker.model").ILoanBrokerDoc;
-    invalidate: {
-        <T_1 extends string | number | symbol>(path: T_1, errorMsg: string | NativeError, value?: any, kind?: string): NativeError;
-        (path: string, errorMsg: string | NativeError, value?: any, kind?: string): NativeError;
-    };
-    isDirectModified: {
-        <T_2 extends string | number | symbol>(path: T_2 | T_2[]): boolean;
-        (path: string | string[]): boolean;
-    };
-    isDirectSelected: {
-        <T_3 extends string | number | symbol>(path: T_3): boolean;
-        (path: string): boolean;
-    };
-    isInit: {
-        <T_4 extends string | number | symbol>(path: T_4): boolean;
-        (path: string): boolean;
-    };
-    isModified: {
-        <T_5 extends string | number | symbol>(path?: T_5 | T_5[], options?: {
-            ignoreAtomics?: boolean;
-        }): boolean;
-        (path?: string | string[], options?: {
-            ignoreAtomics?: boolean;
-        }): boolean;
-    };
-    isNew: boolean;
-    isSelected: {
-        <T_6 extends string | number | symbol>(path: T_6): boolean;
-        (path: string): boolean;
-    };
-    markModified: {
-        <T_7 extends string | number | symbol>(path: T_7, scope?: any): void;
-        (path: string, scope?: any): void;
-    };
-    model: {
-        <ModelType_2 = mongoose.Model<unknown, {}, {}, {}, mongoose.Document<unknown, {}, unknown> & Required<{
-            _id: unknown;
-        }>, any>>(name: string): ModelType_2;
-        <ModelType_3 = mongoose.Model<any, {}, {}, {}, any, any>>(): ModelType_3;
-    };
-    modifiedPaths: (options?: {
-        includeChildren?: boolean;
-    }) => string[];
-    overwrite: (obj: mongoose.AnyObject) => import("../models/LoanBroker.model").ILoanBrokerDoc;
-    $parent: () => mongoose.Document<any, any, any>;
-    populate: {
-        <Paths_1 = {}>(path: string | mongoose.PopulateOptions | (string | mongoose.PopulateOptions)[]): Promise<mongoose.MergeType<import("../models/LoanBroker.model").ILoanBrokerDoc, Paths_1>>;
-        <Paths_2 = {}>(path: string, select?: string | mongoose.AnyObject, model?: mongoose.Model<any, {}, {}, {}, any, any>, match?: mongoose.AnyObject, options?: mongoose.PopulateOptions): Promise<mongoose.MergeType<import("../models/LoanBroker.model").ILoanBrokerDoc, Paths_2>>;
-    };
-    populated: (path: string) => any;
-    replaceOne: (replacement?: mongoose.AnyObject, options?: mongoose.QueryOptions<unknown>) => mongoose.Query<any, import("../models/LoanBroker.model").ILoanBrokerDoc, {}, import("../models/LoanBroker.model").ILoanBrokerDoc, "find">;
-    save: (options?: mongoose.SaveOptions) => Promise<import("../models/LoanBroker.model").ILoanBrokerDoc>;
-    schema: mongoose.FlattenMaps<mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
-        [x: string]: unknown;
-    }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
-        [x: string]: unknown;
-    }>> & mongoose.FlatRecord<{
-        [x: string]: unknown;
-    }> & Required<{
-        _id: unknown;
-    }>>>;
-    set: {
-        <T_8 extends string | number | symbol>(path: T_8, val: any, type: any, options?: mongoose.DocumentSetOptions): import("../models/LoanBroker.model").ILoanBrokerDoc;
-        (path: string | Record<string, any>, val: any, type: any, options?: mongoose.DocumentSetOptions): import("../models/LoanBroker.model").ILoanBrokerDoc;
-        (path: string | Record<string, any>, val: any, options?: mongoose.DocumentSetOptions): import("../models/LoanBroker.model").ILoanBrokerDoc;
-        (value: string | Record<string, any>): import("../models/LoanBroker.model").ILoanBrokerDoc;
-    };
-    toJSON: {
-        <T_9 = any>(options?: mongoose.ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{
-            _id: unknown;
-        }>> & {
-            flattenMaps?: true;
-        }): mongoose.FlattenMaps<T_9>;
-        <T_10 = any>(options: mongoose.ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{
-            _id: unknown;
-        }>> & {
-            flattenMaps: false;
-        }): T_10;
-    };
-    toObject: <T_11 = any>(options?: mongoose.ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{
-        _id: unknown;
-    }>>) => mongoose.Require_id<T_11>;
-    unmarkModified: {
-        <T_12 extends string | number | symbol>(path: T_12): void;
-        (path: string): void;
-    };
-    updateOne: (update?: mongoose.UpdateWithAggregationPipeline | mongoose.UpdateQuery<import("../models/LoanBroker.model").ILoanBrokerDoc>, options?: mongoose.QueryOptions<unknown>) => mongoose.Query<any, import("../models/LoanBroker.model").ILoanBrokerDoc, {}, import("../models/LoanBroker.model").ILoanBrokerDoc, "find">;
-    validate: {
-        <T_13 extends string | number | symbol>(pathsToValidate?: T_13 | T_13[], options?: mongoose.AnyObject): Promise<void>;
-        (pathsToValidate?: mongoose.PathsToValidate, options?: mongoose.AnyObject): Promise<void>;
-        (options: {
-            pathsToSkip?: mongoose.pathsToSkip;
-        }): Promise<void>;
-    };
-    validateSync: {
-        (options: {
-            [k: string]: any;
-            pathsToSkip?: mongoose.pathsToSkip;
-        }): mongoose.Error.ValidationError;
-        <T_14 extends string | number | symbol>(pathsToValidate?: T_14 | T_14[], options?: mongoose.AnyObject): mongoose.Error.ValidationError;
-        (pathsToValidate?: mongoose.PathsToValidate, options?: mongoose.AnyObject): mongoose.Error.ValidationError;
-    };
+    _id: mongoose.Types.ObjectId;
 }[]>;
-export declare const getBrokerProducts: (loanBrokerId: string) => Promise<(mongoose.FlattenMaps<import("../models/ProductBroker.model").IProductBrokerDoc> & Required<{
+export declare const getBrokerProducts: (loanBrokerId: string) => Promise<(mongoose.FlattenMaps<import("../models/ProductBroker.model").IProductBroker> & {
     _id: mongoose.Types.ObjectId;
-}>)[]>;
+})[]>;

package/db/brokers.db.js

@@ -11,7 +11,7 @@ const reports_db_1 = require("./reports.db");
 const ProductBroker_model_1 = require("../models/ProductBroker.model");
 const LoanBroker_model_1 = require("../models/LoanBroker.model");
 const getProductBrokers = async (productId) => {
-    return ProductBroker_model_1.ProductBrokerModel.aggregate([
+    return ProductBroker_model_1.ProductBroker.aggregate([
         {
             '$match': {
                 'productId': new mongoose_1.default.Types.ObjectId(productId),
@@ -63,21 +63,21 @@ const enrichWithBrokers = async (transactions, product) => {
 };
 exports.enrichWithBrokers = enrichWithBrokers;
 const getBorrowerBrokers = async (borrowerId) => {
-    return ProductBroker_model_1.ProductBrokerModel
+    return ProductBroker_model_1.ProductBroker
         .find({ borrowerId }, { createdAt: 0, updatedAt: 0, __v: 0 })
         .sort({ order: 1 })
         .lean();
 };
 exports.getBorrowerBrokers = getBorrowerBrokers;
 const getAllProductBrokers = async () => {
-    return ProductBroker_model_1.ProductBrokerModel
+    return ProductBroker_model_1.ProductBroker
         .find({}, { createdAt: 0, updatedAt: 0, __v: 0 })
         .sort({ order: 1 })
         .lean();
 };
 exports.getAllProductBrokers = getAllProductBrokers;
 const getAllLoanBrokers = async () => {
-    const results = await LoanBroker_model_1.LoanBrokerModel
+    const results = await LoanBroker_model_1.LoanBroker
         .find({}, { createdAt: 0, updatedAt: 0, __v: 0 })
         .sort({ order: 1 })
         .lean();
@@ -88,7 +88,7 @@ const getAllLoanBrokers = async () => {
 };
 exports.getAllLoanBrokers = getAllLoanBrokers;
 const getBrokerProducts = async (loanBrokerId) => {
-    return ProductBroker_model_1.ProductBrokerModel
+    return ProductBroker_model_1.ProductBroker
         .find({ loanBrokerId }, { createdAt: 0, updatedAt: 0, __v: 0 })
         .sort({ order: 1, BSCode: 1, PLCode: 1 })
         .lean();

package/db/brokers.db.ts

@@ -4,11 +4,11 @@ import mongoose from 'mongoose';
 import { MODEL_NAMES } from '../models/_models';
 import { EChargeType, ILedgerDataRow } from './reports.db';
 import { ILoanProductDoc } from '../models/LoanProducts.model';
-import { IProductBrokerDocWithBroker, ProductBrokerModel } from '../models/ProductBroker.model';
-import { LoanBrokerModel } from '../models/LoanBroker.model';
+import { IProductBrokerDocWithLoanBroker, ProductBroker } from '../models/ProductBroker.model';
+import { LoanBroker } from '../models/LoanBroker.model';
 
 export const getProductBrokers = async (productId: string) => {
-  return ProductBrokerModel.aggregate<IProductBrokerDocWithBroker>([
+  return ProductBroker.aggregate<IProductBrokerDocWithLoanBroker>([
     {
       '$match': {
         'productId': new mongoose.Types.ObjectId(productId),
@@ -38,7 +38,7 @@ export const enrichWithBrokers = async (transactions: ILedgerDataRow[], product:
   if (productBrokers.length === 0) {
     return transactions;
   }
-  const handleFee = (t: ILedgerDataRow, broker: IProductBrokerDocWithBroker, shareName: 'adminShare' | 'interestShare' | 'otherShare'): ILedgerDataRow => {
+  const handleFee = (t: ILedgerDataRow, broker: IProductBrokerDocWithLoanBroker, shareName: 'adminShare' | 'interestShare' | 'otherShare'): ILedgerDataRow => {
     return {
       ...t,
       statementAmount: new Decimal(-t.statementAmount).mul(broker[shareName]).toDP(2).toNumber(),
@@ -50,9 +50,9 @@ export const enrichWithBrokers = async (transactions: ILedgerDataRow[], product:
   };
 
   const handlers = {
-    [EChargeType.ADMIN_FEE]: (t: ILedgerDataRow, broker: IProductBrokerDocWithBroker) => handleFee(t, broker, 'adminShare'),
-    [EChargeType.INTEREST_FEE]: (t: ILedgerDataRow, broker: IProductBrokerDocWithBroker) => handleFee(t, broker, 'interestShare'),
-    [EChargeType.OTHER]: (t: ILedgerDataRow, broker: IProductBrokerDocWithBroker) => handleFee(t, broker, 'otherShare'),
+    [EChargeType.ADMIN_FEE]: (t: ILedgerDataRow, broker: IProductBrokerDocWithLoanBroker) => handleFee(t, broker, 'adminShare'),
+    [EChargeType.INTEREST_FEE]: (t: ILedgerDataRow, broker: IProductBrokerDocWithLoanBroker) => handleFee(t, broker, 'interestShare'),
+    [EChargeType.OTHER]: (t: ILedgerDataRow, broker: IProductBrokerDocWithLoanBroker) => handleFee(t, broker, 'otherShare'),
   };
 
   return transactions.reduce((acc, t) => {
@@ -62,21 +62,21 @@ export const enrichWithBrokers = async (transactions: ILedgerDataRow[], product:
 };
 
 export const getBorrowerBrokers = async (borrowerId: string) => {
-  return ProductBrokerModel
+  return ProductBroker
     .find({ borrowerId }, { createdAt: 0, updatedAt: 0, __v: 0 })
     .sort({ order: 1 })
     .lean();
 };
 
 export const getAllProductBrokers = async () => {
-  return ProductBrokerModel
+  return ProductBroker
     .find({}, { createdAt: 0, updatedAt: 0, __v: 0 })
     .sort({ order: 1 })
     .lean();
 };
 
 export const getAllLoanBrokers = async () => {
-  const results = await LoanBrokerModel
+  const results = await LoanBroker
     .find({}, { createdAt: 0, updatedAt: 0, __v: 0 })
     .sort({ order: 1 })
     .lean();
@@ -87,7 +87,7 @@ export const getAllLoanBrokers = async () => {
 };
 
 export const getBrokerProducts = async (loanBrokerId: string) => {
-  return ProductBrokerModel
+  return ProductBroker
     .find({ loanBrokerId }, { createdAt: 0, updatedAt: 0, __v: 0 })
     .sort({ order: 1, BSCode: 1, PLCode: 1 })
     .lean();

package/models/LoanBroker.model.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
 /// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -26,69 +27,42 @@
 /// <reference types="mongoose/types/validation" />
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
-import mongoose, { Document } from 'mongoose';
+import mongoose from 'mongoose';
 import Joi from 'joi';
 export declare const LoanBrokerValidationSchema: Joi.ObjectSchema<any>;
 export interface ILoanBrokerEmail {
-    _id?: mongoose.Types.ObjectId | string;
+    uiId: string;
     email: string;
     title: string;
     isActive: boolean;
 }
+export interface ILoanBrokerEmailLean extends ILoanBrokerEmail {
+    _id: mongoose.Types.ObjectId;
+}
+export interface ILoanBrokerEmailPlain extends ILoanBrokerEmail {
+    _id: string;
+}
 export interface ILoanBroker {
+    uiId: string;
     order: number;
     active: boolean;
     name: string;
     emails: ILoanBrokerEmail[];
 }
-export interface ILoanBrokerWithId extends ILoanBroker {
+export interface ILoanBrokerLean extends ILoanBroker {
     _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
 }
-export type ILoanBrokerView = Omit<ILoanBrokerWithId, 'order'>;
-export interface ILoanBrokerDoc extends ILoanBroker, Document {
+export interface ILoanBrokerPlain extends Omit<ILoanBroker, 'emails'> {
+    _id: string;
+    emails: ILoanBrokerEmailPlain[];
+    createdAt: Date;
+    updatedAt: Date;
 }
-export declare const LoanBrokerSchema: mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
-    timestamps: true;
-}, {
-    createdAt: NativeDate;
-    updatedAt: NativeDate;
-} & {
-    name: string;
-    order: number;
-    active: boolean;
-    emails: mongoose.Types.DocumentArray<{
-        email: string;
-        title: string;
-        isActive: boolean;
-    }>;
-    __v?: number;
-}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
-    createdAt: NativeDate;
-    updatedAt: NativeDate;
-} & {
-    name: string;
-    order: number;
-    active: boolean;
-    emails: mongoose.Types.DocumentArray<{
-        email: string;
-        title: string;
-        isActive: boolean;
-    }>;
-    __v?: number;
-}>> & mongoose.FlatRecord<{
-    createdAt: NativeDate;
-    updatedAt: NativeDate;
-} & {
-    name: string;
-    order: number;
-    active: boolean;
-    emails: mongoose.Types.DocumentArray<{
-        email: string;
-        title: string;
-        isActive: boolean;
-    }>;
-    __v?: number;
-}> & {
+export type TLoanBrokerDoc = mongoose.HydratedDocument<ILoanBroker>;
+export type LoanBrokerModel = mongoose.Model<ILoanBroker>;
+export declare const LoanBrokerSchema: mongoose.Schema<ILoanBroker, LoanBrokerModel, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, ILoanBroker, mongoose.Document<unknown, {}, mongoose.FlatRecord<ILoanBroker>> & mongoose.FlatRecord<ILoanBroker> & {
     _id: mongoose.Types.ObjectId;
 }>;
-export declare const LoanBrokerModel: mongoose.Model<ILoanBrokerDoc>;
+export declare const LoanBroker: LoanBrokerModel;

package/models/LoanBroker.model.js

@@ -3,18 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoanBrokerModel = exports.LoanBrokerSchema = exports.LoanBrokerValidationSchema = void 0;
+exports.LoanBroker = exports.LoanBrokerSchema = exports.LoanBrokerValidationSchema = void 0;
 const mongoose_1 = __importDefault(require("mongoose"));
 const joi_1 = __importDefault(require("joi"));
 const _models_1 = require("./_models");
 exports.LoanBrokerValidationSchema = joi_1.default.object({
     _id: joi_1.default.string().allow(null),
+    uiId: joi_1.default.string(),
     order: joi_1.default.number(),
     active: joi_1.default.boolean().required(),
     name: joi_1.default.string().required(),
     emails: joi_1.default.array(),
 });
 exports.LoanBrokerSchema = new mongoose_1.default.Schema({
+    uiId: {
+        type: String,
+        required: true,
+        trim: true,
+    },
     order: {
         type: Number,
         required: true,
@@ -29,6 +35,11 @@ exports.LoanBrokerSchema = new mongoose_1.default.Schema({
         trim: true,
     },
     emails: [{
+            uiId: {
+                type: String,
+                required: true,
+                trim: true,
+            },
             email: {
                 type: String,
                 required: true,
@@ -44,6 +55,8 @@ exports.LoanBrokerSchema = new mongoose_1.default.Schema({
                 required: true,
             },
         }],
-    __v: { type: Number, select: false },
-}, { timestamps: true });
-exports.LoanBrokerModel = mongoose_1.default.model(_models_1.MODEL_NAMES.loanBrokers, exports.LoanBrokerSchema);
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+});
+exports.LoanBroker = mongoose_1.default.model(_models_1.MODEL_NAMES.loanBrokers, exports.LoanBrokerSchema);

package/models/LoanBroker.model.ts

@@ -1,10 +1,11 @@
-import mongoose, { Document } from 'mongoose';
+import mongoose from 'mongoose';
 import Joi from 'joi';
 
 import { MODEL_NAMES } from './_models';
 
 export const LoanBrokerValidationSchema = Joi.object({
   _id: Joi.string().allow(null),
+  uiId: Joi.string(),
   order: Joi.number(),
   active: Joi.boolean().required(),
   name: Joi.string().required(),
@@ -12,30 +13,52 @@ export const LoanBrokerValidationSchema = Joi.object({
 });
 
 export interface ILoanBrokerEmail {
-  _id?: mongoose.Types.ObjectId | string
+  uiId: string;
   email: string,
   title: string,
   isActive: boolean
 }
 
+export interface ILoanBrokerEmailLean extends ILoanBrokerEmail {
+  _id: mongoose.Types.ObjectId;
+}
+
+export interface ILoanBrokerEmailPlain extends ILoanBrokerEmail {
+  _id: string;
+}
+
 export interface ILoanBroker {
+  uiId: string;
   order: number;
   active: boolean;
   name: string;
   emails: ILoanBrokerEmail[];
 }
 
-export interface ILoanBrokerWithId extends ILoanBroker {
+export interface ILoanBrokerLean extends ILoanBroker {
   _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
 }
 
-export type ILoanBrokerView = Omit<ILoanBrokerWithId, 'order'>
-
-export interface ILoanBrokerDoc extends ILoanBroker, Document {
+export interface ILoanBrokerPlain extends Omit<ILoanBroker, 'emails'> {
+  _id: string;
+  emails: ILoanBrokerEmailPlain[];
+  createdAt: Date;
+  updatedAt: Date;
 }
 
-export const LoanBrokerSchema = new mongoose.Schema(
+export type TLoanBrokerDoc = mongoose.HydratedDocument<ILoanBroker>
+
+export type LoanBrokerModel = mongoose.Model<ILoanBroker>;
+
+export const LoanBrokerSchema = new mongoose.Schema<ILoanBroker, LoanBrokerModel>(
   {
+    uiId: {
+      type: String,
+      required: true,
+      trim: true,
+    },
     order: {
       type: Number,
       required: true,
@@ -50,6 +73,11 @@ export const LoanBrokerSchema = new mongoose.Schema(
       trim: true,
     },
     emails: [{
+      uiId: {
+        type: String,
+        required: true,
+        trim: true,
+      },
       email: {
         type: String,
         required: true,
@@ -65,9 +93,11 @@ export const LoanBrokerSchema = new mongoose.Schema(
         required: true,
       },
     }],
-    __v: { type: Number, select: false },
   },
-  { timestamps: true },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+  },
 );
 
-export const LoanBrokerModel: mongoose.Model<ILoanBrokerDoc> = mongoose.model<ILoanBrokerDoc>(MODEL_NAMES.loanBrokers, LoanBrokerSchema);
+export const LoanBroker = mongoose.model<ILoanBroker, LoanBrokerModel>(MODEL_NAMES.loanBrokers, LoanBrokerSchema);

package/models/ProductBroker.model.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/models" />
 /// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -28,9 +28,10 @@
 /// <reference types="mongoose/types/inferschematype" />
 import mongoose from 'mongoose';
 import Joi from 'joi';
-import { ILoanBrokerWithId } from './LoanBroker.model';
+import { ILoanBrokerLean } from './LoanBroker.model';
 export declare const ProductBrokerValidationSchema: Joi.ObjectSchema<any>;
 export interface IProductBroker {
+    uiId: string;
     order: number;
     borrowerId: mongoose.Types.ObjectId;
     active: boolean;
@@ -42,11 +43,7 @@ export interface IProductBroker {
     adminShare: number;
     otherShare: number;
 }
-export interface IProductBrokerDoc extends IProductBroker, mongoose.Document {
-    _id: mongoose.Types.ObjectId;
-    createdAt: Date;
-    updatedAt: Date;
-}
+export type TProductBrokerDoc = mongoose.HydratedDocument<IProductBroker>;
 export interface IProductBrokerLean extends IProductBroker {
     _id: mongoose.Types.ObjectId;
     createdAt: Date;
@@ -58,8 +55,8 @@ export interface IProductBrokerPlain extends Omit<IProductBroker, 'borrowerId' |
     loanBrokerId: string;
     productId: string;
 }
-export interface IProductBrokerDocWithBroker extends IProductBrokerDoc {
-    loanBroker: ILoanBrokerWithId;
+export interface IProductBrokerDocWithLoanBroker extends TProductBrokerDoc {
+    loanBroker: ILoanBrokerLean;
 }
 export type IProductBrokerView = Omit<IProductBrokerLean, 'borrowerId' | 'order'>;
 export type TProductBrokerModel = mongoose.Model<IProductBroker>;
@@ -69,13 +66,14 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    borrowerId: mongoose.Types.ObjectId;
-    productId: mongoose.Types.ObjectId;
+    uiId: string;
     order: number;
+    borrowerId: mongoose.Types.ObjectId;
     active: boolean;
-    PLCode: string;
     loanBrokerId: mongoose.Types.ObjectId;
     BSCode: string;
+    PLCode: string;
+    productId: mongoose.Types.ObjectId;
     interestShare: number;
     adminShare: number;
     otherShare: number;
@@ -84,13 +82,14 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    borrowerId: mongoose.Types.ObjectId;
-    productId: mongoose.Types.ObjectId;
+    uiId: string;
     order: number;
+    borrowerId: mongoose.Types.ObjectId;
     active: boolean;
-    PLCode: string;
     loanBrokerId: mongoose.Types.ObjectId;
     BSCode: string;
+    PLCode: string;
+    productId: mongoose.Types.ObjectId;
     interestShare: number;
     adminShare: number;
     otherShare: number;
@@ -99,13 +98,14 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    borrowerId: mongoose.Types.ObjectId;
-    productId: mongoose.Types.ObjectId;
+    uiId: string;
     order: number;
+    borrowerId: mongoose.Types.ObjectId;
     active: boolean;
-    PLCode: string;
     loanBrokerId: mongoose.Types.ObjectId;
     BSCode: string;
+    PLCode: string;
+    productId: mongoose.Types.ObjectId;
     interestShare: number;
     adminShare: number;
     otherShare: number;
@@ -113,4 +113,4 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
 }> & {
     _id: mongoose.Types.ObjectId;
 }>;
-export declare const ProductBrokerModel: mongoose.Model<IProductBrokerDoc>;
+export declare const ProductBroker: TProductBrokerModel;