@pdtf/schemas 2.0.0-4 → 2.0.0-6

package/src/schemas/v2/overlays/baspi.json

@@ -55,7 +55,7 @@
             "specialistIssues",
             "fixturesAndFittings",
             "waterAndDrainage",
-            "utilities",
+            "connectedUtilities",
             "greenDealLoan",
             "centralHeating",
             "insurance",
@@ -745,6 +745,10 @@
                                 }
                               },
                               "general": {
+                                "required": [
+                                  "typeOfLeasehold",
+                                  "leaseTerm"
+                                ],
                                 "properties": {
                                   "typeOfLeasehold": {
                                     "baspiRef": "A1.3.1",
@@ -812,6 +816,10 @@
                                   },
                                   "leaseTerm": {
                                     "baspiRef": "A1.4.1",
+                                    "required": [
+                                      "startYearOfLease",
+                                      "lengthOfLeaseInYears"
+                                    ],
                                     "properties": {
                                       "startYearOfLease": {
                                         "baspiRef": "A1.4.1.1",

package/src/tests/v2/verifiedClaimsValidator.test.js

@@ -0,0 +1,128 @@
+const { validateVerifiedClaims } = require("../../../index.js");
+
+const exampleVouch = require("../../examples/v1/exampleVouch.json");
+const exampleDocumentedVouch = require("../../examples/v1/exampleDocumentedVouch.json");
+const v2SchemaId =
+  "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json";
+
+test("returns an empty array for a valid claim", () => {
+  expect(validateVerifiedClaims([exampleVouch])).toEqual([]);
+});
+
+test("returns an empty array for a valid array of claims", () => {
+  const claimsArray = [exampleVouch, exampleDocumentedVouch];
+  expect(validateVerifiedClaims(claimsArray)).toEqual([]);
+});
+
+test("returns an array with an error stating if path is incorrect", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  const originalPath = Object.keys(clonedVouch.claims)[0];
+  const data = clonedVouch.claims[originalPath];
+  clonedVouch.claims = {
+    "/propertyPack/INVALID/materialFacts/councilTax": data,
+  };
+  // v2 schema, no overlay
+  expect(validateVerifiedClaims([clonedVouch], v2SchemaId, null)).toEqual([
+    "Path /propertyPack/INVALID/materialFacts/councilTax is not a valid PDTF schema path",
+  ]);
+});
+
+test("returns errors if BASPI requirements are not met and BASPI overlay is specified (default)", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/delayFactors": {
+      hasDelayFactors: { yesNo: "Yes" },
+    },
+  };
+  const errors = validateVerifiedClaims([clonedVouch], v2SchemaId);
+  expect(errors).toEqual([
+    {
+      instancePath: "/hasDelayFactors",
+      schemaPath: "#/properties/hasDelayFactors/oneOf/1/required",
+      keyword: "required",
+      params: { missingProperty: "details" },
+      message: "must have required property 'details'",
+    },
+    {
+      instancePath: "/hasDelayFactors",
+      schemaPath: "#/properties/hasDelayFactors/oneOf/1/required",
+      keyword: "required",
+      params: { missingProperty: "attachments" },
+      message: "must have required property 'attachments'",
+    },
+  ]);
+});
+
+test("returns no errors if BASPI requirements are not met and null overlay is specified", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/delayFactors": {
+      hasDelayFactors: { yesNo: "Yes" },
+    },
+  };
+  const errors = validateVerifiedClaims([clonedVouch], v2SchemaId, null);
+  expect(errors).toEqual([]);
+});
+
+test("returns errors for invalid fields even if null overlay is specified", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/delayFactors": {
+      hasDelayFactors: { yesNo: "Maybe" },
+    },
+  };
+  const errors = validateVerifiedClaims([clonedVouch], v2SchemaId, null);
+  expect(errors).toHaveLength(4);
+});
+
+test("returns an array of errors for verified claim with multiple paths", () => {
+  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/cousncilTaxBad": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterations: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+    "/propertyPack/materialFacts/councilTaxBadTwo": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterations: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+  };
+  expect(validateVerifiedClaims([clonedVouch], v2SchemaId, null)).toEqual([
+    "Path /propertyPack/materialFacts/cousncilTaxBad is not a valid PDTF schema path",
+    "Path /propertyPack/materialFacts/councilTaxBadTwo is not a valid PDTF schema path",
+  ]);
+});
+
+test("returns an empty array of errors for verified claim with multiple valid paths", () => {
+  const clonedVouch = JSON.parse(
+    JSON.stringify(exampleVouch),
+    v2SchemaId,
+    null
+  );
+  clonedVouch.claims = {
+    "/propertyPack/materialFacts/councilTax": {
+      councilTaxBand: "D",
+      councilTaxAffectingAlterations: {
+        yesNo: "Yes",
+        details:
+          "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated",
+      },
+    },
+    "/propertyPack/materialFacts/address": {
+      line1: "property.line1",
+      line2: "property.line2",
+      town: "property.city",
+      county: "property.province",
+      postcode: "property.postcode",
+    },
+  };
+  expect(validateVerifiedClaims([clonedVouch], v2SchemaId, null)).toEqual([]);
+});

package/src/utils/extractOverlay.js

@@ -112,17 +112,7 @@ const coreSchema = deleteProperties(combinedSchema, [
 ]);
 
 fs.writeFileSync(
-  "../schemas/v2/core.json",
+  "../schemas/v2/pdtf-transaction.json",
   JSON.stringify(coreSchema, null, 2)
 );
-console.log("Core schema written to ../schemas/v2/core.json");
-console.log(overlays.baspi);
-const mergedSchema = merge(overlays.baspi, coreSchema, {
-  arrayMerge: combineMerge,
-});
-
-fs.writeFileSync(
-  "../schemas/v2/merged.json",
-  JSON.stringify(mergedSchema, null, 2)
-);
-console.log("Merged schema written to ../schemas/v2/merged.json");
+console.log("Core schema written to ../schemas/v2/pdtf-transaction.json");

package/src/utils/extractProperties.js

@@ -0,0 +1,44 @@
+const { dereference } = require("@jdw/jst");
+const traverse = require("traverse");
+const jp = require("jsonpointer");
+const fs = require("fs");
+const merge = require("deepmerge");
+
+const combinedSchema = require("../schemas/v2/combined.json");
+
+const overlay = "baspiUI";
+const keys = [
+  "isDependent",
+  "component",
+  "htmlClass",
+  "addButtonLabelFirst",
+  "addButtonLabelSubsequent",
+];
+
+const returnSchema = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  $id: `https://trust.propdata.org.uk/schemas/v2/overlays/${overlay}.json`,
+};
+
+traverse(combinedSchema).forEach(function (element) {
+  let path = "/" + this.path.join("/");
+  if (path === "/") path = "";
+  if (keys.includes(this.key)) {
+    jp.set(returnSchema, path, element);
+  }
+});
+
+const fileName = `../schemas/v2/overlays/${overlay}.json`;
+fs.writeFileSync(fileName, JSON.stringify(returnSchema, null, 2));
+console.log(`Overlay ${overlay} written to ${overlay}`);
+
+traverse(combinedSchema).forEach(function (element) {
+  if (keys.includes(this.key)) {
+    this.delete(true); // true = stop here
+  }
+});
+
+fs.writeFileSync(
+  "../schemas/v2/combined.json",
+  JSON.stringify(combinedSchema, null, 2)
+);