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