@pdtf/schemas 2.0.0-3 → 2.0.0-31

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

@@ -110,12 +110,14 @@ test("correctly gets a subschema through a dependency", () => {
     "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details",
     schemaId
   );
-  expect(subschema.title).toBe("Details");
+  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/general/leaseTerm/lengthOfLeaseInYears",
+    "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/leaseholdInformation/leaseTerm/lengthOfLeaseInYears",
     schemaId
   );
   expect(subschema.title).toBe("Length of lease (years)");
@@ -133,12 +135,12 @@ test("correctly gets yet, yet another subschema through a dependency", () => {
     "/propertyPack/materialFacts/listingAndConservation/isConservationArea/yesNo"
   );
   expect(subschema.type).toBe("string");
-  expect(subschema.enum).toStrictEqual(["Yes", "No"]);
+  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/groundWater/yesNo"
+    "/propertyPack/materialFacts/environmentalIssues/flooding/typeOfFlooding/other/yesNo"
   );
   expect(subschema.type).toBe("string");
   expect(subschema.enum).toStrictEqual(["Yes", "No"]);
@@ -165,6 +167,16 @@ test("correctly gets yes another subschema but through a non-baspi oneOf structu
   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"
@@ -176,6 +188,73 @@ test("correctly gets a subschema validator which is already cached", () => {
   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);
+  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 which validates", () => {
   const path = "/propertyPack/materialFacts/notices";
   const validator = getSubschemaValidator(path);
@@ -198,7 +277,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

@@ -43,9 +43,34 @@ const combineMerge = (target, source, options) => {
   return destination;
 };
 
+const flattenSkeleton = (schema) => {
+  if (!schema) return undefined;
+  // console.log(schema.properties);
+  let returnStructure = {};
+  if (schema.properties) {
+    Object.keys(schema.properties).forEach((key) => {
+      returnStructure[key] = flattenSkeleton(schema.properties[key]);
+    });
+  }
+  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);
+        });
+      }
+    });
+  }
+  if (schema.items) {
+    returnStructure = flattenSkeleton(schema.items);
+  }
+  return returnStructure;
+};
+
 const extractOverlay = (sourceSchema, ref) => {
   const refName = `${ref}Ref`;
-  const refRequired = `${ref}Required`;
   const returnSchema = {
     $schema: "http://json-schema.org/draft-07/schema#",
     $id: `https://trust.propdata.org.uk/schemas/v2/overlays/${ref}.json`,
@@ -74,6 +99,7 @@ const extractOverlay = (sourceSchema, ref) => {
         });
       }
     }
+    const refRequired = `${ref}Required`;
     if (element[refRequired]) {
       jp.set(returnSchema, `${path}/required`, element[refRequired]);
     }
@@ -112,17 +138,29 @@ 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,
-});
+console.log("Core schema written to ../schemas/v2/pdtf-transaction.json");
+
+const skeletonSchema = deleteProperties(coreSchema, [
+  "$schema",
+  "$id",
+  "title",
+  "description",
+  "required",
+  "enum",
+  "minItems",
+  "minLength",
+  "format",
+  "minimum",
+  "maximum",
+]);
+
+const skeletonSchemaFlattened = flattenSkeleton(skeletonSchema);
 
 fs.writeFileSync(
-  "../schemas/v2/merged.json",
-  JSON.stringify(mergedSchema, null, 2)
+  "../schemas/v2/skeleton.json",
+  JSON.stringify(skeletonSchemaFlattened, null, 2)
 );
-console.log("Merged schema written to ../schemas/v2/merged.json");
+console.log("Flat Skeleton schema written to ../schemas/v2/skeleton.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)
+);

package/src/utils/hmlrLLC1.json

@@ -0,0 +1,275 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema#",
+  "$id": "http://www.landregistry.gov.uk/LLC/LLCSearchResponseV2_0#",
+  "type": "object",
+  "properties": {
+    "LocalLandCharge": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "HMLRReference",
+          "RegistrationDate",
+          "Category",
+          "Location",
+          "LocationDominantBuilding"
+        ],
+        "properties": {
+          "HMLRReference": {
+            "type": "string"
+          },
+          "OriginatingAuthority": {
+            "type": "string"
+          },
+          "AuthorityReference": {
+            "type": "string"
+          },
+          "CreationDate": {
+            "type": "object",
+            "properties": {
+              "Value": {
+                "type": "string",
+                "format": "date"
+              }
+            }
+          },
+          "RegistrationDate": {
+            "type": "object",
+            "properties": {
+              "Value": {
+                "type": "string",
+                "format": "date"
+              }
+            }
+          },
+          "Category": {
+            "type": "string"
+          },
+          "ChargeSubCategory": {
+            "type": "string"
+          },
+          "Law": {
+            "type": "string"
+          },
+          "LegalDocument": {
+            "type": "string"
+          },
+          "Location": {
+            "type": "object",
+            "required": ["AddressLine"],
+            "properties": {
+              "PostcodeZone": {
+                "type": "object",
+                "required": ["Postcode"],
+                "properties": {
+                  "Postcode": {
+                    "type": "string"
+                  }
+                }
+              },
+              "AddressLine": {
+                "type": "object",
+                "properties": {
+                  "IndexNumeric": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "Value": {
+                          "type": "number"
+                        }
+                      }
+                    },
+                    "minItems": 0
+                  },
+                  "Line": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "minItems": 0
+                  }
+                }
+              }
+            }
+          },
+          "LocationDominantBuilding": {
+            "type": "object",
+            "required": ["AddressLine"],
+            "properties": {
+              "PostcodeZone": {
+                "type": "object",
+                "required": ["Postcode"],
+                "properties": {
+                  "Postcode": {
+                    "type": "string"
+                  }
+                }
+              },
+              "AddressLine": {
+                "type": "object",
+                "properties": {
+                  "IndexNumeric": {
+                    "type": "array",
+                    "items": {
+                      "type": "number"
+                    },
+                    "minItems": 0
+                  },
+                  "Line": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "minItems": 0
+                  }
+                }
+              }
+            }
+          },
+          "Description": {
+            "type": "string"
+          },
+          "SourceOfInformation": {
+            "type": "string"
+          },
+          "AvailableDocument": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["Document"],
+              "properties": {
+                "Document": {
+                  "type": "string"
+                },
+                "StartDate": {
+                  "type": "string",
+                  "format": "date"
+                },
+                "EndDate": {
+                  "type": "string",
+                  "format": "date"
+                }
+              }
+            },
+            "minItems": 0
+          },
+          "InterestInLand": {
+            "type": "string"
+          },
+          "ApplicantName": {
+            "type": "string"
+          },
+          "ApplicantAddress": {
+            "type": "object",
+            "required": ["AddressLine"],
+            "properties": {
+              "PostcodeZone": {
+                "type": "object",
+                "required": ["Postcode"],
+                "properties": {
+                  "Postcode": {
+                    "type": "string"
+                  }
+                }
+              },
+              "AddressLine": {
+                "type": "object",
+                "properties": {
+                  "IndexNumeric": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "Value": {
+                          "type": "number"
+                        }
+                      }
+                    },
+                    "minItems": 0
+                  },
+                  "Line": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "Value": {
+                          "type": "string"
+                        }
+                      }
+                    },
+                    "minItems": 0
+                  }
+                }
+              }
+            }
+          },
+          "ServientLandDevelopment": {
+            "type": "object",
+            "required": ["Height", "CoversAllOrPartOfExtent"],
+            "properties": {
+              "Height": {
+                "type": "string"
+              },
+              "CoversAllOrPartOfExtent": {
+                "type": "string"
+              }
+            }
+          },
+          "Amount": {
+            "type": "string"
+          },
+          "InterestRate": {
+            "type": "string"
+          },
+          "LandSold": {
+            "type": "string"
+          },
+          "WorksDone": {
+            "type": "string"
+          },
+          "AdvancePayment": {
+            "type": "string"
+          },
+          "TotalCompensation": {
+            "type": "string"
+          },
+          "AgreedOrEstimated": {
+            "type": "string"
+          },
+          "Adjoining": {
+            "type": "boolean"
+          },
+          "OtherData": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["DataLabel", "Data"],
+              "properties": {
+                "DataLabel": {
+                  "type": "string"
+                },
+                "Data": {
+                  "type": "string"
+                }
+              }
+            },
+            "minItems": 0
+          },
+          "ChargeExtent": {
+            "type": "object",
+            "properties": {
+              "Value": {
+                "type": "string"
+              },
+              "format": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      },
+      "minItems": 0
+    }
+  }
+}