convention_builder 1.6.1 → 1.7.2

package/dist/module/index.js

@@ -10546,6 +10546,7 @@ var require_convention_builder = __commonJS({
         this.trivial = trivial;
         this.baseSchemataFolder = baseSchemataFolder;
         this.requiredFields = Array.isArray(requiredFields) ? new Set(requiredFields) : /* @__PURE__ */ new Set([]);
+        this.gitlabProjectId = gitlabProjectId;
         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").`);
@@ -10971,6 +10972,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;
@@ -11068,7 +11070,8 @@ var require_convention_builder = __commonJS({
         let containerSchema = this.overlays[containerEntity].schema;
         let relationshipAttributes = Object.keys(containerSchema.properties.relationships.properties);
         if (!relationshipAttributes.includes(relationName)) {
-          throw new Error(`The provided relationship field, '${relationName}', doesn't seem to be a valid field in the schema for '${containerSchema.properties.type.const}'. Available fields are: ${relationshipAttributes.join(", ")}.`);
+          throw new Error(`The provided relationship field, '${relationName}', doesn't seem to be a valid field in the schema for '${containerSchema.properties.type.const}'. Available fields are: ${relationshipAttributes.join(", ")}.
+ Schema read from ${this.baseSchemataFolder}`);
         }
         ;
         this.relationships.push({ containerEntity, relationName, mentionedEntity, required });
@@ -11275,6 +11278,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 +11387,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} 
@@ -11429,9 +11481,9 @@ import TabItem from '@theme/TabItem';
             typeAndBundle: target,
             attributeOverlayName: this.overlayName,
             baseSchemataFolder: this.baseSchemataFolder,
-            gitlabProjectId: this.gitlabProjectId
+            gitlabProjectId
           });
-          currentOverlay.gitlabProjectId = this.gitlabProjectId;
+          currentOverlay.gitlabProjectId = gitlabProjectId;
           this.overlays.push(currentOverlay);
         });
       }
@@ -25306,9 +25358,17 @@ var require_array_examples_preparator = __commonJS({
     var utils = require_schema_utilities();
     var axios = require_axios();
     var _ArrayDataOrganizer = class _ArrayDataOrganizer {
-      constructor({ exampleArray }) {
+      constructor({
+        exampleArray,
+        storageFolder = `${__dirname}/../../../../output/collection/overlays`,
+        baseSchemataFolder = `${__dirname}/../../../../input/collection`,
+        predefinedConventions
+      }) {
         this.exampleArray = exampleArray;
         this.instances = [];
+        this.storageFolder = storageFolder;
+        this.baseSchemataFolder = baseSchemataFolder;
+        this.predefinedConventions = predefinedConventions;
       }
       /**
        * Will retrieve the data needed and structure the example.
@@ -25340,11 +25400,21 @@ var require_array_examples_preparator = __commonJS({
             return entries;
           });
           let allMentionedConventions = Array.from(new Set(this.exampleArray.filter((d) => d.type == "taxonomy_term--convention").map((d) => d.attributes.external_uri)));
-          let conventionSchemataPromises = allMentionedConventions.map((url) => __async(this, null, function* () {
-            return yield axios.get(url.replace("schema.json", "object.json")).then((res) => res.data);
-          }));
-          let conventionObjects = yield Promise.all(conventionSchemataPromises);
-          let conventions = conventionObjects.map((d) => new builder.ConventionSchema(d));
+          let conventionObjects;
+          if (!this.predefinedConventions) {
+            let conventionSchemataPromises = allMentionedConventions.map((url) => __async(this, null, function* () {
+              return yield axios.get(url.replace("schema.json", "object.json")).then((res) => res.data);
+            }));
+            conventionObjects = yield Promise.all(conventionSchemataPromises);
+          } else {
+            conventionObjects = this.predefinedConventions;
+          }
+          ;
+          let conventions = conventionObjects.map((d) => {
+            d.baseSchemataFolder = this.baseSchemataFolder;
+            d.storageFolder = this.storageFolder;
+            return new builder.ConventionSchema(d);
+          });
           this.detected_conventions = conventionCarrierEntities;
           this.conventions = conventions;
         });
@@ -25356,6 +25426,12 @@ var require_array_examples_preparator = __commonJS({
         return __async(this, null, function* () {
           let structuredInstances = yield this.detected_conventions.forEach((instance) => __async(this, null, function* () {
             let currentConvention = yield this.conventions.find((c) => c.schema.$id == instance.convention_entity.attributes.external_uri);
+            if (!currentConvention) {
+              throw new Error(`Couldn't find a convention matching URI ${instance.convention_entity.attributes.external_uri}
+ available ones are: 
+ ${this.conventions.map((d) => d.schema.$id).join("\n")}`);
+            }
+            ;
             this.instances.push(
               utils.arrayToStructuredConvention(
                 {

package/dist/node/index.js

@@ -10539,6 +10539,7 @@ var require_convention_builder = __commonJS({
         this.trivial = trivial;
         this.baseSchemataFolder = baseSchemataFolder;
         this.requiredFields = Array.isArray(requiredFields) ? new Set(requiredFields) : /* @__PURE__ */ new Set([]);
+        this.gitlabProjectId = gitlabProjectId;
         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").`);
@@ -10964,6 +10965,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;
@@ -11061,7 +11063,8 @@ var require_convention_builder = __commonJS({
         let containerSchema = this.overlays[containerEntity].schema;
         let relationshipAttributes = Object.keys(containerSchema.properties.relationships.properties);
         if (!relationshipAttributes.includes(relationName)) {
-          throw new Error(`The provided relationship field, '${relationName}', doesn't seem to be a valid field in the schema for '${containerSchema.properties.type.const}'. Available fields are: ${relationshipAttributes.join(", ")}.`);
+          throw new Error(`The provided relationship field, '${relationName}', doesn't seem to be a valid field in the schema for '${containerSchema.properties.type.const}'. Available fields are: ${relationshipAttributes.join(", ")}.
+ Schema read from ${this.baseSchemataFolder}`);
         }
         ;
         this.relationships.push({ containerEntity, relationName, mentionedEntity, required });
@@ -11268,6 +11271,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 +11380,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} 
@@ -11422,9 +11474,9 @@ import TabItem from '@theme/TabItem';
             typeAndBundle: target,
             attributeOverlayName: this.overlayName,
             baseSchemataFolder: this.baseSchemataFolder,
-            gitlabProjectId: this.gitlabProjectId
+            gitlabProjectId
           });
-          currentOverlay.gitlabProjectId = this.gitlabProjectId;
+          currentOverlay.gitlabProjectId = gitlabProjectId;
           this.overlays.push(currentOverlay);
         });
       }
@@ -25299,9 +25351,17 @@ var require_array_examples_preparator = __commonJS({
     var utils = require_schema_utilities();
     var axios = require_axios();
     var _ArrayDataOrganizer = class _ArrayDataOrganizer {
-      constructor({ exampleArray }) {
+      constructor({
+        exampleArray,
+        storageFolder = `${__dirname}/../../../../output/collection/overlays`,
+        baseSchemataFolder = `${__dirname}/../../../../input/collection`,
+        predefinedConventions
+      }) {
         this.exampleArray = exampleArray;
         this.instances = [];
+        this.storageFolder = storageFolder;
+        this.baseSchemataFolder = baseSchemataFolder;
+        this.predefinedConventions = predefinedConventions;
       }
       /**
        * Will retrieve the data needed and structure the example.
@@ -25333,11 +25393,21 @@ var require_array_examples_preparator = __commonJS({
             return entries;
           });
           let allMentionedConventions = Array.from(new Set(this.exampleArray.filter((d) => d.type == "taxonomy_term--convention").map((d) => d.attributes.external_uri)));
-          let conventionSchemataPromises = allMentionedConventions.map((url) => __async(this, null, function* () {
-            return yield axios.get(url.replace("schema.json", "object.json")).then((res) => res.data);
-          }));
-          let conventionObjects = yield Promise.all(conventionSchemataPromises);
-          let conventions = conventionObjects.map((d) => new builder.ConventionSchema(d));
+          let conventionObjects;
+          if (!this.predefinedConventions) {
+            let conventionSchemataPromises = allMentionedConventions.map((url) => __async(this, null, function* () {
+              return yield axios.get(url.replace("schema.json", "object.json")).then((res) => res.data);
+            }));
+            conventionObjects = yield Promise.all(conventionSchemataPromises);
+          } else {
+            conventionObjects = this.predefinedConventions;
+          }
+          ;
+          let conventions = conventionObjects.map((d) => {
+            d.baseSchemataFolder = this.baseSchemataFolder;
+            d.storageFolder = this.storageFolder;
+            return new builder.ConventionSchema(d);
+          });
           this.detected_conventions = conventionCarrierEntities;
           this.conventions = conventions;
         });
@@ -25349,6 +25419,12 @@ var require_array_examples_preparator = __commonJS({
         return __async(this, null, function* () {
           let structuredInstances = yield this.detected_conventions.forEach((instance) => __async(this, null, function* () {
             let currentConvention = yield this.conventions.find((c) => c.schema.$id == instance.convention_entity.attributes.external_uri);
+            if (!currentConvention) {
+              throw new Error(`Couldn't find a convention matching URI ${instance.convention_entity.attributes.external_uri}
+ available ones are: 
+ ${this.conventions.map((d) => d.schema.$id).join("\n")}`);
+            }
+            ;
             this.instances.push(
               utils.arrayToStructuredConvention(
                 {

package/package.json

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