convention_builder 1.2.3 → 1.4.0

package/dist/module/index.js

@@ -8404,6 +8404,45 @@ var require_schema_utilities = __commonJS({
       }
     }
     __name(dig, "dig");
+    function findCommonPath(targetObject, path) {
+      const chunks = path.split(/\.|\[|\]/).filter((d) => d.length !== 0);
+      let partialPath = "";
+      chunks.forEach((attr) => {
+        let newPartialPath = partialPath.concat(".", attr).replace(/^\./, "");
+        let partialPathExists = dig(targetObject, newPartialPath, false) ? true : false;
+        if (partialPathExists) {
+          partialPath = newPartialPath;
+        }
+        ;
+      });
+      return partialPath;
+    }
+    __name(findCommonPath, "findCommonPath");
+    function bury(targetObject, path, value, merge = false) {
+      let acum = value;
+      let partialPath = findCommonPath(targetObject, path);
+      let sharedPathPattern = new RegExp("^".concat(partialPath));
+      let targetPath = path.replace(sharedPathPattern, "").replace(/\.$/, "");
+      let chunks = targetPath.split(/\.|\[|\]/).filter((d) => d.length !== 0);
+      chunks.reverse().forEach((attr) => {
+        let newLayer = {};
+        newLayer[attr] = acum;
+        acum = newLayer;
+      });
+      if (merge) {
+        let sharedObjectSection = dig(targetObject, partialPath);
+        Object.assign(sharedObjectSection, acum);
+      } else {
+        chunks = partialPath.split(/\.|\[|\]/).filter((d) => d.length !== 0);
+        let lastAttr = chunks[chunks.length - 1];
+        let remainingPath = path.replace(new RegExp(lastAttr.concat("$")), "").replace(/\.$/, "");
+        let sharedObjectSection = dig(targetObject, remainingPath);
+        sharedObjectSection[lastAttr] = value;
+      }
+      ;
+      return targetObject;
+    }
+    __name(bury, "bury");
     function fixRelationshipDataField(schema) {
       if (schema.properties.relationships) {
         Object.keys(schema.properties.relationships.properties).forEach((relKey) => {
@@ -8871,6 +8910,57 @@ var require_schema_utilities = __commonJS({
       return table;
     }
     __name(flattenJSONSchema, "flattenJSONSchema");
+    function listAttributesAndSubAttributes(schema) {
+      let topLevelAttributes = new Set(Object.keys(schema.properties.attributes.properties));
+      let output = topLevelAttributes;
+      let objectTypeAttributes = Array.from(topLevelAttributes).filter((attr) => schema.properties.attributes.properties[attr].type == "object");
+      objectTypeAttributes.flatMap((objAttr) => {
+        let subAttrs = Object.keys(schema.properties.attributes.properties[objAttr].properties);
+        subAttrs.forEach((subAttr) => {
+          output.add(`${objAttr}.properties.${subAttr}`);
+          output.delete(`${objAttr}`);
+        });
+      });
+      return output;
+    }
+    __name(listAttributesAndSubAttributes, "listAttributesAndSubAttributes");
+    function findAllObjectAttributesInTree(schemataTree) {
+      let output = [];
+      Object.keys(schemataTree).forEach((typeKey) => {
+        Object.keys(schemataTree[typeKey]).forEach((bundleKey) => {
+          let schema = schemataTree[typeKey][bundleKey];
+          let topLevelAttributes = new Set(Object.keys(schema.properties.attributes.properties));
+          let objectTypeAttributes = Array.from(topLevelAttributes).filter((attr) => schema.properties.attributes.properties[attr].type == "object");
+          objectTypeAttributes.forEach((attr) => {
+            let entry = output.find((attrDescription) => attrDescription.attribute == attr);
+            if (entry) {
+              entry.instances.push(
+                {
+                  type: typeKey,
+                  bundle: bundleKey,
+                  schema: `${typeKey}--${bundleKey}`
+                }
+              );
+            } else {
+              output.push({
+                attribute: attr,
+                instances: [
+                  {
+                    type: typeKey,
+                    bundle: bundleKey,
+                    schema: `${typeKey}--${bundleKey}`
+                  }
+                ]
+              });
+            }
+          });
+        });
+      });
+      return output;
+    }
+    __name(findAllObjectAttributesInTree, "findAllObjectAttributesInTree");
+    exports.dig = dig;
+    exports.bury = bury;
     exports.fixRelationshipDataField = fixRelationshipDataField;
     exports.buildValidator = buildValidator;
     exports.buildStaticValidator = buildStaticValidator;
@@ -8887,6 +8977,8 @@ var require_schema_utilities = __commonJS({
     exports.reduceSchemaToRequiredFields = reduceSchemaToRequiredFields;
     exports.flattenObjectBranch = flattenObjectBranch;
     exports.flattenJSONSchema = flattenJSONSchema;
+    exports.listAttributesAndSubAttributes = listAttributesAndSubAttributes;
+    exports.findAllObjectAttributesInTree = findAllObjectAttributesInTree;
   }
 });
 
@@ -8894,7 +8986,7 @@ var require_schema_utilities = __commonJS({
 var require_convention_builder = __commonJS({
   "src/convention_builder.js"(exports) {
     var fs = __require("fs");
-    var { buildValidator, urlToStringPair } = require_schema_utilities();
+    var { buildValidator, urlToStringPair, dig, bury, listAttributesAndSubAttributes } = require_schema_utilities();
     function getAttributes(root, convention) {
       let branches = convention.relationships.filter((rel) => rel.containerEntity == root).map((d) => d.mentionedEntity);
       let output = {};
@@ -8949,7 +9041,7 @@ var require_convention_builder = __commonJS({
         }
         ;
         this.baseSchema = baseSchema;
-        this.unmodifiedAttributes = new Set(Object.keys(this.baseSchema.properties.attributes.properties));
+        this.unmodifiedAttributes = listAttributesAndSubAttributes(this.baseSchema);
         this.modifiedAttributes = /* @__PURE__ */ new Set([]);
         if (!overlay) {
           this.overlay = {
@@ -8978,10 +9070,11 @@ var require_convention_builder = __commonJS({
         this.schema = {};
         this.schema.$id = `${this.repoURL}/schemata/${this.typeAndBundle.replace("--", "/")}/schema.json`;
         Object.assign(this.schema, this.baseSchema);
-        let allModifiedAttributes = new Set(Object.keys(this.overlay.properties.attributes.properties));
+        let allModifiedAttributes = listAttributesAndSubAttributes(this.overlay);
         this.modifiedAttributes = allModifiedAttributes;
         Array.from(this.modifiedAttributes).forEach((attr) => {
-          this.schema.properties.attributes.properties[attr] = this.overlay.properties.attributes.properties[attr];
+          let currentValue = dig(this.overlay.properties.attributes.properties, attr);
+          bury(this.schema, `properties.attributes.properties.${attr}`, currentValue, true);
         });
         let originalRequiredFields = this.schema.properties.attributes.required ? this.schema.properties.attributes.required : [];
         let allRequiredSet = Array.from(/* @__PURE__ */ new Set([...originalRequiredFields, ...Array.from(this.requiredFields)]));
@@ -9023,6 +9116,21 @@ var require_convention_builder = __commonJS({
         this.requiredFields.add(attribute);
         this.updateSchema();
       }
+      setGenericSection({ attribute, section, description }) {
+        this.checkAttributeStatus(attribute);
+        bury(this.overlay.properties.attributes.properties, attribute, section, true);
+        if (attribute.match(/\./)) {
+          let firstLevel = attribute.split(/\./)[0];
+          this.overlay.properties.attributes.properties[firstLevel].type = "object";
+        }
+        ;
+        if (description) {
+          bury(this.overlay.properties.attributes.properties, attribute.concat(".description"), description, true);
+        }
+        ;
+        this.updateAttributeStatus(attribute);
+        this.updateSchema();
+      }
       /**
        * Sets an attribute as a constant as indicated by the given value.
        * @param {string} attribute -- Attribute name for the attribute which will be set to a constant.
@@ -9030,14 +9138,8 @@ var require_convention_builder = __commonJS({
        * @param {string} description -- Describes the rationale behind the chosing of the value.
        */
       setConstant({ attribute, value, description }) {
-        this.checkAttributeStatus(attribute);
-        this.overlay.properties.attributes.properties[attribute] = { const: value };
-        if (description) {
-          this.overlay.properties.attributes.properties[attribute].description = description;
-        }
-        ;
-        this.updateAttributeStatus(attribute);
-        this.updateSchema();
+        let constantSection = { const: value };
+        this.setGenericSection({ attribute, section: constantSection, description });
       }
       /**
        * Sets a regex pattern as a restriction for the value of an attribute. Look into the JSON Schema documentation, as it recomends sticking to a [subset of RegEx](https://website-2v2.pages.dev/understanding-json-schema/reference/regular_expressions).
@@ -9047,17 +9149,11 @@ var require_convention_builder = __commonJS({
        * @param {string} description -- Describes the rationale behind the chosing of the value.
        */
       setPattern({ attribute, pattern, string, description }) {
-        this.checkAttributeStatus(attribute);
-        this.overlay.properties.attributes.properties[attribute] = {
+        let patternSchemaSection = {
           type: "string",
           pattern: pattern ? pattern : string
         };
-        if (description) {
-          this.overlay.properties.attributes.properties[attribute].description = description;
-        }
-        ;
-        this.updateAttributeStatus(attribute);
-        this.updateSchema();
+        this.setGenericSection({ attribute, section: patternSchemaSection, description });
       }
       /**
        * Sets an attribute as a constrained to a list of possible values.
@@ -9073,13 +9169,8 @@ var require_convention_builder = __commonJS({
         } else {
           subschema = { anyOf: [{ type: "string" }, { enum: valuesArray }] };
         }
-        this.overlay.properties.attributes.properties[attribute] = subschema;
-        if (description) {
-          this.overlay.properties.attributes.properties[attribute].description = description;
-        }
         ;
-        this.updateAttributeStatus(attribute);
-        this.updateSchema();
+        this.setGenericSection({ attribute, section: subschema, description });
       }
       /**
        * Build an AJV validator and ensure all valid examples are accepted and all error examples are rejected. Returns an array attribute for each set of examples, plus a general success attribute indicating wether all examples resulted as expected and a failedExamples array only listing entities for which there was no success (meanin unrejected error examples and rejected valid examples).

package/dist/node/index.js

@@ -8397,6 +8397,45 @@ var require_schema_utilities = __commonJS({
       }
     }
     __name(dig, "dig");
+    function findCommonPath(targetObject, path) {
+      const chunks = path.split(/\.|\[|\]/).filter((d) => d.length !== 0);
+      let partialPath = "";
+      chunks.forEach((attr) => {
+        let newPartialPath = partialPath.concat(".", attr).replace(/^\./, "");
+        let partialPathExists = dig(targetObject, newPartialPath, false) ? true : false;
+        if (partialPathExists) {
+          partialPath = newPartialPath;
+        }
+        ;
+      });
+      return partialPath;
+    }
+    __name(findCommonPath, "findCommonPath");
+    function bury(targetObject, path, value, merge = false) {
+      let acum = value;
+      let partialPath = findCommonPath(targetObject, path);
+      let sharedPathPattern = new RegExp("^".concat(partialPath));
+      let targetPath = path.replace(sharedPathPattern, "").replace(/\.$/, "");
+      let chunks = targetPath.split(/\.|\[|\]/).filter((d) => d.length !== 0);
+      chunks.reverse().forEach((attr) => {
+        let newLayer = {};
+        newLayer[attr] = acum;
+        acum = newLayer;
+      });
+      if (merge) {
+        let sharedObjectSection = dig(targetObject, partialPath);
+        Object.assign(sharedObjectSection, acum);
+      } else {
+        chunks = partialPath.split(/\.|\[|\]/).filter((d) => d.length !== 0);
+        let lastAttr = chunks[chunks.length - 1];
+        let remainingPath = path.replace(new RegExp(lastAttr.concat("$")), "").replace(/\.$/, "");
+        let sharedObjectSection = dig(targetObject, remainingPath);
+        sharedObjectSection[lastAttr] = value;
+      }
+      ;
+      return targetObject;
+    }
+    __name(bury, "bury");
     function fixRelationshipDataField(schema) {
       if (schema.properties.relationships) {
         Object.keys(schema.properties.relationships.properties).forEach((relKey) => {
@@ -8864,6 +8903,57 @@ var require_schema_utilities = __commonJS({
       return table;
     }
     __name(flattenJSONSchema, "flattenJSONSchema");
+    function listAttributesAndSubAttributes(schema) {
+      let topLevelAttributes = new Set(Object.keys(schema.properties.attributes.properties));
+      let output = topLevelAttributes;
+      let objectTypeAttributes = Array.from(topLevelAttributes).filter((attr) => schema.properties.attributes.properties[attr].type == "object");
+      objectTypeAttributes.flatMap((objAttr) => {
+        let subAttrs = Object.keys(schema.properties.attributes.properties[objAttr].properties);
+        subAttrs.forEach((subAttr) => {
+          output.add(`${objAttr}.properties.${subAttr}`);
+          output.delete(`${objAttr}`);
+        });
+      });
+      return output;
+    }
+    __name(listAttributesAndSubAttributes, "listAttributesAndSubAttributes");
+    function findAllObjectAttributesInTree(schemataTree) {
+      let output = [];
+      Object.keys(schemataTree).forEach((typeKey) => {
+        Object.keys(schemataTree[typeKey]).forEach((bundleKey) => {
+          let schema = schemataTree[typeKey][bundleKey];
+          let topLevelAttributes = new Set(Object.keys(schema.properties.attributes.properties));
+          let objectTypeAttributes = Array.from(topLevelAttributes).filter((attr) => schema.properties.attributes.properties[attr].type == "object");
+          objectTypeAttributes.forEach((attr) => {
+            let entry = output.find((attrDescription) => attrDescription.attribute == attr);
+            if (entry) {
+              entry.instances.push(
+                {
+                  type: typeKey,
+                  bundle: bundleKey,
+                  schema: `${typeKey}--${bundleKey}`
+                }
+              );
+            } else {
+              output.push({
+                attribute: attr,
+                instances: [
+                  {
+                    type: typeKey,
+                    bundle: bundleKey,
+                    schema: `${typeKey}--${bundleKey}`
+                  }
+                ]
+              });
+            }
+          });
+        });
+      });
+      return output;
+    }
+    __name(findAllObjectAttributesInTree, "findAllObjectAttributesInTree");
+    exports2.dig = dig;
+    exports2.bury = bury;
     exports2.fixRelationshipDataField = fixRelationshipDataField;
     exports2.buildValidator = buildValidator;
     exports2.buildStaticValidator = buildStaticValidator;
@@ -8880,6 +8970,8 @@ var require_schema_utilities = __commonJS({
     exports2.reduceSchemaToRequiredFields = reduceSchemaToRequiredFields;
     exports2.flattenObjectBranch = flattenObjectBranch;
     exports2.flattenJSONSchema = flattenJSONSchema;
+    exports2.listAttributesAndSubAttributes = listAttributesAndSubAttributes;
+    exports2.findAllObjectAttributesInTree = findAllObjectAttributesInTree;
   }
 });
 
@@ -8887,7 +8979,7 @@ var require_schema_utilities = __commonJS({
 var require_convention_builder = __commonJS({
   "src/convention_builder.js"(exports2) {
     var fs = require("fs");
-    var { buildValidator, urlToStringPair } = require_schema_utilities();
+    var { buildValidator, urlToStringPair, dig, bury, listAttributesAndSubAttributes } = require_schema_utilities();
     function getAttributes(root, convention) {
       let branches = convention.relationships.filter((rel) => rel.containerEntity == root).map((d) => d.mentionedEntity);
       let output = {};
@@ -8942,7 +9034,7 @@ var require_convention_builder = __commonJS({
         }
         ;
         this.baseSchema = baseSchema;
-        this.unmodifiedAttributes = new Set(Object.keys(this.baseSchema.properties.attributes.properties));
+        this.unmodifiedAttributes = listAttributesAndSubAttributes(this.baseSchema);
         this.modifiedAttributes = /* @__PURE__ */ new Set([]);
         if (!overlay) {
           this.overlay = {
@@ -8971,10 +9063,11 @@ var require_convention_builder = __commonJS({
         this.schema = {};
         this.schema.$id = `${this.repoURL}/schemata/${this.typeAndBundle.replace("--", "/")}/schema.json`;
         Object.assign(this.schema, this.baseSchema);
-        let allModifiedAttributes = new Set(Object.keys(this.overlay.properties.attributes.properties));
+        let allModifiedAttributes = listAttributesAndSubAttributes(this.overlay);
         this.modifiedAttributes = allModifiedAttributes;
         Array.from(this.modifiedAttributes).forEach((attr) => {
-          this.schema.properties.attributes.properties[attr] = this.overlay.properties.attributes.properties[attr];
+          let currentValue = dig(this.overlay.properties.attributes.properties, attr);
+          bury(this.schema, `properties.attributes.properties.${attr}`, currentValue, true);
         });
         let originalRequiredFields = this.schema.properties.attributes.required ? this.schema.properties.attributes.required : [];
         let allRequiredSet = Array.from(/* @__PURE__ */ new Set([...originalRequiredFields, ...Array.from(this.requiredFields)]));
@@ -9016,6 +9109,21 @@ var require_convention_builder = __commonJS({
         this.requiredFields.add(attribute);
         this.updateSchema();
       }
+      setGenericSection({ attribute, section, description }) {
+        this.checkAttributeStatus(attribute);
+        bury(this.overlay.properties.attributes.properties, attribute, section, true);
+        if (attribute.match(/\./)) {
+          let firstLevel = attribute.split(/\./)[0];
+          this.overlay.properties.attributes.properties[firstLevel].type = "object";
+        }
+        ;
+        if (description) {
+          bury(this.overlay.properties.attributes.properties, attribute.concat(".description"), description, true);
+        }
+        ;
+        this.updateAttributeStatus(attribute);
+        this.updateSchema();
+      }
       /**
        * Sets an attribute as a constant as indicated by the given value.
        * @param {string} attribute -- Attribute name for the attribute which will be set to a constant.
@@ -9023,14 +9131,8 @@ var require_convention_builder = __commonJS({
        * @param {string} description -- Describes the rationale behind the chosing of the value.
        */
       setConstant({ attribute, value, description }) {
-        this.checkAttributeStatus(attribute);
-        this.overlay.properties.attributes.properties[attribute] = { const: value };
-        if (description) {
-          this.overlay.properties.attributes.properties[attribute].description = description;
-        }
-        ;
-        this.updateAttributeStatus(attribute);
-        this.updateSchema();
+        let constantSection = { const: value };
+        this.setGenericSection({ attribute, section: constantSection, description });
       }
       /**
        * Sets a regex pattern as a restriction for the value of an attribute. Look into the JSON Schema documentation, as it recomends sticking to a [subset of RegEx](https://website-2v2.pages.dev/understanding-json-schema/reference/regular_expressions).
@@ -9040,17 +9142,11 @@ var require_convention_builder = __commonJS({
        * @param {string} description -- Describes the rationale behind the chosing of the value.
        */
       setPattern({ attribute, pattern, string, description }) {
-        this.checkAttributeStatus(attribute);
-        this.overlay.properties.attributes.properties[attribute] = {
+        let patternSchemaSection = {
           type: "string",
           pattern: pattern ? pattern : string
         };
-        if (description) {
-          this.overlay.properties.attributes.properties[attribute].description = description;
-        }
-        ;
-        this.updateAttributeStatus(attribute);
-        this.updateSchema();
+        this.setGenericSection({ attribute, section: patternSchemaSection, description });
       }
       /**
        * Sets an attribute as a constrained to a list of possible values.
@@ -9066,13 +9162,8 @@ var require_convention_builder = __commonJS({
         } else {
           subschema = { anyOf: [{ type: "string" }, { enum: valuesArray }] };
         }
-        this.overlay.properties.attributes.properties[attribute] = subschema;
-        if (description) {
-          this.overlay.properties.attributes.properties[attribute].description = description;
-        }
         ;
-        this.updateAttributeStatus(attribute);
-        this.updateSchema();
+        this.setGenericSection({ attribute, section: subschema, description });
       }
       /**
        * Build an AJV validator and ensure all valid examples are accepted and all error examples are rejected. Returns an array attribute for each set of examples, plus a general success attribute indicating wether all examples resulted as expected and a failedExamples array only listing entities for which there was no success (meanin unrejected error examples and rejected valid examples).

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "convention_builder",
-    "version": "1.2.3",
+    "version": "1.4.0",
     "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",