convention_builder 1.4.2 → 1.4.4

package/dist/module/index.js

@@ -8782,6 +8782,47 @@ var require_schema_utilities = __commonJS({
       };
     }
     __name(organizeEntitiesArrayByRelationships, "organizeEntitiesArrayByRelationships");
+    function arrayToStructuredConvention({ entitiesArray, conventionObject }) {
+      let entities = entitiesArray.map((entity) => {
+        let validations = Object.keys(conventionObject.overlays).map((key) => {
+          var _a;
+          conventionObject.overlays[key].validate(entity);
+          let errors = (_a = conventionObject.overlays[key].validate.errors) == null ? void 0 : _a.filter((d) => !/relationships/.test(d.instancePath));
+          return { overlay: key, errors: errors ? errors : [] };
+        });
+        let passedTests = validations.filter((d) => d.errors.length == 0);
+        let amountPassed = passedTests.length;
+        let output2 = {
+          passedTests,
+          possibleOverlays: passedTests ? passedTests.map((d) => d.overlay) : void 0,
+          allTests: validations,
+          amountPassed,
+          entity
+        };
+        return output2;
+      });
+      let output = {
+        identifiedEntities: entities.filter((d) => d.amountPassed == 1),
+        unrecognizedEntities: entities.filter((d) => d.amountPassed == 0),
+        ambiguousEntities: entities.filter((d) => d.amountPassed > 1)
+      };
+      let assembledEntity = {
+        id: randomUUID(),
+        type: "object"
+      };
+      entities.filter((d) => d.possibleOverlays.length == 1).forEach((entityObj) => {
+        assembledEntity[entityObj.possibleOverlays[0]] = entityObj.entity;
+      });
+      let assembledValidation = conventionObject.validate(assembledEntity);
+      if (conventionObject.validate.errors) {
+        output.errors = conventionObject.validate.errors;
+      }
+      ;
+      output.is_valid = assembledValidation;
+      output.assembled_entity = assembledEntity;
+      return output;
+    }
+    __name(arrayToStructuredConvention, "arrayToStructuredConvention");
     function trimNonRequiredFields(schema, attribute = false) {
       let data;
       if (attribute) {
@@ -9025,6 +9066,7 @@ var require_schema_utilities = __commonJS({
     exports.findMissingEntitiesInExample = findMissingEntitiesInExample;
     exports.organizeEntitiesArrayIntoConvention = organizeEntitiesArrayIntoConvention;
     exports.organizeEntitiesArrayByRelationships = organizeEntitiesArrayByRelationships;
+    exports.arrayToStructuredConvention = arrayToStructuredConvention;
     exports.trimNonRequiredFields = trimNonRequiredFields;
     exports.reduceSchemaToRequiredFields = reduceSchemaToRequiredFields;
     exports.flattenObjectBranch = flattenObjectBranch;
@@ -9377,8 +9419,8 @@ var require_convention_builder = __commonJS({
         version,
         repoURL,
         description,
-        validExamples,
-        erroredExamples,
+        validExamples = [],
+        erroredExamples = [],
         storageFolder = `${__dirname}/../../../../output/collection`,
         baseSchemataFolder = `${__dirname}/../../../../input/collection`,
         strictEnums = false,
@@ -9405,7 +9447,10 @@ var require_convention_builder = __commonJS({
         if (overlays) {
           let overlayNames = Object.keys(overlays);
           this.overlays = {};
-          overlayNames.forEach((ovrl) => this.overlays[ovrl] = new SchemaOverlay(overlays[ovrl]));
+          overlayNames.forEach((ovrl) => {
+            this.overlays[ovrl] = new SchemaOverlay(overlays[ovrl]);
+            this.overlays[ovrl].updateSchema();
+          });
         }
         ;
         if (relationships) {
@@ -9699,17 +9744,73 @@ import TabItem from '@theme/TabItem';
         let body = [header, mainText, "# View Schema\n", "<Tabs>", schemaPluginInvocation, schemaPluginInvocationRequiredOnly, codeBlock, conventionAsText, "</Tabs>"].join("\n");
         return body;
       }
+      getExamplesFromFile({ path }) {
+        let isFolder = fs.lstatSync(path).isDirectory();
+        let isJSONFile = new RegExp(/\.json$/i).test(path);
+        let noFilesError = `The provided path (${path}) does not lead to JSON file nor a folder containing JSON files. Folder: ${isFolder}, JSON File: ${isJSONFile}`;
+        let output = [];
+        if (isFolder) {
+          let folderExamples = fs.readdirSync(path, (error, files) => {
+            return files;
+          }).filter((path2) => new RegExp(/\.json$/i).test(path2)).map((filename) => {
+            let examples = JSON.parse(fs.readFileSync(`${path}/${filename}`));
+            return examples;
+          });
+          if (folderExamples.length == 0) {
+            throw new Error(noFilesError);
+          }
+          ;
+          output.push(...folderExamples);
+        } else if (isJSONFile) {
+          let example = JSON.parse(fs.readFileSync(path));
+          output.push(example);
+        } else {
+          throw new Error(noFilesError);
+        }
+        ;
+        return output;
+      }
+      /**
+       * Will retrieve an individual example from a JSON file or all examples in a given folder. They all need to be either valid or invalid examples, and that should be indicated by the 'is_valid_example' attribute.
+       * @param {string} path -- A string representing an absolute path, leading to either a JSON file containing an individual example or a folder containing several examples. 
+       * @param {object|array} object -- Either an array of examples or an individual example. 
+       * @param {boolean} is_valid_example -- Whether to store the provided examples as valid examples or errors, for the tests.
+       */
+      addExample({ path, object, is_valid_example }) {
+        if (!path && !object) {
+          throw new Error(`Either an object or a path leading to a folder or a json file need to be provided. Both arguments are empty.`);
+        }
+        ;
+        let newExamples = [];
+        if (object) {
+          if (!Array.isArray(object)) {
+            newExamples.push(object);
+          } else {
+            newExamples.push(...object);
+          }
+          ;
+        } else if (path) {
+          newExamples = this.getExamplesFromFile({ path });
+        }
+        ;
+        if (is_valid_example) {
+          this.validExamples.push(...newExamples);
+        } else {
+          this.erroredExamples.push(...newExamples);
+        }
+        ;
+      }
       /**
        * Build an AJV validator and ensure all valid examples are accepted and all error examples are rejected. Returns an array attribute for each set of examples, plus a general success attribute indicating wether all examples resulted as expected and a failedExamples array only listing entities for which there was no success (meanin unrejected error examples and rejected valid examples).
        */
       testExamples() {
         let generalOutput = {};
         if (!this.validExamples || !this.erroredExamples) {
-          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute`);
+          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute. Valid examples amount: ${this.validExamples ? this.validExamples.length : "validExamples is not an array"}, errored examples amount: ${this.erroredExamples ? this.erroredExamples.length : "erroredExamples is not an array"}.`);
         }
         ;
         if (this.validExamples.length == 0 || this.erroredExamples.length == 0) {
-          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute`);
+          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute. Valid examples amount: ${this.validExamples ? this.validExamples.length : "validExamples is not an array"}, errored examples amount: ${this.erroredExamples ? this.erroredExamples.length : "erroredExamples is not an array"}.`);
         }
         ;
         this.updateSchema();
@@ -9942,7 +10043,7 @@ var require_src = __commonJS({
     exports.exampleImporter = schemaUtils.exampleImporter;
     exports.findMissingEntitiesInExample = schemaUtils.findMissingEntitiesInExample;
     exports.organizeEntitiesArrayIntoConvention = schemaUtils.organizeEntitiesArrayIntoConvention;
-    exports.organizeEntitiesArrayByRelationships = schemaUtils.organizeEntitiesArrayByRelationships;
+    exports.arrayToStructuredConvention = schemaUtils.arrayToStructuredConvention;
     exports.trimNonRequiredFields = schemaUtils.trimNonRequiredFields;
     exports.reduceSchemaToRequiredFields = schemaUtils.reduceSchemaToRequiredFields;
     exports.flattenJSONSchema = schemaUtils.flattenJSONSchema;

package/dist/node/index.js

@@ -8775,6 +8775,47 @@ var require_schema_utilities = __commonJS({
       };
     }
     __name(organizeEntitiesArrayByRelationships, "organizeEntitiesArrayByRelationships");
+    function arrayToStructuredConvention({ entitiesArray, conventionObject }) {
+      let entities = entitiesArray.map((entity) => {
+        let validations = Object.keys(conventionObject.overlays).map((key) => {
+          var _a;
+          conventionObject.overlays[key].validate(entity);
+          let errors = (_a = conventionObject.overlays[key].validate.errors) == null ? void 0 : _a.filter((d) => !/relationships/.test(d.instancePath));
+          return { overlay: key, errors: errors ? errors : [] };
+        });
+        let passedTests = validations.filter((d) => d.errors.length == 0);
+        let amountPassed = passedTests.length;
+        let output2 = {
+          passedTests,
+          possibleOverlays: passedTests ? passedTests.map((d) => d.overlay) : void 0,
+          allTests: validations,
+          amountPassed,
+          entity
+        };
+        return output2;
+      });
+      let output = {
+        identifiedEntities: entities.filter((d) => d.amountPassed == 1),
+        unrecognizedEntities: entities.filter((d) => d.amountPassed == 0),
+        ambiguousEntities: entities.filter((d) => d.amountPassed > 1)
+      };
+      let assembledEntity = {
+        id: randomUUID(),
+        type: "object"
+      };
+      entities.filter((d) => d.possibleOverlays.length == 1).forEach((entityObj) => {
+        assembledEntity[entityObj.possibleOverlays[0]] = entityObj.entity;
+      });
+      let assembledValidation = conventionObject.validate(assembledEntity);
+      if (conventionObject.validate.errors) {
+        output.errors = conventionObject.validate.errors;
+      }
+      ;
+      output.is_valid = assembledValidation;
+      output.assembled_entity = assembledEntity;
+      return output;
+    }
+    __name(arrayToStructuredConvention, "arrayToStructuredConvention");
     function trimNonRequiredFields(schema, attribute = false) {
       let data;
       if (attribute) {
@@ -9018,6 +9059,7 @@ var require_schema_utilities = __commonJS({
     exports2.findMissingEntitiesInExample = findMissingEntitiesInExample;
     exports2.organizeEntitiesArrayIntoConvention = organizeEntitiesArrayIntoConvention;
     exports2.organizeEntitiesArrayByRelationships = organizeEntitiesArrayByRelationships;
+    exports2.arrayToStructuredConvention = arrayToStructuredConvention;
     exports2.trimNonRequiredFields = trimNonRequiredFields;
     exports2.reduceSchemaToRequiredFields = reduceSchemaToRequiredFields;
     exports2.flattenObjectBranch = flattenObjectBranch;
@@ -9370,8 +9412,8 @@ var require_convention_builder = __commonJS({
         version,
         repoURL,
         description,
-        validExamples,
-        erroredExamples,
+        validExamples = [],
+        erroredExamples = [],
         storageFolder = `${__dirname}/../../../../output/collection`,
         baseSchemataFolder = `${__dirname}/../../../../input/collection`,
         strictEnums = false,
@@ -9398,7 +9440,10 @@ var require_convention_builder = __commonJS({
         if (overlays) {
           let overlayNames = Object.keys(overlays);
           this.overlays = {};
-          overlayNames.forEach((ovrl) => this.overlays[ovrl] = new SchemaOverlay2(overlays[ovrl]));
+          overlayNames.forEach((ovrl) => {
+            this.overlays[ovrl] = new SchemaOverlay2(overlays[ovrl]);
+            this.overlays[ovrl].updateSchema();
+          });
         }
         ;
         if (relationships) {
@@ -9692,17 +9737,73 @@ import TabItem from '@theme/TabItem';
         let body = [header, mainText, "# View Schema\n", "<Tabs>", schemaPluginInvocation, schemaPluginInvocationRequiredOnly, codeBlock, conventionAsText, "</Tabs>"].join("\n");
         return body;
       }
+      getExamplesFromFile({ path }) {
+        let isFolder = fs.lstatSync(path).isDirectory();
+        let isJSONFile = new RegExp(/\.json$/i).test(path);
+        let noFilesError = `The provided path (${path}) does not lead to JSON file nor a folder containing JSON files. Folder: ${isFolder}, JSON File: ${isJSONFile}`;
+        let output = [];
+        if (isFolder) {
+          let folderExamples = fs.readdirSync(path, (error, files) => {
+            return files;
+          }).filter((path2) => new RegExp(/\.json$/i).test(path2)).map((filename) => {
+            let examples = JSON.parse(fs.readFileSync(`${path}/${filename}`));
+            return examples;
+          });
+          if (folderExamples.length == 0) {
+            throw new Error(noFilesError);
+          }
+          ;
+          output.push(...folderExamples);
+        } else if (isJSONFile) {
+          let example = JSON.parse(fs.readFileSync(path));
+          output.push(example);
+        } else {
+          throw new Error(noFilesError);
+        }
+        ;
+        return output;
+      }
+      /**
+       * Will retrieve an individual example from a JSON file or all examples in a given folder. They all need to be either valid or invalid examples, and that should be indicated by the 'is_valid_example' attribute.
+       * @param {string} path -- A string representing an absolute path, leading to either a JSON file containing an individual example or a folder containing several examples. 
+       * @param {object|array} object -- Either an array of examples or an individual example. 
+       * @param {boolean} is_valid_example -- Whether to store the provided examples as valid examples or errors, for the tests.
+       */
+      addExample({ path, object, is_valid_example }) {
+        if (!path && !object) {
+          throw new Error(`Either an object or a path leading to a folder or a json file need to be provided. Both arguments are empty.`);
+        }
+        ;
+        let newExamples = [];
+        if (object) {
+          if (!Array.isArray(object)) {
+            newExamples.push(object);
+          } else {
+            newExamples.push(...object);
+          }
+          ;
+        } else if (path) {
+          newExamples = this.getExamplesFromFile({ path });
+        }
+        ;
+        if (is_valid_example) {
+          this.validExamples.push(...newExamples);
+        } else {
+          this.erroredExamples.push(...newExamples);
+        }
+        ;
+      }
       /**
        * Build an AJV validator and ensure all valid examples are accepted and all error examples are rejected. Returns an array attribute for each set of examples, plus a general success attribute indicating wether all examples resulted as expected and a failedExamples array only listing entities for which there was no success (meanin unrejected error examples and rejected valid examples).
        */
       testExamples() {
         let generalOutput = {};
         if (!this.validExamples || !this.erroredExamples) {
-          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute`);
+          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute. Valid examples amount: ${this.validExamples ? this.validExamples.length : "validExamples is not an array"}, errored examples amount: ${this.erroredExamples ? this.erroredExamples.length : "erroredExamples is not an array"}.`);
         }
         ;
         if (this.validExamples.length == 0 || this.erroredExamples.length == 0) {
-          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute`);
+          throw new Error(`Testing can't happen because examples are missing either in the valid or errored attribute. Valid examples amount: ${this.validExamples ? this.validExamples.length : "validExamples is not an array"}, errored examples amount: ${this.erroredExamples ? this.erroredExamples.length : "erroredExamples is not an array"}.`);
         }
         ;
         this.updateSchema();
@@ -9933,7 +10034,7 @@ exports.apiComposeTaxonomiesTransformation = schemaUtils.apiComposeTaxonomiesTra
 exports.exampleImporter = schemaUtils.exampleImporter;
 exports.findMissingEntitiesInExample = schemaUtils.findMissingEntitiesInExample;
 exports.organizeEntitiesArrayIntoConvention = schemaUtils.organizeEntitiesArrayIntoConvention;
-exports.organizeEntitiesArrayByRelationships = schemaUtils.organizeEntitiesArrayByRelationships;
+exports.arrayToStructuredConvention = schemaUtils.arrayToStructuredConvention;
 exports.trimNonRequiredFields = schemaUtils.trimNonRequiredFields;
 exports.reduceSchemaToRequiredFields = schemaUtils.reduceSchemaToRequiredFields;
 exports.flattenJSONSchema = schemaUtils.flattenJSONSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "convention_builder",
-    "version": "1.4.2",
+    "version": "1.4.4",
     "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",