@backstage/frontend-plugin-api 0.18.1 → 0.18.2-next.0

package/dist/types/{alpha.d-DZG-WVJf.d.ts → alpha.d-BVLu8HlA.d.ts}

@@ -1,9 +1,60 @@
 import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
-import { JSX, ComponentType, ReactNode } from 'react';
-import { Expand, JsonObject } from '@backstage/types';
+import { ComponentType, ReactNode, JSX } from 'react';
+import { JsonObject, Expand } from '@backstage/types';
 import { FilterPredicate } from '@backstage/filter-predicates';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 
+/**
+ * Defines the structure of a plugin wrapper, optionally including a shared
+ * hook value.
+ *
+ * @remarks
+ *
+ * When `useWrapperValue` is provided, the hook is called in a single location
+ * in the app and the resulting value is forwarded as the `value` prop to the
+ * component. The hook obeys the rules of React hooks and is not called until a
+ * component from the plugin is rendered.
+ *
+ * @public
+ */
+type PluginWrapperDefinition<TValue = unknown | never> = {
+    /**
+     * Creates a shared value that is forwarded as the `value` prop to the
+     * component.
+     *
+     * @remarks
+     *
+     * This function obeys the rules of React hooks and is only invoked in a
+     * single location in the app. Note that the hook will not be called until a
+     * component from the plugin is rendered.
+     */
+    useWrapperValue?: () => TValue;
+    component: ComponentType<{
+        children: ReactNode;
+        value: TValue;
+    }>;
+};
+/**
+ * Creates extensions that wrap plugin extensions with providers.
+ *
+ * @public
+ */
+declare const PluginWrapperBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
+    kind: "plugin-wrapper";
+    params: <TValue = never>(params: {
+        loader: () => Promise<PluginWrapperDefinition<TValue>>;
+    }) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<{
+        loader: () => Promise<PluginWrapperDefinition>;
+    }>;
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<() => Promise<PluginWrapperDefinition>, "core.plugin-wrapper.loader", {}>;
+    inputs: {};
+    config: {};
+    configInput: {};
+    dataRefs: {
+        wrapper: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<() => Promise<PluginWrapperDefinition>, "core.plugin-wrapper.loader", {}>;
+    };
+}>;
+
 /**
  * IconComponent is the common icon type used throughout Backstage when
  * working with and rendering generic icons, including the app system icons.
@@ -80,6 +131,138 @@ declare function createRouteRef<TParamKey extends string = never>(config?: {
     [param in TParamKey]: string;
 }>;
 
+/** @public */
+type PortableSchema<TOutput = unknown, TInput = TOutput> = {
+    parse: (input: TInput) => TOutput;
+    schema: () => {
+        schema: JsonObject;
+    };
+};
+
+/** @public */
+type ExtensionAttachTo = {
+    id: string;
+    input: string;
+};
+/** @public */
+interface Extension<TConfig, TConfigInput = TConfig> {
+    $$type: '@backstage/Extension';
+    readonly id: string;
+    readonly attachTo: ExtensionAttachTo;
+    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;
+    params: any;
+}> ? [string] extends [IKind | IName] ? never : (undefined extends IName ? TNamespace : `${TNamespace}/${IName}`) extends infer INamePart extends string ? IKind extends string ? `${IKind}:${INamePart}` : INamePart : never : never;
+
+/**
+ * The specification for this {@link AppNode} in the {@link AppTree}.
+ *
+ * @public
+ * @remarks
+ *
+ * The specifications for a collection of app nodes is all the information needed
+ * to build the tree and instantiate the nodes.
+ */
+interface AppNodeSpec {
+    readonly id: string;
+    readonly attachTo: ExtensionAttachTo;
+    readonly extension: Extension<unknown, unknown>;
+    readonly disabled: boolean;
+    readonly if?: FilterPredicate;
+    readonly config?: unknown;
+    readonly plugin: FrontendPlugin;
+}
+/**
+ * The connections from this {@link AppNode} to other nodes.
+ *
+ * @public
+ * @remarks
+ *
+ * The app node edges are resolved based on the app node specs, regardless of whether
+ * adjacent nodes are disabled or not. If no parent attachment is present or
+ */
+interface AppNodeEdges {
+    readonly attachedTo?: {
+        node: AppNode;
+        input: string;
+    };
+    readonly attachments: ReadonlyMap<string, AppNode[]>;
+}
+/**
+ * The instance of this {@link AppNode} in the {@link AppTree}.
+ *
+ * @public
+ * @remarks
+ *
+ * The app node instance is created when the `factory` function of an extension is called.
+ * Instances will only be present for nodes in the app that are connected to the root
+ * node and not disabled
+ */
+interface AppNodeInstance {
+    /** Returns a sequence of all extension data refs that were output by this instance */
+    getDataRefs(): Iterable<ExtensionDataRef<unknown>>;
+    /** Get the output data for a single extension data ref */
+    getData<T>(ref: ExtensionDataRef<T>): T | undefined;
+}
+/**
+ * A node in the {@link AppTree}.
+ *
+ * @public
+ */
+interface AppNode {
+    /** The specification for how this node should be instantiated */
+    readonly spec: AppNodeSpec;
+    /** The edges from this node to other nodes in the app tree */
+    readonly edges: AppNodeEdges;
+    /** The instance of this node, if it was instantiated */
+    readonly instance?: AppNodeInstance;
+}
+/**
+ * The app tree containing all {@link AppNode}s of the app.
+ *
+ * @public
+ */
+interface AppTree {
+    /** The root node of the app */
+    readonly root: AppNode;
+    /** A map of all nodes in the app by ID, including orphaned or disabled nodes */
+    readonly nodes: ReadonlyMap<string, AppNode>;
+    /** A sequence of all nodes with a parent that is not reachable from the app root node */
+    readonly orphans: Iterable<AppNode>;
+}
+/**
+ * The API for interacting with the {@link AppTree}.
+ *
+ * @public
+ */
+interface AppTreeApi {
+    /**
+     * Get the {@link AppTree} for the app.
+     */
+    getTree(): {
+        tree: AppTree;
+    };
+    /**
+     * Get all nodes in the app that are mounted at a given route path.
+     */
+    getNodesByRoutePath(routePath: string): {
+        nodes: AppNode[];
+    };
+}
+/**
+ * The `ApiRef` of {@link AppTreeApi}.
+ *
+ * @public
+ */
+declare const appTreeApiRef: _backstage_frontend_plugin_api.ApiRef<AppTreeApi, "core.app-tree"> & {
+    readonly $$type: "@backstage/ApiRef";
+};
+
 /** @public */
 type ExtensionDataValue<TData, TId extends string> = {
     readonly $$type: '@backstage/ExtensionDataValue';
@@ -104,127 +287,16 @@ interface ConfigurableExtensionDataRef<TData, TId extends string, TConfig extend
     optional?: true;
 } = {}> extends ExtensionDataRef<TData, TId, TConfig> {
     optional(): ConfigurableExtensionDataRef<TData, TId, TConfig & {
-        optional: true;
-    }>;
-    (t: TData): ExtensionDataValue<TData, TId>;
-}
-/** @public */
-declare function createExtensionDataRef<TData>(): {
-    with<TId extends string>(options: {
-        id: TId;
-    }): ConfigurableExtensionDataRef<TData, TId>;
-};
-
-/** @public */
-interface ExtensionInput<UExtensionData extends ExtensionDataRef<unknown, string, {
-    optional?: true;
-}> = ExtensionDataRef, TConfig extends {
-    singleton: boolean;
-    optional: boolean;
-    internal?: boolean;
-} = {
-    singleton: boolean;
-    optional: boolean;
-    internal?: boolean;
-}> {
-    readonly $$type: '@backstage/ExtensionInput';
-    readonly extensionData: Array<UExtensionData>;
-    readonly config: TConfig;
-    readonly replaces?: Array<{
-        id: string;
-        input: string;
-    }>;
-}
-/**
- * Creates a new extension input to be passed to the input map of an extension.
- *
- * @remarks
- *
- * Extension inputs created with this function can be passed to any `inputs` map
- * as part of creating or overriding an extension.
- *
- * The array of extension data references defines the data this input expects.
- * If the required data is not provided by the attached extension, the
- * attachment will fail.
- *
- * The `config` object can be used to restrict the behavior and shape of the
- * input. By default an input will accept zero or more extensions from any
- * plugin. The following options are available:
- *
- * - `singleton`: If set to `true`, only one extension can be attached to the
- *   input at a time. Additional extensions will trigger an app error and be
- *   ignored.
- * - `optional`: If set to `true`, the input is optional and can be omitted,
- *   this only has an effect if the `singleton` is set to `true`.
- * - `internal`: If set to `true`, only extensions from the same plugin will be
- *   allowed to attach to this input. Other extensions will trigger an app error
- *   and be ignored.
- *
- * @param extensionData - The array of extension data references that this input
- * expects.
- * @param config - The configuration object for the input.
- * @returns An extension input declaration.
- * @example
- * ```ts
- * const extension = createExtension({
- *   attachTo: { id: 'example-parent', input: 'example-input' },
- *   inputs: {
- *     content: createExtensionInput([coreExtensionData.reactElement], {
- *       singleton: true,
- *     }),
- *   },
- *   output: [coreExtensionData.reactElement],
- *   *factory({ inputs }) {
- *     const content = inputs.content?.get(coreExtensionData.reactElement);
- *     yield coreExtensionData.reactElement(<ContentWrapper>{content}</ContentWrapper>);
- *   },
- * });
- * ```
- * @public
- */
-declare function createExtensionInput<UExtensionData extends ExtensionDataRef<unknown, string, {
-    optional?: true;
-}>, TConfig extends {
-    singleton?: boolean;
-    optional?: boolean;
-    internal?: boolean;
-}>(extensionData: Array<UExtensionData>, config?: TConfig & {
-    replaces?: Array<{
-        id: string;
-        input: string;
-    }>;
-}): ExtensionInput<UExtensionData, {
-    singleton: TConfig['singleton'] extends true ? true : false;
-    optional: TConfig['optional'] extends true ? true : false;
-    internal: TConfig['internal'] extends true ? true : false;
-}>;
-
-/** @ignore */
-type ResolvedInputValueOverrides<TInputs extends {
-    [inputName in string]: ExtensionInput;
-} = {
-    [inputName in string]: ExtensionInput;
-}> = Expand<{
-    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<any, {
-        optional: infer IOptional extends boolean;
-        singleton: boolean;
-        internal?: boolean;
-    }> ? IOptional extends true ? never : KName : never]: TInputs[KName] extends ExtensionInput<infer IDataRefs, {
-        optional: boolean;
-        singleton: infer ISingleton extends boolean;
-        internal?: boolean;
-    }> ? ISingleton extends true ? Iterable<ExtensionDataRefToValue<IDataRefs>> : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>> : never;
-} & {
-    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<any, {
-        optional: infer IOptional extends boolean;
-        singleton: boolean;
-        internal?: boolean;
-    }> ? IOptional extends true ? KName : never : never]?: TInputs[KName] extends ExtensionInput<infer IDataRefs, {
-        optional: boolean;
-        singleton: infer ISingleton extends boolean;
-        internal?: boolean;
-    }> ? ISingleton extends true ? Iterable<ExtensionDataRefToValue<IDataRefs>> : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>> : never;
-}>;
+        optional: true;
+    }>;
+    (t: TData): ExtensionDataValue<TData, TId>;
+}
+/** @public */
+declare function createExtensionDataRef<TData>(): {
+    with<TId extends string>(options: {
+        id: TId;
+    }): ConfigurableExtensionDataRef<TData, TId>;
+};
 
 /** @public */
 interface CreateFrontendModuleOptions<TPluginId extends string, TExtensions extends readonly ExtensionDefinition[]> {
@@ -279,33 +351,36 @@ interface FrontendModule {
  */
 declare function createFrontendModule<TId extends string, TExtensions extends readonly ExtensionDefinition[]>(options: CreateFrontendModuleOptions<TId, TExtensions>): FrontendModule;
 
-/** @public */
-type PortableSchema<TOutput = unknown, TInput = TOutput> = {
-    parse: (input: TInput) => TOutput;
-    schema: () => {
-        schema: JsonObject;
-    };
+/**
+ * Feature flag configuration.
+ *
+ * @public
+ */
+type FeatureFlagConfig = {
+    /** Feature flag name */
+    name: string;
+    /** Feature flag description */
+    description?: string;
 };
-
 /** @public */
-type ExtensionAttachTo = {
-    id: string;
-    input: string;
+type ExtensionDataContainer<UExtensionData extends ExtensionDataRef> = Iterable<UExtensionData extends ExtensionDataRef<infer IData, infer IId, infer IConfig> ? IConfig['optional'] extends true ? never : ExtensionDataValue<IData, IId> : never> & {
+    get<TId extends UExtensionData['id']>(ref: ExtensionDataRef<any, TId, any>): UExtensionData extends ExtensionDataRef<infer IData, TId, infer IConfig> ? IConfig['optional'] extends true ? IData | undefined : IData : never;
 };
-/** @public */
-interface Extension<TConfig, TConfigInput = TConfig> {
-    $$type: '@backstage/Extension';
-    readonly id: string;
-    readonly attachTo: ExtensionAttachTo;
-    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;
-    params: any;
-}> ? [string] extends [IKind | IName] ? never : (undefined extends IName ? TNamespace : `${TNamespace}/${IName}`) extends infer INamePart extends string ? IKind extends string ? `${IKind}:${INamePart}` : INamePart : never : never;
+/**
+ * @public
+ * @deprecated Moved to {@link @backstage/frontend-app-api#ExtensionFactoryMiddleware}
+ */
+type ExtensionFactoryMiddleware = (originalFactory: (contextOverrides?: {
+    config?: JsonObject;
+}) => ExtensionDataContainer<ExtensionDataRef>, context: {
+    node: AppNode;
+    apis: ApiHolder;
+    config?: JsonObject;
+}) => Iterable<ExtensionDataValue<any, any>>;
+/** @public  */
+type FrontendFeature = (Omit<FrontendPlugin, 'pluginId'> & {
+    pluginId?: string;
+}) | FrontendModule;
 
 type CompareChars<A extends string, B extends string> = [A, B] extends [
     `${infer IAHead}${infer IARest}`,
@@ -663,35 +738,202 @@ declare function createFrontendPlugin<TId extends string, TExtensions extends re
 } = {}>(options: CreateFrontendPluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>): OverridableFrontendPlugin<TRoutes, TExternalRoutes, MakeSortedExtensionsMap<TExtensions[number], TId>>;
 
 /**
- * Feature flag configuration.
+ * API reference.
  *
  * @public
  */
-type FeatureFlagConfig = {
-    /** Feature flag name */
-    name: string;
-    /** Feature flag description */
-    description?: string;
+type ApiRef<T, TId extends string = string> = {
+    readonly $$type?: '@backstage/ApiRef';
+    readonly id: TId;
+    readonly T: T;
 };
-/** @public */
-type ExtensionDataContainer<UExtensionData extends ExtensionDataRef> = Iterable<UExtensionData extends ExtensionDataRef<infer IData, infer IId, infer IConfig> ? IConfig['optional'] extends true ? never : ExtensionDataValue<IData, IId> : never> & {
-    get<TId extends UExtensionData['id']>(ref: ExtensionDataRef<any, TId, any>): UExtensionData extends ExtensionDataRef<infer IData, TId, infer IConfig> ? IConfig['optional'] extends true ? IData | undefined : IData : never;
+/**
+ * Catch-all {@link ApiRef} type.
+ *
+ * @public
+ */
+type AnyApiRef = ApiRef<unknown>;
+/**
+ * Wraps a type with API properties into a type holding their respective {@link ApiRef}s.
+ *
+ * @public
+ */
+type TypesToApiRefs<T> = {
+    [key in keyof T]: ApiRef<T[key]>;
 };
 /**
+ * Provides lookup of APIs through their {@link ApiRef}s.
+ *
  * @public
- * @deprecated Moved to {@link @backstage/frontend-app-api#ExtensionFactoryMiddleware}
  */
-type ExtensionFactoryMiddleware = (originalFactory: (contextOverrides?: {
-    config?: JsonObject;
-}) => ExtensionDataContainer<ExtensionDataRef>, context: {
-    node: AppNode;
-    apis: ApiHolder;
-    config?: JsonObject;
-}) => Iterable<ExtensionDataValue<any, any>>;
-/** @public  */
-type FrontendFeature = (Omit<FrontendPlugin, 'pluginId'> & {
-    pluginId?: string;
-}) | FrontendModule;
+type ApiHolder = {
+    get<T>(api: ApiRef<T>): T | undefined;
+};
+/**
+ * Describes type returning API implementations.
+ *
+ * @public
+ */
+type ApiFactory<Api, Impl extends Api, Deps extends {
+    [name in string]: unknown;
+}> = {
+    api: ApiRef<Api>;
+    deps: TypesToApiRefs<Deps>;
+    factory(deps: Deps): Impl;
+};
+/**
+ * Catch-all {@link ApiFactory} type.
+ *
+ * @public
+ */
+type AnyApiFactory = ApiFactory<unknown, unknown, {
+    [key in string]: unknown;
+}>;
+
+/**
+ * The Plugin Wrapper API allows plugins to wrap their extensions with
+ * providers. This API is only intended for internal use by the Backstage
+ * frontend system. To provide contexts to plugin components, use
+ * `ExtensionBoundary` instead.
+ *
+ * @public
+ */
+type PluginWrapperApi = {
+    /**
+     * Returns the root wrapper that manages the global plugin state across
+     * plugin wrapper instances.
+     */
+    getRootWrapper(): ComponentType<{
+        children: ReactNode;
+    }>;
+    /**
+     * Returns a wrapper component for a specific plugin, or undefined if no
+     * wrappers exist. Do not use this API directly, instead use
+     * `ExtensionBoundary` to wrap your plugin components if needed.
+     */
+    getPluginWrapper(pluginId: string): ComponentType<{
+        children: ReactNode;
+    }> | undefined;
+};
+/**
+ * The API reference of {@link PluginWrapperApi}.
+ *
+ * @public
+ */
+declare const pluginWrapperApiRef: _backstage_frontend_plugin_api.ApiRef<PluginWrapperApi, "core.plugin-wrapper"> & {
+    readonly $$type: "@backstage/ApiRef";
+};
+
+/** @public */
+interface ExtensionInput<UExtensionData extends ExtensionDataRef<unknown, string, {
+    optional?: true;
+}> = ExtensionDataRef, TConfig extends {
+    singleton: boolean;
+    optional: boolean;
+    internal?: boolean;
+} = {
+    singleton: boolean;
+    optional: boolean;
+    internal?: boolean;
+}> {
+    readonly $$type: '@backstage/ExtensionInput';
+    readonly extensionData: Array<UExtensionData>;
+    readonly config: TConfig;
+    readonly replaces?: Array<{
+        id: string;
+        input: string;
+    }>;
+}
+/**
+ * Creates a new extension input to be passed to the input map of an extension.
+ *
+ * @remarks
+ *
+ * Extension inputs created with this function can be passed to any `inputs` map
+ * as part of creating or overriding an extension.
+ *
+ * The array of extension data references defines the data this input expects.
+ * If the required data is not provided by the attached extension, the
+ * attachment will fail.
+ *
+ * The `config` object can be used to restrict the behavior and shape of the
+ * input. By default an input will accept zero or more extensions from any
+ * plugin. The following options are available:
+ *
+ * - `singleton`: If set to `true`, only one extension can be attached to the
+ *   input at a time. Additional extensions will trigger an app error and be
+ *   ignored.
+ * - `optional`: If set to `true`, the input is optional and can be omitted,
+ *   this only has an effect if the `singleton` is set to `true`.
+ * - `internal`: If set to `true`, only extensions from the same plugin will be
+ *   allowed to attach to this input. Other extensions will trigger an app error
+ *   and be ignored.
+ *
+ * @param extensionData - The array of extension data references that this input
+ * expects.
+ * @param config - The configuration object for the input.
+ * @returns An extension input declaration.
+ * @example
+ * ```ts
+ * const extension = createExtension({
+ *   attachTo: { id: 'example-parent', input: 'example-input' },
+ *   inputs: {
+ *     content: createExtensionInput([coreExtensionData.reactElement], {
+ *       singleton: true,
+ *     }),
+ *   },
+ *   output: [coreExtensionData.reactElement],
+ *   *factory({ inputs }) {
+ *     const content = inputs.content?.get(coreExtensionData.reactElement);
+ *     yield coreExtensionData.reactElement(<ContentWrapper>{content}</ContentWrapper>);
+ *   },
+ * });
+ * ```
+ * @public
+ */
+declare function createExtensionInput<UExtensionData extends ExtensionDataRef<unknown, string, {
+    optional?: true;
+}>, TConfig extends {
+    singleton?: boolean;
+    optional?: boolean;
+    internal?: boolean;
+}>(extensionData: Array<UExtensionData>, config?: TConfig & {
+    replaces?: Array<{
+        id: string;
+        input: string;
+    }>;
+}): ExtensionInput<UExtensionData, {
+    singleton: TConfig['singleton'] extends true ? true : false;
+    optional: TConfig['optional'] extends true ? true : false;
+    internal: TConfig['internal'] extends true ? true : false;
+}>;
+
+/** @ignore */
+type ResolvedInputValueOverrides<TInputs extends {
+    [inputName in string]: ExtensionInput;
+} = {
+    [inputName in string]: ExtensionInput;
+}> = Expand<{
+    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<any, {
+        optional: infer IOptional extends boolean;
+        singleton: boolean;
+        internal?: boolean;
+    }> ? IOptional extends true ? never : KName : never]: TInputs[KName] extends ExtensionInput<infer IDataRefs, {
+        optional: boolean;
+        singleton: infer ISingleton extends boolean;
+        internal?: boolean;
+    }> ? ISingleton extends true ? Iterable<ExtensionDataRefToValue<IDataRefs>> : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>> : never;
+} & {
+    [KName in keyof TInputs as TInputs[KName] extends ExtensionInput<any, {
+        optional: infer IOptional extends boolean;
+        singleton: boolean;
+        internal?: boolean;
+    }> ? IOptional extends true ? KName : never : never]?: TInputs[KName] extends ExtensionInput<infer IDataRefs, {
+        optional: boolean;
+        singleton: infer ISingleton extends boolean;
+        internal?: boolean;
+    }> ? ISingleton extends true ? Iterable<ExtensionDataRefToValue<IDataRefs>> : Array<Iterable<ExtensionDataRefToValue<IDataRefs>>> : never;
+}>;
 
 /**
  * A function used to define a parameter mapping function in order to facilitate
@@ -1198,247 +1440,5 @@ declare function createExtension<UOutput extends ExtensionDataRef, TInputs exten
     name: string | undefined extends TName ? undefined : TName;
 }>;
 
-/**
- * The specification for this {@link AppNode} in the {@link AppTree}.
- *
- * @public
- * @remarks
- *
- * The specifications for a collection of app nodes is all the information needed
- * to build the tree and instantiate the nodes.
- */
-interface AppNodeSpec {
-    readonly id: string;
-    readonly attachTo: ExtensionAttachTo;
-    readonly extension: Extension<unknown, unknown>;
-    readonly disabled: boolean;
-    readonly if?: FilterPredicate;
-    readonly config?: unknown;
-    readonly plugin: FrontendPlugin;
-}
-/**
- * The connections from this {@link AppNode} to other nodes.
- *
- * @public
- * @remarks
- *
- * The app node edges are resolved based on the app node specs, regardless of whether
- * adjacent nodes are disabled or not. If no parent attachment is present or
- */
-interface AppNodeEdges {
-    readonly attachedTo?: {
-        node: AppNode;
-        input: string;
-    };
-    readonly attachments: ReadonlyMap<string, AppNode[]>;
-}
-/**
- * The instance of this {@link AppNode} in the {@link AppTree}.
- *
- * @public
- * @remarks
- *
- * The app node instance is created when the `factory` function of an extension is called.
- * Instances will only be present for nodes in the app that are connected to the root
- * node and not disabled
- */
-interface AppNodeInstance {
-    /** Returns a sequence of all extension data refs that were output by this instance */
-    getDataRefs(): Iterable<ExtensionDataRef<unknown>>;
-    /** Get the output data for a single extension data ref */
-    getData<T>(ref: ExtensionDataRef<T>): T | undefined;
-}
-/**
- * A node in the {@link AppTree}.
- *
- * @public
- */
-interface AppNode {
-    /** The specification for how this node should be instantiated */
-    readonly spec: AppNodeSpec;
-    /** The edges from this node to other nodes in the app tree */
-    readonly edges: AppNodeEdges;
-    /** The instance of this node, if it was instantiated */
-    readonly instance?: AppNodeInstance;
-}
-/**
- * The app tree containing all {@link AppNode}s of the app.
- *
- * @public
- */
-interface AppTree {
-    /** The root node of the app */
-    readonly root: AppNode;
-    /** A map of all nodes in the app by ID, including orphaned or disabled nodes */
-    readonly nodes: ReadonlyMap<string, AppNode>;
-    /** A sequence of all nodes with a parent that is not reachable from the app root node */
-    readonly orphans: Iterable<AppNode>;
-}
-/**
- * The API for interacting with the {@link AppTree}.
- *
- * @public
- */
-interface AppTreeApi {
-    /**
-     * Get the {@link AppTree} for the app.
-     */
-    getTree(): {
-        tree: AppTree;
-    };
-    /**
-     * Get all nodes in the app that are mounted at a given route path.
-     */
-    getNodesByRoutePath(routePath: string): {
-        nodes: AppNode[];
-    };
-}
-/**
- * The `ApiRef` of {@link AppTreeApi}.
- *
- * @public
- */
-declare const appTreeApiRef: _backstage_frontend_plugin_api.ApiRef<AppTreeApi, "core.app-tree"> & {
-    readonly $$type: "@backstage/ApiRef";
-};
-
-/**
- * API reference.
- *
- * @public
- */
-type ApiRef<T, TId extends string = string> = {
-    readonly $$type?: '@backstage/ApiRef';
-    readonly id: TId;
-    readonly T: T;
-};
-/**
- * Catch-all {@link ApiRef} type.
- *
- * @public
- */
-type AnyApiRef = ApiRef<unknown>;
-/**
- * Wraps a type with API properties into a type holding their respective {@link ApiRef}s.
- *
- * @public
- */
-type TypesToApiRefs<T> = {
-    [key in keyof T]: ApiRef<T[key]>;
-};
-/**
- * Provides lookup of APIs through their {@link ApiRef}s.
- *
- * @public
- */
-type ApiHolder = {
-    get<T>(api: ApiRef<T>): T | undefined;
-};
-/**
- * Describes type returning API implementations.
- *
- * @public
- */
-type ApiFactory<Api, Impl extends Api, Deps extends {
-    [name in string]: unknown;
-}> = {
-    api: ApiRef<Api>;
-    deps: TypesToApiRefs<Deps>;
-    factory(deps: Deps): Impl;
-};
-/**
- * Catch-all {@link ApiFactory} type.
- *
- * @public
- */
-type AnyApiFactory = ApiFactory<unknown, unknown, {
-    [key in string]: unknown;
-}>;
-
-/**
- * The Plugin Wrapper API allows plugins to wrap their extensions with
- * providers. This API is only intended for internal use by the Backstage
- * frontend system. To provide contexts to plugin components, use
- * `ExtensionBoundary` instead.
- *
- * @public
- */
-type PluginWrapperApi = {
-    /**
-     * Returns the root wrapper that manages the global plugin state across
-     * plugin wrapper instances.
-     */
-    getRootWrapper(): ComponentType<{
-        children: ReactNode;
-    }>;
-    /**
-     * Returns a wrapper component for a specific plugin, or undefined if no
-     * wrappers exist. Do not use this API directly, instead use
-     * `ExtensionBoundary` to wrap your plugin components if needed.
-     */
-    getPluginWrapper(pluginId: string): ComponentType<{
-        children: ReactNode;
-    }> | undefined;
-};
-/**
- * The API reference of {@link PluginWrapperApi}.
- *
- * @public
- */
-declare const pluginWrapperApiRef: _backstage_frontend_plugin_api.ApiRef<PluginWrapperApi, "core.plugin-wrapper"> & {
-    readonly $$type: "@backstage/ApiRef";
-};
-
-/**
- * Defines the structure of a plugin wrapper, optionally including a shared
- * hook value.
- *
- * @remarks
- *
- * When `useWrapperValue` is provided, the hook is called in a single location
- * in the app and the resulting value is forwarded as the `value` prop to the
- * component. The hook obeys the rules of React hooks and is not called until a
- * component from the plugin is rendered.
- *
- * @public
- */
-type PluginWrapperDefinition<TValue = unknown | never> = {
-    /**
-     * Creates a shared value that is forwarded as the `value` prop to the
-     * component.
-     *
-     * @remarks
-     *
-     * This function obeys the rules of React hooks and is only invoked in a
-     * single location in the app. Note that the hook will not be called until a
-     * component from the plugin is rendered.
-     */
-    useWrapperValue?: () => TValue;
-    component: ComponentType<{
-        children: ReactNode;
-        value: TValue;
-    }>;
-};
-/**
- * Creates extensions that wrap plugin extensions with providers.
- *
- * @public
- */
-declare const PluginWrapperBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
-    kind: "plugin-wrapper";
-    params: <TValue = never>(params: {
-        loader: () => Promise<PluginWrapperDefinition<TValue>>;
-    }) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<{
-        loader: () => Promise<PluginWrapperDefinition>;
-    }>;
-    output: _backstage_frontend_plugin_api.ExtensionDataRef<() => Promise<PluginWrapperDefinition>, "core.plugin-wrapper.loader", {}>;
-    inputs: {};
-    config: {};
-    configInput: {};
-    dataRefs: {
-        wrapper: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<() => Promise<PluginWrapperDefinition>, "core.plugin-wrapper.loader", {}>;
-    };
-}>;
-
-export { createExtensionBlueprintParams as $, PluginWrapperBlueprint as S, appTreeApiRef as Y, createExtension as Z, createExtensionBlueprint as _, createExtensionDataRef as a0, createExtensionInput as a1, createExternalRouteRef as a2, createFrontendModule as a3, createFrontendPlugin as a4, createRouteRef as a5, createSubRouteRef as a6, pluginWrapperApiRef as a7 };
-export type { AnyApiFactory as A, ExtensionFactoryMiddleware as B, ConfigurableExtensionDataRef as C, ExtensionInput as D, Extension as E, ExternalRouteRef as F, FeatureFlagConfig as G, FrontendFeature as H, FrontendModule as I, FrontendPlugin as J, FrontendPluginInfo as K, FrontendPluginInfoOptions as L, IconComponent as M, IconElement as N, OverridableExtensionDefinition as O, OverridableFrontendPlugin as P, PluginOptions as Q, PluginWrapperApi as R, PluginWrapperDefinition as T, PortableSchema as U, RouteRef as V, SubRouteRef as W, TypesToApiRefs as X, AnyApiRef as a, AnyRouteRefParams as b, ApiFactory as c, ApiHolder as d, ApiRef as e, AppNode as f, AppNodeEdges as g, AppNodeInstance as h, AppNodeSpec as i, AppTree as j, AppTreeApi as k, CreateExtensionBlueprintOptions as l, CreateExtensionOptions as m, CreateFrontendModuleOptions as n, CreateFrontendPluginOptions as o, ExtensionAttachTo as p, ExtensionBlueprint as q, ExtensionBlueprintDefineParams as r, ExtensionBlueprintParameters as s, ExtensionBlueprintParams as t, ExtensionDataContainer as u, ExtensionDataRef as v, ExtensionDataValue as w, ExtensionDefinition as x, ExtensionDefinitionAttachTo as y, ExtensionDefinitionParameters as z };
+export { createExtensionBlueprintParams as $, PluginWrapperBlueprint as V, appTreeApiRef as Y, createExtension as Z, createExtensionBlueprint as _, createExtensionDataRef as a0, createExtensionInput as a1, createExternalRouteRef as a2, createFrontendModule as a3, createFrontendPlugin as a4, createRouteRef as a5, createSubRouteRef as a6, pluginWrapperApiRef as a7 };
+export type { AppNode as A, ExtensionDefinition as B, ConfigurableExtensionDataRef as C, ExtensionDefinitionAttachTo as D, ExternalRouteRef as E, FrontendPlugin as F, ExtensionDefinitionParameters as G, ExtensionFactoryMiddleware as H, IconElement as I, ExtensionInput as J, FeatureFlagConfig as K, FrontendModule as L, FrontendPluginInfo as M, FrontendPluginInfoOptions as N, OverridableExtensionDefinition as O, OverridableFrontendPlugin as P, PluginOptions as Q, RouteRef as R, SubRouteRef as S, TypesToApiRefs as T, PluginWrapperApi as U, PluginWrapperDefinition as W, PortableSchema as X, IconComponent as a, AnyRouteRefParams as b, ApiRef as c, ApiHolder as d, ApiFactory as e, FrontendFeature as f, AnyApiFactory as g, AnyApiRef as h, AppNodeEdges as i, AppNodeInstance as j, AppNodeSpec as k, AppTree as l, AppTreeApi as m, CreateExtensionBlueprintOptions as n, CreateExtensionOptions as o, CreateFrontendModuleOptions as p, CreateFrontendPluginOptions as q, Extension as r, ExtensionAttachTo as s, ExtensionBlueprint as t, ExtensionBlueprintDefineParams as u, ExtensionBlueprintParameters as v, ExtensionBlueprintParams as w, ExtensionDataContainer as x, ExtensionDataRef as y, ExtensionDataValue as z };