@atlaskit/help 7.4.2 → 7.5.1

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/help"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using
+> [API Extractor](https://api-extractor.com/).
 > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ### Table of contents
@@ -33,252 +34,244 @@ import { WrappedComponentProps } from 'react-intl-next';
 
 // @public (undocumented)
 export interface Article extends ArticleItem {
-  // (undocumented)
-  body: AdfDoc | string;
-  // (undocumented)
-  bodyFormat?: BODY_FORMAT_TYPES;
-  // (undocumented)
-  relatedArticles?: ArticleItem[];
+	// (undocumented)
+	body: AdfDoc | string;
+	// (undocumented)
+	bodyFormat?: BODY_FORMAT_TYPES;
+	// (undocumented)
+	relatedArticles?: ArticleItem[];
 }
 
 // @public (undocumented)
 export enum ARTICLE_ITEM_TYPES {
-  // (undocumented)
-  topicInProduct = 'topicInProduct',
+	// (undocumented)
+	topicInProduct = 'topicInProduct',
 }
 
 // @public (undocumented)
 export enum ARTICLE_TYPE {
-  // (undocumented)
-  HELP_ARTICLE = 'HELP_ARTICLE',
-  // (undocumented)
-  WHATS_NEW = 'WHATS_NEW',
+	// (undocumented)
+	HELP_ARTICLE = 'HELP_ARTICLE',
+	// (undocumented)
+	WHATS_NEW = 'WHATS_NEW',
 }
 
 // @public (undocumented)
 export interface ArticleFeedback {
-  // (undocumented)
-  contactMe: boolean;
-  // (undocumented)
-  feedbackReason: string;
-  // (undocumented)
-  feedbackReasonText: string;
-  // (undocumented)
-  wasHelpful: boolean;
+	// (undocumented)
+	contactMe: boolean;
+	// (undocumented)
+	feedbackReason: string;
+	// (undocumented)
+	feedbackReasonText: string;
+	// (undocumented)
+	wasHelpful: boolean;
 }
 
 // @public (undocumented)
 export interface articleId {
-  // (undocumented)
-  id: string;
-  // (undocumented)
-  type: ARTICLE_TYPE;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	type: ARTICLE_TYPE;
 }
 
 // @public (undocumented)
 export interface ArticleItem {
-  // (undocumented)
-  description?: string;
-  // (undocumented)
-  href?: string;
-  // (undocumented)
-  id: string;
-  // (undocumented)
-  lastPublished: string;
-  // (undocumented)
-  productName?: string;
-  // (undocumented)
-  routes?: {
-    routeName: string;
-    routeGroup: string;
-  }[];
-  // (undocumented)
-  title: string;
-  // (undocumented)
-  topicId?: string;
-  // (undocumented)
-  type: ARTICLE_ITEM_TYPES;
+	// (undocumented)
+	description?: string;
+	// (undocumented)
+	href?: string;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	lastPublished: string;
+	// (undocumented)
+	productName?: string;
+	// (undocumented)
+	routes?: {
+		routeName: string;
+		routeGroup: string;
+	}[];
+	// (undocumented)
+	title: string;
+	// (undocumented)
+	topicId?: string;
+	// (undocumented)
+	type: ARTICLE_ITEM_TYPES;
 }
 
 // @public (undocumented)
 export const ArticlesListItem: React_2.FC<
-  WithIntlProps<Props_3 & Partial<ArticleItem> & WrappedComponentProps<'intl'>>
+	WithIntlProps<Props_3 & Partial<ArticleItem> & WrappedComponentProps<'intl'>>
 > & {
-  WrappedComponent: React_2.ComponentType<
-    Props_3 & Partial<ArticleItem> & WrappedComponentProps<'intl'>
-  >;
+	WrappedComponent: React_2.ComponentType<
+		Props_3 & Partial<ArticleItem> & WrappedComponentProps<'intl'>
+	>;
 };
 
 // @public (undocumented)
 const _default: React_2.ForwardRefExoticComponent<
-  Pick<
-    Omit<Props, keyof WithAnalyticsEventsProps> &
-      React_2.RefAttributes<any> &
-      WithContextProps,
-    'analyticsContext' | 'key' | keyof Help
-  > &
-    React_2.RefAttributes<any>
+	Pick<
+		Omit<Props, keyof WithAnalyticsEventsProps> & React_2.RefAttributes<any> & WithContextProps,
+		'analyticsContext' | 'key' | keyof Help
+	> &
+		React_2.RefAttributes<any>
 >;
 export default _default;
 
 // @public (undocumented)
 export const DividerLine: StyledComponent<
-  DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
-  Pick<
-    ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>,
-    keyof HTMLAttributes<HTMLDivElement>
-  >,
-  object
+	DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
+	Pick<
+		ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>,
+		keyof HTMLAttributes<HTMLDivElement>
+	>,
+	object
 >;
 
 // @public (undocumented)
 export interface Help {
-  // (undocumented)
-  children?: React.ReactNode;
-  // (undocumented)
-  footer?: React.ReactNode;
-  // (undocumented)
-  header?: {
-    onCloseButtonClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-    ): void;
-    onBackButtonClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-    ): void;
-  };
-  // (undocumented)
-  helpArticle?: {
-    onGetHelpArticle?(articleId: articleId): Promise<Article>;
-    onHelpArticleLoadingFailTryAgainButtonClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-      articleId: articleId,
-    ): void;
-    onWasHelpfulSubmit?(
-      analyticsEvent: UIAnalyticsEvent,
-      articleFeedback: ArticleFeedback,
-      articleData: ArticleItem,
-    ): Promise<boolean>;
-    onWasHelpfulYesButtonClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-      ArticleItem: ArticleItem,
-    ): void;
-    onWasHelpfulNoButtonClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-      ArticleItem: ArticleItem,
-    ): void;
-  };
-  // (undocumented)
-  home?: {
-    homeOptions?: Props_2[];
-  };
-  // (undocumented)
-  navigation?: {
-    navigationData?: {
-      articleId: articleId;
-      history: HistoryItem[];
-    };
-    setNavigationData?(navigationData: {
-      articleId?: articleId;
-      history?: HistoryItem[];
-    }): void;
-  };
-  // (undocumented)
-  relatedArticles?: {
-    routeGroup?: string;
-    routeName?: string;
-    onGetRelatedArticles?(
-      routeGroup?: string,
-      routeName?: string,
-    ): Promise<ArticleItem[]>;
-    onRelatedArticlesShowMoreClick?(
-      event: React.MouseEvent<HTMLElement>,
-      analyticsEvent: UIAnalyticsEvent,
-      isCollapsed: boolean,
-    ): void;
-    onRelatedArticlesListItemClick?: (
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-      articleData: ArticleItem,
-    ) => void;
-  };
-  // (undocumented)
-  search?: {
-    onSearch?(value: string): Promise<ArticleItem[]>;
-    onSearchInputChanged?(
-      event: React.KeyboardEvent<HTMLInputElement>,
-      analyticsEvent: UIAnalyticsEvent,
-      value: string,
-    ): void;
-    onSearchInputCleared?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-    ): void;
-    onSearchResultItemClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-      articleData: ArticleItem,
-    ): void;
-    onSearchExternalUrlClick?(
-      event?: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent?: UIAnalyticsEvent,
-    ): void;
-    searchExternalUrl?: string;
-  };
-  // (undocumented)
-  whatsNew?: {
-    whatsNewGetNotificationProvider?: Promise<NotificationLogProvider>;
-    productName?: string;
-    onWhatsNewButtonClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-    ): void;
-    onSearchWhatsNewArticles?(
-      filter?: '' | WHATS_NEW_ITEM_TYPES,
-      numberOfItems?: number,
-      page?: string,
-    ): Promise<whatsNewSearchResult>;
-    onWhatsNewResultItemClick?(
-      event: React.MouseEvent<HTMLElement, MouseEvent>,
-      analyticsEvent: UIAnalyticsEvent,
-      whatsNewArticleData: WhatsNewArticleItem,
-    ): void;
-    onSearchWhatsNewShowMoreClick?(
-      event: React.MouseEvent<HTMLElement>,
-      analyticsEvent: UIAnalyticsEvent,
-    ): void;
-    onGetWhatsNewArticle?(id: articleId): Promise<WhatsNewArticle>;
-  };
+	// (undocumented)
+	children?: React.ReactNode;
+	// (undocumented)
+	footer?: React.ReactNode;
+	// (undocumented)
+	header?: {
+		onCloseButtonClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+		): void;
+		onBackButtonClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+		): void;
+	};
+	// (undocumented)
+	helpArticle?: {
+		onGetHelpArticle?(articleId: articleId): Promise<Article>;
+		onHelpArticleLoadingFailTryAgainButtonClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+			articleId: articleId,
+		): void;
+		onWasHelpfulSubmit?(
+			analyticsEvent: UIAnalyticsEvent,
+			articleFeedback: ArticleFeedback,
+			articleData: ArticleItem,
+		): Promise<boolean>;
+		onWasHelpfulYesButtonClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+			ArticleItem: ArticleItem,
+		): void;
+		onWasHelpfulNoButtonClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+			ArticleItem: ArticleItem,
+		): void;
+	};
+	// (undocumented)
+	home?: {
+		homeOptions?: Props_2[];
+	};
+	// (undocumented)
+	navigation?: {
+		navigationData?: {
+			articleId: articleId;
+			history: HistoryItem[];
+		};
+		setNavigationData?(navigationData: { articleId?: articleId; history?: HistoryItem[] }): void;
+	};
+	// (undocumented)
+	relatedArticles?: {
+		routeGroup?: string;
+		routeName?: string;
+		onGetRelatedArticles?(routeGroup?: string, routeName?: string): Promise<ArticleItem[]>;
+		onRelatedArticlesShowMoreClick?(
+			event: React.MouseEvent<HTMLElement>,
+			analyticsEvent: UIAnalyticsEvent,
+			isCollapsed: boolean,
+		): void;
+		onRelatedArticlesListItemClick?: (
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+			articleData: ArticleItem,
+		) => void;
+	};
+	// (undocumented)
+	search?: {
+		onSearch?(value: string): Promise<ArticleItem[]>;
+		onSearchInputChanged?(
+			event: React.KeyboardEvent<HTMLInputElement>,
+			analyticsEvent: UIAnalyticsEvent,
+			value: string,
+		): void;
+		onSearchInputCleared?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+		): void;
+		onSearchResultItemClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+			articleData: ArticleItem,
+		): void;
+		onSearchExternalUrlClick?(
+			event?: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent?: UIAnalyticsEvent,
+		): void;
+		searchExternalUrl?: string;
+	};
+	// (undocumented)
+	whatsNew?: {
+		whatsNewGetNotificationProvider?: Promise<NotificationLogProvider>;
+		productName?: string;
+		onWhatsNewButtonClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+		): void;
+		onSearchWhatsNewArticles?(
+			filter?: '' | WHATS_NEW_ITEM_TYPES,
+			numberOfItems?: number,
+			page?: string,
+		): Promise<whatsNewSearchResult>;
+		onWhatsNewResultItemClick?(
+			event: React.MouseEvent<HTMLElement, MouseEvent>,
+			analyticsEvent: UIAnalyticsEvent,
+			whatsNewArticleData: WhatsNewArticleItem,
+		): void;
+		onSearchWhatsNewShowMoreClick?(
+			event: React.MouseEvent<HTMLElement>,
+			analyticsEvent: UIAnalyticsEvent,
+		): void;
+		onGetWhatsNewArticle?(id: articleId): Promise<WhatsNewArticle>;
+	};
 }
 
 // @public (undocumented)
 export const HelpContentButton: ({
-  id,
-  href,
-  notificationMax,
-  notificationLogProvider,
-  text,
-  icon,
-  onClick,
-  tooltipText,
+	id,
+	href,
+	notificationMax,
+	notificationLogProvider,
+	text,
+	icon,
+	onClick,
+	tooltipText,
 }: Props_2) => JSX.Element;
 
 // @public (undocumented)
 export interface HistoryItem {
-  // (undocumented)
-  article?: Article | WhatsNewArticle;
-  // (undocumented)
-  id: string;
-  // (undocumented)
-  state: REQUEST_STATE;
-  // (undocumented)
-  type: ARTICLE_TYPE;
-  // (undocumented)
-  uid: number;
+	// (undocumented)
+	article?: Article | WhatsNewArticle;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	state: REQUEST_STATE;
+	// (undocumented)
+	type: ARTICLE_TYPE;
+	// (undocumented)
+	uid: number;
 }
 
 // @public (undocumented)
@@ -286,134 +279,128 @@ type Props = Help & WithAnalyticsEventsProps;
 
 // @public (undocumented)
 type Props_2 = {
-  id?: string;
-  href?: string;
-  notificationMax?: number;
-  notificationLogProvider?: Promise<NotificationLogProvider>;
-  text: string;
-  icon?: React_2.ReactChild;
-  tooltipText?: string;
-  onClick?: (
-    id: string,
-    analytics: UIAnalyticsEvent,
-    event: React_2.MouseEvent<HTMLElement>,
-  ) => void;
+	id?: string;
+	href?: string;
+	notificationMax?: number;
+	notificationLogProvider?: Promise<NotificationLogProvider>;
+	text: string;
+	icon?: React_2.ReactChild;
+	tooltipText?: string;
+	onClick?: (
+		id: string,
+		analytics: UIAnalyticsEvent,
+		event: React_2.MouseEvent<HTMLElement>,
+	) => void;
 };
 
 // @public (undocumented)
 interface Props_3 {
-  // (undocumented)
-  onClick?: (
-    event: React_2.MouseEvent<HTMLElement>,
-    analyticsEvent: UIAnalyticsEvent,
-  ) => void;
-  // (undocumented)
-  styles?: {};
+	// (undocumented)
+	onClick?: (event: React_2.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent) => void;
+	// (undocumented)
+	styles?: {};
 }
 
 // @public (undocumented)
 interface Props_4 {
-  // (undocumented)
-  onGetRelatedArticles?(
-    routeGroup?: string,
-    routeName?: string,
-  ): Promise<ArticleItem[]>;
-  // (undocumented)
-  onRelatedArticlesListItemClick?: (
-    event: React_2.MouseEvent<HTMLElement, MouseEvent>,
-    analyticsEvent: UIAnalyticsEvent,
-    articleData: ArticleItem,
-  ) => void;
-  // (undocumented)
-  onRelatedArticlesShowMoreClick?: (
-    event: React_2.MouseEvent<HTMLElement>,
-    analyticsEvent: UIAnalyticsEvent,
-    isCollapsed: boolean,
-  ) => void;
-  // (undocumented)
-  routeGroup?: string;
-  // (undocumented)
-  routeName?: string;
-  // (undocumented)
-  style?: 'primary' | 'secondary';
+	// (undocumented)
+	onGetRelatedArticles?(routeGroup?: string, routeName?: string): Promise<ArticleItem[]>;
+	// (undocumented)
+	onRelatedArticlesListItemClick?: (
+		event: React_2.MouseEvent<HTMLElement, MouseEvent>,
+		analyticsEvent: UIAnalyticsEvent,
+		articleData: ArticleItem,
+	) => void;
+	// (undocumented)
+	onRelatedArticlesShowMoreClick?: (
+		event: React_2.MouseEvent<HTMLElement>,
+		analyticsEvent: UIAnalyticsEvent,
+		isCollapsed: boolean,
+	) => void;
+	// (undocumented)
+	routeGroup?: string;
+	// (undocumented)
+	routeName?: string;
+	// (undocumented)
+	style?: 'primary' | 'secondary';
 }
 
 // @public (undocumented)
 export const RelatedArticles: React_2.ForwardRefExoticComponent<
-  Omit<Props_4 & WrappedComponentProps<'intl'>, 'intl'> & {
-    forwardedRef?: React_2.Ref<any> | undefined;
-  } & {
-    children?: React_2.ReactNode;
-  } & WithContextProps &
-    React_2.RefAttributes<any>
+	Omit<Props_4 & WrappedComponentProps<'intl'>, 'intl'> & {
+		forwardedRef?: React_2.Ref<any> | undefined;
+	} & {
+		children?: React_2.ReactNode;
+	} & WithContextProps &
+		React_2.RefAttributes<any>
 >;
 
 // @public (undocumented)
 enum REQUEST_STATE {
-  // (undocumented)
-  done = 'done',
-  // (undocumented)
-  error = 'error',
-  // (undocumented)
-  load = 'load',
-  // (undocumented)
-  loading = 'loading',
-  // (undocumented)
-  reload = 'reload',
+	// (undocumented)
+	done = 'done',
+	// (undocumented)
+	error = 'error',
+	// (undocumented)
+	load = 'load',
+	// (undocumented)
+	loading = 'loading',
+	// (undocumented)
+	reload = 'reload',
 }
 
 // @public (undocumented)
 export enum WHATS_NEW_ITEM_TYPES {
-  // (undocumented)
-  EXPERIMENT = 'Experiment',
-  // (undocumented)
-  FIX = 'Fix',
-  // (undocumented)
-  IMPROVEMENT = 'Improvement',
-  // (undocumented)
-  NEW_FEATURE = 'Announcement',
-  // (undocumented)
-  REMOVED = 'Removed',
+	// (undocumented)
+	EXPERIMENT = 'Experiment',
+	// (undocumented)
+	FIX = 'Fix',
+	// (undocumented)
+	IMPROVEMENT = 'Improvement',
+	// (undocumented)
+	NEW_FEATURE = 'Announcement',
+	// (undocumented)
+	REMOVED = 'Removed',
 }
 
 // @public (undocumented)
 export interface WhatsNewArticle extends WhatsNewArticleItem {
-  // (undocumented)
-  bodyFormat?: BODY_FORMAT_TYPES;
-  // (undocumented)
-  description: AdfDoc | string;
+	// (undocumented)
+	bodyFormat?: BODY_FORMAT_TYPES;
+	// (undocumented)
+	description: AdfDoc | string;
 }
 
 // @public (undocumented)
 export interface WhatsNewArticleItem {
-  // (undocumented)
-  changeTargetSchedule?: string;
-  // (undocumented)
-  communityUrl?: string;
-  // (undocumented)
-  featureRolloutDate?: string;
-  // (undocumented)
-  href?: string;
-  // (undocumented)
-  id: string;
-  // (undocumented)
-  relatedExternalLinks?: string;
-  // (undocumented)
-  status?: string;
-  // (undocumented)
-  title?: string;
-  // (undocumented)
-  type?: WHATS_NEW_ITEM_TYPES;
+	// (undocumented)
+	changeTargetSchedule?: string;
+	// (undocumented)
+	communityUrl?: string;
+	// (undocumented)
+	featureRolloutDate?: string;
+	// (undocumented)
+	href?: string;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	relatedExternalLinks?: string;
+	// (undocumented)
+	status?: string;
+	// (undocumented)
+	title?: string;
+	// (undocumented)
+	type?: WHATS_NEW_ITEM_TYPES;
 }
 
 // @public (undocumented)
 interface whatsNewSearchResult {
-  // (undocumented)
-  articles: WhatsNewArticleItem[];
-  // (undocumented)
-  hasNextPage: boolean;
-  // (undocumented)
-  nextPage: string;
+	// (undocumented)
+	articles: WhatsNewArticleItem[];
+	// (undocumented)
+	hasNextPage: boolean;
+	// (undocumented)
+	nextPage: string;
 }
 
 // (No @packageDocumentation comment for this package)
@@ -427,10 +414,10 @@ interface whatsNewSearchResult {
 
 ```json
 {
-  "react": "^16.8.0",
-  "react-dom": "^16.8.0",
-  "react-intl-next": "npm:react-intl@^5.18.1",
-  "styled-components": "^3.2.6"
+	"react": "^16.8.0",
+	"react-dom": "^16.8.0",
+	"react-intl-next": "npm:react-intl@^5.18.1",
+	"styled-components": "^3.2.6"
 }
 ```