@qrvey/utils 1.2.2 → 1.2.4-10

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 (545) hide show
  1. package/README.md +930 -824
  2. package/dist/{cjs/qrvey → charts}/constants/AGGREGATE.d.ts +0 -0
  3. package/dist/{qrvey → charts}/constants/AGGREGATE.js +0 -0
  4. package/dist/{cjs/qrvey → charts}/constants/AGGREGATE_ABBREVIATION.d.ts +0 -0
  5. package/dist/{qrvey → charts}/constants/AGGREGATE_ABBREVIATION.js +0 -0
  6. package/dist/charts/constants/AGGREGATE_INFO.d.ts +5 -0
  7. package/dist/{qrvey → charts}/constants/AGGREGATE_INFO.js +0 -0
  8. package/dist/charts/constants/AGGREGATE_INFO_LIST.d.ts +1 -0
  9. package/dist/{qrvey → charts}/constants/AGGREGATE_INFO_LIST.js +0 -0
  10. package/dist/charts/constants/AGGREGATE_LABEL.d.ts +11 -0
  11. package/dist/charts/constants/AGGREGATE_LABEL.js +12 -0
  12. package/dist/charts/constants/index.d.ts +5 -0
  13. package/dist/charts/constants/index.js +5 -0
  14. package/dist/charts/index.d.ts +2 -0
  15. package/dist/charts/index.js +2 -0
  16. package/dist/charts/interfaces/IAggregateAbbreviation.d.ts +2 -0
  17. package/dist/{columns/interfaces/IColumnAggregateType.js → charts/interfaces/IAggregateAbbreviation.js} +0 -0
  18. package/dist/charts/interfaces/IAggregateInfo.d.ts +9 -0
  19. package/dist/{qrvey → charts}/interfaces/IAggregateInfo.js +0 -0
  20. package/dist/charts/interfaces/IAggregateLabel.d.ts +2 -0
  21. package/dist/{columns/interfaces/IColumnCalculationType.js → charts/interfaces/IAggregateLabel.js} +0 -0
  22. package/dist/{cjs/qrvey/interfaces/IAggregate.d.ts → charts/interfaces/IAggregateType.d.ts} +1 -1
  23. package/dist/{qrvey/interfaces/IAggregate.js → charts/interfaces/IAggregateType.js} +0 -0
  24. package/dist/charts/interfaces/index.d.ts +4 -0
  25. package/dist/charts/interfaces/index.js +4 -0
  26. package/dist/{qrvey → cjs/charts}/constants/AGGREGATE.d.ts +0 -0
  27. package/dist/cjs/{qrvey → charts}/constants/AGGREGATE.js +0 -0
  28. package/dist/{qrvey → cjs/charts}/constants/AGGREGATE_ABBREVIATION.d.ts +0 -0
  29. package/dist/cjs/{qrvey → charts}/constants/AGGREGATE_ABBREVIATION.js +0 -0
  30. package/dist/cjs/charts/constants/AGGREGATE_INFO.d.ts +5 -0
  31. package/dist/cjs/{qrvey → charts}/constants/AGGREGATE_INFO.js +0 -0
  32. package/dist/cjs/charts/constants/AGGREGATE_INFO_LIST.d.ts +1 -0
  33. package/dist/cjs/{qrvey → charts}/constants/AGGREGATE_INFO_LIST.js +0 -0
  34. package/dist/cjs/charts/constants/AGGREGATE_LABEL.d.ts +11 -0
  35. package/dist/cjs/charts/constants/AGGREGATE_LABEL.js +15 -0
  36. package/dist/cjs/charts/constants/index.d.ts +5 -0
  37. package/dist/cjs/charts/constants/index.js +17 -0
  38. package/dist/cjs/charts/index.d.ts +2 -0
  39. package/dist/cjs/{globalization/filters → charts}/index.js +2 -3
  40. package/dist/cjs/charts/interfaces/IAggregateAbbreviation.d.ts +2 -0
  41. package/dist/cjs/{columns/interfaces/IColumnAggregateType.js → charts/interfaces/IAggregateAbbreviation.js} +0 -0
  42. package/dist/cjs/charts/interfaces/IAggregateInfo.d.ts +9 -0
  43. package/dist/cjs/{qrvey → charts}/interfaces/IAggregateInfo.js +0 -0
  44. package/dist/cjs/charts/interfaces/IAggregateLabel.d.ts +2 -0
  45. package/dist/cjs/{columns/interfaces/IColumnCalculationType.js → charts/interfaces/IAggregateLabel.js} +0 -0
  46. package/dist/{qrvey/interfaces/IAggregate.d.ts → cjs/charts/interfaces/IAggregateType.d.ts} +1 -1
  47. package/dist/cjs/{qrvey/interfaces/IAggregate.js → charts/interfaces/IAggregateType.js} +0 -0
  48. package/dist/cjs/charts/interfaces/index.d.ts +4 -0
  49. package/dist/cjs/charts/interfaces/index.js +16 -0
  50. package/dist/cjs/columns/constants/COLUMN_INFO.js +2 -1
  51. package/dist/cjs/columns/interfaces/IBColumn.d.ts +1 -1
  52. package/dist/cjs/columns/interfaces/IColumn.d.ts +6 -4
  53. package/dist/cjs/columns/interfaces/index.d.ts +0 -2
  54. package/dist/cjs/columns/interfaces/index.js +0 -2
  55. package/dist/cjs/filters/helpers/builder/getFilterBuilderGeneralConfig.js +1 -0
  56. package/dist/cjs/filters/helpers/common/getFilterColumnLabel.js +1 -1
  57. package/dist/cjs/filters/helpers/common/getFilterLabel.js +1 -2
  58. package/dist/cjs/filters/interfaces/builder/IFilterBuilderConfig.d.ts +2 -0
  59. package/dist/cjs/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts +1 -0
  60. package/dist/cjs/filters/interfaces/panel/IFilterPanelConfig.d.ts +2 -0
  61. package/dist/cjs/format/format.js +1 -1
  62. package/dist/cjs/general/mix/compareDeep.d.ts +8 -0
  63. package/dist/cjs/general/mix/compareDeep.js +33 -0
  64. package/dist/cjs/general/mix/index.d.ts +6 -5
  65. package/dist/cjs/general/mix/index.js +6 -5
  66. package/dist/cjs/general/object/index.d.ts +1 -0
  67. package/dist/cjs/general/object/index.js +1 -0
  68. package/dist/cjs/general/object/mergeDeep.d.ts +17 -0
  69. package/dist/cjs/general/object/mergeDeep.js +55 -0
  70. package/dist/cjs/globalization/index.d.ts +3 -1
  71. package/dist/cjs/globalization/index.js +3 -1
  72. package/dist/cjs/globalization/interfaces/IResourceI18n.d.ts +14 -0
  73. package/dist/cjs/globalization/interfaces/IResourceI18n.js +2 -0
  74. package/dist/cjs/globalization/interfaces/columns/II18nColumn.d.ts +10 -0
  75. package/dist/cjs/globalization/interfaces/columns/II18nColumn.js +2 -0
  76. package/dist/cjs/globalization/interfaces/columns/index.d.ts +1 -0
  77. package/dist/cjs/globalization/interfaces/columns/index.js +13 -0
  78. package/dist/cjs/globalization/interfaces/common/II18nAgreggateLabels.d.ts +11 -0
  79. package/dist/cjs/globalization/interfaces/common/II18nAgreggateLabels.js +2 -0
  80. package/dist/cjs/globalization/interfaces/common/II18nChartInfoMessagesCrosstab.d.ts +5 -0
  81. package/dist/cjs/globalization/interfaces/common/II18nChartInfoMessagesCrosstab.js +2 -0
  82. package/dist/cjs/globalization/interfaces/common/II18nChartInfoMessagesDefault.d.ts +8 -0
  83. package/dist/cjs/globalization/interfaces/common/II18nChartInfoMessagesDefault.js +2 -0
  84. package/dist/cjs/globalization/interfaces/common/II18nChartInfoMessagesTableChart.d.ts +8 -0
  85. package/dist/cjs/globalization/interfaces/common/II18nChartInfoMessagesTableChart.js +2 -0
  86. package/dist/cjs/globalization/interfaces/common/II18nColumnProperties.d.ts +46 -0
  87. package/dist/cjs/globalization/interfaces/common/II18nColumnProperties.js +2 -0
  88. package/dist/cjs/globalization/interfaces/common/II18nColumnTypes.d.ts +38 -0
  89. package/dist/cjs/globalization/interfaces/common/II18nColumnTypes.js +2 -0
  90. package/dist/cjs/globalization/interfaces/common/II18nCommon.d.ts +15 -0
  91. package/dist/cjs/globalization/interfaces/common/II18nCommon.js +2 -0
  92. package/dist/cjs/globalization/interfaces/common/index.d.ts +7 -0
  93. package/dist/cjs/globalization/interfaces/common/index.js +19 -0
  94. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboard.d.ts +9 -0
  95. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboard.js +2 -0
  96. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardAddChart.d.ts +5 -0
  97. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardAddChart.js +2 -0
  98. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardTooltips.d.ts +7 -0
  99. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardTooltips.js +2 -0
  100. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardViews.d.ts +6 -0
  101. package/dist/cjs/globalization/interfaces/dashboard/II18nDashboardViews.js +2 -0
  102. package/dist/cjs/globalization/interfaces/dashboard/index.d.ts +4 -0
  103. package/dist/cjs/globalization/interfaces/dashboard/index.js +16 -0
  104. package/dist/cjs/globalization/interfaces/filters/II18nFilter.d.ts +8 -0
  105. package/dist/cjs/globalization/interfaces/filters/II18nFilter.js +2 -0
  106. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilder.d.ts +17 -0
  107. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilder.js +2 -0
  108. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.d.ts +4 -0
  109. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.js +2 -0
  110. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderInfoContainer.d.ts +5 -0
  111. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderInfoContainer.js +2 -0
  112. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderInfoContainerSelection.d.ts +4 -0
  113. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderInfoContainerSelection.js +2 -0
  114. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderSelectedValuesContainer.d.ts +3 -0
  115. package/dist/cjs/globalization/interfaces/filters/II18nFilterBuilderSelectedValuesContainer.js +2 -0
  116. package/dist/cjs/globalization/interfaces/filters/II18nFilterValidator.d.ts +23 -0
  117. package/dist/cjs/globalization/interfaces/filters/II18nFilterValidator.js +2 -0
  118. package/dist/cjs/globalization/interfaces/filters/II18nSlidebar.d.ts +6 -0
  119. package/dist/cjs/globalization/interfaces/filters/II18nSlidebar.js +2 -0
  120. package/dist/cjs/globalization/interfaces/filters/II18nValueContainer.d.ts +4 -0
  121. package/dist/cjs/globalization/interfaces/filters/II18nValueContainer.js +2 -0
  122. package/dist/cjs/globalization/interfaces/filters/II18nValueContainerSearchInput.d.ts +5 -0
  123. package/dist/cjs/globalization/interfaces/filters/II18nValueContainerSearchInput.js +2 -0
  124. package/dist/cjs/globalization/interfaces/filters/II18nValueContainerSearchInputEnterValue.d.ts +5 -0
  125. package/dist/cjs/globalization/interfaces/filters/II18nValueContainerSearchInputEnterValue.js +2 -0
  126. package/dist/cjs/globalization/interfaces/filters/index.d.ts +11 -0
  127. package/dist/cjs/globalization/interfaces/filters/index.js +23 -0
  128. package/dist/cjs/globalization/interfaces/index.d.ts +3 -0
  129. package/dist/cjs/globalization/interfaces/index.js +15 -0
  130. package/dist/cjs/globalization/interfaces/panel/II18nPanel.d.ts +9 -0
  131. package/dist/cjs/globalization/interfaces/panel/II18nPanel.js +2 -0
  132. package/dist/cjs/globalization/interfaces/panel/II18nPanelErrors.d.ts +9 -0
  133. package/dist/cjs/globalization/interfaces/panel/II18nPanelErrors.js +2 -0
  134. package/dist/cjs/globalization/interfaces/panel/II18nPanelMenu.d.ts +15 -0
  135. package/dist/cjs/globalization/interfaces/panel/II18nPanelMenu.js +2 -0
  136. package/dist/cjs/globalization/interfaces/panel/II18nPanelTooltips.d.ts +4 -0
  137. package/dist/cjs/globalization/interfaces/panel/II18nPanelTooltips.js +2 -0
  138. package/dist/cjs/globalization/interfaces/panel/index.d.ts +4 -0
  139. package/dist/cjs/globalization/interfaces/panel/index.js +16 -0
  140. package/dist/cjs/globalization/interfaces/table_charts/II18nTableCharts.d.ts +15 -0
  141. package/dist/cjs/globalization/interfaces/table_charts/II18nTableCharts.js +2 -0
  142. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsInnerCharts.d.ts +8 -0
  143. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsInnerCharts.js +2 -0
  144. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsPagination.d.ts +4 -0
  145. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsPagination.js +2 -0
  146. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsSort.d.ts +9 -0
  147. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsSort.js +2 -0
  148. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsSortTooltip.d.ts +3 -0
  149. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsSortTooltip.js +2 -0
  150. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsVisualizationItems.d.ts +4 -0
  151. package/dist/cjs/globalization/interfaces/table_charts/II18nTableChartsVisualizationItems.js +2 -0
  152. package/dist/cjs/globalization/interfaces/table_charts/index.d.ts +6 -0
  153. package/dist/cjs/globalization/interfaces/table_charts/index.js +18 -0
  154. package/dist/cjs/globalization/labels/I18N_DEFAULT.d.ts +2 -0
  155. package/dist/cjs/globalization/labels/I18N_DEFAULT.js +17 -0
  156. package/dist/cjs/globalization/labels/columns/I18N_COLUMN.d.ts +2 -0
  157. package/dist/cjs/globalization/labels/columns/I18N_COLUMN.js +8 -0
  158. package/dist/cjs/globalization/labels/columns/index.d.ts +1 -0
  159. package/dist/cjs/globalization/labels/columns/index.js +13 -0
  160. package/dist/cjs/globalization/labels/common/I18N_AGGREGATE_LABEL.d.ts +2 -0
  161. package/dist/cjs/globalization/labels/common/I18N_AGGREGATE_LABEL.js +15 -0
  162. package/dist/cjs/globalization/labels/common/I18N_COLUMN_LABEL.d.ts +38 -0
  163. package/dist/cjs/globalization/labels/common/I18N_COLUMN_LABEL.js +42 -0
  164. package/dist/cjs/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.d.ts +46 -0
  165. package/dist/cjs/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +50 -0
  166. package/dist/cjs/globalization/labels/common/I18N_COMMON.d.ts +2 -0
  167. package/dist/cjs/globalization/labels/common/I18N_COMMON.js +33 -0
  168. package/dist/cjs/globalization/labels/common/index.d.ts +3 -0
  169. package/dist/cjs/globalization/labels/common/index.js +15 -0
  170. package/dist/cjs/globalization/labels/dashboard/I18N_DASHBOARD.d.ts +2 -0
  171. package/dist/cjs/globalization/labels/dashboard/I18N_DASHBOARD.js +24 -0
  172. package/dist/cjs/globalization/labels/dashboard/index.d.ts +1 -0
  173. package/dist/cjs/globalization/labels/dashboard/index.js +13 -0
  174. package/dist/cjs/globalization/labels/filters/I18N_FILTER.d.ts +2 -0
  175. package/dist/cjs/globalization/labels/filters/I18N_FILTER.js +11 -0
  176. package/dist/cjs/globalization/labels/filters/I18N_FILTER_BUILDER.d.ts +2 -0
  177. package/dist/cjs/globalization/labels/filters/I18N_FILTER_BUILDER.js +27 -0
  178. package/dist/cjs/globalization/labels/filters/I18N_FILTER_VALIDATOR.d.ts +2 -0
  179. package/dist/cjs/globalization/labels/filters/I18N_FILTER_VALIDATOR.js +27 -0
  180. package/dist/cjs/globalization/labels/filters/I18N_SLIDEBAR.d.ts +2 -0
  181. package/dist/cjs/globalization/{filters/SLIDEBAR.js → labels/filters/I18N_SLIDEBAR.js} +3 -5
  182. package/dist/cjs/globalization/labels/filters/I18N_VALUE_CONTAINER.d.ts +2 -0
  183. package/dist/cjs/globalization/{filters/VALUES_CONTAINER.js → labels/filters/I18N_VALUE_CONTAINER.js} +2 -3
  184. package/dist/cjs/globalization/labels/filters/index.d.ts +5 -0
  185. package/dist/cjs/globalization/labels/filters/index.js +17 -0
  186. package/dist/cjs/globalization/labels/index.d.ts +7 -0
  187. package/dist/cjs/globalization/labels/index.js +19 -0
  188. package/dist/cjs/globalization/labels/panel/I18N_PANEL.d.ts +2 -0
  189. package/dist/cjs/globalization/labels/panel/I18N_PANEL.js +34 -0
  190. package/dist/cjs/globalization/labels/panel/index.d.ts +1 -0
  191. package/dist/cjs/globalization/labels/panel/index.js +13 -0
  192. package/dist/cjs/globalization/labels/table_charts/I18N_TABLE_CHARTS.d.ts +2 -0
  193. package/dist/cjs/globalization/labels/table_charts/I18N_TABLE_CHARTS.js +36 -0
  194. package/dist/cjs/globalization/labels/table_charts/index.d.ts +1 -0
  195. package/dist/cjs/globalization/labels/table_charts/index.js +13 -0
  196. package/dist/cjs/globalization/service/i18nextBuilder.d.ts +9 -0
  197. package/dist/cjs/globalization/service/i18nextBuilder.js +61 -0
  198. package/dist/cjs/globalization/service/index.d.ts +2 -0
  199. package/dist/cjs/globalization/service/index.js +14 -0
  200. package/dist/cjs/globalization/service/initI18n.d.ts +3 -0
  201. package/dist/cjs/globalization/service/initI18n.js +19 -0
  202. package/dist/cjs/index.d.ts +1 -0
  203. package/dist/cjs/index.js +1 -0
  204. package/dist/cjs/interfaces/Qrvey.Interface.d.ts +0 -10
  205. package/dist/cjs/interfaces/general/IGeneralWidgetConfig.d.ts +1 -0
  206. package/dist/cjs/interfaces/index.d.ts +1 -1
  207. package/dist/cjs/interfaces/index.js +1 -1
  208. package/dist/cjs/qrvey/constants/CALCULATION_INFO_LIST.d.ts +1 -1
  209. package/dist/cjs/qrvey/constants/CALCULATION_INFO_LIST.js +2 -2
  210. package/dist/cjs/qrvey/constants/index.d.ts +1 -4
  211. package/dist/cjs/qrvey/constants/index.js +1 -4
  212. package/dist/{columns/interfaces/IColumnCalculationType.d.ts → cjs/qrvey/interfaces/ICalculationType.d.ts} +1 -1
  213. package/dist/cjs/qrvey/interfaces/ICalculationType.js +2 -0
  214. package/dist/cjs/qrvey/interfaces/index.d.ts +4 -0
  215. package/dist/cjs/qrvey/interfaces/index.js +4 -0
  216. package/dist/cjs/services/adapters/BColumnsToUIColumns.adapter.d.ts +4 -0
  217. package/dist/cjs/services/adapters/BColumnsToUIColumns.adapter.js +20 -0
  218. package/dist/cjs/services/adapters/BDatasetsToUIDatasets.adapter.d.ts +3 -0
  219. package/dist/cjs/services/adapters/BDatasetsToUIDatasets.adapter.js +13 -0
  220. package/dist/cjs/services/adapters/index.d.ts +2 -0
  221. package/dist/cjs/services/adapters/index.js +14 -0
  222. package/dist/cjs/services/api/getDatasetColumns.api.js +2 -1
  223. package/dist/cjs/services/helpers/Request.d.ts +1 -0
  224. package/dist/cjs/services/helpers/Request.js +7 -0
  225. package/dist/cjs/services/index.d.ts +1 -0
  226. package/dist/cjs/services/index.js +1 -0
  227. package/dist/columns/constants/COLUMN_INFO.js +2 -1
  228. package/dist/columns/interfaces/IBColumn.d.ts +1 -1
  229. package/dist/columns/interfaces/IColumn.d.ts +6 -4
  230. package/dist/columns/interfaces/index.d.ts +0 -2
  231. package/dist/columns/interfaces/index.js +0 -2
  232. package/dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js +1 -0
  233. package/dist/filters/helpers/common/getFilterColumnLabel.js +1 -1
  234. package/dist/filters/helpers/common/getFilterLabel.js +1 -2
  235. package/dist/filters/interfaces/builder/IFilterBuilderConfig.d.ts +2 -0
  236. package/dist/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts +1 -0
  237. package/dist/filters/interfaces/panel/IFilterPanelConfig.d.ts +2 -0
  238. package/dist/format/format.js +1 -1
  239. package/dist/general/mix/compareDeep.d.ts +8 -0
  240. package/dist/general/mix/compareDeep.js +29 -0
  241. package/dist/general/mix/index.d.ts +6 -5
  242. package/dist/general/mix/index.js +6 -5
  243. package/dist/general/object/index.d.ts +1 -0
  244. package/dist/general/object/index.js +1 -0
  245. package/dist/general/object/mergeDeep.d.ts +17 -0
  246. package/dist/general/object/mergeDeep.js +51 -0
  247. package/dist/globalization/index.d.ts +3 -1
  248. package/dist/globalization/index.js +3 -1
  249. package/dist/globalization/interfaces/IResourceI18n.d.ts +14 -0
  250. package/dist/globalization/interfaces/IResourceI18n.js +1 -0
  251. package/dist/globalization/interfaces/columns/II18nColumn.d.ts +10 -0
  252. package/dist/globalization/interfaces/columns/II18nColumn.js +1 -0
  253. package/dist/globalization/interfaces/columns/index.d.ts +1 -0
  254. package/dist/globalization/interfaces/columns/index.js +1 -0
  255. package/dist/globalization/interfaces/common/II18nAgreggateLabels.d.ts +11 -0
  256. package/dist/globalization/interfaces/common/II18nAgreggateLabels.js +1 -0
  257. package/dist/globalization/interfaces/common/II18nChartInfoMessagesCrosstab.d.ts +5 -0
  258. package/dist/globalization/interfaces/common/II18nChartInfoMessagesCrosstab.js +1 -0
  259. package/dist/globalization/interfaces/common/II18nChartInfoMessagesDefault.d.ts +8 -0
  260. package/dist/globalization/interfaces/common/II18nChartInfoMessagesDefault.js +1 -0
  261. package/dist/globalization/interfaces/common/II18nChartInfoMessagesTableChart.d.ts +8 -0
  262. package/dist/globalization/interfaces/common/II18nChartInfoMessagesTableChart.js +1 -0
  263. package/dist/globalization/interfaces/common/II18nColumnProperties.d.ts +46 -0
  264. package/dist/globalization/interfaces/common/II18nColumnProperties.js +1 -0
  265. package/dist/globalization/interfaces/common/II18nColumnTypes.d.ts +38 -0
  266. package/dist/globalization/interfaces/common/II18nColumnTypes.js +1 -0
  267. package/dist/globalization/interfaces/common/II18nCommon.d.ts +15 -0
  268. package/dist/globalization/interfaces/common/II18nCommon.js +1 -0
  269. package/dist/globalization/interfaces/common/index.d.ts +7 -0
  270. package/dist/globalization/interfaces/common/index.js +7 -0
  271. package/dist/globalization/interfaces/dashboard/II18nDashboard.d.ts +9 -0
  272. package/dist/globalization/interfaces/dashboard/II18nDashboard.js +1 -0
  273. package/dist/globalization/interfaces/dashboard/II18nDashboardAddChart.d.ts +5 -0
  274. package/dist/globalization/interfaces/dashboard/II18nDashboardAddChart.js +1 -0
  275. package/dist/globalization/interfaces/dashboard/II18nDashboardTooltips.d.ts +7 -0
  276. package/dist/globalization/interfaces/dashboard/II18nDashboardTooltips.js +1 -0
  277. package/dist/globalization/interfaces/dashboard/II18nDashboardViews.d.ts +6 -0
  278. package/dist/globalization/interfaces/dashboard/II18nDashboardViews.js +1 -0
  279. package/dist/globalization/interfaces/dashboard/index.d.ts +4 -0
  280. package/dist/globalization/interfaces/dashboard/index.js +4 -0
  281. package/dist/globalization/interfaces/filters/II18nFilter.d.ts +8 -0
  282. package/dist/globalization/interfaces/filters/II18nFilter.js +1 -0
  283. package/dist/globalization/interfaces/filters/II18nFilterBuilder.d.ts +17 -0
  284. package/dist/globalization/interfaces/filters/II18nFilterBuilder.js +1 -0
  285. package/dist/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.d.ts +4 -0
  286. package/dist/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.js +1 -0
  287. package/dist/globalization/interfaces/filters/II18nFilterBuilderInfoContainer.d.ts +5 -0
  288. package/dist/globalization/interfaces/filters/II18nFilterBuilderInfoContainer.js +1 -0
  289. package/dist/globalization/interfaces/filters/II18nFilterBuilderInfoContainerSelection.d.ts +4 -0
  290. package/dist/globalization/interfaces/filters/II18nFilterBuilderInfoContainerSelection.js +1 -0
  291. package/dist/globalization/interfaces/filters/II18nFilterBuilderSelectedValuesContainer.d.ts +3 -0
  292. package/dist/globalization/interfaces/filters/II18nFilterBuilderSelectedValuesContainer.js +1 -0
  293. package/dist/globalization/interfaces/filters/II18nFilterValidator.d.ts +23 -0
  294. package/dist/globalization/interfaces/filters/II18nFilterValidator.js +1 -0
  295. package/dist/globalization/interfaces/filters/II18nSlidebar.d.ts +6 -0
  296. package/dist/globalization/interfaces/filters/II18nSlidebar.js +1 -0
  297. package/dist/globalization/interfaces/filters/II18nValueContainer.d.ts +4 -0
  298. package/dist/globalization/interfaces/filters/II18nValueContainer.js +1 -0
  299. package/dist/globalization/interfaces/filters/II18nValueContainerSearchInput.d.ts +5 -0
  300. package/dist/globalization/interfaces/filters/II18nValueContainerSearchInput.js +1 -0
  301. package/dist/globalization/interfaces/filters/II18nValueContainerSearchInputEnterValue.d.ts +5 -0
  302. package/dist/globalization/interfaces/filters/II18nValueContainerSearchInputEnterValue.js +1 -0
  303. package/dist/globalization/interfaces/filters/index.d.ts +11 -0
  304. package/dist/globalization/interfaces/filters/index.js +11 -0
  305. package/dist/globalization/interfaces/index.d.ts +3 -0
  306. package/dist/globalization/interfaces/index.js +3 -0
  307. package/dist/globalization/interfaces/panel/II18nPanel.d.ts +9 -0
  308. package/dist/globalization/interfaces/panel/II18nPanel.js +1 -0
  309. package/dist/globalization/interfaces/panel/II18nPanelErrors.d.ts +9 -0
  310. package/dist/globalization/interfaces/panel/II18nPanelErrors.js +1 -0
  311. package/dist/globalization/interfaces/panel/II18nPanelMenu.d.ts +15 -0
  312. package/dist/globalization/interfaces/panel/II18nPanelMenu.js +1 -0
  313. package/dist/globalization/interfaces/panel/II18nPanelTooltips.d.ts +4 -0
  314. package/dist/globalization/interfaces/panel/II18nPanelTooltips.js +1 -0
  315. package/dist/globalization/interfaces/panel/index.d.ts +4 -0
  316. package/dist/globalization/interfaces/panel/index.js +4 -0
  317. package/dist/globalization/interfaces/table_charts/II18nTableCharts.d.ts +15 -0
  318. package/dist/globalization/interfaces/table_charts/II18nTableCharts.js +1 -0
  319. package/dist/globalization/interfaces/table_charts/II18nTableChartsInnerCharts.d.ts +8 -0
  320. package/dist/globalization/interfaces/table_charts/II18nTableChartsInnerCharts.js +1 -0
  321. package/dist/globalization/interfaces/table_charts/II18nTableChartsPagination.d.ts +4 -0
  322. package/dist/globalization/interfaces/table_charts/II18nTableChartsPagination.js +1 -0
  323. package/dist/globalization/interfaces/table_charts/II18nTableChartsSort.d.ts +9 -0
  324. package/dist/globalization/interfaces/table_charts/II18nTableChartsSort.js +1 -0
  325. package/dist/globalization/interfaces/table_charts/II18nTableChartsSortTooltip.d.ts +3 -0
  326. package/dist/globalization/interfaces/table_charts/II18nTableChartsSortTooltip.js +1 -0
  327. package/dist/globalization/interfaces/table_charts/II18nTableChartsVisualizationItems.d.ts +4 -0
  328. package/dist/globalization/interfaces/table_charts/II18nTableChartsVisualizationItems.js +1 -0
  329. package/dist/globalization/interfaces/table_charts/index.d.ts +6 -0
  330. package/dist/globalization/interfaces/table_charts/index.js +6 -0
  331. package/dist/globalization/labels/I18N_DEFAULT.d.ts +2 -0
  332. package/dist/globalization/labels/I18N_DEFAULT.js +14 -0
  333. package/dist/globalization/labels/columns/I18N_COLUMN.d.ts +2 -0
  334. package/dist/globalization/labels/columns/I18N_COLUMN.js +5 -0
  335. package/dist/globalization/labels/columns/index.d.ts +1 -0
  336. package/dist/globalization/labels/columns/index.js +1 -0
  337. package/dist/globalization/labels/common/I18N_AGGREGATE_LABEL.d.ts +2 -0
  338. package/dist/globalization/labels/common/I18N_AGGREGATE_LABEL.js +12 -0
  339. package/dist/globalization/labels/common/I18N_COLUMN_LABEL.d.ts +38 -0
  340. package/dist/globalization/labels/common/I18N_COLUMN_LABEL.js +39 -0
  341. package/dist/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.d.ts +46 -0
  342. package/dist/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.js +47 -0
  343. package/dist/globalization/labels/common/I18N_COMMON.d.ts +2 -0
  344. package/dist/globalization/labels/common/I18N_COMMON.js +30 -0
  345. package/dist/globalization/labels/common/index.d.ts +3 -0
  346. package/dist/globalization/labels/common/index.js +3 -0
  347. package/dist/globalization/labels/dashboard/I18N_DASHBOARD.d.ts +2 -0
  348. package/dist/globalization/labels/dashboard/I18N_DASHBOARD.js +21 -0
  349. package/dist/globalization/labels/dashboard/index.d.ts +1 -0
  350. package/dist/globalization/labels/dashboard/index.js +1 -0
  351. package/dist/globalization/labels/filters/I18N_FILTER.d.ts +2 -0
  352. package/dist/globalization/labels/filters/I18N_FILTER.js +8 -0
  353. package/dist/globalization/labels/filters/I18N_FILTER_BUILDER.d.ts +2 -0
  354. package/dist/globalization/labels/filters/I18N_FILTER_BUILDER.js +24 -0
  355. package/dist/globalization/labels/filters/I18N_FILTER_VALIDATOR.d.ts +2 -0
  356. package/dist/globalization/labels/filters/I18N_FILTER_VALIDATOR.js +24 -0
  357. package/dist/globalization/labels/filters/I18N_SLIDEBAR.d.ts +2 -0
  358. package/dist/globalization/labels/filters/I18N_SLIDEBAR.js +6 -0
  359. package/dist/globalization/labels/filters/I18N_VALUE_CONTAINER.d.ts +2 -0
  360. package/{src/globalization/filters/VALUES_CONTAINER.ts → dist/globalization/labels/filters/I18N_VALUE_CONTAINER.js} +1 -2
  361. package/dist/globalization/labels/filters/index.d.ts +5 -0
  362. package/dist/globalization/labels/filters/index.js +5 -0
  363. package/dist/globalization/labels/index.d.ts +7 -0
  364. package/dist/globalization/labels/index.js +7 -0
  365. package/dist/globalization/labels/panel/I18N_PANEL.d.ts +2 -0
  366. package/dist/globalization/labels/panel/I18N_PANEL.js +31 -0
  367. package/dist/globalization/labels/panel/index.d.ts +1 -0
  368. package/dist/globalization/labels/panel/index.js +1 -0
  369. package/dist/globalization/labels/table_charts/I18N_TABLE_CHARTS.d.ts +2 -0
  370. package/dist/globalization/labels/table_charts/I18N_TABLE_CHARTS.js +33 -0
  371. package/dist/globalization/labels/table_charts/index.d.ts +1 -0
  372. package/dist/globalization/labels/table_charts/index.js +1 -0
  373. package/dist/globalization/service/i18nextBuilder.d.ts +9 -0
  374. package/dist/globalization/service/i18nextBuilder.js +53 -0
  375. package/dist/globalization/service/index.d.ts +2 -0
  376. package/dist/globalization/service/index.js +2 -0
  377. package/dist/globalization/service/initI18n.d.ts +3 -0
  378. package/dist/globalization/service/initI18n.js +15 -0
  379. package/dist/index.d.ts +1 -0
  380. package/dist/index.js +1 -0
  381. package/dist/interfaces/Qrvey.Interface.d.ts +0 -10
  382. package/dist/interfaces/general/IGeneralWidgetConfig.d.ts +1 -0
  383. package/dist/interfaces/index.d.ts +1 -1
  384. package/dist/interfaces/index.js +1 -1
  385. package/dist/qrvey/constants/CALCULATION_INFO_LIST.d.ts +1 -1
  386. package/dist/qrvey/constants/CALCULATION_INFO_LIST.js +1 -1
  387. package/dist/qrvey/constants/index.d.ts +1 -4
  388. package/dist/qrvey/constants/index.js +1 -4
  389. package/dist/{cjs/columns/interfaces/IColumnCalculationType.d.ts → qrvey/interfaces/ICalculationType.d.ts} +1 -1
  390. package/dist/qrvey/interfaces/ICalculationType.js +1 -0
  391. package/dist/qrvey/interfaces/index.d.ts +4 -0
  392. package/dist/qrvey/interfaces/index.js +4 -0
  393. package/dist/services/adapters/BColumnsToUIColumns.adapter.d.ts +4 -0
  394. package/dist/services/adapters/BColumnsToUIColumns.adapter.js +16 -0
  395. package/dist/services/adapters/BDatasetsToUIDatasets.adapter.d.ts +3 -0
  396. package/dist/services/adapters/BDatasetsToUIDatasets.adapter.js +9 -0
  397. package/dist/services/adapters/index.d.ts +2 -0
  398. package/dist/services/adapters/index.js +2 -0
  399. package/dist/services/api/getDatasetColumns.api.js +2 -1
  400. package/dist/services/helpers/Request.d.ts +1 -0
  401. package/dist/services/helpers/Request.js +7 -0
  402. package/dist/services/index.d.ts +1 -0
  403. package/dist/services/index.js +1 -0
  404. package/package.json +7 -5
  405. package/src/{qrvey → charts}/constants/AGGREGATE.ts +0 -0
  406. package/src/{qrvey → charts}/constants/AGGREGATE_ABBREVIATION.ts +0 -0
  407. package/src/{qrvey → charts}/constants/AGGREGATE_INFO.ts +2 -2
  408. package/src/{qrvey → charts}/constants/AGGREGATE_INFO_LIST.ts +0 -0
  409. package/src/charts/constants/AGGREGATE_LABEL.ts +11 -0
  410. package/src/charts/constants/index.ts +5 -0
  411. package/src/charts/index.ts +2 -0
  412. package/src/charts/interfaces/IAggregateAbbreviation.ts +3 -0
  413. package/src/charts/interfaces/IAggregateInfo.ts +11 -0
  414. package/src/charts/interfaces/IAggregateLabel.ts +3 -0
  415. package/src/{qrvey/interfaces/IAggregate.ts → charts/interfaces/IAggregateType.ts} +1 -1
  416. package/src/charts/interfaces/index.ts +4 -0
  417. package/src/columns/constants/COLUMN_INFO.ts +29 -28
  418. package/src/columns/interfaces/IBColumn.ts +1 -1
  419. package/src/columns/interfaces/IColumn.ts +6 -4
  420. package/src/columns/interfaces/index.ts +0 -2
  421. package/src/filters/helpers/builder/getFilterBuilderGeneralConfig.ts +1 -0
  422. package/src/filters/helpers/common/getFilterColumnLabel.ts +1 -1
  423. package/src/filters/helpers/common/getFilterLabel.ts +1 -1
  424. package/src/filters/interfaces/builder/IFilterBuilderConfig.ts +2 -0
  425. package/src/filters/interfaces/builder/IFilterBuilderGeneralConfig.ts +1 -0
  426. package/src/filters/interfaces/panel/IFilterPanelConfig.ts +2 -0
  427. package/src/format/format.ts +1 -1
  428. package/src/general/mix/compareDeep.ts +32 -0
  429. package/src/general/mix/index.ts +6 -5
  430. package/src/general/object/index.ts +1 -0
  431. package/src/general/object/mergeDeep.ts +61 -0
  432. package/src/globalization/index.ts +3 -1
  433. package/src/globalization/interfaces/IResourceI18n.ts +16 -0
  434. package/src/globalization/interfaces/columns/II18nColumn.ts +7 -0
  435. package/src/globalization/interfaces/columns/index.ts +1 -0
  436. package/src/globalization/interfaces/common/II18nAgreggateLabels.ts +11 -0
  437. package/src/globalization/interfaces/common/II18nChartInfoMessagesCrosstab.ts +5 -0
  438. package/src/globalization/interfaces/common/II18nChartInfoMessagesDefault.ts +8 -0
  439. package/src/globalization/interfaces/common/II18nChartInfoMessagesTableChart.ts +8 -0
  440. package/src/globalization/interfaces/common/II18nColumnProperties.ts +52 -0
  441. package/src/globalization/interfaces/common/II18nColumnTypes.ts +42 -0
  442. package/src/globalization/interfaces/common/II18nCommon.ts +16 -0
  443. package/src/globalization/interfaces/common/index.ts +9 -0
  444. package/src/globalization/interfaces/dashboard/II18nDashboard.ts +10 -0
  445. package/src/globalization/interfaces/dashboard/II18nDashboardAddChart.ts +5 -0
  446. package/src/globalization/interfaces/dashboard/II18nDashboardTooltips.ts +7 -0
  447. package/src/globalization/interfaces/dashboard/II18nDashboardViews.ts +6 -0
  448. package/src/globalization/interfaces/dashboard/index.ts +4 -0
  449. package/src/globalization/interfaces/filters/II18nFilter.ts +9 -0
  450. package/src/globalization/interfaces/filters/II18nFilterBuilder.ts +16 -0
  451. package/src/globalization/interfaces/filters/II18nFilterBuilderColumnSelector.ts +4 -0
  452. package/src/globalization/interfaces/filters/II18nFilterBuilderInfoContainer.ts +6 -0
  453. package/src/globalization/interfaces/filters/II18nFilterBuilderInfoContainerSelection.ts +4 -0
  454. package/src/globalization/interfaces/filters/II18nFilterBuilderSelectedValuesContainer.ts +3 -0
  455. package/src/globalization/interfaces/filters/II18nFilterValidator.ts +23 -0
  456. package/src/globalization/interfaces/filters/II18nSlidebar.ts +6 -0
  457. package/src/globalization/interfaces/filters/II18nValueContainer.ts +5 -0
  458. package/src/globalization/interfaces/filters/II18nValueContainerSearchInput.ts +6 -0
  459. package/src/globalization/interfaces/filters/II18nValueContainerSearchInputEnterValue.ts +5 -0
  460. package/src/globalization/interfaces/filters/index.ts +12 -0
  461. package/src/globalization/interfaces/index.ts +3 -0
  462. package/src/globalization/interfaces/panel/II18nPanel.ts +10 -0
  463. package/src/globalization/interfaces/panel/II18nPanelErrors.ts +9 -0
  464. package/src/globalization/interfaces/panel/II18nPanelMenu.ts +15 -0
  465. package/src/globalization/interfaces/panel/II18nPanelTooltips.ts +4 -0
  466. package/src/globalization/interfaces/panel/index.ts +4 -0
  467. package/src/globalization/interfaces/table_charts/II18nTableCharts.ts +16 -0
  468. package/src/globalization/interfaces/table_charts/II18nTableChartsInnerCharts.ts +8 -0
  469. package/src/globalization/interfaces/table_charts/II18nTableChartsPagination.ts +4 -0
  470. package/src/globalization/interfaces/table_charts/II18nTableChartsSort.ts +10 -0
  471. package/src/globalization/interfaces/table_charts/II18nTableChartsSortTooltip.ts +3 -0
  472. package/src/globalization/interfaces/table_charts/II18nTableChartsVisualizationItems.ts +5 -0
  473. package/src/globalization/interfaces/table_charts/index.ts +6 -0
  474. package/src/globalization/labels/I18N_DEFAULT.ts +16 -0
  475. package/src/globalization/labels/columns/I18N_COLUMN.ts +9 -0
  476. package/src/globalization/labels/columns/index.ts +1 -0
  477. package/src/globalization/labels/common/I18N_AGGREGATE_LABEL.ts +14 -0
  478. package/src/globalization/labels/common/I18N_COLUMN_LABEL.ts +43 -0
  479. package/src/globalization/labels/common/I18N_COLUMN_PROPERTY_LABEL.ts +54 -0
  480. package/src/globalization/labels/common/I18N_COMMON.ts +32 -0
  481. package/src/globalization/labels/common/index.ts +5 -0
  482. package/src/globalization/labels/dashboard/I18N_DASHBOARD.ts +23 -0
  483. package/src/globalization/labels/dashboard/index.ts +1 -0
  484. package/src/globalization/labels/filters/I18N_FILTER.ts +10 -0
  485. package/src/globalization/labels/filters/I18N_FILTER_BUILDER.ts +26 -0
  486. package/src/globalization/labels/filters/I18N_FILTER_VALIDATOR.ts +27 -0
  487. package/src/globalization/labels/filters/I18N_SLIDEBAR.ts +8 -0
  488. package/{dist/globalization/filters/VALUES_CONTAINER.js → src/globalization/labels/filters/I18N_VALUE_CONTAINER.ts} +3 -2
  489. package/src/globalization/labels/filters/index.ts +7 -0
  490. package/src/globalization/labels/index.ts +8 -0
  491. package/src/globalization/labels/panel/I18N_PANEL.ts +33 -0
  492. package/src/globalization/labels/panel/index.ts +1 -0
  493. package/src/globalization/labels/table_charts/I18N_TABLE_CHARTS.ts +35 -0
  494. package/src/globalization/labels/table_charts/index.ts +1 -0
  495. package/src/globalization/service/i18nextBuilder.ts +51 -0
  496. package/src/globalization/service/index.ts +2 -0
  497. package/src/globalization/service/initI18n.ts +6 -0
  498. package/src/index.ts +1 -0
  499. package/src/interfaces/Qrvey.Interface.ts +0 -11
  500. package/src/interfaces/general/IGeneralWidgetConfig.ts +1 -0
  501. package/src/interfaces/index.ts +1 -1
  502. package/src/qrvey/constants/CALCULATION_INFO_LIST.ts +1 -1
  503. package/src/qrvey/constants/index.ts +1 -4
  504. package/src/{columns/interfaces/IColumnCalculationType.ts → qrvey/interfaces/ICalculationType.ts} +1 -1
  505. package/src/qrvey/interfaces/index.ts +5 -1
  506. package/src/services/adapters/BColumnsToUIColumns.adapter.ts +20 -0
  507. package/src/services/adapters/BDatasetsToUIDatasets.adapter.ts +12 -0
  508. package/src/services/adapters/index.ts +2 -0
  509. package/src/services/api/getDatasetColumns.api.ts +2 -2
  510. package/src/services/helpers/Request.ts +10 -1
  511. package/src/services/index.ts +1 -0
  512. package/src/stencil/util/index.ts +1 -1
  513. package/test/format.test.js +2 -2
  514. package/test/general/mix/compareDeep.test.js +880 -0
  515. package/test/general/object/mergeDeep.test.js +110 -0
  516. package/dist/cjs/columns/interfaces/IColumnAggregateType.d.ts +0 -2
  517. package/dist/cjs/globalization/filters/FILTER_BUILDER.d.ts +0 -129
  518. package/dist/cjs/globalization/filters/FILTER_BUILDER.js +0 -37
  519. package/dist/cjs/globalization/filters/SLIDEBAR.d.ts +0 -8
  520. package/dist/cjs/globalization/filters/VALUES_CONTAINER.d.ts +0 -11
  521. package/dist/cjs/globalization/filters/index.d.ts +0 -3
  522. package/dist/cjs/qrvey/constants/AGGREGATE_INFO.d.ts +0 -5
  523. package/dist/cjs/qrvey/constants/AGGREGATE_INFO_LIST.d.ts +0 -1
  524. package/dist/cjs/qrvey/constants/AGGREGATE_LABEL.d.ts +0 -11
  525. package/dist/cjs/qrvey/constants/AGGREGATE_LABEL.js +0 -15
  526. package/dist/cjs/qrvey/interfaces/IAggregateInfo.d.ts +0 -5
  527. package/dist/columns/interfaces/IColumnAggregateType.d.ts +0 -2
  528. package/dist/globalization/filters/FILTER_BUILDER.d.ts +0 -129
  529. package/dist/globalization/filters/FILTER_BUILDER.js +0 -34
  530. package/dist/globalization/filters/SLIDEBAR.d.ts +0 -8
  531. package/dist/globalization/filters/SLIDEBAR.js +0 -8
  532. package/dist/globalization/filters/VALUES_CONTAINER.d.ts +0 -11
  533. package/dist/globalization/filters/index.d.ts +0 -3
  534. package/dist/globalization/filters/index.js +0 -3
  535. package/dist/qrvey/constants/AGGREGATE_INFO.d.ts +0 -5
  536. package/dist/qrvey/constants/AGGREGATE_INFO_LIST.d.ts +0 -1
  537. package/dist/qrvey/constants/AGGREGATE_LABEL.d.ts +0 -11
  538. package/dist/qrvey/constants/AGGREGATE_LABEL.js +0 -12
  539. package/dist/qrvey/interfaces/IAggregateInfo.d.ts +0 -5
  540. package/src/columns/interfaces/IColumnAggregateType.ts +0 -3
  541. package/src/globalization/filters/FILTER_BUILDER.ts +0 -35
  542. package/src/globalization/filters/SLIDEBAR.ts +0 -8
  543. package/src/globalization/filters/index.ts +0 -3
  544. package/src/qrvey/constants/AGGREGATE_LABEL.ts +0 -11
  545. package/src/qrvey/interfaces/IAggregateInfo.ts +0 -7
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.2*
1
+ # [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.4-10*
2
2
 
3
3
  > Helper, Utils for all Qrvey Projects
4
4
 
@@ -351,12 +351,12 @@ Output:
351
351
 
352
352
 
353
353
 
354
- ### dist/filters/adapters/FDToFlatUI.js
354
+ ### dist/general/array/delete.js
355
355
 
356
356
 
357
- #### FDToFlatUI(filterData, datasetsInfo)
357
+ #### ArrayDelete(array, index)
358
358
 
359
- Generates a Flattened UI filter structure from Filter Data structure.
359
+ Inmutable Array Item deletion
360
360
 
361
361
 
362
362
 
@@ -365,8 +365,8 @@ Generates a Flattened UI filter structure from Filter Data structure.
365
365
 
366
366
  | Name | Type | Description | |
367
367
  | ---- | ---- | ----------- | -------- |
368
- | filterData | | The filter data object. |   |
369
- | datasetsInfo | | Collection of datasets information |   |
368
+ | array | `Array` | a collection of items to delete |   |
369
+ | index | `Number` | the position of the item to delete |   |
370
370
 
371
371
 
372
372
 
@@ -374,13 +374,20 @@ Generates a Flattened UI filter structure from Filter Data structure.
374
374
  ##### Returns
375
375
 
376
376
 
377
- - a flattened UI filters array
377
+ - a new Array or the given parameter when is empty or not an array
378
378
 
379
379
 
380
380
 
381
- #### FD21ToFlatUI(scopes, datasetsInfo)
382
381
 
383
- Generates a Filter Builder Structure from the Filter Data structure v2.1
382
+ ### dist/general/array/filterNestedTree.js
383
+
384
+
385
+ #### filterNestedTree(arr, childArrKey, condition)
386
+
387
+ Filters a nested tree array by a custom condition on the last child node
388
+ - If the given arguments are not valid, the function returns the first argument.
389
+ - If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
390
+ - If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
384
391
 
385
392
 
386
393
 
@@ -389,8 +396,9 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
389
396
 
390
397
  | Name | Type | Description | |
391
398
  | ---- | ---- | ----------- | -------- |
392
- | scopes | | The filter scope section |   |
393
- | datasetsInfo | | Collection of datasets information |   |
399
+ | arr | | nested tree array |   |
400
+ | childArrKey | | property representing the children array on the nested tree |   |
401
+ | condition | | function callback that determines if the filter is applied on the last child node of the nested tree |   |
394
402
 
395
403
 
396
404
 
@@ -398,17 +406,17 @@ Generates a Filter Builder Structure from the Filter Data structure v2.1
398
406
  ##### Returns
399
407
 
400
408
 
401
- - a flattened UI filters array
409
+ - array filtered
402
410
 
403
411
 
404
412
 
405
413
 
406
- ### dist/filters/adapters/FDToLogic.js
414
+ ### dist/general/array/flattenDeep.js
407
415
 
408
416
 
409
- #### FDToLogic(filterData)
417
+ #### flattenDeep(arr)
410
418
 
411
- Generates a Filter Logic structure from Filter Data structure.
419
+ Flat deeply an array
412
420
 
413
421
 
414
422
 
@@ -417,7 +425,7 @@ Generates a Filter Logic structure from Filter Data structure.
417
425
 
418
426
  | Name | Type | Description | |
419
427
  | ---- | ---- | ----------- | -------- |
420
- | filterData | | The filter data object. |   |
428
+ | arr | | Array to flat deeply |   |
421
429
 
422
430
 
423
431
 
@@ -425,13 +433,17 @@ Generates a Filter Logic structure from Filter Data structure.
425
433
  ##### Returns
426
434
 
427
435
 
428
- - a filter logic array
436
+ - flatten array
429
437
 
430
438
 
431
439
 
432
- #### getLogicBodyFromFD21(filterData)
433
440
 
434
- Gets the logic body
441
+ ### dist/general/array/getFirstIndexFromArray.js
442
+
443
+
444
+ #### getFirstIndexFromArray(array, callback)
445
+
446
+ Gets the first index from the array by a callback condition
435
447
 
436
448
 
437
449
 
@@ -440,7 +452,8 @@ Gets the logic body
440
452
 
441
453
  | Name | Type | Description | |
442
454
  | ---- | ---- | ----------- | -------- |
443
- | filterData | | The filter data object |   |
455
+ | array | | |   |
456
+ | callback | | function callback |   |
444
457
 
445
458
 
446
459
 
@@ -448,17 +461,17 @@ Gets the logic body
448
461
  ##### Returns
449
462
 
450
463
 
451
- - a filter logic array
464
+ - the first index of the array. -1 when the condition is not satisfied
452
465
 
453
466
 
454
467
 
455
468
 
456
- ### dist/filters/adapters/FDToUI.js
469
+ ### dist/general/array/getLastIndexFromArray.js
457
470
 
458
471
 
459
- #### FDToUI(filterData, datasetsInfo)
472
+ #### getLastIndexFromArray(array, callback)
460
473
 
461
- Generates a UI filter structure from Filter Data structure.
474
+ Gets the last index from the array by a callback condition
462
475
 
463
476
 
464
477
 
@@ -467,8 +480,8 @@ Generates a UI filter structure from Filter Data structure.
467
480
 
468
481
  | Name | Type | Description | |
469
482
  | ---- | ---- | ----------- | -------- |
470
- | filterData | | The filter data object. |   |
471
- | datasetsInfo | | Collection of datasets information |   |
483
+ | array | | |   |
484
+ | callback | | function callback |   |
472
485
 
473
486
 
474
487
 
@@ -476,13 +489,17 @@ Generates a UI filter structure from Filter Data structure.
476
489
  ##### Returns
477
490
 
478
491
 
479
- - a UI Filters structure
492
+ - the last index of the array. -1 when the condition is not satisfied
480
493
 
481
494
 
482
495
 
483
- #### FD21ToUI(scopes, section, version, datasetsInfo)
484
496
 
485
- Generates a UI filter Structure from the Filter Data structure v2.1
497
+ ### dist/general/function/debounce.js
498
+
499
+
500
+ #### debounce(fn, time)
501
+
502
+ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
486
503
 
487
504
 
488
505
 
@@ -491,10 +508,8 @@ Generates a UI filter Structure from the Filter Data structure v2.1
491
508
 
492
509
  | Name | Type | Description | |
493
510
  | ---- | ---- | ----------- | -------- |
494
- | scopes | | The filter scope section |   |
495
- | section | | The filter section. |   |
496
- | version | | The version of the filter structure |   |
497
- | datasetsInfo | | Collection of datasets information |   |
511
+ | fn | `Function` | original Function |   |
512
+ | time | `Number` | default 500ms |   |
498
513
 
499
514
 
500
515
 
@@ -502,17 +517,17 @@ Generates a UI filter Structure from the Filter Data structure v2.1
502
517
  ##### Returns
503
518
 
504
519
 
505
- - a UI filter Structure
520
+ - `Function` debounced functions
506
521
 
507
522
 
508
523
 
509
524
 
510
- ### dist/filters/adapters/UIToFD.js
525
+ ### dist/general/function/throttled.js
511
526
 
512
527
 
513
- #### UIToFD(filterData)
528
+ #### throttled(fn, time)
514
529
 
515
- Generates a Filter Data Structure structure from UI Filter Data structure.
530
+ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
516
531
 
517
532
 
518
533
 
@@ -521,7 +536,8 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
521
536
 
522
537
  | Name | Type | Description | |
523
538
  | ---- | ---- | ----------- | -------- |
524
- | filterData | | The UI filter data object. |   |
539
+ | fn | `Function` | original Function |   |
540
+ | time | `Number` | default 500ms |   |
525
541
 
526
542
 
527
543
 
@@ -529,13 +545,18 @@ Generates a Filter Data Structure structure from UI Filter Data structure.
529
545
  ##### Returns
530
546
 
531
547
 
532
- - a Filter Data structure
548
+ - `Function` throttled function
533
549
 
534
550
 
535
551
 
536
- #### UI21ToFD(uFilterData, version)
537
552
 
538
- Builds the Fitler Data structure from UI filter data
553
+ ### dist/general/mix/compareDeep.js
554
+
555
+
556
+ #### compareDeep(object1, object2)
557
+
558
+ Compares two objects to know if they are equals. Go across nested objects.
559
+ Includes arrays in the comparison.
539
560
 
540
561
 
541
562
 
@@ -544,8 +565,8 @@ Builds the Fitler Data structure from UI filter data
544
565
 
545
566
  | Name | Type | Description | |
546
567
  | ---- | ---- | ----------- | -------- |
547
- | uFilterData | | The UI filter Data object |   |
548
- | version | | the version of the structure |   |
568
+ | object1 | | First Object to compare |   |
569
+ | object2 | | Second Object to compare |   |
549
570
 
550
571
 
551
572
 
@@ -553,17 +574,17 @@ Builds the Fitler Data structure from UI filter data
553
574
  ##### Returns
554
575
 
555
576
 
556
- -
577
+ - True: objects are equal. False: Objects are not equal. Undefined: invalid
557
578
 
558
579
 
559
580
 
560
581
 
561
- ### dist/filters/adapters/UIToFlatUI.js
582
+ ### dist/general/mix/getTag.js
562
583
 
563
584
 
564
- #### UIToFlatUI(filterData, datasetsInfo)
585
+ #### getTag(value)
565
586
 
566
- Generates a Flattened UI filter structure from UI Filter Data structure.
587
+ Gets the `toStringTag` of `value`.
567
588
 
568
589
 
569
590
 
@@ -572,8 +593,7 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
572
593
 
573
594
  | Name | Type | Description | |
574
595
  | ---- | ---- | ----------- | -------- |
575
- | filterData | | The UI filter data object. |   |
576
- | datasetsInfo | | Collection of datasets information. Optional for updating the datasets info |   |
596
+ | value | | The value to query. |   |
577
597
 
578
598
 
579
599
 
@@ -581,13 +601,17 @@ Generates a Flattened UI filter structure from UI Filter Data structure.
581
601
  ##### Returns
582
602
 
583
603
 
584
- - a flattened UI filters array
604
+ - `string` Returns the `toStringTag`.
585
605
 
586
606
 
587
607
 
588
- #### UI21ToFlatUI(scopes)
589
608
 
590
- Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
609
+ ### dist/general/mix/importScripts.js
610
+
611
+
612
+ #### importScripts(scripts)
613
+
614
+ Import a set of external Scripts given the URL in both serie and cascade way
591
615
 
592
616
 
593
617
 
@@ -596,26 +620,54 @@ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
596
620
 
597
621
  | Name | Type | Description | |
598
622
  | ---- | ---- | ----------- | -------- |
599
- | scopes | | The filter scope section |   |
623
+ | scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | &nbsp; |
624
+ | scripts.url | `String` | CDN URL | &nbsp; |
625
+ | 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; |
626
+ | scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
627
+ | scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
628
+ | scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | &nbsp; |
600
629
 
601
630
 
602
631
 
603
632
 
604
- ##### Returns
633
+ ##### Examples
605
634
 
635
+ ```javascript
636
+ // 1) Simple script (paralell loading)
637
+ importScripts(['http://myscript.js', 'http://another.js']);
638
+
639
+ // 2) Loading `.js` and `.esm.js` script (parallel loading)
640
+ importScripts([
641
+ { url: 'http://myscript.esm.js', type: 'module' },
642
+ { url: 'http://myscript.js', noModule: true }
643
+ ]);
644
+
645
+ // 3) import dependent scripts (cascade)
646
+ importScripts([
647
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
648
+ ]);
649
+
650
+ // 4) mix
651
+ importScripts([
652
+ { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
653
+ { url: 'http://another.esm.js', type: 'module' },
654
+ { url: 'http://another.js', noModule: true },
655
+ 'http://simplescript.js'
656
+ ]);
657
+ ```
606
658
 
607
- - a flattened UI filters array
608
659
 
660
+ ##### Returns
609
661
 
610
662
 
663
+ - `Promise` Promise when all script have been loaded
611
664
 
612
- ### dist/filters/adapters/adaptDateGroupingProperty.js
613
665
 
614
666
 
615
- #### adaptDateGroupingProperty(property)
667
+ #### loadScript(url, type, noModule)
616
668
 
617
- [TODO: For 2022, eliminate this adapter]
618
- Get the new property base on the old date grouping properties
669
+ Creates the script element and appends to document.head
670
+ return a Promise that is resolved when the script is loaded
619
671
 
620
672
 
621
673
 
@@ -624,7 +676,9 @@ Get the new property base on the old date grouping properties
624
676
 
625
677
  | Name | Type | Description | |
626
678
  | ---- | ---- | ----------- | -------- |
627
- | property | | | &nbsp; |
679
+ | url | `String` | Cdn Url | &nbsp; |
680
+ | type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
681
+ | noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
628
682
 
629
683
 
630
684
 
@@ -632,17 +686,17 @@ Get the new property base on the old date grouping properties
632
686
  ##### Returns
633
687
 
634
688
 
635
- -
689
+ - `Void`
636
690
 
637
691
 
638
692
 
639
693
 
640
- ### dist/filters/adapters/adaptFilterData.js
694
+ ### dist/general/mix/isEmpty.js
641
695
 
642
696
 
643
- #### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
697
+ #### isEmpty(variable, includeFalsy)
644
698
 
645
- Checks and adapts the v2.0 Filter Data Structure to the v2.1
699
+ Validates if the given argument is empty
646
700
 
647
701
 
648
702
 
@@ -651,9 +705,8 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
651
705
 
652
706
  | Name | Type | Description | |
653
707
  | ---- | ---- | ----------- | -------- |
654
- | filterData | | The filter data structure. Accepts both v2.1 or v2.0 | &nbsp; |
655
- | getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | &nbsp; |
656
- | datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | &nbsp; |
708
+ | variable | | the given variable | &nbsp; |
709
+ | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
657
710
 
658
711
 
659
712
 
@@ -661,18 +714,18 @@ Checks and adapts the v2.0 Filter Data Structure to the v2.1
661
714
  ##### Returns
662
715
 
663
716
 
664
- - A new filter data structure v2.1
717
+ - true: the given argument is empty; false: is not.
665
718
 
666
719
 
667
720
 
668
721
 
669
- ### dist/filters/adapters/adaptFilterValues.js
722
+ ### dist/general/mix/isNull.js
670
723
 
671
724
 
672
- #### adaptFilterValues(filter)
725
+ #### isNull(arg)
673
726
 
674
- [TODO: For 2022, eliminate this adapter]
675
- Gets an adapted filter value array. Validates the enabled property and sets
727
+ return if a given variable is either `null` or `undefined`
728
+ useful to avoid falsify validating Number Zero (0)
676
729
 
677
730
 
678
731
 
@@ -681,7 +734,7 @@ Gets an adapted filter value array. Validates the enabled property and sets
681
734
 
682
735
  | Name | Type | Description | |
683
736
  | ---- | ---- | ----------- | -------- |
684
- | filter | | The filter | &nbsp; |
737
+ | arg | `any` | | &nbsp; |
685
738
 
686
739
 
687
740
 
@@ -689,17 +742,19 @@ Gets an adapted filter value array. Validates the enabled property and sets
689
742
  ##### Returns
690
743
 
691
744
 
692
- - A new value array with the filled properties.
745
+ - `Boolean`
693
746
 
694
747
 
695
748
 
696
749
 
697
- ### dist/filters/adapters/flatUIToFD.js
750
+ ### dist/general/mix/randomId.js
698
751
 
699
752
 
700
- #### flatUIToFD(uFilters, version)
753
+ #### randomId(length, exclude)
701
754
 
702
- Generates a filter data structure from the flatttened UI filters.
755
+ Creates a random string
756
+ - If the first given argument is different than a length number, the variable is replaced by a default number
757
+ - If the optional second given argument is passed the random string is permutated.
703
758
 
704
759
 
705
760
 
@@ -708,8 +763,8 @@ Generates a filter data structure from the flatttened UI filters.
708
763
 
709
764
  | Name | Type | Description | |
710
765
  | ---- | ---- | ----------- | -------- |
711
- | uFilters | | Array of flattened filters from UI | &nbsp; |
712
- | version | | Tag for the version of the filter data structure | &nbsp; |
766
+ | length | `Number` | size of the generated string. Default 8 | &nbsp; |
767
+ | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
713
768
 
714
769
 
715
770
 
@@ -717,14 +772,19 @@ Generates a filter data structure from the flatttened UI filters.
717
772
  ##### Returns
718
773
 
719
774
 
720
- - a Filter Data.
775
+ - `String` Random string
721
776
 
722
777
 
723
778
 
724
- #### buildScopes(fbFilters)
725
779
 
726
- Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
727
- Also, adds and organizes filters by datasets
780
+ ### dist/general/mix/size.js
781
+
782
+
783
+ #### size(obj)
784
+
785
+ Gets the length of the given array.
786
+ - Useful for Object, Array and string type.
787
+ - For `null` or `undefined` or else argument the returned value will be 0.
728
788
 
729
789
 
730
790
 
@@ -733,7 +793,7 @@ Also, adds and organizes filters by datasets
733
793
 
734
794
  | Name | Type | Description | |
735
795
  | ---- | ---- | ----------- | -------- |
736
- | fbFilters | | Array of flat filters from UI | &nbsp; |
796
+ | obj | `Any` | Any object-type variable | &nbsp; |
737
797
 
738
798
 
739
799
 
@@ -741,13 +801,17 @@ Also, adds and organizes filters by datasets
741
801
  ##### Returns
742
802
 
743
803
 
744
- - an array of scopes structure.
804
+ - `Number` the size of the given variable
745
805
 
746
806
 
747
807
 
748
- #### buildScope(uFilter)
749
808
 
750
- Gets an scope structure for the filter data
809
+ ### dist/general/string/capitalize.js
810
+
811
+
812
+ #### capitalize(text)
813
+
814
+ Upper case the first letter of a given text
751
815
 
752
816
 
753
817
 
@@ -756,7 +820,7 @@ Gets an scope structure for the filter data
756
820
 
757
821
  | Name | Type | Description | |
758
822
  | ---- | ---- | ----------- | -------- |
759
- | uFilter | | UI structure filter | &nbsp; |
823
+ | text | `String` | | &nbsp; |
760
824
 
761
825
 
762
826
 
@@ -764,13 +828,18 @@ Gets an scope structure for the filter data
764
828
  ##### Returns
765
829
 
766
830
 
767
- - an scope structure
831
+ - `String` a capitalized text
768
832
 
769
833
 
770
834
 
771
- #### buildDataset(uFilter)
772
835
 
773
- Gets an dataset structure for the filter data
836
+ ### dist/general/object/cloneDeep.js
837
+
838
+
839
+ #### cloneDeep(obj)
840
+
841
+ A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
842
+ Not to use this function with inner objects and functions
774
843
 
775
844
 
776
845
 
@@ -779,7 +848,7 @@ Gets an dataset structure for the filter data
779
848
 
780
849
  | Name | Type | Description | |
781
850
  | ---- | ---- | ----------- | -------- |
782
- | uFilter | | a UI structure filter | &nbsp; |
851
+ | obj | | The object | &nbsp; |
783
852
 
784
853
 
785
854
 
@@ -787,40 +856,82 @@ Gets an dataset structure for the filter data
787
856
  ##### Returns
788
857
 
789
858
 
790
- - an dataset structure
859
+ - The new reference object or the given object if the parsing is incorrect or empty
791
860
 
792
861
 
793
862
 
794
- #### buildFilter(uFilter)
795
863
 
796
- Gets an filter structure for the filter data
864
+ ### dist/general/object/get.js
797
865
 
798
866
 
867
+ #### _get(baseObject, path, defaultValue)
799
868
 
869
+ Like lodash _.get.
870
+ Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
800
871
 
801
- ##### Parameters
872
+ Empty arrays and empty objects are returned but the defaultValue is not
873
+ Undefined and null values will return the defaultValue.
802
874
 
803
- | Name | Type | Description | |
875
+
876
+
877
+
878
+ ##### Parameters
879
+
880
+ | Name | Type | Description | |
804
881
  | ---- | ---- | ----------- | -------- |
805
- | uFilter | | a UI structure filter | &nbsp; |
882
+ | baseObject | | The object to query | &nbsp; |
883
+ | path | | The string path or collection of string paths of the property to get. | &nbsp; |
884
+ | defaultValue | | The value returned for undefined resolved values. | &nbsp; |
885
+
886
+
806
887
 
807
888
 
889
+ ##### Examples
890
+
891
+ ```javascript
892
+ // returns 'Hello'
893
+ _get({ item1: 'Hello', item2: 'World' }, 'item1')
894
+ ```
895
+ ```javascript
896
+ // returns 'A simple Hello'
897
+ _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
898
+ ```
899
+ ```javascript
900
+ // returns 'Hello Again'
901
+ _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
902
+ ```
903
+ ```javascript
904
+ // returns 'Hello 2'
905
+ _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
906
+ ```
907
+ ```javascript
908
+ // returns 'Hello Again'
909
+ _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
910
+ ```
808
911
 
809
912
 
810
913
  ##### Returns
811
914
 
812
915
 
813
- - an filter structure
916
+ - the resolved value.
814
917
 
815
918
 
816
919
 
817
920
 
818
- ### dist/filters/adapters/flatUIToLogic.js
921
+ ### dist/general/object/getAttribute.js
819
922
 
820
923
 
821
- #### flatUIToLogic(uFilter)
924
+ #### getAttribute(obj, key)
822
925
 
823
- Generates a Logic structure from flattened UI filters
926
+ Searchs for properties in different case styles such as: lower, upper, camel and pascal
927
+ - To optimize the searching, it is required a key in a snake_case style
928
+ - List of cases that do not match
929
+ -- From lower to snake case
930
+ -- From upper to snake case
931
+ -- From lower to camel case
932
+ -- From upper to camel case
933
+ -- From lower to pascal case
934
+ -- From upper to pascal case
824
935
 
825
936
 
826
937
 
@@ -829,25 +940,33 @@ Generates a Logic structure from flattened UI filters
829
940
 
830
941
  | Name | Type | Description | |
831
942
  | ---- | ---- | ----------- | -------- |
832
- | uFilter | | Array of flat filters from UI | &nbsp; |
943
+ | obj | `object` | object to look for | &nbsp; |
944
+ | key | `string` | String attribute in snake_case style | &nbsp; |
945
+
946
+
947
+
833
948
 
949
+ ##### Examples
834
950
 
951
+ ```javascript
952
+ getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
953
+ ```
835
954
 
836
955
 
837
956
  ##### Returns
838
957
 
839
958
 
840
- - The logic structure
959
+ - `Void`
841
960
 
842
961
 
843
962
 
844
963
 
845
- ### dist/filters/adapters/flatUIToOldLogic.js
964
+ ### dist/general/object/hasProperty.js
846
965
 
847
966
 
848
- #### flatUIToOldLogic(uFilters)
967
+ #### _hasProperty(obj, property)
849
968
 
850
- Generates a Logic structure from flattened UI filters
969
+ Use the hasOwnProperty in order to verify if the given property exists in the object.
851
970
 
852
971
 
853
972
 
@@ -856,25 +975,38 @@ Generates a Logic structure from flattened UI filters
856
975
 
857
976
  | Name | Type | Description | |
858
977
  | ---- | ---- | ----------- | -------- |
859
- | uFilters | | Array of flat filters from UI | &nbsp; |
978
+ | obj | `object` | an object | &nbsp; |
979
+ | property | `string` | String to verify if exists in the object as property | &nbsp; |
980
+
860
981
 
861
982
 
862
983
 
984
+ ##### Examples
985
+
986
+ ```javascript
987
+ const prop = 'prop2'
988
+ const obj1 = { prop1: 'hello', prop2: 'world'}
989
+ _hasProperty(ob1, prop1) // true
990
+
991
+ const obj2 = { prop1: 'hello world' }
992
+ _hasProperty(ob1, prop2) // false
993
+ ```
994
+
863
995
 
864
996
  ##### Returns
865
997
 
866
998
 
867
- - The logic structure
999
+ - True if the object has the given property; otherwise, false.
868
1000
 
869
1001
 
870
1002
 
871
1003
 
872
- ### dist/filters/adapters/flatUIToUI.js
1004
+ ### dist/general/object/isObject.js
873
1005
 
874
1006
 
875
- #### flatUIToUI(uFilters, version)
1007
+ #### isObject(obj)
876
1008
 
877
- Generates a UI filter data structure from the flatttened UI filters.
1009
+ Checks if the given argument is an object type
878
1010
 
879
1011
 
880
1012
 
@@ -883,8 +1015,7 @@ Generates a UI filter data structure from the flatttened UI filters.
883
1015
 
884
1016
  | Name | Type | Description | |
885
1017
  | ---- | ---- | ----------- | -------- |
886
- | uFilters | | Array of flattened filters from UI | &nbsp; |
887
- | version | | Tag for the version of the filter data structure | &nbsp; |
1018
+ | obj | | the variable to check | &nbsp; |
888
1019
 
889
1020
 
890
1021
 
@@ -892,14 +1023,18 @@ Generates a UI filter data structure from the flatttened UI filters.
892
1023
  ##### Returns
893
1024
 
894
1025
 
895
- - a UI Filter Data.
1026
+ - True: It is an object; False: It is not.
896
1027
 
897
1028
 
898
1029
 
899
- #### buildScopes(fbFilters)
900
1030
 
901
- Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
902
- Also, adds and organizes filters by datasets
1031
+ ### dist/general/object/mapValues.js
1032
+
1033
+
1034
+ #### mapValues(baseObject, iteratee)
1035
+
1036
+ Invoke iteratee (function) for each object key-value pair
1037
+ and return a mapped object
903
1038
 
904
1039
 
905
1040
 
@@ -908,7 +1043,8 @@ Also, adds and organizes filters by datasets
908
1043
 
909
1044
  | Name | Type | Description | |
910
1045
  | ---- | ---- | ----------- | -------- |
911
- | fbFilters | | Array of flat filters from UI | &nbsp; |
1046
+ | baseObject | `Object` | Base object. | &nbsp; |
1047
+ | iteratee | `Function` | The executed per iteration. | &nbsp; |
912
1048
 
913
1049
 
914
1050
 
@@ -916,13 +1052,18 @@ Also, adds and organizes filters by datasets
916
1052
  ##### Returns
917
1053
 
918
1054
 
919
- - an array of scopes structure.
1055
+ - `Object` New mapped object.
920
1056
 
921
1057
 
922
1058
 
923
- #### buildScope(uFilter)
924
1059
 
925
- Gets an scope structure for the UI filter data
1060
+ ### dist/general/object/mergeDeep.js
1061
+
1062
+
1063
+ #### mergeDeep(obj1, obj2, settings)
1064
+
1065
+ Merges two objects into a new one.
1066
+ The second given argument to the first given argument.
926
1067
 
927
1068
 
928
1069
 
@@ -931,7 +1072,9 @@ Gets an scope structure for the UI filter data
931
1072
 
932
1073
  | Name | Type | Description | |
933
1074
  | ---- | ---- | ----------- | -------- |
934
- | uFilter | | UI structure filter | &nbsp; |
1075
+ | obj1 | | The target object | &nbsp; |
1076
+ | obj2 | | The object to be merged | &nbsp; |
1077
+ | settings | | Object settings for this function | &nbsp; |
935
1078
 
936
1079
 
937
1080
 
@@ -939,13 +1082,13 @@ Gets an scope structure for the UI filter data
939
1082
  ##### Returns
940
1083
 
941
1084
 
942
- - an scope structure
1085
+ - a new merged object
943
1086
 
944
1087
 
945
1088
 
946
- #### buildDataset(uFilter)
1089
+ #### isValid(obj1, obj2)
947
1090
 
948
- Gets an dataset structure for the UI filter data
1091
+ Validates if the two arguments are objects
949
1092
 
950
1093
 
951
1094
 
@@ -954,7 +1097,8 @@ Gets an dataset structure for the UI filter data
954
1097
 
955
1098
  | Name | Type | Description | |
956
1099
  | ---- | ---- | ----------- | -------- |
957
- | uFilter | | a UI structure filter | &nbsp; |
1100
+ | obj1 | | The target object | &nbsp; |
1101
+ | obj2 | | The object to be merged | &nbsp; |
958
1102
 
959
1103
 
960
1104
 
@@ -962,13 +1106,13 @@ Gets an dataset structure for the UI filter data
962
1106
  ##### Returns
963
1107
 
964
1108
 
965
- - an dataset structure
1109
+ - true: they are valid; false: they are not
966
1110
 
967
1111
 
968
1112
 
969
- #### buildFilter(uFilter)
1113
+ #### getParamsToMergeDeep(settings)
970
1114
 
971
- Gets an filter structure for the UI filter data
1115
+ Validates and gets the settings with all set parameters.
972
1116
 
973
1117
 
974
1118
 
@@ -977,7 +1121,7 @@ Gets an filter structure for the UI filter data
977
1121
 
978
1122
  | Name | Type | Description | |
979
1123
  | ---- | ---- | ----------- | -------- |
980
- | uFilter | | a UI structure filter | &nbsp; |
1124
+ | settings | | the settings object | &nbsp; |
981
1125
 
982
1126
 
983
1127
 
@@ -985,17 +1129,17 @@ Gets an filter structure for the UI filter data
985
1129
  ##### Returns
986
1130
 
987
1131
 
988
- - an filter structure
1132
+ - a new settings object with all set parameters.
989
1133
 
990
1134
 
991
1135
 
992
1136
 
993
- ### dist/filters/adapters/logicToFD.js
1137
+ ### dist/general/object/objectCopy.js
994
1138
 
995
1139
 
996
- #### logicToFD(filterData, version)
1140
+ #### objectCopy(entity, cache)
997
1141
 
998
- Generates a filter data structure from the old logic structure (v2.0).
1142
+ Created a new reference of the given argument
999
1143
 
1000
1144
 
1001
1145
 
@@ -1004,8 +1148,8 @@ Generates a filter data structure from the old logic structure (v2.0).
1004
1148
 
1005
1149
  | Name | Type | Description | |
1006
1150
  | ---- | ---- | ----------- | -------- |
1007
- | filterData | | The old filter data structure with logic (v2.0) | &nbsp; |
1008
- | version | | Tag for the version of the filter data structure | &nbsp; |
1151
+ | entity | | The variable to be copied | &nbsp; |
1152
+ | cache | | | &nbsp; |
1009
1153
 
1010
1154
 
1011
1155
 
@@ -1013,17 +1157,17 @@ Generates a filter data structure from the old logic structure (v2.0).
1013
1157
  ##### Returns
1014
1158
 
1015
1159
 
1016
- - a Filter Data.
1160
+ - A new reference of the given argument
1017
1161
 
1018
1162
 
1019
1163
 
1020
1164
 
1021
- ### dist/filters/adapters/logicToFlatUI.js
1165
+ ### dist/general/object/omit.js
1022
1166
 
1023
1167
 
1024
- #### logicToFlatUI(logics)
1168
+ #### omit(obj, props)
1025
1169
 
1026
- Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1170
+ return a new Object excluding attributes in _props_ list
1027
1171
 
1028
1172
 
1029
1173
 
@@ -1032,7 +1176,8 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1032
1176
 
1033
1177
  | Name | Type | Description | |
1034
1178
  | ---- | ---- | ----------- | -------- |
1035
- | logics | | The old logic structure (v2.0) | &nbsp; |
1179
+ | obj | `Object` | base object | &nbsp; |
1180
+ | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
1036
1181
 
1037
1182
 
1038
1183
 
@@ -1040,13 +1185,17 @@ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1040
1185
  ##### Returns
1041
1186
 
1042
1187
 
1043
- - The Flattened UI Filters array
1188
+ - `Object` clean object
1044
1189
 
1045
1190
 
1046
1191
 
1047
- #### getFilter(filters, filter, getIndex)
1048
1192
 
1049
- Get the filter or the index of the given array, validating an old filter structure.
1193
+ ### dist/general/object/pick.js
1194
+
1195
+
1196
+ #### pick(baseObject, keys)
1197
+
1198
+ return a new object just with attributes in _keys_ list
1050
1199
 
1051
1200
 
1052
1201
 
@@ -1055,9 +1204,8 @@ Get the filter or the index of the given array, validating an old filter structu
1055
1204
 
1056
1205
  | Name | Type | Description | |
1057
1206
  | ---- | ---- | ----------- | -------- |
1058
- | filters | | The array of UI filters | &nbsp; |
1059
- | filter | | The old logic structure filter | &nbsp; |
1060
- | getIndex | | Determines if the index or returns the UI filter object | &nbsp; |
1207
+ | baseObject | `Object` | base object | &nbsp; |
1208
+ | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
1061
1209
 
1062
1210
 
1063
1211
 
@@ -1065,13 +1213,17 @@ Get the filter or the index of the given array, validating an old filter structu
1065
1213
  ##### Returns
1066
1214
 
1067
1215
 
1068
- - the index or the UI filter object
1216
+ - `Object` new object just with desired attributes
1069
1217
 
1070
1218
 
1071
1219
 
1072
- #### refineRankingValues(values, uiValues)
1073
1220
 
1074
- Refines the values of the Ranking column type.
1221
+ ### dist/general/object/serialize.js
1222
+
1223
+
1224
+ #### serialize(obj)
1225
+
1226
+ serialize object to url param
1075
1227
 
1076
1228
 
1077
1229
 
@@ -1080,8 +1232,7 @@ Refines the values of the Ranking column type.
1080
1232
 
1081
1233
  | Name | Type | Description | |
1082
1234
  | ---- | ---- | ----------- | -------- |
1083
- | values | | the Array of Ranking values | &nbsp; |
1084
- | uiValues | | Object with additional info about the values of the filter. | &nbsp; |
1235
+ | obj | | - Object to be serialized | &nbsp; |
1085
1236
 
1086
1237
 
1087
1238
 
@@ -1089,17 +1240,17 @@ Refines the values of the Ranking column type.
1089
1240
  ##### Returns
1090
1241
 
1091
1242
 
1092
- - the array of Ranking values
1243
+ - `Void`
1093
1244
 
1094
1245
 
1095
1246
 
1096
1247
 
1097
- ### dist/filters/adapters/logicToUI.js
1248
+ ### dist/filters/adapters/FDToFlatUI.js
1098
1249
 
1099
1250
 
1100
- #### logicToUI(uFilters, datasetsInfo)
1251
+ #### FDToFlatUI(filterData, datasetsInfo)
1101
1252
 
1102
- Generates a UI filter structure from the old logic structure (v2.0).
1253
+ Generates a Flattened UI filter structure from Filter Data structure.
1103
1254
 
1104
1255
 
1105
1256
 
@@ -1108,7 +1259,7 @@ Generates a UI filter structure from the old logic structure (v2.0).
1108
1259
 
1109
1260
  | Name | Type | Description | |
1110
1261
  | ---- | ---- | ----------- | -------- |
1111
- | uFilters | | Array of filters from old logic structure | &nbsp; |
1262
+ | filterData | | The filter data object. | &nbsp; |
1112
1263
  | datasetsInfo | | Collection of datasets information | &nbsp; |
1113
1264
 
1114
1265
 
@@ -1117,17 +1268,13 @@ Generates a UI filter structure from the old logic structure (v2.0).
1117
1268
  ##### Returns
1118
1269
 
1119
1270
 
1120
- - a UI Filter Data.
1121
-
1122
-
1123
-
1271
+ - a flattened UI filters array
1124
1272
 
1125
- ### dist/filters/adapters/transformFilters.js
1126
1273
 
1127
1274
 
1128
- #### transformFilters(oldFiltersObj, section)
1275
+ #### FD21ToFlatUI(scopes, datasetsInfo)
1129
1276
 
1130
- Transform the old filters structure into the new one
1277
+ Generates a Filter Builder Structure from the Filter Data structure v2.1
1131
1278
 
1132
1279
 
1133
1280
 
@@ -1136,77 +1283,49 @@ Transform the old filters structure into the new one
1136
1283
 
1137
1284
  | Name | Type | Description | |
1138
1285
  | ---- | ---- | ----------- | -------- |
1139
- | oldFiltersObj | `Object` | an object with the old filters structure | &nbsp; |
1140
- | section | `String` | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
1286
+ | scopes | | The filter scope section | &nbsp; |
1287
+ | datasetsInfo | | Collection of datasets information | &nbsp; |
1141
1288
 
1142
1289
 
1143
1290
 
1144
1291
 
1145
- ##### Examples
1292
+ ##### Returns
1146
1293
 
1147
- ```javascript
1148
1294
 
1149
- const oldPreferenceFilters = {
1150
- "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
1151
- "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
1152
- "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
1153
- "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
1154
- "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
1155
- "formulaId": null,
1156
- "panelId": null,
1157
- "values": [
1158
- {
1159
- "EQUALS": [
1160
- {
1161
- "id": "AK4M8UV2a0",
1162
- "value": "A",
1163
- "enabled": true,
1164
- "imageUrl": null
1165
- },
1166
- {
1167
- "id": "AK4M8UV2a1",
1168
- "value": "B",
1169
- "enabled": true,
1170
- "imageUrl": null
1171
- }
1172
- ]
1173
- }
1174
- ],
1175
- "bucketId": null,
1176
- "text": "MC",
1177
- "title": "MC",
1178
- "type": "SINGLE_CHOICE",
1179
- "qid": "AK4M8UV2",
1180
- "dataset": {
1181
- "sourceid": "xYOQAdpqT",
1182
- "name": "Form All Questions",
1183
- "qrveyid": "xYOQAdpqT",
1184
- "text": "Form All Questions",
1185
- "linkid": 0
1186
- },
1187
- "enabled": true,
1188
- "linked": null
1189
- }
1190
- };
1295
+ - a flattened UI filters array
1191
1296
 
1192
- const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1193
- ```
1194
1297
 
1195
1298
 
1196
- ##### Returns
1197
1299
 
1300
+ ### dist/filters/adapters/FDToLogic.js
1198
1301
 
1199
- - `Object` an object with the new filters structure
1200
1302
 
1303
+ #### FDToLogic(filterData)
1201
1304
 
1305
+ Generates a Filter Logic structure from Filter Data structure.
1202
1306
 
1203
1307
 
1204
- ### dist/filters/helpers/applyHierarchyForAggFilters.js
1205
1308
 
1206
1309
 
1207
- #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
1310
+ ##### Parameters
1208
1311
 
1209
- [TODO: Make a proper description for this function]
1312
+ | Name | Type | Description | |
1313
+ | ---- | ---- | ----------- | -------- |
1314
+ | filterData | | The filter data object. | &nbsp; |
1315
+
1316
+
1317
+
1318
+
1319
+ ##### Returns
1320
+
1321
+
1322
+ - a filter logic array
1323
+
1324
+
1325
+
1326
+ #### getLogicBodyFromFD21(filterData)
1327
+
1328
+ Gets the logic body
1210
1329
 
1211
1330
 
1212
1331
 
@@ -1215,9 +1334,7 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1215
1334
 
1216
1335
  | Name | Type | Description | |
1217
1336
  | ---- | ---- | ----------- | -------- |
1218
- | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
1219
- | scopes | | | &nbsp; |
1220
- | currentScope | | | &nbsp; |
1337
+ | filterData | | The filter data object | &nbsp; |
1221
1338
 
1222
1339
 
1223
1340
 
@@ -1225,17 +1342,17 @@ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
1225
1342
  ##### Returns
1226
1343
 
1227
1344
 
1228
- -
1345
+ - a filter logic array
1229
1346
 
1230
1347
 
1231
1348
 
1232
1349
 
1233
- ### dist/filters/helpers/getAvailableScopes.js
1350
+ ### dist/filters/adapters/FDToUI.js
1234
1351
 
1235
1352
 
1236
- #### getAvailableScopes(config)
1353
+ #### FDToUI(filterData, datasetsInfo)
1237
1354
 
1238
- Gets Scopes/Scope IDs by given IDs
1355
+ Generates a UI filter structure from Filter Data structure.
1239
1356
 
1240
1357
 
1241
1358
 
@@ -1244,7 +1361,8 @@ Gets Scopes/Scope IDs by given IDs
1244
1361
 
1245
1362
  | Name | Type | Description | |
1246
1363
  | ---- | ---- | ----------- | -------- |
1247
- | config | | given Differnts IDs in order set a available scope | &nbsp; |
1364
+ | filterData | | The filter data object. | &nbsp; |
1365
+ | datasetsInfo | | Collection of datasets information | &nbsp; |
1248
1366
 
1249
1367
 
1250
1368
 
@@ -1252,17 +1370,13 @@ Gets Scopes/Scope IDs by given IDs
1252
1370
  ##### Returns
1253
1371
 
1254
1372
 
1255
- - a Scopes/Scope IDs array
1256
-
1257
-
1258
-
1373
+ - a UI Filters structure
1259
1374
 
1260
- ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
1261
1375
 
1262
1376
 
1263
- #### getAvailableScopesIDsByConfig(config)
1377
+ #### FD21ToUI(scopes, section, version, datasetsInfo)
1264
1378
 
1265
- Gets the Scopes IDS for the Available Scope function by any config
1379
+ Generates a UI filter Structure from the Filter Data structure v2.1
1266
1380
 
1267
1381
 
1268
1382
 
@@ -1271,7 +1385,10 @@ Gets the Scopes IDS for the Available Scope function by any config
1271
1385
 
1272
1386
  | Name | Type | Description | |
1273
1387
  | ---- | ---- | ----------- | -------- |
1274
- | config | | any config | &nbsp; |
1388
+ | scopes | | The filter scope section | &nbsp; |
1389
+ | section | | The filter section. | &nbsp; |
1390
+ | version | | The version of the filter structure | &nbsp; |
1391
+ | datasetsInfo | | Collection of datasets information | &nbsp; |
1275
1392
 
1276
1393
 
1277
1394
 
@@ -1279,17 +1396,17 @@ Gets the Scopes IDS for the Available Scope function by any config
1279
1396
  ##### Returns
1280
1397
 
1281
1398
 
1282
- - a Available Scope IDS config
1399
+ - a UI filter Structure
1283
1400
 
1284
1401
 
1285
1402
 
1286
1403
 
1287
- ### dist/filters/helpers/getScopesByHierarchy.js
1404
+ ### dist/filters/adapters/UIToFD.js
1288
1405
 
1289
1406
 
1290
- #### getScopesByHierarchy(scopes, currentScope)
1407
+ #### UIToFD(filterData)
1291
1408
 
1292
- [TODO: Make a description for this]
1409
+ Generates a Filter Data Structure structure from UI Filter Data structure.
1293
1410
 
1294
1411
 
1295
1412
 
@@ -1298,8 +1415,7 @@ Gets the Scopes IDS for the Available Scope function by any config
1298
1415
 
1299
1416
  | Name | Type | Description | |
1300
1417
  | ---- | ---- | ----------- | -------- |
1301
- | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
1302
- | currentScope | | Current scope type | &nbsp; |
1418
+ | filterData | | The UI filter data object. | &nbsp; |
1303
1419
 
1304
1420
 
1305
1421
 
@@ -1307,17 +1423,13 @@ Gets the Scopes IDS for the Available Scope function by any config
1307
1423
  ##### Returns
1308
1424
 
1309
1425
 
1310
- - A new array of Scopes/Scope IDs
1311
-
1312
-
1313
-
1426
+ - a Filter Data structure
1314
1427
 
1315
- ### dist/general/array/delete.js
1316
1428
 
1317
1429
 
1318
- #### ArrayDelete(array, index)
1430
+ #### UI21ToFD(uFilterData, version)
1319
1431
 
1320
- Inmutable Array Item deletion
1432
+ Builds the Fitler Data structure from UI filter data
1321
1433
 
1322
1434
 
1323
1435
 
@@ -1326,8 +1438,8 @@ Inmutable Array Item deletion
1326
1438
 
1327
1439
  | Name | Type | Description | |
1328
1440
  | ---- | ---- | ----------- | -------- |
1329
- | array | `Array` | a collection of items to delete | &nbsp; |
1330
- | index | `Number` | the position of the item to delete | &nbsp; |
1441
+ | uFilterData | | The UI filter Data object | &nbsp; |
1442
+ | version | | the version of the structure | &nbsp; |
1331
1443
 
1332
1444
 
1333
1445
 
@@ -1335,20 +1447,17 @@ Inmutable Array Item deletion
1335
1447
  ##### Returns
1336
1448
 
1337
1449
 
1338
- - a new Array or the given parameter when is empty or not an array
1450
+ -
1339
1451
 
1340
1452
 
1341
1453
 
1342
1454
 
1343
- ### dist/general/array/filterNestedTree.js
1455
+ ### dist/filters/adapters/UIToFlatUI.js
1344
1456
 
1345
1457
 
1346
- #### filterNestedTree(arr, childArrKey, condition)
1458
+ #### UIToFlatUI(filterData, datasetsInfo)
1347
1459
 
1348
- Filters a nested tree array by a custom condition on the last child node
1349
- - If the given arguments are not valid, the function returns the first argument.
1350
- - If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
1351
- - If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array
1460
+ Generates a Flattened UI filter structure from UI Filter Data structure.
1352
1461
 
1353
1462
 
1354
1463
 
@@ -1357,9 +1466,8 @@ Filters a nested tree array by a custom condition on the last child node
1357
1466
 
1358
1467
  | Name | Type | Description | |
1359
1468
  | ---- | ---- | ----------- | -------- |
1360
- | arr | | nested tree array | &nbsp; |
1361
- | childArrKey | | property representing the children array on the nested tree | &nbsp; |
1362
- | condition | | function callback that determines if the filter is applied on the last child node of the nested tree | &nbsp; |
1469
+ | filterData | | The UI filter data object. | &nbsp; |
1470
+ | datasetsInfo | | Collection of datasets information. Optional for updating the datasets info | &nbsp; |
1363
1471
 
1364
1472
 
1365
1473
 
@@ -1367,17 +1475,13 @@ Filters a nested tree array by a custom condition on the last child node
1367
1475
  ##### Returns
1368
1476
 
1369
1477
 
1370
- - array filtered
1371
-
1372
-
1373
-
1478
+ - a flattened UI filters array
1374
1479
 
1375
- ### dist/general/array/flattenDeep.js
1376
1480
 
1377
1481
 
1378
- #### flattenDeep(arr)
1482
+ #### UI21ToFlatUI(scopes)
1379
1483
 
1380
- Flat deeply an array
1484
+ Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1
1381
1485
 
1382
1486
 
1383
1487
 
@@ -1386,7 +1490,7 @@ Flat deeply an array
1386
1490
 
1387
1491
  | Name | Type | Description | |
1388
1492
  | ---- | ---- | ----------- | -------- |
1389
- | arr | | Array to flat deeply | &nbsp; |
1493
+ | scopes | | The filter scope section | &nbsp; |
1390
1494
 
1391
1495
 
1392
1496
 
@@ -1394,17 +1498,18 @@ Flat deeply an array
1394
1498
  ##### Returns
1395
1499
 
1396
1500
 
1397
- - flatten array
1501
+ - a flattened UI filters array
1398
1502
 
1399
1503
 
1400
1504
 
1401
1505
 
1402
- ### dist/general/array/getFirstIndexFromArray.js
1506
+ ### dist/filters/adapters/adaptDateGroupingProperty.js
1403
1507
 
1404
1508
 
1405
- #### getFirstIndexFromArray(array, callback)
1509
+ #### adaptDateGroupingProperty(property)
1406
1510
 
1407
- Gets the first index from the array by a callback condition
1511
+ [TODO: For 2022, eliminate this adapter]
1512
+ Get the new property base on the old date grouping properties
1408
1513
 
1409
1514
 
1410
1515
 
@@ -1413,8 +1518,7 @@ Gets the first index from the array by a callback condition
1413
1518
 
1414
1519
  | Name | Type | Description | |
1415
1520
  | ---- | ---- | ----------- | -------- |
1416
- | array | | | &nbsp; |
1417
- | callback | | function callback | &nbsp; |
1521
+ | property | | | &nbsp; |
1418
1522
 
1419
1523
 
1420
1524
 
@@ -1422,17 +1526,17 @@ Gets the first index from the array by a callback condition
1422
1526
  ##### Returns
1423
1527
 
1424
1528
 
1425
- - the first index of the array. -1 when the condition is not satisfied
1529
+ -
1426
1530
 
1427
1531
 
1428
1532
 
1429
1533
 
1430
- ### dist/general/array/getLastIndexFromArray.js
1534
+ ### dist/filters/adapters/adaptFilterData.js
1431
1535
 
1432
1536
 
1433
- #### getLastIndexFromArray(array, callback)
1537
+ #### adaptFilterData(filterData, getUIFilterData, datasetsInfo)
1434
1538
 
1435
- Gets the last index from the array by a callback condition
1539
+ Checks and adapts the v2.0 Filter Data Structure to the v2.1
1436
1540
 
1437
1541
 
1438
1542
 
@@ -1441,8 +1545,9 @@ Gets the last index from the array by a callback condition
1441
1545
 
1442
1546
  | Name | Type | Description | |
1443
1547
  | ---- | ---- | ----------- | -------- |
1444
- | array | | | &nbsp; |
1445
- | callback | | function callback | &nbsp; |
1548
+ | filterData | | The filter data structure. Accepts both v2.1 or v2.0 | &nbsp; |
1549
+ | getUIFilterData | | Flag to get a Filter Data (False) or the UI Filter Data (True) | &nbsp; |
1550
+ | datasetsInfo | | Collection of datasets information. If getUIFilterData is true, the datasetsInfo should be mandatory | &nbsp; |
1446
1551
 
1447
1552
 
1448
1553
 
@@ -1450,17 +1555,18 @@ Gets the last index from the array by a callback condition
1450
1555
  ##### Returns
1451
1556
 
1452
1557
 
1453
- - the last index of the array. -1 when the condition is not satisfied
1558
+ - A new filter data structure v2.1
1454
1559
 
1455
1560
 
1456
1561
 
1457
1562
 
1458
- ### dist/general/function/debounce.js
1563
+ ### dist/filters/adapters/adaptFilterValues.js
1459
1564
 
1460
1565
 
1461
- #### debounce(fn, time)
1566
+ #### adaptFilterValues(filter)
1462
1567
 
1463
- Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last time the debounced function was invoked.
1568
+ [TODO: For 2022, eliminate this adapter]
1569
+ Gets an adapted filter value array. Validates the enabled property and sets
1464
1570
 
1465
1571
 
1466
1572
 
@@ -1469,8 +1575,7 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
1469
1575
 
1470
1576
  | Name | Type | Description | |
1471
1577
  | ---- | ---- | ----------- | -------- |
1472
- | fn | `Function` | original Function | &nbsp; |
1473
- | time | `Number` | default 500ms | &nbsp; |
1578
+ | filter | | The filter | &nbsp; |
1474
1579
 
1475
1580
 
1476
1581
 
@@ -1478,17 +1583,17 @@ Delays invoking _fn_ until after _time_ milliseconds have elapsed since the last
1478
1583
  ##### Returns
1479
1584
 
1480
1585
 
1481
- - `Function` debounced functions
1586
+ - A new value array with the filled properties.
1482
1587
 
1483
1588
 
1484
1589
 
1485
1590
 
1486
- ### dist/general/function/throttled.js
1591
+ ### dist/filters/adapters/flatUIToLogic.js
1487
1592
 
1488
1593
 
1489
- #### throttled(fn, time)
1594
+ #### flatUIToLogic(uFilter)
1490
1595
 
1491
- Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1596
+ Generates a Logic structure from flattened UI filters
1492
1597
 
1493
1598
 
1494
1599
 
@@ -1497,8 +1602,7 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1497
1602
 
1498
1603
  | Name | Type | Description | |
1499
1604
  | ---- | ---- | ----------- | -------- |
1500
- | fn | `Function` | original Function | &nbsp; |
1501
- | time | `Number` | default 500ms | &nbsp; |
1605
+ | uFilter | | Array of flat filters from UI | &nbsp; |
1502
1606
 
1503
1607
 
1504
1608
 
@@ -1506,17 +1610,17 @@ Make sure to only invokes _fn_ at most once per every _time_ milliseconds
1506
1610
  ##### Returns
1507
1611
 
1508
1612
 
1509
- - `Function` throttled function
1613
+ - The logic structure
1510
1614
 
1511
1615
 
1512
1616
 
1513
1617
 
1514
- ### dist/general/string/capitalize.js
1618
+ ### dist/filters/adapters/flatUIToFD.js
1515
1619
 
1516
1620
 
1517
- #### capitalize(text)
1621
+ #### flatUIToFD(uFilters, version)
1518
1622
 
1519
- Upper case the first letter of a given text
1623
+ Generates a filter data structure from the flatttened UI filters.
1520
1624
 
1521
1625
 
1522
1626
 
@@ -1525,7 +1629,8 @@ Upper case the first letter of a given text
1525
1629
 
1526
1630
  | Name | Type | Description | |
1527
1631
  | ---- | ---- | ----------- | -------- |
1528
- | text | `String` | | &nbsp; |
1632
+ | uFilters | | Array of flattened filters from UI | &nbsp; |
1633
+ | version | | Tag for the version of the filter data structure | &nbsp; |
1529
1634
 
1530
1635
 
1531
1636
 
@@ -1533,18 +1638,14 @@ Upper case the first letter of a given text
1533
1638
  ##### Returns
1534
1639
 
1535
1640
 
1536
- - `String` a capitalized text
1537
-
1538
-
1539
-
1641
+ - a Filter Data.
1540
1642
 
1541
- ### dist/general/object/cloneDeep.js
1542
1643
 
1543
1644
 
1544
- #### cloneDeep(obj)
1645
+ #### buildScopes(fbFilters)
1545
1646
 
1546
- A simple Deep Cloning function. Valid only for primivite values and object with primitive values.
1547
- Not to use this function with inner objects and functions
1647
+ Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs
1648
+ Also, adds and organizes filters by datasets
1548
1649
 
1549
1650
 
1550
1651
 
@@ -1553,7 +1654,7 @@ Not to use this function with inner objects and functions
1553
1654
 
1554
1655
  | Name | Type | Description | |
1555
1656
  | ---- | ---- | ----------- | -------- |
1556
- | obj | | The object | &nbsp; |
1657
+ | fbFilters | | Array of flat filters from UI | &nbsp; |
1557
1658
 
1558
1659
 
1559
1660
 
@@ -1561,21 +1662,36 @@ Not to use this function with inner objects and functions
1561
1662
  ##### Returns
1562
1663
 
1563
1664
 
1564
- - The new reference object or the given object if the parsing is incorrect or empty
1665
+ - an array of scopes structure.
1565
1666
 
1566
1667
 
1567
1668
 
1669
+ #### buildScope(uFilter)
1568
1670
 
1569
- ### dist/general/object/get.js
1671
+ Gets an scope structure for the filter data
1570
1672
 
1571
1673
 
1572
- #### _get(baseObject, path, defaultValue)
1573
1674
 
1574
- Like lodash _.get.
1575
- Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
1576
1675
 
1577
- Empty arrays and empty objects are returned but the defaultValue is not
1578
- Undefined and null values will return the defaultValue.
1676
+ ##### Parameters
1677
+
1678
+ | Name | Type | Description | |
1679
+ | ---- | ---- | ----------- | -------- |
1680
+ | uFilter | | UI structure filter | &nbsp; |
1681
+
1682
+
1683
+
1684
+
1685
+ ##### Returns
1686
+
1687
+
1688
+ - an scope structure
1689
+
1690
+
1691
+
1692
+ #### buildDataset(uFilter)
1693
+
1694
+ Gets an dataset structure for the filter data
1579
1695
 
1580
1696
 
1581
1697
 
@@ -1584,59 +1700,48 @@ Undefined and null values will return the defaultValue.
1584
1700
 
1585
1701
  | Name | Type | Description | |
1586
1702
  | ---- | ---- | ----------- | -------- |
1587
- | baseObject | | The object to query | &nbsp; |
1588
- | path | | The string path or collection of string paths of the property to get. | &nbsp; |
1589
- | defaultValue | | The value returned for undefined resolved values. | &nbsp; |
1703
+ | uFilter | | a UI structure filter | &nbsp; |
1590
1704
 
1591
1705
 
1592
1706
 
1593
1707
 
1594
- ##### Examples
1708
+ ##### Returns
1709
+
1710
+
1711
+ - an dataset structure
1712
+
1713
+
1714
+
1715
+ #### buildFilter(uFilter)
1716
+
1717
+ Gets an filter structure for the filter data
1718
+
1719
+
1720
+
1721
+
1722
+ ##### Parameters
1723
+
1724
+ | Name | Type | Description | |
1725
+ | ---- | ---- | ----------- | -------- |
1726
+ | uFilter | | a UI structure filter | &nbsp; |
1727
+
1595
1728
 
1596
- ```javascript
1597
- // returns 'Hello'
1598
- _get({ item1: 'Hello', item2: 'World' }, 'item1')
1599
- ```
1600
- ```javascript
1601
- // returns 'A simple Hello'
1602
- _get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')
1603
- ```
1604
- ```javascript
1605
- // returns 'Hello Again'
1606
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')
1607
- ```
1608
- ```javascript
1609
- // returns 'Hello 2'
1610
- _get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')
1611
- ```
1612
- ```javascript
1613
- // returns 'Hello Again'
1614
- _get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])
1615
- ```
1616
1729
 
1617
1730
 
1618
1731
  ##### Returns
1619
1732
 
1620
1733
 
1621
- - the resolved value.
1734
+ - an filter structure
1622
1735
 
1623
1736
 
1624
1737
 
1625
1738
 
1626
- ### dist/general/object/getAttribute.js
1739
+ ### dist/filters/adapters/flatUIToOldLogic.js
1627
1740
 
1628
1741
 
1629
- #### getAttribute(obj, key)
1742
+ #### flatUIToOldLogic(uFilters)
1630
1743
 
1631
- Searchs for properties in different case styles such as: lower, upper, camel and pascal
1632
- - To optimize the searching, it is required a key in a snake_case style
1633
- - List of cases that do not match
1634
- -- From lower to snake case
1635
- -- From upper to snake case
1636
- -- From lower to camel case
1637
- -- From upper to camel case
1638
- -- From lower to pascal case
1639
- -- From upper to pascal case
1744
+ Generates a Logic structure from flattened UI filters
1640
1745
 
1641
1746
 
1642
1747
 
@@ -1645,33 +1750,25 @@ Searchs for properties in different case styles such as: lower, upper, camel and
1645
1750
 
1646
1751
  | Name | Type | Description | |
1647
1752
  | ---- | ---- | ----------- | -------- |
1648
- | obj | `object` | object to look for | &nbsp; |
1649
- | key | `string` | String attribute in snake_case style | &nbsp; |
1650
-
1651
-
1652
-
1753
+ | uFilters | | Array of flat filters from UI | &nbsp; |
1653
1754
 
1654
- ##### Examples
1655
1755
 
1656
- ```javascript
1657
- getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
1658
- ```
1659
1756
 
1660
1757
 
1661
1758
  ##### Returns
1662
1759
 
1663
1760
 
1664
- - `Void`
1761
+ - The logic structure
1665
1762
 
1666
1763
 
1667
1764
 
1668
1765
 
1669
- ### dist/general/object/hasProperty.js
1766
+ ### dist/filters/adapters/flatUIToUI.js
1670
1767
 
1671
1768
 
1672
- #### _hasProperty(obj, property)
1769
+ #### flatUIToUI(uFilters, version)
1673
1770
 
1674
- Use the hasOwnProperty in order to verify if the given property exists in the object.
1771
+ Generates a UI filter data structure from the flatttened UI filters.
1675
1772
 
1676
1773
 
1677
1774
 
@@ -1680,38 +1777,46 @@ Use the hasOwnProperty in order to verify if the given property exists in the ob
1680
1777
 
1681
1778
  | Name | Type | Description | |
1682
1779
  | ---- | ---- | ----------- | -------- |
1683
- | obj | `object` | an object | &nbsp; |
1684
- | property | `string` | String to verify if exists in the object as property | &nbsp; |
1780
+ | uFilters | | Array of flattened filters from UI | &nbsp; |
1781
+ | version | | Tag for the version of the filter data structure | &nbsp; |
1685
1782
 
1686
1783
 
1687
1784
 
1688
1785
 
1689
- ##### Examples
1786
+ ##### Returns
1690
1787
 
1691
- ```javascript
1692
- const prop = 'prop2'
1693
- const obj1 = { prop1: 'hello', prop2: 'world'}
1694
- _hasProperty(ob1, prop1) // true
1695
1788
 
1696
- const obj2 = { prop1: 'hello world' }
1697
- _hasProperty(ob1, prop2) // false
1698
- ```
1789
+ - a UI Filter Data.
1699
1790
 
1700
1791
 
1701
- ##### Returns
1702
1792
 
1793
+ #### buildScopes(fbFilters)
1703
1794
 
1704
- - True if the object has the given property; otherwise, false.
1795
+ Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs
1796
+ Also, adds and organizes filters by datasets
1705
1797
 
1706
1798
 
1707
1799
 
1708
1800
 
1709
- ### dist/general/object/isObject.js
1801
+ ##### Parameters
1802
+
1803
+ | Name | Type | Description | |
1804
+ | ---- | ---- | ----------- | -------- |
1805
+ | fbFilters | | Array of flat filters from UI | &nbsp; |
1710
1806
 
1711
1807
 
1712
- #### isObject(obj)
1713
1808
 
1714
- Checks if the given argument is an object type
1809
+
1810
+ ##### Returns
1811
+
1812
+
1813
+ - an array of scopes structure.
1814
+
1815
+
1816
+
1817
+ #### buildScope(uFilter)
1818
+
1819
+ Gets an scope structure for the UI filter data
1715
1820
 
1716
1821
 
1717
1822
 
@@ -1720,7 +1825,7 @@ Checks if the given argument is an object type
1720
1825
 
1721
1826
  | Name | Type | Description | |
1722
1827
  | ---- | ---- | ----------- | -------- |
1723
- | obj | | the variable to check | &nbsp; |
1828
+ | uFilter | | UI structure filter | &nbsp; |
1724
1829
 
1725
1830
 
1726
1831
 
@@ -1728,18 +1833,13 @@ Checks if the given argument is an object type
1728
1833
  ##### Returns
1729
1834
 
1730
1835
 
1731
- - True: It is an object; False: It is not.
1732
-
1733
-
1836
+ - an scope structure
1734
1837
 
1735
1838
 
1736
- ### dist/general/object/mapValues.js
1737
1839
 
1840
+ #### buildDataset(uFilter)
1738
1841
 
1739
- #### mapValues(baseObject, iteratee)
1740
-
1741
- Invoke iteratee (function) for each object key-value pair
1742
- and return a mapped object
1842
+ Gets an dataset structure for the UI filter data
1743
1843
 
1744
1844
 
1745
1845
 
@@ -1748,8 +1848,7 @@ and return a mapped object
1748
1848
 
1749
1849
  | Name | Type | Description | |
1750
1850
  | ---- | ---- | ----------- | -------- |
1751
- | baseObject | `Object` | Base object. | &nbsp; |
1752
- | iteratee | `Function` | The executed per iteration. | &nbsp; |
1851
+ | uFilter | | a UI structure filter | &nbsp; |
1753
1852
 
1754
1853
 
1755
1854
 
@@ -1757,17 +1856,13 @@ and return a mapped object
1757
1856
  ##### Returns
1758
1857
 
1759
1858
 
1760
- - `Object` New mapped object.
1761
-
1762
-
1859
+ - an dataset structure
1763
1860
 
1764
1861
 
1765
- ### dist/general/object/objectCopy.js
1766
1862
 
1863
+ #### buildFilter(uFilter)
1767
1864
 
1768
- #### objectCopy(entity, cache)
1769
-
1770
- Created a new reference of the given argument
1865
+ Gets an filter structure for the UI filter data
1771
1866
 
1772
1867
 
1773
1868
 
@@ -1776,8 +1871,7 @@ Created a new reference of the given argument
1776
1871
 
1777
1872
  | Name | Type | Description | |
1778
1873
  | ---- | ---- | ----------- | -------- |
1779
- | entity | | The variable to be copied | &nbsp; |
1780
- | cache | | | &nbsp; |
1874
+ | uFilter | | a UI structure filter | &nbsp; |
1781
1875
 
1782
1876
 
1783
1877
 
@@ -1785,17 +1879,17 @@ Created a new reference of the given argument
1785
1879
  ##### Returns
1786
1880
 
1787
1881
 
1788
- - A new reference of the given argument
1882
+ - an filter structure
1789
1883
 
1790
1884
 
1791
1885
 
1792
1886
 
1793
- ### dist/general/object/omit.js
1887
+ ### dist/filters/adapters/logicToFD.js
1794
1888
 
1795
1889
 
1796
- #### omit(obj, props)
1890
+ #### logicToFD(filterData, version)
1797
1891
 
1798
- return a new Object excluding attributes in _props_ list
1892
+ Generates a filter data structure from the old logic structure (v2.0).
1799
1893
 
1800
1894
 
1801
1895
 
@@ -1804,8 +1898,8 @@ return a new Object excluding attributes in _props_ list
1804
1898
 
1805
1899
  | Name | Type | Description | |
1806
1900
  | ---- | ---- | ----------- | -------- |
1807
- | obj | `Object` | base object | &nbsp; |
1808
- | props | `Array.<String>` | list of attribute to exclude | &nbsp; |
1901
+ | filterData | | The old filter data structure with logic (v2.0) | &nbsp; |
1902
+ | version | | Tag for the version of the filter data structure | &nbsp; |
1809
1903
 
1810
1904
 
1811
1905
 
@@ -1813,17 +1907,17 @@ return a new Object excluding attributes in _props_ list
1813
1907
  ##### Returns
1814
1908
 
1815
1909
 
1816
- - `Object` clean object
1910
+ - a Filter Data.
1817
1911
 
1818
1912
 
1819
1913
 
1820
1914
 
1821
- ### dist/general/object/pick.js
1915
+ ### dist/filters/adapters/logicToFlatUI.js
1822
1916
 
1823
1917
 
1824
- #### pick(baseObject, keys)
1918
+ #### logicToFlatUI(logics)
1825
1919
 
1826
- return a new object just with attributes in _keys_ list
1920
+ Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.
1827
1921
 
1828
1922
 
1829
1923
 
@@ -1832,8 +1926,7 @@ return a new object just with attributes in _keys_ list
1832
1926
 
1833
1927
  | Name | Type | Description | |
1834
1928
  | ---- | ---- | ----------- | -------- |
1835
- | baseObject | `Object` | base object | &nbsp; |
1836
- | keys | `Array.<String>` | list of attributes to preserve | &nbsp; |
1929
+ | logics | | The old logic structure (v2.0) | &nbsp; |
1837
1930
 
1838
1931
 
1839
1932
 
@@ -1841,17 +1934,13 @@ return a new object just with attributes in _keys_ list
1841
1934
  ##### Returns
1842
1935
 
1843
1936
 
1844
- - `Object` new object just with desired attributes
1845
-
1846
-
1847
-
1937
+ - The Flattened UI Filters array
1848
1938
 
1849
- ### dist/general/object/serialize.js
1850
1939
 
1851
1940
 
1852
- #### serialize(obj)
1941
+ #### getFilter(filters, filter, getIndex)
1853
1942
 
1854
- serialize object to url param
1943
+ Get the filter or the index of the given array, validating an old filter structure.
1855
1944
 
1856
1945
 
1857
1946
 
@@ -1860,7 +1949,9 @@ serialize object to url param
1860
1949
 
1861
1950
  | Name | Type | Description | |
1862
1951
  | ---- | ---- | ----------- | -------- |
1863
- | obj | | - Object to be serialized | &nbsp; |
1952
+ | filters | | The array of UI filters | &nbsp; |
1953
+ | filter | | The old logic structure filter | &nbsp; |
1954
+ | getIndex | | Determines if the index or returns the UI filter object | &nbsp; |
1864
1955
 
1865
1956
 
1866
1957
 
@@ -1868,17 +1959,13 @@ serialize object to url param
1868
1959
  ##### Returns
1869
1960
 
1870
1961
 
1871
- - `Void`
1872
-
1873
-
1874
-
1962
+ - the index or the UI filter object
1875
1963
 
1876
- ### dist/general/mix/getTag.js
1877
1964
 
1878
1965
 
1879
- #### getTag(value)
1966
+ #### refineRankingValues(values, uiValues)
1880
1967
 
1881
- Gets the `toStringTag` of `value`.
1968
+ Refines the values of the Ranking column type.
1882
1969
 
1883
1970
 
1884
1971
 
@@ -1887,7 +1974,8 @@ Gets the `toStringTag` of `value`.
1887
1974
 
1888
1975
  | Name | Type | Description | |
1889
1976
  | ---- | ---- | ----------- | -------- |
1890
- | value | | The value to query. | &nbsp; |
1977
+ | values | | the Array of Ranking values | &nbsp; |
1978
+ | uiValues | | Object with additional info about the values of the filter. | &nbsp; |
1891
1979
 
1892
1980
 
1893
1981
 
@@ -1895,17 +1983,17 @@ Gets the `toStringTag` of `value`.
1895
1983
  ##### Returns
1896
1984
 
1897
1985
 
1898
- - `string` Returns the `toStringTag`.
1986
+ - the array of Ranking values
1899
1987
 
1900
1988
 
1901
1989
 
1902
1990
 
1903
- ### dist/general/mix/importScripts.js
1991
+ ### dist/filters/adapters/logicToUI.js
1904
1992
 
1905
1993
 
1906
- #### importScripts(scripts)
1994
+ #### logicToUI(uFilters, datasetsInfo)
1907
1995
 
1908
- Import a set of external Scripts given the URL in both serie and cascade way
1996
+ Generates a UI filter structure from the old logic structure (v2.0).
1909
1997
 
1910
1998
 
1911
1999
 
@@ -1914,54 +2002,26 @@ Import a set of external Scripts given the URL in both serie and cascade way
1914
2002
 
1915
2003
  | Name | Type | Description | |
1916
2004
  | ---- | ---- | ----------- | -------- |
1917
- | scripts | `Array.<String>` `Array.<Object>` | can be an array of string or an array of object with the follow structure: | &nbsp; |
1918
- | scripts.url | `String` | CDN URL | &nbsp; |
1919
- | 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; |
1920
- | scripts.type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
1921
- | scripts.noModule | `Boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
1922
- | scripts.dependencies | `Array.<Object>` | an array with the same structure to load in cascade mode | &nbsp; |
1923
-
1924
-
2005
+ | uFilters | | Array of filters from old logic structure | &nbsp; |
2006
+ | datasetsInfo | | Collection of datasets information | &nbsp; |
1925
2007
 
1926
2008
 
1927
- ##### Examples
1928
-
1929
- ```javascript
1930
- // 1) Simple script (paralell loading)
1931
- importScripts(['http://myscript.js', 'http://another.js']);
1932
2009
 
1933
- // 2) Loading `.js` and `.esm.js` script (parallel loading)
1934
- importScripts([
1935
- { url: 'http://myscript.esm.js', type: 'module' },
1936
- { url: 'http://myscript.js', noModule: true }
1937
- ]);
1938
2010
 
1939
- // 3) import dependent scripts (cascade)
1940
- importScripts([
1941
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
1942
- ]);
2011
+ ##### Returns
1943
2012
 
1944
- // 4) mix
1945
- importScripts([
1946
- { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
1947
- { url: 'http://another.esm.js', type: 'module' },
1948
- { url: 'http://another.js', noModule: true },
1949
- 'http://simplescript.js'
1950
- ]);
1951
- ```
1952
2013
 
2014
+ - a UI Filter Data.
1953
2015
 
1954
- ##### Returns
1955
2016
 
1956
2017
 
1957
- - `Promise` Promise when all script have been loaded
1958
2018
 
2019
+ ### dist/filters/adapters/transformFilters.js
1959
2020
 
1960
2021
 
1961
- #### loadScript(url, type, noModule)
2022
+ #### transformFilters(oldFiltersObj, section)
1962
2023
 
1963
- Creates the script element and appends to document.head
1964
- return a Promise that is resolved when the script is loaded
2024
+ Transform the old filters structure into the new one
1965
2025
 
1966
2026
 
1967
2027
 
@@ -1970,27 +2030,77 @@ return a Promise that is resolved when the script is loaded
1970
2030
 
1971
2031
  | Name | Type | Description | |
1972
2032
  | ---- | ---- | ----------- | -------- |
1973
- | url | `String` | Cdn Url | &nbsp; |
1974
- | type | `String` | (Optional) it could be `module` of `text/javascript`. Default `text/javascript` | &nbsp; |
1975
- | noModule | `boolean` | (Optional) add `momodule` attribute to script tag. Default `false` | &nbsp; |
2033
+ | oldFiltersObj | `Object` | an object with the old filters structure | &nbsp; |
2034
+ | section | `String` | could be 'ANALYZE', 'PB', 'UM' or any other value. Deafult is 'ANYWHERE' | &nbsp; |
2035
+
2036
+
2037
+
1976
2038
 
2039
+ ##### Examples
2040
+
2041
+ ```javascript
2042
+
2043
+ const oldPreferenceFilters = {
2044
+ "WWXHAULtR-_-xYOQAdpqT__ENABLED": true,
2045
+ "WWXHAULtR-_-xYOQAdpqT__ALL--ENABLED": true,
2046
+ "WWXHAULtR-_-xYOQAdpqT__COLLAPSED": false,
2047
+ "WWXHAULtR-_-xYOQAdpqT__LABEL": "GLOBAL",
2048
+ "WWXHAULtR-_-xYOQAdpqT-_-AK4M8UV2": {
2049
+ "formulaId": null,
2050
+ "panelId": null,
2051
+ "values": [
2052
+ {
2053
+ "EQUALS": [
2054
+ {
2055
+ "id": "AK4M8UV2a0",
2056
+ "value": "A",
2057
+ "enabled": true,
2058
+ "imageUrl": null
2059
+ },
2060
+ {
2061
+ "id": "AK4M8UV2a1",
2062
+ "value": "B",
2063
+ "enabled": true,
2064
+ "imageUrl": null
2065
+ }
2066
+ ]
2067
+ }
2068
+ ],
2069
+ "bucketId": null,
2070
+ "text": "MC",
2071
+ "title": "MC",
2072
+ "type": "SINGLE_CHOICE",
2073
+ "qid": "AK4M8UV2",
2074
+ "dataset": {
2075
+ "sourceid": "xYOQAdpqT",
2076
+ "name": "Form All Questions",
2077
+ "qrveyid": "xYOQAdpqT",
2078
+ "text": "Form All Questions",
2079
+ "linkid": 0
2080
+ },
2081
+ "enabled": true,
2082
+ "linked": null
2083
+ }
2084
+ };
1977
2085
 
2086
+ const filterData = transformFilters(oldPreferenceFilters, 'ANALYZE');
2087
+ ```
1978
2088
 
1979
2089
 
1980
2090
  ##### Returns
1981
2091
 
1982
2092
 
1983
- - `Void`
2093
+ - `Object` an object with the new filters structure
1984
2094
 
1985
2095
 
1986
2096
 
1987
2097
 
1988
- ### dist/general/mix/isEmpty.js
2098
+ ### dist/filters/helpers/applyHierarchyForAggFilters.js
1989
2099
 
1990
2100
 
1991
- #### isEmpty(variable, includeFalsy)
2101
+ #### applyHierarchyForAggFilters(chartSettings, scopes, currentScope)
1992
2102
 
1993
- Validates if the given argument is empty
2103
+ [TODO: Make a proper description for this function]
1994
2104
 
1995
2105
 
1996
2106
 
@@ -1999,8 +2109,9 @@ Validates if the given argument is empty
1999
2109
 
2000
2110
  | Name | Type | Description | |
2001
2111
  | ---- | ---- | ----------- | -------- |
2002
- | variable | | the given variable | &nbsp; |
2003
- | includeFalsy | | flag to determine include the falsy variables into the validation | &nbsp; |
2112
+ | chartSettings | | Chart Settings for the Filter Builder | &nbsp; |
2113
+ | scopes | | | &nbsp; |
2114
+ | currentScope | | | &nbsp; |
2004
2115
 
2005
2116
 
2006
2117
 
@@ -2008,18 +2119,17 @@ Validates if the given argument is empty
2008
2119
  ##### Returns
2009
2120
 
2010
2121
 
2011
- - true: the given argument is empty; false: is not.
2122
+ -
2012
2123
 
2013
2124
 
2014
2125
 
2015
2126
 
2016
- ### dist/general/mix/isNull.js
2127
+ ### dist/filters/helpers/getAvailableScopes.js
2017
2128
 
2018
2129
 
2019
- #### isNull(arg)
2130
+ #### getAvailableScopes(config)
2020
2131
 
2021
- return if a given variable is either `null` or `undefined`
2022
- useful to avoid falsify validating Number Zero (0)
2132
+ Gets Scopes/Scope IDs by given IDs
2023
2133
 
2024
2134
 
2025
2135
 
@@ -2028,7 +2138,7 @@ useful to avoid falsify validating Number Zero (0)
2028
2138
 
2029
2139
  | Name | Type | Description | |
2030
2140
  | ---- | ---- | ----------- | -------- |
2031
- | arg | `any` | | &nbsp; |
2141
+ | config | | given Differnts IDs in order set a available scope | &nbsp; |
2032
2142
 
2033
2143
 
2034
2144
 
@@ -2036,19 +2146,17 @@ useful to avoid falsify validating Number Zero (0)
2036
2146
  ##### Returns
2037
2147
 
2038
2148
 
2039
- - `Boolean`
2149
+ - a Scopes/Scope IDs array
2040
2150
 
2041
2151
 
2042
2152
 
2043
2153
 
2044
- ### dist/general/mix/randomId.js
2154
+ ### dist/filters/helpers/getAvailableScopesIDsByConfig.js
2045
2155
 
2046
2156
 
2047
- #### randomId(length, exclude)
2157
+ #### getAvailableScopesIDsByConfig(config)
2048
2158
 
2049
- Creates a random string
2050
- - If the first given argument is different than a length number, the variable is replaced by a default number
2051
- - If the optional second given argument is passed the random string is permutated.
2159
+ Gets the Scopes IDS for the Available Scope function by any config
2052
2160
 
2053
2161
 
2054
2162
 
@@ -2057,8 +2165,7 @@ Creates a random string
2057
2165
 
2058
2166
  | Name | Type | Description | |
2059
2167
  | ---- | ---- | ----------- | -------- |
2060
- | length | `Number` | size of the generated string. Default 8 | &nbsp; |
2061
- | exclude | `Array` | collection of strings that is going to be excluded of the random string. | &nbsp; |
2168
+ | config | | any config | &nbsp; |
2062
2169
 
2063
2170
 
2064
2171
 
@@ -2066,19 +2173,17 @@ Creates a random string
2066
2173
  ##### Returns
2067
2174
 
2068
2175
 
2069
- - `String` Random string
2176
+ - a Available Scope IDS config
2070
2177
 
2071
2178
 
2072
2179
 
2073
2180
 
2074
- ### dist/general/mix/size.js
2181
+ ### dist/filters/helpers/getScopesByHierarchy.js
2075
2182
 
2076
2183
 
2077
- #### size(obj)
2184
+ #### getScopesByHierarchy(scopes, currentScope)
2078
2185
 
2079
- Gets the length of the given array.
2080
- - Useful for Object, Array and string type.
2081
- - For `null` or `undefined` or else argument the returned value will be 0.
2186
+ [TODO: Make a description for this]
2082
2187
 
2083
2188
 
2084
2189
 
@@ -2087,7 +2192,8 @@ Gets the length of the given array.
2087
2192
 
2088
2193
  | Name | Type | Description | |
2089
2194
  | ---- | ---- | ----------- | -------- |
2090
- | obj | `Any` | Any object-type variable | &nbsp; |
2195
+ | scopes | | the collection of Scopes/Scope IDs | &nbsp; |
2196
+ | currentScope | | Current scope type | &nbsp; |
2091
2197
 
2092
2198
 
2093
2199
 
@@ -2095,7 +2201,7 @@ Gets the length of the given array.
2095
2201
  ##### Returns
2096
2202
 
2097
2203
 
2098
- - `Number` the size of the given variable
2204
+ - A new array of Scopes/Scope IDs
2099
2205
 
2100
2206
 
2101
2207
 
@@ -2127,49 +2233,47 @@ Get an string of the properties of the given column.
2127
2233
 
2128
2234
 
2129
2235
 
2130
- ### dist/services/api/getAllDatasets.api.js
2131
-
2132
-
2133
- #### getAllDatasets(qrveyids)
2236
+ ### dist/stencil/decorators/Config.js
2134
2237
 
2135
- Get a dataset list from a collection of Qrvey IDs
2136
2238
 
2239
+ #### Config()
2137
2240
 
2241
+ Stencil.js - Prop Decorator
2242
+ 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
2243
+ But for this, is required ask for a property in `snake_case` style
2138
2244
 
2139
2245
 
2140
- ##### Parameters
2141
2246
 
2142
- | Name | Type | Description | |
2143
- | ---- | ---- | ----------- | -------- |
2144
- | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2145
2247
 
2146
2248
 
2147
2249
 
2250
+ ##### Examples
2148
2251
 
2149
- ##### Returns
2252
+ ```javascript
2253
+ \ @Config() @Prop() settings;
2150
2254
 
2255
+ someMethod() {
2256
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2257
+ }
2258
+ ```
2151
2259
 
2152
- - a promise
2153
2260
 
2261
+ ##### Returns
2154
2262
 
2155
2263
 
2264
+ - `Void`
2156
2265
 
2157
- ### dist/services/api/getAllQrveys.api.js
2158
2266
 
2159
2267
 
2160
- #### getAllQrveys(config, params)
2161
2268
 
2162
- POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2269
+ ### dist/stencil/util/createRef.js
2163
2270
 
2164
2271
 
2272
+ #### createRef()
2165
2273
 
2274
+ lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2166
2275
 
2167
- ##### Parameters
2168
2276
 
2169
- | Name | Type | Description | |
2170
- | ---- | ---- | ----------- | -------- |
2171
- | config | | Configuration | &nbsp; |
2172
- | params | | Object for getting precise data | &nbsp; |
2173
2277
 
2174
2278
 
2175
2279
 
@@ -2177,17 +2281,21 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
2177
2281
  ##### Returns
2178
2282
 
2179
2283
 
2180
- - `Void`
2284
+ - function - Function to use in ref prop in html elements
2181
2285
 
2182
2286
 
2183
2287
 
2184
2288
 
2185
- ### dist/services/api/getDatasetColumns.api.js
2289
+ ### dist/stencil/util/getConfig.js
2186
2290
 
2187
2291
 
2188
- #### getDatasetColumns(qrveyid)
2292
+ #### getConfig(cfg)
2189
2293
 
2190
- Get a dataset by Qrvey ID
2294
+ verify the Config object type and try to return a parsed Object
2295
+ - In case _cfg_ is a string, first try to make a JSON parse in other case
2296
+ try to find this string as a variable on Windows object
2297
+ - If _cfg_ is a fuction, tis is invoked and parsed
2298
+ - Finally, if is an object, _cfg_ is inmediatly returned
2191
2299
 
2192
2300
 
2193
2301
 
@@ -2196,7 +2304,7 @@ Get a dataset by Qrvey ID
2196
2304
 
2197
2305
  | Name | Type | Description | |
2198
2306
  | ---- | ---- | ----------- | -------- |
2199
- | qrveyid | | The Qrvey ID | &nbsp; |
2307
+ | cfg | | | &nbsp; |
2200
2308
 
2201
2309
 
2202
2310
 
@@ -2204,74 +2312,72 @@ Get a dataset by Qrvey ID
2204
2312
  ##### Returns
2205
2313
 
2206
2314
 
2207
- - a promise
2208
-
2315
+ - `Void`
2209
2316
 
2210
2317
 
2211
2318
 
2212
- ### dist/stencil/decorators/Config.js
2213
2319
 
2320
+ ### dist/services/api/getAllDatasets.api.js
2214
2321
 
2215
- #### Config()
2216
2322
 
2217
- Stencil.js - Prop Decorator
2218
- 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
2219
- But for this, is required ask for a property in `snake_case` style
2323
+ #### getAllDatasets(qrveyids)
2220
2324
 
2325
+ Get a dataset list from a collection of Qrvey IDs
2221
2326
 
2222
2327
 
2223
2328
 
2224
2329
 
2330
+ ##### Parameters
2225
2331
 
2226
- ##### Examples
2332
+ | Name | Type | Description | |
2333
+ | ---- | ---- | ----------- | -------- |
2334
+ | qrveyids | | Collection of Qrvey IDs | &nbsp; |
2227
2335
 
2228
- ```javascript
2229
- \ @Config() @Prop() settings;
2230
2336
 
2231
- someMethod() {
2232
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
2233
- }
2234
- ```
2235
2337
 
2236
2338
 
2237
2339
  ##### Returns
2238
2340
 
2239
2341
 
2240
- - `Void`
2342
+ - a promise
2241
2343
 
2242
2344
 
2243
2345
 
2244
2346
 
2245
- ### dist/stencil/util/createRef.js
2347
+ ### dist/services/api/getAllQrveys.api.js
2246
2348
 
2247
2349
 
2248
- #### createRef()
2350
+ #### getAllQrveys(config, params)
2249
2351
 
2250
- lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
2352
+ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
2251
2353
 
2252
2354
 
2253
2355
 
2254
2356
 
2357
+ ##### Parameters
2358
+
2359
+ | Name | Type | Description | |
2360
+ | ---- | ---- | ----------- | -------- |
2361
+ | config | | Configuration | &nbsp; |
2362
+ | params | | Object for getting precise data | &nbsp; |
2363
+
2364
+
2255
2365
 
2256
2366
 
2257
2367
  ##### Returns
2258
2368
 
2259
2369
 
2260
- - function - Function to use in ref prop in html elements
2370
+ - `Void`
2261
2371
 
2262
2372
 
2263
2373
 
2264
2374
 
2265
- ### dist/stencil/util/getConfig.js
2375
+ ### dist/services/api/getDatasetColumns.api.js
2266
2376
 
2267
2377
 
2268
- #### getConfig(cfg)
2378
+ #### getDatasetColumns(qrveyid)
2269
2379
 
2270
- verify the Config object type and try to return a parsed Object
2271
- - In case _cfg_ is a string, first try to make a JSON parse in other case
2272
- try to find this string as a variable on Windows object
2273
- - If _cfg_ is a fuction, tis is invoked and parsed
2274
- - Finally, if is an object, _cfg_ is inmediatly returned
2380
+ Get a dataset by Qrvey ID
2275
2381
 
2276
2382
 
2277
2383
 
@@ -2280,7 +2386,7 @@ try to find this string as a variable on Windows object
2280
2386
 
2281
2387
  | Name | Type | Description | |
2282
2388
  | ---- | ---- | ----------- | -------- |
2283
- | cfg | | | &nbsp; |
2389
+ | qrveyid | | The Qrvey ID | &nbsp; |
2284
2390
 
2285
2391
 
2286
2392
 
@@ -2288,7 +2394,7 @@ try to find this string as a variable on Windows object
2288
2394
  ##### Returns
2289
2395
 
2290
2396
 
2291
- - `Void`
2397
+ - a promise
2292
2398
 
2293
2399
 
2294
2400
 
@@ -2429,13 +2535,12 @@ Parses a string date and returns a dayjs date
2429
2535
 
2430
2536
 
2431
2537
 
2432
- ### dist/filters/helpers/backend/buildExpression.js
2538
+ ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
2433
2539
 
2434
2540
 
2435
- #### buildExpression(filter)
2541
+ #### getFilterBuilderGeneralConfig(config)
2436
2542
 
2437
- Builds filter expression by the filter data.
2438
- - If the resulting value array is empty the enabled property will be false.
2543
+ Returns a filter builder config object by a any given config
2439
2544
 
2440
2545
 
2441
2546
 
@@ -2444,7 +2549,7 @@ Builds filter expression by the filter data.
2444
2549
 
2445
2550
  | Name | Type | Description | |
2446
2551
  | ---- | ---- | ----------- | -------- |
2447
- | filter | | The filter to transform | &nbsp; |
2552
+ | config | | any config object | &nbsp; |
2448
2553
 
2449
2554
 
2450
2555
 
@@ -2452,17 +2557,17 @@ Builds filter expression by the filter data.
2452
2557
  ##### Returns
2453
2558
 
2454
2559
 
2455
- - a filter expression
2560
+ - The filter builder config object
2456
2561
 
2457
2562
 
2458
2563
 
2459
2564
 
2460
- ### dist/filters/helpers/backend/buildUserFilters.js
2565
+ ### dist/filters/helpers/common/areFiltersEquals.js
2461
2566
 
2462
2567
 
2463
- #### buildUserFilters(userFilters)
2568
+ #### areFiltersEquals(filter1, filter2)
2464
2569
 
2465
- Transform user Filters array into Filter Logic structure
2570
+ Validates if both filters are the same
2466
2571
 
2467
2572
 
2468
2573
 
@@ -2471,7 +2576,8 @@ Transform user Filters array into Filter Logic structure
2471
2576
 
2472
2577
  | Name | Type | Description | |
2473
2578
  | ---- | ---- | ----------- | -------- |
2474
- | userFilters | | The filters that the user defined. | &nbsp; |
2579
+ | filter1 | | filter 1 | &nbsp; |
2580
+ | filter2 | | filter 2 | &nbsp; |
2475
2581
 
2476
2582
 
2477
2583
 
@@ -2479,17 +2585,17 @@ Transform user Filters array into Filter Logic structure
2479
2585
  ##### Returns
2480
2586
 
2481
2587
 
2482
- - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
2483
-
2588
+ - true: the filters are equal; false: the filters are NOT equal
2484
2589
 
2485
2590
 
2486
2591
 
2487
- ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
2488
2592
 
2593
+ ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
2489
2594
 
2490
- #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
2491
2595
 
2596
+ #### excludeFiltersByAggregateColumn(filterData)
2492
2597
 
2598
+ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
2493
2599
 
2494
2600
 
2495
2601
 
@@ -2498,8 +2604,7 @@ Transform user Filters array into Filter Logic structure
2498
2604
 
2499
2605
  | Name | Type | Description | |
2500
2606
  | ---- | ---- | ----------- | -------- |
2501
- | aggFilters | | | &nbsp; |
2502
- | summaryIndex | | | &nbsp; |
2607
+ | filterData | | The filter data object | &nbsp; |
2503
2608
 
2504
2609
 
2505
2610
 
@@ -2507,17 +2612,26 @@ Transform user Filters array into Filter Logic structure
2507
2612
  ##### Returns
2508
2613
 
2509
2614
 
2510
- -
2615
+ - The new filter data object that were excluded the aggregate filters
2511
2616
 
2512
2617
 
2513
2618
 
2514
2619
 
2515
- ### dist/filters/helpers/backend/getBackendGroupValue.js
2620
+ ### dist/filters/helpers/common/excludeFiltersByParams.js
2516
2621
 
2517
2622
 
2518
- #### getBackendGroupValue(filter)
2623
+ #### excludeFiltersByParams(filterData, params)
2519
2624
 
2520
- Gets a group value for the backend logic structure
2625
+ Excludes filters from the given Filters.
2626
+ The validation to filter the stored filter is depending on:
2627
+ - Column
2628
+ - Qrvey ID
2629
+ - Scope type
2630
+ - Scope ID
2631
+ - Panel ID
2632
+ - Validator type
2633
+ - Property type
2634
+ - Enabled flags
2521
2635
 
2522
2636
 
2523
2637
 
@@ -2526,7 +2640,8 @@ Gets a group value for the backend logic structure
2526
2640
 
2527
2641
  | Name | Type | Description | |
2528
2642
  | ---- | ---- | ----------- | -------- |
2529
- | filter | | The filter | &nbsp; |
2643
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
2644
+ | params | | given parameters to validate the filter data | &nbsp; |
2530
2645
 
2531
2646
 
2532
2647
 
@@ -2534,17 +2649,17 @@ Gets a group value for the backend logic structure
2534
2649
  ##### Returns
2535
2650
 
2536
2651
 
2537
- - a property
2652
+ - a new Filter object structure
2538
2653
 
2539
2654
 
2540
2655
 
2541
2656
 
2542
- ### dist/filters/helpers/backend/getBackendProperty.js
2657
+ ### dist/filters/helpers/common/excludeFiltersByScopes.js
2543
2658
 
2544
2659
 
2545
- #### getBackendProperty(filter)
2660
+ #### excludeFiltersByScopes(filterData, scopes)
2546
2661
 
2547
- Gets a property for the logic structure
2662
+ Excludes and returns a filter data without filters by the given scopes
2548
2663
 
2549
2664
 
2550
2665
 
@@ -2553,7 +2668,8 @@ Gets a property for the logic structure
2553
2668
 
2554
2669
  | Name | Type | Description | |
2555
2670
  | ---- | ---- | ----------- | -------- |
2556
- | filter | | The filter | &nbsp; |
2671
+ | filterData | | The Filter Data | &nbsp; |
2672
+ | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
2557
2673
 
2558
2674
 
2559
2675
 
@@ -2561,17 +2677,17 @@ Gets a property for the logic structure
2561
2677
  ##### Returns
2562
2678
 
2563
2679
 
2564
- - a property
2680
+ - The new Filter Data without filters by the given scopes.
2565
2681
 
2566
2682
 
2567
2683
 
2568
2684
 
2569
- ### dist/filters/helpers/backend/getBackendValidator.js
2685
+ ### dist/filters/helpers/common/getFilterColumnLabel.js
2570
2686
 
2571
2687
 
2572
- #### getBackendValidator(validator)
2688
+ #### getFilterColumnLabel(column)
2573
2689
 
2574
- Gets the Validator that is used in requests
2690
+ Get an string of the properties of the given filter column.
2575
2691
 
2576
2692
 
2577
2693
 
@@ -2580,7 +2696,7 @@ Gets the Validator that is used in requests
2580
2696
 
2581
2697
  | Name | Type | Description | |
2582
2698
  | ---- | ---- | ----------- | -------- |
2583
- | validator | | Filter Validator used in UI | &nbsp; |
2699
+ | column | | The filter column | &nbsp; |
2584
2700
 
2585
2701
 
2586
2702
 
@@ -2588,17 +2704,17 @@ Gets the Validator that is used in requests
2588
2704
  ##### Returns
2589
2705
 
2590
2706
 
2591
- - Filter Validator used in Backend
2707
+ - an string with the property, aggregate or calculation label.
2592
2708
 
2593
2709
 
2594
2710
 
2595
2711
 
2596
- ### dist/filters/helpers/backend/getBackendValues.js
2712
+ ### dist/filters/helpers/common/getFilterLabel.js
2597
2713
 
2598
2714
 
2599
- #### getBackendValues(filter)
2715
+ #### getFilterLabel(filter)
2600
2716
 
2601
- Gets the expresion values in the logic format
2717
+ Gets the Filter Label + Column label
2602
2718
 
2603
2719
 
2604
2720
 
@@ -2607,7 +2723,7 @@ Gets the expresion values in the logic format
2607
2723
 
2608
2724
  | Name | Type | Description | |
2609
2725
  | ---- | ---- | ----------- | -------- |
2610
- | filter | | The filter structure | &nbsp; |
2726
+ | filter | | the UI filter | &nbsp; |
2611
2727
 
2612
2728
 
2613
2729
 
@@ -2615,13 +2731,28 @@ Gets the expresion values in the logic format
2615
2731
  ##### Returns
2616
2732
 
2617
2733
 
2618
- - A collection of backend expression value
2734
+ - a sring label
2619
2735
 
2620
2736
 
2621
2737
 
2622
- #### getResultValues(values, filter)
2623
2738
 
2624
- Gets the expression values. Depending on the column type
2739
+ ### dist/filters/helpers/common/getFilterid.js
2740
+
2741
+
2742
+ #### getFilterid(filter)
2743
+
2744
+ Get the Filter ID by the filter structure
2745
+ The order of the epression ID is:
2746
+ - Scope Type
2747
+ - scopeid
2748
+ - qrveyid
2749
+ - panelid
2750
+ - columnid
2751
+ - validator
2752
+ - property
2753
+ - Column Aggregate
2754
+ - Column Calculation
2755
+ - Optional Index
2625
2756
 
2626
2757
 
2627
2758
 
@@ -2630,8 +2761,7 @@ Gets the expression values. Depending on the column type
2630
2761
 
2631
2762
  | Name | Type | Description | |
2632
2763
  | ---- | ---- | ----------- | -------- |
2633
- | values | | a collection of filter values | &nbsp; |
2634
- | filter | | The filter structure | &nbsp; |
2764
+ | filter | | the filter structure | &nbsp; |
2635
2765
 
2636
2766
 
2637
2767
 
@@ -2639,13 +2769,17 @@ Gets the expression values. Depending on the column type
2639
2769
  ##### Returns
2640
2770
 
2641
2771
 
2642
- -
2772
+ - a text to identify the filter
2643
2773
 
2644
2774
 
2645
2775
 
2646
- #### getRankingValues(values, rankingGroupIndex)
2647
2776
 
2648
- Gets the Ranking values.
2777
+ ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
2778
+
2779
+
2780
+ #### getFiltersByAggregateColumn(filterData)
2781
+
2782
+ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
2649
2783
 
2650
2784
 
2651
2785
 
@@ -2654,8 +2788,7 @@ Gets the Ranking values.
2654
2788
 
2655
2789
  | Name | Type | Description | |
2656
2790
  | ---- | ---- | ----------- | -------- |
2657
- | values | | a collection of filter values in the ranking structure | &nbsp; |
2658
- | rankingGroupIndex | | determine the value by this index to build and return it | &nbsp; |
2791
+ | filterData | | The filter data object | &nbsp; |
2659
2792
 
2660
2793
 
2661
2794
 
@@ -2663,17 +2796,26 @@ Gets the Ranking values.
2663
2796
  ##### Returns
2664
2797
 
2665
2798
 
2666
- - Expression values for ranking
2799
+ - The new filter data object that were get the aggregate filters
2667
2800
 
2668
2801
 
2669
2802
 
2670
2803
 
2671
- ### dist/filters/helpers/backend/getLogicByScopes.js
2804
+ ### dist/filters/helpers/common/getFiltersByParams.js
2672
2805
 
2673
2806
 
2674
- #### getLogicByScopes(logics, scopes)
2807
+ #### getFiltersByParams(filterData, params)
2675
2808
 
2676
- Gets the filters from logic data by Scopes/Scope IDs.
2809
+ Gets filters from the given params.
2810
+ The validation to filter the stored filter is depending on:
2811
+ - Column
2812
+ - Qrvey ID
2813
+ - Scope type
2814
+ - Scope ID
2815
+ - Panel ID
2816
+ - Validator type
2817
+ - Property type
2818
+ - Enabled flags
2677
2819
 
2678
2820
 
2679
2821
 
@@ -2682,8 +2824,8 @@ Gets the filters from logic data by Scopes/Scope IDs.
2682
2824
 
2683
2825
  | Name | Type | Description | |
2684
2826
  | ---- | ---- | ----------- | -------- |
2685
- | logics | | The logic array | &nbsp; |
2686
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
2827
+ | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
2828
+ | params | | given parameters to validate the dataset | &nbsp; |
2687
2829
 
2688
2830
 
2689
2831
 
@@ -2691,17 +2833,17 @@ Gets the filters from logic data by Scopes/Scope IDs.
2691
2833
  ##### Returns
2692
2834
 
2693
2835
 
2694
- - a new Logic array
2836
+ - a new Filter object structure
2695
2837
 
2696
2838
 
2697
2839
 
2698
2840
 
2699
- ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
2841
+ ### dist/filters/helpers/common/getFiltersByScopes.js
2700
2842
 
2701
2843
 
2702
- #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
2844
+ #### getFiltersByScopes(filterData, scopes)
2703
2845
 
2704
- Gets filters from the logic by the scopes hierarchy.
2846
+ Filters and gets a Filter Data by the given scopes
2705
2847
 
2706
2848
 
2707
2849
 
@@ -2710,9 +2852,8 @@ Gets filters from the logic by the scopes hierarchy.
2710
2852
 
2711
2853
  | Name | Type | Description | |
2712
2854
  | ---- | ---- | ----------- | -------- |
2713
- | filterData | | | &nbsp; |
2714
- | scopes | | | &nbsp; |
2715
- | currentScope | | | &nbsp; |
2855
+ | filterData | | The Filter Data | &nbsp; |
2856
+ | scopes | | collection of scopes types | &nbsp; |
2716
2857
 
2717
2858
 
2718
2859
 
@@ -2720,17 +2861,17 @@ Gets filters from the logic by the scopes hierarchy.
2720
2861
  ##### Returns
2721
2862
 
2722
2863
 
2723
- - a new array of Logic
2864
+ - The new Filter Data
2724
2865
 
2725
2866
 
2726
2867
 
2727
2868
 
2728
- ### dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js
2869
+ ### dist/filters/helpers/common/getFiltersByScopesIds.js
2729
2870
 
2730
2871
 
2731
- #### getFilterBuilderGeneralConfig(config)
2872
+ #### getFiltersByScopesIds(filterData, scopes)
2732
2873
 
2733
- Returns a filter builder config object by a any given config
2874
+ Gets filters from Filter Data by Scopes/Scope IDs.
2734
2875
 
2735
2876
 
2736
2877
 
@@ -2739,7 +2880,8 @@ Returns a filter builder config object by a any given config
2739
2880
 
2740
2881
  | Name | Type | Description | |
2741
2882
  | ---- | ---- | ----------- | -------- |
2742
- | config | | any config object | &nbsp; |
2883
+ | filterData | | The filter data | &nbsp; |
2884
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
2743
2885
 
2744
2886
 
2745
2887
 
@@ -2747,17 +2889,17 @@ Returns a filter builder config object by a any given config
2747
2889
  ##### Returns
2748
2890
 
2749
2891
 
2750
- - The filter builder config object
2892
+ - a new Filter Data
2751
2893
 
2752
2894
 
2753
2895
 
2754
2896
 
2755
- ### dist/filters/helpers/common/areFiltersEquals.js
2897
+ ### dist/filters/helpers/common/getFiltersByVisibility.js
2756
2898
 
2757
2899
 
2758
- #### areFiltersEquals(filter1, filter2)
2900
+ #### getFiltersByVisibility(filterData, scopes)
2759
2901
 
2760
- Validates if both filters are the same
2902
+ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
2761
2903
 
2762
2904
 
2763
2905
 
@@ -2766,8 +2908,8 @@ Validates if both filters are the same
2766
2908
 
2767
2909
  | Name | Type | Description | |
2768
2910
  | ---- | ---- | ----------- | -------- |
2769
- | filter1 | | filter 1 | &nbsp; |
2770
- | filter2 | | filter 2 | &nbsp; |
2911
+ | filterData | | a Filter Data or UI Filter Data | &nbsp; |
2912
+ | scopes | | a Scopes/Scope IDs array | &nbsp; |
2771
2913
 
2772
2914
 
2773
2915
 
@@ -2775,17 +2917,17 @@ Validates if both filters are the same
2775
2917
  ##### Returns
2776
2918
 
2777
2919
 
2778
- - true: the filters are equal; false: the filters are NOT equal
2920
+ - a new Filter Data
2779
2921
 
2780
2922
 
2781
2923
 
2782
2924
 
2783
- ### dist/filters/helpers/common/excludeFiltersByAggregateColumn.js
2925
+ ### dist/filters/helpers/common/getMergeFiltersSettings.js
2784
2926
 
2785
2927
 
2786
- #### excludeFiltersByAggregateColumn(filterData)
2928
+ #### getMergeFiltersSettings(settings)
2787
2929
 
2788
- Excludes Aggregate Filters in the Filter Data. Excluding filters when the column.aggregate is included.
2930
+ Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
2789
2931
 
2790
2932
 
2791
2933
 
@@ -2794,7 +2936,7 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
2794
2936
 
2795
2937
  | Name | Type | Description | |
2796
2938
  | ---- | ---- | ----------- | -------- |
2797
- | filterData | | The filter data object | &nbsp; |
2939
+ | settings | | an object to the MergeFilters settings | &nbsp; |
2798
2940
 
2799
2941
 
2800
2942
 
@@ -2802,26 +2944,17 @@ Excludes Aggregate Filters in the Filter Data. Excluding filters when the column
2802
2944
  ##### Returns
2803
2945
 
2804
2946
 
2805
- - The new filter data object that were excluded the aggregate filters
2947
+ - a new MergeFilters settings object.
2806
2948
 
2807
2949
 
2808
2950
 
2809
2951
 
2810
- ### dist/filters/helpers/common/excludeFiltersByParams.js
2952
+ ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
2811
2953
 
2812
2954
 
2813
- #### excludeFiltersByParams(filterData, params)
2955
+ #### getParamsToGetFilterSettings(settings)
2814
2956
 
2815
- Excludes filters from the given Filters.
2816
- The validation to filter the stored filter is depending on:
2817
- - Column
2818
- - Qrvey ID
2819
- - Scope type
2820
- - Scope ID
2821
- - Panel ID
2822
- - Validator type
2823
- - Property type
2824
- - Enabled flags
2957
+ Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
2825
2958
 
2826
2959
 
2827
2960
 
@@ -2830,8 +2963,7 @@ The validation to filter the stored filter is depending on:
2830
2963
 
2831
2964
  | Name | Type | Description | |
2832
2965
  | ---- | ---- | ----------- | -------- |
2833
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
2834
- | params | | given parameters to validate the filter data | &nbsp; |
2966
+ | settings | | an object to the ParamsToGetFilter settings | &nbsp; |
2835
2967
 
2836
2968
 
2837
2969
 
@@ -2839,17 +2971,17 @@ The validation to filter the stored filter is depending on:
2839
2971
  ##### Returns
2840
2972
 
2841
2973
 
2842
- - a new Filter object structure
2974
+ - a new ParamsToGetFilter settings object.
2843
2975
 
2844
2976
 
2845
2977
 
2846
2978
 
2847
- ### dist/filters/helpers/common/excludeFiltersByScopes.js
2979
+ ### dist/filters/helpers/common/haveFiltersByDataset.js
2848
2980
 
2849
2981
 
2850
- #### excludeFiltersByScopes(filterData, scopes)
2982
+ #### haveFiltersByDataset(filterData, qrveyid)
2851
2983
 
2852
- Excludes and returns a filter data without filters by the given scopes
2984
+ Validates if the filter data has filters by a dataset ID (Qrvey ID).
2853
2985
 
2854
2986
 
2855
2987
 
@@ -2858,8 +2990,8 @@ Excludes and returns a filter data without filters by the given scopes
2858
2990
 
2859
2991
  | Name | Type | Description | |
2860
2992
  | ---- | ---- | ----------- | -------- |
2861
- | filterData | | The Filter Data | &nbsp; |
2862
- | scopes | | collection of scopes to be as filtering parameters | &nbsp; |
2993
+ | filterData | | the filter data or the UI filter data. | &nbsp; |
2994
+ | qrveyid | | The Qrvey ID | &nbsp; |
2863
2995
 
2864
2996
 
2865
2997
 
@@ -2867,17 +2999,17 @@ Excludes and returns a filter data without filters by the given scopes
2867
2999
  ##### Returns
2868
3000
 
2869
3001
 
2870
- - The new Filter Data without filters by the given scopes.
3002
+ - true: the filter data has filters by the Qrvey ID
2871
3003
 
2872
3004
 
2873
3005
 
2874
3006
 
2875
- ### dist/filters/helpers/common/getFilterColumnLabel.js
3007
+ ### dist/filters/helpers/common/isBetweenValidator.js
2876
3008
 
2877
3009
 
2878
- #### getFilterColumnLabel(column)
3010
+ #### isBetweenValidator(validator)
2879
3011
 
2880
- Get an string of the properties of the given filter column.
3012
+ Validates if the given validator is a Between type
2881
3013
 
2882
3014
 
2883
3015
 
@@ -2886,7 +3018,7 @@ Get an string of the properties of the given filter column.
2886
3018
 
2887
3019
  | Name | Type | Description | |
2888
3020
  | ---- | ---- | ----------- | -------- |
2889
- | column | | The filter column | &nbsp; |
3021
+ | validator | | The validator | &nbsp; |
2890
3022
 
2891
3023
 
2892
3024
 
@@ -2894,17 +3026,17 @@ Get an string of the properties of the given filter column.
2894
3026
  ##### Returns
2895
3027
 
2896
3028
 
2897
- - an string with the property, aggregate or calculation label.
3029
+ - true: it is a between validator; false: it is not a between validator
2898
3030
 
2899
3031
 
2900
3032
 
2901
3033
 
2902
- ### dist/filters/helpers/common/getFilterLabel.js
3034
+ ### dist/filters/helpers/common/isDateDistinctProperty.js
2903
3035
 
2904
3036
 
2905
- #### getFilterLabel(filter)
3037
+ #### isDateDistinctProperty(column, property)
2906
3038
 
2907
- Gets the Filter Label + Column label
3039
+ Determines if the filter column and property is a distinct group dates type
2908
3040
 
2909
3041
 
2910
3042
 
@@ -2913,7 +3045,8 @@ Gets the Filter Label + Column label
2913
3045
 
2914
3046
  | Name | Type | Description | |
2915
3047
  | ---- | ---- | ----------- | -------- |
2916
- | filter | | the UI filter | &nbsp; |
3048
+ | column | | The filter column | &nbsp; |
3049
+ | property | | The filter property | &nbsp; |
2917
3050
 
2918
3051
 
2919
3052
 
@@ -2921,28 +3054,17 @@ Gets the Filter Label + Column label
2921
3054
  ##### Returns
2922
3055
 
2923
3056
 
2924
- - a sring label
3057
+ - True if the given property is included from distinct group dates type
2925
3058
 
2926
3059
 
2927
3060
 
2928
3061
 
2929
- ### dist/filters/helpers/common/getFilterid.js
3062
+ ### dist/filters/helpers/common/isInValidator.js
2930
3063
 
2931
3064
 
2932
- #### getFilterid(filter)
3065
+ #### isInValidator(validator)
2933
3066
 
2934
- Get the Filter ID by the filter structure
2935
- The order of the epression ID is:
2936
- - Scope Type
2937
- - scopeid
2938
- - qrveyid
2939
- - panelid
2940
- - columnid
2941
- - validator
2942
- - property
2943
- - Column Aggregate
2944
- - Column Calculation
2945
- - Optional Index
3067
+ Validates if the given validator is a In type
2946
3068
 
2947
3069
 
2948
3070
 
@@ -2951,7 +3073,7 @@ The order of the epression ID is:
2951
3073
 
2952
3074
  | Name | Type | Description | |
2953
3075
  | ---- | ---- | ----------- | -------- |
2954
- | filter | | the filter structure | &nbsp; |
3076
+ | validator | | The validator | &nbsp; |
2955
3077
 
2956
3078
 
2957
3079
 
@@ -2959,17 +3081,17 @@ The order of the epression ID is:
2959
3081
  ##### Returns
2960
3082
 
2961
3083
 
2962
- - a text to identify the filter
3084
+ - true: it is a In validator; false: it is not a In validator
2963
3085
 
2964
3086
 
2965
3087
 
2966
3088
 
2967
- ### dist/filters/helpers/common/getFiltersByAggregateColumn.js
3089
+ ### dist/filters/helpers/common/isNullValidator.js
2968
3090
 
2969
3091
 
2970
- #### getFiltersByAggregateColumn(filterData)
3092
+ #### isNullValidator(validator)
2971
3093
 
2972
- Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggregate is included.
3094
+ Checks if the given validator is a Null type.
2973
3095
 
2974
3096
 
2975
3097
 
@@ -2978,7 +3100,7 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
2978
3100
 
2979
3101
  | Name | Type | Description | |
2980
3102
  | ---- | ---- | ----------- | -------- |
2981
- | filterData | | The filter data object | &nbsp; |
3103
+ | validator | | The Filter Validator | &nbsp; |
2982
3104
 
2983
3105
 
2984
3106
 
@@ -2986,26 +3108,17 @@ Gets Aggregate Filters in the Filter Data. Gets the filters when the column.aggr
2986
3108
  ##### Returns
2987
3109
 
2988
3110
 
2989
- - The new filter data object that were get the aggregate filters
3111
+ - True: It is a Null Validator; False: It is not a Null Validator.
2990
3112
 
2991
3113
 
2992
3114
 
2993
3115
 
2994
- ### dist/filters/helpers/common/getFiltersByParams.js
3116
+ ### dist/filters/helpers/common/isRangeValidator.js
2995
3117
 
2996
3118
 
2997
- #### getFiltersByParams(filterData, params)
3119
+ #### isRangeValidator(validator)
2998
3120
 
2999
- Gets filters from the given params.
3000
- The validation to filter the stored filter is depending on:
3001
- - Column
3002
- - Qrvey ID
3003
- - Scope type
3004
- - Scope ID
3005
- - Panel ID
3006
- - Validator type
3007
- - Property type
3008
- - Enabled flags
3121
+ Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3009
3122
 
3010
3123
 
3011
3124
 
@@ -3014,8 +3127,7 @@ The validation to filter the stored filter is depending on:
3014
3127
 
3015
3128
  | Name | Type | Description | |
3016
3129
  | ---- | ---- | ----------- | -------- |
3017
- | filterData | | The Filter Data or the UI Filter Data | &nbsp; |
3018
- | params | | given parameters to validate the dataset | &nbsp; |
3130
+ | validator | | The filter validator | &nbsp; |
3019
3131
 
3020
3132
 
3021
3133
 
@@ -3023,17 +3135,17 @@ The validation to filter the stored filter is depending on:
3023
3135
  ##### Returns
3024
3136
 
3025
3137
 
3026
- - a new Filter object structure
3138
+ - true: it is a range validator
3027
3139
 
3028
3140
 
3029
3141
 
3030
3142
 
3031
- ### dist/filters/helpers/common/getFiltersByScopes.js
3143
+ ### dist/filters/helpers/common/isRegularValidator.js
3032
3144
 
3033
3145
 
3034
- #### getFiltersByScopes(filterData, scopes)
3146
+ #### isRegularValidator(validator)
3035
3147
 
3036
- Filters and gets a Filter Data by the given scopes
3148
+ Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3037
3149
 
3038
3150
 
3039
3151
 
@@ -3042,8 +3154,7 @@ Filters and gets a Filter Data by the given scopes
3042
3154
 
3043
3155
  | Name | Type | Description | |
3044
3156
  | ---- | ---- | ----------- | -------- |
3045
- | filterData | | The Filter Data | &nbsp; |
3046
- | scopes | | collection of scopes types | &nbsp; |
3157
+ | validator | | The filter validator | &nbsp; |
3047
3158
 
3048
3159
 
3049
3160
 
@@ -3051,17 +3162,17 @@ Filters and gets a Filter Data by the given scopes
3051
3162
  ##### Returns
3052
3163
 
3053
3164
 
3054
- - The new Filter Data
3165
+ - true: it is a range validator
3055
3166
 
3056
3167
 
3057
3168
 
3058
3169
 
3059
- ### dist/filters/helpers/common/getFiltersByScopesIds.js
3170
+ ### dist/filters/helpers/common/mergeFilters.js
3060
3171
 
3061
3172
 
3062
- #### getFiltersByScopesIds(filterData, scopes)
3173
+ #### mergeFilters(filterData1, filterData2, overwriteValues)
3063
3174
 
3064
- Gets filters from Filter Data by Scopes/Scope IDs.
3175
+ Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3065
3176
 
3066
3177
 
3067
3178
 
@@ -3070,8 +3181,9 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3070
3181
 
3071
3182
  | Name | Type | Description | |
3072
3183
  | ---- | ---- | ----------- | -------- |
3073
- | filterData | | The filter data | &nbsp; |
3074
- | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3184
+ | filterData1 | | The target filter data | &nbsp; |
3185
+ | filterData2 | | the filter data to be merged | &nbsp; |
3186
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3075
3187
 
3076
3188
 
3077
3189
 
@@ -3079,17 +3191,13 @@ Gets filters from Filter Data by Scopes/Scope IDs.
3079
3191
  ##### Returns
3080
3192
 
3081
3193
 
3082
- - a new Filter Data
3083
-
3084
-
3085
-
3194
+ - a new filter data structure
3086
3195
 
3087
- ### dist/filters/helpers/common/getFiltersByVisibility.js
3088
3196
 
3089
3197
 
3090
- #### getFiltersByVisibility(filterData, scopes)
3198
+ #### mergeScopes(scopes1, scopes2, overwriteValues)
3091
3199
 
3092
- Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3200
+ Gets a new scope structure array by merging two scope structures
3093
3201
 
3094
3202
 
3095
3203
 
@@ -3098,8 +3206,9 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3098
3206
 
3099
3207
  | Name | Type | Description | |
3100
3208
  | ---- | ---- | ----------- | -------- |
3101
- | filterData | | a Filter Data or UI Filter Data | &nbsp; |
3102
- | scopes | | a Scopes/Scope IDs array | &nbsp; |
3209
+ | scopes1 | | the target scope structure | &nbsp; |
3210
+ | scopes2 | | the scope to be merged | &nbsp; |
3211
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3103
3212
 
3104
3213
 
3105
3214
 
@@ -3107,17 +3216,13 @@ Get a new Filter Data by filtering scopes/scope IDs and enabled flags
3107
3216
  ##### Returns
3108
3217
 
3109
3218
 
3110
- - a new Filter Data
3111
-
3112
-
3113
-
3219
+ - a new scope structure array
3114
3220
 
3115
- ### dist/filters/helpers/common/getMergeFiltersSettings.js
3116
3221
 
3117
3222
 
3118
- #### getMergeFiltersSettings(settings)
3223
+ #### mergeDatasets(datasets1, datasets2, overwriteValues)
3119
3224
 
3120
- Transforms the given MergeFilters settings object. Adds the missing properties if they do not exist.
3225
+ Gets a new dataset structure array by merging two dataset structures
3121
3226
 
3122
3227
 
3123
3228
 
@@ -3126,7 +3231,9 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3126
3231
 
3127
3232
  | Name | Type | Description | |
3128
3233
  | ---- | ---- | ----------- | -------- |
3129
- | settings | | an object to the MergeFilters settings | &nbsp; |
3234
+ | datasets1 | | the target dataset structure | &nbsp; |
3235
+ | datasets2 | | the dataset to be merged | &nbsp; |
3236
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3130
3237
 
3131
3238
 
3132
3239
 
@@ -3134,17 +3241,13 @@ Transforms the given MergeFilters settings object. Adds the missing properties i
3134
3241
  ##### Returns
3135
3242
 
3136
3243
 
3137
- - a new MergeFilters settings object.
3138
-
3139
-
3140
-
3244
+ - a new dataset structure array
3141
3245
 
3142
- ### dist/filters/helpers/common/getParamsToGetFilterSettings.js
3143
3246
 
3144
3247
 
3145
- #### getParamsToGetFilterSettings(settings)
3248
+ #### mergeFilterss(filters1, filters2, overwriteValues)
3146
3249
 
3147
- Transforms the given ParamsToGetFilter settings object. Adds the missing properties if they do not exist.
3250
+ Gets a new filter structure array by merging two filter structures
3148
3251
 
3149
3252
 
3150
3253
 
@@ -3153,7 +3256,9 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3153
3256
 
3154
3257
  | Name | Type | Description | |
3155
3258
  | ---- | ---- | ----------- | -------- |
3156
- | settings | | an object to the ParamsToGetFilter settings | &nbsp; |
3259
+ | filters1 | | the target filter structure | &nbsp; |
3260
+ | filters2 | | the filter to be merged | &nbsp; |
3261
+ | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3157
3262
 
3158
3263
 
3159
3264
 
@@ -3161,17 +3266,13 @@ Transforms the given ParamsToGetFilter settings object. Adds the missing propert
3161
3266
  ##### Returns
3162
3267
 
3163
3268
 
3164
- - a new ParamsToGetFilter settings object.
3165
-
3166
-
3167
-
3269
+ - a new filter structure array
3168
3270
 
3169
- ### dist/filters/helpers/common/haveFiltersByDataset.js
3170
3271
 
3171
3272
 
3172
- #### haveFiltersByDataset(filterData, qrveyid)
3273
+ #### mergeValues(filter1, filter2, overwrite)
3173
3274
 
3174
- Validates if the filter data has filters by a dataset ID (Qrvey ID).
3275
+ Gets a new value structure array by merging two value structures
3175
3276
 
3176
3277
 
3177
3278
 
@@ -3180,8 +3281,9 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3180
3281
 
3181
3282
  | Name | Type | Description | |
3182
3283
  | ---- | ---- | ----------- | -------- |
3183
- | filterData | | the filter data or the UI filter data. | &nbsp; |
3184
- | qrveyid | | The Qrvey ID | &nbsp; |
3284
+ | filter1 | | the target filter structure | &nbsp; |
3285
+ | filter2 | | the filter to be used to merge the values | &nbsp; |
3286
+ | overwrite | | Flag to overwrite or not the filter values | &nbsp; |
3185
3287
 
3186
3288
 
3187
3289
 
@@ -3189,17 +3291,17 @@ Validates if the filter data has filters by a dataset ID (Qrvey ID).
3189
3291
  ##### Returns
3190
3292
 
3191
3293
 
3192
- - true: the filter data has filters by the Qrvey ID
3294
+ - a new value structure array
3193
3295
 
3194
3296
 
3195
3297
 
3196
3298
 
3197
- ### dist/filters/helpers/common/isBetweenValidator.js
3299
+ ### dist/filters/helpers/common/resolveDatasetConditions.js
3198
3300
 
3199
3301
 
3200
- #### isBetweenValidator(validator)
3302
+ #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3201
3303
 
3202
- Validates if the given validator is a Between type
3304
+ Resolves the conditions by given params
3203
3305
 
3204
3306
 
3205
3307
 
@@ -3208,7 +3310,10 @@ Validates if the given validator is a Between type
3208
3310
 
3209
3311
  | Name | Type | Description | |
3210
3312
  | ---- | ---- | ----------- | -------- |
3211
- | validator | | The validator | &nbsp; |
3313
+ | filter | | The dataset structure | &nbsp; |
3314
+ | params | | given parameters to validate the dataset | &nbsp; |
3315
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3316
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
3212
3317
 
3213
3318
 
3214
3319
 
@@ -3216,17 +3321,17 @@ Validates if the given validator is a Between type
3216
3321
  ##### Returns
3217
3322
 
3218
3323
 
3219
- - true: it is a between validator; false: it is not a between validator
3324
+ - true: the condition is satisfied
3220
3325
 
3221
3326
 
3222
3327
 
3223
3328
 
3224
- ### dist/filters/helpers/common/isDateDistinctProperty.js
3329
+ ### dist/filters/helpers/common/resolveFilterConditions.js
3225
3330
 
3226
3331
 
3227
- #### isDateDistinctProperty(column, property)
3332
+ #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3228
3333
 
3229
- Determines if the filter column and property is a distinct group dates type
3334
+ Resolves the conditions by given params
3230
3335
 
3231
3336
 
3232
3337
 
@@ -3235,8 +3340,10 @@ Determines if the filter column and property is a distinct group dates type
3235
3340
 
3236
3341
  | Name | Type | Description | |
3237
3342
  | ---- | ---- | ----------- | -------- |
3238
- | column | | The filter column | &nbsp; |
3239
- | property | | The filter property | &nbsp; |
3343
+ | filter | | The filter | &nbsp; |
3344
+ | params | | given parameters to validate the filter | &nbsp; |
3345
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3346
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
3240
3347
 
3241
3348
 
3242
3349
 
@@ -3244,17 +3351,17 @@ Determines if the filter column and property is a distinct group dates type
3244
3351
  ##### Returns
3245
3352
 
3246
3353
 
3247
- - True if the given property is included from distinct group dates type
3354
+ - true: the condition is satisfied
3248
3355
 
3249
3356
 
3250
3357
 
3251
3358
 
3252
- ### dist/filters/helpers/common/isInValidator.js
3359
+ ### dist/filters/helpers/common/resolveScopeConditions.js
3253
3360
 
3254
3361
 
3255
- #### isInValidator(validator)
3362
+ #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3256
3363
 
3257
- Validates if the given validator is a In type
3364
+ Resolves the conditions by given params
3258
3365
 
3259
3366
 
3260
3367
 
@@ -3263,7 +3370,10 @@ Validates if the given validator is a In type
3263
3370
 
3264
3371
  | Name | Type | Description | |
3265
3372
  | ---- | ---- | ----------- | -------- |
3266
- | validator | | The validator | &nbsp; |
3373
+ | filter | | The filter scope structure | &nbsp; |
3374
+ | params | | given parameters to validate the filter | &nbsp; |
3375
+ | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3376
+ | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
3267
3377
 
3268
3378
 
3269
3379
 
@@ -3271,17 +3381,18 @@ Validates if the given validator is a In type
3271
3381
  ##### Returns
3272
3382
 
3273
3383
 
3274
- - true: it is a In validator; false: it is not a In validator
3384
+ - true: the condition is satisfied
3275
3385
 
3276
3386
 
3277
3387
 
3278
3388
 
3279
- ### dist/filters/helpers/common/isNullValidator.js
3389
+ ### dist/filters/helpers/backend/buildExpression.js
3280
3390
 
3281
3391
 
3282
- #### isNullValidator(validator)
3392
+ #### buildExpression(filter)
3283
3393
 
3284
- Checks if the given validator is a Null type.
3394
+ Builds filter expression by the filter data.
3395
+ - If the resulting value array is empty the enabled property will be false.
3285
3396
 
3286
3397
 
3287
3398
 
@@ -3290,7 +3401,7 @@ Checks if the given validator is a Null type.
3290
3401
 
3291
3402
  | Name | Type | Description | |
3292
3403
  | ---- | ---- | ----------- | -------- |
3293
- | validator | | The Filter Validator | &nbsp; |
3404
+ | filter | | The filter to transform | &nbsp; |
3294
3405
 
3295
3406
 
3296
3407
 
@@ -3298,17 +3409,17 @@ Checks if the given validator is a Null type.
3298
3409
  ##### Returns
3299
3410
 
3300
3411
 
3301
- - True: It is a Null Validator; False: It is not a Null Validator.
3412
+ - a filter expression
3302
3413
 
3303
3414
 
3304
3415
 
3305
3416
 
3306
- ### dist/filters/helpers/common/isRangeValidator.js
3417
+ ### dist/filters/helpers/backend/buildUserFilters.js
3307
3418
 
3308
3419
 
3309
- #### isRangeValidator(validator)
3420
+ #### buildUserFilters(userFilters)
3310
3421
 
3311
- Validates if the given validator is a Range type. Range type means the value has min and max values to filter
3422
+ Transform user Filters array into Filter Logic structure
3312
3423
 
3313
3424
 
3314
3425
 
@@ -3317,7 +3428,7 @@ Validates if the given validator is a Range type. Range type means the value has
3317
3428
 
3318
3429
  | Name | Type | Description | |
3319
3430
  | ---- | ---- | ----------- | -------- |
3320
- | validator | | The filter validator | &nbsp; |
3431
+ | userFilters | | The filters that the user defined. | &nbsp; |
3321
3432
 
3322
3433
 
3323
3434
 
@@ -3325,17 +3436,17 @@ Validates if the given validator is a Range type. Range type means the value has
3325
3436
  ##### Returns
3326
3437
 
3327
3438
 
3328
- - true: it is a range validator
3439
+ - The filter logic for the given user filters. if No a given object is recieved, it will return an empty array.
3329
3440
 
3330
3441
 
3331
3442
 
3332
3443
 
3333
- ### dist/filters/helpers/common/isRegularValidator.js
3444
+ ### dist/filters/helpers/backend/getAggFiltersBySummaryIndex.js
3334
3445
 
3335
3446
 
3336
- #### isRegularValidator(validator)
3447
+ #### getAggFiltersBySummaryIndex(aggFilters, summaryIndex)
3448
+
3337
3449
 
3338
- Validates if the given validator is a regular type. Regular type means the filter object has a value as string to filter
3339
3450
 
3340
3451
 
3341
3452
 
@@ -3344,7 +3455,8 @@ Validates if the given validator is a regular type. Regular type means the filte
3344
3455
 
3345
3456
  | Name | Type | Description | |
3346
3457
  | ---- | ---- | ----------- | -------- |
3347
- | validator | | The filter validator | &nbsp; |
3458
+ | aggFilters | | | &nbsp; |
3459
+ | summaryIndex | | | &nbsp; |
3348
3460
 
3349
3461
 
3350
3462
 
@@ -3352,17 +3464,17 @@ Validates if the given validator is a regular type. Regular type means the filte
3352
3464
  ##### Returns
3353
3465
 
3354
3466
 
3355
- - true: it is a range validator
3467
+ -
3356
3468
 
3357
3469
 
3358
3470
 
3359
3471
 
3360
- ### dist/filters/helpers/common/mergeFilters.js
3472
+ ### dist/filters/helpers/backend/getBackendGroupValue.js
3361
3473
 
3362
3474
 
3363
- #### mergeFilters(filterData1, filterData2, overwriteValues)
3475
+ #### getBackendGroupValue(filter)
3364
3476
 
3365
- Merge filter data structures in a new one. The first Filter Data passed in the argument has the priority
3477
+ Gets a group value for the backend logic structure
3366
3478
 
3367
3479
 
3368
3480
 
@@ -3371,9 +3483,7 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3371
3483
 
3372
3484
  | Name | Type | Description | |
3373
3485
  | ---- | ---- | ----------- | -------- |
3374
- | filterData1 | | The target filter data | &nbsp; |
3375
- | filterData2 | | the filter data to be merged | &nbsp; |
3376
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3486
+ | filter | | The filter | &nbsp; |
3377
3487
 
3378
3488
 
3379
3489
 
@@ -3381,13 +3491,17 @@ Merge filter data structures in a new one. The first Filter Data passed in the a
3381
3491
  ##### Returns
3382
3492
 
3383
3493
 
3384
- - a new filter data structure
3494
+ - a property
3385
3495
 
3386
3496
 
3387
3497
 
3388
- #### mergeScopes(scopes1, scopes2, overwriteValues)
3389
3498
 
3390
- Gets a new scope structure array by merging two scope structures
3499
+ ### dist/filters/helpers/backend/getBackendProperty.js
3500
+
3501
+
3502
+ #### getBackendProperty(filter)
3503
+
3504
+ Gets a property for the logic structure
3391
3505
 
3392
3506
 
3393
3507
 
@@ -3396,9 +3510,7 @@ Gets a new scope structure array by merging two scope structures
3396
3510
 
3397
3511
  | Name | Type | Description | |
3398
3512
  | ---- | ---- | ----------- | -------- |
3399
- | scopes1 | | the target scope structure | &nbsp; |
3400
- | scopes2 | | the scope to be merged | &nbsp; |
3401
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3513
+ | filter | | The filter | &nbsp; |
3402
3514
 
3403
3515
 
3404
3516
 
@@ -3406,13 +3518,17 @@ Gets a new scope structure array by merging two scope structures
3406
3518
  ##### Returns
3407
3519
 
3408
3520
 
3409
- - a new scope structure array
3521
+ - a property
3410
3522
 
3411
3523
 
3412
3524
 
3413
- #### mergeDatasets(datasets1, datasets2, overwriteValues)
3414
3525
 
3415
- Gets a new dataset structure array by merging two dataset structures
3526
+ ### dist/filters/helpers/backend/getBackendValidator.js
3527
+
3528
+
3529
+ #### getBackendValidator(validator)
3530
+
3531
+ Gets the Validator that is used in requests
3416
3532
 
3417
3533
 
3418
3534
 
@@ -3421,9 +3537,7 @@ Gets a new dataset structure array by merging two dataset structures
3421
3537
 
3422
3538
  | Name | Type | Description | |
3423
3539
  | ---- | ---- | ----------- | -------- |
3424
- | datasets1 | | the target dataset structure | &nbsp; |
3425
- | datasets2 | | the dataset to be merged | &nbsp; |
3426
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3540
+ | validator | | Filter Validator used in UI | &nbsp; |
3427
3541
 
3428
3542
 
3429
3543
 
@@ -3431,13 +3545,17 @@ Gets a new dataset structure array by merging two dataset structures
3431
3545
  ##### Returns
3432
3546
 
3433
3547
 
3434
- - a new dataset structure array
3548
+ - Filter Validator used in Backend
3435
3549
 
3436
3550
 
3437
3551
 
3438
- #### mergeFilterss(filters1, filters2, overwriteValues)
3439
3552
 
3440
- Gets a new filter structure array by merging two filter structures
3553
+ ### dist/filters/helpers/backend/getBackendValues.js
3554
+
3555
+
3556
+ #### getBackendValues(filter)
3557
+
3558
+ Gets the expresion values in the logic format
3441
3559
 
3442
3560
 
3443
3561
 
@@ -3446,9 +3564,7 @@ Gets a new filter structure array by merging two filter structures
3446
3564
 
3447
3565
  | Name | Type | Description | |
3448
3566
  | ---- | ---- | ----------- | -------- |
3449
- | filters1 | | the target filter structure | &nbsp; |
3450
- | filters2 | | the filter to be merged | &nbsp; |
3451
- | overwriteValues | | Flag to overwrite or not the filter values | &nbsp; |
3567
+ | filter | | The filter structure | &nbsp; |
3452
3568
 
3453
3569
 
3454
3570
 
@@ -3456,13 +3572,13 @@ Gets a new filter structure array by merging two filter structures
3456
3572
  ##### Returns
3457
3573
 
3458
3574
 
3459
- - a new filter structure array
3575
+ - A collection of backend expression value
3460
3576
 
3461
3577
 
3462
3578
 
3463
- #### mergeValues(filter1, filter2, overwrite)
3579
+ #### getResultValues(values, filter)
3464
3580
 
3465
- Gets a new value structure array by merging two value structures
3581
+ Gets the expression values. Depending on the column type
3466
3582
 
3467
3583
 
3468
3584
 
@@ -3471,9 +3587,8 @@ Gets a new value structure array by merging two value structures
3471
3587
 
3472
3588
  | Name | Type | Description | |
3473
3589
  | ---- | ---- | ----------- | -------- |
3474
- | filter1 | | the target filter structure | &nbsp; |
3475
- | filter2 | | the filter to be used to merge the values | &nbsp; |
3476
- | overwrite | | Flag to overwrite or not the filter values | &nbsp; |
3590
+ | values | | a collection of filter values | &nbsp; |
3591
+ | filter | | The filter structure | &nbsp; |
3477
3592
 
3478
3593
 
3479
3594
 
@@ -3481,17 +3596,13 @@ Gets a new value structure array by merging two value structures
3481
3596
  ##### Returns
3482
3597
 
3483
3598
 
3484
- - a new value structure array
3485
-
3486
-
3487
-
3599
+ -
3488
3600
 
3489
- ### dist/filters/helpers/common/resolveDatasetConditions.js
3490
3601
 
3491
3602
 
3492
- #### resolveDatasetConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3603
+ #### getRankingValues(values, rankingGroupIndex)
3493
3604
 
3494
- Resolves the conditions by given params
3605
+ Gets the Ranking values.
3495
3606
 
3496
3607
 
3497
3608
 
@@ -3500,10 +3611,8 @@ Resolves the conditions by given params
3500
3611
 
3501
3612
  | Name | Type | Description | |
3502
3613
  | ---- | ---- | ----------- | -------- |
3503
- | filter | | The dataset structure | &nbsp; |
3504
- | params | | given parameters to validate the dataset | &nbsp; |
3505
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3506
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
3614
+ | values | | a collection of filter values in the ranking structure | &nbsp; |
3615
+ | rankingGroupIndex | | determine the value by this index to build and return it | &nbsp; |
3507
3616
 
3508
3617
 
3509
3618
 
@@ -3511,17 +3620,17 @@ Resolves the conditions by given params
3511
3620
  ##### Returns
3512
3621
 
3513
3622
 
3514
- - true: the condition is satisfied
3623
+ - Expression values for ranking
3515
3624
 
3516
3625
 
3517
3626
 
3518
3627
 
3519
- ### dist/filters/helpers/common/resolveFilterConditions.js
3628
+ ### dist/filters/helpers/backend/getLogicByScopes.js
3520
3629
 
3521
3630
 
3522
- #### resolveFilterConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3631
+ #### getLogicByScopes(logics, scopes)
3523
3632
 
3524
- Resolves the conditions by given params
3633
+ Gets the filters from logic data by Scopes/Scope IDs.
3525
3634
 
3526
3635
 
3527
3636
 
@@ -3530,10 +3639,8 @@ Resolves the conditions by given params
3530
3639
 
3531
3640
  | Name | Type | Description | |
3532
3641
  | ---- | ---- | ----------- | -------- |
3533
- | filter | | The filter | &nbsp; |
3534
- | params | | given parameters to validate the filter | &nbsp; |
3535
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3536
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
3642
+ | logics | | The logic array | &nbsp; |
3643
+ | scopes | | The collection of Scopes/Scope IDs | &nbsp; |
3537
3644
 
3538
3645
 
3539
3646
 
@@ -3541,17 +3648,17 @@ Resolves the conditions by given params
3541
3648
  ##### Returns
3542
3649
 
3543
3650
 
3544
- - true: the condition is satisfied
3651
+ - a new Logic array
3545
3652
 
3546
3653
 
3547
3654
 
3548
3655
 
3549
- ### dist/filters/helpers/common/resolveScopeConditions.js
3656
+ ### dist/filters/helpers/backend/getLogicByScopesHierarchy.js
3550
3657
 
3551
3658
 
3552
- #### resolveScopeConditions(filter, params, letPassUndefinedProperties, letPassUndefinedParams)
3659
+ #### getLogicByScopesHierarchy(filterData, scopes, currentScope)
3553
3660
 
3554
- Resolves the conditions by given params
3661
+ Gets filters from the logic by the scopes hierarchy.
3555
3662
 
3556
3663
 
3557
3664
 
@@ -3560,10 +3667,9 @@ Resolves the conditions by given params
3560
3667
 
3561
3668
  | Name | Type | Description | |
3562
3669
  | ---- | ---- | ----------- | -------- |
3563
- | filter | | The filter scope structure | &nbsp; |
3564
- | params | | given parameters to validate the filter | &nbsp; |
3565
- | letPassUndefinedProperties | | Flag to avoid applying the condition when the filter properties are undefined | &nbsp; |
3566
- | letPassUndefinedParams | | Flag to avoid applying the condition when the param properties are explicit undefined. | &nbsp; |
3670
+ | filterData | | | &nbsp; |
3671
+ | scopes | | | &nbsp; |
3672
+ | currentScope | | | &nbsp; |
3567
3673
 
3568
3674
 
3569
3675
 
@@ -3571,7 +3677,7 @@ Resolves the conditions by given params
3571
3677
  ##### Returns
3572
3678
 
3573
3679
 
3574
- - true: the condition is satisfied
3680
+ - a new array of Logic
3575
3681
 
3576
3682
 
3577
3683