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
  1. package/.auto-changelog +9 -0
  2. package/.auto-changelog-template.hbs +36 -0
  3. package/.github/workflows/codeql-analysis.yml +4 -4
  4. package/.github/workflows/continuous-integration.yaml +84 -0
  5. package/CHANGELOG.md +199 -94
  6. package/CONTRIBUTING.md +51 -43
  7. package/Commands.md +16 -15
  8. package/README.md +193 -137
  9. package/SECURITY.md +2 -2
  10. package/coverage/coverage-summary.json +3 -3
  11. package/coverage/datarestructor.js.html +133 -133
  12. package/coverage/describedfield.js.html +45 -45
  13. package/coverage/index.html +1 -1
  14. package/coverage/templateResolver.js.html +26 -26
  15. package/devdist/datarestructor-ie.js +1487 -1678
  16. package/devdist/datarestructor.js +1438 -1614
  17. package/devdist/describedfield-ie.js +260 -282
  18. package/devdist/describedfield.js +257 -279
  19. package/devdist/templateResolver-ie.js +221 -257
  20. package/devdist/templateResolver.js +192 -228
  21. package/dist/datarestructor-ie.js +1 -1
  22. package/dist/datarestructor-ie.js.map +1 -1
  23. package/dist/datarestructor.js +1 -1
  24. package/dist/datarestructor.js.map +1 -1
  25. package/dist/describedfield-ie.js +1 -1
  26. package/dist/describedfield-ie.js.map +1 -1
  27. package/dist/describedfield.js +1 -1
  28. package/dist/describedfield.js.map +1 -1
  29. package/dist/templateResolver-ie.js +1 -1
  30. package/dist/templateResolver-ie.js.map +1 -1
  31. package/dist/templateResolver.js +1 -1
  32. package/dist/templateResolver.js.map +1 -1
  33. package/docs/datarestructor.js.html +1 -1
  34. package/docs/describedfield.js.html +1 -1
  35. package/docs/index.html +54 -44
  36. package/docs/module-datarestructor.DescribedEntryCreator.html +94 -94
  37. package/docs/module-datarestructor.PropertyStructureDescriptionBuilder.html +1 -1
  38. package/docs/module-datarestructor.Restructor.html +1 -1
  39. package/docs/module-datarestructor.Transform.html +605 -605
  40. package/docs/module-datarestructor.html +959 -995
  41. package/docs/module-described_field.DescribedDataFieldBuilder.html +1 -1
  42. package/docs/module-described_field.DescribedDataFieldGroup.html +1 -1
  43. package/docs/module-described_field.html +1 -37
  44. package/docs/module-template_resolver.Resolver.html +167 -167
  45. package/docs/module-template_resolver.html +1 -37
  46. package/docs/templateResolver.js.html +1 -1
  47. package/package.json +20 -14
  48. package/renovate.json +14 -0
  49. package/.github/workflows/action.yaml +0 -44
@@ -228,7 +228,7 @@ This is the public version of the internal variable _identifier.index, which con
228
228
 
229
229
 
230
230
 
231
- <h4 class="name" id=".indicesOf"><span class="type-signature">(protected, static) </span>indicesOf<span class="signature">(fullPropertyName)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a>}</span></h4>
231
+ <h4 class="name" id="addGroupEntries"><span class="type-signature"></span>addGroupEntries<span class="signature">(groupName, describedEntries)</span><span class="type-signature"></span></h4>
232
232
 
233
233
 
234
234
 
@@ -236,7 +236,7 @@ This is the public version of the internal variable _identifier.index, which con
236
236
 
237
237
 
238
238
  <div class="description">
239
- <p>Returns &quot;1.12.123&quot; and [1,12,123] for &quot;results[1].hits.hits[12].aggregates[123]&quot;.</p>
239
+ <p>Adds entries to the given group. If the group does not exist, it will be created.</p>
240
240
  </div>
241
241
 
242
242
 
@@ -272,7 +272,7 @@ This is the public version of the internal variable _identifier.index, which con
272
272
 
273
273
  <tr>
274
274
 
275
- <td class="name"><code>fullPropertyName</code></td>
275
+ <td class="name"><code>groupName</code></td>
276
276
 
277
277
 
278
278
  <td class="type">
@@ -288,6 +288,29 @@ This is the public version of the internal variable _identifier.index, which con
288
288
 
289
289
 
290
290
 
291
+ <td class="description last"></td>
292
+ </tr>
293
+
294
+
295
+
296
+ <tr>
297
+
298
+ <td class="name"><code>describedEntries</code></td>
299
+
300
+
301
+ <td class="type">
302
+
303
+
304
+ <span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
305
+
306
+
307
+
308
+ </td>
309
+
310
+
311
+
312
+
313
+
291
314
  <td class="description last"></td>
292
315
  </tr>
293
316
 
@@ -329,7 +352,7 @@ This is the public version of the internal variable _identifier.index, which con
329
352
 
330
353
  <dt class="tag-source">Source:</dt>
331
354
  <dd class="tag-source"><ul class="dummy"><li>
332
- <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line594">line 594</a>
355
+ <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line567">line 567</a>
333
356
  </li></ul></dd>
334
357
 
335
358
 
@@ -354,28 +377,6 @@ This is the public version of the internal variable _identifier.index, which con
354
377
 
355
378
 
356
379
 
357
- <h5>Returns:</h5>
358
-
359
-
360
- <div class="param-desc">
361
- <p>extracted indices in different representations</p>
362
- </div>
363
-
364
-
365
-
366
- <dl>
367
- <dt>
368
- Type
369
- </dt>
370
- <dd>
371
-
372
- <span class="param-type"><a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a></span>
373
-
374
-
375
- </dd>
376
- </dl>
377
-
378
-
379
380
 
380
381
 
381
382
 
@@ -387,7 +388,7 @@ This is the public version of the internal variable _identifier.index, which con
387
388
 
388
389
 
389
390
 
390
- <h4 class="name" id=".indicesOfWithRegex"><span class="type-signature">(protected, static) </span>indicesOfWithRegex<span class="signature">(fullPropertyName, regexWithOneNumberGroup)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a>}</span></h4>
391
+ <h4 class="name" id="addGroupEntry"><span class="type-signature"></span>addGroupEntry<span class="signature">(groupName, describedEntry)</span><span class="type-signature"></span></h4>
391
392
 
392
393
 
393
394
 
@@ -395,7 +396,7 @@ This is the public version of the internal variable _identifier.index, which con
395
396
 
396
397
 
397
398
  <div class="description">
398
- <p>Returns &quot;1.12.123&quot; and [1,12,123] for &quot;results[1].hits.hits[12].aggregates[123]&quot;.</p>
399
+ <p>Adds an entry to the given group. If the group does not exist, it will be created.</p>
399
400
  </div>
400
401
 
401
402
 
@@ -431,13 +432,13 @@ This is the public version of the internal variable _identifier.index, which con
431
432
 
432
433
  <tr>
433
434
 
434
- <td class="name"><code>fullPropertyName</code></td>
435
+ <td class="name"><code>groupName</code></td>
435
436
 
436
437
 
437
438
  <td class="type">
438
439
 
439
440
 
440
- <span class="param-type">string</span>
441
+ <span class="param-type">String</span>
441
442
 
442
443
 
443
444
 
@@ -447,20 +448,20 @@ This is the public version of the internal variable _identifier.index, which con
447
448
 
448
449
 
449
450
 
450
- <td class="description last"></td>
451
+ <td class="description last"><p>name of the group that should be added</p></td>
451
452
  </tr>
452
453
 
453
454
 
454
455
 
455
456
  <tr>
456
457
 
457
- <td class="name"><code>regexWithOneNumberGroup</code></td>
458
+ <td class="name"><code>describedEntry</code></td>
458
459
 
459
460
 
460
461
  <td class="type">
461
462
 
462
463
 
463
- <span class="param-type">RegExp</span>
464
+ <span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
464
465
 
465
466
 
466
467
 
@@ -470,7 +471,7 @@ This is the public version of the internal variable _identifier.index, which con
470
471
 
471
472
 
472
473
 
473
- <td class="description last"></td>
474
+ <td class="description last"><p>entry that should be added to the group</p></td>
474
475
  </tr>
475
476
 
476
477
 
@@ -511,7 +512,7 @@ This is the public version of the internal variable _identifier.index, which con
511
512
 
512
513
  <dt class="tag-source">Source:</dt>
513
514
  <dd class="tag-source"><ul class="dummy"><li>
514
- <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line608">line 608</a>
515
+ <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line558">line 558</a>
515
516
  </li></ul></dd>
516
517
 
517
518
 
@@ -536,28 +537,6 @@ This is the public version of the internal variable _identifier.index, which con
536
537
 
537
538
 
538
539
 
539
- <h5>Returns:</h5>
540
-
541
-
542
- <div class="param-desc">
543
- <p>extracted indices in different representations</p>
544
- </div>
545
-
546
-
547
-
548
- <dl>
549
- <dt>
550
- Type
551
- </dt>
552
- <dd>
553
-
554
- <span class="param-type"><a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a></span>
555
-
556
-
557
- </dd>
558
- </dl>
559
-
560
-
561
540
 
562
541
 
563
542
 
@@ -569,7 +548,7 @@ This is the public version of the internal variable _identifier.index, which con
569
548
 
570
549
 
571
550
 
572
- <h4 class="name" id="addGroupEntries"><span class="type-signature"></span>addGroupEntries<span class="signature">(groupName, describedEntries)</span><span class="type-signature"></span></h4>
551
+ <h4 class="name" id=".indicesOf"><span class="type-signature">(protected, static) </span>indicesOf<span class="signature">(fullPropertyName)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a>}</span></h4>
573
552
 
574
553
 
575
554
 
@@ -577,7 +556,7 @@ This is the public version of the internal variable _identifier.index, which con
577
556
 
578
557
 
579
558
  <div class="description">
580
- <p>Adds entries to the given group. If the group does not exist, it will be created.</p>
559
+ <p>Returns &quot;1.12.123&quot; and [1,12,123] for &quot;results[1].hits.hits[12].aggregates[123]&quot;.</p>
581
560
  </div>
582
561
 
583
562
 
@@ -613,7 +592,7 @@ This is the public version of the internal variable _identifier.index, which con
613
592
 
614
593
  <tr>
615
594
 
616
- <td class="name"><code>groupName</code></td>
595
+ <td class="name"><code>fullPropertyName</code></td>
617
596
 
618
597
 
619
598
  <td class="type">
@@ -629,29 +608,6 @@ This is the public version of the internal variable _identifier.index, which con
629
608
 
630
609
 
631
610
 
632
- <td class="description last"></td>
633
- </tr>
634
-
635
-
636
-
637
- <tr>
638
-
639
- <td class="name"><code>describedEntries</code></td>
640
-
641
-
642
- <td class="type">
643
-
644
-
645
- <span class="param-type">Array.&lt;<a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a>></span>
646
-
647
-
648
-
649
- </td>
650
-
651
-
652
-
653
-
654
-
655
611
  <td class="description last"></td>
656
612
  </tr>
657
613
 
@@ -693,7 +649,7 @@ This is the public version of the internal variable _identifier.index, which con
693
649
 
694
650
  <dt class="tag-source">Source:</dt>
695
651
  <dd class="tag-source"><ul class="dummy"><li>
696
- <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line567">line 567</a>
652
+ <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line594">line 594</a>
697
653
  </li></ul></dd>
698
654
 
699
655
 
@@ -718,6 +674,28 @@ This is the public version of the internal variable _identifier.index, which con
718
674
 
719
675
 
720
676
 
677
+ <h5>Returns:</h5>
678
+
679
+
680
+ <div class="param-desc">
681
+ <p>extracted indices in different representations</p>
682
+ </div>
683
+
684
+
685
+
686
+ <dl>
687
+ <dt>
688
+ Type
689
+ </dt>
690
+ <dd>
691
+
692
+ <span class="param-type"><a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a></span>
693
+
694
+
695
+ </dd>
696
+ </dl>
697
+
698
+
721
699
 
722
700
 
723
701
 
@@ -729,7 +707,7 @@ This is the public version of the internal variable _identifier.index, which con
729
707
 
730
708
 
731
709
 
732
- <h4 class="name" id="addGroupEntry"><span class="type-signature"></span>addGroupEntry<span class="signature">(groupName, describedEntry)</span><span class="type-signature"></span></h4>
710
+ <h4 class="name" id=".indicesOfWithRegex"><span class="type-signature">(protected, static) </span>indicesOfWithRegex<span class="signature">(fullPropertyName, regexWithOneNumberGroup)</span><span class="type-signature"> &rarr; {<a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a>}</span></h4>
733
711
 
734
712
 
735
713
 
@@ -737,7 +715,7 @@ This is the public version of the internal variable _identifier.index, which con
737
715
 
738
716
 
739
717
  <div class="description">
740
- <p>Adds an entry to the given group. If the group does not exist, it will be created.</p>
718
+ <p>Returns &quot;1.12.123&quot; and [1,12,123] for &quot;results[1].hits.hits[12].aggregates[123]&quot;.</p>
741
719
  </div>
742
720
 
743
721
 
@@ -773,13 +751,13 @@ This is the public version of the internal variable _identifier.index, which con
773
751
 
774
752
  <tr>
775
753
 
776
- <td class="name"><code>groupName</code></td>
754
+ <td class="name"><code>fullPropertyName</code></td>
777
755
 
778
756
 
779
757
  <td class="type">
780
758
 
781
759
 
782
- <span class="param-type">String</span>
760
+ <span class="param-type">string</span>
783
761
 
784
762
 
785
763
 
@@ -789,20 +767,20 @@ This is the public version of the internal variable _identifier.index, which con
789
767
 
790
768
 
791
769
 
792
- <td class="description last"><p>name of the group that should be added</p></td>
770
+ <td class="description last"></td>
793
771
  </tr>
794
772
 
795
773
 
796
774
 
797
775
  <tr>
798
776
 
799
- <td class="name"><code>describedEntry</code></td>
777
+ <td class="name"><code>regexWithOneNumberGroup</code></td>
800
778
 
801
779
 
802
780
  <td class="type">
803
781
 
804
782
 
805
- <span class="param-type"><a href="module-datarestructor.html#.DescribedEntry">module:datarestructor.DescribedEntry</a></span>
783
+ <span class="param-type">RegExp</span>
806
784
 
807
785
 
808
786
 
@@ -812,7 +790,7 @@ This is the public version of the internal variable _identifier.index, which con
812
790
 
813
791
 
814
792
 
815
- <td class="description last"><p>entry that should be added to the group</p></td>
793
+ <td class="description last"></td>
816
794
  </tr>
817
795
 
818
796
 
@@ -853,7 +831,7 @@ This is the public version of the internal variable _identifier.index, which con
853
831
 
854
832
  <dt class="tag-source">Source:</dt>
855
833
  <dd class="tag-source"><ul class="dummy"><li>
856
- <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line558">line 558</a>
834
+ <a href="datarestructor.js.html">datarestructor.js</a>, <a href="datarestructor.js.html#line608">line 608</a>
857
835
  </li></ul></dd>
858
836
 
859
837
 
@@ -878,6 +856,28 @@ This is the public version of the internal variable _identifier.index, which con
878
856
 
879
857
 
880
858
 
859
+ <h5>Returns:</h5>
860
+
861
+
862
+ <div class="param-desc">
863
+ <p>extracted indices in different representations</p>
864
+ </div>
865
+
866
+
867
+
868
+ <dl>
869
+ <dt>
870
+ Type
871
+ </dt>
872
+ <dd>
873
+
874
+ <span class="param-type"><a href="module-datarestructor.html#.ExtractedIndices">module:datarestructor.ExtractedIndices</a></span>
875
+
876
+
877
+ </dd>
878
+ </dl>
879
+
880
+
881
881
 
882
882
 
883
883
 
@@ -905,7 +905,7 @@ This is the public version of the internal variable _identifier.index, which con
905
905
  <br class="clear">
906
906
 
907
907
  <footer>
908
- 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)
908
+ 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)
909
909
  </footer>
910
910
 
911
911
  <script> prettyPrint(); </script>
@@ -2948,7 +2948,7 @@ starts with the &quot;propertyPattern&quot;.</p>
2948
2948
  <br class="clear">
2949
2949
 
2950
2950
  <footer>
2951
- 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)
2951
+ 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)
2952
2952
  </footer>
2953
2953
 
2954
2954
  <script> prettyPrint(); </script>
@@ -339,7 +339,7 @@ var result = datarestructor.Restructor.processJsonUsingDescriptions(jsonData, al
339
339
  <br class="clear">
340
340
 
341
341
  <footer>
342
- 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)
342
+ 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)
343
343
  </footer>
344
344
 
345
345
  <script> prettyPrint(); </script>