@pdtf/schemas 0.6.12 → 0.6.15

package/index.js

@@ -119,38 +119,44 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
 };
 
-const validateVerifiedClaims = (verifiedClaimsArray) => {
-
-const validatorVClaims = ajv.compile(verifiedClaimsSchema);
+const validateVerifiedClaims = (verifiedClaims) => {
+  const validatorVClaims = ajv.compile(verifiedClaimsSchema);
 
   const validationErrorsArr = [];
   const vClaimSchValidation = validatorVClaims({
-    verified_claims: verifiedClaimsArray,
+    verified_claims: verifiedClaims,
   });
 
   if (!vClaimSchValidation) {
     validationErrorsArr.push(validatorVClaims.errors);
   }
 
+  const verifiedClaimsArray = Array.isArray(verifiedClaims)
+    ? verifiedClaims
+    : [verifiedClaims];
+
   verifiedClaimsArray.forEach((claim) => {
-    const [path] = Object.keys(claim.claims);
-
-    const validPath = isPathValid(path);
-    if (validPath) {
-      const subValidator = getSubschemaValidator(path);
-      const isValid = subValidator(claim.claims[path]);
-      if (!isValid) {
-        validationErrorsArr.push(...subValidator.errors);
+    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`
+        );
       }
-    } else {
-      validationErrorsArr.push(`Path ${path} is not a valid PDTF schema path`);
     }
   });
 
   return validationErrorsArr;
 };
 
-
 module.exports = {
   transactionSchema,
   validator,
@@ -159,5 +165,5 @@ module.exports = {
   getSubschemaValidator,
   getTitleAtPath,
   verifiedClaimsSchema,
-  validateVerifiedClaims
+  validateVerifiedClaims,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "0.6.12",
+  "version": "0.6.15",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

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

@@ -201,24 +201,21 @@
           "maintenanceAgreements": {
             "yesNo": "No"
           },
-          "yesNo": "Yes",
-          "connected": "Yes",
+          "yesNo": "To be connected",
+          "dateToBeConnected": "2022-12-15",
           "supplier": "Northumbria Water"
         },
         "mainsSurfaceWaterDrainage": {
           "maintenanceAgreements": {
             "yesNo": "No"
           },
-          "yesNo": "Yes",
-          "connected": "Yes",
-          "supplier": "Northumbria Water"
+          "yesNo": "Yes"
         },
         "mainsFoulDrainage": {
           "maintenanceAgreements": {
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Northumbria Water"
         }
       },
@@ -228,7 +225,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Octopus Energy"
         },
         "gas": {
@@ -236,7 +232,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Octopus Energy"
         },
         "lpg": {
@@ -250,7 +245,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "EE"
         },
         "cableSatelliteTV": {
@@ -258,7 +252,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "Sky"
         },
         "broadband": {
@@ -266,7 +259,6 @@
             "yesNo": "No"
           },
           "yesNo": "Yes",
-          "connected": "Yes",
           "supplier": "EE"
         },
         "solarPanels": {

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

@@ -792,7 +792,7 @@
             "yesNo": {
               "type": "string",
               "title": "",
-              "enum": ["Yes", "No"]
+              "enum": ["Yes", "To be connected", "No"]
             }
           },
           "dependencies": {
@@ -887,22 +887,40 @@
                     "yesNo": {
                       "enum": ["Yes"]
                     },
-                    "connected": {
-                      "title": "Connected (Yes, No or Date to be connected)",
+                    "supplier": {
+                      "title": "Supplier (if known)",
                       "type": "string",
                       "minLength": 1
                     },
+                    "maintenanceAgreements": {
+                      "title": "Do you have any licences, maintenance agreements, contracts or service agreements in relation to this service?",
+                      "$ref": "#/$defs/yesNoDetailIfYes"
+                    }
+                  },
+                  "required": ["maintenanceAgreements"]
+                },
+                {
+                  "properties": {
+                    "yesNo": {
+                      "enum": ["To be connected"]
+                    },
+                    "dateToBeConnected": {
+                      "title": "Date to be connected",
+                      "type": "string",
+                      "format": "date"
+                    },
                     "supplier": {
                       "title": "Supplier (if known)",
-                      "type": "string",
-                      "minLength": 1
+                      "type": "string"
                     },
                     "maintenanceAgreements": {
+                      "BASPIRef": "A7.2",
+                      "RDSRef": "Services/Certificates,Services/OtherServices/Certificates",
                       "title": "Do you have any licences, maintenance agreements, contracts or service agreements in relation to this service?",
                       "$ref": "#/$defs/yesNoDetailIfYes"
                     }
                   },
-                  "required": ["connected", "maintenanceAgreements"]
+                  "required": ["dateToBeConnected", "maintenanceAgreements"]
                 }
               ]
             }
@@ -1529,7 +1547,7 @@
                   "$ref": "#/$defs/yesNoDetailIfYes"
                 }
               },
-              "required": ["connected"]
+              "required": ["maintenanceAgreements"]
             },
             {
               "properties": {
@@ -1552,7 +1570,7 @@
                   "$ref": "#/$defs/yesNoDetailIfYes"
                 }
               },
-              "required": ["dateToBeConnected"]
+              "required": ["dateToBeConnected", "maintenanceAgreements"]
             }
           ]
         }

package/src/tests/transactionSchema.test.js

@@ -7,7 +7,6 @@ const {
   isPathValid,
   getSubschemaValidator,
   getTitleAtPath,
-  validateVerifiedClaims
 } = require("../../index.js");
 const exampleTransaction = require("../examples/exampleTransaction.json");
 
@@ -183,209 +182,3 @@ 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 empty array of errors if data in the path is in valid 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",
-          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([]);
-});

package/src/tests/verifiedClaimsValidator.test.js

@@ -0,0 +1,96 @@
+const { validateVerifiedClaims } = require("../../index.js");
+
+const exampleVouch = require("../examples/exampleVouch.json");
+const exampleDocumentedVouch = require("../examples/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([]);
+});