@backstage/plugin-techdocs-react 1.1.5-next.0 → 1.1.5-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 +23 -0
- package/dist/index.d.ts +8 -8
- package/package.json +9 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-react
|
|
2
2
|
|
|
3
|
+
## 1.1.5-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/core-components@0.12.6-next.2
|
|
9
|
+
- @backstage/core-plugin-api@1.5.1-next.1
|
|
10
|
+
- @backstage/catalog-model@1.2.1
|
|
11
|
+
- @backstage/config@1.0.7
|
|
12
|
+
- @backstage/version-bridge@1.0.4-next.0
|
|
13
|
+
|
|
14
|
+
## 1.1.5-next.1
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- e0c6e8b9c3c: Update peer dependencies
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
- @backstage/core-components@0.12.6-next.1
|
|
21
|
+
- @backstage/core-plugin-api@1.5.1-next.0
|
|
22
|
+
- @backstage/version-bridge@1.0.4-next.0
|
|
23
|
+
- @backstage/catalog-model@1.2.1
|
|
24
|
+
- @backstage/config@1.0.7
|
|
25
|
+
|
|
3
26
|
## 1.1.5-next.0
|
|
4
27
|
|
|
5
28
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ import { Config } from '@backstage/config';
|
|
|
10
10
|
*
|
|
11
11
|
* @public
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
type TechDocsMetadata = {
|
|
14
14
|
site_name: string;
|
|
15
15
|
site_description: string;
|
|
16
16
|
};
|
|
@@ -19,7 +19,7 @@ declare type TechDocsMetadata = {
|
|
|
19
19
|
*
|
|
20
20
|
* @public
|
|
21
21
|
*/
|
|
22
|
-
|
|
22
|
+
type TechDocsEntityMetadata = Entity & {
|
|
23
23
|
locationMetadata?: {
|
|
24
24
|
type: string;
|
|
25
25
|
target: string;
|
|
@@ -63,7 +63,7 @@ declare const TechDocsAddonLocations: Readonly<{
|
|
|
63
63
|
* Options for creating a TechDocs addon.
|
|
64
64
|
* @public
|
|
65
65
|
*/
|
|
66
|
-
|
|
66
|
+
type TechDocsAddonOptions<TAddonProps = {}> = {
|
|
67
67
|
name: string;
|
|
68
68
|
location: keyof typeof TechDocsAddonLocations;
|
|
69
69
|
component: ComponentType<TAddonProps>;
|
|
@@ -124,7 +124,7 @@ declare const techdocsApiRef: _backstage_core_plugin_api.ApiRef<TechDocsApi>;
|
|
|
124
124
|
*
|
|
125
125
|
* @public
|
|
126
126
|
*/
|
|
127
|
-
|
|
127
|
+
type SyncResult = 'cached' | 'updated';
|
|
128
128
|
/**
|
|
129
129
|
* API which talks to TechDocs storage to fetch files to render.
|
|
130
130
|
*
|
|
@@ -148,7 +148,7 @@ declare const techdocsStorageApiRef: _backstage_core_plugin_api.ApiRef<TechDocsS
|
|
|
148
148
|
/**
|
|
149
149
|
* @public type for the value of the TechDocsReaderPageContext
|
|
150
150
|
*/
|
|
151
|
-
|
|
151
|
+
type TechDocsReaderPageValue = {
|
|
152
152
|
metadata: AsyncState<TechDocsMetadata>;
|
|
153
153
|
entityRef: CompoundEntityRef;
|
|
154
154
|
entityMetadata: AsyncState<TechDocsEntityMetadata>;
|
|
@@ -168,13 +168,13 @@ declare type TechDocsReaderPageValue = {
|
|
|
168
168
|
*
|
|
169
169
|
* @public
|
|
170
170
|
*/
|
|
171
|
-
|
|
171
|
+
type TechDocsReaderPageProviderRenderFunction = (value: TechDocsReaderPageValue) => JSX.Element;
|
|
172
172
|
/**
|
|
173
173
|
* Props for {@link TechDocsReaderPageProvider}
|
|
174
174
|
*
|
|
175
175
|
* @public
|
|
176
176
|
*/
|
|
177
|
-
|
|
177
|
+
type TechDocsReaderPageProviderProps = {
|
|
178
178
|
entityRef: CompoundEntityRef;
|
|
179
179
|
children: TechDocsReaderPageProviderRenderFunction | ReactNode;
|
|
180
180
|
};
|
|
@@ -246,7 +246,7 @@ declare const useShadowDomStylesLoading: (element: Element | null) => boolean;
|
|
|
246
246
|
*
|
|
247
247
|
* @public
|
|
248
248
|
*/
|
|
249
|
-
|
|
249
|
+
type TechDocsShadowDomProps = PropsWithChildren<{
|
|
250
250
|
/**
|
|
251
251
|
* Element tree that is appended to ShadowRoot.
|
|
252
252
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-react",
|
|
3
3
|
"description": "Shared frontend utilities for TechDocs and Addons",
|
|
4
|
-
"version": "1.1.5-next.
|
|
4
|
+
"version": "1.1.5-next.2",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public",
|
|
7
7
|
"main": "dist/index.esm.js",
|
|
@@ -35,26 +35,27 @@
|
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@backstage/catalog-model": "^1.2.1",
|
|
37
37
|
"@backstage/config": "^1.0.7",
|
|
38
|
-
"@backstage/core-components": "^0.12.6-next.
|
|
39
|
-
"@backstage/core-plugin-api": "^1.5.
|
|
40
|
-
"@backstage/version-bridge": "^1.0.
|
|
38
|
+
"@backstage/core-components": "^0.12.6-next.2",
|
|
39
|
+
"@backstage/core-plugin-api": "^1.5.1-next.1",
|
|
40
|
+
"@backstage/version-bridge": "^1.0.4-next.0",
|
|
41
41
|
"@material-ui/core": "^4.12.2",
|
|
42
42
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
43
43
|
"@material-ui/styles": "^4.11.0",
|
|
44
|
+
"@types/react": "^16.13.1 || ^17.0.0",
|
|
44
45
|
"jss": "~10.10.0",
|
|
45
46
|
"lodash": "^4.17.21",
|
|
46
47
|
"react-helmet": "6.1.0",
|
|
47
48
|
"react-use": "^17.2.4"
|
|
48
49
|
},
|
|
49
50
|
"peerDependencies": {
|
|
50
|
-
"@types/react": "^16.13.1 || ^17.0.0",
|
|
51
51
|
"react": "^16.13.1 || ^17.0.0",
|
|
52
|
+
"react-dom": "^16.13.1 || ^17.0.0",
|
|
52
53
|
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
53
54
|
},
|
|
54
55
|
"devDependencies": {
|
|
55
|
-
"@backstage/cli": "^0.22.6-next.
|
|
56
|
-
"@backstage/test-utils": "^1.3.0-next.
|
|
57
|
-
"@backstage/theme": "^0.2.
|
|
56
|
+
"@backstage/cli": "^0.22.6-next.2",
|
|
57
|
+
"@backstage/test-utils": "^1.3.0-next.2",
|
|
58
|
+
"@backstage/theme": "^0.2.19-next.0",
|
|
58
59
|
"@testing-library/jest-dom": "^5.10.1",
|
|
59
60
|
"@testing-library/react": "^12.1.3",
|
|
60
61
|
"@testing-library/react-hooks": "^8.0.0"
|