@dynamatix/gb-schemas 2.0.27 → 2.0.28

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

@@ -1,35 +0,0 @@
-import mongoose from "mongoose";
-const documentSchema = new mongoose.Schema({
-    applicationId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Application",
-        required: false,
-    },
-    documentId: { type: String, required: true },
-    owningEntityId: { type: String, required: false },
-    documentTypeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        required: false,
-    },
-    documentTypeId: { type: String, required: false },
-    fileName: { type: String, required: false },
-    contentType: { type: String, required: false },
-    created: { type: String, required: false },
-    createdBy: { type: String, required: false },
-    isGenerated: { type: String, required: false },
-    data: { type: String, required: false },
-    envelopeId: { type: String, required: false },
-    signers: { type: Array, default: [] },
-    documentType: {
-        documentTypeId: { type: String, required: false },
-        displayName: { type: String, required: false },
-        value: { type: String, required: false },
-        data: { type: Object, required: false },
-    },
-    documentUrl: { type: String, required: false },
-}, {
-    timestamps: true
-});
-const ApplicationDocumentModel = mongoose.model("ApplicationDocument", documentSchema);
-export default ApplicationDocumentModel;

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

@@ -1,7 +0,0 @@
-import mongoose from "mongoose";
-const fieldConfigSchema = new mongoose.Schema({
-    fieldName: { type: String, required: true, unique: true },
-    validateProductOnChange: { type: String, default: true }
-});
-const ApplicationFieldConfigModel = mongoose.model('FieldConfig', fieldConfigSchema);
-export default ApplicationFieldConfigModel;

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

@@ -1,6 +0,0 @@
-import mongoose from "mongoose";
-const illustrationSchema = new mongoose.Schema({
-    date: { type: Date } // e.g., the date of illustration
-});
-const IllustrationModel = mongoose.model("Illustration", illustrationSchema);
-export default IllustrationModel;

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

@@ -1,7 +0,0 @@
-import mongoose from "mongoose";
-const legalSchema = new mongoose.Schema({
-    assignedSolicitor: { type: String, default: "" },
-    solicitorsReference: { type: String, default: "" }
-});
-const LegalModel = mongoose.model("Legal", legalSchema);
-export default LegalModel;

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

@@ -1,271 +0,0 @@
-import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
-const mortgageSchema = new mongoose.Schema({
-    applicationId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Application",
-        required: true,
-        description: "Unique identifier for the application",
-    },
-    pageValidFlag: {
-        type: Boolean,
-        default: false,
-        description: "True if all mandatory fields have been completed, otherwise false",
-    },
-    existingMortgageLender: {
-        type: String,
-        maxlength: 35,
-        description: "Name of the existing mortgage lender",
-    },
-    topSlicing: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the mortgage is being paid off using top slicing",
-    },
-    purposeOfMortgage: {
-        type: String,
-        required: true,
-        maxlength: 50,
-        description: "Purpose of the mortgage (e.g., purchase, refinance)",
-    },
-    depositComeFromLids: {
-        type: [mongoose.Schema.Types.ObjectId],
-        ref: "Lookup",
-        required: true,
-        default: null,
-        description: "Where the deposit for the mortgage will come from",
-    },
-    ifOtherDetails: {
-        type: String,
-        maxlength: 50,
-        required: true,
-        description: "Details if the deposit comes from 'Other'",
-    },
-    purchasePrice: {
-        type: Pound,
-        required: true,
-        description: "Purchase price of the property",
-    },
-    repaymentTypeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        required: true,
-        default: null,
-        description: "Lookup ID representing the type of repayment (e.g., interest-only, repayment)",
-    },
-    exitStrategyLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        required: true,
-        default: null,
-        description: "Lookup ID representing the Exit strategy for the mortgage)",
-    },
-    isCapitalRaise: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if capital raising is part of this finance",
-    },
-    purchaseDate: {
-        type: String,
-        required: true,
-        default: null,
-        description: "Purchase date of the property",
-    },
-    estimatedValue: {
-        type: Pound,
-        required: true,
-        description: "Estimated value of the property",
-    },
-    loanRequired: {
-        type: Pound,
-        required: true,
-        description: "Amount of finance required",
-    },
-    monthlyRentalIncome: {
-        type: Pound,
-        required: true,
-        description: "Monthly rental income from the property",
-    },
-    outstandingBalance: {
-        type: Pound,
-        required: true,
-        description: "Outstanding balance on the existing mortgage",
-    },
-    fundRaisedFor: {
-        type: String,
-        maxlength: 250,
-        required: true,
-        description: "What the funds raised will be used for",
-    },
-    sourceOfFundsLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        required: true,
-        default: null,
-        description: "Lookup ID representing the Main source of income for monthly finance payments",
-    },
-    sourceOfFundDetails: {
-        type: String,
-        maxlength: 50,
-        required: true,
-        description: "Additional details if the source of funds is 'Other'",
-    },
-    propertyValuationDetails: {
-        type: String,
-        maxlength: 35,
-        required: true,
-        description: "Details on who to contact for property valuation",
-    },
-    telephoneNumber: {
-        type: String,
-        maxlength: 15,
-        required: true,
-        description: "Contact number for property valuation",
-    },
-    isDistressedSale: {
-        type: Boolean,
-        default: false,
-        required: true,
-        description: "Indicates if this is a distressed sale",
-    },
-    isPurchasedBelowMarketValue: {
-        type: Boolean,
-        default: false,
-        required: true,
-        description: "Indicates if the property is purchased below market value",
-    },
-    isPurchasedAsSale: {
-        type: Boolean,
-        default: false,
-        required: true,
-        description: "Indicates if the property is purchased as a sale and rent back",
-    },
-    isReadyToSell: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the property is ready to sell or let out",
-    },
-    isGovernmentInitiative: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if this purchase is part of a government initiative",
-    },
-    vendorsName: {
-        type: String,
-        maxlength: 35,
-        description: "Vendor's name in case of property sale",
-    },
-    saleMadeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        description: "Method of sale made",
-    },
-    isTheIntentionToLet: {
-        type: Boolean,
-        default: false,
-        description: "Indicates if the intention is to let out the property",
-    },
-    proposedTenantsLids: {
-        type: [mongoose.Schema.Types.ObjectId],
-        ref: "Lookup",
-        description: "Proposed tenants for the property",
-    },
-    leaseTypeLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Lookup",
-        required: true,
-        default: null,
-        description: "Lease type for the property",
-    },
-}, {
-    timestamps: true,
-    toJSON: { virtuals: true },
-    toObject: { virtuals: true },
-});
-// const virtualDepositComeFrom = mortgageSchema.virtual("depositComeFrom", {
-//   ref: "Lookup",
-//   localField: "depositComeFromLid",
-//   foreignField: "_id",
-//   justOne: false,
-// }) as VirtualWithDescription;
-// virtualDepositComeFrom.description =
-//   "Populated lookup values for where the deposit for the mortgage will come from";
-// const virtualRepaymentType = mortgageSchema.virtual("repaymentType", {
-//   ref: "Lookup",
-//   localField: "repaymentTypeLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualRepaymentType.description =
-//   "Populated lookup value representing the type of repayment";
-// const virtualExitStrategy = mortgageSchema.virtual("exitStrategy", {
-//   ref: "Lookup",
-//   localField: "exitStrategyLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualExitStrategy.description = "Populated lookup value for exit strategy";
-// const virtualSourceOfFunds = mortgageSchema.virtual("sourceOfFunds", {
-//   ref: "Lookup",
-//   localField: "sourceOfFundsLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualSourceOfFunds.description =
-//   "Populated lookup value for the main source of income for monthly finance payments";
-// const virtualSaleMade = mortgageSchema.virtual("saleMade", {
-//   ref: "Lookup",
-//   localField: "saleMadeLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualSaleMade.description = "Populated lookup value for method of sale made";
-// const virtualProposedTenants = mortgageSchema.virtual("proposedTenants", {
-//   ref: "Lookup",
-//   localField: "proposedTenantsLid",
-//   foreignField: "_id",
-//   justOne: false,
-// }) as VirtualWithDescription;
-// virtualProposedTenants.description =
-//   "Populated lookup values for proposed tenants of the property";
-// const virtualLeaseType = mortgageSchema.virtual("leaseType", {
-//   ref: "Lookup",
-//   localField: "leaseTypeLid",
-//   foreignField: "_id",
-//   justOne: true,
-// }) as VirtualWithDescription;
-// virtualLeaseType.description = "Populated lookup value for lease type";
-// virtual property 'applicationType'
-mortgageSchema.virtual("applicationType").get(function () {
-    return this.applicationId?.applicationTypeLid instanceof
-        mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.applicationTypeLid?.text || null;
-});
-// virtual property 'lendingType'
-mortgageSchema.virtual("lendingType").get(function () {
-    return this.applicationId?.lendingTypeLid instanceof
-        mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.lendingTypeLid?.text || null;
-});
-// virtual property 'purchaseType'
-mortgageSchema.virtual("purchaseType").get(function () {
-    return this.applicationId?.purchaseTypeLid instanceof
-        mongoose.Types.ObjectId
-        ? null
-        : this.applicationId?.purchaseTypeLid?.text || null;
-});
-// virtual property 'lendingType'
-mortgageSchema.virtual("sourceOfWealth").get(function () {
-    const sourceOfWealthLids = this.applicationId?.sourceOfWealthLids;
-    if (!Array.isArray(sourceOfWealthLids)) {
-        return null;
-    }
-    return sourceOfWealthLids
-        .filter((lid) => !(lid instanceof mongoose.Types.ObjectId))
-        .map((lid) => lid?.text || null)
-        .filter((text) => text !== null);
-});
-const MortgageModel = mongoose.model("Mortgage", mortgageSchema);
-export default MortgageModel;

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

@@ -1,78 +0,0 @@
-import mongoose from "mongoose";
-const noteSchema = new mongoose.Schema({
-    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true },
-    noteId: {
-        type: String,
-        default: null
-    },
-    createdOn: {
-        type: String,
-        default: null
-    },
-    createdBy: {
-        type: String,
-        default: null
-    },
-    username: {
-        type: String,
-        default: null
-    },
-    createdByUserId: {
-        type: mongoose.Schema.Types.ObjectId, ref: "User",
-    },
-    typeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    subTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    subject: {
-        type: String,
-        default: null
-    },
-    note: {
-        type: String,
-        required: true
-    },
-    reminderDate: {
-        type: String,
-        default: null
-    },
-    attachmentDocumentId: {
-        type: String,
-        default: null
-    },
-    assignedOperation: {
-        type: String,
-        default: ''
-    },
-    autoCreated: {
-        type: String,
-        default: false
-    },
-    additionalData: {
-        type: mongoose.Schema.Types.Mixed,
-        default: null
-    },
-    autoCreatedId: {
-        type: String,
-        default: null
-    },
-    assignedTo: {
-        type: String,
-        default: ''
-    },
-    assignedBy: {
-        type: String,
-        default: null
-    },
-    assignedByUserId: {
-        type: mongoose.Schema.Types.ObjectId, ref: "User",
-    },
-    comment: {
-        type: String,
-        default: null
-    },
-    reminderStatus: {
-        type: String,
-        default: 'None'
-    }
-});
-const ApplictionNoteModel = mongoose.model("ApplictionNote", noteSchema);
-export default ApplictionNoteModel;

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

@@ -1,6 +0,0 @@
-import mongoose from "mongoose";
-const offerSchema = new mongoose.Schema({
-    date: { type: String } // The date associated with the offer
-});
-const OfferModel = mongoose.model("Offer", offerSchema);
-export default OfferModel;

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

@@ -1,9 +0,0 @@
-import mongoose from "mongoose";
-const onboardingSchema = new mongoose.Schema({
-    errors: { type: String, default: "" },
-    status: { type: String, default: "" },
-    statusDate: { type: String },
-    warnings: { type: String, default: "" }
-});
-const ApplicationOnboardingModel = mongoose.model("ApplicationOnboarding", onboardingSchema);
-export default ApplicationOnboardingModel;

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

@@ -1,67 +0,0 @@
-import mongoose from "mongoose";
-import { Pound } from "../value-objects/pound";
-const productSchema = new mongoose.Schema({
-    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true,
-        description: "Unique identifier for the application"
-    },
-    selectedProduct: { type: String, default: "" },
-    lendingTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    pageValidFlag: { type: Boolean, get: (value) => (value ? "Yes" : "No") },
-    repaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    numberOfYearsToRepay: { type: Number, default: 0 },
-    repaymentVehicle: { type: String, required: true, default: '', maxLength: 100 },
-    fixedAmount: { type: Pound, default: 0.00, required: false },
-    isFinanceRecommendedToApplicantLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    procFeeRateLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    networkClubSubmission: { type: Boolean, required: true, get: (value) => (value ? "Yes" : "No") },
-    clubNetworkNameLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    introducerSubmission: { type: Boolean, required: true, get: (value) => (value ? "Yes" : "No") },
-    introducer: { type: String, default: '' },
-    bdm: { type: String, required: true, default: '' },
-    tempAppFee: { type: Pound, default: 0.00, required: true },
-    productFeePaymentTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" }
-});
-// virtual property 'lendingType'
-productSchema.virtual('lendingType').get(function () {
-    const lendingType = this.lendingTypeLid;
-    return lendingType && lendingType instanceof mongoose.Types.ObjectId
-        ? null
-        : lendingType?.name || null;
-});
-// virtual property 'repaymentType'
-productSchema.virtual('repaymentType').get(function () {
-    const repaymentType = this.repaymentTypeLid;
-    return repaymentType && repaymentType instanceof mongoose.Types.ObjectId
-        ? null
-        : repaymentType?.name || null;
-});
-// virtual property 'isFinanceRecommendedToApplicant'
-productSchema.virtual('isFinanceRecommendedToApplicant').get(function () {
-    const isFinanceRecommendedToApplicant = this.isFinanceRecommendedToApplicantLid;
-    return isFinanceRecommendedToApplicant && isFinanceRecommendedToApplicant instanceof mongoose.Types.ObjectId
-        ? null
-        : isFinanceRecommendedToApplicant?.name || null;
-});
-// virtual property 'procFeeRate'
-productSchema.virtual('procFeeRate').get(function () {
-    const procFeeRate = this.procFeeRateLid;
-    return procFeeRate && procFeeRate instanceof mongoose.Types.ObjectId
-        ? null
-        : procFeeRate?.name || null;
-});
-// virtual property 'clubNetworkName'
-productSchema.virtual('clubNetworkName').get(function () {
-    const clubNetworkName = this.clubNetworkNameLid;
-    return clubNetworkName && clubNetworkName instanceof mongoose.Types.ObjectId
-        ? null
-        : clubNetworkName?.name || null;
-});
-// virtual property 'productFeePaymentType'
-productSchema.virtual('productFeePaymentType').get(function () {
-    const productFeePaymentType = this.productFeePaymentTypeLid;
-    return productFeePaymentType && productFeePaymentType instanceof mongoose.Types.ObjectId
-        ? null
-        : productFeePaymentType?.name || null;
-});
-const ProductModel = mongoose.model("Product", productSchema);
-export default ProductModel;

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

@@ -1,38 +0,0 @@
-import mongoose from "mongoose";
-const rationaleSchema = new mongoose.Schema({
-    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true },
-    affordabilityDescription: { type: String, default: "" },
-    affordabilityAreaOfOfferCondition: { type: String, default: "" },
-    affordabilityAreaOfConcern: { type: String, default: "" },
-    affordabilityStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    applicantsDescription: { type: String, default: "" },
-    applicantsAreaOfOfferCondition: { type: String, default: "" },
-    applicantsAreaOfConcern: { type: String, default: "" },
-    applicantsStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    creditConductDescription: { type: String, default: "" },
-    creditConductAreaOfOfferCondition: { type: String, default: "" },
-    creditConductAreaOfConcern: { type: String, default: "" },
-    creditConductStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    fraudCheckDescription: { type: String, default: "" },
-    fraudCheckAreaOfOfferCondition: { type: String, default: "" },
-    fraudCheckAreaOfConcern: { type: String, default: "" },
-    fraudCheckStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    incomeSourceDescription: { type: String, default: "" },
-    incomeSourceAreaOfOfferCondition: { type: String, default: "" },
-    incomeSourceAreaOfConcern: { type: String, default: "" },
-    incomeSourceStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    loanDescription: { type: String, default: "" },
-    loanAreaOfOfferCondition: { type: String, default: "" },
-    loanAreaOfConcern: { type: String, default: "" },
-    loanStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    securityDescription: { type: String, default: "" },
-    securityAreaOfOfferCondition: { type: String, default: "" },
-    securityAreaOfConcern: { type: String, default: "" },
-    securityStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    propertyDescription: { type: String, default: "" },
-    propertyAreaOfOfferCondition: { type: String, default: "" },
-    propertyAreaOfConcern: { type: String, default: "" },
-    propertyStatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-});
-const ApplicationRationaleModel = mongoose.model("ApplicationRationale", rationaleSchema);
-export default ApplicationRationaleModel;

package/dist/applications/application-risk-narrative.model.js

@@ -1,12 +0,0 @@
-import mongoose from 'mongoose';
-const applicantionRiskNarrativeSchema = new mongoose.Schema({
-    call1RequestedOn: { type: String },
-    call2RequestedOn: { type: String },
-    call2StatusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-    rationaleForRiskRating: { type: String },
-    retryCount: { type: String },
-    riskRating: { type: String },
-    statusLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", default: null },
-});
-const ApplicationRiskNarrativeModel = mongoose.model('ApplicationRiskNarrative', applicantionRiskNarrativeSchema);
-export default ApplicationRiskNarrativeModel;

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

@@ -1,15 +0,0 @@
-import mongoose from "mongoose";
-const valuationSchema = new mongoose.Schema({
-    amount: { type: String },
-    epcRating: { type: String, default: "" },
-    epcScore: { type: String },
-    estimatedRentalValue: { type: String },
-    instructionId: { type: String, default: "" },
-    instructionStatus: { type: String, default: "" },
-    instructionStatusComment: { type: String, default: "" },
-    isManual: { type: String, default: false },
-    squareMetres: { type: String },
-    valuerNotes: { type: String, default: "" },
-    version: { type: String, default: "" }
-});
-export default valuationSchema;