@backstage/plugin-api-docs 0.11.8 → 0.11.9-next.1

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 +31 -0
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.d.ts +141 -97
  4. package/package.json +9 -9
package/CHANGELOG.md CHANGED
@@ -1,5 +1,36 @@
1
1
  # @backstage/plugin-api-docs
2
2
 
3
+ ## 0.11.9-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/frontend-plugin-api@0.8.0-next.1
9
+ - @backstage/core-compat-api@0.3.0-next.1
10
+ - @backstage/core-components@0.14.11-next.0
11
+ - @backstage/plugin-catalog-react@1.12.4-next.1
12
+ - @backstage/catalog-model@1.6.0
13
+ - @backstage/core-plugin-api@1.9.3
14
+ - @backstage/plugin-catalog@1.22.1-next.1
15
+ - @backstage/plugin-catalog-common@1.0.26
16
+ - @backstage/plugin-permission-react@0.4.25
17
+
18
+ ## 0.11.9-next.0
19
+
20
+ ### Patch Changes
21
+
22
+ - fec8b57: Updated exports to use the new type parameters for extensions and extension blueprints.
23
+ - Updated dependencies
24
+ - @backstage/frontend-plugin-api@0.8.0-next.0
25
+ - @backstage/core-compat-api@0.2.9-next.0
26
+ - @backstage/plugin-catalog-react@1.12.4-next.0
27
+ - @backstage/plugin-catalog@1.22.1-next.0
28
+ - @backstage/catalog-model@1.6.0
29
+ - @backstage/core-components@0.14.10
30
+ - @backstage/core-plugin-api@1.9.3
31
+ - @backstage/plugin-catalog-common@1.0.26
32
+ - @backstage/plugin-permission-react@0.4.25
33
+
3
34
  ## 0.11.8
4
35
 
5
36
  ### Patch Changes
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs__alpha",
3
- "version": "0.11.8",
3
+ "version": "0.11.9-next.1",
4
4
  "main": "../dist/alpha.esm.js",
5
5
  "module": "../dist/alpha.esm.js",
6
6
  "types": "../dist/alpha.d.ts"
package/dist/alpha.d.ts CHANGED
@@ -3,160 +3,204 @@ import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
3
3
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
4
4
  import React__default from 'react';
5
5
 
6
- declare const _default: _backstage_frontend_plugin_api.BackstagePlugin<{
6
+ declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
7
7
  root: _backstage_frontend_plugin_api.RouteRef<undefined>;
8
8
  }, {
9
9
  registerApi: _backstage_frontend_plugin_api.ExternalRouteRef<undefined>;
10
10
  }, {
11
- "nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{}, {}, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
12
- title: string;
13
- icon: _backstage_core_plugin_api.IconComponent;
14
- routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
15
- }, "core.nav-item.target", {}>, {}, {
11
+ "nav-item:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
16
12
  kind: "nav-item";
17
13
  namespace: undefined;
18
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: {};
19
23
  }>;
20
- "api:api-docs/config": _backstage_frontend_plugin_api.ExtensionDefinition<{}, {}, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>, {}, {
24
+ "api:api-docs/config": _backstage_frontend_plugin_api.ExtensionDefinition<{
21
25
  kind: "api";
22
26
  namespace: undefined;
23
27
  name: "config";
28
+ config: {};
29
+ configInput: {};
30
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
31
+ inputs: {};
24
32
  }>;
25
33
  "page:api-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
26
- initiallySelectedFilter: "all" | "owned" | "starred" | undefined;
27
- } & {
28
- path: string | undefined;
29
- }, {
30
- initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
31
- } & {
32
- path?: string | undefined;
33
- }, _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", {
34
- optional: true;
35
- }>, {
36
- [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
37
- optional: boolean;
38
- singleton: boolean;
34
+ config: {
35
+ initiallySelectedFilter: "all" | "owned" | "starred" | undefined;
36
+ } & {
37
+ path: string | undefined;
38
+ };
39
+ configInput: {
40
+ initiallySelectedFilter?: "all" | "owned" | "starred" | undefined;
41
+ } & {
42
+ path?: string | undefined;
43
+ };
44
+ 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", {
45
+ optional: true;
39
46
  }>;
40
- }, {
47
+ inputs: {
48
+ [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
49
+ optional: boolean;
50
+ singleton: boolean;
51
+ }>;
52
+ };
41
53
  kind: "page";
42
54
  namespace: undefined;
43
55
  name: undefined;
44
56
  }>;
45
57
  "entity-card:api-docs/has-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
46
- filter: string | undefined;
47
- }, {
48
- filter?: string | undefined;
49
- }, _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", {
50
- optional: true;
51
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
52
- optional: true;
53
- }>, {}, {
54
58
  kind: "entity-card";
55
59
  namespace: undefined;
56
60
  name: "has-apis";
61
+ config: {
62
+ filter: string | undefined;
63
+ };
64
+ configInput: {
65
+ filter?: string | undefined;
66
+ };
67
+ 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", {
68
+ optional: true;
69
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
70
+ optional: true;
71
+ }>;
72
+ inputs: {};
57
73
  }>;
58
74
  "entity-card:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
59
- filter: string | undefined;
60
- }, {
61
- filter?: string | undefined;
62
- }, _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", {
63
- optional: true;
64
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
65
- optional: true;
66
- }>, {}, {
67
75
  kind: "entity-card";
68
76
  namespace: undefined;
69
77
  name: "definition";
78
+ config: {
79
+ filter: string | undefined;
80
+ };
81
+ configInput: {
82
+ filter?: string | undefined;
83
+ };
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", {
85
+ optional: true;
86
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
87
+ optional: true;
88
+ }>;
89
+ inputs: {};
70
90
  }>;
71
91
  "entity-card:api-docs/consumed-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
72
- filter: string | undefined;
73
- }, {
74
- filter?: string | undefined;
75
- }, _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", {
76
- optional: true;
77
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
78
- optional: true;
79
- }>, {}, {
80
92
  kind: "entity-card";
81
93
  namespace: undefined;
82
94
  name: "consumed-apis";
95
+ config: {
96
+ filter: string | undefined;
97
+ };
98
+ configInput: {
99
+ filter?: string | undefined;
100
+ };
101
+ 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", {
102
+ optional: true;
103
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
104
+ optional: true;
105
+ }>;
106
+ inputs: {};
83
107
  }>;
84
108
  "entity-card:api-docs/provided-apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
85
- filter: string | undefined;
86
- }, {
87
- filter?: string | undefined;
88
- }, _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", {
89
- optional: true;
90
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
91
- optional: true;
92
- }>, {}, {
93
109
  kind: "entity-card";
94
110
  namespace: undefined;
95
111
  name: "provided-apis";
112
+ config: {
113
+ filter: string | undefined;
114
+ };
115
+ configInput: {
116
+ filter?: string | undefined;
117
+ };
118
+ 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", {
119
+ optional: true;
120
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
121
+ optional: true;
122
+ }>;
123
+ inputs: {};
96
124
  }>;
97
125
  "entity-card:api-docs/consuming-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
98
- filter: string | undefined;
99
- }, {
100
- filter?: string | undefined;
101
- }, _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", {
102
- optional: true;
103
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
104
- optional: true;
105
- }>, {}, {
106
126
  kind: "entity-card";
107
127
  namespace: undefined;
108
128
  name: "consuming-components";
129
+ config: {
130
+ filter: string | undefined;
131
+ };
132
+ configInput: {
133
+ filter?: string | undefined;
134
+ };
135
+ 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", {
136
+ optional: true;
137
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
138
+ optional: true;
139
+ }>;
140
+ inputs: {};
109
141
  }>;
110
142
  "entity-card:api-docs/providing-components": _backstage_frontend_plugin_api.ExtensionDefinition<{
111
- filter: string | undefined;
112
- }, {
113
- filter?: string | undefined;
114
- }, _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", {
115
- optional: true;
116
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
117
- optional: true;
118
- }>, {}, {
119
143
  kind: "entity-card";
120
144
  namespace: undefined;
121
145
  name: "providing-components";
146
+ config: {
147
+ filter: string | undefined;
148
+ };
149
+ configInput: {
150
+ filter?: string | undefined;
151
+ };
152
+ 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", {
153
+ optional: true;
154
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
155
+ optional: true;
156
+ }>;
157
+ inputs: {};
122
158
  }>;
123
159
  "entity-content:api-docs/definition": _backstage_frontend_plugin_api.ExtensionDefinition<{
124
- path: string | undefined;
125
- title: string | undefined;
126
- filter: string | undefined;
127
- }, {
128
- filter?: string | undefined;
129
- title?: string | undefined;
130
- path?: string | undefined;
131
- }, _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", {
132
- optional: true;
133
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
134
- optional: true;
135
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
136
- optional: true;
137
- }>, {}, {
138
160
  kind: "entity-content";
139
161
  namespace: undefined;
140
162
  name: "definition";
163
+ config: {
164
+ path: string | undefined;
165
+ title: string | undefined;
166
+ filter: string | undefined;
167
+ };
168
+ configInput: {
169
+ filter?: string | undefined;
170
+ title?: string | undefined;
171
+ path?: string | undefined;
172
+ };
173
+ 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", {
174
+ optional: true;
175
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
176
+ optional: true;
177
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
178
+ optional: true;
179
+ }>;
180
+ inputs: {};
141
181
  }>;
142
182
  "entity-content:api-docs/apis": _backstage_frontend_plugin_api.ExtensionDefinition<{
143
- path: string | undefined;
144
- title: string | undefined;
145
- filter: string | undefined;
146
- }, {
147
- filter?: string | undefined;
148
- title?: string | undefined;
149
- path?: string | undefined;
150
- }, _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", {
151
- optional: true;
152
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
153
- optional: true;
154
- }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
155
- optional: true;
156
- }>, {}, {
157
183
  kind: "entity-content";
158
184
  namespace: undefined;
159
185
  name: "apis";
186
+ config: {
187
+ path: string | undefined;
188
+ title: string | undefined;
189
+ filter: string | undefined;
190
+ };
191
+ configInput: {
192
+ filter?: string | undefined;
193
+ title?: string | undefined;
194
+ path?: string | undefined;
195
+ };
196
+ 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", {
197
+ optional: true;
198
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
199
+ optional: true;
200
+ }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
201
+ optional: true;
202
+ }>;
203
+ inputs: {};
160
204
  }>;
161
205
  }>;
162
206
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-api-docs",
3
- "version": "0.11.8",
3
+ "version": "0.11.9-next.1",
4
4
  "description": "A Backstage plugin that helps represent API entities in the frontend",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -54,13 +54,13 @@
54
54
  "dependencies": {
55
55
  "@asyncapi/react-component": "1.3.1",
56
56
  "@backstage/catalog-model": "^1.6.0",
57
- "@backstage/core-compat-api": "^0.2.8",
58
- "@backstage/core-components": "^0.14.10",
57
+ "@backstage/core-compat-api": "^0.3.0-next.1",
58
+ "@backstage/core-components": "^0.14.11-next.0",
59
59
  "@backstage/core-plugin-api": "^1.9.3",
60
- "@backstage/frontend-plugin-api": "^0.7.0",
61
- "@backstage/plugin-catalog": "^1.22.0",
60
+ "@backstage/frontend-plugin-api": "^0.8.0-next.1",
61
+ "@backstage/plugin-catalog": "^1.22.1-next.1",
62
62
  "@backstage/plugin-catalog-common": "^1.0.26",
63
- "@backstage/plugin-catalog-react": "^1.12.3",
63
+ "@backstage/plugin-catalog-react": "^1.12.4-next.1",
64
64
  "@backstage/plugin-permission-react": "^0.4.25",
65
65
  "@graphiql/react": "^0.23.0",
66
66
  "@material-ui/core": "^4.12.2",
@@ -75,10 +75,10 @@
75
75
  "swagger-ui-react": "^5.0.0"
76
76
  },
77
77
  "devDependencies": {
78
- "@backstage/cli": "^0.27.0",
78
+ "@backstage/cli": "^0.27.1-next.1",
79
79
  "@backstage/core-app-api": "^1.14.2",
80
- "@backstage/dev-utils": "^1.0.37",
81
- "@backstage/test-utils": "^1.5.10",
80
+ "@backstage/dev-utils": "^1.0.38-next.1",
81
+ "@backstage/test-utils": "^1.6.0-next.0",
82
82
  "@testing-library/dom": "^10.0.0",
83
83
  "@testing-library/jest-dom": "^6.0.0",
84
84
  "@testing-library/react": "^15.0.0",