@dynamatix/gb-schemas 1.2.145 → 1.2.147

package/dist/applicants/applicant-employment.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applicant-employment.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-employment.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqD7B,CAAC;AAEH,eAAe,yBAAyB,CAAC"}
+{"version":3,"file":"applicant-employment.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-employment.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AA+C/C,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAgF,CAAC;AAE1G,eAAe,mBAAmB,CAAC"}

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

@@ -2,7 +2,6 @@ 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 },
@@ -12,10 +11,6 @@ const applicantEmploymentSchema = new mongoose.Schema({
     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 },
@@ -23,10 +18,7 @@ const applicantEmploymentSchema = new mongoose.Schema({
     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,
-    },
+    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 },
@@ -47,11 +39,10 @@ const applicantEmploymentSchema = new mongoose.Schema({
     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 }
 });
-export default applicantEmploymentSchema;
+const ApplicantEmployment = mongoose.model("Applicant_Employment_Information", applicantEmploymentSchema);
+export default ApplicantEmployment;

package/dist/applicants/applicant-expenditure.model.d.ts

@@ -1,64 +1,93 @@
 import mongoose from "mongoose";
 import { Pound } from "../value-objects/pound";
-declare const applicantExpenditureSchema: mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+declare const ApplicantExpenditureModel: mongoose.Model<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    applicantId: mongoose.Types.ObjectId;
+    isFixed: boolean;
+    expenditureTypeLid: mongoose.Types.ObjectId;
+    sectionName?: "essentialExpenditure" | "basicCostOfLivingExpenditure" | null | undefined;
+    declared?: Pound | null | undefined;
+    expected?: Pound | null | undefined;
+    actual?: Pound | null | undefined;
+    rationale?: string | null | undefined;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    applicantId: mongoose.Types.ObjectId;
+    isFixed: boolean;
+    expenditureTypeLid: mongoose.Types.ObjectId;
+    sectionName?: "essentialExpenditure" | "basicCostOfLivingExpenditure" | null | undefined;
+    declared?: Pound | null | undefined;
+    expected?: Pound | null | undefined;
+    actual?: Pound | null | undefined;
+    rationale?: string | null | undefined;
+}> & {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    applicantId: mongoose.Types.ObjectId;
+    isFixed: boolean;
+    expenditureTypeLid: mongoose.Types.ObjectId;
+    sectionName?: "essentialExpenditure" | "basicCostOfLivingExpenditure" | null | undefined;
+    declared?: Pound | null | undefined;
+    expected?: Pound | null | undefined;
+    actual?: Pound | null | undefined;
+    rationale?: string | null | undefined;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    timestamps: true;
     toJSON: {
-        getters: true;
+        virtuals: true;
     };
     toObject: {
-        getters: true;
+        virtuals: true;
     };
 }, {
-    pageValidFlag: boolean;
-    utilities: Pound;
-    transport: Pound;
-    subsistence: Pound;
-    communication: Pound;
-    health: Pound;
-    groundRentOrServiceCharge: Pound;
-    insurance: Pound;
-    childCareForDependents: Pound;
-    councilTax: Pound;
-    clothingAndFootwear: Pound;
-    vehicleInsurance: Pound;
-    mortgagePaymentVehicle: Pound;
-    other: Pound;
-    totalMontlyExpenditure?: string | null | undefined;
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    applicantId: mongoose.Types.ObjectId;
+    isFixed: boolean;
+    expenditureTypeLid: mongoose.Types.ObjectId;
+    sectionName?: "essentialExpenditure" | "basicCostOfLivingExpenditure" | null | undefined;
+    declared?: Pound | null | undefined;
+    expected?: Pound | null | undefined;
+    actual?: Pound | null | undefined;
+    rationale?: string | null | undefined;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
-    pageValidFlag: boolean;
-    utilities: Pound;
-    transport: Pound;
-    subsistence: Pound;
-    communication: Pound;
-    health: Pound;
-    groundRentOrServiceCharge: Pound;
-    insurance: Pound;
-    childCareForDependents: Pound;
-    councilTax: Pound;
-    clothingAndFootwear: Pound;
-    vehicleInsurance: Pound;
-    mortgagePaymentVehicle: Pound;
-    other: Pound;
-    totalMontlyExpenditure?: string | null | undefined;
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    applicantId: mongoose.Types.ObjectId;
+    isFixed: boolean;
+    expenditureTypeLid: mongoose.Types.ObjectId;
+    sectionName?: "essentialExpenditure" | "basicCostOfLivingExpenditure" | null | undefined;
+    declared?: Pound | null | undefined;
+    expected?: Pound | null | undefined;
+    actual?: Pound | null | undefined;
+    rationale?: string | null | undefined;
 }>> & mongoose.FlatRecord<{
-    pageValidFlag: boolean;
-    utilities: Pound;
-    transport: Pound;
-    subsistence: Pound;
-    communication: Pound;
-    health: Pound;
-    groundRentOrServiceCharge: Pound;
-    insurance: Pound;
-    childCareForDependents: Pound;
-    councilTax: Pound;
-    clothingAndFootwear: Pound;
-    vehicleInsurance: Pound;
-    mortgagePaymentVehicle: Pound;
-    other: Pound;
-    totalMontlyExpenditure?: string | null | undefined;
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    applicantId: mongoose.Types.ObjectId;
+    isFixed: boolean;
+    expenditureTypeLid: mongoose.Types.ObjectId;
+    sectionName?: "essentialExpenditure" | "basicCostOfLivingExpenditure" | null | undefined;
+    declared?: Pound | null | undefined;
+    expected?: Pound | null | undefined;
+    actual?: Pound | null | undefined;
+    rationale?: string | null | undefined;
 }> & {
     _id: mongoose.Types.ObjectId;
 } & {
     __v: number;
-}>;
-export default applicantExpenditureSchema;
+}>>;
+export default ApplicantExpenditureModel;
 //# sourceMappingURL=applicant-expenditure.model.d.ts.map

package/dist/applicants/applicant-expenditure.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applicant-expenditure.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-expenditure.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmB9B,CAAC;AAEH,eAAe,0BAA0B,CAAC"}
+{"version":3,"file":"applicant-expenditure.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-expenditure.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AA2E/C,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAuE,CAAC;AACvG,eAAe,yBAAyB,CAAC"}

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

@@ -1,23 +1,62 @@
 import mongoose from "mongoose";
 import { Pound } from "../value-objects/pound";
 const applicantExpenditureSchema = new mongoose.Schema({
-    pageValidFlag: { type: Boolean, default: false },
-    utilities: { type: Pound, required: true },
-    transport: { type: Pound, required: true },
-    subsistence: { type: Pound, required: true },
-    communication: { type: Pound, required: true },
-    health: { type: Pound, required: true },
-    groundRentOrServiceCharge: { type: Pound, required: true },
-    insurance: { type: Pound, required: true },
-    childCareForDependents: { type: Pound, required: true },
-    councilTax: { type: Pound, required: true },
-    clothingAndFootwear: { type: Pound, required: true },
-    vehicleInsurance: { type: Pound, required: true },
-    mortgagePaymentVehicle: { type: Pound, required: true },
-    other: { type: Pound, required: true },
-    totalMontlyExpenditure: { type: String, }
+    applicantId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Applicant",
+        required: true,
+        description: "Reference to the applicant this expenditure record belongs to.",
+    },
+    isFixed: {
+        type: Boolean,
+        default: false,
+        description: "True if all mandatory fields have been completed, otherwise false.",
+    },
+    expenditureTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        default: null,
+        description: "Essential expenditure lookup",
+    },
+    sectionName: {
+        type: String,
+        enum: [
+            "essentialExpenditure",
+            "basicCostOfLivingExpenditure"
+        ],
+        description: "Section of the application this expenditure belongs to.",
+    },
+    declared: {
+        type: Pound,
+        description: "Declared monthly expenditure amount provided by the applicant.",
+    },
+    expected: {
+        type: Pound,
+        description: "Office for National Statistics (ONS) benchmark monthly expenditure.",
+    },
+    actual: {
+        type: Pound,
+        description: "Actual monthly expenditure verified based on applicant's evidence.",
+    },
+    rationale: {
+        type: String,
+        description: "Rationalized monthly expenditure used for affordability assessment.",
+    }
 }, {
-    toJSON: { getters: true },
-    toObject: { getters: true }
+    timestamps: true,
+    toJSON: { virtuals: true },
+    toObject: { virtuals: true },
 });
-export default applicantExpenditureSchema;
+// Virtual property for essentialExpenditure
+const virtualEssentialExpenditure = applicantExpenditureSchema.virtual("ExpenditureType", {
+    ref: "Lookup",
+    localField: "expenditureTypeLid",
+    foreignField: "_id",
+    justOne: true,
+    options: {
+        select: "label",
+    },
+});
+virtualEssentialExpenditure.description = "Populated lookup value for essential expenditure.";
+const ApplicantExpenditureModel = mongoose.model("Applicant_Expenditure", applicantExpenditureSchema);
+export default ApplicantExpenditureModel;

package/dist/applicants/applicant-income-settings.model.d.ts

@@ -0,0 +1,54 @@
+import mongoose from "mongoose";
+declare const ApplicantIncomeSettingsModel: mongoose.Model<{
+    applicantId: mongoose.Types.ObjectId;
+    employmentStatusLid: mongoose.Types.ObjectId;
+    incomeFromEmployment: boolean;
+    incomeFromPension: boolean;
+    incomeFromProperty: boolean;
+    incomeFromSavings: boolean;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    applicantId: mongoose.Types.ObjectId;
+    employmentStatusLid: mongoose.Types.ObjectId;
+    incomeFromEmployment: boolean;
+    incomeFromPension: boolean;
+    incomeFromProperty: boolean;
+    incomeFromSavings: boolean;
+}> & {
+    applicantId: mongoose.Types.ObjectId;
+    employmentStatusLid: mongoose.Types.ObjectId;
+    incomeFromEmployment: boolean;
+    incomeFromPension: boolean;
+    incomeFromProperty: boolean;
+    incomeFromSavings: boolean;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
+    applicantId: mongoose.Types.ObjectId;
+    employmentStatusLid: mongoose.Types.ObjectId;
+    incomeFromEmployment: boolean;
+    incomeFromPension: boolean;
+    incomeFromProperty: boolean;
+    incomeFromSavings: boolean;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    applicantId: mongoose.Types.ObjectId;
+    employmentStatusLid: mongoose.Types.ObjectId;
+    incomeFromEmployment: boolean;
+    incomeFromPension: boolean;
+    incomeFromProperty: boolean;
+    incomeFromSavings: boolean;
+}>> & mongoose.FlatRecord<{
+    applicantId: mongoose.Types.ObjectId;
+    employmentStatusLid: mongoose.Types.ObjectId;
+    incomeFromEmployment: boolean;
+    incomeFromPension: boolean;
+    incomeFromProperty: boolean;
+    incomeFromSavings: boolean;
+}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>;
+export default ApplicantIncomeSettingsModel;
+//# sourceMappingURL=applicant-income-settings.model.d.ts.map

package/dist/applicants/applicant-income-settings.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applicant-income-settings.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-income-settings.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAiBhC,QAAA,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA6E,CAAC;AAEhH,eAAe,4BAA4B,CAAE"}

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

@@ -0,0 +1,16 @@
+import mongoose from "mongoose";
+const applicantIncomeSettingsSchema = new mongoose.Schema({
+    applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true },
+    employmentStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    incomeFromEmployment: { type: Boolean, default: false },
+    incomeFromPension: { type: Boolean, default: false },
+    incomeFromProperty: { type: Boolean, default: false },
+    incomeFromSavings: { type: Boolean, default: false }
+});
+applicantIncomeSettingsSchema.virtual('lendingType').get(function () {
+    return this.applicantId?.lendingTypeLid instanceof mongoose.Types.ObjectId
+        ? null
+        : this.applicantId?.lendingTypeLid?.name || null;
+});
+const ApplicantIncomeSettingsModel = mongoose.model("Applicant_IncomeSettings", applicantIncomeSettingsSchema);
+export default ApplicantIncomeSettingsModel;