@atlaskit/smart-card 22.2.0 → 22.2.1

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 (329) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/client/package.json +8 -1
  3. package/dist/cjs/state/helpers.js +2 -1
  4. package/dist/cjs/version.json +1 -1
  5. package/dist/cjs/view/EmbedModal/components/embed-content/index.js +1 -5
  6. package/dist/es2019/state/helpers.js +2 -1
  7. package/dist/es2019/version.json +1 -1
  8. package/dist/es2019/view/EmbedModal/components/embed-content/index.js +1 -5
  9. package/dist/esm/state/helpers.js +2 -1
  10. package/dist/esm/version.json +1 -1
  11. package/dist/esm/view/EmbedModal/components/embed-content/index.js +1 -4
  12. package/dist/types/extractors/common/__mocks__/jsonld.d.ts +2 -2
  13. package/dist/types-ts4.0/__fixtures__/flexible-ui-data-context.d.ts +3 -0
  14. package/dist/types-ts4.0/__tests_external__/index.d.ts +6 -0
  15. package/dist/types-ts4.0/__tests_external__/page-objects/BaseCard.d.ts +16 -0
  16. package/dist/types-ts4.0/__tests_external__/page-objects/BlockCard.d.ts +6 -0
  17. package/dist/types-ts4.0/__tests_external__/page-objects/EmbedCard.d.ts +6 -0
  18. package/dist/types-ts4.0/__tests_external__/page-objects/InlineCard.d.ts +6 -0
  19. package/dist/types-ts4.0/__tests_external__/test-cases/card.d.ts +3 -0
  20. package/dist/types-ts4.0/__tests_external__/test-cases/embed.d.ts +3 -0
  21. package/dist/types-ts4.0/__tests_external__/test-cases/inline.d.ts +3 -0
  22. package/dist/types-ts4.0/__tests_external__/test-cases/types.d.ts +5 -0
  23. package/dist/types-ts4.0/classNames.d.ts +11 -0
  24. package/dist/types-ts4.0/client/index.d.ts +1 -0
  25. package/dist/types-ts4.0/constants.d.ts +185 -0
  26. package/dist/types-ts4.0/extractors/block/index.d.ts +9 -0
  27. package/dist/types-ts4.0/extractors/block/types.d.ts +14 -0
  28. package/dist/types-ts4.0/extractors/common/__mocks__/jsonld.d.ts +232 -0
  29. package/dist/types-ts4.0/extractors/common/__mocks__/render.d.ts +2 -0
  30. package/dist/types-ts4.0/extractors/common/actions/extractActions.d.ts +4 -0
  31. package/dist/types-ts4.0/extractors/common/actions/extractPreviewAction.d.ts +9 -0
  32. package/dist/types-ts4.0/extractors/common/byline/extractByline.d.ts +3 -0
  33. package/dist/types-ts4.0/extractors/common/context/extractAccessContext.d.ts +7 -0
  34. package/dist/types-ts4.0/extractors/common/context/index.d.ts +1 -0
  35. package/dist/types-ts4.0/extractors/common/detail/extractCommentCount.d.ts +4 -0
  36. package/dist/types-ts4.0/extractors/common/detail/extractDownloadUrl.d.ts +2 -0
  37. package/dist/types-ts4.0/extractors/common/detail/extractProgrammingLanguage.d.ts +4 -0
  38. package/dist/types-ts4.0/extractors/common/detail/extractSubscriberCount.d.ts +4 -0
  39. package/dist/types-ts4.0/extractors/common/detail/index.d.ts +7 -0
  40. package/dist/types-ts4.0/extractors/common/detail/types.d.ts +5 -0
  41. package/dist/types-ts4.0/extractors/common/icon/extractFileFormat.d.ts +2 -0
  42. package/dist/types-ts4.0/extractors/common/icon/extractIcon.d.ts +14 -0
  43. package/dist/types-ts4.0/extractors/common/icon/extractIconFromDocument.d.ts +4 -0
  44. package/dist/types-ts4.0/extractors/common/icon/extractIconFromTask.d.ts +3 -0
  45. package/dist/types-ts4.0/extractors/common/icon/index.d.ts +4 -0
  46. package/dist/types-ts4.0/extractors/common/icon/priority.d.ts +4 -0
  47. package/dist/types-ts4.0/extractors/common/lozenge/extractLozenge.d.ts +3 -0
  48. package/dist/types-ts4.0/extractors/common/lozenge/extractState.d.ts +3 -0
  49. package/dist/types-ts4.0/extractors/common/lozenge/extractTag.d.ts +3 -0
  50. package/dist/types-ts4.0/extractors/common/lozenge/extractTaskStatus.d.ts +3 -0
  51. package/dist/types-ts4.0/extractors/common/lozenge/extractTaskType.d.ts +7 -0
  52. package/dist/types-ts4.0/extractors/common/lozenge/index.d.ts +5 -0
  53. package/dist/types-ts4.0/extractors/common/lozenge/types.d.ts +8 -0
  54. package/dist/types-ts4.0/extractors/common/lozenge/utils.d.ts +4 -0
  55. package/dist/types-ts4.0/extractors/common/meta/extractIsTrusted.d.ts +2 -0
  56. package/dist/types-ts4.0/extractors/common/primitives/extractSummary.d.ts +2 -0
  57. package/dist/types-ts4.0/extractors/common/primitives/extractTitleTextColor.d.ts +2 -0
  58. package/dist/types-ts4.0/extractors/common/primitives/extractVisitUrl.d.ts +2 -0
  59. package/dist/types-ts4.0/extractors/common/primitives/index.d.ts +2 -0
  60. package/dist/types-ts4.0/extractors/common/title-prefix/extractTitlePrefix.d.ts +5 -0
  61. package/dist/types-ts4.0/extractors/common/title-prefix/index.d.ts +1 -0
  62. package/dist/types-ts4.0/extractors/constants.d.ts +12 -0
  63. package/dist/types-ts4.0/extractors/embed/index.d.ts +3 -0
  64. package/dist/types-ts4.0/extractors/flexible/collaboratorGroup/index.d.ts +4 -0
  65. package/dist/types-ts4.0/extractors/flexible/extract-preview.d.ts +4 -0
  66. package/dist/types-ts4.0/extractors/flexible/extract-priority.d.ts +4 -0
  67. package/dist/types-ts4.0/extractors/flexible/icon/extract-document-type-icon.d.ts +3 -0
  68. package/dist/types-ts4.0/extractors/flexible/icon/extract-file-formatIcon.d.ts +3 -0
  69. package/dist/types-ts4.0/extractors/flexible/icon/extract-icon-renderer.d.ts +4 -0
  70. package/dist/types-ts4.0/extractors/flexible/icon/extract-jira-task-icon.d.ts +3 -0
  71. package/dist/types-ts4.0/extractors/flexible/icon/extract-jsonld-data-icon.d.ts +4 -0
  72. package/dist/types-ts4.0/extractors/flexible/icon/extract-provider-icon.d.ts +4 -0
  73. package/dist/types-ts4.0/extractors/flexible/icon/extract-url-icon.d.ts +4 -0
  74. package/dist/types-ts4.0/extractors/flexible/icon/index.d.ts +17 -0
  75. package/dist/types-ts4.0/extractors/flexible/icon/types.d.ts +6 -0
  76. package/dist/types-ts4.0/extractors/flexible/index.d.ts +5 -0
  77. package/dist/types-ts4.0/extractors/flexible/latest-commit/index.d.ts +2 -0
  78. package/dist/types-ts4.0/extractors/flexible/utils.d.ts +12 -0
  79. package/dist/types-ts4.0/extractors/hover/extractMetadata.d.ts +3 -0
  80. package/dist/types-ts4.0/extractors/index.d.ts +14 -0
  81. package/dist/types-ts4.0/extractors/inline/index.d.ts +6 -0
  82. package/dist/types-ts4.0/hooks.d.ts +2 -0
  83. package/dist/types-ts4.0/i18n/cs.d.ts +71 -0
  84. package/dist/types-ts4.0/i18n/da.d.ts +71 -0
  85. package/dist/types-ts4.0/i18n/de.d.ts +71 -0
  86. package/dist/types-ts4.0/i18n/en.d.ts +71 -0
  87. package/dist/types-ts4.0/i18n/en_GB.d.ts +71 -0
  88. package/dist/types-ts4.0/i18n/en_ZZ.d.ts +38 -0
  89. package/dist/types-ts4.0/i18n/es.d.ts +71 -0
  90. package/dist/types-ts4.0/i18n/et.d.ts +94 -0
  91. package/dist/types-ts4.0/i18n/fi.d.ts +71 -0
  92. package/dist/types-ts4.0/i18n/fr.d.ts +71 -0
  93. package/dist/types-ts4.0/i18n/hu.d.ts +71 -0
  94. package/dist/types-ts4.0/i18n/index.d.ts +35 -0
  95. package/dist/types-ts4.0/i18n/is.d.ts +70 -0
  96. package/dist/types-ts4.0/i18n/it.d.ts +71 -0
  97. package/dist/types-ts4.0/i18n/ja.d.ts +71 -0
  98. package/dist/types-ts4.0/i18n/ko.d.ts +71 -0
  99. package/dist/types-ts4.0/i18n/languages.d.ts +27 -0
  100. package/dist/types-ts4.0/i18n/nb.d.ts +71 -0
  101. package/dist/types-ts4.0/i18n/nl.d.ts +71 -0
  102. package/dist/types-ts4.0/i18n/pl.d.ts +71 -0
  103. package/dist/types-ts4.0/i18n/pt_BR.d.ts +71 -0
  104. package/dist/types-ts4.0/i18n/pt_PT.d.ts +94 -0
  105. package/dist/types-ts4.0/i18n/ro.d.ts +70 -0
  106. package/dist/types-ts4.0/i18n/ru.d.ts +71 -0
  107. package/dist/types-ts4.0/i18n/sk.d.ts +94 -0
  108. package/dist/types-ts4.0/i18n/sv.d.ts +71 -0
  109. package/dist/types-ts4.0/i18n/th.d.ts +71 -0
  110. package/dist/types-ts4.0/i18n/tr.d.ts +71 -0
  111. package/dist/types-ts4.0/i18n/uk.d.ts +71 -0
  112. package/dist/types-ts4.0/i18n/vi.d.ts +71 -0
  113. package/dist/types-ts4.0/i18n/zh.d.ts +71 -0
  114. package/dist/types-ts4.0/i18n/zh_TW.d.ts +71 -0
  115. package/dist/types-ts4.0/in-product.d.ts +1 -0
  116. package/dist/types-ts4.0/index.d.ts +22 -0
  117. package/dist/types-ts4.0/messages.d.ts +8 -0
  118. package/dist/types-ts4.0/model/invoke-handler.d.ts +3 -0
  119. package/dist/types-ts4.0/model/invoke-opts.d.ts +17 -0
  120. package/dist/types-ts4.0/ssr.d.ts +6 -0
  121. package/dist/types-ts4.0/state/actions/constants.d.ts +6 -0
  122. package/dist/types-ts4.0/state/actions/index.d.ts +12 -0
  123. package/dist/types-ts4.0/state/actions/types.d.ts +2 -0
  124. package/dist/types-ts4.0/state/analytics/index.d.ts +3 -0
  125. package/dist/types-ts4.0/state/analytics/types.d.ts +9 -0
  126. package/dist/types-ts4.0/state/analytics/ufoExperiences.d.ts +7 -0
  127. package/dist/types-ts4.0/state/analytics/useSmartLinkAnalytics.d.ts +195 -0
  128. package/dist/types-ts4.0/state/config/index.d.ts +2 -0
  129. package/dist/types-ts4.0/state/flexible-ui-context/index.d.ts +8 -0
  130. package/dist/types-ts4.0/state/flexible-ui-context/types.d.ts +159 -0
  131. package/dist/types-ts4.0/state/helpers.d.ts +16 -0
  132. package/dist/types-ts4.0/state/hooks/index.d.ts +2 -0
  133. package/dist/types-ts4.0/state/hooks/usePrefetch.d.ts +1 -0
  134. package/dist/types-ts4.0/state/hooks/useSmartLink.d.ts +50 -0
  135. package/dist/types-ts4.0/state/hooks-external/useSmartLinkActions.d.ts +49 -0
  136. package/dist/types-ts4.0/state/hooks-external/useSmartLinkReload.d.ts +19 -0
  137. package/dist/types-ts4.0/state/index.d.ts +5 -0
  138. package/dist/types-ts4.0/state/reducers/types.d.ts +4 -0
  139. package/dist/types-ts4.0/state/renderers/index.d.ts +2 -0
  140. package/dist/types-ts4.0/state/store/index.d.ts +3 -0
  141. package/dist/types-ts4.0/state/types.d.ts +1 -0
  142. package/dist/types-ts4.0/types.d.ts +20 -0
  143. package/dist/types-ts4.0/utils/analytics/__mocks__/analytics.d.ts +2 -0
  144. package/dist/types-ts4.0/utils/analytics/analytics.d.ts +32 -0
  145. package/dist/types-ts4.0/utils/analytics/index.d.ts +4 -0
  146. package/dist/types-ts4.0/utils/analytics/types.d.ts +93 -0
  147. package/dist/types-ts4.0/utils/flexible.d.ts +5 -0
  148. package/dist/types-ts4.0/utils/index.d.ts +12 -0
  149. package/dist/types-ts4.0/utils/jsonld.d.ts +3 -0
  150. package/dist/types-ts4.0/utils/mocks.d.ts +74 -0
  151. package/dist/types-ts4.0/utils/performance.d.ts +8 -0
  152. package/dist/types-ts4.0/utils/test-utils.d.ts +4 -0
  153. package/dist/types-ts4.0/utils/token.d.ts +16 -0
  154. package/dist/types-ts4.0/utils/types.d.ts +14 -0
  155. package/dist/types-ts4.0/view/BlockCard/actions/AuthorizeAction.d.ts +2 -0
  156. package/dist/types-ts4.0/view/BlockCard/actions/DownloadAction.d.ts +8 -0
  157. package/dist/types-ts4.0/view/BlockCard/actions/ForbiddenAction.d.ts +2 -0
  158. package/dist/types-ts4.0/view/BlockCard/actions/PreviewAction.d.ts +32 -0
  159. package/dist/types-ts4.0/view/BlockCard/actions/RetryAction.d.ts +2 -0
  160. package/dist/types-ts4.0/view/BlockCard/actions/ViewAction.d.ts +8 -0
  161. package/dist/types-ts4.0/view/BlockCard/components/Action.d.ts +11 -0
  162. package/dist/types-ts4.0/view/BlockCard/components/ActionIcon.d.ts +12 -0
  163. package/dist/types-ts4.0/view/BlockCard/components/ActionList.d.ts +6 -0
  164. package/dist/types-ts4.0/view/BlockCard/components/CollaboratorList.d.ts +13 -0
  165. package/dist/types-ts4.0/view/BlockCard/components/Content.d.ts +7 -0
  166. package/dist/types-ts4.0/view/BlockCard/components/ContentFooter.d.ts +7 -0
  167. package/dist/types-ts4.0/view/BlockCard/components/ContentHeader.d.ts +8 -0
  168. package/dist/types-ts4.0/view/BlockCard/components/Emoji.d.ts +5 -0
  169. package/dist/types-ts4.0/view/BlockCard/components/Frame.d.ts +14 -0
  170. package/dist/types-ts4.0/view/BlockCard/components/Link.d.ts +7 -0
  171. package/dist/types-ts4.0/view/BlockCard/components/Name.d.ts +10 -0
  172. package/dist/types-ts4.0/view/BlockCard/components/Provider.d.ts +6 -0
  173. package/dist/types-ts4.0/view/BlockCard/components/Thumbnail.d.ts +9 -0
  174. package/dist/types-ts4.0/view/BlockCard/components/UnresolvedText.d.ts +6 -0
  175. package/dist/types-ts4.0/view/BlockCard/index.d.ts +14 -0
  176. package/dist/types-ts4.0/view/BlockCard/types.d.ts +25 -0
  177. package/dist/types-ts4.0/view/BlockCard/utils/constants.d.ts +3 -0
  178. package/dist/types-ts4.0/view/BlockCard/utils/handlers.d.ts +2 -0
  179. package/dist/types-ts4.0/view/BlockCard/views/ErroredView.d.ts +12 -0
  180. package/dist/types-ts4.0/view/BlockCard/views/ForbiddenView.d.ts +21 -0
  181. package/dist/types-ts4.0/view/BlockCard/views/NotFoundView.d.ts +15 -0
  182. package/dist/types-ts4.0/view/BlockCard/views/ResolvedView.d.ts +32 -0
  183. package/dist/types-ts4.0/view/BlockCard/views/ResolvingView.d.ts +8 -0
  184. package/dist/types-ts4.0/view/BlockCard/views/UnauthorizedView.d.ts +17 -0
  185. package/dist/types-ts4.0/view/Card/index.d.ts +5 -0
  186. package/dist/types-ts4.0/view/Card/types.d.ts +37 -0
  187. package/dist/types-ts4.0/view/CardWithData/component.d.ts +5 -0
  188. package/dist/types-ts4.0/view/CardWithData/loader.d.ts +9 -0
  189. package/dist/types-ts4.0/view/CardWithData/types.d.ts +15 -0
  190. package/dist/types-ts4.0/view/CardWithUrl/component-lazy/LazyFallback.d.ts +4 -0
  191. package/dist/types-ts4.0/view/CardWithUrl/component-lazy/LazyIntersectionObserverCard.d.ts +3 -0
  192. package/dist/types-ts4.0/view/CardWithUrl/component-lazy/LazyLazilyRenderCard.d.ts +3 -0
  193. package/dist/types-ts4.0/view/CardWithUrl/component-lazy/index.d.ts +3 -0
  194. package/dist/types-ts4.0/view/CardWithUrl/component.d.ts +3 -0
  195. package/dist/types-ts4.0/view/CardWithUrl/loader.d.ts +3 -0
  196. package/dist/types-ts4.0/view/CardWithUrl/types.d.ts +29 -0
  197. package/dist/types-ts4.0/view/EmbedCard/EmbedResizeMessageListener.d.ts +15 -0
  198. package/dist/types-ts4.0/view/EmbedCard/components/ExpandedFrame.d.ts +23 -0
  199. package/dist/types-ts4.0/view/EmbedCard/components/Frame.d.ts +7 -0
  200. package/dist/types-ts4.0/view/EmbedCard/components/ImageIcon.d.ts +9 -0
  201. package/dist/types-ts4.0/view/EmbedCard/components/styled.d.ts +45 -0
  202. package/dist/types-ts4.0/view/EmbedCard/index.d.ts +3 -0
  203. package/dist/types-ts4.0/view/EmbedCard/types.d.ts +46 -0
  204. package/dist/types-ts4.0/view/EmbedCard/views/ErroredView.d.ts +8 -0
  205. package/dist/types-ts4.0/view/EmbedCard/views/ForbiddenView.d.ts +13 -0
  206. package/dist/types-ts4.0/view/EmbedCard/views/NotFoundView.d.ts +11 -0
  207. package/dist/types-ts4.0/view/EmbedCard/views/ResolvedView.d.ts +27 -0
  208. package/dist/types-ts4.0/view/EmbedCard/views/UnauthorisedView.d.ts +12 -0
  209. package/dist/types-ts4.0/view/EmbedCard/views/UnresolvedView.d.ts +18 -0
  210. package/dist/types-ts4.0/view/EmbedModal/components/analytics/index.d.ts +5 -0
  211. package/dist/types-ts4.0/view/EmbedModal/components/analytics/types.d.ts +6 -0
  212. package/dist/types-ts4.0/view/EmbedModal/components/embed-content/index.d.ts +5 -0
  213. package/dist/types-ts4.0/view/EmbedModal/components/embed-content/types.d.ts +6 -0
  214. package/dist/types-ts4.0/view/EmbedModal/components/error-boundary/index.d.ts +4 -0
  215. package/dist/types-ts4.0/view/EmbedModal/components/link-info/index.d.ts +4 -0
  216. package/dist/types-ts4.0/view/EmbedModal/components/link-info/link-info-button/index.d.ts +4 -0
  217. package/dist/types-ts4.0/view/EmbedModal/components/link-info/link-info-button/types.d.ts +9 -0
  218. package/dist/types-ts4.0/view/EmbedModal/components/link-info/styled.d.ts +4 -0
  219. package/dist/types-ts4.0/view/EmbedModal/components/link-info/types.d.ts +13 -0
  220. package/dist/types-ts4.0/view/EmbedModal/components/size-experiment/index.d.ts +7 -0
  221. package/dist/types-ts4.0/view/EmbedModal/components/size-experiment/types.d.ts +4 -0
  222. package/dist/types-ts4.0/view/EmbedModal/constants.d.ts +2 -0
  223. package/dist/types-ts4.0/view/EmbedModal/index.d.ts +6 -0
  224. package/dist/types-ts4.0/view/EmbedModal/types.d.ts +34 -0
  225. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/action-button/index.d.ts +5 -0
  226. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/action-button/types.d.ts +8 -0
  227. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/action-dropdown-item/index.d.ts +4 -0
  228. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/action-dropdown-item/types.d.ts +8 -0
  229. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/action-icon/index.d.ts +5 -0
  230. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/action-icon/types.d.ts +7 -0
  231. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/index.d.ts +13 -0
  232. package/dist/types-ts4.0/view/FlexibleCard/components/actions/action/types.d.ts +48 -0
  233. package/dist/types-ts4.0/view/FlexibleCard/components/actions/index.d.ts +20 -0
  234. package/dist/types-ts4.0/view/FlexibleCard/components/actions/utils.d.ts +4 -0
  235. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/action-group/index.d.ts +11 -0
  236. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/action-group/types.d.ts +37 -0
  237. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/block/index.d.ts +12 -0
  238. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/element-group/index.d.ts +15 -0
  239. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/element-group/types.d.ts +10 -0
  240. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/footer-block/index.d.ts +11 -0
  241. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/footer-block/types.d.ts +10 -0
  242. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/index.d.ts +5 -0
  243. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/metadata-block/index.d.ts +11 -0
  244. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/metadata-block/types.d.ts +26 -0
  245. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/preview-block/index.d.ts +10 -0
  246. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/preview-block/types.d.ts +8 -0
  247. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/snippet-block/index.d.ts +10 -0
  248. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/snippet-block/types.d.ts +8 -0
  249. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/errored/index.d.ts +12 -0
  250. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/index.d.ts +16 -0
  251. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/resolved/index.d.ts +9 -0
  252. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/resolving/index.d.ts +11 -0
  253. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/title-block/types.d.ts +86 -0
  254. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/types.d.ts +293 -0
  255. package/dist/types-ts4.0/view/FlexibleCard/components/blocks/utils.d.ts +13 -0
  256. package/dist/types-ts4.0/view/FlexibleCard/components/common/atlaskit-icon/index.d.ts +4 -0
  257. package/dist/types-ts4.0/view/FlexibleCard/components/common/atlaskit-icon/types.d.ts +6 -0
  258. package/dist/types-ts4.0/view/FlexibleCard/components/common/image-icon/index.d.ts +5 -0
  259. package/dist/types-ts4.0/view/FlexibleCard/components/common/image-icon/types.d.ts +7 -0
  260. package/dist/types-ts4.0/view/FlexibleCard/components/common/loading-skeleton/index.d.ts +5 -0
  261. package/dist/types-ts4.0/view/FlexibleCard/components/common/loading-skeleton/types.d.ts +16 -0
  262. package/dist/types-ts4.0/view/FlexibleCard/components/container/index.d.ts +16 -0
  263. package/dist/types-ts4.0/view/FlexibleCard/components/container/layered-link/index.d.ts +10 -0
  264. package/dist/types-ts4.0/view/FlexibleCard/components/container/layered-link/types.d.ts +12 -0
  265. package/dist/types-ts4.0/view/FlexibleCard/components/container/types.d.ts +25 -0
  266. package/dist/types-ts4.0/view/FlexibleCard/components/elements/avatar-group/index.d.ts +12 -0
  267. package/dist/types-ts4.0/view/FlexibleCard/components/elements/avatar-group/types.d.ts +21 -0
  268. package/dist/types-ts4.0/view/FlexibleCard/components/elements/badge/index.d.ts +18 -0
  269. package/dist/types-ts4.0/view/FlexibleCard/components/elements/badge/types.d.ts +17 -0
  270. package/dist/types-ts4.0/view/FlexibleCard/components/elements/date-time/index.d.ts +12 -0
  271. package/dist/types-ts4.0/view/FlexibleCard/components/elements/date-time/types.d.ts +16 -0
  272. package/dist/types-ts4.0/view/FlexibleCard/components/elements/icon/index.d.ts +11 -0
  273. package/dist/types-ts4.0/view/FlexibleCard/components/elements/icon/types.d.ts +27 -0
  274. package/dist/types-ts4.0/view/FlexibleCard/components/elements/index.d.ts +124 -0
  275. package/dist/types-ts4.0/view/FlexibleCard/components/elements/link/index.d.ts +11 -0
  276. package/dist/types-ts4.0/view/FlexibleCard/components/elements/link/types.d.ts +35 -0
  277. package/dist/types-ts4.0/view/FlexibleCard/components/elements/lozenge/index.d.ts +11 -0
  278. package/dist/types-ts4.0/view/FlexibleCard/components/elements/lozenge/types.d.ts +13 -0
  279. package/dist/types-ts4.0/view/FlexibleCard/components/elements/media/index.d.ts +11 -0
  280. package/dist/types-ts4.0/view/FlexibleCard/components/elements/media/types.d.ts +17 -0
  281. package/dist/types-ts4.0/view/FlexibleCard/components/elements/text/index.d.ts +11 -0
  282. package/dist/types-ts4.0/view/FlexibleCard/components/elements/text/types.d.ts +17 -0
  283. package/dist/types-ts4.0/view/FlexibleCard/components/elements/types.d.ts +24 -0
  284. package/dist/types-ts4.0/view/FlexibleCard/components/elements/utils.d.ts +3 -0
  285. package/dist/types-ts4.0/view/FlexibleCard/components/types.d.ts +6 -0
  286. package/dist/types-ts4.0/view/FlexibleCard/components/utils.d.ts +15 -0
  287. package/dist/types-ts4.0/view/FlexibleCard/index.d.ts +10 -0
  288. package/dist/types-ts4.0/view/FlexibleCard/types.d.ts +113 -0
  289. package/dist/types-ts4.0/view/FlexibleCard/utils.d.ts +7 -0
  290. package/dist/types-ts4.0/view/HoverCard/components/HoverCardComponent.d.ts +4 -0
  291. package/dist/types-ts4.0/view/HoverCard/components/HoverCardContent.d.ts +9 -0
  292. package/dist/types-ts4.0/view/HoverCard/components/HoverCardLoadingView.d.ts +4 -0
  293. package/dist/types-ts4.0/view/HoverCard/components/SnippetOrPreview.d.ts +4 -0
  294. package/dist/types-ts4.0/view/HoverCard/index.d.ts +3 -0
  295. package/dist/types-ts4.0/view/HoverCard/styled.d.ts +12 -0
  296. package/dist/types-ts4.0/view/HoverCard/types.d.ts +45 -0
  297. package/dist/types-ts4.0/view/HoverCard/utils.d.ts +3 -0
  298. package/dist/types-ts4.0/view/InlineCard/ErroredView/index.d.ts +21 -0
  299. package/dist/types-ts4.0/view/InlineCard/ForbiddenView/index.d.ts +25 -0
  300. package/dist/types-ts4.0/view/InlineCard/Frame/index.d.ts +16 -0
  301. package/dist/types-ts4.0/view/InlineCard/Frame/styled.d.ts +8 -0
  302. package/dist/types-ts4.0/view/InlineCard/Icon.d.ts +4 -0
  303. package/dist/types-ts4.0/view/InlineCard/IconAndTitleLayout/index.d.ts +19 -0
  304. package/dist/types-ts4.0/view/InlineCard/IconAndTitleLayout/styled.d.ts +13 -0
  305. package/dist/types-ts4.0/view/InlineCard/ResolvedView/index.d.ts +30 -0
  306. package/dist/types-ts4.0/view/InlineCard/ResolvingView/index.d.ts +18 -0
  307. package/dist/types-ts4.0/view/InlineCard/ResolvingView/styled.d.ts +14 -0
  308. package/dist/types-ts4.0/view/InlineCard/UnauthorisedView/index.d.ts +20 -0
  309. package/dist/types-ts4.0/view/InlineCard/index.d.ts +9 -0
  310. package/dist/types-ts4.0/view/InlineCard/styled.d.ts +9 -0
  311. package/dist/types-ts4.0/view/InlineCard/types.d.ts +21 -0
  312. package/dist/types-ts4.0/view/LinkView/index.d.ts +8 -0
  313. package/dist/types-ts4.0/view/SmartLinkEvents/useSmartLinkEvents.d.ts +2 -0
  314. package/dist/types-ts4.0/view/__mocks__/intersection-observer.d.ts +26 -0
  315. package/dist/types-ts4.0/view/__mocks__/intersection-observer.mock.d.ts +12 -0
  316. package/dist/types-ts4.0/view/common/Byline.d.ts +8 -0
  317. package/dist/types-ts4.0/view/common/Icon.d.ts +9 -0
  318. package/dist/types-ts4.0/view/common/Metadata.d.ts +8 -0
  319. package/dist/types-ts4.0/view/common/MetadataList.d.ts +8 -0
  320. package/dist/types-ts4.0/view/common/Modal.d.ts +26 -0
  321. package/dist/types-ts4.0/view/common/ModalHeader.d.ts +17 -0
  322. package/dist/types-ts4.0/view/common/utils.d.ts +5 -0
  323. package/dist/types-ts4.0/view/types.d.ts +29 -0
  324. package/hooks/package.json +8 -1
  325. package/in-product/package.json +8 -1
  326. package/package.json +13 -6
  327. package/report.api.md +341 -738
  328. package/ssr/package.json +8 -1
  329. package/types/package.json +8 -1
package/report.api.md CHANGED
@@ -1,6 +1,10 @@
1
- ## API Report File for "@atlaskit/smart-card".
1
+ ## API Report File for "@atlaskit/smart-card"
2
2
 
3
- > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ <!--
6
+ Generated API Report version: 2.0
7
+ -->
4
8
 
5
9
  [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
6
10
 
@@ -37,63 +41,35 @@ import { WithContextProps } from '@atlaskit/analytics-next';
37
41
  import { WithIntlProps } from 'react-intl-next';
38
42
  import { WrappedComponentProps } from 'react-intl-next';
39
43
 
40
- export declare type ActionItem = NamedActionItem | CustomActionItem;
44
+ // @public (undocumented)
45
+ export type ActionItem = NamedActionItem | CustomActionItem;
41
46
 
42
- /**
43
- * Flexible UI action (button)
44
- */
45
- export declare enum ActionName {
47
+ // @public
48
+ export enum ActionName {
49
+ // (undocumented)
50
+ CustomAction = 'CustomAction',
51
+ // (undocumented)
46
52
  DeleteAction = 'DeleteAction',
53
+ // (undocumented)
47
54
  EditAction = 'EditAction',
48
- CustomAction = 'CustomAction',
49
55
  }
50
56
 
51
- declare type ActionProps = {
52
- /**
53
- * Determines the size of the Action. Corresponds to an Action appearance.
54
- */
57
+ // @public (undocumented)
58
+ type ActionProps = {
55
59
  size?: SmartLinkSize;
56
- /**
57
- * Determines the text content of the Action.
58
- */
59
60
  content?: React.ReactNode;
60
- /**
61
- * Determines the appearance of the action. Corresponds to the Atlaskit action appearance.
62
- */
63
61
  appearance?: Appearance;
64
- /**
65
- * Determines the onClick behaviour of the Action.
66
- */
67
62
  onClick: () => any;
68
- /**
69
- * Determines the icon rendered within the Action.
70
- */
71
63
  icon?: ReactChild;
72
- /**
73
- * Determines where the icon should be rendered if text is provided.
74
- */
75
64
  iconPosition?: 'before' | 'after';
76
- /**
77
- * Determines the tooltip message when hovering over the Action.
78
- */
79
65
  tooltipMessage?: React.ReactNode;
80
- /**
81
- * Used to determine whether the Action is in a Dropdown.
82
- */
83
66
  asDropDownItem?: boolean;
84
- /**
85
- * Additional CSS properties on the Action.
86
- */
87
67
  overrideCss?: SerializedStyles;
88
- /**
89
- * A `testId` prop is provided for specified elements, which is a unique
90
- * string that appears as a data attribute `data-testid` in the rendered code,
91
- * serving as a hook for automated tests
92
- */
93
68
  testId?: string;
94
69
  };
95
70
 
96
- export declare type AnalyticsAction =
71
+ // @public (undocumented)
72
+ export type AnalyticsAction =
97
73
  | 'resolved'
98
74
  | 'unresolved'
99
75
  | 'connectSucceeded'
@@ -109,7 +85,8 @@ export declare type AnalyticsAction =
109
85
  | 'dismissed'
110
86
  | 'created';
111
87
 
112
- export declare type AnalyticsActionSubject =
88
+ // @public (undocumented)
89
+ export type AnalyticsActionSubject =
113
90
  | 'smartLink'
114
91
  | 'smartLinkAction'
115
92
  | 'applicationAccount'
@@ -119,13 +96,17 @@ export declare type AnalyticsActionSubject =
119
96
  | 'modal'
120
97
  | 'embedPreviewModal';
121
98
 
122
- declare type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
99
+ // @public (undocumented)
100
+ type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
123
101
 
124
- export declare type AnalyticsHandler = (event: AnalyticsPayload) => void;
102
+ // @public (undocumented)
103
+ export type AnalyticsHandler = (event: AnalyticsPayload) => void;
125
104
 
126
- declare type AnalyticsName = 'embedPreviewModal';
105
+ // @public (undocumented)
106
+ type AnalyticsName = 'embedPreviewModal';
127
107
 
128
- export declare type AnalyticsPayload = GasPayload & {
108
+ // @public (undocumented)
109
+ export type AnalyticsPayload = GasPayload & {
129
110
  action?: AnalyticsAction;
130
111
  actionSubject: AnalyticsActionSubject;
131
112
  attributes: GasPayload['attributes'] & {
@@ -133,132 +114,78 @@ export declare type AnalyticsPayload = GasPayload & {
133
114
  };
134
115
  };
135
116
 
136
- declare type AnchorTarget = '_blank' | '_self' | '_top' | '_parent';
117
+ // @public (undocumented)
118
+ type AnchorTarget = '_blank' | '_self' | '_top' | '_parent';
137
119
 
138
120
  export { APIError };
139
121
 
140
- /**
141
- * Represents the props available for an AuthorGroup element.
142
- * @see AuthorGroup
143
- */
144
- declare type AuthorGroup = {
122
+ // @public
123
+ type AuthorGroup = {
145
124
  name: ElementName.AuthorGroup;
146
125
  };
147
126
 
148
- /**
149
- * Used to represent an Action when passing props into Flexible UI.
150
- */
151
- declare type BaseActionItem = {
152
- /**
153
- * Determines whether the action should hide the text content of the button.
154
- */
127
+ // @public
128
+ type BaseActionItem = {
155
129
  hideContent?: boolean;
156
- /**
157
- * Determines whether the action should hide the icon inside the button.
158
- */
159
130
  hideIcon?: boolean;
160
- /**
161
- * Determines the text and icon representation of the action, with exception
162
- * to CustomAction.
163
- */
164
131
  name: ActionName;
165
- /**
166
- * Determines the onClick behaviour of the action.
167
- */
168
132
  onClick: () => any;
169
- /**
170
- * Additional CSS properties on the Action.
171
- */
172
133
  overrideCss?: SerializedStyles;
173
- /**
174
- * Determines the size of the Action. Corresponds to an Action appearance.
175
- */
176
134
  size?: SmartLinkSize;
177
- /**
178
- * A `testId` prop is provided for specified elements, which is a unique
179
- * string that appears as a data attribute `data-testid` in the rendered code,
180
- * serving as a hook for automated tests
181
- */
182
135
  testId?: string;
183
136
  };
184
137
 
185
138
  export { BlockCardAdf };
186
139
 
187
- export declare const blockCardContentClassName = 'block-card-content';
140
+ // @public (undocumented)
141
+ export const blockCardContentClassName = 'block-card-content';
188
142
 
189
- export declare const blockCardContentHeaderClassName =
190
- 'block-card-content-header';
143
+ // @public (undocumented)
144
+ export const blockCardContentHeaderClassName = 'block-card-content-header';
191
145
 
192
- export declare const blockCardContentHeaderNameClassName =
146
+ // @public (undocumented)
147
+ export const blockCardContentHeaderNameClassName =
193
148
  'block-card-content-header-name';
194
149
 
195
- export declare const blockCardErroredViewClassName = 'block-card-errored-view';
150
+ // @public (undocumented)
151
+ export const blockCardErroredViewClassName = 'block-card-errored-view';
196
152
 
197
- export declare const blockCardForbiddenViewClassName =
198
- 'block-card-forbidden-view';
153
+ // @public (undocumented)
154
+ export const blockCardForbiddenViewClassName = 'block-card-forbidden-view';
199
155
 
200
- export declare const blockCardForbiddenViewLinkClassName =
156
+ // @public (undocumented)
157
+ export const blockCardForbiddenViewLinkClassName =
201
158
  'block-card-forbidden-view-link';
202
159
 
203
- export declare const blockCardIconImageClassName = 'block-card-icon-image';
160
+ // @public (undocumented)
161
+ export const blockCardIconImageClassName = 'block-card-icon-image';
204
162
 
205
- export declare const blockCardNotFoundViewClassName =
206
- 'block-card-not-found-view';
163
+ // @public (undocumented)
164
+ export const blockCardNotFoundViewClassName = 'block-card-not-found-view';
207
165
 
208
- export declare const blockCardResolvedViewByClassName =
209
- 'block-card-resolved-view-by';
166
+ // @public (undocumented)
167
+ export const blockCardResolvedViewByClassName = 'block-card-resolved-view-by';
210
168
 
211
- export declare const blockCardResolvedViewClassName =
212
- 'block-card-resolved-view';
169
+ // @public (undocumented)
170
+ export const blockCardResolvedViewClassName = 'block-card-resolved-view';
213
171
 
214
- export declare const blockCardResolvingViewClassName =
215
- 'block-card-resolving-view';
172
+ // @public (undocumented)
173
+ export const blockCardResolvingViewClassName = 'block-card-resolving-view';
216
174
 
217
- declare type BlockProps = {
218
- /**
219
- * The direction that the block should arrange it's elements. Can be vertical
220
- * or horizontal. Default is horizontal.
221
- * @internal
222
- */
175
+ // @public (undocumented)
176
+ type BlockProps = {
223
177
  direction?: SmartLinkDirection;
224
- /**
225
- * Any additional CSS properties to apply to the block.
226
- */
227
178
  overrideCss?: SerializedStyles;
228
- /**
229
- * The size of the block and the size that the underlying elements should
230
- * default to.
231
- */
232
179
  size?: SmartLinkSize;
233
- /**
234
- * The status of the Smart Link. Used to conditionally render different blocks
235
- * when Smart Link is in different states.
236
- * @internal
237
- */
238
180
  status?: SmartLinkStatus;
239
- /**
240
- * A `testId` prop is provided for specified elements, which is a unique
241
- * string that appears as a data attribute `data-testid` in the rendered code,
242
- * serving as a hook for automated tests
243
- */
244
181
  testId?: string;
245
- /**
246
- * Ref to block wrapper div.
247
- */
248
182
  blockRef?: Ref<HTMLDivElement>;
249
- /**
250
- * Function to be called on render of block.
251
- * @internal
252
- */
253
183
  onRender?: () => void;
254
- /**
255
- * Function to be called on transition end of block.
256
- * @internal
257
- */
258
184
  onTransitionEnd?: () => void;
259
185
  };
260
186
 
261
- export declare const Card: React_2.ForwardRefExoticComponent<
187
+ // @public (undocumented)
188
+ export const Card: React_2.ForwardRefExoticComponent<
262
189
  Pick<
263
190
  Omit<
264
191
  React_2.PropsWithChildren<
@@ -303,100 +230,118 @@ export { CardAppearance };
303
230
 
304
231
  export { CardContext };
305
232
 
306
- declare type CardInnerAppearance = CardAppearance | 'preview' | 'flexible';
233
+ // @public (undocumented)
234
+ type CardInnerAppearance = CardAppearance | 'preview' | 'flexible';
307
235
 
308
236
  export { CardPlatform };
309
237
 
310
- export declare interface CardProps extends WithAnalyticsEventsProps {
238
+ // @public (undocumented)
239
+ export interface CardProps extends WithAnalyticsEventsProps {
240
+ // (undocumented)
241
+ analyticsEvents?: AnalyticsFacade;
242
+ // (undocumented)
311
243
  appearance: CardAppearance;
312
- id?: string;
313
- platform?: CardPlatform;
314
- isSelected?: boolean;
315
- isFrameVisible?: boolean;
316
- onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
317
- importer?: (target: any) => void;
244
+ // (undocumented)
245
+ children?: React.ReactNode;
246
+ // (undocumented)
318
247
  container?: HTMLElement;
248
+ // (undocumented)
319
249
  data?: any;
320
- url?: string;
321
- testId?: string;
322
- showActions?: boolean;
323
- onResolve?: OnResolveCallback;
324
- onError?: OnErrorCallback;
325
- inheritDimensions?: boolean;
250
+ // (undocumented)
326
251
  embedIframeRef?: React.Ref<HTMLIFrameElement>;
252
+ // (undocumented)
253
+ id?: string;
254
+ // (undocumented)
255
+ importer?: (target: any) => void;
256
+ // (undocumented)
257
+ inheritDimensions?: boolean;
258
+ // (undocumented)
327
259
  inlinePreloaderStyle?: InlinePreloaderStyle;
328
- ui?: FlexibleUiOptions;
329
- children?: React.ReactNode;
330
- showHoverPreview?: boolean;
331
- analyticsEvents?: AnalyticsFacade;
260
+ // (undocumented)
261
+ isFrameVisible?: boolean;
262
+ // (undocumented)
263
+ isSelected?: boolean;
264
+ // (undocumented)
265
+ onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
266
+ // (undocumented)
267
+ onError?: OnErrorCallback;
268
+ // (undocumented)
269
+ onResolve?: OnResolveCallback;
270
+ // (undocumented)
332
271
  placeholder?: string;
272
+ // (undocumented)
273
+ platform?: CardPlatform;
274
+ // (undocumented)
275
+ showActions?: boolean;
276
+ // (undocumented)
277
+ showHoverPreview?: boolean;
278
+ // (undocumented)
279
+ testId?: string;
280
+ // (undocumented)
281
+ ui?: FlexibleUiOptions;
282
+ // (undocumented)
283
+ url?: string;
333
284
  }
334
285
 
335
286
  export { CardType };
336
287
 
337
288
  export { Client };
338
289
 
339
- /**
340
- * Represents the props available for an CollaboratorGroup element.
341
- * @see CollaboratorGroup
342
- */
343
- declare type CollaboratorGroup = {
290
+ // @public
291
+ type CollaboratorGroup = {
344
292
  name: ElementName.CollaboratorGroup;
345
293
  };
346
294
 
347
- /**
348
- * Represents the props available for an CommentCount element.
349
- * @see CommentCount
350
- */
351
- declare type CommentCount = {
295
+ // @public
296
+ type CommentCount = {
352
297
  name: ElementName.CommentCount;
353
298
  };
354
299
 
355
- declare interface CommonEventProps {
356
- id?: string;
300
+ // @public (undocumented)
301
+ interface CommonEventProps {
302
+ // (undocumented)
357
303
  definitionId?: string;
358
- extensionKey?: string;
359
- resourceType?: string;
360
- destinationSubproduct?: DestinationSubproduct | string;
304
+ // (undocumented)
361
305
  destinationProduct?: DestinationProduct | string;
306
+ // (undocumented)
307
+ destinationSubproduct?: DestinationSubproduct | string;
308
+ // (undocumented)
309
+ extensionKey?: string;
310
+ // (undocumented)
311
+ id?: string;
312
+ // (undocumented)
362
313
  location?: string;
314
+ // (undocumented)
315
+ resourceType?: string;
363
316
  }
364
317
 
365
- declare type ConnectFailedEventProps = CommonEventProps & {
318
+ // @public (undocumented)
319
+ type ConnectFailedEventProps = CommonEventProps & {
366
320
  id?: string;
367
321
  reason?: string;
368
322
  };
369
323
 
370
- declare type ConnectSucceededEventProps = CommonEventProps & {
324
+ // @public (undocumented)
325
+ type ConnectSucceededEventProps = CommonEventProps & {
371
326
  id?: string;
372
327
  };
373
328
 
374
- export declare const contentFooterClassName = 'smart-link-content-footer';
329
+ // @public (undocumented)
330
+ export const contentFooterClassName = 'smart-link-content-footer';
375
331
 
376
- /**
377
- * Represents the props available for an CreatedBy element.
378
- * @see CreatedBy
379
- */
380
- declare type CreatedBy = {
332
+ // @public
333
+ type CreatedBy = {
381
334
  name: ElementName.CreatedBy;
382
335
  };
383
336
 
384
- /**
385
- * Represents the props available for an CreatedOn element.
386
- * @see CreatedOn
387
- */
388
- declare type CreatedOn = {
337
+ // @public
338
+ type CreatedOn = {
389
339
  name: ElementName.CreatedOn;
390
- /**
391
- * A string which will be displayed before the specified element.
392
- */
393
340
  text?: string;
394
341
  };
395
342
 
396
- /**
397
- * This represents an action where either Icon or label must be provided.
398
- */
399
- declare type CustomActionItem = BaseActionItem & {
343
+ // @public
344
+ type CustomActionItem = BaseActionItem & {
400
345
  name: ActionName.CustomAction;
401
346
  } & (
402
347
  | (Required<Pick<ActionProps, 'icon' | 'iconPosition'>> &
@@ -406,19 +351,14 @@ declare type CustomActionItem = BaseActionItem & {
406
351
  Pick<ActionProps, 'tooltipMessage'>)
407
352
  );
408
353
 
409
- declare type DestinationProduct =
410
- | 'jira'
411
- | 'confluence'
412
- | 'bitbucket'
413
- | 'trello';
354
+ // @public (undocumented)
355
+ type DestinationProduct = 'jira' | 'confluence' | 'bitbucket' | 'trello';
414
356
 
415
- declare type DestinationSubproduct = 'core' | 'software' | 'servicedesk';
357
+ // @public (undocumented)
358
+ type DestinationSubproduct = 'core' | 'software' | 'servicedesk';
416
359
 
417
- /**
418
- * Represents the props available for an DueOn element.
419
- * @see CreatedOn
420
- */
421
- declare type DueOn = {
360
+ // @public
361
+ type DueOn = {
422
362
  name: ElementName.DueOn;
423
363
  };
424
364
 
@@ -426,30 +366,15 @@ export { EditorCardProvider };
426
366
 
427
367
  export { editorCardProvider };
428
368
 
429
- /**
430
- * Used to represent a metadata element to be rendered.
431
- */
432
- export declare type ElementItem = {
433
- /**
434
- * Any additional CSS properties to apply to the element.
435
- */
369
+ // @public
370
+ export type ElementItem = {
436
371
  overrideCss?: SerializedStyles;
437
- /**
438
- * The size of the element to display.
439
- */
440
372
  size?: SmartLinkSize;
441
- /**
442
- * A `testId` prop is provided for specified elements, which is a unique
443
- * string that appears as a data attribute `data-testid` in the rendered code,
444
- * serving as a hook for automated tests
445
- */
446
373
  testId?: string;
447
374
  } & ElementItemProps;
448
375
 
449
- /**
450
- * A type that contains all the possible combinations of elements with their corresponding props.
451
- */
452
- declare type ElementItemProps =
376
+ // @public
377
+ type ElementItemProps =
453
378
  | AuthorGroup
454
379
  | CollaboratorGroup
455
380
  | CommentCount
@@ -474,350 +399,270 @@ declare type ElementItemProps =
474
399
  | ViewCount
475
400
  | VoteCount;
476
401
 
477
- /**
478
- * Flexible UI element name - each reflecting the link data its represented.
479
- * When adding an element...
480
- * 1) Create base element if it doesn't already exist.
481
- * Base element are inside src/view/FlexibleCard/components/elements.
482
- * E.g. Badge, DateTime, Icon, Lozenge, etc.
483
- * 2) Update FlexibleUiContext with the new prop for data representing
484
- * the element, preferably with the same name as the element itself.
485
- * (src/state/flexible-ui-context/types.ts)
486
- * 3) Update Flexible UI extractor (src/extractors/flexible/index.ts)
487
- * 4) Set base element and data mapping
488
- * (src/view/FlexibleCard/components/elements/utils.tsx)
489
- * 5) Create element. (src/view/FlexibleCard/components/elements/index.ts)
490
- * 6) Update element ElementDisplaySchema for inline/block display
491
- * (src/view/FlexibleCard/components/blocks/utils.tsx)
492
- */
493
- export declare enum ElementName {
402
+ // @public
403
+ export enum ElementName {
404
+ // (undocumented)
494
405
  AuthorGroup = 'AuthorGroup',
406
+ // (undocumented)
495
407
  CollaboratorGroup = 'CollaboratorGroup',
408
+ // (undocumented)
496
409
  CommentCount = 'CommentCount',
410
+ // (undocumented)
497
411
  CreatedBy = 'CreatedBy',
412
+ // (undocumented)
498
413
  CreatedOn = 'CreatedOn',
414
+ // (undocumented)
499
415
  DueOn = 'DueOn',
416
+ // (undocumented)
417
+ LatestCommit = 'LatestCommit',
418
+ // (undocumented)
500
419
  LinkIcon = 'LinkIcon',
420
+ // (undocumented)
501
421
  ModifiedBy = 'ModifiedBy',
422
+ // (undocumented)
502
423
  ModifiedOn = 'ModifiedOn',
424
+ // (undocumented)
503
425
  Preview = 'Preview',
426
+ // (undocumented)
504
427
  Priority = 'Priority',
428
+ // (undocumented)
505
429
  ProgrammingLanguage = 'ProgrammingLanguage',
430
+ // (undocumented)
506
431
  Provider = 'Provider',
432
+ // (undocumented)
507
433
  ReactCount = 'ReactCount',
434
+ // (undocumented)
508
435
  Snippet = 'Snippet',
436
+ // (undocumented)
509
437
  SourceBranch = 'SourceBranch',
438
+ // (undocumented)
510
439
  State = 'State',
440
+ // (undocumented)
511
441
  SubscriberCount = 'SubscriberCount',
442
+ // (undocumented)
512
443
  TargetBranch = 'TargetBranch',
444
+ // (undocumented)
513
445
  Title = 'Title',
446
+ // (undocumented)
514
447
  ViewCount = 'ViewCount',
448
+ // (undocumented)
515
449
  VoteCount = 'VoteCount',
516
- LatestCommit = 'LatestCommit',
517
450
  }
518
451
 
519
452
  export { EmbedCardAdf };
520
453
 
521
- export declare const embedHeaderHeight = 32;
454
+ // @public (undocumented)
455
+ export const embedHeaderHeight = 32;
522
456
 
523
- export declare class EmbedResizeMessageListener extends React_2.Component<
457
+ // @public (undocumented)
458
+ export class EmbedResizeMessageListener extends React_2.Component<
524
459
  Props,
525
460
  State
526
461
  > {
462
+ // (undocumented)
527
463
  componentDidMount(): void;
464
+ // (undocumented)
528
465
  componentWillUnmount(): void;
529
- private messageCallback;
530
- private onEmbedHeightChange;
466
+ // (undocumented)
531
467
  render(): React_2.ReactNode;
532
468
  }
533
469
 
534
- declare type ErrorCardType =
470
+ // @public (undocumented)
471
+ type ErrorCardType =
535
472
  | 'errored'
536
473
  | 'fallback'
537
474
  | 'forbidden'
538
475
  | 'not_found'
539
476
  | 'unauthorized';
540
477
 
541
- declare type FlexibleUiOptions = {
542
- /**
543
- * Determines whether the entire Smart Link container should be clickable.
544
- */
478
+ // @public (undocumented)
479
+ type FlexibleUiOptions = {
545
480
  clickableContainer?: boolean;
546
- /**
547
- * Determines whether to hide elevation styling.
548
- */
549
481
  hideElevation?: boolean;
550
- /**
551
- * Determines whether to hide css padding styling.
552
- */
553
482
  hidePadding?: boolean;
554
- /**
555
- * Determines whether to hide css background color styling.
556
- */
557
483
  hideBackground?: boolean;
558
- /**
559
- * Determines the default padding and sizing of the underlying blocks and
560
- * elements within Flexible UI.
561
- */
562
484
  size?: SmartLinkSize;
563
- /**
564
- * Determines the default theme of the Flexible UI.
565
- * Can be Black or Link (default URL blue)
566
- */
567
485
  theme?: SmartLinkTheme;
568
486
  };
569
487
 
570
- /**
571
- * Represents a FooterBlock, designed to contain elements and actions that should appear
572
- * at the bottom of a link card.
573
- * @public
574
- * @param {FooterBlockProps} FooterBlockProps
575
- * @see Block
576
- */
577
- export declare const FooterBlock: React_2.FC<FooterBlockProps>;
578
-
579
- declare type FooterBlockProps = {
580
- /**
581
- * An array of actions to be displayed on the right.
582
- * Adding more than three actions will result in the second and following
583
- * actions being hidden inside of a dropdown
584
- * @see ActionItem
585
- */
488
+ // @public
489
+ export const FooterBlock: React_2.FC<FooterBlockProps>;
490
+
491
+ // @public (undocumented)
492
+ type FooterBlockProps = {
586
493
  actions?: ActionItem[];
587
494
  } & BlockProps;
588
495
 
589
496
  export { InlineCardAdf };
590
497
 
591
- declare type InlinePreloaderStyle =
498
+ // @public (undocumented)
499
+ type InlinePreloaderStyle =
592
500
  | 'on-left-with-skeleton'
593
501
  | 'on-right-without-skeleton';
594
502
 
595
- declare type InstrumentEventProps = CommonEventProps & {
503
+ // @public (undocumented)
504
+ type InstrumentEventProps = CommonEventProps & {
596
505
  error?: APIError;
597
506
  status: CardType;
598
507
  id: string;
599
508
  };
600
509
 
601
- declare type InvokeFailedEventProps = CommonEventProps & {
510
+ // @public (undocumented)
511
+ type InvokeFailedEventProps = CommonEventProps & {
602
512
  id: string;
603
513
  actionType: string;
604
514
  display: CardInnerAppearance;
605
515
  reason: string;
606
516
  };
607
517
 
608
- declare type InvokeSucceededEventProps = CommonEventProps & {
518
+ // @public (undocumented)
519
+ type InvokeSucceededEventProps = CommonEventProps & {
609
520
  id: string;
610
521
  actionType: string;
611
522
  display: CardInnerAppearance;
612
523
  };
613
524
 
614
- declare type InvokeType = 'server' | 'client';
525
+ // @public (undocumented)
526
+ type InvokeType = 'server' | 'client';
615
527
 
616
- /**
617
- * Represents the props available for an LastCommit element.
618
- * @see BadgeProps
619
- */
620
- declare type LatestCommit = {
528
+ // @public
529
+ type LatestCommit = {
621
530
  name: ElementName.LatestCommit;
622
531
  };
623
532
 
624
- /**
625
- * Represents the props available for an LinkIcon element.
626
- * @see LinkIcon
627
- */
628
- declare type LinkIcon = {
533
+ // @public
534
+ type LinkIcon = {
629
535
  name: ElementName.LinkIcon;
630
536
  };
631
537
 
632
- export declare const loadingPlaceholderClassName =
633
- 'smart-link-loading-placeholder';
634
-
635
- /**
636
- * Represents a MetadataBlock, designed to contain groups of metadata in the form of elements.
637
- * Accepts an array of elements to be shown either primary (left hand side) or secondary (right hand side).
638
- * @public
639
- * @param {MetadataBlockProps} MetadataBlockProps
640
- * @see Block
641
- */
642
- export declare const MetadataBlock: React_2.FC<MetadataBlockProps>;
643
-
644
- declare type MetadataBlockProps = {
645
- /**
646
- * Determines the number of lines the metadata should span across.
647
- * Default is 2. Maximum is 2.
648
- */
538
+ // @public (undocumented)
539
+ export const loadingPlaceholderClassName = 'smart-link-loading-placeholder';
540
+
541
+ // @public
542
+ export const MetadataBlock: React_2.FC<MetadataBlockProps>;
543
+
544
+ // @public (undocumented)
545
+ type MetadataBlockProps = {
649
546
  maxLines?: number;
650
- /**
651
- * An array of metadata elements to display on the left.
652
- * By default elements will be shown to the right of the TitleBlock.
653
- * The visibility of the element is determine by the link data.
654
- * If link contain no data to display a particular element, the element
655
- * will simply not show up.
656
- * @see ElementItem
657
- */
658
547
  primary?: ElementItem[];
659
- /**
660
- * An array of metadata elements to display on the right.
661
- * By default elements will be shown to the right of the TitleBlock.
662
- * The visibility of the element is determine by the link data.
663
- * If link contain no data to display a particular element, the element
664
- * will simply not show up.
665
- * @see ElementItem
666
- */
667
548
  secondary?: ElementItem[];
668
549
  } & BlockProps;
669
550
 
670
- export declare const metadataListClassName = 'smart-link-metadata-list';
551
+ // @public (undocumented)
552
+ export const metadataListClassName = 'smart-link-metadata-list';
671
553
 
672
- /**
673
- * Represents the props available for an ModifiedBy element.
674
- * @see ModifiedBy
675
- */
676
- declare type ModifiedBy = {
554
+ // @public
555
+ type ModifiedBy = {
677
556
  name: ElementName.ModifiedBy;
678
557
  };
679
558
 
680
- /**
681
- * Represents the props available for an ModifiedOn element.
682
- * @see ModifiedOn
683
- */
684
- declare type ModifiedOn = {
559
+ // @public
560
+ type ModifiedOn = {
685
561
  name: ElementName.ModifiedOn;
686
- /**
687
- * A string which will be displayed before the specified element.
688
- */
689
562
  text?: string;
690
563
  };
691
564
 
692
- /**
693
- * This represents an action where Icon and Content are provided implicitly.
694
- * @example DeleteAction - by default will contain a cross icon with the
695
- * 'delete' content if content and icon are not provided.
696
- */
697
- declare type NamedActionItem = BaseActionItem & {
565
+ // @public
566
+ type NamedActionItem = BaseActionItem & {
698
567
  name: Exclude<ActionName, ActionName.CustomAction>;
699
568
  };
700
569
 
701
- export declare type OnActionMenuOpenChangeOptions = {
570
+ // @public (undocumented)
571
+ export type OnActionMenuOpenChangeOptions = {
702
572
  isOpen: boolean;
703
573
  };
704
574
 
705
- declare type OnErrorCallback = (data: {
575
+ // @public (undocumented)
576
+ type OnErrorCallback = (data: {
706
577
  status: Extract<CardType, ErrorCardType>;
707
578
  url: string;
708
579
  }) => void;
709
580
 
710
- declare type OnResolveCallback = (data: {
581
+ // @public (undocumented)
582
+ type OnResolveCallback = (data: {
711
583
  url?: string;
712
584
  title?: string;
713
585
  aspectRatio?: number;
714
586
  }) => void;
715
587
 
716
- /**
717
- * Represents the props available for an Preview element.
718
- * @see Preview
719
- */
720
- declare type Preview = {
588
+ // @public
589
+ type Preview = {
721
590
  name: ElementName.Preview;
722
591
  };
723
592
 
724
- /**
725
- * Represents a PreviewBlock, which typically contains media or other large format content.
726
- * @public
727
- * @param {PreviewBlock} PreviewBlock
728
- * @see Block
729
- */
730
- export declare const PreviewBlock: React_2.FC<PreviewBlockProps>;
731
-
732
- declare type PreviewBlockProps = {
733
- /**
734
- * Function to be called on error loading media.
735
- * @internal
736
- */
593
+ // @public
594
+ export const PreviewBlock: React_2.FC<PreviewBlockProps>;
595
+
596
+ // @public (undocumented)
597
+ type PreviewBlockProps = {
737
598
  onError?: () => void;
738
599
  } & BlockProps;
739
600
 
740
- declare type PreviewDisplay = 'card' | 'embed';
601
+ // @public (undocumented)
602
+ type PreviewDisplay = 'card' | 'embed';
741
603
 
742
- declare type PreviewInvokeMethod = 'keyboard' | 'mouse_hover' | 'mouse_click';
604
+ // @public (undocumented)
605
+ type PreviewInvokeMethod = 'keyboard' | 'mouse_hover' | 'mouse_click';
743
606
 
744
- /**
745
- * Represents the props available for an Priority element.
746
- * @see Priority
747
- */
748
- declare type Priority = {
607
+ // @public
608
+ type Priority = {
749
609
  name: ElementName.Priority;
750
610
  };
751
611
 
752
- /**
753
- * Represents the props available for an ProgrammingLanguage element.
754
- * @see ProgrammingLanguage
755
- */
756
- declare type ProgrammingLanguage = {
612
+ // @public
613
+ type ProgrammingLanguage = {
757
614
  name: ElementName.ProgrammingLanguage;
758
615
  };
759
616
 
760
- declare interface Props {
617
+ // @public (undocumented)
618
+ interface Props {
619
+ // (undocumented)
761
620
  embedIframeRef: React_2.RefObject<HTMLIFrameElement>;
621
+ // (undocumented)
762
622
  onHeightUpdate: (height: number) => void;
763
623
  }
764
624
 
765
625
  export { Provider };
766
626
 
767
- /**
768
- * Represents the props available for an Provider element.
769
- * @see Provider
770
- */
771
- declare type Provider_2 = {
627
+ // @public
628
+ type Provider_2 = {
772
629
  name: ElementName.Provider;
773
630
  };
774
631
 
775
632
  export { ProviderProps };
776
633
 
777
- /**
778
- * Represents the props available for an ReactCount element.
779
- * @see ReactCount
780
- */
781
- declare type ReactCount = {
634
+ // @public
635
+ type ReactCount = {
782
636
  name: ElementName.ReactCount;
783
637
  };
784
638
 
785
- export declare type ResolveResponse = JsonLd.Response;
639
+ // @public (undocumented)
640
+ export type ResolveResponse = JsonLd.Response;
786
641
 
787
- /**
788
- * Retry options used if Smart Link resolves to an errored state.
789
- */
790
- declare type RetryOptions = {
791
- /**
792
- * Determines the error message to show.
793
- */
642
+ // @public
643
+ type RetryOptions = {
794
644
  descriptor?: MessageDescriptor;
795
- /**
796
- * Determines the onClick behaviour of the error message.
797
- */
798
645
  onClick?: ((e: React.MouseEvent<HTMLElement>) => void) | undefined;
799
- /**
800
- * A list of optional value pairs for string interpolation in the message.
801
- */
802
646
  values?: Record<string, string>;
803
647
  };
804
648
 
805
- declare type ScreenAuthPopupEventProps = CommonEventProps;
649
+ // @public (undocumented)
650
+ type ScreenAuthPopupEventProps = CommonEventProps;
806
651
 
807
652
  export { SmartCardContext as Context };
808
653
  export { SmartCardContext };
809
654
 
810
- /**
811
- * The direction of Flexible UI components. It establish the main-axis
812
- * or how the child components laid out inside the parent component.
813
- * Similar to flex's flex-direction concept.
814
- */
815
- export declare enum SmartLinkDirection {
655
+ // @public
656
+ export enum SmartLinkDirection {
657
+ // (undocumented)
816
658
  Horizontal = 'horizontal',
659
+ // (undocumented)
817
660
  Vertical = 'vertical',
818
661
  }
819
662
 
820
- export declare class SmartLinkEvents {
663
+ // @public (undocumented)
664
+ export class SmartLinkEvents {
665
+ // (undocumented)
821
666
  insertSmartLink(
822
667
  url: string,
823
668
  type: CardInnerAppearance,
@@ -825,226 +670,138 @@ export declare class SmartLinkEvents {
825
670
  ): void;
826
671
  }
827
672
 
828
- /**
829
- * The positioning of the component within the parent component.
830
- * Similar to flex's align-items or align-self concept.
831
- */
832
- export declare enum SmartLinkPosition {
833
- Top = 'top',
673
+ // @public
674
+ export enum SmartLinkPosition {
675
+ // (undocumented)
834
676
  Center = 'center',
677
+ // (undocumented)
678
+ Top = 'top',
835
679
  }
836
680
 
837
- /**
838
- * The sizing options of the Flexible UI component. Every component
839
- * has or inherits the sizing props. Implementation varies
840
- * as per component.
841
- */
842
- export declare enum SmartLinkSize {
843
- XLarge = 'xlarge',
681
+ // @public
682
+ export enum SmartLinkSize {
683
+ // (undocumented)
844
684
  Large = 'large',
685
+ // (undocumented)
845
686
  Medium = 'medium',
687
+ // (undocumented)
846
688
  Small = 'small',
689
+ // (undocumented)
690
+ XLarge = 'xlarge',
847
691
  }
848
692
 
849
- /**
850
- * Smart Links link request status
851
- */
852
- declare enum SmartLinkStatus {
853
- Pending = 'pending',
854
- Resolving = 'resolving',
855
- Resolved = 'resolved',
856
- Forbidden = 'forbidden',
693
+ // @public
694
+ enum SmartLinkStatus {
695
+ // (undocumented)
857
696
  Errored = 'errored',
697
+ // (undocumented)
698
+ Fallback = 'fallback',
699
+ // (undocumented)
700
+ Forbidden = 'forbidden',
701
+ // (undocumented)
858
702
  NotFound = 'not_found',
703
+ // (undocumented)
704
+ Pending = 'pending',
705
+ // (undocumented)
706
+ Resolved = 'resolved',
707
+ // (undocumented)
708
+ Resolving = 'resolving',
709
+ // (undocumented)
859
710
  Unauthorized = 'unauthorized',
860
- Fallback = 'fallback',
861
711
  }
862
712
 
863
- /**
864
- * Flexible UI theme available on the Card level.
865
- * This determine the styling of the link.
866
- */
867
- export declare enum SmartLinkTheme {
713
+ // @public
714
+ export enum SmartLinkTheme {
715
+ // (undocumented)
868
716
  Black = 'black',
717
+ // (undocumented)
869
718
  Link = 'link',
870
719
  }
871
720
 
872
- /**
873
- * Represents the props available for an Snippet element.
874
- * @see Snippet
875
- */
876
- declare type Snippet = {
721
+ // @public
722
+ type Snippet = {
877
723
  name: ElementName.Snippet;
878
724
  };
879
725
 
880
- /**
881
- * Represents a SnippetBlock, which is used to display longer form text content, like descriptions.
882
- * @public
883
- * @param {SnippetBlock} SnippetBlock
884
- * @see Block
885
- */
886
- export declare const SnippetBlock: React_2.FC<SnippetBlockProps>;
887
-
888
- declare type SnippetBlockProps = {
889
- /**
890
- * Determines the maximum lines the text within the snippet block should
891
- * spread over. Default is 3. Maximum is 3.
892
- */
726
+ // @public
727
+ export const SnippetBlock: React_2.FC<SnippetBlockProps>;
728
+
729
+ // @public (undocumented)
730
+ type SnippetBlockProps = {
893
731
  maxLines?: number;
894
732
  } & BlockProps;
895
733
 
896
- /**
897
- * Represents the props available for an SourceBranch element.
898
- * @see SourceBranch
899
- */
900
- declare type SourceBranch = {
734
+ // @public
735
+ type SourceBranch = {
901
736
  name: ElementName.SourceBranch;
902
737
  };
903
738
 
904
- declare interface State {}
739
+ // @public (undocumented)
740
+ interface State {}
905
741
 
906
- /**
907
- * Represents the props available for an State element.
908
- * @see State
909
- */
910
- declare type State_2 = {
742
+ // @public
743
+ type State_2 = {
911
744
  name: ElementName.State;
912
745
  };
913
746
 
914
- /**
915
- * Represents the props available for an SubscriberCount element.
916
- * @see SubscriberCount
917
- */
918
- declare type SubscriberCount = {
747
+ // @public
748
+ type SubscriberCount = {
919
749
  name: ElementName.SubscriberCount;
920
750
  };
921
751
 
922
- /**
923
- * Represents the props available for an TargetBranch element.
924
- * @see TargetBranch
925
- */
926
- declare type TargetBranch = {
752
+ // @public
753
+ type TargetBranch = {
927
754
  name: ElementName.TargetBranch;
928
755
  };
929
756
 
930
- /**
931
- * Represents the props available for an Title element.
932
- * @see Title
933
- */
934
- declare type Title = {
757
+ // @public
758
+ type Title = {
935
759
  name: ElementName.Title;
936
760
  };
937
761
 
938
- /**
939
- * Represents a TitleBlock, which is the foundation of Flexible UI.
940
- * This contains an icon, the link, and any associated metadata and actions in one block.
941
- * The TitleBlock will also render differently given the state of the smart link.
942
- * This can be found in the corresponding Resolving, Resolved and Errored views.
943
- * @public
944
- * @param {TitleBlockProps} TitleBlockProps
945
- * @see Block
946
- * @see TitleBlockResolvingView
947
- * @see TitleBlockResolvedView
948
- * @see TitleBlockErroredView
949
- */
950
- export declare const TitleBlock: React_2.FC<TitleBlockProps>;
951
-
952
- declare type TitleBlockProps = {
953
- /**
954
- * An array of action items to be displayed after the title
955
- * on the right of the block.
956
- * An action item provides preset icon and label, with exception of
957
- * a custom action which either Icon or label must be provided.
958
- * @see ActionItem
959
- */
762
+ // @public
763
+ export const TitleBlock: React_2.FC<TitleBlockProps>;
764
+
765
+ // @public (undocumented)
766
+ type TitleBlockProps = {
960
767
  actions?: ActionItem[];
961
- /**
962
- * Determines the href target behaviour of the Link.
963
- */
964
768
  anchorTarget?: AnchorTarget;
965
- /**
966
- * [Experiment] Determines whether the linked title should display tooltip on hover.
967
- */
968
769
  hideTitleTooltip?: boolean;
969
- /**
970
- * Determines the maximum number of lines for the underlying link text to
971
- * spread over. Default is 2. Maximum is 2.
972
- */
973
770
  maxLines?: number;
974
- /**
975
- * An array of metadata elements to display in the TitleBlock.
976
- * By default elements will be shown to the right of the TitleBlock.
977
- * The visibility of the element is determine by the link data.
978
- * If link contain no data to display a particular element, the element
979
- * will simply not show up.
980
- * @see ElementItem
981
- */
982
771
  metadata?: ElementItem[];
983
- /**
984
- * Called when the action dropdown menu (if present) is open/closed.
985
- * Receives an object with `isOpen` state.
986
- */
987
772
  onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
988
- /**
989
- * Determines the position of the link icon in relative to the vertical
990
- * height of the TitleBlock. It can either be centred or placed on “top”.
991
- * Default is top.
992
- */
993
773
  position?: SmartLinkPosition;
994
- /**
995
- * Determines the onClick behaviour of the Link. By default used for analytics.
996
- * @internal
997
- */
998
774
  onClick?: React_2.EventHandler<React_2.MouseEvent | React_2.KeyboardEvent>;
999
- /**
1000
- * The options that determine the retry behaviour when a Smart Link errors.
1001
- * @internal
1002
- */
1003
775
  retry?: RetryOptions;
1004
- /**
1005
- * Determines whether TitleBlock will hide actions until the user is hovering
1006
- * over the link.
1007
- */
1008
776
  showActionOnHover?: boolean;
1009
- /**
1010
- * An array of metadata elements to display in the TitleBlock.
1011
- * By default elements will be shown below the link text.
1012
- * The visibility of the element is determine by the link data.
1013
- * If link contain no data to display a particular element, the element
1014
- * will simply not show up.
1015
- * @see ElementItem
1016
- */
1017
777
  subtitle?: ElementItem[];
1018
- /**
1019
- * The text to display in the link. Overrides any text that is retrieved from
1020
- * the Smart Link.
1021
- */
1022
778
  text?: string;
1023
- /**
1024
- * The theme of the link text. Can be Black or Link (default URL blue)
1025
- * @internal
1026
- */
1027
779
  theme?: SmartLinkTheme;
1028
780
  } & BlockProps;
1029
781
 
1030
- declare type TrackAppAccountConnectedProps = CommonEventProps;
782
+ // @public (undocumented)
783
+ type TrackAppAccountConnectedProps = CommonEventProps;
1031
784
 
1032
- declare type UiActionClickedEventProps = CommonEventProps & {
785
+ // @public (undocumented)
786
+ type UiActionClickedEventProps = CommonEventProps & {
1033
787
  id: string;
1034
788
  display: CardInnerAppearance;
1035
789
  actionType: string;
1036
790
  invokeType?: InvokeType;
1037
791
  };
1038
792
 
1039
- declare type UiAuthAlternateAccountEventProps = CommonEventProps & {
793
+ // @public (undocumented)
794
+ type UiAuthAlternateAccountEventProps = CommonEventProps & {
1040
795
  display: CardInnerAppearance;
1041
796
  };
1042
797
 
1043
- declare type UiAuthEventProps = CommonEventProps & {
798
+ // @public (undocumented)
799
+ type UiAuthEventProps = CommonEventProps & {
1044
800
  display: CardInnerAppearance;
1045
801
  };
1046
802
 
1047
- declare type UiCardClickedEventProps = CommonEventProps & {
803
+ // @public (undocumented)
804
+ type UiCardClickedEventProps = CommonEventProps & {
1048
805
  id: string;
1049
806
  display: CardInnerAppearance;
1050
807
  status: CardType;
@@ -1052,61 +809,51 @@ declare type UiCardClickedEventProps = CommonEventProps & {
1052
809
  actionSubjectId?: string;
1053
810
  };
1054
811
 
1055
- declare type UiClosedAuthEventProps = CommonEventProps & {
812
+ // @public (undocumented)
813
+ type UiClosedAuthEventProps = CommonEventProps & {
1056
814
  display: CardInnerAppearance;
1057
815
  };
1058
816
 
1059
- declare type UiHoverCardDismissedEventProps = CommonEventProps & {
817
+ // @public (undocumented)
818
+ type UiHoverCardDismissedEventProps = CommonEventProps & {
1060
819
  previewDisplay: PreviewDisplay;
1061
820
  hoverTime: number;
1062
821
  previewInvokeMethod?: PreviewInvokeMethod;
1063
822
  };
1064
823
 
1065
- declare type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
824
+ // @public (undocumented)
825
+ type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
1066
826
  previewDisplay: PreviewDisplay;
1067
827
  previewInvokeMethod?: PreviewInvokeMethod;
1068
828
  };
1069
829
 
1070
- declare type UiHoverCardViewedEventProps = CommonEventProps & {
830
+ // @public (undocumented)
831
+ type UiHoverCardViewedEventProps = CommonEventProps & {
1071
832
  previewDisplay: PreviewDisplay;
1072
833
  previewInvokeMethod?: PreviewInvokeMethod;
1073
834
  };
1074
835
 
1075
- declare type UiRenderFailedEventProps = CommonEventProps & {
836
+ // @public (undocumented)
837
+ type UiRenderFailedEventProps = CommonEventProps & {
1076
838
  display: CardInnerAppearance;
1077
839
  error: Error;
1078
840
  errorInfo: ErrorInfo;
1079
841
  };
1080
842
 
1081
- declare type UiRenderSuccessEventProps = CommonEventProps & {
843
+ // @public (undocumented)
844
+ type UiRenderSuccessEventProps = CommonEventProps & {
1082
845
  display: CardInnerAppearance;
1083
846
  status: CardType;
1084
847
  };
1085
848
 
1086
- /**
1087
- * This hook provides usage of Smart Link analytics outside of the Card component.
1088
- * Can be provided to Card via the analyticsEvents prop to change the analytics events.
1089
- * @param url URL of the link
1090
- * @param dispatchAnalytics dispatchAnalytics function
1091
- * @param id fallback id of the events sent if no id is available
1092
- * @param defaultLocation location attribute to be used
1093
- * @returns
1094
- */
1095
- export declare const useSmartLinkAnalytics: (
849
+ // @public
850
+ export const useSmartLinkAnalytics: (
1096
851
  url: string,
1097
852
  dispatchAnalytics: AnalyticsHandler,
1098
853
  id?: string | undefined,
1099
854
  defaultLocation?: string | undefined,
1100
855
  ) => {
1101
856
  ui: {
1102
- /**
1103
- * This fires an event that represents when a user clicks on the authentication
1104
- * call to action with no current authenticated account. (i.e. Connect to Preview).
1105
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1106
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1107
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1108
- * @returns
1109
- */
1110
857
  authEvent: ({
1111
858
  display,
1112
859
  extensionKey,
@@ -1116,14 +863,6 @@ export declare const useSmartLinkAnalytics: (
1116
863
  destinationSubproduct,
1117
864
  location,
1118
865
  }: UiAuthEventProps) => void;
1119
- /**
1120
- * This fires an event that represents when a user clicks on the authentication
1121
- * call to action with a forbidden authenticated account. (i.e. Try another account).
1122
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1123
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1124
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1125
- * @returns
1126
- */
1127
866
  authAlternateAccountEvent: ({
1128
867
  display,
1129
868
  extensionKey,
@@ -1133,28 +872,11 @@ export declare const useSmartLinkAnalytics: (
1133
872
  destinationSubproduct,
1134
873
  location,
1135
874
  }: UiAuthAlternateAccountEventProps) => void;
1136
- /**
1137
- * This fires an event that represents when a user
1138
- * click a button.
1139
- * @param data A partial analytics event payload
1140
- */
1141
875
  buttonClickedEvent: (
1142
876
  data: Partial<AnalyticsPayload> & {
1143
877
  actionSubjectId: Required<string>;
1144
878
  },
1145
879
  ) => void;
1146
- /**
1147
- * This fires an event that represents when a user clicks on a Smart Link.
1148
- * @param id The unique ID for this Smart Link.
1149
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1150
- * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
1151
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1152
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1153
- * @param isModifierKeyPressed Whether a modifier key was pressed when clicking the Smart Link.
1154
- * @param location Where the Smart Link is currently rendered.
1155
- * @param destinationProduct The product the Smart Link is linked to.
1156
- * @returns
1157
- */
1158
880
  cardClickedEvent: ({
1159
881
  id,
1160
882
  display,
@@ -1167,16 +889,6 @@ export declare const useSmartLinkAnalytics: (
1167
889
  destinationSubproduct,
1168
890
  actionSubjectId,
1169
891
  }: UiCardClickedEventProps) => void;
1170
- /**
1171
- * This fires an event that represents when a user clicks on a Smart Link action.
1172
- * Note: This also starts the UFO smart-link-action-invocation experience.
1173
- * @param id The unique ID for this Smart Link.
1174
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1175
- * @param actionType The type of the action that was clicked, e.g. PreviewAction
1176
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1177
- * @param invokeType Whether the action invoked made a call to a server.
1178
- * @returns
1179
- */
1180
892
  actionClickedEvent: ({
1181
893
  id,
1182
894
  actionType,
@@ -1189,14 +901,6 @@ export declare const useSmartLinkAnalytics: (
1189
901
  destinationSubproduct,
1190
902
  location,
1191
903
  }: UiActionClickedEventProps) => void;
1192
- /**
1193
- * This fires an event that represents when a user clicks on a hover preview's "navigate to link" button.
1194
- * https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3206743323/Analytics+Metrics+-+Hover+Previews
1195
- * @param previewDisplay What format the preview is in.
1196
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1197
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1198
- * @param previewInvokeMethod How the preview was triggered.
1199
- */
1200
904
  hoverCardOpenLinkClickedEvent: ({
1201
905
  previewDisplay,
1202
906
  definitionId,
@@ -1206,13 +910,6 @@ export declare const useSmartLinkAnalytics: (
1206
910
  location,
1207
911
  previewInvokeMethod,
1208
912
  }: UiHoverCardOpenLinkClickedEventProps) => void;
1209
- /**
1210
- * This fires an event that represents when a user closed the authentication window without authenticating after opening it.
1211
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1212
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1213
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1214
- * @returns
1215
- */
1216
913
  closedAuthEvent: ({
1217
914
  display,
1218
915
  extensionKey,
@@ -1222,23 +919,11 @@ export declare const useSmartLinkAnalytics: (
1222
919
  destinationSubproduct,
1223
920
  location,
1224
921
  }: UiClosedAuthEventProps) => void;
1225
- /**
1226
- * This fires an event that represents when a user close a modal.
1227
- * @param data A partial analytics event payload
1228
- */
1229
922
  modalClosedEvent: (
1230
923
  data: Partial<AnalyticsPayload> & {
1231
924
  actionSubjectId: Required<string>;
1232
925
  },
1233
926
  ) => void;
1234
- /**
1235
- * This fires an event that represents when a Smart Link was rendered successfully.
1236
- * Note: this fires even if the Smart Link request errored out.
1237
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1238
- * @param id The unique ID for this Smart Link.
1239
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1240
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1241
- */
1242
927
  renderSuccessEvent: ({
1243
928
  display,
1244
929
  status,
@@ -1250,13 +935,6 @@ export declare const useSmartLinkAnalytics: (
1250
935
  destinationSubproduct,
1251
936
  location,
1252
937
  }: UiRenderSuccessEventProps) => void;
1253
- /**
1254
- * This fires an event that represents when a Smart Link renders unsuccessfuly.
1255
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1256
- * @param id The unique ID for this Smart Link.
1257
- * @param error: An error representing why the Smart Link render failed.
1258
- * @param errorInfo: Additional details about the error including the stack trace.
1259
- */
1260
938
  renderFailedEvent: ({
1261
939
  display,
1262
940
  id,
@@ -1269,14 +947,6 @@ export declare const useSmartLinkAnalytics: (
1269
947
  destinationSubproduct,
1270
948
  location,
1271
949
  }: UiRenderFailedEventProps) => void;
1272
- /**
1273
- * This fires an event that represents a hover preview being opened.
1274
- * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
1275
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1276
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1277
- * @param previewInvokeMethod How the preview was triggered.
1278
- * @returns
1279
- */
1280
950
  hoverCardViewedEvent: ({
1281
951
  previewDisplay,
1282
952
  previewInvokeMethod,
@@ -1288,15 +958,6 @@ export declare const useSmartLinkAnalytics: (
1288
958
  destinationSubproduct,
1289
959
  location,
1290
960
  }: UiHoverCardViewedEventProps) => void;
1291
- /**
1292
- * This fires an event that represents a hover preview being dismissed.
1293
- * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
1294
- * @param hoverTime The duration that the user hovered over a Smart Link before the preview was dismissed.
1295
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1296
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1297
- * @param previewInvokeMethod How the preview was triggered.
1298
- * @returns
1299
- */
1300
961
  hoverCardDismissedEvent: ({
1301
962
  id,
1302
963
  previewDisplay,
@@ -1311,13 +972,6 @@ export declare const useSmartLinkAnalytics: (
1311
972
  }: UiHoverCardDismissedEventProps) => void;
1312
973
  };
1313
974
  operational: {
1314
- /**
1315
- * This fires an event that represents an action being successfully invoked.
1316
- * @param id The unique ID for this Smart Link.
1317
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1318
- * @param actionType The type of action invoked, e.g. PreviewAction
1319
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1320
- */
1321
975
  invokeSucceededEvent: ({
1322
976
  id,
1323
977
  actionType,
@@ -1329,14 +983,6 @@ export declare const useSmartLinkAnalytics: (
1329
983
  destinationSubproduct,
1330
984
  location,
1331
985
  }: InvokeSucceededEventProps) => void;
1332
- /**
1333
- * This fires an event that represents an action being unsuccessfully invoked.
1334
- * @param id The unique ID for this Smart Link.
1335
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1336
- * @param actionType The type of action invoked, e.g. PreviewAction
1337
- * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
1338
- * @param reason The reason the invocation failed.
1339
- */
1340
986
  invokeFailedEvent: ({
1341
987
  id,
1342
988
  actionType,
@@ -1349,12 +995,6 @@ export declare const useSmartLinkAnalytics: (
1349
995
  destinationSubproduct,
1350
996
  location,
1351
997
  }: InvokeFailedEventProps) => void;
1352
- /**
1353
- * This fires an event that represents an account successfully being connected via a Smart Link.
1354
- * @param id The unique ID for this Smart Link.
1355
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1356
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1357
- */
1358
998
  connectSucceededEvent: ({
1359
999
  id,
1360
1000
  extensionKey,
@@ -1364,13 +1004,6 @@ export declare const useSmartLinkAnalytics: (
1364
1004
  destinationSubproduct,
1365
1005
  location,
1366
1006
  }: ConnectSucceededEventProps) => void;
1367
- /**
1368
- * This fires an event that represents an account unsuccessfully being connected.
1369
- * @param id The unique ID for this Smart Link.
1370
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1371
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1372
- * @param reason The reason why the Smart Link connect account failed.
1373
- */
1374
1007
  connectFailedEvent: ({
1375
1008
  id,
1376
1009
  reason,
@@ -1381,15 +1014,6 @@ export declare const useSmartLinkAnalytics: (
1381
1014
  destinationSubproduct,
1382
1015
  location,
1383
1016
  }: ConnectFailedEventProps) => void;
1384
- /**
1385
- * This fires an event which represents a Smart Link request succeeding or failing based on the status.
1386
- * @param id The unique ID for this Smart Link.
1387
- * @param status The status of the Smart Link.
1388
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1389
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1390
- * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
1391
- * @param error An error representing why the Smart Link request failed.
1392
- */
1393
1017
  instrument: ({
1394
1018
  id,
1395
1019
  status,
@@ -1403,12 +1027,6 @@ export declare const useSmartLinkAnalytics: (
1403
1027
  }: InstrumentEventProps) => void;
1404
1028
  };
1405
1029
  track: {
1406
- /**
1407
- * This fires an event which represents a user starting the Smart Link connect account process.
1408
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1409
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1410
- * @returns
1411
- */
1412
1030
  appAccountConnected: ({
1413
1031
  extensionKey,
1414
1032
  definitionId,
@@ -1419,12 +1037,6 @@ export declare const useSmartLinkAnalytics: (
1419
1037
  }: TrackAppAccountConnectedProps) => void;
1420
1038
  };
1421
1039
  screen: {
1422
- /**
1423
- * This fires an event which represents the connect account page being opened.
1424
- * @param definitionId The definitionId of the Smart Link resolver invoked.
1425
- * @param extensionKey The extensionKey of the Smart Link resovler invoked.
1426
- * @returns
1427
- */
1428
1040
  authPopupEvent: ({
1429
1041
  extensionKey,
1430
1042
  definitionId,
@@ -1433,10 +1045,6 @@ export declare const useSmartLinkAnalytics: (
1433
1045
  destinationSubproduct,
1434
1046
  location,
1435
1047
  }: ScreenAuthPopupEventProps) => void;
1436
- /**
1437
- * This fires an event that represents when a user view a modal.
1438
- * @param data A partial analytics event payload
1439
- */
1440
1048
  modalViewedEvent: (
1441
1049
  data: Partial<AnalyticsPayload> & {
1442
1050
  name: Extract<AnalyticsName, 'embedPreviewModal'>;
@@ -1445,23 +1053,18 @@ export declare const useSmartLinkAnalytics: (
1445
1053
  };
1446
1054
  };
1447
1055
 
1448
- export declare function useSmartLinkEvents(): SmartLinkEvents;
1056
+ // @public (undocumented)
1057
+ export function useSmartLinkEvents(): SmartLinkEvents;
1449
1058
 
1450
- /**
1451
- * Represents the props available for an ViewCount element.
1452
- * @see ViewCount
1453
- */
1454
- declare type ViewCount = {
1059
+ // @public
1060
+ type ViewCount = {
1455
1061
  name: ElementName.ViewCount;
1456
1062
  };
1457
1063
 
1458
- /**
1459
- * Represents the props available for an VoteCount element.
1460
- * @see VoteCount
1461
- */
1462
- declare type VoteCount = {
1064
+ // @public
1065
+ type VoteCount = {
1463
1066
  name: ElementName.VoteCount;
1464
1067
  };
1465
1068
 
1466
- export {};
1069
+ // (No @packageDocumentation comment for this package)
1467
1070
  ```