@dynamatix/gb-schemas 1.2.143 → 1.2.144

package/dist/applicants/applicant-employment.model.js

@@ -1,58 +1,58 @@
-import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
-const applicantEmploymentSchema = new mongoose.Schema({
-    applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true },
-    pageValidFlag: { type: Boolean, default: false },
-    acceptableIncomeLids: [{ type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }],
-    addressCity: { type: String, default: null },
-    addressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    addressLine1: { type: String, required: true },
-    addressLine2: { type: String, default: null },
-    addressLine3: { type: String, default: null },
-    addressPostCode: { type: String, required: true },
-    averageBonusPreviousTwoYears: { type: Pound, default: 0.00 },
-    basicGrossIncome: { type: Pound, default: 0.00 },
-    basicPay: { type: Pound, default: 0.00 },
-    carAllowance: { type: Pound, default: 0.00 },
-    childBenefit: { type: Pound, default: 0.00 },
-    childBenefitOrSchoolAllowance: { type: Pound, default: 0.00 },
-    contractRemaining: { type: String },
-    dateJoined: { type: String, required: true },
-    disabilityLiving: { type: Pound, default: 0.00 },
-    employerName: { type: String, required: true },
-    employerTelephone: { type: String, default: null },
-    housingAllowance: { type: Pound, default: 0.00 },
-    industryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    isUnderTerminationNotice: {
-        type: Boolean,
-        default: false,
-    },
-    jobTitleLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    maintenance: { type: Pound, default: 0.00 },
-    maternityIncome: { type: Pound, default: 0.00 },
-    natureOfBusiness: { type: String, required: true },
-    pensionIncome: { type: Pound, default: 0.00 },
-    previousAddressCity: { type: String, default: null },
-    previousAddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    previousAddressLine1: { type: String, required: true },
-    previousAddressLine2: { type: String, default: null },
-    previousAddressLine3: { type: String, default: null },
-    previousAddressPostCode: { type: String, required: true },
-    previousBasicGrossIncome: { type: Pound, default: 0.00, required: true },
-    previousDateJoined: { type: String, required: true },
-    previousDateLeft: { type: String, required: true },
-    previousEmployerName: { type: String, required: true },
-    previousEmployerTelephone: { type: String, default: null },
-    previousJobTitle: { type: String, required: true },
-    previousNatureOfBusiness: { type: String, required: true },
-    referenceContact: { type: String, default: null },
-    referenceContactEmail: { type: String, required: true },
-    secondJob: { type: Pound, default: 0.00 },
-    travelAllowance: { type: Pound, default: 0.00 },
-    underTerminationNoticeNote: { type: String, default: null }
-}, {
-    toJSON: { getters: true },
-    toObject: { getters: true }
-});
-const ApplicantEmploymentModel = mongoose.model("Applicant_Employment_Information", applicantEmploymentSchema);
-export default ApplicantEmploymentModel;
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+const applicantEmploymentSchema = new mongoose.Schema({
+    applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true },
+    pageValidFlag: { type: Boolean, default: false },
+    acceptableIncomeLids: [{ type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }],
+    addressCity: { type: String, default: null },
+    addressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    addressLine1: { type: String, required: true },
+    addressLine2: { type: String, default: null },
+    addressLine3: { type: String, default: null },
+    addressPostCode: { type: String, required: true },
+    averageBonusPreviousTwoYears: { type: Pound, default: 0.00 },
+    basicGrossIncome: { type: Pound, default: 0.00 },
+    basicPay: { type: Pound, default: 0.00 },
+    carAllowance: { type: Pound, default: 0.00 },
+    childBenefit: { type: Pound, default: 0.00 },
+    childBenefitOrSchoolAllowance: { type: Pound, default: 0.00 },
+    contractRemaining: { type: String },
+    dateJoined: { type: String, required: true },
+    disabilityLiving: { type: Pound, default: 0.00 },
+    employerName: { type: String, required: true },
+    employerTelephone: { type: String, default: null },
+    housingAllowance: { type: Pound, default: 0.00 },
+    industryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    isUnderTerminationNotice: {
+        type: Boolean,
+        default: false,
+    },
+    jobTitleLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    maintenance: { type: Pound, default: 0.00 },
+    maternityIncome: { type: Pound, default: 0.00 },
+    natureOfBusiness: { type: String, required: true },
+    pensionIncome: { type: Pound, default: 0.00 },
+    previousAddressCity: { type: String, default: null },
+    previousAddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    previousAddressLine1: { type: String, required: true },
+    previousAddressLine2: { type: String, default: null },
+    previousAddressLine3: { type: String, default: null },
+    previousAddressPostCode: { type: String, required: true },
+    previousBasicGrossIncome: { type: Pound, default: 0.00, required: true },
+    previousDateJoined: { type: String, required: true },
+    previousDateLeft: { type: String, required: true },
+    previousEmployerName: { type: String, required: true },
+    previousEmployerTelephone: { type: String, default: null },
+    previousJobTitle: { type: String, required: true },
+    previousNatureOfBusiness: { type: String, required: true },
+    referenceContact: { type: String, default: null },
+    referenceContactEmail: { type: String, required: true },
+    secondJob: { type: Pound, default: 0.00 },
+    travelAllowance: { type: Pound, default: 0.00 },
+    underTerminationNoticeNote: { type: String, default: null }
+}, {
+    toJSON: { getters: true },
+    toObject: { getters: true }
+});
+const ApplicantEmploymentModel = mongoose.model("Applicant_Employment_Information", applicantEmploymentSchema);
+export default ApplicantEmploymentModel;

package/dist/applicants/applicant-income.model.js

@@ -1,55 +1,55 @@
-import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
-const incomeSchema = new mongoose.Schema({
-    accountantsAddressLine1: { type: String, required: true },
-    accountantsAddressLine2: { type: String, required: true },
-    accountantsAddressLine3: { type: String, required: true },
-    accountantsCity: { type: String, default: '' },
-    accountantsCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    accountantsEmail: { type: String, required: true },
-    accountantsPostCode: { type: String, required: true },
-    accountantsPractice: { type: String, required: true },
-    accountantsTelephoneNumber: { type: String, required: true },
-    businessAddressLine1: { type: String, required: true },
-    businessAddressLine2: { type: String, required: true },
-    businessAddressLine3: { type: String, required: true },
-    businessCity: { type: String, default: '' },
-    businessCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    businessPostCode: { type: String, required: true },
-    businessTelephoneNumber: { type: String, required: true },
-    businessTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    charteredCertifiedOrOtherLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    contactName: { type: String, required: true },
-    currentYearEnd: { type: String, required: true },
-    dateEstablished: { type: String, required: true },
-    doYouHaveAccountant: { type: Boolean, required: true },
-    isBusinessAddressDifferent: { type: Boolean, required: true, },
-    nameOfBusiness: { type: String, required: true },
-    natureOfBusiness: { type: String, required: true },
-    netAssets1: { type: Pound, default: 0.00 },
-    netAssets2: { type: Pound, default: 0.00 },
-    netAssets3: { type: Pound, default: 0.00 },
-    pageValidFlag: { type: String, default: true },
-    percentageOfShareholding: { type: Number, required: true, min: 0, max: 100 },
-    registeredAddressLine1: { type: String, required: true },
-    registeredAddressLine2: { type: String, required: true },
-    registeredAddressLine3: { type: String, required: true },
-    registeredCity: { type: String, default: '' },
-    registeredCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    registeredPostCode: { type: String, required: true },
-    registeredTelephone: { type: String, required: true },
-    selfEmployedDate: { type: String, required: true },
-    turnover1: { type: Pound, default: 0.00 },
-    turnover2: { type: Pound, default: 0.00 },
-    turnover3: { type: Pound, default: 0.00 },
-    year1: { type: Pound, default: 0.00 },
-    year2: { type: Pound, default: 0.00 },
-    year3: { type: Pound, default: 0.00 },
-    yearEnd1: { type: Number, default: '' },
-    yearEnd2: { type: Number, default: '' },
-    yearEnd3: { type: Number, default: '' }
-}, {
-    toJSON: { getters: true },
-    toObject: { getters: true }
-});
-export default incomeSchema;
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+const incomeSchema = new mongoose.Schema({
+    accountantsAddressLine1: { type: String, required: true },
+    accountantsAddressLine2: { type: String, required: true },
+    accountantsAddressLine3: { type: String, required: true },
+    accountantsCity: { type: String, default: '' },
+    accountantsCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    accountantsEmail: { type: String, required: true },
+    accountantsPostCode: { type: String, required: true },
+    accountantsPractice: { type: String, required: true },
+    accountantsTelephoneNumber: { type: String, required: true },
+    businessAddressLine1: { type: String, required: true },
+    businessAddressLine2: { type: String, required: true },
+    businessAddressLine3: { type: String, required: true },
+    businessCity: { type: String, default: '' },
+    businessCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    businessPostCode: { type: String, required: true },
+    businessTelephoneNumber: { type: String, required: true },
+    businessTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    charteredCertifiedOrOtherLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    contactName: { type: String, required: true },
+    currentYearEnd: { type: String, required: true },
+    dateEstablished: { type: String, required: true },
+    doYouHaveAccountant: { type: Boolean, required: true },
+    isBusinessAddressDifferent: { type: Boolean, required: true, },
+    nameOfBusiness: { type: String, required: true },
+    natureOfBusiness: { type: String, required: true },
+    netAssets1: { type: Pound, default: 0.00 },
+    netAssets2: { type: Pound, default: 0.00 },
+    netAssets3: { type: Pound, default: 0.00 },
+    pageValidFlag: { type: String, default: true },
+    percentageOfShareholding: { type: Number, required: true, min: 0, max: 100 },
+    registeredAddressLine1: { type: String, required: true },
+    registeredAddressLine2: { type: String, required: true },
+    registeredAddressLine3: { type: String, required: true },
+    registeredCity: { type: String, default: '' },
+    registeredCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    registeredPostCode: { type: String, required: true },
+    registeredTelephone: { type: String, required: true },
+    selfEmployedDate: { type: String, required: true },
+    turnover1: { type: Pound, default: 0.00 },
+    turnover2: { type: Pound, default: 0.00 },
+    turnover3: { type: Pound, default: 0.00 },
+    year1: { type: Pound, default: 0.00 },
+    year2: { type: Pound, default: 0.00 },
+    year3: { type: Pound, default: 0.00 },
+    yearEnd1: { type: Number, default: '' },
+    yearEnd2: { type: Number, default: '' },
+    yearEnd3: { type: Number, default: '' }
+}, {
+    toJSON: { getters: true },
+    toObject: { getters: true }
+});
+export default incomeSchema;

package/dist/applicants/applicant-other-income.model.js

@@ -1,46 +1,46 @@
-import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
-const applicantOtherIncomeSchema = new mongoose.Schema({
-    // Income Source 1
-    sourceDetails1: { type: String, default: null },
-    amount1: { type: Pound, default: 0.00 },
-    payFrequency1Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    guaranteed1: {
-        type: Boolean,
-        default: false
-    },
-    // Income Source 2
-    sourceDetails2: { type: String, default: null },
-    amount2: { type: Pound, default: 0.00 },
-    payFrequency2Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    guaranteed2: {
-        type: Boolean,
-        default: false
-    },
-    // Income Source 3
-    sourceDetails3: { type: String, default: null },
-    amount3: { type: Pound, default: 0.00 },
-    payFrequency3Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    guaranteed3: {
-        type: Boolean,
-        default: false
-    },
-    // Income Source 4
-    sourceDetails4: { type: String, default: null },
-    amount4: { type: Pound, default: 0.00 },
-    payFrequency4Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    guaranteed4: {
-        type: Boolean,
-        default: false
-    },
-    taxCredits: { type: Pound, default: 0.00 },
-    maintenance: { type: Pound, default: 0.00 },
-    otherBenefits: { type: Pound, default: 0.00 },
-    grossPensionIncome: { type: Pound, default: 0.00 },
-    privatePensionIncome: { type: Pound, default: 0.00 },
-    statePensionIncome: { type: Pound, default: 0.00 },
-}, {
-    toJSON: { getters: true },
-    toObject: { getters: true }
-});
-export default applicantOtherIncomeSchema;
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+const applicantOtherIncomeSchema = new mongoose.Schema({
+    // Income Source 1
+    sourceDetails1: { type: String, default: null },
+    amount1: { type: Pound, default: 0.00 },
+    payFrequency1Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    guaranteed1: {
+        type: Boolean,
+        default: false
+    },
+    // Income Source 2
+    sourceDetails2: { type: String, default: null },
+    amount2: { type: Pound, default: 0.00 },
+    payFrequency2Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    guaranteed2: {
+        type: Boolean,
+        default: false
+    },
+    // Income Source 3
+    sourceDetails3: { type: String, default: null },
+    amount3: { type: Pound, default: 0.00 },
+    payFrequency3Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    guaranteed3: {
+        type: Boolean,
+        default: false
+    },
+    // Income Source 4
+    sourceDetails4: { type: String, default: null },
+    amount4: { type: Pound, default: 0.00 },
+    payFrequency4Lid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    guaranteed4: {
+        type: Boolean,
+        default: false
+    },
+    taxCredits: { type: Pound, default: 0.00 },
+    maintenance: { type: Pound, default: 0.00 },
+    otherBenefits: { type: Pound, default: 0.00 },
+    grossPensionIncome: { type: Pound, default: 0.00 },
+    privatePensionIncome: { type: Pound, default: 0.00 },
+    statePensionIncome: { type: Pound, default: 0.00 },
+}, {
+    toJSON: { getters: true },
+    toObject: { getters: true }
+});
+export default applicantOtherIncomeSchema;

package/dist/applicants/applicant.model.js

@@ -1,225 +1,225 @@
-import mongoose from "mongoose";
-import applicantCreditDataSchema from "./applicant-credit-data.model";
-import applicantRiskNarrativeSchema from "./applicant-risk-narrative.model";
-import applicantOtherIncomeSchema from "./applicant-other-income.model";
-import applicantIncomeSourceSchema from "./applicant-income-source.model";
-import applicantExpenditureSchema from "./applicant-expenditure.model";
-import applicantDirectDebitSchema from "./applicant-direct-debit.model";
-import creditProfileSchema from "./applicant-credit-profile.model";
-import propertyIncomeSchema from "./applicant-property-income.model";
-import incomeSchema from "./applicant-income.model";
-import { Pound } from "../value-objects/pound";
-const applicantSchema = new mongoose.Schema({
-    applicantId: { type: String, required: true },
-    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true },
-    addressCity: { type: String, default: null },
-    addressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    addressLine1: { type: String, default: null },
-    addressLine2: { type: String, default: null },
-    addressLine3: { type: String, default: null },
-    addressMovedDate: { type: String, default: null },
-    addressPostCode: { type: String, default: null },
-    correspondenceAddressCity: { type: String, default: null },
-    correspondenceAddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    correspondenceAddressLine1: { type: String, default: null },
-    correspondenceAddressLine2: { type: String, default: null },
-    correspondenceAddressLine3: { type: String, default: null },
-    correspondenceAddressPostCode: { type: String, default: null },
-    countryOfResidenceLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    dateOfBirth: { type: String, required: true },
-    dependant10Age: { type: Number, default: 0 },
-    dependant1Age: { type: Number, default: 0 },
-    dependant2Age: { type: Number, default: 0 },
-    dependant3Age: { type: Number, default: 0 },
-    dependant4Age: { type: Number, default: 0 },
-    dependant5Age: { type: Number, default: 0 },
-    dependant6Age: { type: Number, default: 0 },
-    dependant7Age: { type: Number, default: 0 },
-    dependant8Age: { type: Number, default: 0 },
-    dependant9Age: { type: Number, default: 0 },
-    email: { type: String, required: true },
-    employmentStatusDetails: { type: String, default: null },
-    firstName: { type: String, required: true },
-    isFirstTimelandlord: {
-        type: Boolean,
-        default: false,
-    },
-    foreignNationalsId: { type: String, default: null },
-    gdprEmail: {
-        type: Boolean,
-        default: false,
-    },
-    gdprPost: {
-        type: Boolean,
-        default: false,
-    },
-    gdprTelephone: {
-        type: Boolean,
-        default: false,
-    },
-    gdprTextMessage: {
-        type: Boolean,
-        default: false,
-    },
-    gender: { type: String, required: true },
-    hasBrokerGivenConsentForVulnerabilities: {
-        type: Boolean,
-        required: true,
-    },
-    hasLinkedJurisdiction: {
-        type: Boolean,
-        default: false,
-    },
-    isCorrespondence: {
-        type: Boolean,
-        default: true,
-    },
-    isCurrentContract: {
-        type: Boolean,
-        default: false,
-    },
-    isCustomerVulnerable: {
-        type: Boolean,
-        default: false,
-    },
-    isExpat: {
-        type: Boolean,
-        default: false,
-    },
-    isFirstApplicant: {
-        type: Boolean,
-        default: false,
-    },
-    isUkPassport: {
-        type: Boolean,
-        default: false,
-    },
-    isUkResident: {
-        type: Boolean,
-        required: true,
-    },
-    classLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    pageValidFlag: { type: Boolean, default: false },
-    lastName: { type: String, required: true },
-    linkedJurisdictionCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    linkedJurisdictionDetails: { type: String, default: null },
-    maidenName: { type: String, default: null },
-    maritalStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    mobileNumber: { type: String, default: null },
-    nationalityLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    netIncome: { type: Pound, default: 0.00 },
-    niNumber: { type: String, required: true },
-    numberOfDependants: { type: Number, default: 0 },
-    isOneYearPrior: {
-        type: Boolean,
-        default: false,
-    },
-    phoneNumber: { type: String, default: null },
-    previous1AddressCity: { type: String, default: null },
-    previous1AddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    previous1AddressLine1: { type: String, default: null },
-    previous1AddressLine2: { type: String, default: null },
-    previous1AddressLine3: { type: String, default: null },
-    previous1AddressMovedDate: { type: String, default: null },
-    previous1AddressPostCode: { type: String, default: null },
-    previous1AddressPropertyOwnedBy: { type: String, default: null },
-    previous2AddressCity: { type: String, default: null },
-    previous2AddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    previous2AddressLine1: { type: String, default: null },
-    previous2AddressLine2: { type: String, default: null },
-    previous2AddressLine3: { type: String, default: null },
-    previous2AddressMovedDate: { type: String, default: null },
-    previous2AddressPostCode: { type: String, default: null },
-    previous2AddressPropertyOwnedBy: { type: String, default: null },
-    relationshipToOthers: { type: String, required: true },
-    residentialStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    retirementAge: { type: String, required: true },
-    taxJurisdictionLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    taxPayerLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-    timeResidedAtCountryOfResidence: { type: Number, required: true },
-    title: { type: String, required: true },
-    isTwoYearPrior: {
-        type: Boolean,
-        default: false,
-    },
-    understandEnglish: {
-        type: Boolean,
-        required: true,
-    },
-    vulnerabilityNotes: { type: String, default: null },
-    vulnerabilityTypeLids: [{ type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }],
-    ukPassportProfession: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        required: function () {
-            return this.isUkResident;
-        }
-    },
-    creditData: applicantCreditDataSchema,
-    riskNarrative: applicantRiskNarrativeSchema,
-    otherIncome: applicantOtherIncomeSchema,
-    incomeSource: applicantIncomeSourceSchema,
-    expenditure: applicantExpenditureSchema,
-    directDebit: applicantDirectDebitSchema,
-    creditProfile: creditProfileSchema,
-    propertyIncome: propertyIncomeSchema,
-    income: incomeSchema
-}, {
-    timestamps: true,
-    toJSON: { virtuals: true, getters: true },
-    toObject: { virtuals: true, getters: true }
-});
-applicantSchema.virtual('nationality').get(function () {
-    return this.nationalityLid?.name ?? null;
-});
-applicantSchema.virtual('residence').get(function () {
-    return this.countryOfResidenceLid?.name ?? null;
-});
-applicantSchema.virtual('employmentClass').get(function () {
-    return this.classLid?.name ?? null;
-});
-applicantSchema.virtual('addressCountry').get(function () {
-    return this.addressCountryLid?.name ?? null;
-});
-applicantSchema.virtual('previous1AddressCountry').get(function () {
-    return this.previous1AddressCountryLid?.name ?? null;
-});
-applicantSchema.virtual('previous2AddressCountry').get(function () {
-    return this.previous2AddressCountryLid?.name ?? null;
-});
-applicantSchema.virtual('maritalStatus').get(function () {
-    return this.maritalStatusLid?.name ?? null;
-});
-applicantSchema.virtual('residentialStatus').get(function () {
-    return this.residentialStatusLid?.name ?? null;
-});
-applicantSchema.virtual('taxPayer').get(function () {
-    return this.taxPayerLid?.name ?? null;
-});
-applicantSchema.virtual('vulnerabilityType').get(function () {
-    return this.vulnerabilityTypeLids?.map((v) => v.name);
-});
-applicantSchema.virtual('fullName').get(function () {
-    return `${this.firstName ?? ''} ${this.lastName ?? ''}`.trim();
-});
-// virtual property 'applicationType'
-applicantSchema.virtual('applicationType').get(function () {
-    return this.applicationId?.applicationTypeLid instanceof mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.applicationTypeLid?.name || null;
-});
-// virtual property 'lendingType'
-applicantSchema.virtual('lendingType').get(function () {
-    return this.applicationId?.lendingTypeLid instanceof mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.lendingTypeLid?.name || null;
-});
-// numberOfApplicants – how many applicants are on the associated Application
-applicantSchema.virtual('numberOfApplicants').get(function () {
-    // `this.applicationId` must be populated (with its `applicants` field) 
-    const app = this.applicationId;
-    // if it's populated and has an applicants array, return its length, otherwise 0
-    return Array.isArray(app?.applicants) ? app.applicants.length : 0;
-});
-const ApplicantModel = mongoose.model("Applicant", applicantSchema);
-export default ApplicantModel;
+import mongoose from "mongoose";
+import applicantCreditDataSchema from "./applicant-credit-data.model";
+import applicantRiskNarrativeSchema from "./applicant-risk-narrative.model";
+import applicantOtherIncomeSchema from "./applicant-other-income.model";
+import applicantIncomeSourceSchema from "./applicant-income-source.model";
+import applicantExpenditureSchema from "./applicant-expenditure.model";
+import applicantDirectDebitSchema from "./applicant-direct-debit.model";
+import creditProfileSchema from "./applicant-credit-profile.model";
+import propertyIncomeSchema from "./applicant-property-income.model";
+import incomeSchema from "./applicant-income.model";
+import { Pound } from "../value-objects/pound";
+const applicantSchema = new mongoose.Schema({
+    applicantId: { type: String, required: true },
+    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true },
+    addressCity: { type: String, default: null },
+    addressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    addressLine1: { type: String, default: null },
+    addressLine2: { type: String, default: null },
+    addressLine3: { type: String, default: null },
+    addressMovedDate: { type: String, default: null },
+    addressPostCode: { type: String, default: null },
+    correspondenceAddressCity: { type: String, default: null },
+    correspondenceAddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    correspondenceAddressLine1: { type: String, default: null },
+    correspondenceAddressLine2: { type: String, default: null },
+    correspondenceAddressLine3: { type: String, default: null },
+    correspondenceAddressPostCode: { type: String, default: null },
+    countryOfResidenceLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    dateOfBirth: { type: String, required: true },
+    dependant10Age: { type: Number, default: 0 },
+    dependant1Age: { type: Number, default: 0 },
+    dependant2Age: { type: Number, default: 0 },
+    dependant3Age: { type: Number, default: 0 },
+    dependant4Age: { type: Number, default: 0 },
+    dependant5Age: { type: Number, default: 0 },
+    dependant6Age: { type: Number, default: 0 },
+    dependant7Age: { type: Number, default: 0 },
+    dependant8Age: { type: Number, default: 0 },
+    dependant9Age: { type: Number, default: 0 },
+    email: { type: String, required: true },
+    employmentStatusDetails: { type: String, default: null },
+    firstName: { type: String, required: true },
+    isFirstTimelandlord: {
+        type: Boolean,
+        default: false,
+    },
+    foreignNationalsId: { type: String, default: null },
+    gdprEmail: {
+        type: Boolean,
+        default: false,
+    },
+    gdprPost: {
+        type: Boolean,
+        default: false,
+    },
+    gdprTelephone: {
+        type: Boolean,
+        default: false,
+    },
+    gdprTextMessage: {
+        type: Boolean,
+        default: false,
+    },
+    gender: { type: String, required: true },
+    hasBrokerGivenConsentForVulnerabilities: {
+        type: Boolean,
+        required: true,
+    },
+    hasLinkedJurisdiction: {
+        type: Boolean,
+        default: false,
+    },
+    isCorrespondence: {
+        type: Boolean,
+        default: true,
+    },
+    isCurrentContract: {
+        type: Boolean,
+        default: false,
+    },
+    isCustomerVulnerable: {
+        type: Boolean,
+        default: false,
+    },
+    isExpat: {
+        type: Boolean,
+        default: false,
+    },
+    isFirstApplicant: {
+        type: Boolean,
+        default: false,
+    },
+    isUkPassport: {
+        type: Boolean,
+        default: false,
+    },
+    isUkResident: {
+        type: Boolean,
+        required: true,
+    },
+    classLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    pageValidFlag: { type: Boolean, default: false },
+    lastName: { type: String, required: true },
+    linkedJurisdictionCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    linkedJurisdictionDetails: { type: String, default: null },
+    maidenName: { type: String, default: null },
+    maritalStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    mobileNumber: { type: String, default: null },
+    nationalityLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    netIncome: { type: Pound, default: 0.00 },
+    niNumber: { type: String, required: true },
+    numberOfDependants: { type: Number, default: 0 },
+    isOneYearPrior: {
+        type: Boolean,
+        default: false,
+    },
+    phoneNumber: { type: String, default: null },
+    previous1AddressCity: { type: String, default: null },
+    previous1AddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    previous1AddressLine1: { type: String, default: null },
+    previous1AddressLine2: { type: String, default: null },
+    previous1AddressLine3: { type: String, default: null },
+    previous1AddressMovedDate: { type: String, default: null },
+    previous1AddressPostCode: { type: String, default: null },
+    previous1AddressPropertyOwnedBy: { type: String, default: null },
+    previous2AddressCity: { type: String, default: null },
+    previous2AddressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    previous2AddressLine1: { type: String, default: null },
+    previous2AddressLine2: { type: String, default: null },
+    previous2AddressLine3: { type: String, default: null },
+    previous2AddressMovedDate: { type: String, default: null },
+    previous2AddressPostCode: { type: String, default: null },
+    previous2AddressPropertyOwnedBy: { type: String, default: null },
+    relationshipToOthers: { type: String, required: true },
+    residentialStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    retirementAge: { type: String, required: true },
+    taxJurisdictionLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    taxPayerLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    timeResidedAtCountryOfResidence: { type: Number, required: true },
+    title: { type: String, required: true },
+    isTwoYearPrior: {
+        type: Boolean,
+        default: false,
+    },
+    understandEnglish: {
+        type: Boolean,
+        required: true,
+    },
+    vulnerabilityNotes: { type: String, default: null },
+    vulnerabilityTypeLids: [{ type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }],
+    ukPassportProfession: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        required: function () {
+            return this.isUkResident;
+        }
+    },
+    creditData: applicantCreditDataSchema,
+    riskNarrative: applicantRiskNarrativeSchema,
+    otherIncome: applicantOtherIncomeSchema,
+    incomeSource: applicantIncomeSourceSchema,
+    expenditure: applicantExpenditureSchema,
+    directDebit: applicantDirectDebitSchema,
+    creditProfile: creditProfileSchema,
+    propertyIncome: propertyIncomeSchema,
+    income: incomeSchema
+}, {
+    timestamps: true,
+    toJSON: { virtuals: true, getters: true },
+    toObject: { virtuals: true, getters: true }
+});
+applicantSchema.virtual('nationality').get(function () {
+    return this.nationalityLid?.name ?? null;
+});
+applicantSchema.virtual('residence').get(function () {
+    return this.countryOfResidenceLid?.name ?? null;
+});
+applicantSchema.virtual('employmentClass').get(function () {
+    return this.classLid?.name ?? null;
+});
+applicantSchema.virtual('addressCountry').get(function () {
+    return this.addressCountryLid?.name ?? null;
+});
+applicantSchema.virtual('previous1AddressCountry').get(function () {
+    return this.previous1AddressCountryLid?.name ?? null;
+});
+applicantSchema.virtual('previous2AddressCountry').get(function () {
+    return this.previous2AddressCountryLid?.name ?? null;
+});
+applicantSchema.virtual('maritalStatus').get(function () {
+    return this.maritalStatusLid?.name ?? null;
+});
+applicantSchema.virtual('residentialStatus').get(function () {
+    return this.residentialStatusLid?.name ?? null;
+});
+applicantSchema.virtual('taxPayer').get(function () {
+    return this.taxPayerLid?.name ?? null;
+});
+applicantSchema.virtual('vulnerabilityType').get(function () {
+    return this.vulnerabilityTypeLids?.map((v) => v.name);
+});
+applicantSchema.virtual('fullName').get(function () {
+    return `${this.firstName ?? ''} ${this.lastName ?? ''}`.trim();
+});
+// virtual property 'applicationType'
+applicantSchema.virtual('applicationType').get(function () {
+    return this.applicationId?.applicationTypeLid instanceof mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.applicationTypeLid?.name || null;
+});
+// virtual property 'lendingType'
+applicantSchema.virtual('lendingType').get(function () {
+    return this.applicationId?.lendingTypeLid instanceof mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.lendingTypeLid?.name || null;
+});
+// numberOfApplicants – how many applicants are on the associated Application
+applicantSchema.virtual('numberOfApplicants').get(function () {
+    // `this.applicationId` must be populated (with its `applicants` field) 
+    const app = this.applicationId;
+    // if it's populated and has an applicants array, return its length, otherwise 0
+    return Array.isArray(app?.applicants) ? app.applicants.length : 0;
+});
+const ApplicantModel = mongoose.model("Applicant", applicantSchema);
+export default ApplicantModel;

package/dist/applicants/index.js

@@ -5,3 +5,4 @@ export { default as MortgageCommitmentModel } from './applicant-commitment-mortg
 export { default as ResidenceCommitmentModel } from './applicant-commitment-residence.model';
 export { default as SecuredLoanCommitmentModel } from './applicant-commitment-secureLoan.model';
 export { default as UnsecuredLoanCommitmentModel } from './applicant-commitment-unsecuredLoan.model';
+export { default as ApplicantEmploymentModel } from './applicant-employment.model';

package/dist/applications/application-mortgage.model.js

@@ -1,256 +1,256 @@
-import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
-const mortgageSchema = new mongoose.Schema({
-    applicationId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Application",
-        required: true,
-        description: "Unique identifier for the application",
-    },
-    pageValidFlag: {
-        type: Boolean,
-        default: false,
-        description: "True if all mandatory fields have been completed, otherwise false",
-    },
-    existingMortgageLender: {
-        type: String,
-        maxlength: 35,
-        description: "Name of the existing mortgage lender",
-    },
-    topSlicing: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the mortgage is being paid off using top slicing",
-    },
-    purposeOfMortgage: {
-        type: String,
-        maxlength: 50,
-        description: "Purpose of the mortgage (e.g., purchase, refinance)",
-    },
-    depositComeFromLids: {
-        type: [mongoose.Schema.Types.ObjectId],
-        ref: "Lookup",
-        default: null,
-        description: "Where the deposit for the mortgage will come from",
-    },
-    ifOtherDetails: {
-        type: String,
-        maxlength: 50,
-        description: "Details if the deposit comes from 'Other'",
-    },
-    purchasePrice: {
-        type: Pound,
-        description: "Purchase price of the property",
-    },
-    repaymentTypeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        default: null,
-        description: "Lookup ID representing the type of repayment (e.g., interest-only, repayment)",
-    },
-    exitStrategyLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        default: null,
-        description: "Lookup ID representing the Exit strategy for the mortgage)",
-    },
-    isCapitalRaise: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if capital raising is part of this finance",
-    },
-    purchaseDate: {
-        type: String,
-        default: null,
-        description: "Purchase date of the property",
-    },
-    estimatedValue: {
-        type: Pound,
-        description: "Estimated value of the property",
-    },
-    loanRequired: {
-        type: Pound,
-        description: "Amount of finance required",
-    },
-    monthlyRentalIncome: {
-        type: Pound,
-        description: "Monthly rental income from the property",
-    },
-    outstandingBalance: {
-        type: Pound,
-        description: "Outstanding balance on the existing mortgage",
-    },
-    fundRaisedFor: {
-        type: String,
-        maxlength: 250,
-        description: "What the funds raised will be used for",
-    },
-    sourceOfFundsLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        default: null,
-        description: "Lookup ID representing the Main source of income for monthly finance payments",
-    },
-    sourceOfFundDetails: {
-        type: String,
-        maxlength: 50,
-        description: "Additional details if the source of funds is 'Other'",
-    },
-    propertyValuationDetails: {
-        type: String,
-        maxlength: 35,
-        description: "Details on who to contact for property valuation",
-    },
-    telephoneNumber: {
-        type: String,
-        maxlength: 15,
-        description: "Contact number for property valuation",
-    },
-    isDistressedSale: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if this is a distressed sale",
-    },
-    isPurchasedBelowMarketValue: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the property is purchased below market value",
-    },
-    isPurchasedAsSale: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the property is purchased as a sale and rent back",
-    },
-    isReadyToSell: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the property is ready to sell or let out",
-    },
-    isGovernmentInitiative: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if this purchase is part of a government initiative",
-    },
-    vendorsName: {
-        type: String,
-        maxlength: 35,
-        description: "Vendor's name in case of property sale",
-    },
-    saleMadeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        description: "Method of sale made",
-    },
-    isTheIntentionToLet: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the intention is to let out the property",
-    },
-    proposedTenantsLids: {
-        type: [mongoose.Schema.Types.ObjectId],
-        ref: "Lookup",
-        description: "Proposed tenants for the property",
-    },
-    leaseTypeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        default: null,
-        description: "Lease type for the property",
-    },
-    giftDetails: {
-        type: String,
-        maxlength: 50,
-        description: "Details of the gift for the mortgage",
-    },
-}, {
-    timestamps: true,
-    toJSON: { virtuals: true },
-    toObject: { virtuals: true },
-});
-// const virtualDepositComeFrom = mortgageSchema.virtual("depositComeFrom", {
-//   ref: "Lookup",
-//   localField: "depositComeFromLid",
-//   foreignField: "_id",
-//   justOne: false,
-// }) as VirtualWithDescription;
-// virtualDepositComeFrom.description =
-//   "Populated lookup values for where the deposit for the mortgage will come from";
-// const virtualRepaymentType = mortgageSchema.virtual("repaymentType", {
-//   ref: "Lookup",
-//   localField: "repaymentTypeLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualRepaymentType.description =
-//   "Populated lookup value representing the type of repayment";
-// const virtualExitStrategy = mortgageSchema.virtual("exitStrategy", {
-//   ref: "Lookup",
-//   localField: "exitStrategyLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualExitStrategy.description = "Populated lookup value for exit strategy";
-// const virtualSourceOfFunds = mortgageSchema.virtual("sourceOfFunds", {
-//   ref: "Lookup",
-//   localField: "sourceOfFundsLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualSourceOfFunds.description =
-//   "Populated lookup value for the main source of income for monthly finance payments";
-// const virtualSaleMade = mortgageSchema.virtual("saleMade", {
-//   ref: "Lookup",
-//   localField: "saleMadeLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualSaleMade.description = "Populated lookup value for method of sale made";
-// const virtualProposedTenants = mortgageSchema.virtual("proposedTenants", {
-//   ref: "Lookup",
-//   localField: "proposedTenantsLid",
-//   foreignField: "_id",
-//   justOne: false,
-// }) as VirtualWithDescription;
-// virtualProposedTenants.description =
-//   "Populated lookup values for proposed tenants of the property";
-// const virtualLeaseType = mortgageSchema.virtual("leaseType", {
-//   ref: "Lookup",
-//   localField: "leaseTypeLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualLeaseType.description = "Populated lookup value for lease type";
-// virtual property 'applicationType'
-mortgageSchema.virtual("applicationType").get(function () {
-    return this.applicationId?.applicationTypeLid instanceof
-        mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.applicationTypeLid?.text || null;
-});
-// virtual property 'lendingType'
-mortgageSchema.virtual("lendingType").get(function () {
-    return this.applicationId?.lendingTypeLid instanceof
-        mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.lendingTypeLid?.text || null;
-});
-// virtual property 'purchaseType'
-mortgageSchema.virtual("purchaseType").get(function () {
-    return this.applicationId?.purchaseTypeLid instanceof
-        mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.purchaseTypeLid?.text || null;
-});
-// virtual property 'lendingType'
-mortgageSchema.virtual("sourceOfWealth").get(function () {
-    const sourceOfWealthLids = this.applicationId?.sourceOfWealthLids;
-    if (!Array.isArray(sourceOfWealthLids)) {
-        return null;
-    }
-    return sourceOfWealthLids
-        .filter((lid) => !(lid instanceof mongoose.Types.ObjectId))
-        .map((lid) => lid?.text || null)
-        .filter((text) => text !== null);
-});
-const MortgageModel = mongoose.model("Mortgage", mortgageSchema);
-export default MortgageModel;
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+const mortgageSchema = new mongoose.Schema({
+    applicationId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Application",
+        required: true,
+        description: "Unique identifier for the application",
+    },
+    pageValidFlag: {
+        type: Boolean,
+        default: false,
+        description: "True if all mandatory fields have been completed, otherwise false",
+    },
+    existingMortgageLender: {
+        type: String,
+        maxlength: 35,
+        description: "Name of the existing mortgage lender",
+    },
+    topSlicing: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the mortgage is being paid off using top slicing",
+    },
+    purposeOfMortgage: {
+        type: String,
+        maxlength: 50,
+        description: "Purpose of the mortgage (e.g., purchase, refinance)",
+    },
+    depositComeFromLids: {
+        type: [mongoose.Schema.Types.ObjectId],
+        ref: "Lookup",
+        default: null,
+        description: "Where the deposit for the mortgage will come from",
+    },
+    ifOtherDetails: {
+        type: String,
+        maxlength: 50,
+        description: "Details if the deposit comes from 'Other'",
+    },
+    purchasePrice: {
+        type: Pound,
+        description: "Purchase price of the property",
+    },
+    repaymentTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Lookup ID representing the type of repayment (e.g., interest-only, repayment)",
+    },
+    exitStrategyLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Lookup ID representing the Exit strategy for the mortgage)",
+    },
+    isCapitalRaise: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if capital raising is part of this finance",
+    },
+    purchaseDate: {
+        type: String,
+        default: null,
+        description: "Purchase date of the property",
+    },
+    estimatedValue: {
+        type: Pound,
+        description: "Estimated value of the property",
+    },
+    loanRequired: {
+        type: Pound,
+        description: "Amount of finance required",
+    },
+    monthlyRentalIncome: {
+        type: Pound,
+        description: "Monthly rental income from the property",
+    },
+    outstandingBalance: {
+        type: Pound,
+        description: "Outstanding balance on the existing mortgage",
+    },
+    fundRaisedFor: {
+        type: String,
+        maxlength: 250,
+        description: "What the funds raised will be used for",
+    },
+    sourceOfFundsLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Lookup ID representing the Main source of income for monthly finance payments",
+    },
+    sourceOfFundDetails: {
+        type: String,
+        maxlength: 50,
+        description: "Additional details if the source of funds is 'Other'",
+    },
+    propertyValuationDetails: {
+        type: String,
+        maxlength: 35,
+        description: "Details on who to contact for property valuation",
+    },
+    telephoneNumber: {
+        type: String,
+        maxlength: 15,
+        description: "Contact number for property valuation",
+    },
+    isDistressedSale: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if this is a distressed sale",
+    },
+    isPurchasedBelowMarketValue: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the property is purchased below market value",
+    },
+    isPurchasedAsSale: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the property is purchased as a sale and rent back",
+    },
+    isReadyToSell: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the property is ready to sell or let out",
+    },
+    isGovernmentInitiative: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if this purchase is part of a government initiative",
+    },
+    vendorsName: {
+        type: String,
+        maxlength: 35,
+        description: "Vendor's name in case of property sale",
+    },
+    saleMadeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        description: "Method of sale made",
+    },
+    isTheIntentionToLet: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the intention is to let out the property",
+    },
+    proposedTenantsLids: {
+        type: [mongoose.Schema.Types.ObjectId],
+        ref: "Lookup",
+        description: "Proposed tenants for the property",
+    },
+    leaseTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Lease type for the property",
+    },
+    giftDetails: {
+        type: String,
+        maxlength: 50,
+        description: "Details of the gift for the mortgage",
+    },
+}, {
+    timestamps: true,
+    toJSON: { virtuals: true },
+    toObject: { virtuals: true },
+});
+// const virtualDepositComeFrom = mortgageSchema.virtual("depositComeFrom", {
+//   ref: "Lookup",
+//   localField: "depositComeFromLid",
+//   foreignField: "_id",
+//   justOne: false,
+// }) as VirtualWithDescription;
+// virtualDepositComeFrom.description =
+//   "Populated lookup values for where the deposit for the mortgage will come from";
+// const virtualRepaymentType = mortgageSchema.virtual("repaymentType", {
+//   ref: "Lookup",
+//   localField: "repaymentTypeLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualRepaymentType.description =
+//   "Populated lookup value representing the type of repayment";
+// const virtualExitStrategy = mortgageSchema.virtual("exitStrategy", {
+//   ref: "Lookup",
+//   localField: "exitStrategyLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualExitStrategy.description = "Populated lookup value for exit strategy";
+// const virtualSourceOfFunds = mortgageSchema.virtual("sourceOfFunds", {
+//   ref: "Lookup",
+//   localField: "sourceOfFundsLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualSourceOfFunds.description =
+//   "Populated lookup value for the main source of income for monthly finance payments";
+// const virtualSaleMade = mortgageSchema.virtual("saleMade", {
+//   ref: "Lookup",
+//   localField: "saleMadeLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualSaleMade.description = "Populated lookup value for method of sale made";
+// const virtualProposedTenants = mortgageSchema.virtual("proposedTenants", {
+//   ref: "Lookup",
+//   localField: "proposedTenantsLid",
+//   foreignField: "_id",
+//   justOne: false,
+// }) as VirtualWithDescription;
+// virtualProposedTenants.description =
+//   "Populated lookup values for proposed tenants of the property";
+// const virtualLeaseType = mortgageSchema.virtual("leaseType", {
+//   ref: "Lookup",
+//   localField: "leaseTypeLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualLeaseType.description = "Populated lookup value for lease type";
+// virtual property 'applicationType'
+mortgageSchema.virtual("applicationType").get(function () {
+    return this.applicationId?.applicationTypeLid instanceof
+        mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.applicationTypeLid?.text || null;
+});
+// virtual property 'lendingType'
+mortgageSchema.virtual("lendingType").get(function () {
+    return this.applicationId?.lendingTypeLid instanceof
+        mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.lendingTypeLid?.text || null;
+});
+// virtual property 'purchaseType'
+mortgageSchema.virtual("purchaseType").get(function () {
+    return this.applicationId?.purchaseTypeLid instanceof
+        mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.purchaseTypeLid?.text || null;
+});
+// virtual property 'lendingType'
+mortgageSchema.virtual("sourceOfWealth").get(function () {
+    const sourceOfWealthLids = this.applicationId?.sourceOfWealthLids;
+    if (!Array.isArray(sourceOfWealthLids)) {
+        return null;
+    }
+    return sourceOfWealthLids
+        .filter((lid) => !(lid instanceof mongoose.Types.ObjectId))
+        .map((lid) => lid?.text || null)
+        .filter((text) => text !== null);
+});
+const MortgageModel = mongoose.model("Mortgage", mortgageSchema);
+export default MortgageModel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamatix/gb-schemas",
-  "version": "1.2.143",
+  "version": "1.2.144",
   "description": "All the schemas for gatehouse bank back-end",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",