@pdtf/schemas 3.0.0-3 → 3.0.0-31

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

@@ -11,27 +11,26 @@ const {
 } = require("../../../index.js");
 
 const exampleTransaction = require("../../examples/v3/exampleTransaction.json");
+
 const schemaId =
   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json";
 // const validator = getValidator(schemaId);
 const v3TransactionSchema = getTransactionSchema(schemaId);
 
-test("exports a property pack schema, v3 with baspi overlay by default", () => {
-  const testSchema = getTransactionSchema();
-  expect(testSchema.$id).toEqual(
-    "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json"
+test("exports a property pack schema, v3 with no overlay by default", () => {
+  const testSchema = getTransactionSchema(schemaId);
+  // expect(testSchema.$id).toEqual(
+  //   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json"
+  // );
+  expect(testSchema.properties.propertyPack.properties.baspiRef).toEqual(
+    undefined
   );
-  expect(
-    testSchema.properties.propertyPack.properties.materialFacts.baspiRef
-  ).toEqual("A");
 });
 
 test("sample is valid BASPI", () => {
-  const testSchema = getTransactionSchema();
-  expect(
-    testSchema.properties.propertyPack.properties.materialFacts.baspiRef
-  ).toEqual("A");
-  const validator = getValidator(schemaId);
+  const testSchema = getTransactionSchema(schemaId, ["baspiV4"]);
+  expect(testSchema.properties.propertyPack.baspiRef).toEqual("0");
+  const validator = getValidator(schemaId, ["baspiV4"]);
   const isValid = validator(exampleTransaction);
   if (!isValid) console.log(validator.errors);
   expect(isValid).toBe(true);
@@ -48,8 +47,8 @@ test("invalid sample is invalid", () => {
   const clonedExampleTransaction = JSON.parse(
     JSON.stringify(exampleTransaction)
   );
-  delete clonedExampleTransaction.propertyPack.materialFacts.notices;
-  const validator = getValidator(schemaId);
+  delete clonedExampleTransaction.propertyPack.notices;
+  const validator = getValidator(schemaId, ["baspiV4"]);
   const isValid = validator(clonedExampleTransaction);
   expect(isValid).toBe(false);
 });
@@ -58,7 +57,7 @@ test("sample with missing dependent required fields is invalid", () => {
   const clonedExampleTransaction = JSON.parse(
     JSON.stringify(exampleTransaction)
   );
-  clonedExampleTransaction.propertyPack.materialFacts.ownership.ownershipsToBeTransferred[0].ownershipType =
+  clonedExampleTransaction.propertyPack.ownership.ownershipsToBeTransferred[0].ownershipType =
     "leasehold";
   const validator = getValidator(schemaId);
   const isValid = validator(clonedExampleTransaction);
@@ -71,7 +70,7 @@ test("correctly gets a top level subschema", () => {
 });
 
 test("correctly identifies a valid path", () => {
-  const isValid = isPathValid("/propertyPack/materialFacts");
+  const isValid = isPathValid("/propertyPack");
   expect(isValid).toBe(true);
 });
 
@@ -89,15 +88,12 @@ test("correctly identifies an error generating invalid path", () => {
 });
 
 test("correctly identifies an array invalid path", () => {
-  const isValid = isPathValid("/propertyPack/materialFacts/1/item");
+  const isValid = isPathValid("/propertyPack/1/item");
   expect(isValid).toBe(false);
 });
 
 test("correctly gets a subschema", () => {
-  const subschema = getSubschema(
-    "/propertyPack/materialFacts/notices",
-    schemaId
-  );
+  const subschema = getSubschema("/propertyPack/notices", schemaId);
   expect(subschema.title).toBe("Notices which Affect the Property");
 });
 
@@ -107,14 +103,14 @@ test("correctly gets a subschema through an arrays element", () => {
     schemaId
   );
   expect(Object.keys(subschema.properties)).toEqual([
-    "OCSummaryData",
-    "OCRegisterData",
+    "ocSummaryData",
+    "ocRegisterData",
   ]);
 });
 
 test("correctly gets a subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details",
+    "/propertyPack/delayFactors/hasDelayFactors/details",
     schemaId
   );
   expect(subschema.title).toBe(
@@ -124,7 +120,7 @@ test("correctly gets a subschema through a dependency", () => {
 
 test("correctly gets another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears",
+    "/propertyPack/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears",
     schemaId
   );
   expect(subschema.title).toBe("Length of lease (years)");
@@ -132,14 +128,14 @@ test("correctly gets another subschema through a dependency", () => {
 
 test("correctly gets yet another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/groundRent/rentSubjectToIncrease/rentIncreaseCalculated"
+    "/propertyPack/ownership/ownershipsToBeTransferred/0/leaseholdInformation/groundRent/rentSubjectToIncrease/rentIncreaseCalculated"
   );
   expect(subschema.title).toBe("How is the increase calculated?");
 });
 
 test("correctly gets yet, yet another subschema through a dependency", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/listingAndConservation/isConservationArea/yesNo"
+    "/propertyPack/listingAndConservation/isConservationArea/yesNo"
   );
   expect(subschema.type).toBe("string");
   expect(subschema.enum).toStrictEqual(["Yes", "No", "Not known"]);
@@ -147,28 +143,37 @@ test("correctly gets 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/environmentalIssues/flooding/typeOfFlooding"
+    "/propertyPack/environmentalIssues/flooding/historicalFlooding/typeOfFlooding"
   );
   expect(subschema.type).toBe("array");
 });
 
 test("correctly gets yes another subschema but through a non-baspi oneOf structure", () => {
   const subschema = getSubschema(
-    "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/RestrictionDetails/RestrictionEntry/ChargeRestriction/EntryDetails/EntryText"
+    "/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(
-    "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/RestrictionDetails/RestrictionEntry/0/ChargeRestriction/EntryDetails/EntryText"
+    "/propertyPack/titlesToBeSold/0/registerExtract/ocSummaryData/restrictionDetails/restrictionEntry/0/chargeRestriction/entryDetails/entryText"
   );
   expect(subschema).toEqual({ type: "string" });
 });
 
+test("correctly gets an overlaid enum in a subschema", () => {
+  const subschema = getSubschema(
+    "/propertyPack/electricity/mainsElectricity/yesNo",
+    schemaId,
+    ["nts2023"]
+  );
+  expect(subschema.enum).toEqual(["Yes", "No"]);
+});
+
 test("correctly gets a subschema with multiple overlays", () => {
   const subschema = getSubschema(
-    "/propertyPack/materialFacts/parking/parkingArrangements",
+    "/propertyPack/parking/parkingArrangements",
     schemaId,
     ["baspiV4", "ta6ed4"]
   );
@@ -178,11 +183,11 @@ test("correctly gets a subschema with multiple overlays", () => {
 
 test("correctly gets a subschema validator which is already cached", () => {
   const validator = getSubschemaValidator(
-    "/propertyPack/materialFacts/energyEfficiency/certificate"
+    "/propertyPack/energyEfficiency/certificate"
   );
   expect(validator).not.toBeNull();
   const anotherValidator = getSubschemaValidator(
-    "/propertyPack/materialFacts/energyEfficiency/certificate"
+    "/propertyPack/energyEfficiency/certificate"
   );
   expect(anotherValidator).not.toBeNull();
 });
@@ -194,13 +199,12 @@ test("correctly gets a subschema validator for a TA6 overlay", () => {
     "ta6ed4",
   ]);
   let isValid = validator(data);
-  // console.log(validator.errors);
   expect(isValid).toBe(true);
 });
 
 test("correctly gets a subschema validator for a TA6 overlay which validates", () => {
   const path =
-    "/propertyPack/additionalLegalInfo/guaranteesWarrantiesAndIndemnityInsurances/subsidenceWork";
+    "/propertyPack/guaranteesWarrantiesAndIndemnityInsurances/subsidenceWork";
   const data = { yesNo: "Yes" };
   const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
     "ta6ed4",
@@ -218,7 +222,7 @@ test("correctly gets a subschema validator for a TA6 overlay which validates wit
     JSON.stringify(exampleTransaction)
   );
   const data = jp.get(exampleTransaction, path);
-  data.materialFacts.uprn = undefined;
+  data.uprn = undefined;
   const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
     "ta6ed4",
   ]);
@@ -232,7 +236,7 @@ test("correctly gets a subschema validator for a TA6 overlay which validates wit
     JSON.stringify(exampleTransaction)
   );
   const data = jp.get(clonedExampleTransaction, path);
-  data.additionalLegalInfo.smartHomeSystems = undefined;
+  data.smartHomeSystems = undefined;
   const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
     "ta6ed4",
   ]);
@@ -246,7 +250,7 @@ test("correctly gets a subschema validator for a TA6 overlay which fails to vali
     JSON.stringify(exampleTransaction)
   );
   const data = jp.get(clonedExampleTransaction, path);
-  data.materialFacts.waterAndDrainage = {};
+  data.waterAndDrainage = {};
   const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
     "ta6ed4",
   ]);
@@ -267,21 +271,21 @@ test("correctly gets a subschema validator for an NTS overlay", () => {
   expect(isValid).toBe(true);
 });
 
-test("correctly gets a subschema validator for an LPE1 overlay", () => {
+test("correctly gets a subschema validator for an TA7 overlay", () => {
   const path = "/propertyPack";
   const clonedExampleTransaction = JSON.parse(
     JSON.stringify(exampleTransaction)
   );
   const data = jp.get(clonedExampleTransaction, path);
   const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "lpe1ed4",
+    "ta7ed3",
   ]);
   let isValid = validator(data);
   expect(isValid).toBe(false);
 });
 
 test("correctly gets a subschema validator which validates", () => {
-  const path = "/propertyPack/materialFacts/notices";
+  const path = "/propertyPack/notices";
   const validator = getSubschemaValidator(path);
   const data = jp.get(exampleTransaction, path);
   expect(data.neighbourDevelopment.yesNo).toBe("No");
@@ -296,55 +300,53 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
   expect(
     getTitleAtPath(
       v3TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/ownershipType"
+      "/propertyPack/ownership/ownershipsToBeTransferred/0/ownershipType"
     )
   ).toBe("What type of ownership is the property?");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears"
+      "/propertyPack/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears"
     )
   ).toBe("Length of lease (years)");
-  expect(
-    getTitleAtPath(
-      v3TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/serviceCharge/annualServiceCharge"
-    )
-  ).toBe("Amount of current annual service charge (£)");
-  expect(
-    getTitleAtPath(
-      v3TransactionSchema,
-      "/propertyPack/materialFacts/invalidPath"
-    )
-  ).toBe(undefined);
+
+  expect(getTitleAtPath(v3TransactionSchema, "/propertyPack/invalidPath")).toBe(
+    undefined
+  );
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract"
     )
   ).toBe("HMLR Official Copy Register Extract");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
+      "/propertyPack/titlesToBeSold/0/registerExtract/ocSummaryData/propertyAddress"
     )
   ).toBe("Property address");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
+      "/propertyPack/titlesToBeSold/0/registerExtract/ocSummaryData/invalidProp"
     )
   ).toBe(undefined);
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
-      "/propertyPack/materialFacts/energyEfficiency/certificate/currentEnergyRating"
+      "/propertyPack/energyEfficiency/certificate/currentEnergyRating"
     )
   ).toBe("Current energy efficiency rating");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
-      "/propertyPack/additionalLegalInfo/occupiers/othersAged17OrOver/aged17OrOverNames"
+      "/propertyPack/occupiers/othersAged17OrOver/aged17OrOverNames"
     )
   ).toBe("Please provide their full names and ages.");
 });

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

@@ -1,7 +1,7 @@
 const { validateVerifiedClaims } = require("../../../index.js");
 
-const exampleVouch = require("../../examples/v1/exampleVouch.json");
-const exampleDocumentedVouch = require("../../examples/v1/exampleDocumentedVouch.json");
+const exampleVouch = require("../../examples/v3/exampleVouch.json");
+const exampleDocumentedVouch = require("../../examples/v3/exampleDocumentedVouch.json");
 const v3SchemaId =
   "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json";
 
@@ -19,22 +19,22 @@ test("returns an array with an error stating if path is incorrect", () => {
   const originalPath = Object.keys(clonedVouch.claims)[0];
   const data = clonedVouch.claims[originalPath];
   clonedVouch.claims = {
-    "/propertyPack/INVALID/materialFacts/councilTax": data,
+    "/propertyPack/INVALID/councilTax": data,
   };
   // v3 schema, no overlay
   expect(validateVerifiedClaims([clonedVouch], v3SchemaId, null)).toEqual([
-    "Path /propertyPack/INVALID/materialFacts/councilTax is not a valid PDTF schema path",
+    "Path /propertyPack/INVALID/councilTax is not a valid PDTF schema path",
   ]);
 });
 
-test("returns errors if BASPI requirements are not met and BASPI overlay is specified (default)", () => {
+test("returns errors if BASPI requirements are not met and BASPI overlay is specified", () => {
   const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
   clonedVouch.claims = {
-    "/propertyPack/materialFacts/delayFactors": {
+    "/propertyPack/delayFactors": {
       hasDelayFactors: { yesNo: "Yes" },
     },
   };
-  const errors = validateVerifiedClaims([clonedVouch], v3SchemaId);
+  const errors = validateVerifiedClaims([clonedVouch], v3SchemaId, ["baspiV4"]);
   expect(errors).toEqual([
     {
       instancePath: "/hasDelayFactors",
@@ -56,7 +56,7 @@ test("returns errors if BASPI requirements are not met and BASPI overlay is spec
 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": {
+    "/propertyPack/delayFactors": {
       hasDelayFactors: { yesNo: "Yes" },
     },
   };
@@ -67,7 +67,7 @@ test("returns no errors if BASPI requirements are not met and null overlay is sp
 test("returns errors for invalid fields even if null overlay is specified", () => {
   const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
   clonedVouch.claims = {
-    "/propertyPack/materialFacts/delayFactors": {
+    "/propertyPack/delayFactors": {
       hasDelayFactors: { yesNo: "Maybe" },
     },
   };
@@ -78,7 +78,7 @@ test("returns errors for invalid fields even if null overlay is specified", () =
 test("returns an array of errors for verified claim with multiple paths", () => {
   const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
   clonedVouch.claims = {
-    "/propertyPack/materialFacts/cousncilTaxBad": {
+    "/propertyPack/cousncilTaxBad": {
       councilTaxBand: "D",
       councilTaxAffectingAlterations: {
         yesNo: "Yes",
@@ -86,7 +86,7 @@ test("returns an array of errors for verified claim with multiple paths", () =>
           "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": {
+    "/propertyPack/councilTaxBadTwo": {
       councilTaxBand: "D",
       councilTaxAffectingAlterations: {
         yesNo: "Yes",
@@ -96,8 +96,8 @@ test("returns an array of errors for verified claim with multiple paths", () =>
     },
   };
   expect(validateVerifiedClaims([clonedVouch], v3SchemaId, null)).toEqual([
-    "Path /propertyPack/materialFacts/cousncilTaxBad is not a valid PDTF schema path",
-    "Path /propertyPack/materialFacts/councilTaxBadTwo is not a valid PDTF schema path",
+    "Path /propertyPack/cousncilTaxBad is not a valid PDTF schema path",
+    "Path /propertyPack/councilTaxBadTwo is not a valid PDTF schema path",
   ]);
 });
 
@@ -108,7 +108,7 @@ test("returns an empty array of errors for verified claim with multiple valid pa
     null
   );
   clonedVouch.claims = {
-    "/propertyPack/materialFacts/councilTax": {
+    "/propertyPack/councilTax": {
       councilTaxBand: "D",
       councilTaxAffectingAlterations: {
         yesNo: "Yes",
@@ -116,7 +116,7 @@ test("returns an empty array of errors for verified claim with multiple valid pa
           "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": {
+    "/propertyPack/address": {
       line1: "property.line1",
       line2: "property.line2",
       town: "property.city",

package/src/utils/extractOverlay.js

@@ -23,30 +23,15 @@ const extractFields = [
 ];
 
 const overlayIncludeProperties = [
-  "title",
-  "description",
-  "enum",
+  // "title",
+  // "description",
+  // "enum",
   "discriminator",
-  "minItems",
+  // "minItems",
 ];
 
-const combineMerge = (target, source, options) => {
-  const destination = target.slice();
-  source.forEach((item, index) => {
-    if (typeof destination[index] === "undefined") {
-      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options);
-    } else if (options.isMergeableObject(item)) {
-      destination[index] = merge(target[index], item, options);
-    } else if (target.indexOf(item) === -1) {
-      destination.push(item);
-    }
-  });
-  return destination;
-};
-
 const flattenSkeleton = (schema) => {
   if (!schema) return undefined;
-  // console.log(schema.properties);
   let returnStructure = {};
   if (schema.properties) {
     Object.keys(schema.properties).forEach((key) => {
@@ -55,10 +40,8 @@ const flattenSkeleton = (schema) => {
   }
   if (schema.oneOf) {
     schema.oneOf.forEach((aOneOf) => {
-      // console.log(aOneOf);
       if (aOneOf.properties) {
         Object.entries(aOneOf.properties).forEach(([key, value]) => {
-          // console.log(aProperty);
           returnStructure[key] = flattenSkeleton(value);
         });
       }
@@ -133,6 +116,11 @@ const extractOverlay = (sourceSchema, ref) => {
       jp.set(returnSchema, `${path}/title`, element[refTitle]);
     }
 
+    const refDescription = `${ref}Description`;
+    if (element[refDescription]) {
+      jp.set(returnSchema, `${path}/description`, element[refDescription]);
+    }
+
     const refEnum = `${ref}Enum`;
     if (element[refEnum]) {
       jp.set(returnSchema, `${path}/enum`, element[refEnum]);
@@ -153,12 +141,7 @@ const deleteProperties = (sourceSchema, propertyNames) => {
 const overlays = {};
 
 extractFields.forEach((key) => {
-  let overlay = extractOverlay(combinedSchema, key, [
-    "title",
-    "description",
-    "enum",
-    "discriminator",
-  ]);
+  let overlay = extractOverlay(combinedSchema, key);
   overlays[key] = overlay;
   const fileName = `../schemas/v3/overlays/${key}.json`;
   fs.writeFileSync(fileName, JSON.stringify(overlay, null, 2));