@pdtf/schemas 0.5.13 → 0.6.0

package/index.js

@@ -2,7 +2,7 @@ const { dereference } = require("@jdw/jst");
 const Ajv = require("ajv");
 const addFormats = require("ajv-formats");
 
-const propertyPack = require("./src/schemas/property-pack.json");
+const pdtfTransaction = require("./src/schemas/pdtf-transaction.json");
 const baspiMaterialFacts = require("./src/schemas/baspi-a-material-facts.json");
 const baspiLegalInformation = require("./src/schemas/baspi-b-legal-information.json");
 const energyPerformanceCertificate = require("./src/schemas/energy-performance-certificate.json");
@@ -18,33 +18,41 @@ 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]);
+const transactionSchema = dereference(pdtfTransaction, (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);
 
-const validator = ajv.compile(propertyPackSchema);
+const validator = ajv.compile(transactionSchema);
 
 const getSubschema = (path) => {
   const pathArray = path.split("/").slice(1);
   if (pathArray.length < 1) {
-    return schema;
+    return transactionSchema;
   }
-  return pathArray.reduce((propertyPackSchema, pathElement) => {
-    return propertyPackSchema.properties[pathElement];
-  }, propertyPackSchema);
+  return pathArray.reduce((schema, pathElement) => {
+    if (schema.type === "array") return schema.items;
+    return schema.properties[pathElement];
+  }, transactionSchema);
 };
 
 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) => {
@@ -92,10 +100,10 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
 };
 
 module.exports = {
-  propertyPackSchema,
+  transactionSchema,
   validator,
   getSubschema,
   getSubschemaValidator,
   getTitleAtPath,
-  verifiedClaimsSchema
+  verifiedClaimsSchema,
 };

package/package.json

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

package/src/examples/exampleDocumentedVouch.json

@@ -31,7 +31,7 @@
     ]
   },
   "claims": {
-    "/propertyPack/materialFacts/propertyToBeSold/councilTax": {
+    "/propertyPack/materialFacts/councilTax": {
       "councilTaxBand": "D",
       "councilTaxAffectingAlterations": {
         "yesNo": "Yes",

package/src/examples/exampleElectronicRecord.json

@@ -5,17 +5,21 @@
     "evidence": [
       {
         "type": "electronic_record",
+        "verifier": {
+          "organization": "Property Pack Assembly Software Ltd"
+        },
         "record": {
           "source": {
-            "name": "Royal Mail Postcode Address File record via ideal-postcodes.co.uk"
+            "name": "Royal Mail Postcode Address File",
+            "rights": "(c) Royal Mail"
           },
-          "type": "paf"
+          "type": "postcode_address_file"
         }
       }
     ]
   },
   "claims": {
-    "/propertyPack/materialFacts/propertyToBeSold/address": {
+    "/propertyPack/materialFacts/address": {
       "address1": "3 The Hollys",
       "address2": "Birtley",
       "town": "CHESTER LE STREET",