@pdtf/schemas 0.5.8 → 0.5.9

package/index.js

@@ -39,7 +39,7 @@ const getSubschema = (path) => {
     return schema;
   }
   return pathArray.reduce((propertyPackSchema, pathElement) => {
-    return propertyPackSchema["properties"][pathElement];
+    return propertyPackSchema.properties[pathElement];
   }, propertyPackSchema);
 };
 
@@ -47,11 +47,53 @@ const getSubschemaValidator = (path) => {
   return ajv.getSchema(path) || ajv.compile(getSubschema(path));
 };
 
+const getTitleAtPath = (schema, path, rootPath = path) => {
+  if (path === "") path = "/";
+  let pathArray = path.split("/").slice(1);
+  if (pathArray.length === 1 && pathArray[0] === "") {
+    if (schema.title) return schema.title;
+    // no 'title' property present, so we use the property name to create a readable descriptor
+    const propertyName = rootPath
+      .split("/")
+      .pop()
+      .replace(/([A-Z])/g, " $1")
+      .toLowerCase()
+      .trim();
+    return propertyName.charAt(0).toUpperCase() + propertyName.slice(1);
+  }
+  const propertyName = pathArray.shift();
+  const subPath = "/" + pathArray.join("/");
+  let subSchema = schema.properties?.[propertyName];
+  if (subSchema) {
+    return getTitleAtPath(subSchema, subPath, rootPath);
+  }
+  if (schema.type === "array") {
+    subSchema = schema.items;
+    return getTitleAtPath(subSchema, subPath, rootPath);
+  }
+  const dependencies = schema.dependencies;
+  if (dependencies) {
+    // only single dependency discriminator, oneOf keyword is supported
+    const dependencyDiscriminator = Object.keys(dependencies)[0];
+    const oneOfs = dependencies[dependencyDiscriminator].oneOf;
+    const matchingOneOf = oneOfs.find(
+      (oneOf) => oneOf["properties"][propertyName]
+    );
+    if (matchingOneOf)
+      return getTitleAtPath(
+        matchingOneOf["properties"][propertyName],
+        subPath,
+        rootPath
+      );
+  }
+};
+
 module.exports = {
   propertyPackSchema,
   validator,
   getSubschema,
   getSubschemaValidator,
+  getTitleAtPath,
   pdtfClaim,
   verifiedClaim
 };

package/package.json

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

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

@@ -9,9 +9,9 @@
     "address",
     "delayFactors",
     "ownership",
-    "parkingArrangements",
+    "parking",
     "listingAndConservation",
-    "hasFlammableExternalWallSystem",
+    "flammableExternalWallSystem",
     "energyEfficiency",
     "councilTax",
     "disputesAndComplaints",
@@ -95,8 +95,8 @@
                     "annualServiceCharge",
                     "largeAdditionalExpense",
                     "additionalFeesOnSale",
-                    "freeholderName",
-                    "managingAgentName",
+                    "freeholderContactDetails",
+                    "managingAgentContactDetails",
                     "managementCompanyDirectorRequirement"
                   ],
                   "properties": {
@@ -165,7 +165,8 @@
                     }
                   }
                 }
-              }
+              },
+              "required": ["leaseholdDetails"]
             },
             {
               "properties": {
@@ -180,8 +181,8 @@
                     "annualServiceCharge",
                     "largeAdditionalExpense",
                     "additionalFeesOnSale",
-                    "freeholderName",
-                    "managingAgentName",
+                    "freeholderContactDetails",
+                    "managingAgentContactDetails",
                     "managementCompanyDirectorRequirement"
                   ],
                   "properties": {
@@ -209,13 +210,13 @@
                     "freeholderContactDetails": {
                       "baspiRef": "A1.5.4",
                       "RDSRef": "TenureAgreements/Assignor",
-                      "title": "The name, address and email address of the freeholder or rentcharge owner",
+                      "title": "The contact details of the freeholder or rentcharge owner",
                       "$ref": "#/$defs/contactDetails"
                     },
                     "managingAgentContactDetails": {
                       "baspiRef": "A1.5.5",
                       "RDSRef": "Participants/Role",
-                      "title": "The name, address and email address of the managing agent",
+                      "title": "The contact details of the managing agent",
                       "$ref": "#/$defs/contactDetails"
                     },
                     "managementCompanyDirectorRequirement": {
@@ -226,76 +227,85 @@
                     }
                   }
                 }
-              }
+              },
+              "required": ["managedFreeholdOrCommonhold"]
             }
           ]
         }
       }
     },
-    "parkingArrangements": {
+    "parking": {
       "baspiRef": "A1.6",
       "RDSRef": "Services/Parking",
       "lawSocietyRef": "TA6/9.1",
-      "title": "Parking arrangements",
+      "title": "Parking",
       "type": "object",
-      "required": ["parkingArrangementsType", "electricVehicleChargingPoint"],
+      "required": ["parkingArrangements", "electricVehicleChargingPoint"],
       "properties": {
-        "parkingArrangementsType": {
-          "baspiRef": "A1.6.1",
-          "title": "What parking arrangements are there?",
-          "type": "string",
-          "enum": [
-            "Garage",
-            "Allocated parking space",
-            "Driveway",
-            "On street",
-            "Resident permit",
-            "Metered parking",
-            "Communal parking",
-            "None",
-            "Other"
-          ]
+        "parkingArrangements": {
+          "type": "object",
+          "title": "Parking arrangements",
+          "required": ["parkingArrangementsType"],
+          "properties": {
+            "parkingArrangementsType": {
+              "baspiRef": "A1.6.1",
+              "title": "What type of parking arrangements are there?",
+              "type": "string",
+              "enum": [
+                "Garage",
+                "Allocated parking space",
+                "Driveway",
+                "On street",
+                "Resident permit",
+                "Metered parking",
+                "Communal parking",
+                "None",
+                "Other"
+              ]
+            }
+          },
+          "dependencies": {
+            "parkingArrangementsType": {
+              "oneOf": [
+                {
+                  "properties": {
+                    "parkingArrangementsType": {
+                      "enum": [
+                        "Garage",
+                        "Allocated parking space",
+                        "Driveway",
+                        "On street",
+                        "Resident permit",
+                        "Metered parking",
+                        "Communal parking",
+                        "None"
+                      ]
+                    }
+                  },
+                  "additionalProperties": false
+                },
+                {
+                  "properties": {
+                    "parkingArrangementsType": {
+                      "enum": ["Other"]
+                    },
+                    "otherParkingType": {
+                      "baspiRef": "A1.6.2",
+                      "title": "Please describe the other parking arrangements",
+                      "type": "string"
+                    }
+                  },
+                  "required": ["otherParkingType"]
+                }
+              ]
+            }
+          }
         },
         "electricVehicleChargingPoint": {
           "baspiRef": "A1.6.1",
           "title": "Is there an electric vehicle charging point belonging to the property?",
           "$ref": "#/$defs/yesNo"
         }
-      },
-      "dependencies": {
-        "parkingArrangementsType": {
-          "oneOf": [
-            {
-              "properties": {
-                "parkingArrangementsType": {
-                  "enum": [
-                    "Garage",
-                    "Allocated parking space",
-                    "Driveway",
-                    "On street",
-                    "Resident permit",
-                    "Metered parking",
-                    "Communal parking",
-                    "None"
-                  ]
-                }
-              }
-            },
-            {
-              "properties": {
-                "parkingArrangementsType": {
-                  "enum": ["Other"]
-                },
-                "otherParkingType": {
-                  "baspiRef": "A1.6.2",
-                  "title": "Please describe the other parking arrangements",
-                  "type": "string"
-                }
-              },
-              "required": ["otherParkingType"]
-            }
-          ]
-        }
       }
     },
     "listingAndConservation": {
@@ -375,16 +385,25 @@
         }
       }
     },
-    "hasFlammableExternalWallSystem": {
+    "flammableExternalWallSystem": {
       "baspiRef": "A1.8.2",
       "RDSRef": "Property/Flags,Certificates",
-      "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"
-      ]
+      "type": "object",
+      "required": ["hasFlammableExternalWallSystem"],
+      "properties": {
+        "hasFlammableExternalWallSystem": {
+          "baspiRef": "A2.1",
+          "RDSRef": "Tenure/DisputesComplaints,Tenure/LegalClaims",
+          "lawSocietyRef": "TA6/2.1",
+          "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"
+          ]
+        }
+      }
     },
     "energyEfficiency": {
       "baspiRef": "1.8.3",
@@ -577,7 +596,7 @@
     "notices": {
       "baspiRef": "A4",
       "title": "Notices which Affect the Property",
-      "description": "Are you aware of, or have you received any of the following notices?",
+      "description": "Are you aware of, or have you received, any of the following notices?",
       "type": "object",
       "required": [
         "neighbourDevelopment",
@@ -1118,7 +1137,7 @@
         "partOnSeparateSiteOrDeed": {
           "baspiRef": "A9.2",
           "RDSRef": "Tenure *with different property entity and references etc*",
-          "title": "Is any part of the property on a separate site or separate title deed e.g. garden, outbuilding, parking, garage?",
+          "title": "Is any part of the property on a separate site or separate title number e.g. garden, outbuilding, parking, garage?",
           "$ref": "#/$defs/yesNoDetailIfYes"
         },
         "boundariesDifferFromTitlePlan": {
@@ -1300,7 +1319,7 @@
           "RDSRef": "Tenure/OtherMaterialIssues",
           "title": "Are you aware of any other material issue or information which relates to the property or has anything occurred which may affect the average person’s decision to proceed? (This disclosure is required under the Consumer Protection from Unfair Trading Regulations 2008)",
           "$ref": "#/$defs/yesNoDetailIfYes",
-          "description": "If yes, please describe this issue and any action that has been taken, if applicable ."
+          "description": "If yes, please describe this issue and any action that has been taken, if applicable."
         }
       }
     },

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

@@ -53,7 +53,14 @@
     "RDSRef": "Participants/description=?,Participants/ActingFor/Participants/Role",
     "title": "Sellers Conveyancer",
     "type": "object",
-    "required": ["firstName", "lastName", "address", "email", "reference"],
+    "required": [
+      "firstName",
+      "lastName",
+      "address",
+      "email",
+      "organisation",
+      "reference"
+    ],
     "properties": {
       "firstName": {
         "title": "First name",
@@ -63,15 +70,20 @@
         "title": "Last name",
         "type": "string"
       },
-      "address": {
-        "title": "Address",
-        "$ref": "#/$defs/address"
-      },
       "email": {
         "title": "Email address",
         "type": "string",
         "format": "email"
       },
+      "organisation": {
+        "title": "Organisation",
+        "type": "string"
+      },
+      "address": {
+        "title": "Address",
+        "$ref": "#/$defs/address"
+      },
+
       "reference": {
         "title": "Reference",
         "type": "string"
@@ -315,8 +327,8 @@
                     "baspiRef": "",
                     "RDSRef": "Objects/Ownership",
                     "title": "Do you own the panels, and all equipment related to them, outright?",
-                    "$ref": "#/$defs/yesNoDetailIfYes",
-                    "description": "If yes, provide details of who owns them and the relevant documentation"
+                    "$ref": "#/$defs/yesNoDetailIfNo",
+                    "description": "If no, provide details of who owns them and the relevant documentation"
                   },
                   "panelProviderLease": {
                     "baspiRef": "B4.3.2",
@@ -366,7 +378,7 @@
       "stopcockAndWaterMeterLocation": {
         "baspiRef": "B4.6",
         "RDSRef": "Objects/class='meters|valve|stopcock'&access=?&accessLocation=?",
-        "title": "Please describe, or attach a photograph of, the location of the stopcock and water meter",
+        "title": "Please describe, or attach a photograph of, the location of any stopcock and water meter",
         "type": "string"
       },
       "photovoltaicMeterPanelLocation": {
@@ -375,7 +387,7 @@
         "title": "Please describe, or attach a photograph of, the location of any photovoltaic panel meter",
         "type": "string"
       },
-      "photovoltaicMeterBatteriesLocation": {
+      "photovoltaicBatteriesLocation": {
         "baspiRef": "B4.8",
         "RDSRef": "Objects/class='meters|valve|stopcock'&access=?&accessLocation=?",
         "title": "Please describe, or attach a photograph of, the location of any photovoltaic batteries",
@@ -461,7 +473,8 @@
               "hasValidGuaranteesOrWarranties": {
                 "enum": ["No"]
               }
-            }
+            },
+            "additionalProperties": false
           },
           {
             "properties": {
@@ -542,7 +555,8 @@
                 "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",
-                "$ref": "#/$defs/yesNo"
+                "type": "boolean",
+                "const": true
               },
               "outstandingClaimsOrApplications": {
                 "baspiRef": "B5.2",

package/src/schemas/property-pack.json

@@ -29,32 +29,43 @@
             "type": "object",
             "title": "Seller information",
             "required": [
-              "firstName",
-              "lastName",
+              "name",
               "dateOfBirth",
-              "emailAddress",
+              "mobileNumber",
+              "email",
               "address"
             ],
             "properties": {
-              "firstName": {
-                "RDSRef": "",
-                "title": "First name",
-                "type": "string"
-              },
-              "middleNames": {
-                "title": "Middle name(s)",
-                "type": "string"
-              },
-              "lastName": {
-                "title": "Last name",
-                "type": "string"
+              "name": {
+                "title": "Name",
+                "type": "object",
+                "required": ["firstName", "lastName"],
+                "properties": {
+                  "firstName": {
+                    "RDSRef": "",
+                    "title": "First name",
+                    "type": "string"
+                  },
+                  "middleNames": {
+                    "title": "Middle name(s)",
+                    "type": "string"
+                  },
+                  "lastName": {
+                    "title": "Last name",
+                    "type": "string"
+                  }
+                }
               },
               "dateOfBirth": {
                 "title": "Date of birth",
                 "type": "string",
                 "format": "date"
               },
-              "emailAddress": {
+              "mobileNumber": {
+                "title": "Mobile number",
+                "type": "string"
+              },
+              "email": {
                 "title": "Email address",
                 "type": "string",
                 "format": "email"

package/src/schemas/title-deed.json

@@ -766,7 +766,13 @@
   },
   "type": "object",
   "properties": {
-    "OCSummaryData": { "$ref": "#/definitions/Q1OCSummaryDataType" },
-    "OCRegisterData": { "$ref": "#/definitions/Q1OCRegisterDataType" }
+    "OCSummaryData": {
+      "title": "Official Copy Summary Data",
+      "$ref": "#/definitions/Q1OCSummaryDataType"
+    },
+    "OCRegisterData": {
+      "title": "Official Copy Register Data",
+      "$ref": "#/definitions/Q1OCRegisterDataType"
+    }
   }
 }

package/src/tests/examplePropertyPack.json

@@ -4,10 +4,10 @@
   "propertyPack": {
     "sellers": [
       {
-        "firstName": "John",
-        "lastName": "Davies",
+        "name": { "firstName": "John", "lastName": "Davies" },
         "dateOfBirth": "1975-12-25",
-        "emailAddress": "john@theseller.com",
+        "mobileNumber": "07777 222333",
+        "email": "john@theseller.com",
         "address": { "address1": "10 Downend Park", "postcode": "BS7 9PU" }
       }
     ],
@@ -28,9 +28,11 @@
       "ownership": {
         "ownershipType": "Freehold"
       },
-      "parkingArrangements": {
-        "parkingArrangementsType": "Other",
-        "otherParkingType": "Garage and double width driveway",
+      "parking": {
+        "parkingArrangements": {
+          "parkingArrangementsType": "Other",
+          "otherParkingType": "Garage and double width driveway"
+        },
         "electricVehicleChargingPoint": { "yesNo": "No" }
       },
       "listingAndConservation": {
@@ -44,7 +46,9 @@
           "yesNo": "No"
         }
       },
-      "hasFlammableExternalWallSystem": "No",
+      "flammableExternalWallSystem": {
+        "hasFlammableExternalWallSystem": "No"
+      },
       "councilTax": {
         "councilTaxBand": "A",
         "councilTaxAffectingAlterations": {

package/src/tests/propertyPackSchema.test.js

@@ -4,7 +4,8 @@ const {
   propertyPackSchema,
   validator,
   getSubschema,
-  getSubschemaValidator
+  getSubschemaValidator,
+  getTitleAtPath
 } = require("../../index.js");
 const examplePropertyPack = require("./examplePropertyPack.json");
 
@@ -27,6 +28,16 @@ test("invalid sample is invalid", () => {
   expect(isValid).toBe(false);
 });
 
+test("sample with missing dependent required fields is invalid", () => {
+  const clonedExamplePropertyPack = JSON.parse(
+    JSON.stringify(examplePropertyPack)
+  );
+  clonedExamplePropertyPack.propertyPack.materialFacts.ownership.ownershipType =
+    "leashold";
+  const isValid = validator(clonedExamplePropertyPack);
+  expect(isValid).toBe(false);
+});
+
 test("correctly gets a subschema", () => {
   const subschema = getSubschema("/propertyPack/materialFacts/notices");
   expect(subschema.title).toBe("Notices which Affect the Property");
@@ -43,3 +54,56 @@ test("correctly gets a working subschema validator", () => {
   isValid = validator(data);
   expect(isValid).toBe(false);
 });
+
+test("correctly gets titles across schemas, arrays and non-existient title properties", () => {
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/materialFacts/ownership/ownershipType"
+    )
+  ).toBe("What type of ownership is the property?");
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/materialFacts/ownership/leaseholdDetails/lengthOfLeaseInYears"
+    )
+  ).toBe("Length of lease (years)");
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/materialFacts/ownership/managedFreeholdOrCommonhold/annualServiceCharge"
+    )
+  ).toBe(
+    "Amount of current annual service charge/estate rentcharge/maintenance contribution (£)"
+  );
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/materialFacts/invalidPath"
+    )
+  ).toBe(undefined);
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/titlesToBeSold/0/registerExtract"
+    )
+  ).toBe("Property Data Trust Framework HMLR Register Extract representation");
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
+    )
+  ).toBe("Property address");
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
+    )
+  ).toBe(undefined);
+  expect(
+    getTitleAtPath(
+      propertyPackSchema,
+      "/propertyPack/energyPerformanceCertificate/certificate/currentEnergyRating"
+    )
+  ).toBe("Current energy rating");
+});