convention_builder 1.7.1 → 1.7.3

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").`);
@@ -10708,6 +10709,10 @@ var require_convention_builder = __commonJS({
       setEnum({ attribute, valuesArray, description }) {
         this.checkAttributeStatus(attribute);
         let subschema;
+        if (!valuesArray) {
+          throw new Error(`Attribute 'valuesArray' is empty for ${attribute}, which makes the schema impossible to satisfy.`);
+        }
+        ;
         if (this.strictEnums) {
           subschema = { enum: valuesArray };
         } else {
@@ -11008,6 +11013,7 @@ var require_convention_builder = __commonJS({
           if (isOverlay) {
             try {
               schemaOverlayObject = new SchemaOverlay(JSON.parse(fs.readFileSync(`${this.storagePath()}/overlays/${schemaOverlayObject}/object.json`)));
+              schemaOverlayObject.global = true;
             } catch (e) {
               if (e.code == "ENOENT" && !overlaysOnly) {
                 throw new Error(`Couldn't find any file corresponding to the string provided, searched for ${this.storagePath()}/overlays/${schemaOverlayName}/object.json. Might be the case that you are calling.`);
@@ -11069,7 +11075,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 ? relationshipAttributes.join(", ") : "none"}.
+ Schema read from ${this.baseSchemataFolder}`);
         }
         ;
         this.relationships.push({ containerEntity, relationName, mentionedEntity, required });
@@ -11392,7 +11399,11 @@ import TabItem from '@theme/TabItem';
         }
         ;
         Object.keys(this.overlays).forEach((overlayName) => {
-          this.overlays[overlayName].store(false);
+          let currentOverlay = this.overlays[overlayName];
+          if (!currentOverlay.trivial && !currentOverlay.global) {
+            currentOverlay.store(false);
+          }
+          ;
         });
         if (overlaysOnly) {
           console.log(`Only storing overlays due to overlaysOnly switch.`);
@@ -11479,9 +11490,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);
         });
       }
@@ -25356,9 +25367,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.
@@ -25390,11 +25409,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;
         });
@@ -25406,6 +25435,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").`);
@@ -10701,6 +10702,10 @@ var require_convention_builder = __commonJS({
       setEnum({ attribute, valuesArray, description }) {
         this.checkAttributeStatus(attribute);
         let subschema;
+        if (!valuesArray) {
+          throw new Error(`Attribute 'valuesArray' is empty for ${attribute}, which makes the schema impossible to satisfy.`);
+        }
+        ;
         if (this.strictEnums) {
           subschema = { enum: valuesArray };
         } else {
@@ -11001,6 +11006,7 @@ var require_convention_builder = __commonJS({
           if (isOverlay) {
             try {
               schemaOverlayObject = new SchemaOverlay2(JSON.parse(fs.readFileSync(`${this.storagePath()}/overlays/${schemaOverlayObject}/object.json`)));
+              schemaOverlayObject.global = true;
             } catch (e) {
               if (e.code == "ENOENT" && !overlaysOnly) {
                 throw new Error(`Couldn't find any file corresponding to the string provided, searched for ${this.storagePath()}/overlays/${schemaOverlayName}/object.json. Might be the case that you are calling.`);
@@ -11062,7 +11068,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 ? relationshipAttributes.join(", ") : "none"}.
+ Schema read from ${this.baseSchemataFolder}`);
         }
         ;
         this.relationships.push({ containerEntity, relationName, mentionedEntity, required });
@@ -11385,7 +11392,11 @@ import TabItem from '@theme/TabItem';
         }
         ;
         Object.keys(this.overlays).forEach((overlayName) => {
-          this.overlays[overlayName].store(false);
+          let currentOverlay = this.overlays[overlayName];
+          if (!currentOverlay.trivial && !currentOverlay.global) {
+            currentOverlay.store(false);
+          }
+          ;
         });
         if (overlaysOnly) {
           console.log(`Only storing overlays due to overlaysOnly switch.`);
@@ -11472,9 +11483,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);
         });
       }
@@ -25349,9 +25360,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.
@@ -25383,11 +25402,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;
         });
@@ -25399,6 +25428,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.7.1",
+    "version": "1.7.3",
     "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",