@atlaskit/help 7.1.27 → 7.2.1

package/dist/types-ts4.0/model/Help.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="react" />
+import { Article, ArticleItem, ArticleFeedback } from './Article';
+import { WhatsNewArticleItem, WhatsNewArticle, WHATS_NEW_ITEM_TYPES, whatsNewSearchResult } from './WhatsNew';
+import { REQUEST_STATE } from './Requests';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { NotificationLogProvider } from '@atlaskit/notification-log-client';
+import type { Props as HelpContentButtonProps } from '../components/HelpContentButton';
+export declare enum ARTICLE_TYPE {
+    HELP_ARTICLE = "HELP_ARTICLE",
+    WHATS_NEW = "WHATS_NEW"
+}
+export interface HistoryItem {
+    uid: number;
+    id: string;
+    state: REQUEST_STATE;
+    type: ARTICLE_TYPE;
+    article?: Article | WhatsNewArticle;
+}
+export interface articleId {
+    id: string;
+    type: ARTICLE_TYPE;
+}
+export interface Help {
+    header?: {
+        onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+        onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    };
+    footer?: React.ReactNode;
+    home?: {
+        homeOptions?: HelpContentButtonProps[];
+    };
+    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;
+    };
+    navigation?: {
+        navigationData?: {
+            articleId: articleId;
+            history: HistoryItem[];
+        };
+        setNavigationData?(navigationData: {
+            articleId?: articleId;
+            history?: HistoryItem[];
+        }): void;
+    };
+    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;
+    };
+    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;
+    };
+    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>;
+    };
+    children?: React.ReactNode;
+}

package/dist/types-ts4.0/model/Requests.d.ts

@@ -0,0 +1,7 @@
+export declare enum REQUEST_STATE {
+    done = "done",
+    loading = "loading",
+    load = "load",
+    error = "error",
+    reload = "reload"
+}

package/dist/types-ts4.0/model/WhatsNew.d.ts

@@ -0,0 +1,29 @@
+import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
+import type { AdfDoc } from '@atlaskit/help-article';
+export declare enum WHATS_NEW_ITEM_TYPES {
+    NEW_FEATURE = "Announcement",
+    IMPROVEMENT = "Improvement",
+    FIX = "Fix",
+    REMOVED = "Removed",
+    EXPERIMENT = "Experiment"
+}
+export interface WhatsNewArticle extends WhatsNewArticleItem {
+    description: string | AdfDoc;
+    bodyFormat?: BODY_FORMAT_TYPES;
+}
+export interface WhatsNewArticleItem {
+    title?: string;
+    changeTargetSchedule?: string;
+    type?: WHATS_NEW_ITEM_TYPES;
+    status?: string;
+    featureRolloutDate?: string;
+    relatedExternalLinks?: string;
+    communityUrl?: string;
+    href?: string;
+    id: string;
+}
+export interface whatsNewSearchResult {
+    articles: WhatsNewArticleItem[];
+    nextPage: string;
+    hasNextPage: boolean;
+}

package/dist/types-ts4.0/util/hooks/cancellablePromise.d.ts

@@ -0,0 +1,7 @@
+export declare function makeCancelable(promise: Promise<any>): {
+    promise: Promise<unknown>;
+    cancel(): void;
+};
+export default function useCancellablePromise(cancelable?: typeof makeCancelable): {
+    cancellablePromise: (p: Promise<any>) => Promise<any>;
+};

package/dist/types-ts4.0/util/hooks/ctx.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare function createCtx<ContextType>(): readonly [
+    () => ContextType,
+    import("react").Provider<ContextType | undefined>
+];

package/dist/types-ts4.0/util/hooks/previous.d.ts

@@ -0,0 +1 @@
+export declare function usePrevious(value: any): undefined;

package/dist/types-ts4.0/util/i18n-util.d.ts

@@ -0,0 +1,17 @@
+declare type LanguageCode = 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'en_GB' | 'et' | 'fi' | 'fr' | 'de' | 'hu' | 'is' | 'it' | 'ja' | 'ko' | 'nb' | 'pl' | 'pt_BR' | 'pt_PT' | 'ro' | 'ru' | 'sk' | 'es' | 'sv';
+export declare type LangCode = LanguageCode | 'pt-BR' | 'pt-PT';
+declare type LocaleMessages = {
+    [key: string]: string;
+};
+/**
+ * Tries to get the most specific messages bundle for a given locale.
+ *
+ * Strategy:
+ * 1. Try to find messages with the exact string (i.e. 'fr_FR')
+ * 2. If that doesn't work, try to find messages for the country locale (i.e. 'fr')
+ * 3. If that doesn't work, return english messages as a fallback.
+ *
+ * @param locale string specifying the locale like 'en_GB', or 'fr'.
+ */
+export declare const getMessagesForLocale: (locale: LangCode) => LocaleMessages;
+export {};

package/dist/types-ts4.0/util/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { WHATS_NEW_ITEM_TYPES } from '../model/WhatsNew';
+export declare const getTypeIcon: (itemType?: WHATS_NEW_ITEM_TYPES | undefined) => "" | JSX.Element;
+export declare const getTypeTitle: (itemType: WHATS_NEW_ITEM_TYPES) => {
+    id: string;
+    defaultMessage: string;
+    description: string;
+};

package/dist/types-ts4.0/util/styled.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+/** @jsx jsx */
+import { WHATS_NEW_ITEM_TYPES } from '../model/WhatsNew';
+export declare const DividerLine: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
+/**
+ * Loading container
+ */
+declare type LoadingRectangleProps = {
+    contentWidth?: string;
+    contentHeight?: string;
+    marginTop?: string;
+};
+export declare const LoadingRectangle: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, LoadingRectangleProps, object>;
+/**
+ * Loading Circle
+ */
+declare type LoadingCircleProps = {
+    radius?: string;
+    marginTop?: string;
+};
+export declare const LoadingCircle: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, LoadingCircleProps, object>;
+/**
+ * What's new icon
+ */
+declare type WhatsNewTypeIconProps = {
+    type?: WHATS_NEW_ITEM_TYPES;
+};
+export declare const WhatsNewTypeIcon: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, WhatsNewTypeIconProps, object>;
+export {};

package/dist/types-ts4.0/util/testing/mock.d.ts

@@ -0,0 +1,8 @@
+import { Article, ArticleItem } from '../../model/Article';
+import { WHATS_NEW_ITEM_TYPES, WhatsNewArticleItem } from '../../model/WhatsNew';
+export declare const getMockArticle: (id: string, routeName?: string, routeGroup?: string, productName?: string, href?: string) => Article;
+export declare const getMockArticleItem: (id: string, routeName?: string, routeGroup?: string, productName?: string, href?: string) => ArticleItem;
+export declare const getMockArticleItemList: (numberOfItems: number) => ArticleItem[];
+export declare const getMockWhatsNewArticle: (id: string, routeName?: string, routeGroup?: string, productName?: string, href?: string) => Article;
+export declare const getMockWhatsNewArticleItem: (id: string, type?: WHATS_NEW_ITEM_TYPES | undefined, title?: string, description?: string, changeTargetSchedule?: string, status?: string, featureRolloutDate?: string, href?: string) => WhatsNewArticleItem;
+export declare const getMockWhatsNewArticleItemList: (numberOfItems: number) => WhatsNewArticleItem[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/help",
-  "version": "7.1.27",
+  "version": "7.2.1",
   "description": "A cross-product help component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,25 +26,25 @@
     "ak-postbuild": "ls -d dist/* | xargs -n 1 copyfiles -u 1 -V src/**/*.svg"
   },
   "dependencies": {
-    "@atlaskit/analytics": "^8.0.0",
-    "@atlaskit/analytics-next": "^9.0.0",
-    "@atlaskit/button": "^16.6.0",
-    "@atlaskit/checkbox": "^12.4.0",
-    "@atlaskit/form": "^8.8.0",
-    "@atlaskit/help-article": "^4.0.0",
-    "@atlaskit/help-layout": "^4.1.0",
-    "@atlaskit/icon": "^21.11.0",
-    "@atlaskit/notification-indicator": "^9.0.0",
-    "@atlaskit/notification-log-client": "^6.0.0",
-    "@atlaskit/radio": "^5.4.0",
-    "@atlaskit/section-message": "^6.3.0",
-    "@atlaskit/select": "^16.1.0",
-    "@atlaskit/spinner": "^15.4.0",
-    "@atlaskit/textarea": "^4.5.0",
-    "@atlaskit/textfield": "^5.3.0",
-    "@atlaskit/theme": "^12.3.0",
-    "@atlaskit/tokens": "^1.2.0",
-    "@atlaskit/tooltip": "^17.7.0",
+    "@atlaskit/analytics": "^8.1.0",
+    "@atlaskit/analytics-next": "^9.1.0",
+    "@atlaskit/button": "^16.7.0",
+    "@atlaskit/checkbox": "^12.5.0",
+    "@atlaskit/form": "^8.11.0",
+    "@atlaskit/help-article": "^4.1.0",
+    "@atlaskit/help-layout": "^4.2.0",
+    "@atlaskit/icon": "^21.12.0",
+    "@atlaskit/notification-indicator": "^9.1.0",
+    "@atlaskit/notification-log-client": "^6.1.0",
+    "@atlaskit/radio": "^5.5.0",
+    "@atlaskit/section-message": "^6.4.0",
+    "@atlaskit/select": "^16.2.0",
+    "@atlaskit/spinner": "^15.5.0",
+    "@atlaskit/textarea": "^4.6.0",
+    "@atlaskit/textfield": "^5.4.0",
+    "@atlaskit/theme": "^12.5.0",
+    "@atlaskit/tokens": "^1.3.0",
+    "@atlaskit/tooltip": "^17.8.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/core": "^10.0.9",
     "@emotion/styled": "^10.0.7",
@@ -62,7 +62,7 @@
   "devDependencies": {
     "@atlaskit/docs": "*",
     "@atlaskit/navigation": "^37.0.0",
-    "@atlaskit/page": "^12.2.0",
+    "@atlaskit/page": "^12.3.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@testing-library/react": "^12.1.5",
     "algoliasearch": "^3.35.1",
@@ -80,7 +80,8 @@
   "techstack": {
     "@repo/internal": {
       "design-tokens": [
-        "color"
+        "color",
+        "spacing"
       ]
     }
   }