@backstage/plugin-techdocs 1.1.1 → 1.2.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.
- package/CHANGELOG.md +82 -0
- package/dist/esm/{TechDocsCustomHome-cd82e45b.esm.js → TechDocsCustomHome-5d481b98.esm.js} +4 -6
- package/dist/esm/{TechDocsCustomHome-cd82e45b.esm.js.map → TechDocsCustomHome-5d481b98.esm.js.map} +1 -1
- package/dist/esm/{index-aaf89f6d.esm.js → index-038d31d0.esm.js} +4 -6
- package/dist/esm/index-038d31d0.esm.js.map +1 -0
- package/dist/esm/{index-dd16232a.esm.js → index-8dfcce23.esm.js} +695 -657
- package/dist/esm/index-8dfcce23.esm.js.map +1 -0
- package/dist/index.d.ts +5 -2
- package/dist/index.esm.js +3 -5
- package/dist/index.esm.js.map +1 -1
- package/package.json +16 -16
- package/dist/esm/index-aaf89f6d.esm.js.map +0 -1
- package/dist/esm/index-dd16232a.esm.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -289,8 +289,10 @@ declare const TechDocsReaderPageSubheader: ({ toolbarProps, }: {
|
|
|
289
289
|
* @public
|
|
290
290
|
*/
|
|
291
291
|
declare type TechDocsSearchResultListItemProps = {
|
|
292
|
+
icon?: ReactNode;
|
|
292
293
|
result: any;
|
|
293
294
|
highlight?: ResultHighlight;
|
|
295
|
+
rank?: number;
|
|
294
296
|
lineClamp?: number;
|
|
295
297
|
asListItem?: boolean;
|
|
296
298
|
asLink?: boolean;
|
|
@@ -310,6 +312,7 @@ declare const TechDocsSearchResultListItem: (props: TechDocsSearchResultListItem
|
|
|
310
312
|
*/
|
|
311
313
|
declare type TechDocsSearchProps = {
|
|
312
314
|
entityId: CompoundEntityRef;
|
|
315
|
+
entityTitle?: string;
|
|
313
316
|
debounceTime?: number;
|
|
314
317
|
};
|
|
315
318
|
/**
|
|
@@ -542,7 +545,7 @@ declare const TechdocsPage: () => JSX.Element;
|
|
|
542
545
|
*/
|
|
543
546
|
declare const EntityTechdocsContent: (props: {
|
|
544
547
|
children?: React.ReactNode;
|
|
545
|
-
}) => JSX.Element;
|
|
548
|
+
}) => JSX.Element | null;
|
|
546
549
|
/**
|
|
547
550
|
* Component which takes a custom tabs config object and renders a documentation landing page.
|
|
548
551
|
*
|
|
@@ -579,7 +582,7 @@ declare const Router: () => JSX.Element;
|
|
|
579
582
|
*
|
|
580
583
|
* @public
|
|
581
584
|
*/
|
|
582
|
-
declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => JSX.Element;
|
|
585
|
+
declare const EmbeddedDocsRouter: (props: PropsWithChildren<{}>) => JSX.Element | null;
|
|
583
586
|
|
|
584
587
|
/**
|
|
585
588
|
* The Backstage plugin that renders technical documentation for your components
|
package/dist/index.esm.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, j as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, n as TechDocsReaderPageContent, m as TechDocsReaderPageHeader, o as TechDocsReaderPageSubheader, l as TechDocsReaderProvider, q as TechDocsSearch, p as TechDocsSearchResultListItem, k as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, i as techdocsApiRef, t as techdocsPlugin, h as techdocsStorageApiRef } from './esm/index-
|
|
1
|
+
export { u as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, y as EmbeddedDocsRouter, r as EntityListDocsGrid, s as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, x as Router, j as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, n as TechDocsReaderPageContent, m as TechDocsReaderPageHeader, o as TechDocsReaderPageSubheader, l as TechDocsReaderProvider, q as TechDocsSearch, p as TechDocsSearchResultListItem, k as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, i as techdocsApiRef, t as techdocsPlugin, h as techdocsStorageApiRef } from './esm/index-8dfcce23.esm.js';
|
|
2
2
|
import '@backstage/core-plugin-api';
|
|
3
3
|
import '@backstage/errors';
|
|
4
4
|
import 'event-source-polyfill';
|
|
@@ -8,9 +8,7 @@ import '@backstage/plugin-techdocs-react';
|
|
|
8
8
|
import 'react-use/lib/useAsync';
|
|
9
9
|
import 'react-use/lib/useAsyncRetry';
|
|
10
10
|
import '@backstage/core-components';
|
|
11
|
-
import 'jss';
|
|
12
11
|
import '@material-ui/core';
|
|
13
|
-
import '@material-ui/styles';
|
|
14
12
|
import '@backstage/plugin-search-react';
|
|
15
13
|
import '@material-ui/icons/Search';
|
|
16
14
|
import '@material-ui/lab/Autocomplete';
|
|
@@ -18,14 +16,13 @@ import 'react-router';
|
|
|
18
16
|
import 'react-use/lib/useDebounce';
|
|
19
17
|
import '@material-ui/lab';
|
|
20
18
|
import '@material-ui/icons/Close';
|
|
21
|
-
import '@material-ui/core/styles';
|
|
22
19
|
import '@backstage/integration-react';
|
|
20
|
+
import 'dompurify';
|
|
23
21
|
import '@backstage/integration';
|
|
24
22
|
import '@material-ui/icons/FeedbackOutlined';
|
|
25
23
|
import 'react-dom';
|
|
26
24
|
import 'git-url-parse';
|
|
27
25
|
import '@material-ui/icons/Menu';
|
|
28
|
-
import 'dompurify';
|
|
29
26
|
import 'react-helmet';
|
|
30
27
|
import '@material-ui/icons/Code';
|
|
31
28
|
import '@backstage/plugin-catalog-react';
|
|
@@ -34,6 +31,7 @@ import '@material-ui/icons/Settings';
|
|
|
34
31
|
import 'react-use/lib/useCopyToClipboard';
|
|
35
32
|
import 'lodash';
|
|
36
33
|
import '@material-ui/icons/Share';
|
|
34
|
+
import '@material-ui/styles';
|
|
37
35
|
import '@material-ui/icons/Star';
|
|
38
36
|
import '@material-ui/icons/StarBorder';
|
|
39
37
|
//# sourceMappingURL=index.esm.js.map
|
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs",
|
|
3
3
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.2.0",
|
|
5
5
|
"main": "dist/index.esm.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -35,17 +35,17 @@
|
|
|
35
35
|
"clean": "backstage-cli package clean"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@backstage/catalog-model": "^1.0.
|
|
38
|
+
"@backstage/catalog-model": "^1.0.3",
|
|
39
39
|
"@backstage/config": "^1.0.1",
|
|
40
|
-
"@backstage/core-components": "^0.9.
|
|
41
|
-
"@backstage/core-plugin-api": "^1.0.
|
|
40
|
+
"@backstage/core-components": "^0.9.5",
|
|
41
|
+
"@backstage/core-plugin-api": "^1.0.3",
|
|
42
42
|
"@backstage/errors": "^1.0.0",
|
|
43
|
-
"@backstage/integration": "^1.2.
|
|
44
|
-
"@backstage/integration-react": "^1.1.
|
|
45
|
-
"@backstage/plugin-catalog-react": "^1.1.
|
|
46
|
-
"@backstage/plugin-search-common": "^0.3.
|
|
47
|
-
"@backstage/plugin-search-react": "^0.2.
|
|
48
|
-
"@backstage/plugin-techdocs-react": "^1.0.
|
|
43
|
+
"@backstage/integration": "^1.2.1",
|
|
44
|
+
"@backstage/integration-react": "^1.1.1",
|
|
45
|
+
"@backstage/plugin-catalog-react": "^1.1.1",
|
|
46
|
+
"@backstage/plugin-search-common": "^0.3.5",
|
|
47
|
+
"@backstage/plugin-search-react": "^0.2.1",
|
|
48
|
+
"@backstage/plugin-techdocs-react": "^1.0.1",
|
|
49
49
|
"@backstage/theme": "^0.2.15",
|
|
50
50
|
"@material-ui/core": "^4.12.2",
|
|
51
51
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -67,10 +67,10 @@
|
|
|
67
67
|
"react-dom": "^16.13.1 || ^17.0.0"
|
|
68
68
|
},
|
|
69
69
|
"devDependencies": {
|
|
70
|
-
"@backstage/cli": "^0.17.
|
|
71
|
-
"@backstage/core-app-api": "^1.0.
|
|
72
|
-
"@backstage/dev-utils": "^1.0.
|
|
73
|
-
"@backstage/test-utils": "^1.1.
|
|
70
|
+
"@backstage/cli": "^0.17.2",
|
|
71
|
+
"@backstage/core-app-api": "^1.0.3",
|
|
72
|
+
"@backstage/dev-utils": "^1.0.3",
|
|
73
|
+
"@backstage/test-utils": "^1.1.1",
|
|
74
74
|
"@testing-library/jest-dom": "^5.10.1",
|
|
75
75
|
"@testing-library/react": "^12.1.3",
|
|
76
76
|
"@testing-library/react-hooks": "^8.0.0",
|
|
@@ -81,12 +81,12 @@
|
|
|
81
81
|
"@types/node": "^16.11.26",
|
|
82
82
|
"canvas": "^2.6.1",
|
|
83
83
|
"cross-fetch": "^3.1.5",
|
|
84
|
-
"msw": "^0.
|
|
84
|
+
"msw": "^0.42.0"
|
|
85
85
|
},
|
|
86
86
|
"files": [
|
|
87
87
|
"dist",
|
|
88
88
|
"config.d.ts"
|
|
89
89
|
],
|
|
90
90
|
"configSchema": "config.d.ts",
|
|
91
|
-
"gitHead": "
|
|
91
|
+
"gitHead": "e42cb3887e41f756c16380d757d93feda27f40ee"
|
|
92
92
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index-aaf89f6d.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|