@dynamatix/gb-schemas 2.0.67 → 2.3.4

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

@@ -1,18 +1,47 @@
+/// <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 MortgageCommitmentModel: mongoose.Model<{
     isSelected?: unknown;
     source?: unknown;
     applicantId?: mongoose.Types.ObjectId | null | undefined;
+    monthlyPayment?: unknown;
     repaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     outstandingBalance?: unknown;
     fixedTerm?: unknown;
+    startDate?: unknown;
     commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     lenderName?: unknown;
-    monthlyPayment?: unknown;
     doHaveSharedResponsibility?: unknown;
     sharedMortgage?: unknown;
-    startDate?: unknown;
     propertyValue?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
@@ -36,14 +65,14 @@ declare const MortgageCommitmentModel: 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;
@@ -57,6 +86,7 @@ declare const MortgageCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
@@ -84,14 +114,14 @@ declare const MortgageCommitmentModel: 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;
@@ -105,6 +135,7 @@ declare const MortgageCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
@@ -124,15 +155,16 @@ declare const MortgageCommitmentModel: mongoose.Model<{
     isSelected?: unknown;
     source?: unknown;
     applicantId?: mongoose.Types.ObjectId | null | undefined;
+    monthlyPayment?: unknown;
     repaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     outstandingBalance?: unknown;
     fixedTerm?: unknown;
+    startDate?: unknown;
     commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     lenderName?: unknown;
-    monthlyPayment?: unknown;
     doHaveSharedResponsibility?: unknown;
     sharedMortgage?: unknown;
-    startDate?: unknown;
     propertyValue?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
@@ -156,14 +188,14 @@ declare const MortgageCommitmentModel: 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;
@@ -177,6 +209,7 @@ declare const MortgageCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
@@ -204,14 +237,14 @@ declare const MortgageCommitmentModel: 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;
@@ -225,6 +258,7 @@ declare const MortgageCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
@@ -240,19 +274,20 @@ declare const MortgageCommitmentModel: mongoose.Model<{
     financeHomeTypeLid?: unknown;
     remainingTermMonth?: unknown;
     chargeTypeLid?: unknown;
-}> & {
+}, {}> & {
     isSelected?: unknown;
     source?: unknown;
     applicantId?: mongoose.Types.ObjectId | null | undefined;
+    monthlyPayment?: unknown;
     repaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     outstandingBalance?: unknown;
     fixedTerm?: unknown;
+    startDate?: unknown;
     commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     lenderName?: unknown;
-    monthlyPayment?: unknown;
     doHaveSharedResponsibility?: unknown;
     sharedMortgage?: unknown;
-    startDate?: unknown;
     propertyValue?: {
         validators: mongoose.Types.DocumentArray<{
             type?: unknown;
@@ -276,14 +311,14 @@ declare const MortgageCommitmentModel: 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;
@@ -297,6 +332,7 @@ declare const MortgageCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
@@ -324,14 +360,14 @@ declare const MortgageCommitmentModel: 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;
@@ -345,6 +381,7 @@ declare const MortgageCommitmentModel: mongoose.Model<{
         instance?: unknown;
         isRequired?: unknown;
         path?: unknown;
+        toJSONSchema?: {} | null | undefined;
         validateAll?: {} | null | undefined;
         defaultOptions?: unknown;
     } | null | undefined;
@@ -379,23 +416,24 @@ declare const MortgageCommitmentModel: mongoose.Model<{
     applicantId: mongoose.Types.ObjectId;
     repaymentTypeLid: mongoose.Types.ObjectId;
     fixedTerm: string;
+    startDate: string;
     commitmentId: string;
+    commitmentTypeLid: mongoose.Types.ObjectId;
+    doHaveSharedResponsibility: boolean;
     sharedMortgage: string;
-    startDate: string;
     propertyValue: Pound;
     mortgageTypeLid: mongoose.Types.ObjectId;
     originalLoanAmount: Pound;
+    furtherAdvances: boolean;
     furtherAdvanceDetails: string;
+    accountUptoDate: boolean;
     accountUptoDateFailDetails: string;
+    accountInArrears: boolean;
     accountInArrearsDetails: string;
     financeTypeHppLid: mongoose.Types.ObjectId;
+    monthlyPayment?: Pound | null | undefined;
     outstandingBalance?: Pound | null | undefined;
     lenderName?: string | null | undefined;
-    monthlyPayment?: Pound | null | undefined;
-    doHaveSharedResponsibility?: boolean | null | undefined;
-    furtherAdvances?: boolean | null | undefined;
-    accountUptoDate?: boolean | null | undefined;
-    accountInArrears?: boolean | null | undefined;
     hppRepaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     mortgageRate?: number | null | undefined;
     financeHomeTypeLid?: mongoose.Types.ObjectId | null | undefined;
@@ -407,51 +445,53 @@ declare const MortgageCommitmentModel: mongoose.Model<{
     applicantId: mongoose.Types.ObjectId;
     repaymentTypeLid: mongoose.Types.ObjectId;
     fixedTerm: string;
+    startDate: string;
     commitmentId: string;
+    commitmentTypeLid: mongoose.Types.ObjectId;
+    doHaveSharedResponsibility: boolean;
     sharedMortgage: string;
-    startDate: string;
     propertyValue: Pound;
     mortgageTypeLid: mongoose.Types.ObjectId;
     originalLoanAmount: Pound;
+    furtherAdvances: boolean;
     furtherAdvanceDetails: string;
+    accountUptoDate: boolean;
     accountUptoDateFailDetails: string;
+    accountInArrears: boolean;
     accountInArrearsDetails: string;
     financeTypeHppLid: mongoose.Types.ObjectId;
+    monthlyPayment?: Pound | null | undefined;
     outstandingBalance?: Pound | null | undefined;
     lenderName?: string | null | undefined;
-    monthlyPayment?: Pound | null | undefined;
-    doHaveSharedResponsibility?: boolean | null | undefined;
-    furtherAdvances?: boolean | null | undefined;
-    accountUptoDate?: boolean | null | undefined;
-    accountInArrears?: boolean | null | undefined;
     hppRepaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     mortgageRate?: number | null | undefined;
     financeHomeTypeLid?: mongoose.Types.ObjectId | null | undefined;
     remainingTermMonth?: number | null | undefined;
     chargeTypeLid?: mongoose.Types.ObjectId | null | undefined;
-}>> & mongoose.FlatRecord<{
+}>, {}> & mongoose.FlatRecord<{
     isSelected: boolean;
     source: "Broker" | "Credit Report" | "Underwriter";
     applicantId: mongoose.Types.ObjectId;
     repaymentTypeLid: mongoose.Types.ObjectId;
     fixedTerm: string;
+    startDate: string;
     commitmentId: string;
+    commitmentTypeLid: mongoose.Types.ObjectId;
+    doHaveSharedResponsibility: boolean;
     sharedMortgage: string;
-    startDate: string;
     propertyValue: Pound;
     mortgageTypeLid: mongoose.Types.ObjectId;
     originalLoanAmount: Pound;
+    furtherAdvances: boolean;
     furtherAdvanceDetails: string;
+    accountUptoDate: boolean;
     accountUptoDateFailDetails: string;
+    accountInArrears: boolean;
     accountInArrearsDetails: string;
     financeTypeHppLid: mongoose.Types.ObjectId;
+    monthlyPayment?: Pound | null | undefined;
     outstandingBalance?: Pound | null | undefined;
     lenderName?: string | null | undefined;
-    monthlyPayment?: Pound | null | undefined;
-    doHaveSharedResponsibility?: boolean | null | undefined;
-    furtherAdvances?: boolean | null | undefined;
-    accountUptoDate?: boolean | null | undefined;
-    accountInArrears?: boolean | null | undefined;
     hppRepaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
     mortgageRate?: number | null | undefined;
     financeHomeTypeLid?: mongoose.Types.ObjectId | null | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"applicant-commitment-mortgage.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-commitment-mortgage.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAyE/C,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAiE,CAAC;AAC/F,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"applicant-commitment-mortgage.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-commitment-mortgage.model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAe,MAAM,wBAAwB,CAAC;AA6E5D,QAAA,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAiE,CAAC;AAC/F,eAAe,uBAAuB,CAAC"}

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

@@ -1,40 +1,34 @@
 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 mortgageCommitmentSchema = new mongoose.Schema({
     applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true },
     lenderName: { type: String }, // Provider Name / Provider category
-    propertyValue: { type: Pound, default: null },
+    propertyValue: { type: Pound, default: null, get: formatPound },
     repaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
     mortgageTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
     fixedTerm: { type: String, default: null },
-    originalLoanAmount: { type: Pound, default: null },
-    outstandingBalance: { type: Pound }, // Balance
+    originalLoanAmount: { type: Pound, default: null, get: formatPound },
+    outstandingBalance: { type: Pound, get: formatPound }, // Balance
     startDate: { type: String, default: null },
-    monthlyPayment: { type: Pound }, // Monthly payment
+    monthlyPayment: { type: Pound, get: formatPound }, // Monthly payment
     commitmentId: { type: String, default: null },
-    // commitmentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null }, // As of now not used anywhere
-    furtherAdvances: {
-        type: Boolean
-    },
+    commitmentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    furtherAdvances: { type: Boolean, default: false },
     furtherAdvanceDetails: { type: String, default: null },
-    accountUptoDate: {
-        type: Boolean
-    },
+    accountUptoDate: { type: Boolean, default: false },
     accountUptoDateFailDetails: { type: String, default: null },
-    accountInArrears: {
-        type: Boolean
-    },
+    accountInArrears: { type: Boolean, default: false },
     accountInArrearsDetails: { type: String, default: null },
-    doHaveSharedResponsibility: {
-        type: Boolean
-    },
+    doHaveSharedResponsibility: { type: Boolean, default: false },
     sharedMortgage: { type: String, default: null },
     source: {
         type: String,
         enum: ["Broker", "Credit Report", "Underwriter"],
         default: "Broker"
     },
-    isSelected: { type: Boolean, default: true }, // mark as selected for summary calculation
+    isSelected: { type: Boolean, default: false }, // mark as selected for summary calculation
     financeTypeHppLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
     hppRepaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
     mortgageRate: { type: Number },
@@ -65,5 +59,11 @@ mortgageCommitmentSchema.virtual('applicationType').get(function () {
         ? null
         : this.applicantId?.applicationId?.applicationTypeLid?.name || null;
 });
+applyAuditMiddleware(mortgageCommitmentSchema, "MortgageCommitment");
+// Apply workflow plugin to the schema
+applyWorkflowPlugin(mortgageCommitmentSchema, 'mortgagecommitment');
+// Indexes for query optimization
+mortgageCommitmentSchema.index({ applicantId: 1 });
+mortgageCommitmentSchema.index({ applicantId: 1, isSelected: 1 });
 const MortgageCommitmentModel = mongoose.model("MortgageCommitment", mortgageCommitmentSchema);
 export default MortgageCommitmentModel;