@pdtf/schemas 0.6.3 → 0.6.6

package/package.json

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

package/src/examples/exampleElectronicRecord.json

@@ -20,8 +20,8 @@
   },
   "claims": {
     "/propertyPack/materialFacts/address": {
-      "address1": "3 The Hollys",
-      "address2": "Birtley",
+      "line1": "3 The Hollys",
+      "line2": "Birtley",
       "town": "CHESTER LE STREET",
       "county": "County Durham",
       "postcode": "DH3 1QN"

package/src/examples/exampleTransaction.json

@@ -1,17 +1,17 @@
 {
-  "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-transaction.json",
+  "$schema": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-transaction.json",
   "transactionId": "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a",
   "status": "active",
   "participants": [
     {
       "name": {
-        "forenames": "Peter Ronald",
-        "surname": "Hetherington-Smythe"
+        "firstName": "Peter",
+        "lastName": "Hetherington-Smythe"
       },
       "dateOfBirth": "1975-12-25",
       "phone": "07777 222333",
       "email": "peter@theseller.com",
-      "address": { "address1": "47 Park Road", "postcode": "AL3 5AF" },
+      "address": { "line1": "47 Park Road", "postcode": "AL3 5AF" },
       "role": "Seller"
     }
   ],
@@ -19,15 +19,13 @@
     "materialFacts": {
       "uprn": 1241304304,
       "address": {
-        "address1": "47 Park Road",
-        "address2": "",
+        "line1": "47 Park Road",
+        "line2": "",
         "town": "HARPENDEN",
         "county": "Herts",
         "postcode": "AL3 5AF"
       },
-      "energyEfficiency": {
-        "energyEfficiencyRating": "A"
-      },
+
       "delayFactors": {
         "hasDelayFactors": { "yesNo": "No" }
       },
@@ -52,9 +50,18 @@
           "yesNo": "No"
         }
       },
-      "flammableExternalWallSystem": {
+      "typeOfConstruction": {
+        "isStandardForm": {
+          "yesNo": "Yes"
+        },
         "hasFlammableExternalWallSystem": "No"
       },
+      "energyEfficiency": {
+        "energyEfficiencyRating": "A",
+        "hasSprayFoamInstalled": {
+          "yesNo": "No"
+        }
+      },
       "councilTax": {
         "councilTaxBand": "A",
         "councilTaxAffectingAlterations": {

package/src/schemas/baspi-a-material-facts.json

@@ -12,7 +12,7 @@
     "ownership",
     "parking",
     "listingAndConservation",
-    "flammableExternalWallSystem",
+    "typeOfConstruction",
     "energyEfficiency",
     "councilTax",
     "disputesAndComplaints",
@@ -45,7 +45,10 @@
     },
     "delayFactors": {
       "baspiRef": "A1.2",
-      "RDSRef": "Metadata/PotentialDelays,Metadata/PotentialDelayDuration",
+      "RDSMapping": {
+        "hasDelayFactors/yesNo": " Metadata/PotentialDelays",
+        "hasDelayFactors/details": "Metadata/PotentialDelayDuration"
+      },
       "title": "Delay Factors",
       "type": "object",
       "required": ["hasDelayFactors"],
@@ -398,12 +401,18 @@
         }
       }
     },
-    "flammableExternalWallSystem": {
-      "baspiRef": "A1.8.2",
-      "RDSRef": "Property/Flags,Certificates",
+    "typeOfConstruction": {
+      "baspiRef": "1.8",
+      "title": "Type of Construction",
       "type": "object",
-      "required": ["hasFlammableExternalWallSystem"],
+      "required": ["isStandardForm", "hasFlammableExternalWallSystem"],
       "properties": {
+        "isStandardForm": {
+          "baspiRef": "A1.8.1",
+          "RDSRef": "Buildings,BuildingSections/ConstructionType,ConstructionMaterials",
+          "title": "Is the property built in a standard form of construction? E.g. brick and/or block with timber-supported roof comprising a tile or slate cover?",
+          "$ref": "#/$defs/yesNoDetailIfNo"
+        },
         "hasFlammableExternalWallSystem": {
           "baspiRef": "A2.1",
           "RDSRef": "Tenure/DisputesComplaints,Tenure/LegalClaims",
@@ -419,18 +428,25 @@
       }
     },
     "energyEfficiency": {
-      "baspiRef": "1.8.3",
       "RDSRef": "Certificates/{category='energyEfficiency',standard='EPC',gradeLevelRating=?},Certificates/{category='energyEfficiency',standard='EPC',status='exempt'},",
       "lawSocietyRef": "TA6/7.6",
       "title": "Energy Efficiency",
       "type": "object",
-      "required": ["energyEfficiencyRating"],
+      "required": ["energyEfficiencyRating", "hasSprayFoamInstalled"],
       "properties": {
         "energyEfficiencyRating": {
+          "baspiRef": "1.8.3",
           "title": "Energy Efficiency Rating",
           "description": "What is the energy efficiency rating of the property according to the latest Energy Performance Certificate (EPC)?",
           "type": "string",
           "enum": ["A", "B", "C", "D", "E", "F", "G", "Exempt Property"]
+        },
+        "hasSprayFoamInstalled": {
+          "baspiRef": "A1.8.4",
+          "RDSRef": "",
+          "title": "Has spray foam insulation been installed at the property?",
+          "$ref": "#/$defs/yesNoDetailIfYes",
+          "description": "If yes, please give details together with certification from BBA or KIWA and the installation warranty for the work carried out."
         }
       }
     },
@@ -1625,12 +1641,12 @@
     "address": {
       "type": "object",
       "properties": {
-        "address1": {
+        "line1": {
           "title": "Address 1",
           "type": "string",
           "minLength": 1
         },
-        "address2": {
+        "line2": {
           "title": "Address 2",
           "type": "string"
         },
@@ -1648,7 +1664,7 @@
           "minLength": 1
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["line1", "postcode"]
     },
     "contactDetails": {
       "type": "object",

package/src/schemas/baspi-b-legal-information.json

@@ -658,7 +658,8 @@
     "required": [
       "willRemoveAllRubbish",
       "otherPropertyInChain",
-      "moveRestrictionDates"
+      "moveRestrictionDates",
+      "digitalPropertyLogbook"
     ],
     "properties": {
       "willRemoveAllRubbish": {
@@ -762,6 +763,49 @@
             ]
           }
         }
+      },
+      "digitalPropertyLogbook": {
+        "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]",
+        "type": "object",
+        "properties": {
+          "yesNo": {
+            "type": "string",
+            "title": "",
+            "enum": ["No", "Yes"]
+          }
+        },
+        "required": ["yesNo"],
+        "dependencies": {
+          "yesNo": {
+            "oneOf": [
+              {
+                "properties": {
+                  "yesNo": {
+                    "enum": ["No"]
+                  }
+                },
+                "additionalProperties": false
+              },
+              {
+                "properties": {
+                  "yesNo": {
+                    "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
+                  }
+                },
+                "required": ["willHandoverLogbook"]
+              }
+            ]
+          }
+        }
       }
     }
   },
@@ -917,11 +961,11 @@
     "address": {
       "type": "object",
       "properties": {
-        "address1": {
+        "line1": {
           "title": "Address 1",
           "type": "string"
         },
-        "address2": {
+        "line2": {
           "title": "Address 2",
           "type": "string"
         },
@@ -938,7 +982,7 @@
           "type": "string"
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["line1", "postcode"]
     }
   }
 }

package/src/schemas/baspiNotes.html

@@ -0,0 +1,102 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Buyers and Sellers Property Information Form Notes</title>
+  </head>
+  <body>
+    <h1>ABOUT THIS FORM</h1>
+    <p>
+      The form will take a little time to complete but contains information
+      which will speed up the legal process.
+    </p>
+
+    <h2>
+      PART A - Getting the property 'Market Ready' (Disclosure of material
+      facts)
+    </h2>
+    <p>
+      Whether you are the legal owner of the property or representing them you
+      should complete this form as though the questions are being answered by
+      the legal owner and based, as far as possible, on their personal knowledge
+      of the property.
+    </p>
+    <p>
+      The information you provide must be accurate. You must complete this form
+      to comply with the Consumer Protection from Unfair Trading Regulations
+      2008 during the marketing of the property. Under these regulations it is a
+      legal requirement to disclose anything that would materially affect the
+      'average person's' decision to buy the property.
+    </p>
+
+    <h3>How will the information be used?</h3>
+    <p>
+      To comply with the regulations, the information will be displayed by the
+      person marketing the property for anyone to view, this might include their
+      own website or via the property portals.
+    </p>
+
+    <h2>PART B - Getting the property 'Sale Ready'</h2>
+    <p></p>
+    You need to complete the information in Section A to market your home and
+    both Part A and Part B will be used during the legal process. Anyone making
+    an offer to buy or lend money on the property is entitled to see Part A and
+    Part B.
+
+    <h3>How will the information be used?</h3>
+    <p>
+      Your property lawyer and your buyer's property lawyer and valuer will use
+      this information as part of the legal process for selling your home and it
+      will form part of the contract for sale.
+    </p>
+    <p>
+      You must answer all questions or it will delay the legal process. You must
+      not leave out information which could affect a buyer's decision to
+      proceed.
+    </p>
+    <p>
+      If any of the information changes before you complete the sale then you
+      should let your estate agent and your property lawyer know about the
+      changes, in writing, as soon as possible.
+    </p>
+    <p>
+      If the property is leasehold, commonhold or a managed freehold, additional
+      information forms will need to be completed by you and the person who
+      manages the shared amenities. Your property lawyer will deal with this,
+      but you can help by asking the property manager for details of their costs
+      to provide the information and who your lawyer should contact to get the
+      information.
+    </p>
+    <p>
+      Whilst you do not need a property lawyer to help you complete the form,
+      instructing your property lawyer now will mean they can help you collate
+      the information, review the answers which you have provided and may help
+      you answer questions you aren't sure about. This can significantly speed
+      up the legal process.
+    </p>
+    <p>
+      Make sure you give all of the documents which you have referred to in your
+      answers to your property lawyer.
+    </p>
+
+    <h2>THINKING OF BUYING THIS PROPERTY?</h2>
+    <p>
+      The information contained in this form is intended to help you decide
+      whether the property is suitable for you. However, if there is a
+      particular reason you are buying the property (e.g. to let it, extend it,
+      run a business from it, etc) you should double check with your property
+      lawyer and surveyor whether there is anything which might affect that.
+    </p>
+    <p>
+      The information given by the seller is based on their own knowledge and
+      opinion. You should assume that the seller is not a legal expert, surveyor
+      or building maintenance expert and that any information is given as a home
+      owner, or their representative, and can only be relied upon to that
+      extent.
+    </p>
+    <p>
+      You should verify any answers which are important to you with your
+      property lawyer or surveyor or ask for quotes from the appropriate trade
+      experts, e.g. builder, plumber, electrician, damp and timber expert, etc.
+    </p>
+  </body>
+</html>

package/src/schemas/pdtf-transaction.json

@@ -34,20 +34,24 @@
         "required": ["name", "email", "role"],
         "properties": {
           "name": {
-            "title": "",
+            "title": "Name",
             "type": "object",
-            "required": ["forenames", "surname"],
+            "required": ["firstName", "lastName"],
             "properties": {
-              "forenames": {
-                "title": "Forenames",
+              "firstName": {
+                "title": "First name",
                 "type": "string"
               },
-              "preferredName": {
-                "title": "Preferred name / known as",
+              "middleName": {
+                "title": "Middle name(s)",
+                "type": "string"
+              },
+              "lastName": {
+                "title": "lastName",
                 "type": "string"
               },
-              "surname": {
-                "title": "Surname",
+              "preferredName": {
+                "title": "Preferred name / known as",
                 "type": "string"
               }
             }
@@ -235,12 +239,12 @@
     "address": {
       "type": "object",
       "properties": {
-        "address1": {
+        "line1": {
           "title": "Address 1",
           "type": "string",
           "minLength": 1
         },
-        "address2": {
+        "line2": {
           "title": "Address 2",
           "type": "string"
         },
@@ -258,7 +262,7 @@
           "minLength": 1
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["line1", "postcode"]
     },
     "riskIndicatorAndSearch": {
       "type": "object",
@@ -269,7 +273,7 @@
           "enum": ["Yes", "No"]
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["hasRisk"]
     }
   }
 }

package/src/tests/transactionSchema.test.js

@@ -77,8 +77,8 @@ test("correctly gets a subschema through an arrays element", () => {
 });
 
 test("correctly gets another subschema through an arrays element", () => {
-  const subschema = getSubschema("/participants/0/name/forenames");
-  expect(subschema.title).toBe("Forenames");
+  const subschema = getSubschema("/participants/0/name/firstName");
+  expect(subschema.title).toBe("First name");
 });
 
 test("correctly gets a subschema validator which is already cached", () => {