@dynamatix/gb-schemas 2.0.68 → 2.3.4

package/dist/applicants/applicant-commitment-loan.model.d.ts

@@ -1,10 +1,38 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <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/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/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
 import mongoose from "mongoose";
 import { Pound } from "../value-objects/pound";
 declare const LoanCommitmentModel: mongoose.Model<{
     isSelected?: unknown;
     source?: unknown;
     applicantId?: mongoose.Types.ObjectId | null | undefined;
-    outstandingBalance?: {
+    monthlyPayment?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
             message?: unknown;
@@ -27,14 +55,14 @@ declare const LoanCommitmentModel: mongoose.Model<{
         } | null | undefined;
         set?: {} | null | undefined;
         validate?: {} | null | undefined;
+        index?: {} | null | undefined;
         default?: {} | null | undefined;
         text?: {} | null | undefined;
         unique?: {} | null | undefined;
-        index?: {} | null | undefined;
         sparse?: {} | null | undefined;
+        cast?: {} | null | undefined;
         required?: {} | null | undefined;
         ref?: {} | null | undefined;
-        cast?: {} | null | undefined;
         select?: {} | null | undefined;
         immutable?: {} | null | undefined;
         transform?: {} | null | undefined;
@@ -48,12 +76,11 @@ declare const LoanCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
-    commitmentId?: unknown;
-    lenderName?: unknown;
-    monthlyPayment?: {
+    outstandingBalance?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
             message?: unknown;
@@ -76,14 +103,14 @@ declare const LoanCommitmentModel: mongoose.Model<{
         } | null | undefined;
         set?: {} | null | undefined;
         validate?: {} | null | undefined;
+        index?: {} | null | undefined;
         default?: {} | null | undefined;
         text?: {} | null | undefined;
         unique?: {} | null | undefined;
-        index?: {} | null | undefined;
         sparse?: {} | null | undefined;
+        cast?: {} | null | undefined;
         required?: {} | null | undefined;
         ref?: {} | null | undefined;
-        cast?: {} | null | undefined;
         select?: {} | null | undefined;
         immutable?: {} | null | undefined;
         transform?: {} | null | undefined;
@@ -97,22 +124,26 @@ declare const LoanCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
+    startDate?: unknown;
+    commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    lenderName?: unknown;
     loanTypeLid?: mongoose.Types.ObjectId | null | undefined;
     securityDetails?: unknown;
     purpose?: unknown;
     doHaveSharedResponsibility?: unknown;
     sharedMortgage?: unknown;
     remainingTerm?: unknown;
-    startDate?: unknown;
     loanRationale?: unknown;
 }, {}, {}, {}, mongoose.Document<unknown, {}, {
     isSelected?: unknown;
     source?: unknown;
     applicantId?: mongoose.Types.ObjectId | null | undefined;
-    outstandingBalance?: {
+    monthlyPayment?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
             message?: unknown;
@@ -135,14 +166,14 @@ declare const LoanCommitmentModel: mongoose.Model<{
         } | null | undefined;
         set?: {} | null | undefined;
         validate?: {} | null | undefined;
+        index?: {} | null | undefined;
         default?: {} | null | undefined;
         text?: {} | null | undefined;
         unique?: {} | null | undefined;
-        index?: {} | null | undefined;
         sparse?: {} | null | undefined;
+        cast?: {} | null | undefined;
         required?: {} | null | undefined;
         ref?: {} | null | undefined;
-        cast?: {} | null | undefined;
         select?: {} | null | undefined;
         immutable?: {} | null | undefined;
         transform?: {} | null | undefined;
@@ -156,12 +187,11 @@ declare const LoanCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
-    commitmentId?: unknown;
-    lenderName?: unknown;
-    monthlyPayment?: {
+    outstandingBalance?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
             message?: unknown;
@@ -184,14 +214,14 @@ declare const LoanCommitmentModel: mongoose.Model<{
         } | null | undefined;
         set?: {} | null | undefined;
         validate?: {} | null | undefined;
+        index?: {} | null | undefined;
         default?: {} | null | undefined;
         text?: {} | null | undefined;
         unique?: {} | null | undefined;
-        index?: {} | null | undefined;
         sparse?: {} | null | undefined;
+        cast?: {} | null | undefined;
         required?: {} | null | undefined;
         ref?: {} | null | undefined;
-        cast?: {} | null | undefined;
         select?: {} | null | undefined;
         immutable?: {} | null | undefined;
         transform?: {} | null | undefined;
@@ -205,22 +235,26 @@ declare const LoanCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
+    startDate?: unknown;
+    commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    lenderName?: unknown;
     loanTypeLid?: mongoose.Types.ObjectId | null | undefined;
     securityDetails?: unknown;
     purpose?: unknown;
     doHaveSharedResponsibility?: unknown;
     sharedMortgage?: unknown;
     remainingTerm?: unknown;
-    startDate?: unknown;
     loanRationale?: unknown;
-}> & {
+}, {}> & {
     isSelected?: unknown;
     source?: unknown;
     applicantId?: mongoose.Types.ObjectId | null | undefined;
-    outstandingBalance?: {
+    monthlyPayment?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
             message?: unknown;
@@ -243,14 +277,14 @@ declare const LoanCommitmentModel: mongoose.Model<{
         } | null | undefined;
         set?: {} | null | undefined;
         validate?: {} | null | undefined;
+        index?: {} | null | undefined;
         default?: {} | null | undefined;
         text?: {} | null | undefined;
         unique?: {} | null | undefined;
-        index?: {} | null | undefined;
         sparse?: {} | null | undefined;
+        cast?: {} | null | undefined;
         required?: {} | null | undefined;
         ref?: {} | null | undefined;
-        cast?: {} | null | undefined;
         select?: {} | null | undefined;
         immutable?: {} | null | undefined;
         transform?: {} | null | undefined;
@@ -264,12 +298,11 @@ declare const LoanCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
-    commitmentId?: unknown;
-    lenderName?: unknown;
-    monthlyPayment?: {
+    outstandingBalance?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
             message?: unknown;
@@ -292,14 +325,14 @@ declare const LoanCommitmentModel: mongoose.Model<{
         } | null | undefined;
         set?: {} | null | undefined;
         validate?: {} | null | undefined;
+        index?: {} | null | undefined;
         default?: {} | null | undefined;
         text?: {} | null | undefined;
         unique?: {} | null | undefined;
-        index?: {} | null | undefined;
         sparse?: {} | null | undefined;
+        cast?: {} | null | undefined;
         required?: {} | null | undefined;
         ref?: {} | null | undefined;
-        cast?: {} | null | undefined;
         select?: {} | null | undefined;
         immutable?: {} | null | undefined;
         transform?: {} | null | undefined;
@@ -313,16 +346,20 @@ declare const LoanCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
+    startDate?: unknown;
+    commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    lenderName?: unknown;
     loanTypeLid?: mongoose.Types.ObjectId | null | undefined;
     securityDetails?: unknown;
     purpose?: unknown;
     doHaveSharedResponsibility?: unknown;
     sharedMortgage?: unknown;
     remainingTerm?: unknown;
-    startDate?: unknown;
     loanRationale?: unknown;
 } & {
     _id: mongoose.Types.ObjectId;
@@ -341,50 +378,53 @@ declare const LoanCommitmentModel: mongoose.Model<{
     isSelected: boolean;
     source: "Broker" | "Credit Report" | "Underwriter";
     applicantId: mongoose.Types.ObjectId;
+    monthlyPayment: Pound;
     outstandingBalance: Pound;
+    startDate: string;
     commitmentId: string;
-    lenderName: string;
-    monthlyPayment: Pound;
+    commitmentTypeLid: mongoose.Types.ObjectId;
     loanTypeLid: mongoose.Types.ObjectId;
     securityDetails: string;
     purpose: string;
+    doHaveSharedResponsibility: boolean;
     sharedMortgage: string;
     remainingTerm: string;
-    startDate: string;
     loanRationale: string;
-    doHaveSharedResponsibility?: boolean | null | undefined;
+    lenderName?: string | null | undefined;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
     isSelected: boolean;
     source: "Broker" | "Credit Report" | "Underwriter";
     applicantId: mongoose.Types.ObjectId;
+    monthlyPayment: Pound;
     outstandingBalance: Pound;
+    startDate: string;
     commitmentId: string;
-    lenderName: string;
-    monthlyPayment: Pound;
+    commitmentTypeLid: mongoose.Types.ObjectId;
     loanTypeLid: mongoose.Types.ObjectId;
     securityDetails: string;
     purpose: string;
+    doHaveSharedResponsibility: boolean;
     sharedMortgage: string;
     remainingTerm: string;
-    startDate: string;
     loanRationale: string;
-    doHaveSharedResponsibility?: boolean | null | undefined;
-}>> & mongoose.FlatRecord<{
+    lenderName?: string | null | undefined;
+}>, {}> & mongoose.FlatRecord<{
     isSelected: boolean;
     source: "Broker" | "Credit Report" | "Underwriter";
     applicantId: mongoose.Types.ObjectId;
+    monthlyPayment: Pound;
     outstandingBalance: Pound;
+    startDate: string;
     commitmentId: string;
-    lenderName: string;
-    monthlyPayment: Pound;
+    commitmentTypeLid: mongoose.Types.ObjectId;
     loanTypeLid: mongoose.Types.ObjectId;
     securityDetails: string;
     purpose: string;
+    doHaveSharedResponsibility: boolean;
     sharedMortgage: string;
     remainingTerm: string;
-    startDate: string;
     loanRationale: string;
-    doHaveSharedResponsibility?: boolean | null | undefined;
+    lenderName?: string | null | undefined;
 }> & {
     _id: mongoose.Types.ObjectId;
 } & {

package/dist/applicants/applicant-commitment-loan.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applicant-commitment-loan.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-commitment-loan.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAgD/C,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAyD,CAAC;AACnF,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"applicant-commitment-loan.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-commitment-loan.model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAe,MAAM,wBAAwB,CAAC;AA0D5D,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAyD,CAAC;AACnF,eAAe,mBAAmB,CAAC"}

package/dist/applicants/applicant-commitment-loan.model.js

@@ -1,21 +1,21 @@
 import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
+import { applyWorkflowPlugin } from "../shared/workflow.plugin";
+import { Pound, formatPound } from "../value-objects/pound";
+import { applyAuditMiddleware } from "@dynamatix/cat-shared/middlewares";
 const loanCommitmentSchema = new mongoose.Schema({
     applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true },
     commitmentId: { type: String, default: null },
-    // commitmentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null }, // As of now not used anywhere
-    lenderName: { type: String, required: true }, // Provider Name / Provider category
+    commitmentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    lenderName: { type: String }, // Provider Name / Provider category
     loanTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
     securityDetails: { type: String, default: null },
     purpose: { type: String, default: null },
-    doHaveSharedResponsibility: {
-        type: Boolean
-    },
+    doHaveSharedResponsibility: { type: Boolean, default: false },
     sharedMortgage: { type: String, default: null },
     remainingTerm: { type: String, default: null },
     startDate: { type: String, default: null },
-    outstandingBalance: { type: Pound, required: true }, // Balance
-    monthlyPayment: { type: Pound, required: true }, // Monthly payment
+    outstandingBalance: { type: Pound, required: true, get: formatPound }, // Balance
+    monthlyPayment: { type: Pound, required: true, get: formatPound }, // Monthly payment
     source: {
         type: String,
         enum: ["Broker", "Credit Report", "Underwriter"],
@@ -42,5 +42,10 @@ loanCommitmentSchema.virtual('lendingType').get(function () {
         ? null
         : this.applicantId?.applicationId?.lendingTypeLid?.name || null;
 });
+applyAuditMiddleware(loanCommitmentSchema, "LoanCommitment");
+// Apply workflow plugin to the schema
+applyWorkflowPlugin(loanCommitmentSchema, 'loancommitment');
+// Indexes for query optimization
+loanCommitmentSchema.index({ applicantId: 1 });
 const LoanCommitmentModel = mongoose.model("LoanCommitment", loanCommitmentSchema);
 export default LoanCommitmentModel;