@backstage/plugin-api-docs 0.12.6-next.0 → 0.12.6-next.2
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 +34 -0
- package/dist/alpha.d.ts +10 -10
- package/dist/alpha.esm.js +14 -11
- package/dist/alpha.esm.js.map +1 -1
- package/dist/components/ApiDefinitionCard/ApiDefinitionCard.esm.js +15 -12
- package/dist/components/ApiDefinitionCard/ApiDefinitionCard.esm.js.map +1 -1
- package/dist/components/ApiDefinitionCard/ApiDefinitionWidget.esm.js +6 -6
- package/dist/components/ApiDefinitionCard/ApiDefinitionWidget.esm.js.map +1 -1
- package/dist/components/ApiDefinitionCard/ApiTypeTitle.esm.js +2 -2
- package/dist/components/ApiDefinitionCard/ApiTypeTitle.esm.js.map +1 -1
- package/dist/components/ApiDefinitionDialog/ApiDefinitionDialog.esm.js +45 -30
- package/dist/components/ApiDefinitionDialog/ApiDefinitionDialog.esm.js.map +1 -1
- package/dist/components/ApiExplorerPage/ApiExplorerPage.esm.js +2 -2
- package/dist/components/ApiExplorerPage/ApiExplorerPage.esm.js.map +1 -1
- package/dist/components/ApiExplorerPage/DefaultApiExplorerPage.esm.js +33 -17
- package/dist/components/ApiExplorerPage/DefaultApiExplorerPage.esm.js.map +1 -1
- package/dist/components/ApisCards/ConsumedApisCard.esm.js +21 -14
- package/dist/components/ApisCards/ConsumedApisCard.esm.js.map +1 -1
- package/dist/components/ApisCards/HasApisCard.esm.js +14 -7
- package/dist/components/ApisCards/HasApisCard.esm.js.map +1 -1
- package/dist/components/ApisCards/ProvidedApisCard.esm.js +21 -14
- package/dist/components/ApisCards/ProvidedApisCard.esm.js.map +1 -1
- package/dist/components/ApisCards/presets.esm.js +23 -19
- package/dist/components/ApisCards/presets.esm.js.map +1 -1
- package/dist/components/AsyncApiDefinitionWidget/AsyncApiDefinition.esm.js +2 -2
- package/dist/components/AsyncApiDefinitionWidget/AsyncApiDefinition.esm.js.map +1 -1
- package/dist/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.esm.js +4 -3
- package/dist/components/AsyncApiDefinitionWidget/AsyncApiDefinitionWidget.esm.js.map +1 -1
- package/dist/components/ComponentsCards/ConsumingComponentsCard.esm.js +10 -7
- package/dist/components/ComponentsCards/ConsumingComponentsCard.esm.js.map +1 -1
- package/dist/components/ComponentsCards/ProvidingComponentsCard.esm.js +10 -7
- package/dist/components/ComponentsCards/ProvidingComponentsCard.esm.js.map +1 -1
- package/dist/components/GraphQlDefinitionWidget/GraphQlDefinition.esm.js +6 -6
- package/dist/components/GraphQlDefinitionWidget/GraphQlDefinition.esm.js.map +1 -1
- package/dist/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.esm.js +4 -3
- package/dist/components/GraphQlDefinitionWidget/GraphQlDefinitionWidget.esm.js.map +1 -1
- package/dist/components/GrpcApiDefinitionWidget/GrpcApiDefinitionWidget.esm.js +2 -2
- package/dist/components/GrpcApiDefinitionWidget/GrpcApiDefinitionWidget.esm.js.map +1 -1
- package/dist/components/OpenApiDefinitionWidget/OpenApiDefinition.esm.js +4 -3
- package/dist/components/OpenApiDefinitionWidget/OpenApiDefinition.esm.js.map +1 -1
- package/dist/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.esm.js +5 -4
- package/dist/components/OpenApiDefinitionWidget/OpenApiDefinitionWidget.esm.js.map +1 -1
- package/dist/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.esm.js +2 -2
- package/dist/components/PlainApiDefinitionWidget/PlainApiDefinitionWidget.esm.js.map +1 -1
- package/dist/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.esm.js +2 -2
- package/dist/components/TrpcDefinitionWidget/TrpcApiDefinitionWidget.esm.js.map +1 -1
- package/dist/index.d.ts +25 -25
- package/dist/plugin.esm.js +1 -1
- package/package.json +15 -15
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import React__default from 'react';
|
|
1
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
3
2
|
import * as _backstage_core_components from '@backstage/core-components';
|
|
4
3
|
import { TableColumn, TableProps, InfoCardVariants, TableOptions } from '@backstage/core-components';
|
|
5
4
|
import { CatalogTableRow } from '@backstage/plugin-catalog';
|
|
6
5
|
import { UserListFilterKind, EntityOwnerPickerProps, EntityListPagination } from '@backstage/plugin-catalog-react';
|
|
6
|
+
import { ReactElement } from 'react';
|
|
7
7
|
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
8
8
|
import { ApiEntity, ComponentEntity } from '@backstage/catalog-model';
|
|
9
9
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
@@ -23,22 +23,22 @@ type DefaultApiExplorerPageProps = {
|
|
|
23
23
|
* DefaultApiExplorerPage
|
|
24
24
|
* @public
|
|
25
25
|
*/
|
|
26
|
-
declare const DefaultApiExplorerPage: (props: DefaultApiExplorerPageProps) =>
|
|
26
|
+
declare const DefaultApiExplorerPage: (props: DefaultApiExplorerPageProps) => react_jsx_runtime.JSX.Element;
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
29
|
* ApiExplorerPage
|
|
30
30
|
* @public
|
|
31
31
|
*/
|
|
32
|
-
declare const ApiExplorerPage$1: (props: DefaultApiExplorerPageProps) =>
|
|
32
|
+
declare const ApiExplorerPage$1: (props: DefaultApiExplorerPageProps) => react_jsx_runtime.JSX.Element;
|
|
33
33
|
|
|
34
34
|
/** @public */
|
|
35
|
-
declare const ApiDefinitionCard: () =>
|
|
35
|
+
declare const ApiDefinitionCard: () => react_jsx_runtime.JSX.Element;
|
|
36
36
|
|
|
37
37
|
/** @public */
|
|
38
38
|
type ApiDefinitionWidget = {
|
|
39
39
|
type: string;
|
|
40
40
|
title: string;
|
|
41
|
-
component: (definition: string) =>
|
|
41
|
+
component: (definition: string) => ReactElement;
|
|
42
42
|
rawLanguage?: string;
|
|
43
43
|
};
|
|
44
44
|
/** @public */
|
|
@@ -49,7 +49,7 @@ declare function defaultDefinitionWidgets(): ApiDefinitionWidget[];
|
|
|
49
49
|
*/
|
|
50
50
|
declare const ApiTypeTitle: (props: {
|
|
51
51
|
apiEntity: ApiEntity;
|
|
52
|
-
}) =>
|
|
52
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
55
|
* A dialog that lets users inspect the API definition.
|
|
@@ -60,7 +60,7 @@ declare function ApiDefinitionDialog(props: {
|
|
|
60
60
|
open: boolean;
|
|
61
61
|
entity: ApiEntity;
|
|
62
62
|
onClose: () => void;
|
|
63
|
-
}):
|
|
63
|
+
}): react_jsx_runtime.JSX.Element;
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
66
|
* @public
|
|
@@ -70,7 +70,7 @@ declare const ConsumedApisCard: (props: {
|
|
|
70
70
|
title?: string;
|
|
71
71
|
columns?: TableColumn<ApiEntity>[];
|
|
72
72
|
tableOptions?: TableOptions;
|
|
73
|
-
}) =>
|
|
73
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
76
|
* @public
|
|
@@ -80,7 +80,7 @@ declare const HasApisCard: (props: {
|
|
|
80
80
|
title?: string;
|
|
81
81
|
columns?: TableColumn<ApiEntity>[];
|
|
82
82
|
tableOptions?: TableOptions;
|
|
83
|
-
}) =>
|
|
83
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
84
84
|
|
|
85
85
|
/**
|
|
86
86
|
* @public
|
|
@@ -90,7 +90,7 @@ declare const ProvidedApisCard: (props: {
|
|
|
90
90
|
title?: string;
|
|
91
91
|
columns?: TableColumn<ApiEntity>[];
|
|
92
92
|
tableOptions?: TableOptions;
|
|
93
|
-
}) =>
|
|
93
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
94
94
|
|
|
95
95
|
/** @public */
|
|
96
96
|
type AsyncApiResolver = {
|
|
@@ -106,7 +106,7 @@ type AsyncApiDefinitionWidgetProps = {
|
|
|
106
106
|
resolvers?: AsyncApiResolver[];
|
|
107
107
|
};
|
|
108
108
|
/** @public */
|
|
109
|
-
declare const AsyncApiDefinitionWidget: (props: AsyncApiDefinitionWidgetProps) =>
|
|
109
|
+
declare const AsyncApiDefinitionWidget: (props: AsyncApiDefinitionWidgetProps) => react_jsx_runtime.JSX.Element;
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
112
|
* @public
|
|
@@ -114,20 +114,20 @@ declare const AsyncApiDefinitionWidget: (props: AsyncApiDefinitionWidgetProps) =
|
|
|
114
114
|
declare const ConsumingComponentsCard: (props: {
|
|
115
115
|
variant?: InfoCardVariants;
|
|
116
116
|
columns?: TableColumn<ComponentEntity>[];
|
|
117
|
-
}) =>
|
|
117
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
118
118
|
|
|
119
119
|
/** @public */
|
|
120
120
|
declare const ProvidingComponentsCard: (props: {
|
|
121
121
|
variant?: InfoCardVariants;
|
|
122
122
|
columns?: TableColumn<ComponentEntity>[];
|
|
123
|
-
}) =>
|
|
123
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
124
124
|
|
|
125
125
|
/** @public */
|
|
126
126
|
type GraphQlDefinitionWidgetProps = {
|
|
127
127
|
definition: string;
|
|
128
128
|
};
|
|
129
129
|
/** @public */
|
|
130
|
-
declare const GraphQlDefinitionWidget: (props: GraphQlDefinitionWidgetProps) =>
|
|
130
|
+
declare const GraphQlDefinitionWidget: (props: GraphQlDefinitionWidgetProps) => react_jsx_runtime.JSX.Element;
|
|
131
131
|
|
|
132
132
|
/** @public */
|
|
133
133
|
type OpenApiDefinitionWidgetProps = {
|
|
@@ -136,7 +136,7 @@ type OpenApiDefinitionWidgetProps = {
|
|
|
136
136
|
supportedSubmitMethods?: string[];
|
|
137
137
|
};
|
|
138
138
|
/** @public */
|
|
139
|
-
declare const OpenApiDefinitionWidget: (props: OpenApiDefinitionWidgetProps) =>
|
|
139
|
+
declare const OpenApiDefinitionWidget: (props: OpenApiDefinitionWidgetProps) => react_jsx_runtime.JSX.Element;
|
|
140
140
|
|
|
141
141
|
/** @public */
|
|
142
142
|
type PlainApiDefinitionWidgetProps = {
|
|
@@ -144,14 +144,14 @@ type PlainApiDefinitionWidgetProps = {
|
|
|
144
144
|
language: string;
|
|
145
145
|
};
|
|
146
146
|
/** @public */
|
|
147
|
-
declare const PlainApiDefinitionWidget: (props: PlainApiDefinitionWidgetProps) =>
|
|
147
|
+
declare const PlainApiDefinitionWidget: (props: PlainApiDefinitionWidgetProps) => react_jsx_runtime.JSX.Element;
|
|
148
148
|
|
|
149
149
|
/** @public */
|
|
150
150
|
type TrpcApiDefinitionWidgetProps = {
|
|
151
151
|
definition: string;
|
|
152
152
|
};
|
|
153
153
|
/** @public */
|
|
154
|
-
declare const TrpcApiDefinitionWidget: (props: TrpcApiDefinitionWidgetProps) =>
|
|
154
|
+
declare const TrpcApiDefinitionWidget: (props: TrpcApiDefinitionWidgetProps) => react_jsx_runtime.JSX.Element;
|
|
155
155
|
|
|
156
156
|
/** @public */
|
|
157
157
|
declare const apiDocsConfigRef: _backstage_core_plugin_api.ApiRef<ApiDocsConfig>;
|
|
@@ -167,39 +167,39 @@ declare const apiDocsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
|
|
|
167
167
|
registerApi: _backstage_core_plugin_api.ExternalRouteRef<undefined, true>;
|
|
168
168
|
}>;
|
|
169
169
|
/** @public */
|
|
170
|
-
declare const ApiExplorerPage: (props: DefaultApiExplorerPageProps) =>
|
|
170
|
+
declare const ApiExplorerPage: (props: DefaultApiExplorerPageProps) => react_jsx_runtime.JSX.Element;
|
|
171
171
|
/** @public */
|
|
172
|
-
declare const EntityApiDefinitionCard: () =>
|
|
172
|
+
declare const EntityApiDefinitionCard: () => react_jsx_runtime.JSX.Element;
|
|
173
173
|
/** @public */
|
|
174
174
|
declare const EntityConsumedApisCard: (props: {
|
|
175
175
|
variant?: _backstage_core_components.InfoCardVariants;
|
|
176
176
|
title?: string;
|
|
177
177
|
columns?: _backstage_core_components.TableColumn<ApiEntity>[];
|
|
178
178
|
tableOptions?: _backstage_core_components.TableOptions;
|
|
179
|
-
}) =>
|
|
179
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
180
180
|
/** @public */
|
|
181
181
|
declare const EntityConsumingComponentsCard: (props: {
|
|
182
182
|
variant?: _backstage_core_components.InfoCardVariants;
|
|
183
183
|
columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[];
|
|
184
|
-
}) =>
|
|
184
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
185
185
|
/** @public */
|
|
186
186
|
declare const EntityProvidedApisCard: (props: {
|
|
187
187
|
variant?: _backstage_core_components.InfoCardVariants;
|
|
188
188
|
title?: string;
|
|
189
189
|
columns?: _backstage_core_components.TableColumn<ApiEntity>[];
|
|
190
190
|
tableOptions?: _backstage_core_components.TableOptions;
|
|
191
|
-
}) =>
|
|
191
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
192
192
|
/** @public */
|
|
193
193
|
declare const EntityProvidingComponentsCard: (props: {
|
|
194
194
|
variant?: _backstage_core_components.InfoCardVariants;
|
|
195
195
|
columns?: _backstage_core_components.TableColumn<_backstage_catalog_model.ComponentEntity>[];
|
|
196
|
-
}) =>
|
|
196
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
197
197
|
/** @public */
|
|
198
198
|
declare const EntityHasApisCard: (props: {
|
|
199
199
|
variant?: _backstage_core_components.InfoCardVariants;
|
|
200
200
|
title?: string;
|
|
201
201
|
columns?: _backstage_core_components.TableColumn<ApiEntity>[];
|
|
202
202
|
tableOptions?: _backstage_core_components.TableOptions;
|
|
203
|
-
}) =>
|
|
203
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
204
204
|
|
|
205
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/dist/plugin.esm.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import 'react/jsx-runtime';
|
|
1
2
|
import '@backstage/plugin-catalog-react';
|
|
2
3
|
import '@material-ui/lab/Alert';
|
|
3
|
-
import 'react';
|
|
4
4
|
import { apiDocsConfigRef } from './config.esm.js';
|
|
5
5
|
import '@backstage/core-components';
|
|
6
6
|
import { createPlugin, createApiFactory, createRoutableExtension, createComponentExtension } from '@backstage/core-plugin-api';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-api-docs",
|
|
3
|
-
"version": "0.12.6-next.
|
|
3
|
+
"version": "0.12.6-next.2",
|
|
4
4
|
"description": "A Backstage plugin that helps represent API entities in the frontend",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -44,11 +44,11 @@
|
|
|
44
44
|
"types": "./dist/index.d.ts",
|
|
45
45
|
"typesVersions": {
|
|
46
46
|
"*": {
|
|
47
|
-
"*": [
|
|
48
|
-
"dist/index.d.ts"
|
|
49
|
-
],
|
|
50
47
|
"alpha": [
|
|
51
48
|
"dist/alpha.d.ts"
|
|
49
|
+
],
|
|
50
|
+
"package.json": [
|
|
51
|
+
"package.json"
|
|
52
52
|
]
|
|
53
53
|
}
|
|
54
54
|
},
|
|
@@ -67,14 +67,14 @@
|
|
|
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.4.1-next.
|
|
71
|
-
"@backstage/core-components": "0.17.
|
|
72
|
-
"@backstage/core-plugin-api": "1.10.
|
|
73
|
-
"@backstage/frontend-plugin-api": "0.10.
|
|
74
|
-
"@backstage/plugin-catalog": "1.29.0-next.
|
|
70
|
+
"@backstage/core-compat-api": "0.4.1-next.2",
|
|
71
|
+
"@backstage/core-components": "0.17.1-next.1",
|
|
72
|
+
"@backstage/core-plugin-api": "1.10.6-next.0",
|
|
73
|
+
"@backstage/frontend-plugin-api": "0.10.1-next.1",
|
|
74
|
+
"@backstage/plugin-catalog": "1.29.0-next.2",
|
|
75
75
|
"@backstage/plugin-catalog-common": "1.1.3",
|
|
76
|
-
"@backstage/plugin-catalog-react": "1.
|
|
77
|
-
"@backstage/plugin-permission-react": "0.4.
|
|
76
|
+
"@backstage/plugin-catalog-react": "1.17.0-next.2",
|
|
77
|
+
"@backstage/plugin-permission-react": "0.4.33-next.0",
|
|
78
78
|
"@graphiql/react": "^0.23.0",
|
|
79
79
|
"@material-ui/core": "^4.12.2",
|
|
80
80
|
"@material-ui/icons": "^4.9.1",
|
|
@@ -87,10 +87,10 @@
|
|
|
87
87
|
"swagger-ui-react": "^5.0.0"
|
|
88
88
|
},
|
|
89
89
|
"devDependencies": {
|
|
90
|
-
"@backstage/cli": "0.32.0-next.
|
|
91
|
-
"@backstage/core-app-api": "1.16.0",
|
|
92
|
-
"@backstage/dev-utils": "1.1.9-next.
|
|
93
|
-
"@backstage/test-utils": "1.7.
|
|
90
|
+
"@backstage/cli": "0.32.0-next.2",
|
|
91
|
+
"@backstage/core-app-api": "1.16.1-next.0",
|
|
92
|
+
"@backstage/dev-utils": "1.1.9-next.2",
|
|
93
|
+
"@backstage/test-utils": "1.7.7-next.0",
|
|
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",
|