@pdtf/schemas 0.7.6 → 0.8.0

package/.github/workflows/pages.yml

@@ -0,0 +1,50 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: src
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

package/CNAME

@@ -0,0 +1 @@
+trust.propdata.org.uk

package/index.js

@@ -2,24 +2,33 @@ const { dereference } = require("@jdw/jst");
 const Ajv = require("ajv");
 const addFormats = require("ajv-formats");
 
-const pdtfTransaction = require("./src/schemas/pdtf-transaction.json");
-const materialFacts = require("./src/schemas/material-facts.json");
-const legalInformation = require("./src/schemas/legal-information.json");
-const energyPerformanceCertificate = require("./src/schemas/energy-performance-certificate.json");
-const titleDeed = require("./src/schemas/title-deed.json");
-const geoJson = require("./src/schemas/GeoJSON.json");
-const verifiedClaimsSchema = require("./src/schemas/pdtf-verified-claims.json");
+const pdtfTransaction = require("./src/schemas/v1/pdtf-transaction.json");
+const materialFacts = require("./src/schemas/v1/material-facts.json");
+const legalInformation = require("./src/schemas/v1/legal-information.json");
+const energyPerformanceCertificate = require("./src/schemas/v1/energy-performance-certificate.json");
+const titleDeed = require("./src/schemas/v1/title-deed.json");
+const searches = require("./src/schemas/v1/searches.json");
+const localLandCharges = require("./src/schemas/v1/searches/local-land-charges.json");
+const localSearchesRequired = require("./src/schemas/v1/searches/local-searches-required.json");
+const drainageAndWater = require("./src/schemas/v1/searches/drainage-and-water.json");
+const geoJson = require("./src/schemas/v1/GeoJSON.json");
+const verifiedClaimsSchema = require("./src/schemas/v1/pdtf-verified-claims.json");
 
 const subSchemas = {
-  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/material-facts.json":
-    materialFacts,
-  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/legal-information.json":
+  "https://trust.propdata.org.uk/schemas/v1/material-facts.json": materialFacts,
+  "https://trust.propdata.org.uk/schemas/v1/legal-information.json":
     legalInformation,
-  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/energy-performance-certificate.json":
+  "https://trust.propdata.org.uk/schemas/v1/energy-performance-certificate.json":
     energyPerformanceCertificate,
   "https://geojson.org/schema/GeoJSON.json": geoJson,
-  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/title-deed.json":
-    titleDeed,
+  "https://trust.propdata.org.uk/schemas/v1/title-deed.json": titleDeed,
+  "https://trust.propdata.org.uk/schemas/v1/searches.json": searches,
+  "https://trust.propdata.org.uk/schemas/v1/searches/local-land-charges.json":
+    localLandCharges,
+  "https://trust.propdata.org.uk/schemas/v1/searches/local-searches-required.json":
+    localSearchesRequired,
+  "https://trust.propdata.org.uk/schemas/v1/searches/drainage-and-water.json":
+    drainageAndWater,
 };
 
 const transactionSchema = dereference(pdtfTransaction, (id) => subSchemas[id]);

package/package.json

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

package/src/examples/exampleTransaction.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-transaction.json",
+  "$schema": "https://trust.propdata.org.uk/schemas/v1/pdtf-transaction.json",
   "transactionId": "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a",
   "status": "active",
   "participants": [
@@ -716,6 +716,128 @@
           }
         }
       }
+    ],
+    "searches": [
+      {
+        "displayName": "Groundsure Homebuyers",
+        "productCode": "GSEnviro",
+        "providerName": "TM Group",
+        "status": "Ordered",
+        "orderDate": "2022-10-06T08:55:49.483",
+        "expectedDeliveryDate": "2022-10-10T08:55:49",
+        "searchContentTypes": ["Flood", "Contaminated Land", "Ground Stability"]
+      },
+      {
+        "displayName": "Drainage and Water Enquiry (Residential)",
+        "productCode": "Con29DW",
+        "providerName": "TM Group",
+        "status": "Ordered",
+        "orderDate": "2022-10-06T08:55:49.5",
+        "expectedDeliveryDate": "2022-10-13T08:55:49",
+        "searchContentTypes": ["Drainage and Water Searches"]
+      },
+      {
+        "displayName": "Environmental Risk Flags",
+        "productCode": "TMRiskFlags",
+        "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"
+        ],
+
+        "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"
+          }
+        ]
+      }
     ]
   }
 }

package/src/schemas/{energy-performance-certificate.json → v1/energy-performance-certificate.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/energy-performance-certificate.json",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/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/{legal-information.json → v1/legal-information.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-b-legal-information.json",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/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/{material-facts.json → v1/material-facts.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-a-material-facts.json",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/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.",
@@ -732,7 +732,17 @@
           "title": "Energy Efficiency Rating",
           "description": "What is the energy efficiency rating of the property according to the latest Energy Performance Certificate (EPC)?",
           "type": "string",
-          "enum": ["A", "B", "C", "D", "E", "F", "G", "Exempt Property"]
+          "enum": [
+            "A",
+            "B",
+            "C",
+            "D",
+            "E",
+            "F",
+            "G",
+            "Exempt Property",
+            "Survey Instructed"
+          ]
         },
         "hasSprayFoamInstalled": {
           "baspiRef": "A1.8.4",

package/src/schemas/{pdtf-transaction-search-results.json → v1/pdtf-transaction-search-results.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/minified-pdtf-transaction.json",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/minified-pdtf-transaction.json",
   "title": "Property Data Trust Framework Transaction Schema",
   "description": "A schema defining search results containing minimal elements of the PDTF transaction data structure.",
   "type": "array",

package/src/schemas/{pdtf-transaction.json → v1/pdtf-transaction.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-transaction.json",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/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.",
@@ -107,10 +107,10 @@
       "type": "object",
       "properties": {
         "materialFacts": {
-          "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/material-facts.json"
+          "$ref": "https://trust.propdata.org.uk/schemas/v1/material-facts.json"
         },
         "additionalLegalInfo": {
-          "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/legal-information.json"
+          "$ref": "https://trust.propdata.org.uk/schemas/v1/legal-information.json"
         },
         "titlesToBeSold": {
           "RDSRef": "",
@@ -125,6 +125,11 @@
                 "title": "Title Number",
                 "type": "string"
               },
+              "titleIncludedInSale": {
+                "RDSRef": "",
+                "title": "Confirms that this associated title is included in the sale",
+                "type": "boolean"
+              },
               "titleExtents": {
                 "RDSRef": "",
                 "title": "Title Extents",
@@ -136,7 +141,7 @@
               },
               "registerExtract": {
                 "title": "HMLR Register Extract",
-                "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/title-deed.json"
+                "$ref": "https://trust.propdata.org.uk/schemas/v1/title-deed.json"
               }
             }
           }
@@ -144,98 +149,12 @@
         "energyPerformanceCertificate": {
           "RDSRef": "",
           "title": "Energy Performance Certificate",
-          "$ref": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/energy-performance-certificate.json"
+          "$ref": "https://trust.propdata.org.uk/schemas/v1/energy-performance-certificate.json"
         },
-        "risks": {
+        "searches": {
           "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"
-                }
-              }
-            }
-          }
+          "title": "Searches",
+          "$ref": "https://trust.propdata.org.uk/schemas/v1/searches.json"
         }
       }
     }
@@ -268,17 +187,6 @@
         }
       },
       "required": ["line1", "postcode"]
-    },
-    "riskIndicatorAndSearch": {
-      "type": "object",
-      "properties": {
-        "hasRisk": {
-          "title": "",
-          "type": "string",
-          "enum": ["Yes", "No"]
-        }
-      },
-      "required": ["hasRisk"]
     }
   }
 }

package/src/schemas/{pdtf-verified-claims.json → v1/pdtf-verified-claims.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/pdtf-verified-claims.json",
+  "$id": "https://trust.propdata.org.uk/schemas/v1/pdtf-verified-claims.json",
   "definitions": {
     "date_type": {
       "type": "string",