@dynamatix/gb-schemas 1.2.7 → 1.2.8

package/dist/applications/application-mortgage.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application-mortgage.model.d.ts","sourceRoot":"","sources":["../../applications/application-mortgage.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAgChC,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA6C,CAAC;AACjE,eAAe,aAAa,CAAC"}
+{"version":3,"file":"application-mortgage.model.d.ts","sourceRoot":"","sources":["../../applications/application-mortgage.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAoJ/C,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAyD,CAAC;AAC7E,eAAe,aAAa,CAAC"}

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

@@ -1,31 +1,135 @@
 import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
 const mortgageSchema = new mongoose.Schema({
-    applicationid: { type: mongoose.Schema.Types.ObjectId, ref: "Application" },
-    depositComeFrom: { type: String },
-    estimatedValue: { type: String, default: "" },
-    exitStrategy: { type: String },
-    fundRaisedFor: { type: String, default: "" },
-    giftDetails: { type: String, default: "" },
-    ifOtherDetails: { type: String, default: "" },
-    isDistressedSale: { type: String, default: false },
-    isGovernmentInitiative: { type: String, default: false },
-    isPurchasedAsSale: { type: String, default: false },
-    isPurchasedBelowMarketValue: { type: String, default: false },
-    isReadyToSell: { type: String, default: true },
-    isTheIntentionToLet: { type: String, default: true },
-    leaseTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    loanRequired: { type: String },
-    monthlyRentalIncome: { type: String },
-    propertyValuationDetails: { type: String, default: "" },
-    proposedTenants: { type: String },
-    purchasePrice: { type: String },
-    repaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    repaymentVehicle: { type: String, default: "" },
-    saleMade: { type: String, default: "" },
-    sourceOfFundDetails: { type: String, default: "" },
-    sourceOfFundsLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    telephoneNumber: { type: String },
-    vendorsName: { type: String, default: "" }
+    applicationId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Application",
+        description: "Reference to the application this mortgage belongs to",
+    },
+    repaymentTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Lookup ID representing the type of repayment (e.g., interest-only, repayment)",
+    },
+    landerName: {
+        type: String,
+        default: "",
+        required: true,
+        maxlength: 70,
+        description: "Name of the lender providing the mortgage",
+    },
+    propertyValue: {
+        type: Pound,
+        required: true,
+        description: "Current value of the mortgaged property",
+    },
+    mortgageTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Lookup ID representing the type of mortgage (e.g., residential, BTL)",
+    },
+    fixedTerm: {
+        type: String,
+        default: 0,
+        maxlength: 50,
+        required: true,
+        description: "Length of the fixed term period",
+    },
+    originalLoanAmount: {
+        type: Pound,
+        default: 0,
+        required: true,
+        description: "Original amount of the mortgage loan",
+    },
+    outstandingBalance: {
+        type: Pound,
+        default: 0,
+        required: true,
+        description: "Current outstanding balance on the mortgage",
+    },
+    startDate: {
+        type: Date,
+        default: null,
+        required: true,
+        description: "Start date of the mortgage",
+    },
+    monthlyPayment: {
+        type: Pound,
+        default: 0,
+        required: true,
+        description: "Monthly payment amount for the mortgage",
+    },
+    furtherAdvances: {
+        type: Boolean,
+        required: true,
+        get: (value) => (value ? "Yes" : "No"),
+        description: "Indicates if further advances have been taken",
+    },
+    furtherAdvanceDetails: {
+        type: String,
+        default: "",
+        maxlength: 100,
+        required: true,
+        description: "Details of any further advances taken",
+    },
+    accountUpToDate: {
+        type: Boolean,
+        required: true,
+        get: (value) => (value ? "Yes" : "No"),
+        description: "Flag indicating if the account is up to date",
+    },
+    accountUpToDateFailDetails: {
+        type: String,
+        default: "",
+        maxlength: 100,
+        required: true,
+        description: "Details if the account is not up to date",
+    },
+    accountInArrears: {
+        type: Boolean,
+        required: true,
+        get: (value) => (value ? "Yes" : "No"),
+        description: "Indicates if the account is currently in arrears",
+    },
+    accountInArrearsDetails: {
+        type: String,
+        default: "",
+        maxlength: 100,
+        required: true,
+        description: "Details of account arrears, if any",
+    },
+    doHaveSharedResponsibility: {
+        type: Boolean,
+        default: false,
+        get: (value) => (value ? "Yes" : "No"),
+        description: "Flag indicating if the mortgage responsibility is shared",
+    },
+    sharedMortgage: {
+        type: String,
+        default: "",
+        required: true,
+        description: "Details about shared mortgage responsibility",
+    },
+}, {
+    timestamps: true,
+    toJSON: { virtuals: true },
+    toObject: { virtuals: true },
 });
-const MortgageModel = mongoose.model("Mortgage", mortgageSchema);
+const virtualRepaymentType = mortgageSchema.virtual("repaymentType", {
+    ref: "Lookup",
+    localField: "repaymentTypeLid",
+    foreignField: "_id",
+    justOne: true,
+});
+virtualRepaymentType.description = "Populated lookup value for repayment type";
+const virtualMortgageType = mortgageSchema.virtual("mortgageType", {
+    ref: "Lookup",
+    localField: "mortgageTypeLid",
+    foreignField: "_id",
+    justOne: true,
+});
+virtualMortgageType.description = "Populated lookup value for mortgage type";
+const MortgageModel = mongoose.model("Application_Mortgage", mortgageSchema);
 export default MortgageModel;

package/dist/applications/application.model.d.ts

@@ -39,16 +39,18 @@ declare const ApplicationModel: mongoose.Model<{
     isValuationFeePaid: string;
     withdrawalReason: string;
     withdrawalReasonCode: string;
-    propertyId: mongoose.Types.ObjectId;
+    securityId: mongoose.Types.ObjectId;
     solicitorId: mongoose.Types.ObjectId;
     isActive: string;
     isUkResident: string;
     newAuditRecordsCount: string;
-    propertyPortfolioIds: mongoose.Types.ObjectId[];
+    propertyIds: mongoose.Types.ObjectId[];
     selectedProduct?: string | null | undefined;
     riskRating?: string | null | undefined;
     productFeatures?: {
         name: string;
+        fixedTerm: string;
+        repaymentType: string;
         ltv: string;
         reimbursementPerPound: string;
         stressedPayment: string;
@@ -60,12 +62,10 @@ declare const ApplicationModel: mongoose.Model<{
         reversionRateWithoutBaseRate: string;
         totalReversionRate: string;
         initialRate: string;
-        fixedTerm: string;
         fixedTermEndDate: string;
         baseRate: string;
         productRate: string;
         apr: string;
-        repaymentType: string;
         applicationCategory: string;
         securityType: string;
         erc: string;
@@ -227,16 +227,18 @@ declare const ApplicationModel: mongoose.Model<{
     isValuationFeePaid: string;
     withdrawalReason: string;
     withdrawalReasonCode: string;
-    propertyId: mongoose.Types.ObjectId;
+    securityId: mongoose.Types.ObjectId;
     solicitorId: mongoose.Types.ObjectId;
     isActive: string;
     isUkResident: string;
     newAuditRecordsCount: string;
-    propertyPortfolioIds: mongoose.Types.ObjectId[];
+    propertyIds: mongoose.Types.ObjectId[];
     selectedProduct?: string | null | undefined;
     riskRating?: string | null | undefined;
     productFeatures?: {
         name: string;
+        fixedTerm: string;
+        repaymentType: string;
         ltv: string;
         reimbursementPerPound: string;
         stressedPayment: string;
@@ -248,12 +250,10 @@ declare const ApplicationModel: mongoose.Model<{
         reversionRateWithoutBaseRate: string;
         totalReversionRate: string;
         initialRate: string;
-        fixedTerm: string;
         fixedTermEndDate: string;
         baseRate: string;
         productRate: string;
         apr: string;
-        repaymentType: string;
         applicationCategory: string;
         securityType: string;
         erc: string;
@@ -415,16 +415,18 @@ declare const ApplicationModel: mongoose.Model<{
     isValuationFeePaid: string;
     withdrawalReason: string;
     withdrawalReasonCode: string;
-    propertyId: mongoose.Types.ObjectId;
+    securityId: mongoose.Types.ObjectId;
     solicitorId: mongoose.Types.ObjectId;
     isActive: string;
     isUkResident: string;
     newAuditRecordsCount: string;
-    propertyPortfolioIds: mongoose.Types.ObjectId[];
+    propertyIds: mongoose.Types.ObjectId[];
     selectedProduct?: string | null | undefined;
     riskRating?: string | null | undefined;
     productFeatures?: {
         name: string;
+        fixedTerm: string;
+        repaymentType: string;
         ltv: string;
         reimbursementPerPound: string;
         stressedPayment: string;
@@ -436,12 +438,10 @@ declare const ApplicationModel: mongoose.Model<{
         reversionRateWithoutBaseRate: string;
         totalReversionRate: string;
         initialRate: string;
-        fixedTerm: string;
         fixedTermEndDate: string;
         baseRate: string;
         productRate: string;
         apr: string;
-        repaymentType: string;
         applicationCategory: string;
         securityType: string;
         erc: string;
@@ -615,16 +615,18 @@ declare const ApplicationModel: mongoose.Model<{
     isValuationFeePaid: string;
     withdrawalReason: string;
     withdrawalReasonCode: string;
-    propertyId: mongoose.Types.ObjectId;
+    securityId: mongoose.Types.ObjectId;
     solicitorId: mongoose.Types.ObjectId;
     isActive: string;
     isUkResident: string;
     newAuditRecordsCount: string;
-    propertyPortfolioIds: mongoose.Types.ObjectId[];
+    propertyIds: mongoose.Types.ObjectId[];
     selectedProduct?: string | null | undefined;
     riskRating?: string | null | undefined;
     productFeatures?: {
         name: string;
+        fixedTerm: string;
+        repaymentType: string;
         ltv: string;
         reimbursementPerPound: string;
         stressedPayment: string;
@@ -636,12 +638,10 @@ declare const ApplicationModel: mongoose.Model<{
         reversionRateWithoutBaseRate: string;
         totalReversionRate: string;
         initialRate: string;
-        fixedTerm: string;
         fixedTermEndDate: string;
         baseRate: string;
         productRate: string;
         apr: string;
-        repaymentType: string;
         applicationCategory: string;
         securityType: string;
         erc: string;
@@ -803,16 +803,18 @@ declare const ApplicationModel: mongoose.Model<{
     isValuationFeePaid: string;
     withdrawalReason: string;
     withdrawalReasonCode: string;
-    propertyId: mongoose.Types.ObjectId;
+    securityId: mongoose.Types.ObjectId;
     solicitorId: mongoose.Types.ObjectId;
     isActive: string;
     isUkResident: string;
     newAuditRecordsCount: string;
-    propertyPortfolioIds: mongoose.Types.ObjectId[];
+    propertyIds: mongoose.Types.ObjectId[];
     selectedProduct?: string | null | undefined;
     riskRating?: string | null | undefined;
     productFeatures?: {
         name: string;
+        fixedTerm: string;
+        repaymentType: string;
         ltv: string;
         reimbursementPerPound: string;
         stressedPayment: string;
@@ -824,12 +826,10 @@ declare const ApplicationModel: mongoose.Model<{
         reversionRateWithoutBaseRate: string;
         totalReversionRate: string;
         initialRate: string;
-        fixedTerm: string;
         fixedTermEndDate: string;
         baseRate: string;
         productRate: string;
         apr: string;
-        repaymentType: string;
         applicationCategory: string;
         securityType: string;
         erc: string;
@@ -991,16 +991,18 @@ declare const ApplicationModel: mongoose.Model<{
     isValuationFeePaid: string;
     withdrawalReason: string;
     withdrawalReasonCode: string;
-    propertyId: mongoose.Types.ObjectId;
+    securityId: mongoose.Types.ObjectId;
     solicitorId: mongoose.Types.ObjectId;
     isActive: string;
     isUkResident: string;
     newAuditRecordsCount: string;
-    propertyPortfolioIds: mongoose.Types.ObjectId[];
+    propertyIds: mongoose.Types.ObjectId[];
     selectedProduct?: string | null | undefined;
     riskRating?: string | null | undefined;
     productFeatures?: {
         name: string;
+        fixedTerm: string;
+        repaymentType: string;
         ltv: string;
         reimbursementPerPound: string;
         stressedPayment: string;
@@ -1012,12 +1014,10 @@ declare const ApplicationModel: mongoose.Model<{
         reversionRateWithoutBaseRate: string;
         totalReversionRate: string;
         initialRate: string;
-        fixedTerm: string;
         fixedTermEndDate: string;
         baseRate: string;
         productRate: string;
         apr: string;
-        repaymentType: string;
         applicationCategory: string;
         securityType: string;
         erc: string;

package/dist/applications/application.model.js

@@ -47,7 +47,7 @@ const applicationSchema = new mongoose.Schema({
     withdrawalReasonCode: { type: String, default: "" },
     productId: { type: mongoose.Schema.Types.ObjectId, ref: "Product", required: false },
     product: { type: String },
-    propertyId: { type: mongoose.Schema.Types.ObjectId, ref: "Property", required: true },
+    securityId: { type: mongoose.Schema.Types.ObjectId, ref: "Security", required: true },
     solicitorId: { type: mongoose.Schema.Types.ObjectId, ref: "Solicitor", required: true },
     applicants: [
         { type: mongoose.Schema.Types.ObjectId, ref: "Applicant" }
@@ -62,7 +62,7 @@ const applicationSchema = new mongoose.Schema({
     companyId: { type: mongoose.Schema.Types.ObjectId, ref: "ApplicationCompany" },
     rationaleId: { type: mongoose.Schema.Types.ObjectId, ref: "ApplicationRationale" },
     newAuditRecordsCount: { type: String, default: 0 }, // Ensure it is a Number
-    propertyPortfolioIds: [{ type: mongoose.Schema.Types.ObjectId, ref: "Property_Portfolio" }]
+    propertyIds: [{ type: mongoose.Schema.Types.ObjectId, ref: "Property" }]
 }, {
     timestamps: true,
     toJSON: { virtuals: true },

package/dist/applications/productfeatures.model.d.ts

@@ -1,6 +1,8 @@
 import mongoose from "mongoose";
 declare const productFeaturesSchema: mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
     name: string;
+    fixedTerm: string;
+    repaymentType: string;
     ltv: string;
     reimbursementPerPound: string;
     stressedPayment: string;
@@ -12,12 +14,10 @@ declare const productFeaturesSchema: mongoose.Schema<any, mongoose.Model<any, an
     reversionRateWithoutBaseRate: string;
     totalReversionRate: string;
     initialRate: string;
-    fixedTerm: string;
     fixedTermEndDate: string;
     baseRate: string;
     productRate: string;
     apr: string;
-    repaymentType: string;
     applicationCategory: string;
     securityType: string;
     erc: string;
@@ -121,6 +121,8 @@ declare const productFeaturesSchema: mongoose.Schema<any, mongoose.Model<any, an
     } | null | undefined;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
     name: string;
+    fixedTerm: string;
+    repaymentType: string;
     ltv: string;
     reimbursementPerPound: string;
     stressedPayment: string;
@@ -132,12 +134,10 @@ declare const productFeaturesSchema: mongoose.Schema<any, mongoose.Model<any, an
     reversionRateWithoutBaseRate: string;
     totalReversionRate: string;
     initialRate: string;
-    fixedTerm: string;
     fixedTermEndDate: string;
     baseRate: string;
     productRate: string;
     apr: string;
-    repaymentType: string;
     applicationCategory: string;
     securityType: string;
     erc: string;
@@ -241,6 +241,8 @@ declare const productFeaturesSchema: mongoose.Schema<any, mongoose.Model<any, an
     } | null | undefined;
 }>> & mongoose.FlatRecord<{
     name: string;
+    fixedTerm: string;
+    repaymentType: string;
     ltv: string;
     reimbursementPerPound: string;
     stressedPayment: string;
@@ -252,12 +254,10 @@ declare const productFeaturesSchema: mongoose.Schema<any, mongoose.Model<any, an
     reversionRateWithoutBaseRate: string;
     totalReversionRate: string;
     initialRate: string;
-    fixedTerm: string;
     fixedTermEndDate: string;
     baseRate: string;
     productRate: string;
     apr: string;
-    repaymentType: string;
     applicationCategory: string;
     securityType: string;
     erc: string;

package/dist/properties/index.d.ts

@@ -1,3 +1,3 @@
+export { default as SecurityModel } from './security.model';
 export { default as PropertyModel } from './property.model';
-export { default as PropertyPortfolioModel } from './property-potfolio.model';
 //# sourceMappingURL=index.d.ts.map

package/dist/properties/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../properties/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../properties/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/properties/index.js

@@ -1,2 +1,2 @@
+export { default as SecurityModel } from './security.model';
 export { default as PropertyModel } from './property.model';
-export { default as PropertyPortfolioModel } from './property-potfolio.model';