@atlaskit/smart-card 26.42.7 → 26.42.9

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.
Files changed (114) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/cjs/utils/analytics/analytics.js +1 -1
  3. package/dist/cjs/view/BlockCard/views/ResolvedView.js +1 -1
  4. package/dist/cjs/view/BlockCard/views/flexible/styled.js +3 -7
  5. package/dist/cjs/view/{InlineCard/ResolvingView → BlockCard/views}/styled.js +3 -3
  6. package/dist/cjs/view/CardWithData/component.js +1 -1
  7. package/dist/cjs/view/CardWithUrl/component.js +1 -3
  8. package/dist/cjs/view/EmbedCard/components/styled.js +12 -20
  9. package/dist/cjs/view/EmbedCard/index.js +1 -1
  10. package/dist/cjs/view/HoverCard/components/HoverCardComponent.js +3 -5
  11. package/dist/cjs/view/HoverCard/styled.js +2 -3
  12. package/dist/cjs/view/LinkUrl/index.js +1 -1
  13. package/dist/cjs/view/LinkView/index.js +1 -1
  14. package/dist/es2019/utils/analytics/analytics.js +1 -1
  15. package/dist/es2019/view/BlockCard/views/ResolvedView.js +1 -1
  16. package/dist/es2019/view/BlockCard/views/flexible/styled.js +6 -13
  17. package/dist/es2019/view/BlockCard/views/styled.js +7 -0
  18. package/dist/es2019/view/CardWithData/component.js +1 -1
  19. package/dist/es2019/view/CardWithUrl/component.js +1 -3
  20. package/dist/es2019/view/EmbedCard/components/styled.js +9 -30
  21. package/dist/es2019/view/EmbedCard/index.js +1 -1
  22. package/dist/es2019/view/HoverCard/components/HoverCardComponent.js +3 -5
  23. package/dist/es2019/view/HoverCard/styled.js +6 -9
  24. package/dist/es2019/view/LinkUrl/index.js +1 -1
  25. package/dist/es2019/view/LinkView/index.js +1 -1
  26. package/dist/esm/utils/analytics/analytics.js +1 -1
  27. package/dist/esm/view/BlockCard/views/ResolvedView.js +1 -1
  28. package/dist/esm/view/BlockCard/views/flexible/styled.js +3 -7
  29. package/dist/esm/view/BlockCard/views/styled.js +5 -0
  30. package/dist/esm/view/CardWithData/component.js +1 -1
  31. package/dist/esm/view/CardWithUrl/component.js +1 -3
  32. package/dist/esm/view/EmbedCard/components/styled.js +12 -20
  33. package/dist/esm/view/EmbedCard/index.js +1 -1
  34. package/dist/esm/view/HoverCard/components/HoverCardComponent.js +3 -5
  35. package/dist/esm/view/HoverCard/styled.js +2 -3
  36. package/dist/esm/view/LinkUrl/index.js +1 -1
  37. package/dist/esm/view/LinkView/index.js +1 -1
  38. package/dist/types/extractors/inline/index.d.ts +1 -1
  39. package/dist/types/view/BlockCard/views/styled.d.ts +5 -0
  40. package/dist/types/view/LinkView/index.d.ts +1 -1
  41. package/dist/types-ts4.5/extractors/inline/index.d.ts +1 -1
  42. package/dist/types-ts4.5/view/BlockCard/views/styled.d.ts +5 -0
  43. package/dist/types-ts4.5/view/LinkView/index.d.ts +1 -1
  44. package/package.json +6 -9
  45. package/dist/cjs/view/InlineCard/ErroredView/index.js +0 -89
  46. package/dist/cjs/view/InlineCard/ForbiddenView/index.js +0 -128
  47. package/dist/cjs/view/InlineCard/Frame/index.js +0 -61
  48. package/dist/cjs/view/InlineCard/Frame/styled.js +0 -66
  49. package/dist/cjs/view/InlineCard/Icon.js +0 -40
  50. package/dist/cjs/view/InlineCard/IconAndTitleLayout/index.js +0 -150
  51. package/dist/cjs/view/InlineCard/IconAndTitleLayout/styled.js +0 -47
  52. package/dist/cjs/view/InlineCard/ResolvedView/index.js +0 -82
  53. package/dist/cjs/view/InlineCard/ResolvingView/index.js +0 -68
  54. package/dist/cjs/view/InlineCard/UnauthorisedView/index.js +0 -110
  55. package/dist/cjs/view/InlineCard/index.js +0 -182
  56. package/dist/cjs/view/InlineCard/styled.js +0 -26
  57. package/dist/cjs/view/InlineCard/types.js +0 -5
  58. package/dist/es2019/view/InlineCard/ErroredView/index.js +0 -65
  59. package/dist/es2019/view/InlineCard/ForbiddenView/index.js +0 -107
  60. package/dist/es2019/view/InlineCard/Frame/index.js +0 -54
  61. package/dist/es2019/view/InlineCard/Frame/styled.js +0 -93
  62. package/dist/es2019/view/InlineCard/Icon.js +0 -45
  63. package/dist/es2019/view/InlineCard/IconAndTitleLayout/index.js +0 -124
  64. package/dist/es2019/view/InlineCard/IconAndTitleLayout/styled.js +0 -101
  65. package/dist/es2019/view/InlineCard/ResolvedView/index.js +0 -55
  66. package/dist/es2019/view/InlineCard/ResolvingView/index.js +0 -44
  67. package/dist/es2019/view/InlineCard/ResolvingView/styled.js +0 -6
  68. package/dist/es2019/view/InlineCard/UnauthorisedView/index.js +0 -84
  69. package/dist/es2019/view/InlineCard/index.js +0 -149
  70. package/dist/es2019/view/InlineCard/styled.js +0 -35
  71. package/dist/es2019/view/InlineCard/types.js +0 -1
  72. package/dist/esm/view/InlineCard/ErroredView/index.js +0 -82
  73. package/dist/esm/view/InlineCard/ForbiddenView/index.js +0 -121
  74. package/dist/esm/view/InlineCard/Frame/index.js +0 -52
  75. package/dist/esm/view/InlineCard/Frame/styled.js +0 -59
  76. package/dist/esm/view/InlineCard/Icon.js +0 -34
  77. package/dist/esm/view/InlineCard/IconAndTitleLayout/index.js +0 -143
  78. package/dist/esm/view/InlineCard/IconAndTitleLayout/styled.js +0 -40
  79. package/dist/esm/view/InlineCard/ResolvedView/index.js +0 -75
  80. package/dist/esm/view/InlineCard/ResolvingView/index.js +0 -61
  81. package/dist/esm/view/InlineCard/ResolvingView/styled.js +0 -5
  82. package/dist/esm/view/InlineCard/UnauthorisedView/index.js +0 -103
  83. package/dist/esm/view/InlineCard/index.js +0 -146
  84. package/dist/esm/view/InlineCard/styled.js +0 -19
  85. package/dist/esm/view/InlineCard/types.js +0 -1
  86. package/dist/types/view/InlineCard/ErroredView/index.d.ts +0 -21
  87. package/dist/types/view/InlineCard/ForbiddenView/index.d.ts +0 -28
  88. package/dist/types/view/InlineCard/Frame/index.d.ts +0 -15
  89. package/dist/types/view/InlineCard/Frame/styled.d.ts +0 -15
  90. package/dist/types/view/InlineCard/Icon.d.ts +0 -12
  91. package/dist/types/view/InlineCard/IconAndTitleLayout/index.d.ts +0 -28
  92. package/dist/types/view/InlineCard/IconAndTitleLayout/styled.d.ts +0 -40
  93. package/dist/types/view/InlineCard/ResolvedView/index.d.ts +0 -32
  94. package/dist/types/view/InlineCard/ResolvingView/index.d.ts +0 -17
  95. package/dist/types/view/InlineCard/ResolvingView/styled.d.ts +0 -9
  96. package/dist/types/view/InlineCard/UnauthorisedView/index.d.ts +0 -31
  97. package/dist/types/view/InlineCard/index.d.ts +0 -9
  98. package/dist/types/view/InlineCard/styled.d.ts +0 -17
  99. package/dist/types/view/InlineCard/types.d.ts +0 -25
  100. package/dist/types-ts4.5/view/InlineCard/ErroredView/index.d.ts +0 -21
  101. package/dist/types-ts4.5/view/InlineCard/ForbiddenView/index.d.ts +0 -28
  102. package/dist/types-ts4.5/view/InlineCard/Frame/index.d.ts +0 -15
  103. package/dist/types-ts4.5/view/InlineCard/Frame/styled.d.ts +0 -15
  104. package/dist/types-ts4.5/view/InlineCard/Icon.d.ts +0 -12
  105. package/dist/types-ts4.5/view/InlineCard/IconAndTitleLayout/index.d.ts +0 -28
  106. package/dist/types-ts4.5/view/InlineCard/IconAndTitleLayout/styled.d.ts +0 -40
  107. package/dist/types-ts4.5/view/InlineCard/ResolvedView/index.d.ts +0 -32
  108. package/dist/types-ts4.5/view/InlineCard/ResolvingView/index.d.ts +0 -17
  109. package/dist/types-ts4.5/view/InlineCard/ResolvingView/styled.d.ts +0 -9
  110. package/dist/types-ts4.5/view/InlineCard/UnauthorisedView/index.d.ts +0 -31
  111. package/dist/types-ts4.5/view/InlineCard/index.d.ts +0 -9
  112. package/dist/types-ts4.5/view/InlineCard/styled.d.ts +0 -17
  113. package/dist/types-ts4.5/view/InlineCard/types.d.ts +0 -25
  114. package/tmp/api-report-tmp.d.ts +0 -1007
@@ -1,1007 +0,0 @@
1
- ## API Report File for "@atlaskit/smart-card"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- /// <reference types="react" />
8
-
9
- import { APIError } from '@atlaskit/linking-common';
10
- import { Appearance } from '@atlaskit/button/types';
11
- import { BlockCardAdf } from '@atlaskit/linking-common';
12
- import { CardAdf } from '@atlaskit/linking-common';
13
- import { CardAppearance } from '@atlaskit/linking-common';
14
- import { CardContext } from '@atlaskit/link-provider';
15
- import { CardPlatform } from '@atlaskit/link-extractors';
16
- import { CardType } from '@atlaskit/linking-common';
17
- import { CardClient as Client } from '@atlaskit/link-provider';
18
- import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
19
- import { DatasourceAdf } from '@atlaskit/linking-common';
20
- import { DatasourceAdfView } from '@atlaskit/linking-common';
21
- import { EditorCardProvider } from '@atlaskit/link-provider';
22
- import { editorCardProvider } from '@atlaskit/link-provider';
23
- import { EmbedCardAdf } from '@atlaskit/linking-common';
24
- import { ErrorInfo } from 'react';
25
- import { GasPayload } from '@atlaskit/analytics-gas-types';
26
- import { InlineCardAdf } from '@atlaskit/linking-common';
27
- import { JsonLd } from 'json-ld-types';
28
- import { MessageDescriptor } from 'react-intl-next';
29
- import { SmartCardProvider as Provider } from '@atlaskit/link-provider';
30
- import { ProviderProps } from '@atlaskit/link-provider';
31
- import { default as React_2 } from 'react';
32
- import { ReactChild } from 'react';
33
- import { Ref } from 'react';
34
- import { SerializedStyles } from '@emotion/react';
35
- import { SmartCardContext } from '@atlaskit/link-provider';
36
- import { SmartLinkActionType } from '@atlaskit/linking-types';
37
- import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
38
- import { WithContextProps } from '@atlaskit/analytics-next';
39
- import { WithIntlProps } from 'react-intl-next';
40
- import { WrappedComponentProps } from 'react-intl-next';
41
-
42
- // @public (undocumented)
43
- export type ActionItem = CustomActionItem | NamedActionItem | NamedDataActionItem;
44
-
45
- // @public
46
- export enum ActionName {
47
- // (undocumented)
48
- CustomAction = "CustomAction",
49
- // (undocumented)
50
- DeleteAction = "DeleteAction",
51
- // (undocumented)
52
- DownloadAction = "DownloadAction",
53
- // (undocumented)
54
- EditAction = "EditAction",
55
- // (undocumented)
56
- FollowAction = "FollowAction",
57
- // (undocumented)
58
- PreviewAction = "PreviewAction",
59
- // (undocumented)
60
- ViewAction = "ViewAction"
61
- }
62
-
63
- // @public (undocumented)
64
- type ActionProps = {
65
- size?: SmartLinkSize;
66
- content?: React.ReactNode;
67
- appearance?: Appearance;
68
- onClick: () => any;
69
- icon?: ReactChild;
70
- iconPosition?: 'after' | 'before';
71
- tooltipMessage?: React.ReactNode;
72
- asDropDownItem?: boolean;
73
- overrideCss?: SerializedStyles;
74
- testId?: string;
75
- isDisabled?: boolean;
76
- };
77
-
78
- // @public (undocumented)
79
- export type AnalyticsAction = 'authStarted' | 'chunkLoadFailed' | 'clicked' | 'closed' | 'connectFailed' | 'connectSucceeded' | 'connected' | 'created' | 'dismissed' | 'dwelled' | 'failed' | 'focused' | 'inserted' | 'loaded' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'started' | 'success' | 'unresolved' | 'updated' | 'viewed';
80
-
81
- // @public (undocumented)
82
- export type AnalyticsActionSubject = 'applicationAccount' | 'button' | 'consentModal' | 'embedPreviewModal' | 'hoverCard' | 'link' | 'modal' | 'relatedLinks' | 'smartLink' | 'smartLinkAction' | 'smartLinkIframe' | 'smartLinkQuickAction';
83
-
84
- // @public (undocumented)
85
- type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
86
-
87
- // @public (undocumented)
88
- export type AnalyticsHandler = (event: AnalyticsPayload) => void;
89
-
90
- // @public (undocumented)
91
- type AnalyticsName = 'embedPreviewModal';
92
-
93
- // @public (undocumented)
94
- export type AnalyticsPayload = GasPayload & {
95
- action?: AnalyticsAction;
96
- actionSubject: AnalyticsActionSubject;
97
- attributes: GasPayload['attributes'] & {
98
- display?: CardInnerAppearance;
99
- };
100
- };
101
-
102
- // @public (undocumented)
103
- type AnchorTarget = '_blank' | '_parent' | '_self' | '_top';
104
-
105
- export { APIError }
106
-
107
- // @public
108
- type AssignedTo = {
109
- name: ElementName.AssignedTo;
110
- };
111
-
112
- // @public
113
- type AssignedToGroup = {
114
- name: ElementName.AssignedToGroup;
115
- showNamePrefix?: boolean;
116
- showFallbackAvatar?: boolean;
117
- };
118
-
119
- // @public
120
- type AttachmentCount = {
121
- name: ElementName.AttachmentCount;
122
- };
123
-
124
- // @public
125
- type AuthorGroup = {
126
- name: ElementName.AuthorGroup;
127
- showNamePrefix?: boolean;
128
- };
129
-
130
- // @public
131
- type BaseActionItem = {
132
- hideContent?: boolean;
133
- hideIcon?: boolean;
134
- name: ActionName;
135
- onClick: () => any;
136
- overrideCss?: SerializedStyles;
137
- size?: SmartLinkSize;
138
- testId?: string;
139
- isDisabled?: boolean;
140
- };
141
-
142
- // @public
143
- type BaseDataActionItem = {
144
- hideContent?: boolean;
145
- hideIcon?: boolean;
146
- name: ActionName;
147
- onClick?: () => any;
148
- overrideCss?: SerializedStyles;
149
- size?: SmartLinkSize;
150
- testId?: string;
151
- isDisabled?: boolean;
152
- };
153
-
154
- export { BlockCardAdf }
155
-
156
- // @public (undocumented)
157
- export const blockCardContentClassName = "block-card-content";
158
-
159
- // @public (undocumented)
160
- export const blockCardContentHeaderClassName = "block-card-content-header";
161
-
162
- // @public (undocumented)
163
- export const blockCardContentHeaderNameClassName = "block-card-content-header-name";
164
-
165
- // @public (undocumented)
166
- export const blockCardErroredViewClassName = "block-card-errored-view";
167
-
168
- // @public (undocumented)
169
- export const blockCardForbiddenViewClassName = "block-card-forbidden-view";
170
-
171
- // @public (undocumented)
172
- export const blockCardForbiddenViewLinkClassName = "block-card-forbidden-view-link";
173
-
174
- // @public (undocumented)
175
- export const blockCardIconImageClassName = "block-card-icon-image";
176
-
177
- // @public (undocumented)
178
- export const blockCardNotFoundViewClassName = "block-card-not-found-view";
179
-
180
- // @public (undocumented)
181
- export const blockCardResolvedViewByClassName = "block-card-resolved-view-by";
182
-
183
- // @public (undocumented)
184
- export const blockCardResolvedViewClassName = "block-card-resolved-view";
185
-
186
- // @public (undocumented)
187
- export const blockCardResolvingViewClassName = "block-card-resolving-view";
188
-
189
- // @public (undocumented)
190
- type BlockProps = {
191
- direction?: SmartLinkDirection;
192
- overrideCss?: SerializedStyles;
193
- size?: SmartLinkSize;
194
- status?: SmartLinkStatus;
195
- testId?: string;
196
- blockRef?: Ref<HTMLDivElement>;
197
- onRender?: () => void;
198
- onTransitionEnd?: () => void;
199
- };
200
-
201
- // @public (undocumented)
202
- export const Card: React_2.ForwardRefExoticComponent<Pick<Omit<React_2.PropsWithChildren<WithIntlProps<CardProps & WrappedComponentProps<"intl">>>, keyof WithAnalyticsEventsProps> & React_2.RefAttributes<any> & WithContextProps, "analyticsContext" | "analyticsEvents" | "appearance" | "children" | "container" | "data" | "embedIframeRef" | "embedIframeUrlType" | "fallbackComponent" | "forwardedRef" | "frameStyle" | "id" | "importer" | "inheritDimensions" | "inlinePreloaderStyle" | "isFrameVisible" | "isSelected" | "key" | "onClick" | "onError" | "onResolve" | "placeholder" | "platform" | "showActions" | "showAuthTooltip" | "showHoverPreview" | "showServerActions" | "testId" | "ui" | "url"> & React_2.RefAttributes<any>>;
203
-
204
- export { CardAdf }
205
-
206
- export { CardAppearance }
207
-
208
- export { CardContext }
209
-
210
- // @public (undocumented)
211
- type CardInnerAppearance = 'embedPreview' | 'flexible' | 'hoverCardPreview' | CardAppearance;
212
-
213
- export { CardPlatform }
214
-
215
- // @public (undocumented)
216
- export interface CardProps extends WithAnalyticsEventsProps {
217
- // @deprecated (undocumented)
218
- analyticsEvents?: AnalyticsFacade;
219
- // (undocumented)
220
- appearance: CardAppearance;
221
- // (undocumented)
222
- children?: React.ReactNode;
223
- // (undocumented)
224
- container?: HTMLElement;
225
- // @deprecated (undocumented)
226
- data?: any;
227
- // (undocumented)
228
- embedIframeRef?: React.Ref<HTMLIFrameElement>;
229
- // (undocumented)
230
- embedIframeUrlType?: EmbedIframeUrlType;
231
- fallbackComponent?: React.ComponentType;
232
- frameStyle?: FrameStyle;
233
- // (undocumented)
234
- id?: string;
235
- // (undocumented)
236
- importer?: (target: any) => void;
237
- inheritDimensions?: boolean;
238
- // (undocumented)
239
- inlinePreloaderStyle?: InlinePreloaderStyle;
240
- // @deprecated (undocumented)
241
- isFrameVisible?: boolean;
242
- // (undocumented)
243
- isSelected?: boolean;
244
- // (undocumented)
245
- onClick?: React.EventHandler<React.KeyboardEvent | React.MouseEvent>;
246
- onError?: OnErrorCallback;
247
- // (undocumented)
248
- onResolve?: OnResolveCallback;
249
- // (undocumented)
250
- placeholder?: string;
251
- // (undocumented)
252
- platform?: CardPlatform;
253
- showActions?: boolean;
254
- // (undocumented)
255
- showAuthTooltip?: boolean;
256
- // (undocumented)
257
- showHoverPreview?: boolean;
258
- showServerActions?: boolean;
259
- // (undocumented)
260
- testId?: string;
261
- // (undocumented)
262
- ui?: FlexibleUiOptions;
263
- // (undocumented)
264
- url?: string;
265
- }
266
-
267
- export { CardType }
268
-
269
- // @public
270
- type ChecklistProgress = {
271
- name: ElementName.ChecklistProgress;
272
- };
273
-
274
- export { Client }
275
-
276
- // @public
277
- type CollaboratorGroup = {
278
- name: ElementName.CollaboratorGroup;
279
- };
280
-
281
- // @public
282
- type CommentCount = {
283
- name: ElementName.CommentCount;
284
- };
285
-
286
- // @public (undocumented)
287
- interface CommonEventProps {
288
- // (undocumented)
289
- definitionId?: string;
290
- // (undocumented)
291
- destinatinoObjectType?: string;
292
- // (undocumented)
293
- destinationProduct?: DestinationProduct | string;
294
- // (undocumented)
295
- destinationSubproduct?: DestinationSubproduct | string;
296
- // (undocumented)
297
- extensionKey?: string;
298
- // (undocumented)
299
- id?: string;
300
- // (undocumented)
301
- location?: string;
302
- // (undocumented)
303
- resourceType?: string;
304
- // (undocumented)
305
- statusDetails?: string;
306
- }
307
-
308
- // @public (undocumented)
309
- type ConnectFailedEventProps = CommonEventProps & {
310
- id?: string;
311
- reason?: string;
312
- };
313
-
314
- // @public (undocumented)
315
- type ConnectSucceededEventProps = CommonEventProps & {
316
- id?: string;
317
- };
318
-
319
- // @public (undocumented)
320
- export const contentFooterClassName = "smart-link-content-footer";
321
-
322
- // @public
323
- type CreatedBy = {
324
- name: ElementName.CreatedBy;
325
- };
326
-
327
- // @public
328
- type CreatedOn = {
329
- name: ElementName.CreatedOn;
330
- text?: string;
331
- };
332
-
333
- // @public
334
- type CustomActionItem = BaseActionItem & {
335
- name: ActionName.CustomAction;
336
- } & (((Required<Pick<ActionProps, 'content'>> & Pick<ActionProps, 'icon' | 'iconPosition'>) & Pick<ActionProps, 'tooltipMessage'>) | (Required<Pick<ActionProps, 'icon' | 'iconPosition'>> & Pick<ActionProps, 'content'>));
337
-
338
- // @internal
339
- export const CustomBlock: React_2.FC<BlockProps>;
340
-
341
- export { DatasourceAdf }
342
-
343
- export { DatasourceAdfView }
344
-
345
- // @public (undocumented)
346
- type DestinationProduct = 'bitbucket' | 'confluence' | 'jira' | 'trello';
347
-
348
- // @public (undocumented)
349
- type DestinationSubproduct = 'core' | 'servicedesk' | 'software';
350
-
351
- // @public
352
- type DueOn = {
353
- name: ElementName.DueOn;
354
- };
355
-
356
- export { EditorCardProvider }
357
-
358
- export { editorCardProvider }
359
-
360
- // @public
361
- export type ElementItem = {
362
- overrideCss?: SerializedStyles;
363
- size?: SmartLinkSize;
364
- testId?: string;
365
- } & ElementItemProps;
366
-
367
- // @public
368
- type ElementItemProps = AssignedTo | AssignedToGroup | AttachmentCount | AuthorGroup | ChecklistProgress | CollaboratorGroup | CommentCount | CreatedBy | CreatedOn | DueOn | LatestCommit | LinkIcon | Location_2 | ModifiedBy | ModifiedOn | OwnedBy | OwnedByGroup | Preview | Priority | ProgrammingLanguage | Provider_2 | ReactCount | ReadTime | SentOn | Snippet | SourceBranch | State_2 | StoryPoints | SubTasksProgress | SubscriberCount | TargetBranch | Title | ViewCount | VoteCount;
369
-
370
- // @public
371
- export enum ElementName {
372
- // (undocumented)
373
- AssignedTo = "AssignedTo",
374
- // (undocumented)
375
- AssignedToGroup = "AssignedToGroup",
376
- // (undocumented)
377
- AttachmentCount = "AttachmentCount",
378
- // (undocumented)
379
- AuthorGroup = "AuthorGroup",
380
- // (undocumented)
381
- ChecklistProgress = "ChecklistProgress",
382
- // (undocumented)
383
- CollaboratorGroup = "CollaboratorGroup",
384
- // (undocumented)
385
- CommentCount = "CommentCount",
386
- // (undocumented)
387
- CreatedBy = "CreatedBy",
388
- // (undocumented)
389
- CreatedOn = "CreatedOn",
390
- // (undocumented)
391
- DueOn = "DueOn",
392
- // (undocumented)
393
- LatestCommit = "LatestCommit",
394
- // (undocumented)
395
- LinkIcon = "LinkIcon",
396
- // (undocumented)
397
- Location = "Location",
398
- // (undocumented)
399
- ModifiedBy = "ModifiedBy",
400
- // (undocumented)
401
- ModifiedOn = "ModifiedOn",
402
- // (undocumented)
403
- OwnedBy = "OwnedBy",
404
- // (undocumented)
405
- OwnedByGroup = "OwnedByGroup",
406
- // (undocumented)
407
- Preview = "Preview",
408
- // (undocumented)
409
- Priority = "Priority",
410
- // (undocumented)
411
- ProgrammingLanguage = "ProgrammingLanguage",
412
- // (undocumented)
413
- Provider = "Provider",
414
- // (undocumented)
415
- ReactCount = "ReactCount",
416
- // (undocumented)
417
- ReadTime = "ReadTime",
418
- // (undocumented)
419
- SentOn = "SentOn",
420
- // (undocumented)
421
- Snippet = "Snippet",
422
- // (undocumented)
423
- SourceBranch = "SourceBranch",
424
- // (undocumented)
425
- State = "State",
426
- // (undocumented)
427
- StoryPoints = "StoryPoints",
428
- // (undocumented)
429
- SubscriberCount = "SubscriberCount",
430
- // (undocumented)
431
- SubTasksProgress = "SubTasksProgress",
432
- // (undocumented)
433
- TargetBranch = "TargetBranch",
434
- // (undocumented)
435
- Title = "Title",
436
- // (undocumented)
437
- ViewCount = "ViewCount",
438
- // (undocumented)
439
- VoteCount = "VoteCount"
440
- }
441
-
442
- export { EmbedCardAdf }
443
-
444
- // @public (undocumented)
445
- export const embedHeaderHeight = 32;
446
-
447
- // @public (undocumented)
448
- type EmbedIframeUrlType = 'href' | 'interactiveHref';
449
-
450
- // @public (undocumented)
451
- export class EmbedResizeMessageListener extends React_2.Component<Props, State> {
452
- // (undocumented)
453
- componentDidMount(): void;
454
- // (undocumented)
455
- componentWillUnmount(): void;
456
- // (undocumented)
457
- render(): React_2.ReactNode;
458
- }
459
-
460
- // @public (undocumented)
461
- type ErrorCardType = 'errored' | 'fallback' | 'forbidden' | 'not_found' | 'unauthorized';
462
-
463
- // @public (undocumented)
464
- type FlexibleUiOptions = {
465
- clickableContainer?: boolean;
466
- hideElevation?: boolean;
467
- hideHoverCardPreviewButton?: boolean;
468
- hidePadding?: boolean;
469
- hideBackground?: boolean;
470
- size?: SmartLinkSize;
471
- theme?: SmartLinkTheme;
472
- zIndex?: number;
473
- };
474
-
475
- // @public
476
- export const FooterBlock: React_2.FC<FooterBlockProps>;
477
-
478
- // @public (undocumented)
479
- type FooterBlockProps = {
480
- actions?: ActionItem[];
481
- onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
482
- } & BlockProps;
483
-
484
- // @public (undocumented)
485
- type FrameStyle = 'hide' | 'show' | 'showOnHover';
486
-
487
- export { InlineCardAdf }
488
-
489
- // @public (undocumented)
490
- type InlinePreloaderStyle = 'on-left-with-skeleton' | 'on-right-without-skeleton';
491
-
492
- // @public (undocumented)
493
- type InstrumentEventProps = CommonEventProps & {
494
- error?: APIError;
495
- status: CardType;
496
- id: string;
497
- };
498
-
499
- // @public (undocumented)
500
- type InvokeFailedEventProps = CommonEventProps & {
501
- id?: string;
502
- actionType: string;
503
- display?: CardInnerAppearance;
504
- reason: string;
505
- };
506
-
507
- // @public (undocumented)
508
- type InvokeSucceededEventProps = CommonEventProps & {
509
- id?: string;
510
- actionType: string;
511
- display?: CardInnerAppearance;
512
- };
513
-
514
- // @public (undocumented)
515
- type InvokeType = 'client' | 'server';
516
-
517
- // @public
518
- type LatestCommit = {
519
- name: ElementName.LatestCommit;
520
- };
521
-
522
- // @public
523
- type LinkIcon = {
524
- name: ElementName.LinkIcon;
525
- };
526
-
527
- // @public (undocumented)
528
- export const loadingPlaceholderClassName = "smart-link-loading-placeholder";
529
-
530
- // @public
531
- type Location_2 = {
532
- name: ElementName.Location;
533
- };
534
-
535
- // @public (undocumented)
536
- export enum MediaPlacement {
537
- // (undocumented)
538
- Left = "left",
539
- // (undocumented)
540
- Right = "right"
541
- }
542
-
543
- // @public
544
- export const MetadataBlock: React_2.FC<MetadataBlockProps>;
545
-
546
- // @public (undocumented)
547
- type MetadataBlockProps = {
548
- maxLines?: number;
549
- primary?: ElementItem[];
550
- secondary?: ElementItem[];
551
- } & BlockProps;
552
-
553
- // @public (undocumented)
554
- export const metadataListClassName = "smart-link-metadata-list";
555
-
556
- // @public
557
- type ModifiedBy = {
558
- name: ElementName.ModifiedBy;
559
- };
560
-
561
- // @public
562
- type ModifiedOn = {
563
- name: ElementName.ModifiedOn;
564
- text?: string;
565
- };
566
-
567
- // @public
568
- type NamedActionItem = BaseActionItem & {
569
- name: ActionName.DeleteAction | ActionName.EditAction;
570
- };
571
-
572
- // @public
573
- type NamedDataActionItem = BaseDataActionItem & {
574
- name: ActionName.DownloadAction | ActionName.FollowAction | ActionName.PreviewAction | ActionName.ViewAction;
575
- };
576
-
577
- // @public (undocumented)
578
- export type OnActionMenuOpenChangeOptions = {
579
- isOpen: boolean;
580
- };
581
-
582
- // @public (undocumented)
583
- type OnErrorCallback = (data: {
584
- status: Extract<CardType, ErrorCardType>;
585
- url: string;
586
- err?: Error;
587
- }) => void;
588
-
589
- // @public (undocumented)
590
- type OnResolveCallback = (data: {
591
- url?: string;
592
- title?: string;
593
- aspectRatio?: number;
594
- }) => void;
595
-
596
- // @public
597
- type OwnedBy = {
598
- name: ElementName.OwnedBy;
599
- };
600
-
601
- // @public
602
- type OwnedByGroup = {
603
- name: ElementName.OwnedByGroup;
604
- showNamePrefix?: boolean;
605
- };
606
-
607
- // @public
608
- type Preview = {
609
- name: ElementName.Preview;
610
- };
611
-
612
- // @public
613
- export const PreviewBlock: React_2.FC<PreviewBlockProps>;
614
-
615
- // @public (undocumented)
616
- type PreviewBlockProps = {
617
- ignoreContainerPadding?: boolean;
618
- onError?: () => void;
619
- placement?: MediaPlacement;
620
- overrideUrl?: string;
621
- } & BlockProps;
622
-
623
- // @public (undocumented)
624
- type PreviewDisplay = 'card' | 'embed';
625
-
626
- // @public (undocumented)
627
- type PreviewInvokeMethod = 'keyboard' | 'mouse_click' | 'mouse_hover';
628
-
629
- // @public
630
- type Priority = {
631
- name: ElementName.Priority;
632
- };
633
-
634
- // @public
635
- type ProgrammingLanguage = {
636
- name: ElementName.ProgrammingLanguage;
637
- };
638
-
639
- // @public (undocumented)
640
- interface Props {
641
- // (undocumented)
642
- embedIframeRef: React_2.RefObject<HTMLIFrameElement>;
643
- // (undocumented)
644
- onHeightUpdate: (height: number) => void;
645
- }
646
-
647
- export { Provider }
648
-
649
- // @public
650
- type Provider_2 = {
651
- name: ElementName.Provider;
652
- };
653
-
654
- export { ProviderProps }
655
-
656
- // @public
657
- type ReactCount = {
658
- name: ElementName.ReactCount;
659
- };
660
-
661
- // @public
662
- type ReadTime = {
663
- name: ElementName.ReadTime;
664
- };
665
-
666
- // @public (undocumented)
667
- export type ResolveResponse = JsonLd.Response;
668
-
669
- // @public
670
- type RetryOptions = {
671
- descriptor?: MessageDescriptor;
672
- onClick?: ((e: React.MouseEvent<HTMLElement>) => void) | undefined;
673
- values?: Record<string, string>;
674
- };
675
-
676
- // @public (undocumented)
677
- type ScreenAuthPopupEventProps = CommonEventProps;
678
-
679
- // @public
680
- type SentOn = {
681
- name: ElementName.SentOn;
682
- };
683
-
684
- export { SmartCardContext as Context }
685
- export { SmartCardContext }
686
-
687
- // @public
688
- export enum SmartLinkDirection {
689
- // (undocumented)
690
- Horizontal = "horizontal",
691
- // (undocumented)
692
- Vertical = "vertical"
693
- }
694
-
695
- // @public (undocumented)
696
- export class SmartLinkEvents {
697
- // (undocumented)
698
- insertSmartLink(url: string, type: CardInnerAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
699
- }
700
-
701
- // @public
702
- export enum SmartLinkPosition {
703
- // (undocumented)
704
- Center = "center",
705
- // (undocumented)
706
- Top = "top"
707
- }
708
-
709
- // @public
710
- export enum SmartLinkSize {
711
- // (undocumented)
712
- Large = "large",
713
- // (undocumented)
714
- Medium = "medium",
715
- // (undocumented)
716
- Small = "small",
717
- // (undocumented)
718
- XLarge = "xlarge"
719
- }
720
-
721
- // @public
722
- enum SmartLinkStatus {
723
- // (undocumented)
724
- Errored = "errored",
725
- // (undocumented)
726
- Fallback = "fallback",
727
- // (undocumented)
728
- Forbidden = "forbidden",
729
- // (undocumented)
730
- NotFound = "not_found",
731
- // (undocumented)
732
- Pending = "pending",
733
- // (undocumented)
734
- Resolved = "resolved",
735
- // (undocumented)
736
- Resolving = "resolving",
737
- // (undocumented)
738
- Unauthorized = "unauthorized"
739
- }
740
-
741
- // @public
742
- export enum SmartLinkTheme {
743
- // (undocumented)
744
- Black = "black",
745
- // (undocumented)
746
- Link = "link"
747
- }
748
-
749
- // @public
750
- type Snippet = {
751
- name: ElementName.Snippet;
752
- };
753
-
754
- // @public
755
- export const SnippetBlock: React_2.FC<SnippetBlockProps>;
756
-
757
- // @public (undocumented)
758
- type SnippetBlockProps = {
759
- maxLines?: number;
760
- text?: string;
761
- } & BlockProps;
762
-
763
- // @public
764
- type SourceBranch = {
765
- name: ElementName.SourceBranch;
766
- };
767
-
768
- // @public (undocumented)
769
- interface State {
770
- }
771
-
772
- // @public
773
- type State_2 = {
774
- name: ElementName.State;
775
- };
776
-
777
- // @public
778
- type StoryPoints = {
779
- name: ElementName.StoryPoints;
780
- };
781
-
782
- // @public
783
- type SubscriberCount = {
784
- name: ElementName.SubscriberCount;
785
- };
786
-
787
- // @public
788
- type SubTasksProgress = {
789
- name: ElementName.SubTasksProgress;
790
- };
791
-
792
- // @public
793
- type TargetBranch = {
794
- name: ElementName.TargetBranch;
795
- };
796
-
797
- // @public
798
- type Title = {
799
- name: ElementName.Title;
800
- };
801
-
802
- // @public
803
- export const TitleBlock: React_2.FC<TitleBlockProps>;
804
-
805
- // @public (undocumented)
806
- type TitleBlockProps = {
807
- actions?: ActionItem[];
808
- anchorTarget?: AnchorTarget;
809
- hideTitleTooltip?: boolean;
810
- maxLines?: number;
811
- metadata?: ElementItem[];
812
- onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
813
- position?: SmartLinkPosition;
814
- onClick?: React_2.EventHandler<React_2.KeyboardEvent | React_2.MouseEvent>;
815
- retry?: RetryOptions;
816
- hideRetry?: boolean;
817
- showActionOnHover?: boolean;
818
- subtitle?: ElementItem[];
819
- text?: string;
820
- theme?: SmartLinkTheme;
821
- metadataPosition?: SmartLinkPosition;
822
- hideIcon?: boolean;
823
- } & BlockProps;
824
-
825
- // @public (undocumented)
826
- type TrackAppAccountConnectedProps = CommonEventProps;
827
-
828
- // @public (undocumented)
829
- enum TrackQuickActionFailureReason {
830
- // (undocumented)
831
- PermissionError = "PermissionError",
832
- // (undocumented)
833
- UnknownError = "UnknownError",
834
- // (undocumented)
835
- ValidationError = "ValidationError"
836
- }
837
-
838
- // @public (undocumented)
839
- enum TrackQuickActionType {
840
- // (undocumented)
841
- StatusUpdate = "StatusUpdate"
842
- }
843
-
844
- // @public (undocumented)
845
- type UiActionClickedEventProps = CommonEventProps & {
846
- id?: string;
847
- display?: CardInnerAppearance;
848
- actionType: string;
849
- invokeType?: InvokeType;
850
- };
851
-
852
- // @public (undocumented)
853
- type UiAuthAlternateAccountEventProps = CommonEventProps & {
854
- display: CardInnerAppearance;
855
- };
856
-
857
- // @public (undocumented)
858
- type UiAuthEventProps = CommonEventProps & {
859
- display: CardInnerAppearance;
860
- };
861
-
862
- // @public (undocumented)
863
- type UiCardClickedEventProps = CommonEventProps & {
864
- id: string;
865
- display: CardInnerAppearance;
866
- status: CardType;
867
- isModifierKeyPressed?: boolean;
868
- actionSubjectId?: string;
869
- };
870
-
871
- // @public (undocumented)
872
- type UiClosedAuthEventProps = CommonEventProps & {
873
- display: CardInnerAppearance;
874
- };
875
-
876
- // @public (undocumented)
877
- type UiHoverCardDismissedEventProps = CommonEventProps & {
878
- previewDisplay: PreviewDisplay;
879
- hoverTime: number;
880
- previewInvokeMethod?: PreviewInvokeMethod;
881
- status: CardType;
882
- };
883
-
884
- // @public (undocumented)
885
- type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
886
- previewDisplay: PreviewDisplay;
887
- previewInvokeMethod?: PreviewInvokeMethod;
888
- };
889
-
890
- // @public (undocumented)
891
- type UiHoverCardViewedEventProps = CommonEventProps & {
892
- previewDisplay: PreviewDisplay;
893
- previewInvokeMethod?: PreviewInvokeMethod;
894
- status: CardType;
895
- };
896
-
897
- // @public (undocumented)
898
- type UiIframeDwelledEventProps = CommonEventProps & {
899
- id: string;
900
- display: CardInnerAppearance;
901
- status: CardType;
902
- dwellTime: number;
903
- dwellPercentVisible: number;
904
- };
905
-
906
- // @public (undocumented)
907
- type UiIframeFocusedEventProps = CommonEventProps & {
908
- id: string;
909
- display: CardInnerAppearance;
910
- status: CardType;
911
- };
912
-
913
- // @public (undocumented)
914
- type UiRenderFailedEventProps = CommonEventProps & {
915
- display: CardInnerAppearance;
916
- error: Error;
917
- errorInfo: ErrorInfo;
918
- };
919
-
920
- // @public (undocumented)
921
- type UiRenderSuccessEventProps = CommonEventProps & {
922
- display: CardInnerAppearance;
923
- status: CardType;
924
- canBeDatasource?: boolean;
925
- };
926
-
927
- // @public (undocumented)
928
- type UiServerActionClickedEventProps = CommonEventProps & {
929
- smartLinkActionType: SmartLinkActionType;
930
- };
931
-
932
- // @public @deprecated
933
- export const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: AnalyticsHandler, id?: string, defaultLocation?: string) => {
934
- ui: {
935
- authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
936
- authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthAlternateAccountEventProps) => void;
937
- buttonClickedEvent: (data: Partial<AnalyticsPayload> & {
938
- actionSubjectId: Required<string>;
939
- }) => void;
940
- cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
941
- iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: UiIframeDwelledEventProps) => void;
942
- iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: UiIframeFocusedEventProps) => void;
943
- actionClickedEvent: ({ id, actionType, display, extensionKey: overrideExtensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
944
- hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
945
- closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => void;
946
- modalClosedEvent: (data: Partial<AnalyticsPayload> & {
947
- actionSubjectId: Required<string>;
948
- }) => void;
949
- renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, canBeDatasource, }: UiRenderSuccessEventProps) => void;
950
- renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
951
- hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
952
- hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
953
- learnMoreClickedEvent: () => void;
954
- smartLinkLozengeActionClickedEvent: () => void;
955
- smartLinkLozengeActionListItemClickedEvent: () => void;
956
- smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
957
- smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
958
- };
959
- operational: {
960
- invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
961
- invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
962
- connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => void;
963
- connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectFailedEventProps) => void;
964
- instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
965
- chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
966
- };
967
- track: {
968
- appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => void;
969
- appAccountAuthStarted: ({ extensionKey, location, }: TrackAppAccountConnectedProps) => void;
970
- linkUpdated: () => void;
971
- smartLinkQuickActionStarted: (props: {
972
- smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
973
- }) => void;
974
- smartLinkQuickActionSuccess: (props: {
975
- smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
976
- }) => void;
977
- smartLinkQuickActionFailed: (props: {
978
- smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
979
- reason?: TrackQuickActionFailureReason;
980
- step?: string;
981
- }) => void;
982
- hoverCardResolutionStarted: () => void;
983
- };
984
- screen: {
985
- authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ScreenAuthPopupEventProps) => void;
986
- modalViewedEvent: (data: Partial<AnalyticsPayload> & {
987
- name: Extract<AnalyticsName, 'embedPreviewModal'>;
988
- }) => void;
989
- };
990
- };
991
-
992
- // @public (undocumented)
993
- export function useSmartLinkEvents(): SmartLinkEvents;
994
-
995
- // @public
996
- type ViewCount = {
997
- name: ElementName.ViewCount;
998
- };
999
-
1000
- // @public
1001
- type VoteCount = {
1002
- name: ElementName.VoteCount;
1003
- };
1004
-
1005
- // (No @packageDocumentation comment for this package)
1006
-
1007
- ```