@dynamatix/gb-schemas 2.0.24 → 2.0.26

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

@@ -1,120 +0,0 @@
-import mongoose from "mongoose";
-import { Pound } from "./../value-objects/pound";
-const ApplicantShareholdingSchema = new mongoose.Schema({
-    applicantId: { type: mongoose.Schema.Types.ObjectId, ref: "Applicant", required: true, default: null },
-    applicantName: { type: String, default: "" },
-    directorShareholderLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
-    shareholding: { type: Number, min: 0, max: 100, default: null }
-}, { _id: false });
-const companySchema = new mongoose.Schema({
-    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true,
-        description: "Unique identifier for the application"
-    },
-    pageValidFlag: { type: Boolean, default: true, },
-    registeredName: { type: String, required: true, maxlength: 70, default: '' }, // form
-    businessTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }, // form
-    registeredNumber: { type: Number, max: 99999999, default: 0 }, // form
-    taxJurisdictionLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }, // form
-    tradingSince: { type: String, default: null }, // form
-    natureOfBusiness: { type: String, maxlength: 100, default: '' }, // form
-    yearEnd: { type: String, default: null }, // form
-    addressPostCode: { type: String, maxlength: 50, default: '' }, // form
-    addressLine1: { type: String, required: true, maxlength: 35, default: '' }, // form
-    addressLine2: { type: String, default: '', maxlength: 35 }, // form
-    addressLine3: { type: String, default: '', maxlength: 35 }, // form
-    addressCity: { type: String, default: '', maxlength: 30 }, // form
-    addressCountryLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }, // form
-    applicationTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup", required: true }, // form
-    applicantShareholding: [ApplicantShareholdingSchema], // form
-    yearEnd1: { type: Number, required: true, max: 9999 }, // form
-    turnoverYear1: { type: Pound, required: true, default: 0.00 }, // form
-    netProfitYear1: { type: Pound, required: true, default: 0.00 }, // form
-    yearEnd2: { type: Number, required: true, max: 9999 }, // form
-    turnoverYear2: { type: Pound, required: true, default: 0.00 }, // form
-    netProfitYear2: { type: Pound, required: true, default: 0.00 }, // form
-    yearEnd3: { type: Number, required: true, max: 9999 }, // form
-    turnoverYear3: { type: Pound, required: true, default: 0.00 }, // form
-    netProfitYear3: { type: Pound, required: true, default: 0.00 }, // form
-    // Purchase form - Company section
-    companyCreditDefaults: { type: String, required: true, default: '' }, // form
-    companyCountyCourtJudgment: { type: String, required: true, default: '' }, // form
-    companySecuredArrears: { type: String, required: true, default: '' }, // form
-    companyUnsecuredArrears: { type: String, required: true, default: '' }, // form
-    companyBankruptcy: { type: String, required: true, default: '' }, // form
-    companyBankruptcyYes: { type: Boolean, default: false, },
-    companyBankruptcyNo: { type: Boolean, default: true, },
-    companyCCJInLastThreeYearYes: { type: Boolean, default: false, },
-    companyCCJInLastThreeYearNo: { type: Boolean, default: true, },
-    companyDefaultsInLastYearYes: { type: Boolean, default: false, },
-    companyDefaultsInLastYearNo: { type: Boolean, default: true, },
-    companyAnyVoluntaryEnforcedPossessionYes: { type: Boolean, default: false, },
-    companyAnyVoluntaryEnforcedPossessionNo: { type: Boolean, default: true, },
-    // Not in form Fields
-    doYouKnowRegisteredNumber: { type: Boolean, default: true, },
-    sicCodes: [{ type: String, default: "" }],
-    epc: { type: String, default: "" },
-    remainingLease: { type: String, default: "" },
-    dateOfIncorporation: { type: String, default: null },
-}, {
-    timestamps: true,
-    toJSON: { virtuals: true, getters: true },
-    toObject: { virtuals: true, getters: true }
-});
-///////////////// HOOKS //////////////////
-const yesNoPairs = [
-    ["companyBankruptcyYes", "companyBankruptcyNo"],
-    ["companyCCJInLastThreeYearYes", "companyCCJInLastThreeYearNo"],
-    ["companyDefaultsInLastYearYes", "companyDefaultsInLastYearNo"],
-    ["companyAnyVoluntaryEnforcedPossessionYes", "companyAnyVoluntaryEnforcedPossessionNo"],
-];
-function handleYesNoLogic(update) {
-    const $set = update?.$set ?? update; // Handles both direct update and $set syntax
-    yesNoPairs.forEach(([yesKey, noKey]) => {
-        if (yesKey in $set) {
-            $set[noKey] = !$set[yesKey]; // Set No field to opposite of Yes field
-        }
-        // Prevent direct updates to No fields
-        if (noKey in $set) {
-            delete $set[noKey];
-        }
-    });
-}
-// Apply to various update operations - handle both cases
-companySchema.pre("updateOne", function (next) {
-    handleYesNoLogic(this.getUpdate());
-    next();
-});
-const virtualBusinessType = companySchema.virtual('businessType', {
-    ref: 'Lookup',
-    localField: 'businessTypeLid',
-    foreignField: '_id',
-    justOne: true,
-    options: { select: 'label' }
-});
-virtualBusinessType.description = 'Populated lookup value for business type';
-const virtualTaxJurisdiction = companySchema.virtual('taxJurisdiction', {
-    ref: 'Lookup',
-    localField: 'taxJurisdictionLid',
-    foreignField: '_id',
-    justOne: true,
-    options: { select: 'label' }
-});
-virtualTaxJurisdiction.description = 'Populated lookup value for tax jurisdiction';
-const virtualAddressCountry = companySchema.virtual('addressCountry', {
-    ref: 'Lookup',
-    localField: 'addressCountryLid',
-    foreignField: '_id',
-    justOne: true,
-    options: { select: 'label' }
-});
-virtualAddressCountry.description = 'Populated lookup value for address country';
-const virtualApplicationType = companySchema.virtual('applicationType', {
-    ref: 'Lookup',
-    localField: 'applicationTypeLid',
-    foreignField: '_id',
-    justOne: true,
-    options: { select: 'label' }
-});
-virtualApplicationType.description = 'Populated lookup value for application type';
-const ApplicationCompanyModel = mongoose.model("ApplicationCompany", companySchema);
-export default ApplicationCompanyModel;

package/dist/applications/application-credit-profile.model.js

@@ -1,12 +0,0 @@
-import mongoose from "mongoose";
-const creditProfileSchema = new mongoose.Schema({
-    companyAnyVoluntaryEnforcedPossessionNo: { type: String, default: false },
-    companyAnyVoluntaryEnforcedPossessionYes: { type: String, default: "" },
-    companyBankruptcyNo: { type: String, default: false },
-    companyBankruptcyYes: { type: String, default: "" },
-    companyCCJInLastThreeYearNo: { type: String, default: false },
-    companyCCJInLastThreeYearYes: { type: String, default: "" },
-    companyDefaultsInLastYearNo: { type: String, default: false },
-    companyDefaultsInLastYearYes: { type: String, default: "" }
-});
-export default creditProfileSchema;

package/dist/applications/application-direct-debit.model.js

@@ -1,92 +0,0 @@
-import mongoose from 'mongoose';
-import { SortCode } from '../value-objects/sort-code';
-const applicationDirectDebitSchema = new mongoose.Schema({
-    applicationId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Application',
-        description: 'Reference to the application this direct debit belongs to',
-    },
-    accountNumber: {
-        type: Number,
-        isRequired: true,
-        maxLength: 8,
-        description: 'Bank account number of the applicant',
-    },
-    addressLine1: {
-        type: String,
-        description: 'First line of the applicant’s address'
-    },
-    addressLine2: {
-        type: String,
-        description: 'Second line of the applicant’s address'
-    },
-    applicantId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Applicant',
-        description: 'List of applicant IDs associated with this direct debit',
-    },
-    branch: {
-        type: String,
-        description: 'Branch name or code of the bank',
-        required: true
-    },
-    city: {
-        type: String,
-        description: 'City of the applicant’s address',
-    },
-    contactPostcode: {
-        type: String,
-        description: 'Postcode for correspondence',
-        requird: true
-    },
-    institution: {
-        type: String,
-        description: 'Name of the financial institution',
-        required: true,
-    },
-    isConfirmDeclaration: {
-        type: Boolean,
-        description: 'Whether the applicant has confirmed the declaration'
-    },
-    nameOfAccountHolder: {
-        type: String,
-        description: 'Full name of the bank account holder',
-        required: true,
-    },
-    selectedPaymentDayLid: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Lookup',
-        description: 'Lookup reference for selected payment day',
-    },
-    sortCode: {
-        type: SortCode,
-        description: 'UK bank sort code in XX-XX-XX format',
-        required: true,
-    },
-}, {
-    timestamps: true,
-    toJSON: { virtuals: true, getters: true },
-    toObject: { virtuals: true, getters: true }
-});
-const virtualselectedPaymentDay = applicationDirectDebitSchema.virtual('selectedPaymentDay', {
-    ref: 'Lookup',
-    localField: 'selectedPaymentDayLid',
-    foreignField: '_id',
-    justOne: true,
-    options: {
-        select: 'label' // Only fetch the 'label' field from the Lookup collection
-    }
-});
-virtualselectedPaymentDay.description = 'Populated lookup value for the selected payment day';
-const virtualApplicants = applicationDirectDebitSchema.virtual('applicants', {
-    ref: 'Applicant',
-    localField: 'applicantId',
-    foreignField: '_id',
-    justOne: true,
-    options: {
-        select: 'fullName'
-    }
-});
-virtualApplicants.description = 'Full Name of the applicant';
-const ApplicationDirectDebitModel = mongoose.model("Application_DirectDebit", applicationDirectDebitSchema);
-export default ApplicationDirectDebitModel;

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;