@backstage/plugin-api-docs 0.0.0-nightly-20250305023316 → 0.0.0-nightly-20250307023524

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,15 +1,15 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.0.0-nightly-20250305023316
3
+ ## 0.0.0-nightly-20250307023524
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/core-components@0.0.0-nightly-20250305023316
9
- - @backstage/plugin-catalog-react@0.0.0-nightly-20250305023316
10
- - @backstage/plugin-catalog@0.0.0-nightly-20250305023316
11
- - @backstage/core-compat-api@0.0.0-nightly-20250305023316
12
- - @backstage/frontend-plugin-api@0.0.0-nightly-20250305023316
8
+ - @backstage/plugin-catalog@0.0.0-nightly-20250307023524
9
+ - @backstage/core-components@0.0.0-nightly-20250307023524
10
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20250307023524
11
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20250307023524
12
+ - @backstage/core-compat-api@0.0.0-nightly-20250307023524
13
13
  - @backstage/catalog-model@1.7.3
14
14
  - @backstage/core-plugin-api@1.10.4
15
15
  - @backstage/plugin-catalog-common@1.1.3
package/dist/alpha.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
2
- import * as _backstage_catalog_model from '@backstage/catalog-model';
3
1
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
2
+ import * as _backstage_catalog_model from '@backstage/catalog-model';
3
+ import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
4
4
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
5
5
  import React__default from 'react';
6
6
 
@@ -9,23 +9,6 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
9
9
  }, {
10
10
  registerApi: _backstage_frontend_plugin_api.ExternalRouteRef<undefined>;
11
11
  }, {
12
- "nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
13
- kind: "nav-item";
14
- name: undefined;
15
- config: {};
16
- configInput: {};
17
- output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
18
- title: string;
19
- icon: _backstage_core_plugin_api.IconComponent;
20
- routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
21
- }, "core.nav-item.target", {}>;
22
- inputs: {};
23
- params: {
24
- title: string;
25
- icon: _backstage_core_plugin_api.IconComponent;
26
- routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
27
- };
28
- }>;
29
12
  "api:api-docs/config": _backstage_frontend_plugin_api.ExtensionDefinition<{
30
13
  kind: "api";
31
14
  name: "config";
@@ -37,43 +20,15 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
37
20
  factory: _backstage_frontend_plugin_api.AnyApiFactory;
38
21
  };
39
22
  }>;
40
- "page:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
41
- config: {
42
- initiallySelectedFilter: "all" | "owned" | "starred" | undefined;
43
- } & {
44
- path: string | undefined;
45
- };
46
- configInput: {
47
- initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
48
- } & {
49
- path?: string | undefined;
50
- };
51
- 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", {
52
- optional: true;
53
- }>;
54
- inputs: {
55
- [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
56
- optional: boolean;
57
- singleton: boolean;
58
- }>;
59
- };
60
- kind: "page";
61
- name: undefined;
62
- params: {
63
- defaultPath: string;
64
- loader: () => Promise<JSX.Element>;
65
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
66
- };
67
- }>;
68
- "entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
23
+ "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
69
24
  kind: "entity-card";
70
- name: "has-apis";
25
+ name: "consumed-apis";
71
26
  config: {
72
- filter: string | undefined;
27
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
73
28
  type: "full" | "info" | "peek" | undefined;
74
29
  };
75
30
  configInput: {
76
- filter?: string | undefined;
31
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
77
32
  type?: "full" | "info" | "peek" | undefined;
78
33
  };
79
34
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
@@ -86,19 +41,19 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
86
41
  inputs: {};
87
42
  params: {
88
43
  loader: () => Promise<JSX.Element>;
89
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
44
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
90
45
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
91
46
  };
92
47
  }>;
93
- "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
48
+ "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
94
49
  kind: "entity-card";
95
- name: "definition";
50
+ name: "consuming-components";
96
51
  config: {
97
- filter: string | undefined;
52
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
98
53
  type: "full" | "info" | "peek" | undefined;
99
54
  };
100
55
  configInput: {
101
- filter?: string | undefined;
56
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
102
57
  type?: "full" | "info" | "peek" | undefined;
103
58
  };
104
59
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
@@ -111,19 +66,19 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
111
66
  inputs: {};
112
67
  params: {
113
68
  loader: () => Promise<JSX.Element>;
114
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
69
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
115
70
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
116
71
  };
117
72
  }>;
118
- "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
73
+ "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
119
74
  kind: "entity-card";
120
- name: "consumed-apis";
75
+ name: "definition";
121
76
  config: {
122
- filter: string | undefined;
77
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
123
78
  type: "full" | "info" | "peek" | undefined;
124
79
  };
125
80
  configInput: {
126
- filter?: string | undefined;
81
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
127
82
  type?: "full" | "info" | "peek" | undefined;
128
83
  };
129
84
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
@@ -136,19 +91,19 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
136
91
  inputs: {};
137
92
  params: {
138
93
  loader: () => Promise<JSX.Element>;
139
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
94
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
140
95
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
141
96
  };
142
97
  }>;
143
- "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
98
+ "entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
144
99
  kind: "entity-card";
145
- name: "provided-apis";
100
+ name: "has-apis";
146
101
  config: {
147
- filter: string | undefined;
102
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
148
103
  type: "full" | "info" | "peek" | undefined;
149
104
  };
150
105
  configInput: {
151
- filter?: string | undefined;
106
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
152
107
  type?: "full" | "info" | "peek" | undefined;
153
108
  };
154
109
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
@@ -161,19 +116,19 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
161
116
  inputs: {};
162
117
  params: {
163
118
  loader: () => Promise<JSX.Element>;
164
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
119
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
165
120
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
166
121
  };
167
122
  }>;
168
- "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
123
+ "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
169
124
  kind: "entity-card";
170
- name: "consuming-components";
125
+ name: "provided-apis";
171
126
  config: {
172
- filter: string | undefined;
127
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
173
128
  type: "full" | "info" | "peek" | undefined;
174
129
  };
175
130
  configInput: {
176
- filter?: string | undefined;
131
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
177
132
  type?: "full" | "info" | "peek" | undefined;
178
133
  };
179
134
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
@@ -186,7 +141,7 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
186
141
  inputs: {};
187
142
  params: {
188
143
  loader: () => Promise<JSX.Element>;
189
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
144
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
190
145
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
191
146
  };
192
147
  }>;
@@ -194,11 +149,11 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
194
149
  kind: "entity-card";
195
150
  name: "providing-components";
196
151
  config: {
197
- filter: string | undefined;
152
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
198
153
  type: "full" | "info" | "peek" | undefined;
199
154
  };
200
155
  configInput: {
201
- filter?: string | undefined;
156
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
202
157
  type?: "full" | "info" | "peek" | undefined;
203
158
  };
204
159
  output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<React__default.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
@@ -211,21 +166,21 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
211
166
  inputs: {};
212
167
  params: {
213
168
  loader: () => Promise<JSX.Element>;
214
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
169
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
215
170
  type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
216
171
  };
217
172
  }>;
218
- "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
173
+ "entity-content:api-docs/apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
219
174
  kind: "entity-content";
220
- name: "definition";
175
+ name: "apis";
221
176
  config: {
222
177
  path: string | undefined;
223
178
  title: string | undefined;
224
- filter: string | undefined;
179
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
225
180
  group: string | false | undefined;
226
181
  };
227
182
  configInput: {
228
- filter?: string | undefined;
183
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
229
184
  title?: string | undefined;
230
185
  path?: string | undefined;
231
186
  group?: string | false | undefined;
@@ -246,20 +201,20 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
246
201
  defaultTitle: string;
247
202
  defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
248
203
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
249
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
204
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
250
205
  };
251
206
  }>;
252
- "entity-content:api-docs/apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
207
+ "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
253
208
  kind: "entity-content";
254
- name: "apis";
209
+ name: "definition";
255
210
  config: {
256
211
  path: string | undefined;
257
212
  title: string | undefined;
258
- filter: string | undefined;
213
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
259
214
  group: string | false | undefined;
260
215
  };
261
216
  configInput: {
262
- filter?: string | undefined;
217
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
263
218
  title?: string | undefined;
264
219
  path?: string | undefined;
265
220
  group?: string | false | undefined;
@@ -280,7 +235,52 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
280
235
  defaultTitle: string;
281
236
  defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
282
237
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
283
- filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
238
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
239
+ };
240
+ }>;
241
+ "nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
242
+ kind: "nav-item";
243
+ name: undefined;
244
+ config: {};
245
+ configInput: {};
246
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
247
+ title: string;
248
+ icon: _backstage_core_plugin_api.IconComponent;
249
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
250
+ }, "core.nav-item.target", {}>;
251
+ inputs: {};
252
+ params: {
253
+ title: string;
254
+ icon: _backstage_core_plugin_api.IconComponent;
255
+ routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
256
+ };
257
+ }>;
258
+ "page:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
259
+ config: {
260
+ initiallySelectedFilter: "all" | "owned" | "starred" | undefined;
261
+ } & {
262
+ path: string | undefined;
263
+ };
264
+ configInput: {
265
+ initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
266
+ } & {
267
+ path?: string | undefined;
268
+ };
269
+ 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", {
270
+ optional: true;
271
+ }>;
272
+ inputs: {
273
+ [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
274
+ optional: boolean;
275
+ singleton: boolean;
276
+ }>;
277
+ };
278
+ kind: "page";
279
+ name: undefined;
280
+ params: {
281
+ defaultPath: string;
282
+ loader: () => Promise<JSX.Element>;
283
+ routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
284
284
  };
285
285
  }>;
286
286
  }>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.0.0-nightly-20250305023316",
3
+ "version": "0.0.0-nightly-20250307023524",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -67,13 +67,13 @@
67
67
  "dependencies": {
68
68
  "@asyncapi/react-component": "^2.3.3",
69
69
  "@backstage/catalog-model": "1.7.3",
70
- "@backstage/core-compat-api": "0.0.0-nightly-20250305023316",
71
- "@backstage/core-components": "0.0.0-nightly-20250305023316",
70
+ "@backstage/core-compat-api": "0.0.0-nightly-20250307023524",
71
+ "@backstage/core-components": "0.0.0-nightly-20250307023524",
72
72
  "@backstage/core-plugin-api": "1.10.4",
73
- "@backstage/frontend-plugin-api": "0.0.0-nightly-20250305023316",
74
- "@backstage/plugin-catalog": "0.0.0-nightly-20250305023316",
73
+ "@backstage/frontend-plugin-api": "0.0.0-nightly-20250307023524",
74
+ "@backstage/plugin-catalog": "0.0.0-nightly-20250307023524",
75
75
  "@backstage/plugin-catalog-common": "1.1.3",
76
- "@backstage/plugin-catalog-react": "0.0.0-nightly-20250305023316",
76
+ "@backstage/plugin-catalog-react": "0.0.0-nightly-20250307023524",
77
77
  "@backstage/plugin-permission-react": "0.4.31",
78
78
  "@graphiql/react": "^0.23.0",
79
79
  "@material-ui/core": "^4.12.2",
@@ -87,9 +87,9 @@
87
87
  "swagger-ui-react": "^5.0.0"
88
88
  },
89
89
  "devDependencies": {
90
- "@backstage/cli": "0.0.0-nightly-20250305023316",
90
+ "@backstage/cli": "0.0.0-nightly-20250307023524",
91
91
  "@backstage/core-app-api": "1.15.5",
92
- "@backstage/dev-utils": "0.0.0-nightly-20250305023316",
92
+ "@backstage/dev-utils": "0.0.0-nightly-20250307023524",
93
93
  "@backstage/test-utils": "1.7.5",
94
94
  "@testing-library/dom": "^10.0.0",
95
95
  "@testing-library/jest-dom": "^6.0.0",