convention_builder 1.1.1 → 1.2.1

package/dist/module/index.js

@@ -8773,6 +8773,80 @@ var require_schema_utilities = __commonJS({
       return output;
     }
     __name(reduceSchemaToRequiredFields, "reduceSchemaToRequiredFields");
+    function flattenObjectBranch(parentBranch, targetAttribute) {
+      let output = {};
+      if (typeof parentBranch[targetAttribute] == "object" && !Array.isArray(parentBranch[targetAttribute]) && parentBranch[targetAttribute]) {
+        output.situation = "paths";
+        let childAttributes = Object.keys(parentBranch[targetAttribute]);
+        let paths = childAttributes.flatMap((attr) => {
+          let leafs = flattenObjectBranch(parentBranch[targetAttribute], attr);
+          return leafs.paths.map((path) => `${targetAttribute}.${path}`);
+        });
+        output.paths = paths;
+      } else {
+        output.situation = "value";
+        output.paths = [targetAttribute];
+        output.value = parentBranch[targetAttribute];
+      }
+      ;
+      return output;
+    }
+    __name(flattenObjectBranch, "flattenObjectBranch");
+    function checkRequiredInSchema(path, schema) {
+      let attributeName = path.match(/[a-zA-Z_]*$/)[0];
+      let pathFormat = new RegExp(`properties.${attributeName}`).test(path);
+      if (!pathFormat) {
+        throw new Error(`Attribute paths have a format in which the second to last property is 'properties' such as 'properties.attributes.properties.date' for a field named 'date'. This one seems to have another format. Provided path is ${path} .`);
+      }
+      ;
+      let containerPath = path.replace(new RegExp(`.properties.${attributeName}$`), "");
+      let container = dig(schema, containerPath);
+      let requiredFields = container.required ? container.required : [];
+      let output = requiredFields.includes(attributeName);
+      return output;
+    }
+    __name(checkRequiredInSchema, "checkRequiredInSchema");
+    function flattenJSONSchema(schema, isConvention = false) {
+      let mainAttributes = Object.keys(schema);
+      let mainPaths = mainAttributes.flatMap((attr) => {
+        let object = flattenObjectBranch(schema, attr);
+        return object.paths;
+      });
+      let allFlattenedPaths = mainPaths.map((path) => {
+        let pair = {
+          value: dig(schema, path),
+          path
+        };
+        return pair;
+      });
+      let dataAttributes = allFlattenedPaths.filter((d) => /\.type$/.test(d.path) && !/relationships/.test(d.path) && d.value != "object").map((d) => d.path.replace(/\.type$/, "")).filter((d) => !/\.id$/.test(d)).filter((d) => {
+        let attributes = d.split(".");
+        let lastAttr = attributes[attributes.length - 1];
+        let secondToLastAttr = attributes[attributes.length - 2];
+        return secondToLastAttr == "properties";
+      });
+      let table = dataAttributes.map((attr) => {
+        let isRequired = checkRequiredInSchema(attr, schema);
+        let entry = {
+          path: attr,
+          path_simplified: attr.replace(/\.properties/g, "").replace(/properties\./, ""),
+          name: attr.match(/[a-zA-Z]*$/)[0],
+          required: isRequired
+        };
+        if (isConvention) {
+          entry.overlay = entry.path_simplified.match(/[a-zA-Z-]*/)[0];
+        }
+        ;
+        allFlattenedPaths.filter((d) => d.path.includes(`${attr}.`)).forEach((d) => {
+          let key = d.path.replace(`${attr}.`, "");
+          let value = d.value;
+          entry[key] = value;
+        });
+        return entry;
+      });
+      return table;
+    }
+    __name(flattenJSONSchema, "flattenJSONSchema");
     exports.fixRelationshipDataField = fixRelationshipDataField;
     exports.buildValidator = buildValidator;
     exports.buildStaticValidator = buildStaticValidator;
@@ -8787,6 +8861,8 @@ var require_schema_utilities = __commonJS({
     exports.organizeEntitiesArrayByRelationships = organizeEntitiesArrayByRelationships;
     exports.trimNonRequiredFields = trimNonRequiredFields;
     exports.reduceSchemaToRequiredFields = reduceSchemaToRequiredFields;
+    exports.flattenObjectBranch = flattenObjectBranch;
+    exports.flattenJSONSchema = flattenJSONSchema;
   }
 });
 
@@ -9534,6 +9610,7 @@ var require_src = __commonJS({
     exports.organizeEntitiesArrayByRelationships = schemaUtils.organizeEntitiesArrayByRelationships;
     exports.trimNonRequiredFields = schemaUtils.trimNonRequiredFields;
     exports.reduceSchemaToRequiredFields = schemaUtils.reduceSchemaToRequiredFields;
+    exports.flattenJSONSchema = schemaUtils.flattenJSONSchema;
   }
 });
 export default require_src();

package/dist/node/index.js

@@ -8766,6 +8766,80 @@ var require_schema_utilities = __commonJS({
       return output;
     }
     __name(reduceSchemaToRequiredFields, "reduceSchemaToRequiredFields");
+    function flattenObjectBranch(parentBranch, targetAttribute) {
+      let output = {};
+      if (typeof parentBranch[targetAttribute] == "object" && !Array.isArray(parentBranch[targetAttribute]) && parentBranch[targetAttribute]) {
+        output.situation = "paths";
+        let childAttributes = Object.keys(parentBranch[targetAttribute]);
+        let paths = childAttributes.flatMap((attr) => {
+          let leafs = flattenObjectBranch(parentBranch[targetAttribute], attr);
+          return leafs.paths.map((path) => `${targetAttribute}.${path}`);
+        });
+        output.paths = paths;
+      } else {
+        output.situation = "value";
+        output.paths = [targetAttribute];
+        output.value = parentBranch[targetAttribute];
+      }
+      ;
+      return output;
+    }
+    __name(flattenObjectBranch, "flattenObjectBranch");
+    function checkRequiredInSchema(path, schema) {
+      let attributeName = path.match(/[a-zA-Z_]*$/)[0];
+      let pathFormat = new RegExp(`properties.${attributeName}`).test(path);
+      if (!pathFormat) {
+        throw new Error(`Attribute paths have a format in which the second to last property is 'properties' such as 'properties.attributes.properties.date' for a field named 'date'. This one seems to have another format. Provided path is ${path} .`);
+      }
+      ;
+      let containerPath = path.replace(new RegExp(`.properties.${attributeName}$`), "");
+      let container = dig(schema, containerPath);
+      let requiredFields = container.required ? container.required : [];
+      let output = requiredFields.includes(attributeName);
+      return output;
+    }
+    __name(checkRequiredInSchema, "checkRequiredInSchema");
+    function flattenJSONSchema(schema, isConvention = false) {
+      let mainAttributes = Object.keys(schema);
+      let mainPaths = mainAttributes.flatMap((attr) => {
+        let object = flattenObjectBranch(schema, attr);
+        return object.paths;
+      });
+      let allFlattenedPaths = mainPaths.map((path) => {
+        let pair = {
+          value: dig(schema, path),
+          path
+        };
+        return pair;
+      });
+      let dataAttributes = allFlattenedPaths.filter((d) => /\.type$/.test(d.path) && !/relationships/.test(d.path) && d.value != "object").map((d) => d.path.replace(/\.type$/, "")).filter((d) => !/\.id$/.test(d)).filter((d) => {
+        let attributes = d.split(".");
+        let lastAttr = attributes[attributes.length - 1];
+        let secondToLastAttr = attributes[attributes.length - 2];
+        return secondToLastAttr == "properties";
+      });
+      let table = dataAttributes.map((attr) => {
+        let isRequired = checkRequiredInSchema(attr, schema);
+        let entry = {
+          path: attr,
+          path_simplified: attr.replace(/\.properties/g, "").replace(/properties\./, ""),
+          name: attr.match(/[a-zA-Z]*$/)[0],
+          required: isRequired
+        };
+        if (isConvention) {
+          entry.overlay = entry.path_simplified.match(/[a-zA-Z-]*/)[0];
+        }
+        ;
+        allFlattenedPaths.filter((d) => d.path.includes(`${attr}.`)).forEach((d) => {
+          let key = d.path.replace(`${attr}.`, "");
+          let value = d.value;
+          entry[key] = value;
+        });
+        return entry;
+      });
+      return table;
+    }
+    __name(flattenJSONSchema, "flattenJSONSchema");
     exports2.fixRelationshipDataField = fixRelationshipDataField;
     exports2.buildValidator = buildValidator;
     exports2.buildStaticValidator = buildStaticValidator;
@@ -8780,6 +8854,8 @@ var require_schema_utilities = __commonJS({
     exports2.organizeEntitiesArrayByRelationships = organizeEntitiesArrayByRelationships;
     exports2.trimNonRequiredFields = trimNonRequiredFields;
     exports2.reduceSchemaToRequiredFields = reduceSchemaToRequiredFields;
+    exports2.flattenObjectBranch = flattenObjectBranch;
+    exports2.flattenJSONSchema = flattenJSONSchema;
   }
 });
 
@@ -9525,6 +9601,7 @@ exports.organizeEntitiesArrayIntoConvention = schemaUtils.organizeEntitiesArrayI
 exports.organizeEntitiesArrayByRelationships = schemaUtils.organizeEntitiesArrayByRelationships;
 exports.trimNonRequiredFields = schemaUtils.trimNonRequiredFields;
 exports.reduceSchemaToRequiredFields = schemaUtils.reduceSchemaToRequiredFields;
+exports.flattenJSONSchema = schemaUtils.flattenJSONSchema;
 /*! Bundled license information:
 
 uri-js/dist/es5/uri.all.js:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "convention_builder",
-    "version": "1.1.1",
+    "version": "1.2.1",
     "description": "Helper tools that offer a high level interface that transforms a convention description into it's json schema.",
     "main": "./dist/node/index.js",
     "browser": "./dist/browser/index.js",
@@ -44,6 +44,7 @@
     "devDependencies": {
         "esbuild": "^0.19.7",
         "jest": "^29.7.0",
-        "jest-junit": "^15.0.0"
+        "jest-junit": "^15.0.0",
+        "papaparse": "^5.4.1"
     }
 }