@backstage/plugin-techdocs 1.1.0-next.3 → 1.1.1-next.1

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/dist/index.d.ts CHANGED
@@ -6,7 +6,6 @@ import { DiscoveryApi, FetchApi, IdentityApi } from '@backstage/core-plugin-api'
6
6
  import { Config } from '@backstage/config';
7
7
  import * as React from 'react';
8
8
  import React__default, { ReactNode, PropsWithChildren } from 'react';
9
- import * as _material_ui_core from '@material-ui/core';
10
9
  import { ToolbarProps } from '@material-ui/core';
11
10
  import { TableColumn, TableProps } from '@backstage/core-components';
12
11
  import { UserListFilterKind } from '@backstage/plugin-catalog-react';
@@ -31,6 +30,7 @@ declare type TechDocsReaderPageRenderFunction = ({ techdocsMetadataValue, entity
31
30
  * Utility API reference for the {@link TechDocsStorageApi}.
32
31
  *
33
32
  * @public
33
+ * @deprecated Import from `@backstage/plugin-techdocs-react` instead
34
34
  */
35
35
  declare const techdocsStorageApiRef: _backstage_core_plugin_api.ApiRef<TechDocsStorageApi>;
36
36
  /**
@@ -44,12 +44,14 @@ declare const techdocsApiRef: _backstage_core_plugin_api.ApiRef<TechDocsApi>;
44
44
  * The outcome of a docs sync operation.
45
45
  *
46
46
  * @public
47
+ * @deprecated Import from `@backstage/plugin-techdocs-react` instead
47
48
  */
48
49
  declare type SyncResult = 'cached' | 'updated';
49
50
  /**
50
51
  * API which talks to TechDocs storage to fetch files to render.
51
52
  *
52
53
  * @public
54
+ * @deprecated Import from `@backstage/plugin-techdocs-react` instead
53
55
  */
54
56
  interface TechDocsStorageApi {
55
57
  getApiOrigin(): Promise<string>;
@@ -190,7 +192,7 @@ declare type TechDocsReaderPageHeaderProps = PropsWithChildren<{
190
192
  * the Tech Docs add-ons to customize it
191
193
  * @public
192
194
  */
193
- declare const TechDocsReaderPageHeader: (props: TechDocsReaderPageHeaderProps) => JSX.Element;
195
+ declare const TechDocsReaderPageHeader: (props: TechDocsReaderPageHeaderProps) => JSX.Element | null;
194
196
 
195
197
  /**
196
198
  * Props for {@link TechDocsReaderPageContent}
@@ -276,9 +278,9 @@ declare const TechDocsReaderProvider: ({ children, }: TechDocsReaderProviderProp
276
278
  * Please use the Tech Docs add-ons to customize it
277
279
  * @public
278
280
  */
279
- declare const TechDocsReaderPageSubheader: React__default.ComponentType<Pick<{
281
+ declare const TechDocsReaderPageSubheader: ({ toolbarProps, }: {
280
282
  toolbarProps?: ToolbarProps<"div", {}> | undefined;
281
- }, "toolbarProps"> & _material_ui_core.StyledComponentProps<"root">>;
283
+ }) => JSX.Element | null;
282
284
 
283
285
  /**
284
286
  * Props for {@link TechDocsSearchResultListItem}.
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-fba8389b.esm.js';
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-76cc1cd7.esm.js';
2
2
  import '@backstage/core-plugin-api';
3
3
  import '@backstage/errors';
4
4
  import 'event-source-polyfill';
@@ -36,5 +36,4 @@ import 'lodash';
36
36
  import '@material-ui/icons/Share';
37
37
  import '@material-ui/icons/Star';
38
38
  import '@material-ui/icons/StarBorder';
39
- import '@backstage/core-app-api';
40
39
  //# sourceMappingURL=index.esm.js.map
@@ -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.1.0-next.3",
4
+ "version": "1.1.1-next.1",
5
5
  "main": "dist/index.esm.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -35,24 +35,23 @@
35
35
  "clean": "backstage-cli package clean"
36
36
  },
37
37
  "dependencies": {
38
- "@backstage/catalog-model": "^1.0.1-next.1",
38
+ "@backstage/catalog-model": "^1.0.1",
39
39
  "@backstage/config": "^1.0.0",
40
- "@backstage/core-app-api": "^1.0.1-next.1",
41
- "@backstage/core-components": "^0.9.3-next.2",
42
- "@backstage/core-plugin-api": "^1.0.1-next.0",
40
+ "@backstage/core-components": "^0.9.4-next.0",
41
+ "@backstage/core-plugin-api": "^1.0.2-next.0",
43
42
  "@backstage/errors": "^1.0.0",
44
- "@backstage/integration": "^1.1.0-next.2",
45
- "@backstage/integration-react": "^1.0.1-next.2",
46
- "@backstage/plugin-catalog-react": "^1.0.1-next.3",
47
- "@backstage/plugin-search-react": "^0.1.0-next.0",
48
- "@backstage/plugin-techdocs-react": "^0.1.0-next.0",
43
+ "@backstage/integration": "^1.2.0-next.0",
44
+ "@backstage/integration-react": "^1.1.0-next.1",
45
+ "@backstage/plugin-catalog-react": "^1.1.0-next.1",
46
+ "@backstage/plugin-search-react": "^0.2.0-next.1",
47
+ "@backstage/plugin-techdocs-react": "^0.1.1-next.1",
49
48
  "@backstage/theme": "^0.2.15",
50
49
  "@material-ui/core": "^4.12.2",
51
50
  "@material-ui/icons": "^4.9.1",
52
51
  "@material-ui/lab": "4.0.0-alpha.57",
53
52
  "@material-ui/styles": "^4.10.0",
54
53
  "dompurify": "^2.2.9",
55
- "event-source-polyfill": "^1.0.25",
54
+ "event-source-polyfill": "1.0.25",
56
55
  "git-url-parse": "^11.6.0",
57
56
  "jss": "~10.8.2",
58
57
  "lodash": "^4.17.21",
@@ -68,13 +67,13 @@
68
67
  "react-dom": "^16.13.1 || ^17.0.0"
69
68
  },
70
69
  "devDependencies": {
71
- "@backstage/cli": "^0.17.0-next.3",
72
- "@backstage/core-app-api": "^1.0.1-next.1",
73
- "@backstage/dev-utils": "^1.0.1-next.1",
74
- "@backstage/test-utils": "^1.0.1-next.2",
70
+ "@backstage/cli": "^0.17.1-next.1",
71
+ "@backstage/core-app-api": "^1.0.2-next.0",
72
+ "@backstage/dev-utils": "^1.0.2-next.1",
73
+ "@backstage/test-utils": "^1.1.0-next.1",
75
74
  "@testing-library/jest-dom": "^5.10.1",
76
75
  "@testing-library/react": "^12.1.3",
77
- "@testing-library/react-hooks": "^7.0.2",
76
+ "@testing-library/react-hooks": "^8.0.0",
78
77
  "@testing-library/user-event": "^14.0.0",
79
78
  "@types/dompurify": "^2.2.2",
80
79
  "@types/event-source-polyfill": "^1.0.0",
@@ -89,5 +88,5 @@
89
88
  "config.d.ts"
90
89
  ],
91
90
  "configSchema": "config.d.ts",
92
- "gitHead": "2eca57d93ef1081f4a76a19fc994a8e9e1a19e00"
91
+ "gitHead": "0b3df66a238c66a5498dab85b1ed85a8607289f1"
93
92
  }
@@ -1 +0,0 @@
1
- {"version":3,"file":"index-7b32409a.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}