@pdtf/schemas 0.5.13 → 0.5.14

package/index.js

@@ -18,7 +18,7 @@ const subSchemas = {
   "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json":
     energyPerformanceCertificate,
   "https://geojson.org/schema/GeoJSON.json": geoJson,
-  "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json": titleDeed
+  "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json": titleDeed,
 };
 
 const propertyPackSchema = dereference(propertyPack, (id) => subSchemas[id]);
@@ -26,7 +26,7 @@ const propertyPackSchema = dereference(propertyPack, (id) => subSchemas[id]);
 const ajv = new Ajv({
   allErrors: true,
   // schema contains additional baspiRef and RDSRef metadata which is not strictly valid
-  strictSchema: false
+  strictSchema: false,
 });
 // Adds date formats among other types to the validator.
 addFormats(ajv);
@@ -36,7 +36,7 @@ const validator = ajv.compile(propertyPackSchema);
 const getSubschema = (path) => {
   const pathArray = path.split("/").slice(1);
   if (pathArray.length < 1) {
-    return schema;
+    return propertyPackSchema;
   }
   return pathArray.reduce((propertyPackSchema, pathElement) => {
     return propertyPackSchema.properties[pathElement];
@@ -44,7 +44,14 @@ const getSubschema = (path) => {
 };
 
 const getSubschemaValidator = (path) => {
-  return ajv.getSchema(path) || ajv.compile(getSubschema(path));
+  const subSchema = getSubschema(path);
+  let validator = ajv.getSchema(path);
+  if (!validator && subSchema.$id) validator = ajv.getSchema(subSchema.$id);
+  if (!validator) {
+    ajv.addSchema(subSchema, path);
+    validator = ajv.getSchema(path);
+  }
+  return validator;
 };
 
 const getTitleAtPath = (schema, path, rootPath = path) => {
@@ -97,5 +104,5 @@ module.exports = {
   getSubschema,
   getSubschemaValidator,
   getTitleAtPath,
-  verifiedClaimsSchema
+  verifiedClaimsSchema,
 };

package/package.json

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

package/src/examples/exampleElectronicRecord.json

@@ -9,13 +9,13 @@
           "source": {
             "name": "Royal Mail Postcode Address File record via ideal-postcodes.co.uk"
           },
-          "type": "paf"
+          "type": "postcode_address_file"
         }
       }
     ]
   },
   "claims": {
-    "/propertyPack/materialFacts/propertyToBeSold/address": {
+    "/propertyPack/materialFacts/address": {
       "address1": "3 The Hollys",
       "address2": "Birtley",
       "town": "CHESTER LE STREET",

package/src/examples/examplePropertyPack.json

@@ -25,9 +25,7 @@
         "energyEfficiencyRating": "A"
       },
       "delayFactors": {
-        "hasDelayFactors": {
-          "yesNo": "No"
-        }
+        "hasDelayFactors": { "yesNo": "No" }
       },
       "ownership": {
         "ownershipType": "Freehold"
@@ -371,6 +369,9 @@
       "consumerProtectionRegulationsDeclaration": {
         "consumerProtectionRegulationsResponse": true
       }
+    },
+    "energyPerformanceCertificate": {
+      "certificate": { "currentEnergyRating": "B" }
     }
   }
 }

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

@@ -4,10 +4,13 @@
   "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",
+  "required": ["certificate"],
   "properties": {
     "certificate": {
       "type": "object",
+      "required": ["currentEnergyRating"],
       "properties": {
+        "certificateNumber": { "type": "string" },
         "address": { "type": "string" },
         "address1": { "type": "string" },
         "address2": { "type": "string" },

package/src/tests/propertyPackSchema.test.js

@@ -5,7 +5,7 @@ const {
   validator,
   getSubschema,
   getSubschemaValidator,
-  getTitleAtPath
+  getTitleAtPath,
 } = require("../../index.js");
 const examplePropertyPack = require("../examples/examplePropertyPack.json");
 
@@ -37,11 +37,27 @@ test("sample with missing dependent required fields is invalid", () => {
   expect(isValid).toBe(false);
 });
 
+test("correctly gets a top level subschema", () => {
+  const subschema = getSubschema("/propertyPack");
+  expect(subschema.title).toBe("Property Pack");
+});
+
 test("correctly gets a subschema", () => {
   const subschema = getSubschema("/propertyPack/materialFacts/notices");
   expect(subschema.title).toBe("Notices which Affect the Property");
 });
 
+test("correctly gets a subschema validator which is already cached", () => {
+  const validator = getSubschemaValidator(
+    "/propertyPack/energyPerformanceCertificate"
+  );
+  expect(validator).not.toBeNull();
+  const anotherValidator = getSubschemaValidator(
+    "/propertyPack/energyPerformanceCertificate"
+  );
+  expect(anotherValidator).not.toBeNull();
+});
+
 test("correctly gets a working subschema validator", () => {
   const path = "/propertyPack/materialFacts/notices";
   const validator = getSubschemaValidator(path);