@atlaskit/smart-card 26.1.0 → 26.1.2

package/dist/types-ts4.0/i18n/zh.d.ts

@@ -0,0 +1,84 @@
+declare const _default: {
+    'fabric.linking.actions': string;
+    'fabric.linking.add_account': string;
+    'fabric.linking.cancel': string;
+    'fabric.linking.cannot_connect': string;
+    'fabric.linking.cannot_find_link': string;
+    'fabric.linking.check_this_link': string;
+    'fabric.linking.click_to_join': string;
+    'fabric.linking.click_to_join_description': string;
+    'fabric.linking.close': string;
+    'fabric.linking.connect_account_description': string;
+    'fabric.linking.connect_link_account': string;
+    'fabric.linking.connect_link_account_card_view': string;
+    'fabric.linking.connect_link_account_card_view_description': string;
+    'fabric.linking.connect_link_account_card_view_name': string;
+    'fabric.linking.connect_to': string;
+    'fabric.linking.connect_unauthorised_account_action': string;
+    'fabric.linking.connect_unauthorised_account_description': string;
+    'fabric.linking.continue': string;
+    'fabric.linking.copy_url_to_clipboard': string;
+    'fabric.linking.couldnt_load_link': string;
+    'fabric.linking.create_on_absolute': string;
+    'fabric.linking.create_on_relative': string;
+    'fabric.linking.created_by': string;
+    'fabric.linking.delete': string;
+    'fabric.linking.download': string;
+    'fabric.linking.edit': string;
+    'fabric.linking.forbidden_access': string;
+    'fabric.linking.forbidden_description': string;
+    'fabric.linking.go_back': string;
+    'fabric.linking.invalid_permissions': string;
+    'fabric.linking.invalid_permissions_description': string;
+    'fabric.linking.join_to_view': string;
+    'fabric.linking.learn_more_about_smart_links': string;
+    'fabric.linking.link_safety_warning_message': string;
+    'fabric.linking.loading': string;
+    'fabric.linking.modified_on_absolute': string;
+    'fabric.linking.modified_on_relative': string;
+    'fabric.linking.more_actions': string;
+    'fabric.linking.not_found_description': string;
+    'fabric.linking.not_found_title': string;
+    'fabric.linking.open_link_in_a_new_tab': string;
+    'fabric.linking.owned_by': string;
+    'fabric.linking.pending_request': string;
+    'fabric.linking.preview': string;
+    'fabric.linking.preview_close': string;
+    'fabric.linking.preview_max_size': string;
+    'fabric.linking.preview_min_size': string;
+    'fabric.linking.priority_blocker': string;
+    'fabric.linking.priority_critical': string;
+    'fabric.linking.priority_high': string;
+    'fabric.linking.priority_highest': string;
+    'fabric.linking.priority_low': string;
+    'fabric.linking.priority_lowest': string;
+    'fabric.linking.priority_major': string;
+    'fabric.linking.priority_medium': string;
+    'fabric.linking.priority_minor': string;
+    'fabric.linking.priority_trivial': string;
+    'fabric.linking.priority_undefined': string;
+    'fabric.linking.request_access': string;
+    'fabric.linking.request_access_description': string;
+    'fabric.linking.request_access_pending': string;
+    'fabric.linking.request_access_pending_description': string;
+    'fabric.linking.request_access_to_view': string;
+    'fabric.linking.request_denied': string;
+    'fabric.linking.request_denied_description': string;
+    'fabric.linking.restricted_link': string;
+    'fabric.linking.retry': string;
+    'fabric.linking.save': string;
+    'fabric.linking.srclink': string;
+    'fabric.linking.srclinkunknown': string;
+    'fabric.linking.try_again': string;
+    'fabric.linking.try_another_account': string;
+    'fabric.linking.unlink_account': string;
+    'fabric.linking.updated_by': string;
+    'fabric.linking.view': string;
+};
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+export default _default;

package/dist/types-ts4.0/i18n/zh_TW.d.ts

@@ -0,0 +1,84 @@
+declare const _default: {
+    'fabric.linking.actions': string;
+    'fabric.linking.add_account': string;
+    'fabric.linking.cancel': string;
+    'fabric.linking.cannot_connect': string;
+    'fabric.linking.cannot_find_link': string;
+    'fabric.linking.check_this_link': string;
+    'fabric.linking.click_to_join': string;
+    'fabric.linking.click_to_join_description': string;
+    'fabric.linking.close': string;
+    'fabric.linking.connect_account_description': string;
+    'fabric.linking.connect_link_account': string;
+    'fabric.linking.connect_link_account_card_view': string;
+    'fabric.linking.connect_link_account_card_view_description': string;
+    'fabric.linking.connect_link_account_card_view_name': string;
+    'fabric.linking.connect_to': string;
+    'fabric.linking.connect_unauthorised_account_action': string;
+    'fabric.linking.connect_unauthorised_account_description': string;
+    'fabric.linking.continue': string;
+    'fabric.linking.copy_url_to_clipboard': string;
+    'fabric.linking.couldnt_load_link': string;
+    'fabric.linking.create_on_absolute': string;
+    'fabric.linking.create_on_relative': string;
+    'fabric.linking.created_by': string;
+    'fabric.linking.delete': string;
+    'fabric.linking.download': string;
+    'fabric.linking.edit': string;
+    'fabric.linking.forbidden_access': string;
+    'fabric.linking.forbidden_description': string;
+    'fabric.linking.go_back': string;
+    'fabric.linking.invalid_permissions': string;
+    'fabric.linking.invalid_permissions_description': string;
+    'fabric.linking.join_to_view': string;
+    'fabric.linking.learn_more_about_smart_links': string;
+    'fabric.linking.link_safety_warning_message': string;
+    'fabric.linking.loading': string;
+    'fabric.linking.modified_on_absolute': string;
+    'fabric.linking.modified_on_relative': string;
+    'fabric.linking.more_actions': string;
+    'fabric.linking.not_found_description': string;
+    'fabric.linking.not_found_title': string;
+    'fabric.linking.open_link_in_a_new_tab': string;
+    'fabric.linking.owned_by': string;
+    'fabric.linking.pending_request': string;
+    'fabric.linking.preview': string;
+    'fabric.linking.preview_close': string;
+    'fabric.linking.preview_max_size': string;
+    'fabric.linking.preview_min_size': string;
+    'fabric.linking.priority_blocker': string;
+    'fabric.linking.priority_critical': string;
+    'fabric.linking.priority_high': string;
+    'fabric.linking.priority_highest': string;
+    'fabric.linking.priority_low': string;
+    'fabric.linking.priority_lowest': string;
+    'fabric.linking.priority_major': string;
+    'fabric.linking.priority_medium': string;
+    'fabric.linking.priority_minor': string;
+    'fabric.linking.priority_trivial': string;
+    'fabric.linking.priority_undefined': string;
+    'fabric.linking.request_access': string;
+    'fabric.linking.request_access_description': string;
+    'fabric.linking.request_access_pending': string;
+    'fabric.linking.request_access_pending_description': string;
+    'fabric.linking.request_access_to_view': string;
+    'fabric.linking.request_denied': string;
+    'fabric.linking.request_denied_description': string;
+    'fabric.linking.restricted_link': string;
+    'fabric.linking.retry': string;
+    'fabric.linking.save': string;
+    'fabric.linking.srclink': string;
+    'fabric.linking.srclinkunknown': string;
+    'fabric.linking.try_again': string;
+    'fabric.linking.try_another_account': string;
+    'fabric.linking.unlink_account': string;
+    'fabric.linking.updated_by': string;
+    'fabric.linking.view': string;
+};
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+export default _default;

package/dist/types-ts4.0/in-product.d.ts

@@ -0,0 +1 @@
+export { InlineCardPageObject, BlockCardPageObject, EmbedCardPageObject, inlineSmartLinkRendersTestCase, blockSmartLinkRendersTestCase, embedSmartLinkRendersTestCase, } from './__tests_external__';

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,23 @@
+import { JsonLd } from 'json-ld-types';
+export declare type ResolveResponse = JsonLd.Response;
+export { SmartCardProvider as Provider, SmartCardContext, useSmartLinkAnalytics, } from './state';
+export type { ProviderProps, CardType } from './state';
+export type { CardAdf, InlineCardAdf, BlockCardAdf, EmbedCardAdf, } from '@atlaskit/linking-common';
+export { APIError } from '@atlaskit/linking-common';
+export { CardClient as Client } from '@atlaskit/link-provider';
+export { Card } from './view/Card';
+export type { CardProps, CardAppearance, CardPlatform } from './view/Card';
+export { SmartCardContext as Context } from '@atlaskit/link-provider';
+export type { CardContext } from '@atlaskit/link-provider';
+export { EmbedResizeMessageListener } from './view/EmbedCard/EmbedResizeMessageListener';
+export { embedHeaderHeight } from './view/EmbedCard/components/styled';
+export { SmartLinkEvents } from './utils/analytics/analytics';
+export { useSmartLinkEvents } from './view/SmartLinkEvents/useSmartLinkEvents';
+export { contentFooterClassName, metadataListClassName, blockCardResolvingViewClassName, blockCardResolvedViewClassName, blockCardForbiddenViewClassName, blockCardIconImageClassName, blockCardResolvedViewByClassName, blockCardForbiddenViewLinkClassName, blockCardContentClassName, blockCardContentHeaderClassName, blockCardContentHeaderNameClassName, blockCardNotFoundViewClassName, blockCardErroredViewClassName, } from './classNames';
+export { loadingPlaceholderClassName } from './view/CardWithUrl/component-lazy/LazyFallback';
+export { ActionName, ElementName, MediaPlacement, SmartLinkDirection, SmartLinkPosition, SmartLinkSize, SmartLinkTheme, } from './constants';
+export { MetadataBlock, PreviewBlock, SnippetBlock, TitleBlock, FooterBlock, } from './view/FlexibleCard/components/blocks';
+export type { ActionItem, ElementItem, OnActionMenuOpenChangeOptions, } from './view/FlexibleCard/components/blocks/types';
+export type { AnalyticsAction, AnalyticsActionSubject, AnalyticsPayload, AnalyticsHandler, } from './utils/types';
+/** @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-661 Internal documentation for deprecation (no external access)} */
+export { editorCardProvider, EditorCardProvider, } from '@atlaskit/link-provider';

package/dist/types-ts4.0/linkUrl.d.ts

@@ -0,0 +1,2 @@
+export { default } from './view/LinkUrl';
+export type { LinkUrlProps } from './view/LinkUrl/types';

package/dist/types-ts4.0/messages.d.ts

@@ -0,0 +1,8 @@
+import { MessageDescriptor } from 'react-intl-next';
+export declare type RequestAccessMessageKey = 'click_to_join' | 'click_to_join_description' | 'forbidden_description' | 'request_access' | 'request_access_description' | 'request_access_pending' | 'request_access_pending_description' | 'request_denied_description';
+export declare type MessageKey = 'cannot_find_link' | 'connect_link_account_card' | 'connect_link_account_card_name' | 'connect_link_account_card_description' | 'connect_unauthorised_account_action' | 'connect_unauthorised_account_description' | 'connect_unauthorised_account_description_no_provider' | 'continue' | 'copy_url_to_clipboard' | 'could_not_load_link' | 'download' | 'go_back' | 'invalid_permissions' | 'invalid_permissions_description' | 'join_to_view' | 'connect_link_account' | 'created_by' | 'created_on_relative' | 'created_on_absolute' | 'check_this_link' | 'delete' | 'edit' | 'learn_more_about_smart_links' | 'loading' | 'link_safety_warning_message' | 'modified_by' | 'modified_on_relative' | 'modified_on_absolute' | 'more_actions' | 'not_found_title' | 'not_found_description' | 'open_issue_in_jira' | 'open_link_in_a_new_tab' | 'owned_by' | 'preview' | 'preview_close' | 'preview_max_size' | 'preview_min_size' | 'priority_blocker' | 'priority_critical' | 'priority_high' | 'priority_highest' | 'priority_low' | 'priority_lowest' | 'priority_major' | 'priority_medium' | 'priority_minor' | 'priority_trivial' | 'priority_undefined' | 'forbidden_access' | 'pending_request' | 'restricted_link' | 'request_access_to_view' | 'request_denied' | 'status_change_load_error' | 'status_change_permission_error' | 'status_change_update_error' | 'try_again' | 'try_another_account' | 'view' | 'viewIn' | 'viewOriginal' | 'actions' | 'add_account' | 'cancel' | 'close' | 'connect_to' | 'connect_account_description' | 'retry' | 'save' | 'unlink_account' | RequestAccessMessageKey;
+declare type Messages = {
+    [K in MessageKey]: MessageDescriptor;
+};
+export declare const messages: Messages;
+export {};

package/dist/types-ts4.0/model/invoke-handler.d.ts

@@ -0,0 +1,3 @@
+import { JsonLd } from 'json-ld-types';
+import { InvokeClientOpts, InvokeServerOpts } from './invoke-opts';
+export declare type InvokeHandler = (opts: InvokeClientOpts | InvokeServerOpts) => Promise<JsonLd.Response | void>;

package/dist/types-ts4.0/model/invoke-opts.d.ts

@@ -0,0 +1,17 @@
+import { InvokePayload, ServerActionOpts } from '@atlaskit/linking-common';
+import { CardInnerAppearance } from '../view/Card/types';
+export declare type InvokeType = 'server' | 'client';
+export declare type InvokeOpts<T> = {
+    type: InvokeType;
+    source?: CardInnerAppearance;
+} & InvokePayload<T>;
+export declare type InvokeClientOpts = InvokeOpts<ClientActionOpts> & {
+    type: 'client';
+};
+export declare type InvokeServerOpts = InvokeOpts<ServerActionOpts> & {
+    type: 'server';
+};
+export interface ClientActionOpts {
+    type: string;
+    promise: <T>(opts?: T) => Promise<void>;
+}

package/dist/types-ts4.0/ssr.d.ts

@@ -0,0 +1,6 @@
+import { FC } from 'react';
+import type { CardProps } from './types';
+export declare type CardSSRProps = CardProps & {
+    url: string;
+};
+export declare const CardSSR: FC<CardSSRProps>;

package/dist/types-ts4.0/state/actions/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const ANALYTICS_RESOLVING = "resolving";
+export declare const ANALYTICS_ERROR = "errored";
+export declare const ANALYTICS_FALLBACK = "fallback";
+export declare const ERROR_MESSAGE_OAUTH = "Provider.authFlow is not set to OAuth2.";
+export declare const ERROR_MESSAGE_FATAL = "Fatal error resolving URL";
+export declare const ERROR_MESSAGE_METADATA = "Error resolving metadata.";

package/dist/types-ts4.0/state/actions/index.d.ts

@@ -0,0 +1,11 @@
+import { JsonLd } from 'json-ld-types';
+import { InvokeServerOpts, InvokeClientOpts } from '../../model/invoke-opts';
+import { AnalyticsFacade } from '../analytics';
+import { CardInnerAppearance } from '../../view/Card/types';
+export declare const useSmartCardActions: (id: string, url: string, analytics: AnalyticsFacade) => {
+    register: () => Promise<void>;
+    reload: () => void;
+    authorize: (appearance: CardInnerAppearance) => void;
+    invoke: (opts: InvokeClientOpts | InvokeServerOpts, appearance: CardInnerAppearance) => Promise<JsonLd.Response | void>;
+    loadMetadata: () => Promise<void> | undefined;
+};

package/dist/types-ts4.0/state/actions/types.d.ts

@@ -0,0 +1,2 @@
+import { CardActionType } from '@atlaskit/linking-common';
+export type { CardActionType };

package/dist/types-ts4.0/state/analytics/index.d.ts

@@ -0,0 +1,3 @@
+export { startUfoExperience, succeedUfoExperience, failUfoExperience, addMetadataToExperience, } from './ufoExperiences';
+export { useSmartLinkAnalytics } from './useSmartLinkAnalytics';
+export type { AnalyticsFacade } from './useSmartLinkAnalytics';

package/dist/types-ts4.0/state/analytics/types.d.ts

@@ -0,0 +1,9 @@
+import { DestinationSubproduct, DestinationProduct } from '../../utils/analytics/types';
+export interface CommonEventProps {
+    definitionId?: string;
+    extensionKey?: string;
+    resourceType?: string;
+    destinationSubproduct?: DestinationSubproduct | string;
+    destinationProduct?: DestinationProduct | string;
+    location?: string;
+}

package/dist/types-ts4.0/state/analytics/ufoExperiences.d.ts

@@ -0,0 +1,7 @@
+import { CustomData } from '@atlaskit/ufo';
+declare type UfoExperienceName = 'smart-link-rendered' | 'smart-link-authenticated' | 'smart-link-action-invocation';
+export declare const startUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData | undefined) => void;
+export declare const succeedUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData | undefined) => void;
+export declare const failUfoExperience: (experienceName: UfoExperienceName, id: string, properties?: CustomData | undefined) => void;
+export declare const addMetadataToExperience: (experienceName: UfoExperienceName, id: string, properties: CustomData) => void;
+export {};

package/dist/types-ts4.0/state/analytics/useDispatchAnalytics.d.ts

@@ -0,0 +1,11 @@
+import { AnalyticsHandler } from '../../';
+/**
+ * Hook designed to use a handler if provided (ideally not)
+ * Use this for the short-term to support deprecating `analyticsHandler`s that are being provided externally,
+ * but fallback to the dispatch provided by `useAnalyticsEvents`
+ *
+ * In future, potentially use this hook to feature flag the channel we are dispatching to
+ */
+export declare const useDispatchAnalytics: (handler?: AnalyticsHandler | undefined) => {
+    dispatchAnalytics: AnalyticsHandler;
+};

package/dist/types-ts4.0/state/analytics/useMouseDownEvent.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const useMouseDownEvent: <T extends import("react").MouseEventHandler<Element>>(onMouseDown?: T | undefined) => (event: Parameters<T>[0]) => void;
+export default useMouseDownEvent;

package/dist/types-ts4.0/state/analytics/useSmartLinkAnalytics.d.ts

@@ -0,0 +1,284 @@
+import { AnalyticsHandler, AnalyticsName, AnalyticsPayload } from '../../utils/types';
+import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps } from '../../utils/analytics/types';
+import { SmartLinkActionType } from '@atlaskit/linking-types';
+/**
+ * This hook provides usage of Smart Link analytics outside of the Card component.
+ * Can be provided to Card via the analyticsEvents prop to change the analytics events.
+ *
+ * @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
+ * This hook's external use is deprecated and may no longer be exported from this package in future releases.
+ * Please avoid using it in conjunction with the `analyticsEvents` prop.
+ *
+ * @param url URL of the link
+ * @param dispatchAnalytics dispatchAnalytics function
+ * @param id fallback id of the events sent if no id is available
+ * @param defaultLocation location attribute to be used
+ * @returns
+ */
+export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: AnalyticsHandler | undefined, id?: string | undefined, defaultLocation?: string | undefined) => {
+    ui: {
+        /**
+         * This fires an event that represents when a user clicks on the authentication
+         * call to action with no current authenticated account. (i.e. Connect to Preview).
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @returns
+         */
+        authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
+        /**
+         * This fires an event that represents when a user clicks on the authentication
+         * call to action with a forbidden authenticated account. (i.e. Try another account).
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @returns
+         */
+        authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthAlternateAccountEventProps) => void;
+        /**
+         * This fires an event that represents when a user
+         * click a button.
+         * @param data A partial analytics event payload
+         */
+        buttonClickedEvent: (data: Partial<AnalyticsPayload> & {
+            actionSubjectId: Required<string>;
+        }) => void;
+        /**
+         * This fires an event that represents when a user clicks on a Smart Link.
+         * @param id The unique ID for this Smart Link.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param isModifierKeyPressed Whether a modifier key was pressed when clicking the Smart Link.
+         * @param location Where the Smart Link is currently rendered.
+         * @param destinationProduct The product the Smart Link is linked to.
+         * @returns
+         */
+        cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
+        /**
+         * This fires an event that represents when a user dwells their cursor on a Smart Link's iframe.
+         * @param id The unique ID for this Smart Link.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param location Where the Smart Link is currently rendered.
+         * @param destinationProduct The product the Smart Link is linked to.
+         * @param dwellTime Total seconds that the user has dwelled on this iframe
+         * @param dwellPercentVisible Percentage element was visible at end of dwell
+         * @returns
+         */
+        iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: UiIframeDwelledEventProps) => void;
+        /**
+         * This fires an event that represents when a user clicks or tabs into a Smart Link's iframe.
+         * @param id The unique ID for this Smart Link.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param status What status the Smart Link is currently in (e.g. resolved, unresolved)
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param location Where the Smart Link is currently rendered.
+         * @param destinationProduct The product the Smart Link is linked to.
+         * @returns
+         */
+        iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: UiIframeFocusedEventProps) => void;
+        /**
+         * This fires an event that represents when a user clicks on a Smart Link action.
+         * Note: This also starts the UFO smart-link-action-invocation experience.
+         * @param id The unique ID for this Smart Link.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param actionType The type of the action that was clicked, e.g. PreviewAction
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param invokeType Whether the action invoked made a call to a server.
+         * @returns
+         */
+        actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
+        /**
+         * This fires an event that represents when a user clicks on a hover preview's "navigate to link" button.
+         * https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3206743323/Analytics+Metrics+-+Hover+Previews
+         * @param previewDisplay What format the preview is in.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param previewInvokeMethod How the preview was triggered.
+         */
+        hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
+        /**
+         * This fires an event that represents when a user closed the authentication window without authenticating after opening it.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @returns
+         */
+        closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => void;
+        /**
+         * This fires an event that represents when a user close a modal.
+         * @param data A partial analytics event payload
+         */
+        modalClosedEvent: (data: Partial<AnalyticsPayload> & {
+            actionSubjectId: Required<string>;
+        }) => void;
+        /**
+         * This fires an event that represents when a Smart Link was rendered successfully.
+         * Note: this fires even if the Smart Link request errored out.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param id The unique ID for this Smart Link.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         */
+        renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderSuccessEventProps) => void;
+        /**
+         * This fires an event that represents when a Smart Link renders unsuccessfuly.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param id The unique ID for this Smart Link.
+         * @param error: An error representing why the Smart Link render failed.
+         * @param errorInfo: Additional details about the error including the stack trace.
+         */
+        renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
+        /**
+         * This fires an event that represents a hover preview being opened.
+         * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param previewInvokeMethod How the preview was triggered.
+         * @returns
+         */
+        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
+        /**
+         * This fires an event that represents a hover preview being dismissed.
+         * @param hoverDisplay Whether the hover preview was displayed as a card or embed.
+         * @param hoverTime The duration that the user hovered over a Smart Link before the preview was dismissed.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resolver invoked.
+         * @param previewInvokeMethod How the preview was triggered.
+         * @returns
+         */
+        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
+        /**
+         * Fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param location The location where a link is displayed (jiraWebLinks, confluencePages etc)
+         */
+        learnMoreClickedEvent: () => void;
+        /**
+         * Fires an event that represent a click was performed on a Status Lozenge
+         */
+        smartLinkLozengeActionClickedEvent: () => void;
+        /**
+         * Fires an event that represent a click was performed on a Status Lozenge's dropdown item
+         */
+        smartLinkLozengeActionListItemClickedEvent: () => void;
+        /**
+         * Fires an event that represent a click was performed on a Status Lozenge open preview button
+         */
+        smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
+    };
+    operational: {
+        /**
+         * This fires an event that represents an action being successfully invoked.
+         * @param id The unique ID for this Smart Link.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param actionType The type of action invoked, e.g. PreviewAction
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         */
+        invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
+        /**
+         * This fires an event that represents an action being unsuccessfully invoked.
+         * @param id The unique ID for this Smart Link.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param actionType The type of action invoked, e.g. PreviewAction
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param reason The reason the invocation failed.
+         */
+        invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
+        /**
+         * This fires an event that represents an account successfully being connected via a Smart Link.
+         * @param id The unique ID for this Smart Link.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         */
+        connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => void;
+        /**
+         * This fires an event that represents an account unsuccessfully being connected.
+         * @param id The unique ID for this Smart Link.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param reason The reason why the Smart Link connect account failed.
+         */
+        connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectFailedEventProps) => void;
+        /**
+         * This fires an event which represents a Smart Link request succeeding or failing based on the status.
+         * @param id The unique ID for this Smart Link.
+         * @param status The status of the Smart Link.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
+         * @param error An error representing why the Smart Link request failed.
+         */
+        instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
+        /**
+         * This fires an event that represents when a Smart Link renders unsuccessfuly.
+         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
+         * @param id The unique ID for this Smart Link.
+         * @param error: An error representing why the Smart Link render failed.
+         * @param errorInfo: Additional details about the error including the stack trace.
+         */
+        chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
+    };
+    track: {
+        /**
+         * This fires an event which represents a user connecting their account to view a Smart Link.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @returns
+         */
+        appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => void;
+        /**
+         * This fires an event which represents a user starting the Smart Link connect account process.
+         * @param location a location where the Smart Link auth action was initiated.
+         * @param extensionKey The extensionKey of the Smart Link resolver invoked.
+         * @returns
+         */
+        appAccountAuthStarted: ({ extensionKey, location, }: TrackAppAccountConnectedProps) => void;
+        /**
+         * This fires a tracking event before and after link updated.
+         */
+        linkUpdated: (props: CommonEventProps & {
+            [key: string]: any;
+        }) => void;
+        /**
+         * This fires a tracking event before an action invoke api call is made
+         */
+        smartLinkQuickActionStarted: (props: {
+            smartLinkActionType: SmartLinkActionType;
+        }) => void;
+        /**
+         * This fires a tracking event after an action invoke api call is successful
+         */
+        smartLinkQuickActionSuccess: (props: {
+            smartLinkActionType: SmartLinkActionType;
+        }) => void;
+        /**
+         * This fires a tracking event after an action invoke api call has failed
+         */
+        smartLinkQuickActionFailed: (props: {
+            smartLinkActionType: SmartLinkActionType;
+        }) => void;
+    };
+    screen: {
+        /**
+         * This fires an event which represents the connect account page being opened.
+         * @param definitionId The definitionId of the Smart Link resolver invoked.
+         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
+         * @returns
+         */
+        authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ScreenAuthPopupEventProps) => void;
+        /**
+         * This fires an event that represents when a user view a modal.
+         * @param data A partial analytics event payload
+         */
+        modalViewedEvent: (data: Partial<AnalyticsPayload> & {
+            name: Extract<AnalyticsName, 'embedPreviewModal'>;
+        }) => void;
+    };
+};
+export declare type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;

package/dist/types-ts4.0/state/config/index.d.ts

@@ -0,0 +1,2 @@
+import { CardContext } from '@atlaskit/link-provider';
+export declare const useSmartLinkConfig: () => CardContext['config'] | undefined;