@pdtf/schemas 3.0.0-3 → 3.0.0-31

package/index.js

@@ -71,16 +71,23 @@ const combineMerge = (target, source, options) => {
   return destination;
 };
 
+const mergeEnums = (target, source) => source;
+
 const getTransactionSchema = (
   schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
-  overlays = ["baspiV4"]
+  overlays // = ["baspiV4"]
 ) => {
   const sourceSchema = transactionSchemas[schemaId];
   if (!overlays || overlays.length < 1) return sourceSchema;
   let mergedSchema = sourceSchema;
   overlays.forEach((overlay) => {
     const overlaySchema = overlaysMap[schemaId][overlay] || {};
-    mergedSchema = merge(overlaySchema, mergedSchema, {
+    mergedSchema = merge(mergedSchema, overlaySchema, {
+      customMerge: (key) => {
+        if (key === "enum") {
+          return mergeEnums;
+        }
+      },
       arrayMerge: combineMerge,
     });
   });
@@ -88,13 +95,7 @@ const getTransactionSchema = (
 };
 
 const getValidator = (schemaId, overlays) => {
-  let validator = ajv.getSchema(schemaId);
-  if (!validator) {
-    const schema = getTransactionSchema(schemaId, overlays);
-    ajv.addSchema(schema, schemaId);
-    validator = ajv.getSchema(schemaId);
-  }
-  return validator;
+  return getSubschemaValidator("", schemaId, overlays);
 };
 
 // common functions for v1 and v2
@@ -129,7 +130,7 @@ const isPathValid = (path, schemaId, overlays) => {
   }
 };
 
-const getSubschemaValidator = (path, schemaId, overlays = ["baspiV4"]) => {
+const getSubschemaValidator = (path, schemaId, overlays) => {
   const subSchema = getSubschema(path, schemaId, overlays);
   const overlayKey = (overlays || []).join(".");
   // see if we can retrieve the schema by path, schemaId and overlays
@@ -162,6 +163,7 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   }
   const propertyName = pathArray.shift();
   const subPath = "/" + pathArray.join("/");
+
   let subSchema = schema.properties
     ? schema.properties[propertyName]
     : undefined;
@@ -172,10 +174,9 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
     subSchema = schema.items;
     return getTitleAtPath(subSchema, subPath, rootPath);
   }
-  const discriminator = schema.discriminator?.propertyName;
-  if (discriminator) {
+  const oneOfs = schema.oneOf;
+  if (oneOfs) {
     // only single dependency discriminator, oneOf keyword is supported
-    const oneOfs = schema.oneOf;
     const matchingOneOf = oneOfs.find(
       (oneOf) => oneOf["properties"][propertyName]
     );
@@ -235,4 +236,5 @@ module.exports = {
   getTitleAtPath,
   verifiedClaimsSchema,
   validateVerifiedClaims,
+  overlaysMap,
 };

package/package.json

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

package/src/examples/v3/exampleAddParticipantVouch.json

@@ -0,0 +1,32 @@
+{
+  "verification": {
+    "trust_framework": "uk_pdtf",
+    "time": "2022-01-25T13:05:03.108Z",
+    "evidence": [
+      {
+        "type": "vouch",
+        "attestation": {
+          "type": "digital_attestation",
+          "voucher": {
+            "name": "Martin Abode"
+          }
+        },
+        "verification_method": {
+          "type": "auth"
+        }
+      }
+    ]
+  },
+  "claims": {
+    "/participants/-": {
+      "name": {
+        "firstName": "Martin",
+        "lastName": "Abode"
+      },
+      "email": "martin@abode.co.uk",
+      "organisation": "Abode and Floggit Estate Agents",
+      "organisationReference": "MAR/12243/22",
+      "role": "Estate Agent"
+    }
+  }
+}

package/src/examples/v3/exampleDocumentedVouch.json

@@ -0,0 +1,40 @@
+{
+  "verification": {
+    "trust_framework": "uk_pdtf",
+    "time": "2022-01-25T13:16:44.527Z",
+    "evidence": [
+      {
+        "type": "vouch",
+        "attachments": [
+          {
+            "digest": {
+              "alg": "md5",
+              "value": "randomHashValue"
+            },
+            "url": "https://fakeFileStore.com/some/kind/of/file",
+            "desc": "proofOfAddress.pdf",
+            "pdtfSchemaPath": "/propertyPack/materialFacts/councilTax/councilTaxAffectingAlterations/details"
+          }
+        ],
+        "verification_method": {
+          "type": "auth"
+        },
+        "attestation": {
+          "voucher": {
+            "name": "Maria Harris"
+          },
+          "type": "digital_attestation"
+        }
+      }
+    ]
+  },
+  "claims": {
+    "/propertyPack/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"
+      }
+    }
+  }
+}

package/src/examples/v3/exampleElectronicRecord.json

@@ -0,0 +1,30 @@
+{
+  "verification": {
+    "time": "2022-01-25T07:52:14.318Z",
+    "trust_framework": "uk_pdtf",
+    "evidence": [
+      {
+        "type": "electronic_record",
+        "verifier": {
+          "organization": "Property Pack Assembly Software Ltd"
+        },
+        "record": {
+          "source": {
+            "name": "Royal Mail Postcode Address File",
+            "rights": "(c) Royal Mail"
+          },
+          "type": "postcode_address_file"
+        }
+      }
+    ]
+  },
+  "claims": {
+    "/propertyPack/address": {
+      "line1": "3 The Hollys",
+      "line2": "Birtley",
+      "town": "CHESTER LE STREET",
+      "county": "County Durham",
+      "postcode": "DH3 1QN"
+    }
+  }
+}