@pdtf/schemas 0.6.2 → 0.6.5

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]);
@@ -51,6 +52,7 @@ const isPathValid = (path) => {
     return false;
   }
 };
+
 const getSubschemaValidator = (path) => {
   const subSchema = getSubschema(path);
   let validator = ajv.getSchema(path);

package/package.json

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

package/src/examples/exampleElectronicRecord.json

@@ -20,8 +20,8 @@
   },
   "claims": {
     "/propertyPack/materialFacts/address": {
-      "address1": "3 The Hollys",
-      "address2": "Birtley",
+      "line1": "3 The Hollys",
+      "line2": "Birtley",
       "town": "CHESTER LE STREET",
       "county": "County Durham",
       "postcode": "DH3 1QN"

package/src/examples/exampleTransaction.json

@@ -1,17 +1,17 @@
 {
-  "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-transaction.json",
+  "$schema": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-transaction.json",
   "transactionId": "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a",
   "status": "active",
   "participants": [
     {
       "name": {
-        "forenames": "Peter Ronald",
-        "surname": "Hetherington-Smythe"
+        "firstName": "Peter",
+        "lastName": "Hetherington-Smythe"
       },
       "dateOfBirth": "1975-12-25",
       "phone": "07777 222333",
       "email": "peter@theseller.com",
-      "address": { "address1": "47 Park Road", "postcode": "AL3 5AF" },
+      "address": { "line1": "47 Park Road", "postcode": "AL3 5AF" },
       "role": "Seller"
     }
   ],
@@ -19,8 +19,8 @@
     "materialFacts": {
       "uprn": 1241304304,
       "address": {
-        "address1": "47 Park Road",
-        "address2": "",
+        "line1": "47 Park Road",
+        "line2": "",
         "town": "HARPENDEN",
         "county": "Herts",
         "postcode": "AL3 5AF"

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.",
@@ -1625,12 +1625,12 @@
     "address": {
       "type": "object",
       "properties": {
-        "address1": {
+        "line1": {
           "title": "Address 1",
           "type": "string",
           "minLength": 1
         },
-        "address2": {
+        "line2": {
           "title": "Address 2",
           "type": "string"
         },
@@ -1648,7 +1648,7 @@
           "minLength": 1
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["line1", "postcode"]
     },
     "contactDetails": {
       "type": "object",

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.",
@@ -917,11 +917,11 @@
     "address": {
       "type": "object",
       "properties": {
-        "address1": {
+        "line1": {
           "title": "Address 1",
           "type": "string"
         },
-        "address2": {
+        "line2": {
           "title": "Address 2",
           "type": "string"
         },
@@ -938,7 +938,7 @@
           "type": "string"
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["line1", "postcode"]
     }
   }
 }

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,6 +1,6 @@
 {
   "$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.",
@@ -34,20 +34,24 @@
         "required": ["name", "email", "role"],
         "properties": {
           "name": {
-            "title": "",
+            "title": "Name",
             "type": "object",
-            "required": ["forenames", "surname"],
+            "required": ["firstName", "lastName"],
             "properties": {
-              "forenames": {
-                "title": "Forenames",
+              "firstName": {
+                "title": "First name",
                 "type": "string"
               },
-              "preferredName": {
-                "title": "Preferred name / known as",
+              "middleName": {
+                "title": "Middle name(s)",
+                "type": "string"
+              },
+              "lastName": {
+                "title": "lastName",
                 "type": "string"
               },
-              "surname": {
-                "title": "Surname",
+              "preferredName": {
+                "title": "Preferred name / known as",
                 "type": "string"
               }
             }
@@ -98,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": "",
@@ -127,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"
               }
             }
           }
@@ -135,7 +139,7 @@
         "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": "",
@@ -235,12 +239,12 @@
     "address": {
       "type": "object",
       "properties": {
-        "address1": {
+        "line1": {
           "title": "Address 1",
           "type": "string",
           "minLength": 1
         },
-        "address2": {
+        "line2": {
           "title": "Address 2",
           "type": "string"
         },
@@ -258,7 +262,7 @@
           "minLength": 1
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["line1", "postcode"]
     },
     "riskIndicatorAndSearch": {
       "type": "object",
@@ -269,7 +273,7 @@
           "enum": ["Yes", "No"]
         }
       },
-      "required": ["address1", "postcode"]
+      "required": ["hasRisk"]
     }
   }
 }

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

@@ -77,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/forenames");
-  expect(subschema.title).toBe("Forenames");
+  const subschema = getSubschema("/participants/0/name/firstName");
+  expect(subschema.title).toBe("First name");
 });
 
 test("correctly gets a subschema validator which is already cached", () => {