@backstage/plugin-techdocs 1.4.4-next.0 → 1.5.0-next.2
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 +45 -0
- package/dist/esm/{TechDocsCustomHome-4797a9b1.esm.js → TechDocsCustomHome-a4e83d73.esm.js} +3 -3
- package/dist/esm/{TechDocsCustomHome-4797a9b1.esm.js.map → TechDocsCustomHome-a4e83d73.esm.js.map} +1 -1
- package/dist/esm/{index-e3782e53.esm.js → index-7822455f.esm.js} +33 -23
- package/dist/esm/index-7822455f.esm.js.map +1 -0
- package/dist/esm/{index-c8c3fb5d.esm.js → index-8d041ffc.esm.js} +3 -3
- package/dist/esm/index-8d041ffc.esm.js.map +1 -0
- package/dist/index.d.ts +27 -24
- package/dist/index.esm.js +2 -2
- package/package.json +12 -12
- package/dist/esm/index-c8c3fb5d.esm.js.map +0 -1
- package/dist/esm/index-e3782e53.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-7822455f.esm.js';
|
|
2
2
|
import '@backstage/core-plugin-api';
|
|
3
3
|
import '@backstage/errors';
|
|
4
4
|
import 'event-source-polyfill';
|
|
@@ -9,8 +9,8 @@ import 'react-use/lib/useAsync';
|
|
|
9
9
|
import 'react-use/lib/useAsyncRetry';
|
|
10
10
|
import '@backstage/core-components';
|
|
11
11
|
import '@material-ui/core';
|
|
12
|
-
import '@material-ui/core/Typography';
|
|
13
12
|
import '@backstage/plugin-search-react';
|
|
13
|
+
import '@material-ui/core/Typography';
|
|
14
14
|
import '@material-ui/lab';
|
|
15
15
|
import '@material-ui/icons/Close';
|
|
16
16
|
import '@backstage/integration-react';
|
|
@@ -32,4 +32,4 @@ import '@material-ui/icons/Share';
|
|
|
32
32
|
import '@material-ui/styles';
|
|
33
33
|
import '@material-ui/icons/Star';
|
|
34
34
|
import '@material-ui/icons/StarBorder';
|
|
35
|
-
//# sourceMappingURL=index-
|
|
35
|
+
//# sourceMappingURL=index-8d041ffc.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-8d041ffc.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -7,10 +7,11 @@ 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 {
|
|
11
|
-
import { TableColumn, TableProps } from '@backstage/core-components';
|
|
10
|
+
import { TableColumn, TableProps, TableOptions } from '@backstage/core-components';
|
|
12
11
|
import { UserListFilterKind } from '@backstage/plugin-catalog-react';
|
|
13
12
|
import { CSSProperties } from '@material-ui/styles';
|
|
13
|
+
import { SearchResultListItemExtensionProps } from '@backstage/plugin-search-react';
|
|
14
|
+
import { ResultHighlight } from '@backstage/plugin-search-common';
|
|
14
15
|
|
|
15
16
|
/**
|
|
16
17
|
* Helper function that gives the children of {@link TechDocsReaderPage} access to techdocs and entity metadata
|
|
@@ -283,28 +284,6 @@ declare const TechDocsReaderPageSubheader: (props: {
|
|
|
283
284
|
toolbarProps?: ToolbarProps;
|
|
284
285
|
}) => JSX.Element | null;
|
|
285
286
|
|
|
286
|
-
/**
|
|
287
|
-
* Props for {@link TechDocsSearchResultListItem}.
|
|
288
|
-
*
|
|
289
|
-
* @public
|
|
290
|
-
*/
|
|
291
|
-
declare type TechDocsSearchResultListItemProps = {
|
|
292
|
-
icon?: ReactNode;
|
|
293
|
-
result: any;
|
|
294
|
-
highlight?: ResultHighlight;
|
|
295
|
-
rank?: number;
|
|
296
|
-
lineClamp?: number;
|
|
297
|
-
asListItem?: boolean;
|
|
298
|
-
asLink?: boolean;
|
|
299
|
-
title?: string;
|
|
300
|
-
};
|
|
301
|
-
/**
|
|
302
|
-
* Component which renders documentation and related metadata.
|
|
303
|
-
*
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
declare const TechDocsSearchResultListItem: (props: TechDocsSearchResultListItemProps) => JSX.Element;
|
|
307
|
-
|
|
308
287
|
/**
|
|
309
288
|
* Props for {@link TechDocsSearch}
|
|
310
289
|
*
|
|
@@ -383,6 +362,7 @@ declare type DocsTableRow = {
|
|
|
383
362
|
declare type EntityListDocsTableProps = {
|
|
384
363
|
columns?: TableColumn<DocsTableRow>[];
|
|
385
364
|
actions?: TableProps<DocsTableRow>['actions'];
|
|
365
|
+
options?: TableOptions<DocsTableRow>;
|
|
386
366
|
};
|
|
387
367
|
/**
|
|
388
368
|
* Component which renders a table with entities from catalog.
|
|
@@ -424,6 +404,7 @@ declare type DocsTableProps = {
|
|
|
424
404
|
loading?: boolean | undefined;
|
|
425
405
|
columns?: TableColumn<DocsTableRow>[];
|
|
426
406
|
actions?: TableProps<DocsTableRow>['actions'];
|
|
407
|
+
options?: TableOptions<DocsTableRow>;
|
|
427
408
|
};
|
|
428
409
|
/**
|
|
429
410
|
* Component which renders a table documents
|
|
@@ -543,6 +524,22 @@ declare const TechDocsPageWrapper: (props: TechDocsPageWrapperProps) => JSX.Elem
|
|
|
543
524
|
*/
|
|
544
525
|
declare const TechDocsPicker: () => null;
|
|
545
526
|
|
|
527
|
+
/**
|
|
528
|
+
* Props for {@link TechDocsSearchResultListItem}.
|
|
529
|
+
*
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
declare type TechDocsSearchResultListItemProps = {
|
|
533
|
+
icon?: ReactNode;
|
|
534
|
+
result?: any;
|
|
535
|
+
highlight?: ResultHighlight;
|
|
536
|
+
rank?: number;
|
|
537
|
+
lineClamp?: number;
|
|
538
|
+
asListItem?: boolean;
|
|
539
|
+
asLink?: boolean;
|
|
540
|
+
title?: string;
|
|
541
|
+
};
|
|
542
|
+
|
|
546
543
|
/**
|
|
547
544
|
* The Backstage plugin that renders technical documentation for your components
|
|
548
545
|
*
|
|
@@ -589,6 +586,12 @@ declare const TechDocsIndexPage: (props: TechDocsIndexPageProps) => JSX.Element;
|
|
|
589
586
|
* @public
|
|
590
587
|
*/
|
|
591
588
|
declare const TechDocsReaderPage: (props: TechDocsReaderPageProps) => JSX.Element;
|
|
589
|
+
/**
|
|
590
|
+
* React extension used to render results on Search page or modal
|
|
591
|
+
*
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
declare const TechDocsSearchResultListItem: (props: SearchResultListItemExtensionProps<TechDocsSearchResultListItemProps>) => JSX.Element | null;
|
|
592
595
|
|
|
593
596
|
/**
|
|
594
597
|
* Helper that takes in entity and returns true/false if TechDocs is available for the entity
|
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,
|
|
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-7822455f.esm.js';
|
|
2
2
|
import '@backstage/core-plugin-api';
|
|
3
3
|
import '@backstage/errors';
|
|
4
4
|
import 'event-source-polyfill';
|
|
@@ -9,8 +9,8 @@ import 'react-use/lib/useAsync';
|
|
|
9
9
|
import 'react-use/lib/useAsyncRetry';
|
|
10
10
|
import '@backstage/core-components';
|
|
11
11
|
import '@material-ui/core';
|
|
12
|
-
import '@material-ui/core/Typography';
|
|
13
12
|
import '@backstage/plugin-search-react';
|
|
13
|
+
import '@material-ui/core/Typography';
|
|
14
14
|
import '@material-ui/lab';
|
|
15
15
|
import '@material-ui/icons/Close';
|
|
16
16
|
import '@backstage/integration-react';
|
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.5.0-next.2",
|
|
5
5
|
"main": "dist/index.esm.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -33,17 +33,17 @@
|
|
|
33
33
|
"clean": "backstage-cli package clean"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@backstage/catalog-model": "^1.
|
|
36
|
+
"@backstage/catalog-model": "^1.2.0-next.1",
|
|
37
37
|
"@backstage/config": "^1.0.6",
|
|
38
|
-
"@backstage/core-components": "^0.12.
|
|
38
|
+
"@backstage/core-components": "^0.12.4-next.1",
|
|
39
39
|
"@backstage/core-plugin-api": "^1.3.0",
|
|
40
40
|
"@backstage/errors": "^1.1.4",
|
|
41
41
|
"@backstage/integration": "^1.4.2",
|
|
42
|
-
"@backstage/integration-react": "^1.1.
|
|
43
|
-
"@backstage/plugin-catalog-react": "^1.3.0-next.
|
|
42
|
+
"@backstage/integration-react": "^1.1.10-next.1",
|
|
43
|
+
"@backstage/plugin-catalog-react": "^1.3.0-next.2",
|
|
44
44
|
"@backstage/plugin-search-common": "^1.2.1",
|
|
45
|
-
"@backstage/plugin-search-react": "^1.
|
|
46
|
-
"@backstage/plugin-techdocs-react": "^1.1.3-next.
|
|
45
|
+
"@backstage/plugin-search-react": "^1.5.0-next.1",
|
|
46
|
+
"@backstage/plugin-techdocs-react": "^1.1.3-next.2",
|
|
47
47
|
"@backstage/theme": "^0.2.16",
|
|
48
48
|
"@material-ui/core": "^4.12.2",
|
|
49
49
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -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.1",
|
|
68
|
-
"@backstage/core-app-api": "^1.4.0",
|
|
69
|
-
"@backstage/dev-utils": "^1.0.12-next.
|
|
70
|
-
"@backstage/plugin-techdocs-module-addons-contrib": "^1.0.10-next.
|
|
71
|
-
"@backstage/test-utils": "^1.2.
|
|
67
|
+
"@backstage/cli": "^0.22.2-next.1",
|
|
68
|
+
"@backstage/core-app-api": "^1.4.1-next.0",
|
|
69
|
+
"@backstage/dev-utils": "^1.0.12-next.2",
|
|
70
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "^1.0.10-next.2",
|
|
71
|
+
"@backstage/test-utils": "^1.2.5-next.0",
|
|
72
72
|
"@testing-library/jest-dom": "^5.10.1",
|
|
73
73
|
"@testing-library/react": "^12.1.3",
|
|
74
74
|
"@testing-library/react-hooks": "^8.0.0",
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index-c8c3fb5d.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|