data-restructor 3.3.3 → 3.4.0

package/docs/module-datarestructor.html

@@ -1250,6 +1250,80 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
 
             
                 
+<h4 class="name" id=".DescribedFieldRecursionContext">DescribedFieldRecursionContext</h4>
+
+
+
+
+<div class="description">
+    <p>Describes the context type for the recursive DescribedDataField conversion,
+that contains everything that needs to be accessible throughout recursion regardless of the
+recursion depth.</p>
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1091">line 1091</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+            
+                
 <h4 class="name" id=".ExtractedIndices">ExtractedIndices</h4>
 
 
@@ -1397,7 +1471,7 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
     
 
     
-    <h4 class="name" id=".onEntryFoundFunction"><span class="type-signature"></span>onEntryFoundFunction<span class="signature">(groupName, foundEntry)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id=".onEntryFoundFunction"><span class="type-signature"></span>onEntryFoundFunction<span class="signature">(groupName, foundEntry, allEntries)</span><span class="type-signature"></span></h4>
     
 
     
@@ -1484,6 +1558,29 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>allEntries</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>the array of all entries where the found entry is an element of.</p></td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -1521,7 +1618,7 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1140">line 1140</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1182">line 1182</a>
     </li></ul></dd>
     
 
@@ -2673,7 +2770,7 @@ how the data should be transformed.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:17 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/module-described_field.DescribedDataFieldBuilder.html

@@ -2123,7 +2123,7 @@ Example: "responses[2].hits.hits[4]._source.name" will have an index o
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:18 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/module-described_field.DescribedDataFieldGroup.html

@@ -577,7 +577,7 @@ that contain an array of sub fields of the same type <a href="module-described_f
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:18 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/module-described_field.html

@@ -783,7 +783,7 @@ Dynamically added properties represent custom named groups containing DescribedD
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:18 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/module-template_resolver.Resolver.html

@@ -1285,7 +1285,7 @@ Parts of the index can be inserted by using e.g. &quot;{{index[1]}}&quot;.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:18 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/module-template_resolver.html

@@ -163,7 +163,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:18 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/templateResolver.js.html

@@ -210,7 +210,7 @@ template_resolver.Resolver = (function () {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Jun 06 2021 17:48:17 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 31 2022 17:00:02 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-restructor",
-  "version": "3.3.3",
+  "version": "3.4.0",
   "description": "Transforms parsed JSON objects into a uniform data structure",
   "directories": {
     "test": "test"
@@ -10,12 +10,12 @@
       "context": "node",
       "includeNodeModules": true,
       "engines": {
-        "node": "10"
+        "node": "14"
       }
     }
   },
   "engines": {
-    "node": "10"
+    "node": "18"
   },
   "scripts": {
     "prebuild": "rm -rf dist",
@@ -24,11 +24,11 @@
     "coverage": "nyc npm run test",
     "coverage-badge": "istanbul-badges-readme",
     "doc": "jsdoc -d docs --configure ./docs/jsdoc.json --readme ./README.md ./src/js/*.js",
-    "merger": "merger build",
+    "merger": "echo -ne \"k\n\" | npx merger build",
     "dev": "rm -rf devdist && parcel --out-dir devdist ./src/js/*.js",
     "devbuild": "rm -rf devdist && NODE_ENV=development parcel build --dist-dir devdist ./src/js/*.js --no-optimize --no-source-maps --no-scope-hoist --no-content-hash --detailed-report",
-    "build": "parcel build ./src/js/*.js",
-    "package": "npm run lint && npm run coverage && npm run coverage-badge && npm run doc && npm run devbuild && npm run build && merger"
+    "build": "export NODE_OPTIONS=--no-experimental-fetch;parcel build ./src/js/*.js",
+    "package": "npm run lint && npm run coverage && npm run coverage-badge && npm run doc && npm run devbuild && npm run build && npm run merger"
   },
   "repository": {
     "type": "git",
@@ -46,12 +46,14 @@
   },
   "homepage": "https://joht.github.io/data-restructor-js",
   "devDependencies": {
-    "eslint": "^7.28.0",
-    "istanbul-badges-readme": "^1.3.4",
-    "jasmine": "^3.7.0",
-    "jsdoc": "^3.6.7",
-    "nyc": "^15.1.0",
-    "parcel": "2.0.0-beta.2"
-  },
-  "dependencies": {}
+    "eslint": "8.26.0",
+    "inquirer": "9.1.4",
+    "istanbul-badges-readme": "1.8.2",
+    "jasmine": "4.5.0",
+    "jsdoc": "3.6.11",
+    "merger-js": "3.10.3",
+    "node-notifier": "10.0.1",
+    "nyc": "15.1.0",
+    "parcel": "2.0.0"
+  }
 }

package/renovate.json

@@ -0,0 +1,20 @@
+{
+  "extends": [
+    "config:base",
+    ":pinAllExceptPeerDependencies",
+    ":combinePatchMinorReleases",
+    ":prConcurrentLimit10",
+    ":automergeDigest",
+    ":automergePatch",
+    ":automergeMinor",
+    ":automergeRequireAllStatusChecks",
+    ":automergeLinters",
+    ":automergeTesters"
+  ],
+  "packageRules": [
+    {
+      "matchPackageNames": ["parcel"],
+      "enabled": false
+    }
+  ]
+}

package/src/js/datarestructor.js

@@ -1083,11 +1083,22 @@ datarestructor.Transform = (function () {
     var describedEntity;
     for (index = 0; index < describedEntries.length; index += 1) {
       describedEntity = describedEntries[index];
-      result.push(toDescribedField(describedEntity, 0, config));
+      result.push(toDescribedField(describedEntity, {recursionDepth:0, config: config, groupToSkip:""}));
     }
     return result;
   }
 
+  /**
+   * Describes the context type for the recursive DescribedDataField conversion,
+   * that contains everything that needs to be accessible throughout recursion regardless of the
+   * recursion depth.
+   *
+   * @typedef {Object} module:datarestructor.DescribedFieldRecursionContext
+   * @param {number} recursionDepth current recursion depth
+   * @param {String} groupToSkip name of a group to skip or "" when no group should be skipped. 
+   * @param {module:datarestructor.TransformConfig} config configuration for the data transformation
+   */
+
   /**
    * Converts a internal described entry to a newly created public described field.
    * Since the structure of a described field is hierarchical, this function is called recursively.
@@ -1095,13 +1106,12 @@ datarestructor.Transform = (function () {
    * needs to be limited. Therefore, the current recursion depth is taken as second parameter
    * and the maximum recursion depth is taken as third parameter.
    * @param {module:datarestructor.DescribedEntry} entry the internal entry that will be converted
-   * @param {number} recursionDepth current hierarchy recursion depth
-   * @param {module:datarestructor.TransformConfig} config configuration for the data transformation
+   * @param {module:datarestructor.DescribedFieldRecursionContext} recursionContext context contains everything that needs to be accessible throughout the recursion.
    * @returns {module:described_field.DescribedDataField}
    * @protected
    * @memberof module:datarestructor.Transform
    */
-  function toDescribedField(entry, recursionDepth, config) {
+  function toDescribedField(entry, recursionContext) {
     var field = new described_field.DescribedDataFieldBuilder()
       .category(entry.category)
       .type(entry.type)
@@ -1112,37 +1122,70 @@ datarestructor.Transform = (function () {
       .fieldName(entry.fieldName)
       .value(entry.value)
       .build();
-    if (recursionDepth > config.maxRecursionDepth) {
+    if (recursionContext.recursionDepth > recursionContext.config.maxRecursionDepth) {
       return field;
     }
+    var nextRecursionContext = null;
+    var duplicateGroupNameToSkip = "";
     var fieldGroups = new described_field.DescribedDataFieldGroup(field);
-    forEachGroupEntry(entry, function (groupName, groupEntry) {
-      if (groupEntry != entry || recursionDepth <= config.removeDuplicationAboveRecursionDepth) {
-        fieldGroups.addGroupEntry(groupName, toDescribedField(groupEntry, recursionDepth + 1, config));
-      } else {
-        if (config.debugMode) {
-          console.log(
-            "Removed duplicate field " +
-              groupEntry.fieldName +
-              " with value " +
-              groupEntry.value +
-              " of group " +
-              groupName +
-              " at recursion depth " +
-              recursionDepth
-          );
+    forEachGroupEntry(entry, function (groupName, groupEntry, allGroupEntries) {
+      if (recursionContext.groupToSkip === groupName) {
+        if (recursionContext.config.debugMode) {
+          console.log("Removed duplicate group " + groupName + " at recursion depth " + recursionContext.recursionDepth);
         }
+        return;
+      }
+      duplicateGroupNameToSkip = "";
+      if (recursionContext.recursionDepth >= recursionContext.config.removeDuplicationAboveRecursionDepth) {
+        duplicateGroupNameToSkip = arraysEqual(groupEntry[groupName], allGroupEntries, describedFieldEqual)? groupName : "";
       }
+      nextRecursionContext = {recursionDepth: recursionContext.recursionDepth + 1, config: recursionContext.config, groupToSkip: duplicateGroupNameToSkip};
+      fieldGroups.addGroupEntry(groupName, toDescribedField(groupEntry, nextRecursionContext));
     });
     return field;
   }
 
+  function describedFieldEqual(a, b) {
+    return (
+      defaultEmpty(a.category) === defaultEmpty(b.category) &&
+      defaultEmpty(a.type) === defaultEmpty(b.type) &&
+      a.fieldName === b.fieldName &&
+      a.value === b.value
+    );
+  }
+
+  function defaultEmpty(value) {
+    return defaultValue(value, "");
+  }
+
+  function defaultValue(value, valueAsDefault) {
+    if (typeof value === "undefined" || !value) {
+      return valueAsDefault;
+    }
+    return value;
+  }
+
+  // Reference: https://stackoverflow.com/questions/3115982/how-to-check-if-two-arrays-are-equal-with-javascript/16430730
+  // Added "elementEqualFunction" to implement equal object detection.
+  // Arrays are assumed to be sorted. Differently ordered entries are treated as not equal.
+  function arraysEqual(a, b, elementEqualFunction) {
+    if (a === b) return true;
+    if (a == null || b == null) return false;
+    if (a.length !== b.length) return false;
+
+    for (var i = 0; i < a.length; ++i) {
+      if (!elementEqualFunction(a[i], b[i])) return false;
+    }
+    return true;
+  }
+
   /**
    * Takes the full qualified original property name and extracts a simple name out of it.
    *
    * @callback module:datarestructor.onEntryFoundFunction
    * @param {string} groupName name of the group where the entry had been found.
    * @param {module:datarestructor.DescribedEntry} foundEntry the found entry itself.
+   * @param {module:datarestructor.DescribedEntry[]} allEntries the array of all entries where the found entry is an element of.
    */
 
   /**
@@ -1160,13 +1203,12 @@ datarestructor.Transform = (function () {
       groupName = rootEntry.groupNames[groupIndex];
       for (entryIndex = 0; entryIndex < rootEntry[groupName].length; entryIndex += 1) {
         entry = rootEntry[groupName][entryIndex];
-        onFoundEntry(groupName, entry);
+        onFoundEntry(groupName, entry, rootEntry[groupName]);
       }
     }
   }
-
   return Transform;
-})();
+}());
 
 /**
  * Main fassade for the data restructor as static function(s).

package/test/js/DataRestructorUseCaseTest.js

@@ -432,5 +432,41 @@ describe("datarestructor.Restructor (use case)", function () {
         );
       });
     });
+
+    describe("using Transform with duplication removal", function () {
+      beforeEach(function () {
+        restructorResults = new datarestructor.Transform(descriptions).setRemoveDuplicationAboveRecursionDepth(0).setMaxRecursionDepth(1).enableDebugMode().processJson(jsonData);
+      });
+      
+      it("shouldn't contain duplicated details inside every summary detail", function () {
+        forEachEntryMatching(
+          function (entry) {
+            return entry.type === "summary";
+          },
+          function (entry) {
+            var index;
+            // Each entry in 'details' shouldn't contain details (duplication) itself
+            for (index = 0; index < entry.details.length; index += 1) {
+              expect(entry.details[index].details).toBeUndefined();
+            }
+          }
+        );
+      });
+
+      it("shouldn't contain duplicated options inside every filter option", function () {
+        forEachEntryMatching(
+          function (entry) {
+            return entry.type === "filter";
+          },
+          function (entry) {
+            var index;
+            // Each entry in 'options' shouldn't contain options (duplication) itself
+            for (index = 0; index < entry.options.length; index += 1) {
+              expect(entry.options[index].options).toBeUndefined();
+            }
+          }
+        );
+      });
+    });
   });
 });

package/.github/workflows/action.yaml

@@ -1,44 +0,0 @@
-name: Node CI
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: '12'
-    - name: Install nodes packages
-      run: npm ci
-    - name: Run tests
-      run: npm test
-    - name: Measure test coverage
-      run: npm run coverage
-    - name: Run linter
-      run: npm run lint
-    - name: Generate documentation
-      run: npm run doc
-    - name: Build
-      run: npm run build --if-present
-    - name: Archive code coverage results
-      uses: actions/upload-artifact@v2
-      with:
-        name: code-coverage-report
-        path: coverage
-        retention-days: 2
-    - name: Archive documentation
-      uses: actions/upload-artifact@v2
-      with:
-        name: documentation
-        path: docs
-        retention-days: 2
-    - name: Archive build artifacts
-      uses: actions/upload-artifact@v2
-      with:
-        name: dist-without-markdown
-        path: |
-          dist
-          !dist/**/*.md
-        retention-days: 2