@pdtf/schemas 2.1.2-1 → 2.3.0-1

package/src/schemas/v2/skeleton.json

@@ -59,9 +59,11 @@
       },
       "priceInformation": {
         "price": {},
-        "priceQualifier": {}
+        "priceQualifier": {},
+        "disposal": {}
       },
       "summaryDescription": {},
+      "marketingTenure": {},
       "media": {
         "mediaType": {},
         "mediaUrl": {},
@@ -108,7 +110,8 @@
             "secondary": {},
             "college": {},
             "private": {}
-          }
+          },
+          "otherRating": {}
         },
         "transport": {
           "name": {},
@@ -3721,11 +3724,7 @@
             "consequentialChargingBasis": {}
           }
         },
-        "recommendedActionIndicator": {},
-        "actionAlertRating": {},
-        "summary": {},
-        "recommendations": {},
-        "complianceStatement": {}
+        "riskResults": {}
       }
     },
     "documents": {
@@ -3735,5 +3734,48 @@
       "documentType": {},
       "externalIds": {}
     }
+  },
+  "valuationComparisonData": {
+    "propertyDetails": {
+      "propertyListingInfo": {
+        "listingType": {},
+        "soldDate": {},
+        "soldPrice": {},
+        "listedDate": {},
+        "listPrice": {}
+      },
+      "propertyFullDescription": {},
+      "uprn": {},
+      "propertyType": {},
+      "marketingTenure": {},
+      "basicDetails": {
+        "bedrooms": {},
+        "bathrooms": {},
+        "buildInformation": {
+          "internalArea": {
+            "area": {},
+            "units": {}
+          },
+          "yearOfBuild": {}
+        }
+      },
+      "media": {
+        "mediaType": {},
+        "mediaUrl": {},
+        "caption": {}
+      }
+    },
+    "propertyPricing": {
+      "rentalEstimate": {
+        "estimatedAmount": {},
+        "paymentFrequency": {}
+      },
+      "estimatedPrice": {},
+      "yield": {},
+      "priceEstimationDetails": {
+        "credibilitySources": {},
+        "pricingMethodology": {}
+      }
+    }
   }
 }

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

@@ -255,6 +255,32 @@ test("correctly gets a subschema validator for a TA6 overlay which fails to vali
   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(false);
+});
+
+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);

package/src/tests/v1/pdtfVerifiedClaims.test.js

@@ -1,75 +0,0 @@
-const Ajv = require("ajv");
-const addFormats = require("ajv-formats");
-
-const verifiedClaimsSchema = require("../../schemas/v1/pdtf-verified-claims.json");
-const exampleElectronicRecord = require("../../examples/v1/exampleElectronicRecord.json");
-const exampleVouch = require("../../examples/v1/exampleVouch.json");
-const exampleDocumentedVouch = require("../../examples/v1/exampleDocumentedVouch.json");
-
-const ajv = new Ajv({
-  allErrors: true,
-  strictSchema: false,
-  discriminator: true,
-});
-addFormats(ajv);
-
-const validator = ajv.compile(verifiedClaimsSchema);
-
-test("valid vouch sample is valid", () => {
-  const isValid = validator({ verified_claims: [exampleVouch] });
-  expect(isValid).toBe(true);
-});
-
-test("valid electronic record sample is valid", () => {
-  const isValid = validator({ verified_claims: [exampleElectronicRecord] });
-  expect(isValid).toBe(true);
-});
-
-test("valid documented vouch sample is valid", () => {
-  const isValid = validator({ verified_claims: [exampleDocumentedVouch] });
-  expect(isValid).toBe(true);
-});
-
-test("sample with primitive claims value is valid", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  clonedVouch.claims = { "/propertyPack/uprn": 123456 };
-  const isValid = validator({ verified_claims: [clonedVouch] });
-  expect(isValid).toBe(true);
-});
-
-test("sample with undefined claims value is also valid, but this would fail when the payload is validated", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  clonedVouch.claims = { "/propertyPack/uprn": undefined };
-  const isValid = validator({ verified_claims: [clonedVouch] });
-  expect(isValid).toBe(true);
-});
-
-test("claim with missing claims is invalid", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  delete clonedVouch.claims;
-  const isValid = validator({ verified_claims: [clonedVouch] });
-  expect(isValid).toBe(false);
-});
-
-test("claim with invalid claims path is invalid", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  const originalPath = Object.keys(clonedVouch.claims)[0];
-  const data = clonedVouch.claims[originalPath];
-  clonedVouch.claims = { "invalidPath//of?someKind": data };
-  const isValid = validator({ verified_claims: [clonedVouch] });
-  expect(isValid).toBe(false);
-});
-
-test("verification with invalid evidence type is invalid", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  clonedVouch.verification.evidence[0].type = "something invalid";
-  const isValid = validator({ verified_claims: [clonedVouch] });
-  expect(isValid).toBe(false);
-});
-
-test("verification with no framework type is invalid", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  delete clonedVouch.verification.trust_framework;
-  const isValid = validator({ verified_claims: [clonedVouch] });
-  expect(isValid).toBe(false);
-});

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

@@ -1,227 +0,0 @@
-const jp = require("jsonpointer");
-
-const {
-  transactionSchema,
-  validator,
-  getSubschema,
-  isPathValid,
-  getSubschemaValidator,
-  getTitleAtPath,
-} = 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();
-});
-
-test("sample is valid", () => {
-  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 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 isValid = validator(clonedExampleTransaction);
-  expect(isValid).toBe(false);
-});
-
-test("correctly gets a top level subschema", () => {
-  const subschema = getSubschema("/propertyPack");
-  expect(subschema.title).toBe("Property Pack");
-});
-
-test("correctly identifies a valid path", () => {
-  const isValid = isPathValid("/propertyPack/materialFacts");
-  expect(isValid).toBe(true);
-});
-
-test("correctly identifies an undefined invalid path", () => {
-  const isValid = isPathValid("/propertyPack/materialItems");
-  expect(isValid).toBe(false);
-});
-
-test("correctly identifies an error generating invalid path", () => {
-  const isValid = isPathValid("/propertyPack/materialItems/someProperty/item");
-  expect(isValid).toBe(false);
-});
-
-test("correctly identifies an array invalid path", () => {
-  const isValid = isPathValid("/propertyPack/materialFacts/1/item");
-  expect(isValid).toBe(false);
-});
-
-test("correctly gets a subschema", () => {
-  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 = 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 = getV1Subschema("/participants/0/name/firstName");
-  expect(subschema.title).toBe("First name");
-});
-
-test("correctly gets a subschema through a dependency", () => {
-  const subschema = getV1Subschema(
-    "/propertyPack/materialFacts/delayFactors/hasDelayFactors/details"
-  );
-  expect(subschema.title).toBe("Details");
-});
-
-test("correctly gets another subschema through a dependency", () => {
-  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 = 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 = getV1Subschema(
-    "/propertyPack/materialFacts/listingAndConservation/isConservationArea/yesNo"
-  );
-  expect(subschema.type).toBe("string");
-  expect(subschema.enum).toStrictEqual(["Yes", "No"]);
-});
-
-test("correctly gets yet, yet, yet another subschema through a dependency", () => {
-  const subschema = getV1Subschema(
-    "/propertyPack/materialFacts/otherIssues/flooding/typeOfFlooding/groundWater/yesNo"
-  );
-  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 = 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 = 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 = getV1Subschema(
-    "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/RestrictionDetails/RestrictionEntry/0/ChargeRestriction/EntryDetails/EntryText"
-  );
-  expect(subschema).toEqual({ type: "string" });
-});
-
-test("correctly gets a subschema validator which is already cached", () => {
-  const validator = getSubschemaValidator(
-    "/propertyPack/materialFacts/energyEfficiency/certificate"
-  );
-  expect(validator).not.toBeNull();
-  const anotherValidator = getSubschemaValidator(
-    "/propertyPack/materialFacts/energyEfficiency/certificate"
-  );
-  expect(anotherValidator).not.toBeNull();
-});
-
-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(
-      transactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/ownershipType"
-    )
-  ).toBe("What type of ownership is the property?");
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/lengthOfLeaseInYears"
-    )
-  ).toBe("Length of lease (years)");
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/materialFacts/ownership/ownershipsToBeTransferred/0/annualServiceCharge"
-    )
-  ).toBe(
-    "Amount of current annual service charge/estate rentcharge/maintenance contribution (£)"
-  );
-  expect(
-    getTitleAtPath(transactionSchema, "/propertyPack/materialFacts/invalidPath")
-  ).toBe(undefined);
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract"
-    )
-  ).toBe("HMLR Official Copy Register Extract");
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/PropertyAddress"
-    )
-  ).toBe("Property address");
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/titlesToBeSold/0/registerExtract/OCSummaryData/InvalidProp"
-    )
-  ).toBe(undefined);
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/energyPerformanceCertificate/certificate/currentEnergyRating"
-    )
-  ).toBe("Current energy rating");
-  expect(
-    getTitleAtPath(
-      transactionSchema,
-      "/propertyPack/additionalLegalInfo/occupiers/othersAged17OrOver/aged17OrOverNames/0/firstName"
-    )
-  ).toBe("First Name");
-});

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

@@ -1,96 +0,0 @@
-const { validateVerifiedClaims } = require("../../../index.js");
-
-const exampleVouch = require("../../examples/v1/exampleVouch.json");
-const exampleDocumentedVouch = require("../../examples/v1/exampleDocumentedVouch.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,
-  };
-  expect(validateVerifiedClaims([clonedVouch])).toEqual([
-    "Path /propertyPack/INVALID/materialFacts/councilTax is not a valid PDTF schema path",
-  ]);
-});
-
-test("returns an array of errors if data in the path is in invalid format", () => {
-  const clonedVouch = JSON.parse(JSON.stringify(exampleVouch));
-  clonedVouch.claims = {
-    "/propertyPack/materialFacts/councilTax": {
-      councilTaxBand: "D",
-      councilTaxAffectingAlterationsINVALID: {
-        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])).toEqual([
-    {
-      instancePath: "",
-      schemaPath: "#/required",
-      keyword: "required",
-      params: { missingProperty: "councilTaxAffectingAlterations" },
-      message: "must have required property 'councilTaxAffectingAlterations'",
-    },
-  ]);
-});
-
-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])).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));
-  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])).toEqual([]);
-});