@pdtf/schemas 2.1.2-1 → 2.2.0

package/README.md

@@ -3,7 +3,7 @@ This repository contains the versioned schemas for the Property Data Trust Frame
 
 The aim of the framework is to enable the frictionless exchange of property data between software products and services, supported by trusted information regarding the provenance of that data.
 
-The short term goal for the schema is to encompass all of the requirements of the [Home Buying and Selling Group](https://homebuyingandsellinggroup.co.uk) 'Property Pack', starting with the Buyers and Sellers Property Information set ([BASPI v2.0](https://homebuyingandsellinggroup.co.uk/baspi/)).
+The short term goal for the schema is to encompass all of the requirements of the [Home Buying and Selling Group](https://homebuyingandsellinggroup.co.uk) 'Property Pack', starting with the Buyers and Sellers Property Information set ([BASPI v4.0](https://homebuyingandsellinggroup.co.uk/baspi/)).
 
 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.
 

package/package.json

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

package/src/examples/v2/exampleTransaction.json

@@ -872,7 +872,7 @@
         "status": "Ordered",
         "orderDate": "2022-10-06T08:55:49.483",
         "expectedDeliveryDate": "2022-10-10T08:55:49",
-        "searchContentTypes": ["Flood", "Contaminated Land", "Ground Stability"]
+        "contentTypes": ["Environmental Risks"]
       },
       {
         "displayName": "Drainage and Water Enquiry (Residential)",
@@ -881,7 +881,7 @@
         "status": "Ordered",
         "orderDate": "2022-10-06T08:55:49.5",
         "expectedDeliveryDate": "2022-10-13T08:55:49",
-        "searchContentTypes": ["Drainage and Water Searches"]
+        "contentTypes": ["Drainage and Water Search"]
       },
       {
         "displayName": "Environmental Risk Flags",
@@ -889,99 +889,24 @@
         "providerName": "TM Group",
         "status": "Delivered",
         "reportDate": "2022-10-13T08:55:49",
-        "searchContentTypes": [
-          "Coal",
-          "Bath Stone",
-          "Metalliferous (Tin)",
-          "Kaolin & Ball Clay",
-          "Limestone",
-          "Brine",
-          "HS2",
-          "Flood",
-          "Crossrail",
-          "Energy Exploration",
-          "Wind Farms",
-          "Renewable Power Plants",
-          "Solar Farms",
-          "London Underground",
-          "Ground Stability",
-          "Non Coal Mining",
-          "Ground Movement",
-          "Mineral"
-        ],
-
+        "contentTypes": ["Environmental Risks"],
         "results": [
           {
-            "contentType": "Coal",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Bath Stone",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Metalliferous (Tin)",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Kaolin & Ball Clay",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Limestone",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Brine",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "HS2",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Flood",
-            "recommendedActionIndicator": "Yes"
-          },
-          {
-            "contentType": "Crossrail",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Energy Exploration",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Wind Farms",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Renewable Power Plants",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Solar Farms",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "London Underground",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Ground Stability",
-            "recommendedActionIndicator": "Yes"
-          },
-          {
-            "contentType": "Non Coal Mining",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Ground Movement",
-            "recommendedActionIndicator": "No"
-          },
-          {
-            "contentType": "Mineral",
-            "recommendedActionIndicator": "No"
+            "contentType": "Environmental Risks",
+            "riskResults": [
+              {
+                "riskCategory": "Flood",
+                "recommendedActionIndicator": "Yes"
+              },
+              {
+                "riskCategory": "Ground Stability",
+                "recommendedActionIndicator": "Yes"
+              },
+              {
+                "riskCategory": "Mining",
+                "recommendedActionIndicator": "No"
+              }
+            ]
           }
         ]
       }

package/src/schemas/v1/material-facts.json

@@ -108,6 +108,17 @@
             "Offers in region of",
             "Sale by tender"
           ]
+        },
+        "disposal": {
+          "title": "Disposal",
+          "type": "string",
+          "enum": [
+            "Auction",
+            "Formal tender",
+            "Informal tender",
+            "Modern Method of Auction",
+            "Private treaty"
+          ]
         }
       }
     },
@@ -115,6 +126,17 @@
       "title": "Summary description",
       "type": "string"
     },
+    "marketingTenure": {
+      "title": "Type of tenure being marketed",
+      "type": "string",
+      "enum": [
+        "Commonhold",
+        "Freehold",
+        "Leasehold",
+        "Share of Freehold",
+        "Shared Ownership"
+      ]
+    },
     "media": {
       "title": "Media",
       "type": "array",

package/src/schemas/v1/searches/local-searches-required.json

@@ -441,7 +441,7 @@
             },
             "housing": {
               "con29RRef": "3.7(d)",
-              "title": "(housing;",
+              "title": "housing;",
               "$ref": "#/$defs/yesNoDetailIfYes"
             },
             "highways": {
@@ -485,7 +485,7 @@
             },
             "listedBuildingEnforcementNotice": {
               "con29RRef": "3.9(c)",
-              "title": "(a listed building enforcement notice;",
+              "title": "a listed building enforcement notice;",
               "$ref": "#/$defs/yesNoDetailIfYes"
             },
             "breachOfConditionNotice": {

package/src/schemas/v1/searches.json

@@ -132,7 +132,7 @@
                 {
                   "properties": {
                     "contentType": {
-                      "enum": ["Drainage and Water Searches"]
+                      "enum": ["Drainage and Water Search"]
                     },
                     "drainageAndWater": {
                       "$ref": "https://trust.propdata.org.uk/schemas/v1/searches/drainage-and-water.json"
@@ -208,7 +208,7 @@
         "Local Land Charges",
         "Required Local Searches",
         "Optional Local Searches Optional",
-        "Drainage and Water Searches",
+        "Drainage and Water Search",
         "Flood",
         "Contaminated Land",
         "Coal",