convention_builder 1.6.1 → 1.7.1

package/dist/module/index.js

@@ -10971,6 +10971,7 @@ var require_convention_builder = __commonJS({
           description: this.description,
           required: this.required
         };
+        this.enforceConventionTaxonomyTerm();
         Object.keys(this.overlays).forEach((attributeName) => {
           this.overlays[attributeName].updateSchema();
           this.schema.properties[attributeName] = this.overlays[attributeName].schema;
@@ -11275,6 +11276,56 @@ import TabItem from '@theme/TabItem';
         ;
         return output;
       }
+      /**
+       * Will create an appropiate convention taxonomy term and add it into the definition, with the appropriate content and relationships.
+       */
+      addConventionTaxonomyTerm() {
+        let conventionTree = this.getAttributesTree();
+        let entitiesInRoot = Object.keys(conventionTree);
+        let mainEntity = entitiesInRoot.length == 1 ? entitiesInRoot[0] : void 0;
+        if (mainEntity) {
+          const conventionTaxonomyTerm = new SchemaOverlay(
+            {
+              typeAndBundle: "taxonomy_term--convention",
+              name: "convention_taxonomy",
+              baseSchemataFolder: this.baseSchemataFolder,
+              storageFolder: this.storageFolder
+            }
+          );
+          conventionTaxonomyTerm.setConstant({
+            attribute: "external_uri",
+            value: this.repoURLTemplateFunction({ conventionName: this.schemaName, projectID: this.gitlabProjectId }),
+            description: "External URI in which this convention's schema and other artifacts will be hosted as artifacts by GitLab."
+          });
+          conventionTaxonomyTerm.setMainDescription("This entity tags data as organized into the convention we intend to instantiate, allowing to pick the right schemata to test it against.");
+          conventionTaxonomyTerm.setConstant({
+            attribute: "name",
+            value: this.title
+          });
+          this.addAttribute({
+            schemaOverlayObject: conventionTaxonomyTerm,
+            attributeName: "convention_taxonomy",
+            required: true
+          });
+          this.addRelationship({
+            containerEntity: mainEntity,
+            relationName: "convention",
+            mentionedEntity: "convention_taxonomy",
+            required: true
+          });
+        }
+        ;
+      }
+      enforceConventionTaxonomyTerm() {
+        let conventionExists = Object.keys(this.overlays).find((d) => this.overlays[d].typeAndBundle == "taxonomy_term--convention");
+        let output = false;
+        if (!conventionExists) {
+          this.addConventionTaxonomyTerm();
+          output = true;
+        }
+        ;
+        return output;
+      }
       /**
       * This method takes this object's schema and returns an array of fixed attributes objects, which is equivalent to a row by row encoded excel spreadsheet and is mostly meant at allowing users to work on said schema via a tabular structure.
       * The output will include one row for each data entry path (not all of the paths) and will synthesize all of its properties into columns, such as name, Title, Type, etc.
@@ -11334,7 +11385,6 @@ import TabItem from '@theme/TabItem';
         let test = this.testExamples();
         let valid = test.success;
         if (!valid && !overlaysOnly) {
-          console.log(JSON.stringify(test.failedExamples));
           throw new Error(`The 'testExamples' method failed. The schema ${this.schemaName} either lacks examples, or is rejecting a valid example or accepting an invalid example.
  * Valid examples provided: ${test.validExamples.length} 
  * Error examples provided: ${test.erroredExamples.length} 

package/dist/node/index.js

@@ -10964,6 +10964,7 @@ var require_convention_builder = __commonJS({
           description: this.description,
           required: this.required
         };
+        this.enforceConventionTaxonomyTerm();
         Object.keys(this.overlays).forEach((attributeName) => {
           this.overlays[attributeName].updateSchema();
           this.schema.properties[attributeName] = this.overlays[attributeName].schema;
@@ -11268,6 +11269,56 @@ import TabItem from '@theme/TabItem';
         ;
         return output;
       }
+      /**
+       * Will create an appropiate convention taxonomy term and add it into the definition, with the appropriate content and relationships.
+       */
+      addConventionTaxonomyTerm() {
+        let conventionTree = this.getAttributesTree();
+        let entitiesInRoot = Object.keys(conventionTree);
+        let mainEntity = entitiesInRoot.length == 1 ? entitiesInRoot[0] : void 0;
+        if (mainEntity) {
+          const conventionTaxonomyTerm = new SchemaOverlay2(
+            {
+              typeAndBundle: "taxonomy_term--convention",
+              name: "convention_taxonomy",
+              baseSchemataFolder: this.baseSchemataFolder,
+              storageFolder: this.storageFolder
+            }
+          );
+          conventionTaxonomyTerm.setConstant({
+            attribute: "external_uri",
+            value: this.repoURLTemplateFunction({ conventionName: this.schemaName, projectID: this.gitlabProjectId }),
+            description: "External URI in which this convention's schema and other artifacts will be hosted as artifacts by GitLab."
+          });
+          conventionTaxonomyTerm.setMainDescription("This entity tags data as organized into the convention we intend to instantiate, allowing to pick the right schemata to test it against.");
+          conventionTaxonomyTerm.setConstant({
+            attribute: "name",
+            value: this.title
+          });
+          this.addAttribute({
+            schemaOverlayObject: conventionTaxonomyTerm,
+            attributeName: "convention_taxonomy",
+            required: true
+          });
+          this.addRelationship({
+            containerEntity: mainEntity,
+            relationName: "convention",
+            mentionedEntity: "convention_taxonomy",
+            required: true
+          });
+        }
+        ;
+      }
+      enforceConventionTaxonomyTerm() {
+        let conventionExists = Object.keys(this.overlays).find((d) => this.overlays[d].typeAndBundle == "taxonomy_term--convention");
+        let output = false;
+        if (!conventionExists) {
+          this.addConventionTaxonomyTerm();
+          output = true;
+        }
+        ;
+        return output;
+      }
       /**
       * This method takes this object's schema and returns an array of fixed attributes objects, which is equivalent to a row by row encoded excel spreadsheet and is mostly meant at allowing users to work on said schema via a tabular structure.
       * The output will include one row for each data entry path (not all of the paths) and will synthesize all of its properties into columns, such as name, Title, Type, etc.
@@ -11327,7 +11378,6 @@ import TabItem from '@theme/TabItem';
         let test = this.testExamples();
         let valid = test.success;
         if (!valid && !overlaysOnly) {
-          console.log(JSON.stringify(test.failedExamples));
           throw new Error(`The 'testExamples' method failed. The schema ${this.schemaName} either lacks examples, or is rejecting a valid example or accepting an invalid example.
  * Valid examples provided: ${test.validExamples.length} 
  * Error examples provided: ${test.erroredExamples.length} 

package/package.json

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