@dynamatix/gb-schemas 0.8.0 → 0.10.0

package/applicants/applicant.model.js

@@ -100,23 +100,59 @@ const applicantSchema = new mongoose.Schema({
     incomeSource: applicantIncomeSourceSchema,
     expenditure: applicantExpenditureSchema,
     employment: applicantEmploymentSchema,
-    commitments:[applicantCommitmentSchema],
+    commitments: [applicantCommitmentSchema],
     directDebit: applicantDirectDebitSchema,
     creditProfile: creditProfileSchema,
     income: incomeSchema
+}, {
+    timestamps: true,
+    toJSON: { virtuals: true },
+    toObject: { virtuals: true }
 });
 
 applicantSchema.virtual('nationality').get(function () {
-    return this.nationalityLid ? this.nationalityLid.name : null;
+    return this.nationalityLid?.name ?? null;
 });
 
 applicantSchema.virtual('residence').get(function () {
-    return this.countryOfResidenceLid ? this.countryOfResidenceLid.name : null;
+    return this.countryOfResidenceLid?.name ?? null;
 });
 
 applicantSchema.virtual('industry').get(function () {
-    return this.employment?.industryLid ? this.employment?.industryLid.name : null;
+    return this.employment?.industryLid ? this.employment?.industryLid?.name : null;
 });
-applicantSchema.set('toJSON', { virtuals: true });
+
+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('relationshipToOthers').get(function () {
+    return this.relationshipToOthersLid?.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.VulnerabilityTypeLid?.name ?? null;
+});
+
 const ApplicantModel = mongoose.model("Applicant", applicantSchema);
-export default ApplicantModel;
+export default ApplicantModel;

package/applications/application.model.js

@@ -4,146 +4,146 @@ import creditProfileSchema from "./application-credit-profile.model.js";
 import mortgageSchema from "./application-mortgage.model.js";
 
 const applicationSchema = new mongoose.Schema(
-    {
-        queueId: [{
-            type: mongoose.Schema.Types.ObjectId,
-            ref: "Queue",
-            required: true,
-        }],
-        assignedToUserId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
-        applicationId: { type: String, required: true },
-        isApplicationFeePaid: { type: Boolean, required: true },
-        applicationNumber: { type: String, required: true },
-        applicationTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        bankSolicitor: { type: String, default: "" },
-        brokerId: { type: mongoose.Schema.Types.ObjectId, ref: "Broker", required: true },
-        brokerName: { type: String }, // Broker name field added
-        caseManager: { type: String, default: "" },
-        caseManagerAccepted: { type: Boolean, default: false },
-        completedReason: { type: String, default: "" },
-        isIntendToOccupy: { type: Boolean, required: true },
-        introducer: { type: String, default: "" },
-        isIntroducerSubmission: { type: Boolean, required: true },
-        isBrokerAssigned: { type: Boolean, default: false },
-        isFinanceRecommendedToApplicant: { type: Boolean, required: true },
-        isWorkflowTaskCreated: { type: Boolean, required: true },
-        lastUpdated: { type: Date },
-        lendingTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        networkClubName: { type: String, default: "" },
-        isNetworkClubSubmission: { type: Boolean, required: true },
-        newReason: { type: String, default: "" },
-        purchaseTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        rejectedReason: { type: String, default: "" },
-        repaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        selectedProduct: { type: String, required: true },
-        sourceOfWealthLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        sowBusiness: { type: String, default: "" },
-        sowInheritance: { type: String, default: "" },
-        sowOther: { type: String, default: "" },
-        sowProperty: { type: String, default: "" },
-        sowSalary: { type: String, default: "" },
-        statusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        submitReason: { type: String, default: "" },
-        submittedDate: { type: Date },
-        underwriter: { type: String, default: "" },
-        isValuationFeePaid: { type: Boolean, required: true },
-        withdrawalReason: { type: String, default: "" },
-        withdrawalReasonCode: { type: String, default: "" },
-        productId: { type: mongoose.Schema.Types.ObjectId, ref: "Product", required: true },
-        product: { type: String },
-        propertyId: { type: mongoose.Schema.Types.ObjectId, ref: "Property", required: true },
-        solicitorId: { type: mongoose.Schema.Types.ObjectId, ref: "Solicitor", required: true },
-        applicants: [
-            { type: mongoose.Schema.Types.ObjectId, ref: "Applicant" }
-        ],
-        statusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
-        submittedDate: { type: Date },
-        isValuationFeePaid: { type: Boolean, required: true },
-        isActive: { type: Boolean, default: false },
-        isUkResident: { type: Boolean, default: true },
-        riskRating: { type: String }, 
-        directDebit: directDebitSchema,
-        creditProfile: creditProfileSchema,
-        mortgage: mortgageSchema,
-        companyId: { type: mongoose.Schema.Types.ObjectId, ref: "ApplicationCompany", required: true },    
-        rationaleId: { type: mongoose.Schema.Types.ObjectId, ref: "ApplicationRationale" }
-    },
-    { 
-        timestamps: true, 
-        toJSON: { virtuals: true }, 
-        toObject: { virtuals: true }  
-    }
+  {
+    queueId: [{
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Queue",
+      required: true,
+    }],
+    assignedToUserId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
+    applicationId: { type: String, required: true },
+    isApplicationFeePaid: { type: Boolean, required: true },
+    applicationNumber: { type: String, required: true },
+    applicationTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    bankSolicitor: { type: String, default: "" },
+    brokerId: { type: mongoose.Schema.Types.ObjectId, ref: "Broker", required: true },
+    caseManager: { type: String, default: "" },
+    caseManagerAccepted: { type: Boolean, default: false },
+    completedReason: { type: String, default: "" },
+    isIntendToOccupy: { type: Boolean, required: true },
+    introducer: { type: String, default: "" },
+    isIntroducerSubmission: { type: Boolean, required: true },
+    isBrokerAssigned: { type: Boolean, default: false },
+    isFinanceRecommendedToApplicant: { type: Boolean, required: true },
+    isWorkflowTaskCreated: { type: Boolean, required: true },
+    lastUpdated: { type: Date },
+    lendingTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    networkClubName: { type: String, default: "" },
+    isNetworkClubSubmission: { type: Boolean, required: true },
+    newReason: { type: String, default: "" },
+    purchaseTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    rejectedReason: { type: String, default: "" },
+    repaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    selectedProduct: { type: String, required: true },
+    sourceOfWealthLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    sowBusiness: { type: String, default: "" },
+    sowInheritance: { type: String, default: "" },
+    sowOther: { type: String, default: "" },
+    sowProperty: { type: String, default: "" },
+    sowSalary: { type: String, default: "" },
+    statusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    submitReason: { type: String, default: "" },
+    submittedDate: { type: Date },
+    underwriter: { type: String, default: "" },
+    isValuationFeePaid: { type: Boolean, required: true },
+    withdrawalReason: { type: String, default: "" },
+    withdrawalReasonCode: { type: String, default: "" },
+    productId: { type: mongoose.Schema.Types.ObjectId, ref: "Product", required: true },
+    product: { type: String },
+    propertyId: { type: mongoose.Schema.Types.ObjectId, ref: "Property", required: true },
+    solicitorId: { type: mongoose.Schema.Types.ObjectId, ref: "Solicitor", required: true },
+    applicants: [
+      { type: mongoose.Schema.Types.ObjectId, ref: "Applicant" }
+    ],
+    statusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true },
+    submittedDate: { type: Date },
+    isValuationFeePaid: { type: Boolean, required: true },
+    isActive: { type: Boolean, default: false },
+    isUkResident: { type: Boolean, default: true },
+    riskRating: { type: String },
+    directDebit: directDebitSchema,
+    creditProfile: creditProfileSchema,
+    mortgage: mortgageSchema,
+    companyId: { type: mongoose.Schema.Types.ObjectId, ref: "ApplicationCompany", required: true },
+    rationaleId: { type: mongoose.Schema.Types.ObjectId, ref: "ApplicationRationale" }
+  },
+  {
+    timestamps: true,
+    toJSON: { virtuals: true },
+    toObject: { virtuals: true }
+  }
 );
 
 
 // Virtual property 'noOfApplicants'
-applicationSchema.virtual('noOfApplicants').get(function() {
-    return this.applicants ? this.applicants.length : 0;
-  });
-  
-  // Virtual property 'applicationTypeName'
-  applicationSchema.virtual('applicationTypeName').get(function() {
-    return this.applicationTypeLid ? this.applicationTypeLid.name : null;
-  });
-    
-  // Virtual property 'LTV %'
-  applicationSchema.virtual('ltv').get(function() {
-    const purchasePrice = this.mortgage?.purchasePrice;
-    const loanRequired = this.mortgage?.loanRequired;
-    
-    if (purchasePrice && loanRequired) {
-      const parseCurrency = (value) => {
-        if (typeof value === 'string') {
-          return parseFloat(value.replace(/[^0-9.-]+/g, ""));
-        }
-        return value;
-      };
-  
-      const parsedPurchasePrice = parseCurrency(purchasePrice);
-      const parsedLoanRequired = parseCurrency(loanRequired);
-      const ltv = (parsedLoanRequired / parsedPurchasePrice) * 100;
-      return ltv.toFixed(2)+"%";
-    }
-    return null;
-  });
-  
-  applicationSchema.virtual('submittedDateFormatted').get(function() {
-    if (!this.submittedDate) return null;
-    const day = String(this.submittedDate.getDate()).padStart(2, '0');
-    const month = String(this.submittedDate.getMonth() + 1).padStart(2, '0');
-    const year = this.submittedDate.getFullYear();
-    return `${day}-${month}-${year}`;
-  });
-  
-  // Virtual property for broker name
-  applicationSchema.virtual('brokerFirstName').get(function() {
-    return this.brokerId ? this.brokerId?.firstName : null;
-  });
-  
-  // Virtual property for broker email
-  applicationSchema.virtual('brokerEmail').get(function() {
-    return this.brokerId ? this.brokerId?.email : null;
-  });
-  
-  // Virtual property for solicitor name
-  applicationSchema.virtual('solicitorName').get(function() {
-    return this.solicitorId ? this.solicitorId?.nameOfAccountHolder : null;
-  });
-  
-  // Virtual property for solicitor email
-  applicationSchema.virtual('solicitorEmail').get(function() {
-    return this.solicitorId ? this.solicitorId?.email : null;
-  });
+applicationSchema.virtual('noOfApplicants').get(function () {
+  return this.applicants ? this.applicants.length : 0;
+});
+
+// Virtual property 'applicationTypeName'
+applicationSchema.virtual('applicationTypeName').get(function () {
+  return this.applicationTypeLid ? this.applicationTypeLid.name : null;
+});
+
+// Virtual property 'LTV %'
+applicationSchema.virtual('ltv').get(function () {
+  const purchasePrice = this.mortgage?.purchasePrice;
+  const loanRequired = this.mortgage?.loanRequired;
+
+  if (purchasePrice && loanRequired) {
+    const parseCurrency = (value) => {
+      if (typeof value === 'string') {
+        return parseFloat(value.replace(/[^0-9.-]+/g, ""));
+      }
+      return value;
+    };
+
+    const parsedPurchasePrice = parseCurrency(purchasePrice);
+    const parsedLoanRequired = parseCurrency(loanRequired);
+    const ltv = (parsedLoanRequired / parsedPurchasePrice) * 100;
+    return ltv.toFixed(2) + "%";
+  }
+  return null;
+});
+
+applicationSchema.virtual('submittedDateFormatted').get(function () {
+  if (!this.submittedDate) return null;
+  const day = String(this.submittedDate.getDate()).padStart(2, '0');
+  const month = String(this.submittedDate.getMonth() + 1).padStart(2, '0');
+  const year = this.submittedDate.getFullYear();
+  return `${day}-${month}-${year}`;
+});
+
+// Virtual property for broker name
+applicationSchema.virtual('brokerName').get(function () {
+  if (!this.brokerId?.firstName || !this.brokerId?.lastName) return null;
+  return this.brokerId.firstName + " " + this.brokerId.lastName;
+});
+
+// Virtual property for broker email
+applicationSchema.virtual('brokerEmail').get(function () {
+  return this.brokerId ? this.brokerId?.email : null;
+});
+
+// Virtual property for solicitor name
+applicationSchema.virtual('solicitorName').get(function () {
+  return this.solicitorId ? this.solicitorId?.nameOfAccountHolder : null;
+});
+
+// Virtual property for solicitor email
+applicationSchema.virtual('solicitorEmail').get(function () {
+  return this.solicitorId ? this.solicitorId?.email : null;
+});
+
+// Virtual property for broker phone
+applicationSchema.virtual('brokerPhone').get(function () {
+  return this.brokerId ? this.brokerId?.mobileTelephone : null;
+});
+
+// Virtual property for solicitor phone
+applicationSchema.virtual('solicitorPhone').get(function () {
+  return this.solicitorId ? this.solicitorId?.telephone : null;
+});
 
-  // Virtual property for broker phone
-  applicationSchema.virtual('brokerPhone').get(function () {
-    return this.brokerId ? this.brokerId?.mobileTelephone : null;
-  });
-  
-  // Virtual property for solicitor phone
-  applicationSchema.virtual('solicitorPhone').get(function () {
-    return this.solicitorId ? this.solicitorId?.telephone : null;
-  });
-  
 const ApplicationModel = mongoose.model("Application", applicationSchema);
-export default ApplicationModel;
+export default ApplicationModel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamatix/gb-schemas",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "All the schemas for gatehouse bank back-end",
   "main": "index.js",
   "scripts": {