@atlaskit/help 7.2.0 → 7.2.1

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

@@ -0,0 +1,300 @@
+## API Report File for "@atlaskit/help"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import type { AdfDoc } from '@atlaskit/help-article';
+import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
+import { ClassAttributes } from 'react';
+import { DetailedHTMLProps } from 'react';
+import { HTMLAttributes } from 'react';
+import { NotificationLogProvider } from '@atlaskit/notification-log-client';
+import { default as React_2 } from 'react';
+import { StyledComponent } from '@emotion/styled-base';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+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 interface Article extends ArticleItem {
+    // (undocumented)
+    body: AdfDoc | string;
+    // (undocumented)
+    bodyFormat?: BODY_FORMAT_TYPES;
+    // (undocumented)
+    relatedArticles?: ArticleItem[];
+}
+
+// @public (undocumented)
+export enum ARTICLE_ITEM_TYPES {
+    // (undocumented)
+    topicInProduct = "topicInProduct"
+}
+
+// @public (undocumented)
+export enum ARTICLE_TYPE {
+    // (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;
+}
+
+// @public (undocumented)
+export interface articleId {
+    // (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;
+}
+
+// @public (undocumented)
+export const ArticlesListItem: React_2.FC<WithIntlProps<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>>;
+export default _default;
+
+// @public (undocumented)
+export const DividerLine: StyledComponent<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>;
+    };
+}
+
+// @public (undocumented)
+export const HelpContentButton: ({ 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;
+}
+
+// @public (undocumented)
+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;
+};
+
+// @public (undocumented)
+interface Props_3 {
+    // (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';
+}
+
+// @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>>;
+
+// @public (undocumented)
+enum REQUEST_STATE {
+    // (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"
+}
+
+// @public (undocumented)
+export interface WhatsNewArticle extends WhatsNewArticleItem {
+    // (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;
+}
+
+// @public (undocumented)
+interface whatsNewSearchResult {
+    // (undocumented)
+    articles: WhatsNewArticleItem[];
+    // (undocumented)
+    hasNextPage: boolean;
+    // (undocumented)
+    nextPage: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```