@pdtf/schemas 2.0.0-22 → 2.0.0-24

package/index.js

@@ -60,7 +60,7 @@ 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, null: {} };
+const overlaysMap = { baspiV4: baspiOverlay, ta6ed4: ta6Overlay, null: {} };
 
 const transactionSchemas = {
   "https://trust.propdata.org.uk/schemas/v1/pdtf-transaction.json":
@@ -85,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);
   }
@@ -108,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) => {
@@ -131,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, schemaId and overlay
-  const cacheKey = `${path}-${schemaId}-${overlay}`;
+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);
@@ -198,7 +201,7 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
-const validateVerifiedClaims = (verifiedClaims, schemaId, overlay) => {
+const validateVerifiedClaims = (verifiedClaims, schemaId, overlays) => {
   const validatorVClaims = ajv.compile(verifiedClaimsSchema);
 
   const validationErrorsArr = [];
@@ -217,9 +220,9 @@ const validateVerifiedClaims = (verifiedClaims, schemaId, overlay) => {
   verifiedClaimsArray.forEach((claim) => {
     const paths = Object.keys(claim.claims);
     for (const path of paths) {
-      const validPath = isPathValid(path, schemaId, overlay);
+      const validPath = isPathValid(path, schemaId, overlays);
       if (validPath) {
-        const subValidator = getSubschemaValidator(path, schemaId, overlay);
+        const subValidator = getSubschemaValidator(path, schemaId, overlays);
         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-22",
+  "version": "2.0.0-24",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/examples/v2/exampleTransaction.json

@@ -164,9 +164,6 @@
             "yesNo": "Not required",
             "details": "No restriction"
           },
-          "unfinished": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "details": "Bedroom and ensuite shower room extension 2005"
         },
@@ -190,9 +187,6 @@
             "yesNo": "Not required",
             "details": "No restriction"
           },
-          "unfinished": {
-            "yesNo": "No"
-          },
           "yesNo": "Yes",
           "details": "New front door added 2016",
           "yearCompleted": 2016
@@ -214,13 +208,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"
         },
@@ -382,7 +376,10 @@
       "insurance": {
         "isInsured": "Yes",
         "difficultiesObtainingInsurance": {
-          "yesNo": "No"
+          "abnormalRiseInPremiums": { "yesNo": "No" },
+          "subjectToHighExcesses": { "yesNo": "No" },
+          "subjectToUnusualConditions": { "yesNo": "No" },
+          "refused": { "yesNo": "No" }
         },
         "insuranceClaims": {
           "yesNo": "No"
@@ -477,6 +474,9 @@
         },
         "otherMaterialIssue": {
           "yesNo": "No"
+        },
+        "otherCharges": {
+          "yesNo": "No"
         }
       },
       "consumerProtectionRegulationsDeclaration": {
@@ -551,7 +551,10 @@
       "completionAndMoving": {
         "willRemoveAllRubbish": true,
         "otherPropertyInChain": { "yesNo": "No" },
-        "moveRestrictionDates": { "yesNo": "No" },
+        "moveRestrictionDates": {
+          "yesNo": "Yes",
+          "details": "On holiday 1-15 Aug 23"
+        },
         "digitalPropertyLogbook": {
           "yesNo": "Yes",
           "logbookProvider": "someone",