@pdtf/schemas 2.0.0-1 → 2.0.0-10

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();
 });

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

@@ -59,46 +59,37 @@ test("sample with missing dependent required fields is invalid", () => {
 });
 
 test("correctly gets a top level subschema", () => {
-  const subschema = getSubschema("/propertyPack", v2TransactionSchema);
+  const subschema = getSubschema("/propertyPack");
   expect(subschema.title).toBe("Property Pack");
 });
 
 test("correctly identifies a valid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialFacts",
-    v2TransactionSchema
-  );
+  const isValid = isPathValid("/propertyPack/materialFacts");
   expect(isValid).toBe(true);
 });
 
 test("correctly identifies an undefined invalid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialItems",
-    v2TransactionSchema
-  );
+  const isValid = isPathValid("/propertyPack/materialItems");
   expect(isValid).toBe(false);
 });
 
 test("correctly identifies an error generating invalid path", () => {
   const isValid = isPathValid(
     "/propertyPack/materialItems/someProperty/item",
-    v2TransactionSchema
+    schemaId
   );
   expect(isValid).toBe(false);
 });
 
 test("correctly identifies an array invalid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialFacts/1/item",
-    v2TransactionSchema
-  );
+  const isValid = isPathValid("/propertyPack/materialFacts/1/item");
   expect(isValid).toBe(false);
 });
 
 test("correctly gets a subschema", () => {
   const subschema = getSubschema(
     "/propertyPack/materialFacts/notices",
-    v2TransactionSchema
+    schemaId
   );
   expect(subschema.title).toBe("Notices which Affect the Property");
 });
@@ -106,7 +97,7 @@ test("correctly gets a subschema", () => {
 test("correctly gets a subschema through an arrays element", () => {
   const subschema = getSubschema(
     "/propertyPack/titlesToBeSold/0/registerExtract",
-    v2TransactionSchema
+    schemaId
   );
   expect(Object.keys(subschema.properties)).toEqual([
     "OCSummaryData",
@@ -117,24 +108,26 @@ test("correctly gets a subschema through an arrays element", () => {
 test("correctly gets a subschema through a dependency", () => {
   const subschema = getSubschema(
     "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details",
-    v2TransactionSchema
+    schemaId
+  );
+  expect(subschema.title).toBe(
+    "Provide details and likely timescale for delay (if known)"
   );
-  expect(subschema.title).toBe("Details");
 });
 
 test("correctly gets another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/general/leaseTerm/lengthOfLeaseInYears",
-    v2TransactionSchema
+    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears",
+    schemaId
   );
   expect(subschema.title).toBe("Length of lease (years)");
 });
 
 test("correctly gets yet another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/rentIncrease/details"
+    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/groundRent/rentSubjectToIncrease/rentIncreaseCalculated"
   );
-  expect(subschema.title).toBe("Details");
+  expect(subschema.title).toBe("How is the increase calculated?");
 });
 
 test("correctly gets yet, yet another subschema through a dependency", () => {
@@ -147,7 +140,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(
-    "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding/groundWater/yesNo"
+    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding/groundWater/yesNo"
   );
   expect(subschema.type).toBe("string");
   expect(subschema.enum).toStrictEqual(["Yes", "No"]);
@@ -155,7 +148,7 @@ 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(
-    "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding"
+    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding"
   );
   expect(subschema.type).toBe("object");
 });
@@ -176,11 +169,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();
 });
@@ -207,7 +200,7 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
   expect(
     getTitleAtPath(
       v2TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/general/leaseTerm/lengthOfLeaseInYears"
+      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears"
     )
   ).toBe("Length of lease (years)");
   expect(

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)
+);