@backstage/plugin-techdocs 0.12.2 → 0.12.6

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 CHANGED
@@ -1,5 +1,73 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
+ ## 0.12.6
4
+
5
+ ### Patch Changes
6
+
7
+ - a125278b81: Refactor out the deprecated path and icon from RouteRefs
8
+ - c1858c4cf9: Fixed entity triplet case handling for certain locales.
9
+ - f7703981a9: Use a better checkbox rendering in a task list.
10
+ - e266687580: Updates reader component used to display techdocs documentation. A previous change made this component not usable out of a page which don't have entityRef in url parameters. Reader component EntityRef parameter is now used instead of url parameters. Techdocs documentation component can now be used in our custom pages.
11
+ - Updated dependencies
12
+ - @backstage/plugin-catalog@0.7.3
13
+ - @backstage/catalog-model@0.9.7
14
+ - @backstage/plugin-catalog-react@0.6.4
15
+ - @backstage/plugin-search@0.4.18
16
+ - @backstage/core-components@0.7.4
17
+ - @backstage/core-plugin-api@0.2.0
18
+ - @backstage/integration-react@0.1.14
19
+
20
+ ## 0.12.5
21
+
22
+ ### Patch Changes
23
+
24
+ - fe5738fe1c: Lazy load `LazyLog` as it is rarely used.
25
+ - 53c9ad7e04: Update font weight for headings in TechDocs
26
+ - Updated dependencies
27
+ - @backstage/core-components@0.7.3
28
+ - @backstage/theme@0.2.13
29
+ - @backstage/plugin-search@0.4.17
30
+ - @backstage/core-plugin-api@0.1.13
31
+ - @backstage/plugin-catalog-react@0.6.3
32
+
33
+ ## 0.12.4
34
+
35
+ ### Patch Changes
36
+
37
+ - a9a8c6f7c5: Reader will now scroll to the top of the page when navigating between pages
38
+ - 106a5dc3ad: Restore original casing for `kind`, `namespace` and `name` in `DefaultTechDocsCollator`.
39
+ - Updated dependencies
40
+ - @backstage/config@0.1.11
41
+ - @backstage/theme@0.2.12
42
+ - @backstage/errors@0.1.4
43
+ - @backstage/integration@0.6.9
44
+ - @backstage/core-components@0.7.2
45
+ - @backstage/integration-react@0.1.13
46
+ - @backstage/plugin-catalog-react@0.6.2
47
+ - @backstage/catalog-model@0.9.6
48
+ - @backstage/plugin-search@0.4.16
49
+ - @backstage/core-plugin-api@0.1.12
50
+
51
+ ## 0.12.3
52
+
53
+ ### Patch Changes
54
+
55
+ - ba5b75ed2f: Add `<EntityListDocsGrid>` as an alternative to `<EntityListDocsTable>` that
56
+ shows a grid of card instead of table.
57
+
58
+ Extend `<DocsCardGrid>` to display the entity title of the entity instead of the
59
+ name if available.
60
+
61
+ - 177401b571: Display entity title (if defined) in titles of TechDocs search results
62
+ - cdf8ca6111: Only replace the shadow dom if the content is changed to avoid a flickering UI.
63
+ - Updated dependencies
64
+ - @backstage/core-components@0.7.1
65
+ - @backstage/errors@0.1.3
66
+ - @backstage/core-plugin-api@0.1.11
67
+ - @backstage/plugin-catalog@0.7.2
68
+ - @backstage/plugin-catalog-react@0.6.1
69
+ - @backstage/catalog-model@0.9.5
70
+
3
71
  ## 0.12.2
4
72
 
5
73
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -7,8 +7,8 @@ import { Config } from '@backstage/config';
7
7
  import * as _backstage_core_components from '@backstage/core-components';
8
8
  import { TableColumn, TableProps } from '@backstage/core-components';
9
9
  import { UserListFilterKind } from '@backstage/plugin-catalog-react';
10
- import React from 'react';
11
10
  import { CSSProperties } from '@material-ui/styles';
11
+ import React from 'react';
12
12
  import * as _material_table_core from '@material-table/core';
13
13
 
14
14
  declare type TechDocsMetadata = {
@@ -109,6 +109,14 @@ declare class TechDocsStorageClient implements TechDocsStorageApi {
109
109
  getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
110
110
  }
111
111
 
112
+ declare const DocsResultListItem: ({ result, lineClamp, asListItem, asLink, title, }: {
113
+ result: any;
114
+ lineClamp?: number | undefined;
115
+ asListItem?: boolean | undefined;
116
+ asLink?: boolean | undefined;
117
+ title?: string | undefined;
118
+ }) => JSX.Element;
119
+
112
120
  declare type DocsTableRow = {
113
121
  entity: Entity;
114
122
  resolved: {
@@ -118,6 +126,14 @@ declare type DocsTableRow = {
118
126
  };
119
127
  };
120
128
 
129
+ declare const DefaultTechDocsHome: ({ initialFilter, columns, actions, }: {
130
+ initialFilter?: UserListFilterKind | undefined;
131
+ columns?: TableColumn<DocsTableRow>[] | undefined;
132
+ actions?: TableProps<DocsTableRow>['actions'];
133
+ }) => JSX.Element;
134
+
135
+ declare const EntityListDocsGrid: () => JSX.Element;
136
+
121
137
  declare function createCopyDocsUrlAction(copyToClipboard: Function): (row: DocsTableRow) => {
122
138
  icon: () => JSX.Element;
123
139
  tooltip: string;
@@ -165,19 +181,6 @@ declare const EntityListDocsTable: {
165
181
  actions: typeof actionFactories;
166
182
  };
167
183
 
168
- declare const DefaultTechDocsHome: ({ initialFilter, columns, actions, }: {
169
- initialFilter?: UserListFilterKind | undefined;
170
- columns?: TableColumn<DocsTableRow>[] | undefined;
171
- actions?: TableProps<DocsTableRow>['actions'];
172
- }) => JSX.Element;
173
-
174
- declare type Props$2 = {
175
- children?: React.ReactNode;
176
- };
177
- declare const TechDocsPageWrapper: ({ children }: Props$2) => JSX.Element;
178
-
179
- declare const TechDocsPicker: () => null;
180
-
181
184
  declare type PanelType = 'DocsCardGrid' | 'DocsTable';
182
185
  interface PanelConfig {
183
186
  title: string;
@@ -192,13 +195,12 @@ interface TabConfig {
192
195
  }
193
196
  declare type TabsConfig = TabConfig[];
194
197
 
195
- declare const DocsResultListItem: ({ result, lineClamp, asListItem, asLink, title, }: {
196
- result: any;
197
- lineClamp?: number | undefined;
198
- asListItem?: boolean | undefined;
199
- asLink?: boolean | undefined;
200
- title?: string | undefined;
201
- }) => JSX.Element;
198
+ declare type Props$2 = {
199
+ children?: React.ReactNode;
200
+ };
201
+ declare const TechDocsPageWrapper: ({ children }: Props$2) => JSX.Element;
202
+
203
+ declare const TechDocsPicker: () => null;
202
204
 
203
205
  declare type TechDocsPageRenderFunction = ({ techdocsMetadataValue, entityMetadataValue, entityRef, }: {
204
206
  techdocsMetadataValue?: TechDocsMetadata | undefined;
@@ -265,4 +267,4 @@ declare type Props = {
265
267
  };
266
268
  declare const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
267
269
 
268
- export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPage, TechDocsPageHeader, TechDocsPageHeaderProps, TechDocsPageProps, TechDocsPageRenderFunction, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };
270
+ export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsGrid, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPage, TechDocsPageHeader, TechDocsPageHeaderProps, TechDocsPageProps, TechDocsPageRenderFunction, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };