@pdtf/schemas 0.6.0 → 0.6.2

package/index.js

@@ -44,6 +44,13 @@ const getSubschema = (path) => {
   }, transactionSchema);
 };
 
+const isPathValid = (path) => {
+  try {
+    return getSubschema(path) !== undefined;
+  } catch (err) {
+    return false;
+  }
+};
 const getSubschemaValidator = (path) => {
   const subSchema = getSubschema(path);
   let validator = ajv.getSchema(path);
@@ -103,6 +110,7 @@ module.exports = {
   transactionSchema,
   validator,
   getSubschema,
+  isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
   verifiedClaimsSchema,

package/package.json

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

package/src/examples/exampleTransaction.json

@@ -1,12 +1,16 @@
 {
   "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-transaction.json",
   "transactionId": "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a",
+  "status": "active",
   "participants": [
     {
-      "name": { "firstName": "Peter", "lastName": "Hetherington-Smythe" },
+      "name": {
+        "forenames": "Peter Ronald",
+        "surname": "Hetherington-Smythe"
+      },
       "dateOfBirth": "1975-12-25",
       "phone": "07777 222333",
-      "email": "john@theseller.com",
+      "email": "peter@theseller.com",
       "address": { "address1": "47 Park Road", "postcode": "AL3 5AF" },
       "role": "Seller"
     }

package/src/schemas/pdtf-transaction.json

@@ -4,13 +4,26 @@
   "type": "object",
   "title": "Property Data Trust Framework Transaction Schema",
   "description": "A schema defining the PDTF transaction data structure, supporting mapping to BASPI, Law Society and RICS Data Schema elements.",
-  "required": ["transactionId", "participants", "propertyPack"],
+  "required": [
+    "$schema",
+    "transactionId",
+    "status",
+    "participants",
+    "propertyPack"
+  ],
   "properties": {
+    "$schema": {
+      "type": "string"
+    },
     "transactionId": {
       "title": "UUID for the transaction",
       "type": "string",
       "format": "uuid"
     },
+    "status": {
+      "type": "string",
+      "enum": ["active", "cancelled", "completed"]
+    },
     "participants": {
       "title": "Transaction participants",
       "type": "array",
@@ -18,31 +31,23 @@
       "items": {
         "type": "object",
         "title": "Participant Details",
-        "required": [
-          "name",
-          "dateOfBirth",
-          "phone",
-          "email",
-          "address",
-          "role"
-        ],
+        "required": ["name", "email", "role"],
         "properties": {
           "name": {
             "title": "",
             "type": "object",
-            "required": ["firstName", "lastName"],
+            "required": ["forenames", "surname"],
             "properties": {
-              "firstName": {
-                "RDSRef": "",
-                "title": "First name",
+              "forenames": {
+                "title": "Forenames",
                 "type": "string"
               },
-              "middleNames": {
-                "title": "Middle name(s)",
+              "preferredName": {
+                "title": "Preferred name / known as",
                 "type": "string"
               },
-              "lastName": {
-                "title": "Last name",
+              "surname": {
+                "title": "Surname",
                 "type": "string"
               }
             }
@@ -79,6 +84,7 @@
             "enum": [
               "Seller",
               "Seller's Conveyancer",
+              "Prospective Buyer",
               "Buyer",
               "Buyer's Conveyancer",
               "Estate Agent"
@@ -130,6 +136,97 @@
           "RDSRef": "",
           "title": "Energy Performance Certificate",
           "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json"
+        },
+        "risks": {
+          "RDSRef": "",
+          "title": "Risks",
+          "type": "object",
+          "properties": {
+            "coalMining": {
+              "title": "Coal mining",
+              "$ref": "#/$defs/riskIndicatorAndSearch"
+            },
+            "flood": {
+              "title": "Flood",
+              "$ref": "#/$defs/riskIndicatorAndSearch"
+            },
+            "miningAndGroundStability": {
+              "title": "Mining and ground stability",
+              "type": "object",
+              "properties": {
+                "bathStone": {
+                  "title": "Bath Stone",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "metalliferousTin": {
+                  "title": "Matalliferous (Tin)",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "kaolinAndBallClay": {
+                  "title": "Kaolin and ball clay",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "limestone": {
+                  "title": "Limestone",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "brine": {
+                  "title": "Brine",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "groundStability": {
+                  "title": "Ground stability",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "nonCoalMining": {
+                  "title": "Non coal mining",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "groundMovement": {
+                  "title": "Ground movement",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "mineral": {
+                  "title": "Mineral",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                }
+              }
+            },
+            "energyAndInfrastructure": {
+              "title": "Energy and infrastructure",
+              "type": "object",
+              "properties": {
+                "hs2": {
+                  "title": "HS2",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "crossrail": {
+                  "title": "Crossrail",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "londonUnderground": {
+                  "title": "London Underground",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "energyExploration": {
+                  "title": "Energy exploration",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "windFarms": {
+                  "title": "Wind farms",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "solarFarms": {
+                  "title": "Solar farms",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                },
+                "renewablePowerPlants": {
+                  "title": "Renewable power plants",
+                  "$ref": "#/$defs/riskIndicatorAndSearch"
+                }
+              }
+            }
+          }
         }
       }
     }
@@ -162,6 +259,17 @@
         }
       },
       "required": ["address1", "postcode"]
+    },
+    "riskIndicatorAndSearch": {
+      "type": "object",
+      "properties": {
+        "hasRisk": {
+          "title": "",
+          "type": "string",
+          "enum": ["Yes", "No"]
+        }
+      },
+      "required": ["address1", "postcode"]
     }
   }
 }

package/src/tests/transactionSchema.test.js

@@ -4,6 +4,7 @@ const {
   transactionSchema,
   validator,
   getSubschema,
+  isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
 } = require("../../index.js");
@@ -43,6 +44,26 @@ test("correctly gets a top level subschema", () => {
   expect(subschema.title).toBe("Property Pack");
 });
 
+test("correctly identifies a valid path", () => {
+  const isValid = isPathValid("/propertyPack/materialFacts");
+  expect(isValid).toBe(true);
+});
+
+test("correctly identifies an undefined invalid path", () => {
+  const isValid = isPathValid("/propertyPack/materialItems");
+  expect(isValid).toBe(false);
+});
+
+test("correctly identifies an error generating invalid path", () => {
+  const isValid = isPathValid("/propertyPack/materialItems/someProperty/item");
+  expect(isValid).toBe(false);
+});
+
+test("correctly identifies an array invalid path", () => {
+  const isValid = isPathValid("/propertyPack/materialFacts/1/item");
+  expect(isValid).toBe(false);
+});
+
 test("correctly gets a subschema", () => {
   const subschema = getSubschema("/propertyPack/materialFacts/notices");
   expect(subschema.title).toBe("Notices which Affect the Property");
@@ -56,8 +77,8 @@ test("correctly gets a subschema through an arrays element", () => {
 });
 
 test("correctly gets another subschema through an arrays element", () => {
-  const subschema = getSubschema("/participants/0/name/firstName");
-  expect(subschema.title).toBe("First name");
+  const subschema = getSubschema("/participants/0/name/forenames");
+  expect(subschema.title).toBe("Forenames");
 });
 
 test("correctly gets a subschema validator which is already cached", () => {