@gooddata/sdk-ui 8.10.0-alpha.31 → 8.10.0-alpha.34

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 (272) 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 +1 -0
  15. package/dist/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  16. package/dist/base/headerMatching/MappingHeader.d.ts +2 -0
  17. package/dist/base/headerMatching/MappingHeader.d.ts.map +1 -1
  18. package/dist/base/headerMatching/MappingHeader.js +1 -1
  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/react/BackendContext.d.ts +4 -0
  29. package/dist/base/react/BackendContext.d.ts.map +1 -1
  30. package/dist/base/react/BackendContext.js +5 -1
  31. package/dist/base/react/BackendContext.js.map +1 -1
  32. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
  33. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  34. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
  35. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  36. package/dist/base/react/ErrorComponent.d.ts +4 -2
  37. package/dist/base/react/ErrorComponent.d.ts.map +1 -1
  38. package/dist/base/react/ErrorComponent.js +5 -3
  39. package/dist/base/react/ErrorComponent.js.map +1 -1
  40. package/dist/base/react/LoadingComponent.d.ts +4 -2
  41. package/dist/base/react/LoadingComponent.d.ts.map +1 -1
  42. package/dist/base/react/LoadingComponent.js +5 -3
  43. package/dist/base/react/LoadingComponent.js.map +1 -1
  44. package/dist/base/react/WorkspaceContext.d.ts +4 -0
  45. package/dist/base/react/WorkspaceContext.d.ts.map +1 -1
  46. package/dist/base/react/WorkspaceContext.js +5 -1
  47. package/dist/base/react/WorkspaceContext.js.map +1 -1
  48. package/dist/base/react/placeholders/base.d.ts +75 -41
  49. package/dist/base/react/placeholders/base.d.ts.map +1 -1
  50. package/dist/base/react/placeholders/base.js +1 -1
  51. package/dist/base/react/placeholders/base.js.map +1 -1
  52. package/dist/base/react/placeholders/factory.d.ts +4 -2
  53. package/dist/base/react/placeholders/factory.d.ts.map +1 -1
  54. package/dist/base/react/placeholders/factory.js +1 -1
  55. package/dist/base/react/placeholders/factory.js.map +1 -1
  56. package/dist/base/react/placeholders/hooks.d.ts +8 -0
  57. package/dist/base/react/placeholders/hooks.d.ts.map +1 -1
  58. package/dist/base/react/placeholders/hooks.js +9 -1
  59. package/dist/base/react/placeholders/hooks.js.map +1 -1
  60. package/dist/base/react/useCancelablePromise.d.ts +16 -10
  61. package/dist/base/react/useCancelablePromise.d.ts.map +1 -1
  62. package/dist/base/react/useCancelablePromise.js +9 -3
  63. package/dist/base/react/useCancelablePromise.js.map +1 -1
  64. package/dist/base/react/useCancelablePromiseUtils.d.ts +4 -2
  65. package/dist/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  66. package/dist/base/react/useCancelablePromiseUtils.js +5 -3
  67. package/dist/base/react/useCancelablePromiseUtils.js.map +1 -1
  68. package/dist/base/results/dataAccess.d.ts +29 -8
  69. package/dist/base/results/dataAccess.d.ts.map +1 -1
  70. package/dist/base/results/dataAccessConfig.d.ts +4 -1
  71. package/dist/base/results/dataAccessConfig.d.ts.map +1 -1
  72. package/dist/base/results/dataAccessConfig.js +4 -1
  73. package/dist/base/results/dataAccessConfig.js.map +1 -1
  74. package/dist/base/results/facade.d.ts +8 -2
  75. package/dist/base/results/facade.d.ts.map +1 -1
  76. package/dist/base/results/facade.js +9 -3
  77. package/dist/base/results/facade.js.map +1 -1
  78. package/dist/base/results/internal/definitionMethods.d.ts +1 -1
  79. package/dist/base/results/internal/definitionMethods.js +1 -1
  80. package/dist/base/results/internal/resultDataMethods.d.ts +1 -1
  81. package/dist/base/results/internal/resultMetaMethods.d.ts +1 -1
  82. package/dist/base/results/internal/resultMetaMethods.js +1 -1
  83. package/dist/base/vis/DrillEvents.d.ts +2 -0
  84. package/dist/base/vis/DrillEvents.d.ts.map +1 -1
  85. package/dist/base/vis/DrillEvents.js.map +1 -1
  86. package/dist/base/vis/VisualizationProps.d.ts +11 -4
  87. package/dist/base/vis/VisualizationProps.d.ts.map +1 -1
  88. package/dist/base/vis/VisualizationProps.js +1 -1
  89. package/dist/execution/Execute.d.ts +34 -18
  90. package/dist/execution/Execute.d.ts.map +1 -1
  91. package/dist/execution/Execute.js +6 -4
  92. package/dist/execution/Execute.js.map +1 -1
  93. package/dist/execution/ExecuteInsight.d.ts +47 -16
  94. package/dist/execution/ExecuteInsight.d.ts.map +1 -1
  95. package/dist/execution/ExecuteInsight.js +7 -5
  96. package/dist/execution/ExecuteInsight.js.map +1 -1
  97. package/dist/execution/RawExecute.d.ts +19 -7
  98. package/dist/execution/RawExecute.d.ts.map +1 -1
  99. package/dist/execution/RawExecute.js +2 -1
  100. package/dist/execution/RawExecute.js.map +1 -1
  101. package/dist/execution/createExecution.d.ts +8 -5
  102. package/dist/execution/createExecution.d.ts.map +1 -1
  103. package/dist/execution/createExecution.js.map +1 -1
  104. package/dist/execution/useDataExport.d.ts +5 -3
  105. package/dist/execution/useDataExport.d.ts.map +1 -1
  106. package/dist/execution/useDataExport.js +3 -1
  107. package/dist/execution/useDataExport.js.map +1 -1
  108. package/dist/execution/useDataView.d.ts +5 -0
  109. package/dist/execution/useDataView.d.ts.map +1 -1
  110. package/dist/execution/useDataView.js +3 -0
  111. package/dist/execution/useDataView.js.map +1 -1
  112. package/dist/execution/useExecution.d.ts +16 -8
  113. package/dist/execution/useExecution.d.ts.map +1 -1
  114. package/dist/execution/useExecution.js +3 -0
  115. package/dist/execution/useExecution.js.map +1 -1
  116. package/dist/execution/useExecutionDataView.d.ts +18 -12
  117. package/dist/execution/useExecutionDataView.d.ts.map +1 -1
  118. package/dist/execution/useExecutionDataView.js +1 -1
  119. package/dist/execution/useExecutionDataView.js.map +1 -1
  120. package/dist/execution/useInsightDataView.d.ts +29 -7
  121. package/dist/execution/useInsightDataView.d.ts.map +1 -1
  122. package/dist/execution/useInsightDataView.js +5 -4
  123. package/dist/execution/useInsightDataView.js.map +1 -1
  124. package/dist/execution/withExecution.d.ts +5 -4
  125. package/dist/execution/withExecution.d.ts.map +1 -1
  126. package/dist/execution/withExecution.js +1 -1
  127. package/dist/execution/withExecution.js.map +1 -1
  128. package/dist/execution/withExecutionLoading.d.ts +12 -7
  129. package/dist/execution/withExecutionLoading.d.ts.map +1 -1
  130. package/dist/execution/withExecutionLoading.js +1 -1
  131. package/dist/execution/withExecutionLoading.js.map +1 -1
  132. package/dist/kpi/Kpi.d.ts +13 -9
  133. package/dist/kpi/Kpi.d.ts.map +1 -1
  134. package/dist/kpi/Kpi.js +5 -3
  135. package/dist/kpi/Kpi.js.map +1 -1
  136. package/dist/sdk-ui.d.ts +413 -177
  137. package/esm/base/errors/GoodDataSdkError.d.ts +4 -1
  138. package/esm/base/errors/GoodDataSdkError.d.ts.map +1 -1
  139. package/esm/base/errors/GoodDataSdkError.js +5 -2
  140. package/esm/base/errors/GoodDataSdkError.js.map +1 -1
  141. package/esm/base/errors/errorHandling.d.ts +5 -3
  142. package/esm/base/errors/errorHandling.d.ts.map +1 -1
  143. package/esm/base/errors/errorHandling.js +6 -4
  144. package/esm/base/errors/errorHandling.js.map +1 -1
  145. package/esm/base/headerMatching/HeaderPredicate.d.ts +5 -1
  146. package/esm/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  147. package/esm/base/headerMatching/HeaderPredicate.js.map +1 -1
  148. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  149. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  150. package/esm/base/headerMatching/HeaderPredicateFactory.js +1 -0
  151. package/esm/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  152. package/esm/base/headerMatching/MappingHeader.d.ts +2 -0
  153. package/esm/base/headerMatching/MappingHeader.d.ts.map +1 -1
  154. package/esm/base/headerMatching/MappingHeader.js +1 -1
  155. package/esm/base/headerMatching/MappingHeader.js.map +1 -1
  156. package/esm/base/helpers/CatalogHelper.d.ts +5 -3
  157. package/esm/base/helpers/CatalogHelper.d.ts.map +1 -1
  158. package/esm/base/helpers/CatalogHelper.js +5 -3
  159. package/esm/base/helpers/CatalogHelper.js.map +1 -1
  160. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  161. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  162. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
  163. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  164. package/esm/base/react/BackendContext.d.ts +4 -0
  165. package/esm/base/react/BackendContext.d.ts.map +1 -1
  166. package/esm/base/react/BackendContext.js +5 -1
  167. package/esm/base/react/BackendContext.js.map +1 -1
  168. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
  169. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  170. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
  171. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  172. package/esm/base/react/ErrorComponent.d.ts +4 -2
  173. package/esm/base/react/ErrorComponent.d.ts.map +1 -1
  174. package/esm/base/react/ErrorComponent.js +5 -3
  175. package/esm/base/react/ErrorComponent.js.map +1 -1
  176. package/esm/base/react/LoadingComponent.d.ts +4 -2
  177. package/esm/base/react/LoadingComponent.d.ts.map +1 -1
  178. package/esm/base/react/LoadingComponent.js +5 -3
  179. package/esm/base/react/LoadingComponent.js.map +1 -1
  180. package/esm/base/react/WorkspaceContext.d.ts +4 -0
  181. package/esm/base/react/WorkspaceContext.d.ts.map +1 -1
  182. package/esm/base/react/WorkspaceContext.js +5 -1
  183. package/esm/base/react/WorkspaceContext.js.map +1 -1
  184. package/esm/base/react/placeholders/base.d.ts +75 -41
  185. package/esm/base/react/placeholders/base.d.ts.map +1 -1
  186. package/esm/base/react/placeholders/base.js +1 -1
  187. package/esm/base/react/placeholders/base.js.map +1 -1
  188. package/esm/base/react/placeholders/factory.d.ts +4 -2
  189. package/esm/base/react/placeholders/factory.d.ts.map +1 -1
  190. package/esm/base/react/placeholders/factory.js +1 -1
  191. package/esm/base/react/placeholders/factory.js.map +1 -1
  192. package/esm/base/react/placeholders/hooks.d.ts +8 -0
  193. package/esm/base/react/placeholders/hooks.d.ts.map +1 -1
  194. package/esm/base/react/placeholders/hooks.js +9 -1
  195. package/esm/base/react/placeholders/hooks.js.map +1 -1
  196. package/esm/base/react/useCancelablePromise.d.ts +16 -10
  197. package/esm/base/react/useCancelablePromise.d.ts.map +1 -1
  198. package/esm/base/react/useCancelablePromise.js +9 -3
  199. package/esm/base/react/useCancelablePromise.js.map +1 -1
  200. package/esm/base/react/useCancelablePromiseUtils.d.ts +4 -2
  201. package/esm/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  202. package/esm/base/react/useCancelablePromiseUtils.js +5 -3
  203. package/esm/base/react/useCancelablePromiseUtils.js.map +1 -1
  204. package/esm/base/results/dataAccess.d.ts +29 -8
  205. package/esm/base/results/dataAccess.d.ts.map +1 -1
  206. package/esm/base/results/dataAccessConfig.d.ts +4 -1
  207. package/esm/base/results/dataAccessConfig.d.ts.map +1 -1
  208. package/esm/base/results/dataAccessConfig.js +4 -1
  209. package/esm/base/results/dataAccessConfig.js.map +1 -1
  210. package/esm/base/results/facade.d.ts +8 -2
  211. package/esm/base/results/facade.d.ts.map +1 -1
  212. package/esm/base/results/facade.js +9 -3
  213. package/esm/base/results/facade.js.map +1 -1
  214. package/esm/base/results/internal/definitionMethods.d.ts +1 -1
  215. package/esm/base/results/internal/definitionMethods.js +1 -1
  216. package/esm/base/results/internal/resultDataMethods.d.ts +1 -1
  217. package/esm/base/results/internal/resultMetaMethods.d.ts +1 -1
  218. package/esm/base/results/internal/resultMetaMethods.js +1 -1
  219. package/esm/base/vis/DrillEvents.d.ts +2 -0
  220. package/esm/base/vis/DrillEvents.d.ts.map +1 -1
  221. package/esm/base/vis/DrillEvents.js.map +1 -1
  222. package/esm/base/vis/VisualizationProps.d.ts +11 -4
  223. package/esm/base/vis/VisualizationProps.d.ts.map +1 -1
  224. package/esm/base/vis/VisualizationProps.js +1 -1
  225. package/esm/execution/Execute.d.ts +34 -18
  226. package/esm/execution/Execute.d.ts.map +1 -1
  227. package/esm/execution/Execute.js +6 -4
  228. package/esm/execution/Execute.js.map +1 -1
  229. package/esm/execution/ExecuteInsight.d.ts +47 -16
  230. package/esm/execution/ExecuteInsight.d.ts.map +1 -1
  231. package/esm/execution/ExecuteInsight.js +7 -5
  232. package/esm/execution/ExecuteInsight.js.map +1 -1
  233. package/esm/execution/RawExecute.d.ts +19 -7
  234. package/esm/execution/RawExecute.d.ts.map +1 -1
  235. package/esm/execution/RawExecute.js +2 -1
  236. package/esm/execution/RawExecute.js.map +1 -1
  237. package/esm/execution/createExecution.d.ts +8 -5
  238. package/esm/execution/createExecution.d.ts.map +1 -1
  239. package/esm/execution/createExecution.js.map +1 -1
  240. package/esm/execution/useDataExport.d.ts +5 -3
  241. package/esm/execution/useDataExport.d.ts.map +1 -1
  242. package/esm/execution/useDataExport.js +3 -1
  243. package/esm/execution/useDataExport.js.map +1 -1
  244. package/esm/execution/useDataView.d.ts +5 -0
  245. package/esm/execution/useDataView.d.ts.map +1 -1
  246. package/esm/execution/useDataView.js +3 -0
  247. package/esm/execution/useDataView.js.map +1 -1
  248. package/esm/execution/useExecution.d.ts +16 -8
  249. package/esm/execution/useExecution.d.ts.map +1 -1
  250. package/esm/execution/useExecution.js +3 -0
  251. package/esm/execution/useExecution.js.map +1 -1
  252. package/esm/execution/useExecutionDataView.d.ts +18 -12
  253. package/esm/execution/useExecutionDataView.d.ts.map +1 -1
  254. package/esm/execution/useExecutionDataView.js +1 -1
  255. package/esm/execution/useExecutionDataView.js.map +1 -1
  256. package/esm/execution/useInsightDataView.d.ts +29 -7
  257. package/esm/execution/useInsightDataView.d.ts.map +1 -1
  258. package/esm/execution/useInsightDataView.js +5 -4
  259. package/esm/execution/useInsightDataView.js.map +1 -1
  260. package/esm/execution/withExecution.d.ts +5 -4
  261. package/esm/execution/withExecution.d.ts.map +1 -1
  262. package/esm/execution/withExecution.js +1 -1
  263. package/esm/execution/withExecution.js.map +1 -1
  264. package/esm/execution/withExecutionLoading.d.ts +12 -7
  265. package/esm/execution/withExecutionLoading.d.ts.map +1 -1
  266. package/esm/execution/withExecutionLoading.js +1 -1
  267. package/esm/execution/withExecutionLoading.js.map +1 -1
  268. package/esm/kpi/Kpi.d.ts +13 -9
  269. package/esm/kpi/Kpi.d.ts.map +1 -1
  270. package/esm/kpi/Kpi.js +5 -3
  271. package/esm/kpi/Kpi.js.map +1 -1
  272. package/package.json +7 -7
@@ -2,12 +2,14 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LoadingComponent = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2007-2021 GoodData Corporation
5
+ // (C) 2007-2022 GoodData Corporation
6
6
  var react_1 = tslib_1.__importDefault(require("react"));
7
7
  var baseAnimationDuration = 1.4;
8
8
  /**
9
- * {@link http://sdk.gooddata.com/gooddata-ui/docs/loading_component.html | LoadingComponent }
10
- * is a component that renders a default loading indicator.
9
+ * Component that renders a default loading indicator.
10
+ *
11
+ * @remarks
12
+ * See {@link http://sdk.gooddata.com/gooddata-ui/docs/loading_component.html | LoadingComponent }
11
13
  *
12
14
  * @public
13
15
  */
@@ -1 +1 @@
1
- {"version":3,"file":"LoadingComponent.js","sourceRoot":"","sources":["../../../src/base/react/LoadingComponent.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,wDAA6C;AAiB7C,IAAM,qBAAqB,GAAG,GAAG,CAAC;AAElC;;;;;GAKG;AACH;IAAsC,4CAA8B;IAApE;;IAkFA,CAAC;IAtEU,iCAAM,GAAb;QACU,IAAA,KAAkF,IAAI,CAAC,KAAK,EAA1F,MAAM,YAAA,EAAE,KAAK,WAAA,EAAE,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,WAAW,iBAAA,EAAE,KAAK,WAAA,EAAE,aAAS,EAAT,KAAK,mBAAG,CAAC,KAAA,EAAE,SAAS,eAAe,CAAC;QACnG,IAAM,QAAQ,GAAG,qBAAqB,GAAG,KAAK,CAAC;QAC/C,IAAM,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC;QAE5B,IAAM,SAAS,GAAkB;YAC7B,eAAe,EAAE,SAAS;YAC1B,SAAS,EAAE,aAAW,QAAQ,eAAY;YAC1C,cAAc,EAAK,KAAK,GAAG,CAAC,MAAG;YAC/B,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,IAAM,aAAa,GAAkB;YACjC,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM;YACxC,aAAa,EAAE,QAAQ;YACvB,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,cAAc,EAAE,QAAQ;YACxB,IAAI,EAAE,UAAU;YAChB,MAAM,QAAA;YACN,KAAK,OAAA;SACR,CAAC;QACF,IAAM,SAAS,GAAkB;YAC7B,SAAS,EAAE,MAAM;YACjB,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,WAAW;SACtB,CAAC;QACF,IAAM,UAAU,GAAkB,SAAS,CAAC;QAC5C,IAAM,UAAU,yCACT,SAAS,KACZ,eAAe,EAAE,UAAU,EAC3B,cAAc,EAAK,KAAK,MAAG,GAC9B,CAAC;QACF,IAAM,UAAU,yCACT,SAAS,KACZ,eAAe,EAAE,UAAU,EAC3B,cAAc,EAAE,GAAG,GACtB,CAAC;QAEF,OAAO,CACH,uCAAK,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa;YAC3C,uCAAK,KAAK,EAAE,SAAS,EAAE,OAAO,EAAC,KAAK,EAAC,CAAC,EAAC,KAAK,EAAC,CAAC,EAAC,KAAK,EAAC,OAAO,EAAC,UAAU;gBACnE,yCAAO,MAAM,EAAE,IAAI,IAAG,qZAWrB,CAAS;gBACV,qCAAG,KAAK,EAAE,UAAU;oBAChB,0CAAQ,EAAE,EAAC,GAAG,EAAC,EAAE,EAAC,GAAG,EAAC,CAAC,EAAC,GAAG,GAAG,CAC9B;gBACJ,qCAAG,KAAK,EAAE,UAAU;oBAChB,0CAAQ,EAAE,EAAC,IAAI,EAAC,EAAE,EAAC,GAAG,EAAC,CAAC,EAAC,GAAG,GAAG,CAC/B;gBACJ,qCAAG,KAAK,EAAE,UAAU;oBAChB,0CAAQ,EAAE,EAAC,IAAI,EAAC,EAAE,EAAC,GAAG,EAAC,CAAC,EAAC,GAAG,GAAG,CAC/B,CACF,CACJ,CACT,CAAC;IACN,CAAC;IAhFa,6BAAY,GAA2B;QACjD,SAAS,EAAE,WAAW;QACtB,KAAK,EAAE,4CAA4C;QACnD,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,CAAC;QACd,UAAU,EAAE,SAAS;KACxB,CAAC;IAwEN,uBAAC;CAAA,AAlFD,CAAsC,eAAK,CAAC,SAAS,GAkFpD;AAlFY,4CAAgB"}
1
+ {"version":3,"file":"LoadingComponent.js","sourceRoot":"","sources":["../../../src/base/react/LoadingComponent.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,wDAA6C;AAiB7C,IAAM,qBAAqB,GAAG,GAAG,CAAC;AAElC;;;;;;;GAOG;AACH;IAAsC,4CAA8B;IAApE;;IAkFA,CAAC;IAtEU,iCAAM,GAAb;QACU,IAAA,KAAkF,IAAI,CAAC,KAAK,EAA1F,MAAM,YAAA,EAAE,KAAK,WAAA,EAAE,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,WAAW,iBAAA,EAAE,KAAK,WAAA,EAAE,aAAS,EAAT,KAAK,mBAAG,CAAC,KAAA,EAAE,SAAS,eAAe,CAAC;QACnG,IAAM,QAAQ,GAAG,qBAAqB,GAAG,KAAK,CAAC;QAC/C,IAAM,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC;QAE5B,IAAM,SAAS,GAAkB;YAC7B,eAAe,EAAE,SAAS;YAC1B,SAAS,EAAE,aAAW,QAAQ,eAAY;YAC1C,cAAc,EAAK,KAAK,GAAG,CAAC,MAAG;YAC/B,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,IAAM,aAAa,GAAkB;YACjC,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM;YACxC,aAAa,EAAE,QAAQ;YACvB,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,cAAc,EAAE,QAAQ;YACxB,IAAI,EAAE,UAAU;YAChB,MAAM,QAAA;YACN,KAAK,OAAA;SACR,CAAC;QACF,IAAM,SAAS,GAAkB;YAC7B,SAAS,EAAE,MAAM;YACjB,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,WAAW;SACtB,CAAC;QACF,IAAM,UAAU,GAAkB,SAAS,CAAC;QAC5C,IAAM,UAAU,yCACT,SAAS,KACZ,eAAe,EAAE,UAAU,EAC3B,cAAc,EAAK,KAAK,MAAG,GAC9B,CAAC;QACF,IAAM,UAAU,yCACT,SAAS,KACZ,eAAe,EAAE,UAAU,EAC3B,cAAc,EAAE,GAAG,GACtB,CAAC;QAEF,OAAO,CACH,uCAAK,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa;YAC3C,uCAAK,KAAK,EAAE,SAAS,EAAE,OAAO,EAAC,KAAK,EAAC,CAAC,EAAC,KAAK,EAAC,CAAC,EAAC,KAAK,EAAC,OAAO,EAAC,UAAU;gBACnE,yCAAO,MAAM,EAAE,IAAI,IAAG,qZAWrB,CAAS;gBACV,qCAAG,KAAK,EAAE,UAAU;oBAChB,0CAAQ,EAAE,EAAC,GAAG,EAAC,EAAE,EAAC,GAAG,EAAC,CAAC,EAAC,GAAG,GAAG,CAC9B;gBACJ,qCAAG,KAAK,EAAE,UAAU;oBAChB,0CAAQ,EAAE,EAAC,IAAI,EAAC,EAAE,EAAC,GAAG,EAAC,CAAC,EAAC,GAAG,GAAG,CAC/B;gBACJ,qCAAG,KAAK,EAAE,UAAU;oBAChB,0CAAQ,EAAE,EAAC,IAAI,EAAC,EAAE,EAAC,GAAG,EAAC,CAAC,EAAC,GAAG,GAAG,CAC/B,CACF,CACJ,CACT,CAAC;IACN,CAAC;IAhFa,6BAAY,GAA2B;QACjD,SAAS,EAAE,WAAW;QACtB,KAAK,EAAE,4CAA4C;QACnD,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,CAAC;QACd,UAAU,EAAE,SAAS;KACxB,CAAC;IAwEN,uBAAC;CAAA,AAlFD,CAAsC,eAAK,CAAC,SAAS,GAkFpD;AAlFY,4CAAgB"}
@@ -17,6 +17,8 @@ export interface IWorkspaceProviderProps {
17
17
  export declare const WorkspaceProvider: React.FC<IWorkspaceProviderProps>;
18
18
  /**
19
19
  * Hook to get workspace instance provided to {@link WorkspaceProvider}.
20
+ *
21
+ * @remarks
20
22
  * You can optionally set a workspace override that will be returned if defined.
21
23
  * This makes the usage more ergonomic (see the following example).
22
24
  *
@@ -37,6 +39,8 @@ export declare const WorkspaceProvider: React.FC<IWorkspaceProviderProps>;
37
39
  export declare const useWorkspace: (workspace?: string | undefined) => string | undefined;
38
40
  /**
39
41
  * Hook to get workspace instance provided to {@link WorkspaceProvider}.
42
+ *
43
+ * @remarks
40
44
  * You can optionally set a workspace override that will be returned if defined.
41
45
  * This makes the usage more ergonomic (see the following example).
42
46
  *
@@ -1 +1 @@
1
- {"version":3,"file":"WorkspaceContext.d.ts","sourceRoot":"","sources":["../../../src/base/react/WorkspaceContext.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAE/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,YAAY,sCAAyB,MAAM,GAAG,SAG1D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,kBAAkB,wDAAyD,MAQvF,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,EAC1D,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,GAClC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAUxB"}
1
+ {"version":3,"file":"WorkspaceContext.d.ts","sourceRoot":"","sources":["../../../src/base/react/WorkspaceContext.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAE/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,YAAY,sCAAyB,MAAM,GAAG,SAG1D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,kBAAkB,wDAAyD,MAQvF,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,EAC1D,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,GAClC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAUxB"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.withWorkspace = exports.useWorkspaceStrict = exports.useWorkspace = exports.WorkspaceProvider = 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 wrapDisplayName_1 = require("./wrapDisplayName");
8
8
  var ts_invariant_1 = tslib_1.__importDefault(require("ts-invariant"));
@@ -19,6 +19,8 @@ exports.WorkspaceProvider = function (_a) {
19
19
  };
20
20
  /**
21
21
  * Hook to get workspace instance provided to {@link WorkspaceProvider}.
22
+ *
23
+ * @remarks
22
24
  * You can optionally set a workspace override that will be returned if defined.
23
25
  * This makes the usage more ergonomic (see the following example).
24
26
  *
@@ -42,6 +44,8 @@ exports.useWorkspace = function (workspace) {
42
44
  };
43
45
  /**
44
46
  * Hook to get workspace instance provided to {@link WorkspaceProvider}.
47
+ *
48
+ * @remarks
45
49
  * You can optionally set a workspace override that will be returned if defined.
46
50
  * This makes the usage more ergonomic (see the following example).
47
51
  *
@@ -1 +1 @@
1
- {"version":3,"file":"WorkspaceContext.js","sourceRoot":"","sources":["../../../src/base/react/WorkspaceContext.tsx"],"names":[],"mappings":";;;;AAAA,gCAAgC;AAChC,wDAA0B;AAC1B,qDAAoD;AACpD,sEAAqC;AAErC,IAAM,gBAAgB,GAAG,eAAK,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;AAC5E,gBAAgB,CAAC,WAAW,GAAG,kBAAkB,CAAC;AAalD;;;;GAIG;AACU,QAAA,iBAAiB,GAAsC,UAAC,EAAuB;QAArB,QAAQ,cAAA,EAAE,SAAS,eAAA;IACtF,OAAO,8BAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,SAAS,IAAG,QAAQ,CAA6B,CAAC;AAC/F,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,YAAY,GAAG,UAAC,SAAkB;IAC3C,IAAM,oBAAoB,GAAG,eAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAChE,OAAO,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,oBAAoB,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,kBAAkB,GAAG,UAAC,SAAkB,EAAE,OAA8B;IAA9B,wBAAA,EAAA,8BAA8B;IACjF,IAAM,oBAAoB,GAAG,eAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAChE,IAAM,kBAAkB,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,oBAAoB,CAAC;IAC7D,sBAAS,CACL,kBAAkB,EACf,OAAO,gIAA6H,CAC1I,CAAC;IACF,OAAO,kBAAkB,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,aAAa,CACzB,SAAiC;IAEjC,IAAM,8BAA8B,GAAgB,UAAC,KAAK;QACtD,OAAO,CACH,8BAAC,gBAAgB,CAAC,QAAQ,QACrB,UAAC,SAAS,YAAK,OAAA,8BAAC,SAAS,uBAAK,KAAK,IAAE,SAAS,QAAE,KAAK,CAAC,SAAS,mCAAI,SAAS,IAAI,CAAA,EAAA,CACzD,CAC/B,CAAC;IACN,CAAC,CAAC;IAEF,OAAO,iCAAe,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC,8BAA8B,CAAC,CAAC;AACvF,CAAC;AAZD,sCAYC"}
1
+ {"version":3,"file":"WorkspaceContext.js","sourceRoot":"","sources":["../../../src/base/react/WorkspaceContext.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,wDAA0B;AAC1B,qDAAoD;AACpD,sEAAqC;AAErC,IAAM,gBAAgB,GAAG,eAAK,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;AAC5E,gBAAgB,CAAC,WAAW,GAAG,kBAAkB,CAAC;AAalD;;;;GAIG;AACU,QAAA,iBAAiB,GAAsC,UAAC,EAAuB;QAArB,QAAQ,cAAA,EAAE,SAAS,eAAA;IACtF,OAAO,8BAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,SAAS,IAAG,QAAQ,CAA6B,CAAC;AAC/F,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,YAAY,GAAG,UAAC,SAAkB;IAC3C,IAAM,oBAAoB,GAAG,eAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAChE,OAAO,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,oBAAoB,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,kBAAkB,GAAG,UAAC,SAAkB,EAAE,OAA8B;IAA9B,wBAAA,EAAA,8BAA8B;IACjF,IAAM,oBAAoB,GAAG,eAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAChE,IAAM,kBAAkB,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,oBAAoB,CAAC;IAC7D,sBAAS,CACL,kBAAkB,EACf,OAAO,gIAA6H,CAC1I,CAAC;IACF,OAAO,kBAAkB,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,aAAa,CACzB,SAAiC;IAEjC,IAAM,8BAA8B,GAAgB,UAAC,KAAK;QACtD,OAAO,CACH,8BAAC,gBAAgB,CAAC,QAAQ,QACrB,UAAC,SAAS,YAAK,OAAA,8BAAC,SAAS,uBAAK,KAAK,IAAE,SAAS,QAAE,KAAK,CAAC,SAAS,mCAAI,SAAS,IAAI,CAAA,EAAA,CACzD,CAC/B,CAAC;IACN,CAAC,CAAC;IAEF,OAAO,iCAAe,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC,8BAA8B,CAAC,CAAC;AACvF,CAAC;AAZD,sCAYC"}
@@ -12,9 +12,11 @@ export declare type AnyPlaceholder<T = any> = IPlaceholder<T> | IComposedPlaceho
12
12
  export declare function isAnyPlaceholder<T>(obj: unknown): obj is AnyPlaceholder<T>;
13
13
  /**
14
14
  * Placeholder represents a reference to a specific part of the execution - attribute(s), measure(s), filter(s), sort(s) or total(s),
15
- * that may change the value at runtime. Then you can provide it to visualizations
16
- * instead of the attributes/measures/filters/sorts/totals themselves - placeholders will be replaced
17
- * with the actual values on the background.
15
+ * that may change the value at runtime.
16
+ *
17
+ * @remarks
18
+ * You can provide it to visualizations instead of the attributes/measures/filters/sorts/totals themselves,
19
+ * placeholders will be replaced with the actual values on the background.
18
20
  *
19
21
  * This allows you:
20
22
  * - share a reference to the same execution elements across multiple components.
@@ -24,9 +26,13 @@ export declare function isAnyPlaceholder<T>(obj: unknown): obj is AnyPlaceholder
24
26
  *
25
27
  * Placeholder values are living in React context and you can obtain/set their values by the following hooks:
26
28
  * - {@link usePlaceholder}
29
+ *
27
30
  * - {@link usePlaceholders}
31
+ *
28
32
  * - {@link useComposedPlaceholder}
33
+ *
29
34
  * - {@link useResolveValueWithPlaceholders}
35
+ *
30
36
  * - {@link useResolveValuesWithPlaceholders}
31
37
  *
32
38
  * Note:
@@ -50,6 +56,8 @@ export declare type IPlaceholder<T> = {
50
56
  export declare function isPlaceholder<T>(obj: unknown): obj is IPlaceholder<T>;
51
57
  /**
52
58
  * Represents placeholder composed from other placeholders.
59
+ *
60
+ * @remarks
53
61
  * You can perform computation on top of resolved placeholder values.
54
62
  * Composed placeholders accepts also other composed placeholders as an input.
55
63
  *
@@ -87,8 +95,10 @@ export declare type IUseComposedPlaceholderHook<T extends IComposedPlaceholder<a
87
95
  /**
88
96
  * Get composed placeholder resolution context type.
89
97
  *
90
- * Examples:
91
- * - IComposedPlaceholder\<any, any, IResolutionContext\> is resolved as IResolutionContext
98
+ * @example
99
+ * ```
100
+ * IComposedPlaceholder\<any, any, IResolutionContext\> is resolved as IResolutionContext
101
+ * ```
92
102
  *
93
103
  * @public
94
104
  */
@@ -96,35 +106,44 @@ export declare type ComposedPlaceholderResolutionContext<T> = T extends ICompose
96
106
  /**
97
107
  * Convert union type to intersection type.
98
108
  *
99
- * Examples:
100
- * - number | string | boolean is resolved as number & string & boolean
101
- * - Type1 | Type2 | Type3 is resolved as Type1 & Type2 & Type3
109
+ * @example
110
+ * ```
111
+ * number | string | boolean is resolved as number & string & boolean
112
+ * Type1 | Type2 | Type3 is resolved as Type1 & Type2 & Type3
113
+ * ```
102
114
  *
103
115
  * @public
104
116
  */
105
117
  export declare type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
106
118
  /**
107
119
  * Flatten array type.
120
+ *
121
+ * @remarks
108
122
  * If the type is not an array, return the same type.
109
123
  * Works only for 1 level, nested array types are not recursively flattened.
110
124
  *
111
- * Examples:
112
- * - number[] is resolved as number
113
- * - string[][] is resolved as string[]
114
- * - string is resolved as string
115
- *
125
+ * @example
126
+ * ```
127
+ * number[] is resolved as number
128
+ * string[][] is resolved as string[]
129
+ * string is resolved as string
130
+ * ```
116
131
  * @public
117
132
  */
118
133
  export declare type Flatten<T> = T extends Array<infer A> ? A : T;
119
134
  /**
120
135
  * Get placeholder value type.
136
+ *
137
+ * @remarks
121
138
  * If the type is not a placeholder, return the same type.
122
139
  *
123
- * Examples:
124
- * - IPlaceholder\<IAttribute\> is resolved as IAttribute
125
- * - IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
126
- * - IComposedPlaceholder\<IMeasure\> is resolved as IMeasure
127
- * - null is resolved as null
140
+ * @example
141
+ * ```
142
+ * IPlaceholder\<IAttribute\> is resolved as IAttribute
143
+ * IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
144
+ * IComposedPlaceholder\<IMeasure\> is resolved as IMeasure
145
+ * null is resolved as null
146
+ * ```
128
147
  *
129
148
  * @public
130
149
  */
@@ -132,9 +151,10 @@ export declare type PlaceholderValue<T> = T extends IPlaceholder<infer A> ? A :
132
151
  /**
133
152
  * Convert tuple of placeholders to tuple of their respective value types.
134
153
  *
135
- * Examples:
136
- * - [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
154
+ * @example
155
+ * [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
137
156
  *
157
+ * @remarks
138
158
  * Check mapped tuple types for more details:
139
159
  * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-1.html#mapped-types-on-tuples-and-arrays
140
160
  *
@@ -145,15 +165,19 @@ export declare type PlaceholdersValues<Tuple extends [...any[]]> = {
145
165
  };
146
166
  /**
147
167
  * Convert any value that may contain placeholders to its resolved value type.
168
+ *
169
+ * @remarks
148
170
  * Nested array placeholders resolved value types are flattened.
149
171
  * If the type is not a placeholder, return the same type.
150
172
  *
151
- * Examples:
152
- * - IPlaceholder\<IAttribute\> is resolved as IAttribute
153
- * - IPlaceholder\<IAttribute\>[] is resolved as IAttribute[]
154
- * - IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
155
- * - [IPlaceholder\<IAttribute[]\>, IPlaceholder\<IMeasure[]\>] is resolved as (IAttribute | IMeasure)[]
156
- * - null is resolved as null
173
+ * @example
174
+ * ```
175
+ * IPlaceholder\<IAttribute\> is resolved as IAttribute
176
+ * IPlaceholder\<IAttribute\>[] is resolved as IAttribute[]
177
+ * IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
178
+ * [IPlaceholder\<IAttribute[]\>, IPlaceholder\<IMeasure[]\>] is resolved as (IAttribute | IMeasure)[]
179
+ * null is resolved as null
180
+ * ```
157
181
  *
158
182
  * @public
159
183
  */
@@ -161,10 +185,13 @@ export declare type PlaceholderResolvedValue<T> = T extends Array<infer A> ? Fla
161
185
  /**
162
186
  * Convert tuple of values that may contain placeholders to tuple of their respective resolved value types.
163
187
  *
164
- * Examples:
165
- * - [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
166
- * - [IPlaceholder\<IMeasure\>, IMeasure] is resolved as [IMeasure, IMeasure]
188
+ * @example
189
+ * ```
190
+ * [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
191
+ * [IPlaceholder\<IMeasure\>, IMeasure] is resolved as [IMeasure, IMeasure]
192
+ * ```
167
193
  *
194
+ * @remarks
168
195
  * Check mapped tuple types for more details:
169
196
  * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-1.html#mapped-types-on-tuples-and-arrays
170
197
  *
@@ -176,17 +203,20 @@ export declare type PlaceholdersResolvedValues<Tuple extends any[]> = {
176
203
  /**
177
204
  * Wrap each member of union type in the array.
178
205
  *
179
- * Examples:
180
- * - IAttribute | IMeasure | IFilter is resolved as IAttribute[] | IMeasure[] | IFilter[]
181
- *
206
+ * @example
207
+ * ```
208
+ * IAttribute | IMeasure | IFilter is resolved as IAttribute[] | IMeasure[] | IFilter[]
209
+ * ```
182
210
  * @public
183
211
  */
184
212
  export declare type ArrayOf<T> = T extends any ? T[] : never;
185
213
  /**
186
214
  * Generate all possible combinations of arrays signatures for the union type.
187
215
  *
188
- * Examples:
189
- * - IAttribute | IMeasure is resolved as IAttribute[] | IMeasure[] | (IAttribute | IMeasure)[]
216
+ * @example
217
+ * ```
218
+ * IAttribute | IMeasure is resolved as IAttribute[] | IMeasure[] | (IAttribute | IMeasure)[]
219
+ * ```
190
220
  *
191
221
  * @public
192
222
  */
@@ -194,8 +224,10 @@ export declare type AnyArrayOf<T> = T[] | ArrayOf<T>;
194
224
  /**
195
225
  * Wrap each member of the union type in AnyPlaceholder.
196
226
  *
197
- * Examples:
198
- * - IAttribute | IMeasure is resolved as AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\>
227
+ * @example
228
+ * ```
229
+ * IAttribute | IMeasure is resolved as AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\>
230
+ * ```
199
231
  *
200
232
  * @public
201
233
  */
@@ -203,10 +235,12 @@ export declare type PlaceholderOf<T> = T extends any ? AnyPlaceholder<T> : never
203
235
  /**
204
236
  * Generate all possible combinations of placeholder signatures for the union type.
205
237
  *
206
- * Examples:
207
- * - IAttribute | IMeasure is resolved as
208
- * AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\> | AnyPlaceholder\<IAttribute | IMeasure\>
209
- *
238
+ * @example
239
+ * ```
240
+ * IAttribute | IMeasure
241
+ * is resolved as
242
+ * AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\> | AnyPlaceholder\<IAttribute | IMeasure\>
243
+ * ```
210
244
  * @public
211
245
  */
212
246
  export declare type AnyPlaceholderOf<T> = AnyPlaceholder<T> | PlaceholderOf<T>;
@@ -225,7 +259,7 @@ export declare type ValuesOrPlaceholders<T> = AnyArrayOf<ValueOrMultiValuePlaceh
225
259
  /**
226
260
  * Generate union of measures from union of measure definitions.
227
261
  *
228
- * Examples:
262
+ * @example
229
263
  * - IMeasureDefinition | IArithmeticMeasureDefinition is resolved as
230
264
  * IMeasure\<IMeasureDefinition\> | IMeasure\<IArithmeticMeasureDefinition\>
231
265
  *
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/base/react/placeholders/base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,cAAc,CAAC,CAAC,GAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAE1F;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAI1E;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,oBAAY,YAAY,CAAC,CAAC,IAAI;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,CAAC,CAAC;IACjB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC9B,GAAG,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAErE;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,oBAAoB,CAAC,OAAO,EAAE,MAAM,SAAS,GAAG,EAAE,EAAE,QAAQ;IACzE,IAAI,EAAE,sBAAsB,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,CAAC,MAAM,EAAE,0BAA0B,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,QAAQ,KAAK,OAAO,CAAC;IACnG,GAAG,EAAE,2BAA2B,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;CACrF;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,SAAS,GAAG,EAAE,EAAE,QAAQ,EACzE,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAKxD;AAED;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,IAAI,MAAM;IACjE,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS;IAC/B,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,IAAI;CAC1F,CAAC;AAEF;;;GAGG;AACH,oBAAY,2BAA2B,CAAC,CAAC,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CACrF,iBAAiB,EAAE,oCAAoC,CAAC,CAAC,CAAC,KACzD,wBAAwB,CAAC,CAAC,CAAC,CAAC;AAEjC;;;;;;;GAOG;AACH,oBAAY,oCAAoC,CAAC,CAAC,IAAI,CAAC,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC,GACxG,QAAQ,GACR,GAAG,CAAC;AAEV;;;;;;;;GAQG;AACH,oBAAY,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,GAAG,GAClG,CAAC,GACD,KAAK,CAAC;AAEZ;;;;;;;;;;;GAWG;AACH,oBAAY,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE1D;;;;;;;;;;;GAWG;AACH,oBAAY,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC3D,CAAC,GACD,CAAC,SAAS,oBAAoB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GACjD,CAAC,GACD,CAAC,CAAC;AAER;;;;;;;;;;GAUG;AACH,oBAAY,kBAAkB,CAAC,KAAK,SAAS,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI;KACtD,KAAK,IAAI,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,oBAAY,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC5D,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,EAAE,GACtC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC/B,CAAC,GACD,CAAC,SAAS,oBAAoB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GACjD,CAAC,GACD,CAAC,CAAC;AAER;;;;;;;;;;;GAWG;AACH,oBAAY,0BAA0B,CAAC,KAAK,SAAS,GAAG,EAAE,IAAI;KACzD,KAAK,IAAI,MAAM,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;CACjE,CAAC;AAEF;;;;;;;GAOG;AACH,oBAAY,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC;AAErD;;;;;;;GAOG;AACH,oBAAY,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C;;;;;;;GAOG;AACH,oBAAY,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAEzE;;;;;;;;GAQG;AACH,oBAAY,gBAAgB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAEvE;;;;GAIG;AACH,oBAAY,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAE5D;;;;GAIG;AACH,oBAAY,oBAAoB,CAAC,CAAC,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC;AAElF;;;;;;;;GAQG;AACH,oBAAY,SAAS,CAAC,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAE9F;;;;GAIG;AACH,oBAAY,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,oBAAY,4BAA4B,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/base/react/placeholders/base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,cAAc,CAAC,CAAC,GAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAE1F;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAI1E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,oBAAY,YAAY,CAAC,CAAC,IAAI;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,CAAC,CAAC;IACjB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC9B,GAAG,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAErE;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,oBAAoB,CAAC,OAAO,EAAE,MAAM,SAAS,GAAG,EAAE,EAAE,QAAQ;IACzE,IAAI,EAAE,sBAAsB,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,CAAC,MAAM,EAAE,0BAA0B,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,QAAQ,KAAK,OAAO,CAAC;IACnG,GAAG,EAAE,2BAA2B,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;CACrF;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,SAAS,GAAG,EAAE,EAAE,QAAQ,EACzE,GAAG,EAAE,OAAO,GACb,GAAG,IAAI,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAKxD;AAED;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,IAAI,MAAM;IACjE,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS;IAC/B,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,IAAI;CAC1F,CAAC;AAEF;;;GAGG;AACH,oBAAY,2BAA2B,CAAC,CAAC,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CACrF,iBAAiB,EAAE,oCAAoC,CAAC,CAAC,CAAC,KACzD,wBAAwB,CAAC,CAAC,CAAC,CAAC;AAEjC;;;;;;;;;GASG;AACH,oBAAY,oCAAoC,CAAC,CAAC,IAAI,CAAC,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC,GACxG,QAAQ,GACR,GAAG,CAAC;AAEV;;;;;;;;;;GAUG;AACH,oBAAY,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,GAAG,GAClG,CAAC,GACD,KAAK,CAAC;AAEZ;;;;;;;;;;;;;;GAcG;AACH,oBAAY,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC3D,CAAC,GACD,CAAC,SAAS,oBAAoB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GACjD,CAAC,GACD,CAAC,CAAC;AAER;;;;;;;;;;;GAWG;AACH,oBAAY,kBAAkB,CAAC,KAAK,SAAS,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI;KACtD,KAAK,IAAI,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,oBAAY,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC5D,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,EAAE,GACtC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC/B,CAAC,GACD,CAAC,SAAS,oBAAoB,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GACjD,CAAC,GACD,CAAC,CAAC;AAER;;;;;;;;;;;;;;GAcG;AACH,oBAAY,0BAA0B,CAAC,KAAK,SAAS,GAAG,EAAE,IAAI;KACzD,KAAK,IAAI,MAAM,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;CACjE,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC;AAErD;;;;;;;;;GASG;AACH,oBAAY,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C;;;;;;;;;GASG;AACH,oBAAY,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAEzE;;;;;;;;;;GAUG;AACH,oBAAY,gBAAgB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAEvE;;;;GAIG;AACH,oBAAY,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAE5D;;;;GAIG;AACH,oBAAY,oBAAoB,CAAC,CAAC,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC;AAElF;;;;;;;;GAQG;AACH,oBAAY,SAAS,CAAC,CAAC,SAAS,sBAAsB,IAAI,CAAC,SAAS,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAE9F;;;;GAIG;AACH,oBAAY,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,oBAAY,4BAA4B,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.isComposedPlaceholder = exports.isPlaceholder = exports.isAnyPlaceholder = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019-2021 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
7
7
  /**
8
8
  * Type-guard testing whether the provided object is an instance of {@link AnyPlaceholder}.
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../src/base/react/placeholders/base.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,mEAAqC;AAUrC;;;GAGG;AACH,SAAgB,gBAAgB,CAAI,GAAY;IAC5C,IAAM,MAAM,GAAkC,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC;IAErF,OAAO,MAAM,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,GAAG,CAAC,EAAT,CAAS,CAAC,CAAC;AAC5C,CAAC;AAJD,4CAIC;AAoCD;;;GAGG;AACH,SAAgB,aAAa,CAAI,GAAY;IACzC,OAAO,CAAC,iBAAO,CAAC,GAAG,CAAC,IAAK,GAAuB,CAAC,IAAI,KAAK,cAAc,CAAC;AAC7E,CAAC;AAFD,sCAEC;AAqBD;;;GAGG;AACH,SAAgB,qBAAqB,CACjC,GAAY;IAEZ,OAAO,CACH,CAAC,iBAAO,CAAC,GAAG,CAAC;QACZ,GAAuD,CAAC,IAAI,KAAK,sBAAsB,CAC3F,CAAC;AACN,CAAC;AAPD,sDAOC"}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["../../../../src/base/react/placeholders/base.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,mEAAqC;AAUrC;;;GAGG;AACH,SAAgB,gBAAgB,CAAI,GAAY;IAC5C,IAAM,MAAM,GAAkC,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC;IAErF,OAAO,MAAM,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,GAAG,CAAC,EAAT,CAAS,CAAC,CAAC;AAC5C,CAAC;AAJD,4CAIC;AA0CD;;;GAGG;AACH,SAAgB,aAAa,CAAI,GAAY;IACzC,OAAO,CAAC,iBAAO,CAAC,GAAG,CAAC,IAAK,GAAuB,CAAC,IAAI,KAAK,cAAc,CAAC;AAC7E,CAAC;AAFD,sCAEC;AAuBD;;;GAGG;AACH,SAAgB,qBAAqB,CACjC,GAAY;IAEZ,OAAO,CACH,CAAC,iBAAO,CAAC,GAAG,CAAC;QACZ,GAAuD,CAAC,IAAI,KAAK,sBAAsB,CAC3F,CAAC;AACN,CAAC;AAPD,sDAOC"}
@@ -6,12 +6,14 @@ import { IPlaceholder, IComposedPlaceholder, PlaceholdersResolvedValues, Compose
6
6
  export interface IPlaceholderOptions<T> {
7
7
  /**
8
8
  * By default, each placeholder has a unique generated id.
9
- * You can optionally provide id of the placeholder which can be useful for debugging.
9
+ *
10
+ * @remarks
11
+ * You can provide id of the placeholder which can be useful for debugging.
10
12
  * Please note that the id should be unique for all your placeholders.
11
13
  */
12
14
  id?: string;
13
15
  /**
14
- * Optionally provide function to validate the placeholder value.
16
+ * Provide function to validate the placeholder value.
15
17
  */
16
18
  validate?: (value?: T) => void;
17
19
  }
@@ -1 +1 @@
1
- {"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../src/base/react/placeholders/factory.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,YAAY,EACZ,oBAAoB,EACpB,0BAA0B,EAC1B,oCAAoC,EACpC,OAAO,EACP,mBAAmB,EACtB,MAAM,QAAQ,CAAC;AAEhB;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IAClC;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;CAClC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,OAAO,GAAE,mBAAmB,CAAC,CAAC,CAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAWzG;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAClC,MAAM,SAAS,GAAG,EAAE,EACpB,OAAO,GAAG,0BAA0B,CAAC,MAAM,CAAC,EAG5C,QAAQ,GAAG,mBAAmB,CAAC,oCAAoC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAErF,YAAY,EAAE,CAAC,GAAG,MAAM,CAAC,EACzB,YAAY,GAAE,CACV,MAAM,EAAE,0BAA0B,CAAC,MAAM,CAAC,EAC1C,iBAAiB,EAAE,QAAQ,KAC1B,OAAkB,GACxB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CASjD"}
1
+ {"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../src/base/react/placeholders/factory.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,YAAY,EACZ,oBAAoB,EACpB,0BAA0B,EAC1B,oCAAoC,EACpC,OAAO,EACP,mBAAmB,EACtB,MAAM,QAAQ,CAAC;AAEhB;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IAClC;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;CAClC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,EAAE,OAAO,GAAE,mBAAmB,CAAC,CAAC,CAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAWzG;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAClC,MAAM,SAAS,GAAG,EAAE,EACpB,OAAO,GAAG,0BAA0B,CAAC,MAAM,CAAC,EAG5C,QAAQ,GAAG,mBAAmB,CAAC,oCAAoC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAErF,YAAY,EAAE,CAAC,GAAG,MAAM,CAAC,EACzB,YAAY,GAAE,CACV,MAAM,EAAE,0BAA0B,CAAC,MAAM,CAAC,EAC1C,iBAAiB,EAAE,QAAQ,KAC1B,OAAkB,GACxB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CASjD"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.newComposedPlaceholder = exports.newPlaceholder = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019-2021 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var uuid_1 = require("uuid");
7
7
  var identity_1 = tslib_1.__importDefault(require("lodash/identity"));
8
8
  var hooks_1 = require("./hooks");
@@ -1 +1 @@
1
- {"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../src/base/react/placeholders/factory.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,6BAAoC;AACpC,qEAAuC;AASvC,iCAAiE;AAmBjE;;;;;GAKG;AACH,SAAgB,cAAc,CAAI,YAAgB,EAAE,OAAoC;IAApC,wBAAA,EAAA,YAAoC;IAC5E,IAAA,EAAE,GAAe,OAAO,GAAtB,EAAE,QAAQ,GAAK,OAAO,SAAZ,CAAa;IACjC,IAAM,WAAW,GAAoB;QACjC,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,SAAM,EAAE;QAClB,YAAY,cAAA;QACZ,QAAQ,UAAA;QACR,GAAG,EAAE,cAAM,OAAA,sBAAc,CAAC,WAAW,CAAC,EAA3B,CAA2B;KACzC,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AAXD,wCAWC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAOlC,YAAyB,EACzB,YAGuB;IAHvB,6BAAA,EAAA,eAGe,kBAAQ;IAEvB,IAAM,WAAW,GAAoD;QACjE,IAAI,EAAE,sBAAsB;QAC5B,YAAY,cAAA;QACZ,YAAY,cAAA;QACZ,GAAG,EAAE,UAAC,iBAA2B,IAAK,OAAA,8BAAsB,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAtD,CAAsD;KAC/F,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AArBD,wDAqBC"}
1
+ {"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../src/base/react/placeholders/factory.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,6BAAoC;AACpC,qEAAuC;AASvC,iCAAiE;AAqBjE;;;;;GAKG;AACH,SAAgB,cAAc,CAAI,YAAgB,EAAE,OAAoC;IAApC,wBAAA,EAAA,YAAoC;IAC5E,IAAA,EAAE,GAAe,OAAO,GAAtB,EAAE,QAAQ,GAAK,OAAO,SAAZ,CAAa;IACjC,IAAM,WAAW,GAAoB;QACjC,IAAI,EAAE,cAAc;QACpB,EAAE,EAAE,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,SAAM,EAAE;QAClB,YAAY,cAAA;QACZ,QAAQ,UAAA;QACR,GAAG,EAAE,cAAM,OAAA,sBAAc,CAAC,WAAW,CAAC,EAA3B,CAA2B;KACzC,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AAXD,wCAWC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAOlC,YAAyB,EACzB,YAGuB;IAHvB,6BAAA,EAAA,eAGe,kBAAQ;IAEvB,IAAM,WAAW,GAAoD;QACjE,IAAI,EAAE,sBAAsB;QAC5B,YAAY,cAAA;QACZ,YAAY,cAAA;QACZ,GAAG,EAAE,UAAC,iBAA2B,IAAK,OAAA,8BAAsB,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAtD,CAAsD;KAC/F,CAAC;IAEF,OAAO,WAAW,CAAC;AACvB,CAAC;AArBD,wDAqBC"}
@@ -2,6 +2,8 @@ import { ValueOrUpdateCallback } from "@gooddata/sdk-backend-base";
2
2
  import { IPlaceholder, IComposedPlaceholder, PlaceholderValue, PlaceholdersValues, PlaceholderResolvedValue, PlaceholdersResolvedValues } from "./base";
3
3
  /**
4
4
  * React hook to obtain/set placeholder value.
5
+ *
6
+ * @remarks
5
7
  * See {@link IPlaceholder}.
6
8
  *
7
9
  * Note: When placeholder is not provided, setting its value will result in the error.
@@ -14,6 +16,8 @@ export declare function usePlaceholder<T extends IPlaceholder<any>>(placeholder?
14
16
  ];
15
17
  /**
16
18
  * React hook to obtain/set multiple placeholder values at once.
19
+ *
20
+ * @remarks
17
21
  * This is useful to perform placeholders atomic change.
18
22
  * See {@link IPlaceholder}.
19
23
  * @public
@@ -29,6 +33,8 @@ export declare function usePlaceholders<T extends IPlaceholder<any>[]>(placehold
29
33
  export declare function useComposedPlaceholder<TContext, TPlaceholder extends IComposedPlaceholder<any, any, TContext>>(placeholder: TPlaceholder, resolutionContext?: TContext): PlaceholderResolvedValue<TPlaceholder>;
30
34
  /**
31
35
  * React hook that resolves any value(s) that can possibly contain also placeholder(s) to actual value(s).
36
+ *
37
+ * @remarks
32
38
  * Optionally provide custom context for the composed placeholders resolution.
33
39
  *
34
40
  * @public
@@ -36,6 +42,8 @@ export declare function useComposedPlaceholder<TContext, TPlaceholder extends IC
36
42
  export declare function useResolveValueWithPlaceholders<T, C>(value: T, resolutionContext?: C): PlaceholderResolvedValue<T>;
37
43
  /**
38
44
  * React hook that resolves multiple value(s) that can possibly contain also placeholder(s) to actual value(s).
45
+ *
46
+ * @remarks
39
47
  * Optionally provide custom context for the composed placeholders resolution.
40
48
  *
41
49
  * @public
@@ -1 +1 @@
1
- {"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../src/base/react/placeholders/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EACH,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,0BAA0B,EAE7B,MAAM,QAAQ,CAAC;AAUhB;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,EACtD,WAAW,CAAC,EAAE,CAAC,GAChB;IACC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS;IAC/B,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,IAAI;CAC1F,CA+BA;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,EAAE,EACzD,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC,GACrB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CA8BxG;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAClC,QAAQ,EACR,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,EAC/D,WAAW,EAAE,YAAY,EAAE,iBAAiB,CAAC,EAAE,QAAQ,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAQjG;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,CAAC,EAAE,CAAC,EAChD,KAAK,EAAE,CAAC,EACR,iBAAiB,CAAC,EAAE,CAAC,GACtB,wBAAwB,CAAC,CAAC,CAAC,CAI7B;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAC/D,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EACd,iBAAiB,CAAC,EAAE,CAAC,GACtB,0BAA0B,CAAC,CAAC,CAAC,CAM/B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAI/C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAuBxE"}
1
+ {"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../src/base/react/placeholders/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EACH,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,wBAAwB,EACxB,0BAA0B,EAE7B,MAAM,QAAQ,CAAC;AAUhB;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,EACtD,WAAW,CAAC,EAAE,CAAC,GAChB;IACC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS;IAC/B,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,IAAI;CAC1F,CA+BA;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,EAAE,EACzD,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC,GACrB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CA8BxG;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAClC,QAAQ,EACR,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,EAC/D,WAAW,EAAE,YAAY,EAAE,iBAAiB,CAAC,EAAE,QAAQ,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAQjG;AAED;;;;;;;GAOG;AACH,wBAAgB,+BAA+B,CAAC,CAAC,EAAE,CAAC,EAChD,KAAK,EAAE,CAAC,EACR,iBAAiB,CAAC,EAAE,CAAC,GACtB,wBAAwB,CAAC,CAAC,CAAC,CAI7B;AAED;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAC/D,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EACd,iBAAiB,CAAC,EAAE,CAAC,GACtB,0BAA0B,CAAC,CAAC,CAAC,CAM/B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAI/C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAuBxE"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.useMultiValueMemoStringify = exports.useMemoStringify = exports.useResolveValuesWithPlaceholders = exports.useResolveValueWithPlaceholders = exports.useComposedPlaceholder = exports.usePlaceholders = exports.usePlaceholder = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019-2021 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var react_1 = require("react");
7
7
  var json_stable_stringify_1 = tslib_1.__importDefault(require("json-stable-stringify"));
8
8
  var base_1 = require("./base");
@@ -11,6 +11,8 @@ var ts_invariant_1 = tslib_1.__importDefault(require("ts-invariant"));
11
11
  var resolve_1 = require("./resolve");
12
12
  /**
13
13
  * React hook to obtain/set placeholder value.
14
+ *
15
+ * @remarks
14
16
  * See {@link IPlaceholder}.
15
17
  *
16
18
  * Note: When placeholder is not provided, setting its value will result in the error.
@@ -37,6 +39,8 @@ function usePlaceholder(placeholder) {
37
39
  exports.usePlaceholder = usePlaceholder;
38
40
  /**
39
41
  * React hook to obtain/set multiple placeholder values at once.
42
+ *
43
+ * @remarks
40
44
  * This is useful to perform placeholders atomic change.
41
45
  * See {@link IPlaceholder}.
42
46
  * @public
@@ -78,6 +82,8 @@ function useComposedPlaceholder(placeholder, resolutionContext) {
78
82
  exports.useComposedPlaceholder = useComposedPlaceholder;
79
83
  /**
80
84
  * React hook that resolves any value(s) that can possibly contain also placeholder(s) to actual value(s).
85
+ *
86
+ * @remarks
81
87
  * Optionally provide custom context for the composed placeholders resolution.
82
88
  *
83
89
  * @public
@@ -90,6 +96,8 @@ function useResolveValueWithPlaceholders(value, resolutionContext) {
90
96
  exports.useResolveValueWithPlaceholders = useResolveValueWithPlaceholders;
91
97
  /**
92
98
  * React hook that resolves multiple value(s) that can possibly contain also placeholder(s) to actual value(s).
99
+ *
100
+ * @remarks
93
101
  * Optionally provide custom context for the composed placeholders resolution.
94
102
  *
95
103
  * @public
@@ -1 +1 @@
1
- {"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../../src/base/react/placeholders/hooks.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,+BAAqD;AACrD,wFAAoD;AAEpD,+BAQgB;AAChB,qCAAsE;AACtE,sEAAqC;AACrC,qCAKmB;AAEnB;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC1B,WAAe;IAKT,IAAA,KAAyB,gCAAsB,EAAE,EAA/C,KAAK,WAAA,EAAE,WAAW,iBAA6B,CAAC;IACxD,IAAM,wBAAwB,GAAG,oBAAa,CAAC,WAAW,CAAC;QACvD,CAAC,CAAC,iCAAuB,CAAC,WAAW,EAAE,KAAK,CAAC;QAC7C,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAM,mBAAmB,GAAG,mBAAW,CACnC,UAAC,qBAA6E;QAC1E,WAAW,CAAC,UAAC,CAAC;YACV,sBAAS,CACL,oBAAa,CAAC,WAAW,CAAC,EAC1B,qFAAqF,CACxF,CAAC;YAEF,IAAM,uBAAuB,GAAG,iCAAuB,CACnD,WAAW,EACX,CAAC,CACmB,CAAC;YAEzB,IAAM,YAAY,GACd,qBAAqB,YAAY,QAAQ;gBACrC,CAAC,CAAC,qBAAqB,CAAC,uBAAuB,CAAC;gBAChD,CAAC,CAAC,qBAAqB,CAAC;YAEhC,OAAO,wBAAc,CAAC,WAAW,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACP,CAAC,EACD,EAAE,CACL,CAAC;IAEF,OAAO,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;AAC3D,CAAC;AApCD,wCAoCC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAC3B,YAAoB;IAEd,IAAA,KAAyB,gCAAsB,EAAE,EAA/C,KAAK,WAAA,EAAE,WAAW,iBAA6B,CAAC;IAExD,IAAM,yBAAyB,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,WAAW;QAC3D,OAAA,iCAAuB,CAAC,WAAW,EAAE,KAAK,CAAC;IAA3C,CAA2C,CACrB,CAAC;IAE3B,IAAM,sBAAsB,GAAG,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;IAErF,IAAM,oBAAoB,GAAG,mBAAW,CACpC,UAAC,qBAAmE;QAChE,WAAW,CAAC,UAAC,CAAC;YACV,IAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,WAAW;gBAChD,OAAA,iCAAuB,CAAC,WAAW,EAAE,CAAC,CAAC;YAAvC,CAAuC,CACjB,CAAC;YAE3B,IAAM,aAAa,GACf,OAAO,qBAAqB,KAAK,UAAU;gBACvC,CAAC,CAAC,qBAAqB,CAAC,cAAc,CAAC;gBACvC,CAAC,CAAC,qBAAqB,CAAC;YAEhC,OAAO,YAAY,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,WAAW,EAAE,CAAC;gBAC3C,OAAO,wBAAc,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC9D,CAAC,EAAE,CAAC,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACP,CAAC,EACD,EAAE,CACL,CAAC;IAEF,OAAO,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;AAC1D,CAAC;AAhCD,0CAgCC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAGpC,WAAyB,EAAE,iBAA4B;IAC7C,IAAA,KAAK,GAAK,gCAAsB,EAAE,MAA7B,CAA8B;IAC3C,IAAM,aAAa,GAAG,yCAA+B,CACjD,WAAW,EACX,KAAK,EACL,iBAAiB,CACsB,CAAC;IAC5C,OAAO,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC;AAXD,wDAWC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAC3C,KAAQ,EACR,iBAAqB;IAEb,IAAA,KAAK,GAAK,gCAAsB,EAAE,MAA7B,CAA8B;IAC3C,IAAM,aAAa,GAAG,sCAA4B,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;IACpF,OAAO,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC;AAPD,0EAOC;AAED;;;;;GAKG;AACH,SAAgB,gCAAgC,CAC5C,MAAc,EACd,iBAAqB;IAEb,IAAA,KAAK,GAAK,gCAAsB,EAAE,MAA7B,CAA8B;IAC3C,IAAM,cAAc,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,UAAC,KAAK;QACrC,OAAA,sCAA4B,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC;IAA7D,CAA6D,CAC/B,CAAC;IACnC,OAAO,0BAA0B,CAAC,cAAc,CAAC,CAAC;AACtD,CAAC;AATD,4EASC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAI,KAAQ;IACxC,OAAO,eAAO,CAAC;QACX,OAAO,KAAK,CAAC;IACjB,CAAC,EAAE,CAAC,+BAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAJD,4CAIC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CAAkB,MAAS;;IACjE,IAAM,UAAU,GAAG,cAAM,OACrB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC;QAChB,IAAI,EAAE,+BAAe,CAAC,CAAC,CAAC;QACxB,KAAK,EAAE,CAAC;KACX,CAAC,EAHiB,CAGjB,oCAAK,EAAE,CACZ,CAAC;IAEF,OAAO,eAAO,CAAC;QACX,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,UAAC,GAAG,EAAE,GAAG;YACxB,IAAM,IAAI,GAAG,+BAAe,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;gBACvC,OAAO,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC;aACxC;YAED,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;gBACtB,IAAI,MAAA;gBACJ,KAAK,EAAE,GAAG;aACb,CAAC;YAEF,OAAO,GAAG,CAAC;QACf,CAAC,CAAM,CAAC;IACZ,CAAC,EAAE,CAAC,+BAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAvBD,gEAuBC"}
1
+ {"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../../src/base/react/placeholders/hooks.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,+BAAqD;AACrD,wFAAoD;AAEpD,+BAQgB;AAChB,qCAAsE;AACtE,sEAAqC;AACrC,qCAKmB;AAEnB;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAC1B,WAAe;IAKT,IAAA,KAAyB,gCAAsB,EAAE,EAA/C,KAAK,WAAA,EAAE,WAAW,iBAA6B,CAAC;IACxD,IAAM,wBAAwB,GAAG,oBAAa,CAAC,WAAW,CAAC;QACvD,CAAC,CAAC,iCAAuB,CAAC,WAAW,EAAE,KAAK,CAAC;QAC7C,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAM,mBAAmB,GAAG,mBAAW,CACnC,UAAC,qBAA6E;QAC1E,WAAW,CAAC,UAAC,CAAC;YACV,sBAAS,CACL,oBAAa,CAAC,WAAW,CAAC,EAC1B,qFAAqF,CACxF,CAAC;YAEF,IAAM,uBAAuB,GAAG,iCAAuB,CACnD,WAAW,EACX,CAAC,CACmB,CAAC;YAEzB,IAAM,YAAY,GACd,qBAAqB,YAAY,QAAQ;gBACrC,CAAC,CAAC,qBAAqB,CAAC,uBAAuB,CAAC;gBAChD,CAAC,CAAC,qBAAqB,CAAC;YAEhC,OAAO,wBAAc,CAAC,WAAW,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACP,CAAC,EACD,EAAE,CACL,CAAC;IAEF,OAAO,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;AAC3D,CAAC;AApCD,wCAoCC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAC3B,YAAoB;IAEd,IAAA,KAAyB,gCAAsB,EAAE,EAA/C,KAAK,WAAA,EAAE,WAAW,iBAA6B,CAAC;IAExD,IAAM,yBAAyB,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,WAAW;QAC3D,OAAA,iCAAuB,CAAC,WAAW,EAAE,KAAK,CAAC;IAA3C,CAA2C,CACrB,CAAC;IAE3B,IAAM,sBAAsB,GAAG,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;IAErF,IAAM,oBAAoB,GAAG,mBAAW,CACpC,UAAC,qBAAmE;QAChE,WAAW,CAAC,UAAC,CAAC;YACV,IAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,WAAW;gBAChD,OAAA,iCAAuB,CAAC,WAAW,EAAE,CAAC,CAAC;YAAvC,CAAuC,CACjB,CAAC;YAE3B,IAAM,aAAa,GACf,OAAO,qBAAqB,KAAK,UAAU;gBACvC,CAAC,CAAC,qBAAqB,CAAC,cAAc,CAAC;gBACvC,CAAC,CAAC,qBAAqB,CAAC;YAEhC,OAAO,YAAY,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,WAAW,EAAE,CAAC;gBAC3C,OAAO,wBAAc,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC9D,CAAC,EAAE,CAAC,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACP,CAAC,EACD,EAAE,CACL,CAAC;IAEF,OAAO,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;AAC1D,CAAC;AAhCD,0CAgCC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAGpC,WAAyB,EAAE,iBAA4B;IAC7C,IAAA,KAAK,GAAK,gCAAsB,EAAE,MAA7B,CAA8B;IAC3C,IAAM,aAAa,GAAG,yCAA+B,CACjD,WAAW,EACX,KAAK,EACL,iBAAiB,CACsB,CAAC;IAC5C,OAAO,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC;AAXD,wDAWC;AAED;;;;;;;GAOG;AACH,SAAgB,+BAA+B,CAC3C,KAAQ,EACR,iBAAqB;IAEb,IAAA,KAAK,GAAK,gCAAsB,EAAE,MAA7B,CAA8B;IAC3C,IAAM,aAAa,GAAG,sCAA4B,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;IACpF,OAAO,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC;AAPD,0EAOC;AAED;;;;;;;GAOG;AACH,SAAgB,gCAAgC,CAC5C,MAAc,EACd,iBAAqB;IAEb,IAAA,KAAK,GAAK,gCAAsB,EAAE,MAA7B,CAA8B;IAC3C,IAAM,cAAc,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,UAAC,KAAK;QACrC,OAAA,sCAA4B,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC;IAA7D,CAA6D,CAC/B,CAAC;IACnC,OAAO,0BAA0B,CAAC,cAAc,CAAC,CAAC;AACtD,CAAC;AATD,4EASC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAI,KAAQ;IACxC,OAAO,eAAO,CAAC;QACX,OAAO,KAAK,CAAC;IACjB,CAAC,EAAE,CAAC,+BAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAJD,4CAIC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CAAkB,MAAS;;IACjE,IAAM,UAAU,GAAG,cAAM,OACrB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC;QAChB,IAAI,EAAE,+BAAe,CAAC,CAAC,CAAC;QACxB,KAAK,EAAE,CAAC;KACX,CAAC,EAHiB,CAGjB,oCAAK,EAAE,CACZ,CAAC;IAEF,OAAO,eAAO,CAAC;QACX,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,UAAC,GAAG,EAAE,GAAG;YACxB,IAAM,IAAI,GAAG,+BAAe,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;gBACvC,OAAO,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC;aACxC;YAED,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;gBACtB,IAAI,MAAA;gBACJ,KAAK,EAAE,GAAG;aACb,CAAC;YAEF,OAAO,GAAG,CAAC;QACf,CAAC,CAAM,CAAC;IACZ,CAAC,EAAE,CAAC,+BAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAvBD,gEAuBC"}
@@ -1,12 +1,12 @@
1
1
  import { DependencyList } from "react";
2
2
  /**
3
3
  * Indicates the current state of the promise inside {@link useCancelablePromise} hook
4
- * @beta
4
+ * @public
5
5
  */
6
6
  export declare type UseCancelablePromiseStatus = "success" | "error" | "loading" | "pending";
7
7
  /**
8
8
  * Indicates pending state for {@link useCancelablePromise} hook
9
- * @beta
9
+ * @public
10
10
  */
11
11
  export declare type UseCancelablePromisePendingState = {
12
12
  result: undefined;
@@ -15,7 +15,7 @@ export declare type UseCancelablePromisePendingState = {
15
15
  };
16
16
  /**
17
17
  * Indicates loading state for {@link useCancelablePromise} hook
18
- * @beta
18
+ * @public
19
19
  */
20
20
  export declare type UseCancelablePromiseLoadingState = {
21
21
  result: undefined;
@@ -24,7 +24,7 @@ export declare type UseCancelablePromiseLoadingState = {
24
24
  };
25
25
  /**
26
26
  * Indicates error state for {@link useCancelablePromise} hook
27
- * @beta
27
+ * @public
28
28
  */
29
29
  export declare type UseCancelablePromiseErrorState<TError> = {
30
30
  result: undefined;
@@ -33,7 +33,7 @@ export declare type UseCancelablePromiseErrorState<TError> = {
33
33
  };
34
34
  /**
35
35
  * Indicates success state for {@link useCancelablePromise} hook
36
- * @beta
36
+ * @public
37
37
  */
38
38
  export declare type UseCancelablePromiseSuccessState<TResult> = {
39
39
  result: TResult;
@@ -42,12 +42,12 @@ export declare type UseCancelablePromiseSuccessState<TResult> = {
42
42
  };
43
43
  /**
44
44
  * Indicates the current state of {@link useCancelablePromise} hook
45
- * @beta
45
+ * @public
46
46
  */
47
47
  export declare type UseCancelablePromiseState<TResult, TError> = UseCancelablePromisePendingState | UseCancelablePromiseLoadingState | UseCancelablePromiseErrorState<TError> | UseCancelablePromiseSuccessState<TResult>;
48
48
  /**
49
49
  * Callbacks for {@link useCancelablePromise} hook
50
- * @beta
50
+ * @public
51
51
  */
52
52
  export declare type UseCancelablePromiseCallbacks<TResult, TError> = {
53
53
  /**
@@ -74,20 +74,26 @@ export declare type UseCancelablePromiseCallbacks<TResult, TError> = {
74
74
  /**
75
75
  * Options for the {@link useCancelablePromise} hook.
76
76
  *
77
- * @beta
77
+ * @public
78
78
  */
79
79
  export declare type UseCancelablePromiseOptions<TResult, TError> = UseCancelablePromiseCallbacks<TResult, TError> & {
80
80
  promise: (() => Promise<TResult>) | undefined | null;
81
81
  };
82
82
  /**
83
- * This hook provides easy way to work with Promise.
83
+ * This hook provides easy way to work with Promises in React components.
84
+ *
85
+ * @remarks
84
86
  * You can:
85
87
  * - watch it's status (pending/loading/success/error)
86
88
  * - get it's result/error when the Promise is resolved/rejected,
87
89
  * - attach convenient callbacks to it
88
90
  * - be sure, that when the dependency list changes, result will be still relevant (if previous Promise is still running, it's "canceled").
89
91
  *
90
- * @beta
92
+ * Note that it's not recommended to use this hook for storing data on the backend
93
+ * as it does not cancel requests wrapped in these promises
94
+ * and you have no guarantee about the resolution order of the fired requests.
95
+ *
96
+ * @public
91
97
  */
92
98
  export declare function useCancelablePromise<TResult, TError = any>(options: UseCancelablePromiseOptions<TResult, TError>, deps?: DependencyList): UseCancelablePromiseState<TResult, TError>;
93
99
  //# sourceMappingURL=useCancelablePromise.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"useCancelablePromise.d.ts","sourceRoot":"","sources":["../../../src/base/react/useCancelablePromise.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAuB,MAAM,OAAO,CAAC;AAM5D;;;GAGG;AACH,oBAAY,0BAA0B,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAErF;;;GAGG;AACH,oBAAY,gCAAgC,GAAG;IAC3C,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,oBAAY,gCAAgC,GAAG;IAC3C,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,oBAAY,8BAA8B,CAAC,MAAM,IAAI;IACjD,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,oBAAY,gCAAgC,CAAC,OAAO,IAAI;IACpD,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,oBAAY,yBAAyB,CAAC,OAAO,EAAE,MAAM,IAC/C,gCAAgC,GAChC,gCAAgC,GAChC,8BAA8B,CAAC,MAAM,CAAC,GACtC,gCAAgC,CAAC,OAAO,CAAC,CAAC;AAEhD;;;GAGG;AACH,oBAAY,6BAA6B,CAAC,OAAO,EAAE,MAAM,IAAI;IACzD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;;;GAIG;AACH,oBAAY,2BAA2B,CAAC,OAAO,EAAE,MAAM,IAAI,6BAA6B,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG;IACxG,OAAO,EAAE,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,EACtD,OAAO,EAAE,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EACrD,IAAI,CAAC,EAAE,cAAc,GACtB,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,CAmG5C"}
1
+ {"version":3,"file":"useCancelablePromise.d.ts","sourceRoot":"","sources":["../../../src/base/react/useCancelablePromise.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAuB,MAAM,OAAO,CAAC;AAM5D;;;GAGG;AACH,oBAAY,0BAA0B,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAErF;;;GAGG;AACH,oBAAY,gCAAgC,GAAG;IAC3C,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,oBAAY,gCAAgC,GAAG;IAC3C,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,oBAAY,8BAA8B,CAAC,MAAM,IAAI;IACjD,MAAM,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,oBAAY,gCAAgC,CAAC,OAAO,IAAI;IACpD,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,oBAAY,yBAAyB,CAAC,OAAO,EAAE,MAAM,IAC/C,gCAAgC,GAChC,gCAAgC,GAChC,8BAA8B,CAAC,MAAM,CAAC,GACtC,gCAAgC,CAAC,OAAO,CAAC,CAAC;AAEhD;;;GAGG;AACH,oBAAY,6BAA6B,CAAC,OAAO,EAAE,MAAM,IAAI;IACzD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;;;GAIG;AACH,oBAAY,2BAA2B,CAAC,OAAO,EAAE,MAAM,IAAI,6BAA6B,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG;IACxG,OAAO,EAAE,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;CACxD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,EACtD,OAAO,EAAE,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,EACrD,IAAI,CAAC,EAAE,cAAc,GACtB,yBAAyB,CAAC,OAAO,EAAE,MAAM,CAAC,CAmG5C"}
@@ -2,21 +2,27 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.useCancelablePromise = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019-2021 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var react_1 = require("react");
7
7
  var CancelablePromise_1 = require("./CancelablePromise");
8
8
  var noop_1 = tslib_1.__importDefault(require("lodash/noop"));
9
9
  var GoodDataSdkError_1 = require("../errors/GoodDataSdkError");
10
10
  var safeSerialize_1 = require("./safeSerialize");
11
11
  /**
12
- * This hook provides easy way to work with Promise.
12
+ * This hook provides easy way to work with Promises in React components.
13
+ *
14
+ * @remarks
13
15
  * You can:
14
16
  * - watch it's status (pending/loading/success/error)
15
17
  * - get it's result/error when the Promise is resolved/rejected,
16
18
  * - attach convenient callbacks to it
17
19
  * - be sure, that when the dependency list changes, result will be still relevant (if previous Promise is still running, it's "canceled").
18
20
  *
19
- * @beta
21
+ * Note that it's not recommended to use this hook for storing data on the backend
22
+ * as it does not cancel requests wrapped in these promises
23
+ * and you have no guarantee about the resolution order of the fired requests.
24
+ *
25
+ * @public
20
26
  */
21
27
  function useCancelablePromise(options, deps) {
22
28
  var promise = options.promise, _a = options.onLoading, onLoading = _a === void 0 ? noop_1.default : _a, _b = options.onPending, onPending = _b === void 0 ? noop_1.default : _b, _c = options.onCancel, onCancel = _c === void 0 ? noop_1.default : _c, _d = options.onSuccess, onSuccess = _d === void 0 ? noop_1.default : _d, _e = options.onError, onError = _e === void 0 ? noop_1.default : _e;