convention_builder 1.4.3 → 1.4.4

package/dist/module/index.js

@@ -9419,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,
@@ -9744,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();

package/dist/node/index.js

@@ -9412,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,
@@ -9737,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();

package/package.json

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