@atlaskit/help 7.1.16 → 7.1.18

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 (120) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/version.json +1 -1
  3. package/dist/es2019/version.json +1 -1
  4. package/dist/esm/version.json +1 -1
  5. package/package.json +2 -10
  6. package/dist/types-ts4.0/analytics.d.ts +0 -10
  7. package/dist/types-ts4.0/assets/ErrorImage.d.ts +0 -3
  8. package/dist/types-ts4.0/assets/NotFoundImage.d.ts +0 -3
  9. package/dist/types-ts4.0/assets/SomethingWrongImage.d.ts +0 -3
  10. package/dist/types-ts4.0/assets/WhatsNewIcoExperiment.d.ts +0 -2
  11. package/dist/types-ts4.0/assets/WhatsNewIcoExperiment.svg +0 -5
  12. package/dist/types-ts4.0/assets/WhatsNewIconFix.d.ts +0 -2
  13. package/dist/types-ts4.0/assets/WhatsNewIconFix.svg +0 -5
  14. package/dist/types-ts4.0/assets/WhatsNewIconImprovement.d.ts +0 -2
  15. package/dist/types-ts4.0/assets/WhatsNewIconImprovement.svg +0 -3
  16. package/dist/types-ts4.0/assets/WhatsNewIconNew.d.ts +0 -2
  17. package/dist/types-ts4.0/assets/WhatsNewIconNew.svg +0 -3
  18. package/dist/types-ts4.0/assets/WhatsNewIconRemoved.d.ts +0 -2
  19. package/dist/types-ts4.0/assets/WhatsNewIconRemoved.svg +0 -3
  20. package/dist/types-ts4.0/components/Article/ArticleContent/index.d.ts +0 -10
  21. package/dist/types-ts4.0/components/Article/ArticleLoadingFail/index.d.ts +0 -11
  22. package/dist/types-ts4.0/components/Article/ArticleLoadingFail/styled.d.ts +0 -3
  23. package/dist/types-ts4.0/components/Article/HelpArticle/Loading/index.d.ts +0 -7
  24. package/dist/types-ts4.0/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.d.ts +0 -12
  25. package/dist/types-ts4.0/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.d.ts +0 -12
  26. package/dist/types-ts4.0/components/Article/HelpArticle/WasHelpfulForm/index.d.ts +0 -14
  27. package/dist/types-ts4.0/components/Article/HelpArticle/WasHelpfulForm/styled.d.ts +0 -5
  28. package/dist/types-ts4.0/components/Article/HelpArticle/index.d.ts +0 -8
  29. package/dist/types-ts4.0/components/Article/WhatsNewArticle/Loading/index.d.ts +0 -7
  30. package/dist/types-ts4.0/components/Article/WhatsNewArticle/index.d.ts +0 -12
  31. package/dist/types-ts4.0/components/Article/WhatsNewArticle/styled.d.ts +0 -7
  32. package/dist/types-ts4.0/components/Article/index.d.ts +0 -3
  33. package/dist/types-ts4.0/components/Article/styled.d.ts +0 -3
  34. package/dist/types-ts4.0/components/ArticlesList/ArticlesList.d.ts +0 -7
  35. package/dist/types-ts4.0/components/ArticlesList/ArticlesListItem/index.d.ts +0 -13
  36. package/dist/types-ts4.0/components/ArticlesList/ArticlesListItem/styled.d.ts +0 -11
  37. package/dist/types-ts4.0/components/ArticlesList/constants.d.ts +0 -2
  38. package/dist/types-ts4.0/components/ArticlesList/index.d.ts +0 -4
  39. package/dist/types-ts4.0/components/ArticlesList/model/ArticlesListItem.d.ts +0 -11
  40. package/dist/types-ts4.0/components/ArticlesList/styled.d.ts +0 -5
  41. package/dist/types-ts4.0/components/Help.d.ts +0 -9
  42. package/dist/types-ts4.0/components/HelpContent.d.ts +0 -6
  43. package/dist/types-ts4.0/components/HelpContentButton/index.d.ts +0 -15
  44. package/dist/types-ts4.0/components/HelpContentButton/styled.d.ts +0 -7
  45. package/dist/types-ts4.0/components/MessagesIntlProvider.d.ts +0 -11
  46. package/dist/types-ts4.0/components/RelatedArticles/RelatedArticlesLoading.d.ts +0 -6
  47. package/dist/types-ts4.0/components/RelatedArticles/index.d.ts +0 -19
  48. package/dist/types-ts4.0/components/RelatedArticles/styled.d.ts +0 -10
  49. package/dist/types-ts4.0/components/Search/SearchInput/index.d.ts +0 -7
  50. package/dist/types-ts4.0/components/Search/SearchInput/styled.d.ts +0 -4
  51. package/dist/types-ts4.0/components/Search/SearchResults/SearchExternalSite.d.ts +0 -12
  52. package/dist/types-ts4.0/components/Search/SearchResults/SearchResults.d.ts +0 -9
  53. package/dist/types-ts4.0/components/Search/SearchResults/SearchResultsEmpty.d.ts +0 -12
  54. package/dist/types-ts4.0/components/Search/SearchResults/SearchResultsError.d.ts +0 -10
  55. package/dist/types-ts4.0/components/Search/SearchResults/index.d.ts +0 -3
  56. package/dist/types-ts4.0/components/Search/SearchResults/styled.d.ts +0 -6
  57. package/dist/types-ts4.0/components/ShowMoreButton/index.d.ts +0 -16
  58. package/dist/types-ts4.0/components/WhatsNew/WhatsNewButton/index.d.ts +0 -10
  59. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsEmpty/index.d.ts +0 -10
  60. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsEmpty/styled.d.ts +0 -3
  61. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsError/index.d.ts +0 -11
  62. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsError/styled.d.ts +0 -3
  63. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.d.ts +0 -13
  64. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/styled.d.ts +0 -9
  65. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultsList.d.ts +0 -7
  66. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/index.d.ts +0 -4
  67. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/model/WhatsNewResultsList.d.ts +0 -12
  68. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/styled.d.ts +0 -7
  69. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsLoading/index.d.ts +0 -7
  70. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/WhatsNewResultsLoading/styled.d.ts +0 -6
  71. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/index.d.ts +0 -7
  72. package/dist/types-ts4.0/components/WhatsNew/WhatsNewResults/styled.d.ts +0 -5
  73. package/dist/types-ts4.0/components/constants.d.ts +0 -20
  74. package/dist/types-ts4.0/components/contexts/headerContext.d.ts +0 -9
  75. package/dist/types-ts4.0/components/contexts/helpArticleContext.d.ts +0 -13
  76. package/dist/types-ts4.0/components/contexts/homeContext.d.ts +0 -8
  77. package/dist/types-ts4.0/components/contexts/navigationContext.d.ts +0 -36
  78. package/dist/types-ts4.0/components/contexts/relatedArticlesContext.d.ts +0 -12
  79. package/dist/types-ts4.0/components/contexts/searchContext.d.ts +0 -25
  80. package/dist/types-ts4.0/components/contexts/whatsNewArticleContext.d.ts +0 -26
  81. package/dist/types-ts4.0/components/styled.d.ts +0 -13
  82. package/dist/types-ts4.0/i18n/cs.d.ts +0 -2
  83. package/dist/types-ts4.0/i18n/da.d.ts +0 -2
  84. package/dist/types-ts4.0/i18n/de.d.ts +0 -2
  85. package/dist/types-ts4.0/i18n/en.d.ts +0 -2
  86. package/dist/types-ts4.0/i18n/en_GB.d.ts +0 -2
  87. package/dist/types-ts4.0/i18n/es.d.ts +0 -4
  88. package/dist/types-ts4.0/i18n/et.d.ts +0 -2
  89. package/dist/types-ts4.0/i18n/fi.d.ts +0 -2
  90. package/dist/types-ts4.0/i18n/fr.d.ts +0 -2
  91. package/dist/types-ts4.0/i18n/hu.d.ts +0 -2
  92. package/dist/types-ts4.0/i18n/index.d.ts +0 -24
  93. package/dist/types-ts4.0/i18n/is.d.ts +0 -2
  94. package/dist/types-ts4.0/i18n/it.d.ts +0 -2
  95. package/dist/types-ts4.0/i18n/ja.d.ts +0 -2
  96. package/dist/types-ts4.0/i18n/ko.d.ts +0 -2
  97. package/dist/types-ts4.0/i18n/languages.d.ts +0 -27
  98. package/dist/types-ts4.0/i18n/nb.d.ts +0 -2
  99. package/dist/types-ts4.0/i18n/nl.d.ts +0 -2
  100. package/dist/types-ts4.0/i18n/pl.d.ts +0 -2
  101. package/dist/types-ts4.0/i18n/pt_BR.d.ts +0 -2
  102. package/dist/types-ts4.0/i18n/pt_PT.d.ts +0 -2
  103. package/dist/types-ts4.0/i18n/ro.d.ts +0 -2
  104. package/dist/types-ts4.0/i18n/ru.d.ts +0 -2
  105. package/dist/types-ts4.0/i18n/sk.d.ts +0 -2
  106. package/dist/types-ts4.0/i18n/sv.d.ts +0 -2
  107. package/dist/types-ts4.0/i18n/zh.d.ts +0 -2
  108. package/dist/types-ts4.0/index.d.ts +0 -11
  109. package/dist/types-ts4.0/messages.d.ts +0 -262
  110. package/dist/types-ts4.0/model/Article.d.ts +0 -30
  111. package/dist/types-ts4.0/model/Help.d.ts +0 -74
  112. package/dist/types-ts4.0/model/Requests.d.ts +0 -7
  113. package/dist/types-ts4.0/model/WhatsNew.d.ts +0 -29
  114. package/dist/types-ts4.0/util/hooks/cancellablePromise.d.ts +0 -7
  115. package/dist/types-ts4.0/util/hooks/ctx.d.ts +0 -5
  116. package/dist/types-ts4.0/util/hooks/previous.d.ts +0 -1
  117. package/dist/types-ts4.0/util/i18n-util.d.ts +0 -17
  118. package/dist/types-ts4.0/util/index.d.ts +0 -8
  119. package/dist/types-ts4.0/util/styled.d.ts +0 -29
  120. package/dist/types-ts4.0/util/testing/mock.d.ts +0 -8
@@ -1,25 +0,0 @@
1
- import React from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { ArticleItem } from '../../model/Article';
4
- import { REQUEST_STATE } from '../../model/Requests';
5
- interface SearchSharedInterface {
6
- onSearchInputChanged?(event: React.KeyboardEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent, value: string): void;
7
- onSearchInputCleared?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
8
- onSearchExternalUrlClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
9
- searchExternalUrl?: string;
10
- }
11
- export interface SearchContextInterface extends SearchSharedInterface {
12
- onSearch?(value?: string): void;
13
- onSearchResultItemClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem): void;
14
- isSearchResultVisible: boolean;
15
- searchResult: ArticleItem[] | null;
16
- searchState: REQUEST_STATE;
17
- searchValue: string;
18
- }
19
- export interface SearchProviderInterface extends SearchSharedInterface {
20
- onSearch?(value: string): Promise<ArticleItem[]>;
21
- onSearchResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem): void;
22
- }
23
- export declare const useSearchContext: () => SearchContextInterface, CtxProvider: React.Provider<SearchContextInterface | undefined>;
24
- export declare const SearchContextProvider: React.FC<SearchProviderInterface>;
25
- export {};
@@ -1,26 +0,0 @@
1
- import React from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { NotificationLogProvider } from '@atlaskit/notification-log-client';
4
- import { WhatsNewArticleItem, WhatsNewArticle, whatsNewSearchResult } from '../../model/WhatsNew';
5
- import { REQUEST_STATE } from '../../model/Requests';
6
- import { articleId } from '../../model/Help';
7
- import { WHATS_NEW_ITEM_TYPES } from '../../model/WhatsNew';
8
- interface WhatsNewArticleSharedInterface {
9
- whatsNewGetNotificationProvider?: Promise<NotificationLogProvider>;
10
- productName?: string;
11
- onWhatsNewButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
12
- onWhatsNewResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, whatsNewArticleData: WhatsNewArticleItem): void;
13
- onSearchWhatsNewArticlesShowMoreClick?(event: React.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent): void;
14
- onGetWhatsNewArticle?(id: articleId): Promise<WhatsNewArticle>;
15
- }
16
- interface WhatsNewArticleContextInterface extends WhatsNewArticleSharedInterface {
17
- onSearchWhatsNewArticles?(filter?: WHATS_NEW_ITEM_TYPES | '', numberOfItems?: number, page?: string): Promise<void>;
18
- searchWhatsNewArticlesState: REQUEST_STATE;
19
- searchWhatsNewArticlesResult: whatsNewSearchResult | null;
20
- }
21
- interface WhatsNewArticleProviderInterface extends WhatsNewArticleSharedInterface {
22
- onSearchWhatsNewArticles?(filter?: WHATS_NEW_ITEM_TYPES | '', numberOfItems?: number, page?: string): Promise<whatsNewSearchResult>;
23
- }
24
- export declare const useWhatsNewArticleContext: () => WhatsNewArticleContextInterface, CtxProvider: React.Provider<WhatsNewArticleContextInterface | undefined>;
25
- export declare const WhatsNewArticleProvider: React.FC<WhatsNewArticleProviderInterface>;
26
- export {};
@@ -1,13 +0,0 @@
1
- /// <reference types="react" />
2
- /** @jsx jsx */
3
- declare type HelpBodyProps = {
4
- isOverlayVisible?: boolean;
5
- };
6
- export declare const HelpBodyContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, HelpBodyProps, object>;
7
- export declare const HelpBody: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, HelpBodyProps, object>;
8
- declare type HomeProps = {
9
- isOverlayFullyVisible?: boolean;
10
- isOverlayVisible?: boolean;
11
- };
12
- export declare const Home: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, HomeProps, object>;
13
- export {};
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,4 +0,0 @@
1
- declare const _default: {
2
- 'global_help.header': string;
3
- };
4
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,24 +0,0 @@
1
- export { default as zh } from './zh';
2
- export { default as cs } from './cs';
3
- export { default as da } from './da';
4
- export { default as nl } from './nl';
5
- export { default as en } from './en';
6
- export { default as en_GB } from './en_GB';
7
- export { default as et } from './et';
8
- export { default as fi } from './fi';
9
- export { default as fr } from './fr';
10
- export { default as de } from './de';
11
- export { default as hu } from './hu';
12
- export { default as is } from './is';
13
- export { default as it } from './it';
14
- export { default as ja } from './ja';
15
- export { default as ko } from './ko';
16
- export { default as nb } from './nb';
17
- export { default as pl } from './pl';
18
- export { default as pt_BR } from './pt_BR';
19
- export { default as pt_PT } from './pt_PT';
20
- export { default as ro } from './ro';
21
- export { default as ru } from './ru';
22
- export { default as sk } from './sk';
23
- export { default as es } from './es';
24
- export { default as sv } from './sv';
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,27 +0,0 @@
1
- declare const _default: {
2
- zh: string;
3
- cs: string;
4
- da: string;
5
- nl: string;
6
- en: string;
7
- en_GB: string;
8
- et: string;
9
- fi: string;
10
- fr: string;
11
- de: string;
12
- hu: string;
13
- is: string;
14
- it: string;
15
- ja: string;
16
- ko: string;
17
- nb: string;
18
- pl: string;
19
- pt_BR: string;
20
- pt_PT: string;
21
- ro: string;
22
- ru: string;
23
- sk: string;
24
- es: string;
25
- sv: string;
26
- };
27
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,2 +0,0 @@
1
- declare const _default: {};
2
- export default _default;
@@ -1,11 +0,0 @@
1
- export { default } from './components/Help';
2
- export { default as ArticlesListItem } from './components/ArticlesList/ArticlesListItem';
3
- export { default as RelatedArticles } from './components/RelatedArticles';
4
- export { default as HelpContentButton } from './components/HelpContentButton';
5
- export { DividerLine } from './util/styled';
6
- export { ARTICLE_TYPE } from './model/Help';
7
- export { ARTICLE_ITEM_TYPES } from './model/Article';
8
- export type { Help, HistoryItem, articleId } from './model/Help';
9
- export type { Article, ArticleItem, ArticleFeedback } from './model/Article';
10
- export { WHATS_NEW_ITEM_TYPES } from './model/WhatsNew';
11
- export type { WhatsNewArticle, WhatsNewArticleItem } from './model/WhatsNew';
@@ -1,262 +0,0 @@
1
- export declare const messages: {
2
- help_loading: {
3
- id: string;
4
- defaultMessage: string;
5
- description: string;
6
- };
7
- help_header: {
8
- id: string;
9
- defaultMessage: string;
10
- description: string;
11
- };
12
- help_header_whats_new: {
13
- id: string;
14
- defaultMessage: string;
15
- description: string;
16
- };
17
- help_close: {
18
- id: string;
19
- defaultMessage: string;
20
- description: string;
21
- };
22
- help_navigation_back: {
23
- id: string;
24
- defaultMessage: string;
25
- description: string;
26
- };
27
- help_search_placeholder: {
28
- id: string;
29
- defaultMessage: string;
30
- description: string;
31
- };
32
- help_article_rating_title: {
33
- id: string;
34
- defaultMessage: string;
35
- description: string;
36
- };
37
- help_article_rating_option_yes: {
38
- id: string;
39
- defaultMessage: string;
40
- description: string;
41
- };
42
- help_article_rating_option_no: {
43
- id: string;
44
- defaultMessage: string;
45
- description: string;
46
- };
47
- help_article_rating_form_title: {
48
- id: string;
49
- defaultMessage: string;
50
- description: string;
51
- };
52
- help_article_rating_accurate: {
53
- id: string;
54
- defaultMessage: string;
55
- description: string;
56
- };
57
- help_article_rating_clear: {
58
- id: string;
59
- defaultMessage: string;
60
- description: string;
61
- };
62
- help_article_rating_relevant: {
63
- id: string;
64
- defaultMessage: string;
65
- description: string;
66
- };
67
- help_article_rating_form_submit: {
68
- id: string;
69
- defaultMessage: string;
70
- description: string;
71
- };
72
- help_article_rating_form_Success: {
73
- id: string;
74
- defaultMessage: string;
75
- description: string;
76
- };
77
- help_article_rating_form_failed: {
78
- id: string;
79
- defaultMessage: string;
80
- description: string;
81
- };
82
- help_article_rating_form_failed_try_again: {
83
- id: string;
84
- defaultMessage: string;
85
- description: string;
86
- };
87
- help_article_rating_form_cancel: {
88
- id: string;
89
- defaultMessage: string;
90
- description: string;
91
- };
92
- help_article_rating_form_contact_me: {
93
- id: string;
94
- defaultMessage: string;
95
- description: string;
96
- };
97
- help_article_list_item_type_whats_new: {
98
- id: string;
99
- defaultMessage: string;
100
- description: string;
101
- };
102
- help_article_list_item_type_help_article: {
103
- id: string;
104
- defaultMessage: string;
105
- description: string;
106
- };
107
- help_related_article_title: {
108
- id: string;
109
- defaultMessage: string;
110
- description: string;
111
- };
112
- help_related_article_endpoint_error_title: {
113
- id: string;
114
- defaultMessage: string;
115
- description: string;
116
- };
117
- help_related_article_endpoint_error_description: {
118
- id: string;
119
- defaultMessage: string;
120
- description: string;
121
- };
122
- help_related_article_endpoint_error_button_label: {
123
- id: string;
124
- defaultMessage: string;
125
- description: string;
126
- };
127
- help_search_results_search_external_site: {
128
- id: string;
129
- defaultMessage: string;
130
- description: string;
131
- };
132
- help_search_results_no_results: {
133
- id: string;
134
- defaultMessage: string;
135
- description: string;
136
- };
137
- help_search_results_no_results_line_two: {
138
- id: string;
139
- defaultMessage: string;
140
- description: string;
141
- };
142
- help_search_results_external_site_link: {
143
- id: string;
144
- defaultMessage: string;
145
- description: string;
146
- };
147
- help_article_error_title: {
148
- id: string;
149
- defaultMessage: string;
150
- description: string;
151
- };
152
- help_article_error_text: {
153
- id: string;
154
- defaultMessage: string;
155
- description: string;
156
- };
157
- help_article_error_button_label: {
158
- id: string;
159
- defaultMessage: string;
160
- description: string;
161
- };
162
- help_search_error: {
163
- id: string;
164
- defaultMessage: string;
165
- description: string;
166
- };
167
- help_search_error_line_two: {
168
- id: string;
169
- defaultMessage: string;
170
- description: string;
171
- };
172
- help_search_error_button_label: {
173
- id: string;
174
- defaultMessage: string;
175
- description: string;
176
- };
177
- help_whats_new_button_label: {
178
- id: string;
179
- defaultMessage: string;
180
- description: string;
181
- };
182
- help_whats_new_button_label_without_product_name: {
183
- id: string;
184
- defaultMessage: string;
185
- description: string;
186
- };
187
- help_whats_new_button_tooltip: {
188
- id: string;
189
- defaultMessage: string;
190
- description: string;
191
- };
192
- help_whats_new_filter_select_option_all: {
193
- id: string;
194
- defaultMessage: string;
195
- description: string;
196
- };
197
- help_whats_new_filter_select_option_new: {
198
- id: string;
199
- defaultMessage: string;
200
- description: string;
201
- };
202
- help_whats_new_filter_select_option_improvement: {
203
- id: string;
204
- defaultMessage: string;
205
- description: string;
206
- };
207
- help_whats_new_filter_select_option_fix: {
208
- id: string;
209
- defaultMessage: string;
210
- description: string;
211
- };
212
- help_whats_new_filter_select_option_removed: {
213
- id: string;
214
- defaultMessage: string;
215
- description: string;
216
- };
217
- help_whats_new_filter_select_option_experiment: {
218
- id: string;
219
- defaultMessage: string;
220
- description: string;
221
- };
222
- help_whats_new_no_results: {
223
- id: string;
224
- defaultMessage: string;
225
- description: string;
226
- };
227
- help_whats_new_no_results_info: {
228
- id: string;
229
- defaultMessage: string;
230
- description: string;
231
- };
232
- help_whats_new_no_results_clear_filter_button_label: {
233
- id: string;
234
- defaultMessage: string;
235
- description: string;
236
- };
237
- help_whats_new_no_results_clear_filter_info: {
238
- id: string;
239
- defaultMessage: string;
240
- description: string;
241
- };
242
- help_whats_new_related_link_support: {
243
- id: string;
244
- defaultMessage: string;
245
- description: string;
246
- };
247
- help_whats_new_related_link_community: {
248
- id: string;
249
- defaultMessage: string;
250
- description: string;
251
- };
252
- help_show_more_button_label_more: {
253
- id: string;
254
- defaultMessage: string;
255
- description: string;
256
- };
257
- help_show_more_button_label_less: {
258
- id: string;
259
- defaultMessage: string;
260
- description: string;
261
- };
262
- };
@@ -1,30 +0,0 @@
1
- import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
2
- import type { AdfDoc } from '@atlaskit/help-article';
3
- export interface Article extends ArticleItem {
4
- body: string | AdfDoc;
5
- bodyFormat?: BODY_FORMAT_TYPES;
6
- relatedArticles?: ArticleItem[];
7
- }
8
- export declare enum ARTICLE_ITEM_TYPES {
9
- topicInProduct = "topicInProduct"
10
- }
11
- export interface ArticleItem {
12
- description?: string;
13
- id: string;
14
- lastPublished: string;
15
- title: string;
16
- type: ARTICLE_ITEM_TYPES;
17
- routes?: {
18
- routeName: string;
19
- routeGroup: string;
20
- }[];
21
- topicId?: string;
22
- productName?: string;
23
- href?: string;
24
- }
25
- export interface ArticleFeedback {
26
- wasHelpful: boolean;
27
- feedbackReason: string;
28
- feedbackReasonText: string;
29
- contactMe: boolean;
30
- }
@@ -1,74 +0,0 @@
1
- /// <reference types="react" />
2
- import { Article, ArticleItem, ArticleFeedback } from './Article';
3
- import { WhatsNewArticleItem, WhatsNewArticle, WHATS_NEW_ITEM_TYPES, whatsNewSearchResult } from './WhatsNew';
4
- import { REQUEST_STATE } from './Requests';
5
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
6
- import { NotificationLogProvider } from '@atlaskit/notification-log-client';
7
- import type { Props as HelpContentButtonProps } from '../components/HelpContentButton';
8
- export declare enum ARTICLE_TYPE {
9
- HELP_ARTICLE = "HELP_ARTICLE",
10
- WHATS_NEW = "WHATS_NEW"
11
- }
12
- export interface HistoryItem {
13
- uid: number;
14
- id: string;
15
- state: REQUEST_STATE;
16
- type: ARTICLE_TYPE;
17
- article?: Article | WhatsNewArticle;
18
- }
19
- export interface articleId {
20
- id: string;
21
- type: ARTICLE_TYPE;
22
- }
23
- export interface Help {
24
- header?: {
25
- onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
26
- onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
27
- };
28
- footer?: React.ReactNode;
29
- home?: {
30
- homeOptions?: HelpContentButtonProps[];
31
- };
32
- search?: {
33
- onSearch?(value: string): Promise<ArticleItem[]>;
34
- onSearchInputChanged?(event: React.KeyboardEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent, value: string): void;
35
- onSearchInputCleared?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
36
- onSearchResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem): void;
37
- onSearchExternalUrlClick?(event?: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
38
- searchExternalUrl?: string;
39
- };
40
- navigation?: {
41
- navigationData?: {
42
- articleId: articleId;
43
- history: HistoryItem[];
44
- };
45
- setNavigationData?(navigationData: {
46
- articleId?: articleId;
47
- history?: HistoryItem[];
48
- }): void;
49
- };
50
- helpArticle?: {
51
- onGetHelpArticle?(articleId: articleId): Promise<Article>;
52
- onHelpArticleLoadingFailTryAgainButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleId: articleId): void;
53
- onWasHelpfulSubmit?(analyticsEvent: UIAnalyticsEvent, articleFeedback: ArticleFeedback, articleData: ArticleItem): Promise<boolean>;
54
- onWasHelpfulYesButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, ArticleItem: ArticleItem): void;
55
- onWasHelpfulNoButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, ArticleItem: ArticleItem): void;
56
- };
57
- relatedArticles?: {
58
- routeGroup?: string;
59
- routeName?: string;
60
- onGetRelatedArticles?(routeGroup?: string, routeName?: string): Promise<ArticleItem[]>;
61
- onRelatedArticlesShowMoreClick?(event: React.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent, isCollapsed: boolean): void;
62
- onRelatedArticlesListItemClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem) => void;
63
- };
64
- whatsNew?: {
65
- whatsNewGetNotificationProvider?: Promise<NotificationLogProvider>;
66
- productName?: string;
67
- onWhatsNewButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
68
- onSearchWhatsNewArticles?(filter?: WHATS_NEW_ITEM_TYPES | '', numberOfItems?: number, page?: string): Promise<whatsNewSearchResult>;
69
- onWhatsNewResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, whatsNewArticleData: WhatsNewArticleItem): void;
70
- onSearchWhatsNewShowMoreClick?(event: React.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent): void;
71
- onGetWhatsNewArticle?(id: articleId): Promise<WhatsNewArticle>;
72
- };
73
- children?: React.ReactNode;
74
- }
@@ -1,7 +0,0 @@
1
- export declare enum REQUEST_STATE {
2
- done = "done",
3
- loading = "loading",
4
- load = "load",
5
- error = "error",
6
- reload = "reload"
7
- }
@@ -1,29 +0,0 @@
1
- import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
2
- import type { AdfDoc } from '@atlaskit/help-article';
3
- export declare enum WHATS_NEW_ITEM_TYPES {
4
- NEW_FEATURE = "Announcement",
5
- IMPROVEMENT = "Improvement",
6
- FIX = "Fix",
7
- REMOVED = "Removed",
8
- EXPERIMENT = "Experiment"
9
- }
10
- export interface WhatsNewArticle extends WhatsNewArticleItem {
11
- description: string | AdfDoc;
12
- bodyFormat?: BODY_FORMAT_TYPES;
13
- }
14
- export interface WhatsNewArticleItem {
15
- title?: string;
16
- changeTargetSchedule?: string;
17
- type?: WHATS_NEW_ITEM_TYPES;
18
- status?: string;
19
- featureRolloutDate?: string;
20
- relatedExternalLinks?: string;
21
- communityUrl?: string;
22
- href?: string;
23
- id: string;
24
- }
25
- export interface whatsNewSearchResult {
26
- articles: WhatsNewArticleItem[];
27
- nextPage: string;
28
- hasNextPage: boolean;
29
- }
@@ -1,7 +0,0 @@
1
- export declare function makeCancelable(promise: Promise<any>): {
2
- promise: Promise<unknown>;
3
- cancel(): void;
4
- };
5
- export default function useCancellablePromise(cancelable?: typeof makeCancelable): {
6
- cancellablePromise: (p: Promise<any>) => Promise<any>;
7
- };
@@ -1,5 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createCtx<ContextType>(): readonly [
3
- () => ContextType,
4
- import("react").Provider<ContextType | undefined>
5
- ];
@@ -1 +0,0 @@
1
- export declare function usePrevious(value: any): undefined;