@backstage/plugin-techdocs 0.0.0-nightly-20250305023316 → 0.0.0-nightly-20250306023446
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 +8 -8
- package/dist/alpha.d.ts +89 -89
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20250306023446
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
@@ -10,12 +10,12 @@
|
|
|
10
10
|
- ed1cb3e: Adds the page name of techdoc to the document's title.
|
|
11
11
|
- fe4abb8: Updates logic to check for SVG sources when inlining svgs.
|
|
12
12
|
- Updated dependencies
|
|
13
|
-
- @backstage/core-components@0.0.0-nightly-
|
|
14
|
-
- @backstage/plugin-search-react@0.0.0-nightly-
|
|
15
|
-
- @backstage/plugin-
|
|
16
|
-
- @backstage/
|
|
17
|
-
- @backstage/
|
|
18
|
-
- @backstage/
|
|
13
|
+
- @backstage/core-components@0.0.0-nightly-20250306023446
|
|
14
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20250306023446
|
|
15
|
+
- @backstage/frontend-plugin-api@0.0.0-nightly-20250306023446
|
|
16
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20250306023446
|
|
17
|
+
- @backstage/core-compat-api@0.0.0-nightly-20250306023446
|
|
18
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20250306023446
|
|
19
19
|
- @backstage/catalog-client@1.9.1
|
|
20
20
|
- @backstage/catalog-model@1.7.3
|
|
21
21
|
- @backstage/config@1.3.2
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
- @backstage/integration@1.16.1
|
|
25
25
|
- @backstage/integration-react@1.2.4
|
|
26
26
|
- @backstage/theme@0.6.4
|
|
27
|
-
- @backstage/plugin-auth-react@0.0.0-nightly-
|
|
27
|
+
- @backstage/plugin-auth-react@0.0.0-nightly-20250306023446
|
|
28
28
|
- @backstage/plugin-search-common@1.2.17
|
|
29
29
|
- @backstage/plugin-techdocs-common@0.1.0
|
|
30
30
|
|
package/dist/alpha.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
2
|
-
import * as _backstage_plugin_techdocs_react from '@backstage/plugin-techdocs-react';
|
|
3
1
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
2
|
+
import * as _backstage_plugin_techdocs_react from '@backstage/plugin-techdocs-react';
|
|
3
|
+
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
4
4
|
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
5
5
|
import * as _backstage_plugin_search_react_alpha from '@backstage/plugin-search-react/alpha';
|
|
6
6
|
import React__default from 'react';
|
|
@@ -47,23 +47,6 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
47
47
|
}>;
|
|
48
48
|
entityContent: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
49
49
|
}, {}, {
|
|
50
|
-
"nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
51
|
-
kind: "nav-item";
|
|
52
|
-
name: undefined;
|
|
53
|
-
config: {};
|
|
54
|
-
configInput: {};
|
|
55
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
|
|
56
|
-
title: string;
|
|
57
|
-
icon: _backstage_core_plugin_api.IconComponent;
|
|
58
|
-
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
59
|
-
}, "core.nav-item.target", {}>;
|
|
60
|
-
inputs: {};
|
|
61
|
-
params: {
|
|
62
|
-
title: string;
|
|
63
|
-
icon: _backstage_core_plugin_api.IconComponent;
|
|
64
|
-
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
65
|
-
};
|
|
66
|
-
}>;
|
|
67
50
|
"api:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
68
51
|
kind: "api";
|
|
69
52
|
name: undefined;
|
|
@@ -86,79 +69,21 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
86
69
|
factory: _backstage_frontend_plugin_api.AnyApiFactory;
|
|
87
70
|
};
|
|
88
71
|
}>;
|
|
89
|
-
"
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
path: string | undefined;
|
|
94
|
-
};
|
|
95
|
-
configInput: {
|
|
96
|
-
path?: string | undefined;
|
|
97
|
-
};
|
|
98
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
72
|
+
"empty-state:techdocs/entity-content": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
73
|
+
config: {};
|
|
74
|
+
configInput: {};
|
|
75
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {
|
|
99
76
|
optional: true;
|
|
100
77
|
}>;
|
|
101
|
-
inputs: {};
|
|
102
|
-
params: {
|
|
103
|
-
defaultPath: string;
|
|
104
|
-
loader: () => Promise<JSX.Element>;
|
|
105
|
-
routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
|
|
106
|
-
};
|
|
107
|
-
}>;
|
|
108
|
-
"search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
109
|
-
config: {
|
|
110
|
-
title: string | undefined;
|
|
111
|
-
lineClamp: number;
|
|
112
|
-
asLink: boolean;
|
|
113
|
-
asListItem: boolean;
|
|
114
|
-
} & {
|
|
115
|
-
noTrack: boolean;
|
|
116
|
-
};
|
|
117
|
-
configInput: {
|
|
118
|
-
title?: string | undefined;
|
|
119
|
-
lineClamp?: number | undefined;
|
|
120
|
-
asListItem?: boolean | undefined;
|
|
121
|
-
asLink?: boolean | undefined;
|
|
122
|
-
} & {
|
|
123
|
-
noTrack?: boolean | undefined;
|
|
124
|
-
};
|
|
125
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
|
|
126
|
-
predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
|
|
127
|
-
component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
|
|
128
|
-
}, "search.search-result-list-item.item", {}>;
|
|
129
78
|
inputs: {
|
|
130
79
|
[x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
|
|
131
80
|
optional: boolean;
|
|
132
81
|
singleton: boolean;
|
|
133
82
|
}>;
|
|
134
83
|
};
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
}>;
|
|
139
|
-
"page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
140
|
-
config: {
|
|
141
|
-
path: string | undefined;
|
|
142
|
-
};
|
|
143
|
-
configInput: {
|
|
144
|
-
path?: string | undefined;
|
|
145
|
-
};
|
|
146
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
147
|
-
optional: true;
|
|
148
|
-
}>;
|
|
149
|
-
inputs: {
|
|
150
|
-
addons: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_techdocs_react.TechDocsAddonOptions, "techdocs.addon", {}>, {
|
|
151
|
-
singleton: false;
|
|
152
|
-
optional: false;
|
|
153
|
-
}>;
|
|
154
|
-
};
|
|
155
|
-
kind: "page";
|
|
156
|
-
name: "reader";
|
|
157
|
-
params: {
|
|
158
|
-
defaultPath: string;
|
|
159
|
-
loader: () => Promise<JSX.Element>;
|
|
160
|
-
routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
|
|
161
|
-
};
|
|
84
|
+
params: never;
|
|
85
|
+
kind: "empty-state";
|
|
86
|
+
name: "entity-content";
|
|
162
87
|
}>;
|
|
163
88
|
"entity-content:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
164
89
|
config: {
|
|
@@ -205,21 +130,96 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
|
|
|
205
130
|
filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
|
|
206
131
|
};
|
|
207
132
|
}>;
|
|
208
|
-
"
|
|
133
|
+
"nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
134
|
+
kind: "nav-item";
|
|
135
|
+
name: undefined;
|
|
209
136
|
config: {};
|
|
210
137
|
configInput: {};
|
|
211
|
-
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<
|
|
138
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
|
|
139
|
+
title: string;
|
|
140
|
+
icon: _backstage_core_plugin_api.IconComponent;
|
|
141
|
+
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
142
|
+
}, "core.nav-item.target", {}>;
|
|
143
|
+
inputs: {};
|
|
144
|
+
params: {
|
|
145
|
+
title: string;
|
|
146
|
+
icon: _backstage_core_plugin_api.IconComponent;
|
|
147
|
+
routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
|
|
148
|
+
};
|
|
149
|
+
}>;
|
|
150
|
+
"page:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
151
|
+
kind: "page";
|
|
152
|
+
name: undefined;
|
|
153
|
+
config: {
|
|
154
|
+
path: string | undefined;
|
|
155
|
+
};
|
|
156
|
+
configInput: {
|
|
157
|
+
path?: string | undefined;
|
|
158
|
+
};
|
|
159
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
212
160
|
optional: true;
|
|
213
161
|
}>;
|
|
162
|
+
inputs: {};
|
|
163
|
+
params: {
|
|
164
|
+
defaultPath: string;
|
|
165
|
+
loader: () => Promise<JSX.Element>;
|
|
166
|
+
routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
|
|
167
|
+
};
|
|
168
|
+
}>;
|
|
169
|
+
"page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
170
|
+
config: {
|
|
171
|
+
path: string | undefined;
|
|
172
|
+
};
|
|
173
|
+
configInput: {
|
|
174
|
+
path?: string | undefined;
|
|
175
|
+
};
|
|
176
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
|
|
177
|
+
optional: true;
|
|
178
|
+
}>;
|
|
179
|
+
inputs: {
|
|
180
|
+
addons: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_techdocs_react.TechDocsAddonOptions, "techdocs.addon", {}>, {
|
|
181
|
+
singleton: false;
|
|
182
|
+
optional: false;
|
|
183
|
+
}>;
|
|
184
|
+
};
|
|
185
|
+
kind: "page";
|
|
186
|
+
name: "reader";
|
|
187
|
+
params: {
|
|
188
|
+
defaultPath: string;
|
|
189
|
+
loader: () => Promise<JSX.Element>;
|
|
190
|
+
routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
|
|
191
|
+
};
|
|
192
|
+
}>;
|
|
193
|
+
"search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
|
|
194
|
+
config: {
|
|
195
|
+
title: string | undefined;
|
|
196
|
+
lineClamp: number;
|
|
197
|
+
asLink: boolean;
|
|
198
|
+
asListItem: boolean;
|
|
199
|
+
} & {
|
|
200
|
+
noTrack: boolean;
|
|
201
|
+
};
|
|
202
|
+
configInput: {
|
|
203
|
+
title?: string | undefined;
|
|
204
|
+
lineClamp?: number | undefined;
|
|
205
|
+
asListItem?: boolean | undefined;
|
|
206
|
+
asLink?: boolean | undefined;
|
|
207
|
+
} & {
|
|
208
|
+
noTrack?: boolean | undefined;
|
|
209
|
+
};
|
|
210
|
+
output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
|
|
211
|
+
predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate | undefined;
|
|
212
|
+
component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
|
|
213
|
+
}, "search.search-result-list-item.item", {}>;
|
|
214
214
|
inputs: {
|
|
215
215
|
[x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
|
|
216
216
|
optional: boolean;
|
|
217
217
|
singleton: boolean;
|
|
218
218
|
}>;
|
|
219
219
|
};
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
220
|
+
kind: "search-result-list-item";
|
|
221
|
+
name: undefined;
|
|
222
|
+
params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
|
|
223
223
|
}>;
|
|
224
224
|
}>;
|
|
225
225
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20250306023446",
|
|
4
4
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -74,19 +74,19 @@
|
|
|
74
74
|
"@backstage/catalog-client": "1.9.1",
|
|
75
75
|
"@backstage/catalog-model": "1.7.3",
|
|
76
76
|
"@backstage/config": "1.3.2",
|
|
77
|
-
"@backstage/core-compat-api": "0.0.0-nightly-
|
|
78
|
-
"@backstage/core-components": "0.0.0-nightly-
|
|
77
|
+
"@backstage/core-compat-api": "0.0.0-nightly-20250306023446",
|
|
78
|
+
"@backstage/core-components": "0.0.0-nightly-20250306023446",
|
|
79
79
|
"@backstage/core-plugin-api": "1.10.4",
|
|
80
80
|
"@backstage/errors": "1.2.7",
|
|
81
|
-
"@backstage/frontend-plugin-api": "0.0.0-nightly-
|
|
81
|
+
"@backstage/frontend-plugin-api": "0.0.0-nightly-20250306023446",
|
|
82
82
|
"@backstage/integration": "1.16.1",
|
|
83
83
|
"@backstage/integration-react": "1.2.4",
|
|
84
|
-
"@backstage/plugin-auth-react": "0.0.0-nightly-
|
|
85
|
-
"@backstage/plugin-catalog-react": "0.0.0-nightly-
|
|
84
|
+
"@backstage/plugin-auth-react": "0.0.0-nightly-20250306023446",
|
|
85
|
+
"@backstage/plugin-catalog-react": "0.0.0-nightly-20250306023446",
|
|
86
86
|
"@backstage/plugin-search-common": "1.2.17",
|
|
87
|
-
"@backstage/plugin-search-react": "0.0.0-nightly-
|
|
87
|
+
"@backstage/plugin-search-react": "0.0.0-nightly-20250306023446",
|
|
88
88
|
"@backstage/plugin-techdocs-common": "0.1.0",
|
|
89
|
-
"@backstage/plugin-techdocs-react": "0.0.0-nightly-
|
|
89
|
+
"@backstage/plugin-techdocs-react": "0.0.0-nightly-20250306023446",
|
|
90
90
|
"@backstage/theme": "0.6.4",
|
|
91
91
|
"@material-ui/core": "^4.12.2",
|
|
92
92
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -101,11 +101,11 @@
|
|
|
101
101
|
"react-use": "^17.2.4"
|
|
102
102
|
},
|
|
103
103
|
"devDependencies": {
|
|
104
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
104
|
+
"@backstage/cli": "0.0.0-nightly-20250306023446",
|
|
105
105
|
"@backstage/core-app-api": "1.15.5",
|
|
106
|
-
"@backstage/dev-utils": "0.0.0-nightly-
|
|
107
|
-
"@backstage/plugin-catalog": "0.0.0-nightly-
|
|
108
|
-
"@backstage/plugin-techdocs-module-addons-contrib": "0.0.0-nightly-
|
|
106
|
+
"@backstage/dev-utils": "0.0.0-nightly-20250306023446",
|
|
107
|
+
"@backstage/plugin-catalog": "0.0.0-nightly-20250306023446",
|
|
108
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "0.0.0-nightly-20250306023446",
|
|
109
109
|
"@backstage/test-utils": "1.7.5",
|
|
110
110
|
"@testing-library/dom": "^10.0.0",
|
|
111
111
|
"@testing-library/jest-dom": "^6.0.0",
|