@backstage/plugin-api-docs 0.0.0-nightly-20250310022211 → 0.0.0-nightly-20250311023550

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 (4) hide show
  1. package/CHANGELOG.md +6 -6
  2. package/dist/alpha.d.ts +19 -19
  3. package/dist/index.d.ts +16 -17
  4. package/package.json +10 -10
package/CHANGELOG.md CHANGED
@@ -1,16 +1,16 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
- ## 0.0.0-nightly-20250310022211
3
+ ## 0.0.0-nightly-20250311023550
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - 74871cc: Use consistent Typography in Entity HasApisCard
8
8
  - Updated dependencies
9
- - @backstage/plugin-catalog@0.0.0-nightly-20250310022211
10
- - @backstage/core-components@0.0.0-nightly-20250310022211
11
- - @backstage/frontend-plugin-api@0.0.0-nightly-20250310022211
12
- - @backstage/plugin-catalog-react@0.0.0-nightly-20250310022211
13
- - @backstage/core-compat-api@0.0.0-nightly-20250310022211
9
+ - @backstage/plugin-catalog@0.0.0-nightly-20250311023550
10
+ - @backstage/core-components@0.0.0-nightly-20250311023550
11
+ - @backstage/frontend-plugin-api@0.0.0-nightly-20250311023550
12
+ - @backstage/plugin-catalog-react@0.0.0-nightly-20250311023550
13
+ - @backstage/core-compat-api@0.0.0-nightly-20250311023550
14
14
  - @backstage/catalog-model@1.7.3
15
15
  - @backstage/core-plugin-api@1.10.4
16
16
  - @backstage/plugin-catalog-common@1.1.3
package/dist/alpha.d.ts CHANGED
@@ -41,8 +41,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
41
41
  inputs: {};
42
42
  params: {
43
43
  loader: () => Promise<JSX.Element>;
44
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
45
- type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
44
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
45
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
46
46
  };
47
47
  }>;
48
48
  "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -66,8 +66,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
66
66
  inputs: {};
67
67
  params: {
68
68
  loader: () => Promise<JSX.Element>;
69
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
70
- type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
69
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
70
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
71
71
  };
72
72
  }>;
73
73
  "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -91,8 +91,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
91
91
  inputs: {};
92
92
  params: {
93
93
  loader: () => Promise<JSX.Element>;
94
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
95
- type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
94
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
95
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
96
96
  };
97
97
  }>;
98
98
  "entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -116,8 +116,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
116
116
  inputs: {};
117
117
  params: {
118
118
  loader: () => Promise<JSX.Element>;
119
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
120
- type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
119
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
120
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
121
121
  };
122
122
  }>;
123
123
  "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -141,8 +141,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
141
141
  inputs: {};
142
142
  params: {
143
143
  loader: () => Promise<JSX.Element>;
144
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
145
- type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
144
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
145
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
146
146
  };
147
147
  }>;
148
148
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -166,8 +166,8 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
166
166
  inputs: {};
167
167
  params: {
168
168
  loader: () => Promise<JSX.Element>;
169
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
170
- type?: _backstage_plugin_catalog_react_alpha.EntityCardType | undefined;
169
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
170
+ type?: _backstage_plugin_catalog_react_alpha.EntityCardType;
171
171
  };
172
172
  }>;
173
173
  "entity-content:api-docs/apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -199,9 +199,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
199
199
  loader: () => Promise<JSX.Element>;
200
200
  defaultPath: string;
201
201
  defaultTitle: string;
202
- defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
203
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
204
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
202
+ defaultGroup?: keyof typeof _backstage_plugin_catalog_react_alpha.defaultEntityContentGroups | (string & {});
203
+ routeRef?: _backstage_frontend_plugin_api.RouteRef;
204
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
205
205
  };
206
206
  }>;
207
207
  "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -233,9 +233,9 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
233
233
  loader: () => Promise<JSX.Element>;
234
234
  defaultPath: string;
235
235
  defaultTitle: string;
236
- defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
237
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
238
- filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
236
+ defaultGroup?: keyof typeof _backstage_plugin_catalog_react_alpha.defaultEntityContentGroups | (string & {});
237
+ routeRef?: _backstage_frontend_plugin_api.RouteRef;
238
+ filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
239
239
  };
240
240
  }>;
241
241
  "nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
@@ -280,7 +280,7 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
280
280
  params: {
281
281
  defaultPath: string;
282
282
  loader: () => Promise<JSX.Element>;
283
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
283
+ routeRef?: _backstage_frontend_plugin_api.RouteRef;
284
284
  };
285
285
  }>;
286
286
  }>;
package/dist/index.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import * as React from 'react';
3
2
  import React__default from 'react';
4
3
  import * as _backstage_core_components from '@backstage/core-components';
@@ -173,34 +172,34 @@ declare const ApiExplorerPage: (props: DefaultApiExplorerPageProps) => React.JSX
173
172
  declare const EntityApiDefinitionCard: () => React.JSX.Element;
174
173
  /** @public */
175
174
  declare const EntityConsumedApisCard: (props: {
176
- variant?: _backstage_core_components.InfoCardVariants | undefined;
177
- title?: string | undefined;
178
- columns?: _backstage_core_components.TableColumn<ApiEntity>[] | undefined;
179
- tableOptions?: _backstage_core_components.TableOptions<{}> | undefined;
175
+ variant?: _backstage_core_components.InfoCardVariants;
176
+ title?: string;
177
+ columns?: _backstage_core_components.TableColumn<ApiEntity>[];
178
+ tableOptions?: _backstage_core_components.TableOptions;
180
179
  }) => React.JSX.Element;
181
180
  /** @public */
182
181
  declare const EntityConsumingComponentsCard: (props: {
183
- variant?: _backstage_core_components.InfoCardVariants | undefined;
184
- columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[] | undefined;
182
+ variant?: _backstage_core_components.InfoCardVariants;
183
+ columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[];
185
184
  }) => React.JSX.Element;
186
185
  /** @public */
187
186
  declare const EntityProvidedApisCard: (props: {
188
- variant?: _backstage_core_components.InfoCardVariants | undefined;
189
- title?: string | undefined;
190
- columns?: _backstage_core_components.TableColumn<ApiEntity>[] | undefined;
191
- tableOptions?: _backstage_core_components.TableOptions<{}> | undefined;
187
+ variant?: _backstage_core_components.InfoCardVariants;
188
+ title?: string;
189
+ columns?: _backstage_core_components.TableColumn<ApiEntity>[];
190
+ tableOptions?: _backstage_core_components.TableOptions;
192
191
  }) => React.JSX.Element;
193
192
  /** @public */
194
193
  declare const EntityProvidingComponentsCard: (props: {
195
- variant?: _backstage_core_components.InfoCardVariants | undefined;
196
- columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[] | undefined;
194
+ variant?: _backstage_core_components.InfoCardVariants;
195
+ columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[];
197
196
  }) => React.JSX.Element;
198
197
  /** @public */
199
198
  declare const EntityHasApisCard: (props: {
200
- variant?: _backstage_core_components.InfoCardVariants | undefined;
201
- title?: string | undefined;
202
- columns?: _backstage_core_components.TableColumn<ApiEntity>[] | undefined;
203
- tableOptions?: _backstage_core_components.TableOptions<{}> | undefined;
199
+ variant?: _backstage_core_components.InfoCardVariants;
200
+ title?: string;
201
+ columns?: _backstage_core_components.TableColumn<ApiEntity>[];
202
+ tableOptions?: _backstage_core_components.TableOptions;
204
203
  }) => React.JSX.Element;
205
204
 
206
205
  export { ApiDefinitionCard, ApiDefinitionDialog, type ApiDefinitionWidget, type ApiDocsConfig, ApiExplorerPage$1 as ApiExplorerIndexPage, ApiExplorerPage, ApiTypeTitle, AsyncApiDefinitionWidget, type AsyncApiDefinitionWidgetProps, type AsyncApiResolver, ConsumedApisCard, ConsumingComponentsCard, DefaultApiExplorerPage, type DefaultApiExplorerPageProps, EntityApiDefinitionCard, EntityConsumedApisCard, EntityConsumingComponentsCard, EntityHasApisCard, EntityProvidedApisCard, EntityProvidingComponentsCard, GraphQlDefinitionWidget, type GraphQlDefinitionWidgetProps, HasApisCard, OpenApiDefinitionWidget, type OpenApiDefinitionWidgetProps, PlainApiDefinitionWidget, type PlainApiDefinitionWidgetProps, ProvidedApisCard, ProvidingComponentsCard, TrpcApiDefinitionWidget, type TrpcApiDefinitionWidgetProps, apiDocsConfigRef, apiDocsPlugin, defaultDefinitionWidgets, apiDocsPlugin as plugin };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.0.0-nightly-20250310022211",
3
+ "version": "0.0.0-nightly-20250311023550",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -44,7 +44,7 @@
44
44
  "types": "./dist/index.d.ts",
45
45
  "typesVersions": {
46
46
  "*": {
47
- "index": [
47
+ "*": [
48
48
  "dist/index.d.ts"
49
49
  ],
50
50
  "alpha": [
@@ -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-20250310022211",
71
- "@backstage/core-components": "0.0.0-nightly-20250310022211",
70
+ "@backstage/core-compat-api": "0.0.0-nightly-20250311023550",
71
+ "@backstage/core-components": "0.0.0-nightly-20250311023550",
72
72
  "@backstage/core-plugin-api": "1.10.4",
73
- "@backstage/frontend-plugin-api": "0.0.0-nightly-20250310022211",
74
- "@backstage/plugin-catalog": "0.0.0-nightly-20250310022211",
73
+ "@backstage/frontend-plugin-api": "0.0.0-nightly-20250311023550",
74
+ "@backstage/plugin-catalog": "0.0.0-nightly-20250311023550",
75
75
  "@backstage/plugin-catalog-common": "1.1.3",
76
- "@backstage/plugin-catalog-react": "0.0.0-nightly-20250310022211",
76
+ "@backstage/plugin-catalog-react": "0.0.0-nightly-20250311023550",
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,10 +87,10 @@
87
87
  "swagger-ui-react": "^5.0.0"
88
88
  },
89
89
  "devDependencies": {
90
- "@backstage/cli": "0.0.0-nightly-20250310022211",
90
+ "@backstage/cli": "0.0.0-nightly-20250311023550",
91
91
  "@backstage/core-app-api": "1.15.5",
92
- "@backstage/dev-utils": "0.0.0-nightly-20250310022211",
93
- "@backstage/test-utils": "1.7.5",
92
+ "@backstage/dev-utils": "0.0.0-nightly-20250311023550",
93
+ "@backstage/test-utils": "0.0.0-nightly-20250311023550",
94
94
  "@testing-library/dom": "^10.0.0",
95
95
  "@testing-library/jest-dom": "^6.0.0",
96
96
  "@testing-library/react": "^16.0.0",