@atlaskit/help-article 4.4.0 → 5.0.1

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 (10) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/dist/types/components/ArticleBody/index.d.ts +2 -2
  3. package/dist/types/components/ArticleBody/styled.d.ts +1 -1
  4. package/dist/types/components/HelpArticle.d.ts +2 -2
  5. package/dist/types/components/styled.d.ts +3 -3
  6. package/dist/types-ts4.5/components/ArticleBody/index.d.ts +2 -2
  7. package/dist/types-ts4.5/components/ArticleBody/styled.d.ts +1 -1
  8. package/dist/types-ts4.5/components/HelpArticle.d.ts +2 -2
  9. package/dist/types-ts4.5/components/styled.d.ts +3 -3
  10. package/package.json +12 -10
package/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @atlaskit/help-article
2
2
 
3
+ ## 5.0.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#120533](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/120533)
8
+ [`f1bec731e278f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f1bec731e278f) -
9
+ Adds a `sideEffects` field to ensure this package does not have Compiled styles tree-shaken in the
10
+ future to avoid an accidental regression.
11
+
12
+ This is related to
13
+ https://community.developer.atlassian.com/t/rfc-73-migrating-our-components-to-compiled-css-in-js/85953
14
+
15
+ ## 5.0.0
16
+
17
+ ### Major Changes
18
+
19
+ - [#117363](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/117363)
20
+ [`10a0f7f6c2027`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/10a0f7f6c2027) -
21
+ This package's `peerDependencies` have been adjusted for `react` and/or `react-dom` to reflect the
22
+ status of only supporting React 18 going forward. No explicit breaking change to React support has
23
+ been made in this release, but this is to signify going forward, breaking changes for React 16 or
24
+ React 17 may come via non-major semver releases.
25
+
26
+ Please refer this community post for more details:
27
+ https://community.developer.atlassian.com/t/rfc-78-dropping-support-for-react-16-and-rendering-in-a-react-18-concurrent-root-in-jira-and-confluence/87026
28
+
29
+ ### Patch Changes
30
+
31
+ - Updated dependencies
32
+
3
33
  ## 4.4.0
4
34
 
5
35
  ### Minor Changes
package/dist/types/components/ArticleBody/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import React from 'react';
2
2
  import { BODY_FORMAT_TYPES } from '../../model/HelpArticle';
3
3
  import type { AdfDoc } from '../../model/HelpArticle';
4
4
  export interface Props {
@@ -7,5 +7,5 @@ export interface Props {
7
7
  onArticleRenderBegin?(): void;
8
8
  onArticleRenderDone?(): void;
9
9
  }
10
- export declare const ArticleBody: (props: Props) => JSX.Element | null;
10
+ export declare const ArticleBody: (props: Props) => React.JSX.Element | null;
11
11
  export default ArticleBody;
package/dist/types/components/ArticleBody/styled.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /// <reference types="react" />
2
2
  export declare const ArticleFrame: import("@emotion/styled").StyledComponent<{
3
3
  theme?: import("@emotion/react").Theme | undefined;
4
- as?: import("react").ElementType<any> | undefined;
4
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
5
5
  }, import("react").DetailedHTMLProps<import("react").IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, {}>;
package/dist/types/components/HelpArticle.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import React from 'react';
2
2
  import type { HelpArticle as HelpArticleType } from '../model/HelpArticle';
3
- declare const HelpArticle: (props: HelpArticleType) => JSX.Element;
3
+ declare const HelpArticle: (props: HelpArticleType) => React.JSX.Element;
4
4
  export default HelpArticle;
package/dist/types/components/styled.d.ts CHANGED
@@ -1,13 +1,13 @@
1
1
  /// <reference types="react" />
2
2
  export declare const ArticleContentInner: import("@emotion/styled").StyledComponent<{
3
3
  theme?: import("@emotion/react").Theme | undefined;
4
- as?: import("react").ElementType<any> | undefined;
4
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
5
5
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
6
6
  export declare const ArticleContentTitle: import("@emotion/styled").StyledComponent<{
7
7
  theme?: import("@emotion/react").Theme | undefined;
8
- as?: import("react").ElementType<any> | undefined;
8
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
9
9
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
10
10
  export declare const ArticleContentTitleLink: import("@emotion/styled").StyledComponent<{
11
11
  theme?: import("@emotion/react").Theme | undefined;
12
- as?: import("react").ElementType<any> | undefined;
12
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
13
13
  }, import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, {}>;
package/dist/types-ts4.5/components/ArticleBody/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import React from 'react';
2
2
  import { BODY_FORMAT_TYPES } from '../../model/HelpArticle';
3
3
  import type { AdfDoc } from '../../model/HelpArticle';
4
4
  export interface Props {
@@ -7,5 +7,5 @@ export interface Props {
7
7
  onArticleRenderBegin?(): void;
8
8
  onArticleRenderDone?(): void;
9
9
  }
10
- export declare const ArticleBody: (props: Props) => JSX.Element | null;
10
+ export declare const ArticleBody: (props: Props) => React.JSX.Element | null;
11
11
  export default ArticleBody;
package/dist/types-ts4.5/components/ArticleBody/styled.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /// <reference types="react" />
2
2
  export declare const ArticleFrame: import("@emotion/styled").StyledComponent<{
3
3
  theme?: import("@emotion/react").Theme | undefined;
4
- as?: import("react").ElementType<any> | undefined;
4
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
5
5
  }, import("react").DetailedHTMLProps<import("react").IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, {}>;
package/dist/types-ts4.5/components/HelpArticle.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import React from 'react';
2
2
  import type { HelpArticle as HelpArticleType } from '../model/HelpArticle';
3
- declare const HelpArticle: (props: HelpArticleType) => JSX.Element;
3
+ declare const HelpArticle: (props: HelpArticleType) => React.JSX.Element;
4
4
  export default HelpArticle;
package/dist/types-ts4.5/components/styled.d.ts CHANGED
@@ -1,13 +1,13 @@
1
1
  /// <reference types="react" />
2
2
  export declare const ArticleContentInner: import("@emotion/styled").StyledComponent<{
3
3
  theme?: import("@emotion/react").Theme | undefined;
4
- as?: import("react").ElementType<any> | undefined;
4
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
5
5
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
6
6
  export declare const ArticleContentTitle: import("@emotion/styled").StyledComponent<{
7
7
  theme?: import("@emotion/react").Theme | undefined;
8
- as?: import("react").ElementType<any> | undefined;
8
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
9
9
  }, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
10
10
  export declare const ArticleContentTitleLink: import("@emotion/styled").StyledComponent<{
11
11
  theme?: import("@emotion/react").Theme | undefined;
12
- as?: import("react").ElementType<any> | undefined;
12
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
13
13
  }, import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, {}>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.4.0",
3
+ "version": "5.0.1",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -20,7 +20,9 @@
20
20
  ]
21
21
  }
22
22
  },
23
- "sideEffects": false,
23
+ "sideEffects": [
24
+ "*.compiled.css"
25
+ ],
24
26
  "atlaskit:src": "src/index.ts",
25
27
  "af:exports": {
26
28
  ".": "./src/index.ts"
@@ -33,19 +35,19 @@
33
35
  "runReact18": true
34
36
  },
35
37
  "dependencies": {
36
- "@atlaskit/css-reset": "^6.11.0",
37
- "@atlaskit/heading": "^4.1.0",
38
- "@atlaskit/icon": "^23.5.0",
39
- "@atlaskit/primitives": "^13.4.0",
40
- "@atlaskit/renderer": "^112.12.0",
41
- "@atlaskit/tokens": "^3.3.0",
38
+ "@atlaskit/css-reset": "^7.0.0",
39
+ "@atlaskit/heading": "^5.1.0",
40
+ "@atlaskit/icon": "^24.1.0",
41
+ "@atlaskit/primitives": "^14.1.0",
42
+ "@atlaskit/renderer": "^113.0.0",
43
+ "@atlaskit/tokens": "^4.2.0",
42
44
  "@babel/runtime": "^7.0.0",
43
45
  "@emotion/styled": "^11.0.0",
44
46
  "lodash": "^4.17.21"
45
47
  },
46
48
  "peerDependencies": {
47
- "react": "^16.8.0 || ^17.0.0 || ^18.2.0",
48
- "react-dom": "^16.8.0 || ^17.0.0 || ^18.2.0"
49
+ "react": "^18.2.0",
50
+ "react-dom": "^18.2.0"
49
51
  },
50
52
  "devDependencies": {
51
53
  "enzyme": "^3.10.0",