@atlaskit/smart-card 26.0.0 → 26.1.0

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

@@ -1,5 +1,6 @@
 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.
@@ -158,6 +159,18 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
          * @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: {
         /**
@@ -232,6 +245,24 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
         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: {
         /**

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

@@ -32,6 +32,9 @@ export declare const FlexibleUiAnalyticsContext: import("react").Context<{
         hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
         hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
         learnMoreClickedEvent: () => void;
+        smartLinkLozengeActionClickedEvent: () => void;
+        smartLinkLozengeActionListItemClickedEvent: () => void;
+        smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
     };
     operational: {
         invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
@@ -47,6 +50,15 @@ export declare const FlexibleUiAnalyticsContext: import("react").Context<{
         linkUpdated: (props: import("../../utils/analytics/types").CommonEventProps & {
             [key: string]: any;
         }) => void;
+        smartLinkQuickActionStarted: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
+        smartLinkQuickActionSuccess: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
+        smartLinkQuickActionFailed: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
     };
     screen: {
         authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
@@ -76,6 +88,9 @@ export declare const useFlexibleUiAnalyticsContext: () => {
         hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
         hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
         learnMoreClickedEvent: () => void;
+        smartLinkLozengeActionClickedEvent: () => void;
+        smartLinkLozengeActionListItemClickedEvent: () => void;
+        smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
     };
     operational: {
         invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
@@ -91,6 +106,15 @@ export declare const useFlexibleUiAnalyticsContext: () => {
         linkUpdated: (props: import("../../utils/analytics/types").CommonEventProps & {
             [key: string]: any;
         }) => void;
+        smartLinkQuickActionStarted: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
+        smartLinkQuickActionSuccess: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
+        smartLinkQuickActionFailed: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
     };
     screen: {
         authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;

package/dist/types/state/hooks/use-invoke/index.d.ts

@@ -1,3 +1,9 @@
 import type { InvokeRequest } from '@atlaskit/linking-types/smart-link-actions';
-declare const useInvoke: () => (req: InvokeRequest, cb?: Function | undefined) => Promise<any>;
+import { AnalyticsFacade } from '../../../state/analytics';
+declare type InvokeRequestTracker = {
+    started?: AnalyticsFacade['track']['smartLinkQuickActionStarted'];
+    success?: AnalyticsFacade['track']['smartLinkQuickActionSuccess'];
+    failed?: AnalyticsFacade['track']['smartLinkQuickActionFailed'];
+};
+declare const useInvoke: ({ failed, started, success }?: InvokeRequestTracker) => (req: InvokeRequest, cb?: Function | undefined) => Promise<any>;
 export default useInvoke;

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

@@ -35,6 +35,9 @@ dispatchAnalytics?: AnalyticsHandler): {
             hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
             hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
             learnMoreClickedEvent: () => void;
+            smartLinkLozengeActionClickedEvent: () => void;
+            smartLinkLozengeActionListItemClickedEvent: () => void;
+            smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
         };
         operational: {
             invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
@@ -50,6 +53,15 @@ dispatchAnalytics?: AnalyticsHandler): {
             linkUpdated: (props: import("../../utils/analytics/types").CommonEventProps & {
                 [key: string]: any;
             }) => void;
+            smartLinkQuickActionStarted: (props: {
+                smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+            }) => void;
+            smartLinkQuickActionSuccess: (props: {
+                smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+            }) => void;
+            smartLinkQuickActionFailed: (props: {
+                smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+            }) => void;
         };
         screen: {
             authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;

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

@@ -2,6 +2,7 @@ import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { AnalyticsPayload } from '../types';
 import { CardInnerAppearance } from '../../view/Card/types';
 import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UnresolvedEventProps } from './types';
+import { SmartLinkActionType } from '@atlaskit/linking-types';
 export declare const ANALYTICS_CHANNEL = "media";
 export declare const context: {
     componentName: string;
@@ -23,6 +24,15 @@ export declare const trackAppAccountAuthStarted: ({ extensionKey, location, }: T
 export declare const trackLinkUpdated: ({ actionSubjectId, ...attributes }: CommonEventProps & {
     [key: string]: any;
 }) => AnalyticsPayload;
+export declare const trackSmartLinkQuickActionStarted: ({ smartLinkActionType, ...attributes }: CommonEventProps & {
+    smartLinkActionType: SmartLinkActionType;
+}) => AnalyticsPayload;
+export declare const trackSmartLinkQuickActionSuccess: ({ smartLinkActionType, ...attributes }: CommonEventProps & {
+    smartLinkActionType: SmartLinkActionType;
+}) => AnalyticsPayload;
+export declare const trackSmartLinkQuickActionFailed: ({ smartLinkActionType, ...attributes }: CommonEventProps & {
+    smartLinkActionType: SmartLinkActionType;
+}) => AnalyticsPayload;
 export declare const uiAuthEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, display, }: UiAuthEventProps) => AnalyticsPayload;
 export declare const uiAuthAlternateAccountEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, display, }: UiAuthAlternateAccountEventProps) => AnalyticsPayload;
 export declare const uiCardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => AnalyticsPayload;
@@ -38,3 +48,6 @@ export declare const uiHoverCardDismissedEvent: ({ id, previewDisplay, hoverTime
 export declare const uiHoverCardOpenLinkClickedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => AnalyticsPayload;
 export declare const uiLearnMoreLinkClickedEvent: () => AnalyticsPayload;
 export declare const chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => AnalyticsPayload;
+export declare const uiSmartLinkStatusLozengeButtonClicked: () => AnalyticsPayload;
+export declare const uiSmartLinkStatusListItemButtonClicked: () => AnalyticsPayload;
+export declare const uiSmartLinkStatusOpenPreviewButtonClicked: () => AnalyticsPayload;

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

@@ -1,4 +1,4 @@
 import { AnalyticsPayload } from '../types';
 import { InstrumentEventProps } from './types';
-export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, chunkloadFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountAuthStarted, trackAppAccountConnected, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, screenAuthPopupEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiLearnMoreLinkClickedEvent, uiIframeDwelledEvent, } from './analytics';
+export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, chunkloadFailedEvent, connectSucceededEvent, connectFailedEvent, trackAppAccountAuthStarted, trackAppAccountConnected, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, screenAuthPopupEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiLearnMoreLinkClickedEvent, uiIframeDwelledEvent, uiSmartLinkStatusLozengeButtonClicked, uiSmartLinkStatusListItemButtonClicked, uiSmartLinkStatusOpenPreviewButtonClicked, } from './analytics';
 export declare const instrumentEvent: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => AnalyticsPayload | undefined;

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

@@ -10,6 +10,7 @@ export interface CommonEventProps {
     definitionId?: string;
     extensionKey?: string;
     resourceType?: string;
+    destinatinoObjectType?: string;
     destinationSubproduct?: DestinationSubproduct | string;
     destinationProduct?: DestinationProduct | string;
     location?: string;

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

@@ -60,6 +60,9 @@ export declare const mockAnalytics: {
         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;
+        smartLinkLozengeActionClickedEvent: () => void;
+        smartLinkLozengeActionListItemClickedEvent: () => void;
+        smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
     };
     operational: {
         invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").InvokeSucceededEventProps) => void;
@@ -75,6 +78,15 @@ export declare const mockAnalytics: {
         linkUpdated: (props: import("./analytics/types").CommonEventProps & {
             [key: string]: any;
         }) => void;
+        smartLinkQuickActionStarted: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
+        smartLinkQuickActionSuccess: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
+        smartLinkQuickActionFailed: (props: {
+            smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType;
+        }) => void;
     };
     screen: {
         authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").CommonEventProps) => void;

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 = 'authStarted' | 'clicked' | 'closed' | 'connected' | 'connectFailed' | 'connectSucceeded' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'viewed' | 'unresolved' | 'updated' | 'chunkLoadFailed' | 'dwelled' | 'focused';
-export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard' | 'modal' | 'embedPreviewModal' | 'smartLinkIframe' | 'link';
+export declare type AnalyticsAction = 'authStarted' | 'clicked' | 'closed' | 'connected' | 'connectFailed' | 'connectSucceeded' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'viewed' | 'unresolved' | 'updated' | 'chunkLoadFailed' | 'dwelled' | 'focused' | 'started' | 'success' | 'failed';
+export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard' | 'modal' | 'embedPreviewModal' | 'smartLinkIframe' | 'link' | 'smartLinkQuickAction';
 export declare type AnalyticsName = 'embedPreviewModal';
 export declare type AnalyticsOrigin = 'smartLinkCard' | 'smartLinkEmbed' | 'smartLinkInline' | 'smartLinkPreviewHoverCard';
 export declare type AnalyticsPayload = GasPayload & {

package/dist/types/view/FlexibleCard/components/common/lozenge-action/types.d.ts

@@ -7,7 +7,7 @@ export declare type LozengeItem = {
     text: string;
 };
 export declare type LozengeActionProps = {
-    action?: InvokeActions;
+    action: InvokeActions;
     appearance?: ThemeAppearance;
     testId?: string;
     text: string | React.ReactNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "26.0.0",
+  "version": "26.1.0",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -42,6 +42,7 @@ import { ReactChild } from 'react';
 import { Ref } from 'react';
 import { SerializedStyles } from '@emotion/react';
 import { SmartCardContext } from '@atlaskit/link-provider';
+import { SmartLinkActionType } from '@atlaskit/linking-types';
 import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 import { WithContextProps } from '@atlaskit/analytics-next';
 import { WithIntlProps } from 'react-intl-next';
@@ -95,12 +96,15 @@ export type AnalyticsAction =
   | 'created'
   | 'dismissed'
   | 'dwelled'
+  | 'failed'
   | 'focused'
   | 'inserted'
   | 'renderFailed'
   | 'renderSuccess'
   | 'renderWithStatus'
   | 'resolved'
+  | 'started'
+  | 'success'
   | 'unresolved'
   | 'updated'
   | 'viewed';
@@ -116,7 +120,8 @@ export type AnalyticsActionSubject =
   | 'modal'
   | 'smartLink'
   | 'smartLinkAction'
-  | 'smartLinkIframe';
+  | 'smartLinkIframe'
+  | 'smartLinkQuickAction';
 
 // @public (undocumented)
 type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
@@ -357,6 +362,8 @@ interface CommonEventProps {
   // (undocumented)
   definitionId?: string;
   // (undocumented)
+  destinatinoObjectType?: string;
+  // (undocumented)
   destinationProduct?: DestinationProduct | string;
   // (undocumented)
   destinationSubproduct?: DestinationSubproduct | string;
@@ -1118,6 +1125,9 @@ export const useSmartLinkAnalytics: (
       status,
     }: UiHoverCardDismissedEventProps) => void;
     learnMoreClickedEvent: () => void;
+    smartLinkLozengeActionClickedEvent: () => void;
+    smartLinkLozengeActionListItemClickedEvent: () => void;
+    smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
   };
   operational: {
     invokeSucceededEvent: ({
@@ -1203,6 +1213,15 @@ export const useSmartLinkAnalytics: (
         [key: string]: any;
       },
     ) => void;
+    smartLinkQuickActionStarted: (props: {
+      smartLinkActionType: SmartLinkActionType;
+    }) => void;
+    smartLinkQuickActionSuccess: (props: {
+      smartLinkActionType: SmartLinkActionType;
+    }) => void;
+    smartLinkQuickActionFailed: (props: {
+      smartLinkActionType: SmartLinkActionType;
+    }) => void;
   };
   screen: {
     authPopupEvent: ({