@pdtf/schemas 0.9.4 → 0.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "0.9.4",
+  "version": "0.10.1",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/examples/exampleTransaction.json

@@ -30,7 +30,21 @@
         "hasDelayFactors": { "yesNo": "No" }
       },
       "ownership": {
-        "ownershipType": "Freehold"
+        "ownershipType": "Leasehold",
+        "startYearOfLease": 1900,
+        "lengthOfLeaseInYears": 999,
+        "currentGroundRent": 1750,
+        "rentIncrease": { "yesNo": "No" },
+        "annualServiceCharge": 250.23,
+        "largeAdditionalExpense": { "yesNo": "No" },
+        "additionalFeesOnSale": 0,
+        "freeholderContactDetails": {
+          "nameOrOrganisation": "Fleesum Properties"
+        },
+        "managingAgentContactDetails": {
+          "nameOrOrganisation": "Pricee Living"
+        },
+        "managementCompanyDirectorRequirement": { "yesNo": "No" }
       },
       "parking": {
         "parkingArrangements": {
@@ -55,7 +69,7 @@
         "isStandardForm": {
           "yesNo": "Yes"
         },
-        "hasFlammableExternalWallSystem": "No"
+        "hasFlammableExternalWallSystem": { "yesNo": "No" }
       },
       "energyEfficiency": {
         "energyEfficiencyRating": "A",
@@ -216,6 +230,7 @@
           "cesspit": { "yesNo": "No" },
           "sewerageTreatmentPlant": { "yesNo": "No" },
           "otherConnectedProperties": { "yesNo": "No" },
+          "yearSystemInstalled": 1980,
           "plantOnOtherLand": { "yesNo": "No" },
           "plantRegistered": { "yesNo": "No" },
           "plantDrainsIntoWaterway": {
@@ -348,7 +363,36 @@
         }
       },
       "otherIssues": {
-        "environmental": {
+        "flooding": {
+          "floodRiskReport": { "yesNo": "No" },
+          "hasBeenFlooded": "Yes",
+          "details": "Minor basement flood",
+          "typeOfFlooding": {
+            "groundWater": {
+              "yesNo": "No"
+            },
+            "sewer": {
+              "yesNo": "Yes"
+            },
+            "surfaceWater": {
+              "yesNo": "No"
+            },
+            "coastal": {
+              "yesNo": "No"
+            },
+            "river": {
+              "yesNo": "No"
+            },
+            "other": {
+              "yesNo": "No"
+            }
+          }
+        },
+        "radon": {
+          "radonTest": { "yesNo": "No" },
+          "remedialMeasuresOnConstruction": { "yesNo": "No" }
+        },
+        "otherEnvironmental": {
           "yesNo": "No"
         },
         "excessiveNoise": {
@@ -392,7 +436,6 @@
         "areBoundariesUniform": { "yesNo": "Yes" },
         "haveBoundaryFeaturesMoved": { "yesNo": "No" },
         "adjacentLandIncluded": { "yesNo": "No" },
-        "titlePlanAccurate": { "yesNo": "Yes" },
         "flyingFreehold": { "yesNo": "No" }
       },
       "servicesCrossing": {
@@ -411,12 +454,14 @@
       },
       "occupiers": {
         "sellerLivesAtProperty": { "yesNo": "Yes" },
-        "otherOver17sAtProperty": {
-          "hasOver17s": "Yes",
-          "over17sNames": [
-            { "firstName": "Freya", "lastName": "Jones", "age": 21 }
-          ],
-          "over17sTenantsOrLodgers": { "yesNo": "No" },
+        "hasOthersAged17OrOver": "Yes",
+        "aged17OrOverNames": [
+          { "firstName": "Freya", "lastName": "Jones", "age": 21 }
+        ],
+        "aged17OrOverTenantsOrLodgers": { "yesNo": "No" },
+        "vacantPossession": {
+          "soldWithVacantPosesssion": "Yes",
+          "aged17OrOverAgreedToLeave": { "yesNo": "Yes" },
           "over17sWillSignToConfirmWillVacate": { "yesNo": "Yes" }
         }
       },

package/src/schemas/v1/legal-information.json

@@ -117,7 +117,6 @@
         "areBoundariesUniform",
         "haveBoundaryFeaturesMoved",
         "adjacentLandIncluded",
-        "titlePlanAccurate",
         "flyingFreehold"
       ],
       "properties": {
@@ -175,12 +174,6 @@
           "title": "Has any adjacent land or property been purchased by you that will be included in the sale?",
           "$ref": "#/$defs/yesNoDetailIfYes"
         },
-        "titlePlanAccurate": {
-          "baspiRef": "B2.4",
-          "RDSRef": "Tenure/BoundaryDifferences,Tenure/CadastralMapOfParcels",
-          "title": "Does the title plan for the property accurately show the extent of the land and property which you are selling?",
-          "$ref": "#/$defs/yesNoDetailIfNo"
-        },
         "flyingFreehold": {
           "baspiRef": "B2.5",
           "RDSRef": "Tenure/tenure=?",
@@ -581,7 +574,7 @@
       "lawSocietyRef": "TA6/11",
       "title": "Occupiers",
       "type": "object",
-      "required": ["sellerLivesAtProperty", "otherOver17sAtProperty"],
+      "required": ["sellerLivesAtProperty", "hasOthersAged17OrOver"],
       "properties": {
         "sellerLivesAtProperty": {
           "baspiRef": "B6.1",
@@ -590,90 +583,128 @@
           "title": "Does the seller live at the property?",
           "$ref": "#/$defs/yesNo"
         },
-        "otherOver17sAtProperty": {
+        "hasOthersAged17OrOver": {
           "baspiRef": "B6.2",
           "RDSRef": "Participants",
           "lawSocietyRef": "TA6/11.2",
           "title": "Does anyone else, aged 17 or over, live at the property?",
-          "type": "object",
-          "properties": {
-            "hasOver17s": {
-              "type": "string",
-              "title": "",
-              "enum": ["Yes", "No"]
-            }
-          },
-          "required": ["hasOver17s"],
-          "dependencies": {
-            "hasOver17s": {
-              "oneOf": [
-                {
+          "type": "string",
+          "enum": ["Yes", "No"]
+        }
+      },
+      "dependencies": {
+        "hasOthersAged17OrOver": {
+          "oneOf": [
+            {
+              "properties": {
+                "hasOthersAged17OrOver": {
+                  "enum": ["No"]
+                }
+              },
+              "additionalProperties": false
+            },
+            {
+              "properties": {
+                "hasOthersAged17OrOver": {
+                  "enum": ["Yes"]
+                },
+                "aged17OrOverNames": {
+                  "lawSocietyRef": "TA6/11.3",
+                  "title": "Please specify their full names and ages.",
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "firstName": {
+                        "title": "First Name",
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "middleNames": {
+                        "title": "Middle name(s) if any",
+                        "type": "string"
+                      },
+                      "lastName": {
+                        "title": "Last Name",
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "age": {
+                        "title": "Age",
+                        "type": "integer"
+                      }
+                    },
+                    "required": ["firstName", "lastName", "age"]
+                  }
+                },
+                "aged17OrOverTenantsOrLodgers": {
+                  "baspiRef": "B6.1",
+                  "RDSRef": "Property/Flags",
+                  "lawSocietyRef": "TA6/11.4",
+                  "title": "Are any of them tenants or lodgers?",
+                  "$ref": "#/$defs/yesNo"
+                },
+                "vacantPossesssion": {
+                  "lawSocietyRef": "TA6/11.5",
+                  "type": "object",
+                  "required": ["soldWithVacantPossession"],
                   "properties": {
-                    "hasOver17s": {
-                      "enum": ["No"]
+                    "soldWithVacantPosesssion": {
+                      "type": "string",
+                      "title": "Is the property being sold with vacant possession?",
+                      "enum": ["Yes", "No"]
                     }
                   },
-                  "additionalProperties": false
-                },
-                {
-                  "properties": {
-                    "hasOver17s": {
-                      "enum": ["Yes"]
-                    },
-                    "over17sNames": {
-                      "lawSocietyRef": "TA6/11.3",
-                      "title": "Please specify their full names and ages.",
-                      "type": "array",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "firstName": {
-                            "title": "First Name",
-                            "type": "string",
-                            "minLength": 1
-                          },
-                          "middleNames": {
-                            "title": "Middle name(s) if any",
-                            "type": "string"
+                  "dependencies": {
+                    "soldWithVacantPossession": {
+                      "oneOf": [
+                        {
+                          "properties": {
+                            "soldWithVacantPossesssion": {
+                              "enum": ["No"]
+                            }
                           },
-                          "lastName": {
-                            "title": "Last Name",
-                            "type": "string",
-                            "minLength": 1
-                          },
-                          "age": {
-                            "title": "Age",
-                            "type": "integer"
-                          }
+                          "additionalProperties": false
                         },
-                        "required": ["firstName", "lastName", "age"]
-                      }
-                    },
-                    "over17sTenantsOrLodgers": {
-                      "baspiRef": "B6.1",
-                      "RDSRef": "Property/Flags",
-                      "lawSocietyRef": "TA6/11.4",
-                      "title": "Are any of them tenants or lodgers?",
-                      "$ref": "#/$defs/yesNo"
-                    },
-                    "over17sWillSignToConfirmWillVacate": {
-                      "baspiRef": "B6.4",
-                      "RDSRef": "RightsHolders,TenureAgreements,Notifications",
-                      "lawSocietyRef": "TA6/11.5",
-                      "title": "Have all occupiers aged over 17, agreed to sign the contract to confirm that they will vacate the property prior to completion of the sale?",
-                      "$ref": "#/$defs/yesNoDetailIfNo",
-                      "description": "If 'No', please provide details (e.g. the property is sold let to tenants) and supply a copy of the tenancy agreement together with a copy of any notice to quit which has been served upon them."
+                        {
+                          "properties": {
+                            "soldWithVacantPosesssion": {
+                              "enum": ["Yes"]
+                            },
+                            "aged17OrOverAgreedToLeave": {
+                              "baspiRef": "B6.4",
+                              "RDSRef": "RightsHolders,TenureAgreements,Notifications",
+                              "lawSocietyRef": "TA6/11.5a",
+                              "title": "Have all occupiers aged 17 or over agreed to leave prior to completion?",
+                              "$ref": "#/$defs/yesNo"
+                            },
+                            "aged17OrOverWillSignToConfirmWillVacate": {
+                              "baspiRef": "B6.4",
+                              "RDSRef": "RightsHolders,TenureAgreements,Notifications",
+                              "lawSocietyRef": "TA6/11.5b",
+                              "title": "Have all occupiers aged 17 or over, agreed to sign the sale contract?",
+                              "$ref": "#/$defs/yesNoDetailIfNo",
+                              "description": "If 'No', please supply other evidence that the property will be vacant on completion."
+                            }
+                          },
+                          "required": [
+                            "aged17OrOverAgreedToLeave",
+                            "aged17OrOverWillSignToConfirmWillVacate"
+                          ]
+                        }
+                      ]
                     }
-                  },
-                  "required": [
-                    "over17sNames",
-                    "over17sTenantsOrLodgers",
-                    "over17sWillSignToConfirmWillVacate"
-                  ]
+                  }
                 }
+              },
+              "required": [
+                "aged17OrOverNames",
+                "aged17OrOverTenantsOrLodgers",
+                "vacantPossession"
               ]
             }
-          }
+          ]
         }
       }
     },

package/src/schemas/v1/material-facts.json

@@ -602,12 +602,8 @@
           "baspiRef": "A2.1",
           "RDSRef": "Tenure/DisputesComplaints,Tenure/LegalClaims",
           "title": "Does the property have potentially flammable external wall system - including cladding and balconies etc?",
-          "type": "string",
-          "enum": [
-            "Yes (EWS form attached)",
-            "Yes (No external wall system review to hand)",
-            "No"
-          ]
+          "$ref": "#/$defs/yesNoDetailIfYes",
+          "description": "If yes, please give details and attach an EWS form or state if none is to hand"
         }
       }
     },
@@ -1055,6 +1051,12 @@
                       "$ref": "#/$defs/yesNoDetailIfYes",
                       "description": "If yes, provide details of the properties sharing the system and explain how maintenance of the system is arranged and paid for."
                     },
+                    "yearSystemInstalled": {
+                      "lawSocietyRef": "TA6/12.9",
+                      "title": "What year was the system installed?",
+                      "type": "integer",
+                      "minimum": 1000
+                    },
                     "plantOnOtherLand": {
                       "baspiRef": "A7.2.6",
                       "RDSRef": "Services/OtherServices/Located,Services/OtherServices/{access=?}",
@@ -1129,6 +1131,7 @@
                     "cesspit",
                     "sewerageTreatmentPlant",
                     "otherConnectedProperties",
+                    "yearSystemInstalled",
                     "plantOnOtherLand",
                     "plantRegistered",
                     "plantDrainsIntoWaterway"
@@ -1450,7 +1453,7 @@
                   "baspiRef": "A8.2",
                   "RDSRef": "Insurance/Flags,Insurance/refusalReason=?",
                   "lawSocietyRef": "TA6/6.4",
-                  "title": "Have you had any difficulty obtaining competitively priced building insurance due to the structure or location of the property or had insurance refused (e.g. high premiums, excess over £1,500, special conditions etc )",
+                  "title": "Have you had any difficulty obtaining competitively priced building insurance due to the structure or location of the property or had insurance refused (e.g. high premiums, excess over £1,500, special conditions etc)",
                   "$ref": "#/$defs/yesNoDetailIfYes"
                 },
                 "insuranceClaims": {
@@ -1609,20 +1612,142 @@
       "title": "Other Issues Affecting the Property",
       "type": "object",
       "required": [
-        "environmental",
+        "flooding",
+        "radon",
+        "otherEnvironmental",
         "excessiveNoise",
         "crime",
         "cautionOrConviction",
         "failedTransactionsInLast12Months"
       ],
       "properties": {
-        "environmental": {
+        "flooding": {
+          "baspiRef": "A11.1",
+          "RDSRef": "Sustainability/Environmental|Natural|Situational",
+          "lawSocietyRef": "TA6/7.1",
+          "title": "Flooding",
+          "type": "object",
+          "required": ["floodRiskReport", "hasBeenFlooded"],
+          "properties": {
+            "floodRiskReport": {
+              "baspiRef": "A11.1",
+              "RDSRef": "Sustainability/Environmental|Natural|Situational",
+              "lawSocietyRef": "TA6/7.3",
+              "title": "Has a Flood Risk Report been prepared?",
+              "$ref": "#/$defs/yesNoDetailIfYes",
+              "description": "If yes, please supply a copy."
+            },
+            "hasBeenFlooded": {
+              "title": "Has any part of the property (whether buildings or surrounding garden or land) ever been flooded?",
+              "description": "If yes, please state when the flooding occurred and identify the parts that flooded",
+              "lawSocietyRef": "TA6/7.2",
+              "type": "string",
+              "enum": ["Yes", "No"]
+            }
+          },
+          "dependencies": {
+            "hasBeenFlooded": {
+              "oneOf": [
+                {
+                  "properties": {
+                    "hasBeenFlooded": {
+                      "enum": ["No"]
+                    },
+                    "additionalProperties": false
+                  }
+                },
+                {
+                  "properties": {
+                    "hasBeenFlooded": {
+                      "enum": ["Yes"]
+                    },
+                    "details": {
+                      "lawSocietyRef": "TA6/7.1",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "typeOfFlooding": {
+                      "baspiRef": "A11.1",
+                      "RDSRef": "Sustainability/Environmental|Natural|Situational",
+                      "lawSocietyRef": "TA6/7.2",
+                      "title": "What type of flooding occurred?",
+                      "type": "object",
+                      "properties": {
+                        "groundWater": {
+                          "lawSocietyRef": "TA6/7.2a",
+                          "title": "Ground water",
+                          "$ref": "#/$defs/yesNo"
+                        },
+                        "sewer": {
+                          "lawSocietyRef": "TA6/7.2b",
+                          "title": "Sewer",
+                          "$ref": "#/$defs/yesNo"
+                        },
+                        "surfaceWater": {
+                          "lawSocietyRef": "TA6/7.2c",
+                          "title": "Surface water",
+                          "$ref": "#/$defs/yesNo"
+                        },
+                        "coastal": {
+                          "lawSocietyRef": "TA6/7.2d",
+                          "title": "Coastal flooding",
+                          "$ref": "#/$defs/yesNo"
+                        },
+                        "river": {
+                          "lawSocietyRef": "TA6/7.2e",
+                          "title": "River flooding",
+                          "$ref": "#/$defs/yesNo"
+                        },
+                        "other": {
+                          "title": "Other",
+                          "$ref": "#/$defs/yesNoDetailIfYes",
+                          "description": "Please state"
+                        }
+                      },
+                      "required": [
+                        "groundWater",
+                        "sewer",
+                        "surfaceWater",
+                        "coastal",
+                        "river",
+                        "other"
+                      ]
+                    }
+                  },
+                  "required": ["typeOfFlooding", "details"]
+                }
+              ]
+            }
+          }
+        },
+        "radon": {
+          "baspiRef": "A11.1",
+          "RDSRef": "Sustainability/Environmental|Natural|Situational",
+          "lawSocietyRef": "TA6/7.4",
+          "title": "Radon",
+          "type": "object",
+          "required": ["remedialMeasuresOnConstruction", "radonTest"],
+          "properties": {
+            "radonTest": {
+              "lawSocietyRef": "TA6/7.4",
+              "title": "Has a Radon test been carried out on the property?",
+              "$ref": "#/$defs/yesNoDetailIfYes",
+              "description": "If yes, please supply a copy of the report and indicate if the test result was below the recommended level."
+            },
+            "remedialMeasuresOnConstruction": {
+              "RDSRef": "Sustainability/Environmental|Natural|Situational",
+              "lawSocietyRef": "TA6/7.5",
+              "title": "Were any remedial measures undertaken on construction to reduce Radon gas levels on the property?",
+              "$ref": "#/$defs/yesNo"
+            }
+          }
+        },
+        "otherEnvironmental": {
           "baspiRef": "A11.1",
           "RDSRef": "Sustainability/Environmental|Natural|Situational",
-          "lawSocietyRef": "TA6/7",
-          "title": "To your knowledge, has there been any environmental issues that affect the property or garden (for example, these could include air pollution, flooding, radon gas, mining, sink holes, quarrying or fracking etc)?",
+          "title": "To your knowledge, have there been any other environmental issues that affect the property or garden (for example, these could include air pollution, mining, sink holes, quarrying or fracking etc)?",
           "$ref": "#/$defs/yesNoDetailIfYes",
-          "description": "If yes, please provide details.  For example the level of air pollution, type of flooding (e.g. ground water, coastal, river, surface water, sewer, etc), level of radon, a copy of any radon report, location of fracking etc, and whether any action has been taken to prevent harm."
+          "description": "If yes, please provide details. For example the level of air pollution, location of fracking etc, and whether any action has been taken to prevent harm."
         },
         "excessiveNoise": {
           "baspiRef": "A11.2",
@@ -1989,13 +2114,8 @@
     "contactDetails": {
       "type": "object",
       "properties": {
-        "firstName": {
-          "title": "First name",
-          "type": "string",
-          "minLength": 1
-        },
-        "lastName": {
-          "title": "Last name",
+        "nameOrOrganisation": {
+          "title": "Name or organisation",
           "type": "string",
           "minLength": 1
         },
@@ -2006,33 +2126,12 @@
         },
         "address": {
           "title": "Address",
-          "type": "object",
-          "properties": {
-            "line1": {
-              "title": "Address 1",
-              "type": "string",
-              "minLength": 1
-            },
-            "line2": {
-              "title": "Address 2",
-              "type": "string"
-            },
-            "town": {
-              "title": "Town",
-              "type": "string"
-            },
-            "county": {
-              "title": "County",
-              "type": "string"
-            },
-            "postcode": {
-              "title": "Postcode",
-              "type": "string",
-              "minLength": 1
-            }
-          }
+
+          "type": "string",
+          "minLength": 1
         }
-      }
+      },
+      "required": ["nameOrOrganisation"]
     }
   }
 }

package/src/tests/transactionSchema.test.js

@@ -184,7 +184,7 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
   expect(
     getTitleAtPath(
       transactionSchema,
-      "/propertyPack/additionalLegalInfo/occupiers/otherOver17sAtProperty/over17sNames/0/firstName"
+      "/propertyPack/additionalLegalInfo/occupiers/aged17OrOverNames/0/firstName"
     )
   ).toBe("First Name");
 });