@atlaskit/smart-card 26.24.0 → 26.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/dist/cjs/extractors/block/index.js +1 -1
- package/dist/cjs/extractors/common/actions/extractActions.js +3 -31
- package/dist/cjs/state/analytics/useSmartLinkAnalytics.js +10 -15
- package/dist/cjs/state/hooks/use-invoke/utils.js +23 -0
- package/dist/cjs/state/hooks/use-invoke-client-action/index.js +20 -14
- package/dist/cjs/utils/analytics/analytics.js +28 -7
- package/dist/cjs/utils/mocks.js +7 -2
- package/dist/cjs/view/BlockCard/views/flexible/FlexibleErroredView.js +1 -0
- package/dist/cjs/view/BlockCard/views/flexible/FlexibleResolvedView.js +3 -45
- package/dist/cjs/view/FlexibleCard/components/actions/action/download-action/index.js +33 -1
- package/dist/cjs/view/FlexibleCard/components/actions/action/preview-action/index.js +41 -15
- package/dist/cjs/view/FlexibleCard/components/actions/action/server-action/index.js +32 -15
- package/dist/cjs/view/FlexibleCard/components/actions/action/view-action/index.js +33 -1
- package/dist/cjs/view/FlexibleCard/components/elements/lozenge/lozenge-action/index.js +2 -4
- package/dist/cjs/view/FlexibleCard/components/utils.js +9 -20
- package/dist/cjs/view/FlexibleCard/index.js +14 -1
- package/dist/cjs/view/HoverCard/components/HoverCardContent.js +1 -0
- package/dist/cjs/view/LinkUrl/index.js +1 -1
- package/dist/es2019/extractors/block/index.js +2 -2
- package/dist/es2019/extractors/common/actions/extractActions.js +2 -23
- package/dist/es2019/state/analytics/useSmartLinkAnalytics.js +10 -17
- package/dist/es2019/state/hooks/use-invoke/utils.js +13 -0
- package/dist/es2019/state/hooks/use-invoke-client-action/index.js +14 -8
- package/dist/es2019/utils/analytics/analytics.js +65 -32
- package/dist/es2019/utils/mocks.js +7 -2
- package/dist/es2019/view/BlockCard/views/flexible/FlexibleErroredView.js +1 -0
- package/dist/es2019/view/BlockCard/views/flexible/FlexibleResolvedView.js +4 -42
- package/dist/es2019/view/FlexibleCard/components/actions/action/download-action/index.js +15 -1
- package/dist/es2019/view/FlexibleCard/components/actions/action/preview-action/index.js +18 -7
- package/dist/es2019/view/FlexibleCard/components/actions/action/server-action/index.js +19 -1
- package/dist/es2019/view/FlexibleCard/components/actions/action/view-action/index.js +15 -1
- package/dist/es2019/view/FlexibleCard/components/elements/lozenge/lozenge-action/index.js +1 -1
- package/dist/es2019/view/FlexibleCard/components/utils.js +3 -17
- package/dist/es2019/view/FlexibleCard/index.js +11 -1
- package/dist/es2019/view/HoverCard/components/HoverCardContent.js +1 -0
- package/dist/es2019/view/LinkUrl/index.js +1 -1
- package/dist/esm/extractors/block/index.js +2 -2
- package/dist/esm/extractors/common/actions/extractActions.js +2 -30
- package/dist/esm/state/analytics/useSmartLinkAnalytics.js +11 -16
- package/dist/esm/state/hooks/use-invoke/utils.js +15 -0
- package/dist/esm/state/hooks/use-invoke-client-action/index.js +20 -14
- package/dist/esm/utils/analytics/analytics.js +23 -5
- package/dist/esm/utils/mocks.js +7 -2
- package/dist/esm/view/BlockCard/views/flexible/FlexibleErroredView.js +1 -0
- package/dist/esm/view/BlockCard/views/flexible/FlexibleResolvedView.js +4 -46
- package/dist/esm/view/FlexibleCard/components/actions/action/download-action/index.js +33 -1
- package/dist/esm/view/FlexibleCard/components/actions/action/preview-action/index.js +41 -15
- package/dist/esm/view/FlexibleCard/components/actions/action/server-action/index.js +32 -15
- package/dist/esm/view/FlexibleCard/components/actions/action/view-action/index.js +33 -1
- package/dist/esm/view/FlexibleCard/components/elements/lozenge/lozenge-action/index.js +1 -3
- package/dist/esm/view/FlexibleCard/components/utils.js +9 -20
- package/dist/esm/view/FlexibleCard/index.js +14 -1
- package/dist/esm/view/HoverCard/components/HoverCardContent.js +1 -0
- package/dist/esm/view/LinkUrl/index.js +1 -1
- package/dist/types/extractors/common/__mocks__/jsonld.d.ts +0 -1
- package/dist/types/extractors/common/actions/extractActions.d.ts +1 -1
- package/dist/types/state/analytics/useSmartLinkAnalytics.d.ts +6 -5
- package/dist/types/state/flexible-ui-context/index.d.ts +3 -119
- package/dist/types/state/flexible-ui-context/types.d.ts +6 -0
- package/dist/types/state/hooks/use-invoke/utils.d.ts +4 -0
- package/dist/types/state/hooks/useSmartLink.d.ts +4 -3
- package/dist/types/utils/analytics/analytics.d.ts +4 -1
- package/dist/types/utils/analytics/types.d.ts +7 -3
- package/dist/types/utils/mocks.d.ts +4 -3
- package/dist/types/view/Card/index.d.ts +1 -1
- package/dist/types/view/FlexibleCard/components/utils.d.ts +2 -63
- package/dist/types/view/FlexibleCard/types.d.ts +2 -3
- package/dist/types-ts4.5/extractors/common/__mocks__/jsonld.d.ts +0 -1
- package/dist/types-ts4.5/extractors/common/actions/extractActions.d.ts +1 -1
- package/dist/types-ts4.5/state/analytics/useSmartLinkAnalytics.d.ts +6 -5
- package/dist/types-ts4.5/state/flexible-ui-context/index.d.ts +3 -119
- package/dist/types-ts4.5/state/flexible-ui-context/types.d.ts +6 -0
- package/dist/types-ts4.5/state/hooks/use-invoke/utils.d.ts +4 -0
- package/dist/types-ts4.5/state/hooks/useSmartLink.d.ts +4 -3
- package/dist/types-ts4.5/utils/analytics/analytics.d.ts +4 -1
- package/dist/types-ts4.5/utils/analytics/types.d.ts +7 -3
- package/dist/types-ts4.5/utils/mocks.d.ts +4 -3
- package/dist/types-ts4.5/view/Card/index.d.ts +1 -1
- package/dist/types-ts4.5/view/FlexibleCard/components/utils.d.ts +2 -63
- package/dist/types-ts4.5/view/FlexibleCard/types.d.ts +2 -3
- package/package.json +2 -2
- package/report.api.md +14 -6
- package/tmp/api-report-tmp.d.ts +12 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AnalyticsHandler, AnalyticsName, AnalyticsPayload } from '../../utils/types';
|
|
2
|
-
import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps } from '../../utils/analytics/types';
|
|
2
|
+
import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UiServerActionClickedEventProps } from '../../utils/analytics/types';
|
|
3
3
|
import { TrackQuickActionFailureReason, TrackQuickActionType } from '../../utils/analytics/analytics';
|
|
4
4
|
import { SmartLinkActionType } from '@atlaskit/linking-types';
|
|
5
5
|
/**
|
|
@@ -90,10 +90,10 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
90
90
|
* @param extensionKey The extensionKey of the Smart Link resovler invoked.
|
|
91
91
|
* @param actionType The type of the action that was clicked, e.g. PreviewAction
|
|
92
92
|
* @param display Whether the card was an Inline, Block, Embed or Flexible UI.
|
|
93
|
-
* @param invokeType
|
|
93
|
+
* @param invokeType @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
|
|
94
94
|
* @returns
|
|
95
95
|
*/
|
|
96
|
-
actionClickedEvent: ({ id
|
|
96
|
+
actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
|
|
97
97
|
/**
|
|
98
98
|
* This fires an event that represents when a user clicks on a hover preview's "navigate to link" button.
|
|
99
99
|
* https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3206743323/Analytics+Metrics+-+Hover+Previews
|
|
@@ -172,6 +172,7 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
172
172
|
* Fires an event that represent a click was performed on a Status Lozenge open preview button
|
|
173
173
|
*/
|
|
174
174
|
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
175
|
+
smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
|
|
175
176
|
};
|
|
176
177
|
operational: {
|
|
177
178
|
/**
|
|
@@ -181,7 +182,7 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
181
182
|
* @param actionType The type of action invoked, e.g. PreviewAction
|
|
182
183
|
* @param display Whether the card was an Inline, Block, Embed or Flexible UI.
|
|
183
184
|
*/
|
|
184
|
-
invokeSucceededEvent: ({ id
|
|
185
|
+
invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
|
|
185
186
|
/**
|
|
186
187
|
* This fires an event that represents an action being unsuccessfully invoked.
|
|
187
188
|
* @param id The unique ID for this Smart Link.
|
|
@@ -190,7 +191,7 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
190
191
|
* @param display Whether the card was an Inline, Block, Embed or Flexible UI.
|
|
191
192
|
* @param reason The reason the invocation failed.
|
|
192
193
|
*/
|
|
193
|
-
invokeFailedEvent: ({ id
|
|
194
|
+
invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
|
|
194
195
|
/**
|
|
195
196
|
* This fires an event that represents an account successfully being connected via a Smart Link.
|
|
196
197
|
* @param id The unique ID for this Smart Link.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import { FlexibleUiDataContext } from './types';
|
|
2
|
+
import type { FlexibleAnalyticsContextType, FlexibleUiDataContext } from './types';
|
|
3
3
|
import { FlexibleUiOptions } from '../../view/FlexibleCard/types';
|
|
4
4
|
/**
|
|
5
5
|
* This provides the data that will be used by Smart Links Flexible UI to populate it's
|
|
@@ -11,124 +11,8 @@ export declare const useFlexibleUiContext: () => FlexibleUiDataContext | undefin
|
|
|
11
11
|
* This provides the data that will be used by Smart Links Flexible UI to populate it's
|
|
12
12
|
* underlying elements.
|
|
13
13
|
*/
|
|
14
|
-
export declare const FlexibleUiAnalyticsContext: import("react").Context<
|
|
15
|
-
|
|
16
|
-
authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthEventProps) => void;
|
|
17
|
-
authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthAlternateAccountEventProps) => void;
|
|
18
|
-
buttonClickedEvent: (data: Partial<import("../..").AnalyticsPayload> & {
|
|
19
|
-
actionSubjectId: string;
|
|
20
|
-
}) => void;
|
|
21
|
-
cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("../../utils/analytics/types").UiCardClickedEventProps) => void;
|
|
22
|
-
iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: import("../../utils/analytics/types").UiIframeDwelledEventProps) => void;
|
|
23
|
-
iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: import("../../utils/analytics/types").UiIframeFocusedEventProps) => void;
|
|
24
|
-
actionClickedEvent: ({ id: experienceId, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiActionClickedEventProps) => void;
|
|
25
|
-
hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("../../utils/analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
|
|
26
|
-
closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiClosedAuthEventProps) => void;
|
|
27
|
-
modalClosedEvent: (data: Partial<import("../..").AnalyticsPayload> & {
|
|
28
|
-
actionSubjectId: string;
|
|
29
|
-
}) => void;
|
|
30
|
-
renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderSuccessEventProps) => void;
|
|
31
|
-
renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
|
|
32
|
-
hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
|
|
33
|
-
hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
|
|
34
|
-
learnMoreClickedEvent: () => void;
|
|
35
|
-
smartLinkLozengeActionClickedEvent: () => void;
|
|
36
|
-
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
37
|
-
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
38
|
-
};
|
|
39
|
-
operational: {
|
|
40
|
-
invokeSucceededEvent: ({ id: experienceId, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
|
|
41
|
-
invokeFailedEvent: ({ id: experienceId, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeFailedEventProps) => void;
|
|
42
|
-
connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectSucceededEventProps) => void;
|
|
43
|
-
connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectFailedEventProps) => void;
|
|
44
|
-
instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("../../utils/analytics/types").InstrumentEventProps) => void;
|
|
45
|
-
chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
|
|
46
|
-
};
|
|
47
|
-
track: {
|
|
48
|
-
appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
|
|
49
|
-
appAccountAuthStarted: ({ extensionKey, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
|
|
50
|
-
linkUpdated: (props: import("../../utils/analytics/types").CommonEventProps & {
|
|
51
|
-
[key: string]: any;
|
|
52
|
-
}) => void;
|
|
53
|
-
smartLinkQuickActionStarted: (props: {
|
|
54
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../utils/analytics/analytics").TrackQuickActionType;
|
|
55
|
-
}) => void;
|
|
56
|
-
smartLinkQuickActionSuccess: (props: {
|
|
57
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../utils/analytics/analytics").TrackQuickActionType;
|
|
58
|
-
}) => void;
|
|
59
|
-
smartLinkQuickActionFailed: (props: {
|
|
60
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../utils/analytics/analytics").TrackQuickActionType;
|
|
61
|
-
reason?: import("../../utils/analytics/analytics").TrackQuickActionFailureReason | undefined;
|
|
62
|
-
step?: string | undefined;
|
|
63
|
-
}) => void;
|
|
64
|
-
hoverCardResolutionStarted: () => void;
|
|
65
|
-
};
|
|
66
|
-
screen: {
|
|
67
|
-
authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
|
|
68
|
-
modalViewedEvent: (data: Partial<import("../..").AnalyticsPayload> & {
|
|
69
|
-
name: "embedPreviewModal";
|
|
70
|
-
}) => void;
|
|
71
|
-
};
|
|
72
|
-
} | undefined>;
|
|
73
|
-
export declare const useFlexibleUiAnalyticsContext: () => {
|
|
74
|
-
ui: {
|
|
75
|
-
authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthEventProps) => void;
|
|
76
|
-
authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiAuthAlternateAccountEventProps) => void;
|
|
77
|
-
buttonClickedEvent: (data: Partial<import("../..").AnalyticsPayload> & {
|
|
78
|
-
actionSubjectId: string;
|
|
79
|
-
}) => void;
|
|
80
|
-
cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("../../utils/analytics/types").UiCardClickedEventProps) => void;
|
|
81
|
-
iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: import("../../utils/analytics/types").UiIframeDwelledEventProps) => void;
|
|
82
|
-
iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: import("../../utils/analytics/types").UiIframeFocusedEventProps) => void;
|
|
83
|
-
actionClickedEvent: ({ id: experienceId, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiActionClickedEventProps) => void;
|
|
84
|
-
hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("../../utils/analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
|
|
85
|
-
closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiClosedAuthEventProps) => void;
|
|
86
|
-
modalClosedEvent: (data: Partial<import("../..").AnalyticsPayload> & {
|
|
87
|
-
actionSubjectId: string;
|
|
88
|
-
}) => void;
|
|
89
|
-
renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderSuccessEventProps) => void;
|
|
90
|
-
renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
|
|
91
|
-
hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
|
|
92
|
-
hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
|
|
93
|
-
learnMoreClickedEvent: () => void;
|
|
94
|
-
smartLinkLozengeActionClickedEvent: () => void;
|
|
95
|
-
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
96
|
-
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
97
|
-
};
|
|
98
|
-
operational: {
|
|
99
|
-
invokeSucceededEvent: ({ id: experienceId, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
|
|
100
|
-
invokeFailedEvent: ({ id: experienceId, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeFailedEventProps) => void;
|
|
101
|
-
connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectSucceededEventProps) => void;
|
|
102
|
-
connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectFailedEventProps) => void;
|
|
103
|
-
instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("../../utils/analytics/types").InstrumentEventProps) => void;
|
|
104
|
-
chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiRenderFailedEventProps) => void;
|
|
105
|
-
};
|
|
106
|
-
track: {
|
|
107
|
-
appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
|
|
108
|
-
appAccountAuthStarted: ({ extensionKey, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
|
|
109
|
-
linkUpdated: (props: import("../../utils/analytics/types").CommonEventProps & {
|
|
110
|
-
[key: string]: any;
|
|
111
|
-
}) => void;
|
|
112
|
-
smartLinkQuickActionStarted: (props: {
|
|
113
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../utils/analytics/analytics").TrackQuickActionType;
|
|
114
|
-
}) => void;
|
|
115
|
-
smartLinkQuickActionSuccess: (props: {
|
|
116
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../utils/analytics/analytics").TrackQuickActionType;
|
|
117
|
-
}) => void;
|
|
118
|
-
smartLinkQuickActionFailed: (props: {
|
|
119
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../utils/analytics/analytics").TrackQuickActionType;
|
|
120
|
-
reason?: import("../../utils/analytics/analytics").TrackQuickActionFailureReason | undefined;
|
|
121
|
-
step?: string | undefined;
|
|
122
|
-
}) => void;
|
|
123
|
-
hoverCardResolutionStarted: () => void;
|
|
124
|
-
};
|
|
125
|
-
screen: {
|
|
126
|
-
authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").CommonEventProps) => void;
|
|
127
|
-
modalViewedEvent: (data: Partial<import("../..").AnalyticsPayload> & {
|
|
128
|
-
name: "embedPreviewModal";
|
|
129
|
-
}) => void;
|
|
130
|
-
};
|
|
131
|
-
} | undefined;
|
|
14
|
+
export declare const FlexibleUiAnalyticsContext: import("react").Context<FlexibleAnalyticsContextType | undefined>;
|
|
15
|
+
export declare const useFlexibleUiAnalyticsContext: () => FlexibleAnalyticsContextType | undefined;
|
|
132
16
|
/**
|
|
133
17
|
* This provides the ui options that will be used by Smart Links Flexible UI
|
|
134
18
|
* to render its underlying elements.
|
|
@@ -2,6 +2,8 @@ import { LinkLozenge } from '../../extractors/common/lozenge/types';
|
|
|
2
2
|
import { LinkPerson } from '@atlaskit/link-extractors';
|
|
3
3
|
import { IconType, MediaType } from '../../constants';
|
|
4
4
|
import { InvokeRequestWithCardDetails } from '../hooks/use-invoke/types';
|
|
5
|
+
import type { CardInnerAppearance } from '../../view/Card/types';
|
|
6
|
+
import type { AnalyticsFacade } from '../analytics';
|
|
5
7
|
/**
|
|
6
8
|
* This provides the data that will be used by Smart Links Flexible UI to populate it's
|
|
7
9
|
* underlying elements.
|
|
@@ -261,6 +263,10 @@ export type ViewActionData = {
|
|
|
261
263
|
export type DownloadActionData = {
|
|
262
264
|
downloadUrl?: string;
|
|
263
265
|
};
|
|
266
|
+
export type FlexibleAnalyticsContextType = AnalyticsFacade & {
|
|
267
|
+
display?: CardInnerAppearance;
|
|
268
|
+
extensionKey?: string;
|
|
269
|
+
};
|
|
264
270
|
export type ServerActionProp<TValue> = {
|
|
265
271
|
action: InvokeRequestWithCardDetails;
|
|
266
272
|
value?: TValue;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { InvokeError } from '@atlaskit/linking-types';
|
|
2
|
+
import { TrackQuickActionFailureReason } from '../../../utils/analytics/analytics';
|
|
3
|
+
export declare const getInvokeFailureReason: (err: InvokeError | Error) => TrackQuickActionFailureReason.PermissionError | TrackQuickActionFailureReason.UnknownError;
|
|
4
|
+
export declare const isInvokeCustomError: (err: InvokeError | Error) => err is InvokeError;
|
|
@@ -24,7 +24,7 @@ dispatchAnalytics?: AnalyticsHandler): {
|
|
|
24
24
|
cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("../../utils/analytics/types").UiCardClickedEventProps) => void;
|
|
25
25
|
iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: import("../../utils/analytics/types").UiIframeDwelledEventProps) => void;
|
|
26
26
|
iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: import("../../utils/analytics/types").UiIframeFocusedEventProps) => void;
|
|
27
|
-
actionClickedEvent: ({ id
|
|
27
|
+
actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiActionClickedEventProps) => void;
|
|
28
28
|
hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("../../utils/analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
|
|
29
29
|
closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").UiClosedAuthEventProps) => void;
|
|
30
30
|
modalClosedEvent: (data: Partial<import("../../utils/types").AnalyticsPayload> & {
|
|
@@ -38,10 +38,11 @@ dispatchAnalytics?: AnalyticsHandler): {
|
|
|
38
38
|
smartLinkLozengeActionClickedEvent: () => void;
|
|
39
39
|
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
40
40
|
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
41
|
+
smartLinkServerActionClickedEvent: (props: import("../../utils/analytics/types").UiServerActionClickedEventProps) => void;
|
|
41
42
|
};
|
|
42
43
|
operational: {
|
|
43
|
-
invokeSucceededEvent: ({ id
|
|
44
|
-
invokeFailedEvent: ({ id
|
|
44
|
+
invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeSucceededEventProps) => void;
|
|
45
|
+
invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").InvokeFailedEventProps) => void;
|
|
45
46
|
connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectSucceededEventProps) => void;
|
|
46
47
|
connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../utils/analytics/types").ConnectFailedEventProps) => void;
|
|
47
48
|
instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("../../utils/analytics/types").InstrumentEventProps) => void;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
2
2
|
import { AnalyticsPayload } from '../types';
|
|
3
3
|
import { CardInnerAppearance } from '../../view/Card/types';
|
|
4
|
-
import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UnresolvedEventProps } from './types';
|
|
4
|
+
import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ResolvedEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UiServerActionClickedEventProps, UnresolvedEventProps } from './types';
|
|
5
5
|
import { SmartLinkActionType } from '@atlaskit/linking-types';
|
|
6
6
|
export declare const ANALYTICS_CHANNEL = "media";
|
|
7
7
|
export declare const context: {
|
|
@@ -17,6 +17,8 @@ export declare enum TrackQuickActionFailureReason {
|
|
|
17
17
|
ValidationError = "ValidationError",
|
|
18
18
|
UnknownError = "UnknownError"
|
|
19
19
|
}
|
|
20
|
+
export declare const SmartLinkActionTypeTrackingEventMapper: Record<string, string>;
|
|
21
|
+
export declare const SmartLinkActionTypeUiEventMapper: Record<string, string>;
|
|
20
22
|
export declare class SmartLinkEvents {
|
|
21
23
|
insertSmartLink(url: string, type: CardInnerAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
|
|
22
24
|
}
|
|
@@ -57,3 +59,4 @@ export declare const chunkloadFailedEvent: ({ display, error, errorInfo, extensi
|
|
|
57
59
|
export declare const uiSmartLinkStatusLozengeButtonClicked: () => AnalyticsPayload;
|
|
58
60
|
export declare const uiSmartLinkStatusListItemButtonClicked: () => AnalyticsPayload;
|
|
59
61
|
export declare const uiSmartLinkStatusOpenPreviewButtonClicked: () => AnalyticsPayload;
|
|
62
|
+
export declare const uiServerActionClicked: ({ smartLinkActionType, }: UiServerActionClickedEventProps) => AnalyticsPayload;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { APIError, CardType } from '@atlaskit/linking-common';
|
|
2
|
+
import { SmartLinkActionType } from '@atlaskit/linking-types';
|
|
2
3
|
import { PreviewDisplay, PreviewInvokeMethod } from '../../view/HoverCard/types';
|
|
3
4
|
import { ErrorInfo } from 'react';
|
|
4
5
|
import { CardInnerAppearance } from '../../view/Card/types';
|
|
@@ -25,12 +26,12 @@ export type UnresolvedEventProps = CommonEventProps & {
|
|
|
25
26
|
error?: APIError;
|
|
26
27
|
};
|
|
27
28
|
export type InvokeSucceededEventProps = CommonEventProps & {
|
|
28
|
-
id
|
|
29
|
+
id?: string;
|
|
29
30
|
actionType: string;
|
|
30
31
|
display?: CardInnerAppearance;
|
|
31
32
|
};
|
|
32
33
|
export type InvokeFailedEventProps = CommonEventProps & {
|
|
33
|
-
id
|
|
34
|
+
id?: string;
|
|
34
35
|
actionType: string;
|
|
35
36
|
display?: CardInnerAppearance;
|
|
36
37
|
reason: string;
|
|
@@ -69,11 +70,14 @@ export type UiIframeFocusedEventProps = CommonEventProps & {
|
|
|
69
70
|
status: CardType;
|
|
70
71
|
};
|
|
71
72
|
export type UiActionClickedEventProps = CommonEventProps & {
|
|
72
|
-
id
|
|
73
|
+
id?: string;
|
|
73
74
|
display?: CardInnerAppearance;
|
|
74
75
|
actionType: string;
|
|
75
76
|
invokeType?: InvokeType;
|
|
76
77
|
};
|
|
78
|
+
export type UiServerActionClickedEventProps = CommonEventProps & {
|
|
79
|
+
smartLinkActionType: SmartLinkActionType;
|
|
80
|
+
};
|
|
77
81
|
export type ScreenAuthPopupEventProps = CommonEventProps;
|
|
78
82
|
export type UiClosedAuthEventProps = CommonEventProps & {
|
|
79
83
|
display: CardInnerAppearance;
|
|
@@ -49,7 +49,7 @@ export declare const mockAnalytics: {
|
|
|
49
49
|
cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("./analytics/types").UiCardClickedEventProps) => void;
|
|
50
50
|
iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: import("./analytics/types").UiIframeDwelledEventProps) => void;
|
|
51
51
|
iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: import("./analytics/types").UiIframeFocusedEventProps) => void;
|
|
52
|
-
actionClickedEvent: ({ id
|
|
52
|
+
actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiActionClickedEventProps) => void;
|
|
53
53
|
hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("./analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
|
|
54
54
|
closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").UiClosedAuthEventProps) => void;
|
|
55
55
|
modalClosedEvent: (data: Partial<import("./types").AnalyticsPayload> & {
|
|
@@ -63,10 +63,11 @@ export declare const mockAnalytics: {
|
|
|
63
63
|
smartLinkLozengeActionClickedEvent: () => void;
|
|
64
64
|
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
65
65
|
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
66
|
+
smartLinkServerActionClickedEvent: (props: import("./analytics/types").UiServerActionClickedEventProps) => void;
|
|
66
67
|
};
|
|
67
68
|
operational: {
|
|
68
|
-
invokeSucceededEvent: ({ id
|
|
69
|
-
invokeFailedEvent: ({ id
|
|
69
|
+
invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").InvokeSucceededEventProps) => void;
|
|
70
|
+
invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").InvokeFailedEventProps) => void;
|
|
70
71
|
connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").ConnectSucceededEventProps) => void;
|
|
71
72
|
connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("./analytics/types").ConnectFailedEventProps) => void;
|
|
72
73
|
instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("./analytics/types").InstrumentEventProps) => void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { CardAppearance, CardPlatform, CardProps } from './types';
|
|
3
3
|
import { WrappedComponentProps } from 'react-intl-next';
|
|
4
|
-
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, "url" | "children" | "data" | "key" | "id" | "placeholder" | "onError" | "onClick" | "appearance" | "testId" | "analyticsContext" | "isSelected" | "inheritDimensions" | "
|
|
4
|
+
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, "url" | "children" | "data" | "key" | "id" | "placeholder" | "onError" | "onClick" | "appearance" | "testId" | "analyticsContext" | "isSelected" | "inheritDimensions" | "showServerActions" | "onResolve" | "ui" | "showHoverPreview" | "showAuthTooltip" | "platform" | "isFrameVisible" | "frameStyle" | "importer" | "container" | "showActions" | "fallbackComponent" | "embedIframeRef" | "embedIframeUrlType" | "inlinePreloaderStyle" | "analyticsEvents" | "forwardedRef"> & React.RefAttributes<any>>;
|
|
5
5
|
export type { CardAppearance, CardProps, CardPlatform };
|
|
@@ -3,9 +3,9 @@ import { SerializedStyles } from '@emotion/react';
|
|
|
3
3
|
import { Spacing } from '@atlaskit/button';
|
|
4
4
|
import { SmartLinkSize } from '../../../constants';
|
|
5
5
|
import { MessageProps } from './types';
|
|
6
|
-
import { AnalyticsFacade } from '../../../state/analytics';
|
|
7
6
|
import { PreviewActionData } from '../../../state/flexible-ui-context/types';
|
|
8
7
|
import { IntlShape, MessageDescriptor } from 'react-intl-next';
|
|
8
|
+
import { EmbedModalProps } from '../../EmbedModal/types';
|
|
9
9
|
export declare const sizeToButtonSpacing: Record<SmartLinkSize, Spacing>;
|
|
10
10
|
export declare const getFormattedMessage: (message?: MessageProps) => JSX.Element | undefined;
|
|
11
11
|
export declare const getFormattedMessageAsString: (intl: IntlShape, message: MessageDescriptor, context?: string) => string;
|
|
@@ -17,65 +17,4 @@ export declare const getMaxLineHeight: (size: SmartLinkSize) => 1.5 | 1.75;
|
|
|
17
17
|
export declare const getMaxLines: (value: number, defaultValue: number, max: number, min: number) => number;
|
|
18
18
|
export declare const getTruncateStyles: (maxLines: number, lineHeight?: string, wordBreak?: 'break-word' | 'break-all') => SerializedStyles;
|
|
19
19
|
export declare const hasWhiteSpace: (str: string) => boolean;
|
|
20
|
-
export declare const openEmbedModalWithFlexibleUiIcon: ({
|
|
21
|
-
analytics?: {
|
|
22
|
-
ui: {
|
|
23
|
-
authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiAuthEventProps) => void;
|
|
24
|
-
authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiAuthAlternateAccountEventProps) => void;
|
|
25
|
-
buttonClickedEvent: (data: Partial<import("../../..").AnalyticsPayload> & {
|
|
26
|
-
actionSubjectId: string;
|
|
27
|
-
}) => void;
|
|
28
|
-
cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: import("../../../utils/analytics/types").UiCardClickedEventProps) => void;
|
|
29
|
-
iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: import("../../../utils/analytics/types").UiIframeDwelledEventProps) => void;
|
|
30
|
-
iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: import("../../../utils/analytics/types").UiIframeFocusedEventProps) => void;
|
|
31
|
-
actionClickedEvent: ({ id: experienceId, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiActionClickedEventProps) => void;
|
|
32
|
-
hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: import("../../../utils/analytics/types").UiHoverCardOpenLinkClickedEventProps) => void;
|
|
33
|
-
closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiClosedAuthEventProps) => void;
|
|
34
|
-
modalClosedEvent: (data: Partial<import("../../..").AnalyticsPayload> & {
|
|
35
|
-
actionSubjectId: string;
|
|
36
|
-
}) => void;
|
|
37
|
-
renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiRenderSuccessEventProps) => void;
|
|
38
|
-
renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiRenderFailedEventProps) => void;
|
|
39
|
-
hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../../utils/analytics/types").UiHoverCardViewedEventProps) => void;
|
|
40
|
-
hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: import("../../../utils/analytics/types").UiHoverCardDismissedEventProps) => void;
|
|
41
|
-
learnMoreClickedEvent: () => void;
|
|
42
|
-
smartLinkLozengeActionClickedEvent: () => void;
|
|
43
|
-
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
44
|
-
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
45
|
-
};
|
|
46
|
-
operational: {
|
|
47
|
-
invokeSucceededEvent: ({ id: experienceId, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").InvokeSucceededEventProps) => void;
|
|
48
|
-
invokeFailedEvent: ({ id: experienceId, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").InvokeFailedEventProps) => void;
|
|
49
|
-
connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").ConnectSucceededEventProps) => void;
|
|
50
|
-
connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").ConnectFailedEventProps) => void;
|
|
51
|
-
instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: import("../../../utils/analytics/types").InstrumentEventProps) => void;
|
|
52
|
-
chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").UiRenderFailedEventProps) => void;
|
|
53
|
-
};
|
|
54
|
-
track: {
|
|
55
|
-
appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").CommonEventProps) => void;
|
|
56
|
-
appAccountAuthStarted: ({ extensionKey, location, }: import("../../../utils/analytics/types").CommonEventProps) => void;
|
|
57
|
-
linkUpdated: (props: import("../../../utils/analytics/types").CommonEventProps & {
|
|
58
|
-
[key: string]: any;
|
|
59
|
-
}) => void;
|
|
60
|
-
smartLinkQuickActionStarted: (props: {
|
|
61
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../../utils/analytics/analytics").TrackQuickActionType;
|
|
62
|
-
}) => void;
|
|
63
|
-
smartLinkQuickActionSuccess: (props: {
|
|
64
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../../utils/analytics/analytics").TrackQuickActionType;
|
|
65
|
-
}) => void;
|
|
66
|
-
smartLinkQuickActionFailed: (props: {
|
|
67
|
-
smartLinkActionType: import("@atlaskit/linking-types").SmartLinkActionType | import("../../../utils/analytics/analytics").TrackQuickActionType;
|
|
68
|
-
reason?: import("../../../utils/analytics/analytics").TrackQuickActionFailureReason | undefined;
|
|
69
|
-
step?: string | undefined;
|
|
70
|
-
}) => void;
|
|
71
|
-
hoverCardResolutionStarted: () => void;
|
|
72
|
-
};
|
|
73
|
-
screen: {
|
|
74
|
-
authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: import("../../../utils/analytics/types").CommonEventProps) => void;
|
|
75
|
-
modalViewedEvent: (data: Partial<import("../../..").AnalyticsPayload> & {
|
|
76
|
-
name: "embedPreviewModal";
|
|
77
|
-
}) => void;
|
|
78
|
-
};
|
|
79
|
-
} | undefined;
|
|
80
|
-
onClose?: (() => void) | undefined;
|
|
81
|
-
}) => Promise<void>;
|
|
20
|
+
export declare const openEmbedModalWithFlexibleUiIcon: ({ linkIcon, ...props }: Partial<EmbedModalProps> & Pick<PreviewActionData, 'linkIcon'>) => Promise<void>;
|
|
@@ -4,8 +4,7 @@ import type { JsonLd } from 'json-ld-types';
|
|
|
4
4
|
import { CardState, LinkingPlatformFeatureFlags } from '@atlaskit/linking-common';
|
|
5
5
|
import { CardProviderRenderers } from '@atlaskit/link-provider';
|
|
6
6
|
import { SmartLinkSize, SmartLinkStatus, SmartLinkTheme } from '../../constants';
|
|
7
|
-
import {
|
|
8
|
-
import { OnResolveCallback } from '../Card/types';
|
|
7
|
+
import { CardInnerAppearance, OnResolveCallback } from '../Card/types';
|
|
9
8
|
import { OnErrorCallback } from '../types';
|
|
10
9
|
import { AnalyticsFacade } from '../../state/analytics';
|
|
11
10
|
export type FlexibleCardProps = {
|
|
@@ -22,7 +21,7 @@ export type FlexibleCardProps = {
|
|
|
22
21
|
* Determines the appearance of the Smart Link.
|
|
23
22
|
* @internal
|
|
24
23
|
*/
|
|
25
|
-
appearance?:
|
|
24
|
+
appearance?: CardInnerAppearance;
|
|
26
25
|
/**
|
|
27
26
|
* Determines the status and data of the Smart Link.
|
|
28
27
|
* @internal
|
|
@@ -27,7 +27,6 @@ export declare const TEST_CURRENT_DOCUMENT: JsonLd.Data.Document;
|
|
|
27
27
|
export declare const TEST_DOWNLOAD_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
|
|
28
28
|
export declare const TEST_UNDEFINED_LINK: JsonLd.Data.UndefinedLinkDocument;
|
|
29
29
|
export declare const TEST_ASSIGN_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
|
|
30
|
-
export declare const TEST_NO_ID_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
|
|
31
30
|
export declare const TEST_VIEW_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
|
|
32
31
|
export declare const TEST_FOLLOW_ACTION: JsonLd.Primitives.UpdateAction;
|
|
33
32
|
export declare const TEST_UNFOLLOW_ACTION: JsonLd.Primitives.UpdateAction;
|
|
@@ -2,4 +2,4 @@ import { JsonLd } from 'json-ld-types';
|
|
|
2
2
|
import { InvokeHandler } from '../../../model/invoke-handler';
|
|
3
3
|
import { ActionProps } from '../../../view/BlockCard/components/Action';
|
|
4
4
|
export declare const getActionsFromJsonLd: (jsonLd: JsonLd.Data.BaseData) => JsonLd.Primitives.Action[];
|
|
5
|
-
export declare function
|
|
5
|
+
export declare function extractClientActions(jsonLd: JsonLd.Data.BaseData, handler: InvokeHandler): ActionProps[];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AnalyticsHandler, AnalyticsName, AnalyticsPayload } from '../../utils/types';
|
|
2
|
-
import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps } from '../../utils/analytics/types';
|
|
2
|
+
import { CommonEventProps, ConnectFailedEventProps, ConnectSucceededEventProps, InstrumentEventProps, InvokeFailedEventProps, InvokeSucceededEventProps, ScreenAuthPopupEventProps, TrackAppAccountConnectedProps, UiActionClickedEventProps, UiAuthAlternateAccountEventProps, UiAuthEventProps, UiCardClickedEventProps, UiClosedAuthEventProps, UiHoverCardDismissedEventProps, UiHoverCardOpenLinkClickedEventProps, UiHoverCardViewedEventProps, UiIframeDwelledEventProps, UiIframeFocusedEventProps, UiRenderFailedEventProps, UiRenderSuccessEventProps, UiServerActionClickedEventProps } from '../../utils/analytics/types';
|
|
3
3
|
import { TrackQuickActionFailureReason, TrackQuickActionType } from '../../utils/analytics/analytics';
|
|
4
4
|
import { SmartLinkActionType } from '@atlaskit/linking-types';
|
|
5
5
|
/**
|
|
@@ -90,10 +90,10 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
90
90
|
* @param extensionKey The extensionKey of the Smart Link resovler invoked.
|
|
91
91
|
* @param actionType The type of the action that was clicked, e.g. PreviewAction
|
|
92
92
|
* @param display Whether the card was an Inline, Block, Embed or Flexible UI.
|
|
93
|
-
* @param invokeType
|
|
93
|
+
* @param invokeType @deprecated {@link https://hello.atlassian.net/browse/ENGHEALTH-2681 Internal documentation for deprecation (no external access)}
|
|
94
94
|
* @returns
|
|
95
95
|
*/
|
|
96
|
-
actionClickedEvent: ({ id
|
|
96
|
+
actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
|
|
97
97
|
/**
|
|
98
98
|
* This fires an event that represents when a user clicks on a hover preview's "navigate to link" button.
|
|
99
99
|
* https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3206743323/Analytics+Metrics+-+Hover+Previews
|
|
@@ -172,6 +172,7 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
172
172
|
* Fires an event that represent a click was performed on a Status Lozenge open preview button
|
|
173
173
|
*/
|
|
174
174
|
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
175
|
+
smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
|
|
175
176
|
};
|
|
176
177
|
operational: {
|
|
177
178
|
/**
|
|
@@ -181,7 +182,7 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
181
182
|
* @param actionType The type of action invoked, e.g. PreviewAction
|
|
182
183
|
* @param display Whether the card was an Inline, Block, Embed or Flexible UI.
|
|
183
184
|
*/
|
|
184
|
-
invokeSucceededEvent: ({ id
|
|
185
|
+
invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
|
|
185
186
|
/**
|
|
186
187
|
* This fires an event that represents an action being unsuccessfully invoked.
|
|
187
188
|
* @param id The unique ID for this Smart Link.
|
|
@@ -190,7 +191,7 @@ export declare const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: A
|
|
|
190
191
|
* @param display Whether the card was an Inline, Block, Embed or Flexible UI.
|
|
191
192
|
* @param reason The reason the invocation failed.
|
|
192
193
|
*/
|
|
193
|
-
invokeFailedEvent: ({ id
|
|
194
|
+
invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
|
|
194
195
|
/**
|
|
195
196
|
* This fires an event that represents an account successfully being connected via a Smart Link.
|
|
196
197
|
* @param id The unique ID for this Smart Link.
|