convention_builder 1.0.0 → 1.1.1

package/dist/module/index.js

@@ -8814,7 +8814,8 @@ var require_convention_builder = __commonJS({
         overlay = false,
         originalSrcScript,
         trivial = false,
-        baseSchemataFolder = `${__dirname}/../../../../input/collection`
+        baseSchemataFolder = `${__dirname}/../../../../input/collection`,
+        requiredFields = []
       }) {
         this.name = name;
         this.typeAndBundle = typeAndBundle;
@@ -8826,6 +8827,7 @@ var require_convention_builder = __commonJS({
         this.strictEnums = strictEnums;
         this.trivial = trivial;
         this.baseSchemataFolder = baseSchemataFolder;
+        this.requiredFields = Array.isArray(requiredFields) ? new Set(requiredFields) : /* @__PURE__ */ new Set([]);
         let validBaseSchemaPattern = typeAndBundle.match(/^[a-z_]*--[a-z_]*$/) ? typeAndBundle.match(/^[a-z_]*--[a-z_]*$/).index == 0 : false;
         if (!validBaseSchemaPattern) {
           throw new Error(`No schema for ${typeAndBundle} was found, as wanted by ${name}. This parameter should be a type--bundle pair, as farmOS mandates (examples are "log--lab_test" and "asset--land").`);
@@ -8881,6 +8883,9 @@ var require_convention_builder = __commonJS({
         Array.from(this.modifiedAttributes).forEach((attr) => {
           this.schema.properties.attributes.properties[attr] = this.overlay.properties.attributes.properties[attr];
         });
+        let originalRequiredFields = this.schema.properties.attributes.required ? this.schema.properties.attributes.required : [];
+        let allRequiredSet = Array.from(/* @__PURE__ */ new Set([...originalRequiredFields, ...Array.from(this.requiredFields)]));
+        this.schema.properties.attributes.required = allRequiredSet;
         this.schema.description = this.overlay.description;
         let validatorObj = buildValidator();
         this.validate = validatorObj.compile(this.schema);
@@ -8910,6 +8915,14 @@ var require_convention_builder = __commonJS({
         this.overlay.description = description;
         this.updateSchema();
       }
+      /**
+       * Adds an attribute to the set of required attributes.
+       * @param {} attribute
+       */
+      setRequiredAttribute(attribute) {
+        this.requiredFields.add(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.

package/dist/node/index.js

@@ -8807,7 +8807,8 @@ var require_convention_builder = __commonJS({
         overlay = false,
         originalSrcScript,
         trivial = false,
-        baseSchemataFolder = `${__dirname}/../../../../input/collection`
+        baseSchemataFolder = `${__dirname}/../../../../input/collection`,
+        requiredFields = []
       }) {
         this.name = name;
         this.typeAndBundle = typeAndBundle;
@@ -8819,6 +8820,7 @@ var require_convention_builder = __commonJS({
         this.strictEnums = strictEnums;
         this.trivial = trivial;
         this.baseSchemataFolder = baseSchemataFolder;
+        this.requiredFields = Array.isArray(requiredFields) ? new Set(requiredFields) : /* @__PURE__ */ new Set([]);
         let validBaseSchemaPattern = typeAndBundle.match(/^[a-z_]*--[a-z_]*$/) ? typeAndBundle.match(/^[a-z_]*--[a-z_]*$/).index == 0 : false;
         if (!validBaseSchemaPattern) {
           throw new Error(`No schema for ${typeAndBundle} was found, as wanted by ${name}. This parameter should be a type--bundle pair, as farmOS mandates (examples are "log--lab_test" and "asset--land").`);
@@ -8874,6 +8876,9 @@ var require_convention_builder = __commonJS({
         Array.from(this.modifiedAttributes).forEach((attr) => {
           this.schema.properties.attributes.properties[attr] = this.overlay.properties.attributes.properties[attr];
         });
+        let originalRequiredFields = this.schema.properties.attributes.required ? this.schema.properties.attributes.required : [];
+        let allRequiredSet = Array.from(/* @__PURE__ */ new Set([...originalRequiredFields, ...Array.from(this.requiredFields)]));
+        this.schema.properties.attributes.required = allRequiredSet;
         this.schema.description = this.overlay.description;
         let validatorObj = buildValidator();
         this.validate = validatorObj.compile(this.schema);
@@ -8903,6 +8908,14 @@ var require_convention_builder = __commonJS({
         this.overlay.description = description;
         this.updateSchema();
       }
+      /**
+       * Adds an attribute to the set of required attributes.
+       * @param {} attribute
+       */
+      setRequiredAttribute(attribute) {
+        this.requiredFields.add(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.

package/package.json

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