@pdtf/schemas 0.6.10 → 0.6.13

package/index.js

@@ -119,6 +119,42 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
+const validateVerifiedClaims = (verifiedClaimsArray) => {
+  const validatorVClaims = ajv.compile(verifiedClaimsSchema);
+
+  const validationErrorsArr = [];
+  const vClaimSchValidation = validatorVClaims({
+    verified_claims: verifiedClaimsArray,
+  });
+
+  if (!vClaimSchValidation) {
+    validationErrorsArr.push(validatorVClaims.errors);
+  }
+
+  verifiedClaimsArray.forEach((claim) => {
+    const paths = Object.keys(claim.claims);
+
+    for (const path of paths) {
+      const validPath = isPathValid(path);
+      if (validPath) {
+        const subValidator = getSubschemaValidator(path);
+        const isValid = subValidator(claim.claims[path]);
+        if (!isValid) {
+          validationErrorsArr.push(...subValidator.errors);
+        }
+      } else {
+        validationErrorsArr.push(
+          `Path ${path} is not a valid PDTF schema path`
+        );
+      }
+    }
+  });
+
+  return validationErrorsArr;
+};
+
+
+
 module.exports = {
   transactionSchema,
   validator,
@@ -127,4 +163,5 @@ module.exports = {
   getSubschemaValidator,
   getTitleAtPath,
   verifiedClaimsSchema,
+  validateVerifiedClaims
 };

package/package.json

@@ -1,36 +1,36 @@
 {
-  "name": "@pdtf/schemas",
-  "version": "0.6.10",
-  "description": "Property Data Trust Framework Schemas and Utilities",
-  "main": "index.js",
-  "directories": {
-    "doc": "docs"
-  },
-  "scripts": {
-    "test": "jest",
-    "test:watch": "jest --watch"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Property-Data-Trust-Framework/schemas.git"
-  },
-  "keywords": [
-    "PDTF",
-    "Schemas"
-  ],
-  "author": "",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Property-Data-Trust-Framework/schemas/issues"
-  },
-  "homepage": "https://github.com/Property-Data-Trust-Framework/schemas#readme",
-  "dependencies": {
-    "@jdw/jst": "^2.0.0-beta.15",
-    "ajv": "^8.10.0",
-    "ajv-formats": "^2.1.1",
-    "jsonpointer": "^5.0.0"
-  },
-  "devDependencies": {
-    "jest": "^27.5.1"
-  }
-}
+	"name": "@pdtf/schemas",
+	"version": "0.6.13",
+	"description": "Property Data Trust Framework Schemas and Utilities",
+	"main": "index.js",
+	"directories": {
+		"doc": "docs"
+	},
+	"scripts": {
+		"test": "jest",
+		"test:watch": "jest --watch"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Property-Data-Trust-Framework/schemas.git"
+	},
+	"keywords": [
+		"PDTF",
+		"Schemas"
+	],
+	"author": "",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/Property-Data-Trust-Framework/schemas/issues"
+	},
+	"homepage": "https://github.com/Property-Data-Trust-Framework/schemas#readme",
+	"dependencies": {
+		"@jdw/jst": "^2.0.0-beta.15",
+		"ajv": "^8.10.0",
+		"ajv-formats": "^2.1.1",
+		"jsonpointer": "^5.0.0"
+	},
+	"devDependencies": {
+		"jest": "^27.5.1"
+	}
+}

package/src/examples/exampleDocumentedVouch.json

@@ -4,19 +4,7 @@
     "time": "2022-01-25T13:16:44.527Z",
     "evidence": [
       {
-        "verification_method": {
-          "type": "auth"
-        },
         "type": "vouch",
-        "attestation": {
-          "voucher": {
-            "name": "Maria Harris"
-          },
-          "type": "digital_attestation"
-        }
-      },
-      {
-        "type": "document",
         "attachments": [
           {
             "digest": {
@@ -26,7 +14,16 @@
             "url": "https://fakeFileStore.com/some/kind/of/file",
             "desc": "proofOfAddress.pdf"
           }
-        ]
+        ],
+        "verification_method": {
+          "type": "auth"
+        },
+        "attestation": {
+          "voucher": {
+            "name": "Maria Harris"
+          },
+          "type": "digital_attestation"
+        }
       }
     ]
   },

package/src/examples/exampleTransaction.json

@@ -282,7 +282,8 @@
         }
       },
       "centralHeating": {
-        "hasCentralHeating": {
+        "hasCentralHeating": "Yes",
+        "centralHeatingDetails": {
           "boilerInstallationCertificate": {
             "yesNo": "Yes",
             "details": "Certified installation"
@@ -290,10 +291,8 @@
           "heatingInGoodWorkingOrder": {
             "yesNo": "Yes"
           },
-          "yesNo": "Yes",
           "centralHeatingFuel": "Gas boiler",
           "centralHeatingInstalled": "2016-04-20",
-          "heatingServiceReport": "Full service history available from Whickham Plumbing & Heating ",
           "heatingLastServiced": "2021-03-26"
         }
       },

package/src/schemas/baspi-a-material-facts.json

@@ -1005,90 +1005,89 @@
       "baspiRef": "A7.4",
       "RDSRef": "Buildings|BuildingSections/isUnheated=no|yes|true|false",
       "lawSocietyRef": "TA6/12.3",
+      "title": "Central Heating",
       "type": "object",
       "required": ["hasCentralHeating"],
       "properties": {
         "hasCentralHeating": {
           "title": "Is there full/partial central heating in your property?",
-          "yesNoCentralHeatingDetailIfYes": {
-            "type": "object",
-            "properties": {
-              "yesNo": {
-                "type": "string",
-                "title": "",
-                "enum": ["Yes", "No"]
-              }
+          "type": "string",
+          "enum": ["Yes", "No"]
+        }
+      },
+      "dependencies": {
+        "hasCentralHeating": {
+          "oneOf": [
+            {
+              "properties": {
+                "hasCentralHeating": {
+                  "enum": ["No"]
+                }
+              },
+              "additionalProperties": false
             },
-            "required": ["yesNo"],
-            "dependencies": {
-              "yesNo": {
-                "oneOf": [
-                  {
-                    "properties": {
-                      "yesNo": {
-                        "enum": ["No"]
-                      }
+            {
+              "properties": {
+                "hasCentralHeating": {
+                  "enum": ["Yes"]
+                },
+                "centralHeatingDetails": {
+                  "type": "object",
+                  "title": "Central Heating Details",
+                  "properties": {
+                    "centralHeatingFuel": {
+                      "baspiRef": "A7.5.1",
+                      "RDSRef": "Buildings|BuildingSections/Heating/isGas=no|yes|true|false",
+                      "lawSocietyRef": "TA6/12.3a",
+                      "title": "Please provide details of the type of fuel which the system and boiler runs on",
+                      "type": "string",
+                      "minLength": 1
                     },
-                    "additionalProperties": false
-                  },
-                  {
-                    "properties": {
-                      "yesNo": {
-                        "enum": ["Yes"]
-                      },
-                      "centralHeatingFuel": {
-                        "baspiRef": "A7.5.1",
-                        "RDSRef": "Buildings|BuildingSections/Heating/isGas=no|yes|true|false",
-                        "lawSocietyRef": "TA6/12.3a",
-                        "title": "Please provide details of the type of fuel which the system and boiler runs on",
-                        "type": "string",
-                        "minLength": 1
-                      },
-                      "centralHeatingInstalled": {
-                        "baspiRef": "A7.5.2",
-                        "RDSRef": "Objects/Installed",
-                        "lawSocietyRef": "TA6/12.3b",
-                        "title": "When was the heating system and boiler installed?",
-                        "type": "string",
-                        "format": "date"
-                      },
-                      "boilerInstallationCertificate": {
-                        "baspiRef": "A7.5.3",
-                        "RDSRef": "Objects/Installation,Objects/Certificates",
-                        "lawSocietyRef": "TA6/12.3b",
-                        "title": "Was a gas boiler installed after 1st April 2005, or a solid fuel or oil boiler installed after 1 October 2010?",
-                        "$ref": "#/$defs/yesNoDetailIfYes",
-                        "description": "If yes, please supply a copy of the installation completion certificate from a competent person qualified under the relevant self-certification scheme e.g. HETAS etc"
-                      },
-                      "heatingLastServiced": {
-                        "baspiRef": "A7.5.4",
-                        "RDSRef": "Objects/Maintenance",
-                        "lawSocietyRef": "TA6/12.3d",
-                        "title": "When was the heating system and boiler last serviced or maintained?",
-                        "type": "string",
-                        "format": "date"
-                      },
-                      "heatingServiceReport": {
-                        "baspiRef": "A7.5.5",
-                        "RDSRef": "Objects/Servicing",
-                        "lawSocietyRef": "TA6/12.3d",
-                        "title": "Please provide a copy of the service or maintenance works report",
-                        "type": "string"
-                      },
-                      "heatingInGoodWorkingOrder": {
-                        "baspiRef": "A7.5.6",
-                        "RDSRef": "Objects/Condition=?",
-                        "lawSocietyRef": "TA6/12.3c",
-                        "title": "Is the heating system in good working order to your satisfaction?",
-                        "$ref": "#/$defs/yesNoDetailIfNo",
-                        "description": "If 'No' please provide details"
-                      }
+                    "centralHeatingInstalled": {
+                      "baspiRef": "A7.5.2",
+                      "RDSRef": "Objects/Installed",
+                      "lawSocietyRef": "TA6/12.3b",
+                      "title": "When was the heating system and boiler installed?",
+                      "type": "string",
+                      "format": "date"
+                    },
+                    "boilerInstallationCertificate": {
+                      "baspiRef": "A7.5.3",
+                      "RDSRef": "Objects/Installation,Objects/Certificates",
+                      "lawSocietyRef": "TA6/12.3b",
+                      "title": "Was a gas boiler installed after 1st April 2005, or a solid fuel or oil boiler installed after 1 October 2010?",
+                      "$ref": "#/$defs/yesNoDetailIfYes",
+                      "description": "If yes, please supply a copy of the installation completion certificate from a competent person qualified under the relevant self-certification scheme e.g. HETAS etc"
+                    },
+                    "heatingLastServiced": {
+                      "baspiRef": "A7.5.4",
+                      "RDSRef": "Objects/Maintenance",
+                      "lawSocietyRef": "TA6/12.3d",
+                      "title": "When was the heating system and boiler last serviced or maintained? Please provide a copy of the service or maintenance works report ",
+                      "type": "string",
+                      "format": "date"
+                    },
+                    "heatingInGoodWorkingOrder": {
+                      "baspiRef": "A7.5.6",
+                      "RDSRef": "Objects/Condition=?",
+                      "lawSocietyRef": "TA6/12.3c",
+                      "title": "Is the heating system in good working order to your satisfaction?",
+                      "$ref": "#/$defs/yesNoDetailIfNo",
+                      "description": "If 'No' please provide details"
                     }
-                  }
-                ]
-              }
+                  },
+                  "required": [
+                    "centralHeatingFuel",
+                    "centralHeatingInstalled",
+                    "boilerInstallationCertificate",
+                    "heatingLastServiced",
+                    "heatingInGoodWorkingOrder"
+                  ]
+                }
+              },
+              "required": ["centralHeatingDetails"]
             }
-          }
+          ]
         }
       }
     },

package/src/tests/transactionSchema.test.js

@@ -7,6 +7,7 @@ const {
   isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
+  validateVerifiedClaims
 } = require("../../index.js");
 const exampleTransaction = require("../examples/exampleTransaction.json");
 
@@ -182,3 +183,274 @@ test("correctly gets titles across schemas, arrays and non-existient title prope
     )
   ).toBe("Current energy rating");
 });
+
+test("returns an array with an error stating if path is incorrect", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        time: "2022-01-25T13:16:44.527Z",
+        evidence: [
+          {
+            verification_method: {
+              type: "auth",
+            },
+            type: "vouch",
+            attestation: {
+              voucher: {
+                name: "Maria Harris",
+              },
+              type: "digital_attestation",
+            },
+          },
+          {
+            type: "document",
+            attachments: [
+              {
+                digest: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      claims: {
+        "/propertyPack/INVALID/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",
+          },
+        },
+      },
+    },
+  ];
+  expect(validateVerifiedClaims(vClaims)).toEqual([
+    "Path /propertyPack/INVALID/materialFacts/councilTax is not a valid PDTF schema path",
+  ]);
+});
+
+test("returns an empty array if path is correct", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        time: "2022-01-25T13:16:44.527Z",
+        evidence: [
+          {
+            verification_method: {
+              type: "auth",
+            },
+            type: "vouch",
+            attestation: {
+              voucher: {
+                name: "Maria Harris",
+              },
+              type: "digital_attestation",
+            },
+          },
+          {
+            type: "document",
+            attachments: [
+              {
+                digest: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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",
+          },
+        },
+      },
+    },
+  ];
+  expect(validateVerifiedClaims(vClaims)).toEqual([]);
+});
+
+test("returns an array of errors if data in the path is in invalid format", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        time: "2022-01-25T13:16:44.527Z",
+        evidence: [
+          {
+            verification_method: {
+              type: "auth",
+            },
+            type: "vouch",
+            attestation: {
+              voucher: {
+                name: "Maria Harris",
+              },
+              type: "digital_attestation",
+            },
+          },
+          {
+            type: "document",
+            attachments: [
+              {
+                digest: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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(vClaims)).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 vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        time: "2022-01-25T13:16:44.527Z",
+        evidence: [
+          {
+            verification_method: {
+              type: "auth",
+            },
+            type: "vouch",
+            attestation: {
+              voucher: {
+                name: "Maria Harris",
+              },
+              type: "digital_attestation",
+            },
+          },
+          {
+            type: "document",
+            attachments: [
+              {
+                digest: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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(vClaims)).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 paths", () => {
+  const vClaims = [
+    {
+      verification: {
+        trust_framework: "uk_pdtf",
+        time: "2022-01-25T13:16:44.527Z",
+        evidence: [
+          {
+            verification_method: {
+              type: "auth",
+            },
+            type: "vouch",
+            attestation: {
+              voucher: {
+                name: "Maria Harris",
+              },
+              type: "digital_attestation",
+            },
+          },
+          {
+            type: "document",
+            attachments: [
+              {
+                digest: {
+                  alg: "md5",
+                  value: "randomHashValue",
+                },
+                url: "https://fakeFileStore.com/some/kind/of/file",
+                desc: "proofOfAddress.pdf",
+              },
+            ],
+          },
+        ],
+      },
+      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(vClaims)).toEqual([]);
+});