@pdtf/schemas 3.0.0-2 → 3.0.0-21

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

@@ -11,23 +11,24 @@ 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.materialFacts.baspiRef
-  ).toEqual("A");
+  ).toEqual(undefined);
 });
 
 test("sample is valid BASPI", () => {
-  const testSchema = getTransactionSchema();
+  const testSchema = getTransactionSchema(schemaId, ["baspiV4"]);
   expect(
     testSchema.properties.propertyPack.properties.materialFacts.baspiRef
   ).toEqual("A");
@@ -49,7 +50,7 @@ test("invalid sample is invalid", () => {
     JSON.stringify(exampleTransaction)
   );
   delete clonedExampleTransaction.propertyPack.materialFacts.notices;
-  const validator = getValidator(schemaId);
+  const validator = getValidator(schemaId, ["baspiV4"]);
   const isValid = validator(clonedExampleTransaction);
   expect(isValid).toBe(false);
 });
@@ -147,7 +148,7 @@ 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/materialFacts/environmentalIssues/flooding/historicalFlooding/typeOfFlooding"
   );
   expect(subschema.type).toBe("array");
 });
@@ -166,6 +167,15 @@ test("correctly gets yes another subschema but through a non-baspi oneOf structu
   expect(subschema).toEqual({ type: "string" });
 });
 
+test("correctly gets an overlaid enum in a subschema", () => {
+  const subschema = getSubschema(
+    "/propertyPack/materialFacts/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",
@@ -194,7 +204,6 @@ test("correctly gets a subschema validator for a TA6 overlay", () => {
     "ta6ed4",
   ]);
   let isValid = validator(data);
-  // console.log(validator.errors);
   expect(isValid).toBe(true);
 });
 
@@ -267,14 +276,14 @@ 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);
@@ -299,48 +308,49 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
       "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/ownershipType"
     )
   ).toBe("What type of ownership is the property?");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/materialFacts/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/titlesToBeSold/0/registerExtract"
     )
   ).toBe("HMLR Official Copy Register Extract");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
     )
   ).toBe("Property address");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
     )
   ).toBe(undefined);
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,
       "/propertyPack/materialFacts/energyEfficiency/certificate/currentEnergyRating"
     )
   ).toBe("Current energy efficiency rating");
+
   expect(
     getTitleAtPath(
       v3TransactionSchema,

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

@@ -27,14 +27,14 @@ test("returns an array with an error stating if path is incorrect", () => {
   ]);
 });
 
-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": {
       hasDelayFactors: { yesNo: "Yes" },
     },
   };
-  const errors = validateVerifiedClaims([clonedVouch], v3SchemaId);
+  const errors = validateVerifiedClaims([clonedVouch], v3SchemaId, ["baspiV4"]);
   expect(errors).toEqual([
     {
       instancePath: "/hasDelayFactors",

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);
         });
       }
@@ -153,12 +136,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));

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

@@ -1,361 +0,0 @@
-const jp = require("jsonpointer");
-const fs = require("fs");
-
-const {
-  getTransactionSchema,
-  getSubschema,
-  isPathValid,
-  getValidator,
-  getSubschemaValidator,
-  getTitleAtPath,
-} = require("../../../index.js");
-
-const exampleTransaction = require("../../examples/v2/exampleTransaction.json");
-const schemaId =
-  "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json";
-// const validator = getValidator(schemaId);
-const v2TransactionSchema = getTransactionSchema(schemaId);
-
-test("exports a property pack schema, v2 with baspi overlay by default", () => {
-  const testSchema = getTransactionSchema(schemaId);
-  expect(testSchema.$id).toEqual(
-    "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json"
-  );
-  expect(
-    testSchema.properties.propertyPack.properties.materialFacts.baspiRef
-  ).toEqual("A");
-});
-
-test("sample is valid BASPI", () => {
-  const testSchema = getTransactionSchema(schemaId);
-  expect(
-    testSchema.properties.propertyPack.properties.materialFacts.properties
-      .centralHeating.title
-  ).toEqual("Central Heating");
-  const validator = getValidator(schemaId);
-  const isValid = validator(exampleTransaction);
-  if (!isValid) console.log(validator.errors);
-  expect(isValid).toBe(true);
-});
-
-test("invalid sample is invalid", () => {
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  delete clonedExampleTransaction.propertyPack.materialFacts.notices;
-  const validator = getValidator(schemaId);
-  const isValid = validator(clonedExampleTransaction);
-  expect(isValid).toBe(false);
-});
-
-test("sample with missing dependent required fields is invalid", () => {
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  clonedExampleTransaction.propertyPack.materialFacts.ownership.ownershipsToBeTransferred[0].ownershipType =
-    "leasehold";
-  const validator = getValidator(schemaId);
-  const isValid = validator(clonedExampleTransaction);
-  expect(isValid).toBe(false);
-});
-
-test("correctly gets a top level subschema", () => {
-  const subschema = getSubschema("/propertyPack", schemaId);
-  expect(subschema.title).toBe("Property Pack");
-});
-
-test("correctly identifies a valid path", () => {
-  const isValid = isPathValid("/propertyPack/materialFacts", schemaId);
-  expect(isValid).toBe(true);
-});
-
-test("correctly identifies an undefined invalid path", () => {
-  const isValid = isPathValid("/propertyPack/materialItems", schemaId);
-  expect(isValid).toBe(false);
-});
-
-test("correctly identifies an error generating invalid path", () => {
-  const isValid = isPathValid(
-    "/propertyPack/materialItems/someProperty/item",
-    schemaId
-  );
-  expect(isValid).toBe(false);
-});
-
-test("correctly identifies an array invalid path", () => {
-  const isValid = isPathValid("/propertyPack/materialFacts/1/item", schemaId);
-  expect(isValid).toBe(false);
-});
-
-test("correctly gets a subschema", () => {
-  const subschema = getSubschema(
-    "/propertyPack/materialFacts/notices",
-    schemaId
-  );
-  expect(subschema.title).toBe("Notices which Affect the Property");
-});
-
-test("correctly gets a subschema through an arrays element", () => {
-  const subschema = getSubschema(
-    "/propertyPack/titlesToBeSold/0/registerExtract",
-    schemaId
-  );
-  expect(Object.keys(subschema.properties)).toEqual([
-    "OCSummaryData",
-    "OCRegisterData",
-  ]);
-});
-
-test("correctly gets a subschema through a dependency", () => {
-  const subschema = getSubschema(
-    "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details",
-    schemaId
-  );
-  expect(subschema.title).toBe(
-    "Provide details and likely timescale for delay"
-  );
-});
-
-test("correctly gets another subschema through a dependency", () => {
-  const subschema = getSubschema(
-    "/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/leaseholdInformation/groundRent/rentSubjectToIncrease/rentIncreaseCalculated",
-    schemaId
-  );
-  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",
-    schemaId
-  );
-  expect(subschema.type).toBe("string");
-  expect(subschema.enum).toStrictEqual(["Yes", "No", "Not known"]);
-});
-
-test("correctly gets yet, yet, yet another subschema through a dependency", () => {
-  const subschema = getSubschema(
-    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding/other/yesNo",
-    schemaId
-  );
-  expect(subschema.type).toBe("string");
-  expect(subschema.enum).toStrictEqual(["Yes", "No"]);
-});
-
-test("correctly gets yet, yet, yet another subschema through a second item dependency", () => {
-  const subschema = getSubschema(
-    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding",
-    schemaId
-  );
-  expect(subschema.type).toBe("object");
-});
-
-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",
-    schemaId
-  );
-  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",
-    schemaId
-  );
-  expect(subschema).toEqual({ type: "string" });
-});
-
-test("correctly gets a subschema with multiple overlays", () => {
-  const subschema = getSubschema(
-    "/propertyPack/materialFacts/parking/parkingArrangements",
-    schemaId,
-    ["baspiV4", "ta6ed4"]
-  );
-  expect(subschema.baspiRef).toBe("A1.6.0");
-  expect(subschema.ta6Ref).toBe("9.1");
-});
-
-test("correctly gets a subschema validator which is already cached", () => {
-  const validator = getSubschemaValidator(
-    "/propertyPack/materialFacts/energyEfficiency/certificate",
-    schemaId
-  );
-  expect(validator).not.toBeNull();
-  const anotherValidator = getSubschemaValidator(
-    "/propertyPack/materialFacts/energyEfficiency/certificate",
-    schemaId
-  );
-  expect(anotherValidator).not.toBeNull();
-});
-
-test("correctly gets a subschema validator for a TA6 overlay", () => {
-  const path = "/propertyPack";
-  const data = jp.get(exampleTransaction, path);
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "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";
-  const data = { yesNo: "Yes" };
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "ta6ed4",
-  ]);
-  let isValid = validator(data);
-  expect(isValid).toBe(false);
-  expect(validator.errors[0].message).toBe(
-    "must have required property 'attachments'"
-  );
-});
-
-test("correctly gets a subschema validator for a TA6 overlay which validates with non-TA6 field missing", () => {
-  const path = "/propertyPack";
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  const data = jp.get(exampleTransaction, path);
-  data.materialFacts.uprn = undefined;
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "ta6ed4",
-  ]);
-  let isValid = validator(data);
-  expect(isValid).toBe(true);
-});
-
-test("correctly gets a subschema validator for a TA6 overlay which validates with non-TA6 section missing", () => {
-  const path = "/propertyPack";
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  const data = jp.get(clonedExampleTransaction, path);
-  data.additionalLegalInfo.smartHomeSystems = undefined;
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "ta6ed4",
-  ]);
-  let isValid = validator(data);
-  // console.log(validator.errors);
-  expect(isValid).toBe(true);
-});
-
-test("correctly gets a subschema validator for a TA6 overlay which fails to validate with BASPI/TA6 section missing", () => {
-  const path = "/propertyPack";
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  const data = jp.get(clonedExampleTransaction, path);
-  data.materialFacts.waterAndDrainage = {};
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "ta6ed4",
-  ]);
-  let isValid = validator(data);
-  expect(isValid).toBe(false);
-});
-
-test("correctly gets a subschema validator for an NTS overlay", () => {
-  const path = "/propertyPack";
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  const data = jp.get(clonedExampleTransaction, path);
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "nts2023",
-  ]);
-  let isValid = validator(data);
-  expect(isValid).toBe(true);
-});
-
-test("correctly gets a subschema validator for an LPE1 overlay", () => {
-  const path = "/propertyPack";
-  const clonedExampleTransaction = JSON.parse(
-    JSON.stringify(exampleTransaction)
-  );
-  const data = jp.get(clonedExampleTransaction, path);
-  const validator = getSubschemaValidator(path, exampleTransaction.$schema, [
-    "lpe1ed4",
-  ]);
-  let isValid = validator(data);
-  expect(isValid).toBe(false);
-});
-
-test("correctly gets a subschema validator which validates", () => {
-  const path = "/propertyPack/materialFacts/notices";
-  const validator = getSubschemaValidator(path);
-  const data = jp.get(exampleTransaction, 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);
-});
-
-test("correctly gets titles across schemas, arrays and non-existient title properties", () => {
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/ownershipType"
-    )
-  ).toBe("What type of ownership is the property?");
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears"
-    )
-  ).toBe("Length of lease (years)");
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/serviceCharge/annualServiceCharge"
-    )
-  ).toBe("Amount of current annual service charge (£)");
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/materialFacts/invalidPath"
-    )
-  ).toBe(undefined);
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract"
-    )
-  ).toBe("HMLR Official Copy Register Extract");
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
-    )
-  ).toBe("Property address");
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
-    )
-  ).toBe(undefined);
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/materialFacts/energyEfficiency/certificate/currentEnergyRating"
-    )
-  ).toBe("Current energy efficiency rating");
-  expect(
-    getTitleAtPath(
-      v2TransactionSchema,
-      "/propertyPack/additionalLegalInfo/occupiers/othersAged17OrOver/aged17OrOverNames"
-    )
-  ).toBe("Please provide their full names and ages.");
-});