@dynamatix/gb-schemas 2.17.12 → 2.17.13

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

@@ -0,0 +1 @@
+{"version":3,"file":"applicant-income-summary.model.d.ts","sourceRoot":"","sources":["../../applicants/applicant-income-summary.model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAe,MAAM,wBAAwB,CAAC;AAgE5D,QAAA,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA2E,CAAC;AAE7G,eAAe,2BAA2B,CAAC"}

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

@@ -0,0 +1,59 @@
+import mongoose from "mongoose";
+import { applyWorkflowPlugin } from "../shared/workflow.plugin";
+import { Pound, formatPound } from "../value-objects/pound";
+import { applyAuditMiddleware } from "@dynamatix/cat-shared/middlewares";
+const applicantIncomeSummarySchema = new mongoose.Schema({
+    applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true },
+    totalEmploymentGrossIncome: { type: Pound, default: 0.00 },
+    totalEmploymentNetIncome: { type: Pound, default: 0.00 },
+    isEmploymentIncomeConfirmed: { type: Boolean, default: false },
+    employmentIncomeRationale: { type: String, default: null },
+    isPensionIncomeConfirmed: { type: Boolean, default: false },
+    pensionIncomeRationale: { type: String, default: null },
+    totalPensionGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    totalPensionNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    totalAdditionalGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    totalAdditionalNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    isAdditionalIncomeConfirmed: { type: Boolean, default: false },
+    additionalIncomeRationale: { type: String, default: null },
+    isUKTaxCreditsIncomeConfirmed: { type: Boolean, default: false },
+    totalUKTaxCreditsNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    ukTaxCreditsIncomeRationale: { type: String, default: null },
+    totalUKTaxCreditsGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    isPropertyIncomeConfirmed: { type: Boolean, default: false },
+    propertyIncomeRationale: { type: String, default: null },
+    selfEmployedIncomeRationale: { type: String, default: null },
+    isSelfEmployedIncomeConfirmed: { type: Boolean, default: false },
+    totalSelfEmployedGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    totalSelfEmployedNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    soleTraderIncomeRationale: { type: String, default: null },
+    isSoleTraderIncomeConfirmed: { type: Boolean, default: false },
+    soleTraderGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    soleTraderNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    totalAnnualGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    totalAnnualNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    // FX Buffer adjustments returned by the v7 HPP affordability calculator
+    countryOfResidence: { type: String, default: null },
+    fxTier: { type: Number, default: null },
+    incomeReductionPercentage: { type: Number, default: 0 },
+    adjustedAnnualGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    adjustedAnnualNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    adjustedMonthlyGrossIncome: { type: Pound, get: formatPound, default: 0.00 },
+    adjustedMonthlyNetIncome: { type: Pound, get: formatPound, default: 0.00 },
+    fxAdjustmentCheckedAt: { type: Date, default: null },
+    fxAdjustmentVersion: { type: String, default: null },
+    // Set when the v7 calculator rejected this applicant's country/product (e.g. Ukraine
+    // missing from the workbook). Null when the last calculator call succeeded. Drives the
+    // "Country not recognised" chip on the Monthly Income tile.
+    fxAdjustmentError: { type: String, default: null },
+}, {
+    toJSON: { getters: true },
+    toObject: { getters: true }
+});
+applyAuditMiddleware(applicantIncomeSummarySchema, "Applicant_Income_Summary");
+// Apply workflow plugin to the schema
+applyWorkflowPlugin(applicantIncomeSummarySchema, 'applicant_income_summary');
+// Add indexes that exist in database but missing from model
+applicantIncomeSummarySchema.index({ applicantId: 1 }, { unique: true }); // Filter by applicant - unique constraint
+const ApplicantIncomeSummaryModel = mongoose.model("Applicant_Income_Summary", applicantIncomeSummarySchema);
+export default ApplicantIncomeSummaryModel;

package/dist/applicants/applicant-income-summary.type.d.ts

@@ -0,0 +1,72 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Types } from "mongoose";
+import { IBaseType } from "../types/base.types";
+export default interface IApplicantIncomeSummary extends IBaseType {
+    applicantId: Types.ObjectId;
+    totalEmploymentGrossIncome?: number;
+    totalEmploymentNetIncome?: number;
+    isEmploymentIncomeConfirmed?: boolean;
+    employmentIncomeRationale?: string | null;
+    isPensionIncomeConfirmed?: boolean;
+    pensionIncomeRationale?: string | null;
+    totalPensionGrossIncome?: number;
+    totalPensionNetIncome?: number;
+    totalAdditionalGrossIncome?: number;
+    totalAdditionalNetIncome?: number;
+    isAdditionalIncomeConfirmed?: boolean;
+    additionalIncomeRationale?: string | null;
+    isUKTaxCreditsIncomeConfirmed?: boolean;
+    totalUKTaxCreditsNetIncome?: number;
+    ukTaxCreditsIncomeRationale?: string | null;
+    totalUKTaxCreditsGrossIncome?: number;
+    isPropertyIncomeConfirmed?: boolean;
+    propertyIncomeRationale?: string | null;
+    selfEmployedIncomeRationale?: string | null;
+    isSelfEmployedIncomeConfirmed?: boolean;
+    totalSelfEmployedGrossIncome?: number;
+    totalSelfEmployedNetIncome?: number;
+    soleTraderIncomeRationale?: string | null;
+    isSoleTraderIncomeConfirmed?: boolean;
+    soleTraderGrossIncome?: number;
+    soleTraderNetIncome?: number;
+    totalAnnualGrossIncome?: number;
+    totalAnnualNetIncome?: number;
+    countryOfResidence?: string | null;
+    fxTier?: number | null;
+    incomeReductionPercentage?: number;
+    adjustedAnnualGrossIncome?: number;
+    adjustedAnnualNetIncome?: number;
+    adjustedMonthlyGrossIncome?: number;
+    adjustedMonthlyNetIncome?: number;
+    fxAdjustmentCheckedAt?: Date | null;
+    fxAdjustmentVersion?: string | null;
+    fxAdjustmentError?: string | null;
+}
+//# sourceMappingURL=applicant-income-summary.type.d.ts.map

package/dist/applicants/applicant-income-summary.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applicant-income-summary.type.d.ts","sourceRoot":"","sources":["../../applicants/applicant-income-summary.type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,uBAAwB,SAAQ,SAAS;IAC9D,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC;IAC5B,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,qBAAqB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC"}

package/dist/applicants/applicant-income-summary.type.js

@@ -0,0 +1 @@
+export {};