@dynamatix/gb-schemas 2.0.34 → 2.0.36

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

@@ -0,0 +1,472 @@
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+declare const MortgageCommitmentModel: mongoose.Model<{
+    isSelected?: unknown;
+    source?: unknown;
+    applicantId?: unknown;
+    repaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    outstandingBalance?: unknown;
+    fixedTerm?: unknown;
+    commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    lenderName?: unknown;
+    monthlyPayment?: unknown;
+    doHaveSharedResponsibility?: unknown;
+    sharedMortgage?: unknown;
+    startDate?: unknown;
+    propertyValue?: {
+        validators: mongoose.Types.DocumentArray<{
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }, mongoose.Types.Subdocument<mongoose.Types.ObjectId, any, {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }> & {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }>;
+        get?: {} | null | undefined;
+        schema?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        set?: {} | null | undefined;
+        validate?: {} | null | undefined;
+        default?: {} | null | undefined;
+        text?: {} | null | undefined;
+        unique?: {} | null | undefined;
+        index?: {} | null | undefined;
+        sparse?: {} | null | undefined;
+        required?: {} | null | undefined;
+        ref?: {} | null | undefined;
+        cast?: {} | null | undefined;
+        select?: {} | null | undefined;
+        immutable?: {} | null | undefined;
+        transform?: {} | null | undefined;
+        options?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        OptionsConstructor?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        getEmbeddedSchemaType?: {} | null | undefined;
+        instance?: unknown;
+        isRequired?: unknown;
+        path?: unknown;
+        validateAll?: {} | null | undefined;
+        defaultOptions?: unknown;
+    } | null | undefined;
+    mortgageTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    originalLoanAmount?: {
+        validators: mongoose.Types.DocumentArray<{
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }, mongoose.Types.Subdocument<mongoose.Types.ObjectId, any, {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }> & {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }>;
+        get?: {} | null | undefined;
+        schema?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        set?: {} | null | undefined;
+        validate?: {} | null | undefined;
+        default?: {} | null | undefined;
+        text?: {} | null | undefined;
+        unique?: {} | null | undefined;
+        index?: {} | null | undefined;
+        sparse?: {} | null | undefined;
+        required?: {} | null | undefined;
+        ref?: {} | null | undefined;
+        cast?: {} | null | undefined;
+        select?: {} | null | undefined;
+        immutable?: {} | null | undefined;
+        transform?: {} | null | undefined;
+        options?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        OptionsConstructor?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        getEmbeddedSchemaType?: {} | null | undefined;
+        instance?: unknown;
+        isRequired?: unknown;
+        path?: unknown;
+        validateAll?: {} | null | undefined;
+        defaultOptions?: unknown;
+    } | null | undefined;
+    furtherAdvances?: unknown;
+    furtherAdvanceDetails?: unknown;
+    accountUptoDate?: unknown;
+    accountUptoDateFailDetails?: unknown;
+    accountInArrears?: unknown;
+    accountInArrearsDetails?: unknown;
+    financeTypeHppLid?: mongoose.Types.ObjectId | null | undefined;
+    hppRepaymentTypeLid?: unknown;
+    mortgageRate?: unknown;
+    financeHomeTypeLid?: unknown;
+    remainingTermMonth?: unknown;
+    chargeTypeLid?: unknown;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    isSelected?: unknown;
+    source?: unknown;
+    applicantId?: unknown;
+    repaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    outstandingBalance?: unknown;
+    fixedTerm?: unknown;
+    commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    lenderName?: unknown;
+    monthlyPayment?: unknown;
+    doHaveSharedResponsibility?: unknown;
+    sharedMortgage?: unknown;
+    startDate?: unknown;
+    propertyValue?: {
+        validators: mongoose.Types.DocumentArray<{
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }, mongoose.Types.Subdocument<mongoose.Types.ObjectId, any, {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }> & {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }>;
+        get?: {} | null | undefined;
+        schema?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        set?: {} | null | undefined;
+        validate?: {} | null | undefined;
+        default?: {} | null | undefined;
+        text?: {} | null | undefined;
+        unique?: {} | null | undefined;
+        index?: {} | null | undefined;
+        sparse?: {} | null | undefined;
+        required?: {} | null | undefined;
+        ref?: {} | null | undefined;
+        cast?: {} | null | undefined;
+        select?: {} | null | undefined;
+        immutable?: {} | null | undefined;
+        transform?: {} | null | undefined;
+        options?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        OptionsConstructor?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        getEmbeddedSchemaType?: {} | null | undefined;
+        instance?: unknown;
+        isRequired?: unknown;
+        path?: unknown;
+        validateAll?: {} | null | undefined;
+        defaultOptions?: unknown;
+    } | null | undefined;
+    mortgageTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    originalLoanAmount?: {
+        validators: mongoose.Types.DocumentArray<{
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }, mongoose.Types.Subdocument<mongoose.Types.ObjectId, any, {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }> & {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }>;
+        get?: {} | null | undefined;
+        schema?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        set?: {} | null | undefined;
+        validate?: {} | null | undefined;
+        default?: {} | null | undefined;
+        text?: {} | null | undefined;
+        unique?: {} | null | undefined;
+        index?: {} | null | undefined;
+        sparse?: {} | null | undefined;
+        required?: {} | null | undefined;
+        ref?: {} | null | undefined;
+        cast?: {} | null | undefined;
+        select?: {} | null | undefined;
+        immutable?: {} | null | undefined;
+        transform?: {} | null | undefined;
+        options?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        OptionsConstructor?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        getEmbeddedSchemaType?: {} | null | undefined;
+        instance?: unknown;
+        isRequired?: unknown;
+        path?: unknown;
+        validateAll?: {} | null | undefined;
+        defaultOptions?: unknown;
+    } | null | undefined;
+    furtherAdvances?: unknown;
+    furtherAdvanceDetails?: unknown;
+    accountUptoDate?: unknown;
+    accountUptoDateFailDetails?: unknown;
+    accountInArrears?: unknown;
+    accountInArrearsDetails?: unknown;
+    financeTypeHppLid?: mongoose.Types.ObjectId | null | undefined;
+    hppRepaymentTypeLid?: unknown;
+    mortgageRate?: unknown;
+    financeHomeTypeLid?: unknown;
+    remainingTermMonth?: unknown;
+    chargeTypeLid?: unknown;
+}> & {
+    isSelected?: unknown;
+    source?: unknown;
+    applicantId?: unknown;
+    repaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    outstandingBalance?: unknown;
+    fixedTerm?: unknown;
+    commitmentId?: unknown;
+    commitmentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    lenderName?: unknown;
+    monthlyPayment?: unknown;
+    doHaveSharedResponsibility?: unknown;
+    sharedMortgage?: unknown;
+    startDate?: unknown;
+    propertyValue?: {
+        validators: mongoose.Types.DocumentArray<{
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }, mongoose.Types.Subdocument<mongoose.Types.ObjectId, any, {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }> & {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }>;
+        get?: {} | null | undefined;
+        schema?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        set?: {} | null | undefined;
+        validate?: {} | null | undefined;
+        default?: {} | null | undefined;
+        text?: {} | null | undefined;
+        unique?: {} | null | undefined;
+        index?: {} | null | undefined;
+        sparse?: {} | null | undefined;
+        required?: {} | null | undefined;
+        ref?: {} | null | undefined;
+        cast?: {} | null | undefined;
+        select?: {} | null | undefined;
+        immutable?: {} | null | undefined;
+        transform?: {} | null | undefined;
+        options?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        OptionsConstructor?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        getEmbeddedSchemaType?: {} | null | undefined;
+        instance?: unknown;
+        isRequired?: unknown;
+        path?: unknown;
+        validateAll?: {} | null | undefined;
+        defaultOptions?: unknown;
+    } | null | undefined;
+    mortgageTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    originalLoanAmount?: {
+        validators: mongoose.Types.DocumentArray<{
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }, mongoose.Types.Subdocument<mongoose.Types.ObjectId, any, {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }> & {
+            type?: unknown;
+            message?: unknown;
+            validator?: unknown;
+            reason?: unknown;
+        }>;
+        get?: {} | null | undefined;
+        schema?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        set?: {} | null | undefined;
+        validate?: {} | null | undefined;
+        default?: {} | null | undefined;
+        text?: {} | null | undefined;
+        unique?: {} | null | undefined;
+        index?: {} | null | undefined;
+        sparse?: {} | null | undefined;
+        required?: {} | null | undefined;
+        ref?: {} | null | undefined;
+        cast?: {} | null | undefined;
+        select?: {} | null | undefined;
+        immutable?: {} | null | undefined;
+        transform?: {} | null | undefined;
+        options?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        OptionsConstructor?: {
+            [x: string]: unknown;
+        } | null | undefined;
+        getEmbeddedSchemaType?: {} | null | undefined;
+        instance?: unknown;
+        isRequired?: unknown;
+        path?: unknown;
+        validateAll?: {} | null | undefined;
+        defaultOptions?: unknown;
+    } | null | undefined;
+    furtherAdvances?: unknown;
+    furtherAdvanceDetails?: unknown;
+    accountUptoDate?: unknown;
+    accountUptoDateFailDetails?: unknown;
+    accountInArrears?: unknown;
+    accountInArrearsDetails?: unknown;
+    financeTypeHppLid?: mongoose.Types.ObjectId | null | undefined;
+    hppRepaymentTypeLid?: unknown;
+    mortgageRate?: unknown;
+    financeHomeTypeLid?: unknown;
+    remainingTermMonth?: unknown;
+    chargeTypeLid?: unknown;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    toJSON: {
+        getters: true;
+        virtuals: true;
+    };
+    toObject: {
+        getters: true;
+        virtuals: true;
+    };
+}, {
+    isSelected: boolean;
+    source: "Broker" | "Credit Report" | "Underwriter";
+    repaymentTypeLid: mongoose.Types.ObjectId;
+    fixedTerm: string;
+    commitmentId: string;
+    commitmentTypeLid: mongoose.Types.ObjectId;
+    sharedMortgage: string;
+    startDate: string;
+    propertyValue: Pound;
+    mortgageTypeLid: mongoose.Types.ObjectId;
+    originalLoanAmount: Pound;
+    furtherAdvanceDetails: string;
+    accountUptoDateFailDetails: string;
+    accountInArrearsDetails: string;
+    financeTypeHppLid: mongoose.Types.ObjectId;
+    applicantId?: mongoose.Types.ObjectId | null | undefined;
+    outstandingBalance?: Pound | null | undefined;
+    lenderName?: string | null | undefined;
+    monthlyPayment?: Pound | null | undefined;
+    doHaveSharedResponsibility?: boolean | null | undefined;
+    furtherAdvances?: boolean | null | undefined;
+    accountUptoDate?: boolean | null | undefined;
+    accountInArrears?: boolean | null | undefined;
+    hppRepaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    mortgageRate?: number | null | undefined;
+    financeHomeTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    remainingTermMonth?: number | null | undefined;
+    chargeTypeLid?: mongoose.Types.ObjectId | null | undefined;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    isSelected: boolean;
+    source: "Broker" | "Credit Report" | "Underwriter";
+    repaymentTypeLid: mongoose.Types.ObjectId;
+    fixedTerm: string;
+    commitmentId: string;
+    commitmentTypeLid: mongoose.Types.ObjectId;
+    sharedMortgage: string;
+    startDate: string;
+    propertyValue: Pound;
+    mortgageTypeLid: mongoose.Types.ObjectId;
+    originalLoanAmount: Pound;
+    furtherAdvanceDetails: string;
+    accountUptoDateFailDetails: string;
+    accountInArrearsDetails: string;
+    financeTypeHppLid: mongoose.Types.ObjectId;
+    applicantId?: mongoose.Types.ObjectId | null | undefined;
+    outstandingBalance?: Pound | null | undefined;
+    lenderName?: string | null | undefined;
+    monthlyPayment?: Pound | null | undefined;
+    doHaveSharedResponsibility?: boolean | null | undefined;
+    furtherAdvances?: boolean | null | undefined;
+    accountUptoDate?: boolean | null | undefined;
+    accountInArrears?: boolean | null | undefined;
+    hppRepaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    mortgageRate?: number | null | undefined;
+    financeHomeTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    remainingTermMonth?: number | null | undefined;
+    chargeTypeLid?: mongoose.Types.ObjectId | null | undefined;
+}>> & mongoose.FlatRecord<{
+    isSelected: boolean;
+    source: "Broker" | "Credit Report" | "Underwriter";
+    repaymentTypeLid: mongoose.Types.ObjectId;
+    fixedTerm: string;
+    commitmentId: string;
+    commitmentTypeLid: mongoose.Types.ObjectId;
+    sharedMortgage: string;
+    startDate: string;
+    propertyValue: Pound;
+    mortgageTypeLid: mongoose.Types.ObjectId;
+    originalLoanAmount: Pound;
+    furtherAdvanceDetails: string;
+    accountUptoDateFailDetails: string;
+    accountInArrearsDetails: string;
+    financeTypeHppLid: mongoose.Types.ObjectId;
+    applicantId?: mongoose.Types.ObjectId | null | undefined;
+    outstandingBalance?: Pound | null | undefined;
+    lenderName?: string | null | undefined;
+    monthlyPayment?: Pound | null | undefined;
+    doHaveSharedResponsibility?: boolean | null | undefined;
+    furtherAdvances?: boolean | null | undefined;
+    accountUptoDate?: boolean | null | undefined;
+    accountInArrears?: boolean | null | undefined;
+    hppRepaymentTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    mortgageRate?: number | null | undefined;
+    financeHomeTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    remainingTermMonth?: number | null | undefined;
+    chargeTypeLid?: mongoose.Types.ObjectId | null | undefined;
+}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>;
+export default MortgageCommitmentModel;
+//# sourceMappingURL=applicant-commitment-mortgage.model.d.ts.map

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

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

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

@@ -0,0 +1,69 @@
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+const mortgageCommitmentSchema = new mongoose.Schema({
+    applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant" },
+    lenderName: { type: String }, // Provider Name / Provider category
+    propertyValue: { type: Pound, default: null },
+    repaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    mortgageTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    fixedTerm: { type: String, default: null },
+    originalLoanAmount: { type: Pound, default: null },
+    outstandingBalance: { type: Pound }, // Balance
+    startDate: { type: String, default: null },
+    monthlyPayment: { type: Pound }, // Monthly payment
+    commitmentId: { type: String, default: null },
+    commitmentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    furtherAdvances: {
+        type: Boolean
+    },
+    furtherAdvanceDetails: { type: String, default: null },
+    accountUptoDate: {
+        type: Boolean
+    },
+    accountUptoDateFailDetails: { type: String, default: null },
+    accountInArrears: {
+        type: Boolean
+    },
+    accountInArrearsDetails: { type: String, default: null },
+    doHaveSharedResponsibility: {
+        type: Boolean
+    },
+    sharedMortgage: { type: String, default: null },
+    source: {
+        type: String,
+        enum: ["Broker", "Credit Report", "Underwriter"],
+        default: "Broker"
+    },
+    isSelected: { type: Boolean, default: true }, // mark as selected for summary calculation
+    financeTypeHppLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
+    hppRepaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
+    mortgageRate: { type: Number },
+    financeHomeTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
+    remainingTermMonth: { type: Number },
+    chargeTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" }
+}, {
+    toJSON: { getters: true, virtuals: true },
+    toObject: { getters: true, virtuals: true }
+});
+// virtual field: ApplicationId (applicantId -> applicationId)
+mortgageCommitmentSchema.virtual('ApplicationId', {
+    ref: 'Applicant',
+    localField: 'applicantId',
+    foreignField: '_id',
+    justOne: true,
+    options: { select: 'applicationId' }
+});
+// virtual property 'lendingType'
+mortgageCommitmentSchema.virtual('lendingType').get(function () {
+    return this.applicantId?.applicationId?.lendingTypeLid instanceof mongoose.Types.ObjectId
+        ? null
+        : this.applicantId?.applicationId?.lendingTypeLid?.name || null;
+});
+// virtual property 'applicationType'
+mortgageCommitmentSchema.virtual('applicationType').get(function () {
+    return this.applicantId?.applicationId?.applicationTypeLid instanceof mongoose.Types.ObjectId
+        ? null
+        : this.applicantId?.applicationId?.applicationTypeLid?.name || null;
+});
+const MortgageCommitmentModel = mongoose.model("MortgageCommitment", mortgageCommitmentSchema);
+export default MortgageCommitmentModel;