@dynamatix/gb-schemas 2.3.253 → 2.3.255

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

@@ -1,401 +1,471 @@
 import mongoose from "mongoose";
 import { applyWorkflowPlugin } from "../shared/workflow.plugin";
 const propertyTypeSchema = new mongoose.Schema({
-    detachedHouse: {
-        type: String,
-        default: ""
+    isDetachedHouse: {
+        type: Boolean,
+        default: null
     },
-    semiDetachedHouse: {
-        type: String,
-        default: ""
+    isSemiDetachedHouse: {
+        type: Boolean,
+        default: null
     },
-    terracedHouse: {
-        type: String,
-        default: ""
+    isTerracedHouse: {
+        type: Boolean,
+        default: null
     },
-    bungalow: {
-        type: String,
-        default: ""
+    isBungalow: {
+        type: Boolean,
+        default: null
     },
-    flat: {
-        type: String,
-        default: ""
+    isFlat: {
+        type: Boolean,
+        default: null
     },
-    maisonette: {
-        type: String,
-        default: ""
+    isMaisonette: {
+        type: Boolean,
+        default: null
     },
     flatMaisonetteFloor: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     numberOfFloorsInBlock: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    builtOrOwnedByLocalAuthority: {
-        type: String,
-        default: ""
+    isBuiltOrOwnedByLocalAuthority: {
+        type: Boolean,
+        default: null
     },
     ownerOccupationPercentage: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     isFlatMaisonetteConverted: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     conversionYear: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     isPurposeBuilt: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     numberOfUnitsInBlock: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    aboveCommercial: {
-        type: String,
-        default: ""
+    isAboveCommercial: {
+        type: Boolean,
+        default: null
     },
     residentialNatureImpact: {
         type: String,
-        default: ""
+        default: null
     },
     tenure: {
         type: String,
-        default: ""
+        default: null
     },
-    flyingFreehold: {
-        type: String,
-        default: ""
+    isFlyingFreehold: {
+        type: Boolean,
+        default: null
     },
     flyingFreeholdPercentage: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     maintenanceCharge: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     roadCharges: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     groundRent: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     remainingLeaseTermYears: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    partCommercialUse: {
-        type: String,
-        default: ""
+    isPartCommercialUse: {
+        type: Boolean,
+        default: null
     },
     commercialUsePercentage: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    purchasedUnderSharedOwnership: {
-        type: String,
-        default: ""
+    isPurchasedUnderSharedOwnership: {
+        type: Boolean,
+        default: null
     },
     yearBuilt: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     }
 });
 const accommodationSchema = new mongoose.Schema({
     hall: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     livingRooms: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     kitchen: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    lift: {
-        type: String,
-        default: ""
+    isLiftPresent: {
+        type: Boolean,
+        default: null
     },
     utility: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     bedrooms: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     bathrooms: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     separateWc: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     basement: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     garage: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     parking: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     gardens: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
-    privateOrCommunal: {
-        type: String,
-        default: ""
+    isPrivate: {
+        type: Boolean,
+        default: null
+    },
+    isCommunal: {
+        type: Boolean,
+        default: null
     },
     numberOfOutbuildings: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     outbuildingDetails: {
         type: String,
-        default: ""
+        default: null
     },
     grossFloorAreaOfDwelling: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     }
 });
 const newBuildSchema = new mongoose.Schema({
     isNewBuildOrRecentlyConverted: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
-    newBuildStatus: {
-        type: String,
-        default: ""
+    isCompleted: {
+        type: Boolean,
+        default: null
+    },
+    isUnderConstruction: {
+        type: Boolean,
+        default: null
     },
     isFinalInspectionRequired: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
-    hasNhbcCert: {
-        type: String,
-        default: ""
+    isNhbcCert: {
+        type: Boolean,
+        default: null
     },
-    hasBuildZone: {
-        type: String,
-        default: ""
+    isBuildZone: {
+        type: Boolean,
+        default: null
     },
-    hasPremier: {
-        type: String,
-        default: ""
+    isPremier: {
+        type: Boolean,
+        default: null
     },
-    hasProfessionalConsultant: {
-        type: String,
-        default: ""
+    isProfessionalConsultant: {
+        type: Boolean,
+        default: null
+    },
+    isOtherCert: {
+        type: Boolean,
+        default: null
     },
     otherCertDetails: {
         type: String,
-        default: ""
+        default: null
     },
     isSelfBuildProject: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
-    involvesPartExchange: {
-        type: String,
-        default: ""
+    isInvolvesPartExchange: {
+        type: Boolean,
+        default: null
     },
-    disclosureOfIncentivesSeen: {
-        type: String,
-        default: ""
+    isDisclosureOfIncentivesSeen: {
+        type: Boolean,
+        default: null
     },
     incentivesDetails: {
         type: String,
-        default: ""
+        default: null
     },
     newBuildDeveloperName: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const currentOccupencySchema = new mongoose.Schema({
-    everOccupied: {
-        type: String,
-        default: ""
+    isEverOccupied: {
+        type: Boolean,
+        default: null
     },
     numberOfAdultsInProperty: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     isHmoOrMultiUnitFreeholdBlock: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     isCurrentlyTenanted: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     hmoOrMultiUnitDetails: {
         type: String,
-        default: ""
+        default: null
     },
 });
 const constructionSchema = new mongoose.Schema({
     isStandardConstruction: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     nonStandardConstructionType: {
         type: String,
-        default: ""
+        default: null
     },
     mainWalls: {
         type: String,
-        default: ""
+        default: null
     },
     mainRoof: {
         type: String,
-        default: ""
+        default: null
     },
     garageConstruction: {
         type: String,
-        default: ""
+        default: null
     },
     outbuildingsConstruction: {
         type: String,
-        default: ""
+        default: null
     },
-    hasAlterationsOrExtensions: {
-        type: String,
-        default: ""
+    isHasAlterationsOrExtensions: {
+        type: Boolean,
+        default: null
     },
-    alterationsRequireConsents: {
-        type: String,
-        default: ""
+    isAlterationsRequireConsents: {
+        type: Boolean,
+        default: null
     },
     alterationsAge: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     }
 });
 const localityAndDemandSchema = new mongoose.Schema({
-    locationType: {
-        type: String,
-        default: ""
-    },
-    marketAppeal: {
-        type: String,
-        default: ""
-    },
-    surroundingProperties: {
-        type: String,
-        default: ""
-    },
-    propertyPricesTrend: {
-        type: String,
-        default: ""
-    },
-    demandTrend: {
-        type: String,
-        default: ""
-    },
-    affectedByCompulsoryPurchase: {
-        type: String,
-        default: ""
+    // Location Type - Boolean fields
+    isUrban: {
+        type: Boolean,
+        default: null
+    },
+    isSuburban: {
+        type: Boolean,
+        default: null
+    },
+    isRural: {
+        type: Boolean,
+        default: null
+    },
+    // Market Appeal - Boolean fields
+    isGoodMarketAppeal: {
+        type: Boolean,
+        default: null
+    },
+    isAverageMarketAppeal: {
+        type: Boolean,
+        default: null
+    },
+    isPoorMarketAppeal: {
+        type: Boolean,
+        default: null
+    },
+    // Surrounding Properties - Boolean fields
+    isSimilarProperties: {
+        type: Boolean,
+        default: null
+    },
+    isBetterProperties: {
+        type: Boolean,
+        default: null
+    },
+    isWorseProperties: {
+        type: Boolean,
+        default: null
+    },
+    // Property Prices Trend - Boolean fields
+    isPricesRising: {
+        type: Boolean,
+        default: null
+    },
+    isPricesStatic: {
+        type: Boolean,
+        default: null
+    },
+    isPricesFalling: {
+        type: Boolean,
+        default: null
+    },
+    // Demand Trend - Boolean fields
+    isDemandRising: {
+        type: Boolean,
+        default: null
+    },
+    isDemandStatic: {
+        type: Boolean,
+        default: null
+    },
+    isDemandFalling: {
+        type: Boolean,
+        default: null
+    },
+    isAffectedByCompulsoryPurchase: {
+        type: Boolean,
+        default: null
     },
     compulsoryPurchaseDetails: {
         type: String,
-        default: ""
+        default: null
     },
-    vacantOrBoardedPropertiesNearby: {
-        type: String,
-        default: ""
+    isVacantOrBoardedPropertiesNearby: {
+        type: Boolean,
+        default: null
     },
     vacantOrBoardedDetails: {
         type: String,
-        default: ""
+        default: null
     },
-    occupancyRestrictionPossible: {
-        type: String,
-        default: ""
+    isOccupancyRestrictionPossible: {
+        type: Boolean,
+        default: null
     },
     occupancyRestrictionDetails: {
         type: String,
-        default: ""
+        default: null
     },
-    closeToHighVoltageEquipment: {
-        type: String,
-        default: ""
+    isCloseToHighVoltageEquipment: {
+        type: Boolean,
+        default: null
     },
     highVoltageEquipmentDetails: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const servicesSchema = new mongoose.Schema({
-    waterSupply: {
-        type: String,
-        default: ""
-    },
-    gasSupply: {
-        type: String,
-        default: ""
-    },
-    electricitySupply: {
-        type: String,
-        default: ""
-    },
-    centralHeating: {
-        type: String,
-        default: ""
+    // Water Supply - Boolean fields
+    isMainsWater: {
+        type: Boolean,
+        default: null
+    },
+    isPrivateWater: {
+        type: Boolean,
+        default: null
+    },
+    isUnknownWater: {
+        type: Boolean,
+        default: null
+    },
+    // Gas Supply - Boolean
+    isGasSupply: {
+        type: Boolean,
+        default: null
+    },
+    // Electricity Supply - Boolean
+    isElectricitySupply: {
+        type: Boolean,
+        default: null
+    },
+    // Central Heating - Boolean
+    isCentralHeating: {
+        type: Boolean,
+        default: null
     },
     centralHeatingType: {
         type: String,
-        default: ""
+        default: null
     },
-    mainDrainage: {
-        type: String,
-        default: ""
+    // Main Drainage - Boolean
+    isMainDrainage: {
+        type: Boolean,
+        default: null
     },
-    septicTankPlant: {
-        type: String,
-        default: ""
+    // Septic Tank/Cesspit/Treatment Plant - Boolean
+    isSepticTankPlant: {
+        type: Boolean,
+        default: null
     },
-    unknown: {
-        type: String,
-        default: ""
+    // Solar Panels - Boolean
+    isSolarPanels: {
+        type: Boolean,
+        default: null
     },
-    solarPanels: {
-        type: String,
-        default: ""
+    // Shared Access - Boolean
+    isSharedAccess: {
+        type: Boolean,
+        default: null
     },
-    sharedAccess: {
-        type: String,
-        default: ""
+    // Road Adopted - Boolean
+    isRoadAdopted: {
+        type: Boolean,
+        default: null
     },
-    roadAdopted: {
-        type: String,
-        default: ""
-    },
-    hasEasementsOrRightsOfWay: {
-        type: String,
-        default: ""
+    isHasEasementsOrRightsOfWay: {
+        type: Boolean,
+        default: null
     },
     easementsOrRightsDetails: {
         type: String,
-        default: ""
+        default: null
     },
     servicesSeparateForFlats: {
         type: String,
@@ -409,277 +479,277 @@ const servicesSchema = new mongoose.Schema({
 const energyEfficiencySchema = new mongoose.Schema({
     epcRating: {
         type: String,
-        default: ""
+        default: null
     },
     epcScore: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     }
 });
 const essentialRepairsSchema = new mongoose.Schema({
-    essentialRepairsRequired: {
-        type: String,
-        default: ""
+    isEssentialRepairsRequired: {
+        type: Boolean,
+        default: null
     },
     essentialRepairsDetails: {
         type: String,
-        default: ""
+        default: null
     },
-    reinspectionRequired: {
-        type: String,
-        default: ""
+    isReinspectionRequired: {
+        type: Boolean,
+        default: null
     }
 });
 const reportsSchema = new mongoose.Schema({
-    timberDamp: {
-        type: String,
-        default: ""
+    isTimberDamp: {
+        type: Boolean,
+        default: null
     },
-    mining: {
-        type: String,
-        default: ""
+    isMining: {
+        type: Boolean,
+        default: null
     },
-    electrical: {
-        type: String,
-        default: ""
+    isElectrical: {
+        type: Boolean,
+        default: null
     },
-    drains: {
-        type: String,
-        default: ""
+    isDrains: {
+        type: Boolean,
+        default: null
     },
-    structuralEngineers: {
-        type: String,
-        default: ""
+    isStructuralEngineers: {
+        type: Boolean,
+        default: null
     },
-    arboricultural: {
-        type: String,
-        default: ""
+    isArboricultural: {
+        type: Boolean,
+        default: null
     },
-    mundic: {
-        type: String,
-        default: ""
+    isMundic: {
+        type: Boolean,
+        default: null
     },
-    wallTies: {
-        type: String,
-        default: ""
+    isWallTies: {
+        type: Boolean,
+        default: null
     },
-    roof: {
-        type: String,
-        default: ""
+    isRoof: {
+        type: Boolean,
+        default: null
     },
-    metalliferous: {
-        type: String,
-        default: ""
+    isMetalliferous: {
+        type: Boolean,
+        default: null
     },
-    sulfateRedAsh: {
-        type: String,
-        default: ""
+    isSulfateRedAsh: {
+        type: Boolean,
+        default: null
     },
-    other: {
-        type: String,
-        default: ""
+    isOtherReport: {
+        type: Boolean,
+        default: null
     },
     otherReportDetails: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const propertyProneToSchema = new mongoose.Schema({
     flooding: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     subsidence: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     heave: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     landslip: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     details: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const conditionsOfPropertySchema = new mongoose.Schema({
-    structuralMovement: {
-        type: String,
-        default: ""
+    isStructuralMovement: {
+        type: Boolean,
+        default: null
     },
-    structuralMovementHistoricOrNonProgressive: {
-        type: String,
-        default: ""
+    isStructuralMovementHistoricOrNonProgressive: {
+        type: Boolean,
+        default: null
     },
     structuralMovementDetails: {
         type: String,
         default: ""
     },
-    structuralModifications: {
-        type: String,
-        default: ""
+    isStructuralModifications: {
+        type: Boolean,
+        default: null
     },
     structuralModificationsDetails: {
         type: String,
-        default: ""
+        default: null
     },
     communalAreasMaintained: {
         type: String,
-        default: ""
+        default: null
     },
     propertyProneTo: [propertyProneToSchema],
-    plotBoundariesDefinedUnderPointFourHectares: {
-        type: String,
-        default: ""
+    isPlotBoundariesDefinedUnderPointFourHectares: {
+        type: Boolean,
+        default: null
     },
-    treesWithinInfluencingDistance: {
-        type: String,
-        default: ""
+    isTreesWithinInfluencingDistance: {
+        type: Boolean,
+        default: null
     },
     treesInfluenceDetails: {
         type: String,
-        default: ""
+        default: null
     },
-    builtOnSteepSlope: {
-        type: String,
-        default: ""
+    isBuiltOnSteepSlope: {
+        type: Boolean,
+        default: null
     },
     steepSlopeDetails: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const rentalInformationSchema = new mongoose.Schema({
-    rentalDemandInLocality: {
-        type: String,
-        default: ""
+    isRentalDemandInLocality: {
+        type: Boolean,
+        default: null
     },
     rentalDemandDetails: {
         type: String,
-        default: ""
+        default: null
     },
     monthlyMarketRentPresentCondition: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     monthlyMarketRentImprovedCondition: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    otherLettingDemandFactors: {
-        type: String,
-        default: ""
+    isOtherLettingDemandFactors: {
+        type: Boolean,
+        default: null
     },
     otherLettingDemandDetails: {
         type: String,
-        default: ""
+        default: null
     },
     investorOnlyDemand: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     investorOnlyDemandDetails: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const valuationForFinancePurposeSchema = new mongoose.Schema({
     valuationComparativeOnly: {
         type: String,
-        default: ""
+        default: null
     },
-    suitableForFinance: {
-        type: String,
-        default: ""
+    isSuitableForFinance: {
+        type: Boolean,
+        default: null
     },
     financeSuitabilityDetails: {
         type: String,
         default: ""
     },
     marketValuePresentCondition: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     marketValueAfterRepairs: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     purchasePriceOrBorrowerEstimate: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     buildingInsuranceReinstatementCost: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
-    insurancePremiumLoadingRisk: {
-        type: String,
-        default: ""
+    isInsurancePremiumLoadingRisk: {
+        type: Boolean,
+        default: null
     },
     insurancePremiumLoadingDetails: {
         type: String,
-        default: ""
+        default: null
     }
 });
 const valuerQualificationsSchema = new mongoose.Schema({
     mrics: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     frics: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     },
     assocRics: {
-        type: String,
-        default: ""
+        type: Boolean,
+        default: null
     }
 });
 const valuersDeclarationSchema = new mongoose.Schema({
     valuerSignature: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     valuerName: {
         type: String,
-        default: ""
+        default: null
     },
     onBehalfOf: {
         type: String,
-        default: ""
+        default: null
     },
     telephone: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     fax: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     email: {
         type: String,
-        default: ""
+        default: null
     },
     valuerQualifications: [valuerQualificationsSchema],
     ricsNumber: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     },
     valuerAddress: {
         type: String,
-        default: ""
+        default: null
     },
     valuerPostcode: {
         type: String,
-        default: ""
+        default: null
     },
     reportDate: {
-        type: String,
-        default: ""
+        type: Number,
+        default: null
     }
 });
 const valuationReportSchema = new mongoose.Schema({