@atlaskit/help-article 4.0.33 → 4.0.35

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 (13) hide show
  1. package/CHANGELOG.md +30 -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 +3 -11
  6. package/report.api.md +14 -0
  7. package/dist/types-ts4.0/components/ArticleBody/index.d.ts +0 -11
  8. package/dist/types-ts4.0/components/ArticleBody/resetCss.d.ts +0 -2
  9. package/dist/types-ts4.0/components/ArticleBody/styled.d.ts +0 -2
  10. package/dist/types-ts4.0/components/HelpArticle.d.ts +0 -4
  11. package/dist/types-ts4.0/components/styled.d.ts +0 -4
  12. package/dist/types-ts4.0/index.d.ts +0 -3
  13. package/dist/types-ts4.0/model/HelpArticle.d.ts +0 -19
package/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @atlaskit/help-article
2
2
 
3
+ ## 4.0.35
4
+
5
+ ### Patch Changes
6
+
7
+ - [`224a2482244`](https://bitbucket.org/atlassian/atlassian-frontend/commits/224a2482244) - [ED-16166] Changes the renderer prop document type from any to DocNode
8
+
9
+ BREAKING for `@atlaskit/renderer`: Previously the `document` prop for the renderer component had the type of `any`. This has now been changed to `DocNode` which comes from `@atlaskit/adf-schema`.
10
+
11
+ Documents being passed into the renderer component will need to be updated to use this type.
12
+
13
+ Example Usage:
14
+
15
+ ```tsx
16
+ import { DocNode } from '@atlaskit/adf-schema';
17
+
18
+ const emptyDoc: DocNode = {
19
+ type: 'doc',
20
+ version: 1,
21
+ content: [],
22
+ };
23
+ ```
24
+
25
+ - Updated dependencies
26
+
27
+ ## 4.0.34
28
+
29
+ ### Patch Changes
30
+
31
+ - Updated dependencies
32
+
3
33
  ## 4.0.33
4
34
 
5
35
  ### Patch Changes
package/dist/cjs/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.33",
3
+ "version": "4.0.35",
4
4
  "sideEffects": false
5
5
  }
package/dist/es2019/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.33",
3
+ "version": "4.0.35",
4
4
  "sideEffects": false
5
5
  }
package/dist/esm/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.33",
3
+ "version": "4.0.35",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.33",
3
+ "version": "4.0.35",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,14 +12,6 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
- "typesVersions": {
16
- ">=4.0 <4.5": {
17
- "*": [
18
- "dist/types-ts4.0/*",
19
- "dist/types-ts4.0/index.d.ts"
20
- ]
21
- }
22
- },
23
15
  "sideEffects": false,
24
16
  "atlaskit:src": "src/index.ts",
25
17
  "atlassian": {
@@ -33,7 +25,7 @@
33
25
  "dependencies": {
34
26
  "@atlaskit/css-reset": "^6.3.0",
35
27
  "@atlaskit/icon": "^21.11.0",
36
- "@atlaskit/renderer": "^103.0.0",
28
+ "@atlaskit/renderer": "^105.0.0",
37
29
  "@atlaskit/theme": "^12.2.0",
38
30
  "@babel/runtime": "^7.0.0",
39
31
  "@emotion/styled": "^10.0.7",
@@ -44,7 +36,7 @@
44
36
  "react-dom": "^16.8.0"
45
37
  },
46
38
  "devDependencies": {
47
- "@atlaskit/button": "^16.4.0",
39
+ "@atlaskit/button": "^16.5.0",
48
40
  "@atlaskit/docs": "*",
49
41
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
50
42
  "enzyme": "^3.10.0",
package/report.api.md CHANGED
@@ -8,6 +8,7 @@
8
8
  ### Table of contents
9
9
 
10
10
  - [Main Entry Types](#main-entry-types)
11
+ - [Peer Dependencies](#peer-dependencies)
11
12
 
12
13
  ### Main Entry Types
13
14
 
@@ -51,3 +52,16 @@ export default HelpArticle_2;
51
52
  ```
52
53
 
53
54
  <!--SECTION END: Main Entry Types-->
55
+
56
+ ### Peer Dependencies
57
+
58
+ <!--SECTION START: Peer Dependencies-->
59
+
60
+ ```json
61
+ {
62
+ "react": "^16.8.0",
63
+ "react-dom": "^16.8.0"
64
+ }
65
+ ```
66
+
67
+ <!--SECTION END: Peer Dependencies-->
package/dist/types-ts4.0/components/ArticleBody/index.d.ts DELETED
@@ -1,11 +0,0 @@
1
- /// <reference types="react" />
2
- import { BODY_FORMAT_TYPES } from '../../model/HelpArticle';
3
- import type { AdfDoc } from '../../model/HelpArticle';
4
- export interface Props {
5
- body?: string | AdfDoc;
6
- bodyFormat: BODY_FORMAT_TYPES;
7
- onArticleRenderBegin?(): void;
8
- onArticleRenderDone?(): void;
9
- }
10
- export declare const ArticleBody: (props: Props) => JSX.Element | null;
11
- export default ArticleBody;
package/dist/types-ts4.0/components/ArticleBody/resetCss.d.ts DELETED
@@ -1,2 +0,0 @@
1
- declare const DEFAULT_CSS: string;
2
- export default DEFAULT_CSS;
package/dist/types-ts4.0/components/ArticleBody/styled.d.ts DELETED
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare const ArticleFrame: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, Pick<import("react").ClassAttributes<HTMLIFrameElement> & import("react").IframeHTMLAttributes<HTMLIFrameElement>, keyof import("react").IframeHTMLAttributes<HTMLIFrameElement>>, object>;
package/dist/types-ts4.0/components/HelpArticle.d.ts DELETED
@@ -1,4 +0,0 @@
1
- /// <reference types="react" />
2
- import type { HelpArticle as HelpArticleType } from '../model/HelpArticle';
3
- declare const HelpArticle: (props: HelpArticleType) => JSX.Element;
4
- export default HelpArticle;
package/dist/types-ts4.0/components/styled.d.ts DELETED
@@ -1,4 +0,0 @@
1
- /// <reference types="react" />
2
- export declare const ArticleContentInner: 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>;
3
- export declare const ArticleContentTitle: 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>;
4
- export declare const ArticleContentTitleLink: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, Pick<import("react").ClassAttributes<HTMLAnchorElement> & import("react").AnchorHTMLAttributes<HTMLAnchorElement>, keyof import("react").AnchorHTMLAttributes<HTMLAnchorElement>>, object>;
package/dist/types-ts4.0/index.d.ts DELETED
@@ -1,3 +0,0 @@
1
- export { default } from './components/HelpArticle';
2
- export { BODY_FORMAT_TYPES } from './model/HelpArticle';
3
- export type { HelpArticle, AdfDoc } from './model/HelpArticle';
package/dist/types-ts4.0/model/HelpArticle.d.ts DELETED
@@ -1,19 +0,0 @@
1
- export declare enum BODY_FORMAT_TYPES {
2
- adf = "adf",
3
- html = "html"
4
- }
5
- export declare type AdfDoc = {
6
- type: string;
7
- version: number;
8
- content: {
9
- [fieldName: string]: any;
10
- }[];
11
- };
12
- export declare type HelpArticle = {
13
- title?: string;
14
- body?: string | AdfDoc;
15
- bodyFormat?: BODY_FORMAT_TYPES;
16
- titleLinkUrl?: string;
17
- onArticleRenderBegin?(): void;
18
- onArticleRenderDone?(): void;
19
- };