@backstage/core-app-api 1.20.2 → 1.20.3-next.0
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 +8 -0
- package/config.schema.json +223 -0
- package/package.json +10 -10
- package/config.d.ts +0 -176
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"app": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"baseUrl": {
|
|
9
|
+
"type": "string",
|
|
10
|
+
"description": "The public absolute root URL that the frontend.",
|
|
11
|
+
"visibility": "frontend"
|
|
12
|
+
},
|
|
13
|
+
"title": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"description": "The title of the app, as shown in the Backstage web interface.",
|
|
16
|
+
"visibility": "frontend"
|
|
17
|
+
},
|
|
18
|
+
"support": {
|
|
19
|
+
"type": "object",
|
|
20
|
+
"properties": {
|
|
21
|
+
"url": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"description": "The primary support url.",
|
|
24
|
+
"visibility": "frontend"
|
|
25
|
+
},
|
|
26
|
+
"items": {
|
|
27
|
+
"type": "array",
|
|
28
|
+
"items": {
|
|
29
|
+
"type": "object",
|
|
30
|
+
"properties": {
|
|
31
|
+
"title": {
|
|
32
|
+
"type": "string",
|
|
33
|
+
"description": "The title of the support item grouping.",
|
|
34
|
+
"visibility": "frontend"
|
|
35
|
+
},
|
|
36
|
+
"icon": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"description": "An optional icon for the support item grouping.",
|
|
39
|
+
"visibility": "frontend"
|
|
40
|
+
},
|
|
41
|
+
"links": {
|
|
42
|
+
"type": "array",
|
|
43
|
+
"items": {
|
|
44
|
+
"type": "object",
|
|
45
|
+
"properties": {
|
|
46
|
+
"url": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"visibility": "frontend"
|
|
49
|
+
},
|
|
50
|
+
"title": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"visibility": "frontend"
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
"required": [
|
|
56
|
+
"url"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
"description": "A list of support links for the Backstage instance inside this grouping."
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
"required": [
|
|
63
|
+
"title",
|
|
64
|
+
"links"
|
|
65
|
+
]
|
|
66
|
+
},
|
|
67
|
+
"description": "A list of categorized support item groupings."
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"required": [
|
|
71
|
+
"url",
|
|
72
|
+
"items"
|
|
73
|
+
],
|
|
74
|
+
"description": "Information about support of this Backstage instance and how to contact the integrator team."
|
|
75
|
+
},
|
|
76
|
+
"routes": {
|
|
77
|
+
"type": "object",
|
|
78
|
+
"properties": {
|
|
79
|
+
"bindings": {
|
|
80
|
+
"type": "object",
|
|
81
|
+
"additionalProperties": {
|
|
82
|
+
"anyOf": [
|
|
83
|
+
{
|
|
84
|
+
"type": "string"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"type": "boolean",
|
|
88
|
+
"const": false
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
},
|
|
92
|
+
"description": "Maps external route references to regular route references. Both the key and the value is expected to be on the form `<pluginId>.<routeId>`. If the value is `false`, the route will be disabled even if it has a default mapping.",
|
|
93
|
+
"deepVisibility": "frontend"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"required": [
|
|
99
|
+
"baseUrl"
|
|
100
|
+
],
|
|
101
|
+
"description": "Generic frontend configuration."
|
|
102
|
+
},
|
|
103
|
+
"backend": {
|
|
104
|
+
"type": "object",
|
|
105
|
+
"properties": {
|
|
106
|
+
"baseUrl": {
|
|
107
|
+
"type": "string",
|
|
108
|
+
"description": "The public absolute root URL that the backend is reachable at, from the browser's perspective.",
|
|
109
|
+
"visibility": "frontend"
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
"required": [
|
|
113
|
+
"baseUrl"
|
|
114
|
+
],
|
|
115
|
+
"description": "Generic backend configuration."
|
|
116
|
+
},
|
|
117
|
+
"organization": {
|
|
118
|
+
"type": "object",
|
|
119
|
+
"properties": {
|
|
120
|
+
"name": {
|
|
121
|
+
"type": "string",
|
|
122
|
+
"description": "The name of the organization that the app belongs to.",
|
|
123
|
+
"visibility": "frontend"
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
"description": "Configuration that provides information about the organization that the app is for."
|
|
127
|
+
},
|
|
128
|
+
"homepage": {
|
|
129
|
+
"type": "object",
|
|
130
|
+
"properties": {
|
|
131
|
+
"clocks": {
|
|
132
|
+
"type": "array",
|
|
133
|
+
"items": {
|
|
134
|
+
"type": "object",
|
|
135
|
+
"properties": {
|
|
136
|
+
"label": {
|
|
137
|
+
"type": "string",
|
|
138
|
+
"visibility": "frontend"
|
|
139
|
+
},
|
|
140
|
+
"timezone": {
|
|
141
|
+
"type": "string",
|
|
142
|
+
"visibility": "frontend"
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"required": [
|
|
146
|
+
"label",
|
|
147
|
+
"timezone"
|
|
148
|
+
]
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
},
|
|
152
|
+
"description": "This config was used by the HomepageTimer but has been replaced by the HeaderWorldClock in the home plugin",
|
|
153
|
+
"deprecated": "in favor of the HeaderWorldClock which is found in the home plugin"
|
|
154
|
+
},
|
|
155
|
+
"auth": {
|
|
156
|
+
"type": "object",
|
|
157
|
+
"properties": {
|
|
158
|
+
"environment": {
|
|
159
|
+
"type": "string",
|
|
160
|
+
"description": "The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`. default value: 'development' optional values: 'development' | 'production'",
|
|
161
|
+
"visibility": "frontend"
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"description": "Configuration that provides information on available configured authentication providers."
|
|
165
|
+
},
|
|
166
|
+
"enableExperimentalRedirectFlow": {
|
|
167
|
+
"type": "boolean",
|
|
168
|
+
"description": "Enable redirect authentication flow type, instead of a popup for authentication.",
|
|
169
|
+
"visibility": "frontend"
|
|
170
|
+
},
|
|
171
|
+
"discovery": {
|
|
172
|
+
"type": "object",
|
|
173
|
+
"properties": {
|
|
174
|
+
"endpoints": {
|
|
175
|
+
"type": "array",
|
|
176
|
+
"items": {
|
|
177
|
+
"type": "object",
|
|
178
|
+
"properties": {
|
|
179
|
+
"target": {
|
|
180
|
+
"anyOf": [
|
|
181
|
+
{
|
|
182
|
+
"type": "string"
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"type": "object",
|
|
186
|
+
"properties": {
|
|
187
|
+
"external": {
|
|
188
|
+
"type": "string",
|
|
189
|
+
"visibility": "frontend"
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
],
|
|
194
|
+
"description": "The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys. (Internal is used for the backend, external for the frontend) Targets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.",
|
|
195
|
+
"visibility": "frontend"
|
|
196
|
+
},
|
|
197
|
+
"plugins": {
|
|
198
|
+
"type": "array",
|
|
199
|
+
"items": {
|
|
200
|
+
"type": "string"
|
|
201
|
+
},
|
|
202
|
+
"description": "Array of plugins which use the target baseUrl.",
|
|
203
|
+
"visibility": "frontend"
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
"required": [
|
|
207
|
+
"target",
|
|
208
|
+
"plugins"
|
|
209
|
+
]
|
|
210
|
+
},
|
|
211
|
+
"description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
|
|
212
|
+
"visibility": "frontend"
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
"description": "Discovery options.",
|
|
216
|
+
"visibility": "frontend"
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
"required": [
|
|
220
|
+
"app",
|
|
221
|
+
"backend"
|
|
222
|
+
]
|
|
223
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/core-app-api",
|
|
3
|
-
"version": "1.20.
|
|
3
|
+
"version": "1.20.3-next.0",
|
|
4
4
|
"description": "Core app API used by Backstage apps",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "web-library"
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
},
|
|
39
39
|
"files": [
|
|
40
40
|
"dist",
|
|
41
|
-
"config.
|
|
41
|
+
"config.schema.json"
|
|
42
42
|
],
|
|
43
43
|
"scripts": {
|
|
44
44
|
"build": "backstage-cli package build",
|
|
@@ -50,11 +50,11 @@
|
|
|
50
50
|
"test": "backstage-cli package test"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
|
-
"@backstage/config": "
|
|
54
|
-
"@backstage/core-plugin-api": "
|
|
55
|
-
"@backstage/types": "
|
|
56
|
-
"@backstage/ui": "
|
|
57
|
-
"@backstage/version-bridge": "
|
|
53
|
+
"@backstage/config": "1.3.8",
|
|
54
|
+
"@backstage/core-plugin-api": "1.12.8-next.0",
|
|
55
|
+
"@backstage/types": "1.2.2",
|
|
56
|
+
"@backstage/ui": "0.17.0-next.0",
|
|
57
|
+
"@backstage/version-bridge": "1.0.12",
|
|
58
58
|
"@types/prop-types": "^15.7.3",
|
|
59
59
|
"history": "^5.0.0",
|
|
60
60
|
"i18next": "^22.4.15",
|
|
@@ -65,8 +65,8 @@
|
|
|
65
65
|
"zod": "^3.25.76 || ^4.0.0"
|
|
66
66
|
},
|
|
67
67
|
"devDependencies": {
|
|
68
|
-
"@backstage/cli": "
|
|
69
|
-
"@backstage/test-utils": "
|
|
68
|
+
"@backstage/cli": "0.36.4-next.0",
|
|
69
|
+
"@backstage/test-utils": "1.7.20-next.0",
|
|
70
70
|
"@testing-library/dom": "^10.0.0",
|
|
71
71
|
"@testing-library/jest-dom": "^6.0.0",
|
|
72
72
|
"@testing-library/react": "^16.0.0",
|
|
@@ -94,6 +94,6 @@
|
|
|
94
94
|
"optional": true
|
|
95
95
|
}
|
|
96
96
|
},
|
|
97
|
-
"configSchema": "config.
|
|
97
|
+
"configSchema": "config.schema.json",
|
|
98
98
|
"module": "./dist/index.esm.js"
|
|
99
99
|
}
|
package/config.d.ts
DELETED
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright 2020 The Backstage Authors
|
|
3
|
-
*
|
|
4
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
-
* you may not use this file except in compliance with the License.
|
|
6
|
-
* You may obtain a copy of the License at
|
|
7
|
-
*
|
|
8
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
-
*
|
|
10
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
-
* See the License for the specific language governing permissions and
|
|
14
|
-
* limitations under the License.
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
export interface Config {
|
|
18
|
-
/**
|
|
19
|
-
* Generic frontend configuration.
|
|
20
|
-
*/
|
|
21
|
-
app: {
|
|
22
|
-
/**
|
|
23
|
-
* The public absolute root URL that the frontend.
|
|
24
|
-
* @visibility frontend
|
|
25
|
-
*/
|
|
26
|
-
baseUrl: string;
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* The title of the app, as shown in the Backstage web interface.
|
|
30
|
-
* @visibility frontend
|
|
31
|
-
*/
|
|
32
|
-
title?: string;
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* Information about support of this Backstage instance and how to contact the integrator team.
|
|
36
|
-
*/
|
|
37
|
-
support?: {
|
|
38
|
-
/**
|
|
39
|
-
* The primary support url.
|
|
40
|
-
* @visibility frontend
|
|
41
|
-
*/
|
|
42
|
-
url: string;
|
|
43
|
-
/**
|
|
44
|
-
* A list of categorized support item groupings.
|
|
45
|
-
*/
|
|
46
|
-
items: Array<{
|
|
47
|
-
/**
|
|
48
|
-
* The title of the support item grouping.
|
|
49
|
-
* @visibility frontend
|
|
50
|
-
*/
|
|
51
|
-
title: string;
|
|
52
|
-
/**
|
|
53
|
-
* An optional icon for the support item grouping.
|
|
54
|
-
* @visibility frontend
|
|
55
|
-
*/
|
|
56
|
-
icon?: string;
|
|
57
|
-
/**
|
|
58
|
-
* A list of support links for the Backstage instance inside this grouping.
|
|
59
|
-
*/
|
|
60
|
-
links: Array<{
|
|
61
|
-
/** @visibility frontend */
|
|
62
|
-
url: string;
|
|
63
|
-
/** @visibility frontend */
|
|
64
|
-
title?: string;
|
|
65
|
-
}>;
|
|
66
|
-
}>;
|
|
67
|
-
};
|
|
68
|
-
|
|
69
|
-
routes?: {
|
|
70
|
-
/**
|
|
71
|
-
* Maps external route references to regular route references. Both the
|
|
72
|
-
* key and the value is expected to be on the form `<pluginId>.<routeId>`.
|
|
73
|
-
* If the value is `false`, the route will be disabled even if it has a
|
|
74
|
-
* default mapping.
|
|
75
|
-
*
|
|
76
|
-
* @deepVisibility frontend
|
|
77
|
-
*/
|
|
78
|
-
bindings?: { [externalRouteRefId: string]: string | false };
|
|
79
|
-
};
|
|
80
|
-
};
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* Generic backend configuration.
|
|
84
|
-
*/
|
|
85
|
-
backend: {
|
|
86
|
-
/**
|
|
87
|
-
* The public absolute root URL that the backend is reachable at, from the browser's perspective.
|
|
88
|
-
* @visibility frontend
|
|
89
|
-
*/
|
|
90
|
-
baseUrl: string;
|
|
91
|
-
};
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Configuration that provides information about the organization that the app is for.
|
|
95
|
-
*/
|
|
96
|
-
organization?: {
|
|
97
|
-
/**
|
|
98
|
-
* The name of the organization that the app belongs to.
|
|
99
|
-
* @visibility frontend
|
|
100
|
-
*/
|
|
101
|
-
name?: string;
|
|
102
|
-
};
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* This config was used by the HomepageTimer but has been replaced by the HeaderWorldClock in the home plugin
|
|
106
|
-
*
|
|
107
|
-
* @deprecated in favor of the HeaderWorldClock which is found in the home plugin
|
|
108
|
-
*/
|
|
109
|
-
homepage?: {
|
|
110
|
-
clocks?: Array<{
|
|
111
|
-
/** @visibility frontend */
|
|
112
|
-
label: string;
|
|
113
|
-
/** @visibility frontend */
|
|
114
|
-
timezone: string;
|
|
115
|
-
}>;
|
|
116
|
-
};
|
|
117
|
-
|
|
118
|
-
/**
|
|
119
|
-
* Configuration that provides information on available configured authentication providers.
|
|
120
|
-
*/
|
|
121
|
-
auth?: {
|
|
122
|
-
/**
|
|
123
|
-
* The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.
|
|
124
|
-
* default value: 'development'
|
|
125
|
-
* optional values: 'development' | 'production'
|
|
126
|
-
* @visibility frontend
|
|
127
|
-
*/
|
|
128
|
-
environment?: string;
|
|
129
|
-
};
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
* Enable redirect authentication flow type, instead of a popup for authentication.
|
|
133
|
-
* @defaultValue false
|
|
134
|
-
* @visibility frontend
|
|
135
|
-
*/
|
|
136
|
-
enableExperimentalRedirectFlow?: boolean;
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
* Discovery options.
|
|
140
|
-
*
|
|
141
|
-
* @visibility frontend
|
|
142
|
-
*/
|
|
143
|
-
discovery?: {
|
|
144
|
-
/**
|
|
145
|
-
* Endpoints
|
|
146
|
-
*
|
|
147
|
-
* A list of target baseUrls and the associated plugins.
|
|
148
|
-
*
|
|
149
|
-
* @visibility frontend
|
|
150
|
-
*/
|
|
151
|
-
endpoints?: Array<{
|
|
152
|
-
/**
|
|
153
|
-
* The target baseUrl to use for the plugin
|
|
154
|
-
*
|
|
155
|
-
* Can be either a string or an object with internal and external keys. (Internal is used for the backend, external for the frontend)
|
|
156
|
-
* Targets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.
|
|
157
|
-
*
|
|
158
|
-
* @visibility frontend
|
|
159
|
-
*/
|
|
160
|
-
target:
|
|
161
|
-
| string
|
|
162
|
-
| {
|
|
163
|
-
/**
|
|
164
|
-
* @visibility frontend
|
|
165
|
-
*/
|
|
166
|
-
external?: string;
|
|
167
|
-
};
|
|
168
|
-
/**
|
|
169
|
-
* Array of plugins which use the target baseUrl.
|
|
170
|
-
*
|
|
171
|
-
* @visibility frontend
|
|
172
|
-
*/
|
|
173
|
-
plugins: Array<string>;
|
|
174
|
-
}>;
|
|
175
|
-
};
|
|
176
|
-
}
|