@pdtf/schemas 0.6.0 → 0.6.4

package/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

package/index.js

@@ -11,14 +11,15 @@ const geoJson = require("./src/schemas/GeoJSON.json");
 const verifiedClaimsSchema = require("./src/schemas/pdtf-verified-claims.json");
 
 const subSchemas = {
-  "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json":
+  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-a-material-facts.json":
     baspiMaterialFacts,
-  "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json":
+  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-b-legal-information.json":
     baspiLegalInformation,
-  "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json":
+  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/energy-performance-certificate.json":
     energyPerformanceCertificate,
   "https://geojson.org/schema/GeoJSON.json": geoJson,
-  "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json": titleDeed,
+  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/title-deed.json":
+    titleDeed,
 };
 
 const transactionSchema = dereference(pdtfTransaction, (id) => subSchemas[id]);
@@ -44,6 +45,14 @@ 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 +112,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.4",
   "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": {
+        "firstName": "Peter",
+        "lastName": "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/baspi-a-material-facts.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-a-material-facts.json",
   "type": "object",
   "title": "Material facts at the point of marketing",
   "description": "BASPI v2.0 Part A - Disclosure of material facts at the point of marketing, supporting mapping to BASPI, Law Society and RICS Data Schema elements.",

package/src/schemas/baspi-b-legal-information.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-b-legal-information.json",
   "type": "object",
   "title": "Additional information required for the legal process",
   "description": "A schema defining Part B of BASPI v2.0 spporting mapping to BASPI, Law Society and RICS Data Schema elements.",

package/src/schemas/energy-performance-certificate.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/energy-performance-certificate.json",
   "type": "object",
   "title": "Energy Performance Certificate and Recommendations Schema, supporting data retrieved from https://epc.opendatacommunities.org ",
   "description": "Mirrors the Domestic EPC Glossary at https://epc.opendatacommunities.org/docs/guidance#glossary",

package/src/schemas/pdtf-transaction.json

@@ -1,16 +1,29 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-transaction.json",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-transaction.json",
   "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,27 @@
       "items": {
         "type": "object",
         "title": "Participant Details",
-        "required": [
-          "name",
-          "dateOfBirth",
-          "phone",
-          "email",
-          "address",
-          "role"
-        ],
+        "required": ["name", "email", "role"],
         "properties": {
           "name": {
-            "title": "",
+            "title": "Name",
             "type": "object",
             "required": ["firstName", "lastName"],
             "properties": {
               "firstName": {
-                "RDSRef": "",
                 "title": "First name",
                 "type": "string"
               },
-              "middleNames": {
+              "middleName": {
                 "title": "Middle name(s)",
                 "type": "string"
               },
               "lastName": {
-                "title": "Last name",
+                "title": "lastName",
+                "type": "string"
+              },
+              "preferredName": {
+                "title": "Preferred name / known as",
                 "type": "string"
               }
             }
@@ -79,6 +88,7 @@
             "enum": [
               "Seller",
               "Seller's Conveyancer",
+              "Prospective Buyer",
               "Buyer",
               "Buyer's Conveyancer",
               "Estate Agent"
@@ -92,10 +102,10 @@
       "type": "object",
       "properties": {
         "materialFacts": {
-          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json"
+          "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-a-material-facts.json"
         },
         "additionalLegalInfo": {
-          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json"
+          "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-b-legal-information.json"
         },
         "titlesToBeSold": {
           "RDSRef": "",
@@ -121,7 +131,7 @@
               },
               "registerExtract": {
                 "title": "HMLR Register Extract",
-                "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json"
+                "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/title-deed.json"
               }
             }
           }
@@ -129,7 +139,98 @@
         "energyPerformanceCertificate": {
           "RDSRef": "",
           "title": "Energy Performance Certificate",
-          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json"
+          "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/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 +263,17 @@
         }
       },
       "required": ["address1", "postcode"]
+    },
+    "riskIndicatorAndSearch": {
+      "type": "object",
+      "properties": {
+        "hasRisk": {
+          "title": "",
+          "type": "string",
+          "enum": ["Yes", "No"]
+        }
+      },
+      "required": ["address1", "postcode"]
     }
   }
 }

package/src/schemas/pdtf-verified-claims.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-verified-claims.json",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-verified-claims.json",
   "definitions": {
     "date_type": {
       "type": "string",
@@ -387,7 +387,7 @@
         "claims": {
           "type": "object",
           "patternProperties": {
-            "^(/|([a-zA-Z0-9/-]+)+$)": { "type": "object" }
+            "^(/|([a-zA-Z0-9/-]+)+$)": {}
           },
           "minProperties": 1,
           "additionalProperties": false

package/src/schemas/title-deed.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json",
+  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/title-deed.json",
   "title": "HMLR Official Copy Register Extract",
   "description": "A schema mirroring the V2_1 XML version of the HMLR Register Extract web service.",
   "definitions": {

package/src/tests/pdtfVerifiedClaims.test.js

@@ -29,6 +29,20 @@ test("valid documented vouch sample is valid", () => {
   expect(isValid).toBe(true);
 });
 
+test("sample with primitive claims value is valid", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = { "/propertyPack/uprn": 123456 };
+  const isValid = validator({ verified_claims: clonedVouch });
+  expect(isValid).toBe(true);
+});
+
+test("sample with undefined claims value is also valid, but this would fail when the payload is validated", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = { "/propertyPack/uprn": undefined };
+  const isValid = validator({ verified_claims: clonedVouch });
+  expect(isValid).toBe(true);
+});
+
 test("claim with missing claims is invalid", () => {
   const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
   delete clonedVouch.claims;

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");