@atlaskit/smart-card 19.1.26 → 19.1.29

package/report.api.md

@@ -0,0 +1,501 @@
+## API Report File for "@atlaskit/smart-card"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { APIError } from '@atlaskit/linking-common';
+import { Appearance } from '@atlaskit/button/types';
+import { BlockCardAdf } from '@atlaskit/linking-common';
+import { CardAdf } from '@atlaskit/linking-common';
+import { CardAppearance } from '@atlaskit/linking-common';
+import { CardContext } from '@atlaskit/link-provider';
+import { CardPlatform } from '@atlaskit/linking-common';
+import { CardType } from '@atlaskit/linking-common';
+import { CardClient as Client } from '@atlaskit/link-provider';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { EditorCardProvider } from '@atlaskit/link-provider';
+import { editorCardProvider } from '@atlaskit/link-provider';
+import { EmbedCardAdf } from '@atlaskit/linking-common';
+import { GasPayload } from '@atlaskit/analytics-gas-types';
+import { InlineCardAdf } from '@atlaskit/linking-common';
+import { JsonLd } from 'json-ld-types';
+import { MessageDescriptor } from 'react-intl-next';
+import { SmartCardProvider as Provider } from '@atlaskit/link-provider';
+import { ProviderProps } from '@atlaskit/link-provider';
+import { default as React_2 } from 'react';
+import { ReactChild } from 'react';
+import { SerializedStyles } from '@emotion/core';
+import { SmartCardContext } from '@atlaskit/link-provider';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+import { WithContextProps } from '@atlaskit/analytics-next';
+import { WithIntlProps } from 'react-intl-next';
+import { WrappedComponentProps } from 'react-intl-next';
+
+// @public (undocumented)
+export type ActionItem = NamedActionItem | CustomActionItem;
+
+// @public
+export enum ActionName {
+  // (undocumented)
+  CustomAction = 'CustomAction',
+  // (undocumented)
+  DeleteAction = 'DeleteAction',
+  // (undocumented)
+  EditAction = 'EditAction',
+}
+
+// @public (undocumented)
+export type AnalyticsAction =
+  | 'resolved'
+  | 'unresolved'
+  | 'connectSucceeded'
+  | 'connectFailed'
+  | 'connected'
+  | 'clicked'
+  | 'closed'
+  | 'renderFailed'
+  | 'renderWithStatus'
+  | 'renderSuccess'
+  | 'inserted'
+  | 'viewed'
+  | 'dismissed'
+  | 'created';
+
+// @public (undocumented)
+export type AnalyticsActionSubject =
+  | 'smartLink'
+  | 'smartLinkAction'
+  | 'applicationAccount'
+  | 'button'
+  | 'consentModal'
+  | 'hoverCard';
+
+// @public (undocumented)
+export type AnalyticsHandler = (event: AnalyticsPayload) => void;
+
+// @public (undocumented)
+export type AnalyticsPayload = GasPayload & {
+  action?: AnalyticsAction;
+  actionSubject: AnalyticsActionSubject;
+  attributes: GasPayload['attributes'] & {
+    display?: CardInnerAppearance;
+  };
+};
+
+export { APIError };
+
+export { BlockCardAdf };
+
+// @public (undocumented)
+export const blockCardContentClassName = 'block-card-content';
+
+// @public (undocumented)
+export const blockCardContentHeaderClassName = 'block-card-content-header';
+
+// @public (undocumented)
+export const blockCardContentHeaderNameClassName =
+  'block-card-content-header-name';
+
+// @public (undocumented)
+export const blockCardErroredViewClassName = 'block-card-errored-view';
+
+// @public (undocumented)
+export const blockCardForbiddenViewClassName = 'block-card-forbidden-view';
+
+// @public (undocumented)
+export const blockCardForbiddenViewLinkClassName =
+  'block-card-forbidden-view-link';
+
+// @public (undocumented)
+export const blockCardIconImageClassName = 'block-card-icon-image';
+
+// @public (undocumented)
+export const blockCardNotFoundViewClassName = 'block-card-not-found-view';
+
+// @public (undocumented)
+export const blockCardResolvedViewByClassName = 'block-card-resolved-view-by';
+
+// @public (undocumented)
+export const blockCardResolvedViewClassName = 'block-card-resolved-view';
+
+// @public (undocumented)
+export const blockCardResolvingViewClassName = 'block-card-resolving-view';
+
+// @public (undocumented)
+export const Card: React_2.ForwardRefExoticComponent<
+  Pick<
+    Omit<
+      React_2.PropsWithChildren<
+        WithIntlProps<CardProps & WrappedComponentProps<'intl'>>
+      >,
+      keyof WithAnalyticsEventsProps
+    > &
+      React_2.RefAttributes<any> &
+      WithContextProps,
+    | 'children'
+    | 'data'
+    | 'appearance'
+    | 'testId'
+    | 'isSelected'
+    | 'inheritDimensions'
+    | 'id'
+    | 'placeholder'
+    | 'onClick'
+    | 'analyticsContext'
+    | 'key'
+    | 'url'
+    | 'ui'
+    | 'showActions'
+    | 'onResolve'
+    | 'platform'
+    | 'isFrameVisible'
+    | 'embedIframeRef'
+    | 'showHoverPreview'
+    | 'inlinePreloaderStyle'
+    | 'importer'
+    | 'container'
+    | 'analyticsEvents'
+    | 'forwardedRef'
+  > &
+    React_2.RefAttributes<any>
+>;
+
+export { CardAdf };
+
+export { CardAppearance };
+
+export { CardContext };
+
+export { CardPlatform };
+
+// @public (undocumented)
+export interface CardProps extends WithAnalyticsEventsProps {
+  // (undocumented)
+  analyticsEvents?: AnalyticsFacade;
+  // (undocumented)
+  appearance: CardAppearance;
+  // (undocumented)
+  children?: React.ReactNode;
+  // (undocumented)
+  container?: HTMLElement;
+  // (undocumented)
+  data?: any;
+  // (undocumented)
+  embedIframeRef?: React.Ref<HTMLIFrameElement>;
+  // (undocumented)
+  id?: string;
+  // (undocumented)
+  importer?: (target: any) => void;
+  // (undocumented)
+  inheritDimensions?: boolean;
+  // (undocumented)
+  inlinePreloaderStyle?: InlinePreloaderStyle;
+  // (undocumented)
+  isFrameVisible?: boolean;
+  // (undocumented)
+  isSelected?: boolean;
+  // (undocumented)
+  onClick?: React.EventHandler<React.MouseEvent | React.KeyboardEvent>;
+  // (undocumented)
+  onResolve?: OnResolveCallback;
+  // (undocumented)
+  placeholder?: string;
+  // (undocumented)
+  platform?: CardPlatform;
+  // (undocumented)
+  showActions?: boolean;
+  // (undocumented)
+  showHoverPreview?: boolean;
+  // (undocumented)
+  testId?: string;
+  // (undocumented)
+  ui?: FlexibleUiOptions;
+  // (undocumented)
+  url?: string;
+}
+
+export { CardType };
+
+export { Client };
+
+// @public (undocumented)
+export const contentFooterClassName = 'smart-link-content-footer';
+
+export { EditorCardProvider };
+
+export { editorCardProvider };
+
+// @public
+export type ElementItem = {
+  overrideCss?: SerializedStyles;
+  size?: SmartLinkSize;
+  testId?: string;
+} & ElementItemProps;
+
+// @public
+export enum ElementName {
+  // (undocumented)
+  AuthorGroup = 'AuthorGroup',
+  // (undocumented)
+  CollaboratorGroup = 'CollaboratorGroup',
+  // (undocumented)
+  CommentCount = 'CommentCount',
+  // (undocumented)
+  CreatedBy = 'CreatedBy',
+  // (undocumented)
+  CreatedOn = 'CreatedOn',
+  // (undocumented)
+  LatestCommit = 'LatestCommit',
+  // (undocumented)
+  LinkIcon = 'LinkIcon',
+  // (undocumented)
+  ModifiedBy = 'ModifiedBy',
+  // (undocumented)
+  ModifiedOn = 'ModifiedOn',
+  // (undocumented)
+  Preview = 'Preview',
+  // (undocumented)
+  Priority = 'Priority',
+  // (undocumented)
+  ProgrammingLanguage = 'ProgrammingLanguage',
+  // (undocumented)
+  Provider = 'Provider',
+  // (undocumented)
+  ReactCount = 'ReactCount',
+  // (undocumented)
+  Snippet = 'Snippet',
+  // (undocumented)
+  State = 'State',
+  // (undocumented)
+  SubscriberCount = 'SubscriberCount',
+  // (undocumented)
+  Title = 'Title',
+  // (undocumented)
+  ViewCount = 'ViewCount',
+  // (undocumented)
+  VoteCount = 'VoteCount',
+}
+
+export { EmbedCardAdf };
+
+// @public (undocumented)
+export const embedHeaderHeight = 32;
+
+// @public (undocumented)
+export class EmbedResizeMessageListener extends React_2.Component<
+  Props,
+  State
+> {
+  // (undocumented)
+  componentDidMount(): void;
+  // (undocumented)
+  componentWillUnmount(): void;
+  // (undocumented)
+  render(): React_2.ReactNode;
+}
+
+// @public
+export const FooterBlock: React_2.FC<FooterBlockProps>;
+
+export { InlineCardAdf };
+
+// @public (undocumented)
+export const loadingPlaceholderClassName = 'smart-link-loading-placeholder';
+
+// @public
+export const MetadataBlock: React_2.FC<MetadataBlockProps>;
+
+// @public (undocumented)
+export const metadataListClassName = 'smart-link-metadata-list';
+
+// @public
+export const PreviewBlock: React_2.FC<PreviewBlockProps>;
+
+export { Provider };
+
+export { ProviderProps };
+
+// @public (undocumented)
+export type ResolveResponse = JsonLd.Response;
+
+export { SmartCardContext as Context };
+export { SmartCardContext };
+
+// @public
+export enum SmartLinkDirection {
+  // (undocumented)
+  Horizontal = 'horizontal',
+  // (undocumented)
+  Vertical = 'vertical',
+}
+
+// @public (undocumented)
+export class SmartLinkEvents {
+  // (undocumented)
+  insertSmartLink(
+    url: string,
+    type: CardInnerAppearance,
+    createAnalyticsEvent?: CreateUIAnalyticsEvent,
+  ): void;
+}
+
+// @public
+export enum SmartLinkPosition {
+  // (undocumented)
+  Center = 'center',
+  // (undocumented)
+  Top = 'top',
+}
+
+// @public
+export enum SmartLinkSize {
+  // (undocumented)
+  Large = 'large',
+  // (undocumented)
+  Medium = 'medium',
+  // (undocumented)
+  Small = 'small',
+  // (undocumented)
+  XLarge = 'xlarge',
+}
+
+// @public
+export enum SmartLinkTheme {
+  // (undocumented)
+  Black = 'black',
+  // (undocumented)
+  Link = 'link',
+}
+
+// @public
+export const SnippetBlock: React_2.FC<SnippetBlockProps>;
+
+// @public
+export const TitleBlock: React_2.FC<TitleBlockProps>;
+
+// @public
+export const useSmartLinkAnalytics: (
+  url: string,
+  dispatchAnalytics: AnalyticsHandler,
+  id?: string | undefined,
+  defaultLocation?: string | undefined,
+) => {
+  ui: {
+    authEvent: (
+      display: CardInnerAppearance,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+    authAlternateAccountEvent: (
+      display: CardInnerAppearance,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+    cardClickedEvent: (
+      id: string | undefined,
+      display: CardInnerAppearance,
+      status: CardType,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+      isModifierKeyPressed?: boolean | undefined,
+      location?: string | undefined,
+      destinationProduct?: DestinationProduct | string | undefined,
+      destinationSubproduct?: DestinationSubproduct | string | undefined,
+      actionSubjectId?: string | undefined,
+    ) => void;
+    actionClickedEvent: (
+      id: string | undefined,
+      extensionKey: string | undefined,
+      actionType: string,
+      display: CardInnerAppearance,
+      invokeType: InvokeType,
+    ) => void;
+    hoverCardOpenLinkClickedEvent: (
+      previewDisplay: PreviewDisplay,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+      previewInvokeMethod?: PreviewInvokeMethod | undefined,
+    ) => void;
+    closedAuthEvent: (
+      display: CardInnerAppearance,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+    renderSuccessEvent: (
+      display: CardInnerAppearance,
+      status: CardType,
+      id?: string,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+    hoverCardViewedEvent: (
+      previewDisplay: PreviewDisplay,
+      previewInvokeMethod?: PreviewInvokeMethod | undefined,
+      id?: string,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+    hoverCardDismissedEvent: (
+      previewDisplay: PreviewDisplay,
+      hoverTime: number,
+      previewInvokeMethod?: PreviewInvokeMethod | undefined,
+      id?: string,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+  };
+  operational: {
+    invokeSucceededEvent: (
+      id: string | undefined,
+      extensionKey: string | undefined,
+      actionType: string,
+      display: CardInnerAppearance,
+    ) => void;
+    invokeFailedEvent: (
+      id: string | undefined,
+      providerKey: string | undefined,
+      actionType: string,
+      display: CardInnerAppearance,
+      reason: string,
+    ) => void;
+    connectSucceededEvent: (
+      id?: string,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+    connectFailedEvent: (
+      id?: string,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+      reason?: string | undefined,
+    ) => void;
+    instrument: (
+      id: string | undefined,
+      status: CardType,
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+      resourceType?: string | undefined,
+      error?: APIError | undefined,
+    ) => void;
+  };
+  track: {
+    appAccountConnected: (
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+  };
+  screen: {
+    authPopupEvent: (
+      definitionId?: string | undefined,
+      extensionKey?: string | undefined,
+    ) => void;
+  };
+};
+
+// @public (undocumented)
+export function useSmartLinkEvents(): SmartLinkEvents;
+
+// (No @packageDocumentation comment for this package)
+```