@atlaskit/smart-card 23.7.3 → 23.8.1

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

@@ -53,8 +53,9 @@ export declare const mockAnalytics: {
         }) => void;
         renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiRenderSuccessEventProps) => void;
         renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiRenderFailedEventProps) => void;
-        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiHoverCardViewedEventProps) => void;
-        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiHoverCardDismissedEventProps) => void;
+        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("./analytics/types").UiHoverCardViewedEventProps) => void;
+        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("./analytics/types").UiHoverCardDismissedEventProps) => void;
+        learnMoreClickedEvent: () => void;
     };
     operational: {
         invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").InvokeSucceededEventProps) => void;
@@ -65,6 +66,7 @@ export declare const mockAnalytics: {
     };
     track: {
         appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").CommonEventProps) => void;
+        appAccountAuthStarted: ({ extensionKey, location, }: import("./analytics/types").CommonEventProps) => void;
     };
     screen: {
         authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").CommonEventProps) => void;

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

@@ -1,6 +1,6 @@
 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' | 'viewed' | 'dismissed' | 'created';
+export declare type AnalyticsAction = 'authStarted' | 'clicked' | 'closed' | 'connected' | 'connectFailed' | 'connectSucceeded' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'viewed' | 'unresolved';
 export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard' | 'modal' | 'embedPreviewModal';
 export declare type AnalyticsName = 'embedPreviewModal';
 export declare type AnalyticsOrigin = 'smartLinkCard' | 'smartLinkEmbed' | 'smartLinkInline' | 'smartLinkPreviewHoverCard';

package/dist/types/view/BlockCard/components/flexible/footer/index.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { BlockCardFooterProps } from './types';
 /**
- * This Components is a footer that is used in a Block Card with Flexible UI.
+ * This Component is a footer that is used in a Block Card with Flexible UI.
  * It contains a provider icon if provider is present and an actions list if one is passed.
  * To be shown as a part of Flexible UI, needs to be wrapped inside of a CustomBlock
  *

package/dist/types/view/BlockCard/views/flexible/FlexibleUnauthorisedView.d.ts

@@ -7,5 +7,5 @@ import { FlexibleBlockCardProps } from './types';
  * @see SmartLinkStatus
  * @see FlexibleCardProps
  */
-declare const FlexibleUnauthorisedView: ({ cardState, onAuthorize, onClick, onError, testId, ui, url, }: FlexibleBlockCardProps) => JSX.Element;
+declare const FlexibleUnauthorisedView: ({ analytics, cardState, extensionKey, onAuthorize, onClick, onError, testId, ui, url, }: FlexibleBlockCardProps) => JSX.Element;
 export default FlexibleUnauthorisedView;

package/dist/types/view/BlockCard/views/flexible/types.d.ts

@@ -6,20 +6,23 @@ import { OnResolveCallback } from '../../../Card/types';
 import { CardProviderRenderers } from '@atlaskit/link-provider';
 import { AnalyticsFacade } from '../../../../state/analytics';
 export declare type FlexibleBlockCardProps = {
+    /**
+     * An AnalyticsFacade object used for calling analytics.
+     */
+    analytics: AnalyticsFacade;
     /**
      * Determines the status and data of the Smart Link.
      * @internal
      */
     cardState: CardState;
     /**
-     * function to be called after a flexible card has rendered its resolved state
+     * Provides the extensionKey of a Smart Link resolver invoked.
      */
-    onResolve?: OnResolveCallback;
+    extensionKey?: string;
     /**
-     * Any additional renderers required by Flexible UI. Currently used by icon
-     * to render Emoji.
+     * A unique id for this Smart Link instance, used for analytics.
      */
-    renderers?: CardProviderRenderers;
+    id?: string;
     /**
      * An additional action that can be performed when link is not resolved, e.g.
      * connect account to gain access to 403 link.
@@ -35,6 +38,15 @@ export declare type FlexibleBlockCardProps = {
      * function to be called after a flexible card has rendered its error states
      */
     onError?: OnErrorCallback;
+    /**
+     * function to be called after a flexible card has rendered its resolved state
+     */
+    onResolve?: OnResolveCallback;
+    /**
+     * Any additional renderers required by Flexible UI. Currently used by icon
+     * to render Emoji.
+     */
+    renderers?: CardProviderRenderers;
     /**
      * A name of the provider, needed to specify to user which account has to be connected
      */
@@ -50,14 +62,6 @@ export declare type FlexibleBlockCardProps = {
      * @see FlexibleUiOptions
      */
     ui?: FlexibleUiOptions;
-    /**
-     * A unique id for this Smart Link instance, used for analytics.
-     */
-    id?: string;
-    /**
-     * An AnalyticsFacade object used for calling analytics.
-     */
-    analytics: AnalyticsFacade;
     /**
      * Determines the URL of the Smart Link.
      */

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

@@ -5,7 +5,7 @@ import { AnalyticsFacade } from '../../state/analytics';
 import { FlexibleUiOptions } from '../FlexibleCard/types';
 import { InlinePreloaderStyle, OnErrorCallback } from '../types';
 export type { CardAppearance, CardPlatform };
-export declare type CardInnerAppearance = CardAppearance | 'preview' | 'flexible';
+export declare type CardInnerAppearance = CardAppearance | 'embedPreview' | 'flexible' | 'hoverCardPreview';
 export declare type OnResolveCallback = (data: {
     url?: string;
     title?: string;

package/dist/types/view/EmbedCard/views/UnauthorisedView.d.ts

@@ -1,6 +1,8 @@
 import React, { FC } from 'react';
 import { ContextViewModel } from '../types';
+import { AnalyticsFacade } from '../../../state/analytics';
 export interface EmbedCardUnauthorisedViewProps {
+    analytics: AnalyticsFacade;
     context?: ContextViewModel;
     link: string;
     isSelected?: boolean;
@@ -8,5 +10,6 @@ export interface EmbedCardUnauthorisedViewProps {
     onAuthorise?: () => void;
     inheritDimensions?: boolean;
     onClick?: (evt: React.MouseEvent) => void;
+    extensionKey?: string;
 }
 export declare const EmbedCardUnauthorisedView: FC<EmbedCardUnauthorisedViewProps>;

package/dist/types/view/HoverCard/components/HoverCardComponent.d.ts

@@ -1,4 +1,3 @@
 import { FC } from 'react';
 import { HoverCardComponentProps } from '../types';
-export declare const hoverCardClassName = "smart-links-hover-preview";
 export declare const HoverCardComponent: FC<HoverCardComponentProps>;

package/dist/types/view/HoverCard/components/HoverCardContent.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { AnalyticsFacade } from '../../../state/analytics';
 import { ActionItem } from '../../FlexibleCard/components/blocks/types';
 import { HoverCardContentProps } from '../types';
+export declare const hoverCardClassName = "smart-links-hover-preview";
 export declare const getOpenAction: (url: string, analytics: AnalyticsFacade, onActionClick?: ((actionId: string) => void) | undefined) => ActionItem;
 declare const HoverCardContent: React.FC<HoverCardContentProps>;
 export default HoverCardContent;

package/dist/types/view/HoverCard/components/views/unauthorised/types.d.ts

@@ -1,19 +1,30 @@
 import { FlexibleCardProps } from '../../../../FlexibleCard/types';
+import { AnalyticsFacade } from '../../../../../state/analytics';
 export declare type HoverCardUnauthorisedProps = {
+    /**
+     * An AnalyticsFacade object used for calling analytics.
+     */
+    analytics: AnalyticsFacade;
+    /**
+     * Provides the extensionKey of a Smart Link resolver invoked.
+     */
+    extensionKey?: string;
     /**
      * Data required for rendering a Flexible Card
      */
     flexibleCardProps: FlexibleCardProps;
     /**
-     * A function that determines an additional action that can be performed on an unauthorised link, e.g.
-     * connecting an account to gain access.
-     * @internal
+     *  A unique ID for a Smart Link.
      */
-    onAuthorize?: () => void;
+    id?: string;
     /**
      * A `testId` prop is provided for specified elements, which is a unique
      * string that appears as a data attribute `data-testid` in the rendered code,
      * serving as a hook for automated tests
      */
     testId?: string;
+    /**
+     * The url that we were trying to resolve and that has the 'unauthorized' state for the current user
+     */
+    url: string;
 };

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

@@ -5,7 +5,7 @@ import { LinkAction } from '../../state/hooks-external/useSmartLinkActions';
 import { CardState } from '@atlaskit/linking-common';
 import { CardProviderRenderers } from '@atlaskit/link-provider';
 import { AnalyticsHandler } from '../../utils/types';
-import { ReactElement } from 'react';
+import { ReactElement, MouseEventHandler } from 'react';
 import { JsonLd } from 'json-ld-types';
 export interface HoverCardProps extends WithAnalyticsEventsProps {
     id?: string;
@@ -16,7 +16,6 @@ export interface HoverCardProps extends WithAnalyticsEventsProps {
 export interface HoverCardComponentProps extends HoverCardProps {
     analyticsHandler: AnalyticsHandler;
     analytics: AnalyticsFacade;
-    onAuthorize?: () => void;
 }
 export declare type PreviewDisplay = 'card' | 'embed';
 export declare type PreviewInvokeMethod = 'keyboard' | 'mouse_hover' | 'mouse_click';
@@ -34,7 +33,8 @@ export declare type HoverCardContentProps = {
     onActionClick: (actionId: string) => void;
     onResolve: () => void;
     url: string;
-    onAuthorize?: () => void;
+    onMouseEnter?: MouseEventHandler;
+    onMouseLeave?: MouseEventHandler;
 };
 export declare type SnippetOrPreviewProps = {
     data: JsonLd.Data.BaseData;

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

@@ -1,6 +1,5 @@
 import { JsonLd } from 'json-ld-types';
 import { LinkAction } from '../../state/hooks-external/useSmartLinkActions';
 import { ElementItem } from '../FlexibleCard/components/blocks/types';
-export declare const SMART_CARD_ANALYTICS_DISPLAY = "flexible";
 export declare const getSimulatedMetadata: (extensionKey?: string, types?: JsonLd.Primitives.ObjectType[]) => JsonLd.Primitives.Property<any>;
 export declare const toActionableMetadata: (onActionClick: (actionId: string) => void, extensionKey?: string | undefined, types?: JsonLd.Primitives.ObjectType[], cardActions?: LinkAction[], elementItems?: ElementItem[]) => ElementItem[];

package/dist/types/view/InlineCard/UnauthorisedView/index.d.ts

@@ -16,6 +16,8 @@ export interface InlineCardUnauthorizedViewProps {
     testId?: string;
     /** A flag that determines is a tooltip should show up on hover over the unauthorised link */
     showAuthTooltip?: boolean;
+    /** A smart link id that may be used in analytics */
+    id?: string;
 }
 export declare class InlineCardUnauthorizedView extends React.Component<InlineCardUnauthorizedViewProps> {
     handleConnectAccount: (event: React.MouseEvent<HTMLElement>) => void;

package/dist/types/view/common/UnauthorisedViewContent.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { AnalyticsFacade } from '../../state/analytics';
 declare type UnauthorisedViewContentProps = {
     /**
      * Is the name of the provider for the account that needs to be connected
@@ -11,10 +12,15 @@ declare type UnauthorisedViewContentProps = {
      * serving as a hook for automated tests
      */
     testId?: string;
+    /**
+     * An analytics facade object which will be used to send analytics.
+     * @internal
+     */
+    analytics?: AnalyticsFacade;
 };
 /**
  * This component is used in unauthorized views of a smart link.
  * It represents the main text that provides a user with information on how to connect their account
  */
-declare const UnauthorisedViewContent: ({ providerName, testId, }: UnauthorisedViewContentProps) => JSX.Element;
+declare const UnauthorisedViewContent: ({ providerName, testId, analytics, }: UnauthorisedViewContentProps) => JSX.Element;
 export default UnauthorisedViewContent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "23.7.3",
+  "version": "23.8.1",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,7 +26,7 @@
     "@atlaskit/analytics-next": "^8.2.0",
     "@atlaskit/avatar": "^21.1.0",
     "@atlaskit/avatar-group": "^9.1.0",
-    "@atlaskit/button": "^16.4.0",
+    "@atlaskit/button": "^16.5.0",
     "@atlaskit/dropdown-menu": "^11.5.0",
     "@atlaskit/icon": "^21.11.0",
     "@atlaskit/icon-file-type": "^6.3.0",
@@ -40,7 +40,7 @@
     "@atlaskit/modal-dialog": "^12.4.0",
     "@atlaskit/outbound-auth-flow-client": "^3.3.0",
     "@atlaskit/popup": "^1.5.0",
-    "@atlaskit/spinner": "^15.2.0",
+    "@atlaskit/spinner": "^15.3.0",
     "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.11.0",
     "@atlaskit/tooltip": "^17.6.0",
@@ -70,7 +70,7 @@
     "@atlaskit/css-reset": "^6.3.0",
     "@atlaskit/docs": "*",
     "@atlaskit/field-base": "^15.0.6",
-    "@atlaskit/form": "^8.7.0",
+    "@atlaskit/form": "^8.8.0",
     "@atlaskit/inline-message": "^11.4.0",
     "@atlaskit/lozenge": "^11.3.0",
     "@atlaskit/media-integration-test-helpers": "^2.6.0",
@@ -79,7 +79,7 @@
     "@atlaskit/radio": "^5.4.0",
     "@atlaskit/range": "^7.0.0",
     "@atlaskit/section-message": "^6.3.0",
-    "@atlaskit/select": "^15.7.0",
+    "@atlaskit/select": "^16.0.0",
     "@atlaskit/table-tree": "^9.2.0",
     "@atlaskit/tabs": "^13.3.0",
     "@atlaskit/textarea": "^4.5.0",

package/report.api.md

@@ -85,6 +85,7 @@ type ActionProps = {
 
 // @public (undocumented)
 export type AnalyticsAction =
+  | 'authStarted'
   | 'clicked'
   | 'closed'
   | 'connectFailed'
@@ -262,7 +263,11 @@ export { CardAppearance };
 export { CardContext };
 
 // @public (undocumented)
-type CardInnerAppearance = 'flexible' | 'preview' | CardAppearance;
+type CardInnerAppearance =
+  | 'embedPreview'
+  | 'flexible'
+  | 'hoverCardPreview'
+  | CardAppearance;
 
 export { CardPlatform };
 
@@ -880,6 +885,7 @@ type UiHoverCardDismissedEventProps = CommonEventProps & {
   previewDisplay: PreviewDisplay;
   hoverTime: number;
   previewInvokeMethod?: PreviewInvokeMethod;
+  status: CardType;
 };
 
 // @public (undocumented)
@@ -892,6 +898,7 @@ type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
 type UiHoverCardViewedEventProps = CommonEventProps & {
   previewDisplay: PreviewDisplay;
   previewInvokeMethod?: PreviewInvokeMethod;
+  status: CardType;
 };
 
 // @public (undocumented)
@@ -1018,6 +1025,7 @@ export const useSmartLinkAnalytics: (
       destinationProduct,
       destinationSubproduct,
       location,
+      status,
     }: UiHoverCardViewedEventProps) => void;
     hoverCardDismissedEvent: ({
       id,
@@ -1030,7 +1038,9 @@ export const useSmartLinkAnalytics: (
       destinationProduct,
       destinationSubproduct,
       location,
+      status,
     }: UiHoverCardDismissedEventProps) => void;
+    learnMoreClickedEvent: () => void;
   };
   operational: {
     invokeSucceededEvent: ({
@@ -1096,6 +1106,10 @@ export const useSmartLinkAnalytics: (
       destinationSubproduct,
       location,
     }: TrackAppAccountConnectedProps) => void;
+    appAccountAuthStarted: ({
+      extensionKey,
+      location,
+    }: TrackAppAccountConnectedProps) => void;
   };
   screen: {
     authPopupEvent: ({

package/tmp/api-report-tmp.d.ts

@@ -70,7 +70,7 @@ type ActionProps = {
 };
 
 // @public (undocumented)
-export type AnalyticsAction = 'clicked' | 'closed' | 'connectFailed' | 'connectSucceeded' | 'connected' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'unresolved' | 'viewed';
+export type AnalyticsAction = 'authStarted' | 'clicked' | 'closed' | 'connectFailed' | 'connectSucceeded' | 'connected' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'unresolved' | 'viewed';
 
 // @public (undocumented)
 export type AnalyticsActionSubject = 'applicationAccount' | 'button' | 'consentModal' | 'embedPreviewModal' | 'hoverCard' | 'modal' | 'smartLink' | 'smartLinkAction';
@@ -187,7 +187,7 @@ export { CardAppearance }
 export { CardContext }
 
 // @public (undocumented)
-type CardInnerAppearance = 'flexible' | 'preview' | CardAppearance;
+type CardInnerAppearance = 'embedPreview' | 'flexible' | 'hoverCardPreview' | CardAppearance;
 
 export { CardPlatform }
 
@@ -758,6 +758,7 @@ type UiHoverCardDismissedEventProps = CommonEventProps & {
     previewDisplay: PreviewDisplay;
     hoverTime: number;
     previewInvokeMethod?: PreviewInvokeMethod;
+    status: CardType;
 };
 
 // @public (undocumented)
@@ -770,6 +771,7 @@ type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
 type UiHoverCardViewedEventProps = CommonEventProps & {
     previewDisplay: PreviewDisplay;
     previewInvokeMethod?: PreviewInvokeMethod;
+    status: CardType;
 };
 
 // @public (undocumented)
@@ -802,8 +804,9 @@ export const useSmartLinkAnalytics: (url: string, dispatchAnalytics: AnalyticsHa
         }) => void;
         renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderSuccessEventProps) => void;
         renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
-        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiHoverCardViewedEventProps) => void;
-        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiHoverCardDismissedEventProps) => void;
+        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
+        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
+        learnMoreClickedEvent: () => void;
     };
     operational: {
         invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
@@ -814,6 +817,7 @@ export const useSmartLinkAnalytics: (url: string, dispatchAnalytics: AnalyticsHa
     };
     track: {
         appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => void;
+        appAccountAuthStarted: ({ extensionKey, location, }: TrackAppAccountConnectedProps) => void;
     };
     screen: {
         authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ScreenAuthPopupEventProps) => void;