@pdtf/schemas 2.0.0-0 → 2.0.0-10

package/index.js

@@ -45,7 +45,7 @@ const validator = ajv.compile(transactionSchema);
 
 // v2, via accessor functions and overlays
 const combinedSchema = require("./src/schemas/v2/combined.json");
-const coreSchema = require("./src/schemas/v2/core.json");
+const v2CoreSchema = require("./src/schemas/v2/pdtf-transaction.json");
 
 const baspiOverlay = require("./src/schemas/v2/overlays/baspi.json");
 // const ta6Overlay = require("./src/schemas/v2/overlays/ta6.json");
@@ -58,12 +58,13 @@ const baspiOverlay = require("./src/schemas/v2/overlays/baspi.json");
 // const rdsOverlay = require("./src/schemas/v2/overlays/rds.json");
 // const oc1Overlay = require("./src/schemas/v2/overlays/oc1.json");
 
-const overlays = { baspiV4: baspiOverlay };
+const overlays = { baspiV4: baspiOverlay, null: {} };
 
 const transactionSchemas = {
   "https://trust.propdata.org.uk/schemas/v1/pdtf-transaction.json":
     transactionSchema,
-  "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json": coreSchema,
+  "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json":
+    v2CoreSchema,
 };
 
 const combineMerge = (target, source, options) => {
@@ -105,7 +106,8 @@ const getValidator = (schemaId, overlay = "baspiV4") => {
 };
 
 // common functions for v1 and v2
-const getSubschema = (path, sourceSchema = transactionSchema) => {
+const getSubschema = (path, schemaId, overlay) => {
+  const sourceSchema = getTransactionSchema(schemaId, overlay);
   const pathArray = path.split("/").slice(1);
   if (pathArray.length < 1) return sourceSchema;
   return pathArray.reduce((schema, pathElement) => {
@@ -127,23 +129,25 @@ const getSubschema = (path, sourceSchema = transactionSchema) => {
   }, sourceSchema);
 };
 
-const isPathValid = (path, schema = transactionSchema) => {
+const isPathValid = (path, schemaId, overlay) => {
+  const schema = getTransactionSchema(schemaId, overlay);
   try {
-    return getSubschema(path, schema) !== undefined;
+    return getSubschema(path, schemaId, overlay) !== undefined;
   } catch (err) {
     return false;
   }
 };
 
-const getSubschemaValidator = (path, schema = transactionSchema) => {
-  const subSchema = getSubschema(path, schema);
-  // see if we can retrieve the schema by path
-  let validator = ajv.getSchema(path);
+const getSubschemaValidator = (path, schemaId, overlay) => {
+  const subSchema = getSubschema(path, schemaId, overlay);
+  // see if we can retrieve the schema by path, schemaId and overlay
+  const cacheKey = `${path}-${schemaId}-${overlay}`;
+  let validator = ajv.getSchema(cacheKey);
   // retrieve whole schema by $id if available
-  if (!validator && subSchema.$id) validator = ajv.getSchema(subSchema.$id);
+  if (!validator && subSchema.$id) validator = ajv.getSchema(cacheKey);
   if (!validator) {
-    ajv.addSchema(subSchema, path);
-    validator = ajv.getSchema(path);
+    ajv.addSchema(subSchema, cacheKey);
+    validator = ajv.getSchema(cacheKey);
   }
   return validator;
 };
@@ -192,7 +196,7 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
-const validateVerifiedClaims = (verifiedClaims) => {
+const validateVerifiedClaims = (verifiedClaims, schemaId, overlay) => {
   const validatorVClaims = ajv.compile(verifiedClaimsSchema);
 
   const validationErrorsArr = [];
@@ -210,11 +214,10 @@ const validateVerifiedClaims = (verifiedClaims) => {
 
   verifiedClaimsArray.forEach((claim) => {
     const paths = Object.keys(claim.claims);
-
     for (const path of paths) {
-      const validPath = isPathValid(path);
+      const validPath = isPathValid(path, schemaId, overlay);
       if (validPath) {
-        const subValidator = getSubschemaValidator(path);
+        const subValidator = getSubschemaValidator(path, schemaId, overlay);
         const isValid = subValidator(claim.claims[path]);
         if (!isValid) {
           validationErrorsArr.push(...subValidator.errors);

package/package.json

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

package/src/examples/v2/exampleTransaction.json

@@ -21,11 +21,10 @@
       "address": {
         "line1": "47 Park Road",
         "line2": "",
+        "line3": "",
         "town": "HARPENDEN",
-        "county": "Herts",
         "postcode": "AL3 5AF"
       },
-
       "delayFactors": {
         "hasDelayFactors": { "yesNo": "No" }
       },
@@ -34,21 +33,66 @@
           {
             "titleNumber": "HD221222",
             "ownershipType": "Leasehold",
-            "sharedOwnership": { "isSharedOwnership": "No" },
-            "startYearOfLease": 1900,
-            "lengthOfLeaseInYears": 999,
-            "currentGroundRent": 1750,
-            "rentIncrease": { "yesNo": "No" },
-            "annualServiceCharge": 250.23,
-            "largeAdditionalExpense": { "yesNo": "No" },
-            "additionalFeesOnSale": 0,
-            "freeholderContactDetails": {
-              "nameOrOrganisation": "Fleesum Properties"
-            },
-            "managingAgentContactDetails": {
-              "nameOrOrganisation": "Pricee Living"
-            },
-            "managementCompanyDirectorRequirement": { "yesNo": "No" }
+            "leaseholdInformation": {
+              "typeOfLeasehold": {
+                "leaseholdType": "Shared ownership",
+                "sharedOwnershipPercentage": 50,
+                "sharedOwnershipRent": 200,
+                "sharedOwnershipRentFrequency": "Monthly"
+              },
+              "leaseTerm": {
+                "startYearOfLease": 1900,
+                "lengthOfLeaseInYears": 999
+              },
+              "contactDetails": {
+                "contacts": {
+                  "landlord": {
+                    "contact": {
+                      "nameOrOrganisation": "Fleesum Properties",
+                      "address": {
+                        "line1": "47 Park Road",
+                        "postcode": "AL3 5AF"
+                      },
+                      "emailAddress": "james@fleesum.com"
+                    }
+                  },
+                  "managingAgent": {
+                    "contact": {
+                      "nameOrOrganisation": "Pricee Living",
+                      "address": {
+                        "line1": "Pricee House",
+                        "postcode": "AL3 5KK"
+                      },
+                      "emailAddress": "marcel@pricee.co.uk"
+                    }
+                  }
+                }
+              },
+              "groundRent": {
+                "isGroundRentPayable": "Yes",
+                "annualGroundRent": 1750,
+                "rentSubjectToIncrease": {
+                  "yesNo": "Yes",
+                  "rentReviewFrequency": "Annually",
+                  "rentIncreaseCalculated": "RPI"
+                }
+              },
+              "transferAndRegistration": {
+                "requirementsToBeMemberOfManagementCompany": {
+                  "yesNoNotApplicable": "No"
+                }
+              },
+              "serviceCharge": {
+                "sellerContributesToServiceCharge": "Yes",
+                "annualServiceCharge": 250.23,
+                "largeAdditionalExpense": { "yesNo": "No" },
+                "reserveFund": {
+                  "yesNo": "Yes",
+                  "details": "There is sinking fund."
+                }
+              },
+              "additionalFeesOnSale": 0
+            }
           }
         ]
       },
@@ -75,12 +119,15 @@
         "isStandardForm": {
           "yesNo": "Yes"
         },
-        "hasFlammableExternalWallSystem": { "yesNo": "No" }
+        "buildingSafetyRemediation": { "yesNo": "No" },
+        "sprayFoamInsulation": {
+          "hasSprayFoamInstalled": "No"
+        }
       },
       "energyEfficiency": {
-        "energyEfficiencyRating": "A",
-        "hasSprayFoamInstalled": {
-          "yesNo": "No"
+        "certificate": {
+          "certificateNumber": "12345",
+          "currentEnergyRating": "A"
         }
       },
       "councilTax": {
@@ -260,15 +307,15 @@
           }
         }
       },
-      "utilities": {
-        "electricity": {
+      "connectedUtilities": {
+        "mainsElectricity": {
           "maintenanceAgreements": {
             "yesNo": "No"
           },
           "yesNo": "Yes",
           "supplier": "Octopus Energy"
         },
-        "gas": {
+        "mainsGas": {
           "maintenanceAgreements": {
             "yesNo": "No"
           },
@@ -384,7 +431,7 @@
           }
         }
       },
-      "otherIssues": {
+      "environmentalIssues": {
         "flooding": {
           "floodRiskReport": { "yesNo": "No" },
           "hasBeenFlooded": "Yes",
@@ -416,7 +463,9 @@
         },
         "otherEnvironmental": {
           "yesNo": "No"
-        },
+        }
+      },
+      "otherIssues": {
         "excessiveNoise": {
           "yesNo": "No"
         },
@@ -449,6 +498,12 @@
             "ownerType": "Private individual",
             "firstName": "Peter",
             "lastName": "Hetherington-Smythe"
+          },
+          {
+            "ownerType": "Private individual",
+            "firstName": "Clarissa",
+            "middleNames": "Jane",
+            "lastName": "Hetherington-Smythe"
           }
         ]
       },
@@ -507,9 +562,6 @@
         "confirmInformationIsAccurate": true
       }
     },
-    "energyPerformanceCertificate": {
-      "certificate": { "currentEnergyRating": "B" }
-    },
     "titlesToBeSold": [
       {
         "titleNumber": "HD221222",