@pdtf/schemas 1.1.1 → 2.0.0-0

package/index.js

@@ -1,7 +1,17 @@
 const { dereference } = require("@jdw/jst");
+const merge = require("deepmerge");
 const Ajv = require("ajv");
 const addFormats = require("ajv-formats");
+const ajv = new Ajv({
+  allErrors: true,
+  // schema contains additional baspiRef and RDSRef metadata which is not strictly valid
+  strictSchema: false,
+  discriminator: true,
+});
+// Adds date formats among other types to the validator.
+addFormats(ajv);
 
+// v1, deprecated direct access
 const pdtfTransaction = require("./src/schemas/v1/pdtf-transaction.json");
 const materialFacts = require("./src/schemas/v1/material-facts.json");
 const legalInformation = require("./src/schemas/v1/legal-information.json");
@@ -30,50 +40,106 @@ const subSchemas = {
   "https://trust.propdata.org.uk/schemas/v1/searches/drainage-and-water.json":
     drainageAndWater,
 };
-
 const transactionSchema = dereference(pdtfTransaction, (id) => subSchemas[id]);
+const validator = ajv.compile(transactionSchema);
 
-const ajv = new Ajv({
-  allErrors: true,
-  // schema contains additional baspiRef and RDSRef metadata which is not strictly valid
-  strictSchema: false,
-  discriminator: true,
-});
-// Adds date formats among other types to the validator.
-addFormats(ajv);
+// v2, via accessor functions and overlays
+const combinedSchema = require("./src/schemas/v2/combined.json");
+const coreSchema = require("./src/schemas/v2/core.json");
+
+const baspiOverlay = require("./src/schemas/v2/overlays/baspi.json");
+// const ta6Overlay = require("./src/schemas/v2/overlays/ta6.json");
+// const ta7Overlay = require("./src/schemas/v2/overlays/ta7.json");
+// const lpe1Overlay = require("./src/schemas/v2/overlays/lpe1.json");
+// const fme1Overlay = require("./src/schemas/v2/overlays/fme1.json");
+// const llc1Overlay = require("./src/schemas/v2/overlays/llc1.json");
+// const con29ROverlay = require("./src/schemas/v2/overlays/con29R.json");
+// const con29DWOverlay = require("./src/schemas/v2/overlays/con29DW.json");
+// const rdsOverlay = require("./src/schemas/v2/overlays/rds.json");
+// const oc1Overlay = require("./src/schemas/v2/overlays/oc1.json");
+
+const overlays = { baspiV4: baspiOverlay };
+
+const transactionSchemas = {
+  "https://trust.propdata.org.uk/schemas/v1/pdtf-transaction.json":
+    transactionSchema,
+  "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json": coreSchema,
+};
 
-const validator = ajv.compile(transactionSchema);
+const combineMerge = (target, source, options) => {
+  const destination = target.slice();
+  source.forEach((item, index) => {
+    if (typeof destination[index] === "undefined") {
+      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options);
+    } else if (options.isMergeableObject(item)) {
+      destination[index] = merge(target[index], item, options);
+    } else if (target.indexOf(item) === -1) {
+      destination.push(item);
+    }
+  });
+  return destination;
+};
+
+const getTransactionSchema = (
+  schemaId = "https://trust.propdata.org.uk/schemas/v2/pdtf-transaction.json",
+  overlay = "baspiV4"
+) => {
+  const sourceSchema = transactionSchemas[schemaId];
+  const overlaySchema = overlays[overlay];
+  if (!overlaySchema) return sourceSchema;
+  const mergedSchema = merge(overlaySchema, sourceSchema, {
+    arrayMerge: combineMerge,
+  });
+  // console.log("mergedSchema", mergedSchema);
+  return mergedSchema;
+};
+
+const getValidator = (schemaId, overlay = "baspiV4") => {
+  let validator = ajv.getSchema(schemaId);
+  if (!validator) {
+    const schema = getTransactionSchema(schemaId, overlay);
+    ajv.addSchema(schema, schemaId);
+    validator = ajv.getSchema(schemaId);
+  }
+  return validator;
+};
 
-const getSubschema = (path) => {
+// common functions for v1 and v2
+const getSubschema = (path, sourceSchema = transactionSchema) => {
   const pathArray = path.split("/").slice(1);
-  if (pathArray.length < 1) return transactionSchema;
+  if (pathArray.length < 1) return sourceSchema;
   return pathArray.reduce((schema, pathElement) => {
-    if (schema.type === "array") return schema.items;
-    if (schema.properties[pathElement]) return schema.properties[pathElement];
-    const discriminator = schema.discriminator?.propertyName;
-    if (discriminator) {
-      // only single dependency discriminator, oneOf keyword is supported
-      const oneOfs = schema.oneOf;
-      const matchingOneOf = oneOfs.find(
-        (oneOf) => oneOf["properties"][pathElement]
-      );
-      if (matchingOneOf) return matchingOneOf["properties"][pathElement];
+    const { type, items, properties, oneOf } = schema;
+    if (type === "array") return items;
+    if (properties?.[pathElement]) return properties[pathElement];
+    if (oneOf) {
+      let matchingProperty;
+      oneOf.forEach((aOneOf) => {
+        if (aOneOf.type === "array" && !Number.isNaN(pathElement)) {
+          matchingProperty = aOneOf.items;
+        } else if (aOneOf.properties?.[pathElement]) {
+          matchingProperty = aOneOf.properties?.[pathElement];
+        }
+      });
+      if (matchingProperty) return matchingProperty;
     }
     return undefined;
-  }, transactionSchema);
+  }, sourceSchema);
 };
 
-const isPathValid = (path) => {
+const isPathValid = (path, schema = transactionSchema) => {
   try {
-    return getSubschema(path) !== undefined;
+    return getSubschema(path, schema) !== undefined;
   } catch (err) {
     return false;
   }
 };
 
-const getSubschemaValidator = (path) => {
-  const subSchema = getSubschema(path);
+const getSubschemaValidator = (path, schema = transactionSchema) => {
+  const subSchema = getSubschema(path, schema);
+  // see if we can retrieve the schema by path
   let validator = ajv.getSchema(path);
+  // retrieve whole schema by $id if available
   if (!validator && subSchema.$id) validator = ajv.getSchema(subSchema.$id);
   if (!validator) {
     ajv.addSchema(subSchema, path);
@@ -82,6 +148,7 @@ const getSubschemaValidator = (path) => {
   return validator;
 };
 
+// v1, deprecated
 const getTitleAtPath = (schema, path, rootPath = path) => {
   if (path === "") path = "/";
   let pathArray = path.split("/").slice(1);
@@ -164,8 +231,11 @@ const validateVerifiedClaims = (verifiedClaims) => {
 };
 
 module.exports = {
-  transactionSchema,
-  validator,
+  ajv,
+  transactionSchema, // v1 deprecated
+  validator, // v1 deprecated
+  getTransactionSchema,
+  getValidator,
   getSubschema,
   isPathValid,
   getSubschemaValidator,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "1.1.1",
+  "version": "2.0.0-0",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {
@@ -26,9 +26,11 @@
   "homepage": "https://github.com/Property-Data-Trust-Framework/schemas#readme",
   "dependencies": {
     "@jdw/jst": "^2.0.0-beta.15",
-    "ajv": "^8.10.0",
+    "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "jsonpointer": "^5.0.0"
+    "deepmerge": "^4.3.1",
+    "jsonpointer": "^5.0.0",
+    "traverse": "^0.6.7"
   },
   "devDependencies": {
     "jest": "^27.5.1"