@pdtf/schemas 3.6.0-dev.17 → 3.6.0-dev.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.6.0-dev.17",
+  "version": "3.6.0-dev.18",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "files": [

package/src/schemas/v3/combined.json

@@ -1301,6 +1301,215 @@
           "ntslRequired": ["building"],
           "ntsl2Required": ["building"],
           "properties": {
+            "attributes": {
+              "title": "Sourced building attributes",
+              "description": "Objectively sourced physical attributes of the building that contains the property, as distinct from the dwelling itself. These sit alongside the seller-declared fields in buildInformation rather than within them: everything here is measured, surveyed or registered, and none of it is asked of the seller on a form. For a house the building and the dwelling are the same thing; for a flat or maisonette these attributes describe the whole block rather than the individual unit. Values here are measured, surveyed or registered rather than declared by the seller, so they are not mapped to any form overlay. The source and verification of each value is carried by the claim that supplies it, not by this schema.",
+              "type": "object",
+              "properties": {
+                "storeyCount": {
+                  "title": "Number of storeys in the building",
+                  "description": "The number of occupiable storeys at or above ground level in the building as a whole. Unlike the sibling building/numberOfFloors, which is only available for flats and maisonettes, this is populated for every property type and always counts the whole building.",
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "heightMetres": {
+                  "title": "Height of the building in metres",
+                  "description": "The height of the building measured on the basis used by the Building Safety Act, that is from ground level to the floor surface of the top occupied storey. Populate this only where a value on that basis is available, for example from the register of higher-risk buildings. Remotely sensed estimates belong in heightToRoofBaseMetres and heightToHighestPointMetres instead.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "heightToRoofBaseMetres": {
+                  "title": "Height to the base of the roof in metres",
+                  "description": "Height from the underlying ground surface to the point where the roof meets the external walls, that is the eaves. Where a building has sections of differing height this may reflect the lowest roofline within the footprint, so it acts as a lower bound on the height of the tallest part.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "heightToHighestPointMetres": {
+                  "title": "Height to the highest point in metres",
+                  "description": "Height from the underlying ground surface to the highest point of the building, which may include chimneys, aerials, plant or other roof structures. It therefore acts as an upper bound on the height of the occupied part of the building.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "heightMeasurementDate": {
+                  "title": "Date the building height was measured",
+                  "description": "The date of the survey or aerial imagery the height values were derived from. This is the age of the underlying evidence rather than the date the value was supplied, and matters where a building has been altered or extended since it was last measured.",
+                  "type": "string",
+                  "format": "date"
+                },
+                "footprintAreaSquareMetres": {
+                  "title": "Ground floor footprint area in square metres",
+                  "description": "The area covered by the outline of the building at ground level. This is the footprint of the building and is not the internal floor area of the dwelling.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "residentialUnitCount": {
+                  "title": "Number of residential units in the building",
+                  "description": "The number of separate residential units the building contains. Both the higher-risk building and relevant building tests under the Building Safety Act require at least two dwellings, so this is needed alongside height and storey count to apply them. Where it is derived from a count of addresses it may include non-residential addresses in a mixed use building.",
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "constructionMaterial": {
+                  "title": "Primary construction material of the building",
+                  "description": "The predominant material of the external walls, for example \"Brick or block or stone\", \"Metal\", \"Timber\" or \"Other non standard or system build\". Left unconstrained because source vocabularies differ.",
+                  "type": "string"
+                },
+                "roofMaterial": {
+                  "title": "Primary roof material of the building",
+                  "description": "The predominant roof covering, for example \"Tile or stone or slate\", \"Waterproof membrane or concrete\", \"Thatch\" or \"Metal\". Left unconstrained because source vocabularies differ.",
+                  "type": "string"
+                },
+                "basementPresent": {
+                  "title": "Is a basement present in the building?",
+                  "type": "string",
+                  "enum": ["Yes", "No", "Not known"]
+                },
+                "solarPanelsPresent": {
+                  "title": "Are solar panels present on the roof of the building?",
+                  "type": "string",
+                  "enum": ["Yes", "No", "Not known"]
+                },
+                "constructionPeriod": {
+                  "title": "Period in which the building was constructed",
+                  "description": "A range of years within which the building was built, for example \"1870-1918\" or \"2020-2029\". Use constructionYear where a single year is known.",
+                  "type": "string"
+                },
+                "constructionYear": {
+                  "title": "Year in which the building was constructed",
+                  "type": "integer"
+                }
+              }
+            },
+            "higherRiskBuildingRegistration": {
+              "title": "Higher-risk building registration",
+              "description": "The building's entry on the register of higher-risk buildings maintained by the Building Safety Regulator under the Building Safety Act 2022. The register covers England only, and describes the building containing the property rather than the individual dwelling. Absence from the register is not proof that a building falls outside the higher-risk definition, only that no registration was found, so a \"Not found\" status should be read alongside the measured height and storey count in the sibling attributes node. Values here are taken from the register rather than declared by the seller, so they are not mapped to any form overlay.",
+              "type": "object",
+              "properties": {
+                "registrationStatus": {
+                  "title": "Registration status",
+                  "description": "\"Registered\" where an entry for this building was found. \"Not found\" where the register returned no entry, which for a building over the height or storey threshold may itself be worth raising. \"Not known\" where the register could not be searched, or returned entries that could not be narrowed to this property.",
+                  "type": "string",
+                  "enum": ["Registered", "Not found", "Not known"]
+                },
+                "registrationNumber": {
+                  "title": "Registration number",
+                  "description": "The registration reference issued by the Building Safety Regulator, for example \"HRB15504S8K8\".",
+                  "type": "string"
+                },
+                "candidateCount": {
+                  "title": "Number of registered buildings that could not be told apart",
+                  "description": "Set only where the register returned more than one entry for the property's postcode and none could be matched to it. Recorded so the ambiguity is visible rather than resolved by guessing, and paired with a \"Not known\" registration status.",
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "building": {
+                  "title": "Registered building particulars",
+                  "description": "The particulars the register holds for the building. These are as supplied by the person who registered it, so they may differ from the remotely measured values in the sibling attributes node.",
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "title": "Registered building name",
+                      "type": "string"
+                    },
+                    "address": {
+                      "title": "Registered address",
+                      "type": "string"
+                    },
+                    "postcode": {
+                      "title": "Registered postcode",
+                      "type": "string"
+                    },
+                    "storeyCount": {
+                      "title": "Number of storeys above ground",
+                      "type": "integer",
+                      "minimum": 0
+                    },
+                    "heightMetres": {
+                      "title": "Registered height of the building in metres",
+                      "description": "The height as registered, measured on the Building Safety Act basis. This is the statutory measurement rather than a remotely sensed estimate.",
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "residentialUnitCount": {
+                      "title": "Number of residential units",
+                      "type": "integer",
+                      "minimum": 0
+                    },
+                    "yearOfCompletion": {
+                      "title": "Year the building was completed",
+                      "type": "integer"
+                    },
+                    "occupied": {
+                      "title": "Are people living in the building?",
+                      "type": "string",
+                      "enum": ["Yes", "No", "Not known"]
+                    }
+                  }
+                },
+                "completionCertificate": {
+                  "title": "Completion certificate",
+                  "type": "object",
+                  "properties": {
+                    "date": {
+                      "title": "Date of the completion certificate",
+                      "type": "string",
+                      "format": "date"
+                    },
+                    "issuer": {
+                      "title": "Who issued the completion certificate",
+                      "type": "string"
+                    },
+                    "reference": {
+                      "title": "Completion certificate reference",
+                      "type": "string"
+                    }
+                  }
+                },
+                "accountablePersons": {
+                  "title": "Accountable persons",
+                  "description": "The people or organisations accountable for the building's safety. Exactly one is the principal accountable person, who carries the duties for the structure and common parts.",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "role": {
+                        "title": "Role",
+                        "type": "string",
+                        "enum": [
+                          "Principal accountable person",
+                          "Accountable person"
+                        ]
+                      },
+                      "personType": {
+                        "title": "Is the accountable person an organisation or an individual?",
+                        "type": "string",
+                        "enum": ["Organisation", "Individual", "Not known"]
+                      },
+                      "name": {
+                        "title": "Name of the accountable person",
+                        "type": "string"
+                      },
+                      "accountability": {
+                        "title": "What this person is accountable for",
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "section": {
+                              "title": "Part of the building",
+                              "type": "string"
+                            },
+                            "area": {
+                              "title": "Area of accountability",
+                              "type": "string"
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            },
             "building": {
               "ntsRef": "B1.1.1",
               "nts2Ref": "B1.1.1",

package/src/schemas/v3/compactSkeleton.txt

@@ -130,6 +130,46 @@
       caption
     ]
     buildInformation
+      attributes
+        storeyCount
+        heightMetres
+        heightToRoofBaseMetres
+        heightToHighestPointMetres
+        heightMeasurementDate
+        footprintAreaSquareMetres
+        residentialUnitCount
+        constructionMaterial
+        roofMaterial
+        basementPresent
+        solarPanelsPresent
+        constructionPeriod
+        constructionYear
+      higherRiskBuildingRegistration
+        registrationStatus
+        registrationNumber
+        candidateCount
+        building
+          name
+          address
+          postcode
+          storeyCount
+          heightMetres
+          residentialUnitCount
+          yearOfCompletion
+          occupied
+        completionCertificate
+          date
+          issuer
+          reference
+        accountablePersons[
+          role
+          personType
+          name
+          accountability[
+            section
+            area
+          ]
+        ]
       building
         builtForm
         propertyType

package/src/schemas/v3/pdtf-transaction.json

@@ -955,6 +955,235 @@
           "title": "About the property building",
           "type": "object",
           "properties": {
+            "attributes": {
+              "title": "Sourced building attributes",
+              "description": "Objectively sourced physical attributes of the building that contains the property, as distinct from the dwelling itself. These sit alongside the seller-declared fields in buildInformation rather than within them: everything here is measured, surveyed or registered, and none of it is asked of the seller on a form. For a house the building and the dwelling are the same thing; for a flat or maisonette these attributes describe the whole block rather than the individual unit. Values here are measured, surveyed or registered rather than declared by the seller, so they are not mapped to any form overlay. The source and verification of each value is carried by the claim that supplies it, not by this schema.",
+              "type": "object",
+              "properties": {
+                "storeyCount": {
+                  "title": "Number of storeys in the building",
+                  "description": "The number of occupiable storeys at or above ground level in the building as a whole. Unlike the sibling building/numberOfFloors, which is only available for flats and maisonettes, this is populated for every property type and always counts the whole building.",
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "heightMetres": {
+                  "title": "Height of the building in metres",
+                  "description": "The height of the building measured on the basis used by the Building Safety Act, that is from ground level to the floor surface of the top occupied storey. Populate this only where a value on that basis is available, for example from the register of higher-risk buildings. Remotely sensed estimates belong in heightToRoofBaseMetres and heightToHighestPointMetres instead.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "heightToRoofBaseMetres": {
+                  "title": "Height to the base of the roof in metres",
+                  "description": "Height from the underlying ground surface to the point where the roof meets the external walls, that is the eaves. Where a building has sections of differing height this may reflect the lowest roofline within the footprint, so it acts as a lower bound on the height of the tallest part.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "heightToHighestPointMetres": {
+                  "title": "Height to the highest point in metres",
+                  "description": "Height from the underlying ground surface to the highest point of the building, which may include chimneys, aerials, plant or other roof structures. It therefore acts as an upper bound on the height of the occupied part of the building.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "heightMeasurementDate": {
+                  "title": "Date the building height was measured",
+                  "description": "The date of the survey or aerial imagery the height values were derived from. This is the age of the underlying evidence rather than the date the value was supplied, and matters where a building has been altered or extended since it was last measured.",
+                  "type": "string",
+                  "format": "date"
+                },
+                "footprintAreaSquareMetres": {
+                  "title": "Ground floor footprint area in square metres",
+                  "description": "The area covered by the outline of the building at ground level. This is the footprint of the building and is not the internal floor area of the dwelling.",
+                  "type": "number",
+                  "minimum": 0
+                },
+                "residentialUnitCount": {
+                  "title": "Number of residential units in the building",
+                  "description": "The number of separate residential units the building contains. Both the higher-risk building and relevant building tests under the Building Safety Act require at least two dwellings, so this is needed alongside height and storey count to apply them. Where it is derived from a count of addresses it may include non-residential addresses in a mixed use building.",
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "constructionMaterial": {
+                  "title": "Primary construction material of the building",
+                  "description": "The predominant material of the external walls, for example \"Brick or block or stone\", \"Metal\", \"Timber\" or \"Other non standard or system build\". Left unconstrained because source vocabularies differ.",
+                  "type": "string"
+                },
+                "roofMaterial": {
+                  "title": "Primary roof material of the building",
+                  "description": "The predominant roof covering, for example \"Tile or stone or slate\", \"Waterproof membrane or concrete\", \"Thatch\" or \"Metal\". Left unconstrained because source vocabularies differ.",
+                  "type": "string"
+                },
+                "basementPresent": {
+                  "title": "Is a basement present in the building?",
+                  "type": "string",
+                  "enum": [
+                    "Yes",
+                    "No",
+                    "Not known"
+                  ]
+                },
+                "solarPanelsPresent": {
+                  "title": "Are solar panels present on the roof of the building?",
+                  "type": "string",
+                  "enum": [
+                    "Yes",
+                    "No",
+                    "Not known"
+                  ]
+                },
+                "constructionPeriod": {
+                  "title": "Period in which the building was constructed",
+                  "description": "A range of years within which the building was built, for example \"1870-1918\" or \"2020-2029\". Use constructionYear where a single year is known.",
+                  "type": "string"
+                },
+                "constructionYear": {
+                  "title": "Year in which the building was constructed",
+                  "type": "integer"
+                }
+              }
+            },
+            "higherRiskBuildingRegistration": {
+              "title": "Higher-risk building registration",
+              "description": "The building's entry on the register of higher-risk buildings maintained by the Building Safety Regulator under the Building Safety Act 2022. The register covers England only, and describes the building containing the property rather than the individual dwelling. Absence from the register is not proof that a building falls outside the higher-risk definition, only that no registration was found, so a \"Not found\" status should be read alongside the measured height and storey count in the sibling attributes node. Values here are taken from the register rather than declared by the seller, so they are not mapped to any form overlay.",
+              "type": "object",
+              "properties": {
+                "registrationStatus": {
+                  "title": "Registration status",
+                  "description": "\"Registered\" where an entry for this building was found. \"Not found\" where the register returned no entry, which for a building over the height or storey threshold may itself be worth raising. \"Not known\" where the register could not be searched, or returned entries that could not be narrowed to this property.",
+                  "type": "string",
+                  "enum": [
+                    "Registered",
+                    "Not found",
+                    "Not known"
+                  ]
+                },
+                "registrationNumber": {
+                  "title": "Registration number",
+                  "description": "The registration reference issued by the Building Safety Regulator, for example \"HRB15504S8K8\".",
+                  "type": "string"
+                },
+                "candidateCount": {
+                  "title": "Number of registered buildings that could not be told apart",
+                  "description": "Set only where the register returned more than one entry for the property's postcode and none could be matched to it. Recorded so the ambiguity is visible rather than resolved by guessing, and paired with a \"Not known\" registration status.",
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "building": {
+                  "title": "Registered building particulars",
+                  "description": "The particulars the register holds for the building. These are as supplied by the person who registered it, so they may differ from the remotely measured values in the sibling attributes node.",
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "title": "Registered building name",
+                      "type": "string"
+                    },
+                    "address": {
+                      "title": "Registered address",
+                      "type": "string"
+                    },
+                    "postcode": {
+                      "title": "Registered postcode",
+                      "type": "string"
+                    },
+                    "storeyCount": {
+                      "title": "Number of storeys above ground",
+                      "type": "integer",
+                      "minimum": 0
+                    },
+                    "heightMetres": {
+                      "title": "Registered height of the building in metres",
+                      "description": "The height as registered, measured on the Building Safety Act basis. This is the statutory measurement rather than a remotely sensed estimate.",
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "residentialUnitCount": {
+                      "title": "Number of residential units",
+                      "type": "integer",
+                      "minimum": 0
+                    },
+                    "yearOfCompletion": {
+                      "title": "Year the building was completed",
+                      "type": "integer"
+                    },
+                    "occupied": {
+                      "title": "Are people living in the building?",
+                      "type": "string",
+                      "enum": [
+                        "Yes",
+                        "No",
+                        "Not known"
+                      ]
+                    }
+                  }
+                },
+                "completionCertificate": {
+                  "title": "Completion certificate",
+                  "type": "object",
+                  "properties": {
+                    "date": {
+                      "title": "Date of the completion certificate",
+                      "type": "string",
+                      "format": "date"
+                    },
+                    "issuer": {
+                      "title": "Who issued the completion certificate",
+                      "type": "string"
+                    },
+                    "reference": {
+                      "title": "Completion certificate reference",
+                      "type": "string"
+                    }
+                  }
+                },
+                "accountablePersons": {
+                  "title": "Accountable persons",
+                  "description": "The people or organisations accountable for the building's safety. Exactly one is the principal accountable person, who carries the duties for the structure and common parts.",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "role": {
+                        "title": "Role",
+                        "type": "string",
+                        "enum": [
+                          "Principal accountable person",
+                          "Accountable person"
+                        ]
+                      },
+                      "personType": {
+                        "title": "Is the accountable person an organisation or an individual?",
+                        "type": "string",
+                        "enum": [
+                          "Organisation",
+                          "Individual",
+                          "Not known"
+                        ]
+                      },
+                      "name": {
+                        "title": "Name of the accountable person",
+                        "type": "string"
+                      },
+                      "accountability": {
+                        "title": "What this person is accountable for",
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "section": {
+                              "title": "Part of the building",
+                              "type": "string"
+                            },
+                            "area": {
+                              "title": "Area of accountability",
+                              "type": "string"
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            },
             "building": {
               "title": "Building information",
               "type": "object",

package/src/schemas/v3/skeleton.json

@@ -168,6 +168,54 @@
       }
     ],
     "buildInformation": {
+      "attributes": {
+        "storeyCount": "integer",
+        "heightMetres": "number",
+        "heightToRoofBaseMetres": "number",
+        "heightToHighestPointMetres": "number",
+        "heightMeasurementDate": "string",
+        "footprintAreaSquareMetres": "number",
+        "residentialUnitCount": "integer",
+        "constructionMaterial": "string",
+        "roofMaterial": "string",
+        "basementPresent": "string",
+        "solarPanelsPresent": "string",
+        "constructionPeriod": "string",
+        "constructionYear": "integer"
+      },
+      "higherRiskBuildingRegistration": {
+        "registrationStatus": "string",
+        "registrationNumber": "string",
+        "candidateCount": "integer",
+        "building": {
+          "name": "string",
+          "address": "string",
+          "postcode": "string",
+          "storeyCount": "integer",
+          "heightMetres": "number",
+          "residentialUnitCount": "integer",
+          "yearOfCompletion": "integer",
+          "occupied": "string"
+        },
+        "completionCertificate": {
+          "date": "string",
+          "issuer": "string",
+          "reference": "string"
+        },
+        "accountablePersons": [
+          {
+            "role": "string",
+            "personType": "string",
+            "name": "string",
+            "accountability": [
+              {
+                "section": "string",
+                "area": "string"
+              }
+            ]
+          }
+        ]
+      },
       "building": {
         "builtForm": "string",
         "propertyType": "variant",