@pdtf/schemas 3.0.0-2 → 3.0.0-21

package/index.js

@@ -71,16 +71,23 @@ const combineMerge = (target, source, options) => {
   return destination;
 };
 
+const mergeEnums = (target, source) => source;
+
 const getTransactionSchema = (
   schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
-  overlays = ["baspiV4"]
+  overlays // = ["baspiV4"]
 ) => {
   const sourceSchema = transactionSchemas[schemaId];
   if (!overlays || overlays.length < 1) return sourceSchema;
   let mergedSchema = sourceSchema;
   overlays.forEach((overlay) => {
     const overlaySchema = overlaysMap[schemaId][overlay] || {};
-    mergedSchema = merge(overlaySchema, mergedSchema, {
+    mergedSchema = merge(mergedSchema, overlaySchema, {
+      customMerge: (key) => {
+        if (key === "enum") {
+          return mergeEnums;
+        }
+      },
       arrayMerge: combineMerge,
     });
   });
@@ -88,13 +95,7 @@ const getTransactionSchema = (
 };
 
 const getValidator = (schemaId, overlays) => {
-  let validator = ajv.getSchema(schemaId);
-  if (!validator) {
-    const schema = getTransactionSchema(schemaId, overlays);
-    ajv.addSchema(schema, schemaId);
-    validator = ajv.getSchema(schemaId);
-  }
-  return validator;
+  return getSubschemaValidator("", schemaId, overlays);
 };
 
 // common functions for v1 and v2
@@ -129,7 +130,7 @@ const isPathValid = (path, schemaId, overlays) => {
   }
 };
 
-const getSubschemaValidator = (path, schemaId, overlays = ["baspiV4"]) => {
+const getSubschemaValidator = (path, schemaId, overlays) => {
   const subSchema = getSubschema(path, schemaId, overlays);
   const overlayKey = (overlays || []).join(".");
   // see if we can retrieve the schema by path, schemaId and overlays
@@ -162,6 +163,7 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
   const propertyName = pathArray.shift();
   const subPath = "/" + pathArray.join("/");
+
   let subSchema = schema.properties
     ? schema.properties[propertyName]
     : undefined;
@@ -172,10 +174,9 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
     subSchema = schema.items;
     return getTitleAtPath(subSchema, subPath, rootPath);
   }
-  const discriminator = schema.discriminator?.propertyName;
-  if (discriminator) {
+  const oneOfs = schema.oneOf;
+  if (oneOfs) {
     // only single dependency discriminator, oneOf keyword is supported
-    const oneOfs = schema.oneOf;
     const matchingOneOf = oneOfs.find(
       (oneOf) => oneOf["properties"][propertyName]
     );
@@ -235,4 +236,5 @@ module.exports = {
   getTitleAtPath,
   verifiedClaimsSchema,
   validateVerifiedClaims,
+  overlaysMap,
 };

package/package.json

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

package/src/examples/v3/exampleTransaction.json

@@ -39,6 +39,13 @@
         "town": "HARPENDEN",
         "postcode": "AL3 5AF"
       },
+      "localAuthority": { "localAuthorityName": "Neverland Hook" },
+      "buildInformation": {
+        "building": { "propertyType": "House", "builtForm": "Detached" },
+        "roomDimensions": {
+          "hasFloorplan": "Yes"
+        }
+      },
       "delayFactors": {
         "hasDelayFactors": { "yesNo": "No" }
       },
@@ -112,7 +119,7 @@
       },
       "parking": {
         "parkingArrangements": ["Garage", "Driveway"],
-
+        "disabledParking": { "yesNo": "No" },
         "electricVehicleChargingPoint": { "yesNo": "No" },
         "controlledParking": { "yesNo": "No" }
       },
@@ -296,12 +303,56 @@
           "yesNo": "No"
         }
       },
+      "electricity": {
+        "mainsElectricity": {
+          "yesNo": "Yes",
+          "supplier": "Octopus Energy",
+          "electricityMeter": {
+            "location": "Under the stairs"
+          }
+        },
+        "solarPanels": {
+          "yesNo": "No"
+        },
+        "otherSources": {
+          "yesNo": "No"
+        }
+      },
+      "heating": {
+        "heatingSystem": {
+          "heatingType": "Central heating",
+          "centralHeatingDetails": {
+            "boilerInstallationCertificate": {
+              "yesNo": "Yes",
+              "details": "Certified installation",
+              "attachments": "To follow"
+            },
+            "heatingInGoodWorkingOrder": {
+              "yesNo": "Yes"
+            },
+            "centralHeatingFuel": {
+              "centralHeatingFuelType": "Other",
+              "otherCentralHeatingFuelType": "Ground-source Heat Pump"
+            },
+            "centralHeatingInstalled": "2016-04-20",
+            "heatingLastServicedDate": "2021-03-26",
+            "heatingLastServicedReport": "To follow"
+          }
+        },
+        "otherHeatingFeatures": ["Underfloor heating"]
+      },
       "waterAndDrainage": {
         "water": {
           "mainsWater": {
-            "yesNo": "To be connected",
-            "dateToBeConnected": "2022-12-15",
-            "supplier": "Northumbria Water"
+            "yesNo": "Yes",
+            "waterMeter": {
+              "isSupplyMetered": "Yes",
+              "location": "At the front"
+            },
+            "supplier": "Northumbria Water",
+            "stopcock": {
+              "location": "Under the sink"
+            }
           }
         },
         "drainage": {
@@ -310,22 +361,17 @@
           },
           "mainsFoulDrainage": {
             "yesNo": "No",
-            "sustainableDrainageSystem": { "yesNo": "No" },
-            "septicTank": {
-              "yesNo": "Yes",
-              "details": "Last emptied on 1 Jan 2022",
+            "offMainsDrainageSystem": {
+              "offMainsDrainageSystemType": "Septic tank",
               "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"
+              "dateLastEmptied": "2022-01-01",
+              "plantOnOtherLand": { "yesNo": "No" },
+              "otherConnectedProperties": { "yesNo": "No" },
+              "plantRegistered": { "yesNo": "No" },
+              "plantDrainsIntoWaterway": {
+                "yesNo": "Yes",
+                "dischargeCompliesWithGBR": "Yes"
+              }
             }
           }
         },
@@ -333,21 +379,7 @@
           "yesNo": "No"
         }
       },
-      "connectedUtilities": {
-        "mainsElectricity": {
-          "yesNo": "Yes",
-          "supplier": "Octopus Energy"
-        },
-        "mainsGas": {
-          "yesNo": "Yes",
-          "supplier": "Octopus Energy"
-        },
-        "lpg": {
-          "yesNo": "No"
-        },
-        "oil": {
-          "yesNo": "No"
-        },
+      "connectivity": {
         "telephone": {
           "yesNo": "Yes",
           "supplier": "EE"
@@ -357,39 +389,13 @@
           "supplier": "Sky"
         },
         "broadband": {
-          "yesNo": "Yes",
           "supplier": "BT",
           "typeOfConnection": "FTTC (Fibre to the Cabinet)"
         },
-        "solarPanels": {
-          "yesNo": "No"
-        },
-        "otherServices": {
-          "yesNo": "No"
-        },
-        "maintenanceAgreements": {
-          "yesNo": "No"
-        }
-      },
-      "heating": {
-        "heatingType": "Central heating",
-        "otherHeatingFeatures": ["Underfloor Heating"],
-        "centralHeatingDetails": {
-          "boilerInstallationCertificate": {
-            "yesNo": "Yes",
-            "details": "Certified installation",
-            "attachments": "To follow"
-          },
-          "heatingInGoodWorkingOrder": {
-            "yesNo": "Yes"
-          },
-          "centralHeatingFuel": {
-            "centralHeatingFuelType": "Other",
-            "otherCentralHeatingFuelType": "Ground-source Heat Pump"
-          },
-          "centralHeatingInstalled": "2016-04-20",
-          "heatingLastServicedDate": "2021-03-26",
-          "heatingLastServicedReport": "To follow"
+        "mobilePhone": {
+          "knownSignalIssues": {
+            "yesNo": "No"
+          }
         }
       },
       "insurance": {
@@ -462,28 +468,30 @@
       "environmentalIssues": {
         "flooding": {
           "floodRisk": {
-            "impactIndicator": "Yes",
+            "riskIndicator": "Yes",
             "summary": "Likely to flood from surface water"
           },
-          "hasBeenFlooded": "Yes",
-          "details": "Minor basement flood",
-          "typeOfFlooding": ["Surface water"]
+          "historicalFlooding": {
+            "hasBeenFlooded": "Yes",
+            "details": "Minor basement flood",
+            "typeOfFlooding": ["Surface water"]
+          }
         },
         "radon": {
           "radonTest": { "yesNo": "No" },
           "remedialMeasuresOnConstruction": { "yesNo": "No" }
         },
         "coalMining": {
-          "impactIndicator": "No"
+          "riskIndicator": "No"
         },
         "nonCoalMining": {
-          "impactIndicator": "No"
+          "riskIndicator": "No"
         },
         "coastalErosion": {
-          "impactIndicator": "No"
+          "riskIndicator": "No"
         },
         "otherEnvironmental": {
-          "yesNo": "No"
+          "riskIndicator": "No"
         }
       },
       "otherIssues": {
@@ -554,7 +562,7 @@
         "pipesWiresCablesDrainsFromProperty": { "yesNo": "No" },
         "formalOrInformalAgreements": { "yesNo": "No" }
       },
-      "energyAndMeters": {
+      "electricalWorks": {
         "testedByQualifiedElectrician": {
           "yesNo": "Yes",
           "yearTested": 2015,
@@ -565,8 +573,7 @@
           "yearWorkCarriedOut": 2016,
           "details": "New fuse box",
           "attachments": "To follow"
-        },
-        "solarPanels": { "hasSolarPanels": "No" }
+        }
       },
       "smartHomeSystems": { "hasSmartHomeSystems": "No" },
       "guaranteesWarrantiesAndIndemnityInsurances": {