@backstage/plugin-api-docs 0.14.8 → 0.14.9

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,10 +1,64 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.14.8
3
+ ## 0.14.9
4
4
 
5
5
  ### Patch Changes
6
6
 
7
- - 640f025: The AsyncAPI definition widget no longer resolves external references by default. References to whole external documents still render, with a placeholder naming the document that was not loaded; references that point into an external document (using a `#` fragment) fail to render with an error naming the reference. To resolve external references — for example to reach internal schema registries that require authentication — provide the `resolvers` prop to enable external reference resolution.
7
+ - 24de596: Bumped the version to account for a patch release from an older release line, so that `^` ranges resolve to this release.
8
+
9
+ ## 0.14.7
10
+
11
+ ### Patch Changes
12
+
13
+ - a44c5eb: The AsyncAPI definition widget no longer resolves external references by default. References to whole external documents still render, with a placeholder naming the document that was not loaded; references that point into an external document (using a `#` fragment) fail to render with an error naming the reference. To resolve external references — for example to reach internal schema registries that require authentication — provide the `resolvers` prop to enable external reference resolution.
14
+ - 4bbc7a9: Removed explicit support for React 17: the peer dependency range for `react`, `react-dom` and `@types/react` is now `^18.0.0`. React 17 is no longer tested or guaranteed to work, although it may continue to work in some cases. See the [migration guide](https://backstage.io/docs/frontend-system/architecture/migrations#157).
15
+ - Updated dependencies
16
+ - @backstage/frontend-plugin-api@1.0.0
17
+ - @backstage/core-plugin-api@1.13.0
18
+ - @backstage/plugin-catalog@2.1.0
19
+ - @backstage/core-components@0.18.16
20
+ - @backstage/plugin-catalog-react@4.0.0
21
+ - @backstage/ui@0.20.0
22
+ - @backstage/plugin-permission-react@0.5.7
23
+ - @backstage/catalog-model@1.10.3
24
+ - @backstage/plugin-catalog-common@1.2.2
25
+
26
+ ## 0.14.7-next.2
27
+
28
+ ### Patch Changes
29
+
30
+ - Updated dependencies
31
+ - @backstage/plugin-catalog@2.0.11-next.2
32
+ - @backstage/core-components@0.18.16-next.1
33
+ - @backstage/ui@0.20.0-next.0
34
+ - @backstage/frontend-plugin-api@0.19.0-next.2
35
+ - @backstage/catalog-model@1.10.3-next.0
36
+ - @backstage/core-plugin-api@1.12.12-next.2
37
+ - @backstage/plugin-catalog-react@4.0.0-next.2
38
+ - @backstage/plugin-catalog-common@1.2.2-next.0
39
+ - @backstage/plugin-permission-react@0.5.7-next.1
40
+
41
+ ## 0.14.7-next.1
42
+
43
+ ### Patch Changes
44
+
45
+ - Updated dependencies
46
+ - @backstage/core-plugin-api@1.12.12-next.1
47
+ - @backstage/frontend-plugin-api@0.19.0-next.1
48
+ - @backstage/plugin-catalog@2.0.11-next.1
49
+ - @backstage/plugin-catalog-react@4.0.0-next.1
50
+
51
+ ## 0.14.7-next.0
52
+
53
+ ### Patch Changes
54
+
55
+ - Updated dependencies
56
+ - @backstage/frontend-plugin-api@0.18.3-next.0
57
+ - @backstage/core-plugin-api@1.12.12-next.0
58
+ - @backstage/plugin-catalog@2.0.11-next.0
59
+ - @backstage/plugin-catalog-react@4.0.0-next.0
60
+ - @backstage/core-components@0.18.16-next.0
61
+ - @backstage/plugin-permission-react@0.5.7-next.0
8
62
 
9
63
  ## 0.14.6
10
64
 
package/dist/alpha.d.ts CHANGED
@@ -15,9 +15,9 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
15
15
  name: "config";
16
16
  config: {};
17
17
  configInput: {};
18
- output: _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
18
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.ApiFactory, "core.api.factory", {}>;
19
19
  inputs: {};
20
- params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: _backstage_frontend_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_frontend_plugin_api.AnyApiFactory>;
20
+ params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: _backstage_frontend_plugin_api.ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<_backstage_frontend_plugin_api.ApiFactory>;
21
21
  }>;
22
22
  "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
23
23
  kind: "entity-card";
@@ -188,7 +188,9 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
188
188
  };
189
189
  output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
190
190
  optional: true;
191
- }> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
191
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.TranslationRefTuple<undefined>, "core.titleTranslation", {
192
+ optional: true;
193
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
192
194
  optional: true;
193
195
  }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-filter-expression", {
194
196
  optional: true;
@@ -202,7 +204,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
202
204
  defaultPath?: [Error: `Use the 'path' param instead`];
203
205
  path: string;
204
206
  defaultTitle?: [Error: `Use the 'title' param instead`];
205
- title: string;
207
+ title: string | _backstage_frontend_plugin_api.TranslationRefTuple<undefined>;
206
208
  defaultGroup?: [Error: `Use the 'group' param instead`];
207
209
  group?: keyof typeof _backstage_plugin_catalog_react_alpha.defaultEntityContentGroups | (string & {});
208
210
  icon?: string | react.ReactElement;
@@ -230,7 +232,9 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
230
232
  };
231
233
  output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
232
234
  optional: true;
233
- }> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
235
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.TranslationRefTuple<undefined>, "core.titleTranslation", {
236
+ optional: true;
237
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
234
238
  optional: true;
235
239
  }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-filter-expression", {
236
240
  optional: true;
@@ -244,7 +248,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
244
248
  defaultPath?: [Error: `Use the 'path' param instead`];
245
249
  path: string;
246
250
  defaultTitle?: [Error: `Use the 'title' param instead`];
247
- title: string;
251
+ title: string | _backstage_frontend_plugin_api.TranslationRefTuple<undefined>;
248
252
  defaultGroup?: [Error: `Use the 'group' param instead`];
249
253
  group?: keyof typeof _backstage_plugin_catalog_react_alpha.defaultEntityContentGroups | (string & {});
250
254
  icon?: string | react.ReactElement;
@@ -268,6 +272,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
268
272
  optional: true;
269
273
  }> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.title", {
270
274
  optional: true;
275
+ }> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.TranslationRefTuple<undefined>, "core.titleTranslation", {
276
+ optional: true;
271
277
  }> | _backstage_frontend_plugin_api.ExtensionDataRef<_backstage_frontend_plugin_api.IconElement, "core.icon", {
272
278
  optional: true;
273
279
  }>;
@@ -276,6 +282,8 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
276
282
  optional: true;
277
283
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.title", {
278
284
  optional: true;
285
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.TranslationRefTuple<undefined>, "core.titleTranslation", {
286
+ optional: true;
279
287
  }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.IconElement, "core.icon", {
280
288
  optional: true;
281
289
  }>, {
@@ -288,7 +296,7 @@ declare const _default: _backstage_frontend_plugin_api.OverridableFrontendPlugin
288
296
  name: undefined;
289
297
  params: {
290
298
  path: string;
291
- title?: string;
299
+ title?: string | _backstage_frontend_plugin_api.TranslationRefTuple<undefined>;
292
300
  icon?: _backstage_frontend_plugin_api.IconElement;
293
301
  loader?: () => Promise<react.JSX.Element>;
294
302
  routeRef?: _backstage_frontend_plugin_api.RouteRef;
@@ -1,5 +1,5 @@
1
1
  var name = "@backstage/plugin-api-docs";
2
- var version = "0.14.8";
2
+ var version = "0.14.9";
3
3
  var description = "A Backstage plugin that helps represent API entities in the frontend";
4
4
  var backstage = {
5
5
  role: "frontend-plugin",
@@ -92,9 +92,9 @@ var devDependencies = {
92
92
  "react-router-dom": "^6.30.2"
93
93
  };
94
94
  var peerDependencies = {
95
- "@types/react": "^17.0.0 || ^18.0.0",
96
- react: "^17.0.0 || ^18.0.0",
97
- "react-dom": "^17.0.0 || ^18.0.0",
95
+ "@types/react": "^18.0.0",
96
+ react: "^18.0.0",
97
+ "react-dom": "^18.0.0",
98
98
  "react-router-dom": "^6.30.2"
99
99
  };
100
100
  var peerDependenciesMeta = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.14.8",
3
+ "version": "0.14.9",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -66,15 +66,15 @@
66
66
  },
67
67
  "dependencies": {
68
68
  "@asyncapi/react-component": "^2.3.3",
69
- "@backstage/catalog-model": "^1.10.2",
70
- "@backstage/core-components": "^0.18.15",
71
- "@backstage/core-plugin-api": "^1.12.11",
72
- "@backstage/frontend-plugin-api": "^0.18.2",
73
- "@backstage/plugin-catalog": "^2.0.10",
74
- "@backstage/plugin-catalog-common": "^1.2.1",
75
- "@backstage/plugin-catalog-react": "^3.3.0",
76
- "@backstage/plugin-permission-react": "^0.5.6",
77
- "@backstage/ui": "^0.19.0",
69
+ "@backstage/catalog-model": "^1.10.3",
70
+ "@backstage/core-components": "^0.18.16",
71
+ "@backstage/core-plugin-api": "^1.13.0",
72
+ "@backstage/frontend-plugin-api": "^1.0.0",
73
+ "@backstage/plugin-catalog": "^2.1.0",
74
+ "@backstage/plugin-catalog-common": "^1.2.2",
75
+ "@backstage/plugin-catalog-react": "^4.0.0",
76
+ "@backstage/plugin-permission-react": "^0.5.7",
77
+ "@backstage/ui": "^0.20.0",
78
78
  "@graphiql/react": "0.29.0",
79
79
  "@material-ui/core": "^4.12.2",
80
80
  "@material-ui/icons": "^4.9.1",
@@ -87,11 +87,11 @@
87
87
  "zod": "^4.0.0"
88
88
  },
89
89
  "devDependencies": {
90
- "@backstage/cli": "^0.36.7",
91
- "@backstage/core-app-api": "^1.20.6",
92
- "@backstage/dev-utils": "^1.1.28",
93
- "@backstage/frontend-test-utils": "^0.6.5",
94
- "@backstage/test-utils": "^1.7.23",
90
+ "@backstage/cli": "^0.36.8",
91
+ "@backstage/core-app-api": "^1.20.7",
92
+ "@backstage/dev-utils": "^1.2.0",
93
+ "@backstage/frontend-test-utils": "^1.0.0",
94
+ "@backstage/test-utils": "^1.8.0",
95
95
  "@testing-library/dom": "^10.0.0",
96
96
  "@testing-library/jest-dom": "^6.0.0",
97
97
  "@testing-library/react": "^16.0.0",
@@ -105,9 +105,9 @@
105
105
  "react-router-dom": "^6.30.2"
106
106
  },
107
107
  "peerDependencies": {
108
- "@types/react": "^17.0.0 || ^18.0.0",
109
- "react": "^17.0.0 || ^18.0.0",
110
- "react-dom": "^17.0.0 || ^18.0.0",
108
+ "@types/react": "^18.0.0",
109
+ "react": "^18.0.0",
110
+ "react-dom": "^18.0.0",
111
111
  "react-router-dom": "^6.30.2"
112
112
  },
113
113
  "peerDependenciesMeta": {