convention_builder 1.2.0 → 1.2.2

package/dist/module/index.js

@@ -8792,7 +8792,21 @@ var require_schema_utilities = __commonJS({
       return output;
     }
     __name(flattenObjectBranch, "flattenObjectBranch");
-    function flattenJSONSchema(schema) {
+    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);
@@ -8805,19 +8819,53 @@ var require_schema_utilities = __commonJS({
         };
         return pair;
       });
-      let dataAttributes = allFlattenedPaths.filter((d) => /\.type$/.test(d.path) && !/relationships/.test(d.path) && d.value != "object").map((d) => d.path.replace(/\.type$/, ""));
-      let table = dataAttributes.map((attr) => {
+      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 attributesTable = dataAttributes.map((attr) => {
+        let isRequired = checkRequiredInSchema(attr, schema);
         let entry = {
           path: attr,
-          name: attr.match(/[a-zA-Z]*$/)[0]
+          path_simplified: attr.replace(/\.properties/g, "").replace(/properties\./, ""),
+          name: attr.match(/[a-zA-Z_]*$/)[0],
+          required: isRequired
         };
-        let relatedPaths = allFlattenedPaths.filter((d) => d.path.includes(attr)).forEach((d) => {
+        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;
       });
+      let relationshipPaths = allFlattenedPaths.filter((d) => d.path.includes(".relationships.")).map((d) => d.path).filter((d) => /\.data.type$/.test(d)).map((d) => d.replace(/\.properties.data.type$/, ""));
+      let relationshipsTable = relationshipPaths.map((rel) => {
+        let entry = {
+          path: rel,
+          path_simplified: rel.replace(/\.properties/g, "").replace(/properties\./, ""),
+          name: rel.match(/[a-zA-Z]*$/)[0]
+        };
+        if (isConvention) {
+          entry.overlay = entry.path_simplified.match(/[a-zA-Z-_]*/)[0];
+          let relatedDataPaths = dig(
+            schema,
+            `${rel}.properties.data.contains.anyOf`
+          );
+          entry.convention_data_targets = relatedDataPaths ? relatedDataPaths.map((d) => d.properties.id.const.$data) : [];
+        }
+        ;
+        return entry;
+      });
+      let table = [
+        ...attributesTable,
+        ...relationshipsTable
+      ];
       return table;
     }
     __name(flattenJSONSchema, "flattenJSONSchema");

package/dist/node/index.js

@@ -8785,7 +8785,21 @@ var require_schema_utilities = __commonJS({
       return output;
     }
     __name(flattenObjectBranch, "flattenObjectBranch");
-    function flattenJSONSchema(schema) {
+    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);
@@ -8798,19 +8812,53 @@ var require_schema_utilities = __commonJS({
         };
         return pair;
       });
-      let dataAttributes = allFlattenedPaths.filter((d) => /\.type$/.test(d.path) && !/relationships/.test(d.path) && d.value != "object").map((d) => d.path.replace(/\.type$/, ""));
-      let table = dataAttributes.map((attr) => {
+      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 attributesTable = dataAttributes.map((attr) => {
+        let isRequired = checkRequiredInSchema(attr, schema);
         let entry = {
           path: attr,
-          name: attr.match(/[a-zA-Z]*$/)[0]
+          path_simplified: attr.replace(/\.properties/g, "").replace(/properties\./, ""),
+          name: attr.match(/[a-zA-Z_]*$/)[0],
+          required: isRequired
         };
-        let relatedPaths = allFlattenedPaths.filter((d) => d.path.includes(attr)).forEach((d) => {
+        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;
       });
+      let relationshipPaths = allFlattenedPaths.filter((d) => d.path.includes(".relationships.")).map((d) => d.path).filter((d) => /\.data.type$/.test(d)).map((d) => d.replace(/\.properties.data.type$/, ""));
+      let relationshipsTable = relationshipPaths.map((rel) => {
+        let entry = {
+          path: rel,
+          path_simplified: rel.replace(/\.properties/g, "").replace(/properties\./, ""),
+          name: rel.match(/[a-zA-Z]*$/)[0]
+        };
+        if (isConvention) {
+          entry.overlay = entry.path_simplified.match(/[a-zA-Z-_]*/)[0];
+          let relatedDataPaths = dig(
+            schema,
+            `${rel}.properties.data.contains.anyOf`
+          );
+          entry.convention_data_targets = relatedDataPaths ? relatedDataPaths.map((d) => d.properties.id.const.$data) : [];
+        }
+        ;
+        return entry;
+      });
+      let table = [
+        ...attributesTable,
+        ...relationshipsTable
+      ];
       return table;
     }
     __name(flattenJSONSchema, "flattenJSONSchema");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "convention_builder",
-    "version": "1.2.0",
+    "version": "1.2.2",
     "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"
     }
 }