@atlaskit/help-article 4.0.29 → 4.0.31

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 (14) 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/dist/types-ts4.0/components/ArticleBody/index.d.ts +11 -0
  6. package/dist/types-ts4.0/components/ArticleBody/resetCss.d.ts +2 -0
  7. package/dist/types-ts4.0/components/ArticleBody/styled.d.ts +2 -0
  8. package/dist/types-ts4.0/components/HelpArticle.d.ts +4 -0
  9. package/dist/types-ts4.0/components/styled.d.ts +4 -0
  10. package/dist/types-ts4.0/index.d.ts +3 -0
  11. package/dist/types-ts4.0/model/HelpArticle.d.ts +19 -0
  12. package/package.json +12 -5
  13. package/report.api.md +26 -9
  14. package/tmp/api-report-tmp.d.ts +42 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/help-article
2
2
 
3
+ ## 4.0.31
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 4.0.30
10
+
11
+ ### Patch Changes
12
+
13
+ - [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
14
+
3
15
  ## 4.0.29
4
16
 
5
17
  ### Patch Changes
package/dist/cjs/version.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.29",
3
+ "version": "4.0.31",
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.29",
3
+ "version": "4.0.31",
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.29",
3
+ "version": "4.0.31",
4
4
  "sideEffects": false
5
5
  }
package/dist/types-ts4.0/components/ArticleBody/index.d.ts ADDED
@@ -0,0 +1,11 @@
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 ADDED
@@ -0,0 +1,2 @@
1
+ declare const DEFAULT_CSS: string;
2
+ export default DEFAULT_CSS;
package/dist/types-ts4.0/components/ArticleBody/styled.d.ts ADDED
@@ -0,0 +1,2 @@
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 ADDED
@@ -0,0 +1,4 @@
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 ADDED
@@ -0,0 +1,4 @@
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 ADDED
@@ -0,0 +1,3 @@
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 ADDED
@@ -0,0 +1,19 @@
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
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.29",
3
+ "version": "4.0.31",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
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
+ ]
20
+ }
21
+ },
15
22
  "sideEffects": false,
16
23
  "atlaskit:src": "src/index.ts",
17
24
  "atlassian": {
@@ -24,9 +31,9 @@
24
31
  },
25
32
  "dependencies": {
26
33
  "@atlaskit/css-reset": "^6.3.0",
27
- "@atlaskit/icon": "^21.10.0",
28
- "@atlaskit/renderer": "^101.0.0",
29
- "@atlaskit/theme": "^12.1.0",
34
+ "@atlaskit/icon": "^21.11.0",
35
+ "@atlaskit/renderer": "^102.0.0",
36
+ "@atlaskit/theme": "^12.2.0",
30
37
  "@babel/runtime": "^7.0.0",
31
38
  "@emotion/styled": "^10.0.7",
32
39
  "lodash": "^4.17.21"
@@ -41,7 +48,7 @@
41
48
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
42
49
  "enzyme": "^3.10.0",
43
50
  "react-test-renderer": "^16.8.0",
44
- "typescript": "4.3.5"
51
+ "typescript": "4.5.5"
45
52
  },
46
53
  "keywords": [
47
54
  "atlaskit",
package/report.api.md CHANGED
@@ -1,13 +1,23 @@
1
- ## API Report File for "@atlaskit/help-article".
1
+ <!-- API Report Version: 2.2 -->
2
2
 
3
- > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
3
+ ## API Report File for "@atlaskit/help-article"
4
4
 
5
- [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
5
+ > Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
6
+ > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
7
+
8
+ ### Table of contents
9
+
10
+ - [Main Entry Types](#main-entry-types)
11
+
12
+ ### Main Entry Types
13
+
14
+ <!--SECTION START: Main Entry Types-->
6
15
 
7
16
  ```ts
8
17
  /// <reference types="react" />
9
18
 
10
- export declare type AdfDoc = {
19
+ // @public (undocumented)
20
+ export type AdfDoc = {
11
21
  type: string;
12
22
  version: number;
13
23
  content: {
@@ -15,22 +25,29 @@ export declare type AdfDoc = {
15
25
  }[];
16
26
  };
17
27
 
18
- export declare enum BODY_FORMAT_TYPES {
28
+ // @public (undocumented)
29
+ export enum BODY_FORMAT_TYPES {
30
+ // (undocumented)
19
31
  adf = 'adf',
32
+ // (undocumented)
20
33
  html = 'html',
21
34
  }
22
35
 
23
- export declare type HelpArticle = {
36
+ // @public (undocumented)
37
+ export type HelpArticle = {
24
38
  title?: string;
25
- body?: string | AdfDoc;
39
+ body?: AdfDoc | string;
26
40
  bodyFormat?: BODY_FORMAT_TYPES;
27
41
  titleLinkUrl?: string;
28
42
  onArticleRenderBegin?(): void;
29
43
  onArticleRenderDone?(): void;
30
44
  };
31
45
 
32
- declare const HelpArticle_2: (props: HelpArticle) => JSX.Element;
46
+ // @public (undocumented)
47
+ const HelpArticle_2: (props: HelpArticle) => JSX.Element;
33
48
  export default HelpArticle_2;
34
49
 
35
- export {};
50
+ // (No @packageDocumentation comment for this package)
36
51
  ```
52
+
53
+ <!--SECTION END: Main Entry Types-->
package/tmp/api-report-tmp.d.ts ADDED
@@ -0,0 +1,42 @@
1
+ ## API Report File for "@atlaskit/help-article"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ /// <reference types="react" />
8
+
9
+ // @public (undocumented)
10
+ export type AdfDoc = {
11
+ type: string;
12
+ version: number;
13
+ content: {
14
+ [fieldName: string]: any;
15
+ }[];
16
+ };
17
+
18
+ // @public (undocumented)
19
+ export enum BODY_FORMAT_TYPES {
20
+ // (undocumented)
21
+ adf = "adf",
22
+ // (undocumented)
23
+ html = "html"
24
+ }
25
+
26
+ // @public (undocumented)
27
+ export type HelpArticle = {
28
+ title?: string;
29
+ body?: AdfDoc | string;
30
+ bodyFormat?: BODY_FORMAT_TYPES;
31
+ titleLinkUrl?: string;
32
+ onArticleRenderBegin?(): void;
33
+ onArticleRenderDone?(): void;
34
+ };
35
+
36
+ // @public (undocumented)
37
+ const HelpArticle_2: (props: HelpArticle) => JSX.Element;
38
+ export default HelpArticle_2;
39
+
40
+ // (No @packageDocumentation comment for this package)
41
+
42
+ ```