@atlaskit/smart-card 21.3.0 → 22.1.1

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

@@ -1,10 +1,5 @@
-import { ErrorInfo } from 'react';
-import { CardType, APIError } from '@atlaskit/linking-common';
-import { AnalyticsHandler } from '../../utils/types';
-import { CardInnerAppearance } from '../../view/Card/types';
-import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
-import { InvokeType } from '../../model/invoke-opts';
-import { DestinationProduct, DestinationSubproduct } from '../../utils/analytics/types';
+import { AnalyticsHandler, AnalyticsName, AnalyticsPayload } from '../../utils/types';
+import { ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps } from '../../utils/analytics/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.
@@ -24,7 +19,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
          */
-        authEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        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).
@@ -33,7 +28,15 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
          */
-        authAlternateAccountEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        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.
@@ -46,7 +49,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param destinationProduct The product the Smart Link is linked to.
          * @returns
          */
-        cardClickedEvent: (id: string | undefined, display: CardInnerAppearance, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, isModifierKeyPressed?: boolean | undefined, location?: string | undefined, destinationProduct?: DestinationProduct | string | undefined, destinationSubproduct?: DestinationSubproduct | string | undefined, actionSubjectId?: string | undefined) => void;
+        cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => 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.
@@ -57,7 +60,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param invokeType Whether the action invoked made a call to a server.
          * @returns
          */
-        actionClickedEvent: (id: string | undefined, extensionKey: string | undefined, actionType: string, display: CardInnerAppearance, invokeType: InvokeType) => void;
+        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
@@ -66,7 +69,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param previewInvokeMethod How the preview was triggered.
          */
-        hoverCardOpenLinkClickedEvent: (previewDisplay: PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => void;
+        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.
@@ -74,7 +77,14 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
          */
-        closedAuthEvent: (display: CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        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.
@@ -83,7 +93,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          */
-        renderSuccessEvent: (display: CardInnerAppearance, status: CardType, id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        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.
@@ -91,7 +101,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param error: An error representing why the Smart Link render failed.
          * @param errorInfo: Additional details about the error including the stack trace.
          */
-        renderFailedEvent: (display: CardInnerAppearance, id: string | undefined, error: Error, errorInfo: ErrorInfo) => void;
+        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.
@@ -100,7 +110,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param previewInvokeMethod How the preview was triggered.
          * @returns
          */
-        hoverCardViewedEvent: (previewDisplay: PreviewDisplay, previewInvokeMethod?: PreviewInvokeMethod | undefined, id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: 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.
@@ -110,7 +120,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param previewInvokeMethod How the preview was triggered.
          * @returns
          */
-        hoverCardDismissedEvent: (previewDisplay: PreviewDisplay, hoverTime: number, previewInvokeMethod?: PreviewInvokeMethod | undefined, id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiHoverCardDismissedEventProps) => void;
     };
     operational: {
         /**
@@ -120,7 +130,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @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: string | undefined, extensionKey: string | undefined, actionType: string, display: CardInnerAppearance) => void;
+        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.
@@ -129,14 +139,14 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
          * @param reason The reason the invocation failed.
          */
-        invokeFailedEvent: (id: string | undefined, providerKey: string | undefined, actionType: string, display: CardInnerAppearance, reason: string) => void;
+        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?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        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.
@@ -144,7 +154,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param reason The reason why the Smart Link connect account failed.
          */
-        connectFailedEvent: (id?: string, definitionId?: string | undefined, extensionKey?: string | undefined, reason?: string | undefined) => void;
+        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.
@@ -154,7 +164,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @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: string | undefined, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: APIError | undefined) => void;
+        instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
     };
     track: {
         /**
@@ -163,7 +173,7 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
          */
-        appAccountConnected: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => void;
     };
     screen: {
         /**
@@ -172,7 +182,14 @@ export declare const useSmartLinkAnalytics: (url: string, dispatchAnalytics: Ana
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
          */
-        authPopupEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+        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/state/hooks/useSmartLink.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { AnalyticsHandler } from '../../utils/types';
 export declare function useSmartLink(id: string, url: string, dispatchAnalytics: AnalyticsHandler): {
     state: import("@atlaskit/linking-common").CardState;
@@ -12,29 +11,38 @@ export declare function useSmartLink(id: string, url: string, dispatchAnalytics:
     config: (import("@atlaskit/link-provider").CardProviderCacheOpts & import("@atlaskit/link-provider").CardAuthFlowOpts) | undefined;
     analytics: {
         ui: {
-            authEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            authAlternateAccountEvent: (display: import("../../view/Card/types").CardInnerAppearance, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            cardClickedEvent: (id: string | undefined, display: import("../../view/Card/types").CardInnerAppearance, status: import("@atlaskit/linking-common/types").CardType, definitionId?: string | undefined, extensionKey?: string | undefined, isModifierKeyPressed?: boolean | undefined, location?: string | undefined, destinationProduct?: string | undefined, destinationSubproduct?: string | undefined, actionSubjectId?: string | undefined) => void;
-            actionClickedEvent: (id: string | undefined, extensionKey: string | undefined, 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, status: import("@atlaskit/linking-common/types").CardType, id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            renderFailedEvent: (display: import("../../view/Card/types").CardInnerAppearance, id: string | undefined, error: Error, errorInfo: import("react").ErrorInfo) => void;
-            hoverCardViewedEvent: (previewDisplay: import("../../view/HoverCard/types").PreviewDisplay, previewInvokeMethod?: import("../../view/HoverCard/types").PreviewInvokeMethod | undefined, id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            hoverCardDismissedEvent: (previewDisplay: import("../../view/HoverCard/types").PreviewDisplay, hoverTime: number, previewInvokeMethod?: import("../../view/HoverCard/types").PreviewInvokeMethod | undefined, id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+            authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthEventProps) => void;
+            authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthAlternateAccountEventProps) => void;
+            buttonClickedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
+                actionSubjectId: string;
+            }) => void;
+            cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("../../utils/analytics/types").UiCardClickedEventProps) => void;
+            actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiActionClickedEventProps) => void;
+            hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("../../utils/analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
+            closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiClosedAuthEventProps) => void;
+            modalClosedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
+                actionSubjectId: string;
+            }) => void;
+            renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderSuccessEventProps) => void;
+            renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
+            hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
+            hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
         };
         operational: {
-            invokeSucceededEvent: (id: string | undefined, extensionKey: string | undefined, actionType: string, display: import("../../view/Card/types").CardInnerAppearance) => void;
-            invokeFailedEvent: (id: string | undefined, providerKey: string | undefined, actionType: string, display: import("../../view/Card/types").CardInnerAppearance, reason: string) => void;
-            connectSucceededEvent: (id?: string, definitionId?: string | undefined, extensionKey?: string | undefined) => void;
-            connectFailedEvent: (id?: string, definitionId?: string | undefined, extensionKey?: string | undefined, reason?: string | undefined) => void;
-            instrument: (id: string | undefined, status: import("@atlaskit/linking-common/types").CardType, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: import("@atlaskit/linking-common").APIError | undefined) => void;
+            invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
+            invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeFailedEventProps) => void;
+            connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectSucceededEventProps) => void;
+            connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectFailedEventProps) => void;
+            instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("../../utils/analytics/types").InstrumentEventProps) => void;
         };
         track: {
-            appAccountConnected: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+            appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
         };
         screen: {
-            authPopupEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => void;
+            authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
+            modalViewedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
+                name: "embedPreviewModal";
+            }) => void;
         };
     };
     renderers: import("@atlaskit/link-provider").CardProviderRenderers | undefined;

package/dist/types/state/hooks-external/useSmartLinkActions.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { JsonLd } from 'json-ld-types';
-import type { AnalyticsHandler } from '../../utils/types';
+import type { AnalyticsHandler, AnalyticsOrigin } from '../../utils/types';
 import type { CardInnerAppearance } from '../../view/Card/types';
 export interface LinkAction {
     /**
@@ -41,5 +41,9 @@ export interface UseSmartLinkActionsOpts {
      * @default 'web'
      */
     platform?: JsonLd.Primitives.Platforms;
+    /**
+     * Smart link origin that the action being invoked from.
+     */
+    origin?: AnalyticsOrigin;
 }
-export declare function useSmartLinkActions({ url, appearance, analyticsHandler, platform, }: UseSmartLinkActionsOpts): LinkAction[];
+export declare function useSmartLinkActions({ url, appearance, analyticsHandler, platform, origin, }: UseSmartLinkActionsOpts): LinkAction[];

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

@@ -1,9 +1,7 @@
 import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { APIError, CardType } from '@atlaskit/linking-common';
 import { AnalyticsPayload } from '../types';
-import { ErrorInfo } from 'react';
 import { CardInnerAppearance } from '../../view/Card/types';
-import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
+import { ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UnresolvedEventProps } from './types';
 export declare const ANALYTICS_CHANNEL = "media";
 export declare const context: {
     componentName: string;
@@ -14,21 +12,21 @@ export declare class SmartLinkEvents {
     insertSmartLink(url: string, type: CardInnerAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
 }
 export declare const fireSmartLinkEvent: (payload: AnalyticsPayload, createAnalyticsEvent?: CreateUIAnalyticsEvent | undefined) => void;
-export declare const resolvedEvent: (id: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined) => AnalyticsPayload;
-export declare const unresolvedEvent: (id: string, status: string, definitionId?: string | undefined, extensionKey?: string | undefined, resourceType?: string | undefined, error?: APIError | undefined) => AnalyticsPayload;
-export declare const invokeSucceededEvent: (id: string, actionType: string, display: CardInnerAppearance, extensionKey?: string | undefined) => AnalyticsPayload;
-export declare const invokeFailedEvent: (id: string, actionType: string, display: CardInnerAppearance, reason: string, extensionKey?: string | undefined) => AnalyticsPayload;
-export declare const connectSucceededEvent: (definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
-export declare const connectFailedEvent: (definitionId?: string | undefined, extensionKey?: string | undefined, reason?: string | undefined) => AnalyticsPayload;
-export declare const trackAppAccountConnected: (definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
-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: (id: string, display: CardInnerAppearance, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined, isModifierKeyPressed?: boolean | undefined, location?: string | undefined, destinationProduct?: string | undefined, destinationSubproduct?: string | undefined, actionSubjectId?: string | undefined) => AnalyticsPayload;
-export declare const uiActionClickedEvent: (id: string, actionType: string, extensionKey?: string | undefined, 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, status: CardType, definitionId?: string | undefined, extensionKey?: string | undefined) => AnalyticsPayload;
-export declare const uiRenderFailedEvent: (display: CardInnerAppearance, error: Error, errorInfo: ErrorInfo) => AnalyticsPayload;
-export declare const uiHoverCardViewedEvent: (id: string, previewDisplay: PreviewDisplay, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => AnalyticsPayload;
-export declare const uiHoverCardDismissedEvent: (id: string, previewDisplay: PreviewDisplay, hoverTime: number, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => AnalyticsPayload;
-export declare const uiHoverCardOpenLinkClickedEvent: (id: string, previewDisplay: string, definitionId?: string | undefined, extensionKey?: string | undefined, previewInvokeMethod?: PreviewInvokeMethod | undefined) => AnalyticsPayload;
+export declare const resolvedEvent: (props: ResolvedEventProps) => AnalyticsPayload;
+export declare const unresolvedEvent: ({ id, definitionId, extensionKey, resourceType, destinationSubproduct, destinationProduct, error, status, location, }: UnresolvedEventProps) => AnalyticsPayload;
+export declare const invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => AnalyticsPayload;
+export declare const invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => AnalyticsPayload;
+export declare const connectSucceededEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => AnalyticsPayload;
+export declare const connectFailedEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, reason, }: ConnectFailedEventProps) => AnalyticsPayload;
+export declare const trackAppAccountConnected: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => 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;
+export declare const uiActionClickedEvent: ({ id, actionType, extensionKey, display, definitionId, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => AnalyticsPayload;
+export declare const uiClosedAuthEvent: ({ display, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => AnalyticsPayload;
+export declare const screenAuthPopupEvent: ({ extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: ScreenAuthPopupEventProps) => AnalyticsPayload;
+export declare const uiRenderSuccessEvent: ({ display, status, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderSuccessEventProps) => AnalyticsPayload;
+export declare const uiRenderFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => AnalyticsPayload;
+export declare const uiHoverCardViewedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardViewedEventProps) => AnalyticsPayload;
+export declare const uiHoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardDismissedEventProps) => AnalyticsPayload;
+export declare const uiHoverCardOpenLinkClickedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => AnalyticsPayload;

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

@@ -1,4 +1,4 @@
-import { APIError, CardType } from '@atlaskit/linking-common';
 import { AnalyticsPayload } from '../types';
+import { InstrumentEventProps } from './types';
 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;
+export declare const instrumentEvent: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => AnalyticsPayload | undefined;

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

@@ -1,2 +1,93 @@
+import { APIError, CardType } from '@atlaskit/linking-common';
+import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
+import { ErrorInfo } from 'react';
+import { CardInnerAppearance } from '../../view/Card/types';
+import { InvokeType } from '../../model/invoke-opts';
 export declare type DestinationProduct = 'jira' | 'confluence' | 'bitbucket' | 'trello';
 export declare type DestinationSubproduct = 'core' | 'software' | 'servicedesk';
+export interface CommonEventProps {
+    id?: string;
+    definitionId?: string;
+    extensionKey?: string;
+    resourceType?: string;
+    destinationSubproduct?: DestinationSubproduct | string;
+    destinationProduct?: DestinationProduct | string;
+    location?: string;
+}
+export declare type ResolvedEventProps = CommonEventProps & {
+    id: string;
+};
+export declare type UnresolvedEventProps = CommonEventProps & {
+    id: string;
+    status: string;
+    error?: APIError;
+};
+export declare type InvokeSucceededEventProps = CommonEventProps & {
+    id: string;
+    actionType: string;
+    display: CardInnerAppearance;
+};
+export declare type InvokeFailedEventProps = CommonEventProps & {
+    id: string;
+    actionType: string;
+    display: CardInnerAppearance;
+    reason: string;
+};
+export declare type ConnectSucceededEventProps = CommonEventProps & {
+    id?: string;
+};
+export declare type ConnectFailedEventProps = CommonEventProps & {
+    id?: string;
+    reason?: string;
+};
+export declare type TrackAppAccountConnectedProps = CommonEventProps;
+export declare type UiAuthEventProps = CommonEventProps & {
+    display: CardInnerAppearance;
+};
+export declare type UiAuthAlternateAccountEventProps = CommonEventProps & {
+    display: CardInnerAppearance;
+};
+export declare type UiCardClickedEventProps = CommonEventProps & {
+    id: string;
+    display: CardInnerAppearance;
+    status: CardType;
+    isModifierKeyPressed?: boolean;
+    actionSubjectId?: string;
+};
+export declare type UiActionClickedEventProps = CommonEventProps & {
+    id: string;
+    display: CardInnerAppearance;
+    actionType: string;
+    invokeType?: InvokeType;
+};
+export declare type ScreenAuthPopupEventProps = CommonEventProps;
+export declare type UiClosedAuthEventProps = CommonEventProps & {
+    display: CardInnerAppearance;
+};
+export declare type UiRenderSuccessEventProps = CommonEventProps & {
+    display: CardInnerAppearance;
+    status: CardType;
+};
+export declare type UiRenderFailedEventProps = CommonEventProps & {
+    display: CardInnerAppearance;
+    error: Error;
+    errorInfo: ErrorInfo;
+};
+export declare type UiHoverCardViewedEventProps = CommonEventProps & {
+    previewDisplay: PreviewDisplay;
+    previewInvokeMethod?: PreviewInvokeMethod;
+};
+export declare type UiHoverCardDismissedEventProps = CommonEventProps & {
+    previewDisplay: PreviewDisplay;
+    hoverTime: number;
+    previewInvokeMethod?: PreviewInvokeMethod;
+};
+export declare type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
+    previewDisplay: PreviewDisplay;
+    previewInvokeMethod?: PreviewInvokeMethod;
+};
+export declare type InstrumentEventProps = CommonEventProps & {
+    error?: APIError;
+    status: CardType;
+    id: string;
+};

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

@@ -20,7 +20,55 @@ export declare const mocks: {
             status: string;
         };
     };
+    analytics: {
+        status: string;
+        details: {
+            meta: {
+                definitionId: string;
+                key: string;
+                resourceType: string;
+                subproduct: string;
+                product: string;
+            };
+        };
+    };
 };
 export declare const fakeResponse: () => Promise<JsonLd.Response<JsonLd.Data.BaseData>>;
 export declare const fakeFactory: any;
 export declare const waitFor: (time?: number) => Promise<unknown>;
+export declare const mockAnalytics: {
+    ui: {
+        authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiAuthEventProps) => void;
+        authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiAuthAlternateAccountEventProps) => void;
+        buttonClickedEvent: (data: Partial<import("./types").AnalyticsPayload> & {
+            actionSubjectId: string;
+        }) => void;
+        cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("./analytics/types").UiCardClickedEventProps) => void;
+        actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiActionClickedEventProps) => void;
+        hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("./analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
+        closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiClosedAuthEventProps) => void;
+        modalClosedEvent: (data: Partial<import("./types").AnalyticsPayload> & {
+            actionSubjectId: string;
+        }) => 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;
+    };
+    operational: {
+        invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").InvokeSucceededEventProps) => void;
+        invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").InvokeFailedEventProps) => void;
+        connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").ConnectSucceededEventProps) => void;
+        connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").ConnectFailedEventProps) => void;
+        instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("./analytics/types").InstrumentEventProps) => void;
+    };
+    track: {
+        appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").CommonEventProps) => void;
+    };
+    screen: {
+        authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").CommonEventProps) => void;
+        modalViewedEvent: (data: Partial<import("./types").AnalyticsPayload> & {
+            name: "embedPreviewModal";
+        }) => void;
+    };
+};

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

@@ -1,7 +1,9 @@
 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 AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard';
+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';
 export declare type AnalyticsPayload = GasPayload & {
     action?: AnalyticsAction;
     actionSubject: AnalyticsActionSubject;

package/dist/types/view/BlockCard/actions/PreviewAction.d.ts

@@ -1,9 +1,11 @@
 import React, { ErrorInfo } from 'react';
 import { LinkingPlatformFeatureFlags } from '@atlaskit/linking-common';
+import { AnalyticsFacade } from '../../../state/analytics';
 import { EmbedModalWithExperimentProps } from '../../EmbedModal/types';
 import { ActionProps } from '../components/Action';
 import { IconProps } from '../../common/Icon';
 import { MetadataProps } from '../../common/Metadata';
+import { AnalyticsOrigin } from '../../../utils/types';
 export interface PreviewFunctionArg extends EmbedModalWithExperimentProps {
     popupMountPointId: string;
 }
@@ -23,6 +25,8 @@ declare type PreviewInfo = {
     onOpen?: () => void;
     onOpenFailed?: (error: Error, errorInfo: ErrorInfo) => void;
     featureFlags?: Partial<LinkingPlatformFeatureFlags>;
+    analytics: AnalyticsFacade;
+    origin?: AnalyticsOrigin;
 };
 declare const _default: ({ details, ...rest }: PreviewInfo) => ActionProps;
 export default _default;

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

@@ -1,14 +1,14 @@
 import { FC } from 'react';
 import { BlockCardProps } from './types';
-export { default as PreviewAction } from './actions/PreviewAction';
 import { AuthorizeAction } from './actions/AuthorizeAction';
 import { ForbiddenAction } from './actions/ForbiddenAction';
 import { ResolvedView as BlockCardResolvedView } from './views/ResolvedView';
-export type { ResolvedViewProps as BlockCardResolvedViewProps } from './views/ResolvedView';
 import { NotFoundView as BlockCardNotFoundView } from './views/NotFoundView';
 import { ResolvingView as BlockCardResolvingView } from './views/ResolvingView';
 import { UnauthorizedView as BlockCardUnauthorisedView } from './views/UnauthorizedView';
 import { ForbiddenView as BlockCardForbiddenView } from './views/ForbiddenView';
 import { ErroredView as BlockCardErroredView } from './views/ErroredView';
+export { default as PreviewAction } from './actions/PreviewAction';
+export type { ResolvedViewProps as BlockCardResolvedViewProps } from './views/ResolvedView';
 export { ForbiddenAction, AuthorizeAction, BlockCardResolvedView, BlockCardResolvingView, BlockCardUnauthorisedView, BlockCardForbiddenView, BlockCardErroredView, BlockCardNotFoundView, };
 export declare const BlockCard: FC<BlockCardProps>;

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

@@ -1,10 +1,10 @@
 /// <reference types="react" />
-import { CardProviderRenderers, CardAuthFlowOpts } from '@atlaskit/link-provider';
+import { CardAuthFlowOpts, CardProviderRenderers } from '@atlaskit/link-provider';
 import { CardState } from '../../state/types';
 import { InvokeHandler } from '../../model/invoke-handler';
-import { AnalyticsHandler } from '../../utils/types';
-import { OnResolveCallback, CardPlatform } from '../Card/types';
+import { CardPlatform, OnResolveCallback } from '../Card/types';
 import { OnErrorCallback } from '../types';
+import { AnalyticsFacade } from '../../state/analytics';
 export declare type BlockCardProps = {
     id: string;
     url: string;
@@ -12,7 +12,6 @@ export declare type BlockCardProps = {
     authFlow?: CardAuthFlowOpts['authFlow'];
     handleAuthorize: (() => void) | undefined;
     handleErrorRetry: () => void;
-    handleAnalytics: AnalyticsHandler;
     handleInvoke: InvokeHandler;
     handleFrameClick: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
     isSelected?: boolean;
@@ -22,4 +21,5 @@ export declare type BlockCardProps = {
     showActions?: boolean;
     renderers?: CardProviderRenderers;
     platform?: CardPlatform;
+    analytics: AnalyticsFacade;
 };

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<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" | "id" | "placeholder" | "onError" | "onClick" | "analyticsContext" | "key" | "url" | "ui" | "showHoverPreview" | "showActions" | "onResolve" | "platform" | "isFrameVisible" | "embedIframeRef" | "inlinePreloaderStyle" | "importer" | "container" | "analyticsEvents" | "forwardedRef"> & 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" | "id" | "placeholder" | "onError" | "onClick" | "analyticsContext" | "key" | "url" | "ui" | "showActions" | "showHoverPreview" | "onResolve" | "platform" | "isFrameVisible" | "embedIframeRef" | "inlinePreloaderStyle" | "importer" | "container" | "analyticsEvents" | "forwardedRef"> & React.RefAttributes<any>>;
 export type { CardAppearance, CardProps, CardPlatform };