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

frontend-plugin-api: improve type errors for createFrontend{Plugin,Module}

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-08-31 10:21:44 +02:00
parent 2926f773c2
commit 2fb8b04f79
4 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/fine-hands-think.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/frontend-plugin-api': patch
---
Improved the types of `createFrontendPlugin` and `createFrontendModule` so that errors due to incompatible options are indicated more clearly.
packages/frontend-plugin-api/report.api.md
+2 -2
View File
@@ -691,7 +691,7 @@ export interface CreateFrontendFeatureLoaderOptions {
// @public
export function createFrontendModule<
TId extends string,
TExtensions extends readonly ExtensionDefinition[] = [],
TExtensions extends readonly ExtensionDefinition[],
>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule;
// @public (undocumented)
@@ -710,13 +710,13 @@ export interface CreateFrontendModuleOptions<
// @public
export function createFrontendPlugin<
TId extends string,
TExtensions extends readonly ExtensionDefinition[],
TRoutes extends {
[name in string]: RouteRef | SubRouteRef;
} = {},
TExternalRoutes extends {
[name in string]: ExternalRouteRef;
} = {},
TExtensions extends readonly ExtensionDefinition[] = [],
>(
options: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>,
): OverridableFrontendPlugin<
packages/frontend-plugin-api/src/wiring/createFrontendModule.ts
+1 -1
View File
@@ -86,7 +86,7 @@ export interface InternalFrontendModule extends FrontendModule {
*/
export function createFrontendModule<
TId extends string,
TExtensions extends readonly ExtensionDefinition[] = [],
TExtensions extends readonly ExtensionDefinition[],
>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule {
const { pluginId } = options;
packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts
+1 -1
View File
@@ -182,9 +182,9 @@ export interface PluginOptions<
*/
export function createFrontendPlugin<
TId extends string,
TExtensions extends readonly ExtensionDefinition[],
TRoutes extends { [name in string]: RouteRef | SubRouteRef } = {},
TExternalRoutes extends { [name in string]: ExternalRouteRef } = {},
TExtensions extends readonly ExtensionDefinition[] = [],
>(
options: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>,
): OverridableFrontendPlugin<