@atlaskit/smart-card 18.0.12 → 18.0.15

package/dist/esm/view/HoverCard/index.js

@@ -11,9 +11,18 @@ import { SmartLinkSize, ActionName } from '../../constants';
 import { useSmartLinkActions } from '../../state/hooks-external/useSmartLinkActions';
 import { HoverCardContainer } from './styled';
 import ShortcutIcon from '@atlaskit/icon/glyph/shortcut';
-export var HoverCard = function HoverCard(_ref) {
+import { withAnalyticsEvents, withAnalyticsContext } from '@atlaskit/analytics-next';
+import { fireSmartLinkEvent } from '../../utils/analytics';
+import { useSmartCardState as useLinkState } from '../../state/store';
+import { useSmartLinkAnalytics } from '../../state/analytics';
+import { getExtensionKey, getDefinitionId } from '../../state/helpers';
+export var HoverCardComponent = function HoverCardComponent(_ref) {
   var children = _ref.children,
-      url = _ref.url;
+      url = _ref.url,
+      createAnalyticsEvent = _ref.createAnalyticsEvent;
+  var analyticsHandler = useCallback(function (analyticsPayload) {
+    fireSmartLinkEvent(analyticsPayload, createAnalyticsEvent);
+  }, [createAnalyticsEvent]);
   var delay = 300;
 
   var _React$useState = React.useState(false),
@@ -23,26 +32,45 @@ export var HoverCard = function HoverCard(_ref) {
 
   var fadeOutTimeoutId = useRef();
   var fadeInTimeoutId = useRef();
+  var cardOpenTime = useRef();
+  var linkState = useLinkState(url);
+  var analytics = useSmartLinkAnalytics(analyticsHandler);
+  var extensionKey = useMemo(function () {
+    return getExtensionKey(linkState.details);
+  }, [linkState]);
+  var definitionId = useMemo(function () {
+    return getDefinitionId(linkState.details);
+  }, [linkState]);
   var initHideCard = useCallback(function () {
     if (fadeInTimeoutId.current) {
       clearTimeout(fadeInTimeoutId.current);
     }
 
     fadeOutTimeoutId.current = setTimeout(function () {
+      //Check its previously open to avoid firing events when moving between the child and hover card components
+      if (isOpen === true && cardOpenTime.current) {
+        var hoverTime = Date.now() - cardOpenTime.current;
+        analytics.ui.hoverCardDismissedEvent('card', hoverTime, definitionId, extensionKey);
+      }
+
       setIsOpen(false);
     }, delay);
-  }, [delay]);
+  }, [delay, isOpen, definitionId, extensionKey, analytics]);
   var initShowCard = useCallback(function () {
     if (fadeOutTimeoutId.current) {
       clearTimeout(fadeOutTimeoutId.current);
     }
 
     fadeInTimeoutId.current = setTimeout(function () {
+      //Check if its previously closed to avoid firing events when moving between the child and hover card components
+      if (isOpen === false) {
+        cardOpenTime.current = Date.now();
+        analytics.ui.hoverCardViewedEvent('card', definitionId, extensionKey);
+      }
+
       setIsOpen(true);
     }, delay);
-  }, [delay]); //TODO: EDM-2905: Add analytics events
-
-  var analyticsHandler = useCallback(function () {}, []);
+  }, [delay, isOpen, definitionId, extensionKey, analytics]);
   var linkActions = useSmartLinkActions({
     url: url,
     appearance: 'block',
@@ -69,11 +97,12 @@ export var HoverCard = function HoverCard(_ref) {
       }),
       iconPosition: 'before',
       onClick: function onClick() {
-        return window.open(url, '_blank');
+        window.open(url, '_blank');
+        analytics.ui.hoverCardOpenLinkClickedEvent('card', definitionId, extensionKey);
       },
       testId: 'hover-card-open-button'
     };
-  }, [url]);
+  }, [url, definitionId, extensionKey, analytics]);
 
   var cardComponent = function cardComponent() {
     return jsx("div", {
@@ -101,7 +130,7 @@ export var HoverCard = function HoverCard(_ref) {
     testId: "hover-card",
     isOpen: isOpen,
     onClose: onClose,
-    placement: "bottom",
+    placement: "bottom-start",
     content: cardComponent,
     trigger: function trigger(triggerProps) {
       return jsx("span", _extends({}, triggerProps, {
@@ -110,4 +139,7 @@ export var HoverCard = function HoverCard(_ref) {
       }), children);
     }
   });
-};
+};
+export var HoverCard = withAnalyticsContext({
+  source: 'smartLinkPreviewHoverCard'
+})(withAnalyticsEvents()(HoverCardComponent));

package/dist/esm/view/HoverCard/styled.js

@@ -3,4 +3,5 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
 var _templateObject;
 
 import { css } from '@emotion/core';
-export var HoverCardContainer = css(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  background: none;\n  border-width: 0;\n  max-width: 500px;\n  padding: 0;\n"])));
+import { loadingPlaceholderClassName } from '../../index';
+export var HoverCardContainer = css(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  background: none;\n  border-width: 0;\n  max-width: 350px;\n  padding: 0;\n\n  .", " {\n    display: none;\n  }\n"])), loadingPlaceholderClassName);

package/dist/types/client/errors.d.ts

@@ -1,8 +1,9 @@
+import { ErrorType } from './types/responses';
 export declare type APIErrorKind = 'fatal' | 'auth' | 'error' | 'fallback';
 export declare class APIError extends Error {
     readonly kind: APIErrorKind;
     readonly hostname: string;
     readonly message: string;
-    readonly type?: "ResolveBadRequestError" | "ResolveAuthError" | "ResolveUnsupportedError" | "ResolveFailedError" | "ResolveTimeoutError" | "InternalServerError" | "UnexpectedError" | undefined;
-    constructor(kind: APIErrorKind, hostname: string, message: string, type?: "ResolveBadRequestError" | "ResolveAuthError" | "ResolveUnsupportedError" | "ResolveFailedError" | "ResolveTimeoutError" | "InternalServerError" | "UnexpectedError" | undefined);
+    readonly type?: ErrorType | undefined;
+    constructor(kind: APIErrorKind, hostname: string, message: string, type?: ErrorType | undefined);
 }

package/dist/types/extractors/block/index.d.ts

@@ -4,6 +4,6 @@ import { ExtractBlockOpts } from './types';
 import { CardProviderRenderers } from '../../state/context/types';
 import { BlockCardResolvedViewProps } from '../../view/BlockCard';
 import { ActionProps } from '../../view/BlockCard/components/Action';
-export declare const extractBlockActions: (props: BlockCardResolvedViewProps, jsonLd: JsonLd.Data.BaseData, opts?: ExtractBlockOpts | undefined, platform?: "web" | "mobile" | undefined) => ActionProps[];
+export declare const extractBlockActions: (props: BlockCardResolvedViewProps, jsonLd: JsonLd.Data.BaseData, opts?: ExtractBlockOpts | undefined, platform?: JsonLd.Primitives.Platforms | undefined) => ActionProps[];
 export declare const extractBlockUsers: (jsonLd: JsonLd.Data.BaseData) => LinkPerson[] | undefined;
-export declare const extractBlockProps: (jsonLd: JsonLd.Data.BaseData, meta?: JsonLd.Meta.BaseMeta | undefined, opts?: ExtractBlockOpts | undefined, renderers?: CardProviderRenderers | undefined, platform?: "web" | "mobile" | undefined) => BlockCardResolvedViewProps;
+export declare const extractBlockProps: (jsonLd: JsonLd.Data.BaseData, meta?: JsonLd.Meta.BaseMeta | undefined, opts?: ExtractBlockOpts | undefined, renderers?: CardProviderRenderers | undefined, platform?: JsonLd.Primitives.Platforms | undefined) => BlockCardResolvedViewProps;

package/dist/types/extractors/common/__mocks__/jsonld.d.ts

@@ -27,11 +27,11 @@ export declare const TEST_ASSIGN_ACTION: JsonLd.Data.BaseData['schema:potentialA
 export declare const TEST_NO_ID_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
 export declare const TEST_DOCUMENT_WITH_ACTIONS: {
     'schema:potentialAction': any[];
-    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | ("Object" | "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink")[] | ("Document" | "schema:DigitalDocument")[];
+    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | (JsonLd.Data.DocumentChildType | JsonLd.Data.DocumentParentType)[] | ("Document" | "schema:DigitalDocument")[];
     'schema:fileFormat'?: string | undefined;
     'atlassian:fileSize'?: number | undefined;
     'schema:dateCreated'?: string | undefined;
-    'atlassian:updatedBy'?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Person<any> | undefined;
+    'atlassian:updatedBy'?: JsonLd.Primitives.Link | JsonLd.Primitives.Person<any> | undefined;
     'schema:commentCount'?: number | undefined;
     'atlassian:isDeleted'?: boolean | undefined;
     'atlassian:dateViewed'?: string | undefined;
@@ -44,38 +44,28 @@ export declare const TEST_DOCUMENT_WITH_ACTIONS: {
     'atlassian:visitUrl'?: string | undefined;
     'atlassian:titlePrefix'?: JsonLd.Data.TitlePrefix | undefined;
     '@id'?: string | undefined;
-    attachment?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    attributedTo?: (string & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.Object<any> & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.LinkModel & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | ((string & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.Object<any> & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.LinkModel & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }))[] | undefined;
-    audience?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    bcc?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    bto?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    cc?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    context?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | undefined;
-    generator?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | undefined;
-    icon?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Image | undefined;
-    image?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Image | undefined;
-    inReplyTo?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    location?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    oneOf?: (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    anyOf?: (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    closed?: string | boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | undefined;
-    preview?: string | (JsonLd.Primitives.Object<any> & JsonLd.Primitives.PreviewExtension) | (JsonLd.Primitives.LinkModel & JsonLd.Primitives.PreviewExtension) | undefined;
+    attachment?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    attributedTo?: JsonLd.Primitives.Property<(JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link) & {
+        actor?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    }> | undefined;
+    audience?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    bcc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    bto?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    cc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    context?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
+    generator?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
+    icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
+    image?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
+    inReplyTo?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    location?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    oneOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
+    anyOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
+    closed?: boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
+    preview?: string | ((JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel) & JsonLd.Primitives.PreviewExtension) | undefined;
     replies?: JsonLd.Primitives.Collection<any> | undefined;
-    tag?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    to?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    url?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Link[] | undefined;
+    tag?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    to?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    url?: JsonLd.Primitives.Property<JsonLd.Primitives.Link> | undefined;
     content?: string | undefined;
     contentMap?: Record<string, string> | undefined;
     name?: string | undefined;
@@ -92,14 +82,14 @@ export declare const TEST_DOCUMENT_WITH_ACTIONS: {
 export declare const PREVIEW: JsonLd.Data.BaseData['preview'];
 export declare const TEST_DOCUMENT_WITH_PREVIEW: {
     preview: JsonLd.Primitives.LinkModel & JsonLd.Primitives.PreviewExtension;
-    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | ("Object" | "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink")[] | ("Document" | "schema:DigitalDocument")[];
+    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | (JsonLd.Data.DocumentChildType | JsonLd.Data.DocumentParentType)[] | ("Document" | "schema:DigitalDocument")[];
     'schema:fileFormat'?: string | undefined;
     'atlassian:fileSize'?: number | undefined;
     'schema:dateCreated'?: string | undefined;
-    'atlassian:updatedBy'?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Person<any> | undefined;
+    'atlassian:updatedBy'?: JsonLd.Primitives.Link | JsonLd.Primitives.Person<any> | undefined;
     'schema:commentCount'?: number | undefined;
     'atlassian:isDeleted'?: boolean | undefined;
-    'schema:potentialAction'?: import("schema-dts").DeleteAction | import("schema-dts").ViewAction | import("schema-dts").DownloadAction | import("schema-dts").WatchAction | import("schema-dts").CommentAction | import("schema-dts").ShareAction | JsonLd.Data.DocumentAction[] | undefined;
+    'schema:potentialAction'?: JsonLd.Primitives.Property<JsonLd.Data.DocumentAction> | undefined;
     'atlassian:dateViewed'?: string | undefined;
     'atlassian:reactCount'?: number | undefined;
     'atlassian:state'?: string | undefined;
@@ -110,37 +100,27 @@ export declare const TEST_DOCUMENT_WITH_PREVIEW: {
     'atlassian:visitUrl'?: string | undefined;
     'atlassian:titlePrefix'?: JsonLd.Data.TitlePrefix | undefined;
     '@id'?: string | undefined;
-    attachment?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    attributedTo?: (string & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.Object<any> & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.LinkModel & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | ((string & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.Object<any> & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }) | (JsonLd.Primitives.LinkModel & {
-        actor?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    }))[] | undefined;
-    audience?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    bcc?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    bto?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    cc?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    context?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | undefined;
-    generator?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | undefined;
-    icon?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Image | undefined;
-    image?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Image | undefined;
-    inReplyTo?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    location?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    oneOf?: (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    anyOf?: (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    closed?: string | boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | undefined;
+    attachment?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    attributedTo?: JsonLd.Primitives.Property<(JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link) & {
+        actor?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    }> | undefined;
+    audience?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    bcc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    bto?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    cc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    context?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
+    generator?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
+    icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
+    image?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
+    inReplyTo?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    location?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    oneOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
+    anyOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
+    closed?: boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
     replies?: JsonLd.Primitives.Collection<any> | undefined;
-    tag?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    to?: string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel | (string | JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel)[] | undefined;
-    url?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Link[] | undefined;
+    tag?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    to?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
+    url?: JsonLd.Primitives.Property<JsonLd.Primitives.Link> | undefined;
     content?: string | undefined;
     contentMap?: Record<string, string> | undefined;
     name?: string | undefined;

package/dist/types/extractors/common/actions/extractPreviewAction.d.ts

@@ -2,4 +2,4 @@ import { JsonLd } from 'json-ld-types';
 import { InvokeHandler } from '../../../model/invoke-handler';
 import { AnalyticsHandler } from '../../../utils/types';
 import { BlockCardResolvedViewProps } from '../../../view/BlockCard';
-export declare const extractPreviewAction: (extensionKey: string | undefined, viewProps: BlockCardResolvedViewProps, jsonLd: JsonLd.Data.BaseData, handleInvoke: InvokeHandler, handleAnalytics: AnalyticsHandler, testId?: string | undefined, platform?: "web" | "mobile" | undefined) => import("../../../view/BlockCard/components/Action").ActionProps | undefined;
+export declare const extractPreviewAction: (extensionKey: string | undefined, viewProps: BlockCardResolvedViewProps, jsonLd: JsonLd.Data.BaseData, handleInvoke: InvokeHandler, handleAnalytics: AnalyticsHandler, testId?: string | undefined, platform?: JsonLd.Primitives.Platforms | undefined) => import("../../../view/BlockCard/components/Action").ActionProps | undefined;

package/dist/types/extractors/common/title-prefix/extractTitlePrefix.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
 import { JsonLd } from 'json-ld-types';
 import { CardProviderRenderers } from '../../../state/context/types';
-export declare const extractTitlePrefix: (jsonLd: JsonLd.Data.BaseData, renderers?: CardProviderRenderers | undefined, type?: "embed" | "block" | "inline" | undefined) => string | React.ReactNode | undefined;
+import { CardAppearance } from '../../../view/Card';
+export declare const extractTitlePrefix: (jsonLd: JsonLd.Data.BaseData, renderers?: CardProviderRenderers | undefined, type?: CardAppearance | undefined) => string | React.ReactNode | undefined;

package/dist/types/extractors/embed/index.d.ts

@@ -1,3 +1,3 @@
 import { JsonLd } from 'json-ld-types';
 import { EmbedCardResolvedViewProps } from '../../view/EmbedCard/views/ResolvedView';
-export declare const extractEmbedProps: (jsonLd: JsonLd.Data.BaseData, meta?: JsonLd.Meta.BaseMeta | undefined, platform?: "web" | "mobile" | undefined) => EmbedCardResolvedViewProps;
+export declare const extractEmbedProps: (jsonLd: JsonLd.Data.BaseData, meta?: JsonLd.Meta.BaseMeta | undefined, platform?: JsonLd.Primitives.Platforms | undefined) => EmbedCardResolvedViewProps;

package/dist/types/extractors/flexible/icon/extract-url-icon.d.ts

@@ -1,4 +1,4 @@
 import { JsonLd } from 'json-ld-types';
 import { IconDescriptor } from './types';
-declare const extractUrlIcon: (icon?: string | JsonLd.Primitives.LinkModel | JsonLd.Primitives.Image | undefined, label?: string | undefined) => IconDescriptor | undefined;
+declare const extractUrlIcon: (icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined, label?: string | undefined) => IconDescriptor | undefined;
 export default extractUrlIcon;

package/dist/types/state/analytics/useSmartLinkAnalytics.d.ts

@@ -1,5 +1,6 @@
 import { AnalyticsHandler } from '../../utils/types';
 import { CardInnerAppearance } from '../../view/Card/types';
+import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
 import { CardType } from '../store/types';
 import { APIError } from '../../client/errors';
 import { InvokeType } from '../../model/invoke-opts';
@@ -9,8 +10,11 @@ export declare const useSmartLinkAnalytics: (dispatchAnalytics: AnalyticsHandler
         authAlternateAccountEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
         cardClickedEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined, isModifierKeyPressed?: boolean | undefined) => void;
         actionClickedEvent: (id: string, extensionKey: string, actionType: string, display: CardInnerAppearance, invokeType: InvokeType) => void;
+        hoverCardOpenLinkClickedEvent: (previewDisplay: PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => void;
         closedAuthEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
         renderSuccessEvent: (display: CardInnerAppearance, id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        hoverCardViewedEvent: (hoverDisplay: PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => void;
+        hoverCardDismissedEvent: (hoverDisplay: PreviewDisplay, hoverTime: number, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => void;
     };
     operational: {
         resolvedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;

package/dist/types/state/flexible-ui-context/index.d.ts

@@ -1,4 +1,8 @@
 /// <reference types="react" />
 import { FlexibleUiDataContext } from './types';
+/**
+ * This provides the data that will be used by Smart Links Flexible UI to populate it's
+ * underlying elements.
+ */
 export declare const FlexibleUiContext: import("react").Context<FlexibleUiDataContext | undefined>;
 export declare const useFlexibleUiContext: () => FlexibleUiDataContext | undefined;

package/dist/types/state/flexible-ui-context/types.d.ts

@@ -1,26 +1,128 @@
 import { LinkLozenge } from '../../extractors/common/lozenge/types';
 import { LinkPerson } from '../../extractors/common/person/types';
 import { IconType, MediaType } from '../../constants';
+/**
+ * This provides the data that will be used by Smart Links Flexible UI to populate it's
+ * underlying elements.
+ */
 export declare type FlexibleUiDataContext = {
+    /**
+     * An array containing data used to populate the AuthorGroup element.
+     * @see AvatarGroup
+     */
     authorGroup?: LinkPerson[];
+    /**
+     * An array containing a @type {LinkPerson} used to populate the CollaboratorGroup element.
+     * @see CollaboratorGroup
+     */
     collaboratorGroup?: LinkPerson[];
+    /**
+     * Contains the number of comments of the linked resource.
+     * @type number
+     * @see CommentCount
+     */
     commentCount?: number;
+    /**
+     * Contains the number of views of the linked resource.
+     * @type number
+     * @see ViewCount
+     */
     viewCount?: number;
+    /**
+     * Contains the number of react of the linked resource.
+     * @type number
+     * @see ReactCount
+     */
     reactCount?: number;
+    /**
+     * Contains the number of votes of the linked resource.
+     * @type number
+     * @see VoteCount
+     */
     voteCount?: number;
+    /**
+     * Contains the name of the entity that created the resource.
+     * @type string
+     * @see CreatedBy
+     */
     createdBy?: string;
+    /**
+     * Contains the ISO timestamp of when the resource was created.
+     * @type string - ISO Timestamp
+     * @see CreatedOn
+     */
     createdOn?: string;
+    /**
+     * Contains the favicon of the resource.
+     * @type Icon
+     * @see LinkIcon
+     */
     linkIcon?: Icon;
+    /**
+     * Contains the name of the entity that last modified the resource.
+     * @type string
+     * @see ModifiedBy
+     */
     modifiedBy?: string;
+    /**
+     * Contains the ISO timestamp of when the resource was last modified.
+     * @type string - ISO Timestamp
+     * @see ModifiedOn
+     */
     modifiedOn?: string;
+    /**
+     * Contains the preview (typically the thumbnail) of the resource.
+     * @type Media
+     * @see Preview
+     */
     preview?: Media;
+    /**
+     * Contains the priority icon of the resource.
+     * @type Icon
+     * @see Priority
+     */
     priority?: Icon;
+    /**
+     * Contains the programming language of the resource.
+     * @type string
+     * @see ProgrammingLanguage
+     */
     programmingLanguage?: string;
+    /**
+     * Contains the snippet of the resource.
+     * @type string
+     * @see Snippet
+     */
     snippet?: string;
+    /**
+     * Contains the number of subscribers of the linked resource.
+     * @type number
+     * @see SubscriberCount
+     */
     subscriberCount?: number;
+    /**
+     * Contains the number of subscribers of the linked resource.
+     * @type number
+     * @see SubscriberCount
+     */
     state?: LinkLozenge;
+    /**
+     * Contains the Title of the linked resource.
+     * @type string
+     * @see Title
+     */
     title?: string;
+    /**
+     * Contains the url of the linked resource.
+     * @type string
+     * @see Title
+     */
     url?: string;
+    /**
+     * Contains the provider icon of the linked resource.
+     * @type Icon
+     * @see Provider
+     */
     provider?: Icon;
 };
 export declare type Icon = {

package/dist/types/state/hooks/useSmartLink.d.ts

@@ -14,8 +14,11 @@ export declare function useSmartLink(id: string, url: string, dispatchAnalytics:
             authAlternateAccountEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
             cardClickedEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined, isModifierKeyPressed?: boolean | undefined) => void;
             actionClickedEvent: (id: string, extensionKey: string, actionType: string, display: import("../../view/Card/types").CardInnerAppearance, invokeType: import("../../model/invoke-opts").InvokeType) => void;
+            hoverCardOpenLinkClickedEvent: (previewDisplay: import("../../view/HoverCard/types").PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: import("../../view/HoverCard/types").PreviewInvokeMethod | undefined) => void;
             closedAuthEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
             renderSuccessEvent: (display: import("../../view/Card/types").CardInnerAppearance, id: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+            hoverCardViewedEvent: (hoverDisplay: import("../../view/HoverCard/types").PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: import("../../view/HoverCard/types").PreviewInvokeMethod | undefined) => void;
+            hoverCardDismissedEvent: (hoverDisplay: import("../../view/HoverCard/types").PreviewDisplay, hoverTime: number, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: import("../../view/HoverCard/types").PreviewInvokeMethod | undefined) => void;
         };
         operational: {
             resolvedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => void;

package/dist/types/utils/analytics/analytics.d.ts

@@ -2,6 +2,7 @@ import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { AnalyticsPayload } from '../types';
 import { ErrorInfo } from 'react';
 import { CardInnerAppearance } from '../../view/Card/types';
+import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
 import { APIError } from '../../client/errors';
 export declare const ANALYTICS_CHANNEL = "media";
 export declare const context: {
@@ -23,8 +24,11 @@ export declare const trackAppAccountConnected: (definitionId?: string | undefine
 export declare const uiAuthEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
 export declare const uiAuthAlternateAccountEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
 export declare const uiCardClickedEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined, isModifierKeyPressed?: boolean | undefined) => AnalyticsPayload;
-export declare const uiActionClickedEvent: (extensionKey: string, actionType: string, display?: "embed" | "block" | "inline" | "preview" | "flexible" | undefined) => AnalyticsPayload;
+export declare const uiActionClickedEvent: (extensionKey: string, actionType: string, display?: CardInnerAppearance | undefined) => AnalyticsPayload;
 export declare const uiClosedAuthEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
 export declare const screenAuthPopupEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
 export declare const uiRenderSuccessEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
 export declare const uiRenderFailedEvent: (display: CardInnerAppearance, error: Error, errorInfo: ErrorInfo) => AnalyticsPayload;
+export declare const uiHoverCardViewedEvent: (hoverDisplay: PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => AnalyticsPayload;
+export declare const uiHoverCardDismissedEvent: (hoverDisplay: PreviewDisplay, hoverTime: number, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => AnalyticsPayload;
+export declare const uiHoverCardOpenLinkClickedEvent: (previewDisplay: string, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => AnalyticsPayload;

package/dist/types/utils/analytics/index.d.ts

@@ -1,5 +1,5 @@
 import { CardType } from '../../state/store/types';
 import { APIError } from '../../client/errors';
 import { AnalyticsPayload } from '../types';
-export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountConnected, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, screenAuthPopupEvent, uiRenderSuccessEvent, uiRenderFailedEvent, } from './analytics';
+export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountConnected, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, screenAuthPopupEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, } from './analytics';
 export declare const instrumentEvent: (id: string, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: APIError | undefined) => AnalyticsPayload | undefined;

package/dist/types/utils/types.d.ts

@@ -1,7 +1,7 @@
 import { GasPayload } from '@atlaskit/analytics-gas-types';
 import { CardInnerAppearance } from '../view/Card/types';
-export declare type AnalyticsAction = 'resolved' | 'unresolved' | 'connectSucceeded' | 'connectFailed' | 'connected' | 'clicked' | 'closed' | 'renderFailed' | 'renderWithStatus' | 'renderSuccess' | 'inserted';
-export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal';
+export declare type AnalyticsAction = 'resolved' | 'unresolved' | 'connectSucceeded' | 'connectFailed' | 'connected' | 'clicked' | 'closed' | 'renderFailed' | 'renderWithStatus' | 'renderSuccess' | 'inserted' | 'viewed' | 'dismissed';
+export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard';
 export declare type AnalyticsPayload = GasPayload & {
     action?: AnalyticsAction;
     actionSubject: AnalyticsActionSubject;

package/dist/types/view/BlockCard/utils/handlers.d.ts

@@ -1,2 +1,2 @@
 import React from 'react';
-export declare const handleClickCommon: (event: React.MouseEvent, onClick?: ((event: React.MouseEvent<Element, MouseEvent>) => void) | undefined) => void;
+export declare const handleClickCommon: (event: React.MouseEvent, onClick?: React.MouseEventHandler<Element> | undefined) => void;

package/dist/types/view/Card/index.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
 import { CardAppearance, CardPlatform, CardProps } from './types';
 import { WrappedComponentProps } from 'react-intl-next';
-export declare const Card: React.ForwardRefExoticComponent<Pick<Pick<React.PropsWithChildren<import("react-intl-next").WithIntlProps<CardProps & WrappedComponentProps<"intl">>>, "children" | "data" | "appearance" | "testId" | "isSelected" | "inheritDimensions" | "onClick" | "url" | "ui" | "showActions" | "onResolve" | "platform" | "forwardedRef" | "isFrameVisible" | "importer" | "container" | "embedIframeRef" | "inlinePreloaderStyle"> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "children" | "data" | "appearance" | "testId" | "isSelected" | "inheritDimensions" | "onClick" | "analyticsContext" | "key" | "url" | "ui" | "showActions" | "onResolve" | "platform" | "forwardedRef" | "isFrameVisible" | "importer" | "container" | "embedIframeRef" | "inlinePreloaderStyle"> & React.RefAttributes<any>>;
+export declare const Card: React.ForwardRefExoticComponent<Pick<Omit<React.PropsWithChildren<import("react-intl-next").WithIntlProps<CardProps & WrappedComponentProps<"intl">>>, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "children" | "data" | "appearance" | "testId" | "isSelected" | "inheritDimensions" | "onClick" | "analyticsContext" | "key" | "url" | "ui" | "showActions" | "onResolve" | "platform" | "isFrameVisible" | "embedIframeRef" | "forwardedRef" | "importer" | "container" | "inlinePreloaderStyle" | "showHoverPreview"> & React.RefAttributes<any>>;
 export type { CardAppearance, CardProps, CardPlatform };

package/dist/types/view/Card/types.d.ts

@@ -29,4 +29,5 @@ export interface CardProps extends WithAnalyticsEventsProps {
     inlinePreloaderStyle?: InlinePreloaderStyle;
     ui?: FlexibleUiOptions;
     children?: React.ReactNode;
+    showHoverPreview?: boolean;
 }

package/dist/types/view/CardWithUrl/component.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CardWithUrlContentProps } from './types';
-export declare function CardWithUrlContent({ id, url, isSelected, isFrameVisible, platform, onClick, appearance, dispatchAnalytics, onResolve, testId, showActions, inheritDimensions, embedIframeRef, inlinePreloaderStyle, ui, children, }: CardWithUrlContentProps): JSX.Element;
+export declare function CardWithUrlContent({ id, url, isSelected, isFrameVisible, platform, onClick, appearance, dispatchAnalytics, onResolve, testId, showActions, inheritDimensions, embedIframeRef, inlinePreloaderStyle, ui, children, showHoverPreview, }: CardWithUrlContentProps): JSX.Element;

package/dist/types/view/CardWithUrl/types.d.ts

@@ -21,4 +21,5 @@ export declare type CardWithUrlContentProps = {
     inlinePreloaderStyle?: InlinePreloaderStyle;
     ui?: FlexibleUiOptions;
     children?: React.ReactNode;
+    showHoverPreview?: boolean;
 };