paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

frontend-plugin-api: add new internal option for extension inputs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2026-01-22 14:22:56 +01:00
parent 24eb7d7933
commit 7edb810248
27 changed files with 315 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/app/report.api.md
+17
View File
@@ -40,6 +40,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: false;
internal: false;
}
>;
};
@@ -57,6 +58,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: false;
internal: false;
}
>;
content: ExtensionInput<
@@ -64,6 +66,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: false;
internal: false;
}
>;
};
@@ -89,6 +92,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: false;
}
>;
content: ExtensionInput<
@@ -100,6 +104,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: true;
internal: true;
}
>;
};
@@ -121,6 +126,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: true;
internal: true;
}
>;
signInPage: ExtensionInput<
@@ -132,6 +138,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: true;
internal: true;
}
>;
children: ExtensionInput<
@@ -139,6 +146,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: true;
optional: false;
internal: false;
}
>;
elements: ExtensionInput<
@@ -146,6 +154,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: false;
}
>;
wrappers: ExtensionInput<
@@ -157,6 +166,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: true;
}
>;
};
@@ -182,6 +192,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: false;
}
>;
};
@@ -218,6 +229,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: false;
}
>;
};
@@ -262,6 +274,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: true;
}
>;
};
@@ -471,6 +484,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: true;
}
>;
};
@@ -592,6 +606,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: false;
}
>;
};
@@ -669,6 +684,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: true;
}
>;
};
@@ -703,6 +719,7 @@ const appPlugin: OverridableFrontendPlugin<
{
singleton: false;
optional: false;
internal: true;
}
>;
};
plugins/app/src/extensions/AppNav.tsx
+1 -8
View File
@@ -90,18 +90,11 @@ export const AppNav = createExtension({
content: createExtensionInput([NavContentBlueprint.dataRefs.component], {
singleton: true,
optional: true,
internal: true,
}),
},
output: [coreExtensionData.reactElement],
*factory({ inputs }) {
if (inputs.content && inputs.content.node.spec.plugin?.id !== 'app') {
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: NavContent should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${inputs.content.node.spec.id}`,
);
}
const Content =
inputs.content?.get(NavContentBlueprint.dataRefs.component) ??
DefaultNavContent;
plugins/app/src/extensions/AppRoot.tsx
+8 -27
View File
@@ -59,37 +59,26 @@ export const AppRoot = createExtension({
router: createExtensionInput([RouterBlueprint.dataRefs.component], {
singleton: true,
optional: true,
internal: true,
}),
signInPage: createExtensionInput([SignInPageBlueprint.dataRefs.component], {
singleton: true,
optional: true,
internal: true,
}),
children: createExtensionInput([coreExtensionData.reactElement], {
singleton: true,
}),
elements: createExtensionInput([coreExtensionData.reactElement]),
wrappers: createExtensionInput([
AppRootWrapperBlueprint.dataRefs.component,
]),
wrappers: createExtensionInput(
[AppRootWrapperBlueprint.dataRefs.component],
{
internal: true,
},
),
},
output: [coreExtensionData.reactElement],
factory({ inputs, apis }) {
if (inputs.router && inputs.router.node.spec.plugin?.id !== 'app') {
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: Router should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${inputs.router.node.spec.id}`,
);
}
if (inputs.signInPage && inputs.signInPage.node.spec.plugin?.id !== 'app') {
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: SignInPage should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${inputs.signInPage.node.spec.id}`,
);
}
if (isProtectedApp()) {
const identityApi = apis.get(identityApiRef);
if (!identityApi) {
@@ -117,16 +106,8 @@ export const AppRoot = createExtension({
for (const wrapper of inputs.wrappers) {
const Component = wrapper.get(AppRootWrapperBlueprint.dataRefs.component);
const pluginId = wrapper.node.spec.plugin.id;
if (Component) {
content = <Component>{content}</Component>;
if (pluginId !== 'app') {
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: AppRootWrappers should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${wrapper.node.spec.id}`,
);
}
}
}
plugins/app/src/extensions/AppThemeApi.tsx
+1 -13
View File
@@ -37,6 +37,7 @@ export const AppThemeApi = ApiBlueprint.makeWithOverrides({
inputs: {
themes: createExtensionInput([ThemeBlueprint.dataRefs.theme], {
replaces: [{ id: 'app', input: 'themes' }],
internal: true,
}),
},
factory: (originalFactory, { inputs }) => {
@@ -45,19 +46,6 @@ export const AppThemeApi = ApiBlueprint.makeWithOverrides({
api: appThemeApiRef,
deps: {},
factory: () => {
const nonAppExtensions = inputs.themes.filter(
i => i.node.spec.plugin?.id !== 'app',
);
if (nonAppExtensions.length > 0) {
const list = nonAppExtensions.map(i => i.node.spec.id).join(', ');
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: Theme should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${list}`,
);
}
return AppThemeSelector.createWithStorage(
inputs.themes.map(i => i.get(ThemeBlueprint.dataRefs.theme)),
);
plugins/app/src/extensions/IconsApi.ts
+1 -13
View File
@@ -33,6 +33,7 @@ export const IconsApi = ApiBlueprint.makeWithOverrides({
inputs: {
icons: createExtensionInput([IconBundleBlueprint.dataRefs.icons], {
replaces: [{ id: 'app', input: 'icons' }],
internal: true,
}),
},
factory: (originalFactory, { inputs }) => {
@@ -41,19 +42,6 @@ export const IconsApi = ApiBlueprint.makeWithOverrides({
api: iconsApiRef,
deps: {},
factory: () => {
const nonAppExtensions = inputs.icons.filter(
i => i.node.spec.plugin?.id !== 'app',
);
if (nonAppExtensions.length > 0) {
const list = nonAppExtensions.map(i => i.node.spec.id).join(', ');
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: IconBundle should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${list}`,
);
}
return new DefaultIconsApi(
inputs.icons
.map(i => i.get(IconBundleBlueprint.dataRefs.icons))
plugins/app/src/extensions/SwappableComponentsApi.ts
+7 -21
View File
@@ -28,9 +28,12 @@ import { DefaultSwappableComponentsApi } from '../apis/SwappableComponentsApi';
export const SwappableComponentsApi = ApiBlueprint.makeWithOverrides({
name: 'swappable-components',
inputs: {
components: createExtensionInput([
SwappableComponentBlueprint.dataRefs.component,
]),
components: createExtensionInput(
[SwappableComponentBlueprint.dataRefs.component],
{
internal: true,
},
),
},
factory: (originalFactory, { inputs }) => {
return originalFactory(defineParams =>
@@ -38,25 +41,8 @@ export const SwappableComponentsApi = ApiBlueprint.makeWithOverrides({
api: swappableComponentsApiRef,
deps: {},
factory: () => {
const nonAppExtensions = inputs.components.filter(
i => i.node.spec.plugin?.id !== 'app',
);
if (nonAppExtensions.length > 0) {
// eslint-disable-next-line no-console
console.warn(
`SwappableComponents should only be installed as an extension in the app plugin. You can either use appPlugin.override(), or provide a module for the app-plugin with the extension there instead. Invalid extensions: ${nonAppExtensions
.map(i => i.node.spec.id)
.join(', ')}`,
);
}
const appExtensions = inputs.components.filter(
i => i.node.spec.plugin?.id === 'app',
);
return DefaultSwappableComponentsApi.fromComponents(
appExtensions.map(i =>
inputs.components.map(i =>
i.get(SwappableComponentBlueprint.dataRefs.component),
),
);
plugins/app/src/extensions/TranslationsApi.tsx
+1 -14
View File
@@ -34,7 +34,7 @@ export const TranslationsApi = ApiBlueprint.makeWithOverrides({
inputs: {
translations: createExtensionInput(
[TranslationBlueprint.dataRefs.translation],
{ replaces: [{ id: 'app', input: 'translations' }] },
{ replaces: [{ id: 'app', input: 'translations' }], internal: true },
),
},
factory: (originalFactory, { inputs }) => {
@@ -43,19 +43,6 @@ export const TranslationsApi = ApiBlueprint.makeWithOverrides({
api: translationApiRef,
deps: { languageApi: appLanguageApiRef },
factory: ({ languageApi }) => {
const nonAppExtensions = inputs.translations.filter(
i => i.node.spec.plugin?.id !== 'app',
);
if (nonAppExtensions.length > 0) {
const list = nonAppExtensions.map(i => i.node.spec.id).join(', ');
// eslint-disable-next-line no-console
console.warn(
`DEPRECATION WARNING: Translations should only be installed as an extension in the app plugin. ` +
`You can either use appPlugin.override(), or a module for the app plugin. The following extension will be ignored in the future: ${list}`,
);
}
return I18nextTranslationApi.create({
languageApi,
resources: inputs.translations.map(i =>