@backstage/frontend-app-api 0.8.0 → 0.9.0-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.
- package/CHANGELOG.md +64 -0
- package/dist/core-app-api/src/apis/system/ApiRegistry.esm.js +50 -0
- package/dist/core-app-api/src/apis/system/ApiRegistry.esm.js.map +1 -0
- package/dist/extensions/Root.esm.js +18 -0
- package/dist/extensions/Root.esm.js.map +1 -0
- package/dist/frontend-plugin-api/src/wiring/createExtension.esm.js.map +1 -1
- package/dist/frontend-plugin-api/src/wiring/createExtensionOverrides.esm.js.map +1 -1
- package/dist/frontend-plugin-api/src/wiring/createFrontendModule.esm.js +25 -0
- package/dist/frontend-plugin-api/src/wiring/createFrontendModule.esm.js.map +1 -0
- package/dist/frontend-plugin-api/src/wiring/createFrontendPlugin.esm.js +10 -3
- package/dist/frontend-plugin-api/src/wiring/createFrontendPlugin.esm.js.map +1 -1
- package/dist/frontend-plugin-api/src/wiring/resolveExtensionDefinition.esm.js.map +1 -1
- package/dist/index.d.ts +22 -49
- package/dist/index.esm.js +1 -1
- package/dist/routing/collectRouteIds.esm.js +2 -1
- package/dist/routing/collectRouteIds.esm.js.map +1 -1
- package/dist/tree/instantiateAppNodeTree.esm.js +8 -5
- package/dist/tree/instantiateAppNodeTree.esm.js.map +1 -1
- package/dist/tree/resolveAppNodeSpecs.esm.js +42 -5
- package/dist/tree/resolveAppNodeSpecs.esm.js.map +1 -1
- package/dist/tree/resolveAppTree.esm.js +40 -20
- package/dist/tree/resolveAppTree.esm.js.map +1 -1
- package/dist/wiring/createSpecializedApp.esm.js +188 -0
- package/dist/wiring/createSpecializedApp.esm.js.map +1 -0
- package/package.json +6 -8
- package/dist/apis/implementations/ComponentsApi/DefaultComponentsApi.esm.js +0 -30
- package/dist/apis/implementations/ComponentsApi/DefaultComponentsApi.esm.js.map +0 -1
- package/dist/apis/implementations/IconsApi/DefaultIconsApi.esm.js +0 -15
- package/dist/apis/implementations/IconsApi/DefaultIconsApi.esm.js.map +0 -1
- package/dist/app/src/components/Root/LogoFull.esm.js +0 -33
- package/dist/app/src/components/Root/LogoFull.esm.js.map +0 -1
- package/dist/app/src/components/Root/LogoIcon.esm.js +0 -33
- package/dist/app/src/components/Root/LogoIcon.esm.js.map +0 -1
- package/dist/app-defaults/src/defaults/apis.esm.js +0 -221
- package/dist/app-defaults/src/defaults/apis.esm.js.map +0 -1
- package/dist/app-defaults/src/defaults/components.esm.js +0 -46
- package/dist/app-defaults/src/defaults/components.esm.js.map +0 -1
- package/dist/app-defaults/src/defaults/icons.esm.js +0 -51
- package/dist/app-defaults/src/defaults/icons.esm.js.map +0 -1
- package/dist/core-app-api/src/apis/implementations/AppLanguageApi/AppLanguageSelector.esm.js +0 -89
- package/dist/core-app-api/src/apis/implementations/AppLanguageApi/AppLanguageSelector.esm.js.map +0 -1
- package/dist/core-app-api/src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.esm.js +0 -76
- package/dist/core-app-api/src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.esm.js.map +0 -1
- package/dist/core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.esm.js +0 -234
- package/dist/core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.esm.js.map +0 -1
- package/dist/core-app-api/src/app/AppThemeProvider.esm.js +0 -60
- package/dist/core-app-api/src/app/AppThemeProvider.esm.js.map +0 -1
- package/dist/core-app-api/src/app/defaultConfigLoader.esm.js +0 -33
- package/dist/core-app-api/src/app/defaultConfigLoader.esm.js.map +0 -1
- package/dist/core-app-api/src/app/isProtectedApp.esm.js +0 -8
- package/dist/core-app-api/src/app/isProtectedApp.esm.js.map +0 -1
- package/dist/core-app-api/src/app/overrideBaseUrlConfigs.esm.js +0 -50
- package/dist/core-app-api/src/app/overrideBaseUrlConfigs.esm.js.map +0 -1
- package/dist/core-app-api/src/lib/subjects.esm.js +0 -69
- package/dist/core-app-api/src/lib/subjects.esm.js.map +0 -1
- package/dist/core-plugin-api/src/translation/TranslationRef.esm.js +0 -13
- package/dist/core-plugin-api/src/translation/TranslationRef.esm.js.map +0 -1
- package/dist/core-plugin-api/src/translation/TranslationResource.esm.js +0 -13
- package/dist/core-plugin-api/src/translation/TranslationResource.esm.js.map +0 -1
- package/dist/extensions/App.esm.js +0 -31
- package/dist/extensions/App.esm.js.map +0 -1
- package/dist/extensions/AppLayout.esm.js +0 -26
- package/dist/extensions/AppLayout.esm.js.map +0 -1
- package/dist/extensions/AppNav.esm.js +0 -66
- package/dist/extensions/AppNav.esm.js.map +0 -1
- package/dist/extensions/AppRoot.esm.js +0 -126
- package/dist/extensions/AppRoot.esm.js.map +0 -1
- package/dist/extensions/AppRoutes.esm.js +0 -39
- package/dist/extensions/AppRoutes.esm.js.map +0 -1
- package/dist/extensions/components.esm.js +0 -52
- package/dist/extensions/components.esm.js.map +0 -1
- package/dist/extensions/elements.esm.js +0 -32
- package/dist/extensions/elements.esm.js.map +0 -1
- package/dist/extensions/themes.esm.js +0 -33
- package/dist/extensions/themes.esm.js.map +0 -1
- package/dist/routing/RouteTracker.esm.js +0 -69
- package/dist/routing/RouteTracker.esm.js.map +0 -1
- package/dist/tree/createAppTree.esm.js +0 -21
- package/dist/tree/createAppTree.esm.js.map +0 -1
- package/dist/wiring/InternalAppContext.esm.js +0 -6
- package/dist/wiring/InternalAppContext.esm.js.map +0 -1
- package/dist/wiring/createApp.esm.js +0 -275
- package/dist/wiring/createApp.esm.js.map +0 -1
- package/dist/wiring/discovery.esm.js +0 -54
- package/dist/wiring/discovery.esm.js.map +0 -1
|
@@ -1,275 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import { ConfigReader } from '@backstage/config';
|
|
3
|
-
import { ApiBlueprint, coreExtensionData, ThemeBlueprint, TranslationBlueprint, IconBundleBlueprint, appTreeApiRef, routeResolutionApiRef, componentsApiRef, iconsApiRef } from '@backstage/frontend-plugin-api';
|
|
4
|
-
import { App } from '../extensions/App.esm.js';
|
|
5
|
-
import { AppRoutes } from '../extensions/AppRoutes.esm.js';
|
|
6
|
-
import { AppLayout } from '../extensions/AppLayout.esm.js';
|
|
7
|
-
import { AppNav } from '../extensions/AppNav.esm.js';
|
|
8
|
-
import { discoveryApiRef, errorApiRef, fetchApiRef, featureFlagsApiRef, identityApiRef, appThemeApiRef, configApiRef } from '@backstage/core-plugin-api';
|
|
9
|
-
import { getAvailableFeatures } from './discovery.esm.js';
|
|
10
|
-
import { ApiFactoryRegistry, AppThemeSelector, ApiResolver, ApiProvider } from '@backstage/core-app-api';
|
|
11
|
-
import { isProtectedApp } from '../core-app-api/src/app/isProtectedApp.esm.js';
|
|
12
|
-
import { AppThemeProvider } from '../core-app-api/src/app/AppThemeProvider.esm.js';
|
|
13
|
-
import { AppIdentityProxy } from '../core-app-api/src/apis/implementations/IdentityApi/AppIdentityProxy.esm.js';
|
|
14
|
-
import { LocalStorageFeatureFlags } from '../core-app-api/src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags.esm.js';
|
|
15
|
-
import { defaultConfigLoaderSync } from '../core-app-api/src/app/defaultConfigLoader.esm.js';
|
|
16
|
-
import { overrideBaseUrlConfigs } from '../core-app-api/src/app/overrideBaseUrlConfigs.esm.js';
|
|
17
|
-
import { AppLanguageSelector } from '../core-app-api/src/apis/implementations/AppLanguageApi/AppLanguageSelector.esm.js';
|
|
18
|
-
import { I18nextTranslationApi } from '../core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi.esm.js';
|
|
19
|
-
import { resolveExtensionDefinition } from '../frontend-plugin-api/src/wiring/resolveExtensionDefinition.esm.js';
|
|
20
|
-
import { apis } from '../app-defaults/src/defaults/apis.esm.js';
|
|
21
|
-
import '@material-ui/core/Button';
|
|
22
|
-
import '@backstage/core-components';
|
|
23
|
-
import 'react-router-dom';
|
|
24
|
-
import { icons } from '../app-defaults/src/defaults/icons.esm.js';
|
|
25
|
-
import '@backstage/theme';
|
|
26
|
-
import '@material-ui/icons/Brightness2';
|
|
27
|
-
import '@material-ui/icons/WbSunny';
|
|
28
|
-
import { LightTheme, DarkTheme } from '../extensions/themes.esm.js';
|
|
29
|
-
import { oauthRequestDialogAppRootElement, alertDisplayAppRootElement } from '../extensions/elements.esm.js';
|
|
30
|
-
import { extractRouteInfoFromAppNode } from '../routing/extractRouteInfoFromAppNode.esm.js';
|
|
31
|
-
import { appLanguageApiRef, translationApiRef } from '@backstage/core-plugin-api/alpha';
|
|
32
|
-
import { RouteResolver } from '../routing/RouteResolver.esm.js';
|
|
33
|
-
import { resolveRouteBindings } from '../routing/resolveRouteBindings.esm.js';
|
|
34
|
-
import { collectRouteIds } from '../routing/collectRouteIds.esm.js';
|
|
35
|
-
import { createAppTree } from '../tree/createAppTree.esm.js';
|
|
36
|
-
import { DefaultProgressComponent, DefaultErrorBoundaryComponent, DefaultNotFoundErrorPageComponent } from '../extensions/components.esm.js';
|
|
37
|
-
import { InternalAppContext } from './InternalAppContext.esm.js';
|
|
38
|
-
import { AppRoot } from '../extensions/AppRoot.esm.js';
|
|
39
|
-
import { toInternalBackstagePlugin } from '../frontend-plugin-api/src/wiring/createFrontendPlugin.esm.js';
|
|
40
|
-
import { toInternalExtensionOverrides } from '../frontend-plugin-api/src/wiring/createExtensionOverrides.esm.js';
|
|
41
|
-
import { DefaultComponentsApi } from '../apis/implementations/ComponentsApi/DefaultComponentsApi.esm.js';
|
|
42
|
-
import { DefaultIconsApi } from '../apis/implementations/IconsApi/DefaultIconsApi.esm.js';
|
|
43
|
-
import { stringifyError } from '@backstage/errors';
|
|
44
|
-
import { getBasePath } from '../routing/getBasePath.esm.js';
|
|
45
|
-
|
|
46
|
-
const DefaultApis = apis.map(
|
|
47
|
-
(factory) => ApiBlueprint.make({ namespace: factory.api.id, params: { factory } })
|
|
48
|
-
);
|
|
49
|
-
const builtinExtensions = [
|
|
50
|
-
App,
|
|
51
|
-
AppRoot,
|
|
52
|
-
AppRoutes,
|
|
53
|
-
AppNav,
|
|
54
|
-
AppLayout,
|
|
55
|
-
DefaultProgressComponent,
|
|
56
|
-
DefaultErrorBoundaryComponent,
|
|
57
|
-
DefaultNotFoundErrorPageComponent,
|
|
58
|
-
LightTheme,
|
|
59
|
-
DarkTheme,
|
|
60
|
-
oauthRequestDialogAppRootElement,
|
|
61
|
-
alertDisplayAppRootElement,
|
|
62
|
-
...DefaultApis
|
|
63
|
-
].map((def) => resolveExtensionDefinition(def));
|
|
64
|
-
function deduplicateFeatures(allFeatures) {
|
|
65
|
-
const features = Array.from(new Set(allFeatures));
|
|
66
|
-
const seenIds = /* @__PURE__ */ new Set();
|
|
67
|
-
return features.reverse().filter((feature) => {
|
|
68
|
-
if (feature.$$type !== "@backstage/BackstagePlugin") {
|
|
69
|
-
return true;
|
|
70
|
-
}
|
|
71
|
-
if (seenIds.has(feature.id)) {
|
|
72
|
-
return false;
|
|
73
|
-
}
|
|
74
|
-
seenIds.add(feature.id);
|
|
75
|
-
return true;
|
|
76
|
-
}).reverse();
|
|
77
|
-
}
|
|
78
|
-
function createApp(options) {
|
|
79
|
-
let suspenseFallback = options?.loadingComponent;
|
|
80
|
-
if (suspenseFallback === void 0) {
|
|
81
|
-
suspenseFallback = "Loading...";
|
|
82
|
-
}
|
|
83
|
-
async function appLoader() {
|
|
84
|
-
const config = await options?.configLoader?.().then((c) => c.config) ?? ConfigReader.fromConfigs(
|
|
85
|
-
overrideBaseUrlConfigs(defaultConfigLoaderSync())
|
|
86
|
-
);
|
|
87
|
-
const discoveredFeatures = getAvailableFeatures(config);
|
|
88
|
-
const providedFeatures = [];
|
|
89
|
-
for (const entry of options?.features ?? []) {
|
|
90
|
-
if ("load" in entry) {
|
|
91
|
-
try {
|
|
92
|
-
const result = await entry.load({ config });
|
|
93
|
-
providedFeatures.push(...result.features);
|
|
94
|
-
} catch (e) {
|
|
95
|
-
throw new Error(
|
|
96
|
-
`Failed to read frontend features from loader '${entry.getLoaderName()}', ${stringifyError(
|
|
97
|
-
e
|
|
98
|
-
)}`
|
|
99
|
-
);
|
|
100
|
-
}
|
|
101
|
-
} else {
|
|
102
|
-
providedFeatures.push(entry);
|
|
103
|
-
}
|
|
104
|
-
}
|
|
105
|
-
const app = createSpecializedApp({
|
|
106
|
-
icons: options?.icons,
|
|
107
|
-
config,
|
|
108
|
-
features: [...discoveredFeatures, ...providedFeatures],
|
|
109
|
-
bindRoutes: options?.bindRoutes
|
|
110
|
-
}).createRoot();
|
|
111
|
-
return { default: () => app };
|
|
112
|
-
}
|
|
113
|
-
return {
|
|
114
|
-
createRoot() {
|
|
115
|
-
const LazyApp = React.lazy(appLoader);
|
|
116
|
-
return /* @__PURE__ */ React.createElement(React.Suspense, { fallback: suspenseFallback }, /* @__PURE__ */ React.createElement(LazyApp, null));
|
|
117
|
-
}
|
|
118
|
-
};
|
|
119
|
-
}
|
|
120
|
-
function createSpecializedApp(options) {
|
|
121
|
-
const {
|
|
122
|
-
features: duplicatedFeatures = [],
|
|
123
|
-
config = new ConfigReader({}, "empty-config")
|
|
124
|
-
} = options ?? {};
|
|
125
|
-
const features = deduplicateFeatures(duplicatedFeatures);
|
|
126
|
-
const tree = createAppTree({
|
|
127
|
-
features,
|
|
128
|
-
builtinExtensions,
|
|
129
|
-
config
|
|
130
|
-
});
|
|
131
|
-
const routeInfo = extractRouteInfoFromAppNode(tree.root);
|
|
132
|
-
const routeBindings = resolveRouteBindings(
|
|
133
|
-
options?.bindRoutes,
|
|
134
|
-
config,
|
|
135
|
-
collectRouteIds(features)
|
|
136
|
-
);
|
|
137
|
-
const appIdentityProxy = new AppIdentityProxy();
|
|
138
|
-
const apiHolder = createApiHolder(
|
|
139
|
-
tree,
|
|
140
|
-
config,
|
|
141
|
-
appIdentityProxy,
|
|
142
|
-
new RouteResolver(
|
|
143
|
-
routeInfo.routePaths,
|
|
144
|
-
routeInfo.routeParents,
|
|
145
|
-
routeInfo.routeObjects,
|
|
146
|
-
routeBindings,
|
|
147
|
-
getBasePath(config)
|
|
148
|
-
),
|
|
149
|
-
options?.icons
|
|
150
|
-
);
|
|
151
|
-
if (isProtectedApp()) {
|
|
152
|
-
const discoveryApi = apiHolder.get(discoveryApiRef);
|
|
153
|
-
const errorApi = apiHolder.get(errorApiRef);
|
|
154
|
-
const fetchApi = apiHolder.get(fetchApiRef);
|
|
155
|
-
if (!discoveryApi || !errorApi || !fetchApi) {
|
|
156
|
-
throw new Error(
|
|
157
|
-
"App is running in protected mode but missing required APIs"
|
|
158
|
-
);
|
|
159
|
-
}
|
|
160
|
-
appIdentityProxy.enableCookieAuth({
|
|
161
|
-
discoveryApi,
|
|
162
|
-
errorApi,
|
|
163
|
-
fetchApi
|
|
164
|
-
});
|
|
165
|
-
}
|
|
166
|
-
const featureFlagApi = apiHolder.get(featureFlagsApiRef);
|
|
167
|
-
if (featureFlagApi) {
|
|
168
|
-
for (const feature of features) {
|
|
169
|
-
if (feature.$$type === "@backstage/BackstagePlugin") {
|
|
170
|
-
toInternalBackstagePlugin(feature).featureFlags.forEach(
|
|
171
|
-
(flag) => featureFlagApi.registerFlag({
|
|
172
|
-
name: flag.name,
|
|
173
|
-
pluginId: feature.id
|
|
174
|
-
})
|
|
175
|
-
);
|
|
176
|
-
}
|
|
177
|
-
if (feature.$$type === "@backstage/ExtensionOverrides") {
|
|
178
|
-
toInternalExtensionOverrides(feature).featureFlags.forEach(
|
|
179
|
-
(flag) => featureFlagApi.registerFlag({ name: flag.name, pluginId: "" })
|
|
180
|
-
);
|
|
181
|
-
}
|
|
182
|
-
}
|
|
183
|
-
}
|
|
184
|
-
const rootEl = tree.root.instance.getData(coreExtensionData.reactElement);
|
|
185
|
-
const AppComponent = () => /* @__PURE__ */ React.createElement(ApiProvider, { apis: apiHolder }, /* @__PURE__ */ React.createElement(AppThemeProvider, null, /* @__PURE__ */ React.createElement(
|
|
186
|
-
InternalAppContext.Provider,
|
|
187
|
-
{
|
|
188
|
-
value: { appIdentityProxy, routeObjects: routeInfo.routeObjects }
|
|
189
|
-
},
|
|
190
|
-
rootEl
|
|
191
|
-
)));
|
|
192
|
-
return {
|
|
193
|
-
createRoot() {
|
|
194
|
-
return /* @__PURE__ */ React.createElement(AppComponent, null);
|
|
195
|
-
}
|
|
196
|
-
};
|
|
197
|
-
}
|
|
198
|
-
function createApiHolder(tree, configApi, appIdentityProxy, routeResolutionApi, icons$1) {
|
|
199
|
-
const factoryRegistry = new ApiFactoryRegistry();
|
|
200
|
-
const pluginApis = tree.root.edges.attachments.get("apis")?.map((e) => e.instance?.getData(ApiBlueprint.dataRefs.factory)).filter((x) => !!x) ?? [];
|
|
201
|
-
const themeExtensions = tree.root.edges.attachments.get("themes")?.map((e) => e.instance?.getData(ThemeBlueprint.dataRefs.theme)).filter((x) => !!x) ?? [];
|
|
202
|
-
const translationResources = tree.root.edges.attachments.get("translations")?.map((e) => e.instance?.getData(TranslationBlueprint.dataRefs.translation)).filter(
|
|
203
|
-
(x) => !!x
|
|
204
|
-
) ?? [];
|
|
205
|
-
const extensionIcons = tree.root.edges.attachments.get("icons")?.map((e) => e.instance?.getData(IconBundleBlueprint.dataRefs.icons)).reduce((acc, bundle) => ({ ...acc, ...bundle }), {});
|
|
206
|
-
for (const factory of pluginApis) {
|
|
207
|
-
factoryRegistry.register("default", factory);
|
|
208
|
-
}
|
|
209
|
-
factoryRegistry.register("default", {
|
|
210
|
-
api: featureFlagsApiRef,
|
|
211
|
-
deps: {},
|
|
212
|
-
factory: () => new LocalStorageFeatureFlags()
|
|
213
|
-
});
|
|
214
|
-
factoryRegistry.register("static", {
|
|
215
|
-
api: identityApiRef,
|
|
216
|
-
deps: {},
|
|
217
|
-
factory: () => appIdentityProxy
|
|
218
|
-
});
|
|
219
|
-
factoryRegistry.register("static", {
|
|
220
|
-
api: appTreeApiRef,
|
|
221
|
-
deps: {},
|
|
222
|
-
factory: () => ({
|
|
223
|
-
getTree: () => ({ tree })
|
|
224
|
-
})
|
|
225
|
-
});
|
|
226
|
-
factoryRegistry.register("static", {
|
|
227
|
-
api: routeResolutionApiRef,
|
|
228
|
-
deps: {},
|
|
229
|
-
factory: () => routeResolutionApi
|
|
230
|
-
});
|
|
231
|
-
factoryRegistry.register("static", {
|
|
232
|
-
api: componentsApiRef,
|
|
233
|
-
deps: {},
|
|
234
|
-
factory: () => DefaultComponentsApi.fromTree(tree)
|
|
235
|
-
});
|
|
236
|
-
factoryRegistry.register("static", {
|
|
237
|
-
api: iconsApiRef,
|
|
238
|
-
deps: {},
|
|
239
|
-
factory: () => new DefaultIconsApi({ ...icons, ...extensionIcons, ...icons$1 })
|
|
240
|
-
});
|
|
241
|
-
factoryRegistry.register("static", {
|
|
242
|
-
api: appThemeApiRef,
|
|
243
|
-
deps: {},
|
|
244
|
-
// TODO: add extension for registering themes
|
|
245
|
-
factory: () => AppThemeSelector.createWithStorage(themeExtensions)
|
|
246
|
-
});
|
|
247
|
-
factoryRegistry.register("static", {
|
|
248
|
-
api: appLanguageApiRef,
|
|
249
|
-
deps: {},
|
|
250
|
-
factory: () => AppLanguageSelector.createWithStorage()
|
|
251
|
-
});
|
|
252
|
-
factoryRegistry.register("static", {
|
|
253
|
-
api: configApiRef,
|
|
254
|
-
deps: {},
|
|
255
|
-
factory: () => configApi
|
|
256
|
-
});
|
|
257
|
-
factoryRegistry.register("static", {
|
|
258
|
-
api: appLanguageApiRef,
|
|
259
|
-
deps: {},
|
|
260
|
-
factory: () => AppLanguageSelector.createWithStorage()
|
|
261
|
-
});
|
|
262
|
-
factoryRegistry.register("static", {
|
|
263
|
-
api: translationApiRef,
|
|
264
|
-
deps: { languageApi: appLanguageApiRef },
|
|
265
|
-
factory: ({ languageApi }) => I18nextTranslationApi.create({
|
|
266
|
-
languageApi,
|
|
267
|
-
resources: translationResources
|
|
268
|
-
})
|
|
269
|
-
});
|
|
270
|
-
ApiResolver.validateFactories(factoryRegistry, factoryRegistry.getAllApis());
|
|
271
|
-
return new ApiResolver(factoryRegistry);
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
export { builtinExtensions, createApp, createSpecializedApp };
|
|
275
|
-
//# sourceMappingURL=createApp.esm.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"createApp.esm.js","sources":["../../src/wiring/createApp.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 React, { JSX, ReactNode } from 'react';\nimport { ConfigReader } from '@backstage/config';\nimport {\n ApiBlueprint,\n AppTree,\n appTreeApiRef,\n componentsApiRef,\n coreExtensionData,\n FrontendFeature,\n IconBundleBlueprint,\n iconsApiRef,\n RouteResolutionApi,\n routeResolutionApiRef,\n ThemeBlueprint,\n TranslationBlueprint,\n} from '@backstage/frontend-plugin-api';\nimport { App } from '../extensions/App';\nimport { AppRoutes } from '../extensions/AppRoutes';\nimport { AppLayout } from '../extensions/AppLayout';\nimport { AppNav } from '../extensions/AppNav';\nimport {\n AnyApiFactory,\n ApiHolder,\n appThemeApiRef,\n ConfigApi,\n configApiRef,\n IconComponent,\n featureFlagsApiRef,\n identityApiRef,\n AppTheme,\n errorApiRef,\n discoveryApiRef,\n fetchApiRef,\n} from '@backstage/core-plugin-api';\nimport { getAvailableFeatures } from './discovery';\nimport {\n ApiFactoryRegistry,\n ApiProvider,\n ApiResolver,\n AppThemeSelector,\n} from '@backstage/core-app-api';\n\n// TODO: Get rid of all of these\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { isProtectedApp } from '../../../core-app-api/src/app/isProtectedApp';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { AppThemeProvider } from '../../../core-app-api/src/app/AppThemeProvider';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { AppIdentityProxy } from '../../../core-app-api/src/apis/implementations/IdentityApi/AppIdentityProxy';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { LocalStorageFeatureFlags } from '../../../core-app-api/src/apis/implementations/FeatureFlagsApi/LocalStorageFeatureFlags';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { defaultConfigLoaderSync } from '../../../core-app-api/src/app/defaultConfigLoader';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { overrideBaseUrlConfigs } from '../../../core-app-api/src/app/overrideBaseUrlConfigs';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { AppLanguageSelector } from '../../../core-app-api/src/apis/implementations/AppLanguageApi/AppLanguageSelector';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { I18nextTranslationApi } from '../../../core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { resolveExtensionDefinition } from '../../../frontend-plugin-api/src/wiring/resolveExtensionDefinition';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { apis as defaultApis } from '../../../app-defaults/src/defaults';\nimport { DarkTheme, LightTheme } from '../extensions/themes';\nimport {\n oauthRequestDialogAppRootElement,\n alertDisplayAppRootElement,\n} from '../extensions/elements';\nimport { extractRouteInfoFromAppNode } from '../routing/extractRouteInfoFromAppNode';\nimport {\n appLanguageApiRef,\n translationApiRef,\n} from '@backstage/core-plugin-api/alpha';\nimport { CreateAppRouteBinder } from '../routing';\nimport { RouteResolver } from '../routing/RouteResolver';\nimport { resolveRouteBindings } from '../routing/resolveRouteBindings';\nimport { collectRouteIds } from '../routing/collectRouteIds';\nimport { createAppTree } from '../tree';\nimport {\n DefaultProgressComponent,\n DefaultErrorBoundaryComponent,\n DefaultNotFoundErrorPageComponent,\n} from '../extensions/components';\nimport { InternalAppContext } from './InternalAppContext';\nimport { AppRoot } from '../extensions/AppRoot';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalBackstagePlugin } from '../../../frontend-plugin-api/src/wiring/createFrontendPlugin';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { toInternalExtensionOverrides } from '../../../frontend-plugin-api/src/wiring/createExtensionOverrides';\nimport { DefaultComponentsApi } from '../apis/implementations/ComponentsApi';\nimport { DefaultIconsApi } from '../apis/implementations/IconsApi';\nimport { stringifyError } from '@backstage/errors';\n// eslint-disable-next-line @backstage/no-relative-monorepo-imports\nimport { icons as defaultIcons } from '../../../app-defaults/src/defaults';\nimport { getBasePath } from '../routing/getBasePath';\n\nconst DefaultApis = defaultApis.map(factory =>\n ApiBlueprint.make({ namespace: factory.api.id, params: { factory } }),\n);\n\nexport const builtinExtensions = [\n App,\n AppRoot,\n AppRoutes,\n AppNav,\n AppLayout,\n DefaultProgressComponent,\n DefaultErrorBoundaryComponent,\n DefaultNotFoundErrorPageComponent,\n LightTheme,\n DarkTheme,\n oauthRequestDialogAppRootElement,\n alertDisplayAppRootElement,\n ...DefaultApis,\n].map(def => resolveExtensionDefinition(def));\n\nfunction deduplicateFeatures(\n allFeatures: FrontendFeature[],\n): FrontendFeature[] {\n // Start by removing duplicates by reference\n const features = Array.from(new Set(allFeatures));\n\n // Plugins are deduplicated by ID, last one wins\n const seenIds = new Set<string>();\n return features\n .reverse()\n .filter(feature => {\n if (feature.$$type !== '@backstage/BackstagePlugin') {\n return true;\n }\n if (seenIds.has(feature.id)) {\n return false;\n }\n seenIds.add(feature.id);\n return true;\n })\n .reverse();\n}\n\n/**\n * A source of dynamically loaded frontend features.\n *\n * @public\n */\nexport interface CreateAppFeatureLoader {\n /**\n * Returns name of this loader. suitable for showing to users.\n */\n getLoaderName(): string;\n\n /**\n * Loads a number of features dynamically.\n */\n load(options: { config: ConfigApi }): Promise<{\n features: FrontendFeature[];\n }>;\n}\n\n/** @public */\nexport function createApp(options?: {\n /** @deprecated - Please use {@link @backstage/frontend-plugin-api#IconBundleBlueprint} to make new icon bundles which can be installed in the app seperately */\n icons?: { [key in string]: IconComponent };\n features?: (FrontendFeature | CreateAppFeatureLoader)[];\n configLoader?: () => Promise<{ config: ConfigApi }>;\n bindRoutes?(context: { bind: CreateAppRouteBinder }): void;\n /**\n * The component to render while loading the app (waiting for config, features, etc)\n *\n * Is the text \"Loading...\" by default.\n * If set to \"null\" then no loading fallback component is rendered. *\n */\n loadingComponent?: ReactNode;\n}): {\n createRoot(): JSX.Element;\n} {\n let suspenseFallback = options?.loadingComponent;\n if (suspenseFallback === undefined) {\n suspenseFallback = 'Loading...';\n }\n\n async function appLoader() {\n const config =\n (await options?.configLoader?.().then(c => c.config)) ??\n ConfigReader.fromConfigs(\n overrideBaseUrlConfigs(defaultConfigLoaderSync()),\n );\n\n const discoveredFeatures = getAvailableFeatures(config);\n\n const providedFeatures: FrontendFeature[] = [];\n for (const entry of options?.features ?? []) {\n if ('load' in entry) {\n try {\n const result = await entry.load({ config });\n providedFeatures.push(...result.features);\n } catch (e) {\n throw new Error(\n `Failed to read frontend features from loader '${entry.getLoaderName()}', ${stringifyError(\n e,\n )}`,\n );\n }\n } else {\n providedFeatures.push(entry);\n }\n }\n\n const app = createSpecializedApp({\n icons: options?.icons,\n config,\n features: [...discoveredFeatures, ...providedFeatures],\n bindRoutes: options?.bindRoutes,\n }).createRoot();\n\n return { default: () => app };\n }\n\n return {\n createRoot() {\n const LazyApp = React.lazy(appLoader);\n return (\n <React.Suspense fallback={suspenseFallback}>\n <LazyApp />\n </React.Suspense>\n );\n },\n };\n}\n\n/**\n * Synchronous version of {@link createApp}, expecting all features and\n * config to have been loaded already.\n *\n * @public\n */\nexport function createSpecializedApp(options?: {\n /** @deprecated - Please use {@link @backstage/frontend-plugin-api#IconBundleBlueprint} to make new icon bundles which can be installed in the app seperately */\n icons?: { [key in string]: IconComponent };\n features?: FrontendFeature[];\n config?: ConfigApi;\n bindRoutes?(context: { bind: CreateAppRouteBinder }): void;\n}): { createRoot(): JSX.Element } {\n const {\n features: duplicatedFeatures = [],\n config = new ConfigReader({}, 'empty-config'),\n } = options ?? {};\n\n const features = deduplicateFeatures(duplicatedFeatures);\n\n const tree = createAppTree({\n features,\n builtinExtensions,\n config,\n });\n\n const routeInfo = extractRouteInfoFromAppNode(tree.root);\n const routeBindings = resolveRouteBindings(\n options?.bindRoutes,\n config,\n collectRouteIds(features),\n );\n\n const appIdentityProxy = new AppIdentityProxy();\n const apiHolder = createApiHolder(\n tree,\n config,\n appIdentityProxy,\n new RouteResolver(\n routeInfo.routePaths,\n routeInfo.routeParents,\n routeInfo.routeObjects,\n routeBindings,\n getBasePath(config),\n ),\n options?.icons,\n );\n\n if (isProtectedApp()) {\n const discoveryApi = apiHolder.get(discoveryApiRef);\n const errorApi = apiHolder.get(errorApiRef);\n const fetchApi = apiHolder.get(fetchApiRef);\n if (!discoveryApi || !errorApi || !fetchApi) {\n throw new Error(\n 'App is running in protected mode but missing required APIs',\n );\n }\n appIdentityProxy.enableCookieAuth({\n discoveryApi,\n errorApi,\n fetchApi,\n });\n }\n\n const featureFlagApi = apiHolder.get(featureFlagsApiRef);\n if (featureFlagApi) {\n for (const feature of features) {\n if (feature.$$type === '@backstage/BackstagePlugin') {\n toInternalBackstagePlugin(feature).featureFlags.forEach(flag =>\n featureFlagApi.registerFlag({\n name: flag.name,\n pluginId: feature.id,\n }),\n );\n }\n if (feature.$$type === '@backstage/ExtensionOverrides') {\n toInternalExtensionOverrides(feature).featureFlags.forEach(flag =>\n featureFlagApi.registerFlag({ name: flag.name, pluginId: '' }),\n );\n }\n }\n }\n\n const rootEl = tree.root.instance!.getData(coreExtensionData.reactElement);\n\n const AppComponent = () => (\n <ApiProvider apis={apiHolder}>\n <AppThemeProvider>\n <InternalAppContext.Provider\n value={{ appIdentityProxy, routeObjects: routeInfo.routeObjects }}\n >\n {rootEl}\n </InternalAppContext.Provider>\n </AppThemeProvider>\n </ApiProvider>\n );\n\n return {\n createRoot() {\n return <AppComponent />;\n },\n };\n}\n\nfunction createApiHolder(\n tree: AppTree,\n configApi: ConfigApi,\n appIdentityProxy: AppIdentityProxy,\n routeResolutionApi: RouteResolutionApi,\n icons?: { [key in string]: IconComponent },\n): ApiHolder {\n const factoryRegistry = new ApiFactoryRegistry();\n\n const pluginApis =\n tree.root.edges.attachments\n .get('apis')\n ?.map(e => e.instance?.getData(ApiBlueprint.dataRefs.factory))\n .filter((x): x is AnyApiFactory => !!x) ?? [];\n\n const themeExtensions =\n tree.root.edges.attachments\n .get('themes')\n ?.map(e => e.instance?.getData(ThemeBlueprint.dataRefs.theme))\n .filter((x): x is AppTheme => !!x) ?? [];\n\n const translationResources =\n tree.root.edges.attachments\n .get('translations')\n ?.map(e => e.instance?.getData(TranslationBlueprint.dataRefs.translation))\n .filter(\n (x): x is typeof TranslationBlueprint.dataRefs.translation.T => !!x,\n ) ?? [];\n\n const extensionIcons = tree.root.edges.attachments\n .get('icons')\n ?.map(e => e.instance?.getData(IconBundleBlueprint.dataRefs.icons))\n .reduce((acc, bundle) => ({ ...acc, ...bundle }), {});\n\n for (const factory of pluginApis) {\n factoryRegistry.register('default', factory);\n }\n\n // TODO: properly discovery feature flags, maybe rework the whole thing\n factoryRegistry.register('default', {\n api: featureFlagsApiRef,\n deps: {},\n factory: () => new LocalStorageFeatureFlags(),\n });\n\n factoryRegistry.register('static', {\n api: identityApiRef,\n deps: {},\n factory: () => appIdentityProxy,\n });\n\n factoryRegistry.register('static', {\n api: appTreeApiRef,\n deps: {},\n factory: () => ({\n getTree: () => ({ tree }),\n }),\n });\n\n factoryRegistry.register('static', {\n api: routeResolutionApiRef,\n deps: {},\n factory: () => routeResolutionApi,\n });\n\n factoryRegistry.register('static', {\n api: componentsApiRef,\n deps: {},\n factory: () => DefaultComponentsApi.fromTree(tree),\n });\n\n factoryRegistry.register('static', {\n api: iconsApiRef,\n deps: {},\n factory: () =>\n new DefaultIconsApi({ ...defaultIcons, ...extensionIcons, ...icons }),\n });\n\n factoryRegistry.register('static', {\n api: appThemeApiRef,\n deps: {},\n // TODO: add extension for registering themes\n factory: () => AppThemeSelector.createWithStorage(themeExtensions),\n });\n\n factoryRegistry.register('static', {\n api: appLanguageApiRef,\n deps: {},\n factory: () => AppLanguageSelector.createWithStorage(),\n });\n\n factoryRegistry.register('static', {\n api: configApiRef,\n deps: {},\n factory: () => configApi,\n });\n\n factoryRegistry.register('static', {\n api: appLanguageApiRef,\n deps: {},\n factory: () => AppLanguageSelector.createWithStorage(),\n });\n\n factoryRegistry.register('static', {\n api: translationApiRef,\n deps: { languageApi: appLanguageApiRef },\n factory: ({ languageApi }) =>\n I18nextTranslationApi.create({\n languageApi,\n resources: translationResources,\n }),\n });\n\n ApiResolver.validateFactories(factoryRegistry, factoryRegistry.getAllApis());\n\n return new ApiResolver(factoryRegistry);\n}\n"],"names":["defaultApis","icons","defaultIcons"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgHA,MAAM,cAAcA,IAAY,CAAA,GAAA;AAAA,EAAI,CAClC,OAAA,KAAA,YAAA,CAAa,IAAK,CAAA,EAAE,SAAW,EAAA,OAAA,CAAQ,GAAI,CAAA,EAAA,EAAI,MAAQ,EAAA,EAAE,OAAQ,EAAA,EAAG,CAAA;AACtE,CAAA,CAAA;AAEO,MAAM,iBAAoB,GAAA;AAAA,EAC/B,GAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACA,wBAAA;AAAA,EACA,6BAAA;AAAA,EACA,iCAAA;AAAA,EACA,UAAA;AAAA,EACA,SAAA;AAAA,EACA,gCAAA;AAAA,EACA,0BAAA;AAAA,EACA,GAAG,WAAA;AACL,CAAA,CAAE,GAAI,CAAA,CAAA,GAAA,KAAO,0BAA2B,CAAA,GAAG,CAAC,EAAA;AAE5C,SAAS,oBACP,WACmB,EAAA;AAEnB,EAAA,MAAM,WAAW,KAAM,CAAA,IAAA,CAAK,IAAI,GAAA,CAAI,WAAW,CAAC,CAAA,CAAA;AAGhD,EAAM,MAAA,OAAA,uBAAc,GAAY,EAAA,CAAA;AAChC,EAAA,OAAO,QACJ,CAAA,OAAA,EACA,CAAA,MAAA,CAAO,CAAW,OAAA,KAAA;AACjB,IAAI,IAAA,OAAA,CAAQ,WAAW,4BAA8B,EAAA;AACnD,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AACA,IAAA,IAAI,OAAQ,CAAA,GAAA,CAAI,OAAQ,CAAA,EAAE,CAAG,EAAA;AAC3B,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AACA,IAAQ,OAAA,CAAA,GAAA,CAAI,QAAQ,EAAE,CAAA,CAAA;AACtB,IAAO,OAAA,IAAA,CAAA;AAAA,GACR,EACA,OAAQ,EAAA,CAAA;AACb,CAAA;AAsBO,SAAS,UAAU,OAexB,EAAA;AACA,EAAA,IAAI,mBAAmB,OAAS,EAAA,gBAAA,CAAA;AAChC,EAAA,IAAI,qBAAqB,KAAW,CAAA,EAAA;AAClC,IAAmB,gBAAA,GAAA,YAAA,CAAA;AAAA,GACrB;AAEA,EAAA,eAAe,SAAY,GAAA;AACzB,IAAM,MAAA,MAAA,GACH,MAAM,OAAA,EAAS,YAAe,IAAA,CAAE,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,MAAM,CAAA,IACnD,YAAa,CAAA,WAAA;AAAA,MACX,sBAAA,CAAuB,yBAAyB,CAAA;AAAA,KAClD,CAAA;AAEF,IAAM,MAAA,kBAAA,GAAqB,qBAAqB,MAAM,CAAA,CAAA;AAEtD,IAAA,MAAM,mBAAsC,EAAC,CAAA;AAC7C,IAAA,KAAA,MAAW,KAAS,IAAA,OAAA,EAAS,QAAY,IAAA,EAAI,EAAA;AAC3C,MAAA,IAAI,UAAU,KAAO,EAAA;AACnB,QAAI,IAAA;AACF,UAAA,MAAM,SAAS,MAAM,KAAA,CAAM,IAAK,CAAA,EAAE,QAAQ,CAAA,CAAA;AAC1C,UAAiB,gBAAA,CAAA,IAAA,CAAK,GAAG,MAAA,CAAO,QAAQ,CAAA,CAAA;AAAA,iBACjC,CAAG,EAAA;AACV,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAiD,8CAAA,EAAA,KAAA,CAAM,aAAc,EAAC,CAAM,GAAA,EAAA,cAAA;AAAA,cAC1E,CAAA;AAAA,aACD,CAAA,CAAA;AAAA,WACH,CAAA;AAAA,SACF;AAAA,OACK,MAAA;AACL,QAAA,gBAAA,CAAiB,KAAK,KAAK,CAAA,CAAA;AAAA,OAC7B;AAAA,KACF;AAEA,IAAA,MAAM,MAAM,oBAAqB,CAAA;AAAA,MAC/B,OAAO,OAAS,EAAA,KAAA;AAAA,MAChB,MAAA;AAAA,MACA,QAAU,EAAA,CAAC,GAAG,kBAAA,EAAoB,GAAG,gBAAgB,CAAA;AAAA,MACrD,YAAY,OAAS,EAAA,UAAA;AAAA,KACtB,EAAE,UAAW,EAAA,CAAA;AAEd,IAAO,OAAA,EAAE,OAAS,EAAA,MAAM,GAAI,EAAA,CAAA;AAAA,GAC9B;AAEA,EAAO,OAAA;AAAA,IACL,UAAa,GAAA;AACX,MAAM,MAAA,OAAA,GAAU,KAAM,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACpC,MACE,uBAAA,KAAA,CAAA,aAAA,CAAC,MAAM,QAAN,EAAA,EAAe,UAAU,gBACxB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,aAAQ,CACX,CAAA,CAAA;AAAA,KAEJ;AAAA,GACF,CAAA;AACF,CAAA;AAQO,SAAS,qBAAqB,OAMH,EAAA;AAChC,EAAM,MAAA;AAAA,IACJ,QAAA,EAAU,qBAAqB,EAAC;AAAA,IAChC,MAAS,GAAA,IAAI,YAAa,CAAA,IAAI,cAAc,CAAA;AAAA,GAC9C,GAAI,WAAW,EAAC,CAAA;AAEhB,EAAM,MAAA,QAAA,GAAW,oBAAoB,kBAAkB,CAAA,CAAA;AAEvD,EAAA,MAAM,OAAO,aAAc,CAAA;AAAA,IACzB,QAAA;AAAA,IACA,iBAAA;AAAA,IACA,MAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAM,MAAA,SAAA,GAAY,2BAA4B,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AACvD,EAAA,MAAM,aAAgB,GAAA,oBAAA;AAAA,IACpB,OAAS,EAAA,UAAA;AAAA,IACT,MAAA;AAAA,IACA,gBAAgB,QAAQ,CAAA;AAAA,GAC1B,CAAA;AAEA,EAAM,MAAA,gBAAA,GAAmB,IAAI,gBAAiB,EAAA,CAAA;AAC9C,EAAA,MAAM,SAAY,GAAA,eAAA;AAAA,IAChB,IAAA;AAAA,IACA,MAAA;AAAA,IACA,gBAAA;AAAA,IACA,IAAI,aAAA;AAAA,MACF,SAAU,CAAA,UAAA;AAAA,MACV,SAAU,CAAA,YAAA;AAAA,MACV,SAAU,CAAA,YAAA;AAAA,MACV,aAAA;AAAA,MACA,YAAY,MAAM,CAAA;AAAA,KACpB;AAAA,IACA,OAAS,EAAA,KAAA;AAAA,GACX,CAAA;AAEA,EAAA,IAAI,gBAAkB,EAAA;AACpB,IAAM,MAAA,YAAA,GAAe,SAAU,CAAA,GAAA,CAAI,eAAe,CAAA,CAAA;AAClD,IAAM,MAAA,QAAA,GAAW,SAAU,CAAA,GAAA,CAAI,WAAW,CAAA,CAAA;AAC1C,IAAM,MAAA,QAAA,GAAW,SAAU,CAAA,GAAA,CAAI,WAAW,CAAA,CAAA;AAC1C,IAAA,IAAI,CAAC,YAAA,IAAgB,CAAC,QAAA,IAAY,CAAC,QAAU,EAAA;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,4DAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAA,gBAAA,CAAiB,gBAAiB,CAAA;AAAA,MAChC,YAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAEA,EAAM,MAAA,cAAA,GAAiB,SAAU,CAAA,GAAA,CAAI,kBAAkB,CAAA,CAAA;AACvD,EAAA,IAAI,cAAgB,EAAA;AAClB,IAAA,KAAA,MAAW,WAAW,QAAU,EAAA;AAC9B,MAAI,IAAA,OAAA,CAAQ,WAAW,4BAA8B,EAAA;AACnD,QAA0B,yBAAA,CAAA,OAAO,EAAE,YAAa,CAAA,OAAA;AAAA,UAAQ,CAAA,IAAA,KACtD,eAAe,YAAa,CAAA;AAAA,YAC1B,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,UAAU,OAAQ,CAAA,EAAA;AAAA,WACnB,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AACA,MAAI,IAAA,OAAA,CAAQ,WAAW,+BAAiC,EAAA;AACtD,QAA6B,4BAAA,CAAA,OAAO,EAAE,YAAa,CAAA,OAAA;AAAA,UAAQ,CAAA,IAAA,KACzD,eAAe,YAAa,CAAA,EAAE,MAAM,IAAK,CAAA,IAAA,EAAM,QAAU,EAAA,EAAA,EAAI,CAAA;AAAA,SAC/D,CAAA;AAAA,OACF;AAAA,KACF;AAAA,GACF;AAEA,EAAA,MAAM,SAAS,IAAK,CAAA,IAAA,CAAK,QAAU,CAAA,OAAA,CAAQ,kBAAkB,YAAY,CAAA,CAAA;AAEzE,EAAA,MAAM,eAAe,sBACnB,KAAA,CAAA,aAAA,CAAC,eAAY,IAAM,EAAA,SAAA,EAAA,sCAChB,gBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,kBAAmB,CAAA,QAAA;AAAA,IAAnB;AAAA,MACC,KAAO,EAAA,EAAE,gBAAkB,EAAA,YAAA,EAAc,UAAU,YAAa,EAAA;AAAA,KAAA;AAAA,IAE/D,MAAA;AAAA,GAEL,CACF,CAAA,CAAA;AAGF,EAAO,OAAA;AAAA,IACL,UAAa,GAAA;AACX,MAAA,2CAAQ,YAAa,EAAA,IAAA,CAAA,CAAA;AAAA,KACvB;AAAA,GACF,CAAA;AACF,CAAA;AAEA,SAAS,eACP,CAAA,IAAA,EACA,SACA,EAAA,gBAAA,EACA,oBACAC,OACW,EAAA;AACX,EAAM,MAAA,eAAA,GAAkB,IAAI,kBAAmB,EAAA,CAAA;AAE/C,EAAM,MAAA,UAAA,GACJ,IAAK,CAAA,IAAA,CAAK,KAAM,CAAA,WAAA,CACb,IAAI,MAAM,CAAA,EACT,GAAI,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,QAAA,EAAU,QAAQ,YAAa,CAAA,QAAA,CAAS,OAAO,CAAC,CAC5D,CAAA,MAAA,CAAO,CAAC,CAAA,KAA0B,CAAC,CAAC,CAAC,CAAA,IAAK,EAAC,CAAA;AAEhD,EAAM,MAAA,eAAA,GACJ,IAAK,CAAA,IAAA,CAAK,KAAM,CAAA,WAAA,CACb,IAAI,QAAQ,CAAA,EACX,GAAI,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,QAAA,EAAU,QAAQ,cAAe,CAAA,QAAA,CAAS,KAAK,CAAC,CAC5D,CAAA,MAAA,CAAO,CAAC,CAAA,KAAqB,CAAC,CAAC,CAAC,CAAA,IAAK,EAAC,CAAA;AAE3C,EAAA,MAAM,uBACJ,IAAK,CAAA,IAAA,CAAK,KAAM,CAAA,WAAA,CACb,IAAI,cAAc,CAAA,EACjB,GAAI,CAAA,CAAA,CAAA,KAAK,EAAE,QAAU,EAAA,OAAA,CAAQ,qBAAqB,QAAS,CAAA,WAAW,CAAC,CACxE,CAAA,MAAA;AAAA,IACC,CAAC,CAA+D,KAAA,CAAC,CAAC,CAAA;AAAA,OAC/D,EAAC,CAAA;AAEV,EAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,IAAK,CAAA,KAAA,CAAM,WACpC,CAAA,GAAA,CAAI,OAAO,CAAA,EACV,GAAI,CAAA,CAAA,CAAA,KAAK,CAAE,CAAA,QAAA,EAAU,OAAQ,CAAA,mBAAA,CAAoB,QAAS,CAAA,KAAK,CAAC,CAAA,CACjE,MAAO,CAAA,CAAC,GAAK,EAAA,MAAA,MAAY,EAAE,GAAG,GAAK,EAAA,GAAG,MAAO,EAAA,CAAA,EAAI,EAAE,CAAA,CAAA;AAEtD,EAAA,KAAA,MAAW,WAAW,UAAY,EAAA;AAChC,IAAgB,eAAA,CAAA,QAAA,CAAS,WAAW,OAAO,CAAA,CAAA;AAAA,GAC7C;AAGA,EAAA,eAAA,CAAgB,SAAS,SAAW,EAAA;AAAA,IAClC,GAAK,EAAA,kBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,IAAI,wBAAyB,EAAA;AAAA,GAC7C,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,cAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,MAAM,gBAAA;AAAA,GAChB,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,aAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,OAAO;AAAA,MACd,OAAA,EAAS,OAAO,EAAE,IAAK,EAAA,CAAA;AAAA,KACzB,CAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,qBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,MAAM,kBAAA;AAAA,GAChB,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,gBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAS,EAAA,MAAM,oBAAqB,CAAA,QAAA,CAAS,IAAI,CAAA;AAAA,GAClD,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,WAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MACP,IAAI,eAAgB,CAAA,EAAE,GAAGC,KAAA,EAAc,GAAG,cAAA,EAAgB,GAAGD,OAAA,EAAO,CAAA;AAAA,GACvE,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,cAAA;AAAA,IACL,MAAM,EAAC;AAAA;AAAA,IAEP,OAAS,EAAA,MAAM,gBAAiB,CAAA,iBAAA,CAAkB,eAAe,CAAA;AAAA,GAClE,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,iBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,mBAAA,CAAoB,iBAAkB,EAAA;AAAA,GACtD,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,YAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,SAAS,MAAM,SAAA;AAAA,GAChB,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,iBAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,mBAAA,CAAoB,iBAAkB,EAAA;AAAA,GACtD,CAAA,CAAA;AAED,EAAA,eAAA,CAAgB,SAAS,QAAU,EAAA;AAAA,IACjC,GAAK,EAAA,iBAAA;AAAA,IACL,IAAA,EAAM,EAAE,WAAA,EAAa,iBAAkB,EAAA;AAAA,IACvC,SAAS,CAAC,EAAE,WAAY,EAAA,KACtB,sBAAsB,MAAO,CAAA;AAAA,MAC3B,WAAA;AAAA,MACA,SAAW,EAAA,oBAAA;AAAA,KACZ,CAAA;AAAA,GACJ,CAAA,CAAA;AAED,EAAA,WAAA,CAAY,iBAAkB,CAAA,eAAA,EAAiB,eAAgB,CAAA,UAAA,EAAY,CAAA,CAAA;AAE3E,EAAO,OAAA,IAAI,YAAY,eAAe,CAAA,CAAA;AACxC;;;;"}
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { ConfigReader } from '@backstage/config';
|
|
2
|
-
|
|
3
|
-
function readPackageDetectionConfig(config) {
|
|
4
|
-
const packages = config.getOptional("app.experimental.packages");
|
|
5
|
-
if (packages === void 0 || packages === null) {
|
|
6
|
-
return void 0;
|
|
7
|
-
}
|
|
8
|
-
if (typeof packages === "string") {
|
|
9
|
-
if (packages !== "all") {
|
|
10
|
-
throw new Error(
|
|
11
|
-
`Invalid app.experimental.packages mode, got '${packages}', expected 'all'`
|
|
12
|
-
);
|
|
13
|
-
}
|
|
14
|
-
return {};
|
|
15
|
-
}
|
|
16
|
-
if (typeof packages !== "object" || Array.isArray(packages)) {
|
|
17
|
-
throw new Error(
|
|
18
|
-
"Invalid config at 'app.experimental.packages', expected object"
|
|
19
|
-
);
|
|
20
|
-
}
|
|
21
|
-
const packagesConfig = new ConfigReader(
|
|
22
|
-
packages,
|
|
23
|
-
"app.experimental.packages"
|
|
24
|
-
);
|
|
25
|
-
return {
|
|
26
|
-
include: packagesConfig.getOptionalStringArray("include"),
|
|
27
|
-
exclude: packagesConfig.getOptionalStringArray("exclude")
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
function getAvailableFeatures(config) {
|
|
31
|
-
const discovered = window["__@backstage/discovered__"];
|
|
32
|
-
const detection = readPackageDetectionConfig(config);
|
|
33
|
-
if (!detection) {
|
|
34
|
-
return [];
|
|
35
|
-
}
|
|
36
|
-
return discovered?.modules.filter(({ name }) => {
|
|
37
|
-
if (detection.exclude?.includes(name)) {
|
|
38
|
-
return false;
|
|
39
|
-
}
|
|
40
|
-
if (detection.include && !detection.include.includes(name)) {
|
|
41
|
-
return false;
|
|
42
|
-
}
|
|
43
|
-
return true;
|
|
44
|
-
}).map((m) => m.default).filter(isBackstageFeature) ?? [];
|
|
45
|
-
}
|
|
46
|
-
function isBackstageFeature(obj) {
|
|
47
|
-
if (obj !== null && typeof obj === "object" && "$$type" in obj) {
|
|
48
|
-
return obj.$$type === "@backstage/BackstagePlugin" || obj.$$type === "@backstage/ExtensionOverrides";
|
|
49
|
-
}
|
|
50
|
-
return false;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
export { getAvailableFeatures };
|
|
54
|
-
//# sourceMappingURL=discovery.esm.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"discovery.esm.js","sources":["../../src/wiring/discovery.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { Config, ConfigReader } from '@backstage/config';\nimport { FrontendFeature } from '@backstage/frontend-plugin-api';\n\ninterface DiscoveryGlobal {\n modules: Array<{ name: string; export?: string; default: unknown }>;\n}\n\nfunction readPackageDetectionConfig(config: Config) {\n const packages = config.getOptional('app.experimental.packages');\n if (packages === undefined || packages === null) {\n return undefined;\n }\n\n if (typeof packages === 'string') {\n if (packages !== 'all') {\n throw new Error(\n `Invalid app.experimental.packages mode, got '${packages}', expected 'all'`,\n );\n }\n return {};\n }\n\n if (typeof packages !== 'object' || Array.isArray(packages)) {\n throw new Error(\n \"Invalid config at 'app.experimental.packages', expected object\",\n );\n }\n const packagesConfig = new ConfigReader(\n packages,\n 'app.experimental.packages',\n );\n\n return {\n include: packagesConfig.getOptionalStringArray('include'),\n exclude: packagesConfig.getOptionalStringArray('exclude'),\n };\n}\n\n/**\n * @public\n */\nexport function getAvailableFeatures(config: Config): FrontendFeature[] {\n const discovered = (\n window as { '__@backstage/discovered__'?: DiscoveryGlobal }\n )['__@backstage/discovered__'];\n\n const detection = readPackageDetectionConfig(config);\n if (!detection) {\n return [];\n }\n\n return (\n discovered?.modules\n .filter(({ name }) => {\n if (detection.exclude?.includes(name)) {\n return false;\n }\n if (detection.include && !detection.include.includes(name)) {\n return false;\n }\n return true;\n })\n .map(m => m.default)\n .filter(isBackstageFeature) ?? []\n );\n}\n\nfunction isBackstageFeature(obj: unknown): obj is FrontendFeature {\n if (obj !== null && typeof obj === 'object' && '$$type' in obj) {\n return (\n obj.$$type === '@backstage/BackstagePlugin' ||\n obj.$$type === '@backstage/ExtensionOverrides'\n );\n }\n return false;\n}\n"],"names":[],"mappings":";;AAuBA,SAAS,2BAA2B,MAAgB,EAAA;AAClD,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,WAAA,CAAY,2BAA2B,CAAA,CAAA;AAC/D,EAAI,IAAA,QAAA,KAAa,KAAa,CAAA,IAAA,QAAA,KAAa,IAAM,EAAA;AAC/C,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACT;AAEA,EAAI,IAAA,OAAO,aAAa,QAAU,EAAA;AAChC,IAAA,IAAI,aAAa,KAAO,EAAA;AACtB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,gDAAgD,QAAQ,CAAA,iBAAA,CAAA;AAAA,OAC1D,CAAA;AAAA,KACF;AACA,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,IAAI,OAAO,QAAa,KAAA,QAAA,IAAY,KAAM,CAAA,OAAA,CAAQ,QAAQ,CAAG,EAAA;AAC3D,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gEAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,MAAM,iBAAiB,IAAI,YAAA;AAAA,IACzB,QAAA;AAAA,IACA,2BAAA;AAAA,GACF,CAAA;AAEA,EAAO,OAAA;AAAA,IACL,OAAA,EAAS,cAAe,CAAA,sBAAA,CAAuB,SAAS,CAAA;AAAA,IACxD,OAAA,EAAS,cAAe,CAAA,sBAAA,CAAuB,SAAS,CAAA;AAAA,GAC1D,CAAA;AACF,CAAA;AAKO,SAAS,qBAAqB,MAAmC,EAAA;AACtE,EAAM,MAAA,UAAA,GACJ,OACA,2BAA2B,CAAA,CAAA;AAE7B,EAAM,MAAA,SAAA,GAAY,2BAA2B,MAAM,CAAA,CAAA;AACnD,EAAA,IAAI,CAAC,SAAW,EAAA;AACd,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,OACE,YAAY,OACT,CAAA,MAAA,CAAO,CAAC,EAAE,MAAW,KAAA;AACpB,IAAA,IAAI,SAAU,CAAA,OAAA,EAAS,QAAS,CAAA,IAAI,CAAG,EAAA;AACrC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AACA,IAAA,IAAI,UAAU,OAAW,IAAA,CAAC,UAAU,OAAQ,CAAA,QAAA,CAAS,IAAI,CAAG,EAAA;AAC1D,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACR,CACA,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,OAAO,CAClB,CAAA,MAAA,CAAO,kBAAkB,CAAA,IAAK,EAAC,CAAA;AAEtC,CAAA;AAEA,SAAS,mBAAmB,GAAsC,EAAA;AAChE,EAAA,IAAI,QAAQ,IAAQ,IAAA,OAAO,GAAQ,KAAA,QAAA,IAAY,YAAY,GAAK,EAAA;AAC9D,IAAA,OACE,GAAI,CAAA,MAAA,KAAW,4BACf,IAAA,GAAA,CAAI,MAAW,KAAA,+BAAA,CAAA;AAAA,GAEnB;AACA,EAAO,OAAA,KAAA,CAAA;AACT;;;;"}
|