@pdtf/schemas 0.5.6 → 0.5.9

package/src/schemas/energy-performance-certificate.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate-0.1.0.json",
+  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json",
   "type": "object",
   "title": "Energy Performance Certificate and Recommendations Schema, supporting data retrieved from https://epc.opendatacommunities.org ",
   "description": "Mirrors the Domestic EPC Glossary at https://epc.opendatacommunities.org/docs/guidance#glossary",
@@ -12,106 +12,109 @@
         "address1": { "type": "string" },
         "address2": { "type": "string" },
         "address3": { "type": "string" },
-        "building-reference-number": { "type": "string" },
-        "built-form": { "type": "string" },
-        "co2-emiss-curr-per-floor-area": { "type": "number" },
-        "co2-emissions-current": { "type": "number" },
-        "co2-emissions-potential": { "type": "number" },
-        "constituency-label": { "type": "string" },
+        "buildingReferenceNumber": { "type": "string" },
+        "builtForm": { "type": "string" },
+        "co2EmissCurrPerFloorArea": { "type": "number" },
+        "co2EmissionsCurrent": { "type": "number" },
+        "co2EmissionsPotential": { "type": "number" },
+        "constituencyLabel": { "type": "string" },
         "constituency": { "type": "string" },
-        "construction-age-band": { "type": "string" },
+        "constructionAgeBand": { "type": "string" },
         "county": { "type": "string" },
-        "current-energy-efficiency": { "type": "integer" },
-        "current-energy-rating": { "type": "string" },
-        "energy-consumption-current": { "type": "integer" },
-        "energy-consumption-potential": { "type": "integer" },
-        "energy-tariff": { "type": "string" },
-        "environment-impact-current": { "type": "integer" },
-        "environment-impact-potential": { "type": "integer" },
-        "extension-count": { "type": "integer" },
-        "fixed-lighting-outlets-count": { "type": "integer" },
-        "flat-storey-count": { "type": "integer" },
-        "flat-top-storey": { "type": "string" },
-        "floor-description": { "type": "string" },
-        "floor-energy-eff": { "type": "string" },
-        "floor-env-eff": { "type": "string" },
-        "floor-height": { "type": "number" },
-        "floor-level": { "type": "string" },
-        "glazed-area": { "type": "string" },
-        "glazed-type": { "type": "string" },
-        "heat-loss-corridor": { "type": "string" },
-        "heating-cost-current": { "type": "integer" },
-        "heating-cost-potential": { "type": "integer" },
-        "hot-water-cost-current": { "type": "integer" },
-        "hot-water-cost-potential": { "type": "integer" },
-        "hot-water-energy-eff": { "type": "string" },
-        "hot-water-env-eff": { "type": "string" },
-        "hotwater-description": { "type": "string" },
-        "inspection-date": { "type": "string", "format": "date" },
-        "lighting-cost-current": { "type": "integer" },
-        "lighting-cost-potential": { "type": "integer" },
-        "lighting-description": { "type": "string" },
-        "lighting-energy-eff": { "type": "string" },
-        "lighting-env-eff": { "type": "string" },
-        "lmk-key": { "type": "string" },
-        "local-authority-label": { "type": "string" },
-        "local-authority": { "type": "string" },
-        "lodgement-date": { "type": "string", "format": "date" },
-        "lodgement-datetime": { "type": "string", "format": "date-time" },
-        "low-energy-fixed-light-count": { "type": "integer" },
-        "low-energy-lighting": { "type": "integer" },
-        "main-fuel": { "type": "string" },
-        "main-heating-controls": { "type": "string" },
-        "mainheat-description": { "type": "string" },
-        "mainheat-energy-eff": { "type": "string" },
-        "mainheat-env-eff": { "type": "string" },
-        "mainheatc-energy-eff": { "type": "string" },
-        "mainheatc-env-eff": { "type": "string" },
-        "mainheatcont-description": { "type": "string" },
-        "mains-gas-flag": { "type": "string" },
-        "mechanical-ventilation": { "type": "string" },
-        "multi-glaze-proportion": { "type": "integer" },
-        "number-habitable-rooms": { "type": "integer" },
-        "number-heated-rooms": { "type": "integer" },
-        "number-open-fireplaces": { "type": "integer" },
-        "photo-supply": { "type": "integer" },
+        "currentEnergyEfficiency": { "type": "integer" },
+        "currentEnergyRating": { "type": "string" },
+        "energyConsumptionCurrent": { "type": "integer" },
+        "energyConsumptionPotential": { "type": "integer" },
+        "energyTariff": { "type": "string" },
+        "environmentImpactCurrent": { "type": "integer" },
+        "environmentImpactPotential": { "type": "integer" },
+        "extensionCount": { "type": "integer" },
+        "fixedLightingOutletsCount": { "type": "integer" },
+        "flatStoreyCount": { "type": "integer" },
+        "flatTopStorey": { "type": "string" },
+        "floorDescription": { "type": "string" },
+        "floorEnergyEff": { "type": "string" },
+        "floorEnvEff": { "type": "string" },
+        "floorHeight": { "type": "number" },
+        "floorLevel": { "type": "string" },
+        "glazedArea": { "type": "string" },
+        "glazedType": { "type": "string" },
+        "heatLossCorridor": { "type": "string" },
+        "heatingCostCurrent": { "type": "integer" },
+        "heatingCostPotential": { "type": "integer" },
+        "hotWaterCostCurrent": { "type": "integer" },
+        "hotWaterCostPotential": { "type": "integer" },
+        "hotWaterEnergyEff": { "type": "string" },
+        "hotWaterEnvEff": { "type": "string" },
+        "hotwaterDescription": { "type": "string" },
+        "inspectionDate": { "type": "string", "format": "date" },
+        "lightingCostCurrent": { "type": "integer" },
+        "lightingCostPotential": { "type": "integer" },
+        "lightingDescription": { "type": "string" },
+        "lightingEnergyEff": { "type": "string" },
+        "lightingEnvEff": { "type": "string" },
+        "lmkKey": { "type": "string" },
+        "localAuthorityLabel": { "type": "string" },
+        "localAuthority": { "type": "string" },
+        "lodgementDate": { "type": "string", "format": "date" },
+        "lodgementDatetime": { "type": "string", "format": "date-time" },
+        "lowEnergyFixedLightCount": { "type": "integer" },
+        "lowEnergyLighting": { "type": "integer" },
+        "mainFuel": { "type": "string" },
+        "mainHeatingControls": { "type": "string" },
+        "mainheatDescription": { "type": "string" },
+        "mainheatEnergyEff": { "type": "string" },
+        "mainheatEnvEff": { "type": "string" },
+        "mainheatcEnergyEff": { "type": "string" },
+        "mainheatcEnvEff": { "type": "string" },
+        "mainheatcontDescription": { "type": "string" },
+        "mainsGasFlag": { "type": "string" },
+        "mechanicalVentilation": { "type": "string" },
+        "multiGlazeProportion": { "type": "integer" },
+        "numberHabitableRooms": { "type": "integer" },
+        "numberHeatedRooms": { "type": "integer" },
+        "numberOpenFireplaces": { "type": "integer" },
+        "photoSupply": { "type": "integer" },
         "postcode": { "type": "string" },
         "posttown": { "type": "string" },
-        "potential-energy-efficiency": { "type": "integer" },
-        "potential-energy-rating": { "type": "string" },
-        "property-type": { "type": "string" },
-        "roof-description": { "type": "string" },
-        "roof-energy-eff": { "type": "string" },
-        "roof-env-eff": { "type": "string" },
-        "secondheat-description": { "type": "string" },
-        "sheating-energy-eff": { "type": "string" },
-        "sheating-env-eff": { "type": "string" },
-        "solar-water-heating-flag": { "type": "string" },
+        "potentialEnergyEfficiency": { "type": "integer" },
+        "potentialEnergyRating": { "type": "string" },
+        "propertyType": { "type": "string" },
+        "roofDescription": { "type": "string" },
+        "roofEnergyEff": { "type": "string" },
+        "roofEnvEff": { "type": "string" },
+        "secondheatDescription": { "type": "string" },
+        "sheatingEnergyEff": { "type": "string" },
+        "sheatingEnvEff": { "type": "string" },
+        "solarWaterHeatingFlag": { "type": "string" },
         "tenure": { "type": "string" },
-        "total-floor-area": { "type": "number" },
-        "transaction-type": { "type": "string" },
-        "unheated-corridor-length": { "type": "number" },
-        "uprn-source": { "type": "string" },
+        "totalFloorArea": { "type": "number" },
+        "transactionType": { "type": "string" },
+        "unheatedCorridorLength": { "type": "number" },
+        "uprnSource": { "type": "string" },
         "uprn": { "type": "integer" },
-        "walls-description": { "type": "string" },
-        "walls-energy-eff": { "type": "string" },
-        "walls-env-eff": { "type": "string" },
-        "wind-turbine-count": { "type": "integer" },
-        "windows-description": { "type": "string" },
-        "windows-energy-eff": { "type": "string" },
-        "windows-env-eff": { "type": "string" }
+        "wallsDescription": { "type": "string" },
+        "wallsEnergyEff": { "type": "string" },
+        "wallsEnvEff": { "type": "string" },
+        "windTurbineCount": { "type": "integer" },
+        "windowsDescription": { "type": "string" },
+        "windowsEnergyEff": { "type": "string" },
+        "windowsEnvEff": { "type": "string" }
       }
     },
     "recommendations": {
-      "type": "object",
-      "properties": {
-        "lmk-key": { "type": "string" },
-        "improvement-item": { "type": "integer" },
-        "indicative-cost": { "type": "string" },
-        "improvement-summary-text": { "type": "string" },
-        "improvement-descr-text": { "type": "string" },
-        "improvement-id": { "type": "string" },
-        "improvement-id-text": { "type": "string" }
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "lmkKey": { "type": "string" },
+          "improvementItem": { "type": "integer" },
+          "indicativeCost": { "type": "string" },
+          "improvementSummaryText": { "type": "string" },
+          "improvementDescrText": { "type": "string" },
+          "improvementId": { "type": "string" },
+          "improvementIdText": { "type": "string" }
+        }
       }
     }
   }

package/src/schemas/pdtf-claim.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-claim-0.1.0.json",
+  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-claim.json",
   "type": "object",
   "title": "Property Data Trust Framework Claim",
   "description": "PDTF verified claims are implemented in accordance with the OpenID Connect Verified Claims model, within which the actual claims object should conform to this schema to ensure the necessary metadata is attached",

package/src/schemas/property-pack.json

@@ -3,7 +3,7 @@
   "$id": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
   "type": "object",
   "title": "Property Data Trust Framework Schema",
-  "description": "A schema defining the PDTF data structure, supporting mapping to BASPI, Law Society and RICS Data Schema elements.",
+  "description": "A schema defining the PDTF Property Pack data structure, supporting mapping to BASPI, Law Society and RICS Data Schema elements.",
   "required": ["$schema", "uprn", "propertyPack"],
   "properties": {
     "$schema": {
@@ -18,7 +18,70 @@
     "propertyPack": {
       "title": "Property Pack",
       "type": "object",
+      "required": ["sellers"],
       "properties": {
+        "sellers": {
+          "RDSRef": "",
+          "title": "About the sellers",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "title": "Seller information",
+            "required": [
+              "name",
+              "dateOfBirth",
+              "mobileNumber",
+              "email",
+              "address"
+            ],
+            "properties": {
+              "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"
+              },
+              "mobileNumber": {
+                "title": "Mobile number",
+                "type": "string"
+              },
+              "email": {
+                "title": "Email address",
+                "type": "string",
+                "format": "email"
+              },
+              "address": {
+                "title": "Address",
+                "$ref": "#/$defs/address"
+              },
+              "amlCheckResult": {
+                "title": "AML check result",
+                "type": "string",
+                "enum": ["clear", "consider"]
+              }
+            }
+          }
+        },
         "materialFacts": {
           "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json"
         },
@@ -95,5 +158,35 @@
         }
       }
     }
+  },
+  "$defs": {
+    "address": {
+      "type": "object",
+      "properties": {
+        "address1": {
+          "title": "Address 1",
+          "type": "string",
+          "minLength": 1
+        },
+        "address2": {
+          "title": "Address 2",
+          "type": "string"
+        },
+        "town": {
+          "title": "Town",
+          "type": "string"
+        },
+        "county": {
+          "title": "County",
+          "type": "string"
+        },
+        "postcode": {
+          "title": "Postcode",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": ["address1", "postcode"]
+    }
   }
 }

package/src/schemas/title-deed.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed-0.1.0.json",
+  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json",
   "title": "Property Data Trust Framework HMLR Register Extract representation",
-  "description": "A schema mirroring the V2_1 XML version of the HMLR Register Extract web service. Versioning is using SchemaVer",
+  "description": "A schema mirroring the V2_1 XML version of the HMLR Register Extract web service.",
   "definitions": {
     "BinaryObjectType": {
       "type": "object",
@@ -766,8 +766,13 @@
   },
   "type": "object",
   "properties": {
-    "Attachment": { "$ref": "#/definitions/Q1AttachmentType" },
-    "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

@@ -2,50 +2,57 @@
   "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
   "uprn": 100000059583,
   "propertyPack": {
+    "sellers": [
+      {
+        "name": { "firstName": "John", "lastName": "Davies" },
+        "dateOfBirth": "1975-12-25",
+        "mobileNumber": "07777 222333",
+        "email": "john@theseller.com",
+        "address": { "address1": "10 Downend Park", "postcode": "BS7 9PU" }
+      }
+    ],
     "materialFacts": {
-      "propertyToBeSold": {
-        "address": {
-          "address1": "10 Downend Park",
-          "address2": "",
-          "town": "BRISTOLS",
-          "county": "Avon",
-          "postcode": "BS7 9PU"
-        },
-        "energyEfficiency": {
-          "energyEfficiencyRating": "A"
-        },
-        "delayFactors": {
-          "yesNo": "No"
-        },
-        "ownership": {
-          "ownershipType": "Freehold"
-        },
+      "address": {
+        "address1": "10 Downend Park",
+        "address2": "",
+        "town": "BRISTOLS",
+        "county": "Avon",
+        "postcode": "BS7 9PU"
+      },
+      "energyEfficiency": {
+        "energyEfficiencyRating": "A"
+      },
+      "delayFactors": {
+        "yesNo": "No"
+      },
+      "ownership": {
+        "ownershipType": "Freehold"
+      },
+      "parking": {
         "parkingArrangements": {
           "parkingArrangementsType": "Other",
           "otherParkingType": "Garage and double width driveway"
         },
-        "listingAndConservation": {
-          "isListed": {
-            "yesNo": "No"
-          },
-          "isConservationArea": {
-            "yesNo": "No"
-          },
-          "hasTreePreservationOrder": {
-            "yesNo": "No"
-          }
+        "electricVehicleChargingPoint": { "yesNo": "No" }
+      },
+      "listingAndConservation": {
+        "isListed": {
+          "yesNo": "No"
         },
-        "typeOfConstruction": {
-          "isStandardForm": {
-            "yesNo": "Yes"
-          },
-          "hasFlammableExternalWallSystem": "No"
+        "isConservationArea": {
+          "yesNo": "No"
         },
-        "councilTax": {
-          "councilTaxBand": "A",
-          "councilTaxAffectingAlterations": {
-            "yesNo": "No"
-          }
+        "hasTreePreservationOrder": {
+          "yesNo": "No"
+        }
+      },
+      "flammableExternalWallSystem": {
+        "hasFlammableExternalWallSystem": "No"
+      },
+      "councilTax": {
+        "councilTaxBand": "A",
+        "councilTaxAffectingAlterations": {
+          "yesNo": "No"
         }
       },
       "disputesAndComplaints": {
@@ -357,7 +364,9 @@
           "yesNo": "No"
         }
       },
-      "consumerProtectionRegulationsDeclaration": true
+      "consumerProtectionRegulationsDeclaration": {
+        "consumerProtectionRegulationsResponse": true
+      }
     }
   }
 }

package/src/tests/propertyPackSchema.test.js

@@ -1,12 +1,13 @@
-import jp from "jsonpointer";
+const jp = require("jsonpointer");
 
-import {
+const {
   propertyPackSchema,
   validator,
   getSubschema,
-  getSubschemaValidator
-} from "../../index.js";
-import examplePropertyPack from "./examplePropertyPack.json";
+  getSubschemaValidator,
+  getTitleAtPath
+} = require("../../index.js");
+const examplePropertyPack = require("./examplePropertyPack.json");
 
 test("exports a property pack schema", () => {
   expect(propertyPackSchema).not.toBeNull();
@@ -14,6 +15,7 @@ test("exports a property pack schema", () => {
 
 test("sample is valid", () => {
   const isValid = validator(examplePropertyPack);
+  console.log(validator.errors);
   expect(isValid).toBe(true);
 });
 
@@ -26,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");
@@ -42,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");
+});

package/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [["@babel/preset-env", { targets: { node: "current" } }]]
-};