@pdtf/schemas 0.5.15 → 0.6.0

package/index.js

@@ -2,7 +2,7 @@ const { dereference } = require("@jdw/jst");
 const Ajv = require("ajv");
 const addFormats = require("ajv-formats");
 
-const propertyPack = require("./src/schemas/property-pack.json");
+const pdtfTransaction = require("./src/schemas/pdtf-transaction.json");
 const baspiMaterialFacts = require("./src/schemas/baspi-a-material-facts.json");
 const baspiLegalInformation = require("./src/schemas/baspi-b-legal-information.json");
 const energyPerformanceCertificate = require("./src/schemas/energy-performance-certificate.json");
@@ -21,7 +21,7 @@ const subSchemas = {
   "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json": titleDeed,
 };
 
-const propertyPackSchema = dereference(propertyPack, (id) => subSchemas[id]);
+const transactionSchema = dereference(pdtfTransaction, (id) => subSchemas[id]);
 
 const ajv = new Ajv({
   allErrors: true,
@@ -31,17 +31,17 @@ const ajv = new Ajv({
 // Adds date formats among other types to the validator.
 addFormats(ajv);
 
-const validator = ajv.compile(propertyPackSchema);
+const validator = ajv.compile(transactionSchema);
 
 const getSubschema = (path) => {
   const pathArray = path.split("/").slice(1);
   if (pathArray.length < 1) {
-    return propertyPackSchema;
+    return transactionSchema;
   }
   return pathArray.reduce((schema, pathElement) => {
     if (schema.type === "array") return schema.items;
     return schema.properties[pathElement];
-  }, propertyPackSchema);
+  }, transactionSchema);
 };
 
 const getSubschemaValidator = (path) => {
@@ -100,7 +100,7 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
 };
 
 module.exports = {
-  propertyPackSchema,
+  transactionSchema,
   validator,
   getSubschema,
   getSubschemaValidator,

package/package.json

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

package/src/examples/exampleDocumentedVouch.json

@@ -31,7 +31,7 @@
     ]
   },
   "claims": {
-    "/propertyPack/materialFacts/propertyToBeSold/councilTax": {
+    "/propertyPack/materialFacts/councilTax": {
       "councilTaxBand": "D",
       "councilTaxAffectingAlterations": {
         "yesNo": "Yes",

package/src/examples/exampleElectronicRecord.json

@@ -5,9 +5,13 @@
     "evidence": [
       {
         "type": "electronic_record",
+        "verifier": {
+          "organization": "Property Pack Assembly Software Ltd"
+        },
         "record": {
           "source": {
-            "name": "Royal Mail Postcode Address File record via ideal-postcodes.co.uk"
+            "name": "Royal Mail Postcode Address File",
+            "rights": "(c) Royal Mail"
           },
           "type": "postcode_address_file"
         }

package/src/examples/{examplePropertyPack.json → exampleTransaction.json}

@@ -1,19 +1,19 @@
 {
-  "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
-  "uprn": 100000059583,
+  "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/pdtf-transaction.json",
+  "transactionId": "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a",
+  "participants": [
+    {
+      "name": { "firstName": "Peter", "lastName": "Hetherington-Smythe" },
+      "dateOfBirth": "1975-12-25",
+      "phone": "07777 222333",
+      "email": "john@theseller.com",
+      "address": { "address1": "47 Park Road", "postcode": "AL3 5AF" },
+      "role": "Seller"
+    }
+  ],
   "propertyPack": {
-    "sellers": {
-      "sellerInformation": [
-        {
-          "name": { "firstName": "Peter", "lastName": "Hetherington-Smythe" },
-          "dateOfBirth": "1975-12-25",
-          "mobileNumber": "07777 222333",
-          "email": "john@theseller.com",
-          "address": { "address1": "47 Park Road", "postcode": "AL3 5AF" }
-        }
-      ]
-    },
     "materialFacts": {
+      "uprn": 1241304304,
       "address": {
         "address1": "47 Park Road",
         "address2": "",

package/src/examples/exampleVouch.json

@@ -18,7 +18,7 @@
     ]
   },
   "claims": {
-    "/propertyPack/materialFacts/propertyToBeSold/delayFactors/hasDelayFactors": {
+    "/propertyPack/materialFacts/delayFactors/hasDelayFactors": {
       "yesNo": "No"
     }
   }

package/src/schemas/baspi-a-material-facts.json

@@ -6,6 +6,7 @@
   "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.",
   "baspiRef": "A",
   "required": [
+    "uprn",
     "address",
     "delayFactors",
     "ownership",
@@ -31,6 +32,11 @@
     "consumerProtectionRegulationsDeclaration"
   ],
   "properties": {
+    "uprn": {
+      "RDSRef": "Property/GUID/{name='UPRN',id=?}",
+      "title": "Unique Property Reference Number ",
+      "type": "integer"
+    },
     "address": {
       "baspiRef": "A1.1",
       "RDSRef": "Property/Address/xal:AddressDetails",

package/src/schemas/pdtf-transaction.json

@@ -0,0 +1,167 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://homebuyingandsellinggroup.co.uk/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"],
+  "properties": {
+    "transactionId": {
+      "title": "UUID for the transaction",
+      "type": "string",
+      "format": "uuid"
+    },
+    "participants": {
+      "title": "Transaction participants",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "title": "Participant Details",
+        "required": [
+          "name",
+          "dateOfBirth",
+          "phone",
+          "email",
+          "address",
+          "role"
+        ],
+        "properties": {
+          "name": {
+            "title": "",
+            "type": "object",
+            "required": ["firstName", "lastName"],
+            "properties": {
+              "firstName": {
+                "RDSRef": "",
+                "title": "First name",
+                "type": "string"
+              },
+              "middleNames": {
+                "title": "Middle name(s)",
+                "type": "string"
+              },
+              "lastName": {
+                "title": "Last name",
+                "type": "string"
+              }
+            }
+          },
+          "dateOfBirth": {
+            "title": "Date of birth",
+            "type": "string",
+            "format": "date"
+          },
+          "phone": {
+            "title": "Phone number",
+            "type": "string"
+          },
+          "email": {
+            "title": "Email address",
+            "type": "string",
+            "format": "email"
+          },
+          "address": {
+            "title": "Address",
+            "$ref": "#/$defs/address"
+          },
+          "organisation": {
+            "title": "Organisation",
+            "type": "string"
+          },
+          "organisationReference": {
+            "title": "Reference",
+            "type": "string"
+          },
+          "role": {
+            "title": "Role",
+            "type": "string",
+            "enum": [
+              "Seller",
+              "Seller's Conveyancer",
+              "Buyer",
+              "Buyer's Conveyancer",
+              "Estate Agent"
+            ]
+          }
+        }
+      }
+    },
+    "propertyPack": {
+      "title": "Property Pack",
+      "type": "object",
+      "properties": {
+        "materialFacts": {
+          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json"
+        },
+        "additionalLegalInfo": {
+          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json"
+        },
+        "titlesToBeSold": {
+          "RDSRef": "",
+          "title": "Title(s) as registered with HMLR which are included in the sale",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "title": "Registered Title",
+            "properties": {
+              "titleNumber": {
+                "RDSRef": "",
+                "title": "Title Number",
+                "type": "string"
+              },
+              "titleExtents": {
+                "RDSRef": "",
+                "title": "Title Extents",
+                "description": "One or more index polygons describing indicative location of registered title from National Polygon Dataset",
+                "type": "array",
+                "items": {
+                  "$ref": "https://geojson.org/schema/GeoJSON.json"
+                }
+              },
+              "registerExtract": {
+                "title": "HMLR Register Extract",
+                "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json"
+              }
+            }
+          }
+        },
+        "energyPerformanceCertificate": {
+          "RDSRef": "",
+          "title": "Energy Performance Certificate",
+          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json"
+        }
+      }
+    }
+  },
+  "$defs": {
+    "address": {
+      "type": "object",
+      "properties": {
+        "address1": {
+          "title": "Address 1",
+          "type": "string",
+          "minLength": 1
+        },
+        "address2": {
+          "title": "Address 2",
+          "type": "string"
+        },
+        "town": {
+          "title": "Town",
+          "type": "string"
+        },
+        "county": {
+          "title": "County",
+          "type": "string"
+        },
+        "postcode": {
+          "title": "Postcode",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": ["address1", "postcode"]
+    }
+  }
+}

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

@@ -134,8 +134,7 @@
                 "$ref": "#/definitions/document_details"
               }
             }
-          },
-          "else": {}
+          }
         },
         {
           "if": {
@@ -155,6 +154,7 @@
               },
               "verifier": {
                 "type": "object",
+                "required": ["organization"],
                 "properties": {
                   "organization": {
                     "type": "string"
@@ -169,6 +169,7 @@
               },
               "record": {
                 "type": "object",
+                "required": ["source"],
                 "properties": {
                   "type": {
                     "type": "string"
@@ -184,6 +185,7 @@
                   },
                   "source": {
                     "type": "object",
+                    "required": ["name"],
                     "properties": {
                       "name": {
                         "type": "string"
@@ -211,14 +213,14 @@
                       },
                       "jurisdiction": {
                         "type": "string"
-                      }
+                      },
+                      "rights": { "type": "string" }
                     }
                   }
                 }
               }
             }
-          },
-          "else": {}
+          }
         },
         {
           "if": {
@@ -307,8 +309,7 @@
                 }
               }
             }
-          },
-          "else": {}
+          }
         }
       ]
     },

package/src/tests/{propertyPackSchema.test.js → transactionSchema.test.js}

@@ -1,40 +1,40 @@
 const jp = require("jsonpointer");
 
 const {
-  propertyPackSchema,
+  transactionSchema,
   validator,
   getSubschema,
   getSubschemaValidator,
   getTitleAtPath,
 } = require("../../index.js");
-const examplePropertyPack = require("../examples/examplePropertyPack.json");
+const exampleTransaction = require("../examples/exampleTransaction.json");
 
 test("exports a property pack schema", () => {
-  expect(propertyPackSchema).not.toBeNull();
+  expect(transactionSchema).not.toBeNull();
 });
 
 test("sample is valid", () => {
-  const isValid = validator(examplePropertyPack);
+  const isValid = validator(exampleTransaction);
   if (!isValid) console.log(validator.errors);
   expect(isValid).toBe(true);
 });
 
 test("invalid sample is invalid", () => {
-  const clonedExamplePropertyPack = JSON.parse(
-    JSON.stringify(examplePropertyPack)
+  const clonedExampleTransaction = JSON.parse(
+    JSON.stringify(exampleTransaction)
   );
-  delete clonedExamplePropertyPack.propertyPack.materialFacts.notices;
-  const isValid = validator(clonedExamplePropertyPack);
+  delete clonedExampleTransaction.propertyPack.materialFacts.notices;
+  const isValid = validator(clonedExampleTransaction);
   expect(isValid).toBe(false);
 });
 
 test("sample with missing dependent required fields is invalid", () => {
-  const clonedExamplePropertyPack = JSON.parse(
-    JSON.stringify(examplePropertyPack)
+  const clonedExampleTransaction = JSON.parse(
+    JSON.stringify(exampleTransaction)
   );
-  clonedExamplePropertyPack.propertyPack.materialFacts.ownership.ownershipType =
+  clonedExampleTransaction.propertyPack.materialFacts.ownership.ownershipType =
     "leashold";
-  const isValid = validator(clonedExamplePropertyPack);
+  const isValid = validator(clonedExampleTransaction);
   expect(isValid).toBe(false);
 });
 
@@ -56,9 +56,7 @@ test("correctly gets a subschema through an arrays element", () => {
 });
 
 test("correctly gets another subschema through an arrays element", () => {
-  const subschema = getSubschema(
-    "/propertyPack/sellers/sellerInformation/0/name/firstName"
-  );
+  const subschema = getSubschema("/participants/0/name/firstName");
   expect(subschema.title).toBe("First name");
 });
 
@@ -76,7 +74,7 @@ test("correctly gets a subschema validator which is already cached", () => {
 test("correctly gets a subschema validator which validates", () => {
   const path = "/propertyPack/materialFacts/notices";
   const validator = getSubschemaValidator(path);
-  const data = jp.get(examplePropertyPack, path);
+  const data = jp.get(exampleTransaction, path);
   expect(data.neighbourDevelopment.yesNo).toBe("No");
   let isValid = validator(data);
   expect(isValid).toBe(true);
@@ -88,51 +86,48 @@ test("correctly gets a subschema validator which validates", () => {
 test("correctly gets titles across schemas, arrays and non-existient title properties", () => {
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/materialFacts/ownership/ownershipType"
     )
   ).toBe("What type of ownership is the property?");
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/materialFacts/ownership/leaseholdDetails/lengthOfLeaseInYears"
     )
   ).toBe("Length of lease (years)");
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/materialFacts/ownership/managedFreeholdOrCommonhold/annualServiceCharge"
     )
   ).toBe(
     "Amount of current annual service charge/estate rentcharge/maintenance contribution (£)"
   );
   expect(
-    getTitleAtPath(
-      propertyPackSchema,
-      "/propertyPack/materialFacts/invalidPath"
-    )
+    getTitleAtPath(transactionSchema, "/propertyPack/materialFacts/invalidPath")
   ).toBe(undefined);
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract"
     )
   ).toBe("HMLR Official Copy Register Extract");
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
     )
   ).toBe("Property address");
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
     )
   ).toBe(undefined);
   expect(
     getTitleAtPath(
-      propertyPackSchema,
+      transactionSchema,
       "/propertyPack/energyPerformanceCertificate/certificate/currentEnergyRating"
     )
   ).toBe("Current energy rating");

package/src/schemas/property-pack.json

@@ -1,159 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
-  "type": "object",
-  "title": "Property Data Trust Framework Schema",
-  "description": "A schema defining the PDTF Property Pack data structure, supporting mapping to BASPI, Law Society and RICS Data Schema elements.",
-  "required": ["$schema", "uprn", "propertyPack"],
-  "properties": {
-    "$schema": {
-      "title": "The version reference ($id) of the PDTF Schema used",
-      "type": "string"
-    },
-    "uprn": {
-      "RDSRef": "Property/GUID/{name='UPRN',id=?}",
-      "title": "Unique Property Reference Number ",
-      "type": "integer"
-    },
-    "propertyPack": {
-      "title": "Property Pack",
-      "type": "object",
-      "properties": {
-        "sellers": {
-          "RDSRef": "",
-          "title": "Information about the sellers",
-          "type": "object",
-          "required": ["sellerInformation"],
-          "properties": {
-            "sellerInformation": {
-              "title": "",
-              "type": "array",
-              "minItems": 1,
-              "items": {
-                "type": "object",
-                "title": "Seller Details",
-                "required": [
-                  "name",
-                  "dateOfBirth",
-                  "mobileNumber",
-                  "email",
-                  "address"
-                ],
-                "properties": {
-                  "name": {
-                    "title": "",
-                    "type": "object",
-                    "required": ["firstName", "lastName"],
-                    "properties": {
-                      "firstName": {
-                        "RDSRef": "",
-                        "title": "First name",
-                        "type": "string"
-                      },
-                      "middleNames": {
-                        "title": "Middle name(s)",
-                        "type": "string"
-                      },
-                      "lastName": {
-                        "title": "Last name",
-                        "type": "string"
-                      }
-                    }
-                  },
-                  "dateOfBirth": {
-                    "title": "Date of birth",
-                    "type": "string",
-                    "format": "date"
-                  },
-                  "mobileNumber": {
-                    "title": "Mobile number",
-                    "type": "string"
-                  },
-                  "email": {
-                    "title": "Email address",
-                    "type": "string",
-                    "format": "email"
-                  },
-                  "address": {
-                    "title": "Address",
-                    "$ref": "#/$defs/address"
-                  }
-                }
-              }
-            }
-          }
-        },
-        "materialFacts": {
-          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-a-material-facts.json"
-        },
-        "additionalLegalInfo": {
-          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/baspi-b-legal-information.json"
-        },
-        "titlesToBeSold": {
-          "RDSRef": "",
-          "title": "Title(s) as registered with HMLR which are included in the sale",
-          "type": "array",
-          "items": {
-            "type": "object",
-            "title": "Registered Title",
-            "properties": {
-              "titleNumber": {
-                "RDSRef": "",
-                "title": "Title Number",
-                "type": "string"
-              },
-              "titleExtents": {
-                "RDSRef": "",
-                "title": "Title Extents",
-                "description": "One or more index polygons describing indicative location of registered title from National Polygon Dataset",
-                "type": "array",
-                "items": {
-                  "$ref": "https://geojson.org/schema/GeoJSON.json"
-                }
-              },
-              "registerExtract": {
-                "title": "HMLR Register Extract",
-                "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/title-deed.json"
-              }
-            }
-          }
-        },
-        "energyPerformanceCertificate": {
-          "RDSRef": "",
-          "title": "Energy Performance Certificate",
-          "$ref": "https://homebuyingandsellinggroup.co.uk/schemas/energy-performance-certificate.json"
-        }
-      }
-    }
-  },
-  "$defs": {
-    "address": {
-      "type": "object",
-      "properties": {
-        "address1": {
-          "title": "Address 1",
-          "type": "string",
-          "minLength": 1
-        },
-        "address2": {
-          "title": "Address 2",
-          "type": "string"
-        },
-        "town": {
-          "title": "Town",
-          "type": "string"
-        },
-        "county": {
-          "title": "County",
-          "type": "string"
-        },
-        "postcode": {
-          "title": "Postcode",
-          "type": "string",
-          "minLength": 1
-        }
-      },
-      "required": ["address1", "postcode"]
-    }
-  }
-}