@backstage/plugin-techdocs 1.6.3-next.1 → 1.6.3
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 +3 -33
- package/dist/esm/{TechDocsCustomHome-bdd58b65.esm.js → TechDocsCustomHome-a537ceed.esm.js} +2 -2
- package/dist/esm/{TechDocsCustomHome-bdd58b65.esm.js.map → TechDocsCustomHome-a537ceed.esm.js.map} +1 -1
- package/dist/esm/{index-13791883.esm.js → index-7df60ec3.esm.js} +4 -4
- package/dist/esm/index-7df60ec3.esm.js.map +1 -0
- package/dist/esm/{index-ad02ba08.esm.js → index-b76ec28b.esm.js} +2 -2
- package/dist/esm/index-b76ec28b.esm.js.map +1 -0
- package/dist/index.d.ts +6 -6
- package/dist/index.esm.js +1 -1
- package/package.json +17 -17
- package/dist/esm/index-13791883.esm.js.map +0 -1
- package/dist/esm/index-ad02ba08.esm.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-
|
|
1
|
+
export { c as TechDocsReaderLayout, b as TechDocsReaderPage } from './index-7df60ec3.esm.js';
|
|
2
2
|
import '@backstage/core-plugin-api';
|
|
3
3
|
import '@backstage/errors';
|
|
4
4
|
import 'event-source-polyfill';
|
|
@@ -33,4 +33,4 @@ import '@material-ui/icons/Share';
|
|
|
33
33
|
import '@material-ui/styles';
|
|
34
34
|
import '@material-ui/icons/Star';
|
|
35
35
|
import '@material-ui/icons/StarBorder';
|
|
36
|
-
//# sourceMappingURL=index-
|
|
36
|
+
//# sourceMappingURL=index-b76ec28b.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-b76ec28b.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import { TechDocsMetadata, TechDocsEntityMetadata
|
|
2
|
+
import { TechDocsMetadata, TechDocsEntityMetadata } from '@backstage/plugin-techdocs-react';
|
|
3
3
|
import { CompoundEntityRef, Entity } from '@backstage/catalog-model';
|
|
4
4
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
5
5
|
import { DiscoveryApi, FetchApi, IdentityApi } from '@backstage/core-plugin-api';
|
|
@@ -80,7 +80,7 @@ interface TechDocsApi {
|
|
|
80
80
|
*
|
|
81
81
|
* @public
|
|
82
82
|
*/
|
|
83
|
-
declare class TechDocsClient implements TechDocsApi
|
|
83
|
+
declare class TechDocsClient implements TechDocsApi {
|
|
84
84
|
configApi: Config;
|
|
85
85
|
discoveryApi: DiscoveryApi;
|
|
86
86
|
private fetchApi;
|
|
@@ -115,7 +115,7 @@ declare class TechDocsClient implements TechDocsApi$1 {
|
|
|
115
115
|
*
|
|
116
116
|
* @public
|
|
117
117
|
*/
|
|
118
|
-
declare class TechDocsStorageClient implements TechDocsStorageApi
|
|
118
|
+
declare class TechDocsStorageClient implements TechDocsStorageApi {
|
|
119
119
|
configApi: Config;
|
|
120
120
|
discoveryApi: DiscoveryApi;
|
|
121
121
|
identityApi: IdentityApi;
|
|
@@ -144,9 +144,9 @@ declare class TechDocsStorageClient implements TechDocsStorageApi$1 {
|
|
|
144
144
|
* @param entityId - Object containing entity data like name, namespace, etc.
|
|
145
145
|
* @param logHandler - Callback to receive log messages from the build process
|
|
146
146
|
* @returns Whether documents are currently synchronized to newest version
|
|
147
|
-
* @throws Throws error on error from sync endpoint in
|
|
147
|
+
* @throws Throws error on error from sync endpoint in Techdocs Backend
|
|
148
148
|
*/
|
|
149
|
-
syncEntityDocs(entityId: CompoundEntityRef, logHandler?: (line: string) => void): Promise<SyncResult
|
|
149
|
+
syncEntityDocs(entityId: CompoundEntityRef, logHandler?: (line: string) => void): Promise<SyncResult>;
|
|
150
150
|
getBaseUrl(oldBaseUrl: string, entityId: CompoundEntityRef, path: string): Promise<string>;
|
|
151
151
|
}
|
|
152
152
|
|
|
@@ -511,7 +511,7 @@ type TechDocsPageWrapperProps = {
|
|
|
511
511
|
children?: React__default.ReactNode;
|
|
512
512
|
};
|
|
513
513
|
/**
|
|
514
|
-
* Component wrapping a
|
|
514
|
+
* Component wrapping a techdocs page with Page and Header components
|
|
515
515
|
*
|
|
516
516
|
* @public
|
|
517
517
|
*/
|
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, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i 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, k as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, v as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, o as TechDocsReaderPageContent, n as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, m as TechDocsReaderProvider, q as TechDocsSearch, h as TechDocsSearchResultListItem, l as TechDocsStorageClient, f as TechdocsPage, w as isTechDocsAvailable, t as plugin, j as techdocsApiRef, t as techdocsPlugin, i as techdocsStorageApiRef } from './esm/index-7df60ec3.esm.js';
|
|
2
2
|
import '@backstage/core-plugin-api';
|
|
3
3
|
import '@backstage/errors';
|
|
4
4
|
import 'event-source-polyfill';
|
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.6.3
|
|
4
|
+
"version": "1.6.3",
|
|
5
5
|
"main": "dist/index.esm.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -33,18 +33,18 @@
|
|
|
33
33
|
"clean": "backstage-cli package clean"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@backstage/catalog-model": "^1.
|
|
36
|
+
"@backstage/catalog-model": "^1.3.0",
|
|
37
37
|
"@backstage/config": "^1.0.7",
|
|
38
|
-
"@backstage/core-components": "^0.13.
|
|
39
|
-
"@backstage/core-plugin-api": "^1.5.
|
|
40
|
-
"@backstage/errors": "^1.
|
|
41
|
-
"@backstage/integration": "^1.5
|
|
42
|
-
"@backstage/integration-react": "^1.1.
|
|
43
|
-
"@backstage/plugin-catalog-react": "^1.
|
|
44
|
-
"@backstage/plugin-search-common": "^1.2.
|
|
45
|
-
"@backstage/plugin-search-react": "^1.6.1
|
|
46
|
-
"@backstage/plugin-techdocs-react": "^1.1.
|
|
47
|
-
"@backstage/theme": "^0.
|
|
38
|
+
"@backstage/core-components": "^0.13.1",
|
|
39
|
+
"@backstage/core-plugin-api": "^1.5.1",
|
|
40
|
+
"@backstage/errors": "^1.1.5",
|
|
41
|
+
"@backstage/integration": "^1.4.5",
|
|
42
|
+
"@backstage/integration-react": "^1.1.13",
|
|
43
|
+
"@backstage/plugin-catalog-react": "^1.6.0",
|
|
44
|
+
"@backstage/plugin-search-common": "^1.2.3",
|
|
45
|
+
"@backstage/plugin-search-react": "^1.6.1",
|
|
46
|
+
"@backstage/plugin-techdocs-react": "^1.1.6",
|
|
47
|
+
"@backstage/theme": "^0.3.0",
|
|
48
48
|
"@material-ui/core": "^4.12.2",
|
|
49
49
|
"@material-ui/icons": "^4.9.1",
|
|
50
50
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -64,11 +64,11 @@
|
|
|
64
64
|
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
|
-
"@backstage/cli": "^0.22.
|
|
68
|
-
"@backstage/core-app-api": "^1.8.
|
|
69
|
-
"@backstage/dev-utils": "^1.0.
|
|
70
|
-
"@backstage/plugin-techdocs-module-addons-contrib": "^1.0.
|
|
71
|
-
"@backstage/test-utils": "^1.
|
|
67
|
+
"@backstage/cli": "^0.22.7",
|
|
68
|
+
"@backstage/core-app-api": "^1.8.0",
|
|
69
|
+
"@backstage/dev-utils": "^1.0.15",
|
|
70
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "^1.0.13",
|
|
71
|
+
"@backstage/test-utils": "^1.3.1",
|
|
72
72
|
"@testing-library/dom": "^8.0.0",
|
|
73
73
|
"@testing-library/jest-dom": "^5.10.1",
|
|
74
74
|
"@testing-library/react": "^12.1.3",
|