@pdtf/schemas 0.5.0

package/src/tests/examplePropertyPack.json

@@ -0,0 +1,363 @@
+{
+  "$schema": "https://homebuyingandsellinggroup.co.uk/schemas/property-pack.json",
+  "uprn": 100000059583,
+  "propertyPack": {
+    "materialFacts": {
+      "propertyToBeSold": {
+        "address": {
+          "address1": "10 Downend Park",
+          "address2": "",
+          "town": "BRISTOLS",
+          "county": "Avon",
+          "postcode": "BS7 9PU"
+        },
+        "energyEfficiency": {
+          "energyEfficiencyRating": "A"
+        },
+        "delayFactors": {
+          "yesNo": "No"
+        },
+        "ownership": {
+          "ownershipType": "Freehold"
+        },
+        "parkingArrangements": {
+          "parkingArrangementsType": "Other",
+          "otherParkingType": "Garage and double width driveway"
+        },
+        "listingAndConservation": {
+          "isListed": {
+            "yesNo": "No"
+          },
+          "isConservationArea": {
+            "yesNo": "No"
+          },
+          "hasTreePreservationOrder": {
+            "yesNo": "No"
+          }
+        },
+        "typeOfConstruction": {
+          "isStandardForm": {
+            "yesNo": "Yes"
+          },
+          "hasFlammableExternalWallSystem": "No"
+        },
+        "councilTax": {
+          "councilTaxBand": "A",
+          "councilTaxAffectingAlterations": {
+            "yesNo": "No"
+          }
+        }
+      },
+      "disputesAndComplaints": {
+        "hasDisputesAndComplaints": {
+          "yesNo": "No"
+        }
+      },
+      "alterationsAndChanges": {
+        "hasStructuralAlterations": {
+          "buildingRegApproval": {
+            "yesNo": "Yes"
+          },
+          "planningPermission": {
+            "yesNo": "Yes"
+          },
+          "listedBuildingConsent": {
+            "yesNo": "Not required",
+            "reasons": "Not listed building\n"
+          },
+          "deedRestrictionConsent": {
+            "yesNo": "Not required",
+            "reasons": "Retrospective consent obtained from leasehold provider but property now freehold"
+          },
+          "unfinished": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "details": "Bedroom and ensuite shower room extension 2005"
+        },
+        "windowReplacementsSince2002": {
+          "buildingRegApproval": {
+            "yesNo": "Not required",
+            "reasons": "Not required"
+          },
+          "planningPermission": {
+            "yesNo": "Not required",
+            "reasons": "Not required"
+          },
+          "listedBuildingConsent": {
+            "yesNo": "Not required",
+            "reasons": "Not listed building"
+          },
+          "deedRestrictionConsent": {
+            "yesNo": "Not required",
+            "reasons": "None required"
+          },
+          "unfinished": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "details": "New front door added 2016"
+        },
+        "hasAddedConservatory": {
+          "buildingRegApproval": {
+            "yesNo": "Not required",
+            "reasons": "Added as part of initial build"
+          },
+          "planningPermission": {
+            "yesNo": "Not required",
+            "reasons": "Added as part of initial build"
+          },
+          "listedBuildingConsent": {
+            "yesNo": "Not required",
+            "reasons": "Not listed building"
+          },
+          "deedRestrictionConsent": {
+            "yesNo": "Not required",
+            "reasons": "Added as part of initial build and deeds"
+          },
+          "unfinished": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "details": "Conservatory added during house build in 1990 and exterior quality door separates the conservatory from the kitchen/dining room"
+        },
+        "planningPermissionBreaches": {
+          "yesNo": "No"
+        },
+        "unresolvedPlanningIssues": {
+          "yesNo": "No"
+        }
+      },
+      "notices": {
+        "neighbourDevelopment": {
+          "yesNo": "No"
+        },
+        "planningApplication": {
+          "yesNo": "No"
+        },
+        "requiredMaintenance": {
+          "yesNo": "No"
+        },
+        "listedBuildingApplication": {
+          "yesNo": "No"
+        },
+        "infrastructureProject": {
+          "yesNo": "No"
+        },
+        "partyWallAct": {
+          "yesNo": "No"
+        },
+        "otherNotices": {
+          "yesNo": "No"
+        }
+      },
+      "specialistIssues": {
+        "dryRotEtcTreatment": {
+          "yesNo": "No"
+        },
+        "containsAsbestos": {
+          "yesNo": "No"
+        },
+        "japaneseKnotweed": {
+          "yesNo": "No"
+        },
+        "subsidenceOrStructuralFault": {
+          "yesNo": "No"
+        },
+        "ongoingHealthOrSafetyIssue": {
+          "yesNo": "No"
+        }
+      },
+      "fixturesAndFittings": {
+        "itemsToRemove": {
+          "yesNo": "No"
+        },
+        "itemsToInclude": {
+          "yesNo": "No"
+        }
+      },
+      "waterAndDrainage": {
+        "mainsWater": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "Northumbria Water"
+        },
+        "mainsSurfaceWaterDrainage": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "Northumbria Water"
+        },
+        "mainsFoulDrainage": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "Northumbria Water"
+        }
+      },
+      "utilities": {
+        "electricity": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "Octopus Energy"
+        },
+        "gas": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "Octopus Energy"
+        },
+        "lpg": {
+          "yesNo": "No"
+        },
+        "oil": {
+          "yesNo": "No"
+        },
+        "telephone": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "EE"
+        },
+        "cableSatelliteTV": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "Sky"
+        },
+        "broadband": {
+          "maintenanceAgreements": {
+            "yesNo": "No"
+          },
+          "yesNo": "Yes",
+          "connected": "Yes",
+          "supplier": "EE"
+        },
+        "solarPanels": {
+          "yesNo": "No"
+        },
+        "otherServices": {
+          "yesNo": "No"
+        }
+      },
+      "greenDealLoan": {
+        "hasGreenDealLoan": {
+          "yesNo": "No"
+        }
+      },
+      "centralHeating": {
+        "hasCentralHeating": {
+          "boilerInstallationCertificate": {
+            "yesNo": "Yes",
+            "details": "Certified installation"
+          },
+          "heatingInGoodWorkingOrder": {
+            "yesNo": "Yes"
+          },
+          "yesNo": "Yes",
+          "centralHeatingFuel": "Gas boiler",
+          "centralHeatingInstalled": "2016-04-20",
+          "heatingServiceReport": "Full service history available from Whickham Plumbing & Heating ",
+          "heatingLastServiced": "2021-03-26"
+        }
+      },
+      "insurance": {
+        "difficultiesObtainingInsurance": {
+          "yesNo": "No"
+        },
+        "insuranceClaims": {
+          "yesNo": "No"
+        },
+        "isInsured": "Yes"
+      },
+      "boundaries": {
+        "partOutsideLegalOwnership": {
+          "yesNo": "No"
+        },
+        "partOnSeparateSiteOrDeed": {
+          "yesNo": "No"
+        },
+        "boundariesDifferFromTitlePlan": {
+          "yesNo": "No"
+        },
+        "boundaryAlterationProposal": {
+          "yesNo": "No"
+        }
+      },
+      "rightsAndInformalArrangements": {
+        "sharedContributions": {
+          "yesNo": "No"
+        },
+        "neighbouringLandRights": {
+          "yesNo": "No"
+        },
+        "accessRestrictionAttempts": {
+          "yesNo": "No"
+        },
+        "rightsOrArrangements": {
+          "publicRightOfWay": {
+            "yesNo": "No"
+          },
+          "rightsofLightOrSupport": {
+            "yesNo": "No"
+          },
+          "rightsCreatedThroughCustom": {
+            "yesNo": "No"
+          },
+          "minesAndMinerals": {
+            "yesNo": "No"
+          },
+          "churchChancel": {
+            "yesNo": "No"
+          },
+          "otherRights": {
+            "yesNo": "No"
+          }
+        }
+      },
+      "otherIssues": {
+        "environmental": {
+          "yesNo": "No"
+        },
+        "excessiveNoise": {
+          "yesNo": "No"
+        },
+        "crime": {
+          "yesNo": "No"
+        },
+        "cautionOrConviction": {
+          "yesNo": "No"
+        },
+        "failedTransactionsInLast12Months": {
+          "yesNo": "No"
+        },
+        "comments": "Not applicable"
+      },
+      "additionalInformation": {
+        "restrictionsOnUseNotCompliedWith": {
+          "yesNo": "No"
+        },
+        "otherMaterialIssue": {
+          "yesNo": "No"
+        }
+      },
+      "consumerProtectionRegulationsDeclaration": true
+    }
+  }
+}

package/src/tests/propertyPackSchema.test.js

@@ -0,0 +1,44 @@
+import jp from "jsonpointer";
+
+import {
+  propertyPackSchema,
+  validator,
+  getSubschema,
+  getSubschemaValidator
+} from "../index.js";
+import examplePropertyPack from "./examplePropertyPack.json";
+
+test("exports a property pack schema", () => {
+  expect(propertyPackSchema).not.toBeNull();
+});
+
+test("sample is valid", () => {
+  const isValid = validator(examplePropertyPack);
+  expect(isValid).toBe(true);
+});
+
+test("invalid sample is invalid", () => {
+  const clonedExamplePropertyPack = JSON.parse(
+    JSON.stringify(examplePropertyPack)
+  );
+  delete clonedExamplePropertyPack.propertyPack.materialFacts.notices;
+  const isValid = validator(clonedExamplePropertyPack);
+  expect(isValid).toBe(false);
+});
+
+test("correctly gets a subschema", () => {
+  const subschema = getSubschema("/propertyPack/materialFacts/notices");
+  expect(subschema.title).toBe("Notices which Affect the Property");
+});
+
+test("correctly gets a working subschema validator", () => {
+  const path = "/propertyPack/materialFacts/notices";
+  const validator = getSubschemaValidator(path);
+  const data = jp.get(examplePropertyPack, path);
+  expect(data.neighbourDevelopment.yesNo).toBe("No");
+  let isValid = validator(data);
+  expect(isValid).toBe(true);
+  data.neighbourDevelopment.yesNo = "Invalid string";
+  isValid = validator(data);
+  expect(isValid).toBe(false);
+});