@backstage/frontend-plugin-api 0.10.0-next.2 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/frontend-plugin-api
 
+## 0.10.0
+
+### Minor Changes
+
+- 4823831: Introduced a `createFrontendFeatureLoader()` function, as well as a `FrontendFeatureLoader` interface, to gather several frontend plugins, modules or feature loaders in a single exported entrypoint and load them, possibly asynchronously. This new feature, very similar to the `createBackendFeatureLoader()` already available on the backend, supersedes the previous `CreateAppFeatureLoader` type which has been deprecated.
+- 8250ffe: **BREAKING**: Removed the deprecated `ExtensionOverrides` and `FrontendFeature` types.
+- 0d1a397: **BREAKING**: Removed deprecated variant of `createExtensionDataRef` where the ID is passed directly.
+
+### Patch Changes
+
+- 5aa7f2c: Added a new Utility API, `DialogApi`, which can be used to show dialogs in the React tree that can collect input from the user.
+- e23f5e0: Added new `ExtensionMiddlewareFactory` type.
+- a6cb67d: The extensions map for plugins created with `createFrontendPlugin` is now sorted alphabetically by ID in the TypeScript type.
+- de72253: Added a new `ExtensionBoundary.lazyComponent` helper in addition to the existing `ExtensionBoundary.lazy` helper.
+- Updated dependencies
+  - @backstage/core-components@0.17.0
+  - @backstage/core-plugin-api@1.10.5
+  - @backstage/types@1.2.1
+  - @backstage/version-bridge@1.0.11
+
 ## 0.10.0-next.2
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as React$1 from 'react';
 import React__default, { ReactNode, JSX as JSX$1, ComponentType, PropsWithChildren } from 'react';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { ApiHolder, ApiRef, AnyApiFactory, IconComponent as IconComponent$1, SignInPageProps, AppTheme } from '@backstage/core-plugin-api';
+import { ApiHolder, ConfigApi, ApiRef, AnyApiFactory, IconComponent as IconComponent$1, SignInPageProps, AppTheme } from '@backstage/core-plugin-api';
 export { AlertApi, AlertMessage, AnyApiFactory, AnyApiRef, ApiFactory, ApiHolder, ApiRef, ApiRefConfig, AppTheme, AppThemeApi, AuthProviderInfo, AuthRequestOptions, BackstageIdentityApi, BackstageIdentityResponse, BackstageUserIdentity, ConfigApi, DiscoveryApi, ErrorApi, ErrorApiError, ErrorApiErrorContext, FeatureFlag, FeatureFlagState, FeatureFlagsApi, FeatureFlagsSaveOptions, FetchApi, IdentityApi, OAuthApi, OAuthRequestApi, OAuthRequester, OAuthRequesterOptions, OAuthScope, OpenIdConnectApi, PendingOAuthRequest, ProfileInfo, ProfileInfoApi, SessionApi, SessionState, StorageApi, StorageValueSnapshot, TypesToApiRefs, alertApiRef, appThemeApiRef, atlassianAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, configApiRef, createApiFactory, createApiRef, discoveryApiRef, errorApiRef, featureFlagsApiRef, fetchApiRef, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, identityApiRef, microsoftAuthApiRef, oauthRequestApiRef, oktaAuthApiRef, oneloginAuthApiRef, storageApiRef, useApi, useApiHolder, vmwareCloudAuthApiRef, withApis } from '@backstage/core-plugin-api';
 import { Expand, JsonObject } from '@backstage/types';
 import { z } from 'zod';
@@ -316,6 +316,102 @@ type ResolveInputValueOverrides<TInputs extends {
     }> ? ISingleton extends true ? Iterable<ExtensionDataRefToValue<IDataRefs>> : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>> : never;
 }>;
 
+/** @public */
+interface CreateFrontendModuleOptions<TPluginId extends string, TExtensions extends readonly ExtensionDefinition[]> {
+    pluginId: TPluginId;
+    extensions?: TExtensions;
+    featureFlags?: FeatureFlagConfig[];
+}
+/** @public */
+interface FrontendModule {
+    readonly $$type: '@backstage/FrontendModule';
+    readonly pluginId: string;
+}
+/** @public */
+declare function createFrontendModule<TId extends string, TExtensions extends readonly ExtensionDefinition[] = []>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule;
+
+/** @public */
+type PortableSchema<TOutput, TInput = TOutput> = {
+    parse: (input: TInput) => TOutput;
+    schema: JsonObject;
+};
+
+/** @public */
+interface Extension<TConfig, TConfigInput = TConfig> {
+    $$type: '@backstage/Extension';
+    readonly id: string;
+    readonly attachTo: ExtensionAttachToSpec;
+    readonly disabled: boolean;
+    readonly configSchema?: PortableSchema<TConfig, TConfigInput>;
+}
+/** @ignore */
+type ResolveExtensionId<TExtension extends ExtensionDefinition, TNamespace extends string> = TExtension extends ExtensionDefinition<{
+    kind: infer IKind extends string | undefined;
+    name: infer IName extends string | undefined;
+}> ? [string] extends [IKind | IName] ? never : (undefined extends IName ? TNamespace : `${TNamespace}/${IName}`) extends infer INamePart extends string ? IKind extends string ? `${IKind}:${INamePart}` : INamePart : never : never;
+
+type CompareChars<A extends string, B extends string> = [A, B] extends [
+    `${infer IAHead}${infer IARest}`,
+    `${infer IBHead}${infer IBRest}`
+] ? IAHead extends IBHead ? IBRest extends '' ? IARest extends '' ? 'eq' : 'gt' : IARest extends '' ? 'lt' : CompareChars<IARest, IBRest> : `0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz` extends `${string}${IAHead}${string}${IBHead}${string}` ? 'lt' : 'gt' : 'eq';
+type CompareStrings<A extends string | undefined, B extends string | undefined> = A extends B ? 'eq' : A extends undefined ? 'lt' : B extends undefined ? 'gt' : CompareChars<A & string, B & string>;
+type CompareExtensions<A extends ExtensionDefinition, B extends ExtensionDefinition> = CompareStrings<A['T']['kind'], B['T']['kind']> extends 'eq' ? CompareStrings<A['T']['name'], B['T']['name']> : CompareStrings<A['T']['kind'], B['T']['kind']>;
+type SortExtensionsInner<TPivot extends ExtensionDefinition, TRest extends readonly ExtensionDefinition[], TLow extends readonly ExtensionDefinition[], THigh extends readonly ExtensionDefinition[]> = TRest extends [
+    infer IHead extends ExtensionDefinition,
+    ...infer IRest extends readonly ExtensionDefinition[]
+] ? CompareExtensions<IHead, TPivot> extends 'lt' ? SortExtensionsInner<TPivot, IRest, [...TLow, IHead], THigh> : SortExtensionsInner<TPivot, IRest, TLow, [...THigh, IHead]> : [low: TLow, high: THigh];
+type SortExtensions<T extends readonly ExtensionDefinition[]> = T extends [
+    infer IPivot extends ExtensionDefinition,
+    ...infer IRest extends readonly ExtensionDefinition[]
+] ? SortExtensionsInner<IPivot, IRest, [], []> extends [
+    low: infer ILow extends readonly ExtensionDefinition[],
+    high: infer IHigh extends readonly ExtensionDefinition[]
+] ? [...SortExtensions<ILow>, IPivot, ...SortExtensions<IHigh>] : 'invalid SortExtensionsInner' : [];
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type PopUnion$1<U> = UnionToIntersection<U extends any ? () => U : never> extends () => infer R ? [next: R, rest: Exclude<U, R>] : undefined;
+type UnionToArray<U, T = U, TResult extends T[] = []> = PopUnion$1<U> extends [
+    next: infer INext extends T,
+    rest: infer IRest extends T
+] ? UnionToArray<IRest, T, [INext, ...TResult]> : TResult;
+type ExtensionArrayToMap<T extends ExtensionDefinition[], TId extends string, TOut extends {
+    [KId in string]: ExtensionDefinition;
+} = {}> = T extends [
+    infer IHead extends ExtensionDefinition,
+    ...infer IRest extends ExtensionDefinition[]
+] ? ExtensionArrayToMap<IRest, TId, TOut & {
+    [K in ResolveExtensionId<IHead, TId>]: IHead;
+}> : TOut extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+/** @ignore */
+type MakeSortedExtensionsMap<UExtensions extends ExtensionDefinition, TId extends string> = ExtensionArrayToMap<SortExtensions<UnionToArray<UExtensions>>, TId>;
+
+/** @public */
+interface FrontendPlugin<TRoutes extends AnyRoutes = AnyRoutes, TExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, TExtensionMap extends {
+    [id in string]: ExtensionDefinition;
+} = {
+    [id in string]: ExtensionDefinition;
+}> {
+    readonly $$type: '@backstage/FrontendPlugin';
+    readonly id: string;
+    readonly routes: TRoutes;
+    readonly externalRoutes: TExternalRoutes;
+    getExtension<TId extends keyof TExtensionMap>(id: TId): TExtensionMap[TId];
+    withOverrides(options: {
+        extensions: Array<ExtensionDefinition>;
+    }): FrontendPlugin<TRoutes, TExternalRoutes, TExtensionMap>;
+}
+/** @public */
+interface PluginOptions<TId extends string, TRoutes extends AnyRoutes, TExternalRoutes extends AnyExternalRoutes, TExtensions extends readonly ExtensionDefinition[]> {
+    id: TId;
+    routes?: TRoutes;
+    externalRoutes?: TExternalRoutes;
+    extensions?: TExtensions;
+    featureFlags?: FeatureFlagConfig[];
+}
+/** @public */
+declare function createFrontendPlugin<TId extends string, TRoutes extends AnyRoutes = {}, TExternalRoutes extends AnyExternalRoutes = {}, TExtensions extends readonly ExtensionDefinition[] = []>(options: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>): FrontendPlugin<TRoutes, TExternalRoutes, MakeSortedExtensionsMap<TExtensions[number], TId>>;
+
 /**
  * Feature flag configuration.
  *
@@ -345,6 +441,8 @@ type ExtensionFactoryMiddleware = (originalFactory: (contextOverrides?: {
     apis: ApiHolder;
     config?: JsonObject;
 }) => Iterable<ExtensionDataValue<any, any>>;
+/** @public  */
+type FrontendFeature = FrontendPlugin | FrontendModule;
 
 /**
  * Convert a single extension input into a matching resolved input.
@@ -363,9 +461,9 @@ type ResolvedExtensionInputs<TInputs extends {
     [InputName in keyof TInputs]: false extends TInputs[InputName]['config']['singleton'] ? Array<Expand<ResolvedExtensionInput<TInputs[InputName]>>> : false extends TInputs[InputName]['config']['optional'] ? Expand<ResolvedExtensionInput<TInputs[InputName]>> : Expand<ResolvedExtensionInput<TInputs[InputName]> | undefined>;
 };
 type ToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-type PopUnion$1<U> = ToIntersection<U extends any ? () => U : never> extends () => infer R ? [rest: Exclude<U, R>, next: R] : undefined;
+type PopUnion<U> = ToIntersection<U extends any ? () => U : never> extends () => infer R ? [rest: Exclude<U, R>, next: R] : undefined;
 /** @ignore */
-type JoinStringUnion<U, TDiv extends string = ', ', TResult extends string = ''> = PopUnion$1<U> extends [infer IRest extends string, infer INext extends string] ? TResult extends '' ? JoinStringUnion<IRest, TDiv, INext> : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`> : TResult;
+type JoinStringUnion<U, TDiv extends string = ', ', TResult extends string = ''> = PopUnion<U> extends [infer IRest extends string, infer INext extends string] ? TResult extends '' ? JoinStringUnion<IRest, TDiv, INext> : JoinStringUnion<IRest, TDiv, `${TResult}${TDiv}${INext}`> : TResult;
 /** @ignore */
 type VerifyExtensionFactoryOutput<UDeclaredOutput extends AnyExtensionDataRef, UFactoryOutput extends ExtensionDataValue<any, any>> = (UDeclaredOutput extends any ? UDeclaredOutput['config']['optional'] extends true ? never : UDeclaredOutput['id'] : never) extends infer IRequiredOutputIds ? [IRequiredOutputIds] extends [UFactoryOutput['id']] ? [UFactoryOutput['id']] extends [UDeclaredOutput['id']] ? {} : `Error: The extension factory has undeclared output(s): ${JoinStringUnion<Exclude<UFactoryOutput['id'], UDeclaredOutput['id']>>}` : `Error: The extension factory is missing the following output(s): ${JoinStringUnion<Exclude<IRequiredOutputIds, UFactoryOutput['id']>>}` : never;
 /** @public */
@@ -496,100 +594,23 @@ declare function createExtension<UOutput extends AnyExtensionDataRef, TInputs ex
 }>;
 
 /** @public */
-type PortableSchema<TOutput, TInput = TOutput> = {
-    parse: (input: TInput) => TOutput;
-    schema: JsonObject;
-};
-
-/** @public */
-interface Extension<TConfig, TConfigInput = TConfig> {
-    $$type: '@backstage/Extension';
-    readonly id: string;
-    readonly attachTo: ExtensionAttachToSpec;
-    readonly disabled: boolean;
-    readonly configSchema?: PortableSchema<TConfig, TConfigInput>;
-}
-/** @ignore */
-type ResolveExtensionId<TExtension extends ExtensionDefinition, TNamespace extends string> = TExtension extends ExtensionDefinition<{
-    kind: infer IKind extends string | undefined;
-    name: infer IName extends string | undefined;
-}> ? [string] extends [IKind | IName] ? never : (undefined extends IName ? TNamespace : `${TNamespace}/${IName}`) extends infer INamePart extends string ? IKind extends string ? `${IKind}:${INamePart}` : INamePart : never : never;
-
-type CompareChars<A extends string, B extends string> = [A, B] extends [
-    `${infer IAHead}${infer IARest}`,
-    `${infer IBHead}${infer IBRest}`
-] ? IAHead extends IBHead ? IBRest extends '' ? IARest extends '' ? 'eq' : 'gt' : IARest extends '' ? 'lt' : CompareChars<IARest, IBRest> : `0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz` extends `${string}${IAHead}${string}${IBHead}${string}` ? 'lt' : 'gt' : 'eq';
-type CompareStrings<A extends string | undefined, B extends string | undefined> = A extends B ? 'eq' : A extends undefined ? 'lt' : B extends undefined ? 'gt' : CompareChars<A & string, B & string>;
-type CompareExtensions<A extends ExtensionDefinition, B extends ExtensionDefinition> = CompareStrings<A['T']['kind'], B['T']['kind']> extends 'eq' ? CompareStrings<A['T']['name'], B['T']['name']> : CompareStrings<A['T']['kind'], B['T']['kind']>;
-type SortExtensionsInner<TPivot extends ExtensionDefinition, TRest extends readonly ExtensionDefinition[], TLow extends readonly ExtensionDefinition[], THigh extends readonly ExtensionDefinition[]> = TRest extends [
-    infer IHead extends ExtensionDefinition,
-    ...infer IRest extends readonly ExtensionDefinition[]
-] ? CompareExtensions<IHead, TPivot> extends 'lt' ? SortExtensionsInner<TPivot, IRest, [...TLow, IHead], THigh> : SortExtensionsInner<TPivot, IRest, TLow, [...THigh, IHead]> : [low: TLow, high: THigh];
-type SortExtensions<T extends readonly ExtensionDefinition[]> = T extends [
-    infer IPivot extends ExtensionDefinition,
-    ...infer IRest extends readonly ExtensionDefinition[]
-] ? SortExtensionsInner<IPivot, IRest, [], []> extends [
-    low: infer ILow extends readonly ExtensionDefinition[],
-    high: infer IHigh extends readonly ExtensionDefinition[]
-] ? [...SortExtensions<ILow>, IPivot, ...SortExtensions<IHigh>] : 'invalid SortExtensionsInner' : [];
-type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-type PopUnion<U> = UnionToIntersection<U extends any ? () => U : never> extends () => infer R ? [next: R, rest: Exclude<U, R>] : undefined;
-type UnionToArray<U, T = U, TResult extends T[] = []> = PopUnion<U> extends [
-    next: infer INext extends T,
-    rest: infer IRest extends T
-] ? UnionToArray<IRest, T, [INext, ...TResult]> : TResult;
-type ExtensionArrayToMap<T extends ExtensionDefinition[], TId extends string, TOut extends {
-    [KId in string]: ExtensionDefinition;
-} = {}> = T extends [
-    infer IHead extends ExtensionDefinition,
-    ...infer IRest extends ExtensionDefinition[]
-] ? ExtensionArrayToMap<IRest, TId, TOut & {
-    [K in ResolveExtensionId<IHead, TId>]: IHead;
-}> : TOut extends infer O ? {
-    [K in keyof O]: O[K];
-} : never;
-/** @ignore */
-type MakeSortedExtensionsMap<UExtensions extends ExtensionDefinition, TId extends string> = ExtensionArrayToMap<SortExtensions<UnionToArray<UExtensions>>, TId>;
-
-/** @public */
-interface FrontendPlugin<TRoutes extends AnyRoutes = AnyRoutes, TExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes, TExtensionMap extends {
-    [id in string]: ExtensionDefinition;
-} = {
-    [id in string]: ExtensionDefinition;
-}> {
-    readonly $$type: '@backstage/FrontendPlugin';
-    readonly id: string;
-    readonly routes: TRoutes;
-    readonly externalRoutes: TExternalRoutes;
-    getExtension<TId extends keyof TExtensionMap>(id: TId): TExtensionMap[TId];
-    withOverrides(options: {
-        extensions: Array<ExtensionDefinition>;
-    }): FrontendPlugin<TRoutes, TExternalRoutes, TExtensionMap>;
-}
-/** @public */
-interface PluginOptions<TId extends string, TRoutes extends AnyRoutes, TExternalRoutes extends AnyExternalRoutes, TExtensions extends readonly ExtensionDefinition[]> {
-    id: TId;
-    routes?: TRoutes;
-    externalRoutes?: TExternalRoutes;
-    extensions?: TExtensions;
-    featureFlags?: FeatureFlagConfig[];
-}
-/** @public */
-declare function createFrontendPlugin<TId extends string, TRoutes extends AnyRoutes = {}, TExternalRoutes extends AnyExternalRoutes = {}, TExtensions extends readonly ExtensionDefinition[] = []>(options: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>): FrontendPlugin<TRoutes, TExternalRoutes, MakeSortedExtensionsMap<TExtensions[number], TId>>;
-
-/** @public */
-interface CreateFrontendModuleOptions<TPluginId extends string, TExtensions extends readonly ExtensionDefinition[]> {
-    pluginId: TPluginId;
-    extensions?: TExtensions;
-    featureFlags?: FeatureFlagConfig[];
+interface CreateFrontendFeatureLoaderOptions {
+    loader(deps: {
+        config: ConfigApi;
+    }): Iterable<FrontendFeature | FrontendFeatureLoader | Promise<{
+        default: FrontendFeature | FrontendFeatureLoader;
+    }>> | Promise<Iterable<FrontendFeature | FrontendFeatureLoader | Promise<{
+        default: FrontendFeature | FrontendFeatureLoader;
+    }>>> | AsyncIterable<FrontendFeature | FrontendFeatureLoader | {
+        default: FrontendFeature | FrontendFeatureLoader;
+    }>;
 }
 /** @public */
-interface FrontendModule {
-    readonly $$type: '@backstage/FrontendModule';
-    readonly pluginId: string;
+interface FrontendFeatureLoader {
+    readonly $$type: '@backstage/FrontendFeatureLoader';
 }
 /** @public */
-declare function createFrontendModule<TId extends string, TExtensions extends readonly ExtensionDefinition[] = []>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule;
+declare function createFrontendFeatureLoader(options: CreateFrontendFeatureLoaderOptions): FrontendFeatureLoader;
 
 /**
  * @public
@@ -1525,4 +1546,4 @@ declare namespace createComponentExtension {
     }, "core.component.component", {}>;
 }
 
-export { type AnalyticsApi, AnalyticsContext, type AnalyticsContextValue, type AnalyticsEvent, type AnalyticsEventAttributes, type AnalyticsTracker, type AnyExtensionDataRef, type AnyExternalRoutes, type AnyRouteRefParams, type AnyRoutes, ApiBlueprint, type AppNode, type AppNodeEdges, type AppNodeInstance, type AppNodeSpec, AppRootElementBlueprint, AppRootWrapperBlueprint, type AppTree, type AppTreeApi, type CommonAnalyticsContext, type ComponentRef, type ComponentsApi, type ConfigurableExtensionDataRef, type CoreErrorBoundaryFallbackProps, type CoreNotFoundErrorPageProps, type CoreProgressProps, type CreateExtensionBlueprintOptions, type CreateExtensionOptions, type CreateFrontendModuleOptions, type DialogApi, type DialogApiDialog, type Extension, type ExtensionAttachToSpec, type ExtensionBlueprint, type ExtensionBlueprintParameters, ExtensionBoundary, type ExtensionBoundaryProps, type ExtensionDataContainer, type ExtensionDataRef, type ExtensionDataRefToValue, type ExtensionDataValue, type ExtensionDefinition, type ExtensionDefinitionParameters, type ExtensionFactoryMiddleware, type ExtensionInput, type ExternalRouteRef, type FeatureFlagConfig, type FrontendModule, type FrontendPlugin, IconBundleBlueprint, type IconComponent, type IconsApi, NavItemBlueprint, NavLogoBlueprint, PageBlueprint, type PluginOptions, type PortableSchema, type ResolveInputValueOverrides, type ResolvedExtensionInput, type ResolvedExtensionInputs, type RouteFunc, type RouteRef, type RouteResolutionApi, type RouteResolutionApiResolveOptions, RouterBlueprint, SignInPageBlueprint, type SubRouteRef, ThemeBlueprint, TranslationBlueprint, analyticsApiRef, appTreeApiRef, componentsApiRef, coreComponentRefs, coreExtensionData, createComponentExtension, createComponentRef, createExtension, createExtensionBlueprint, createExtensionDataRef, createExtensionInput, createExternalRouteRef, createFrontendModule, createFrontendPlugin, createRouteRef, createSubRouteRef, dialogApiRef, iconsApiRef, routeResolutionApiRef, useAnalytics, useComponentRef, useRouteRef, useRouteRefParams };
+export { type AnalyticsApi, AnalyticsContext, type AnalyticsContextValue, type AnalyticsEvent, type AnalyticsEventAttributes, type AnalyticsTracker, type AnyExtensionDataRef, type AnyExternalRoutes, type AnyRouteRefParams, type AnyRoutes, ApiBlueprint, type AppNode, type AppNodeEdges, type AppNodeInstance, type AppNodeSpec, AppRootElementBlueprint, AppRootWrapperBlueprint, type AppTree, type AppTreeApi, type CommonAnalyticsContext, type ComponentRef, type ComponentsApi, type ConfigurableExtensionDataRef, type CoreErrorBoundaryFallbackProps, type CoreNotFoundErrorPageProps, type CoreProgressProps, type CreateExtensionBlueprintOptions, type CreateExtensionOptions, type CreateFrontendFeatureLoaderOptions, type CreateFrontendModuleOptions, type DialogApi, type DialogApiDialog, type Extension, type ExtensionAttachToSpec, type ExtensionBlueprint, type ExtensionBlueprintParameters, ExtensionBoundary, type ExtensionBoundaryProps, type ExtensionDataContainer, type ExtensionDataRef, type ExtensionDataRefToValue, type ExtensionDataValue, type ExtensionDefinition, type ExtensionDefinitionParameters, type ExtensionFactoryMiddleware, type ExtensionInput, type ExternalRouteRef, type FeatureFlagConfig, type FrontendFeature, type FrontendFeatureLoader, type FrontendModule, type FrontendPlugin, IconBundleBlueprint, type IconComponent, type IconsApi, NavItemBlueprint, NavLogoBlueprint, PageBlueprint, type PluginOptions, type PortableSchema, type ResolveInputValueOverrides, type ResolvedExtensionInput, type ResolvedExtensionInputs, type RouteFunc, type RouteRef, type RouteResolutionApi, type RouteResolutionApiResolveOptions, RouterBlueprint, SignInPageBlueprint, type SubRouteRef, ThemeBlueprint, TranslationBlueprint, analyticsApiRef, appTreeApiRef, componentsApiRef, coreComponentRefs, coreExtensionData, createComponentExtension, createComponentRef, createExtension, createExtensionBlueprint, createExtensionDataRef, createExtensionInput, createExternalRouteRef, createFrontendFeatureLoader, createFrontendModule, createFrontendPlugin, createRouteRef, createSubRouteRef, dialogApiRef, iconsApiRef, routeResolutionApiRef, useAnalytics, useComponentRef, useRouteRef, useRouteRefParams };

package/dist/index.esm.js

@@ -34,5 +34,6 @@ export { createExtensionInput } from './wiring/createExtensionInput.esm.js';
 export { createExtensionDataRef } from './wiring/createExtensionDataRef.esm.js';
 export { createFrontendPlugin } from './wiring/createFrontendPlugin.esm.js';
 export { createFrontendModule } from './wiring/createFrontendModule.esm.js';
+export { createFrontendFeatureLoader } from './wiring/createFrontendFeatureLoader.esm.js';
 export { createExtensionBlueprint } from './wiring/createExtensionBlueprint.esm.js';
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/wiring/createFrontendFeatureLoader.esm.js

@@ -0,0 +1,36 @@
+import { describeParentCallSite } from '../routing/describeParentCallSite.esm.js';
+
+function createFrontendFeatureLoader(options) {
+  const description = `created at '${describeParentCallSite()}'`;
+  return {
+    $$type: "@backstage/FrontendFeatureLoader",
+    version: "v1",
+    description,
+    toString() {
+      return `FeatureLoader{description=${description}}`;
+    },
+    async loader(deps) {
+      const it = await options.loader(deps);
+      const result = new Array();
+      for await (const item of it) {
+        if (isFeatureOrLoader(item)) {
+          result.push(item);
+        } else if ("default" in item) {
+          result.push(item.default);
+        } else {
+          throw new Error(`Invalid item "${item}"`);
+        }
+      }
+      return result;
+    }
+  };
+}
+function isFeatureOrLoader(obj) {
+  if (obj !== null && typeof obj === "object" && "$$type" in obj) {
+    return obj.$$type === "@backstage/FrontendPlugin" || obj.$$type === "@backstage/FrontendModule" || obj.$$type === "@backstage/FrontendFeatureLoader";
+  }
+  return false;
+}
+
+export { createFrontendFeatureLoader };
+//# sourceMappingURL=createFrontendFeatureLoader.esm.js.map

package/dist/wiring/createFrontendFeatureLoader.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFrontendFeatureLoader.esm.js","sources":["../../src/wiring/createFrontendFeatureLoader.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { ConfigApi } from '../apis/definitions';\nimport { describeParentCallSite } from '../routing/describeParentCallSite';\nimport { FrontendFeature } from './types';\n\n/** @public */\nexport interface CreateFrontendFeatureLoaderOptions {\n  loader(deps: {\n    config: ConfigApi;\n  }):\n    | Iterable<\n        | FrontendFeature\n        | FrontendFeatureLoader\n        | Promise<{ default: FrontendFeature | FrontendFeatureLoader }>\n      >\n    | Promise<\n        Iterable<\n          | FrontendFeature\n          | FrontendFeatureLoader\n          | Promise<{ default: FrontendFeature | FrontendFeatureLoader }>\n        >\n      >\n    | AsyncIterable<\n        | FrontendFeature\n        | FrontendFeatureLoader\n        | { default: FrontendFeature | FrontendFeatureLoader }\n      >;\n}\n\n/** @public */\nexport interface FrontendFeatureLoader {\n  readonly $$type: '@backstage/FrontendFeatureLoader';\n}\n\n/** @internal */\nexport interface InternalFrontendFeatureLoader extends FrontendFeatureLoader {\n  readonly version: 'v1';\n  readonly description: string;\n  readonly loader: (deps: {\n    config: ConfigApi;\n  }) => Promise<(FrontendFeature | FrontendFeatureLoader)[]>;\n}\n\n/** @public */\nexport function createFrontendFeatureLoader(\n  options: CreateFrontendFeatureLoaderOptions,\n): FrontendFeatureLoader {\n  const description = `created at '${describeParentCallSite()}'`;\n  return {\n    $$type: '@backstage/FrontendFeatureLoader',\n    version: 'v1',\n    description,\n    toString() {\n      return `FeatureLoader{description=${description}}`;\n    },\n    async loader(deps: {\n      config: ConfigApi;\n    }): Promise<(FrontendFeature | FrontendFeatureLoader)[]> {\n      const it = await options.loader(deps);\n      const result = new Array<FrontendFeature | FrontendFeatureLoader>();\n      for await (const item of it) {\n        if (isFeatureOrLoader(item)) {\n          result.push(item);\n        } else if ('default' in item) {\n          result.push(item.default);\n        } else {\n          throw new Error(`Invalid item \"${item}\"`);\n        }\n      }\n      return result;\n    },\n  } as InternalFrontendFeatureLoader;\n}\n\n/** @internal */\nexport function isInternalFrontendFeatureLoader(opaque: {\n  $$type: string;\n}): opaque is InternalFrontendFeatureLoader {\n  if (opaque.$$type === '@backstage/FrontendFeatureLoader') {\n    // Make sure we throw if invalid\n    toInternalFrontendFeatureLoader(opaque as FrontendFeatureLoader);\n    return true;\n  }\n  return false;\n}\n\n/** @internal */\nexport function toInternalFrontendFeatureLoader(\n  plugin: FrontendFeatureLoader,\n): InternalFrontendFeatureLoader {\n  const internal = plugin as InternalFrontendFeatureLoader;\n  if (internal.$$type !== '@backstage/FrontendFeatureLoader') {\n    throw new Error(`Invalid plugin instance, bad type '${internal.$$type}'`);\n  }\n  if (internal.version !== 'v1') {\n    throw new Error(\n      `Invalid plugin instance, bad version '${internal.version}'`,\n    );\n  }\n  return internal;\n}\n\nfunction isFeatureOrLoader(\n  obj: unknown,\n): obj is FrontendFeature | FrontendFeatureLoader {\n  if (obj !== null && typeof obj === 'object' && '$$type' in obj) {\n    return (\n      obj.$$type === '@backstage/FrontendPlugin' ||\n      obj.$$type === '@backstage/FrontendModule' ||\n      obj.$$type === '@backstage/FrontendFeatureLoader'\n    );\n  }\n  return false;\n}\n"],"names":[],"mappings":";;AA2DO,SAAS,4BACd,OACuB,EAAA;AACvB,EAAM,MAAA,WAAA,GAAc,CAAe,YAAA,EAAA,sBAAA,EAAwB,CAAA,CAAA,CAAA;AAC3D,EAAO,OAAA;AAAA,IACL,MAAQ,EAAA,kCAAA;AAAA,IACR,OAAS,EAAA,IAAA;AAAA,IACT,WAAA;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,6BAA6B,WAAW,CAAA,CAAA,CAAA;AAAA,KACjD;AAAA,IACA,MAAM,OAAO,IAE4C,EAAA;AACvD,MAAA,MAAM,EAAK,GAAA,MAAM,OAAQ,CAAA,MAAA,CAAO,IAAI,CAAA;AACpC,MAAM,MAAA,MAAA,GAAS,IAAI,KAA+C,EAAA;AAClE,MAAA,WAAA,MAAiB,QAAQ,EAAI,EAAA;AAC3B,QAAI,IAAA,iBAAA,CAAkB,IAAI,CAAG,EAAA;AAC3B,UAAA,MAAA,CAAO,KAAK,IAAI,CAAA;AAAA,SAClB,MAAA,IAAW,aAAa,IAAM,EAAA;AAC5B,UAAO,MAAA,CAAA,IAAA,CAAK,KAAK,OAAO,CAAA;AAAA,SACnB,MAAA;AACL,UAAA,MAAM,IAAI,KAAA,CAAM,CAAiB,cAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA;AAC1C;AAEF,MAAO,OAAA,MAAA;AAAA;AACT,GACF;AACF;AA8BA,SAAS,kBACP,GACgD,EAAA;AAChD,EAAA,IAAI,QAAQ,IAAQ,IAAA,OAAO,GAAQ,KAAA,QAAA,IAAY,YAAY,GAAK,EAAA;AAC9D,IAAA,OACE,IAAI,MAAW,KAAA,2BAAA,IACf,IAAI,MAAW,KAAA,2BAAA,IACf,IAAI,MAAW,KAAA,kCAAA;AAAA;AAGnB,EAAO,OAAA,KAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-plugin-api",
-  "version": "0.10.0-next.2",
+  "version": "0.10.0",
   "backstage": {
     "role": "web-library"
   },
@@ -31,20 +31,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-components": "0.16.5-next.1",
-    "@backstage/core-plugin-api": "1.10.4",
-    "@backstage/types": "1.2.1",
-    "@backstage/version-bridge": "1.0.11",
+    "@backstage/core-components": "^0.17.0",
+    "@backstage/core-plugin-api": "^1.10.5",
+    "@backstage/types": "^1.2.1",
+    "@backstage/version-bridge": "^1.0.11",
     "@material-ui/core": "^4.12.4",
     "lodash": "^4.17.21",
     "zod": "^3.22.4",
     "zod-to-json-schema": "^3.21.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.31.0-next.1",
-    "@backstage/frontend-app-api": "0.11.0-next.2",
-    "@backstage/frontend-test-utils": "0.3.0-next.2",
-    "@backstage/test-utils": "1.7.6-next.0",
+    "@backstage/cli": "^0.31.0",
+    "@backstage/frontend-app-api": "^0.11.0",
+    "@backstage/frontend-test-utils": "^0.3.0",
+    "@backstage/test-utils": "^1.7.6",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",