@pdtf/schemas 3.0.0-1 → 3.0.0-11

package/src/schemas/v3/skeleton.json

@@ -34,10 +34,6 @@
         "postcode": {}
       },
       "uprn": {},
-      "propertyType": {},
-      "isNewBuild": {
-        "yesNo": {}
-      },
       "location": {
         "latitude": {},
         "longitude": {},
@@ -72,18 +68,38 @@
         "caption": {}
       },
       "buildInformation": {
+        "building": {
+          "propertyType": {},
+          "otherType": {},
+          "builtForm": {},
+          "numberOfFloors": {},
+          "entranceFloor": {},
+          "hasLift": {},
+          "overCommercialPremises": {
+            "isLocatedOverCommercialPremises": {},
+            "details": {}
+          }
+        },
         "internalArea": {
           "area": {},
           "units": {}
         },
         "yearOfBuild": {},
-        "rooms": {
-          "roomName": {},
-          "length": {},
-          "width": {},
-          "units": {},
-          "dimensionDetails": {},
-          "photoUrls": {}
+        "isNewBuild": {
+          "yesNo": {}
+        },
+        "roomDimensions": {
+          "hasFloorplan": {
+            "yesNo": {},
+            "rooms": {
+              "roomName": {},
+              "length": {},
+              "width": {},
+              "units": {},
+              "dimensionDetails": {},
+              "photoUrls": {}
+            }
+          }
         }
       },
       "residentialPropertyFeatures": {
@@ -2010,51 +2026,38 @@
         "drainage": {
           "mainsSurfaceWaterDrainage": {
             "yesNo": {},
-            "supplier": {},
             "details": {},
             "dateToBeConnected": {}
           },
           "mainsFoulDrainage": {
             "yesNo": {},
-            "supplier": {},
             "details": {},
             "dateToBeConnected": {},
-            "sustainableDrainageSystem": {
-              "yesNo": {},
-              "supplier": {},
-              "dateToBeConnected": {}
-            },
-            "septicTank": {
-              "yesNo": {},
+            "supplier": {},
+            "offMainsDrainageSystem": {
+              "offMainsDrainageSystemType": {},
+              "otherConnectedProperties": {
+                "yesNo": {},
+                "numberOfPropertiesSharing": {},
+                "details": {}
+              },
+              "plantOnOtherLand": {
+                "yesNo": {},
+                "attachments": {}
+              },
+              "plantRegistered": {
+                "yesNo": {},
+                "attachments": {}
+              },
+              "plantDrainsIntoWaterway": {
+                "yesNo": {},
+                "dischargeCompliesWithGBR": {}
+              },
               "dateReplaced": {},
-              "dateLastEmptied": {}
-            },
-            "cesspit": {
-              "yesNo": {},
-              "dateLastEmptied": {}
-            },
-            "sewerageTreatmentPlant": {
-              "yesNo": {},
+              "dateLastEmptied": {},
               "dateInstalled": {},
               "dateLastServiced": {},
               "attachments": {}
-            },
-            "otherConnectedProperties": {
-              "yesNo": {},
-              "numberOfPropertiesSharing": {},
-              "details": {}
-            },
-            "plantOnOtherLand": {
-              "yesNo": {},
-              "attachments": {}
-            },
-            "plantRegistered": {
-              "yesNo": {},
-              "attachments": {}
-            },
-            "plantDrainsIntoWaterway": {
-              "yesNo": {},
-              "dischargeCompliesWithGBR": {}
             }
           },
           "surfaceDrainageCharge": {
@@ -2226,15 +2229,17 @@
       "environmentalIssues": {
         "flooding": {
           "floodRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2246,15 +2251,17 @@
         },
         "radon": {
           "radonRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2271,15 +2278,17 @@
         },
         "contaminatedLand": {
           "contaminatedLandRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2288,15 +2297,17 @@
         },
         "groundStability": {
           "groundStabilityRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2305,15 +2316,17 @@
         },
         "energy": {
           "energyRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2322,15 +2335,17 @@
         },
         "transportation": {
           "transportationRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2339,15 +2354,17 @@
         },
         "planning": {
           "planningRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2356,15 +2373,17 @@
         },
         "climate": {
           "climateRisk": {
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {},
             "riskSubcategories": {
               "subCategory": {},
-              "impactIndicator": {},
+              "riskIndicator": {},
               "actionAlertRating": {},
+              "result": {},
               "summary": {},
               "recommendations": {},
               "datasetAttribution": {}
@@ -2372,45 +2391,51 @@
           }
         },
         "coalMining": {
-          "impactIndicator": {},
+          "riskIndicator": {},
           "actionAlertRating": {},
+          "result": {},
           "summary": {},
           "recommendations": {},
           "datasetAttribution": {},
           "riskSubcategories": {
             "subCategory": {},
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {}
           }
         },
         "nonCoalMining": {
-          "impactIndicator": {},
+          "riskIndicator": {},
           "actionAlertRating": {},
+          "result": {},
           "summary": {},
           "recommendations": {},
           "datasetAttribution": {},
           "riskSubcategories": {
             "subCategory": {},
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {}
           }
         },
         "coastalErosion": {
-          "impactIndicator": {},
+          "riskIndicator": {},
           "actionAlertRating": {},
+          "result": {},
           "summary": {},
           "recommendations": {},
           "datasetAttribution": {},
           "riskSubcategories": {
             "subCategory": {},
-            "impactIndicator": {},
+            "riskIndicator": {},
             "actionAlertRating": {},
+            "result": {},
             "summary": {},
             "recommendations": {},
             "datasetAttribution": {}

package/src/tests/v3/transactionSchema.test.js

@@ -11,23 +11,24 @@ const {
 } = require("../../../index.js");
 
 const exampleTransaction = require("../../examples/v3/exampleTransaction.json");
+
 const schemaId =
   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json";
 // const validator = getValidator(schemaId);
 const v3TransactionSchema = getTransactionSchema(schemaId);
 
-test("exports a property pack schema, v3 with baspi overlay by default", () => {
-  const testSchema = getTransactionSchema();
-  expect(testSchema.$id).toEqual(
-    "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json"
-  );
+test("exports a property pack schema, v3 with no overlay by default", () => {
+  const testSchema = getTransactionSchema(schemaId);
+  // expect(testSchema.$id).toEqual(
+  //   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json"
+  // );
   expect(
     testSchema.properties.propertyPack.properties.materialFacts.baspiRef
-  ).toEqual("A");
+  ).toEqual(undefined);
 });
 
 test("sample is valid BASPI", () => {
-  const testSchema = getTransactionSchema();
+  const testSchema = getTransactionSchema(schemaId, ["baspiV4"]);
   expect(
     testSchema.properties.propertyPack.properties.materialFacts.baspiRef
   ).toEqual("A");
@@ -49,7 +50,7 @@ test("invalid sample is invalid", () => {
     JSON.stringify(exampleTransaction)
   );
   delete clonedExampleTransaction.propertyPack.materialFacts.notices;
-  const validator = getValidator(schemaId);
+  const validator = getValidator(schemaId, ["baspiV4"]);
   const isValid = validator(clonedExampleTransaction);
   expect(isValid).toBe(false);
 });
@@ -166,6 +167,15 @@ test("correctly gets yes another subschema but through a non-baspi oneOf structu
   expect(subschema).toEqual({ type: "string" });
 });
 
+test("correctly gets an overlaid enum in a subschema", () => {
+  const subschema = getSubschema(
+    "/propertyPack/materialFacts/connectedUtilities/mainsElectricity/yesNo",
+    schemaId,
+    ["nts2023"]
+  );
+  expect(subschema.enum).toEqual(["Yes", "No"]);
+});
+
 test("correctly gets a subschema with multiple overlays", () => {
   const subschema = getSubschema(
     "/propertyPack/materialFacts/parking/parkingArrangements",
@@ -194,7 +204,6 @@ test("correctly gets a subschema validator for a TA6 overlay", () => {
     "ta6ed4",
   ]);
   let isValid = validator(data);
-  // console.log(validator.errors);
   expect(isValid).toBe(true);
 });
 
@@ -267,14 +276,14 @@ test("correctly gets a subschema validator for an NTS overlay", () => {
   expect(isValid).toBe(true);
 });
 
-test("correctly gets a subschema validator for an LPE1 overlay", () => {
+test("correctly gets a subschema validator for an TA7 overlay", () => {
   const path = "/propertyPack";
   const clonedExampleTransaction = JSON.parse(
     JSON.stringify(exampleTransaction)
   );
   const data = jp.get(clonedExampleTransaction, path);
   const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "lpe1ed4",
+    "ta7ed3",
   ]);
   let isValid = validator(data);
   expect(isValid).toBe(false);
@@ -299,48 +308,49 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
       "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/ownershipType"
     )
   ).toBe("What type of ownership is the property?");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears"
     )
   ).toBe("Length of lease (years)");
-  expect(
-    getTitleAtPath(
-      v3TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/serviceCharge/annualServiceCharge"
-    )
-  ).toBe("Amount of current annual service charge (£)");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/materialFacts/invalidPath"
     )
   ).toBe(undefined);
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract"
     )
   ).toBe("HMLR Official Copy Register Extract");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
     )
   ).toBe("Property address");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
     )
   ).toBe(undefined);
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/materialFacts/energyEfficiency/certificate/currentEnergyRating"
     )
   ).toBe("Current energy efficiency rating");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,

package/src/tests/v3/verifiedClaimsValidator.test.js

@@ -27,14 +27,14 @@ test("returns an array with an error stating if path is incorrect", () => {
   ]);
 });
 
-test("returns errors if BASPI requirements are not met and BASPI overlay is specified (default)", () => {
+test("returns errors if BASPI requirements are not met and BASPI overlay is specified", () => {
   const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
   clonedVouch.claims = {
     "/propertyPack/materialFacts/delayFactors": {
       hasDelayFactors: { yesNo: "Yes" },
     },
   };
-  const errors = validateVerifiedClaims([clonedVouch], v3SchemaId);
+  const errors = validateVerifiedClaims([clonedVouch], v3SchemaId, ["baspiV4"]);
   expect(errors).toEqual([
     {
       instancePath: "/hasDelayFactors",

package/src/utils/extractOverlay.js

@@ -23,30 +23,15 @@ const extractFields = [
 ];
 
 const overlayIncludeProperties = [
-  "title",
-  "description",
-  "enum",
+  // "title",
+  // "description",
+  // "enum",
   "discriminator",
-  "minItems",
+  // "minItems",
 ];
 
-const combineMerge = (target, source, options) => {
-  const destination = target.slice();
-  source.forEach((item, index) => {
-    if (typeof destination[index] === "undefined") {
-      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options);
-    } else if (options.isMergeableObject(item)) {
-      destination[index] = merge(target[index], item, options);
-    } else if (target.indexOf(item) === -1) {
-      destination.push(item);
-    }
-  });
-  return destination;
-};
-
 const flattenSkeleton = (schema) => {
   if (!schema) return undefined;
-  // console.log(schema.properties);
   let returnStructure = {};
   if (schema.properties) {
     Object.keys(schema.properties).forEach((key) => {
@@ -55,10 +40,8 @@ const flattenSkeleton = (schema) => {
   }
   if (schema.oneOf) {
     schema.oneOf.forEach((aOneOf) => {
-      // console.log(aOneOf);
       if (aOneOf.properties) {
         Object.entries(aOneOf.properties).forEach(([key, value]) => {
-          // console.log(aProperty);
           returnStructure[key] = flattenSkeleton(value);
         });
       }
@@ -153,12 +136,7 @@ const deleteProperties = (sourceSchema, propertyNames) => {
 const overlays = {};
 
 extractFields.forEach((key) => {
-  let overlay = extractOverlay(combinedSchema, key, [
-    "title",
-    "description",
-    "enum",
-    "discriminator",
-  ]);
+  let overlay = extractOverlay(combinedSchema, key);
   overlays[key] = overlay;
   const fileName = `../schemas/v3/overlays/${key}.json`;
   fs.writeFileSync(fileName, JSON.stringify(overlay, null, 2));