@atlaskit/help 7.3.2 → 7.4.0

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 (63) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/dist/cjs/analytics.js +1 -1
  3. package/dist/cjs/components/Article/ArticleLoadingFail/index.js +1 -1
  4. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.js +1 -1
  5. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.js +1 -1
  6. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/index.js +1 -1
  7. package/dist/cjs/components/Article/HelpArticle/index.js +1 -1
  8. package/dist/cjs/components/Article/WhatsNewArticle/index.js +1 -1
  9. package/dist/cjs/components/ArticlesList/ArticlesList.js +8 -2
  10. package/dist/cjs/components/ArticlesList/ArticlesListItem/index.js +19 -4
  11. package/dist/cjs/components/ArticlesList/ArticlesListItem/styled.js +42 -8
  12. package/dist/cjs/components/HelpContentButton/index.js +1 -1
  13. package/dist/cjs/components/RelatedArticles/index.js +1 -1
  14. package/dist/cjs/components/Search/SearchInput/index.js +1 -1
  15. package/dist/cjs/components/WhatsNew/WhatsNewButton/index.js +1 -1
  16. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.js +1 -1
  17. package/dist/cjs/components/contexts/navigationContext.js +29 -10
  18. package/dist/cjs/components/contexts/searchContext.js +0 -3
  19. package/dist/es2019/analytics.js +1 -1
  20. package/dist/es2019/components/Article/ArticleLoadingFail/index.js +1 -1
  21. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.js +1 -1
  22. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.js +1 -1
  23. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/index.js +1 -1
  24. package/dist/es2019/components/Article/HelpArticle/index.js +1 -1
  25. package/dist/es2019/components/Article/WhatsNewArticle/index.js +1 -1
  26. package/dist/es2019/components/ArticlesList/ArticlesList.js +8 -2
  27. package/dist/es2019/components/ArticlesList/ArticlesListItem/index.js +20 -5
  28. package/dist/es2019/components/ArticlesList/ArticlesListItem/styled.js +41 -7
  29. package/dist/es2019/components/HelpContentButton/index.js +1 -1
  30. package/dist/es2019/components/RelatedArticles/index.js +1 -1
  31. package/dist/es2019/components/Search/SearchInput/index.js +1 -1
  32. package/dist/es2019/components/WhatsNew/WhatsNewButton/index.js +1 -1
  33. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.js +1 -1
  34. package/dist/es2019/components/contexts/navigationContext.js +29 -10
  35. package/dist/es2019/components/contexts/searchContext.js +0 -3
  36. package/dist/esm/analytics.js +1 -1
  37. package/dist/esm/components/Article/ArticleLoadingFail/index.js +1 -1
  38. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.js +1 -1
  39. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.js +1 -1
  40. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/index.js +1 -1
  41. package/dist/esm/components/Article/HelpArticle/index.js +1 -1
  42. package/dist/esm/components/Article/WhatsNewArticle/index.js +1 -1
  43. package/dist/esm/components/ArticlesList/ArticlesList.js +8 -2
  44. package/dist/esm/components/ArticlesList/ArticlesListItem/index.js +20 -5
  45. package/dist/esm/components/ArticlesList/ArticlesListItem/styled.js +41 -7
  46. package/dist/esm/components/HelpContentButton/index.js +1 -1
  47. package/dist/esm/components/RelatedArticles/index.js +1 -1
  48. package/dist/esm/components/Search/SearchInput/index.js +1 -1
  49. package/dist/esm/components/WhatsNew/WhatsNewButton/index.js +1 -1
  50. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.js +1 -1
  51. package/dist/esm/components/contexts/navigationContext.js +29 -10
  52. package/dist/esm/components/contexts/searchContext.js +0 -3
  53. package/dist/types/components/ArticlesList/ArticlesList.d.ts +1 -1
  54. package/dist/types/components/ArticlesList/ArticlesListItem/index.d.ts +3 -3
  55. package/dist/types/components/ArticlesList/ArticlesListItem/styled.d.ts +25 -1
  56. package/dist/types/components/contexts/navigationContext.d.ts +5 -5
  57. package/dist/types/model/Article.d.ts +6 -1
  58. package/dist/types-ts4.5/components/ArticlesList/ArticlesList.d.ts +1 -1
  59. package/dist/types-ts4.5/components/ArticlesList/ArticlesListItem/index.d.ts +3 -3
  60. package/dist/types-ts4.5/components/ArticlesList/ArticlesListItem/styled.d.ts +25 -1
  61. package/dist/types-ts4.5/components/contexts/navigationContext.d.ts +5 -5
  62. package/dist/types-ts4.5/model/Article.d.ts +6 -1
  63. package/package.json +5 -5
@@ -10,6 +10,10 @@ export declare const ArticlesListItemContainer: import("@emotion/styled").Styled
10
10
  theme?: import("@emotion/react").Theme | undefined;
11
11
  as?: import("react").ElementType<any> | undefined;
12
12
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
13
+ export declare const ArticlesListItemTitleSection: import("@emotion/styled").StyledComponent<{
14
+ theme?: import("@emotion/react").Theme | undefined;
15
+ as?: import("react").ElementType<any> | undefined;
16
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
13
17
  export declare const ArticlesListItemTypeTitle: import("@emotion/styled").StyledComponent<{
14
18
  theme?: import("@emotion/react").Theme | undefined;
15
19
  as?: import("react").ElementType<any> | undefined;
@@ -21,9 +25,29 @@ export declare const ArticlesListItemLinkIcon: import("@emotion/styled").StyledC
21
25
  export declare const ArticlesListItemTitleText: import("@emotion/styled").StyledComponent<{
22
26
  theme?: import("@emotion/react").Theme | undefined;
23
27
  as?: import("react").ElementType<any> | undefined;
24
- }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
28
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, {}>;
25
29
  export declare const ArticlesListItemDescription: import("@emotion/styled").StyledComponent<{
26
30
  theme?: import("@emotion/react").Theme | undefined;
27
31
  as?: import("react").ElementType<any> | undefined;
28
32
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, {}>;
33
+ export declare const ArticlesListItemSource: import("@emotion/styled").StyledComponent<{
34
+ theme?: import("@emotion/react").Theme | undefined;
35
+ as?: import("react").ElementType<any> | undefined;
36
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
37
+ export declare const ArticlesListItemTrustFactor: import("@emotion/styled").StyledComponent<{
38
+ theme?: import("@emotion/react").Theme | undefined;
39
+ as?: import("react").ElementType<any> | undefined;
40
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
41
+ export declare const ArticlesListItemViewCount: import("@emotion/styled").StyledComponent<{
42
+ theme?: import("@emotion/react").Theme | undefined;
43
+ as?: import("react").ElementType<any> | undefined;
44
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
45
+ export declare const ArticlesListItemHelpfulCount: import("@emotion/styled").StyledComponent<{
46
+ theme?: import("@emotion/react").Theme | undefined;
47
+ as?: import("react").ElementType<any> | undefined;
48
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
49
+ export declare const ArticlesListItemLastModified: import("@emotion/styled").StyledComponent<{
50
+ theme?: import("@emotion/react").Theme | undefined;
51
+ as?: import("react").ElementType<any> | undefined;
52
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
29
53
  export {};
@@ -1,8 +1,8 @@
1
- import React, { PropsWithChildren } from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { Article, ArticleItem } from '../../model/Article';
4
- import { WhatsNewArticleItem, WhatsNewArticle } from '../../model/WhatsNew';
5
- import { HistoryItem, articleId } from '../../model/Help';
1
+ import React, { type PropsWithChildren } from 'react';
2
+ import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ import { type Article, type ArticleItem } from '../../model/Article';
4
+ import { type WhatsNewArticleItem, type WhatsNewArticle } from '../../model/WhatsNew';
5
+ import { type HistoryItem, type articleId } from '../../model/Help';
6
6
  import { VIEW } from '../constants';
7
7
  type ViewType = keyof typeof VIEW;
8
8
  type NavigationProviderInterface = PropsWithChildren<{
@@ -1,4 +1,4 @@
1
- import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
1
+ import { type BODY_FORMAT_TYPES } from '@atlaskit/help-article';
2
2
  import type { AdfDoc } from '@atlaskit/help-article';
3
3
  export interface Article extends ArticleItem {
4
4
  body: string | AdfDoc;
@@ -21,6 +21,11 @@ export interface ArticleItem {
21
21
  topicId?: string;
22
22
  productName?: string;
23
23
  href?: string;
24
+ trustFactors?: {
25
+ numViews?: number;
26
+ helpfulCount?: number;
27
+ };
28
+ source?: string;
24
29
  }
25
30
  export interface ArticleFeedback {
26
31
  wasHelpful: boolean;
@@ -1,5 +1,5 @@
1
1
  import React from 'react';
2
- import { ArticlesList as ArticlesListInterface } from './model/ArticlesListItem';
2
+ import { type ArticlesList as ArticlesListInterface } from './model/ArticlesListItem';
3
3
  export interface Props {
4
4
  numberOfArticlesToDisplay?: number;
5
5
  }
@@ -1,7 +1,7 @@
1
1
  import React from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { WrappedComponentProps } from 'react-intl-next';
4
- import { ArticleItem } from '../../../model/Article';
2
+ import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ import { type WrappedComponentProps } from 'react-intl-next';
4
+ import { type ArticleItem } from '../../../model/Article';
5
5
  interface Props {
6
6
  styles?: {};
7
7
  onClick?: (event: React.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent) => void;
@@ -10,6 +10,10 @@ export declare const ArticlesListItemContainer: import("@emotion/styled").Styled
10
10
  theme?: import("@emotion/react").Theme | undefined;
11
11
  as?: import("react").ElementType<any> | undefined;
12
12
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
13
+ export declare const ArticlesListItemTitleSection: import("@emotion/styled").StyledComponent<{
14
+ theme?: import("@emotion/react").Theme | undefined;
15
+ as?: import("react").ElementType<any> | undefined;
16
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
13
17
  export declare const ArticlesListItemTypeTitle: import("@emotion/styled").StyledComponent<{
14
18
  theme?: import("@emotion/react").Theme | undefined;
15
19
  as?: import("react").ElementType<any> | undefined;
@@ -21,9 +25,29 @@ export declare const ArticlesListItemLinkIcon: import("@emotion/styled").StyledC
21
25
  export declare const ArticlesListItemTitleText: import("@emotion/styled").StyledComponent<{
22
26
  theme?: import("@emotion/react").Theme | undefined;
23
27
  as?: import("react").ElementType<any> | undefined;
24
- }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
28
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, {}>;
25
29
  export declare const ArticlesListItemDescription: import("@emotion/styled").StyledComponent<{
26
30
  theme?: import("@emotion/react").Theme | undefined;
27
31
  as?: import("react").ElementType<any> | undefined;
28
32
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, {}>;
33
+ export declare const ArticlesListItemSource: import("@emotion/styled").StyledComponent<{
34
+ theme?: import("@emotion/react").Theme | undefined;
35
+ as?: import("react").ElementType<any> | undefined;
36
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
37
+ export declare const ArticlesListItemTrustFactor: import("@emotion/styled").StyledComponent<{
38
+ theme?: import("@emotion/react").Theme | undefined;
39
+ as?: import("react").ElementType<any> | undefined;
40
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
41
+ export declare const ArticlesListItemViewCount: import("@emotion/styled").StyledComponent<{
42
+ theme?: import("@emotion/react").Theme | undefined;
43
+ as?: import("react").ElementType<any> | undefined;
44
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
45
+ export declare const ArticlesListItemHelpfulCount: import("@emotion/styled").StyledComponent<{
46
+ theme?: import("@emotion/react").Theme | undefined;
47
+ as?: import("react").ElementType<any> | undefined;
48
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, {}>;
49
+ export declare const ArticlesListItemLastModified: import("@emotion/styled").StyledComponent<{
50
+ theme?: import("@emotion/react").Theme | undefined;
51
+ as?: import("react").ElementType<any> | undefined;
52
+ }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
29
53
  export {};
@@ -1,8 +1,8 @@
1
- import React, { PropsWithChildren } from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { Article, ArticleItem } from '../../model/Article';
4
- import { WhatsNewArticleItem, WhatsNewArticle } from '../../model/WhatsNew';
5
- import { HistoryItem, articleId } from '../../model/Help';
1
+ import React, { type PropsWithChildren } from 'react';
2
+ import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ import { type Article, type ArticleItem } from '../../model/Article';
4
+ import { type WhatsNewArticleItem, type WhatsNewArticle } from '../../model/WhatsNew';
5
+ import { type HistoryItem, type articleId } from '../../model/Help';
6
6
  import { VIEW } from '../constants';
7
7
  type ViewType = keyof typeof VIEW;
8
8
  type NavigationProviderInterface = PropsWithChildren<{
@@ -1,4 +1,4 @@
1
- import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
1
+ import { type BODY_FORMAT_TYPES } from '@atlaskit/help-article';
2
2
  import type { AdfDoc } from '@atlaskit/help-article';
3
3
  export interface Article extends ArticleItem {
4
4
  body: string | AdfDoc;
@@ -21,6 +21,11 @@ export interface ArticleItem {
21
21
  topicId?: string;
22
22
  productName?: string;
23
23
  href?: string;
24
+ trustFactors?: {
25
+ numViews?: number;
26
+ helpfulCount?: number;
27
+ };
28
+ source?: string;
24
29
  }
25
30
  export interface ArticleFeedback {
26
31
  wasHelpful: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.3.2",
3
+ "version": "7.4.0",
4
4
  "description": "A cross-product help component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -44,10 +44,10 @@
44
44
  "@atlaskit/analytics-next": "^9.3.0",
45
45
  "@atlaskit/button": "^17.14.0",
46
46
  "@atlaskit/checkbox": "^13.3.0",
47
- "@atlaskit/form": "^10.0.0",
47
+ "@atlaskit/form": "^10.1.0",
48
48
  "@atlaskit/help-article": "^4.1.10",
49
49
  "@atlaskit/help-layout": "^4.2.15",
50
- "@atlaskit/icon": "^22.1.0",
50
+ "@atlaskit/icon": "^22.2.0",
51
51
  "@atlaskit/notification-indicator": "^9.2.0",
52
52
  "@atlaskit/notification-log-client": "^6.1.0",
53
53
  "@atlaskit/radio": "^6.3.0",
@@ -57,8 +57,8 @@
57
57
  "@atlaskit/textarea": "^5.4.0",
58
58
  "@atlaskit/textfield": "^6.3.0",
59
59
  "@atlaskit/theme": "^12.8.0",
60
- "@atlaskit/tokens": "^1.47.0",
61
- "@atlaskit/tooltip": "^18.3.0",
60
+ "@atlaskit/tokens": "^1.48.0",
61
+ "@atlaskit/tooltip": "^18.4.0",
62
62
  "@babel/runtime": "^7.0.0",
63
63
  "@emotion/react": "^11.7.1",
64
64
  "@emotion/styled": "^11.0.0",