@pdtf/schemas 2.0.0-3 → 2.0.0-31

package/index.js

@@ -45,25 +45,28 @@ 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");
-// const ta7Overlay = require("./src/schemas/v2/overlays/ta7.json");
-// const lpe1Overlay = require("./src/schemas/v2/overlays/lpe1.json");
-// const fme1Overlay = require("./src/schemas/v2/overlays/fme1.json");
-// const llc1Overlay = require("./src/schemas/v2/overlays/llc1.json");
-// const con29ROverlay = require("./src/schemas/v2/overlays/con29R.json");
-// const con29DWOverlay = require("./src/schemas/v2/overlays/con29DW.json");
-// const rdsOverlay = require("./src/schemas/v2/overlays/rds.json");
-// const oc1Overlay = require("./src/schemas/v2/overlays/oc1.json");
-
-const overlays = { baspiV4: baspiOverlay };
+const ta6Overlay = require("./src/schemas/v2/overlays/ta6.json");
+const ta7Overlay = require("./src/schemas/v2/overlays/ta7.json");
+const ta10Overlay = require("./src/schemas/v2/overlays/ta10.json");
+const lpe1Overlay = require("./src/schemas/v2/overlays/lpe1.json");
+const fme1Overlay = require("./src/schemas/v2/overlays/fme1.json");
+const llc1Overlay = require("./src/schemas/v2/overlays/llc1.json");
+const ntsOverlay = require("./src/schemas/v2/overlays/nts.json");
+const con29ROverlay = require("./src/schemas/v2/overlays/con29R.json");
+const con29DWOverlay = require("./src/schemas/v2/overlays/con29DW.json");
+const rdsOverlay = require("./src/schemas/v2/overlays/rds.json");
+const oc1Overlay = require("./src/schemas/v2/overlays/oc1.json");
+
+const overlaysMap = { baspiV4: baspiOverlay, ta6ed4: ta6Overlay, 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) => {
@@ -82,22 +85,25 @@ const combineMerge = (target, source, options) => {
 
 const getTransactionSchema = (
   schemaId = "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json",
-  overlay = "baspiV4"
+  overlays = ["baspiV4"]
 ) => {
   const sourceSchema = transactionSchemas[schemaId];
-  const overlaySchema = overlays[overlay];
-  if (!overlaySchema) return sourceSchema;
-  const mergedSchema = merge(overlaySchema, sourceSchema, {
-    arrayMerge: combineMerge,
+  if (!overlays || overlays.length < 1) return sourceSchema;
+  let mergedSchema = sourceSchema;
+  overlays.forEach((overlay) => {
+    const overlaySchema = overlaysMap[overlay] || {};
+    mergedSchema = merge(overlaySchema, mergedSchema, {
+      arrayMerge: combineMerge,
+    });
   });
   // console.log("mergedSchema", mergedSchema);
   return mergedSchema;
 };
 
-const getValidator = (schemaId, overlay = "baspiV4") => {
+const getValidator = (schemaId, overlays) => {
   let validator = ajv.getSchema(schemaId);
   if (!validator) {
-    const schema = getTransactionSchema(schemaId, overlay);
+    const schema = getTransactionSchema(schemaId, overlays);
     ajv.addSchema(schema, schemaId);
     validator = ajv.getSchema(schemaId);
   }
@@ -105,8 +111,8 @@ const getValidator = (schemaId, overlay = "baspiV4") => {
 };
 
 // common functions for v1 and v2
-const getSubschema = (path, schemaId, overlay) => {
-  const sourceSchema = getTransactionSchema(schemaId, overlay);
+const getSubschema = (path, schemaId, overlays) => {
+  const sourceSchema = getTransactionSchema(schemaId, overlays);
   const pathArray = path.split("/").slice(1);
   if (pathArray.length < 1) return sourceSchema;
   return pathArray.reduce((schema, pathElement) => {
@@ -128,19 +134,19 @@ const getSubschema = (path, schemaId, overlay) => {
   }, sourceSchema);
 };
 
-const isPathValid = (path, schemaId, overlay) => {
-  const schema = getTransactionSchema(schemaId, overlay);
+const isPathValid = (path, schemaId, overlays) => {
   try {
-    return getSubschema(path, schemaId, overlay) !== undefined;
+    return getSubschema(path, schemaId, overlays) !== undefined;
   } catch (err) {
     return false;
   }
 };
 
-const getSubschemaValidator = (path, schemaId, overlay) => {
-  const subSchema = getSubschema(path, schemaId, overlay);
-  // see if we can retrieve the schema by path
-  const cacheKey = `${path}-${schemaId}`;
+const getSubschemaValidator = (path, schemaId, overlays = ["baspiV4"]) => {
+  const subSchema = getSubschema(path, schemaId, overlays);
+  const overlayKey = (overlays || []).join(".");
+  // see if we can retrieve the schema by path, schemaId and overlays
+  const cacheKey = `${path}-${schemaId}-${overlayKey}`;
   let validator = ajv.getSchema(cacheKey);
   // retrieve whole schema by $id if available
   if (!validator && subSchema.$id) validator = ajv.getSchema(cacheKey);
@@ -195,7 +201,7 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
-const validateVerifiedClaims = (verifiedClaims) => {
+const validateVerifiedClaims = (verifiedClaims, schemaId, overlays) => {
   const validatorVClaims = ajv.compile(verifiedClaimsSchema);
 
   const validationErrorsArr = [];
@@ -213,11 +219,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, overlays);
       if (validPath) {
-        const subValidator = getSubschemaValidator(path);
+        const subValidator = getSubschemaValidator(path, schemaId, overlays);
         const isValid = subValidator(claim.claims[path]);
         if (!isValid) {
           validationErrorsArr.push(...subValidator.errors);
@@ -245,4 +250,16 @@ module.exports = {
   getTitleAtPath,
   verifiedClaimsSchema,
   validateVerifiedClaims,
+  baspiOverlay,
+  ta6Overlay,
+  ta7Overlay,
+  ta10Overlay,
+  lpe1Overlay,
+  fme1Overlay,
+  llc1Overlay,
+  ntsOverlay,
+  con29ROverlay,
+  con29DWOverlay,
+  rdsOverlay,
+  oc1Overlay,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "2.0.0-3",
+  "version": "2.0.0-31",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {
@@ -26,6 +26,7 @@
   "homepage": "https://github.com/Property-Data-Trust-Framework/schemas#readme",
   "dependencies": {
     "@jdw/jst": "^2.0.0-beta.15",
+    "@pdtf/schemas": "^2.0.0-30",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "deepmerge": "^4.3.1",

package/src/examples/v2/exampleTransaction.json

@@ -12,7 +12,21 @@
       "phone": "07777 222333",
       "email": "peter@theseller.com",
       "address": { "line1": "47 Park Road", "postcode": "AL3 5AF" },
-      "role": "Seller"
+      "role": "Seller",
+      "externalIds": { "MoveReady": "123434" }
+    },
+    {
+      "role": "Seller's Conveyancer",
+      "name": { "firstName": "Johnny", "lastName": "Law" },
+      "address": {
+        "line1": "123 Sweet St",
+        "line2": "Test building",
+        "town": "London",
+        "postcode": "SW1A 1AA"
+      },
+      "email": "johnny@suemme.co.uk",
+      "organisation": "Suemme and Profitt",
+      "organisationReference": "123456"
     }
   ],
   "propertyPack": {
@@ -34,23 +48,37 @@
             "titleNumber": "HD221222",
             "ownershipType": "Leasehold",
             "leaseholdInformation": {
+              "typeOfLeasehold": {
+                "leaseholdType": "Shared ownership",
+                "sharedOwnershipPercentage": 50,
+                "sharedOwnershipRent": 200,
+                "sharedOwnershipRentFrequency": "Monthly"
+              },
+              "leaseTerm": {
+                "startYearOfLease": 1900,
+                "lengthOfLeaseInYears": 999
+              },
               "contactDetails": {
                 "contacts": {
                   "landlord": {
-                    "nameOrOrganisation": "Fleesum Properties",
-                    "address": {
-                      "line1": "47 Park Road",
-                      "postcode": "AL3 5AF"
-                    },
-                    "emailAddress": "james@fleesum.com"
+                    "contact": {
+                      "nameOrOrganisation": "Fleesum Properties",
+                      "address": {
+                        "line1": "47 Park Road",
+                        "postcode": "AL3 5AF"
+                      },
+                      "emailAddress": "james@fleesum.com"
+                    }
                   },
                   "managingAgent": {
-                    "nameOrOrganisation": "Pricee Living",
-                    "address": {
-                      "line1": "Pricee House",
-                      "postcode": "AL3 5KK"
-                    },
-                    "emailAddress": "marcel@pricee.co.uk"
+                    "contact": {
+                      "nameOrOrganisation": "Pricee Living",
+                      "address": {
+                        "line1": "Pricee House",
+                        "postcode": "AL3 5KK"
+                      },
+                      "emailAddress": "marcel@pricee.co.uk"
+                    }
                   }
                 }
               },
@@ -77,20 +105,6 @@
                   "details": "There is sinking fund."
                 }
               },
-              "general": {
-                "typeOfLeasehold": {
-                  "leaseholdType": "Shared ownership",
-                  "sharedOwnershipPercentage": 50,
-                  "sharedOwnershipRent": 200,
-                  "sharedOwnershipRentFrequency": "Monthly"
-                },
-                "leaseTerm": {
-                  "startYearOfLease": 1900,
-                  "lengthOfLeaseInYears": 999
-                }
-              },
-
-              "largeAdditionalExpense": { "yesNo": "No" },
               "additionalFeesOnSale": 0
             }
           }
@@ -106,13 +120,18 @@
       },
       "listingAndConservation": {
         "isListed": {
-          "yesNo": "No"
+          "yesNo": "Yes",
+          "details": "Grade II listed",
+          "attachments": "To follow"
         },
         "isConservationArea": {
-          "yesNo": "No"
+          "yesNo": "Yes",
+          "details": "Harpenden Conservation Area",
+          "attachments": "To follow"
         },
         "hasTreePreservationOrder": {
-          "yesNo": "No"
+          "yesNo": "Yes",
+          "workCarriedOut": { "yesNo": "Yes", "consentsObtained": "Yes" }
         }
       },
       "typeOfConstruction": {
@@ -125,9 +144,15 @@
         }
       },
       "energyEfficiency": {
+        "certificateIsSupplied": "Attached",
         "certificate": {
           "certificateNumber": "12345",
           "currentEnergyRating": "A"
+        },
+        "greenDealLoan": {
+          "hasGreenDealLoan": {
+            "yesNo": "No"
+          }
         }
       },
       "councilTax": {
@@ -138,7 +163,12 @@
       },
       "disputesAndComplaints": {
         "hasDisputesAndComplaints": {
-          "yesNo": "No"
+          "yesNo": "Yes",
+          "details": "Neighbour's very annoying"
+        },
+        "leadingToDisputesAndComplaints": {
+          "yesNo": "Yes",
+          "details": "Neighbour's dog barking"
         }
       },
       "alterationsAndChanges": {
@@ -148,8 +178,8 @@
             "attachments": "Attached"
           },
           "planningPermission": {
-            "yesNo": "Yes",
-            "attachments": "Attached"
+            "yesNo": "Not required",
+            "details": "Permitted development rights applied"
           },
           "listedBuildingConsent": {
             "yesNo": "Not required",
@@ -159,9 +189,6 @@
             "yesNo": "Not required",
             "details": "No restriction"
           },
-          "unfinished": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "details": "Bedroom and ensuite shower room extension 2005"
         },
@@ -185,9 +212,6 @@
             "yesNo": "Not required",
             "details": "No restriction"
           },
-          "unfinished": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "details": "New front door added 2016",
           "yearCompleted": 2016
@@ -209,13 +233,13 @@
             "yesNo": "No",
             "details": "Added as part of initial build and deeds"
           },
-          "unfinished": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "details": "Conservatory added during house build in 1990 and exterior quality door separates the conservatory from the kitchen/dining room",
           "yearCompleted": 1990
         },
+        "worksUnfinished": {
+          "yesNo": "No"
+        },
         "planningPermissionBreaches": {
           "yesNo": "No"
         },
@@ -240,7 +264,9 @@
           "yesNo": "No"
         },
         "partyWallAct": {
-          "yesNo": "No"
+          "yesNo": "Yes",
+          "details": "Party wall agreement in place",
+          "attachments": "Attached"
         },
         "otherNotices": {
           "yesNo": "No"
@@ -272,53 +298,48 @@
         }
       },
       "waterAndDrainage": {
-        "mainsWater": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
-          },
-          "yesNo": "To be connected",
-          "dateToBeConnected": "2022-12-15",
-          "supplier": "Northumbria Water"
+        "water": {
+          "mainsWater": {
+            "yesNo": "To be connected",
+            "dateToBeConnected": "2022-12-15",
+            "supplier": "Northumbria Water"
+          }
         },
-        "mainsSurfaceWaterDrainage": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
+        "drainage": {
+          "mainsSurfaceWaterDrainage": {
+            "yesNo": "Yes"
           },
-          "yesNo": "Yes"
-        },
-        "mainsFoulDrainage": {
-          "yesNo": "No",
-          "sustainableDrainageSystem": { "yesNo": "No" },
-          "septicTank": {
-            "yesNo": "Yes",
-            "details": "Last emptied on 1 Jan 2022",
-            "dateReplaced": "2022-01-01",
-            "dateLastEmptied": "2022-01-01"
-          },
-          "cesspit": { "yesNo": "No" },
-          "sewerageTreatmentPlant": { "yesNo": "No" },
-          "otherConnectedProperties": { "yesNo": "No" },
-          "yearSystemInstalled": 1980,
-          "plantOnOtherLand": { "yesNo": "No" },
-          "plantRegistered": { "yesNo": "No" },
-          "plantDrainsIntoWaterway": {
-            "yesNo": "Yes",
-            "dischargeCompliesWithGBR": "Yes"
+          "mainsFoulDrainage": {
+            "yesNo": "No",
+            "sustainableDrainageSystem": { "yesNo": "No" },
+            "septicTank": {
+              "yesNo": "Yes",
+              "details": "Last emptied on 1 Jan 2022",
+              "dateReplaced": "2022-01-01",
+              "dateLastEmptied": "2022-01-01"
+            },
+            "cesspit": { "yesNo": "No" },
+            "sewerageTreatmentPlant": { "yesNo": "No" },
+            "otherConnectedProperties": { "yesNo": "No" },
+            "yearSystemInstalled": 1980,
+            "plantOnOtherLand": { "yesNo": "No" },
+            "plantRegistered": { "yesNo": "No" },
+            "plantDrainsIntoWaterway": {
+              "yesNo": "Yes",
+              "dischargeCompliesWithGBR": "Yes"
+            }
           }
+        },
+        "maintenanceAgreements": {
+          "yesNo": "No"
         }
       },
-      "utilities": {
-        "electricity": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
-          },
+      "connectedUtilities": {
+        "mainsElectricity": {
           "yesNo": "Yes",
           "supplier": "Octopus Energy"
         },
-        "gas": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
-          },
+        "mainsGas": {
           "yesNo": "Yes",
           "supplier": "Octopus Energy"
         },
@@ -329,23 +350,14 @@
           "yesNo": "No"
         },
         "telephone": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "supplier": "EE"
         },
         "cableSatelliteTV": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "supplier": "Sky"
         },
         "broadband": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "supplier": "EE"
         },
@@ -354,10 +366,8 @@
         },
         "otherServices": {
           "yesNo": "No"
-        }
-      },
-      "greenDealLoan": {
-        "hasGreenDealLoan": {
+        },
+        "maintenanceAgreements": {
           "yesNo": "No"
         }
       },
@@ -372,15 +382,25 @@
           "heatingInGoodWorkingOrder": {
             "yesNo": "Yes"
           },
-          "centralHeatingFuel": { "centralHeatingFuelType": "Gas" },
+          "centralHeatingFuel": {
+            "centralHeatingFuelType": "Other",
+            "otherCentralHeatingFuelType": "Ground-source Heat Pump"
+          },
           "centralHeatingInstalled": "2016-04-20",
-          "heatingLastServiced": "2021-03-26"
+          "heatingLastServicedDate": "2021-03-26",
+          "heatingLastServicedReport": "To follow"
         }
       },
       "insurance": {
         "isInsured": "Yes",
         "difficultiesObtainingInsurance": {
-          "yesNo": "No"
+          "abnormalRiseInPremiums": {
+            "yesNo": "Yes",
+            "details": "Very history"
+          },
+          "subjectToHighExcesses": { "yesNo": "No" },
+          "subjectToUnusualConditions": { "yesNo": "No" },
+          "refused": { "yesNo": "Yes", "details": "Much refuse" }
         },
         "insuranceClaims": {
           "yesNo": "No"
@@ -414,7 +434,10 @@
           "publicRightOfWay": {
             "yesNo": "No"
           },
-          "rightsOfLightOrSupport": {
+          "rightsOfLight": {
+            "yesNo": "No"
+          },
+          "rightsOfSupport": {
             "yesNo": "No"
           },
           "rightsCreatedThroughCustom": {
@@ -426,6 +449,10 @@
           "churchChancel": {
             "yesNo": "No"
           },
+          "rightsToTakeFromLand": {
+            "yesNo": "Yes",
+            "details": "Annual gold mining festival"
+          },
           "otherRights": {
             "yesNo": "No"
           }
@@ -437,21 +464,11 @@
           "hasBeenFlooded": "Yes",
           "details": "Minor basement flood",
           "typeOfFlooding": {
-            "groundWater": {
-              "yesNo": "No"
-            },
-            "sewer": {
-              "yesNo": "Yes"
-            },
-            "surfaceWater": {
-              "yesNo": "No"
-            },
-            "coastal": {
-              "yesNo": "No"
-            },
-            "river": {
-              "yesNo": "No"
-            },
+            "groundWater": "No",
+            "sewer": "Yes",
+            "surfaceWater": "No",
+            "coastal": "No",
+            "river": "No",
             "other": {
               "yesNo": "No"
             }
@@ -485,6 +502,9 @@
         },
         "otherMaterialIssue": {
           "yesNo": "No"
+        },
+        "otherCharges": {
+          "yesNo": "No"
         }
       },
       "consumerProtectionRegulationsDeclaration": {
@@ -511,14 +531,19 @@
       "legalBoundaries": {
         "ownership": {
           "areBoundariesUniform": "Yes",
-          "left": "Seller",
-          "right": "Seller",
-          "rear": "Next-door neighbour",
-          "front": "Next-door neighbour"
+          "uniformBoundaries": {
+            "left": "Neighbour",
+            "right": "Seller",
+            "rear": "Neighbour",
+            "front": "Not known"
+          }
         },
-        "haveBoundaryFeaturesMoved": { "yesNo": "No" },
-        "adjacentLandIncluded": { "yesNo": "No" },
-        "flyingFreehold": { "yesNo": "No" }
+        "haveBoundaryFeaturesMoved": {
+          "yesNo": "Yes",
+          "details": "Moved a bit to the lefts"
+        },
+        "adjacentLandIncluded": { "yesNo": "Yes", "details": "Some movements" },
+        "flyingFreehold": { "yesNo": "Yes", "details": "Some flying stuff" }
       },
       "servicesCrossing": {
         "pipesWiresCablesDrainsToProperty": { "yesNo": "No" },
@@ -528,10 +553,15 @@
       "energyAndMeters": {
         "testedByQualifiedElectrician": {
           "yesNo": "Yes",
-          "details": "2015",
+          "yearTested": 2015,
+          "attachments": "To follow"
+        },
+        "electricalWorkSince2005": {
+          "yesNo": "Yes",
+          "yearWorkCarriedOut": 2016,
+          "details": "New fuse box",
           "attachments": "To follow"
         },
-        "electricalWorkSince2005": { "yesNo": "No" },
         "solarPanels": { "hasSolarPanels": "No" }
       },
       "smartHomeSystems": { "hasSmartHomeSystems": "No" },
@@ -552,19 +582,25 @@
         }
       },
       "completionAndMoving": {
-        "willRemoveAllRubbish": true,
+        "sellerWillEnsure": {
+          "removeRubbish": true,
+          "replaceLightFittings": true,
+          "takeReasonableCare": true,
+          "leaveKeys": true
+        },
         "otherPropertyInChain": { "yesNo": "No" },
-        "moveRestrictionDates": { "yesNo": "No" },
-        "digitalPropertyLogbook": { "yesNo": "No" }
+        "moveRestrictionDates": {
+          "yesNo": "Yes",
+          "details": "On holiday 1-15 Aug 23"
+        },
+        "digitalPropertyLogbook": { "yesNo": "No" },
+        "sufficientToRepayAllMortgages": { "yesNo": "Yes" }
       },
       "confirmationOfAccuracyByOwners": {
         "confirmWillProvideAdditionalDocumentation": true,
         "confirmInformationIsAccurate": true
       }
     },
-    "energyPerformanceCertificate": {
-      "certificate": { "currentEnergyRating": "B" }
-    },
     "titlesToBeSold": [
       {
         "titleNumber": "HD221222",