@pdtf/schemas 2.0.0-1 → 2.0.0-2

package/index.js

@@ -105,7 +105,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 +128,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);
+const getSubschemaValidator = (path, schemaId, overlay) => {
+  const subSchema = getSubschema(path, schemaId, overlay);
   // see if we can retrieve the schema by path
-  let validator = ajv.getSchema(path);
+  const cacheKey = `${path}-${schemaId}`;
+  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;
 };

package/package.json

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

package/src/examples/v2/exampleTransaction.json

@@ -119,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": {
@@ -428,7 +431,7 @@
           }
         }
       },
-      "otherIssues": {
+      "environmentalIssues": {
         "flooding": {
           "floodRiskReport": { "yesNo": "No" },
           "hasBeenFlooded": "Yes",
@@ -460,7 +463,9 @@
         },
         "otherEnvironmental": {
           "yesNo": "No"
-        },
+        }
+      },
+      "otherIssues": {
         "excessiveNoise": {
           "yesNo": "No"
         },
@@ -493,6 +498,12 @@
             "ownerType": "Private individual",
             "firstName": "Peter",
             "lastName": "Hetherington-Smythe"
+          },
+          {
+            "ownerType": "Private individual",
+            "firstName": "Clarissa",
+            "middleNames": "Jane",
+            "lastName": "Hetherington-Smythe"
           }
         ]
       },

package/src/schemas/v2/combined.json

@@ -155,6 +155,7 @@
             "insurance",
             "boundaries",
             "rightsAndInformalArrangements",
+            "environmentalIssues",
             "otherIssues",
             "additionalInformation",
             "consumerProtectionRegulationsDeclaration"
@@ -7051,7 +7052,8 @@
               "type": "object",
               "baspiRequired": [
                 "isStandardForm",
-                "hasFlammableExternalWallSystem"
+                "buildingSafetyRemediation",
+                "sprayFoamInsulation"
               ],
               "properties": {
                 "isStandardForm": {
@@ -7142,38 +7144,38 @@
                     }
                   ]
                 },
-                "hasSprayFoamInstalled": {
+                "sprayFoamInsulation": {
                   "baspiRef": "A1.8.4",
                   "title": "Has spray foam insulation been installed at the property?",
                   "type": "object",
                   "properties": {
-                    "yesNo": {
+                    "hasSprayFoamInstalled": {
                       "baspiRef": "A1.8.4.1",
                       "type": "string",
                       "title": "",
                       "enum": ["Yes", "No"]
                     }
                   },
-                  "baspiRequired": ["yesNo"],
+                  "baspiRequired": ["hasSprayFoamInstalled"],
                   "discriminator": {
-                    "propertyName": "yesNo"
+                    "propertyName": "hasSprayFoamInstalled"
                   },
                   "oneOf": [
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": ["No"]
                         }
                       }
                     },
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": ["Yes"]
                         },
                         "details": {
                           "baspiRef": "A1.8.4.2",
-                          "title": "Details",
+                          "title": "Please give details together with certification from BBA or KIWA and the installation warranty for the work carried out",
                           "type": "string",
                           "minLength": 1
                         },
@@ -7186,8 +7188,7 @@
                       },
                       "baspiRequired": ["details", "attachments"]
                     }
-                  ],
-                  "description": "If yes, please give details together with certification from BBA or KIWA and the installation warranty for the work carried out."
+                  ]
                 }
               }
             },
@@ -7196,6 +7197,7 @@
               "rdsRef": "Certificates/{category='energyEfficiency',standard='EPC',gradeLevelRating=?},Certificates/{category='energyEfficiency',standard='EPC',status='exempt'},",
               "title": "Energy Efficiency",
               "type": "object",
+              "baspiRequired": ["certificate"],
               "properties": {
                 "certificate": {
                   "baspiRef": "A1.8.3.1",

package/src/schemas/v2/core.json

@@ -6476,11 +6476,11 @@
                     }
                   ]
                 },
-                "hasSprayFoamInstalled": {
+                "sprayFoamInsulation": {
                   "title": "Has spray foam insulation been installed at the property?",
                   "type": "object",
                   "properties": {
-                    "yesNo": {
+                    "hasSprayFoamInstalled": {
                       "type": "string",
                       "title": "",
                       "enum": [
@@ -6492,7 +6492,7 @@
                   "oneOf": [
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": [
                             "No"
                           ]
@@ -6501,13 +6501,13 @@
                     },
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": [
                             "Yes"
                           ]
                         },
                         "details": {
-                          "title": "Details",
+                          "title": "Please give details together with certification from BBA or KIWA and the installation warranty for the work carried out",
                           "type": "string",
                           "minLength": 1
                         },
@@ -6521,8 +6521,7 @@
                         }
                       }
                     }
-                  ],
-                  "description": "If yes, please give details together with certification from BBA or KIWA and the installation warranty for the work carried out."
+                  ]
                 }
               }
             },

package/src/schemas/v2/merged.json

@@ -151,6 +151,7 @@
             "insurance",
             "boundaries",
             "rightsAndInformalArrangements",
+            "environmentalIssues",
             "otherIssues",
             "additionalInformation",
             "consumerProtectionRegulationsDeclaration"
@@ -6654,7 +6655,8 @@
               "title": "Type of Construction",
               "required": [
                 "isStandardForm",
-                "hasFlammableExternalWallSystem"
+                "buildingSafetyRemediation",
+                "sprayFoamInsulation"
               ],
               "properties": {
                 "isStandardForm": {
@@ -6770,17 +6772,16 @@
                   },
                   "type": "object"
                 },
-                "hasSprayFoamInstalled": {
+                "sprayFoamInsulation": {
                   "baspiRef": "A1.8.4",
                   "title": "Has spray foam insulation been installed at the property?",
-                  "description": "If yes, please give details together with certification from BBA or KIWA and the installation warranty for the work carried out.",
                   "discriminator": {
-                    "propertyName": "yesNo"
+                    "propertyName": "hasSprayFoamInstalled"
                   },
                   "oneOf": [
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": [
                             "No"
                           ]
@@ -6789,14 +6790,14 @@
                     },
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": [
                             "Yes"
                           ]
                         },
                         "details": {
                           "baspiRef": "A1.8.4.2",
-                          "title": "Details",
+                          "title": "Please give details together with certification from BBA or KIWA and the installation warranty for the work carried out",
                           "type": "string",
                           "minLength": 1
                         },
@@ -6817,10 +6818,10 @@
                     }
                   ],
                   "required": [
-                    "yesNo"
+                    "hasSprayFoamInstalled"
                   ],
                   "properties": {
-                    "yesNo": {
+                    "hasSprayFoamInstalled": {
                       "baspiRef": "A1.8.4.1",
                       "enum": [
                         "Yes",
@@ -6838,6 +6839,9 @@
             "energyEfficiency": {
               "baspiRef": "A1.8.3",
               "title": "Energy Efficiency",
+              "required": [
+                "certificate"
+              ],
               "properties": {
                 "certificate": {
                   "baspiRef": "A1.8.3.1",

package/src/schemas/v2/overlays/baspi.json

@@ -61,6 +61,7 @@
             "insurance",
             "boundaries",
             "rightsAndInformalArrangements",
+            "environmentalIssues",
             "otherIssues",
             "additionalInformation",
             "consumerProtectionRegulationsDeclaration"
@@ -1204,7 +1205,8 @@
               "title": "Type of Construction",
               "required": [
                 "isStandardForm",
-                "hasFlammableExternalWallSystem"
+                "buildingSafetyRemediation",
+                "sprayFoamInsulation"
               ],
               "properties": {
                 "isStandardForm": {
@@ -1309,17 +1311,16 @@
                     }
                   }
                 },
-                "hasSprayFoamInstalled": {
+                "sprayFoamInsulation": {
                   "baspiRef": "A1.8.4",
                   "title": "Has spray foam insulation been installed at the property?",
-                  "description": "If yes, please give details together with certification from BBA or KIWA and the installation warranty for the work carried out.",
                   "discriminator": {
-                    "propertyName": "yesNo"
+                    "propertyName": "hasSprayFoamInstalled"
                   },
                   "oneOf": [
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": [
                             "No"
                           ]
@@ -1328,14 +1329,14 @@
                     },
                     {
                       "properties": {
-                        "yesNo": {
+                        "hasSprayFoamInstalled": {
                           "enum": [
                             "Yes"
                           ]
                         },
                         "details": {
                           "baspiRef": "A1.8.4.2",
-                          "title": "Details"
+                          "title": "Please give details together with certification from BBA or KIWA and the installation warranty for the work carried out"
                         },
                         "attachments": {
                           "baspiRef": "A1.8.4.3",
@@ -1353,10 +1354,10 @@
                     }
                   ],
                   "required": [
-                    "yesNo"
+                    "hasSprayFoamInstalled"
                   ],
                   "properties": {
-                    "yesNo": {
+                    "hasSprayFoamInstalled": {
                       "baspiRef": "A1.8.4.1",
                       "enum": [
                         "Yes",
@@ -1370,6 +1371,9 @@
             "energyEfficiency": {
               "baspiRef": "A1.8.3",
               "title": "Energy Efficiency",
+              "required": [
+                "certificate"
+              ],
               "properties": {
                 "certificate": {
                   "baspiRef": "A1.8.3.1",

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

@@ -59,46 +59,37 @@ test("sample with missing dependent required fields is invalid", () => {
 });
 
 test("correctly gets a top level subschema", () => {
-  const subschema = getSubschema("/propertyPack", v2TransactionSchema);
+  const subschema = getSubschema("/propertyPack");
   expect(subschema.title).toBe("Property Pack");
 });
 
 test("correctly identifies a valid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialFacts",
-    v2TransactionSchema
-  );
+  const isValid = isPathValid("/propertyPack/materialFacts");
   expect(isValid).toBe(true);
 });
 
 test("correctly identifies an undefined invalid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialItems",
-    v2TransactionSchema
-  );
+  const isValid = isPathValid("/propertyPack/materialItems");
   expect(isValid).toBe(false);
 });
 
 test("correctly identifies an error generating invalid path", () => {
   const isValid = isPathValid(
     "/propertyPack/materialItems/someProperty/item",
-    v2TransactionSchema
+    schemaId
   );
   expect(isValid).toBe(false);
 });
 
 test("correctly identifies an array invalid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialFacts/1/item",
-    v2TransactionSchema
-  );
+  const isValid = isPathValid("/propertyPack/materialFacts/1/item");
   expect(isValid).toBe(false);
 });
 
 test("correctly gets a subschema", () => {
   const subschema = getSubschema(
     "/propertyPack/materialFacts/notices",
-    v2TransactionSchema
+    schemaId
   );
   expect(subschema.title).toBe("Notices which Affect the Property");
 });
@@ -106,7 +97,7 @@ test("correctly gets a subschema", () => {
 test("correctly gets a subschema through an arrays element", () => {
   const subschema = getSubschema(
     "/propertyPack/titlesToBeSold/0/registerExtract",
-    v2TransactionSchema
+    schemaId
   );
   expect(Object.keys(subschema.properties)).toEqual([
     "OCSummaryData",
@@ -117,7 +108,7 @@ test("correctly gets a subschema through an arrays element", () => {
 test("correctly gets a subschema through a dependency", () => {
   const subschema = getSubschema(
     "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details",
-    v2TransactionSchema
+    schemaId
   );
   expect(subschema.title).toBe("Details");
 });
@@ -125,16 +116,16 @@ test("correctly gets a subschema through a dependency", () => {
 test("correctly gets another subschema through a dependency", () => {
   const subschema = getSubschema(
     "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/general/leaseTerm/lengthOfLeaseInYears",
-    v2TransactionSchema
+    schemaId
   );
   expect(subschema.title).toBe("Length of lease (years)");
 });
 
 test("correctly gets yet another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/rentIncrease/details"
+    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/groundRent/rentSubjectToIncrease/rentIncreaseCalculated"
   );
-  expect(subschema.title).toBe("Details");
+  expect(subschema.title).toBe("How is the increase calculated?");
 });
 
 test("correctly gets yet, yet another subschema through a dependency", () => {
@@ -147,7 +138,7 @@ test("correctly gets yet, yet another subschema through a dependency", () => {
 
 test("correctly gets yet, yet, yet another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding/groundWater/yesNo"
+    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding/groundWater/yesNo"
   );
   expect(subschema.type).toBe("string");
   expect(subschema.enum).toStrictEqual(["Yes", "No"]);
@@ -155,7 +146,7 @@ test("correctly gets yet, yet, yet another subschema through a dependency", () =
 
 test("correctly gets yet, yet, yet another subschema through a second item dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding"
+    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding"
   );
   expect(subschema.type).toBe("object");
 });
@@ -176,11 +167,11 @@ test("correctly gets yes another subschema but through a non-baspi oneOf structu
 
 test("correctly gets a subschema validator which is already cached", () => {
   const validator = getSubschemaValidator(
-    "/propertyPack/energyPerformanceCertificate"
+    "/propertyPack/materialFacts/energyEfficiency/certificate"
   );
   expect(validator).not.toBeNull();
   const anotherValidator = getSubschemaValidator(
-    "/propertyPack/energyPerformanceCertificate"
+    "/propertyPack/materialFacts/energyEfficiency/certificate"
   );
   expect(anotherValidator).not.toBeNull();
 });