@backstage/plugin-techdocs 1.1.1-next.0 → 1.1.1-next.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 +41 -0
- package/dist/esm/{TechDocsCustomHome-7836f59f.esm.js → TechDocsCustomHome-b77adc6d.esm.js} +3 -3
- package/dist/esm/{TechDocsCustomHome-7836f59f.esm.js.map → TechDocsCustomHome-b77adc6d.esm.js.map} +1 -1
- package/dist/esm/{index-28e41621.esm.js → index-52f21300.esm.js} +3 -3
- package/dist/esm/index-52f21300.esm.js.map +1 -0
- package/dist/esm/{index-3d3f8718.esm.js → index-c537b1f3.esm.js} +71 -26
- package/dist/esm/index-c537b1f3.esm.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.esm.js +2 -2
- package/package.json +16 -16
- package/dist/esm/index-28e41621.esm.js.map +0 -1
- package/dist/esm/index-3d3f8718.esm.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -7,6 +7,7 @@ import { Config } from '@backstage/config';
|
|
|
7
7
|
import * as React from 'react';
|
|
8
8
|
import React__default, { ReactNode, PropsWithChildren } from 'react';
|
|
9
9
|
import { ToolbarProps } from '@material-ui/core';
|
|
10
|
+
import { ResultHighlight } from '@backstage/plugin-search-common';
|
|
10
11
|
import { TableColumn, TableProps } from '@backstage/core-components';
|
|
11
12
|
import { UserListFilterKind } from '@backstage/plugin-catalog-react';
|
|
12
13
|
import { CSSProperties } from '@material-ui/styles';
|
|
@@ -30,6 +31,7 @@ declare type TechDocsReaderPageRenderFunction = ({ techdocsMetadataValue, entity
|
|
|
30
31
|
* Utility API reference for the {@link TechDocsStorageApi}.
|
|
31
32
|
*
|
|
32
33
|
* @public
|
|
34
|
+
* @deprecated Import from `@backstage/plugin-techdocs-react` instead
|
|
33
35
|
*/
|
|
34
36
|
declare const techdocsStorageApiRef: _backstage_core_plugin_api.ApiRef<TechDocsStorageApi>;
|
|
35
37
|
/**
|
|
@@ -43,12 +45,14 @@ declare const techdocsApiRef: _backstage_core_plugin_api.ApiRef<TechDocsApi>;
|
|
|
43
45
|
* The outcome of a docs sync operation.
|
|
44
46
|
*
|
|
45
47
|
* @public
|
|
48
|
+
* @deprecated Import from `@backstage/plugin-techdocs-react` instead
|
|
46
49
|
*/
|
|
47
50
|
declare type SyncResult = 'cached' | 'updated';
|
|
48
51
|
/**
|
|
49
52
|
* API which talks to TechDocs storage to fetch files to render.
|
|
50
53
|
*
|
|
51
54
|
* @public
|
|
55
|
+
* @deprecated Import from `@backstage/plugin-techdocs-react` instead
|
|
52
56
|
*/
|
|
53
57
|
interface TechDocsStorageApi {
|
|
54
58
|
getApiOrigin(): Promise<string>;
|
|
@@ -286,6 +290,7 @@ declare const TechDocsReaderPageSubheader: ({ toolbarProps, }: {
|
|
|
286
290
|
*/
|
|
287
291
|
declare type TechDocsSearchResultListItemProps = {
|
|
288
292
|
result: any;
|
|
293
|
+
highlight?: ResultHighlight;
|
|
289
294
|
lineClamp?: number;
|
|
290
295
|
asListItem?: boolean;
|
|
291
296
|
asLink?: boolean;
|
package/dist/index.esm.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { y as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, C as EmbeddedDocsRouter, v as EntityListDocsGrid, x as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, B as Router, j as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, z as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, m as TechDocsReaderPageContent, l as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, n as TechDocsReaderProvider, s as TechDocsSearch, r as TechDocsSearchResultListItem, q as TechDocsStateIndicator, k as TechDocsStorageClient, f as TechdocsPage, A as isTechDocsAvailable, t as plugin, i as techdocsApiRef, t as techdocsPlugin, h as techdocsStorageApiRef, u as useTechDocsReader, o as useTechDocsReaderDom, w as withTechDocsReaderProvider } from './esm/index-
|
|
1
|
+
export { y as DefaultTechDocsHome, a as DocsCardGrid, D as DocsTable, C as EmbeddedDocsRouter, v as EntityListDocsGrid, x as EntityListDocsTable, E as EntityTechdocsContent, R as Reader, B as Router, j as TechDocsClient, d as TechDocsCustomHome, e as TechDocsIndexPage, T as TechDocsPageWrapper, z as TechDocsPicker, c as TechDocsReaderLayout, g as TechDocsReaderPage, m as TechDocsReaderPageContent, l as TechDocsReaderPageHeader, p as TechDocsReaderPageSubheader, n as TechDocsReaderProvider, s as TechDocsSearch, r as TechDocsSearchResultListItem, q as TechDocsStateIndicator, k as TechDocsStorageClient, f as TechdocsPage, A as isTechDocsAvailable, t as plugin, i as techdocsApiRef, t as techdocsPlugin, h as techdocsStorageApiRef, u as useTechDocsReader, o as useTechDocsReaderDom, w as withTechDocsReaderProvider } from './esm/index-c537b1f3.esm.js';
|
|
2
2
|
import '@backstage/core-plugin-api';
|
|
3
3
|
import '@backstage/errors';
|
|
4
4
|
import 'event-source-polyfill';
|
|
@@ -9,7 +9,6 @@ import '@backstage/plugin-techdocs-react';
|
|
|
9
9
|
import 'jss';
|
|
10
10
|
import '@material-ui/core';
|
|
11
11
|
import '@material-ui/styles';
|
|
12
|
-
import 'react-text-truncate';
|
|
13
12
|
import '@backstage/plugin-search-react';
|
|
14
13
|
import '@material-ui/icons/Search';
|
|
15
14
|
import '@material-ui/lab/Autocomplete';
|
|
@@ -31,6 +30,7 @@ import 'react-helmet';
|
|
|
31
30
|
import '@material-ui/icons/Code';
|
|
32
31
|
import '@backstage/plugin-catalog-react';
|
|
33
32
|
import '@backstage/catalog-model';
|
|
33
|
+
import '@material-ui/icons/Settings';
|
|
34
34
|
import 'react-use/lib/useCopyToClipboard';
|
|
35
35
|
import 'lodash';
|
|
36
36
|
import '@material-ui/icons/Share';
|
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.1.1-next.
|
|
4
|
+
"version": "1.1.1-next.3",
|
|
5
5
|
"main": "dist/index.esm.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -35,16 +35,17 @@
|
|
|
35
35
|
"clean": "backstage-cli package clean"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@backstage/catalog-model": "^1.0.
|
|
39
|
-
"@backstage/config": "^1.0.0",
|
|
40
|
-
"@backstage/core-components": "^0.9.
|
|
41
|
-
"@backstage/core-plugin-api": "^1.0.1",
|
|
38
|
+
"@backstage/catalog-model": "^1.0.2-next.0",
|
|
39
|
+
"@backstage/config": "^1.0.1-next.0",
|
|
40
|
+
"@backstage/core-components": "^0.9.4-next.2",
|
|
41
|
+
"@backstage/core-plugin-api": "^1.0.2-next.1",
|
|
42
42
|
"@backstage/errors": "^1.0.0",
|
|
43
|
-
"@backstage/integration": "^1.2.0-next.
|
|
44
|
-
"@backstage/integration-react": "^1.1.0-next.
|
|
45
|
-
"@backstage/plugin-catalog-react": "^1.1.0-next.
|
|
46
|
-
"@backstage/plugin-search-
|
|
47
|
-
"@backstage/plugin-
|
|
43
|
+
"@backstage/integration": "^1.2.0-next.1",
|
|
44
|
+
"@backstage/integration-react": "^1.1.0-next.2",
|
|
45
|
+
"@backstage/plugin-catalog-react": "^1.1.0-next.2",
|
|
46
|
+
"@backstage/plugin-search-common": "^0.3.4-next.0",
|
|
47
|
+
"@backstage/plugin-search-react": "^0.2.0-next.2",
|
|
48
|
+
"@backstage/plugin-techdocs-react": "^0.1.1-next.2",
|
|
48
49
|
"@backstage/theme": "^0.2.15",
|
|
49
50
|
"@material-ui/core": "^4.12.2",
|
|
50
51
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -58,7 +59,6 @@
|
|
|
58
59
|
"react-helmet": "6.1.0",
|
|
59
60
|
"react-router": "6.0.0-beta.0",
|
|
60
61
|
"react-router-dom": "6.0.0-beta.0",
|
|
61
|
-
"react-text-truncate": "^0.18.0",
|
|
62
62
|
"react-use": "^17.2.4"
|
|
63
63
|
},
|
|
64
64
|
"peerDependencies": {
|
|
@@ -67,10 +67,10 @@
|
|
|
67
67
|
"react-dom": "^16.13.1 || ^17.0.0"
|
|
68
68
|
},
|
|
69
69
|
"devDependencies": {
|
|
70
|
-
"@backstage/cli": "^0.17.1-next.
|
|
71
|
-
"@backstage/core-app-api": "^1.0.1",
|
|
72
|
-
"@backstage/dev-utils": "^1.0.2-next.
|
|
73
|
-
"@backstage/test-utils": "^1.0
|
|
70
|
+
"@backstage/cli": "^0.17.1-next.2",
|
|
71
|
+
"@backstage/core-app-api": "^1.0.2-next.1",
|
|
72
|
+
"@backstage/dev-utils": "^1.0.2-next.2",
|
|
73
|
+
"@backstage/test-utils": "^1.1.0-next.2",
|
|
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",
|
|
@@ -88,5 +88,5 @@
|
|
|
88
88
|
"config.d.ts"
|
|
89
89
|
],
|
|
90
90
|
"configSchema": "config.d.ts",
|
|
91
|
-
"gitHead": "
|
|
91
|
+
"gitHead": "586464f803f55325dd11aca1cb4bc014fd80f04d"
|
|
92
92
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index-28e41621.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|