@gooddata/sdk-ui 8.10.0-alpha.5 → 8.10.0-alpha.52

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 (355) hide show
  1. package/dist/base/errors/GoodDataSdkError.d.ts +4 -1
  2. package/dist/base/errors/GoodDataSdkError.d.ts.map +1 -1
  3. package/dist/base/errors/GoodDataSdkError.js +5 -2
  4. package/dist/base/errors/GoodDataSdkError.js.map +1 -1
  5. package/dist/base/errors/errorHandling.d.ts +5 -3
  6. package/dist/base/errors/errorHandling.d.ts.map +1 -1
  7. package/dist/base/errors/errorHandling.js +6 -4
  8. package/dist/base/errors/errorHandling.js.map +1 -1
  9. package/dist/base/headerMatching/HeaderPredicate.d.ts +5 -1
  10. package/dist/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  11. package/dist/base/headerMatching/HeaderPredicate.js.map +1 -1
  12. package/dist/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  13. package/dist/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  14. package/dist/base/headerMatching/HeaderPredicateFactory.js +14 -34
  15. package/dist/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  16. package/dist/base/headerMatching/MappingHeader.d.ts +3 -1
  17. package/dist/base/headerMatching/MappingHeader.d.ts.map +1 -1
  18. package/dist/base/headerMatching/MappingHeader.js +13 -13
  19. package/dist/base/headerMatching/MappingHeader.js.map +1 -1
  20. package/dist/base/helpers/CatalogHelper.d.ts +5 -3
  21. package/dist/base/helpers/CatalogHelper.d.ts.map +1 -1
  22. package/dist/base/helpers/CatalogHelper.js +5 -3
  23. package/dist/base/helpers/CatalogHelper.js.map +1 -1
  24. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  25. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  26. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
  27. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  28. package/dist/base/localization/bundles/de-DE.json +6 -2
  29. package/dist/base/localization/bundles/en-US.json +24 -9
  30. package/dist/base/localization/bundles/es-ES.json +6 -2
  31. package/dist/base/localization/bundles/fr-FR.json +6 -2
  32. package/dist/base/localization/bundles/ja-JP.json +6 -2
  33. package/dist/base/localization/bundles/nl-NL.json +6 -2
  34. package/dist/base/localization/bundles/pt-BR.json +6 -2
  35. package/dist/base/localization/bundles/pt-PT.json +6 -2
  36. package/dist/base/localization/bundles/ru-RU.json +6 -2
  37. package/dist/base/localization/bundles/zh-Hans.json +6 -2
  38. package/dist/base/react/BackendContext.d.ts +7 -3
  39. package/dist/base/react/BackendContext.d.ts.map +1 -1
  40. package/dist/base/react/BackendContext.js +8 -4
  41. package/dist/base/react/BackendContext.js.map +1 -1
  42. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
  43. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  44. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
  45. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  46. package/dist/base/react/ErrorComponent.d.ts +4 -2
  47. package/dist/base/react/ErrorComponent.d.ts.map +1 -1
  48. package/dist/base/react/ErrorComponent.js +5 -3
  49. package/dist/base/react/ErrorComponent.js.map +1 -1
  50. package/dist/base/react/LoadingComponent.d.ts +4 -2
  51. package/dist/base/react/LoadingComponent.d.ts.map +1 -1
  52. package/dist/base/react/LoadingComponent.js +5 -3
  53. package/dist/base/react/LoadingComponent.js.map +1 -1
  54. package/dist/base/react/WorkspaceContext.d.ts +7 -3
  55. package/dist/base/react/WorkspaceContext.d.ts.map +1 -1
  56. package/dist/base/react/WorkspaceContext.js +8 -4
  57. package/dist/base/react/WorkspaceContext.js.map +1 -1
  58. package/dist/base/react/legacy/availableDrillTargets.d.ts +1 -1
  59. package/dist/base/react/legacy/availableDrillTargets.d.ts.map +1 -1
  60. package/dist/base/react/legacy/availableDrillTargets.js +1 -1
  61. package/dist/base/react/legacy/availableDrillTargets.js.map +1 -1
  62. package/dist/base/react/placeholders/base.d.ts +76 -42
  63. package/dist/base/react/placeholders/base.d.ts.map +1 -1
  64. package/dist/base/react/placeholders/base.js +1 -1
  65. package/dist/base/react/placeholders/base.js.map +1 -1
  66. package/dist/base/react/placeholders/factory.d.ts +4 -2
  67. package/dist/base/react/placeholders/factory.d.ts.map +1 -1
  68. package/dist/base/react/placeholders/factory.js +1 -1
  69. package/dist/base/react/placeholders/factory.js.map +1 -1
  70. package/dist/base/react/placeholders/hooks.d.ts +13 -3
  71. package/dist/base/react/placeholders/hooks.d.ts.map +1 -1
  72. package/dist/base/react/placeholders/hooks.js +14 -4
  73. package/dist/base/react/placeholders/hooks.js.map +1 -1
  74. package/dist/base/react/useCancelablePromise.d.ts +17 -11
  75. package/dist/base/react/useCancelablePromise.d.ts.map +1 -1
  76. package/dist/base/react/useCancelablePromise.js +9 -3
  77. package/dist/base/react/useCancelablePromise.js.map +1 -1
  78. package/dist/base/react/useCancelablePromiseUtils.d.ts +5 -3
  79. package/dist/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  80. package/dist/base/react/useCancelablePromiseUtils.js +6 -4
  81. package/dist/base/react/useCancelablePromiseUtils.js.map +1 -1
  82. package/dist/base/results/dataAccess.d.ts +32 -12
  83. package/dist/base/results/dataAccess.d.ts.map +1 -1
  84. package/dist/base/results/dataAccessConfig.d.ts +5 -2
  85. package/dist/base/results/dataAccessConfig.d.ts.map +1 -1
  86. package/dist/base/results/dataAccessConfig.js +4 -1
  87. package/dist/base/results/dataAccessConfig.js.map +1 -1
  88. package/dist/base/results/facade.d.ts +10 -4
  89. package/dist/base/results/facade.d.ts.map +1 -1
  90. package/dist/base/results/facade.js +9 -3
  91. package/dist/base/results/facade.js.map +1 -1
  92. package/dist/base/results/internal/dataAccessDigest.d.ts +2 -2
  93. package/dist/base/results/internal/dataAccessDigest.d.ts.map +1 -1
  94. package/dist/base/results/internal/dataAccessDigest.js +5 -7
  95. package/dist/base/results/internal/dataAccessDigest.js.map +1 -1
  96. package/dist/base/results/internal/dataAccessImpl.d.ts.map +1 -1
  97. package/dist/base/results/internal/dataAccessImpl.js +6 -6
  98. package/dist/base/results/internal/dataAccessImpl.js.map +1 -1
  99. package/dist/base/results/internal/dataAccessMethods.d.ts.map +1 -1
  100. package/dist/base/results/internal/dataAccessMethods.js +1 -1
  101. package/dist/base/results/internal/dataAccessMethods.js.map +1 -1
  102. package/dist/base/results/internal/definitionMethods.d.ts +1 -1
  103. package/dist/base/results/internal/definitionMethods.js +1 -1
  104. package/dist/base/results/internal/resultDataMethods.d.ts +3 -2
  105. package/dist/base/results/internal/resultDataMethods.d.ts.map +1 -1
  106. package/dist/base/results/internal/resultDataMethods.js.map +1 -1
  107. package/dist/base/results/internal/resultMetaMethods.d.ts +3 -3
  108. package/dist/base/results/internal/resultMetaMethods.d.ts.map +1 -1
  109. package/dist/base/results/internal/resultMetaMethods.js +8 -9
  110. package/dist/base/results/internal/resultMetaMethods.js.map +1 -1
  111. package/dist/base/results/internal/utils.d.ts +2 -1
  112. package/dist/base/results/internal/utils.d.ts.map +1 -1
  113. package/dist/base/results/internal/utils.js +1 -1
  114. package/dist/base/vis/DrillEvents.d.ts +4 -1
  115. package/dist/base/vis/DrillEvents.d.ts.map +1 -1
  116. package/dist/base/vis/DrillEvents.js.map +1 -1
  117. package/dist/base/vis/Events.d.ts +2 -2
  118. package/dist/base/vis/Events.d.ts.map +1 -1
  119. package/dist/base/vis/VisualizationProps.d.ts +11 -4
  120. package/dist/base/vis/VisualizationProps.d.ts.map +1 -1
  121. package/dist/base/vis/VisualizationProps.js +1 -1
  122. package/dist/base/vis/drilling.js +5 -5
  123. package/dist/base/vis/drilling.js.map +1 -1
  124. package/dist/base/vis/export.d.ts +1 -1
  125. package/dist/base/vis/export.js +2 -2
  126. package/dist/execution/Execute.d.ts +36 -20
  127. package/dist/execution/Execute.d.ts.map +1 -1
  128. package/dist/execution/Execute.js +7 -5
  129. package/dist/execution/Execute.js.map +1 -1
  130. package/dist/execution/ExecuteInsight.d.ts +47 -16
  131. package/dist/execution/ExecuteInsight.d.ts.map +1 -1
  132. package/dist/execution/ExecuteInsight.js +7 -5
  133. package/dist/execution/ExecuteInsight.js.map +1 -1
  134. package/dist/execution/RawExecute.d.ts +19 -7
  135. package/dist/execution/RawExecute.d.ts.map +1 -1
  136. package/dist/execution/RawExecute.js +2 -1
  137. package/dist/execution/RawExecute.js.map +1 -1
  138. package/dist/execution/createExecution.d.ts +9 -6
  139. package/dist/execution/createExecution.d.ts.map +1 -1
  140. package/dist/execution/createExecution.js +3 -5
  141. package/dist/execution/createExecution.js.map +1 -1
  142. package/dist/execution/useDataExport.d.ts +5 -3
  143. package/dist/execution/useDataExport.d.ts.map +1 -1
  144. package/dist/execution/useDataExport.js +3 -1
  145. package/dist/execution/useDataExport.js.map +1 -1
  146. package/dist/execution/useDataView.d.ts +5 -0
  147. package/dist/execution/useDataView.d.ts.map +1 -1
  148. package/dist/execution/useDataView.js +3 -0
  149. package/dist/execution/useDataView.js.map +1 -1
  150. package/dist/execution/useExecution.d.ts +17 -9
  151. package/dist/execution/useExecution.d.ts.map +1 -1
  152. package/dist/execution/useExecution.js +3 -0
  153. package/dist/execution/useExecution.js.map +1 -1
  154. package/dist/execution/useExecutionDataView.d.ts +19 -13
  155. package/dist/execution/useExecutionDataView.d.ts.map +1 -1
  156. package/dist/execution/useExecutionDataView.js +1 -1
  157. package/dist/execution/useExecutionDataView.js.map +1 -1
  158. package/dist/execution/useInsightDataView.d.ts +29 -7
  159. package/dist/execution/useInsightDataView.d.ts.map +1 -1
  160. package/dist/execution/useInsightDataView.js +5 -4
  161. package/dist/execution/useInsightDataView.js.map +1 -1
  162. package/dist/execution/withExecution.d.ts +5 -4
  163. package/dist/execution/withExecution.d.ts.map +1 -1
  164. package/dist/execution/withExecution.js +1 -1
  165. package/dist/execution/withExecution.js.map +1 -1
  166. package/dist/execution/withExecutionLoading.d.ts +12 -7
  167. package/dist/execution/withExecutionLoading.d.ts.map +1 -1
  168. package/dist/execution/withExecutionLoading.js +1 -1
  169. package/dist/execution/withExecutionLoading.js.map +1 -1
  170. package/dist/index.d.ts +1 -1
  171. package/dist/index.d.ts.map +1 -1
  172. package/dist/index.js +1 -1
  173. package/dist/kpi/Kpi.d.ts +13 -9
  174. package/dist/kpi/Kpi.d.ts.map +1 -1
  175. package/dist/kpi/Kpi.js +5 -3
  176. package/dist/kpi/Kpi.js.map +1 -1
  177. package/dist/sdk-ui.d.ts +447 -209
  178. package/esm/base/errors/GoodDataSdkError.d.ts +4 -1
  179. package/esm/base/errors/GoodDataSdkError.d.ts.map +1 -1
  180. package/esm/base/errors/GoodDataSdkError.js +5 -2
  181. package/esm/base/errors/GoodDataSdkError.js.map +1 -1
  182. package/esm/base/errors/errorHandling.d.ts +5 -3
  183. package/esm/base/errors/errorHandling.d.ts.map +1 -1
  184. package/esm/base/errors/errorHandling.js +6 -4
  185. package/esm/base/errors/errorHandling.js.map +1 -1
  186. package/esm/base/headerMatching/HeaderPredicate.d.ts +5 -1
  187. package/esm/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  188. package/esm/base/headerMatching/HeaderPredicate.js.map +1 -1
  189. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  190. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  191. package/esm/base/headerMatching/HeaderPredicateFactory.js +10 -30
  192. package/esm/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  193. package/esm/base/headerMatching/MappingHeader.d.ts +3 -1
  194. package/esm/base/headerMatching/MappingHeader.d.ts.map +1 -1
  195. package/esm/base/headerMatching/MappingHeader.js +2 -2
  196. package/esm/base/headerMatching/MappingHeader.js.map +1 -1
  197. package/esm/base/helpers/CatalogHelper.d.ts +5 -3
  198. package/esm/base/helpers/CatalogHelper.d.ts.map +1 -1
  199. package/esm/base/helpers/CatalogHelper.js +5 -3
  200. package/esm/base/helpers/CatalogHelper.js.map +1 -1
  201. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  202. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  203. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
  204. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  205. package/esm/base/localization/bundles/de-DE.json +6 -2
  206. package/esm/base/localization/bundles/en-US.json +24 -9
  207. package/esm/base/localization/bundles/es-ES.json +6 -2
  208. package/esm/base/localization/bundles/fr-FR.json +6 -2
  209. package/esm/base/localization/bundles/ja-JP.json +6 -2
  210. package/esm/base/localization/bundles/nl-NL.json +6 -2
  211. package/esm/base/localization/bundles/pt-BR.json +6 -2
  212. package/esm/base/localization/bundles/pt-PT.json +6 -2
  213. package/esm/base/localization/bundles/ru-RU.json +6 -2
  214. package/esm/base/localization/bundles/zh-Hans.json +6 -2
  215. package/esm/base/react/BackendContext.d.ts +7 -3
  216. package/esm/base/react/BackendContext.d.ts.map +1 -1
  217. package/esm/base/react/BackendContext.js +8 -4
  218. package/esm/base/react/BackendContext.js.map +1 -1
  219. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
  220. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  221. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
  222. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  223. package/esm/base/react/ErrorComponent.d.ts +4 -2
  224. package/esm/base/react/ErrorComponent.d.ts.map +1 -1
  225. package/esm/base/react/ErrorComponent.js +5 -3
  226. package/esm/base/react/ErrorComponent.js.map +1 -1
  227. package/esm/base/react/LoadingComponent.d.ts +4 -2
  228. package/esm/base/react/LoadingComponent.d.ts.map +1 -1
  229. package/esm/base/react/LoadingComponent.js +5 -3
  230. package/esm/base/react/LoadingComponent.js.map +1 -1
  231. package/esm/base/react/WorkspaceContext.d.ts +7 -3
  232. package/esm/base/react/WorkspaceContext.d.ts.map +1 -1
  233. package/esm/base/react/WorkspaceContext.js +8 -4
  234. package/esm/base/react/WorkspaceContext.js.map +1 -1
  235. package/esm/base/react/legacy/availableDrillTargets.d.ts +1 -1
  236. package/esm/base/react/legacy/availableDrillTargets.d.ts.map +1 -1
  237. package/esm/base/react/legacy/availableDrillTargets.js +1 -1
  238. package/esm/base/react/legacy/availableDrillTargets.js.map +1 -1
  239. package/esm/base/react/placeholders/base.d.ts +76 -42
  240. package/esm/base/react/placeholders/base.d.ts.map +1 -1
  241. package/esm/base/react/placeholders/base.js +1 -1
  242. package/esm/base/react/placeholders/base.js.map +1 -1
  243. package/esm/base/react/placeholders/factory.d.ts +4 -2
  244. package/esm/base/react/placeholders/factory.d.ts.map +1 -1
  245. package/esm/base/react/placeholders/factory.js +1 -1
  246. package/esm/base/react/placeholders/factory.js.map +1 -1
  247. package/esm/base/react/placeholders/hooks.d.ts +13 -3
  248. package/esm/base/react/placeholders/hooks.d.ts.map +1 -1
  249. package/esm/base/react/placeholders/hooks.js +14 -4
  250. package/esm/base/react/placeholders/hooks.js.map +1 -1
  251. package/esm/base/react/useCancelablePromise.d.ts +17 -11
  252. package/esm/base/react/useCancelablePromise.d.ts.map +1 -1
  253. package/esm/base/react/useCancelablePromise.js +9 -3
  254. package/esm/base/react/useCancelablePromise.js.map +1 -1
  255. package/esm/base/react/useCancelablePromiseUtils.d.ts +5 -3
  256. package/esm/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  257. package/esm/base/react/useCancelablePromiseUtils.js +6 -4
  258. package/esm/base/react/useCancelablePromiseUtils.js.map +1 -1
  259. package/esm/base/results/dataAccess.d.ts +32 -12
  260. package/esm/base/results/dataAccess.d.ts.map +1 -1
  261. package/esm/base/results/dataAccessConfig.d.ts +5 -2
  262. package/esm/base/results/dataAccessConfig.d.ts.map +1 -1
  263. package/esm/base/results/dataAccessConfig.js +4 -1
  264. package/esm/base/results/dataAccessConfig.js.map +1 -1
  265. package/esm/base/results/facade.d.ts +10 -4
  266. package/esm/base/results/facade.d.ts.map +1 -1
  267. package/esm/base/results/facade.js +9 -3
  268. package/esm/base/results/facade.js.map +1 -1
  269. package/esm/base/results/internal/dataAccessDigest.d.ts +2 -2
  270. package/esm/base/results/internal/dataAccessDigest.d.ts.map +1 -1
  271. package/esm/base/results/internal/dataAccessDigest.js +1 -3
  272. package/esm/base/results/internal/dataAccessDigest.js.map +1 -1
  273. package/esm/base/results/internal/dataAccessImpl.d.ts.map +1 -1
  274. package/esm/base/results/internal/dataAccessImpl.js +1 -1
  275. package/esm/base/results/internal/dataAccessImpl.js.map +1 -1
  276. package/esm/base/results/internal/dataAccessMethods.d.ts.map +1 -1
  277. package/esm/base/results/internal/dataAccessMethods.js +2 -2
  278. package/esm/base/results/internal/dataAccessMethods.js.map +1 -1
  279. package/esm/base/results/internal/definitionMethods.d.ts +1 -1
  280. package/esm/base/results/internal/definitionMethods.js +1 -1
  281. package/esm/base/results/internal/resultDataMethods.d.ts +3 -2
  282. package/esm/base/results/internal/resultDataMethods.d.ts.map +1 -1
  283. package/esm/base/results/internal/resultDataMethods.js.map +1 -1
  284. package/esm/base/results/internal/resultMetaMethods.d.ts +3 -3
  285. package/esm/base/results/internal/resultMetaMethods.d.ts.map +1 -1
  286. package/esm/base/results/internal/resultMetaMethods.js +2 -3
  287. package/esm/base/results/internal/resultMetaMethods.js.map +1 -1
  288. package/esm/base/results/internal/utils.d.ts +2 -1
  289. package/esm/base/results/internal/utils.d.ts.map +1 -1
  290. package/esm/base/results/internal/utils.js +1 -1
  291. package/esm/base/vis/DrillEvents.d.ts +4 -1
  292. package/esm/base/vis/DrillEvents.d.ts.map +1 -1
  293. package/esm/base/vis/DrillEvents.js.map +1 -1
  294. package/esm/base/vis/Events.d.ts +2 -2
  295. package/esm/base/vis/Events.d.ts.map +1 -1
  296. package/esm/base/vis/VisualizationProps.d.ts +11 -4
  297. package/esm/base/vis/VisualizationProps.d.ts.map +1 -1
  298. package/esm/base/vis/VisualizationProps.js +1 -1
  299. package/esm/base/vis/drilling.js +2 -2
  300. package/esm/base/vis/drilling.js.map +1 -1
  301. package/esm/base/vis/export.d.ts +1 -1
  302. package/esm/base/vis/export.js +2 -2
  303. package/esm/execution/Execute.d.ts +36 -20
  304. package/esm/execution/Execute.d.ts.map +1 -1
  305. package/esm/execution/Execute.js +7 -5
  306. package/esm/execution/Execute.js.map +1 -1
  307. package/esm/execution/ExecuteInsight.d.ts +47 -16
  308. package/esm/execution/ExecuteInsight.d.ts.map +1 -1
  309. package/esm/execution/ExecuteInsight.js +7 -5
  310. package/esm/execution/ExecuteInsight.js.map +1 -1
  311. package/esm/execution/RawExecute.d.ts +19 -7
  312. package/esm/execution/RawExecute.d.ts.map +1 -1
  313. package/esm/execution/RawExecute.js +2 -1
  314. package/esm/execution/RawExecute.js.map +1 -1
  315. package/esm/execution/createExecution.d.ts +9 -6
  316. package/esm/execution/createExecution.d.ts.map +1 -1
  317. package/esm/execution/createExecution.js +4 -6
  318. package/esm/execution/createExecution.js.map +1 -1
  319. package/esm/execution/useDataExport.d.ts +5 -3
  320. package/esm/execution/useDataExport.d.ts.map +1 -1
  321. package/esm/execution/useDataExport.js +3 -1
  322. package/esm/execution/useDataExport.js.map +1 -1
  323. package/esm/execution/useDataView.d.ts +5 -0
  324. package/esm/execution/useDataView.d.ts.map +1 -1
  325. package/esm/execution/useDataView.js +3 -0
  326. package/esm/execution/useDataView.js.map +1 -1
  327. package/esm/execution/useExecution.d.ts +17 -9
  328. package/esm/execution/useExecution.d.ts.map +1 -1
  329. package/esm/execution/useExecution.js +3 -0
  330. package/esm/execution/useExecution.js.map +1 -1
  331. package/esm/execution/useExecutionDataView.d.ts +19 -13
  332. package/esm/execution/useExecutionDataView.d.ts.map +1 -1
  333. package/esm/execution/useExecutionDataView.js +1 -1
  334. package/esm/execution/useExecutionDataView.js.map +1 -1
  335. package/esm/execution/useInsightDataView.d.ts +29 -7
  336. package/esm/execution/useInsightDataView.d.ts.map +1 -1
  337. package/esm/execution/useInsightDataView.js +5 -4
  338. package/esm/execution/useInsightDataView.js.map +1 -1
  339. package/esm/execution/withExecution.d.ts +5 -4
  340. package/esm/execution/withExecution.d.ts.map +1 -1
  341. package/esm/execution/withExecution.js +1 -1
  342. package/esm/execution/withExecution.js.map +1 -1
  343. package/esm/execution/withExecutionLoading.d.ts +12 -7
  344. package/esm/execution/withExecutionLoading.d.ts.map +1 -1
  345. package/esm/execution/withExecutionLoading.js +1 -1
  346. package/esm/execution/withExecutionLoading.js.map +1 -1
  347. package/esm/index.d.ts +1 -1
  348. package/esm/index.d.ts.map +1 -1
  349. package/esm/index.js +1 -1
  350. package/esm/kpi/Kpi.d.ts +13 -9
  351. package/esm/kpi/Kpi.d.ts.map +1 -1
  352. package/esm/kpi/Kpi.js +5 -3
  353. package/esm/kpi/Kpi.js.map +1 -1
  354. package/esm/tsdoc-metadata.json +1 -1
  355. package/package.json +9 -9
@@ -1 +1 @@
1
- {"version":3,"file":"ExecuteInsight.js","sourceRoot":"","sources":["../../src/execution/ExecuteInsight.tsx"],"names":[],"mappings":";AAAA,gCAAgC;AAChC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,SAAS,MAAM,cAAc,CAAC;AA+GrC,IAAM,WAAW,GAAoB,UAAC,KAAY;IACtC,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,oBAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,oBAAC,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,aAAa,CAAC,KAA2B;IAC9C,OAAO,KAAK,CAAC,aAAa,IAAI,gBAAgB,CAAC;AACnD,CAAC;AAED,SAAS,WAAW,CAAC,KAA2B;IAC5C,OAAO,KAAK,CAAC,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,IAAM,cAAc,GAAG,YAAY,CACtC,aAAa,CAAuB;IAChC,WAAW,aAAA;IACX,SAAS,EAAE,UAAO,KAAK;;;;;oBACF,UAAU,GAAiE,KAAK,QAAtE,EAAE,OAAO,GAAwD,KAAK,QAA7D,EAAE,KAAK,GAAiD,KAAK,MAAtD,EAAE,UAAU,GAAqC,KAAK,WAA1C,EAAE,UAAU,GAAyB,KAAK,WAA9B,EAAE,OAAO,GAAgB,KAAK,QAArB,EAAE,SAAS,GAAK,KAAK,UAAV,CAAW;oBAClG,SAAS,CACL,OAAO,EACP,wIAAwI,CAC3I,CAAC;oBACF,SAAS,CACL,SAAS,EACT,4IAA4I,CAC/I,CAAC;oBAEc,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAA;;oBAA9E,OAAO,GAAG,SAAoE;oBAChF,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAElG,IAAI,KAAK,EAAE;wBACD,aAAa,GACf,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACpF,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,OAA5B,gBAAgB,WAAgB,aAAa,EAAC,CAAC;qBACrE;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,OAA/B,gBAAgB,WAAmB,kBAAkB,EAAC,CAAC;qBAC7E;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;qBAC1E;oBAED,sBAAO,gBAAgB,EAAC;;;SAC3B;IACD,MAAM,EAAE,UAAC,KAA2B;QACxB,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,SAA+B,EAAE,SAA+B;QAC5E,IAAM,aAAa,GAAsC;YACrD,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAAsC;YAC9D,SAAS;YACT,SAAS;YACT,QAAQ;SACX,CAAC;QAEF,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,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,CAChG,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAA4B;QAC9B,IAAA,MAAuB,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,aAAhB,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAiB;QAE3C,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAA2B,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACxD,CAAC,CAAC,WAAW,CAAC,CAClB,CAAC"}
1
+ {"version":3,"file":"ExecuteInsight.js","sourceRoot":"","sources":["../../src/execution/ExecuteInsight.tsx"],"names":[],"mappings":";AAAA,qCAAqC;AACrC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,SAAS,MAAM,cAAc,CAAC;AA+IrC,IAAM,WAAW,GAAoB,UAAC,KAAY;IACtC,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,oBAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,oBAAC,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,aAAa,CAAC,KAA2B;IAC9C,OAAO,KAAK,CAAC,aAAa,IAAI,gBAAgB,CAAC;AACnD,CAAC;AAED,SAAS,WAAW,CAAC,KAA2B;IAC5C,OAAO,KAAK,CAAC,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,IAAM,cAAc,GAAG,YAAY,CACtC,aAAa,CAAuB;IAChC,WAAW,aAAA;IACX,SAAS,EAAE,UAAO,KAAK;;;;;oBAEN,UAAU,GAQnB,KAAK,QARc,EACnB,OAAO,GAOP,KAAK,QAPE,EACP,KAAK,GAML,KAAK,MANA,EACL,UAAU,GAKV,KAAK,WALK,EACV,UAAU,GAIV,KAAK,WAJK,EACV,OAAO,GAGP,KAAK,QAHE,EACP,SAAS,GAET,KAAK,UAFI,EACT,kBAAkB,GAClB,KAAK,mBADa,CACZ;oBACV,SAAS,CACL,OAAO,EACP,wIAAwI,CAC3I,CAAC;oBACF,SAAS,CACL,SAAS,EACT,4IAA4I,CAC/I,CAAC;oBAEc,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAA;;oBAA9E,OAAO,GAAG,SAAoE;oBAE9E,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;oBAE5D,SAAS,GAAG,CACd,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CACtF,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBAErB,gBAAgB,GAAG,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAEnD,IAAI,KAAK,EAAE;wBACD,aAAa,GACf,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACpF,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,OAA5B,gBAAgB,WAAgB,aAAa,EAAC,CAAC;qBACrE;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,OAA/B,gBAAgB,WAAmB,kBAAkB,EAAC,CAAC;qBAC7E;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;qBAC1E;oBAED,sBAAO,gBAAgB,EAAC;;;SAC3B;IACD,MAAM,EAAE,UAAC,KAA2B;QACxB,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,SAA+B,EAAE,SAA+B;QAC5E,IAAM,aAAa,GAAsC;YACrD,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAAsC;YAC9D,SAAS;YACT,SAAS;YACT,QAAQ;SACX,CAAC;QAEF,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,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,CAChG,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAA4B;QAC9B,IAAA,MAAuB,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,aAAhB,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAiB;QAE3C,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAA2B,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACxD,CAAC,CAAC,WAAW,CAAC,CAClB,CAAC"}
@@ -15,12 +15,15 @@ export interface IRawExecuteProps extends IWithLoadingEvents<IRawExecuteProps> {
15
15
  * Specifies whether {@link RawExecute} should load all data from backend or just a particular window - specified by
16
16
  * offset and size of the window.
17
17
  *
18
+ * @remarks
18
19
  * If not specified, all data will be loaded.
19
20
  */
20
21
  window?: DataViewWindow;
21
22
  /**
22
- * Optional name to use for files exported from this component. If you do not specify this, then
23
- * the 'RawExecute' will be used instead.
23
+ * Name to use for files exported from this component.
24
+ *
25
+ * @remarks
26
+ * If you do not specify this, then the 'RawExecute' will be used instead.
24
27
  *
25
28
  * Note: it is also possible to pass custom name to the export function that will be sent via the
26
29
  * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -29,28 +32,36 @@ export interface IRawExecuteProps extends IWithLoadingEvents<IRawExecuteProps> {
29
32
  exportTitle?: string;
30
33
  /**
31
34
  * Indicates whether the executor should trigger execution and loading right after it is
32
- * mounted. If not specified defaults to `true`.
35
+ * mounted.
36
+ *
37
+ * @remarks
38
+ * If not specified defaults to `true`.
33
39
  *
34
40
  * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
35
41
  * to trigger the execution and loading.
36
42
  */
37
43
  loadOnMount?: boolean;
38
44
  /**
39
- * Child component to which rendering is delegated. This is a function that will be called
40
- * every time state of execution and data loading changes.
45
+ * Child component to which rendering is delegated.
46
+ *
47
+ * @remarks
48
+ * This is a function that will be called every time state of execution and data loading changes.
41
49
  *
42
50
  * @param executionResult - execution result, indicating state and/or results
43
51
  */
44
52
  children: (executionResult: WithLoadingResult) => React.ReactElement | null;
45
53
  /**
46
- * Optionally provide component for rendering of the loading state.
54
+ * Provide component for rendering of the loading state.
47
55
  *
56
+ * @remarks
48
57
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
49
58
  * will be called only with a successful result.
50
59
  */
51
60
  LoadingComponent?: IExecuteLoadingComponent;
52
61
  /**
53
- * Optionally provide component for rendering of the error state.
62
+ * Provide component for rendering of the error state.
63
+ *
64
+ * @remarks
54
65
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
55
66
  * will be called only with a successful result.
56
67
  */
@@ -60,6 +71,7 @@ export interface IRawExecuteProps extends IWithLoadingEvents<IRawExecuteProps> {
60
71
  * Raw executor is the most basic React component to drive custom executions to obtain
61
72
  * data from backends.
62
73
  *
74
+ * @remarks
63
75
  * The component accepts an instance of prepared execution and drives all the necessary
64
76
  * APIs and boilerplate needed to obtain a {@link DataViewFacade}.
65
77
  * 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.d.ts","sourceRoot":"","sources":["../../src/execution/RawExecute.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB,CAAC,gBAAgB,CAAC;IAC1E;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;IAE9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AA+BD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,6CAoCP,CAAC"}
1
+ {"version":3,"file":"RawExecute.d.ts","sourceRoot":"","sources":["../../src/execution/RawExecute.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB,CAAC,gBAAgB,CAAC;IAC1E;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;IAE9B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AA+BD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,6CAoCP,CAAC"}
@@ -1,4 +1,4 @@
1
- // (C) 2019 GoodData Corporation
1
+ // (C) 2019-2022 GoodData Corporation
2
2
  import React from "react";
3
3
  import { withExecution } from "./withExecution";
4
4
  import isEqual from "lodash/isEqual";
@@ -27,6 +27,7 @@ function exportTitle(props) {
27
27
  * Raw executor is the most basic React component to drive custom executions to obtain
28
28
  * data from backends.
29
29
  *
30
+ * @remarks
30
31
  * The component accepts an instance of prepared execution and drives all the necessary
31
32
  * APIs and boilerplate needed to obtain a {@link DataViewFacade}.
32
33
  * 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,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,OAAO,MAAM,gBAAgB,CAAC;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,oBAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,oBAAC,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;AACH,MAAM,CAAC,IAAM,UAAU,GAAG,aAAa,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,OAAO,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,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,OAAO,MAAM,gBAAgB,CAAC;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,oBAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,oBAAC,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;AACH,MAAM,CAAC,IAAM,UAAU,GAAG,aAAa,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,OAAO,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,EAGH,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;AA8BF;;;;;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,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;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AA2BF;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,kBAAkB,CA2BnF"}
@@ -1,13 +1,13 @@
1
1
  import { __read, __spread } from "tslib";
2
- // (C) 2019-2021 GoodData Corporation
3
- import { attributeLocalId, isAttribute, MeasureGroupIdentifier, newDimension, newTwoDimensional, } from "@gooddata/sdk-model";
2
+ // (C) 2019-2022 GoodData Corporation
3
+ import { isAttribute, MeasureGroupIdentifier, newDimension, newTwoDimensional, } from "@gooddata/sdk-model";
4
4
  import isEmpty from "lodash/isEmpty";
5
5
  import invariant from "ts-invariant";
6
6
  /**
7
7
  * When caller desires just data series and no slicing, create a single-dim result.
8
8
  */
9
9
  function seriesOnlyDim(seriesBy) {
10
- return [newDimension(seriesBy.filter(isAttribute).map(attributeLocalId).concat(MeasureGroupIdentifier))];
10
+ return [newDimension(__spread(seriesBy.filter(isAttribute), [MeasureGroupIdentifier]))];
11
11
  }
12
12
  /**
13
13
  * When caller desires data series to be sliced further by some attributes (and perhaps with totals as well)
@@ -17,9 +17,7 @@ function seriesOnlyDim(seriesBy) {
17
17
  * - measures & scoping attributes will be in columns (second dim)
18
18
  */
19
19
  function seriesAndSlicesDim(seriesBy, slices, totals) {
20
- var firstDimItems = slices.map(attributeLocalId);
21
- firstDimItems.push.apply(firstDimItems, __spread(totals));
22
- return newTwoDimensional(firstDimItems, seriesBy.filter(isAttribute).map(attributeLocalId).concat(MeasureGroupIdentifier));
20
+ return newTwoDimensional(__spread(slices, totals), __spread(seriesBy.filter(isAttribute), [MeasureGroupIdentifier]));
23
21
  }
24
22
  /**
25
23
  * 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,OAAO,EACH,gBAAgB,EAMhB,WAAW,EAGX,sBAAsB,EACtB,YAAY,EACZ,iBAAiB,GACpB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,SAAS,MAAM,cAAc,CAAC;AA0DrC;;GAEG;AACH,SAAS,aAAa,CAAC,QAA+B;IAClD,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;AAC7G,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACvB,QAA+B,EAC/B,MAAoB,EACpB,MAAgB;IAEhB,IAAM,aAAa,GAAoB,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpE,aAAa,CAAC,IAAI,OAAlB,aAAa,WAAS,MAAM,GAAE;IAE9B,OAAO,iBAAiB,CACpB,aAAa,EACb,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,CACpF,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,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,SAAS,CACL,OAAO,IAAI,SAAS,EACpB,qFAAqF,CACxF,CAAC;IAEF,IAAM,UAAU,GAAG,OAAO,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,oBAAI,MAAM,EAAC,CAAA;SACtB,cAAc,oBAAI,UAAU,GAAE;AACvC,CAAC"}
1
+ {"version":3,"file":"createExecution.js","sourceRoot":"","sources":["../../src/execution/createExecution.ts"],"names":[],"mappings":";AAAA,qCAAqC;AACrC,OAAO,EAKH,WAAW,EAGX,sBAAsB,EACtB,YAAY,EACZ,iBAAiB,GACpB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,SAAS,MAAM,cAAc,CAAC;AA6DrC;;GAEG;AACH,SAAS,aAAa,CAAC,QAA+B;IAClD,OAAO,CAAC,YAAY,UAAK,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAE,sBAAsB,GAAE,CAAC,CAAC;AACrF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACvB,QAA+B,EAC/B,MAAoB,EACpB,MAAgB;IAEhB,OAAO,iBAAiB,UAChB,MAAM,EAAK,MAAM,YACjB,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAE,sBAAsB,GAC3D,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,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,SAAS,CACL,OAAO,IAAI,SAAS,EACpB,qFAAqF,CACxF,CAAC;IAEF,IAAM,UAAU,GAAG,OAAO,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,oBAAI,MAAM,EAAC,CAAA;SACtB,cAAc,oBAAI,UAAU,GAAE;AACvC,CAAC"}
@@ -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"}
@@ -1,10 +1,12 @@
1
1
  import { convertError, useCancelablePromise, } from "../base";
2
2
  /**
3
3
  * This hook provides easy way to export data in your preferred format (csv/xlsx/raw) for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
4
+ *
5
+ * @remarks
4
6
  * As a result, you will receive a string with uri, so you can easily create a download link.
5
7
  * Be aware that execution is re-executed only on dependency list change, not on execution/exportConfig/callbacks change.
6
8
  *
7
- * @beta
9
+ * @public
8
10
  */
9
11
  export function useDataExport(_a, deps) {
10
12
  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,OAAO,EACH,YAAY,EAEZ,oBAAoB,GAGvB,MAAM,SAAS,CAAC;AAcjB;;;;;;GAMG;AACH,MAAM,UAAU,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,oBAAoB,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,YAAY,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"}
1
+ {"version":3,"file":"useDataExport.js","sourceRoot":"","sources":["../../src/execution/useDataExport.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,YAAY,EAEZ,oBAAoB,GAGvB,MAAM,SAAS,CAAC;AAcjB;;;;;;;;GAQG;AACH,MAAM,UAAU,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,oBAAoB,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,YAAY,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"}
@@ -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"}
@@ -1,9 +1,12 @@
1
1
  import { convertError, DataViewFacade, useCancelablePromise, } from "../base";
2
2
  /**
3
3
  * This hook provides easy way to get data for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
4
+ *
5
+ * @remarks
4
6
  * You can use it to create custom visualizations on top of GoodData platform.
5
7
  * Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.
6
8
  *
9
+ * @deprecated use {@link useExecutionDataView} instead
7
10
  * @beta
8
11
  */
9
12
  export function useDataView(_a, deps) {
@@ -1 +1 @@
1
- {"version":3,"file":"useDataView.js","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,YAAY,EACZ,cAAc,EAEd,oBAAoB,GAGvB,MAAM,SAAS,CAAC;AAcjB;;;;;;GAMG;AACH,MAAM,UAAU,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,oBAAoB,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,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,YAAY,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"}
1
+ {"version":3,"file":"useDataView.js","sourceRoot":"","sources":["../../src/execution/useDataView.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,YAAY,EACZ,cAAc,EAEd,oBAAoB,GAGvB,MAAM,SAAS,CAAC;AAgBjB;;;;;;;;;GASG;AACH,MAAM,UAAU,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,oBAAoB,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,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC;qBACD,KAAK,CAAC,UAAC,KAAK;oBACT,MAAM,YAAY,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"}
@@ -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"}
@@ -3,8 +3,11 @@ import { useBackend, useResolveValuesWithPlaceholders, useWorkspace, } from "../
3
3
  import { createExecution } from "./createExecution";
4
4
  /**
5
5
  * This hook provides a simplified interface for creating executions.
6
+ *
7
+ * @remarks
6
8
  * It builds the execution on top of the backend passed to the BackendProvider, and workspace passed to the WorkspaceProvider.
7
9
  *
10
+ * @deprecated use {@link useExecutionDataView} instead
8
11
  * @beta
9
12
  */
10
13
  export function useExecution(config) {
@@ -1 +1 @@
1
- {"version":3,"file":"useExecution.js","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":";AAEA,OAAO,EACH,UAAU,EACV,gCAAgC,EAChC,YAAY,GAMf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AA+DpD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,MAA2B;IACpD,IAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,IAAA,KAAA,OAAgD,gCAAgC,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,eAAe,uBACf,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"}
1
+ {"version":3,"file":"useExecution.js","sourceRoot":"","sources":["../../src/execution/useExecution.ts"],"names":[],"mappings":";AAEA,OAAO,EACH,UAAU,EACV,gCAAgC,EAChC,YAAY,GAMf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAoEpD;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,MAA2B;IACpD,IAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,IAAA,KAAA,OAAgD,gCAAgC,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,eAAe,uBACf,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"}
@@ -3,45 +3,47 @@ import { IAnalyticalBackend, IPreparedExecution } from "@gooddata/sdk-backend-sp
3
3
  import { DataViewWindow } from "./withExecutionLoading";
4
4
  import { DataViewFacade, GoodDataSdkError, UseCancelablePromiseState, AttributesMeasuresOrPlaceholders, AttributesOrPlaceholders, NullableFiltersOrPlaceholders, SortsOrPlaceholders, TotalsOrPlaceholders } from "../base";
5
5
  /**
6
- * @beta
6
+ * @public
7
7
  */
8
8
  export interface IExecutionConfiguration {
9
9
  /**
10
- * Data series will be built using the provided measures that are optionally further scoped for
10
+ * Data series will be built using the provided measures that are further scoped for
11
11
  * elements of the specified attributes.
12
12
  */
13
13
  seriesBy: AttributesMeasuresOrPlaceholders;
14
14
  /**
15
- * Optionally slice all data series by elements of these attributes.
15
+ * Slice all data series by elements of these attributes.
16
16
  */
17
17
  slicesBy?: AttributesOrPlaceholders;
18
18
  /**
19
- * Optionally include these totals among the data slices.
19
+ * Include these totals among the data slices.
20
20
  */
21
21
  totals?: TotalsOrPlaceholders;
22
22
  /**
23
- * Optional filters to apply on server side.
23
+ * Filters to apply on server side.
24
24
  */
25
25
  filters?: NullableFiltersOrPlaceholders;
26
26
  /**
27
- * Optional sorting to apply on server side.
27
+ * Sorting to apply on server side.
28
28
  */
29
29
  sortBy?: SortsOrPlaceholders;
30
30
  /**
31
- * Optional resolution context for composed placeholders.
31
+ * Resolution context for composed placeholders.
32
32
  */
33
33
  placeholdersResolutionContext?: any;
34
34
  /**
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.
35
+ * Informative name of the component.
36
+ *
37
+ * @remarks
38
+ * This value is sent as telemetry information together with the actual execution request.
39
+ * We recommend to set this because it can be useful for diagnostic purposes.
38
40
  *
39
41
  * Defaults 'Execute'.
40
42
  */
41
43
  componentName?: string;
42
44
  }
43
45
  /**
44
- * @beta
46
+ * @public
45
47
  */
46
48
  export interface IUseExecutionDataViewConfig {
47
49
  /**
@@ -49,13 +51,16 @@ export interface IUseExecutionDataViewConfig {
49
51
  */
50
52
  execution?: IPreparedExecution | IExecutionConfiguration;
51
53
  /**
52
- * Optionally, you can define only a specific "window" of data to load.
54
+ * You can define only a specific "window" of data to load.
55
+ *
56
+ * @remarks
53
57
  * This is useful if you want to page data.
54
58
  */
55
59
  window?: DataViewWindow;
56
60
  /**
57
61
  * Backend to work with.
58
62
  *
63
+ * @remarks
59
64
  * Note: the backend must come either from this property or from BackendContext. If you do not specify
60
65
  * backend here, then the executor MUST be rendered within an existing BackendContext.
61
66
  */
@@ -63,6 +68,7 @@ export interface IUseExecutionDataViewConfig {
63
68
  /**
64
69
  * Workspace where execution should be executed.
65
70
  *
71
+ * @remarks
66
72
  * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
67
73
  * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
68
74
  */
@@ -71,7 +77,7 @@ export interface IUseExecutionDataViewConfig {
71
77
  /**
72
78
  * React hook to get data for a specific execution.
73
79
  *
74
- * @beta
80
+ * @public
75
81
  */
76
82
  export declare function useExecutionDataView(config: IUseExecutionDataViewConfig, deps?: React.DependencyList): UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>;
77
83
  //# 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,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;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AASD;;GAEG;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,wBAAgB,oBAAoB,CAChC,MAAM,EAAE,2BAA2B,EACnC,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,GAC5B,yBAAyB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAqC7D"}
@@ -13,7 +13,7 @@ function isExecutionConfiguration(obj) {
13
13
  /**
14
14
  * React hook to get data for a specific execution.
15
15
  *
16
- * @beta
16
+ * @public
17
17
  */
18
18
  export function useExecutionDataView(config, deps) {
19
19
  var _a;
@@ -1 +1 @@
1
- {"version":3,"file":"useExecutionDataView.js","sourceRoot":"","sources":["../../src/execution/useExecutionDataView.ts"],"names":[],"mappings":";AAGA,OAAO,EAGH,gBAAgB,EAChB,kBAAkB,EAElB,gCAAgC,GAMnC,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AA+CpD;;GAEG;AACH,SAAS,wBAAwB,CAAC,GAAY;;IAC1C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAE,GAA+B,0CAAE,QAAQ,CAAA,CAAC;AACzE,CAAC;AAkCD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAChC,MAAmC,EACnC,IAA2B;;IAEnB,IAAA,SAAS,GAAa,MAAM,UAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAY;IACrC,IAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IACzE,IAAM,SAAS,GAAG,kBAAkB,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,OAAgD,gCAAgC,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,eAAe,uBACR,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,WAAW,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;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,OAAO,EAGH,gBAAgB,EAChB,kBAAkB,EAElB,gCAAgC,GAMnC,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAiDpD;;GAEG;AACH,SAAS,wBAAwB,CAAC,GAAY;;IAC1C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAE,GAA+B,0CAAE,QAAQ,CAAA,CAAC;AACzE,CAAC;AAsCD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAChC,MAAmC,EACnC,IAA2B;;IAEnB,IAAA,SAAS,GAAa,MAAM,UAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAY;IACrC,IAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IACzE,IAAM,SAAS,GAAG,kBAAkB,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,OAAgD,gCAAgC,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,eAAe,uBACR,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,WAAW,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;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"}