@pdtf/schemas 3.2.0-2 → 3.2.0-4

package/README.md

@@ -7,3 +7,8 @@ The short term goal for the schema is to encompass all of the requirements of th
 
 A parallel repository for this one has been created for the [Open API Specifications](https://github.com/Property-Data-Trust-Framework/api) for the data exchanges themselves, which will evolve independently.
 
+This repository is intended to be a living document, with the schema evolving over time as the requirements of the framework are refined and extended. The schema is versioned to allow for backwards compatibility and to enable the evolution of the schema over time.
+
+## Licensing
+The schema is licenced under the permissive [MIT License](https://opensource.org/license/MIT), but note that overlays and references are included which contain fields from [BASPI](https://homebuyingsellingcouncil.co.uk/wp-content/uploads/2021/03/Terms-of-Licence-mandatory-download-for-use-of-BASPI.pdf), [PIQ](https://www.propertymark.co.uk/static/14e7c154-98de-4230-957f09bd8d5ddeec/f542b10a-7710-4c37-b3958ccaeec25d4b/property-information-questionnaire-residential-sales.pdf) and [Law Society TA](https://www.lawsociety.org.uk/topics/property/transaction-forms) forms. If you intend to render data described by the schema into one of these forms, you should ensure that you comply with the terms of the respective licences.
+

package/index.js

@@ -1,4 +1,3 @@
-const { dereference } = require("@jdw/jst");
 const merge = require("deepmerge");
 const Ajv = require("ajv");
 const addFormats = require("ajv-formats");
@@ -11,7 +10,7 @@ const ajv = new Ajv({
 // Adds date formats among other types to the validator.
 addFormats(ajv);
 
-const verifiedClaimsSchema = require("./src/schemas/v1/pdtf-verified-claims.json");
+const verifiedClaimsSchema = require("./src/schemas/verifiedClaims/pdtf-verified-claims.json");
 const v2CoreSchema = require("./src/schemas/v2/pdtf-transaction.json");
 const v3CoreSchema = require("./src/schemas/v3/pdtf-transaction.json");
 
@@ -33,7 +32,8 @@ const overlaysMap = {
     null: {},
   },
   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json": {
-    baspiV4: require("./src/schemas/v3/overlays/baspi.json"),
+    baspiV4: require("./src/schemas/v3/overlays/baspi4.json"),
+    baspiV5: require("./src/schemas/v3/overlays/baspi5.json"),
     ta6ed4: require("./src/schemas/v3/overlays/ta6.json"),
     ta7ed3: require("./src/schemas/v3/overlays/ta7.json"),
     ta10ed3: require("./src/schemas/v3/overlays/ta10.json"),

package/package.json

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

package/src/examples/v3/exampleTransaction.json

@@ -5,13 +5,18 @@
   "participants": [
     {
       "name": {
+        "title": "Mr",
         "firstName": "Peter",
         "lastName": "Hetherington-Smythe"
       },
       "dateOfBirth": "1975-12-25",
       "phone": "07777 222333",
       "email": "peter@theseller.com",
-      "address": { "line1": "47 Park Road", "postcode": "AL3 5AF", "countryCode": "GBR" },
+      "address": {
+        "line1": "47 Park Road",
+        "postcode": "AL3 5AF",
+        "countryCode": "GBR"
+      },
       "role": "Seller",
       "sellersCapacity": { "capacity": "Legal Owner" },
       "externalIds": { "Moverly": "123434" }
@@ -38,9 +43,14 @@
       "line2": "",
       "line3": "",
       "town": "HARPENDEN",
-      "postcode": "AL3 5AF"
+      "postcode": "AL3 5AF",
+      "homeNation": "England"
+    },
+    "localAuthority": {
+      "localAuthorityName": "Neverland Hook",
+      "districtCouncil": "Neverland Hook",
+      "countyCouncil": "Neverland County Council"
     },
-    "localAuthority": { "localAuthorityName": "Neverland Hook", "districtCouncil": "Neverland Hook", "countyCouncil": "Neverland County Council" },
     "priceInformation": {
       "price": 1260000,
       "priceQualifier": "Offers in excess of"
@@ -684,14 +694,18 @@
               "commonholdIndicator": false
             },
             "officialCopyDateTime": "2021-12-16T08:39:52",
-            "propertyAddress": {
-              "postcodeZone": {
-                "postcode": "AL3 5AF"
+            "propertyAddress": [
+              {
+                "postcodeZone": {
+                  "postcode": "AL3 5AF"
+                }
               },
-              "addressLine": {
-                "line": ["47 Park Road", "Harpenden"]
+              {
+                "addressLine": {
+                  "line": ["47 Park Road", "Harpenden"]
+                }
               }
-            },
+            ],
             "proprietorship": {
               "registeredProprietorParty": [
                 {