@qrvey/utils 1.1.2 → 1.1.6

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 (128) hide show
  1. package/README.md +196 -143
  2. package/dist/cjs/constants/COLUMN_PROPERTY_VALUE.js +1 -1
  3. package/dist/cjs/date/constants/DATE_VALUES.js +1 -1
  4. package/dist/cjs/filters/adapters/FDToFlatUI.js +2 -1
  5. package/dist/cjs/filters/adapters/FDToUI.js +2 -1
  6. package/dist/cjs/filters/adapters/UIToFlatUI.js +2 -1
  7. package/dist/cjs/filters/adapters/UIToOldLogic.js +2 -1
  8. package/dist/cjs/filters/adapters/adaptFilterValues.d.ts +8 -0
  9. package/dist/cjs/filters/adapters/adaptFilterValues.js +18 -0
  10. package/dist/cjs/filters/adapters/flatUIToFD.js +2 -1
  11. package/dist/cjs/filters/adapters/flatUIToUI.js +2 -1
  12. package/dist/cjs/filters/adapters/logicToFlatUI.js +0 -3
  13. package/dist/cjs/filters/helpers/common/getFilterColumnLabel.js +1 -1
  14. package/dist/cjs/filters/helpers/common/getFiltersByParams.js +1 -1
  15. package/dist/cjs/filters/helpers/ui/getFilterPropertyLabel.d.ts +7 -0
  16. package/dist/cjs/filters/helpers/ui/getFilterPropertyLabel.js +13 -0
  17. package/dist/cjs/filters/helpers/ui/index.d.ts +1 -0
  18. package/dist/cjs/filters/helpers/ui/index.js +1 -0
  19. package/dist/cjs/filters/interfaces/common/IFSValueRelativeDate.d.ts +1 -1
  20. package/dist/cjs/general/array/filterNestedTree.d.ts +5 -2
  21. package/dist/cjs/general/array/filterNestedTree.js +13 -5
  22. package/dist/cjs/general/mix/isEmpty.js +3 -1
  23. package/dist/cjs/general/mix/isNull.js +1 -1
  24. package/dist/cjs/general/mix/randomId.d.ts +6 -3
  25. package/dist/cjs/general/mix/randomId.js +24 -7
  26. package/dist/cjs/general/mix/size.d.ts +5 -5
  27. package/dist/cjs/general/mix/size.js +9 -6
  28. package/dist/cjs/general/object/get.d.ts +1 -1
  29. package/dist/cjs/general/object/getAttribute.d.ts +9 -2
  30. package/dist/cjs/general/object/getAttribute.js +39 -8
  31. package/dist/cjs/general/object/hasProperty.d.ts +1 -1
  32. package/dist/cjs/general/object/hasProperty.js +10 -2
  33. package/dist/cjs/general/object/index.d.ts +1 -0
  34. package/dist/cjs/general/object/index.js +1 -0
  35. package/dist/cjs/general/object/isObject.js +1 -1
  36. package/dist/cjs/general/object/objectCopy.d.ts +7 -0
  37. package/dist/cjs/general/object/objectCopy.js +32 -0
  38. package/dist/cjs/general/string/capitalize.d.ts +3 -3
  39. package/dist/cjs/general/string/capitalize.js +6 -3
  40. package/dist/cjs/qrvey/getPropertyLabel.d.ts +2 -0
  41. package/dist/cjs/qrvey/getPropertyLabel.js +14 -0
  42. package/dist/cjs/qrvey/index.d.ts +1 -0
  43. package/dist/cjs/qrvey/index.js +1 -0
  44. package/dist/constants/COLUMN_PROPERTY_VALUE.js +2 -2
  45. package/dist/date/constants/DATE_VALUES.js +1 -1
  46. package/dist/filters/adapters/FDToFlatUI.js +2 -1
  47. package/dist/filters/adapters/FDToUI.js +2 -1
  48. package/dist/filters/adapters/UIToFlatUI.js +2 -1
  49. package/dist/filters/adapters/UIToOldLogic.js +2 -1
  50. package/dist/filters/adapters/adaptFilterValues.d.ts +8 -0
  51. package/dist/filters/adapters/adaptFilterValues.js +14 -0
  52. package/dist/filters/adapters/flatUIToFD.js +2 -1
  53. package/dist/filters/adapters/flatUIToUI.js +2 -1
  54. package/dist/filters/adapters/logicToFlatUI.js +0 -3
  55. package/dist/filters/helpers/common/getFilterColumnLabel.js +2 -2
  56. package/dist/filters/helpers/common/getFiltersByParams.js +1 -1
  57. package/dist/filters/helpers/ui/getFilterPropertyLabel.d.ts +7 -0
  58. package/dist/filters/helpers/ui/getFilterPropertyLabel.js +9 -0
  59. package/dist/filters/helpers/ui/index.d.ts +1 -0
  60. package/dist/filters/helpers/ui/index.js +1 -0
  61. package/dist/filters/interfaces/common/IFSValueRelativeDate.d.ts +1 -1
  62. package/dist/general/array/filterNestedTree.d.ts +5 -2
  63. package/dist/general/array/filterNestedTree.js +13 -5
  64. package/dist/general/mix/isEmpty.js +3 -1
  65. package/dist/general/mix/isNull.js +1 -1
  66. package/dist/general/mix/randomId.d.ts +6 -3
  67. package/dist/general/mix/randomId.js +24 -7
  68. package/dist/general/mix/size.d.ts +5 -5
  69. package/dist/general/mix/size.js +9 -6
  70. package/dist/general/object/get.d.ts +1 -1
  71. package/dist/general/object/getAttribute.d.ts +9 -2
  72. package/dist/general/object/getAttribute.js +39 -8
  73. package/dist/general/object/hasProperty.d.ts +1 -1
  74. package/dist/general/object/hasProperty.js +8 -0
  75. package/dist/general/object/index.d.ts +1 -0
  76. package/dist/general/object/index.js +1 -0
  77. package/dist/general/object/isObject.js +1 -1
  78. package/dist/general/object/objectCopy.d.ts +7 -0
  79. package/dist/general/object/objectCopy.js +28 -0
  80. package/dist/general/string/capitalize.d.ts +3 -3
  81. package/dist/general/string/capitalize.js +6 -3
  82. package/dist/qrvey/getPropertyLabel.d.ts +2 -0
  83. package/dist/qrvey/getPropertyLabel.js +10 -0
  84. package/dist/qrvey/index.d.ts +1 -0
  85. package/dist/qrvey/index.js +1 -0
  86. package/package.json +1 -1
  87. package/src/constants/COLUMN_PROPERTY_VALUE.ts +2 -2
  88. package/src/date/constants/DATE_VALUES.ts +1 -1
  89. package/src/filters/adapters/FDToFlatUI.ts +2 -1
  90. package/src/filters/adapters/FDToUI.ts +2 -0
  91. package/src/filters/adapters/UIToFlatUI.ts +2 -1
  92. package/src/filters/adapters/UIToOldLogic.ts +2 -1
  93. package/src/filters/adapters/adaptFilterValues.ts +17 -0
  94. package/src/filters/adapters/flatUIToFD.ts +2 -1
  95. package/src/filters/adapters/flatUIToUI.ts +2 -1
  96. package/src/filters/adapters/logicToFlatUI.ts +0 -3
  97. package/src/filters/helpers/backend/getAggFiltersBySummaryIndex.ts +1 -1
  98. package/src/filters/helpers/common/getFilterColumnLabel.ts +2 -2
  99. package/src/filters/helpers/common/getFiltersByParams.ts +1 -1
  100. package/src/filters/helpers/ui/getFilterPropertyLabel.ts +11 -0
  101. package/src/filters/helpers/ui/index.ts +1 -0
  102. package/src/filters/interfaces/common/IFSValueRelativeDate.ts +1 -1
  103. package/src/general/array/filterNestedTree.ts +13 -4
  104. package/src/general/mix/getTag.ts +1 -1
  105. package/src/general/mix/isEmpty.ts +3 -1
  106. package/src/general/mix/isNull.ts +1 -1
  107. package/src/general/mix/randomId.ts +24 -7
  108. package/src/general/mix/size.ts +10 -6
  109. package/src/general/object/get.ts +1 -1
  110. package/src/general/object/getAttribute.ts +47 -9
  111. package/src/general/object/hasProperty.ts +10 -1
  112. package/src/general/object/index.ts +1 -0
  113. package/src/general/object/isObject.ts +1 -1
  114. package/src/general/object/objectCopy.ts +35 -0
  115. package/src/general/string/capitalize.ts +7 -3
  116. package/src/qrvey/getPropertyLabel.ts +9 -0
  117. package/src/qrvey/index.ts +1 -0
  118. package/test/general/array/filterNestedTree.test.js +115 -0
  119. package/test/general/mix/getTag.test.js +101 -0
  120. package/test/general/mix/isEmpty.test.js +24 -24
  121. package/test/general/mix/isNull.test.js +72 -0
  122. package/test/general/mix/randomId.test.js +134 -0
  123. package/test/general/mix/size.test.js +87 -0
  124. package/test/general/object/cloneDeep.test.js +8 -16
  125. package/test/general/object/getAttribute.test.js +316 -0
  126. package/test/general/object/hasProperty.test.js +103 -0
  127. package/test/general/object/objectCopy.test.js +105 -0
  128. package/test/general/string/capitalize.test.js +87 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.1.2*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.1.6*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -422,6 +422,34 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
422
422
 
423
423
 
424
424
 
425
+ ### dist/filters/adapters/adaptFilterValues.js
426
+
427
+
428
+ #### adaptFilterValues(filter)
429
+
430
+ [TODO: For 2022, eliminate this adapter]
431
+ Gets an adapted filter value array. Validates the enabled property and sets
432
+
433
+
434
+
435
+
436
+ ##### Parameters
437
+
438
+ | Name | Type | Description | |
439
+ | ---- | ---- | ----------- | -------- |
440
+ | filter | | The filter |   |
441
+
442
+
443
+
444
+
445
+ ##### Returns
446
+
447
+
448
+ - A new value array with the filled properties.
449
+
450
+
451
+
452
+
425
453
  ### dist/filters/adapters/flatUIToFD.js
426
454
 
427
455
 
@@ -1311,12 +1339,12 @@ Output:
1311
1339
 
1312
1340
 
1313
1341
 
1314
- ### dist/general/function/debounce.js
1342
+ ### dist/general/array/delete.js
1315
1343
 
1316
1344
 
1317
- #### debounce(fn, time)
1345
+ #### ArrayDelete(array, index)
1318
1346
 
1319
- Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
1347
+ Inmutable Array Item deletion
1320
1348
 
1321
1349
 
1322
1350
 
@@ -1325,8 +1353,8 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
1325
1353
 
1326
1354
  | Name | Type | Description | |
1327
1355
  | ---- | ---- | ----------- | -------- |
1328
- | fn | `Function` | original Function |   |
1329
- | time | `Number` | default 500ms |   |
1356
+ | array | `Array` | a collection of items to delete |   |
1357
+ | index | `Number` | the position of the item to delete |   |
1330
1358
 
1331
1359
 
1332
1360
 
@@ -1334,17 +1362,20 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
1334
1362
  ##### Returns
1335
1363
 
1336
1364
 
1337
- - `Function` debounced functions
1365
+ - a new Array or the given parameter when is empty or not an array
1338
1366
 
1339
1367
 
1340
1368
 
1341
1369
 
1342
- ### dist/general/function/throttled.js
1370
+ ### dist/general/array/filterNestedTree.js
1343
1371
 
1344
1372
 
1345
- #### throttled(fn, time)
1373
+ #### filterNestedTree(arr, childArrKey, condition)
1346
1374
 
1347
- Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1375
+ Filters a nested tree array by a custom condition on the last child node
1376
+ - If the given arguments are not valid, the function returns the first argument.
1377
+ - If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
1378
+ - If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
1348
1379
 
1349
1380
 
1350
1381
 
@@ -1353,8 +1384,9 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1353
1384
 
1354
1385
  | Name | Type | Description | |
1355
1386
  | ---- | ---- | ----------- | -------- |
1356
- | fn | `Function` | original Function |   |
1357
- | time | `Number` | default 500ms |   |
1387
+ | arr | | nested tree array |   |
1388
+ | childArrKey | | property representing the children array on the nested tree |   |
1389
+ | condition | | function callback that determines if the filter is applied on the last child node of the nested tree |   |
1358
1390
 
1359
1391
 
1360
1392
 
@@ -1362,17 +1394,17 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1362
1394
  ##### Returns
1363
1395
 
1364
1396
 
1365
- - `Function` throttled function
1397
+ - array filtered
1366
1398
 
1367
1399
 
1368
1400
 
1369
1401
 
1370
- ### dist/general/array/delete.js
1402
+ ### dist/general/array/flattenDeep.js
1371
1403
 
1372
1404
 
1373
- #### ArrayDelete(array, index)
1405
+ #### flattenDeep(arr)
1374
1406
 
1375
- Inmutable Array Item deletion
1407
+ Flat deeply an array
1376
1408
 
1377
1409
 
1378
1410
 
@@ -1381,8 +1413,7 @@ Inmutable Array Item deletion
1381
1413
 
1382
1414
  | Name | Type | Description | |
1383
1415
  | ---- | ---- | ----------- | -------- |
1384
- | array | `Array` | a collection of items to delete |   |
1385
- | index | `Number` | the position of the item to delete |   |
1416
+ | arr | | Array to flat deeply |   |
1386
1417
 
1387
1418
 
1388
1419
 
@@ -1390,17 +1421,17 @@ Inmutable Array Item deletion
1390
1421
  ##### Returns
1391
1422
 
1392
1423
 
1393
- - a new Array or the given parameter when is empty or not an array
1424
+ - flatten array
1394
1425
 
1395
1426
 
1396
1427
 
1397
1428
 
1398
- ### dist/general/array/filterNestedTree.js
1429
+ ### dist/general/array/getFirstIndexFromArray.js
1399
1430
 
1400
1431
 
1401
- #### filterNestedTree(arr, childArrKey, condition)
1432
+ #### getFirstIndexFromArray(array, callback)
1402
1433
 
1403
- Filters a nested tree array by a custom condition on the las child node
1434
+ Gets the first index from the array by a callback condition
1404
1435
 
1405
1436
 
1406
1437
 
@@ -1409,9 +1440,8 @@ Filters a nested tree array by a custom condition on the las child node
1409
1440
 
1410
1441
  | Name | Type | Description | |
1411
1442
  | ---- | ---- | ----------- | -------- |
1412
- | arr | | nested tree array |   |
1413
- | childArrKey | | property representing the children array on the nested tree |   |
1414
- | condition | | function callback that determines if the filter is applied on the last child node of the nested tree |   |
1443
+ | array | | |   |
1444
+ | callback | | function callback |   |
1415
1445
 
1416
1446
 
1417
1447
 
@@ -1419,17 +1449,17 @@ Filters a nested tree array by a custom condition on the las child node
1419
1449
  ##### Returns
1420
1450
 
1421
1451
 
1422
- - array filtered
1452
+ - the first index of the array. -1 when the condition is not satisfied
1423
1453
 
1424
1454
 
1425
1455
 
1426
1456
 
1427
- ### dist/general/array/flattenDeep.js
1457
+ ### dist/general/array/getLastIndexFromArray.js
1428
1458
 
1429
1459
 
1430
- #### flattenDeep(arr)
1460
+ #### getLastIndexFromArray(array, callback)
1431
1461
 
1432
- Flat deeply an array
1462
+ Gets the last index from the array by a callback condition
1433
1463
 
1434
1464
 
1435
1465
 
@@ -1438,7 +1468,8 @@ Flat deeply an array
1438
1468
 
1439
1469
  | Name | Type | Description | |
1440
1470
  | ---- | ---- | ----------- | -------- |
1441
- | arr | | Array to flat deeply |   |
1471
+ | array | | |   |
1472
+ | callback | | function callback |   |
1442
1473
 
1443
1474
 
1444
1475
 
@@ -1446,17 +1477,17 @@ Flat deeply an array
1446
1477
  ##### Returns
1447
1478
 
1448
1479
 
1449
- - flatten array
1480
+ - the last index of the array. -1 when the condition is not satisfied
1450
1481
 
1451
1482
 
1452
1483
 
1453
1484
 
1454
- ### dist/general/array/getFirstIndexFromArray.js
1485
+ ### dist/general/function/debounce.js
1455
1486
 
1456
1487
 
1457
- #### getFirstIndexFromArray(array, callback)
1488
+ #### debounce(fn, time)
1458
1489
 
1459
- Gets the first index from the array by a callback condition
1490
+ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
1460
1491
 
1461
1492
 
1462
1493
 
@@ -1465,8 +1496,8 @@ Gets the first index from the array by a callback condition
1465
1496
 
1466
1497
  | Name | Type | Description | |
1467
1498
  | ---- | ---- | ----------- | -------- |
1468
- | array | | |   |
1469
- | callback | | function callback |   |
1499
+ | fn | `Function` | original Function |   |
1500
+ | time | `Number` | default 500ms |   |
1470
1501
 
1471
1502
 
1472
1503
 
@@ -1474,17 +1505,17 @@ Gets the first index from the array by a callback condition
1474
1505
  ##### Returns
1475
1506
 
1476
1507
 
1477
- - the first index of the array. -1 when the condition is not satisfied
1508
+ - `Function` debounced functions
1478
1509
 
1479
1510
 
1480
1511
 
1481
1512
 
1482
- ### dist/general/array/getLastIndexFromArray.js
1513
+ ### dist/general/function/throttled.js
1483
1514
 
1484
1515
 
1485
- #### getLastIndexFromArray(array, callback)
1516
+ #### throttled(fn, time)
1486
1517
 
1487
- Gets the last index from the array by a callback condition
1518
+ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1488
1519
 
1489
1520
 
1490
1521
 
@@ -1493,8 +1524,8 @@ Gets the last index from the array by a callback condition
1493
1524
 
1494
1525
  | Name | Type | Description | |
1495
1526
  | ---- | ---- | ----------- | -------- |
1496
- | array | | |   |
1497
- | callback | | function callback |   |
1527
+ | fn | `Function` | original Function |   |
1528
+ | time | `Number` | default 500ms |   |
1498
1529
 
1499
1530
 
1500
1531
 
@@ -1502,7 +1533,7 @@ Gets the last index from the array by a callback condition
1502
1533
  ##### Returns
1503
1534
 
1504
1535
 
1505
- - the last index of the array. -1 when the condition is not satisfied
1536
+ - `Function` throttled function
1506
1537
 
1507
1538
 
1508
1539
 
@@ -1678,9 +1709,11 @@ useful to avoid falsify validating Number Zero (0)
1678
1709
  ### dist/general/mix/randomId.js
1679
1710
 
1680
1711
 
1681
- #### randomId(length)
1712
+ #### randomId(length, exclude)
1682
1713
 
1683
- create random unique string
1714
+ Creates a random string
1715
+ - If the first given argument is different than a length number, the variable is replaced by a default number
1716
+ - If the optional second given argument is passed the random string is permutated.
1684
1717
 
1685
1718
 
1686
1719
 
@@ -1690,6 +1723,7 @@ create random unique string
1690
1723
  | Name | Type | Description | |
1691
1724
  | ---- | ---- | ----------- | -------- |
1692
1725
  | length | `Number` | size of the generated string. Default 8 |   |
1726
+ | exclude | `Array` | collection of strings that is going to be excluded of the random string. |   |
1693
1727
 
1694
1728
 
1695
1729
 
@@ -1697,7 +1731,7 @@ create random unique string
1697
1731
  ##### Returns
1698
1732
 
1699
1733
 
1700
- - `String`
1734
+ - `String` Random string
1701
1735
 
1702
1736
 
1703
1737
 
@@ -1707,9 +1741,9 @@ create random unique string
1707
1741
 
1708
1742
  #### size(obj)
1709
1743
 
1710
- get the length of an Array or String and also the number of first level attributes
1711
- in an Object.
1712
- For `null` or `undefined` argument the returned value will be 0.
1744
+ Gets the length of the given array.
1745
+ - Useful for Object, Array and string type.
1746
+ - For `null` or `undefined` or else argument the returned value will be 0.
1713
1747
 
1714
1748
 
1715
1749
 
@@ -1718,7 +1752,7 @@ For `null` or `undefined` argument the returned value will be 0.
1718
1752
 
1719
1753
  | Name | Type | Description | |
1720
1754
  | ---- | ---- | ----------- | -------- |
1721
- | obj | `Any` | |   |
1755
+ | obj | `Any` | Any object-type variable |   |
1722
1756
 
1723
1757
 
1724
1758
 
@@ -1726,7 +1760,7 @@ For `null` or `undefined` argument the returned value will be 0.
1726
1760
  ##### Returns
1727
1761
 
1728
1762
 
1729
- - `Number`
1763
+ - `Number` the size of the given variable
1730
1764
 
1731
1765
 
1732
1766
 
@@ -1816,42 +1850,6 @@ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
1816
1850
 
1817
1851
 
1818
1852
 
1819
- ### dist/general/object/getAttribute.js
1820
-
1821
-
1822
- #### getAttribute(obj, key)
1823
-
1824
- search for properties in different case styles such as: lower, upper, camel and pascal
1825
- But for this, is required ask for a property in snake_case style
1826
-
1827
-
1828
-
1829
-
1830
- ##### Parameters
1831
-
1832
- | Name | Type | Description | |
1833
- | ---- | ---- | ----------- | -------- |
1834
- | obj | `object` | object to look for |   |
1835
- | key | `string` | String attribute in snake_case style |   |
1836
-
1837
-
1838
-
1839
-
1840
- ##### Examples
1841
-
1842
- ```javascript
1843
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
1844
- ```
1845
-
1846
-
1847
- ##### Returns
1848
-
1849
-
1850
- - `Void`
1851
-
1852
-
1853
-
1854
-
1855
1853
  ### dist/general/object/hasProperty.js
1856
1854
 
1857
1855
 
@@ -1948,6 +1946,34 @@ and return a mapped object
1948
1946
 
1949
1947
 
1950
1948
 
1949
+ ### dist/general/object/objectCopy.js
1950
+
1951
+
1952
+ #### objectCopy(entity, cache)
1953
+
1954
+ Created a new reference of the given argument
1955
+
1956
+
1957
+
1958
+
1959
+ ##### Parameters
1960
+
1961
+ | Name | Type | Description | |
1962
+ | ---- | ---- | ----------- | -------- |
1963
+ | entity | | The variable to be copied |   |
1964
+ | cache | | |   |
1965
+
1966
+
1967
+
1968
+
1969
+ ##### Returns
1970
+
1971
+
1972
+ - A new reference of the given argument
1973
+
1974
+
1975
+
1976
+
1951
1977
  ### dist/general/object/omit.js
1952
1978
 
1953
1979
 
@@ -2009,7 +2035,7 @@ return a new object just with attributes in _keys_ list
2009
2035
 
2010
2036
  #### capitalize(text)
2011
2037
 
2012
- Upper case teh first letter of a given text
2038
+ Upper case the first letter of a given text
2013
2039
 
2014
2040
 
2015
2041
 
@@ -2026,34 +2052,28 @@ Upper case teh first letter of a given text
2026
2052
  ##### Returns
2027
2053
 
2028
2054
 
2029
- - `String`
2055
+ - `String` a capitalized text
2030
2056
 
2031
2057
 
2032
2058
 
2033
2059
 
2034
- ### dist/stencil/decorators/Config.js
2035
-
2060
+ ### dist/typescript/decorators/Debounce.js
2036
2061
 
2037
- #### Config()
2038
2062
 
2039
- Stencil.js - Prop Decorator
2040
- Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2041
- But for this, is required ask for a property in `snake_case` style
2063
+ #### Debounce(time)
2042
2064
 
2065
+ (Method Decorator) Debounce Class Method
2043
2066
 
2044
2067
 
2045
2068
 
2046
2069
 
2070
+ ##### Parameters
2047
2071
 
2048
- ##### Examples
2072
+ | Name | Type | Description | |
2073
+ | ---- | ---- | ----------- | -------- |
2074
+ | time | | (optional) deafult 500 |   |
2049
2075
 
2050
- ```javascript
2051
- \ @Config() @Prop() settings;
2052
2076
 
2053
- someMethod() {
2054
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2055
- }
2056
- ```
2057
2077
 
2058
2078
 
2059
2079
  ##### Returns
@@ -2064,72 +2084,74 @@ someMethod() {
2064
2084
 
2065
2085
 
2066
2086
 
2067
- ### dist/stencil/util/createRef.js
2087
+ ### dist/typescript/decorators/Throttled.js
2068
2088
 
2069
2089
 
2070
- #### createRef()
2090
+ #### Throttled(time)
2071
2091
 
2072
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2092
+ (Method Decorator) Throttled Class Method
2073
2093
 
2074
2094
 
2075
2095
 
2076
2096
 
2097
+ ##### Parameters
2077
2098
 
2099
+ | Name | Type | Description | |
2100
+ | ---- | ---- | ----------- | -------- |
2101
+ | time | | (optional) deafult 500 |   |
2078
2102
 
2079
- ##### Returns
2080
2103
 
2081
2104
 
2082
- - function - Function to use in ref prop in html elements
2083
2105
 
2106
+ ##### Returns
2084
2107
 
2085
2108
 
2109
+ - `Void`
2086
2110
 
2087
- ### dist/stencil/util/getConfig.js
2088
2111
 
2089
2112
 
2090
- #### getConfig(cfg)
2091
2113
 
2092
- verify the Config object type and try to return a parsed Object
2093
- - In case _cfg_ is a string, first try to make a JSON parse in other case
2094
- try to find this string as a variable on Windows object
2095
- - If _cfg_ is a fuction, tis is invoked and parsed
2096
- - Finally, if is an object, _cfg_ is inmediatly returned
2114
+ ### dist/stencil/decorators/Config.js
2097
2115
 
2098
2116
 
2117
+ #### Config()
2099
2118
 
2119
+ Stencil.js - Prop Decorator
2120
+ Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
2121
+ But for this, is required ask for a property in `snake_case` style
2100
2122
 
2101
- ##### Parameters
2102
2123
 
2103
- | Name | Type | Description | |
2104
- | ---- | ---- | ----------- | -------- |
2105
- | cfg | | |   |
2106
2124
 
2107
2125
 
2108
2126
 
2109
2127
 
2110
- ##### Returns
2128
+ ##### Examples
2111
2129
 
2130
+ ```javascript
2131
+ \ @Config() @Prop() settings;
2112
2132
 
2113
- - `Void`
2133
+ someMethod() {
2134
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2135
+ }
2136
+ ```
2114
2137
 
2115
2138
 
2139
+ ##### Returns
2116
2140
 
2117
2141
 
2118
- ### dist/typescript/decorators/Debounce.js
2142
+ - `Void`
2119
2143
 
2120
2144
 
2121
- #### Debounce(time)
2122
2145
 
2123
- (Method Decorator) Debounce Class Method
2124
2146
 
2147
+ ### dist/stencil/util/createRef.js
2125
2148
 
2126
2149
 
2150
+ #### createRef()
2151
+
2152
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2127
2153
 
2128
- ##### Parameters
2129
2154
 
2130
- | Name | Type | Description | |
2131
- | ---- | ---- | ----------- | -------- |
2132
- | time | | (optional) deafult 500 |   |
2133
2155
 
2134
2156
 
2135
2157
 
@@ -2137,17 +2159,21 @@ try to find this string as a variable on Windows object
2137
2159
  ##### Returns
2138
2160
 
2139
2161
 
2140
- - `Void`
2162
+ - function - Function to use in ref prop in html elements
2141
2163
 
2142
2164
 
2143
2165
 
2144
2166
 
2145
- ### dist/typescript/decorators/Throttled.js
2167
+ ### dist/stencil/util/getConfig.js
2146
2168
 
2147
2169
 
2148
- #### Throttled(time)
2170
+ #### getConfig(cfg)
2149
2171
 
2150
- (Method Decorator) Throttled Class Method
2172
+ verify the Config object type and try to return a parsed Object
2173
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2174
+ try to find this string as a variable on Windows object
2175
+ - If _cfg_ is a fuction, tis is invoked and parsed
2176
+ - Finally, if is an object, _cfg_ is inmediatly returned
2151
2177
 
2152
2178
 
2153
2179
 
@@ -2156,7 +2182,7 @@ try to find this string as a variable on Windows object
2156
2182
 
2157
2183
  | Name | Type | Description | |
2158
2184
  | ---- | ---- | ----------- | -------- |
2159
- | time | | (optional) deafult 500 |   |
2185
+ | cfg | | |   |
2160
2186
 
2161
2187
 
2162
2188
 
@@ -2612,12 +2638,12 @@ The validation to filter the stored filter is depending on:
2612
2638
 
2613
2639
 
2614
2640
 
2615
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
2641
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
2616
2642
 
2617
2643
 
2618
- #### excludeFiltersByScopes(filterData, scopes)
2644
+ #### getFilterColumnLabel(column)
2619
2645
 
2620
- Excludes and returns a filter data without filters by the given scopes
2646
+ Get an string of the properties of the given filter column.
2621
2647
 
2622
2648
 
2623
2649
 
@@ -2626,8 +2652,7 @@ Excludes and returns a filter data without filters by the given scopes
2626
2652
 
2627
2653
  | Name | Type | Description | |
2628
2654
  | ---- | ---- | ----------- | -------- |
2629
- | filterData | | The Filter Data |   |
2630
- | scopes | | collection of scopes to be as filtering parameters |   |
2655
+ | column | | The filter column |   |
2631
2656
 
2632
2657
 
2633
2658
 
@@ -2635,17 +2660,17 @@ Excludes and returns a filter data without filters by the given scopes
2635
2660
  ##### Returns
2636
2661
 
2637
2662
 
2638
- - The new Filter Data without filters by the given scopes.
2663
+ - an string with the property, aggregate or calculation label.
2639
2664
 
2640
2665
 
2641
2666
 
2642
2667
 
2643
- ### dist/filters/helpers/common/getFilterColumnLabel.js
2668
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
2644
2669
 
2645
2670
 
2646
- #### getFilterColumnLabel(column)
2671
+ #### excludeFiltersByScopes(filterData, scopes)
2647
2672
 
2648
- Get an string of the properties of the given filter column.
2673
+ Excludes and returns a filter data without filters by the given scopes
2649
2674
 
2650
2675
 
2651
2676
 
@@ -2654,7 +2679,8 @@ Get an string of the properties of the given filter column.
2654
2679
 
2655
2680
  | Name | Type | Description | |
2656
2681
  | ---- | ---- | ----------- | -------- |
2657
- | column | | The filter column |   |
2682
+ | filterData | | The Filter Data |   |
2683
+ | scopes | | collection of scopes to be as filtering parameters |   |
2658
2684
 
2659
2685
 
2660
2686
 
@@ -2662,7 +2688,7 @@ Get an string of the properties of the given filter column.
2662
2688
  ##### Returns
2663
2689
 
2664
2690
 
2665
- - an string with the property, aggregate or calculation label.
2691
+ - The new Filter Data without filters by the given scopes.
2666
2692
 
2667
2693
 
2668
2694
 
@@ -3371,6 +3397,33 @@ Excludes and returns a UI Flat Filters without filters by the given scopes
3371
3397
 
3372
3398
 
3373
3399
 
3400
+ ### dist/filters/helpers/ui/getFilterPropertyLabel.js
3401
+
3402
+
3403
+ #### getFilterPropertyLabel(filter)
3404
+
3405
+ Gets the label of the filter property
3406
+
3407
+
3408
+
3409
+
3410
+ ##### Parameters
3411
+
3412
+ | Name | Type | Description | |
3413
+ | ---- | ---- | ----------- | -------- |
3414
+ | filter | | The UI Filter |   |
3415
+
3416
+
3417
+
3418
+
3419
+ ##### Returns
3420
+
3421
+
3422
+ - a string of the filter property label
3423
+
3424
+
3425
+
3426
+
3374
3427
  ### dist/filters/helpers/ui/getOutputFormatByColumn.js
3375
3428
 
3376
3429
 
@@ -21,5 +21,5 @@ const C = {
21
21
  [COLUMN_1.COLUMN.EXPRESSION]: COLUMN_COMPLEX_VALUE_1.COLUMN_COMPLEX_VALUE.EXPRESSION.map(setTabStructure),
22
22
  [COLUMN_1.COLUMN.IMAGEUPLOAD]: COLUMN_COMPLEX_VALUE_1.COLUMN_COMPLEX_VALUE.IMAGEUPLOAD.map(setTabStructure),
23
23
  };
24
- C[COLUMN_1.COLUMN.DATE + '-complete'] = C[COLUMN_1.COLUMN.DATE].concat(date_1.DATE_P_VALUES).concat(date_1.DATE_TIME_P_VALUES);
24
+ C[COLUMN_1.COLUMN.DATE + '-complete'] = C[COLUMN_1.COLUMN.DATE].concat(date_1.DATE_TIME_VALUES).concat(date_1.DATE_P_VALUES).concat(date_1.DATE_TIME_P_VALUES);
25
25
  exports.COLUMN_PROPERTY_VALUE = C;