@atlaskit/smart-card 23.11.3 → 23.12.0

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

@@ -1,7 +1,7 @@
 import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { AnalyticsPayload } from '../types';
 import { CardInnerAppearance } from '../../view/Card/types';
-import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UnresolvedEventProps } from './types';
+import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UnresolvedEventProps } from './types';
 export declare const ANALYTICS_CHANNEL = "media";
 export declare const context: {
     componentName: string;
@@ -26,6 +26,8 @@ export declare const trackLinkUpdated: ({ actionSubjectId, ...attributes }: Comm
 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 uiIframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: UiIframeDwelledEventProps) => AnalyticsPayload;
+export declare const uiIframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: UiIframeFocusedEventProps) => 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;

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

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

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

@@ -54,6 +54,18 @@ export declare type UiCardClickedEventProps = CommonEventProps & {
     isModifierKeyPressed?: boolean;
     actionSubjectId?: string;
 };
+export declare type UiIframeDwelledEventProps = CommonEventProps & {
+    id: string;
+    display: CardInnerAppearance;
+    status: CardType;
+    dwellTime: number;
+    dwellPercentVisible: number;
+};
+export declare type UiIframeFocusedEventProps = CommonEventProps & {
+    id: string;
+    display: CardInnerAppearance;
+    status: CardType;
+};
 export declare type UiActionClickedEventProps = CommonEventProps & {
     id: string;
     display: CardInnerAppearance;

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

@@ -47,6 +47,8 @@ export declare const mockAnalytics: {
             actionSubjectId: string;
         }) => void;
         cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("./analytics/types").UiCardClickedEventProps) => void;
+        iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: import("./analytics/types").UiIframeDwelledEventProps) => void;
+        iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: import("./analytics/types").UiIframeFocusedEventProps) => 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;

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

@@ -1,7 +1,7 @@
 import { GasPayload } from '@atlaskit/analytics-gas-types';
 import { CardInnerAppearance } from '../view/Card/types';
-export declare type AnalyticsAction = 'authStarted' | 'clicked' | 'closed' | 'connected' | 'connectFailed' | 'connectSucceeded' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'viewed' | 'unresolved' | 'updated' | 'chunkLoadFailed';
-export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard' | 'modal' | 'embedPreviewModal' | 'link';
+export declare type AnalyticsAction = 'authStarted' | 'clicked' | 'closed' | 'connected' | 'connectFailed' | 'connectSucceeded' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'viewed' | 'unresolved' | 'updated' | 'chunkLoadFailed' | 'dwelled' | 'focused';
+export declare type AnalyticsActionSubject = 'smartLink' | 'smartLinkAction' | 'applicationAccount' | 'button' | 'consentModal' | 'hoverCard' | 'modal' | 'embedPreviewModal' | 'smartLinkIframe' | 'link';
 export declare type AnalyticsName = 'embedPreviewModal';
 export declare type AnalyticsOrigin = 'smartLinkCard' | 'smartLinkEmbed' | 'smartLinkInline' | 'smartLinkPreviewHoverCard';
 export declare type AnalyticsPayload = GasPayload & {

package/dist/types/view/EmbedCard/components/Frame.d.ts

@@ -3,5 +3,7 @@ export interface FrameProps {
     url?: string;
     isTrusted?: boolean;
     testId?: string;
+    onIframeDwell?: (dwellTime: number, dwellPercentVisible: number) => void;
+    onIframeFocus?: () => void;
 }
 export declare const Frame: React.ForwardRefExoticComponent<FrameProps & React.RefAttributes<HTMLIFrameElement>>;

package/dist/types/view/EmbedCard/components/IframeDwellTracker.d.ts

@@ -0,0 +1,8 @@
+export interface IframeDwellTrackerProps {
+    isIframeLoaded: boolean;
+    isMouseOver: boolean;
+    isWindowFocused: boolean;
+    iframePercentVisible: number;
+    onIframeDwell?: (dwellTime: number, dwellPercentVisible: number) => void;
+}
+export declare const IframeDwellTracker: ({ isIframeLoaded, isMouseOver, isWindowFocused, iframePercentVisible, onIframeDwell, }: IframeDwellTrackerProps) => null;

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

@@ -23,6 +23,8 @@ export declare type EmbedCardProps = {
     testId?: string;
     inheritDimensions?: boolean;
     showActions?: boolean;
+    onIframeDwell?: (dwellTime: number, dwellPercentVisible: number) => void;
+    onIframeFocus?: () => void;
 };
 export interface WithShowControlMethodProp {
     showControls?: () => void;

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

@@ -23,5 +23,9 @@ export interface EmbedCardResolvedViewProps {
     /** For testing purposes only. */
     testId?: string;
     inheritDimensions?: boolean;
+    /** Optional callback for when user dwells cursor over iframe - for analytics **/
+    onIframeDwell?: (dwellTime: number, dwellPercentVisible: number) => void;
+    /** Optional callback for when user navigates into an iframe - for analytics **/
+    onIframeFocus?: () => void;
 }
 export declare const EmbedCardResolvedView: React.ForwardRefExoticComponent<EmbedCardResolvedViewProps & React.RefAttributes<HTMLIFrameElement>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "23.11.3",
+  "version": "23.12.0",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -33,7 +33,7 @@
     "@atlaskit/icon-object": "^6.2.0",
     "@atlaskit/icon-priority": "^6.3.0",
     "@atlaskit/in-product-testing": "^0.1.0",
-    "@atlaskit/linking-common": "^1.16.0",
+    "@atlaskit/linking-common": "^1.19.0",
     "@atlaskit/logo": "^13.10.0",
     "@atlaskit/lozenge": "^11.3.0",
     "@atlaskit/media-common": "^2.18.0",

package/report.api.md

@@ -94,6 +94,8 @@ export type AnalyticsAction =
   | 'connected'
   | 'created'
   | 'dismissed'
+  | 'dwelled'
+  | 'focused'
   | 'inserted'
   | 'renderFailed'
   | 'renderSuccess'
@@ -113,7 +115,8 @@ export type AnalyticsActionSubject =
   | 'link'
   | 'modal'
   | 'smartLink'
-  | 'smartLinkAction';
+  | 'smartLinkAction'
+  | 'smartLinkIframe';
 
 // @public (undocumented)
 type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
@@ -905,6 +908,22 @@ type UiHoverCardViewedEventProps = CommonEventProps & {
   status: CardType;
 };
 
+// @public (undocumented)
+type UiIframeDwelledEventProps = CommonEventProps & {
+  id: string;
+  display: CardInnerAppearance;
+  status: CardType;
+  dwellTime: number;
+  dwellPercentVisible: number;
+};
+
+// @public (undocumented)
+type UiIframeFocusedEventProps = CommonEventProps & {
+  id: string;
+  display: CardInnerAppearance;
+  status: CardType;
+};
+
 // @public (undocumented)
 type UiRenderFailedEventProps = CommonEventProps & {
   display: CardInnerAppearance;
@@ -961,6 +980,28 @@ export const useSmartLinkAnalytics: (
       destinationSubproduct,
       actionSubjectId,
     }: UiCardClickedEventProps) => void;
+    iframeDwelledEvent: ({
+      id,
+      display,
+      status,
+      definitionId,
+      extensionKey,
+      location,
+      destinationProduct,
+      destinationSubproduct,
+      dwellTime,
+      dwellPercentVisible,
+    }: UiIframeDwelledEventProps) => void;
+    iframeFocusedEvent: ({
+      id,
+      display,
+      status,
+      definitionId,
+      extensionKey,
+      location,
+      destinationProduct,
+      destinationSubproduct,
+    }: UiIframeFocusedEventProps) => void;
     actionClickedEvent: ({
       id,
       actionType,

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

@@ -70,10 +70,10 @@ type ActionProps = {
 };
 
 // @public (undocumented)
-export type AnalyticsAction = 'authStarted' | 'chunkLoadFailed' | 'clicked' | 'closed' | 'connectFailed' | 'connectSucceeded' | 'connected' | 'created' | 'dismissed' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'unresolved' | 'updated' | 'viewed';
+export type AnalyticsAction = 'authStarted' | 'chunkLoadFailed' | 'clicked' | 'closed' | 'connectFailed' | 'connectSucceeded' | 'connected' | 'created' | 'dismissed' | 'dwelled' | 'focused' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'unresolved' | 'updated' | 'viewed';
 
 // @public (undocumented)
-export type AnalyticsActionSubject = 'applicationAccount' | 'button' | 'consentModal' | 'embedPreviewModal' | 'hoverCard' | 'link' | 'modal' | 'smartLink' | 'smartLinkAction';
+export type AnalyticsActionSubject = 'applicationAccount' | 'button' | 'consentModal' | 'embedPreviewModal' | 'hoverCard' | 'link' | 'modal' | 'smartLink' | 'smartLinkAction' | 'smartLinkIframe';
 
 // @public (undocumented)
 type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
@@ -775,6 +775,22 @@ type UiHoverCardViewedEventProps = CommonEventProps & {
     status: CardType;
 };
 
+// @public (undocumented)
+type UiIframeDwelledEventProps = CommonEventProps & {
+    id: string;
+    display: CardInnerAppearance;
+    status: CardType;
+    dwellTime: number;
+    dwellPercentVisible: number;
+};
+
+// @public (undocumented)
+type UiIframeFocusedEventProps = CommonEventProps & {
+    id: string;
+    display: CardInnerAppearance;
+    status: CardType;
+};
+
 // @public (undocumented)
 type UiRenderFailedEventProps = CommonEventProps & {
     display: CardInnerAppearance;
@@ -797,6 +813,8 @@ export const useSmartLinkAnalytics: (url: string, dispatchAnalytics: AnalyticsHa
             actionSubjectId: Required<string>;
         }) => void;
         cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
+        iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: UiIframeDwelledEventProps) => void;
+        iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: UiIframeFocusedEventProps) => void;
         actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
         hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
         closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => void;