@backstage/plugin-api-docs 0.12.5-next.1 → 0.12.5-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.
Files changed (6) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/alpha.d.ts +107 -107
  3. package/dist/components/ApiDefinitionCard/ApiTypeTitle.esm.js +1 -1
  4. package/dist/components/ApiDefinitionCard/ApiTypeTitle.esm.js.map +1 -1
  5. package/dist/index.d.ts +16 -17
  6. package/package.json +11 -11
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
+ ## 0.12.5-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 74871cc: Use consistent Typography in Entity HasApisCard
8
+ - Updated dependencies
9
+ - @backstage/plugin-catalog@1.28.0-next.2
10
+ - @backstage/frontend-plugin-api@0.10.0-next.2
11
+ - @backstage/plugin-catalog-react@1.16.0-next.2
12
+ - @backstage/core-compat-api@0.4.0-next.2
13
+ - @backstage/core-components@0.16.5-next.1
14
+ - @backstage/catalog-model@1.7.3
15
+ - @backstage/core-plugin-api@1.10.4
16
+ - @backstage/plugin-catalog-common@1.1.3
17
+ - @backstage/plugin-permission-react@0.4.31
18
+
3
19
  ## 0.12.5-next.1
4
20
 
5
21
  ### Patch Changes
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,44 +20,16 @@ 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;
73
- type: "full" | "info" | "peek" | undefined;
27
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
28
+ type: "content" | "summary" | "info" | undefined;
74
29
  };
75
30
  configInput: {
76
- filter?: string | undefined;
77
- type?: "full" | "info" | "peek" | undefined;
31
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
32
+ type?: "content" | "summary" | "info" | 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", {
80
35
  optional: true;
@@ -86,20 +41,20 @@ 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;
90
- 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;
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;
98
- type: "full" | "info" | "peek" | undefined;
52
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
53
+ type: "content" | "summary" | "info" | undefined;
99
54
  };
100
55
  configInput: {
101
- filter?: string | undefined;
102
- type?: "full" | "info" | "peek" | undefined;
56
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
57
+ type?: "content" | "summary" | "info" | 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", {
105
60
  optional: true;
@@ -111,20 +66,20 @@ 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;
115
- 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;
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;
123
- type: "full" | "info" | "peek" | undefined;
77
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
78
+ type: "content" | "summary" | "info" | undefined;
124
79
  };
125
80
  configInput: {
126
- filter?: string | undefined;
127
- type?: "full" | "info" | "peek" | undefined;
81
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
82
+ type?: "content" | "summary" | "info" | 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", {
130
85
  optional: true;
@@ -136,20 +91,20 @@ 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;
140
- 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;
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;
148
- type: "full" | "info" | "peek" | undefined;
102
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
103
+ type: "content" | "summary" | "info" | undefined;
149
104
  };
150
105
  configInput: {
151
- filter?: string | undefined;
152
- type?: "full" | "info" | "peek" | undefined;
106
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
107
+ type?: "content" | "summary" | "info" | 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", {
155
110
  optional: true;
@@ -161,20 +116,20 @@ 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;
165
- 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;
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;
173
- type: "full" | "info" | "peek" | undefined;
127
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
128
+ type: "content" | "summary" | "info" | undefined;
174
129
  };
175
130
  configInput: {
176
- filter?: string | undefined;
177
- type?: "full" | "info" | "peek" | undefined;
131
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
132
+ type?: "content" | "summary" | "info" | 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", {
180
135
  optional: true;
@@ -186,20 +141,20 @@ 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;
190
- 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;
191
146
  };
192
147
  }>;
193
148
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
194
149
  kind: "entity-card";
195
150
  name: "providing-components";
196
151
  config: {
197
- filter: string | undefined;
198
- type: "full" | "info" | "peek" | undefined;
152
+ filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
153
+ type: "content" | "summary" | "info" | undefined;
199
154
  };
200
155
  configInput: {
201
- filter?: string | undefined;
202
- type?: "full" | "info" | "peek" | undefined;
156
+ filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
157
+ type?: "content" | "summary" | "info" | 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", {
205
160
  optional: true;
@@ -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;
215
- 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;
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;
@@ -244,22 +199,22 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
244
199
  loader: () => Promise<JSX.Element>;
245
200
  defaultPath: string;
246
201
  defaultTitle: string;
247
- defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
248
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
249
- filter?: string | ((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);
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;
@@ -278,9 +233,54 @@ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
278
233
  loader: () => Promise<JSX.Element>;
279
234
  defaultPath: string;
280
235
  defaultTitle: string;
281
- defaultGroup?: (string & {}) | "documentation" | "development" | "deployment" | "observability" | undefined;
282
- routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
283
- filter?: string | ((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
+ };
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;
284
284
  };
285
285
  }>;
286
286
  }>;
package/dist/components/ApiDefinitionCard/ApiTypeTitle.esm.js CHANGED
@@ -8,7 +8,7 @@ const ApiTypeTitle = (props) => {
8
8
  const config = useApi(apiDocsConfigRef);
9
9
  const definition = config.getApiDefinitionWidget(apiEntity);
10
10
  const type = definition ? definition.title : apiEntity.spec.type;
11
- return /* @__PURE__ */ React.createElement(Typography, { component: "span" }, type);
11
+ return /* @__PURE__ */ React.createElement(Typography, { component: "span", variant: "inherit" }, type);
12
12
  };
13
13
 
14
14
  export { ApiTypeTitle };
package/dist/components/ApiDefinitionCard/ApiTypeTitle.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiTypeTitle.esm.js","sources":["../../../src/components/ApiDefinitionCard/ApiTypeTitle.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiEntity } from '@backstage/catalog-model';\nimport Typography from '@material-ui/core/Typography';\nimport React from 'react';\nimport { apiDocsConfigRef } from '../../config';\nimport { useApi } from '@backstage/core-plugin-api';\n\n/**\n * @public\n */\nexport const ApiTypeTitle = (props: { apiEntity: ApiEntity }) => {\n const { apiEntity } = props;\n const config = useApi(apiDocsConfigRef);\n const definition = config.getApiDefinitionWidget(apiEntity);\n const type = definition ? definition.title : apiEntity.spec.type;\n\n return <Typography component=\"span\">{type}</Typography>;\n};\n"],"names":[],"mappings":";;;;;AAyBa,MAAA,YAAA,GAAe,CAAC,KAAoC,KAAA;AAC/D,EAAM,MAAA,EAAE,WAAc,GAAA,KAAA;AACtB,EAAM,MAAA,MAAA,GAAS,OAAO,gBAAgB,CAAA;AACtC,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,sBAAA,CAAuB,SAAS,CAAA;AAC1D,EAAA,MAAM,IAAO,GAAA,UAAA,GAAa,UAAW,CAAA,KAAA,GAAQ,UAAU,IAAK,CAAA,IAAA;AAE5D,EAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA,EAAW,SAAU,EAAA,MAAA,EAAA,EAAQ,IAAK,CAAA;AAC5C;;;;"}
1
+ {"version":3,"file":"ApiTypeTitle.esm.js","sources":["../../../src/components/ApiDefinitionCard/ApiTypeTitle.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiEntity } from '@backstage/catalog-model';\nimport Typography from '@material-ui/core/Typography';\nimport React from 'react';\nimport { apiDocsConfigRef } from '../../config';\nimport { useApi } from '@backstage/core-plugin-api';\n\n/**\n * @public\n */\nexport const ApiTypeTitle = (props: { apiEntity: ApiEntity }) => {\n const { apiEntity } = props;\n const config = useApi(apiDocsConfigRef);\n const definition = config.getApiDefinitionWidget(apiEntity);\n const type = definition ? definition.title : apiEntity.spec.type;\n\n return (\n <Typography component=\"span\" variant=\"inherit\">\n {type}\n </Typography>\n );\n};\n"],"names":[],"mappings":";;;;;AAyBa,MAAA,YAAA,GAAe,CAAC,KAAoC,KAAA;AAC/D,EAAM,MAAA,EAAE,WAAc,GAAA,KAAA;AACtB,EAAM,MAAA,MAAA,GAAS,OAAO,gBAAgB,CAAA;AACtC,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,sBAAA,CAAuB,SAAS,CAAA;AAC1D,EAAA,MAAM,IAAO,GAAA,UAAA,GAAa,UAAW,CAAA,KAAA,GAAQ,UAAU,IAAK,CAAA,IAAA;AAE5D,EAAA,2CACG,UAAW,EAAA,EAAA,SAAA,EAAU,MAAO,EAAA,OAAA,EAAQ,aAClC,IACH,CAAA;AAEJ;;;;"}
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.12.5-next.1",
3
+ "version": "0.12.5-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,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.3.7-next.1",
71
- "@backstage/core-components": "0.16.5-next.0",
70
+ "@backstage/core-compat-api": "0.4.0-next.2",
71
+ "@backstage/core-components": "0.16.5-next.1",
72
72
  "@backstage/core-plugin-api": "1.10.4",
73
- "@backstage/frontend-plugin-api": "0.9.6-next.1",
74
- "@backstage/plugin-catalog": "1.28.0-next.1",
73
+ "@backstage/frontend-plugin-api": "0.10.0-next.2",
74
+ "@backstage/plugin-catalog": "1.28.0-next.2",
75
75
  "@backstage/plugin-catalog-common": "1.1.3",
76
- "@backstage/plugin-catalog-react": "1.16.0-next.1",
76
+ "@backstage/plugin-catalog-react": "1.16.0-next.2",
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.30.1-next.0",
91
- "@backstage/core-app-api": "1.15.5",
92
- "@backstage/dev-utils": "1.1.8-next.1",
93
- "@backstage/test-utils": "1.7.5",
90
+ "@backstage/cli": "0.31.0-next.1",
91
+ "@backstage/core-app-api": "1.16.0-next.0",
92
+ "@backstage/dev-utils": "1.1.8-next.2",
93
+ "@backstage/test-utils": "1.7.6-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",