@pdtf/schemas 0.7.3 → 0.7.6

package/package.json

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

package/src/schemas/legal-information.json

@@ -26,6 +26,7 @@
       "minItems": 1,
       "items": {
         "type": "object",
+        "baspiRef": "B1.1.1",
         "title": "Owner name",
         "required": ["firstName", "lastName"],
         "properties": {
@@ -254,7 +255,7 @@
           "type": "object",
           "properties": {
             "hasSolarPanels": {
-              "baspiRef": "B.4.3x",
+              "baspiRef": "B4.3",
               "RDSRef": "Property/Flags",
               "title": "Are there solar or photovoltaic panels installed at the property?",
               "type": "string",
@@ -411,10 +412,15 @@
                 "handoverOnCompletion": {
                   "title": "Confirm that you will handover details on day of completion",
                   "description": "Confirm that you will provide the buyer with the login, password and link to user instructions for the relevant system(s). [NOTE: It is recommended that you reset the password before handing it over to avoid security issues by passing on your own password.]",
-                  "type": "boolean",
-                  "const": true
+                  "type": "boolean"
                 }
-              }
+              },
+              "required": [
+                "heatingAndPower",
+                "security",
+                "entertainment",
+                "handoverOnCompletion"
+              ]
             }
           ]
         }
@@ -524,8 +530,7 @@
                   "baspiRef": "B5.1.11",
                   "RDSRef": "Property/Flags",
                   "title": "Please confirm that you will leave all paperwork relating to any guarantee or warranty at the property when you move out",
-                  "type": "boolean",
-                  "const": true
+                  "type": "boolean"
                 },
                 "outstandingClaimsOrApplications": {
                   "baspiRef": "B5.2",
@@ -636,8 +641,7 @@
           "lawSocietyRef": "TA6/14.4",
           "title": "Please confirm that on completion you will remove all rubbish and items not included in the sale from the property including its garden, loft and any sheds or outbuildings.",
           "description": "When the property is cleared out you will be expected to take reasonable care when clearing the property, leaving it clean and tidy and repairing any damage caused when removing items from the property and making safe any light or electrical fittings which are being removed.\n\nKeys for all door and window locks, along with any alarm codes, should be available for the buyer on the day of completion.  If there is any reason why you cannot do this you should let the estate agent and your property lawyer know. For all internet connected services eg doorbells, boiler controls, burglar alarms, CCTV cameras etc) access to them will need to be provided to the buyer on the day of completion so that they can control them or sign up to the service.  If there is any reason why you cannot do this you should let the estate agent and your property lawyer know.",
-          "type": "boolean",
-          "const": true
+          "type": "boolean"
         },
         "otherPropertyInChain": {
           "baspiRef": "B7.2",
@@ -736,7 +740,7 @@
           "baspiRef": "B7.5",
           "RDSRef": "",
           "title": "Do you have a Digital Property Logbook?",
-          "description": "See https://www.rlba.org.uk/what-is-a-property-logbook? [NOTE: If you do not, check if you have documents form when you bought your property provided by your property lawyer at the time.  It is recommended that you provide your property lawyer with access to avoid duplication and delays]",
+          "description": "See https://www.rlba.org.uk/what-is-a-property-logbook?",
           "type": "object",
           "properties": {
             "yesNo": {
@@ -763,10 +767,8 @@
                       "enum": ["Yes"]
                     },
                     "willHandoverLogbook": {
-                      "title": "Please confirm that on completion you will provide the buyer with the login and password to the Property Logbook.",
-                      "description": "[NOTE: It is recommended that you reset the password before handing it over to avoid security issues by passing on your own password.]",
-                      "type": "boolean",
-                      "const": true
+                      "title": "Please confirm that on completion you will transfer it to the new owner",
+                      "type": "boolean"
                     }
                   },
                   "required": ["willHandoverLogbook"]
@@ -789,14 +791,12 @@
         "confirmWillProvideAdditionalDocumentation": {
           "baspiRef": "B8.1",
           "title": "I/we will provide my property lawyer with the additional documentation in support of the information supplied.",
-          "type": "boolean",
-          "const": true
+          "type": "boolean"
         },
         "confirmInformationIsAccurate": {
           "baspiRef": "B8.2",
           "title": "I/we confirm that all information provided is accurate to the best of our knowledge and if we become aware of any change to/changes which alter the information supplied/provided prior to exchange of contracts for the sale of the property, I/we will update immediately notify the person marketing the property as well as my/our property lawyer. All sellers should sign this form",
-          "type": "boolean",
-          "const": true
+          "type": "boolean"
         }
       }
     }
@@ -915,13 +915,13 @@
                 "yesNo": {
                   "enum": ["No", "Not required"]
                 },
-                "reasons": {
+                "details": {
                   "title": "Please outline the reasons why",
                   "type": "string",
                   "minLength": 1
                 }
               },
-              "required": ["reasons"]
+              "required": ["details"]
             }
           ]
         }

package/src/schemas/material-facts.json

@@ -248,6 +248,7 @@
       "required": ["hasDelayFactors"],
       "properties": {
         "hasDelayFactors": {
+          "baspiRef": "A1.2.1",
           "title": "Are you aware of any factors which might delay or complicate the sale?",
           "description": "E.g. family split, pending application for grant of probate, absent seller or unregistered title? If yes, provide details and likely timescale for delay (if known)",
           "$ref": "#/$defs/yesNoDetailIfYes"
@@ -294,6 +295,7 @@
                   "enum": ["Other"]
                 },
                 "otherOwnershipDetails": {
+                  "baspiRef": "A1.3.2",
                   "title": "Details of the ownership type",
                   "type": "string",
                   "minLength": 1
@@ -1251,7 +1253,7 @@
                       "type": "string"
                     },
                     "maintenanceAgreements": {
-                      "BASPIRef": "A7.2",
+                      "baspiRef": "A7.2",
                       "RDSRef": "Services/Certificates,Services/OtherServices/Certificates",
                       "title": "Do you have any licences, maintenance agreements, contracts or service agreements in relation to this service?",
                       "$ref": "#/$defs/yesNoDetailIfYes"
@@ -1351,6 +1353,7 @@
       "required": ["hasGreenDealLoan"],
       "properties": {
         "hasGreenDealLoan": {
+          "baspiRef": "A7.3",
           "title": "Is this property subject to a Green Deal loan or other financed home improvement scheme?",
           "description": "If yes, please provide details below including any outstanding payments for the renewable devices and any feed-in tariffs and a copy of your fuel bills",
           "$ref": "#/$defs/yesNoDetailIfYes"
@@ -1366,6 +1369,7 @@
       "required": ["hasCentralHeating"],
       "properties": {
         "hasCentralHeating": {
+          "baspiRef": "A7.4",
           "title": "Is there full/partial central heating in your property?",
           "type": "string",
           "enum": ["Yes", "No"]
@@ -1400,7 +1404,7 @@
                       "required": ["centralHeatingFuelType"],
                       "properties": {
                         "centralHeatingFuelType": {
-                          "baspiRef": "A1.6.1",
+                          "baspiRef": "A7.5.1a",
                           "title": "What type of fuel does the system and boiler run on?",
                           "type": "string",
                           "enum": ["Gas", "Electricity", "Oil", "LPG", "Other"]
@@ -1423,6 +1427,7 @@
                                   "enum": ["Other"]
                                 },
                                 "otherCentralHeatingFuelType": {
+                                  "baspiRef": "A7.5.1b",
                                   "title": "Please describe the other fuel type",
                                   "type": "string",
                                   "minLength": 1
@@ -1742,10 +1747,10 @@
       "required": ["consumerProtectionRegulationsResponse"],
       "properties": {
         "consumerProtectionRegulationsResponse": {
+          "baspiRef": "A13.1",
           "title": "Seller's declaration",
           "description": "I/we confirm the answers to be truthful and accurate and to the best of my/our knowledge. The questions have been designed to assist with the disclosure of material information and any misleading or incorrect answers are likely to be exposed later in the legal process which may hinder my/our sale. I/we will provide my property lawyer with the additional documentation in support of the information supplied on this form. If there are any changes which alter the information provided, I/we will immediately notify the person marketing the property as well as my/our property lawyer.",
-          "type": "boolean",
-          "const": true
+          "type": "boolean"
         }
       }
     }
@@ -1907,7 +1912,7 @@
                   "type": "string"
                 },
                 "maintenanceAgreements": {
-                  "BASPIRef": "A7.2",
+                  "baspiRef": "A7.2",
                   "RDSRef": "Services/Certificates,Services/OtherServices/Certificates",
                   "title": "Do you have any licences, maintenance agreements, contracts or service agreements in relation to this service?",
                   "$ref": "#/$defs/yesNoDetailIfYes"
@@ -1930,7 +1935,7 @@
                   "type": "string"
                 },
                 "maintenanceAgreements": {
-                  "BASPIRef": "A7.2",
+                  "baspiRef": "A7.2",
                   "RDSRef": "Services/Certificates,Services/OtherServices/Certificates",
                   "title": "Do you have any licences, maintenance agreements, contracts or service agreements in relation to this service?",
                   "$ref": "#/$defs/yesNoDetailIfYes"

package/src/schemas/pdtf-transaction-search-results.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/minified-pdtf-transaction.json",
+  "title": "Property Data Trust Framework Transaction Schema",
+  "description": "A schema defining search results containing minimal elements of the PDTF transaction data structure.",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "required": [
+      "$schema",
+      "transactionId",
+      "status",
+      "uprn",
+      "createdAt",
+      "updatedAt"
+    ],
+    "properties": {
+      "transactionId": {
+        "title": "UUID for the transaction",
+        "type": "string",
+        "format": "uuid"
+      },
+      "status": {
+        "type": "string",
+        "enum": ["active", "cancelled", "completed"]
+      },
+      "uprn": {
+        "type": "integer"
+      },
+      "createdAt": {
+        "type": "string",
+        "format": "date-time"
+      },
+      "updatedAt": {
+        "type": "string",
+        "format": "date-time"
+      }
+    }
+  }
+}