@pdtf/schemas 0.6.14 → 0.7.1

package/index.js

@@ -3,18 +3,18 @@ const Ajv = require("ajv");
 const addFormats = require("ajv-formats");
 
 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 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 subSchemas = {
-  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-a-material-facts.json":
-    baspiMaterialFacts,
-  "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/baspi-b-legal-information.json":
-    baspiLegalInformation,
+  "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":
+    legalInformation,
   "https://raw.githubusercontent.com/Property-Data-Trust-Framework/schemas/master/src/schemas/energy-performance-certificate.json":
     energyPerformanceCertificate,
   "https://geojson.org/schema/GeoJSON.json": geoJson,
@@ -39,6 +39,7 @@ const getSubschema = (path) => {
   if (pathArray.length < 1) {
     return transactionSchema;
   }
+
   return pathArray.reduce((schema, pathElement) => {
     if (schema.type === "array") return schema.items;
     if (schema.properties[pathElement]) return schema.properties[pathElement];

package/package.json

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

package/src/examples/exampleTransaction.json

@@ -82,12 +82,10 @@
             "yesNo": "Yes"
           },
           "listedBuildingConsent": {
-            "yesNo": "Not required",
-            "reasons": "Not listed building\n"
+            "yesNo": "Not required"
           },
           "deedRestrictionConsent": {
-            "yesNo": "Not required",
-            "reasons": "Retrospective consent obtained from leasehold provider but property now freehold"
+            "yesNo": "Not required"
           },
           "unfinished": {
             "yesNo": "No"
@@ -97,20 +95,16 @@
         },
         "windowReplacementsSince2002": {
           "buildingRegApproval": {
-            "yesNo": "Not required",
-            "reasons": "Not required"
+            "yesNo": "Not required"
           },
           "planningPermission": {
-            "yesNo": "Not required",
-            "reasons": "Not required"
+            "yesNo": "Not required"
           },
           "listedBuildingConsent": {
-            "yesNo": "Not required",
-            "reasons": "Not listed building"
+            "yesNo": "Not required"
           },
           "deedRestrictionConsent": {
-            "yesNo": "Not required",
-            "reasons": "None required"
+            "yesNo": "Not required"
           },
           "unfinished": {
             "yesNo": "No"
@@ -120,20 +114,17 @@
         },
         "hasAddedConservatory": {
           "buildingRegApproval": {
-            "yesNo": "Not required",
-            "reasons": "Added as part of initial build"
+            "yesNo": "Not required"
           },
           "planningPermission": {
-            "yesNo": "Not required",
-            "reasons": "Added as part of initial build"
+            "yesNo": "Not required"
           },
           "listedBuildingConsent": {
-            "yesNo": "Not required",
-            "reasons": "Not listed building"
+            "yesNo": "Not required"
           },
           "deedRestrictionConsent": {
-            "yesNo": "Not required",
-            "reasons": "Added as part of initial build and deeds"
+            "yesNo": "No",
+            "details": "Added as part of initial build and deeds"
           },
           "unfinished": {
             "yesNo": "No"
@@ -201,25 +192,32 @@
           "maintenanceAgreements": {
             "yesNo": "No"
           },
-          "yesNo": "Yes",
-          "connected": "Yes",
+          "yesNo": "To be connected",
+          "dateToBeConnected": "2022-12-15",
           "supplier": "Northumbria Water"
         },
         "mainsSurfaceWaterDrainage": {
           "maintenanceAgreements": {
             "yesNo": "No"
           },
-          "yesNo": "Yes",
-          "connected": "Yes",
-          "supplier": "Northumbria Water"
+          "yesNo": "Yes"
         },
         "mainsFoulDrainage": {
-          "maintenanceAgreements": {
-            "yesNo": "No"
+          "yesNo": "No",
+          "sustainableDrainageSystem": { "yesNo": "No" },
+          "septicTank": {
+            "yesNo": "Yes",
+            "details": "Last emptied on 1 Jan 2022"
           },
-          "yesNo": "Yes",
-          "connected": "Yes",
-          "supplier": "Northumbria Water"
+          "cesspit": { "yesNo": "No" },
+          "sewerageTreatmentPlant": { "yesNo": "No" },
+          "otherConnectedProperties": { "yesNo": "No" },
+          "plantOnOtherLand": { "yesNo": "No" },
+          "plantRegistered": { "yesNo": "No" },
+          "plantDrainsIntoWaterway": {
+            "yesNo": "Yes",
+            "dischargeCompliesWithGBR": "Yes"
+          }
         }
       },
       "utilities": {
@@ -228,7 +226,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Octopus Energy"
         },
         "gas": {
@@ -236,7 +233,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Octopus Energy"
         },
         "lpg": {
@@ -250,7 +246,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "EE"
         },
         "cableSatelliteTV": {
@@ -258,7 +253,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Sky"
         },
         "broadband": {
@@ -266,7 +260,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "EE"
         },
         "solarPanels": {
@@ -291,7 +284,7 @@
           "heatingInGoodWorkingOrder": {
             "yesNo": "Yes"
           },
-          "centralHeatingFuel": "Gas boiler",
+          "centralHeatingFuel": { "centralHeatingFuelType": "Gas" },
           "centralHeatingInstalled": "2016-04-20",
           "heatingLastServiced": "2021-03-26"
         }
@@ -333,7 +326,7 @@
           "publicRightOfWay": {
             "yesNo": "No"
           },
-          "rightsofLightOrSupport": {
+          "rightsOfLightOrSupport": {
             "yesNo": "No"
           },
           "rightsCreatedThroughCustom": {
@@ -365,8 +358,7 @@
         },
         "failedTransactionsInLast12Months": {
           "yesNo": "No"
-        },
-        "comments": "Not applicable"
+        }
       },
       "additionalInformation": {
         "restrictionsOnUseNotCompliedWith": {
@@ -387,14 +379,6 @@
           "lastName": "Hetherington-Smythe"
         }
       ],
-      "sellersConveyancer": {
-        "firstName": "John",
-        "lastName": "Lawson",
-        "address": { "line1": "66 Railway Ave", "postcode": "SL12 1AA" },
-        "email": "john@bodgit.co.uk",
-        "organisation": "Bodgit, Leggit and Run Partners",
-        "reference": "12345"
-      },
       "sellersCapacity": { "capacity": "Legal Owner" },
       "legalBoundaries": {
         "left": "Seller",

package/src/mappings/adf.js

@@ -0,0 +1,198 @@
+const PROPERTY_TYPES = {
+  0: "Not Specified",
+  1: "Terraced House",
+  2: "End of terrace house",
+  3: "Semi-detached house",
+  4: "Detached house",
+  5: "Mews house",
+  6: "Cluster house",
+  7: "Ground floor flat",
+  8: "Flat",
+  9: "Studio flat",
+  10: "Ground floor maisonette",
+  11: "Maisonette",
+  12: "Bungalow",
+  13: "Terraced bungalow",
+  14: "Semi-detached bungalow",
+  15: "Detached bungalow",
+  16: "Mobile home",
+  20: "Land (Residential)",
+  21: "Link detached house",
+  22: "Town house",
+  23: "Cottage",
+  24: "Chalet",
+  25: "Character Property",
+  26: "House (unspecified)",
+  27: "Villa",
+  28: "Apartment",
+  29: "Penthouse",
+  30: "Finca",
+  43: "Barn Conversion",
+  44: "Serviced apartment",
+  45: "Parking",
+  46: "Sheltered Housing",
+  47: "Reteirment property",
+  48: "House share",
+  49: "Flat share",
+  50: "Park home",
+  51: "Garages",
+  52: "Farm House",
+  53: "Equestrian facility",
+  56: "Duplex",
+  59: "Triplex",
+  62: "Longere",
+  65: "Gite",
+  68: "Barn",
+  71: "Trulli",
+  74: "Mill",
+  77: "Ruins",
+  80: "Restaurant",
+  83: "Cafe",
+  86: "Mill",
+  92: "Castle",
+  95: "Village House",
+  101: "Cave House",
+  104: "Cortijo",
+  107: "Farm Land",
+  110: "Plot",
+  113: "Country House",
+  116: "Stone House",
+  117: "Caravan",
+  118: "Lodge",
+  119: "Log Cabin",
+  120: "Manor House",
+  121: "Stately Home",
+  125: "Off-Plan",
+  128: "Semi-detached Villa",
+  131: "Detached Villa",
+  134: "Bar/Nightclub",
+  137: "Shop",
+  140: "Riad",
+  141: "House Boat",
+  142: "Hotel Room",
+  143: "Block of Apartments",
+  144: "Private Halls",
+  178: "Office",
+  181: "Business Park",
+  184: "Serviced Office",
+  187: "Retail Property (High Street)",
+  190: "Retail Property (Out of Town)",
+  193: "Convenience Store",
+  196: "Garages",
+  199: "Hairdresser/Barber Shop",
+  202: "Hotel",
+  205: "Petrol Station",
+  208: "Post Office",
+  211: "Pub",
+  214: "Workshop & Retail Space",
+  217: "Distribution Warehouse",
+  220: "Factory",
+  223: "Heavy Industrial",
+  226: "Industrial Park",
+  229: "Light Industrial",
+  232: "Storage",
+  235: "Showroom",
+  238: "Warehouse",
+  241: "Land (Commercial)",
+  244: "Commercial Development",
+  247: "Industrial Development",
+  250: "Residential Development",
+  253: "Commercial Property",
+  256: "Data Centre",
+  259: "Farm",
+  262: "Healthcare Facility",
+  265: "Marine Property",
+  268: "Mixed Use",
+  271: "Research & Development Facility",
+  274: "Science Park",
+  277: "Guest House",
+  280: "Hospitality",
+  283: "Leisure Facility",
+  298: "Takeaway",
+  301: "Childcare Facility",
+  304: "Smallholding",
+  307: "Place of Worship",
+  310: "Trade Counter",
+  511: "Coach House",
+  512: "House of Multiple Occupation",
+  535: "Sports facilities",
+  538: "Spa",
+  541: "Campsite & Holiday Village",
+};
+
+const PRICE_QUALIFIER_TYPES = {
+  0: "Default",
+  1: "POA",
+  2: "Guide Price",
+  3: "Fixed Price",
+  4: "Offers in excess of",
+  5: "OIRO",
+  6: "Sale by Tender",
+  7: "From",
+  9: "Shared Ownership",
+  10: "Offers over",
+  11: "Part Buy, Part Rent",
+  12: "Shared Equity",
+  15: "Offers Invited",
+  16: "Coming Soon",
+};
+
+const TENURE_TYPES = {
+  1: "Freehold",
+  2: "Leasehold",
+  3: "Feudal",
+  4: "Commonhold",
+  5: "Share of Freehold",
+};
+
+const FREQUENCY_TYPES = {
+  1: "Yearly",
+  4: "Quarterly",
+  12: "Monthly",
+  52: "Weekly",
+  365: "Daily",
+};
+
+export const adfProperty = (pdtfTransaction) => {
+  const materialFacts = pdtfTransaction.propertyPack?.materialFacts;
+  return {
+    property_type:
+      Object.keys(PROPERTY_TYPES).find(
+        (key) => PROPERTY_TYPES(key) === materialFacts?.propertyType
+      ) || 0,
+    new_home: materialFacts?.isNewBuild,
+    address: {
+      house_name_number: materialFacts?.address?.line1,
+      address_2: materialFacts?.address?.line2,
+      town: materialFacts?.address?.town,
+      postcode_1: materialFacts?.address?.postcode.split(" ")[0],
+      postcode_2: materialFacts?.address?.postcode.split(" ")[1],
+      display_address: materialFacts?.address?.line1,
+      latitude: materialFacts?.location?.latitude,
+      longitude: materialFacts?.location?.longitude,
+    },
+    price_information: {
+      price: materialFacts?.price_information?.price,
+      price_qualifier: materialFacts?.price_information?.priceQualifier,
+    },
+  };
+};
+
+export const pdtfClaims = (adfProperty) => {
+  return {
+    "/propertyPack/materialFacts/address": {
+      line1: adfProperty?.address?.house_name_number,
+      line2: adfProperty?.address?.line2,
+      town: adfProperty?.address?.town,
+      postcode: `${adfProperty?.address?.postcode_1} ${adfProperty?.address?.postcode_2}`,
+    },
+    "/propertyPack/materialFacts/location": {
+      latitude: adfProperty?.address?.latitude,
+      longitude: adfProperty?.address?.longitude,
+    },
+    "/propertyPack/materialFacts/priceInformation": {
+      price: adfProperty?.price_information?.price,
+      priceQualifier: adfProperty?.price_information?.price_qualifier,
+    },
+  };
+};

package/src/schemas/{baspi-b-legal-information.json → legal-information.json}

@@ -7,7 +7,6 @@
   "baspiRef": "B",
   "required": [
     "namesOfLegalOwners",
-    "sellersConveyancer",
     "sellersCapacity",
     "legalBoundaries",
     "servicesCrossing",
@@ -33,7 +32,8 @@
           "firstName": {
             "baspiRef": "B1.1.1",
             "title": "First name",
-            "type": "string"
+            "type": "string",
+            "minLength": 1
           },
           "middleNames": {
             "baspiRef": "B1.1.2",
@@ -43,53 +43,12 @@
           "lastName": {
             "baspiRef": "B1.1.3",
             "title": "Last name",
-            "type": "string"
+            "type": "string",
+            "minLength": 1
           }
         }
       }
     },
-    "sellersConveyancer": {
-      "baspiRef": "B1.2",
-      "RDSRef": "Participants/description=?,Participants/ActingFor/Participants/Role",
-      "title": "Sellers Conveyancer",
-      "type": "object",
-      "required": [
-        "firstName",
-        "lastName",
-        "address",
-        "email",
-        "organisation",
-        "reference"
-      ],
-      "properties": {
-        "firstName": {
-          "title": "First name",
-          "type": "string"
-        },
-        "lastName": {
-          "title": "Last name",
-          "type": "string"
-        },
-        "email": {
-          "title": "Email address",
-          "type": "string",
-          "format": "email"
-        },
-        "organisation": {
-          "title": "Organisation",
-          "type": "string"
-        },
-        "address": {
-          "title": "Address",
-          "$ref": "#/$defs/address"
-        },
-
-        "reference": {
-          "title": "Reference",
-          "type": "string"
-        }
-      }
-    },
     "sellersCapacity": {
       "baspiRef": "B1.3",
       "RDSRef": "Participants/description=?,Participants/ActingFor/Participants/Role",
@@ -106,7 +65,7 @@
             "Personal Representative for a Deceased Owner",
             "Under Power of Attorney",
             "Mortgagee in Possession",
-            "Other (please give details)"
+            "Other"
           ]
         }
       },
@@ -118,7 +77,8 @@
                 "capacity": {
                   "enum": ["Legal Owner", "Mortgagee in Possession"]
                 }
-              }
+              },
+              "additionalProperties": false
             },
             {
               "properties": {
@@ -126,17 +86,17 @@
                   "enum": [
                     "Personal Representative for a Deceased Owner",
                     "Under Power of Attorney",
-                    "Other (please give details)"
+                    "Other"
                   ]
                 },
-                "probateOrPowerOfAttorney": {
+                "sellersCapacityDetails": {
                   "baspiRef": "B1.4",
                   "RDSRef": "Participants/OtherDocumentation",
-                  "title": "Please provide details.",
+                  "title": "Please provide details and provide any probate, grant of representation or power of attorney ",
                   "type": "string"
                 }
               },
-              "required": ["probateOrPowerOfAttorney"]
+              "required": ["sellersCapacityDetails"]
             }
           ]
         }
@@ -301,6 +261,7 @@
               "enum": ["Yes", "No"]
             }
           },
+          "required": ["hasSolarPanels"],
           "dependencies": {
             "hasSolarPanels": {
               "oneOf": [
@@ -309,7 +270,8 @@
                     "hasSolarPanels": {
                       "enum": ["No"]
                     }
-                  }
+                  },
+                  "additionalProperties": false
                 },
                 {
                   "properties": {
@@ -347,7 +309,7 @@
                       "baspiRef": "B4.3.5",
                       "RDSRef": "Objects/isNotWorking=yes|no|true|false",
                       "title": "Is the system in good working order to your satisfaction?",
-                      "$ref": "#/$defs/yesNoDetailIfYes"
+                      "$ref": "#/$defs/yesNoDetailIfNo"
                     },
                     "isConnectedToNationalGrid": {
                       "baspiRef": "B4.3.6",
@@ -356,7 +318,15 @@
                       "type": "string",
                       "enum": ["Yes (FiT)", "Yes (SEG)", "No"]
                     }
-                  }
+                  },
+                  "required": [
+                    "yearInstalled",
+                    "panelsOwnedOutright",
+                    "panelProviderLease",
+                    "lastMaintained",
+                    "inGoodWorkingOrder",
+                    "isConnectedToNationalGrid"
+                  ]
                 }
               ]
             }
@@ -598,7 +568,6 @@
       "type": "object",
       "required": [
         "sellerLivesAtProperty",
-        "otherOver17sAtProperty",
         "over17sWillSignToConfirmWillVacate"
       ],
       "properties": {
@@ -628,7 +597,7 @@
                 "type": "string"
               },
               "lastName": {
-                "title": "LastName",
+                "title": "Last Name",
                 "type": "string",
                 "minLength": 1
               },
@@ -963,7 +932,8 @@
       "properties": {
         "line1": {
           "title": "Address 1",
-          "type": "string"
+          "type": "string",
+          "minLength": 1
         },
         "line2": {
           "title": "Address 2",
@@ -979,7 +949,8 @@
         },
         "postcode": {
           "title": "Postcode",
-          "type": "string"
+          "type": "string",
+          "minLength": 1
         }
       },
       "required": ["line1", "postcode"]