@pdtf/schemas 0.7.6 → 0.9.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.9.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": [
@@ -290,13 +290,13 @@
         }
       },
       "insurance": {
+        "isInsured": "Yes",
         "difficultiesObtainingInsurance": {
           "yesNo": "No"
         },
         "insuranceClaims": {
           "yesNo": "No"
-        },
-        "isInsured": "Yes"
+        }
       },
       "boundaries": {
         "partOutsideLegalOwnership": {
@@ -407,8 +407,14 @@
       },
       "occupiers": {
         "sellerLivesAtProperty": { "yesNo": "Yes" },
-        "otherOver17sAtProperty": [],
-        "over17sWillSignToConfirmWillVacate": { "yesNo": "Yes" }
+        "otherOver17sAtProperty": {
+          "hasOver17s": "Yes",
+          "over17sNames": [
+            { "firstName": "Freya", "lastName": "Jones", "age": 21 }
+          ],
+          "over17sTenantsOrLodgers": { "yesNo": "No" },
+          "over17sWillSignToConfirmWillVacate": { "yesNo": "Yes" }
+        }
       },
       "completionAndMoving": {
         "willRemoveAllRubbish": true,
@@ -716,6 +722,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.",
@@ -105,6 +105,7 @@
     },
     "legalBoundaries": {
       "baspiRef": "B2.1",
+      "lawSocietyRef": "TA6/1",
       "title": "Legal Boundaries",
       "description": "Please indicate who has repaired, or treated as belonging to them, each of the boundaries.  Identify each boundary as if you were looking at the property from the road",
       "type": "object",
@@ -281,12 +282,14 @@
                     },
                     "yearInstalled": {
                       "baspiRef": "B4.3.1",
+                      "lawSocietyRef": "TA6/4.6a",
                       "RDSRef": "Objects/Installation",
                       "title": "What year were they installed?",
                       "type": "number"
                     },
                     "panelsOwnedOutright": {
                       "baspiRef": "",
+                      "lawSocietyRef": "TA6/4.6b",
                       "RDSRef": "Objects/Ownership",
                       "title": "Do you own the panels, and all equipment related to them, outright?",
                       "$ref": "#/$defs/yesNoDetailIfNo",
@@ -294,6 +297,7 @@
                     },
                     "panelProviderLease": {
                       "baspiRef": "B4.3.2",
+                      "lawSocietyRef": "TA6/4.6c",
                       "RDSRef": "Objects/Ownership",
                       "title": "Is there an existing long lease of the roof/air space granted to a panel provider?",
                       "$ref": "#/$defs/yesNoDetailIfYes",
@@ -367,7 +371,6 @@
     },
     "smartHomeSystems": {
       "baspiRef": "B7.4",
-      "RDSRef": "",
       "title": "Smart Home Systems",
       "type": "object",
       "required": ["hasSmartHomeSystems"],
@@ -460,7 +463,7 @@
                   "baspiRef": "B5.1.1",
                   "RDSRef": "Certificates",
                   "lawSocietyRef": "TA6/5.1a",
-                  "title": "New Home Warranty",
+                  "title": "New Home Warranty (NHBC or similar)",
                   "$ref": "#/$defs/yesNoDetailIfYes",
                   "description": "If yes, please confirm the name of the warranty provider and the date of the warranty:"
                 },
@@ -510,7 +513,7 @@
                   "baspiRef": "B5.1.8",
                   "RDSRef": "Certificates",
                   "lawSocietyRef": "TA6/5.1h",
-                  "title": "Preventative work and/or remedial action relating to subsidence",
+                  "title": "Underpinning or other preventative work and/or remedial action relating to subsidence",
                   "$ref": "#/$defs/yesNo"
                 },
                 "solarPanels": {
@@ -571,10 +574,7 @@
       "baspiRef": "B6",
       "title": "Occupiers",
       "type": "object",
-      "required": [
-        "sellerLivesAtProperty",
-        "over17sWillSignToConfirmWillVacate"
-      ],
+      "required": ["sellerLivesAtProperty", "otherOver17sAtProperty"],
       "properties": {
         "sellerLivesAtProperty": {
           "baspiRef": "B6.1",
@@ -586,41 +586,87 @@
         "otherOver17sAtProperty": {
           "baspiRef": "B6.2",
           "RDSRef": "Participants",
-          "lawSocietyRef": "TA6/11.3",
-          "title": "Please specify the full names and ages of anyone aged over 17, other than the owner(s), who live at the property?",
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "firstName": {
-                "title": "First Name",
-                "type": "string",
-                "minLength": 1
-              },
-              "middleNames": {
-                "title": "Middle name(s) if any",
-                "type": "string"
-              },
-              "lastName": {
-                "title": "Last Name",
-                "type": "string",
-                "minLength": 1
-              },
-              "age": {
-                "title": "Age",
-                "type": "integer"
-              }
-            },
-            "required": ["firstName", "lastName", "age"]
+          "lawSocietyRef": "TA6/11.1",
+          "title": "Does anyone else, aged 17 or over, live at the property?",
+          "type": "object",
+          "properties": {
+            "hasOver17s": {
+              "type": "string",
+              "title": "",
+              "enum": ["Yes", "No"]
+            }
+          },
+          "required": ["hasOver17s"],
+          "dependencies": {
+            "yesNo": {
+              "oneOf": [
+                {
+                  "properties": {
+                    "hasOver17s": {
+                      "enum": ["No"]
+                    }
+                  },
+                  "additionalProperties": false
+                },
+                {
+                  "properties": {
+                    "hasOver17s": {
+                      "enum": ["Yes"]
+                    },
+                    "over17sNames": {
+                      "lawSocietyRef": "TA6/11.3",
+                      "title": "Please specify their full names and ages.",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "firstName": {
+                            "title": "First Name",
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "middleNames": {
+                            "title": "Middle name(s) if any",
+                            "type": "string"
+                          },
+                          "lastName": {
+                            "title": "Last Name",
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "age": {
+                            "title": "Age",
+                            "type": "integer"
+                          }
+                        },
+                        "required": ["firstName", "lastName", "age"]
+                      }
+                    },
+                    "over17sTenantsOrLodgers": {
+                      "baspiRef": "B6.1",
+                      "RDSRef": "Property/Flags",
+                      "lawSocietyRef": "TA6/11.1",
+                      "title": "Are any of them tenants or lodgers?",
+                      "$ref": "#/$defs/yesNo"
+                    },
+                    "over17sWillSignToConfirmWillVacate": {
+                      "baspiRef": "B6.4",
+                      "RDSRef": "RightsHolders,TenureAgreements,Notifications",
+                      "lawSocietyRef": "TA6/11.5",
+                      "title": "Have all occupiers aged over 17, agreed to sign the contract to confirm that they will vacate the property prior to completion of the sale?",
+                      "$ref": "#/$defs/yesNoDetailIfNo",
+                      "description": "If 'No', please provide details (e.g. the property is sold let to tenants) and supply a copy of the tenancy agreement together with a copy of any notice to quit which has been served upon them."
+                    }
+                  },
+                  "required": [
+                    "over17sNames",
+                    "over17sTenantsOrLodgers",
+                    "over17sWillSignToConfirmWillVacate"
+                  ]
+                }
+              ]
+            }
           }
-        },
-        "over17sWillSignToConfirmWillVacate": {
-          "baspiRef": "B6.4",
-          "RDSRef": "RightsHolders,TenureAgreements,Notifications",
-          "lawSocietyRef": "TA6/11.5",
-          "title": "Have all occupiers aged over 17, agreed to sign the contract to confirm that they will vacate the property prior to completion of the sale?",
-          "$ref": "#/$defs/yesNoDetailIfNo",
-          "description": "If 'No', please provide details (e.g. the property is sold let to tenants) and supply a copy of the tenancy agreement together with a copy of any notice to quit which has been served upon them."
         }
       }
     },
@@ -736,9 +782,13 @@
             }
           }
         },
+        "sufficientToRepayAllMortgages": {
+          "lawSocietyRef": "TA6/14.3",
+          "title": "Will the sale price be sufficient to repay all mortgages and charges secured on the property?",
+          "$ref": "#/$defs/yesNo"
+        },
         "digitalPropertyLogbook": {
           "baspiRef": "B7.5",
-          "RDSRef": "",
           "title": "Do you have a Digital Property Logbook?",
           "description": "See https://www.rlba.org.uk/what-is-a-property-logbook?",
           "type": "object",