@backstage/plugin-api-docs 0.0.0-nightly-20250221023113 → 0.0.0-nightly-20250223023257

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +5 -4
  2. package/dist/alpha.d.ts +29 -28
  3. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -1,13 +1,14 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.0.0-nightly-20250221023113
3
+ ## 0.0.0-nightly-20250223023257
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/plugin-catalog-react@0.0.0-nightly-20250221023113
9
- - @backstage/plugin-catalog@0.0.0-nightly-20250221023113
10
- - @backstage/core-compat-api@0.3.6
8
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20250223023257
9
+ - @backstage/plugin-catalog@0.0.0-nightly-20250223023257
10
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20250223023257
11
+ - @backstage/core-compat-api@0.0.0-nightly-20250223023257
11
12
 
12
13
  ## 0.12.4
13
14
 
package/dist/alpha.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
1
2
  import * as _backstage_catalog_model from '@backstage/catalog-model';
2
3
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
3
4
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
@@ -69,24 +70,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
69
70
  name: "has-apis";
70
71
  config: {
71
72
  filter: string | undefined;
72
- area: "full" | "info" | "peek" | undefined;
73
+ type: "full" | "info" | "peek" | undefined;
73
74
  };
74
75
  configInput: {
75
76
  filter?: string | undefined;
76
- area?: "full" | "info" | "peek" | undefined;
77
+ type?: "full" | "info" | "peek" | undefined;
77
78
  };
78
79
  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", {
79
80
  optional: true;
80
81
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
81
82
  optional: true;
82
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
83
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
83
84
  optional: true;
84
85
  }>;
85
86
  inputs: {};
86
87
  params: {
87
88
  loader: () => Promise<JSX.Element>;
88
89
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
89
- defaultArea?: "full" | "info" | "peek" | undefined;
90
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
90
91
  };
91
92
  }>;
92
93
  "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -94,24 +95,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
94
95
  name: "definition";
95
96
  config: {
96
97
  filter: string | undefined;
97
- area: "full" | "info" | "peek" | undefined;
98
+ type: "full" | "info" | "peek" | undefined;
98
99
  };
99
100
  configInput: {
100
101
  filter?: string | undefined;
101
- area?: "full" | "info" | "peek" | undefined;
102
+ type?: "full" | "info" | "peek" | undefined;
102
103
  };
103
104
  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", {
104
105
  optional: true;
105
106
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
106
107
  optional: true;
107
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
108
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
108
109
  optional: true;
109
110
  }>;
110
111
  inputs: {};
111
112
  params: {
112
113
  loader: () => Promise<JSX.Element>;
113
114
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
114
- defaultArea?: "full" | "info" | "peek" | undefined;
115
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
115
116
  };
116
117
  }>;
117
118
  "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -119,24 +120,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
119
120
  name: "consumed-apis";
120
121
  config: {
121
122
  filter: string | undefined;
122
- area: "full" | "info" | "peek" | undefined;
123
+ type: "full" | "info" | "peek" | undefined;
123
124
  };
124
125
  configInput: {
125
126
  filter?: string | undefined;
126
- area?: "full" | "info" | "peek" | undefined;
127
+ type?: "full" | "info" | "peek" | undefined;
127
128
  };
128
129
  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", {
129
130
  optional: true;
130
131
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
131
132
  optional: true;
132
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
133
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
133
134
  optional: true;
134
135
  }>;
135
136
  inputs: {};
136
137
  params: {
137
138
  loader: () => Promise<JSX.Element>;
138
139
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
139
- defaultArea?: "full" | "info" | "peek" | undefined;
140
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
140
141
  };
141
142
  }>;
142
143
  "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -144,24 +145,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
144
145
  name: "provided-apis";
145
146
  config: {
146
147
  filter: string | undefined;
147
- area: "full" | "info" | "peek" | undefined;
148
+ type: "full" | "info" | "peek" | undefined;
148
149
  };
149
150
  configInput: {
150
151
  filter?: string | undefined;
151
- area?: "full" | "info" | "peek" | undefined;
152
+ type?: "full" | "info" | "peek" | undefined;
152
153
  };
153
154
  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", {
154
155
  optional: true;
155
156
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
156
157
  optional: true;
157
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
158
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
158
159
  optional: true;
159
160
  }>;
160
161
  inputs: {};
161
162
  params: {
162
163
  loader: () => Promise<JSX.Element>;
163
164
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
164
- defaultArea?: "full" | "info" | "peek" | undefined;
165
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
165
166
  };
166
167
  }>;
167
168
  "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -169,24 +170,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
169
170
  name: "consuming-components";
170
171
  config: {
171
172
  filter: string | undefined;
172
- area: "full" | "info" | "peek" | undefined;
173
+ type: "full" | "info" | "peek" | undefined;
173
174
  };
174
175
  configInput: {
175
176
  filter?: string | undefined;
176
- area?: "full" | "info" | "peek" | undefined;
177
+ type?: "full" | "info" | "peek" | undefined;
177
178
  };
178
179
  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", {
179
180
  optional: true;
180
181
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
181
182
  optional: true;
182
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
183
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
183
184
  optional: true;
184
185
  }>;
185
186
  inputs: {};
186
187
  params: {
187
188
  loader: () => Promise<JSX.Element>;
188
189
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
189
- defaultArea?: "full" | "info" | "peek" | undefined;
190
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
190
191
  };
191
192
  }>;
192
193
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -194,24 +195,24 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
194
195
  name: "providing-components";
195
196
  config: {
196
197
  filter: string | undefined;
197
- area: "full" | "info" | "peek" | undefined;
198
+ type: "full" | "info" | "peek" | undefined;
198
199
  };
199
200
  configInput: {
200
201
  filter?: string | undefined;
201
- area?: "full" | "info" | "peek" | undefined;
202
+ type?: "full" | "info" | "peek" | undefined;
202
203
  };
203
204
  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", {
204
205
  optional: true;
205
206
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
206
207
  optional: true;
207
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<"full" | "info" | "peek", "catalog.entity-card-area", {
208
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_catalog_react_alpha.EntityCardType, "catalog.entity-card-type", {
208
209
  optional: true;
209
210
  }>;
210
211
  inputs: {};
211
212
  params: {
212
213
  loader: () => Promise<JSX.Element>;
213
214
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
214
- defaultArea?: "full" | "info" | "peek" | undefined;
215
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
215
216
  };
216
217
  }>;
217
218
  "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -235,7 +236,7 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
235
236
  optional: true;
236
237
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
237
238
  optional: true;
238
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string | false, "catalog.entity-content-group", {
239
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-group", {
239
240
  optional: true;
240
241
  }>;
241
242
  inputs: {};
@@ -243,7 +244,7 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
243
244
  loader: () => Promise<JSX.Element>;
244
245
  defaultPath: string;
245
246
  defaultTitle: string;
246
- defaultGroup?: "documentation" | "development" | "deployment" | "observability" | undefined;
247
+ defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
247
248
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
248
249
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
249
250
  };
@@ -269,7 +270,7 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
269
270
  optional: true;
270
271
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
271
272
  optional: true;
272
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string | false, "catalog.entity-content-group", {
273
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-group", {
273
274
  optional: true;
274
275
  }>;
275
276
  inputs: {};
@@ -277,7 +278,7 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
277
278
  loader: () => Promise<JSX.Element>;
278
279
  defaultPath: string;
279
280
  defaultTitle: string;
280
- defaultGroup?: "documentation" | "development" | "deployment" | "observability" | undefined;
281
+ defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
281
282
  routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
282
283
  filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
283
284
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.0.0-nightly-20250221023113",
3
+ "version": "0.0.0-nightly-20250223023257",
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.3.6",
70
+ "@backstage/core-compat-api": "0.0.0-nightly-20250223023257",
71
71
  "@backstage/core-components": "0.16.4",
72
72
  "@backstage/core-plugin-api": "1.10.4",
73
- "@backstage/frontend-plugin-api": "0.9.5",
74
- "@backstage/plugin-catalog": "0.0.0-nightly-20250221023113",
73
+ "@backstage/frontend-plugin-api": "0.0.0-nightly-20250223023257",
74
+ "@backstage/plugin-catalog": "0.0.0-nightly-20250223023257",
75
75
  "@backstage/plugin-catalog-common": "1.1.3",
76
- "@backstage/plugin-catalog-react": "0.0.0-nightly-20250221023113",
76
+ "@backstage/plugin-catalog-react": "0.0.0-nightly-20250223023257",
77
77
  "@backstage/plugin-permission-react": "0.4.31",
78
78
  "@graphiql/react": "^0.23.0",
79
79
  "@material-ui/core": "^4.12.2",
@@ -89,7 +89,7 @@
89
89
  "devDependencies": {
90
90
  "@backstage/cli": "0.30.0",
91
91
  "@backstage/core-app-api": "1.15.5",
92
- "@backstage/dev-utils": "0.0.0-nightly-20250221023113",
92
+ "@backstage/dev-utils": "0.0.0-nightly-20250223023257",
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",