@qrvey/utils 1.2.9-0 → 1.2.9-4

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 (168) hide show
  1. package/README.md +291 -291
  2. package/dist/cjs/columns/constants/COLUMN_PROPERTY_LABEL.d.ts +1 -0
  3. package/dist/cjs/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.d.ts +1 -0
  4. package/dist/cjs/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.js +1 -0
  5. package/dist/cjs/filters/adapters/FDToFlatUI.js +0 -2
  6. package/dist/cjs/filters/adapters/FDToUI.js +1 -2
  7. package/dist/cjs/filters/adapters/UIToFD.js +0 -1
  8. package/dist/cjs/filters/adapters/UIToFlatUI.js +0 -2
  9. package/dist/cjs/filters/adapters/UIToOldLogic.js +1 -1
  10. package/dist/cjs/filters/adapters/flatUIToOldLogic.js +1 -1
  11. package/dist/cjs/filters/adapters/flatUIToUI.js +0 -2
  12. package/dist/cjs/filters/adapters/logicToFlatUI.js +0 -2
  13. package/dist/cjs/filters/helpers/ui/getUIValues.d.ts +2 -1
  14. package/dist/cjs/filters/helpers/ui/getUIValues.js +25 -12
  15. package/dist/cjs/filters/interfaces/ui/IFUFilter.d.ts +1 -1
  16. package/dist/cjs/filters/interfaces/ui/IFUUIValueSettings.d.ts +6 -0
  17. package/dist/cjs/{globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.js → filters/interfaces/ui/IFUUIValueSettings.js} +0 -0
  18. package/dist/cjs/filters/interfaces/ui/index.d.ts +1 -0
  19. package/dist/cjs/filters/interfaces/ui/index.js +1 -0
  20. package/dist/cjs/globalization/interfaces/bucket_builder/II18nBucketBuilderMessages.d.ts +2 -1
  21. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilder.d.ts +0 -14
  22. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderAggregatedFormulas.d.ts +2 -1
  23. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderRefernceLine.d.ts +9 -8
  24. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderShelfMenu.d.ts +1 -0
  25. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderSorting.d.ts +11 -9
  26. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderTrendChart.d.ts +14 -13
  27. package/dist/cjs/globalization/interfaces/chart_builder/index.d.ts +0 -7
  28. package/dist/cjs/globalization/interfaces/chart_builder/index.js +0 -7
  29. package/dist/cjs/globalization/interfaces/common/II18nColumnProperties.d.ts +1 -0
  30. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboard.d.ts +2 -0
  31. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardEmptyState.d.ts +5 -0
  32. package/dist/cjs/globalization/interfaces/{chart_builder/II18nChartBuilderComplexFile.js → dashboard/II18nDashboardEmptyState.js} +0 -0
  33. package/dist/cjs/globalization/interfaces/dashboard/index.d.ts +1 -0
  34. package/dist/cjs/globalization/interfaces/dashboard/index.js +1 -0
  35. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.d.ts +1 -0
  36. package/dist/cjs/globalization/interfaces/filters/II18nValueContainer.d.ts +1 -0
  37. package/dist/cjs/globalization/interfaces/panel/II18nPanelErrors.d.ts +11 -9
  38. package/dist/cjs/globalization/interfaces/panel/II18nPanelSummaryViews.d.ts +17 -9
  39. package/dist/cjs/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.js +3 -2
  40. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.d.ts +1 -1
  41. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +11 -45
  42. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +14 -11
  43. package/dist/cjs/globalization/labels/chart_builder/I18N_CHART_BUILDER_LAYER_OPTIONS.js +9 -8
  44. package/dist/cjs/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +1 -0
  45. package/dist/cjs/globalization/labels/dashboard/I18N_DASHBOARD.js +12 -7
  46. package/dist/cjs/globalization/labels/filters/I18N_FILTER_BUILDER.js +3 -2
  47. package/dist/cjs/globalization/labels/filters/I18N_VALUE_CONTAINER.js +3 -2
  48. package/dist/cjs/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.js +1 -1
  49. package/dist/cjs/globalization/labels/panel/I18N_PANEL.js +28 -18
  50. package/dist/columns/constants/COLUMN_PROPERTY_LABEL.d.ts +1 -0
  51. package/dist/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.d.ts +1 -0
  52. package/dist/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.js +1 -0
  53. package/dist/filters/adapters/FDToFlatUI.js +0 -2
  54. package/dist/filters/adapters/FDToUI.js +1 -2
  55. package/dist/filters/adapters/UIToFD.js +0 -1
  56. package/dist/filters/adapters/UIToFlatUI.js +0 -2
  57. package/dist/filters/adapters/UIToOldLogic.js +1 -1
  58. package/dist/filters/adapters/flatUIToOldLogic.js +1 -1
  59. package/dist/filters/adapters/flatUIToUI.js +0 -2
  60. package/dist/filters/adapters/logicToFlatUI.js +0 -2
  61. package/dist/filters/helpers/ui/getUIValues.d.ts +2 -1
  62. package/dist/filters/helpers/ui/getUIValues.js +25 -12
  63. package/dist/filters/interfaces/ui/IFUFilter.d.ts +1 -1
  64. package/dist/filters/interfaces/ui/IFUUIValueSettings.d.ts +6 -0
  65. package/dist/{globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.js → filters/interfaces/ui/IFUUIValueSettings.js} +0 -0
  66. package/dist/filters/interfaces/ui/index.d.ts +1 -0
  67. package/dist/filters/interfaces/ui/index.js +1 -0
  68. package/dist/globalization/interfaces/bucket_builder/II18nBucketBuilderMessages.d.ts +2 -1
  69. package/dist/globalization/interfaces/chart_builder/II18nChartBuilder.d.ts +0 -14
  70. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderAggregatedFormulas.d.ts +2 -1
  71. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderRefernceLine.d.ts +9 -8
  72. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderShelfMenu.d.ts +1 -0
  73. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderSorting.d.ts +11 -9
  74. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderTrendChart.d.ts +14 -13
  75. package/dist/globalization/interfaces/chart_builder/index.d.ts +0 -7
  76. package/dist/globalization/interfaces/chart_builder/index.js +0 -7
  77. package/dist/globalization/interfaces/common/II18nColumnProperties.d.ts +1 -0
  78. package/dist/globalization/interfaces/dashboard/II18nDashboard.d.ts +2 -0
  79. package/dist/globalization/interfaces/dashboard/II18nDashboardEmptyState.d.ts +5 -0
  80. package/dist/globalization/interfaces/{chart_builder/II18nChartBuilderComplexFile.js → dashboard/II18nDashboardEmptyState.js} +0 -0
  81. package/dist/globalization/interfaces/dashboard/index.d.ts +1 -0
  82. package/dist/globalization/interfaces/dashboard/index.js +1 -0
  83. package/dist/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.d.ts +1 -0
  84. package/dist/globalization/interfaces/filters/II18nValueContainer.d.ts +1 -0
  85. package/dist/globalization/interfaces/panel/II18nPanelErrors.d.ts +11 -9
  86. package/dist/globalization/interfaces/panel/II18nPanelSummaryViews.d.ts +17 -9
  87. package/dist/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.js +3 -2
  88. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.d.ts +1 -1
  89. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.js +11 -45
  90. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.js +14 -11
  91. package/dist/globalization/labels/chart_builder/I18N_CHART_BUILDER_LAYER_OPTIONS.js +9 -8
  92. package/dist/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +1 -0
  93. package/dist/globalization/labels/dashboard/I18N_DASHBOARD.js +12 -7
  94. package/dist/globalization/labels/filters/I18N_FILTER_BUILDER.js +3 -2
  95. package/dist/globalization/labels/filters/I18N_VALUE_CONTAINER.js +3 -2
  96. package/dist/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.js +1 -1
  97. package/dist/globalization/labels/panel/I18N_PANEL.js +28 -18
  98. package/package.json +1 -1
  99. package/src/columns/constants/COMPLEX_COLUMN_PROPERTY_LABEL.ts +1 -0
  100. package/src/filters/adapters/FDToFlatUI.ts +0 -2
  101. package/src/filters/adapters/FDToUI.ts +0 -2
  102. package/src/filters/adapters/UIToFD.ts +0 -1
  103. package/src/filters/adapters/UIToFlatUI.ts +0 -2
  104. package/src/filters/adapters/UIToOldLogic.ts +1 -1
  105. package/src/filters/adapters/flatUIToOldLogic.ts +1 -1
  106. package/src/filters/adapters/flatUIToUI.ts +0 -2
  107. package/src/filters/adapters/logicToFlatUI.ts +1 -3
  108. package/src/filters/helpers/ui/getUIValues.ts +28 -12
  109. package/src/filters/interfaces/ui/IFUFilter.ts +1 -1
  110. package/src/filters/interfaces/ui/IFUUIValueSettings.ts +7 -0
  111. package/src/filters/interfaces/ui/index.ts +1 -0
  112. package/src/globalization/interfaces/bucket_builder/II18nBucketBuilderMessages.ts +2 -1
  113. package/src/globalization/interfaces/chart_builder/II18nChartBuilder.ts +0 -14
  114. package/src/globalization/interfaces/chart_builder/II18nChartBuilderAggregatedFormulas.ts +2 -1
  115. package/src/globalization/interfaces/chart_builder/II18nChartBuilderRefernceLine.ts +9 -8
  116. package/src/globalization/interfaces/chart_builder/II18nChartBuilderShelfMenu.ts +1 -0
  117. package/src/globalization/interfaces/chart_builder/II18nChartBuilderSorting.ts +11 -9
  118. package/src/globalization/interfaces/chart_builder/II18nChartBuilderTrendChart.ts +14 -13
  119. package/src/globalization/interfaces/chart_builder/index.ts +0 -7
  120. package/src/globalization/interfaces/common/II18nColumnProperties.ts +1 -0
  121. package/src/globalization/interfaces/dashboard/II18nDashboard.ts +2 -0
  122. package/src/globalization/interfaces/dashboard/II18nDashboardEmptyState.ts +5 -0
  123. package/src/globalization/interfaces/dashboard/index.ts +1 -0
  124. package/src/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.ts +1 -0
  125. package/src/globalization/interfaces/filters/II18nValueContainer.ts +1 -0
  126. package/src/globalization/interfaces/panel/II18nPanelErrors.ts +11 -9
  127. package/src/globalization/interfaces/panel/II18nPanelSummaryViews.ts +17 -9
  128. package/src/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.ts +3 -2
  129. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL.ts +13 -47
  130. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_GENERAL_OPTIONS.ts +15 -11
  131. package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_LAYER_OPTIONS.ts +9 -8
  132. package/src/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.ts +1 -0
  133. package/src/globalization/labels/dashboard/I18N_DASHBOARD.ts +12 -7
  134. package/src/globalization/labels/filters/I18N_FILTER_BUILDER.ts +3 -2
  135. package/src/globalization/labels/filters/I18N_VALUE_CONTAINER.ts +3 -2
  136. package/src/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.ts +1 -1
  137. package/src/globalization/labels/panel/I18N_PANEL.ts +28 -18
  138. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.d.ts +0 -5
  139. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.d.ts +0 -4
  140. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.d.ts +0 -4
  141. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.js +0 -2
  142. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.d.ts +0 -4
  143. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.js +0 -2
  144. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.d.ts +0 -4
  145. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.js +0 -2
  146. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.d.ts +0 -6
  147. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.js +0 -2
  148. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.d.ts +0 -5
  149. package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.js +0 -2
  150. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.d.ts +0 -5
  151. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.d.ts +0 -4
  152. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.d.ts +0 -4
  153. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.js +0 -1
  154. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.d.ts +0 -4
  155. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.js +0 -1
  156. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.d.ts +0 -4
  157. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.js +0 -1
  158. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.d.ts +0 -6
  159. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.js +0 -1
  160. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.d.ts +0 -5
  161. package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.js +0 -1
  162. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.ts +0 -6
  163. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.ts +0 -4
  164. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.ts +0 -4
  165. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.ts +0 -4
  166. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.ts +0 -4
  167. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.ts +0 -6
  168. package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.ts +0 -6
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-0*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-4*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -136,12 +136,12 @@ Transforms String Date from a [Month Year] format to Date object.
136
136
 
137
137
 
138
138
 
139
- ### dist/dates/adapters/quarterYearToDate.js
139
+ ### dist/dates/adapters/weekYearToDate.js
140
140
 
141
141
 
142
- #### quarterYearToDate(quarterYearDate, time)
142
+ #### weekYearToDate(date, time)
143
143
 
144
- Transforms String Date from a [Quarter Year] format to Date object.
144
+ Transforms String Date from a [Week Year] format to Date object.
145
145
 
146
146
 
147
147
 
@@ -150,7 +150,7 @@ Transforms String Date from a [Quarter Year] format to Date object.
150
150
 
151
151
  | Name | Type | Description | |
152
152
  | ---- | ---- | ----------- | -------- |
153
- | quarterYearDate | | String of [Quarter Year] date |   |
153
+ | date | | String of [Week Year] date |   |
154
154
  | time | | Flag to parse the object date to milliseconds. |   |
155
155
 
156
156
 
@@ -164,12 +164,12 @@ Transforms String Date from a [Quarter Year] format to Date object.
164
164
 
165
165
 
166
166
 
167
- ### dist/dates/adapters/weekYearToDate.js
167
+ ### dist/dates/adapters/quarterYearToDate.js
168
168
 
169
169
 
170
- #### weekYearToDate(date, time)
170
+ #### quarterYearToDate(quarterYearDate, time)
171
171
 
172
- Transforms String Date from a [Week Year] format to Date object.
172
+ Transforms String Date from a [Quarter Year] format to Date object.
173
173
 
174
174
 
175
175
 
@@ -178,7 +178,7 @@ Transforms String Date from a [Week Year] format to Date object.
178
178
 
179
179
  | Name | Type | Description | |
180
180
  | ---- | ---- | ----------- | -------- |
181
- | date | | String of [Week Year] date |   |
181
+ | quarterYearDate | | String of [Quarter Year] date |   |
182
182
  | time | | Flag to parse the object date to milliseconds. |   |
183
183
 
184
184
 
@@ -1868,13 +1868,13 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1868
1868
 
1869
1869
 
1870
1870
 
1871
- ### dist/general/mix/compareDeep.js
1871
+ ### dist/general/object/cloneDeep.js
1872
1872
 
1873
1873
 
1874
- #### compareDeep(object1, object2)
1874
+ #### cloneDeep(obj)
1875
1875
 
1876
- Compares two objects to know if they are equals. Go across nested objects.
1877
- Includes arrays in the comparison.
1876
+ A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
1877
+ Not to use this function with inner objects and functions
1878
1878
 
1879
1879
 
1880
1880
 
@@ -1883,8 +1883,7 @@ Includes arrays in the comparison.
1883
1883
 
1884
1884
  | Name | Type | Description | |
1885
1885
  | ---- | ---- | ----------- | -------- |
1886
- | object1 | | First Object to compare |   |
1887
- | object2 | | Second Object to compare |   |
1886
+ | obj | | The object |   |
1888
1887
 
1889
1888
 
1890
1889
 
@@ -1892,17 +1891,21 @@ Includes arrays in the comparison.
1892
1891
  ##### Returns
1893
1892
 
1894
1893
 
1895
- - True: objects are equal. False: Objects are not equal. Undefined: invalid
1894
+ - The new reference object or the given object if the parsing is incorrect or empty
1896
1895
 
1897
1896
 
1898
1897
 
1899
1898
 
1900
- ### dist/general/mix/getTag.js
1899
+ ### dist/general/object/get.js
1901
1900
 
1902
1901
 
1903
- #### getTag(value)
1902
+ #### _get(baseObject, path, defaultValue)
1904
1903
 
1905
- Gets the `toStringTag` of `value`.
1904
+ Like lodash _.get.
1905
+ Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
1906
+
1907
+ Empty arrays and empty objects are returned but the defaultValue is not
1908
+ Undefined and null values will return the defaultValue.
1906
1909
 
1907
1910
 
1908
1911
 
@@ -1911,25 +1914,59 @@ Gets the `toStringTag` of `value`.
1911
1914
 
1912
1915
  | Name | Type | Description | |
1913
1916
  | ---- | ---- | ----------- | -------- |
1914
- | value | | The value to query. |   |
1917
+ | baseObject | | The object to query |   |
1918
+ | path | | The string path or collection of string paths of the property to get. |   |
1919
+ | defaultValue | | The value returned for undefined resolved values. |   |
1920
+
1915
1921
 
1916
1922
 
1917
1923
 
1924
+ ##### Examples
1925
+
1926
+ ```javascript
1927
+ // returns 'Hello'
1928
+ _get({ item1: 'Hello', item2: 'World' }, 'item1')
1929
+ ```
1930
+ ```javascript
1931
+ // returns 'A simple Hello'
1932
+ _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
1933
+ ```
1934
+ ```javascript
1935
+ // returns 'Hello Again'
1936
+ _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
1937
+ ```
1938
+ ```javascript
1939
+ // returns 'Hello 2'
1940
+ _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
1941
+ ```
1942
+ ```javascript
1943
+ // returns 'Hello Again'
1944
+ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
1945
+ ```
1946
+
1918
1947
 
1919
1948
  ##### Returns
1920
1949
 
1921
1950
 
1922
- - `string` Returns the `toStringTag`.
1951
+ - the resolved value.
1923
1952
 
1924
1953
 
1925
1954
 
1926
1955
 
1927
- ### dist/general/mix/importScripts.js
1956
+ ### dist/general/object/getAttribute.js
1928
1957
 
1929
1958
 
1930
- #### importScripts(scripts)
1959
+ #### getAttribute(obj, key)
1931
1960
 
1932
- Import a set of external Scripts given the URL in both serie and cascade way
1961
+ Searchs for properties in different case styles such as: lower, upper, camel and pascal
1962
+ - To optimize the searching, it is required a key in a snake_case style
1963
+ - List of cases that do not match
1964
+ -- From lower to snake case
1965
+ -- From upper to snake case
1966
+ -- From lower to camel case
1967
+ -- From upper to camel case
1968
+ -- From lower to pascal case
1969
+ -- From upper to pascal case
1933
1970
 
1934
1971
 
1935
1972
 
@@ -1938,12 +1975,8 @@ Import a set of external Scripts given the URL in both serie and cascade way
1938
1975
 
1939
1976
  | Name | Type | Description | |
1940
1977
  | ---- | ---- | ----------- | -------- |
1941
- | scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | &nbsp; |
1942
- | scripts.url | `String` | CDN URL | &nbsp; |
1943
- | scripts.namespace | `String` `Function` | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
1944
- | scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
1945
- | scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
1946
- | scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | &nbsp; |
1978
+ | obj | `object` | object to look for | &nbsp; |
1979
+ | key | `string` | String attribute in snake_case style | &nbsp; |
1947
1980
 
1948
1981
 
1949
1982
 
@@ -1951,41 +1984,24 @@ Import a set of external Scripts given the URL in both serie and cascade way
1951
1984
  ##### Examples
1952
1985
 
1953
1986
  ```javascript
1954
- // 1) Simple script (paralell loading)
1955
- importScripts(['http://myscript.js', 'http://another.js']);
1987
+ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
1988
+ ```
1956
1989
 
1957
- // 2) Loading `.js` and `.esm.js` script (parallel loading)
1958
- importScripts([
1959
- { url: 'http://myscript.esm.js', type: 'module' },
1960
- { url: 'http://myscript.js', noModule: true }
1961
- ]);
1962
1990
 
1963
- // 3) import dependent scripts (cascade)
1964
- importScripts([
1965
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
1966
- ]);
1991
+ ##### Returns
1967
1992
 
1968
- // 4) mix
1969
- importScripts([
1970
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
1971
- { url: 'http://another.esm.js', type: 'module' },
1972
- { url: 'http://another.js', noModule: true },
1973
- 'http://simplescript.js'
1974
- ]);
1975
- ```
1976
1993
 
1994
+ - `Void`
1977
1995
 
1978
- ##### Returns
1979
1996
 
1980
1997
 
1981
- - `Promise` Promise when all script have been loaded
1982
1998
 
1999
+ ### dist/general/object/hasProperty.js
1983
2000
 
1984
2001
 
1985
- #### loadScript(url, type, noModule)
2002
+ #### _hasProperty(obj, property)
1986
2003
 
1987
- Creates the script element and appends to document.head
1988
- return a Promise that is resolved when the script is loaded
2004
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
1989
2005
 
1990
2006
 
1991
2007
 
@@ -1994,27 +2010,38 @@ return a Promise that is resolved when the script is loaded
1994
2010
 
1995
2011
  | Name | Type | Description | |
1996
2012
  | ---- | ---- | ----------- | -------- |
1997
- | url | `String` | Cdn Url | &nbsp; |
1998
- | type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
1999
- | noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
2013
+ | obj | `object` | an object | &nbsp; |
2014
+ | property | `string` | String to verify if exists in the object as property | &nbsp; |
2015
+
2000
2016
 
2001
2017
 
2002
2018
 
2019
+ ##### Examples
2020
+
2021
+ ```javascript
2022
+ const prop = 'prop2'
2023
+ const obj1 = { prop1: 'hello', prop2: 'world'}
2024
+ _hasProperty(ob1, prop1) // true
2025
+
2026
+ const obj2 = { prop1: 'hello world' }
2027
+ _hasProperty(ob1, prop2) // false
2028
+ ```
2029
+
2003
2030
 
2004
2031
  ##### Returns
2005
2032
 
2006
2033
 
2007
- - `Void`
2034
+ - True if the object has the given property; otherwise, false.
2008
2035
 
2009
2036
 
2010
2037
 
2011
2038
 
2012
- ### dist/general/mix/isEmpty.js
2039
+ ### dist/general/object/isObject.js
2013
2040
 
2014
2041
 
2015
- #### isEmpty(variable, includeFalsy)
2042
+ #### isObject(obj)
2016
2043
 
2017
- Validates if the given argument is empty
2044
+ Checks if the given argument is an object type
2018
2045
 
2019
2046
 
2020
2047
 
@@ -2023,8 +2050,7 @@ Validates if the given argument is empty
2023
2050
 
2024
2051
  | Name | Type | Description | |
2025
2052
  | ---- | ---- | ----------- | -------- |
2026
- | variable | | the given variable | &nbsp; |
2027
- | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2053
+ | obj | | the variable to check | &nbsp; |
2028
2054
 
2029
2055
 
2030
2056
 
@@ -2032,19 +2058,18 @@ Validates if the given argument is empty
2032
2058
  ##### Returns
2033
2059
 
2034
2060
 
2035
- - true: the given argument is empty; false: is not.
2061
+ - True: It is an object; False: It is not.
2036
2062
 
2037
2063
 
2038
2064
 
2039
2065
 
2040
- ### dist/general/mix/isNaNV2.js
2066
+ ### dist/general/object/mapValues.js
2041
2067
 
2042
2068
 
2043
- #### isNaNV2(variable)
2069
+ #### mapValues(baseObject, iteratee)
2044
2070
 
2045
- Validates if the recieved number is NaN type.
2046
- This function recieves any variable but will return false.
2047
- Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
2071
+ Invoke iteratee (function) for each object key-value pair
2072
+ and return a mapped object
2048
2073
 
2049
2074
 
2050
2075
 
@@ -2053,7 +2078,8 @@ Validates if variable is null, undefined, or an empty string, also, the function
2053
2078
 
2054
2079
  | Name | Type | Description | |
2055
2080
  | ---- | ---- | ----------- | -------- |
2056
- | variable | | the variable to validate | &nbsp; |
2081
+ | baseObject | `Object` | Base object. | &nbsp; |
2082
+ | iteratee | `Function` | The executed per iteration. | &nbsp; |
2057
2083
 
2058
2084
 
2059
2085
 
@@ -2061,18 +2087,18 @@ Validates if variable is null, undefined, or an empty string, also, the function
2061
2087
  ##### Returns
2062
2088
 
2063
2089
 
2064
- - True if variable is a NaN or false otherwise
2090
+ - `Object` New mapped object.
2065
2091
 
2066
2092
 
2067
2093
 
2068
2094
 
2069
- ### dist/general/mix/isNull.js
2095
+ ### dist/general/object/mergeDeep.js
2070
2096
 
2071
2097
 
2072
- #### isNull(arg)
2098
+ #### mergeDeep(obj1, obj2, settings)
2073
2099
 
2074
- return if a given variable is either `null` or `undefined`
2075
- useful to avoid falsify validating Number Zero (0)
2100
+ Merges two objects into a new one.
2101
+ The second given argument to the first given argument.
2076
2102
 
2077
2103
 
2078
2104
 
@@ -2081,7 +2107,9 @@ useful to avoid falsify validating Number Zero (0)
2081
2107
 
2082
2108
  | Name | Type | Description | |
2083
2109
  | ---- | ---- | ----------- | -------- |
2084
- | arg | `any` | | &nbsp; |
2110
+ | obj1 | | The target object | &nbsp; |
2111
+ | obj2 | | The object to be merged | &nbsp; |
2112
+ | settings | | Object settings for this function | &nbsp; |
2085
2113
 
2086
2114
 
2087
2115
 
@@ -2089,19 +2117,13 @@ useful to avoid falsify validating Number Zero (0)
2089
2117
  ##### Returns
2090
2118
 
2091
2119
 
2092
- - `Boolean`
2093
-
2094
-
2095
-
2120
+ - a new merged object
2096
2121
 
2097
- ### dist/general/mix/randomId.js
2098
2122
 
2099
2123
 
2100
- #### randomId(length, exclude)
2124
+ #### isValid(obj1, obj2)
2101
2125
 
2102
- Creates a random string
2103
- - If the first given argument is different than a length number, the variable is replaced by a default number
2104
- - If the optional second given argument is passed the random string is permutated.
2126
+ Validates if the two arguments are objects
2105
2127
 
2106
2128
 
2107
2129
 
@@ -2110,8 +2132,8 @@ Creates a random string
2110
2132
 
2111
2133
  | Name | Type | Description | |
2112
2134
  | ---- | ---- | ----------- | -------- |
2113
- | length | `Number` | size of the generated string. Default 8 | &nbsp; |
2114
- | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
2135
+ | obj1 | | The target object | &nbsp; |
2136
+ | obj2 | | The object to be merged | &nbsp; |
2115
2137
 
2116
2138
 
2117
2139
 
@@ -2119,19 +2141,13 @@ Creates a random string
2119
2141
  ##### Returns
2120
2142
 
2121
2143
 
2122
- - `String` Random string
2123
-
2124
-
2125
-
2144
+ - true: they are valid; false: they are not
2126
2145
 
2127
- ### dist/general/mix/size.js
2128
2146
 
2129
2147
 
2130
- #### size(obj)
2148
+ #### getParamsToMergeDeep(settings)
2131
2149
 
2132
- Gets the length of the given array.
2133
- - Useful for Object, Array and string type.
2134
- - For `null` or `undefined` or else argument the returned value will be 0.
2150
+ Validates and gets the settings with all set parameters.
2135
2151
 
2136
2152
 
2137
2153
 
@@ -2140,7 +2156,7 @@ Gets the length of the given array.
2140
2156
 
2141
2157
  | Name | Type | Description | |
2142
2158
  | ---- | ---- | ----------- | -------- |
2143
- | obj | `Any` | Any object-type variable | &nbsp; |
2159
+ | settings | | the settings object | &nbsp; |
2144
2160
 
2145
2161
 
2146
2162
 
@@ -2148,17 +2164,17 @@ Gets the length of the given array.
2148
2164
  ##### Returns
2149
2165
 
2150
2166
 
2151
- - `Number` the size of the given variable
2167
+ - a new settings object with all set parameters.
2152
2168
 
2153
2169
 
2154
2170
 
2155
2171
 
2156
- ### dist/general/string/capitalize.js
2172
+ ### dist/general/object/objectCopy.js
2157
2173
 
2158
2174
 
2159
- #### capitalize(text)
2175
+ #### objectCopy(entity, cache)
2160
2176
 
2161
- Upper case the first letter of a given text
2177
+ Created a new reference of the given argument
2162
2178
 
2163
2179
 
2164
2180
 
@@ -2167,7 +2183,8 @@ Upper case the first letter of a given text
2167
2183
 
2168
2184
  | Name | Type | Description | |
2169
2185
  | ---- | ---- | ----------- | -------- |
2170
- | text | `String` | | &nbsp; |
2186
+ | entity | | The variable to be copied | &nbsp; |
2187
+ | cache | | | &nbsp; |
2171
2188
 
2172
2189
 
2173
2190
 
@@ -2175,18 +2192,17 @@ Upper case the first letter of a given text
2175
2192
  ##### Returns
2176
2193
 
2177
2194
 
2178
- - `String` a capitalized text
2195
+ - A new reference of the given argument
2179
2196
 
2180
2197
 
2181
2198
 
2182
2199
 
2183
- ### dist/general/object/cloneDeep.js
2200
+ ### dist/general/object/omit.js
2184
2201
 
2185
2202
 
2186
- #### cloneDeep(obj)
2203
+ #### omit(obj, props)
2187
2204
 
2188
- A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
2189
- Not to use this function with inner objects and functions
2205
+ return a new Object excluding attributes in _props_ list
2190
2206
 
2191
2207
 
2192
2208
 
@@ -2195,7 +2211,8 @@ Not to use this function with inner objects and functions
2195
2211
 
2196
2212
  | Name | Type | Description | |
2197
2213
  | ---- | ---- | ----------- | -------- |
2198
- | obj | | The object | &nbsp; |
2214
+ | obj | `Object` | base object | &nbsp; |
2215
+ | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2199
2216
 
2200
2217
 
2201
2218
 
@@ -2203,21 +2220,17 @@ Not to use this function with inner objects and functions
2203
2220
  ##### Returns
2204
2221
 
2205
2222
 
2206
- - The new reference object or the given object if the parsing is incorrect or empty
2207
-
2223
+ - `Object` clean object
2208
2224
 
2209
2225
 
2210
2226
 
2211
- ### dist/general/object/get.js
2212
2227
 
2228
+ ### dist/general/object/pick.js
2213
2229
 
2214
- #### _get(baseObject, path, defaultValue)
2215
2230
 
2216
- Like lodash _.get.
2217
- Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
2231
+ #### pick(baseObject, keys)
2218
2232
 
2219
- Empty arrays and empty objects are returned but the defaultValue is not
2220
- Undefined and null values will return the defaultValue.
2233
+ return a new object just with attributes in _keys_ list
2221
2234
 
2222
2235
 
2223
2236
 
@@ -2226,59 +2239,26 @@ Undefined and null values will return the defaultValue.
2226
2239
 
2227
2240
  | Name | Type | Description | |
2228
2241
  | ---- | ---- | ----------- | -------- |
2229
- | baseObject | | The object to query | &nbsp; |
2230
- | path | | The string path or collection of string paths of the property to get. | &nbsp; |
2231
- | defaultValue | | The value returned for undefined resolved values. | &nbsp; |
2242
+ | baseObject | `Object` | base object | &nbsp; |
2243
+ | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2232
2244
 
2233
2245
 
2234
2246
 
2235
2247
 
2236
- ##### Examples
2237
-
2238
- ```javascript
2239
- // returns 'Hello'
2240
- _get({ item1: 'Hello', item2: 'World' }, 'item1')
2241
- ```
2242
- ```javascript
2243
- // returns 'A simple Hello'
2244
- _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
2245
- ```
2246
- ```javascript
2247
- // returns 'Hello Again'
2248
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
2249
- ```
2250
- ```javascript
2251
- // returns 'Hello 2'
2252
- _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
2253
- ```
2254
- ```javascript
2255
- // returns 'Hello Again'
2256
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
2257
- ```
2258
-
2259
-
2260
- ##### Returns
2248
+ ##### Returns
2261
2249
 
2262
2250
 
2263
- - the resolved value.
2251
+ - `Object` new object just with desired attributes
2264
2252
 
2265
2253
 
2266
2254
 
2267
2255
 
2268
- ### dist/general/object/getAttribute.js
2256
+ ### dist/general/object/serialize.js
2269
2257
 
2270
2258
 
2271
- #### getAttribute(obj, key)
2259
+ #### serialize(obj)
2272
2260
 
2273
- Searchs for properties in different case styles such as: lower, upper, camel and pascal
2274
- - To optimize the searching, it is required a key in a snake_case style
2275
- - List of cases that do not match
2276
- -- From lower to snake case
2277
- -- From upper to snake case
2278
- -- From lower to camel case
2279
- -- From upper to camel case
2280
- -- From lower to pascal case
2281
- -- From upper to pascal case
2261
+ serialize object to url param
2282
2262
 
2283
2263
 
2284
2264
 
@@ -2287,18 +2267,10 @@ Searchs for properties in different case styles such as: lower, upper, camel and
2287
2267
 
2288
2268
  | Name | Type | Description | |
2289
2269
  | ---- | ---- | ----------- | -------- |
2290
- | obj | `object` | object to look for | &nbsp; |
2291
- | key | `string` | String attribute in snake_case style | &nbsp; |
2292
-
2270
+ | obj | | - Object to be serialized | &nbsp; |
2293
2271
 
2294
2272
 
2295
2273
 
2296
- ##### Examples
2297
-
2298
- ```javascript
2299
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2300
- ```
2301
-
2302
2274
 
2303
2275
  ##### Returns
2304
2276
 
@@ -2308,12 +2280,13 @@ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase
2308
2280
 
2309
2281
 
2310
2282
 
2311
- ### dist/general/object/hasProperty.js
2283
+ ### dist/general/mix/compareDeep.js
2312
2284
 
2313
2285
 
2314
- #### _hasProperty(obj, property)
2286
+ #### compareDeep(object1, object2)
2315
2287
 
2316
- Use the hasOwnProperty in order to verify if the given property exists in the object.
2288
+ Compares two objects to know if they are equals. Go across nested objects.
2289
+ Includes arrays in the comparison.
2317
2290
 
2318
2291
 
2319
2292
 
@@ -2322,38 +2295,26 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
2322
2295
 
2323
2296
  | Name | Type | Description | |
2324
2297
  | ---- | ---- | ----------- | -------- |
2325
- | obj | `object` | an object | &nbsp; |
2326
- | property | `string` | String to verify if exists in the object as property | &nbsp; |
2327
-
2328
-
2329
-
2330
-
2331
- ##### Examples
2298
+ | object1 | | First Object to compare | &nbsp; |
2299
+ | object2 | | Second Object to compare | &nbsp; |
2332
2300
 
2333
- ```javascript
2334
- const prop = 'prop2'
2335
- const obj1 = { prop1: 'hello', prop2: 'world'}
2336
- _hasProperty(ob1, prop1) // true
2337
2301
 
2338
- const obj2 = { prop1: 'hello world' }
2339
- _hasProperty(ob1, prop2) // false
2340
- ```
2341
2302
 
2342
2303
 
2343
2304
  ##### Returns
2344
2305
 
2345
2306
 
2346
- - True if the object has the given property; otherwise, false.
2307
+ - True: objects are equal. False: Objects are not equal. Undefined: invalid
2347
2308
 
2348
2309
 
2349
2310
 
2350
2311
 
2351
- ### dist/general/object/isObject.js
2312
+ ### dist/general/mix/getTag.js
2352
2313
 
2353
2314
 
2354
- #### isObject(obj)
2315
+ #### getTag(value)
2355
2316
 
2356
- Checks if the given argument is an object type
2317
+ Gets the `toStringTag` of `value`.
2357
2318
 
2358
2319
 
2359
2320
 
@@ -2362,7 +2323,7 @@ Checks if the given argument is an object type
2362
2323
 
2363
2324
  | Name | Type | Description | |
2364
2325
  | ---- | ---- | ----------- | -------- |
2365
- | obj | | the variable to check | &nbsp; |
2326
+ | value | | The value to query. | &nbsp; |
2366
2327
 
2367
2328
 
2368
2329
 
@@ -2370,18 +2331,17 @@ Checks if the given argument is an object type
2370
2331
  ##### Returns
2371
2332
 
2372
2333
 
2373
- - True: It is an object; False: It is not.
2334
+ - `string` Returns the `toStringTag`.
2374
2335
 
2375
2336
 
2376
2337
 
2377
2338
 
2378
- ### dist/general/object/mapValues.js
2339
+ ### dist/general/mix/importScripts.js
2379
2340
 
2380
2341
 
2381
- #### mapValues(baseObject, iteratee)
2342
+ #### importScripts(scripts)
2382
2343
 
2383
- Invoke iteratee (function) for each object key-value pair
2384
- and return a mapped object
2344
+ Import a set of external Scripts given the URL in both serie and cascade way
2385
2345
 
2386
2346
 
2387
2347
 
@@ -2390,27 +2350,54 @@ and return a mapped object
2390
2350
 
2391
2351
  | Name | Type | Description | |
2392
2352
  | ---- | ---- | ----------- | -------- |
2393
- | baseObject | `Object` | Base object. | &nbsp; |
2394
- | iteratee | `Function` | The executed per iteration. | &nbsp; |
2353
+ | scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | &nbsp; |
2354
+ | scripts.url | `String` | CDN URL | &nbsp; |
2355
+ | scripts.namespace | `String` `Function` | (Optional) if is a String, that name is evaluated on Window[namespace] object otherwise the Function is invoked expecting a Thrutly value | &nbsp; |
2356
+ | scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
2357
+ | scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
2358
+ | scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | &nbsp; |
2395
2359
 
2396
2360
 
2397
2361
 
2398
2362
 
2399
- ##### Returns
2363
+ ##### Examples
2400
2364
 
2365
+ ```javascript
2366
+ // 1) Simple script (paralell loading)
2367
+ importScripts(['http://myscript.js', 'http://another.js']);
2401
2368
 
2402
- - `Object` New mapped object.
2369
+ // 2) Loading `.js` and `.esm.js` script (parallel loading)
2370
+ importScripts([
2371
+ { url: 'http://myscript.esm.js', type: 'module' },
2372
+ { url: 'http://myscript.js', noModule: true }
2373
+ ]);
2403
2374
 
2375
+ // 3) import dependent scripts (cascade)
2376
+ importScripts([
2377
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
2378
+ ]);
2404
2379
 
2380
+ // 4) mix
2381
+ importScripts([
2382
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
2383
+ { url: 'http://another.esm.js', type: 'module' },
2384
+ { url: 'http://another.js', noModule: true },
2385
+ 'http://simplescript.js'
2386
+ ]);
2387
+ ```
2405
2388
 
2406
2389
 
2407
- ### dist/general/object/mergeDeep.js
2390
+ ##### Returns
2408
2391
 
2409
2392
 
2410
- #### mergeDeep(obj1, obj2, settings)
2393
+ - `Promise` Promise when all script have been loaded
2411
2394
 
2412
- Merges two objects into a new one.
2413
- The second given argument to the first given argument.
2395
+
2396
+
2397
+ #### loadScript(url, type, noModule)
2398
+
2399
+ Creates the script element and appends to document.head
2400
+ return a Promise that is resolved when the script is loaded
2414
2401
 
2415
2402
 
2416
2403
 
@@ -2419,9 +2406,9 @@ The second given argument to the first given argument.
2419
2406
 
2420
2407
  | Name | Type | Description | |
2421
2408
  | ---- | ---- | ----------- | -------- |
2422
- | obj1 | | The target object | &nbsp; |
2423
- | obj2 | | The object to be merged | &nbsp; |
2424
- | settings | | Object settings for this function | &nbsp; |
2409
+ | url | `String` | Cdn Url | &nbsp; |
2410
+ | type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
2411
+ | noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
2425
2412
 
2426
2413
 
2427
2414
 
@@ -2429,13 +2416,17 @@ The second given argument to the first given argument.
2429
2416
  ##### Returns
2430
2417
 
2431
2418
 
2432
- - a new merged object
2419
+ - `Void`
2433
2420
 
2434
2421
 
2435
2422
 
2436
- #### isValid(obj1, obj2)
2437
2423
 
2438
- Validates if the two arguments are objects
2424
+ ### dist/general/mix/isEmpty.js
2425
+
2426
+
2427
+ #### isEmpty(variable, includeFalsy)
2428
+
2429
+ Validates if the given argument is empty
2439
2430
 
2440
2431
 
2441
2432
 
@@ -2444,8 +2435,8 @@ Validates if the two arguments are objects
2444
2435
 
2445
2436
  | Name | Type | Description | |
2446
2437
  | ---- | ---- | ----------- | -------- |
2447
- | obj1 | | The target object | &nbsp; |
2448
- | obj2 | | The object to be merged | &nbsp; |
2438
+ | variable | | the given variable | &nbsp; |
2439
+ | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2449
2440
 
2450
2441
 
2451
2442
 
@@ -2453,13 +2444,19 @@ Validates if the two arguments are objects
2453
2444
  ##### Returns
2454
2445
 
2455
2446
 
2456
- - true: they are valid; false: they are not
2447
+ - true: the given argument is empty; false: is not.
2457
2448
 
2458
2449
 
2459
2450
 
2460
- #### getParamsToMergeDeep(settings)
2461
2451
 
2462
- Validates and gets the settings with all set parameters.
2452
+ ### dist/general/mix/isNaNV2.js
2453
+
2454
+
2455
+ #### isNaNV2(variable)
2456
+
2457
+ Validates if the recieved number is NaN type.
2458
+ This function recieves any variable but will return false.
2459
+ Validates if variable is null, undefined, or an empty string, also, the function uses isNaN native function.
2463
2460
 
2464
2461
 
2465
2462
 
@@ -2468,7 +2465,7 @@ Validates and gets the settings with all set parameters.
2468
2465
 
2469
2466
  | Name | Type | Description | |
2470
2467
  | ---- | ---- | ----------- | -------- |
2471
- | settings | | the settings object | &nbsp; |
2468
+ | variable | | the variable to validate | &nbsp; |
2472
2469
 
2473
2470
 
2474
2471
 
@@ -2476,17 +2473,18 @@ Validates and gets the settings with all set parameters.
2476
2473
  ##### Returns
2477
2474
 
2478
2475
 
2479
- - a new settings object with all set parameters.
2476
+ - True if variable is a NaN or false otherwise
2480
2477
 
2481
2478
 
2482
2479
 
2483
2480
 
2484
- ### dist/general/object/objectCopy.js
2481
+ ### dist/general/mix/isNull.js
2485
2482
 
2486
2483
 
2487
- #### objectCopy(entity, cache)
2484
+ #### isNull(arg)
2488
2485
 
2489
- Created a new reference of the given argument
2486
+ return if a given variable is either `null` or `undefined`
2487
+ useful to avoid falsify validating Number Zero (0)
2490
2488
 
2491
2489
 
2492
2490
 
@@ -2495,8 +2493,7 @@ Created a new reference of the given argument
2495
2493
 
2496
2494
  | Name | Type | Description | |
2497
2495
  | ---- | ---- | ----------- | -------- |
2498
- | entity | | The variable to be copied | &nbsp; |
2499
- | cache | | | &nbsp; |
2496
+ | arg | `any` | | &nbsp; |
2500
2497
 
2501
2498
 
2502
2499
 
@@ -2504,17 +2501,19 @@ Created a new reference of the given argument
2504
2501
  ##### Returns
2505
2502
 
2506
2503
 
2507
- - A new reference of the given argument
2504
+ - `Boolean`
2508
2505
 
2509
2506
 
2510
2507
 
2511
2508
 
2512
- ### dist/general/object/omit.js
2509
+ ### dist/general/mix/size.js
2513
2510
 
2514
2511
 
2515
- #### omit(obj, props)
2512
+ #### size(obj)
2516
2513
 
2517
- return a new Object excluding attributes in _props_ list
2514
+ Gets the length of the given array.
2515
+ - Useful for Object, Array and string type.
2516
+ - For `null` or `undefined` or else argument the returned value will be 0.
2518
2517
 
2519
2518
 
2520
2519
 
@@ -2523,8 +2522,7 @@ return a new Object excluding attributes in _props_ list
2523
2522
 
2524
2523
  | Name | Type | Description | |
2525
2524
  | ---- | ---- | ----------- | -------- |
2526
- | obj | `Object` | base object | &nbsp; |
2527
- | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
2525
+ | obj | `Any` | Any object-type variable | &nbsp; |
2528
2526
 
2529
2527
 
2530
2528
 
@@ -2532,17 +2530,19 @@ return a new Object excluding attributes in _props_ list
2532
2530
  ##### Returns
2533
2531
 
2534
2532
 
2535
- - `Object` clean object
2533
+ - `Number` the size of the given variable
2536
2534
 
2537
2535
 
2538
2536
 
2539
2537
 
2540
- ### dist/general/object/pick.js
2538
+ ### dist/general/mix/randomId.js
2541
2539
 
2542
2540
 
2543
- #### pick(baseObject, keys)
2541
+ #### randomId(length, exclude)
2544
2542
 
2545
- return a new object just with attributes in _keys_ list
2543
+ Creates a random string
2544
+ - If the first given argument is different than a length number, the variable is replaced by a default number
2545
+ - If the optional second given argument is passed the random string is permutated.
2546
2546
 
2547
2547
 
2548
2548
 
@@ -2551,8 +2551,8 @@ return a new object just with attributes in _keys_ list
2551
2551
 
2552
2552
  | Name | Type | Description | |
2553
2553
  | ---- | ---- | ----------- | -------- |
2554
- | baseObject | `Object` | base object | &nbsp; |
2555
- | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
2554
+ | length | `Number` | size of the generated string. Default 8 | &nbsp; |
2555
+ | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
2556
2556
 
2557
2557
 
2558
2558
 
@@ -2560,17 +2560,17 @@ return a new object just with attributes in _keys_ list
2560
2560
  ##### Returns
2561
2561
 
2562
2562
 
2563
- - `Object` new object just with desired attributes
2563
+ - `String` Random string
2564
2564
 
2565
2565
 
2566
2566
 
2567
2567
 
2568
- ### dist/general/object/serialize.js
2568
+ ### dist/general/string/capitalize.js
2569
2569
 
2570
2570
 
2571
- #### serialize(obj)
2571
+ #### capitalize(text)
2572
2572
 
2573
- serialize object to url param
2573
+ Upper case the first letter of a given text
2574
2574
 
2575
2575
 
2576
2576
 
@@ -2579,7 +2579,7 @@ serialize object to url param
2579
2579
 
2580
2580
  | Name | Type | Description | |
2581
2581
  | ---- | ---- | ----------- | -------- |
2582
- | obj | | - Object to be serialized | &nbsp; |
2582
+ | text | `String` | | &nbsp; |
2583
2583
 
2584
2584
 
2585
2585
 
@@ -2587,17 +2587,17 @@ serialize object to url param
2587
2587
  ##### Returns
2588
2588
 
2589
2589
 
2590
- - `Void`
2590
+ - `String` a capitalized text
2591
2591
 
2592
2592
 
2593
2593
 
2594
2594
 
2595
- ### dist/qrvey/helpers/getColumnsLabel.js
2595
+ ### dist/services/api/getAllDatasets.api.js
2596
2596
 
2597
2597
 
2598
- #### getColumnLabels(column)
2598
+ #### getAllDatasets(qrveyids)
2599
2599
 
2600
- Get an string of the properties of the given column.
2600
+ Get a dataset list from a collection of Qrvey IDs
2601
2601
 
2602
2602
 
2603
2603
 
@@ -2606,7 +2606,7 @@ Get an string of the properties of the given column.
2606
2606
 
2607
2607
  | Name | Type | Description | |
2608
2608
  | ---- | ---- | ----------- | -------- |
2609
- | column | | The column | &nbsp; |
2609
+ | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2610
2610
 
2611
2611
 
2612
2612
 
@@ -2614,34 +2614,29 @@ Get an string of the properties of the given column.
2614
2614
  ##### Returns
2615
2615
 
2616
2616
 
2617
- - an string with the property, aggregate or calculation label.
2618
-
2617
+ - a promise
2619
2618
 
2620
2619
 
2621
2620
 
2622
- ### dist/stencil/decorators/Config.js
2623
2621
 
2622
+ ### dist/services/api/getAllQrveys.api.js
2624
2623
 
2625
- #### Config()
2626
2624
 
2627
- Stencil.js - Prop Decorator
2628
- 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
2629
- But for this, is required ask for a property in `snake_case` style
2625
+ #### getAllQrveys(config, params)
2630
2626
 
2627
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2631
2628
 
2632
2629
 
2633
2630
 
2634
2631
 
2632
+ ##### Parameters
2635
2633
 
2636
- ##### Examples
2634
+ | Name | Type | Description | |
2635
+ | ---- | ---- | ----------- | -------- |
2636
+ | config | | Configuration | &nbsp; |
2637
+ | params | | Object for getting precise data | &nbsp; |
2637
2638
 
2638
- ```javascript
2639
- \ @Config() @Prop() settings;
2640
2639
 
2641
- someMethod() {
2642
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2643
- }
2644
- ```
2645
2640
 
2646
2641
 
2647
2642
  ##### Returns
@@ -2652,47 +2647,56 @@ someMethod() {
2652
2647
 
2653
2648
 
2654
2649
 
2655
- ### dist/stencil/util/createRef.js
2650
+ ### dist/services/api/getDatasetColumns.api.js
2656
2651
 
2657
2652
 
2658
- #### createRef()
2653
+ #### getDatasetColumns(qrveyid)
2659
2654
 
2660
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2655
+ Get a dataset by Qrvey ID
2661
2656
 
2662
2657
 
2663
2658
 
2664
2659
 
2660
+ ##### Parameters
2661
+
2662
+ | Name | Type | Description | |
2663
+ | ---- | ---- | ----------- | -------- |
2664
+ | qrveyid | | The Qrvey ID | &nbsp; |
2665
+
2666
+
2665
2667
 
2666
2668
 
2667
2669
  ##### Returns
2668
2670
 
2669
2671
 
2670
- - function - Function to use in ref prop in html elements
2672
+ - a promise
2671
2673
 
2672
2674
 
2673
2675
 
2674
2676
 
2675
- ### dist/stencil/util/getConfig.js
2677
+ ### dist/stencil/decorators/Config.js
2676
2678
 
2677
2679
 
2678
- #### getConfig(cfg)
2680
+ #### Config()
2679
2681
 
2680
- verify the Config object type and try to return a parsed Object
2681
- - In case _cfg_ is a string, first try to make a JSON parse in other case
2682
- try to find this string as a variable on Windows object
2683
- - If _cfg_ is a fuction, tis is invoked and parsed
2684
- - Finally, if is an object, _cfg_ is inmediatly returned
2682
+ Stencil.js - Prop Decorator
2683
+ 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
2684
+ But for this, is required ask for a property in `snake_case` style
2685
2685
 
2686
2686
 
2687
2687
 
2688
2688
 
2689
- ##### Parameters
2690
2689
 
2691
- | Name | Type | Description | |
2692
- | ---- | ---- | ----------- | -------- |
2693
- | cfg | | | &nbsp; |
2694
2690
 
2691
+ ##### Examples
2692
+
2693
+ ```javascript
2694
+ \ @Config() @Prop() settings;
2695
2695
 
2696
+ someMethod() {
2697
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2698
+ }
2699
+ ```
2696
2700
 
2697
2701
 
2698
2702
  ##### Returns
@@ -2703,12 +2707,16 @@ try to find this string as a variable on Windows object
2703
2707
 
2704
2708
 
2705
2709
 
2706
- ### dist/services/api/getAllDatasets.api.js
2710
+ ### dist/stencil/util/getConfig.js
2707
2711
 
2708
2712
 
2709
- #### getAllDatasets(qrveyids)
2713
+ #### getConfig(cfg)
2710
2714
 
2711
- Get a dataset list from a collection of Qrvey IDs
2715
+ verify the Config object type and try to return a parsed Object
2716
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2717
+ try to find this string as a variable on Windows object
2718
+ - If _cfg_ is a fuction, tis is invoked and parsed
2719
+ - Finally, if is an object, _cfg_ is inmediatly returned
2712
2720
 
2713
2721
 
2714
2722
 
@@ -2717,7 +2725,7 @@ Get a dataset list from a collection of Qrvey IDs
2717
2725
 
2718
2726
  | Name | Type | Description | |
2719
2727
  | ---- | ---- | ----------- | -------- |
2720
- | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2728
+ | cfg | | | &nbsp; |
2721
2729
 
2722
2730
 
2723
2731
 
@@ -2725,27 +2733,19 @@ Get a dataset list from a collection of Qrvey IDs
2725
2733
  ##### Returns
2726
2734
 
2727
2735
 
2728
- - a promise
2729
-
2730
-
2736
+ - `Void`
2731
2737
 
2732
2738
 
2733
- ### dist/services/api/getAllQrveys.api.js
2734
2739
 
2735
2740
 
2736
- #### getAllQrveys(config, params)
2737
-
2738
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2741
+ ### dist/stencil/util/createRef.js
2739
2742
 
2740
2743
 
2744
+ #### createRef()
2741
2745
 
2746
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2742
2747
 
2743
- ##### Parameters
2744
2748
 
2745
- | Name | Type | Description | |
2746
- | ---- | ---- | ----------- | -------- |
2747
- | config | | Configuration | &nbsp; |
2748
- | params | | Object for getting precise data | &nbsp; |
2749
2749
 
2750
2750
 
2751
2751
 
@@ -2753,17 +2753,17 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2753
2753
  ##### Returns
2754
2754
 
2755
2755
 
2756
- - `Void`
2756
+ - function - Function to use in ref prop in html elements
2757
2757
 
2758
2758
 
2759
2759
 
2760
2760
 
2761
- ### dist/services/api/getDatasetColumns.api.js
2761
+ ### dist/qrvey/helpers/getColumnsLabel.js
2762
2762
 
2763
2763
 
2764
- #### getDatasetColumns(qrveyid)
2764
+ #### getColumnLabels(column)
2765
2765
 
2766
- Get a dataset by Qrvey ID
2766
+ Get an string of the properties of the given column.
2767
2767
 
2768
2768
 
2769
2769
 
@@ -2772,7 +2772,7 @@ Get a dataset by Qrvey ID
2772
2772
 
2773
2773
  | Name | Type | Description | |
2774
2774
  | ---- | ---- | ----------- | -------- |
2775
- | qrveyid | | The Qrvey ID | &nbsp; |
2775
+ | column | | The column | &nbsp; |
2776
2776
 
2777
2777
 
2778
2778
 
@@ -2780,7 +2780,7 @@ Get a dataset by Qrvey ID
2780
2780
  ##### Returns
2781
2781
 
2782
2782
 
2783
- - a promise
2783
+ - an string with the property, aggregate or calculation label.
2784
2784
 
2785
2785
 
2786
2786