convention_builder 1.7.4 → 1.8.0

package/dist/module/index.js

@@ -10604,7 +10604,7 @@ var require_convention_builder = __commonJS({
        */
       updateSchema() {
         this.schema = {};
-        Object.assign(this.schema, this.baseSchema);
+        this.schema = structuredClone(this.baseSchema);
         this.schema.$id = this.repoURLTemplateFunction({ overlayName: this.name, projectID: this.gitlabProjectId, baseEntityTypeAndBundle: this.typeAndBundle });
         let allModifiedAttributes = listAttributesAndSubAttributes(this.overlay);
         this.modifiedAttributes = allModifiedAttributes;
@@ -10676,6 +10676,24 @@ var require_convention_builder = __commonJS({
         this.updateAttributeStatus(attribute);
         this.updateSchema();
       }
+      /**
+       * Allows to "reset" a section to be able to set new constraints or leave it in a "generic" state altogether. This is mostly useful when creating a child convention and a preexisting attribute needs to be modified.
+       * @param {} attribute
+       */
+      cleanGenericSection({ attribute }) {
+        bury(this.overlay.properties.attributes.properties, attribute, dig(this.baseSchema.properties.attributes.properties, attribute), false);
+        this.unmodifiedAttributes.add(attribute);
+        this.modifiedAttributes.delete(attribute);
+        this.updateSchema();
+      }
+      /**
+       * Edits the description for an attribute, independently of any schema limitations set on it. It will overwrite previous descriptions.
+       * @param {} attribute
+       * @param {} description
+       */
+      setDescription({ attribute, description }) {
+        bury(this.overlay.properties.attributes.properties, attribute.concat(".description"), description, false);
+      }
       /**
        * 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.

package/dist/node/index.js

@@ -10597,7 +10597,7 @@ var require_convention_builder = __commonJS({
        */
       updateSchema() {
         this.schema = {};
-        Object.assign(this.schema, this.baseSchema);
+        this.schema = structuredClone(this.baseSchema);
         this.schema.$id = this.repoURLTemplateFunction({ overlayName: this.name, projectID: this.gitlabProjectId, baseEntityTypeAndBundle: this.typeAndBundle });
         let allModifiedAttributes = listAttributesAndSubAttributes(this.overlay);
         this.modifiedAttributes = allModifiedAttributes;
@@ -10669,6 +10669,24 @@ var require_convention_builder = __commonJS({
         this.updateAttributeStatus(attribute);
         this.updateSchema();
       }
+      /**
+       * Allows to "reset" a section to be able to set new constraints or leave it in a "generic" state altogether. This is mostly useful when creating a child convention and a preexisting attribute needs to be modified.
+       * @param {} attribute
+       */
+      cleanGenericSection({ attribute }) {
+        bury(this.overlay.properties.attributes.properties, attribute, dig(this.baseSchema.properties.attributes.properties, attribute), false);
+        this.unmodifiedAttributes.add(attribute);
+        this.modifiedAttributes.delete(attribute);
+        this.updateSchema();
+      }
+      /**
+       * Edits the description for an attribute, independently of any schema limitations set on it. It will overwrite previous descriptions.
+       * @param {} attribute
+       * @param {} description
+       */
+      setDescription({ attribute, description }) {
+        bury(this.overlay.properties.attributes.properties, attribute.concat(".description"), description, false);
+      }
       /**
        * 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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "convention_builder",
-    "version": "1.7.4",
+    "version": "1.8.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",