@gooddata/sdk-ui 8.10.0-alpha.14 → 8.10.0-alpha.142

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 (484) hide show
  1. package/README.md +3 -3
  2. package/dist/base/errors/GoodDataSdkError.d.ts +4 -1
  3. package/dist/base/errors/GoodDataSdkError.d.ts.map +1 -1
  4. package/dist/base/errors/GoodDataSdkError.js +5 -2
  5. package/dist/base/errors/GoodDataSdkError.js.map +1 -1
  6. package/dist/base/errors/errorHandling.d.ts +5 -3
  7. package/dist/base/errors/errorHandling.d.ts.map +1 -1
  8. package/dist/base/errors/errorHandling.js +6 -4
  9. package/dist/base/errors/errorHandling.js.map +1 -1
  10. package/dist/base/headerMatching/HeaderPredicate.d.ts +5 -1
  11. package/dist/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  12. package/dist/base/headerMatching/HeaderPredicate.js.map +1 -1
  13. package/dist/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  14. package/dist/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  15. package/dist/base/headerMatching/HeaderPredicateFactory.js +6 -6
  16. package/dist/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  17. package/dist/base/headerMatching/MappingHeader.d.ts +3 -1
  18. package/dist/base/headerMatching/MappingHeader.d.ts.map +1 -1
  19. package/dist/base/headerMatching/MappingHeader.js +13 -13
  20. package/dist/base/headerMatching/MappingHeader.js.map +1 -1
  21. package/dist/base/helpers/CatalogHelper.d.ts +5 -3
  22. package/dist/base/helpers/CatalogHelper.d.ts.map +1 -1
  23. package/dist/base/helpers/CatalogHelper.js +5 -3
  24. package/dist/base/helpers/CatalogHelper.js.map +1 -1
  25. package/dist/base/index.d.ts +6 -3
  26. package/dist/base/index.d.ts.map +1 -1
  27. package/dist/base/index.js +11 -2
  28. package/dist/base/index.js.map +1 -1
  29. package/dist/base/localization/IntlStore.d.ts +3 -1
  30. package/dist/base/localization/IntlStore.d.ts.map +1 -1
  31. package/dist/base/localization/IntlStore.js +5 -25
  32. package/dist/base/localization/IntlStore.js.map +1 -1
  33. package/dist/base/localization/IntlWrapper.d.ts +0 -12
  34. package/dist/base/localization/IntlWrapper.d.ts.map +1 -1
  35. package/dist/base/localization/IntlWrapper.js +3 -28
  36. package/dist/base/localization/IntlWrapper.js.map +1 -1
  37. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  38. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  39. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +4 -4
  40. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  41. package/dist/base/localization/TranslationsProvider.d.ts.map +1 -1
  42. package/dist/base/localization/TranslationsProvider.js +5 -9
  43. package/dist/base/localization/TranslationsProvider.js.map +1 -1
  44. package/dist/base/localization/bundles/de-DE.json +80 -18
  45. package/dist/base/localization/bundles/en-US.json +425 -64
  46. package/dist/base/localization/bundles/es-ES.json +89 -27
  47. package/dist/base/localization/bundles/fr-FR.json +79 -17
  48. package/dist/base/localization/bundles/ja-JP.json +80 -18
  49. package/dist/base/localization/bundles/nl-NL.json +79 -17
  50. package/dist/base/localization/bundles/pt-BR.json +79 -17
  51. package/dist/base/localization/bundles/pt-PT.json +79 -17
  52. package/dist/base/localization/bundles/ru-RU.json +79 -17
  53. package/dist/base/localization/bundles/zh-Hans.json +80 -18
  54. package/dist/base/localization/intlUtils.d.ts +1 -1
  55. package/dist/base/localization/intlUtils.js +4 -4
  56. package/dist/base/localization/messagesMap.d.ts +13 -0
  57. package/dist/base/localization/messagesMap.d.ts.map +1 -0
  58. package/dist/base/localization/messagesMap.js +32 -0
  59. package/dist/base/localization/messagesMap.js.map +1 -0
  60. package/dist/base/measureFormats/fillMissingFormat.d.ts +12 -0
  61. package/dist/base/measureFormats/fillMissingFormat.d.ts.map +1 -0
  62. package/dist/base/measureFormats/fillMissingFormat.js +27 -0
  63. package/dist/base/measureFormats/fillMissingFormat.js.map +1 -0
  64. package/dist/base/measureFormats/fillMissingFormats.d.ts +12 -0
  65. package/dist/base/measureFormats/fillMissingFormats.d.ts.map +1 -0
  66. package/dist/base/measureFormats/fillMissingFormats.js +20 -0
  67. package/dist/base/measureFormats/fillMissingFormats.js.map +1 -0
  68. package/dist/base/measureTitles/ArithmeticMeasureTitleFactory.d.ts.map +1 -1
  69. package/dist/base/measureTitles/ArithmeticMeasureTitleFactory.js +6 -14
  70. package/dist/base/measureTitles/ArithmeticMeasureTitleFactory.js.map +1 -1
  71. package/dist/base/measureTitles/DerivedMeasureTitleSuffixFactory.js +4 -3
  72. package/dist/base/measureTitles/DerivedMeasureTitleSuffixFactory.js.map +1 -1
  73. package/dist/base/measureTitles/fillMissingTitles.d.ts.map +1 -1
  74. package/dist/base/measureTitles/fillMissingTitles.js +4 -13
  75. package/dist/base/measureTitles/fillMissingTitles.js.map +1 -1
  76. package/dist/base/react/BackendContext.d.ts +7 -3
  77. package/dist/base/react/BackendContext.d.ts.map +1 -1
  78. package/dist/base/react/BackendContext.js +8 -4
  79. package/dist/base/react/BackendContext.js.map +1 -1
  80. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +12 -3
  81. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  82. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +14 -3
  83. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  84. package/dist/base/react/ClientWorkspaceContext/interfaces.d.ts +6 -0
  85. package/dist/base/react/ClientWorkspaceContext/interfaces.d.ts.map +1 -1
  86. package/dist/base/react/ClientWorkspaceContext/interfaces.js +1 -1
  87. package/dist/base/react/ErrorComponent.d.ts +4 -2
  88. package/dist/base/react/ErrorComponent.d.ts.map +1 -1
  89. package/dist/base/react/ErrorComponent.js +5 -3
  90. package/dist/base/react/ErrorComponent.js.map +1 -1
  91. package/dist/base/react/LoadingComponent.d.ts +4 -2
  92. package/dist/base/react/LoadingComponent.d.ts.map +1 -1
  93. package/dist/base/react/LoadingComponent.js +5 -3
  94. package/dist/base/react/LoadingComponent.js.map +1 -1
  95. package/dist/base/react/WorkspaceContext.d.ts +7 -3
  96. package/dist/base/react/WorkspaceContext.d.ts.map +1 -1
  97. package/dist/base/react/WorkspaceContext.js +8 -4
  98. package/dist/base/react/WorkspaceContext.js.map +1 -1
  99. package/dist/base/react/legacy/availableDrillTargets.d.ts +1 -1
  100. package/dist/base/react/legacy/availableDrillTargets.d.ts.map +1 -1
  101. package/dist/base/react/legacy/availableDrillTargets.js +1 -1
  102. package/dist/base/react/legacy/availableDrillTargets.js.map +1 -1
  103. package/dist/base/react/placeholders/base.d.ts +76 -42
  104. package/dist/base/react/placeholders/base.d.ts.map +1 -1
  105. package/dist/base/react/placeholders/base.js +1 -1
  106. package/dist/base/react/placeholders/base.js.map +1 -1
  107. package/dist/base/react/placeholders/factory.d.ts +4 -2
  108. package/dist/base/react/placeholders/factory.d.ts.map +1 -1
  109. package/dist/base/react/placeholders/factory.js +3 -1
  110. package/dist/base/react/placeholders/factory.js.map +1 -1
  111. package/dist/base/react/placeholders/hooks.d.ts +13 -3
  112. package/dist/base/react/placeholders/hooks.d.ts.map +1 -1
  113. package/dist/base/react/placeholders/hooks.js +14 -4
  114. package/dist/base/react/placeholders/hooks.js.map +1 -1
  115. package/dist/base/react/placeholders/resolve.d.ts.map +1 -1
  116. package/dist/base/react/placeholders/resolve.js +5 -3
  117. package/dist/base/react/placeholders/resolve.js.map +1 -1
  118. package/dist/base/react/useCancelablePromise.d.ts +17 -11
  119. package/dist/base/react/useCancelablePromise.d.ts.map +1 -1
  120. package/dist/base/react/useCancelablePromise.js +9 -3
  121. package/dist/base/react/useCancelablePromise.js.map +1 -1
  122. package/dist/base/react/useCancelablePromiseUtils.d.ts +5 -3
  123. package/dist/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  124. package/dist/base/react/useCancelablePromiseUtils.js +6 -4
  125. package/dist/base/react/useCancelablePromiseUtils.js.map +1 -1
  126. package/dist/base/results/dataAccess.d.ts +32 -12
  127. package/dist/base/results/dataAccess.d.ts.map +1 -1
  128. package/dist/base/results/dataAccessConfig.d.ts +5 -2
  129. package/dist/base/results/dataAccessConfig.d.ts.map +1 -1
  130. package/dist/base/results/dataAccessConfig.js +4 -1
  131. package/dist/base/results/dataAccessConfig.js.map +1 -1
  132. package/dist/base/results/facade.d.ts +10 -8
  133. package/dist/base/results/facade.d.ts.map +1 -1
  134. package/dist/base/results/facade.js +9 -7
  135. package/dist/base/results/facade.js.map +1 -1
  136. package/dist/base/results/internal/dataAccessDigest.d.ts +2 -2
  137. package/dist/base/results/internal/dataAccessDigest.d.ts.map +1 -1
  138. package/dist/base/results/internal/dataAccessDigest.js +5 -7
  139. package/dist/base/results/internal/dataAccessDigest.js.map +1 -1
  140. package/dist/base/results/internal/dataAccessImpl.d.ts.map +1 -1
  141. package/dist/base/results/internal/dataAccessImpl.js +6 -6
  142. package/dist/base/results/internal/dataAccessImpl.js.map +1 -1
  143. package/dist/base/results/internal/dataAccessMethods.d.ts.map +1 -1
  144. package/dist/base/results/internal/dataAccessMethods.js +1 -1
  145. package/dist/base/results/internal/dataAccessMethods.js.map +1 -1
  146. package/dist/base/results/internal/definitionMethods.d.ts +1 -1
  147. package/dist/base/results/internal/definitionMethods.js +1 -1
  148. package/dist/base/results/internal/resultDataMethods.d.ts +3 -2
  149. package/dist/base/results/internal/resultDataMethods.d.ts.map +1 -1
  150. package/dist/base/results/internal/resultDataMethods.js.map +1 -1
  151. package/dist/base/results/internal/resultMetaMethods.d.ts +3 -3
  152. package/dist/base/results/internal/resultMetaMethods.d.ts.map +1 -1
  153. package/dist/base/results/internal/resultMetaMethods.js +9 -10
  154. package/dist/base/results/internal/resultMetaMethods.js.map +1 -1
  155. package/dist/base/results/internal/utils.d.ts +2 -1
  156. package/dist/base/results/internal/utils.d.ts.map +1 -1
  157. package/dist/base/results/internal/utils.js +1 -1
  158. package/dist/base/vis/DrillEvents.d.ts +4 -1
  159. package/dist/base/vis/DrillEvents.d.ts.map +1 -1
  160. package/dist/base/vis/DrillEvents.js.map +1 -1
  161. package/dist/base/vis/Events.d.ts +2 -2
  162. package/dist/base/vis/Events.d.ts.map +1 -1
  163. package/dist/base/vis/VisualizationProps.d.ts +11 -4
  164. package/dist/base/vis/VisualizationProps.d.ts.map +1 -1
  165. package/dist/base/vis/VisualizationProps.js +1 -1
  166. package/dist/base/vis/drilling.js +6 -6
  167. package/dist/base/vis/drilling.js.map +1 -1
  168. package/dist/base/vis/export.d.ts +1 -1
  169. package/dist/base/vis/export.js +3 -3
  170. package/dist/base/vis/export.js.map +1 -1
  171. package/dist/execution/DataViewLoader.d.ts +70 -0
  172. package/dist/execution/DataViewLoader.d.ts.map +1 -0
  173. package/dist/execution/DataViewLoader.js +146 -0
  174. package/dist/execution/DataViewLoader.js.map +1 -0
  175. package/dist/execution/Execute.d.ts +36 -20
  176. package/dist/execution/Execute.d.ts.map +1 -1
  177. package/dist/execution/Execute.js +7 -5
  178. package/dist/execution/Execute.js.map +1 -1
  179. package/dist/execution/ExecuteInsight.d.ts +47 -16
  180. package/dist/execution/ExecuteInsight.d.ts.map +1 -1
  181. package/dist/execution/ExecuteInsight.js +7 -5
  182. package/dist/execution/ExecuteInsight.js.map +1 -1
  183. package/dist/execution/RawExecute.d.ts +19 -7
  184. package/dist/execution/RawExecute.d.ts.map +1 -1
  185. package/dist/execution/RawExecute.js +2 -1
  186. package/dist/execution/RawExecute.js.map +1 -1
  187. package/dist/execution/createExecution.d.ts +9 -6
  188. package/dist/execution/createExecution.d.ts.map +1 -1
  189. package/dist/execution/createExecution.js +11 -2
  190. package/dist/execution/createExecution.js.map +1 -1
  191. package/dist/execution/index.d.ts +3 -2
  192. package/dist/execution/index.d.ts.map +1 -1
  193. package/dist/execution/index.js +4 -2
  194. package/dist/execution/index.js.map +1 -1
  195. package/dist/execution/useDataExport.d.ts +5 -3
  196. package/dist/execution/useDataExport.d.ts.map +1 -1
  197. package/dist/execution/useDataExport.js +3 -1
  198. package/dist/execution/useDataExport.js.map +1 -1
  199. package/dist/execution/useDataView.d.ts +5 -0
  200. package/dist/execution/useDataView.d.ts.map +1 -1
  201. package/dist/execution/useDataView.js +3 -0
  202. package/dist/execution/useDataView.js.map +1 -1
  203. package/dist/execution/useExecution.d.ts +17 -9
  204. package/dist/execution/useExecution.d.ts.map +1 -1
  205. package/dist/execution/useExecution.js +3 -0
  206. package/dist/execution/useExecution.js.map +1 -1
  207. package/dist/execution/useExecutionDataView.d.ts +32 -15
  208. package/dist/execution/useExecutionDataView.d.ts.map +1 -1
  209. package/dist/execution/useExecutionDataView.js +3 -3
  210. package/dist/execution/useExecutionDataView.js.map +1 -1
  211. package/dist/execution/useInsightDataView.d.ts +39 -9
  212. package/dist/execution/useInsightDataView.d.ts.map +1 -1
  213. package/dist/execution/useInsightDataView.js +10 -4
  214. package/dist/execution/useInsightDataView.js.map +1 -1
  215. package/dist/execution/withExecution.d.ts +5 -4
  216. package/dist/execution/withExecution.d.ts.map +1 -1
  217. package/dist/execution/withExecution.js +1 -1
  218. package/dist/execution/withExecution.js.map +1 -1
  219. package/dist/execution/withExecutionLoading.d.ts +12 -7
  220. package/dist/execution/withExecutionLoading.d.ts.map +1 -1
  221. package/dist/execution/withExecutionLoading.js +1 -1
  222. package/dist/execution/withExecutionLoading.js.map +1 -1
  223. package/dist/index.d.ts +1 -1
  224. package/dist/index.d.ts.map +1 -1
  225. package/dist/index.js +2 -1
  226. package/dist/index.js.map +1 -1
  227. package/dist/kpi/Kpi.d.ts +13 -9
  228. package/dist/kpi/Kpi.d.ts.map +1 -1
  229. package/dist/kpi/Kpi.js +5 -3
  230. package/dist/kpi/Kpi.js.map +1 -1
  231. package/dist/locales.d.ts +42 -0
  232. package/dist/locales.d.ts.map +1 -0
  233. package/dist/locales.js +22 -0
  234. package/dist/locales.js.map +1 -0
  235. package/dist/polyfills.d.ts.map +1 -1
  236. package/dist/polyfills.js +3 -1
  237. package/dist/polyfills.js.map +1 -1
  238. package/dist/sdk-ui.d.ts +576 -216
  239. package/esm/base/errors/GoodDataSdkError.d.ts +4 -1
  240. package/esm/base/errors/GoodDataSdkError.d.ts.map +1 -1
  241. package/esm/base/errors/GoodDataSdkError.js +5 -2
  242. package/esm/base/errors/GoodDataSdkError.js.map +1 -1
  243. package/esm/base/errors/errorHandling.d.ts +5 -3
  244. package/esm/base/errors/errorHandling.d.ts.map +1 -1
  245. package/esm/base/errors/errorHandling.js +6 -4
  246. package/esm/base/errors/errorHandling.js.map +1 -1
  247. package/esm/base/headerMatching/HeaderPredicate.d.ts +5 -1
  248. package/esm/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  249. package/esm/base/headerMatching/HeaderPredicate.js.map +1 -1
  250. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  251. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  252. package/esm/base/headerMatching/HeaderPredicateFactory.js +2 -2
  253. package/esm/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  254. package/esm/base/headerMatching/MappingHeader.d.ts +3 -1
  255. package/esm/base/headerMatching/MappingHeader.d.ts.map +1 -1
  256. package/esm/base/headerMatching/MappingHeader.js +2 -2
  257. package/esm/base/headerMatching/MappingHeader.js.map +1 -1
  258. package/esm/base/helpers/CatalogHelper.d.ts +5 -3
  259. package/esm/base/helpers/CatalogHelper.d.ts.map +1 -1
  260. package/esm/base/helpers/CatalogHelper.js +5 -3
  261. package/esm/base/helpers/CatalogHelper.js.map +1 -1
  262. package/esm/base/index.d.ts +6 -3
  263. package/esm/base/index.d.ts.map +1 -1
  264. package/esm/base/index.js +8 -2
  265. package/esm/base/index.js.map +1 -1
  266. package/esm/base/localization/IntlStore.d.ts +3 -1
  267. package/esm/base/localization/IntlStore.d.ts.map +1 -1
  268. package/esm/base/localization/IntlStore.js +5 -24
  269. package/esm/base/localization/IntlStore.js.map +1 -1
  270. package/esm/base/localization/IntlWrapper.d.ts +0 -12
  271. package/esm/base/localization/IntlWrapper.d.ts.map +1 -1
  272. package/esm/base/localization/IntlWrapper.js +2 -27
  273. package/esm/base/localization/IntlWrapper.js.map +1 -1
  274. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  275. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  276. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +4 -4
  277. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  278. package/esm/base/localization/TranslationsProvider.d.ts.map +1 -1
  279. package/esm/base/localization/TranslationsProvider.js +5 -9
  280. package/esm/base/localization/TranslationsProvider.js.map +1 -1
  281. package/esm/base/localization/bundles/de-DE.json +80 -18
  282. package/esm/base/localization/bundles/en-US.json +425 -64
  283. package/esm/base/localization/bundles/es-ES.json +89 -27
  284. package/esm/base/localization/bundles/fr-FR.json +79 -17
  285. package/esm/base/localization/bundles/ja-JP.json +80 -18
  286. package/esm/base/localization/bundles/nl-NL.json +79 -17
  287. package/esm/base/localization/bundles/pt-BR.json +79 -17
  288. package/esm/base/localization/bundles/pt-PT.json +79 -17
  289. package/esm/base/localization/bundles/ru-RU.json +79 -17
  290. package/esm/base/localization/bundles/zh-Hans.json +80 -18
  291. package/esm/base/localization/intlUtils.d.ts +1 -1
  292. package/esm/base/localization/intlUtils.js +2 -2
  293. package/esm/base/localization/messagesMap.d.ts +13 -0
  294. package/esm/base/localization/messagesMap.d.ts.map +1 -0
  295. package/esm/base/localization/messagesMap.js +28 -0
  296. package/esm/base/localization/messagesMap.js.map +1 -0
  297. package/esm/base/measureFormats/fillMissingFormat.d.ts +12 -0
  298. package/esm/base/measureFormats/fillMissingFormat.d.ts.map +1 -0
  299. package/esm/base/measureFormats/fillMissingFormat.js +23 -0
  300. package/esm/base/measureFormats/fillMissingFormat.js.map +1 -0
  301. package/esm/base/measureFormats/fillMissingFormats.d.ts +12 -0
  302. package/esm/base/measureFormats/fillMissingFormats.d.ts.map +1 -0
  303. package/esm/base/measureFormats/fillMissingFormats.js +16 -0
  304. package/esm/base/measureFormats/fillMissingFormats.js.map +1 -0
  305. package/esm/base/measureTitles/ArithmeticMeasureTitleFactory.d.ts.map +1 -1
  306. package/esm/base/measureTitles/ArithmeticMeasureTitleFactory.js +6 -14
  307. package/esm/base/measureTitles/ArithmeticMeasureTitleFactory.js.map +1 -1
  308. package/esm/base/measureTitles/DerivedMeasureTitleSuffixFactory.js +4 -3
  309. package/esm/base/measureTitles/DerivedMeasureTitleSuffixFactory.js.map +1 -1
  310. package/esm/base/measureTitles/fillMissingTitles.d.ts.map +1 -1
  311. package/esm/base/measureTitles/fillMissingTitles.js +5 -14
  312. package/esm/base/measureTitles/fillMissingTitles.js.map +1 -1
  313. package/esm/base/react/BackendContext.d.ts +7 -3
  314. package/esm/base/react/BackendContext.d.ts.map +1 -1
  315. package/esm/base/react/BackendContext.js +8 -4
  316. package/esm/base/react/BackendContext.js.map +1 -1
  317. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +12 -3
  318. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  319. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +14 -2
  320. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  321. package/esm/base/react/ClientWorkspaceContext/interfaces.d.ts +6 -0
  322. package/esm/base/react/ClientWorkspaceContext/interfaces.d.ts.map +1 -1
  323. package/esm/base/react/ClientWorkspaceContext/interfaces.js +1 -1
  324. package/esm/base/react/ErrorComponent.d.ts +4 -2
  325. package/esm/base/react/ErrorComponent.d.ts.map +1 -1
  326. package/esm/base/react/ErrorComponent.js +5 -3
  327. package/esm/base/react/ErrorComponent.js.map +1 -1
  328. package/esm/base/react/LoadingComponent.d.ts +4 -2
  329. package/esm/base/react/LoadingComponent.d.ts.map +1 -1
  330. package/esm/base/react/LoadingComponent.js +5 -3
  331. package/esm/base/react/LoadingComponent.js.map +1 -1
  332. package/esm/base/react/WorkspaceContext.d.ts +7 -3
  333. package/esm/base/react/WorkspaceContext.d.ts.map +1 -1
  334. package/esm/base/react/WorkspaceContext.js +8 -4
  335. package/esm/base/react/WorkspaceContext.js.map +1 -1
  336. package/esm/base/react/legacy/availableDrillTargets.d.ts +1 -1
  337. package/esm/base/react/legacy/availableDrillTargets.d.ts.map +1 -1
  338. package/esm/base/react/legacy/availableDrillTargets.js +1 -1
  339. package/esm/base/react/legacy/availableDrillTargets.js.map +1 -1
  340. package/esm/base/react/placeholders/base.d.ts +76 -42
  341. package/esm/base/react/placeholders/base.d.ts.map +1 -1
  342. package/esm/base/react/placeholders/base.js +1 -1
  343. package/esm/base/react/placeholders/base.js.map +1 -1
  344. package/esm/base/react/placeholders/factory.d.ts +4 -2
  345. package/esm/base/react/placeholders/factory.d.ts.map +1 -1
  346. package/esm/base/react/placeholders/factory.js +3 -1
  347. package/esm/base/react/placeholders/factory.js.map +1 -1
  348. package/esm/base/react/placeholders/hooks.d.ts +13 -3
  349. package/esm/base/react/placeholders/hooks.d.ts.map +1 -1
  350. package/esm/base/react/placeholders/hooks.js +14 -4
  351. package/esm/base/react/placeholders/hooks.js.map +1 -1
  352. package/esm/base/react/placeholders/resolve.d.ts.map +1 -1
  353. package/esm/base/react/placeholders/resolve.js +5 -3
  354. package/esm/base/react/placeholders/resolve.js.map +1 -1
  355. package/esm/base/react/useCancelablePromise.d.ts +17 -11
  356. package/esm/base/react/useCancelablePromise.d.ts.map +1 -1
  357. package/esm/base/react/useCancelablePromise.js +9 -3
  358. package/esm/base/react/useCancelablePromise.js.map +1 -1
  359. package/esm/base/react/useCancelablePromiseUtils.d.ts +5 -3
  360. package/esm/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  361. package/esm/base/react/useCancelablePromiseUtils.js +6 -4
  362. package/esm/base/react/useCancelablePromiseUtils.js.map +1 -1
  363. package/esm/base/results/dataAccess.d.ts +32 -12
  364. package/esm/base/results/dataAccess.d.ts.map +1 -1
  365. package/esm/base/results/dataAccessConfig.d.ts +5 -2
  366. package/esm/base/results/dataAccessConfig.d.ts.map +1 -1
  367. package/esm/base/results/dataAccessConfig.js +4 -1
  368. package/esm/base/results/dataAccessConfig.js.map +1 -1
  369. package/esm/base/results/facade.d.ts +10 -8
  370. package/esm/base/results/facade.d.ts.map +1 -1
  371. package/esm/base/results/facade.js +9 -7
  372. package/esm/base/results/facade.js.map +1 -1
  373. package/esm/base/results/internal/dataAccessDigest.d.ts +2 -2
  374. package/esm/base/results/internal/dataAccessDigest.d.ts.map +1 -1
  375. package/esm/base/results/internal/dataAccessDigest.js +1 -3
  376. package/esm/base/results/internal/dataAccessDigest.js.map +1 -1
  377. package/esm/base/results/internal/dataAccessImpl.d.ts.map +1 -1
  378. package/esm/base/results/internal/dataAccessImpl.js +1 -1
  379. package/esm/base/results/internal/dataAccessImpl.js.map +1 -1
  380. package/esm/base/results/internal/dataAccessMethods.d.ts.map +1 -1
  381. package/esm/base/results/internal/dataAccessMethods.js +2 -2
  382. package/esm/base/results/internal/dataAccessMethods.js.map +1 -1
  383. package/esm/base/results/internal/definitionMethods.d.ts +1 -1
  384. package/esm/base/results/internal/definitionMethods.js +1 -1
  385. package/esm/base/results/internal/resultDataMethods.d.ts +3 -2
  386. package/esm/base/results/internal/resultDataMethods.d.ts.map +1 -1
  387. package/esm/base/results/internal/resultDataMethods.js.map +1 -1
  388. package/esm/base/results/internal/resultMetaMethods.d.ts +3 -3
  389. package/esm/base/results/internal/resultMetaMethods.d.ts.map +1 -1
  390. package/esm/base/results/internal/resultMetaMethods.js +3 -4
  391. package/esm/base/results/internal/resultMetaMethods.js.map +1 -1
  392. package/esm/base/results/internal/utils.d.ts +2 -1
  393. package/esm/base/results/internal/utils.d.ts.map +1 -1
  394. package/esm/base/results/internal/utils.js +1 -1
  395. package/esm/base/vis/DrillEvents.d.ts +4 -1
  396. package/esm/base/vis/DrillEvents.d.ts.map +1 -1
  397. package/esm/base/vis/DrillEvents.js.map +1 -1
  398. package/esm/base/vis/Events.d.ts +2 -2
  399. package/esm/base/vis/Events.d.ts.map +1 -1
  400. package/esm/base/vis/VisualizationProps.d.ts +11 -4
  401. package/esm/base/vis/VisualizationProps.d.ts.map +1 -1
  402. package/esm/base/vis/VisualizationProps.js +1 -1
  403. package/esm/base/vis/drilling.js +3 -3
  404. package/esm/base/vis/drilling.js.map +1 -1
  405. package/esm/base/vis/export.d.ts +1 -1
  406. package/esm/base/vis/export.js +3 -3
  407. package/esm/base/vis/export.js.map +1 -1
  408. package/esm/execution/DataViewLoader.d.ts +70 -0
  409. package/esm/execution/DataViewLoader.d.ts.map +1 -0
  410. package/esm/execution/DataViewLoader.js +143 -0
  411. package/esm/execution/DataViewLoader.js.map +1 -0
  412. package/esm/execution/Execute.d.ts +36 -20
  413. package/esm/execution/Execute.d.ts.map +1 -1
  414. package/esm/execution/Execute.js +7 -5
  415. package/esm/execution/Execute.js.map +1 -1
  416. package/esm/execution/ExecuteInsight.d.ts +47 -16
  417. package/esm/execution/ExecuteInsight.d.ts.map +1 -1
  418. package/esm/execution/ExecuteInsight.js +7 -5
  419. package/esm/execution/ExecuteInsight.js.map +1 -1
  420. package/esm/execution/RawExecute.d.ts +19 -7
  421. package/esm/execution/RawExecute.d.ts.map +1 -1
  422. package/esm/execution/RawExecute.js +2 -1
  423. package/esm/execution/RawExecute.js.map +1 -1
  424. package/esm/execution/createExecution.d.ts +9 -6
  425. package/esm/execution/createExecution.d.ts.map +1 -1
  426. package/esm/execution/createExecution.js +12 -3
  427. package/esm/execution/createExecution.js.map +1 -1
  428. package/esm/execution/index.d.ts +3 -2
  429. package/esm/execution/index.d.ts.map +1 -1
  430. package/esm/execution/index.js +3 -2
  431. package/esm/execution/index.js.map +1 -1
  432. package/esm/execution/useDataExport.d.ts +5 -3
  433. package/esm/execution/useDataExport.d.ts.map +1 -1
  434. package/esm/execution/useDataExport.js +3 -1
  435. package/esm/execution/useDataExport.js.map +1 -1
  436. package/esm/execution/useDataView.d.ts +5 -0
  437. package/esm/execution/useDataView.d.ts.map +1 -1
  438. package/esm/execution/useDataView.js +3 -0
  439. package/esm/execution/useDataView.js.map +1 -1
  440. package/esm/execution/useExecution.d.ts +17 -9
  441. package/esm/execution/useExecution.d.ts.map +1 -1
  442. package/esm/execution/useExecution.js +3 -0
  443. package/esm/execution/useExecution.js.map +1 -1
  444. package/esm/execution/useExecutionDataView.d.ts +32 -15
  445. package/esm/execution/useExecutionDataView.d.ts.map +1 -1
  446. package/esm/execution/useExecutionDataView.js +3 -3
  447. package/esm/execution/useExecutionDataView.js.map +1 -1
  448. package/esm/execution/useInsightDataView.d.ts +39 -9
  449. package/esm/execution/useInsightDataView.d.ts.map +1 -1
  450. package/esm/execution/useInsightDataView.js +10 -4
  451. package/esm/execution/useInsightDataView.js.map +1 -1
  452. package/esm/execution/withExecution.d.ts +5 -4
  453. package/esm/execution/withExecution.d.ts.map +1 -1
  454. package/esm/execution/withExecution.js +1 -1
  455. package/esm/execution/withExecution.js.map +1 -1
  456. package/esm/execution/withExecutionLoading.d.ts +12 -7
  457. package/esm/execution/withExecutionLoading.d.ts.map +1 -1
  458. package/esm/execution/withExecutionLoading.js +1 -1
  459. package/esm/execution/withExecutionLoading.js.map +1 -1
  460. package/esm/index.d.ts +1 -1
  461. package/esm/index.d.ts.map +1 -1
  462. package/esm/index.js +2 -1
  463. package/esm/index.js.map +1 -1
  464. package/esm/kpi/Kpi.d.ts +13 -9
  465. package/esm/kpi/Kpi.d.ts.map +1 -1
  466. package/esm/kpi/Kpi.js +5 -3
  467. package/esm/kpi/Kpi.js.map +1 -1
  468. package/esm/locales.d.ts +42 -0
  469. package/esm/locales.d.ts.map +1 -0
  470. package/esm/locales.js +19 -0
  471. package/esm/locales.js.map +1 -0
  472. package/esm/polyfills.d.ts.map +1 -1
  473. package/esm/polyfills.js +3 -1
  474. package/esm/polyfills.js.map +1 -1
  475. package/esm/tsdoc-metadata.json +1 -1
  476. package/package.json +20 -16
  477. package/dist/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.d.ts +0 -15
  478. package/dist/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.d.ts.map +0 -1
  479. package/dist/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.js +0 -48
  480. package/dist/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.js.map +0 -1
  481. package/esm/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.d.ts +0 -15
  482. package/esm/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.d.ts.map +0 -1
  483. package/esm/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.js +0 -43
  484. package/esm/base/localization/TranslationsCustomizationProvider/workspaceSettingsLoader.js.map +0 -1
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.RawExecute = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var react_1 = tslib_1.__importDefault(require("react"));
7
7
  var withExecution_1 = require("./withExecution");
8
8
  var isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
@@ -31,6 +31,7 @@ function exportTitle(props) {
31
31
  * Raw executor is the most basic React component to drive custom executions to obtain
32
32
  * data from backends.
33
33
  *
34
+ * @remarks
34
35
  * The component accepts an instance of prepared execution and drives all the necessary
35
36
  * APIs and boilerplate needed to obtain a {@link DataViewFacade}.
36
37
  * Note that if the resulting data is empty this will NOT throw a {@link @gooddata/sdk-backend-spi#NoDataError}.
@@ -1 +1 @@
1
- {"version":3,"file":"RawExecute.js","sourceRoot":"","sources":["../../src/execution/RawExecute.tsx"],"names":[],"mappings":";;;;AAAA,gCAAgC;AAChC,wDAA0B;AAE1B,iDAAgD;AAEhD,mEAAqC;AAkErC,IAAM,YAAY,GAAoB,UAAC,KAAY;IACvC,IAAA,QAAQ,GAAyE,KAAK,SAA9E,EAAE,KAAK,GAAkE,KAAK,MAAvE,EAAE,SAAS,GAAuD,KAAK,UAA5D,EAAE,MAAM,GAA+C,KAAK,OAApD,EAAE,MAAM,GAAuC,KAAK,OAA5C,EAAE,gBAAgB,GAAqB,KAAK,iBAA1B,EAAE,cAAc,GAAK,KAAK,eAAV,CAAW;IAE/F,IAAI,cAAc,IAAI,KAAK,EAAE;QACzB,OAAO,8BAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,8BAAC,gBAAgB,OAAG,CAAC;KAC/B;IAED,IAAI,gBAAgB,IAAI,cAAc,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,IAAI,CAAC;KACf;IAED,OAAO,QAAQ,CAAC;QACZ,KAAK,OAAA;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,MAAM,QAAA;KACT,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,SAAS,WAAW,CAAC,KAAuB;IACxC,OAAO,KAAK,CAAC,WAAW,IAAI,YAAY,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;GAaG;AACU,QAAA,UAAU,GAAG,6BAAa,CAAmB;IACtD,WAAW,aAAA;IACX,SAAS,EAAE,UAAC,KAAuB,IAAK,OAAA,KAAK,CAAC,SAAS,EAAf,CAAe;IACvD,MAAM,EAAE,UAAC,KAAuB;QACpB,IAAA,OAAO,GAAuE,KAAK,QAA5E,EAAE,gBAAgB,GAAqD,KAAK,iBAA1D,EAAE,eAAe,GAAoC,KAAK,gBAAzC,EAAE,cAAc,GAAoB,KAAK,eAAzB,EAAE,aAAa,GAAK,KAAK,cAAV,CAAW;QAE5F,OAAO;YACH,OAAO,SAAA;YACP,gBAAgB,kBAAA;YAChB,eAAe,iBAAA;YACf,cAAc,gBAAA;YACd,aAAa,eAAA;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,UAAC,SAA2B,EAAE,SAA2B;QACpE,IAAM,aAAa,GAAkC;YACjD,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAAkC,CAAC,QAAQ,CAAC,CAAC;QAEzE,OAAO,CACH,aAAa,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,EAA3C,CAA2C,CAAC;YAC7E,sBAAsB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,iBAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC;YAC7F,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,CAC1E,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAAuB;QACzB,IAAA,KAAuB,KAAK,YAAV,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAW;QAErC,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAAuB,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACpD,CAAC,CAAC,YAAY,CAAC,CAAC"}
1
+ {"version":3,"file":"RawExecute.js","sourceRoot":"","sources":["../../src/execution/RawExecute.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,wDAA0B;AAE1B,iDAAgD;AAEhD,mEAAqC;AA6ErC,IAAM,YAAY,GAAoB,UAAC,KAAY;IACvC,IAAA,QAAQ,GAAyE,KAAK,SAA9E,EAAE,KAAK,GAAkE,KAAK,MAAvE,EAAE,SAAS,GAAuD,KAAK,UAA5D,EAAE,MAAM,GAA+C,KAAK,OAApD,EAAE,MAAM,GAAuC,KAAK,OAA5C,EAAE,gBAAgB,GAAqB,KAAK,iBAA1B,EAAE,cAAc,GAAK,KAAK,eAAV,CAAW;IAE/F,IAAI,cAAc,IAAI,KAAK,EAAE;QACzB,OAAO,8BAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,8BAAC,gBAAgB,OAAG,CAAC;KAC/B;IAED,IAAI,gBAAgB,IAAI,cAAc,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,IAAI,CAAC;KACf;IAED,OAAO,QAAQ,CAAC;QACZ,KAAK,OAAA;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,MAAM,QAAA;KACT,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,SAAS,WAAW,CAAC,KAAuB;IACxC,OAAO,KAAK,CAAC,WAAW,IAAI,YAAY,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACU,QAAA,UAAU,GAAG,6BAAa,CAAmB;IACtD,WAAW,aAAA;IACX,SAAS,EAAE,UAAC,KAAuB,IAAK,OAAA,KAAK,CAAC,SAAS,EAAf,CAAe;IACvD,MAAM,EAAE,UAAC,KAAuB;QACpB,IAAA,OAAO,GAAuE,KAAK,QAA5E,EAAE,gBAAgB,GAAqD,KAAK,iBAA1D,EAAE,eAAe,GAAoC,KAAK,gBAAzC,EAAE,cAAc,GAAoB,KAAK,eAAzB,EAAE,aAAa,GAAK,KAAK,cAAV,CAAW;QAE5F,OAAO;YACH,OAAO,SAAA;YACP,gBAAgB,kBAAA;YAChB,eAAe,iBAAA;YACf,cAAc,gBAAA;YACd,aAAa,eAAA;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,UAAC,SAA2B,EAAE,SAA2B;QACpE,IAAM,aAAa,GAAkC;YACjD,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAAkC,CAAC,QAAQ,CAAC,CAAC;QAEzE,OAAO,CACH,aAAa,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,EAA3C,CAA2C,CAAC;YAC7E,sBAAsB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,iBAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC;YAC7F,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,CAC1E,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAAuB;QACzB,IAAA,KAAuB,KAAK,YAAV,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAW;QAErC,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAAuB,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACpD,CAAC,CAAC,YAAY,CAAC,CAAC"}
@@ -19,28 +19,31 @@ export declare type CreateExecutionOptions = {
19
19
  */
20
20
  workspace?: string;
21
21
  /**
22
- * Data series will be built using the provided measures that are optionally further scoped for
22
+ * Data series will be built using the provided measures that are further scoped for
23
23
  * elements of the specified attributes.
24
24
  */
25
25
  seriesBy: IAttributeOrMeasure[];
26
26
  /**
27
- * Optionally slice all data series by elements of these attributes.
27
+ * Slice all data series by elements of these attributes.
28
28
  */
29
29
  slicesBy?: IAttribute[];
30
30
  /**
31
- * Optionally include these totals among the data slices.
31
+ * Include these totals among the data slices.
32
32
  */
33
33
  totals?: ITotal[];
34
34
  /**
35
- * Optional filters to apply on server side.
35
+ * Filters to apply on server side.
36
36
  */
37
37
  filters?: INullableFilter[];
38
38
  /**
39
- * Optional sorting to apply on server side.
39
+ * Sorting to apply on server side.
40
40
  */
41
41
  sortBy?: ISortItem[];
42
42
  /**
43
- * Optional informative name of the component. This value is sent as telemetry information together
43
+ * Informative name of the component.
44
+ *
45
+ * @remarks
46
+ * This value is sent as telemetry information together
44
47
  * with the actual execution request. We recommend to set this because it can be useful for diagnostic
45
48
  * purposes.
46
49
  *
@@ -1 +1 @@
1
- {"version":3,"file":"createExecution.d.ts","sourceRoot":"","sources":["../../src/execution/createExecution.ts"],"names":[],"mappings":"AACA,OAAO,EACH,UAAU,EACV,mBAAmB,EAEnB,eAAe,EAEf,SAAS,EACT,MAAM,EAIT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAInF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACjC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAErB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AA2BF;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,kBAAkB,CA2BnF"}
1
+ {"version":3,"file":"createExecution.d.ts","sourceRoot":"","sources":["../../src/execution/createExecution.ts"],"names":[],"mappings":"AACA,OAAO,EACH,UAAU,EACV,mBAAmB,EAEnB,eAAe,EAGf,SAAS,EACT,MAAM,EAIT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAKnF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACjC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAErB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAuCF;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,kBAAkB,CA2BnF"}
@@ -4,13 +4,19 @@ exports.createExecution = void 0;
4
4
  var tslib_1 = require("tslib");
5
5
  // (C) 2019-2022 GoodData Corporation
6
6
  var sdk_model_1 = require("@gooddata/sdk-model");
7
+ var compact_1 = tslib_1.__importDefault(require("lodash/compact"));
7
8
  var isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
8
9
  var ts_invariant_1 = tslib_1.__importDefault(require("ts-invariant"));
9
10
  /**
10
11
  * When caller desires just data series and no slicing, create a single-dim result.
11
12
  */
12
13
  function seriesOnlyDim(seriesBy) {
13
- return [sdk_model_1.newDimension(tslib_1.__spread(seriesBy.filter(sdk_model_1.isAttribute), [sdk_model_1.MeasureGroupIdentifier]))];
14
+ return [
15
+ sdk_model_1.newDimension(compact_1.default(tslib_1.__spread(seriesBy.filter(sdk_model_1.isAttribute), [
16
+ // only include MeasureGroupIdentifier if there are some measures, otherwise the execution will always fail on the backend
17
+ seriesBy.some(sdk_model_1.isMeasure) && sdk_model_1.MeasureGroupIdentifier,
18
+ ]))),
19
+ ];
14
20
  }
15
21
  /**
16
22
  * When caller desires data series to be sliced further by some attributes (and perhaps with totals as well)
@@ -20,7 +26,10 @@ function seriesOnlyDim(seriesBy) {
20
26
  * - measures & scoping attributes will be in columns (second dim)
21
27
  */
22
28
  function seriesAndSlicesDim(seriesBy, slices, totals) {
23
- return sdk_model_1.newTwoDimensional(tslib_1.__spread(slices, totals), tslib_1.__spread(seriesBy.filter(sdk_model_1.isAttribute), [sdk_model_1.MeasureGroupIdentifier]));
29
+ return sdk_model_1.newTwoDimensional(tslib_1.__spread(slices, totals), compact_1.default(tslib_1.__spread(seriesBy.filter(sdk_model_1.isAttribute), [
30
+ // only include MeasureGroupIdentifier if there are some measures, otherwise the execution will always fail on the backend
31
+ seriesBy.some(sdk_model_1.isMeasure) && sdk_model_1.MeasureGroupIdentifier,
32
+ ])));
24
33
  }
25
34
  /**
26
35
  * Given execute props, this will prepare execution to send to backend.
@@ -1 +1 @@
1
- {"version":3,"file":"createExecution.js","sourceRoot":"","sources":["../../src/execution/createExecution.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,iDAW6B;AAE7B,mEAAqC;AACrC,sEAAqC;AA0DrC;;GAEG;AACH,SAAS,aAAa,CAAC,QAA+B;IAClD,OAAO,CAAC,wBAAY,kBAAK,QAAQ,CAAC,MAAM,CAAC,uBAAW,CAAC,GAAE,kCAAsB,GAAE,CAAC,CAAC;AACrF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACvB,QAA+B,EAC/B,MAAoB,EACpB,MAAgB;IAEhB,OAAO,6BAAiB,kBAChB,MAAM,EAAK,MAAM,oBACjB,QAAQ,CAAC,MAAM,CAAC,uBAAW,CAAC,GAAE,kCAAsB,GAC3D,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAA+B;;IAEvD,IAAA,OAAO,GAQP,OAAO,QARA,EACP,SAAS,GAOT,OAAO,UAPE,EACT,QAAQ,GAMR,OAAO,SANC,EACR,KAKA,OAAO,SALM,EAAb,QAAQ,mBAAG,EAAE,KAAA,EACb,KAIA,OAAO,QAJK,EAAZ,OAAO,mBAAG,EAAE,KAAA,EACZ,KAGA,OAAO,OAHI,EAAX,MAAM,mBAAG,EAAE,KAAA,EACX,KAEA,OAAO,OAFI,EAAX,MAAM,mBAAG,EAAE,KAAA,EACX,KACA,OAAO,cADoB,EAA3B,aAAa,mBAAG,WAAW,KAAA,CACnB;IACZ,sBAAS,CACL,OAAO,IAAI,SAAS,EACpB,qFAAqF,CACxF,CAAC;IAEF,IAAM,UAAU,GAAG,iBAAO,CAAC,QAAQ,CAAC;QAChC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC;QACzB,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAErD,OAAO,CAAA,KAAA,CAAA,KAAA,OAAO;SACT,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC;SACrC,SAAS,CAAC,SAAS,CAAC;SACpB,SAAS,EAAE;SACX,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAA;SAC5C,WAAW,4BAAI,MAAM,EAAC,CAAA;SACtB,cAAc,4BAAI,UAAU,GAAE;AACvC,CAAC;AA3BD,0CA2BC"}
1
+ {"version":3,"file":"createExecution.js","sourceRoot":"","sources":["../../src/execution/createExecution.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,iDAY6B;AAE7B,mEAAqC;AACrC,mEAAqC;AACrC,sEAAqC;AA6DrC;;GAEG;AACH,SAAS,aAAa,CAAC,QAA+B;IAClD,OAAO;QACH,wBAAY,CACR,iBAAO,kBACA,QAAQ,CAAC,MAAM,CAAC,uBAAW,CAAC;YAC/B,0HAA0H;YAC1H,QAAQ,CAAC,IAAI,CAAC,qBAAS,CAAC,IAAI,kCAAsB;WACpD,CACL;KACJ,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACvB,QAA+B,EAC/B,MAAoB,EACpB,MAAgB;IAEhB,OAAO,6BAAiB,kBAChB,MAAM,EAAK,MAAM,GACrB,iBAAO,kBACA,QAAQ,CAAC,MAAM,CAAC,uBAAW,CAAC;QAC/B,0HAA0H;QAC1H,QAAQ,CAAC,IAAI,CAAC,qBAAS,CAAC,IAAI,kCAAsB;OACpD,CACL,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAA+B;;IAEvD,IAAA,OAAO,GAQP,OAAO,QARA,EACP,SAAS,GAOT,OAAO,UAPE,EACT,QAAQ,GAMR,OAAO,SANC,EACR,KAKA,OAAO,SALM,EAAb,QAAQ,mBAAG,EAAE,KAAA,EACb,KAIA,OAAO,QAJK,EAAZ,OAAO,mBAAG,EAAE,KAAA,EACZ,KAGA,OAAO,OAHI,EAAX,MAAM,mBAAG,EAAE,KAAA,EACX,KAEA,OAAO,OAFI,EAAX,MAAM,mBAAG,EAAE,KAAA,EACX,KACA,OAAO,cADoB,EAA3B,aAAa,mBAAG,WAAW,KAAA,CACnB;IACZ,sBAAS,CACL,OAAO,IAAI,SAAS,EACpB,qFAAqF,CACxF,CAAC;IAEF,IAAM,UAAU,GAAG,iBAAO,CAAC,QAAQ,CAAC;QAChC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC;QACzB,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAErD,OAAO,CAAA,KAAA,CAAA,KAAA,OAAO;SACT,aAAa,CAAC,aAAa,EAAE,OAAO,CAAC;SACrC,SAAS,CAAC,SAAS,CAAC;SACpB,SAAS,EAAE;SACX,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAA;SAC5C,WAAW,4BAAI,MAAM,EAAC,CAAA;SACtB,cAAc,4BAAI,UAAU,GAAE;AACvC,CAAC;AA3BD,0CA2BC"}
@@ -5,8 +5,9 @@ export { Execute, IExecuteProps } from "./Execute";
5
5
  export { useDataExport, UseDataExportCallbacks, UseDataExportState } from "./useDataExport";
6
6
  export { useDataView, UseDataViewCallbacks, UseDataViewState } from "./useDataView";
7
7
  export { useExecution, IUseExecutionConfig } from "./useExecution";
8
- export { IExecutionConfiguration, IUseExecutionDataViewConfig, useExecutionDataView, } from "./useExecutionDataView";
9
- export { IUseInsightDataViewConfig, useInsightDataView } from "./useInsightDataView";
8
+ export { IExecutionConfiguration, IUseExecutionDataViewConfig, UseExecutionDataViewCallbacks, useExecutionDataView, } from "./useExecutionDataView";
9
+ export { IUseInsightDataViewConfig, UseInsightDataViewCallbacks, useInsightDataView, } from "./useInsightDataView";
10
10
  export { ExecuteInsight, IExecuteInsightProps } from "./ExecuteInsight";
11
11
  export { IExecuteErrorComponent, IExecuteErrorComponentProps, IExecuteLoadingComponent } from "./interfaces";
12
+ export { DataViewLoader } from "./DataViewLoader";
12
13
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EACH,uBAAuB,EACvB,2BAA2B,EAC3B,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EACH,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,oBAAoB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACH,yBAAyB,EACzB,2BAA2B,EAC3B,kBAAkB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7G,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
- // (C) 2020-2021 GoodData Corporation
2
+ // (C) 2020-2022 GoodData Corporation
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.ExecuteInsight = exports.useInsightDataView = exports.useExecutionDataView = exports.useExecution = exports.useDataView = exports.useDataExport = exports.Execute = exports.RawExecute = exports.withExecutionLoading = exports.withExecution = void 0;
4
+ exports.DataViewLoader = exports.ExecuteInsight = exports.useInsightDataView = exports.useExecutionDataView = exports.useExecution = exports.useDataView = exports.useDataExport = exports.Execute = exports.RawExecute = exports.withExecutionLoading = exports.withExecution = void 0;
5
5
  var withExecution_1 = require("./withExecution");
6
6
  Object.defineProperty(exports, "withExecution", { enumerable: true, get: function () { return withExecution_1.withExecution; } });
7
7
  var withExecutionLoading_1 = require("./withExecutionLoading");
@@ -22,4 +22,6 @@ var useInsightDataView_1 = require("./useInsightDataView");
22
22
  Object.defineProperty(exports, "useInsightDataView", { enumerable: true, get: function () { return useInsightDataView_1.useInsightDataView; } });
23
23
  var ExecuteInsight_1 = require("./ExecuteInsight");
24
24
  Object.defineProperty(exports, "ExecuteInsight", { enumerable: true, get: function () { return ExecuteInsight_1.ExecuteInsight; } });
25
+ var DataViewLoader_1 = require("./DataViewLoader");
26
+ Object.defineProperty(exports, "DataViewLoader", { enumerable: true, get: function () { return DataViewLoader_1.DataViewLoader; } });
25
27
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":";AAAA,qCAAqC;;;AAErC,iDAAgE;AAAvD,8GAAA,aAAa,OAAA;AACtB,+DAMgC;AAL5B,4HAAA,oBAAoB,OAAA;AAMxB,2CAA4D;AAAnD,wGAAA,UAAU,OAAA;AACnB,qCAAmD;AAA1C,kGAAA,OAAO,OAAA;AAChB,iDAA4F;AAAnF,8GAAA,aAAa,OAAA;AACtB,6CAAoF;AAA3E,0GAAA,WAAW,OAAA;AACpB,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AACrB,+DAIgC;AAD5B,4HAAA,oBAAoB,OAAA;AAExB,2DAAqF;AAAjD,wHAAA,kBAAkB,OAAA;AACtD,mDAAwE;AAA/D,gHAAA,cAAc,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/execution/index.ts"],"names":[],"mappings":";AAAA,qCAAqC;;;AAErC,iDAAgE;AAAvD,8GAAA,aAAa,OAAA;AACtB,+DAMgC;AAL5B,4HAAA,oBAAoB,OAAA;AAMxB,2CAA4D;AAAnD,wGAAA,UAAU,OAAA;AACnB,qCAAmD;AAA1C,kGAAA,OAAO,OAAA;AAChB,iDAA4F;AAAnF,8GAAA,aAAa,OAAA;AACtB,6CAAoF;AAA3E,0GAAA,WAAW,OAAA;AACpB,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AACrB,+DAKgC;AAD5B,4HAAA,oBAAoB,OAAA;AAExB,2DAI8B;AAD1B,wHAAA,kBAAkB,OAAA;AAEtB,mDAAwE;AAA/D,gHAAA,cAAc,OAAA;AAEvB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA"}
@@ -3,20 +3,22 @@ import { IExportConfig, IPreparedExecution } from "@gooddata/sdk-backend-spi";
3
3
  import { GoodDataSdkError, UseCancelablePromiseCallbacks, UseCancelablePromiseState } from "../base";
4
4
  /**
5
5
  * Indicates current state of useDataExport hook
6
- * @beta
6
+ * @public
7
7
  */
8
8
  export declare type UseDataExportState = UseCancelablePromiseState<string, GoodDataSdkError>;
9
9
  /**
10
10
  * Callbacks for useDataExport hook
11
- * @beta
11
+ * @public
12
12
  */
13
13
  export declare type UseDataExportCallbacks = UseCancelablePromiseCallbacks<string, GoodDataSdkError>;
14
14
  /**
15
15
  * This hook provides easy way to export data in your preferred format (csv/xlsx/raw) for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
16
+ *
17
+ * @remarks
16
18
  * As a result, you will receive a string with uri, so you can easily create a download link.
17
19
  * Be aware that execution is re-executed only on dependency list change, not on execution/exportConfig/callbacks change.
18
20
  *
19
- * @beta
21
+ * @public
20
22
  */
21
23
  export declare function useDataExport({ execution, exportConfig, onCancel, onError, onLoading, onPending, onSuccess, }: {
22
24
  execution: IPreparedExecution | undefined | null;
@@ -1 +1 @@
1
- {"version":3,"file":"useDataExport.d.ts","sourceRoot":"","sources":["../../src/execution/useDataExport.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAEH,gBAAgB,EAEhB,6BAA6B,EAC7B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,sBAAsB,GAAG,6BAA6B,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAE7F;;;;;;GAMG;AACH,wBAAgB,aAAa,CACzB,EACI,SAAS,EACT,YAAiB,EACjB,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IACjD,YAAY,CAAC,EAAE,aAAa,CAAC;CAChC,GAAG,sBAAsB,EAC1B,IAAI,CAAC,EAAE,cAAc,GACtB,kBAAkB,CAuBpB"}
1
+ {"version":3,"file":"useDataExport.d.ts","sourceRoot":"","sources":["../../src/execution/useDataExport.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAEH,gBAAgB,EAEhB,6BAA6B,EAC7B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,sBAAsB,GAAG,6BAA6B,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAE7F;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CACzB,EACI,SAAS,EACT,YAAiB,EACjB,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IACjD,YAAY,CAAC,EAAE,aAAa,CAAC;CAChC,GAAG,sBAAsB,EAC1B,IAAI,CAAC,EAAE,cAAc,GACtB,kBAAkB,CAuBpB"}
@@ -4,10 +4,12 @@ exports.useDataExport = void 0;
4
4
  var base_1 = require("../base");
5
5
  /**
6
6
  * This hook provides easy way to export data in your preferred format (csv/xlsx/raw) for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
7
+ *
8
+ * @remarks
7
9
  * As a result, you will receive a string with uri, so you can easily create a download link.
8
10
  * Be aware that execution is re-executed only on dependency list change, not on execution/exportConfig/callbacks change.
9
11
  *
10
- * @beta
12
+ * @public
11
13
  */
12
14
  function useDataExport(_a, deps) {
13
15
  var execution = _a.execution, _b = _a.exportConfig, exportConfig = _b === void 0 ? {} : _b, onCancel = _a.onCancel, onError = _a.onError, onLoading = _a.onLoading, onPending = _a.onPending, onSuccess = _a.onSuccess;
@@ -1 +1 @@
1
- {"version":3,"file":"useDataExport.js","sourceRoot":"","sources":["../../src/execution/useDataExport.ts"],"names":[],"mappings":";;;AAGA,gCAMiB;AAcjB;;;;;;GAMG;AACH,SAAgB,aAAa,CACzB,EAW0B,EAC1B,IAAqB;QAXjB,SAAS,eAAA,EACT,oBAAiB,EAAjB,YAAY,mBAAG,EAAE,KAAA,EACjB,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,SAAS,eAAA,EACT,SAAS,eAAA,EACT,SAAS,eAAA;IAOb,OAAO,2BAAoB,CACvB;QACI,OAAO,EAAE,SAAS;YACd,CAAC,CAAC;gBACI,OAAA,SAAS;qBACJ,OAAO,EAAE;qBACT,IAAI,CAAC,UAAC,eAAe,IAAK,OAAA,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,EAApC,CAAoC,CAAC;qBAC/D,IAAI,CAAC,UAAC,YAAY;oBACf,OAAO,YAAY,CAAC,GAAG,CAAC;gBAC5B,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,mBAAY,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC;YARN,CAQM;YACZ,CAAC,CAAC,IAAI;QACV,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;AACN,CAAC;AArCD,sCAqCC"}
1
+ {"version":3,"file":"useDataExport.js","sourceRoot":"","sources":["../../src/execution/useDataExport.ts"],"names":[],"mappings":";;;AAGA,gCAMiB;AAcjB;;;;;;;;GAQG;AACH,SAAgB,aAAa,CACzB,EAW0B,EAC1B,IAAqB;QAXjB,SAAS,eAAA,EACT,oBAAiB,EAAjB,YAAY,mBAAG,EAAE,KAAA,EACjB,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,SAAS,eAAA,EACT,SAAS,eAAA,EACT,SAAS,eAAA;IAOb,OAAO,2BAAoB,CACvB;QACI,OAAO,EAAE,SAAS;YACd,CAAC,CAAC;gBACI,OAAA,SAAS;qBACJ,OAAO,EAAE;qBACT,IAAI,CAAC,UAAC,eAAe,IAAK,OAAA,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,EAApC,CAAoC,CAAC;qBAC/D,IAAI,CAAC,UAAC,YAAY;oBACf,OAAO,YAAY,CAAC,GAAG,CAAC;gBAC5B,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,mBAAY,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC;YARN,CAQM;YACZ,CAAC,CAAC,IAAI;QACV,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;AACN,CAAC;AArCD,sCAqCC"}
@@ -4,19 +4,24 @@ import { DataViewWindow } from "./withExecutionLoading";
4
4
  import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseCallbacks, UseCancelablePromiseState } from "../base";
5
5
  /**
6
6
  * Indicates current state of useDataView hook
7
+ * @deprecated use {@link useExecutionDataView} instead
7
8
  * @beta
8
9
  */
9
10
  export declare type UseDataViewState = UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
10
11
  /**
11
12
  * Callbacks for useDataView hook
13
+ * @deprecated use {@link useExecutionDataView} instead
12
14
  * @beta
13
15
  */
14
16
  export declare type UseDataViewCallbacks = UseCancelablePromiseCallbacks<DataViewFacade, GoodDataSdkError>;
15
17
  /**
16
18
  * This hook provides easy way to get data for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
19
+ *
20
+ * @remarks
17
21
  * You can use it to create custom visualizations on top of GoodData platform.
18
22
  * Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.
19
23
  *
24
+ * @deprecated use {@link useExecutionDataView} instead
20
25
  * @beta
21
26
  */
22
27
  export declare function useDataView({ execution, window, onCancel, onError, onLoading, onPending, onSuccess, }: {
@@ -1 +1 @@
1
- {"version":3,"file":"useDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAEH,cAAc,EACd,gBAAgB,EAEhB,6BAA6B,EAC7B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAE3F;;;GAGG;AACH,oBAAY,oBAAoB,GAAG,6BAA6B,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAEnG;;;;;;GAMG;AACH,wBAAgB,WAAW,CACvB,EACI,SAAS,EACT,MAAM,EACN,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IACjD,MAAM,CAAC,EAAE,cAAc,CAAC;CAC3B,GAAG,oBAAoB,EACxB,IAAI,CAAC,EAAE,cAAc,GACtB,gBAAgB,CA2BlB"}
1
+ {"version":3,"file":"useDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAEH,cAAc,EACd,gBAAgB,EAEhB,6BAA6B,EAC7B,yBAAyB,EAC5B,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,oBAAY,gBAAgB,GAAG,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,oBAAY,oBAAoB,GAAG,6BAA6B,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAEnG;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CACvB,EACI,SAAS,EACT,MAAM,EACN,QAAQ,EACR,OAAO,EACP,SAAS,EACT,SAAS,EACT,SAAS,GACZ,EAAE;IACC,SAAS,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI,CAAC;IACjD,MAAM,CAAC,EAAE,cAAc,CAAC;CAC3B,GAAG,oBAAoB,EACxB,IAAI,CAAC,EAAE,cAAc,GACtB,gBAAgB,CA2BlB"}
@@ -4,9 +4,12 @@ exports.useDataView = void 0;
4
4
  var base_1 = require("../base");
5
5
  /**
6
6
  * This hook provides easy way to get data for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
7
+ *
8
+ * @remarks
7
9
  * You can use it to create custom visualizations on top of GoodData platform.
8
10
  * Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.
9
11
  *
12
+ * @deprecated use {@link useExecutionDataView} instead
10
13
  * @beta
11
14
  */
12
15
  function useDataView(_a, deps) {
@@ -1 +1 @@
1
- {"version":3,"file":"useDataView.js","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":";;;AAIA,gCAOiB;AAcjB;;;;;;GAMG;AACH,SAAgB,WAAW,CACvB,EAWwB,EACxB,IAAqB;QAXjB,SAAS,eAAA,EACT,MAAM,YAAA,EACN,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,SAAS,eAAA,EACT,SAAS,eAAA,EACT,SAAS,eAAA;IAOb,OAAO,2BAAoB,CACvB;QACI,OAAO,EAAE,SAAS;YACd,CAAC,CAAC;gBACI,OAAA,SAAS;qBACJ,OAAO,EAAE;qBACT,IAAI,CAAC,UAAC,eAAe;oBAClB,OAAA,MAAM;wBACF,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;wBACxD,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE;gBAF/B,CAE+B,CAClC;qBACA,IAAI,CAAC,UAAC,QAAQ;oBACX,OAAO,qBAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,mBAAY,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC;YAZN,CAYM;YACZ,CAAC,CAAC,IAAI;QACV,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;AACN,CAAC;AAzCD,kCAyCC"}
1
+ {"version":3,"file":"useDataView.js","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":";;;AAIA,gCAOiB;AAgBjB;;;;;;;;;GASG;AACH,SAAgB,WAAW,CACvB,EAWwB,EACxB,IAAqB;QAXjB,SAAS,eAAA,EACT,MAAM,YAAA,EACN,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,SAAS,eAAA,EACT,SAAS,eAAA,EACT,SAAS,eAAA;IAOb,OAAO,2BAAoB,CACvB;QACI,OAAO,EAAE,SAAS;YACd,CAAC,CAAC;gBACI,OAAA,SAAS;qBACJ,OAAO,EAAE;qBACT,IAAI,CAAC,UAAC,eAAe;oBAClB,OAAA,MAAM;wBACF,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;wBACxD,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE;gBAF/B,CAE+B,CAClC;qBACA,IAAI,CAAC,UAAC,QAAQ;oBACX,OAAO,qBAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,mBAAY,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC,CAAC;YAZN,CAYM;YACZ,CAAC,CAAC,IAAI;QACV,QAAQ,UAAA;QACR,OAAO,SAAA;QACP,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;KACZ,EACD,IAAI,CACP,CAAC;AACN,CAAC;AAzCD,kCAyCC"}
@@ -1,38 +1,41 @@
1
1
  import { IAnalyticalBackend, IPreparedExecution } from "@gooddata/sdk-backend-spi";
2
2
  import { AttributesMeasuresOrPlaceholders, AttributesOrPlaceholders, TotalsOrPlaceholders, NullableFiltersOrPlaceholders, SortsOrPlaceholders } from "../base";
3
3
  /**
4
+ * @deprecated use {@link useExecutionDataView} instead
4
5
  * @beta
5
6
  */
6
7
  export interface IUseExecutionConfig {
7
8
  /**
8
- * Data series will be built using the provided measures that are optionally further scoped for
9
+ * Data series will be built using the provided measures that are further scoped for
9
10
  * elements of the specified attributes.
10
11
  */
11
12
  seriesBy: AttributesMeasuresOrPlaceholders;
12
13
  /**
13
- * Optionally slice all data series by elements of these attributes.
14
+ * Slice all data series by elements of these attributes.
14
15
  */
15
16
  slicesBy?: AttributesOrPlaceholders;
16
17
  /**
17
- * Optionally include these totals among the data slices.
18
+ * Include these totals among the data slices.
18
19
  */
19
20
  totals?: TotalsOrPlaceholders;
20
21
  /**
21
- * Optional filters to apply on server side.
22
+ * Filters to apply on server side.
22
23
  */
23
24
  filters?: NullableFiltersOrPlaceholders;
24
25
  /**
25
- * Optional sorting to apply on server side.
26
+ * Sorting to apply on server side.
26
27
  */
27
28
  sortBy?: SortsOrPlaceholders;
28
29
  /**
29
- * Optional resolution context for composed placeholders.
30
+ * Resolution context for composed placeholders.
30
31
  */
31
32
  placeholdersResolutionContext?: any;
32
33
  /**
33
- * Optional informative name of the component. This value is sent as telemetry information together
34
- * with the actual execution request. We recommend to set this because it can be useful for diagnostic
35
- * purposes.
34
+ * Informative name of the component.
35
+ *
36
+ * @remarks
37
+ * This value is sent as telemetry information together with the actual execution request.
38
+ * We recommend to set this because it can be useful for diagnostic purposes.
36
39
  *
37
40
  * Defaults 'Execute'.
38
41
  */
@@ -40,6 +43,7 @@ export interface IUseExecutionConfig {
40
43
  /**
41
44
  * Backend to work with.
42
45
  *
46
+ * @remarks
43
47
  * Note: the backend must come either from this property or from BackendContext. If you do not specify
44
48
  * backend here, then the executor MUST be rendered within an existing BackendContext.
45
49
  */
@@ -47,6 +51,7 @@ export interface IUseExecutionConfig {
47
51
  /**
48
52
  * Workspace where execution should be executed.
49
53
  *
54
+ * @remarks
50
55
  * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
51
56
  * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
52
57
  */
@@ -54,8 +59,11 @@ export interface IUseExecutionConfig {
54
59
  }
55
60
  /**
56
61
  * This hook provides a simplified interface for creating executions.
62
+ *
63
+ * @remarks
57
64
  * It builds the execution on top of the backend passed to the BackendProvider, and workspace passed to the WorkspaceProvider.
58
65
  *
66
+ * @deprecated use {@link useExecutionDataView} instead
59
67
  * @beta
60
68
  */
61
69
  export declare function useExecution(config: IUseExecutionConfig): IPreparedExecution;
@@ -1 +1 @@
1
- {"version":3,"file":"useExecution.d.ts","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAIH,gCAAgC,EAChC,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,mBAAmB,EACtB,MAAM,SAAS,CAAC;AAGjB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,kBAAkB,CAkB5E"}
1
+ {"version":3,"file":"useExecution.d.ts","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAIH,gCAAgC,EAChC,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,mBAAmB,EACtB,MAAM,SAAS,CAAC;AAGjB;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,kBAAkB,CAkB5E"}
@@ -6,8 +6,11 @@ var base_1 = require("../base");
6
6
  var createExecution_1 = require("./createExecution");
7
7
  /**
8
8
  * This hook provides a simplified interface for creating executions.
9
+ *
10
+ * @remarks
9
11
  * It builds the execution on top of the backend passed to the BackendProvider, and workspace passed to the WorkspaceProvider.
10
12
  *
13
+ * @deprecated use {@link useExecutionDataView} instead
11
14
  * @beta
12
15
  */
13
16
  function useExecution(config) {
@@ -1 +1 @@
1
- {"version":3,"file":"useExecution.js","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":";;;;AAEA,gCASiB;AACjB,qDAAoD;AA+DpD;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,MAA2B;IACpD,IAAM,OAAO,GAAG,iBAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAM,SAAS,GAAG,mBAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,IAAA,KAAA,eAAgD,uCAAgC,CAClF,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAChF,MAAM,CAAC,6BAA6B,CACvC,IAAA,EAHM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QAGjD,CAAC;IAEF,OAAO,iCAAe,uCACf,MAAM,KACT,OAAO,SAAA;QACP,SAAS,WAAA;QACT,QAAQ,UAAA;QACR,QAAQ,UAAA;QACR,MAAM,QAAA;QACN,OAAO,SAAA;QACP,MAAM,QAAA,IACR,CAAC;AACP,CAAC;AAlBD,oCAkBC"}
1
+ {"version":3,"file":"useExecution.js","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":";;;;AAEA,gCASiB;AACjB,qDAAoD;AAoEpD;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,MAA2B;IACpD,IAAM,OAAO,GAAG,iBAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAM,SAAS,GAAG,mBAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,IAAA,KAAA,eAAgD,uCAAgC,CAClF,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAChF,MAAM,CAAC,6BAA6B,CACvC,IAAA,EAHM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QAGjD,CAAC;IAEF,OAAO,iCAAe,uCACf,MAAM,KACT,OAAO,SAAA;QACP,SAAS,WAAA;QACT,QAAQ,UAAA;QACR,QAAQ,UAAA;QACR,MAAM,QAAA;QACN,OAAO,SAAA;QACP,MAAM,QAAA,IACR,CAAC;AACP,CAAC;AAlBD,oCAkBC"}
@@ -1,47 +1,54 @@
1
1
  /// <reference types="react" />
2
2
  import { IAnalyticalBackend, IPreparedExecution } from "@gooddata/sdk-backend-spi";
3
3
  import { DataViewWindow } from "./withExecutionLoading";
4
- import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseState, AttributesMeasuresOrPlaceholders, AttributesOrPlaceholders, NullableFiltersOrPlaceholders, SortsOrPlaceholders, TotalsOrPlaceholders } from "../base";
4
+ import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseState, AttributesMeasuresOrPlaceholders, AttributesOrPlaceholders, NullableFiltersOrPlaceholders, SortsOrPlaceholders, TotalsOrPlaceholders, UseCancelablePromiseCallbacks } from "../base";
5
5
  /**
6
- * @beta
6
+ * Convenient interfance to define execution by series and slices.
7
+ *
8
+ * @public
7
9
  */
8
10
  export interface IExecutionConfiguration {
9
11
  /**
10
- * Data series will be built using the provided measures that are optionally further scoped for
12
+ * Data series will be built using the provided measures that are further scoped for
11
13
  * elements of the specified attributes.
12
14
  */
13
15
  seriesBy: AttributesMeasuresOrPlaceholders;
14
16
  /**
15
- * Optionally slice all data series by elements of these attributes.
17
+ * Slice all data series by elements of these attributes.
16
18
  */
17
19
  slicesBy?: AttributesOrPlaceholders;
18
20
  /**
19
- * Optionally include these totals among the data slices.
21
+ * Include these totals among the data slices.
20
22
  */
21
23
  totals?: TotalsOrPlaceholders;
22
24
  /**
23
- * Optional filters to apply on server side.
25
+ * Filters to apply on server side.
24
26
  */
25
27
  filters?: NullableFiltersOrPlaceholders;
26
28
  /**
27
- * Optional sorting to apply on server side.
29
+ * Sorting to apply on server side.
28
30
  */
29
31
  sortBy?: SortsOrPlaceholders;
30
32
  /**
31
- * Optional resolution context for composed placeholders.
33
+ * Resolution context for composed placeholders.
32
34
  */
33
35
  placeholdersResolutionContext?: any;
34
36
  /**
35
- * Optional informative name of the component. This value is sent as telemetry information together
36
- * with the actual execution request. We recommend to set this because it can be useful for diagnostic
37
- * purposes.
37
+ * Informative name of the component.
38
+ *
39
+ * @remarks
40
+ * This value is sent as telemetry information together with the actual execution request.
41
+ * We recommend to set this because it can be useful for diagnostic purposes.
38
42
  *
39
43
  * Defaults 'Execute'.
40
44
  */
41
45
  componentName?: string;
42
46
  }
43
47
  /**
44
- * @beta
48
+ * Configuration for {@link useExecutionDataView} hook.
49
+ * See also {@link UseExecutionDataViewCallbacks}.
50
+ *
51
+ * @public
45
52
  */
46
53
  export interface IUseExecutionDataViewConfig {
47
54
  /**
@@ -49,13 +56,16 @@ export interface IUseExecutionDataViewConfig {
49
56
  */
50
57
  execution?: IPreparedExecution | IExecutionConfiguration;
51
58
  /**
52
- * Optionally, you can define only a specific "window" of data to load.
59
+ * You can define only a specific "window" of data to load.
60
+ *
61
+ * @remarks
53
62
  * This is useful if you want to page data.
54
63
  */
55
64
  window?: DataViewWindow;
56
65
  /**
57
66
  * Backend to work with.
58
67
  *
68
+ * @remarks
59
69
  * Note: the backend must come either from this property or from BackendContext. If you do not specify
60
70
  * backend here, then the executor MUST be rendered within an existing BackendContext.
61
71
  */
@@ -63,15 +73,22 @@ export interface IUseExecutionDataViewConfig {
63
73
  /**
64
74
  * Workspace where execution should be executed.
65
75
  *
76
+ * @remarks
66
77
  * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
67
78
  * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
68
79
  */
69
80
  workspace?: string;
70
81
  }
82
+ /**
83
+ * Callbacks for {@link useExecutionDataView} hook.
84
+ *
85
+ * @public
86
+ */
87
+ export declare type UseExecutionDataViewCallbacks = UseCancelablePromiseCallbacks<DataViewFacade, GoodDataSdkError>;
71
88
  /**
72
89
  * React hook to get data for a specific execution.
73
90
  *
74
- * @beta
91
+ * @public
75
92
  */
76
- export declare function useExecutionDataView(config: IUseExecutionDataViewConfig, deps?: React.DependencyList): UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
93
+ export declare function useExecutionDataView(config: IUseExecutionDataViewConfig & UseExecutionDataViewCallbacks, deps?: React.DependencyList): UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
77
94
  //# sourceMappingURL=useExecutionDataView.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"useExecutionDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useExecutionDataView.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EACH,cAAc,EACd,gBAAgB,EAGhB,yBAAyB,EAEzB,gCAAgC,EAChC,wBAAwB,EACxB,6BAA6B,EAC7B,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,SAAS,CAAC;AAKjB;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AASD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,GAAG,uBAAuB,CAAC;IAEzD;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAChC,MAAM,EAAE,2BAA2B,EACnC,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,GAC5B,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAqC7D"}
1
+ {"version":3,"file":"useExecutionDataView.d.ts","sourceRoot":"","sources":["../../src/execution/useExecutionDataView.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EACH,cAAc,EACd,gBAAgB,EAGhB,yBAAyB,EAEzB,gCAAgC,EAChC,wBAAwB,EACxB,6BAA6B,EAC7B,mBAAmB,EACnB,oBAAoB,EACpB,6BAA6B,EAChC,MAAM,SAAS,CAAC;AAKjB;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AASD;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,GAAG,uBAAuB,CAAC;IAEzD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;AAE5G;;;;GAIG;AACH,wBAAgB,oBAAoB,CAChC,MAAM,EAAE,2BAA2B,GAAG,6BAA6B,EACnE,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,GAC5B,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAwC7D"}
@@ -16,11 +16,11 @@ function isExecutionConfiguration(obj) {
16
16
  /**
17
17
  * React hook to get data for a specific execution.
18
18
  *
19
- * @beta
19
+ * @public
20
20
  */
21
21
  function useExecutionDataView(config, deps) {
22
22
  var _a;
23
- var execution = config.execution, window = config.window;
23
+ var execution = config.execution, window = config.window, onCancel = config.onCancel, onError = config.onError, onLoading = config.onLoading, onPending = config.onPending, onSuccess = config.onSuccess;
24
24
  var backend = base_1.useBackendStrict(config.backend, "useExecutionDataView");
25
25
  var workspace = base_1.useWorkspaceStrict(config.workspace, "useExecutionDataView");
26
26
  var effectiveDeps = deps !== null && deps !== void 0 ? deps : [];
@@ -40,7 +40,7 @@ function useExecutionDataView(config, deps) {
40
40
  backend: backend,
41
41
  workspace: workspace }))
42
42
  : execution;
43
- return useDataView_1.useDataView({ execution: preparedExecution, window: window }, tslib_1.__spread([
43
+ return useDataView_1.useDataView({ execution: preparedExecution, window: window, onCancel: onCancel, onError: onError, onLoading: onLoading, onPending: onPending, onSuccess: onSuccess }, tslib_1.__spread([
44
44
  backend,
45
45
  workspace,
46
46
  (_a = preparedExecution === null || preparedExecution === void 0 ? void 0 : preparedExecution.fingerprint()) !== null && _a !== void 0 ? _a : "__executionFingerprint__"
@@ -1 +1 @@
1
- {"version":3,"file":"useExecutionDataView.js","sourceRoot":"","sources":["../../src/execution/useExecutionDataView.ts"],"names":[],"mappings":";;;;AAGA,gCAYiB;AACjB,6CAA4C;AAC5C,mEAAqC;AACrC,qDAAoD;AA+CpD;;GAEG;AACH,SAAS,wBAAwB,CAAC,GAAY;;IAC1C,OAAO,CAAC,iBAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAE,GAA+B,0CAAE,QAAQ,CAAA,CAAC;AACzE,CAAC;AAkCD;;;;GAIG;AACH,SAAgB,oBAAoB,CAChC,MAAmC,EACnC,IAA2B;;IAEnB,IAAA,SAAS,GAAa,MAAM,UAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAY;IACrC,IAAM,OAAO,GAAG,uBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IACzE,IAAM,SAAS,GAAG,yBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;IAC/E,IAAM,aAAa,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;IAEjC,IAAM,cAAc,GAAG,8BAA8B,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClE,IAAA,KAAA,eAAgD,uCAAgC,CAClF;QACI,cAAc,CAAC,QAAQ;QACvB,cAAc,CAAC,QAAQ;QACvB,cAAc,CAAC,MAAM;QACrB,cAAc,CAAC,OAAO;QACtB,cAAc,CAAC,MAAM;KACxB,EACD,cAAc,CAAC,6BAA6B,CAC/C,IAAA,EATM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QASjD,CAAC;IAEF,IAAM,iBAAiB,GAAG,wBAAwB,CAAC,SAAS,CAAC;QACzD,CAAC,CAAC,iCAAe,uCACR,SAAS,KACZ,QAAQ,EAAE,QAAS,EACnB,QAAQ,UAAA;YACR,MAAM,QAAA;YACN,OAAO,SAAA;YACP,MAAM,QAAA;YACN,OAAO,SAAA;YACP,SAAS,WAAA,IACX;QACJ,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,yBAAW,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,QAAA,EAAE;QACvD,OAAO;QACP,SAAS;cACT,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,WAAW,qCAAM,0BAA0B;OAC3D,aAAa,EAClB,CAAC;AACP,CAAC;AAxCD,oDAwCC;AAED;;GAEG;AACH,SAAS,8BAA8B,CACnC,SAAwD;IAExD,IAAI,wBAAwB,CAAC,SAAS,CAAC,EAAE;QACrC,OAAO,SAAS,CAAC;KACpB;IAED,OAAO,EAAE,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"useExecutionDataView.js","sourceRoot":"","sources":["../../src/execution/useExecutionDataView.ts"],"names":[],"mappings":";;;;AAGA,gCAaiB;AACjB,6CAA4C;AAC5C,mEAAqC;AACrC,qDAAoD;AAmDpD;;GAEG;AACH,SAAS,wBAAwB,CAAC,GAAY;;IAC1C,OAAO,CAAC,iBAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAE,GAA+B,0CAAE,QAAQ,CAAA,CAAC;AACzE,CAAC;AAgDD;;;;GAIG;AACH,SAAgB,oBAAoB,CAChC,MAAmE,EACnE,IAA2B;;IAEnB,IAAA,SAAS,GAAiE,MAAM,UAAvE,EAAE,MAAM,GAAyD,MAAM,OAA/D,EAAE,QAAQ,GAA+C,MAAM,SAArD,EAAE,OAAO,GAAsC,MAAM,QAA5C,EAAE,SAAS,GAA2B,MAAM,UAAjC,EAAE,SAAS,GAAgB,MAAM,UAAtB,EAAE,SAAS,GAAK,MAAM,UAAX,CAAY;IACzF,IAAM,OAAO,GAAG,uBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IACzE,IAAM,SAAS,GAAG,yBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;IAC/E,IAAM,aAAa,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;IAEjC,IAAM,cAAc,GAAG,8BAA8B,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClE,IAAA,KAAA,eAAgD,uCAAgC,CAClF;QACI,cAAc,CAAC,QAAQ;QACvB,cAAc,CAAC,QAAQ;QACvB,cAAc,CAAC,MAAM;QACrB,cAAc,CAAC,OAAO;QACtB,cAAc,CAAC,MAAM;KACxB,EACD,cAAc,CAAC,6BAA6B,CAC/C,IAAA,EATM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QASjD,CAAC;IAEF,IAAM,iBAAiB,GAAG,wBAAwB,CAAC,SAAS,CAAC;QACzD,CAAC,CAAC,iCAAe,uCACR,SAAS,KACZ,QAAQ,EAAE,QAAS,EACnB,QAAQ,UAAA;YACR,MAAM,QAAA;YACN,OAAO,SAAA;YACP,MAAM,QAAA;YACN,OAAO,SAAA;YACP,SAAS,WAAA,IACX;QACJ,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,yBAAW,CACd,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,QAAA,EAAE,QAAQ,UAAA,EAAE,OAAO,SAAA,EAAE,SAAS,WAAA,EAAE,SAAS,WAAA,EAAE,SAAS,WAAA,EAAE;QAExF,OAAO;QACP,SAAS;cACT,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,WAAW,qCAAM,0BAA0B;OAC3D,aAAa,EAEvB,CAAC;AACN,CAAC;AA3CD,oDA2CC;AAED;;GAEG;AACH,SAAS,8BAA8B,CACnC,SAAwD;IAExD,IAAI,wBAAwB,CAAC,SAAS,CAAC,EAAE;QACrC,OAAO,SAAS,CAAC;KACpB;IAED,OAAO,EAAE,CAAC;AACd,CAAC"}