@pdtf/schemas 2.0.0-2 → 2.0.0-3

package/package.json

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

package/src/examples/v2/exampleTransaction.json

@@ -21,8 +21,8 @@
       "address": {
         "line1": "47 Park Road",
         "line2": "",
+        "line3": "",
         "town": "HARPENDEN",
-        "county": "Herts",
         "postcode": "AL3 5AF"
       },
       "delayFactors": {

package/src/schemas/v2/combined.json

@@ -81,12 +81,12 @@
                 "title": "Address 2",
                 "type": "string"
               },
-              "town": {
-                "title": "Town",
+              "line 3": {
+                "title": "Address 3",
                 "type": "string"
               },
-              "county": {
-                "title": "County",
+              "town": {
+                "title": "Town",
                 "type": "string"
               },
               "postcode": {
@@ -12501,16 +12501,13 @@
               "baspiRef": "A13",
               "title": "Consumer Protection Regulations Declaration",
               "type": "object",
-              "baspiRequired": ["consumerProtectionRegulationsResponse"],
+              "required": ["consumerProtectionRegulationsResponse"],
               "properties": {
                 "consumerProtectionRegulationsResponse": {
                   "baspiRef": "A13.1",
                   "title": "Seller’s declaration",
                   "description": "I/we confirm the answers to be truthful and accurate and to the best of my/our knowledge. The questions have been designed to assist with the disclosure of material information and any misleading or incorrect answers are likely to be exposed later in the legal process which may hinder my/our sale. I/we will provide my property lawyer with the additional documentation in support of the information supplied on this form. If there are any changes which alter the information provided, I/we will immediately notify the person marketing the property as well as my/our property lawyer.",
-                  "confirmation": {
-                    "type": "string",
-                    "enum": ["true", "false"]
-                  }
+                  "type": "boolean"
                 }
               }
             }
@@ -14299,13 +14296,10 @@
                 "willRemoveAllRubbish": {
                   "baspiRef": "B7.1",
                   "rdsRef": "RightsHolders/Flags",
-                  "TA6Ref": "14.4",
+                  "ta6Ref": "14.4",
                   "title": "Please confirm that on completion you will remove all rubbish and items not included in the sale from the property including its garden, loft and any sheds or outbuildings.",
                   "description": "When the property is cleared out you will be expected to take reasonable care when clearing the property, leaving it clean and tidy and repairing any damage caused when removing items from the property and making safe any light or electrical fittings which are being removed.\n\nKeys for all door and window locks, along with any alarm codes, should be available for the buyer on the day of completion.  If there is any reason why you cannot do this you should let the estate agent and your property lawyer know. For all internet connected services eg doorbells, boiler controls, burglar alarms, CCTV cameras etc) access to them will need to be provided to the buyer on the day of completion so that they can control them or sign up to the service.  If there is any reason why you cannot do this you should let the estate agent and your property lawyer know.",
-                  "confirmation": {
-                    "type": "string",
-                    "enum": ["true", "false"]
-                  }
+                  "type": "boolean"
                 },
                 "otherPropertyInChain": {
                   "baspiRef": "B7.2",
@@ -14505,7 +14499,7 @@
               "baspiRef": "B8",
               "title": "Confirmation to be supplied by all owners or their representative",
               "type": "object",
-              "baspiRequired": [
+              "required": [
                 "confirmWillProvideAdditionalDocumentation",
                 "confirmInformationIsAccurate"
               ],
@@ -14513,18 +14507,12 @@
                 "confirmWillProvideAdditionalDocumentation": {
                   "baspiRef": "B8.1",
                   "title": "I/we will provide my property lawyer with the additional documentation in support of the information supplied.",
-                  "confirmation": {
-                    "type": "string",
-                    "enum": ["true", "false"]
-                  }
+                  "type": "boolean"
                 },
                 "confirmInformationIsAccurate": {
                   "baspiRef": "B8.2",
                   "title": "I/we confirm that all information provided is accurate to the best of our knowledge and if we become aware of any change to/changes which alter the information supplied/provided prior to exchange of contracts for the sale of the property, I/we will update immediately notify the person marketing the property as well as my/our property lawyer. All sellers should sign this form",
-                  "confirmation": {
-                    "type": "string",
-                    "enum": ["true", "false"]
-                  }
+                  "type": "boolean"
                 }
               }
             }

package/src/tests/v1/transactionSchema.test.js

@@ -10,6 +10,14 @@ const {
 } = require("../../../index.js");
 const exampleTransaction = require("../../examples/v1/exampleTransaction.json");
 
+const getV1Subschema = (path) => {
+  return getSubschema(
+    path,
+    "https://trust.propdata.org.uk/schemas/v1/pdtf-transaction.json",
+    null
+  );
+};
+
 test("exports a property pack schema", () => {
   expect(transactionSchema).not.toBeNull();
 });
@@ -65,45 +73,45 @@ test("correctly identifies an array invalid path", () => {
 });
 
 test("correctly gets a subschema", () => {
-  const subschema = getSubschema("/propertyPack/materialFacts/notices");
+  const subschema = getV1Subschema("/propertyPack/materialFacts/notices");
   expect(subschema.title).toBe("Notices which Affect the Property");
 });
 
 test("correctly gets a subschema through an arrays element", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/titlesToBeSold/0/registerExtract"
   );
   expect(subschema.title).toBe("HMLR Official Copy Register Extract");
 });
 
 test("correctly gets another subschema through an arrays element", () => {
-  const subschema = getSubschema("/participants/0/name/firstName");
+  const subschema = getV1Subschema("/participants/0/name/firstName");
   expect(subschema.title).toBe("First name");
 });
 
 test("correctly gets a subschema through a dependency", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details"
   );
   expect(subschema.title).toBe("Details");
 });
 
 test("correctly gets another subschema through a dependency", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/lengthOfLeaseInYears"
   );
   expect(subschema.title).toBe("Length of lease (years)");
 });
 
 test("correctly gets yet another subschema through a dependency", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/rentIncrease/details"
   );
   expect(subschema.title).toBe("Details");
 });
 
 test("correctly gets yet, yet another subschema through a dependency", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/materialFacts/listingAndConservation/isConservationArea/yesNo"
   );
   expect(subschema.type).toBe("string");
@@ -111,7 +119,7 @@ test("correctly gets yet, yet another subschema through a dependency", () => {
 });
 
 test("correctly gets yet, yet, yet another subschema through a dependency", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding/groundWater/yesNo"
   );
   expect(subschema.type).toBe("string");
@@ -119,21 +127,21 @@ test("correctly gets yet, yet, yet another subschema through a dependency", () =
 });
 
 test("correctly gets yet, yet, yet another subschema through a second item dependency", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding"
   );
   expect(subschema.type).toBe("object");
 });
 
 test("correctly gets yes another subschema but through a non-baspi oneOf structure", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/RestrictionDetails/RestrictionEntry/ChargeRestriction/EntryDetails/EntryText"
   );
   expect(subschema).toEqual({ type: "string" });
 });
 
 test("correctly gets yes another subschema but through a non-baspi oneOf structure with array option", () => {
-  const subschema = getSubschema(
+  const subschema = getV1Subschema(
     "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/RestrictionDetails/RestrictionEntry/0/ChargeRestriction/EntryDetails/EntryText"
   );
   expect(subschema).toEqual({ type: "string" });
@@ -141,11 +149,11 @@ test("correctly gets yes another subschema but through a non-baspi oneOf structu
 
 test("correctly gets a subschema validator which is already cached", () => {
   const validator = getSubschemaValidator(
-    "/propertyPack/energyPerformanceCertificate"
+    "/propertyPack/materialFacts/energyEfficiency/certificate"
   );
   expect(validator).not.toBeNull();
   const anotherValidator = getSubschemaValidator(
-    "/propertyPack/energyPerformanceCertificate"
+    "/propertyPack/materialFacts/energyEfficiency/certificate"
   );
   expect(anotherValidator).not.toBeNull();
 });