@atlaskit/smart-card 32.5.1 → 32.7.0

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

@@ -1,4 +1,4 @@
-import { type ConnectFailedEventProps, type ConnectSucceededEventProps, type InstrumentEventProps, type InvokeFailedEventProps, type InvokeSucceededEventProps, type UiActionClickedEventProps, type UiAuthAlternateAccountEventProps, type UiAuthEventProps, type UiCardClickedEventProps, type UiClosedAuthEventProps, type UiHoverCardDismissedEventProps, type UiHoverCardOpenLinkClickedEventProps, type UiHoverCardViewedEventProps, type UiRenderFailedEventProps, type UiRenderSuccessEventProps, type UiServerActionClickedEventProps } from '../../utils/analytics/types';
+import { type InvokeFailedEventProps, type InvokeSucceededEventProps, type UiActionClickedEventProps, type UiAuthAlternateAccountEventProps, type UiAuthEventProps, type UiCardClickedEventProps, type UiClosedAuthEventProps, type UiHoverCardDismissedEventProps, type UiHoverCardOpenLinkClickedEventProps, type UiHoverCardViewedEventProps, type UiRenderFailedEventProps, type UiRenderSuccessEventProps, type UiServerActionClickedEventProps } from '../../utils/analytics/types';
 import { type AnalyticsName, type AnalyticsPayload } from '../../utils/types';
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
@@ -18,6 +18,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
         /**
@@ -27,6 +28,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthAlternateAccountEventProps) => void;
         /**
@@ -48,6 +50,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param location Where the Smart Link is currently rendered.
          * @param destinationProduct The product the Smart Link is linked to.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
         /**
@@ -67,6 +70,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param previewInvokeMethod How the preview was triggered.
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
         /**
@@ -75,6 +79,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => void;
         /**
@@ -109,6 +114,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param previewInvokeMethod How the preview was triggered.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
         /**
@@ -119,26 +125,34 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param extensionKey The extensionKey of the Smart Link resolver invoked.
          * @param previewInvokeMethod How the preview was triggered.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
         /**
          * Fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param location The location where a link is displayed (jiraWebLinks, confluencePages etc)
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         learnMoreClickedEvent: () => void;
         /**
          * Fires an event that represent a click was performed on a Status Lozenge
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         smartLinkLozengeActionClickedEvent: () => void;
         /**
          * Fires an event that represent a click was performed on a Status Lozenge's dropdown item
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         smartLinkLozengeActionListItemClickedEvent: () => void;
         /**
          * Fires an event that represent a click was performed on a Status Lozenge open preview button
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
+        /**
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+         */
         smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
     };
     operational: {
@@ -159,43 +173,6 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param reason The reason the invocation failed.
          */
         invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
-        /**
-         * This fires an event that represents an account successfully being connected via a Smart Link.
-         * @param id The unique ID for this Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => void;
-        /**
-         * This fires an event that represents an account unsuccessfully being connected.
-         * @param id The unique ID for this Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param reason The reason why the Smart Link connect account failed.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectFailedEventProps) => void;
-        /**
-         * This fires an event which represents a Smart Link request succeeding or failing based on the status.
-         * @param id The unique ID for this Smart Link.
-         * @param status The status of the Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
-         * @param error An error representing why the Smart Link request failed.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
-        /**
-         * This fires an event that represents when a Smart Link renders unsuccessfully.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param id The unique ID for this Smart Link.
-         * @param error: An error representing why the Smart Link render failed.
-         * @param errorInfo: Additional details about the error including the stack trace.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
     };
     screen: {
         /**

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

@@ -35,10 +35,6 @@ export declare function useSmartLink(id: string, url: string): {
         operational: {
             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;
-            chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
         };
         screen: {
             modalViewedEvent: (data: Partial<import("../..").AnalyticsPayload> & {

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

@@ -1,7 +1,7 @@
 import { type CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { type CardInnerAppearance } from '../../view/Card/types';
 import { type AnalyticsPayload } from '../types';
-import { type ConnectFailedEventProps, type ConnectSucceededEventProps, type InvokeFailedEventProps, type InvokeSucceededEventProps, type ResolvedEventProps, type UiActionClickedEventProps, type UiAuthAlternateAccountEventProps, type UiAuthEventProps, type UiCardClickedEventProps, type UiClosedAuthEventProps, type UiHoverCardDismissedEventProps, type UiHoverCardOpenLinkClickedEventProps, type UiHoverCardViewedEventProps, type UiRenderFailedEventProps, type UiRenderSuccessEventProps, type UiServerActionClickedEventProps, type UnresolvedEventProps } from './types';
+import { type InvokeFailedEventProps, type InvokeSucceededEventProps, type UiActionClickedEventProps, type UiAuthAlternateAccountEventProps, type UiAuthEventProps, type UiCardClickedEventProps, type UiClosedAuthEventProps, type UiHoverCardDismissedEventProps, type UiHoverCardOpenLinkClickedEventProps, type UiHoverCardViewedEventProps, type UiRenderFailedEventProps, type UiRenderSuccessEventProps, type UiServerActionClickedEventProps } from './types';
 export declare const ANALYTICS_CHANNEL = "media";
 export declare const context: {
     componentName: string;
@@ -22,40 +22,56 @@ export declare class SmartLinkEvents {
     insertSmartLink(url: string, type: CardInnerAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
 }
 export declare const fireSmartLinkEvent: (payload: AnalyticsPayload, createAnalyticsEvent?: CreateUIAnalyticsEvent) => void;
-/**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
- */
-export declare const resolvedEvent: (props: ResolvedEventProps) => AnalyticsPayload;
-/**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
- */
-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;
 /**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
  */
-export declare const connectSucceededEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => AnalyticsPayload;
+export declare const uiAuthEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, display, }: UiAuthEventProps) => AnalyticsPayload;
 /**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
  */
-export declare const connectFailedEvent: ({ definitionId, extensionKey, destinationProduct, destinationSubproduct, location, reason, }: ConnectFailedEventProps) => 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;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 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;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiClosedAuthEvent: ({ display, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => AnalyticsPayload;
 export declare const uiRenderSuccessEvent: ({ display, status, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, canBeDatasource, }: UiRenderSuccessEventProps) => AnalyticsPayload;
 export declare const uiRenderFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiHoverCardViewedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, status, }: UiHoverCardViewedEventProps) => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiHoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, status, }: UiHoverCardDismissedEventProps) => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiHoverCardOpenLinkClickedEvent: ({ id, previewDisplay, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiLearnMoreLinkClickedEvent: () => AnalyticsPayload;
 /**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
  */
-export declare const chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => AnalyticsPayload;
 export declare const uiSmartLinkStatusLozengeButtonClicked: () => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiSmartLinkStatusListItemButtonClicked: () => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiSmartLinkStatusOpenPreviewButtonClicked: () => AnalyticsPayload;
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export declare const uiServerActionClicked: ({ smartLinkActionType, }: UiServerActionClickedEventProps) => AnalyticsPayload;

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

@@ -1,7 +1 @@
-import { type AnalyticsPayload } from '../types';
-import { type InstrumentEventProps } from './types';
-export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, resolvedEvent, unresolvedEvent, invokeSucceededEvent, invokeFailedEvent, chunkloadFailedEvent, connectSucceededEvent, connectFailedEvent, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiLearnMoreLinkClickedEvent, uiSmartLinkStatusLozengeButtonClicked, uiSmartLinkStatusListItemButtonClicked, uiSmartLinkStatusOpenPreviewButtonClicked, } from './analytics';
-/**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
- */
-export declare const instrumentEvent: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => AnalyticsPayload | undefined;
+export { ANALYTICS_CHANNEL, context, fireSmartLinkEvent, invokeSucceededEvent, invokeFailedEvent, uiAuthEvent, uiAuthAlternateAccountEvent, uiCardClickedEvent, uiActionClickedEvent, uiClosedAuthEvent, uiRenderSuccessEvent, uiRenderFailedEvent, uiHoverCardViewedEvent, uiHoverCardDismissedEvent, uiHoverCardOpenLinkClickedEvent, uiLearnMoreLinkClickedEvent, uiSmartLinkStatusLozengeButtonClicked, uiSmartLinkStatusListItemButtonClicked, uiSmartLinkStatusOpenPreviewButtonClicked, } from './analytics';

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

@@ -37,24 +37,20 @@ export type InvokeFailedEventProps = CommonEventProps & {
     reason: string;
 };
 /**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
  */
-export type ConnectSucceededEventProps = CommonEventProps & {
-    id?: string;
-};
-/**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
- */
-export type ConnectFailedEventProps = CommonEventProps & {
-    id?: string;
-    reason?: string;
-};
 export type UiAuthEventProps = CommonEventProps & {
     display: CardInnerAppearance;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiAuthAlternateAccountEventProps = CommonEventProps & {
     display: CardInnerAppearance;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiCardClickedEventProps = CommonEventProps & {
     id: string;
     display: CardInnerAppearance;
@@ -68,9 +64,15 @@ export type UiActionClickedEventProps = CommonEventProps & {
     actionType: string;
     invokeType?: InvokeType;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiServerActionClickedEventProps = CommonEventProps & {
     smartLinkActionType: SmartLinkActionType;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiClosedAuthEventProps = CommonEventProps & {
     display: CardInnerAppearance;
 };
@@ -79,37 +81,35 @@ export type UiRenderSuccessEventProps = CommonEventProps & {
     status: CardType;
     canBeDatasource?: boolean;
 };
-/**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
- */
 export type UiRenderFailedEventProps = CommonEventProps & {
     display: CardInnerAppearance;
     error: Error;
     errorInfo: ErrorInfo;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiHoverCardViewedEventProps = CommonEventProps & {
     previewDisplay: PreviewDisplay;
     previewInvokeMethod?: PreviewInvokeMethod;
     status: CardType;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiHoverCardDismissedEventProps = CommonEventProps & {
     previewDisplay: PreviewDisplay;
     hoverTime: number;
     previewInvokeMethod?: PreviewInvokeMethod;
     status: CardType;
 };
+/**
+ * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+ */
 export type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
     previewDisplay: PreviewDisplay;
     previewInvokeMethod?: PreviewInvokeMethod;
 };
-/**
- * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
- */
-export type InstrumentEventProps = CommonEventProps & {
-    error?: APIError;
-    status: CardType;
-    id: string;
-};
 export type ClickType = 'left' | 'middle' | 'right' | 'keyboard' | 'none';
 export type ClickOutcome = 'prevented' | 'clickThrough' | 'clickThroughNewTabOrWindow' | 'contextMenu' | 'alt' | 'contentEditable' | 'unknown';
 export type UiLinkClickedEventProps = {

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

@@ -116,10 +116,6 @@ export declare const mockAnalytics: {
     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;
-        chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiRenderFailedEventProps) => void;
     };
     screen: {
         modalViewedEvent: (data: Partial<import("./types").AnalyticsPayload> & {

package/dist/types-ts4.5/common/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::519effabaa6c383d7fa35374469faada>>
+ * @codegen <<SignedSource::050cd99cdd30e3c38674dc47986e3214>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen smart-card
  */
 export type PackageMetaDataContextType = {
@@ -115,6 +115,48 @@ export type SmartLinkChunkLoadFailedAttributesType = {
     error: Record<string, unknown>;
     errorInfo: Record<string, unknown>;
 };
+export type SmartLinkClickedAttributesType = {
+    id: string;
+    display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
+    definitionId: string | null;
+    isModifierKeyPressed: boolean | null;
+};
+export type SmartLinkClickedTitleGoToLinkAttributesType = {
+    id: string;
+    display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
+    definitionId: string | null;
+    isModifierKeyPressed: boolean | null;
+};
+export type HoverCardViewedAttributesType = {
+    previewDisplay: 'card' | 'embed';
+    previewInvokeMethod: 'keyboard' | 'mouse_hover' | 'mouse_click' | null;
+    definitionId: string | null;
+};
+export type HoverCardDismissedAttributesType = {
+    previewDisplay: 'card' | 'embed';
+    hoverTime: number;
+    previewInvokeMethod: 'keyboard' | 'mouse_hover' | 'mouse_click' | null;
+    definitionId: string | null;
+};
+export type ButtonClickedConnectAccountAttributesType = {
+    display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
+    definitionId: string | null;
+};
+export type SmartLinkClickedTryAnotherAccountAttributesType = {
+    display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
+    definitionId: string | null;
+};
+export type ConsentModalClosedAttributesType = {
+    display: 'inline' | 'block' | 'embed' | 'embedPreview' | 'flexible' | 'hoverCardPreview';
+    definitionId: string | null;
+};
+export type ButtonClickedLearnMoreAttributesType = {};
+export type ButtonClickedSmartLinkStatusLozengeAttributesType = {};
+export type ButtonClickedSmartLinkStatusListItemAttributesType = {};
+export type ButtonClickedSmartLinkStatusOpenPreviewAttributesType = {};
+export type ButtonClickedSmartLinkFollowButtonAttributesType = {};
+export type ButtonClickedStatusUpdateActionAttributesType = {};
+export type ButtonClickedGetStatusTransitionsActionAttributesType = {};
 export type AnalyticsEventAttributes = {
     /**
      * fired when an ai summary is clicked */
@@ -194,5 +236,45 @@ export type AnalyticsEventAttributes = {
     /**
      * fires an event that represents when a Smart Link renders unsuccessfully. */
     'operational.smartLink.chunkLoadFailed': SmartLinkChunkLoadFailedAttributesType;
+    /**
+     * fires an event that represents when a user clicks on a Smart Link. */
+    'ui.smartLink.clicked': SmartLinkClickedAttributesType;
+    /**
+     * fires an event that represents when a user clicks on a Smart Link. */
+    'ui.smartLink.clicked.titleGoToLink': SmartLinkClickedTitleGoToLinkAttributesType;
+    /**
+     * fires an event that represents a hover preview being opened. */
+    'ui.hoverCard.viewed': HoverCardViewedAttributesType;
+    /**
+     * fires an event that represents a hover preview being dismissed. */
+    'ui.hoverCard.dismissed': HoverCardDismissedAttributesType;
+    /**
+     * fires an event that represents when a user clicks on the authentication call to action with no current authenticated account. (i.e. Connect to Preview). */
+    'ui.button.clicked.connectAccount': ButtonClickedConnectAccountAttributesType;
+    /**
+     * 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). */
+    'ui.smartLink.clicked.tryAnotherAccount': SmartLinkClickedTryAnotherAccountAttributesType;
+    /**
+     * fires an event that represents when a user closed the authentication window without authenticating after opening it. */
+    'ui.consentModal.closed': ConsentModalClosedAttributesType;
+    /**
+     * fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card */
+    'ui.button.clicked.learnMore': ButtonClickedLearnMoreAttributesType;
+    /**
+     * fires an event that represent a click was performed on a Status Lozenge */
+    'ui.button.clicked.smartLinkStatusLozenge': ButtonClickedSmartLinkStatusLozengeAttributesType;
+    /**
+     * fires an event that represent a click was performed on a Status Lozenge's dropdown item */
+    'ui.button.clicked.smartLinkStatusListItem': ButtonClickedSmartLinkStatusListItemAttributesType;
+    /**
+     * fires an event that represent a click was performed on a Status Lozenge open preview button */
+    'ui.button.clicked.smartLinkStatusOpenPreview': ButtonClickedSmartLinkStatusOpenPreviewAttributesType;
+    /**
+     * fires an event that represents a click was performed on the follow button. */
+    'ui.button.clicked.smartLinkFollowButton': ButtonClickedSmartLinkFollowButtonAttributesType;
+    /** */
+    'ui.button.clicked.StatusUpdateAction': ButtonClickedStatusUpdateActionAttributesType;
+    /** */
+    'ui.button.clicked.GetStatusTransitionsAction': ButtonClickedGetStatusTransitionsActionAttributesType;
 };
 export type EventKey = keyof AnalyticsEventAttributes;

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

@@ -1,4 +1,4 @@
-import { type ConnectFailedEventProps, type ConnectSucceededEventProps, type InstrumentEventProps, type InvokeFailedEventProps, type InvokeSucceededEventProps, type UiActionClickedEventProps, type UiAuthAlternateAccountEventProps, type UiAuthEventProps, type UiCardClickedEventProps, type UiClosedAuthEventProps, type UiHoverCardDismissedEventProps, type UiHoverCardOpenLinkClickedEventProps, type UiHoverCardViewedEventProps, type UiRenderFailedEventProps, type UiRenderSuccessEventProps, type UiServerActionClickedEventProps } from '../../utils/analytics/types';
+import { type InvokeFailedEventProps, type InvokeSucceededEventProps, type UiActionClickedEventProps, type UiAuthAlternateAccountEventProps, type UiAuthEventProps, type UiCardClickedEventProps, type UiClosedAuthEventProps, type UiHoverCardDismissedEventProps, type UiHoverCardOpenLinkClickedEventProps, type UiHoverCardViewedEventProps, type UiRenderFailedEventProps, type UiRenderSuccessEventProps, type UiServerActionClickedEventProps } from '../../utils/analytics/types';
 import { type AnalyticsName, type AnalyticsPayload } from '../../utils/types';
 /**
  * This hook provides usage of Smart Link analytics outside of the Card component.
@@ -18,6 +18,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
         /**
@@ -27,6 +28,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthAlternateAccountEventProps) => void;
         /**
@@ -48,6 +50,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param location Where the Smart Link is currently rendered.
          * @param destinationProduct The product the Smart Link is linked to.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
         /**
@@ -67,6 +70,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param previewInvokeMethod How the preview was triggered.
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
         /**
@@ -75,6 +79,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param definitionId The definitionId of the Smart Link resolver invoked.
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => void;
         /**
@@ -109,6 +114,7 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param previewInvokeMethod How the preview was triggered.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
         /**
@@ -119,26 +125,34 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param extensionKey The extensionKey of the Smart Link resolver invoked.
          * @param previewInvokeMethod How the preview was triggered.
          * @returns
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
         /**
          * Fires an event that signifies that a "Learn More" link was clicked on an unauthenticated card
          * @param extensionKey The extensionKey of the Smart Link resovler invoked.
          * @param location The location where a link is displayed (jiraWebLinks, confluencePages etc)
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         learnMoreClickedEvent: () => void;
         /**
          * Fires an event that represent a click was performed on a Status Lozenge
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         smartLinkLozengeActionClickedEvent: () => void;
         /**
          * Fires an event that represent a click was performed on a Status Lozenge's dropdown item
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         smartLinkLozengeActionListItemClickedEvent: () => void;
         /**
          * Fires an event that represent a click was performed on a Status Lozenge open preview button
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
          */
         smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
+        /**
+         * @deprecated consider removing when cleaning up FF platform_migrate-some-ui-events-smart-card
+         */
         smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
     };
     operational: {
@@ -159,43 +173,6 @@ export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLo
          * @param reason The reason the invocation failed.
          */
         invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
-        /**
-         * This fires an event that represents an account successfully being connected via a Smart Link.
-         * @param id The unique ID for this Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => void;
-        /**
-         * This fires an event that represents an account unsuccessfully being connected.
-         * @param id The unique ID for this Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param reason The reason why the Smart Link connect account failed.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectFailedEventProps) => void;
-        /**
-         * This fires an event which represents a Smart Link request succeeding or failing based on the status.
-         * @param id The unique ID for this Smart Link.
-         * @param status The status of the Smart Link.
-         * @param definitionId The definitionId of the Smart Link resolver invoked.
-         * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-         * @param resourceType The type of resource that was invoked. This is provider specific (e.g. File, PullRequest).
-         * @param error An error representing why the Smart Link request failed.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
-        /**
-         * This fires an event that represents when a Smart Link renders unsuccessfully.
-         * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-         * @param id The unique ID for this Smart Link.
-         * @param error: An error representing why the Smart Link render failed.
-         * @param errorInfo: Additional details about the error including the stack trace.
-         * @deprecated remove with platform_smart-card-migrate-operational-analytics clean up
-         */
-        chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
     };
     screen: {
         /**

package/dist/types-ts4.5/state/hooks/useSmartLink.d.ts

@@ -35,10 +35,6 @@ export declare function useSmartLink(id: string, url: string): {
         operational: {
             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;
-            chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
         };
         screen: {
             modalViewedEvent: (data: Partial<import("../..").AnalyticsPayload> & {