npm - data-restructor - Versions diffs - 3.3.4 → 3.4.1 - Mend

data-restructor 3.3.4 → 3.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (49) hide show

package/.auto-changelog +9 -0
package/.auto-changelog-template.hbs +36 -0
package/.github/workflows/codeql-analysis.yml +4 -4
package/.github/workflows/continuous-integration.yaml +84 -0
package/CHANGELOG.md +199 -94
package/CONTRIBUTING.md +51 -43
package/Commands.md +16 -15
package/README.md +193 -137
package/SECURITY.md +2 -2
package/coverage/coverage-summary.json +3 -3
package/coverage/datarestructor.js.html +133 -133
package/coverage/describedfield.js.html +45 -45
package/coverage/index.html +1 -1
package/coverage/templateResolver.js.html +26 -26
package/devdist/datarestructor-ie.js +1487 -1678
package/devdist/datarestructor.js +1438 -1614
package/devdist/describedfield-ie.js +260 -282
package/devdist/describedfield.js +257 -279
package/devdist/templateResolver-ie.js +221 -257
package/devdist/templateResolver.js +192 -228
package/dist/datarestructor-ie.js +1 -1
package/dist/datarestructor-ie.js.map +1 -1
package/dist/datarestructor.js +1 -1
package/dist/datarestructor.js.map +1 -1
package/dist/describedfield-ie.js +1 -1
package/dist/describedfield-ie.js.map +1 -1
package/dist/describedfield.js +1 -1
package/dist/describedfield.js.map +1 -1
package/dist/templateResolver-ie.js +1 -1
package/dist/templateResolver-ie.js.map +1 -1
package/dist/templateResolver.js +1 -1
package/dist/templateResolver.js.map +1 -1
package/docs/datarestructor.js.html +1 -1
package/docs/describedfield.js.html +1 -1
package/docs/index.html +54 -44
package/docs/module-datarestructor.DescribedEntryCreator.html +94 -94
package/docs/module-datarestructor.PropertyStructureDescriptionBuilder.html +1 -1
package/docs/module-datarestructor.Restructor.html +1 -1
package/docs/module-datarestructor.Transform.html +605 -605
package/docs/module-datarestructor.html +959 -995
package/docs/module-described_field.DescribedDataFieldBuilder.html +1 -1
package/docs/module-described_field.DescribedDataFieldGroup.html +1 -1
package/docs/module-described_field.html +1 -37
package/docs/module-template_resolver.Resolver.html +167 -167
package/docs/module-template_resolver.html +1 -37
package/docs/templateResolver.js.html +1 -1
package/package.json +20 -14
package/renovate.json +14 -0
package/.github/workflows/action.yaml +0 -44

package/docs/module-datarestructor.html CHANGED Viewed

@@ -28,10 +28,6 @@
 <header>
 </header>
 <article>
@@ -53,20 +49,6 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
 <dl class="details">
@@ -109,24 +91,6 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
 </dl>
@@ -173,33 +137,32 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
+<h4 class="name" id=".DescribedEntry">DescribedEntry</h4>
-    <h4 class="name" id=".addGroupEntriesFunction"><span class="type-signature"></span>addGroupEntriesFunction<span class="signature">(groupName, describedEntry)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Adds some group items/entries to the <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>.</p>
-</div>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Object</span>
+        </li>
+    </ul>
+    <h5 class="subsection-title">Properties:</h5>
-    <h5>Parameters:</h5>
-<table class="params">
+<table class="props">
     <thead>
     <tr>
@@ -209,8 +172,12 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
         <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -221,336 +188,318 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
         <tr>
-                <td class="name"><code>groupName</code></td>
+                <td class="name"><code>category</code></td>
             <td class="type">
-<span class="param-type">String</span>
+<span class="param-type">string</span>
             </td>
+                <td class="attributes">
+                </td>
-            <td class="description last"><p>name of the group that should be added</p></td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>category of the result from the PropertyStructureDescription using a short name or e.g. a symbol character</p></td>
         </tr>
         <tr>
-                <td class="name"><code>describedEntry</code></td>
+                <td class="name"><code>type</code></td>
             <td class="type">
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+<span class="param-type">string</span>
             </td>
+                <td class="attributes">
+                </td>
-            <td class="description last"><p>entries that should be added to the group</p></td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>type of the result from PropertyStructureDescription</p></td>
         </tr>
-    </tbody>
-</table>
+        <tr>
+                <td class="name"><code>abbreviation</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
-<dl class="details">
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    ""
+                </td>
+            <td class="description last"><p>one optional character, a symbol character or a short abbreviation of the category</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>image</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    ""
+                </td>
+            <td class="description last"><p>one optional path to an image resource</p></td>
+        </tr>
-    <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#line459">line 459</a>
-    </li></ul></dd>
+        <tr>
+                <td class="name"><code>index</code></td>
+            <td class="type">
+<span class="param-type">string</span>
-</dl>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>array of numbers containing the split index. Example: &quot;responses[2].hits.hits[4]._source.name&quot; leads to an array with the two elements: [2,4]</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>displayName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>display name extracted from the point separated hierarchical property name, e.g. &quot;Name&quot;</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>fieldName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
-    <h4 class="name" id=".addGroupEntryFunction"><span class="type-signature"></span>addGroupEntryFunction<span class="signature">(groupName, describedEntry)</span><span class="type-signature"></span></h4>
+                <td class="default">
+                </td>
+            <td class="description last"><p>field name extracted from the point separated hierarchical property name, e.g. &quot;name&quot;</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>value</code></td>
+            <td class="type">
+<span class="param-type">string</span>
-<div class="description">
-    <p>Adds a group item/entry to the <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>.</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>groupName</code></td>
+            </td>
-            <td class="type">
+                <td class="attributes">
-<span class="param-type">String</span>
+                </td>
-            </td>
+                <td class="default">
+                </td>
-            <td class="description last"><p>name of the group that should be added</p></td>
+            <td class="description last"><p>content of the field</p></td>
         </tr>
         <tr>
-                <td class="name"><code>describedEntry</code></td>
+                <td class="name"><code>groupNames</code></td>
             <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
+<span class="param-type">Array.&lt;string></span>
             </td>
+                <td class="attributes">
+                </td>
-            <td class="description last"><p>entry that should be added to the group</p></td>
-        </tr>
-    </tbody>
-</table>
-<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#line451">line 451</a>
-    </li></ul></dd>
-</dl>
+                <td class="default">
-<h4 class="name" id=".DescribedEntry">DescribedEntry</h4>
-    <h5>Type:</h5>
-    <ul>
-        <li>
+                </td>
-<span class="param-type">Object</span>
-        </li>
-    </ul>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+            <td class="description last"><p>array of names of all dynamically added properties representing groups</p></td>
+        </tr>
-    <tbody>
         <tr>
-                <td class="name"><code>category</code></td>
+                <td class="name"><code>addGroupEntry</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type"><a href="module-datarestructor.html#.addGroupEntryFunction">module:datarestructor.addGroupEntryFunction</a></span>
@@ -570,20 +519,20 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 </td>
-            <td class="description last"><p>category of the result from the PropertyStructureDescription using a short name or e.g. a symbol character</p></td>
+            <td class="description last"><p>function, that adds an entry to the given group. If the group does not exist, it will be created.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>type</code></td>
+                <td class="name"><code>addGroupEntries</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type"><a href="module-datarestructor.html#.addGroupEntriesFunction">module:datarestructor.addGroupEntriesFunction</a></span>
@@ -603,20 +552,20 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 </td>
-            <td class="description last"><p>type of the result from PropertyStructureDescription</p></td>
+            <td class="description last"><p>function, that adds entries to the given group. If the group does not exist, it will be created.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>abbreviation</code></td>
+                <td class="name"><code>_isMatchingIndex</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">boolean</span>
@@ -625,8 +574,6 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 <td class="attributes">
-                    &lt;optional><br>
                 </td>
@@ -635,25 +582,23 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 <td class="default">
-                    ""
                 </td>
-            <td class="description last"><p>one optional character, a symbol character or a short abbreviation of the category</p></td>
+            <td class="description last"><p>true, when _identifier.index matches the described &quot;indexStartsWith&quot;</p></td>
         </tr>
         <tr>
-                <td class="name"><code>image</code></td>
+                <td class="name"><code>_identifier</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">Object</span>
@@ -662,8 +607,6 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 <td class="attributes">
-                    &lt;optional><br>
                 </td>
@@ -672,14 +615,30 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 <td class="default">
-                    ""
                 </td>
-            <td class="description last"><p>one optional path to an image resource</p></td>
-        </tr>
+            <td class="description last"><p>internal structure for identifier. Avoid using it outside since it may change.</p>
+                <h6>Properties</h6>
+<table class="props">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
         <tr>
@@ -697,27 +656,17 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>array of numbers containing the split index. Example: &quot;responses[2].hits.hits[4]._source.name&quot; leads to an array with the two elements: [2,4]</p></td>
+            <td class="description last"><p>array indices in hierarchical order separated by points, e.g. &quot;0.0&quot;</p></td>
         </tr>
         <tr>
-                <td class="name"><code>displayName</code></td>
+                <td class="name"><code>value</code></td>
             <td class="type">
@@ -730,27 +679,17 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>display name extracted from the point separated hierarchical property name, e.g. &quot;Name&quot;</p></td>
+            <td class="description last"><p>the (single) value of the &quot;flattened&quot; property, e.g. &quot;Smith&quot;</p></td>
         </tr>
         <tr>
-                <td class="name"><code>fieldName</code></td>
+                <td class="name"><code>propertyNameWithArrayIndices</code></td>
             <td class="type">
@@ -763,27 +702,17 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>field name extracted from the point separated hierarchical property name, e.g. &quot;name&quot;</p></td>
+            <td class="description last"><p>the &quot;original&quot; flattened property name in hierarchical order separated by points, e.g. &quot;responses[0].hits.hits[0]._source.name&quot;</p></td>
         </tr>
         <tr>
-                <td class="name"><code>value</code></td>
+                <td class="name"><code>propertyNameWithoutArrayIndices</code></td>
             <td class="type">
@@ -796,132 +725,99 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>content of the field</p></td>
+            <td class="description last"><p>same as propertyNamesWithArrayIndices but without array indices, e.g. &quot;responses.hits.hits._source.name&quot;</p></td>
         </tr>
         <tr>
-                <td class="name"><code>groupNames</code></td>
+                <td class="name"><code>groupId</code></td>
             <td class="type">
-<span class="param-type">Array.&lt;string></span>
+<span class="param-type">string</span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>array of names of all dynamically added properties representing groups</p></td>
+            <td class="description last"><p>Contains the resolved groupPattern from the PropertyStructureDescription. Entries with the same id will be grouped into the &quot;groupName&quot; of the PropertyStructureDescription.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>addGroupEntry</code></td>
+                <td class="name"><code>groupDestinationId</code></td>
             <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.addGroupEntryFunction">module:datarestructor.addGroupEntryFunction</a></span>
+<span class="param-type">string</span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>function, that adds an entry to the given group. If the group does not exist, it will be created.</p></td>
+            <td class="description last"><p>Contains the resolved groupDestinationPattern from the PropertyStructureDescription. Entries with this id will be moved to the given destination group.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>addGroupEntries</code></td>
+                <td class="name"><code>deduplicationId</code></td>
             <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.addGroupEntriesFunction">module:datarestructor.addGroupEntriesFunction</a></span>
+<span class="param-type">string</span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
+            <td class="description last"><p>Contains the resolved deduplicationPattern from the PropertyStructureDescription. Entries with the same id will be considered to be a duplicate and hence removed.</p></td>
+        </tr>
-            <td class="description last"><p>function, that adds entries to the given group. If the group does not exist, it will be created.</p></td>
+    </tbody>
+</table>
+            </td>
         </tr>
         <tr>
-                <td class="name"><code>_isMatchingIndex</code></td>
+                <td class="name"><code>_description</code></td>
             <td class="type">
-<span class="param-type">boolean</span>
+<span class="param-type">Object</span>
@@ -941,41 +837,161 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 </td>
-            <td class="description last"><p>true, when _identifier.index matches the described &quot;indexStartsWith&quot;</p></td>
+            <td class="description last"><p>PropertyStructureDescription for internal use. Avoid using it outside since it may change.</p></td>
         </tr>
+    </tbody>
+</table>
+<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#line467">line 467</a>
+    </li></ul></dd>
+</dl>
-        <tr>
-                <td class="name"><code>_identifier</code></td>
-            <td class="type">
-<span class="param-type">Object</span>
-            </td>
-                <td class="attributes">
+<h4 class="name" id=".DescribedFieldRecursionContext">DescribedFieldRecursionContext</h4>
-                </td>
+<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>
-                <td class="default">
-                </td>
+<h4 class="name" id=".ExtractedIndices">ExtractedIndices</h4>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Object</span>
+        </li>
+    </ul>
-            <td class="description last"><p>internal structure for identifier. Avoid using it outside since it may change.</p>
-                <h6>Properties</h6>
+    <h5 class="subsection-title">Properties:</h5>
 <table class="props">
     <thead>
@@ -999,7 +1015,7 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
         <tr>
-                <td class="name"><code>index</code></td>
+                <td class="name"><code>pointDelimited</code></td>
             <td class="type">
@@ -1015,20 +1031,20 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
-            <td class="description last"><p>array indices in hierarchical order separated by points, e.g. &quot;0.0&quot;</p></td>
+            <td class="description last"><p>bracket indices separated by points</p></td>
         </tr>
         <tr>
-                <td class="name"><code>value</code></td>
+                <td class="name"><code>numberArray</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">Array.&lt;number></span>
@@ -1038,37 +1054,120 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
-            <td class="description last"><p>the (single) value of the &quot;flattened&quot; property, e.g. &quot;Smith&quot;</p></td>
+            <td class="description last"><p>as array of numbers</p></td>
         </tr>
+    </tbody>
+</table>
+<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#line580">line 580</a>
+    </li></ul></dd>
+</dl>
-        <tr>
-                <td class="name"><code>propertyNameWithArrayIndices</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
+<h4 class="name" id=".PropertyStructureDescription">PropertyStructureDescription</h4>
+<div class="description">
+    <p>Describes a selected part of the incoming data structure and defines,
+how the data should be transformed.</p>
+</div>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Object</span>
-            <td class="description last"><p>the &quot;original&quot; flattened property name in hierarchical order separated by points, e.g. &quot;responses[0].hits.hits[0]._source.name&quot;</p></td>
-        </tr>
+        </li>
+    </ul>
+    <h5 class="subsection-title">Properties:</h5>
+<table class="props">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
         <tr>
-                <td class="name"><code>propertyNameWithoutArrayIndices</code></td>
+                <td class="name"><code>type</code></td>
             <td class="type">
@@ -1081,17 +1180,27 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
-            <td class="description last"><p>same as propertyNamesWithArrayIndices but without array indices, e.g. &quot;responses.hits.hits._source.name&quot;</p></td>
+            <td class="description last"><p>&quot;&quot;(default). Some examples: &quot;summary&quot; for e.g. a list overview. &quot;detail&quot; e.g. when a summary is selected. &quot;filter&quot; e.g. for field/value pair results that can be selected as search parameters.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>groupId</code></td>
+                <td class="name"><code>category</code></td>
             <td class="type">
@@ -1104,17 +1213,27 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
+                <td class="attributes">
+                </td>
-            <td class="description last"><p>Contains the resolved groupPattern from the PropertyStructureDescription. Entries with the same id will be grouped into the &quot;groupName&quot; of the PropertyStructureDescription.</p></td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>name of the category. Default = &quot;&quot;. Could contain a short domain name like &quot;product&quot; or &quot;vendor&quot;.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>groupDestinationId</code></td>
+                <td class="name"><code>abbreviation</code></td>
             <td class="type">
@@ -1127,17 +1246,31 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
-            <td class="description last"><p>Contains the resolved groupDestinationPattern from the PropertyStructureDescription. Entries with this id will be moved to the given destination group.</p></td>
+                <td class="default">
+                    ""
+                </td>
+            <td class="description last"><p>one optional character, a symbol character or a short abbreviation of the category</p></td>
         </tr>
         <tr>
-                <td class="name"><code>deduplicationId</code></td>
+                <td class="name"><code>image</code></td>
             <td class="type">
@@ -1150,30 +1283,37 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
             </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
-            <td class="description last"><p>Contains the resolved deduplicationPattern from the PropertyStructureDescription. Entries with the same id will be considered to be a duplicate and hence removed.</p></td>
-        </tr>
-    </tbody>
-</table>
+                <td class="default">
+                    ""
+                </td>
-            </td>
+            <td class="description last"><p>one optional path to an image resource</p></td>
         </tr>
         <tr>
-                <td class="name"><code>_description</code></td>
+                <td class="name"><code>propertyPatternTemplateMode</code></td>
             <td class="type">
-<span class="param-type">Object</span>
+<span class="param-type">boolean</span>
@@ -1193,185 +1333,245 @@ It contains all functions to convert an object (e.g. parsed JSON) into uniform e
                 </td>
-            <td class="description last"><p>PropertyStructureDescription for internal use. Avoid using it outside since it may change.</p></td>
+            <td class="description last"><p>&quot;false&quot;(default): property name needs to be equal to the pattern. &quot;true&quot; allows variables like &quot;{{fieldName}}&quot; inside the pattern.</p></td>
         </tr>
-    </tbody>
-</table>
+        <tr>
+                <td class="name"><code>propertyPattern</code></td>
-<dl class="details">
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>property name pattern (without array indices) to match</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>indexStartsWith</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
-    <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#line467">line 467</a>
-    </li></ul></dd>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>&quot;&quot;(default) matches all ids. String that needs to match the beginning of the id. E.g. &quot;1.&quot; will match id=&quot;1.3.4&quot; but not &quot;0.1.2&quot;.</p></td>
+        </tr>
-</dl>
+        <tr>
+                <td class="name"><code>getDisplayNameForPropertyName</code></td>
+            <td class="type">
-<h4 class="name" id=".DescribedFieldRecursionContext">DescribedFieldRecursionContext</h4>
+<span class="param-type"><a href="module-datarestructor.html#.propertyNameFunction">module:datarestructor.propertyNameFunction</a></span>
-<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">
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>display name for the property. &quot;&quot;(default) last property name element with upper case first letter.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>getFieldNameForPropertyName</code></td>
+            <td class="type">
+<span class="param-type"><a href="module-datarestructor.html#.propertyNameFunction">module:datarestructor.propertyNameFunction</a></span>
+            </td>
+                <td class="attributes">
+                </td>
-    <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>
+                <td class="default">
+                </td>
+            <td class="description last"><p>field name for the property. &quot;&quot; (default) last property name element.</p></td>
+        </tr>
-</dl>
+        <tr>
+                <td class="name"><code>groupName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
-<h4 class="name" id=".ExtractedIndices">ExtractedIndices</h4>
+                </td>
+            <td class="description last"><p>name of the property, that contains grouped entries. Default=&quot;group&quot;.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>groupPattern</code></td>
+            <td class="type">
+<span class="param-type">string</span>
-    <h5>Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">Object</span>
+            </td>
+                <td class="attributes">
-        </li>
-    </ul>
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>Pattern that describes how to group entries. &quot;groupName&quot; defines the name of this group. A pattern may contain variables in double curly brackets {{variable}}.</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>groupDestinationPattern</code></td>
-    <h5 class="subsection-title">Properties:</h5>
+            <td class="type">
+<span class="param-type">string</span>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
+            </td>
-        <th>Type</th>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
+            <td class="description last"><p>Pattern that describes where the group should be moved to. Default=&quot;&quot;=Group will not be moved. A pattern may contain variables in double curly brackets {{variable}}.</p></td>
+        </tr>
-    <tbody>
         <tr>
-                <td class="name"><code>pointDelimited</code></td>
+                <td class="name"><code>groupDestinationName</code></td>
             <td class="type">
@@ -1384,33 +1584,53 @@ recursion depth.</p>
             </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
-            <td class="description last"><p>bracket indices separated by points</p></td>
+            <td class="description last"><p>(default=groupName) Name of the group when it had been moved to the destination.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>numberArray</code></td>
+                <td class="name"><code>deduplicationPattern</code></td>
             <td class="type">
-<span class="param-type">Array.&lt;number></span>
+<span class="param-type">string</span>
             </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
-            <td class="description last"><p>as array of numbers</p></td>
+            <td class="description last"><p>Pattern to use to remove duplicate entries. A pattern may contain variables in double curly brackets {{variable}}.</p></td>
         </tr>
@@ -1449,7 +1669,7 @@ recursion depth.</p>
     <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#line580">line 580</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line43">line 43</a>
     </li></ul></dd>
@@ -1467,33 +1687,32 @@ recursion depth.</p>
+<h4 class="name" id=".TransformConfig">TransformConfig</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>
-<div class="description">
-    <p>Takes the full qualified original property name and extracts a simple name out of it.</p>
-</div>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type">Object</span>
+        </li>
+    </ul>
+    <h5 class="subsection-title">Properties:</h5>
-    <h5>Parameters:</h5>
-<table class="params">
+<table class="props">
     <thead>
     <tr>
@@ -1503,8 +1722,12 @@ recursion depth.</p>
         <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -1515,69 +1738,107 @@ recursion depth.</p>
         <tr>
-                <td class="name"><code>groupName</code></td>
+                <td class="name"><code>debugMode</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">boolean</span>
             </td>
+                <td class="attributes">
+                </td>
-            <td class="description last"><p>name of the group where the entry had been found.</p></td>
+                <td class="default">
+                </td>
+            <td class="description last"><p>enables/disables detailed logging</p></td>
         </tr>
         <tr>
-                <td class="name"><code>foundEntry</code></td>
+                <td class="name"><code>maxRecursionDepth</code></td>
             <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
+<span class="param-type">number</span>
             </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
-            <td class="description last"><p>the found entry itself.</p></td>
+                <td class="default">
+                    8
+                </td>
+            <td class="description last"><p>Maximum recursion depth</p></td>
         </tr>
         <tr>
-                <td class="name"><code>allEntries</code></td>
+                <td class="name"><code>removeDuplicationAboveRecursionDepth</code></td>
             <td class="type">
-<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
+<span class="param-type">number</span>
             </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
-            <td class="description last"><p>the array of all entries where the found entry is an element of.</p></td>
+                <td class="default">
+                    1
+                </td>
+            <td class="description last"><p>Duplications will be removed above the given recursion depth value and remain unchanged below it.</p></td>
         </tr>
@@ -1587,8 +1848,6 @@ recursion depth.</p>
 <dl class="details">
@@ -1618,7 +1877,7 @@ recursion depth.</p>
     <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#line1182">line 1182</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line628">line 628</a>
     </li></ul></dd>
@@ -1633,20 +1892,6 @@ recursion depth.</p>
@@ -1654,7 +1899,7 @@ recursion depth.</p>
-    <h4 class="name" id=".propertyNameFunction"><span class="type-signature"></span>propertyNameFunction<span class="signature">(propertyName)</span><span class="type-signature"> &rarr; {String}</span></h4>
+    <h4 class="name" id=".addGroupEntriesFunction"><span class="type-signature"></span>addGroupEntriesFunction<span class="signature">(groupName, describedEntry)</span><span class="type-signature"></span></h4>
@@ -1662,7 +1907,7 @@ recursion depth.</p>
 <div class="description">
-    <p>Takes the full qualified original property name and extracts a simple name out of it.</p>
+    <p>Adds some group items/entries to the <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>.</p>
 </div>
@@ -1698,13 +1943,13 @@ recursion depth.</p>
         <tr>
-                <td class="name"><code>propertyName</code></td>
+                <td class="name"><code>groupName</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">String</span>
@@ -1714,7 +1959,30 @@ recursion depth.</p>
-            <td class="description last"><p>full qualified, point separated property name</p></td>
+            <td class="description last"><p>name of the group that should be added</p></td>
+        </tr>
+        <tr>
+                <td class="name"><code>describedEntry</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>entries that should be added to the group</p></td>
         </tr>
@@ -1755,7 +2023,7 @@ recursion depth.</p>
     <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#line35">line 35</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line459">line 459</a>
     </li></ul></dd>
@@ -1780,66 +2048,40 @@ recursion depth.</p>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>extracted, simple name</p>
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">String</span>
-    </dd>
-</dl>
+    <h4 class="name" id=".addGroupEntryFunction"><span class="type-signature"></span>addGroupEntryFunction<span class="signature">(groupName, describedEntry)</span><span class="type-signature"></span></h4>
-<h4 class="name" id=".PropertyStructureDescription">PropertyStructureDescription</h4>
 <div class="description">
-    <p>Describes a selected part of the incoming data structure and defines,
-how the data should be transformed.</p>
+    <p>Adds a group item/entry to the <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>.</p>
 </div>
-    <h5>Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">Object</span>
-        </li>
-    </ul>
-    <h5 class="subsection-title">Properties:</h5>
+    <h5>Parameters:</h5>
-<table class="props">
+<table class="params">
     <thead>
     <tr>
@@ -1849,12 +2091,8 @@ how the data should be transformed.</p>
         <th>Type</th>
-        <th>Attributes</th>
-        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -1865,378 +2103,167 @@ how the data should be transformed.</p>
         <tr>
-                <td class="name"><code>type</code></td>
+                <td class="name"><code>groupName</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">String</span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>&quot;&quot;(default). Some examples: &quot;summary&quot; for e.g. a list overview. &quot;detail&quot; e.g. when a summary is selected. &quot;filter&quot; e.g. for field/value pair results that can be selected as search parameters.</p></td>
+            <td class="description last"><p>name of the group that should be added</p></td>
         </tr>
         <tr>
-                <td class="name"><code>category</code></td>
+                <td class="name"><code>describedEntry</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>name of the category. Default = &quot;&quot;. Could contain a short domain name like &quot;product&quot; or &quot;vendor&quot;.</p></td>
+            <td class="description last"><p>entry that should be added to the group</p></td>
         </tr>
-        <tr>
-                <td class="name"><code>abbreviation</code></td>
-            <td class="type">
-<span class="param-type">string</span>
+    </tbody>
+</table>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    ""
-                </td>
-            <td class="description last"><p>one optional character, a symbol character or a short abbreviation of the category</p></td>
-        </tr>
+<dl class="details">
-        <tr>
-                <td class="name"><code>image</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    ""
-                </td>
-            <td class="description last"><p>one optional path to an image resource</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>propertyPatternTemplateMode</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>&quot;false&quot;(default): property name needs to be equal to the pattern. &quot;true&quot; allows variables like &quot;{{fieldName}}&quot; inside the pattern.</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>propertyPattern</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>property name pattern (without array indices) to match</p></td>
-        </tr>
+    <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#line451">line 451</a>
+    </li></ul></dd>
-        <tr>
-                <td class="name"><code>indexStartsWith</code></td>
-            <td class="type">
-<span class="param-type">string</span>
+</dl>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>&quot;&quot;(default) matches all ids. String that needs to match the beginning of the id. E.g. &quot;1.&quot; will match id=&quot;1.3.4&quot; but not &quot;0.1.2&quot;.</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>getDisplayNameForPropertyName</code></td>
-            <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.propertyNameFunction">module:datarestructor.propertyNameFunction</a></span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>display name for the property. &quot;&quot;(default) last property name element with upper case first letter.</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>getFieldNameForPropertyName</code></td>
-            <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.propertyNameFunction">module:datarestructor.propertyNameFunction</a></span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>field name for the property. &quot;&quot; (default) last property name element.</p></td>
-        </tr>
+    <h4 class="name" id=".onEntryFoundFunction"><span class="type-signature"></span>onEntryFoundFunction<span class="signature">(groupName, foundEntry, allEntries)</span><span class="type-signature"></span></h4>
-        <tr>
-                <td class="name"><code>groupName</code></td>
-            <td class="type">
-<span class="param-type">string</span>
+<div class="description">
+    <p>Takes the full qualified original property name and extracts a simple name out of it.</p>
+</div>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>name of the property, that contains grouped entries. Default=&quot;group&quot;.</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>groupPattern</code></td>
-            <td class="type">
-<span class="param-type">string</span>
+    <h5>Parameters:</h5>
-            </td>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
-                <td class="attributes">
+        <th>Type</th>
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>Pattern that describes how to group entries. &quot;groupName&quot; defines the name of this group. A pattern may contain variables in double curly brackets {{variable}}.</p></td>
-        </tr>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
         <tr>
-                <td class="name"><code>groupDestinationPattern</code></td>
+                <td class="name"><code>groupName</code></td>
             <td class="type">
@@ -2249,86 +2276,56 @@ how the data should be transformed.</p>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>Pattern that describes where the group should be moved to. Default=&quot;&quot;=Group will not be moved. A pattern may contain variables in double curly brackets {{variable}}.</p></td>
+            <td class="description last"><p>name of the group where the entry had been found.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>groupDestinationName</code></td>
+                <td class="name"><code>foundEntry</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>(default=groupName) Name of the group when it had been moved to the destination.</p></td>
+            <td class="description last"><p>the found entry itself.</p></td>
         </tr>
         <tr>
-                <td class="name"><code>deduplicationPattern</code></td>
+                <td class="name"><code>allEntries</code></td>
             <td class="type">
-<span class="param-type">string</span>
+<span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
             </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>Pattern to use to remove duplicate entries. A pattern may contain variables in double curly brackets {{variable}}.</p></td>
+            <td class="description last"><p>the array of all entries where the found entry is an element of.</p></td>
         </tr>
@@ -2338,6 +2335,8 @@ how the data should be transformed.</p>
 <dl class="details">
@@ -2367,7 +2366,7 @@ how the data should be transformed.</p>
     <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#line43">line 43</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line1182">line 1182</a>
     </li></ul></dd>
@@ -2382,6 +2381,20 @@ how the data should be transformed.</p>
@@ -2389,7 +2402,7 @@ how the data should be transformed.</p>
-    <h4 class="name" id=".stringFieldOfDescribedEntryFunction"><span class="type-signature"></span>stringFieldOfDescribedEntryFunction<span class="signature">(entry)</span><span class="type-signature"> &rarr; {String}</span></h4>
+    <h4 class="name" id=".propertyNameFunction"><span class="type-signature"></span>propertyNameFunction<span class="signature">(propertyName)</span><span class="type-signature"> &rarr; {String}</span></h4>
@@ -2397,7 +2410,7 @@ how the data should be transformed.</p>
 <div class="description">
-    <p>Returns a field value of the given <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>.</p>
+    <p>Takes the full qualified original property name and extracts a simple name out of it.</p>
 </div>
@@ -2433,13 +2446,13 @@ how the data should be transformed.</p>
         <tr>
-                <td class="name"><code>entry</code></td>
+                <td class="name"><code>propertyName</code></td>
             <td class="type">
-<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
+<span class="param-type">string</span>
@@ -2449,7 +2462,7 @@ how the data should be transformed.</p>
-            <td class="description last"><p>described entry that contains the field that should be returned</p></td>
+            <td class="description last"><p>full qualified, point separated property name</p></td>
         </tr>
@@ -2490,7 +2503,7 @@ how the data should be transformed.</p>
     <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#line492">line 492</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line35">line 35</a>
     </li></ul></dd>
@@ -2519,7 +2532,7 @@ how the data should be transformed.</p>
 <div class="param-desc">
-    <p>field value</p>
+    <p>extracted, simple name</p>
 </div>
@@ -2544,32 +2557,33 @@ how the data should be transformed.</p>
-<h4 class="name" id=".TransformConfig">TransformConfig</h4>
+    <h4 class="name" id=".stringFieldOfDescribedEntryFunction"><span class="type-signature"></span>stringFieldOfDescribedEntryFunction<span class="signature">(entry)</span><span class="type-signature"> &rarr; {String}</span></h4>
-    <h5>Type:</h5>
-    <ul>
-        <li>
-<span class="param-type">Object</span>
+<div class="description">
+    <p>Returns a field value of the given <a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>.</p>
+</div>
-        </li>
-    </ul>
-    <h5 class="subsection-title">Properties:</h5>
+    <h5>Parameters:</h5>
-<table class="props">
+<table class="params">
     <thead>
     <tr>
@@ -2579,12 +2593,8 @@ how the data should be transformed.</p>
         <th>Type</th>
-        <th>Attributes</th>
-        <th>Default</th>
         <th class="last">Description</th>
     </tr>
@@ -2595,107 +2605,23 @@ how the data should be transformed.</p>
         <tr>
-                <td class="name"><code>debugMode</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
-            </td>
-                <td class="attributes">
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last"><p>enables/disables detailed logging</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>maxRecursionDepth</code></td>
-            <td class="type">
-<span class="param-type">number</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    8
-                </td>
-            <td class="description last"><p>Maximum recursion depth</p></td>
-        </tr>
-        <tr>
-                <td class="name"><code>removeDuplicationAboveRecursionDepth</code></td>
+                <td class="name"><code>entry</code></td>
             <td class="type">
-<span class="param-type">number</span>
+<span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
             </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    1
-                </td>
-            <td class="description last"><p>Duplications will be removed above the given recursion depth value and remain unchanged below it.</p></td>
+            <td class="description last"><p>described entry that contains the field that should be returned</p></td>
         </tr>
@@ -2705,6 +2631,8 @@ how the data should be transformed.</p>
 <dl class="details">
@@ -2734,7 +2662,7 @@ how the data should be transformed.</p>
     <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#line628">line 628</a>
+        <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line492">line 492</a>
     </li></ul></dd>
@@ -2750,6 +2678,42 @@ how the data should be transformed.</p>
+<h5>Returns:</h5>
+<div class="param-desc">
+    <p>field value</p>
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
@@ -2770,7 +2734,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 Thu Jun 17 2021 07:24:00 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Feb 28 2023 21:27:12 GMT+0100 (Central European Standard Time)
 </footer>
 <script> prettyPrint(); </script>