@backstage/frontend-plugin-api 0.13.2-next.0 → 0.13.2

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/dist/index.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
2
  import * as react from 'react';
3
- import { ReactNode, ComponentType, PropsWithChildren, JSX as JSX$1 } from 'react';
3
+ import { ReactNode, JSX as JSX$1, ComponentType, PropsWithChildren } from 'react';
4
+ import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
5
+ import { IconComponent as IconComponent$1, RouteRef as RouteRef$1 } from '@backstage/frontend-plugin-api';
4
6
  import { Expand, JsonObject, Observable, JsonValue, ExpandRecursive } from '@backstage/types';
5
7
  import { z } from 'zod';
6
8
  import { Config } from '@backstage/config';
7
- import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
8
- import { IconComponent as IconComponent$1, RouteRef as RouteRef$1 } from '@backstage/frontend-plugin-api';
9
9
 
10
10
  /**
11
11
  * Analytics context envelope.
@@ -41,120 +41,50 @@ declare const AnalyticsContext: (options: {
41
41
  }) => react_jsx_runtime.JSX.Element;
42
42
 
43
43
  /**
44
- * API reference.
45
- *
46
- * @public
47
- */
48
- type ApiRef<T> = {
49
- id: string;
50
- T: T;
51
- };
52
- /**
53
- * Catch-all {@link ApiRef} type.
44
+ * Catch-all type for route params.
54
45
  *
55
46
  * @public
56
47
  */
57
- type AnyApiRef = ApiRef<unknown>;
48
+ type AnyRouteRefParams = {
49
+ [param in string]: string;
50
+ } | undefined;
51
+
58
52
  /**
59
- * Wraps a type with API properties into a type holding their respective {@link ApiRef}s.
53
+ * Absolute route reference.
60
54
  *
61
- * @public
62
- */
63
- type TypesToApiRefs<T> = {
64
- [key in keyof T]: ApiRef<T[key]>;
65
- };
66
- /**
67
- * Provides lookup of APIs through their {@link ApiRef}s.
55
+ * @remarks
68
56
  *
69
- * @public
70
- */
71
- type ApiHolder = {
72
- get<T>(api: ApiRef<T>): T | undefined;
73
- };
74
- /**
75
- * Describes type returning API implementations.
57
+ * See {@link https://backstage.io/docs/plugins/composability#routing-system}.
76
58
  *
77
59
  * @public
78
60
  */
79
- type ApiFactory<Api, Impl extends Api, Deps extends {
80
- [name in string]: unknown;
81
- }> = {
82
- api: ApiRef<Api>;
83
- deps: TypesToApiRefs<Deps>;
84
- factory(deps: Deps): Impl;
85
- };
61
+ interface RouteRef<TParams extends AnyRouteRefParams = AnyRouteRefParams> {
62
+ readonly $$type: '@backstage/RouteRef';
63
+ readonly T: TParams;
64
+ }
86
65
  /**
87
- * Catch-all {@link ApiFactory} type.
66
+ * Create a {@link RouteRef} from a route descriptor.
88
67
  *
68
+ * @param config - Description of the route reference to be created.
89
69
  * @public
90
70
  */
91
- type AnyApiFactory = ApiFactory<unknown, unknown, {
92
- [key in string]: unknown;
71
+ declare function createRouteRef<TParams extends {
72
+ [param in TParamKeys]: string;
73
+ } | undefined = undefined, TParamKeys extends string = string>(config?: {
74
+ /** A list of parameter names that the path that this route ref is bound to must contain */
75
+ readonly params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[];
76
+ aliasFor?: string;
77
+ }): RouteRef<keyof TParams extends never ? undefined : string extends TParamKeys ? TParams : {
78
+ [param in TParamKeys]: string;
93
79
  }>;
94
80
 
95
- /**
96
- * React hook for retrieving {@link ApiHolder}, an API catalog.
97
- *
98
- * @public
99
- */
100
- declare function useApiHolder(): ApiHolder;
101
- /**
102
- * React hook for retrieving APIs.
103
- *
104
- * @param apiRef - Reference of the API to use.
105
- * @public
106
- */
107
- declare function useApi<T>(apiRef: ApiRef<T>): T;
108
- /**
109
- * Wrapper for giving component an API context.
110
- *
111
- * @param apis - APIs for the context.
112
- * @public
113
- */
114
- declare function withApis<T extends {}>(apis: TypesToApiRefs<T>): <TProps extends T>(WrappedComponent: ComponentType<TProps>) => {
115
- (props: PropsWithChildren<Omit<TProps, keyof T>>): react_jsx_runtime.JSX.Element;
116
- displayName: string;
117
- };
118
-
119
- /**
120
- * API reference configuration - holds an ID of the referenced API.
121
- *
122
- * @public
123
- */
124
- type ApiRefConfig = {
125
- id: string;
81
+ /** @public */
82
+ declare const coreExtensionData: {
83
+ title: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.title", {}>;
84
+ reactElement: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<JSX$1.Element, "core.reactElement", {}>;
85
+ routePath: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}>;
86
+ routeRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {}>;
126
87
  };
127
- /**
128
- * Creates a reference to an API.
129
- *
130
- * @param config - The descriptor of the API to reference.
131
- * @returns An API reference.
132
- * @public
133
- */
134
- declare function createApiRef<T>(config: ApiRefConfig): ApiRef<T>;
135
-
136
- /**
137
- * Used to infer types for a standalone {@link ApiFactory} that isn't immediately passed
138
- * to another function.
139
- *
140
- * @remarks
141
- *
142
- * This function doesn't actually do anything, it's only used to infer types.
143
- *
144
- * @public
145
- */
146
- declare function createApiFactory<Api, Impl extends Api, Deps extends {
147
- [name in string]: unknown;
148
- }>(factory: ApiFactory<Api, Impl, Deps>): ApiFactory<Api, Impl, Deps>;
149
- /**
150
- * Used to infer types for a standalone {@link ApiFactory} that isn't immediately passed
151
- * to another function.
152
- *
153
- * @param api - Ref of the API that will be produced by the factory.
154
- * @param instance - Implementation of the API to use.
155
- * @public
156
- */
157
- declare function createApiFactory<Api, Impl extends Api>(api: ApiRef<Api>, instance: Impl): ApiFactory<Api, Impl, {}>;
158
88
 
159
89
  /** @public */
160
90
  type ExtensionDataValue<TData, TId extends string> = {
@@ -196,52 +126,6 @@ declare function createExtensionDataRef<TData>(): {
196
126
  }): ConfigurableExtensionDataRef<TData, TId>;
197
127
  };
198
128
 
199
- /**
200
- * Catch-all type for route params.
201
- *
202
- * @public
203
- */
204
- type AnyRouteRefParams = {
205
- [param in string]: string;
206
- } | undefined;
207
-
208
- /**
209
- * Absolute route reference.
210
- *
211
- * @remarks
212
- *
213
- * See {@link https://backstage.io/docs/plugins/composability#routing-system}.
214
- *
215
- * @public
216
- */
217
- interface RouteRef<TParams extends AnyRouteRefParams = AnyRouteRefParams> {
218
- readonly $$type: '@backstage/RouteRef';
219
- readonly T: TParams;
220
- }
221
- /**
222
- * Create a {@link RouteRef} from a route descriptor.
223
- *
224
- * @param config - Description of the route reference to be created.
225
- * @public
226
- */
227
- declare function createRouteRef<TParams extends {
228
- [param in TParamKeys]: string;
229
- } | undefined = undefined, TParamKeys extends string = string>(config?: {
230
- /** A list of parameter names that the path that this route ref is bound to must contain */
231
- readonly params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[];
232
- aliasFor?: string;
233
- }): RouteRef<keyof TParams extends never ? undefined : string extends TParamKeys ? TParams : {
234
- [param in TParamKeys]: string;
235
- }>;
236
-
237
- /** @public */
238
- declare const coreExtensionData: {
239
- title: ConfigurableExtensionDataRef<string, "core.title", {}>;
240
- reactElement: ConfigurableExtensionDataRef<JSX$1.Element, "core.reactElement", {}>;
241
- routePath: ConfigurableExtensionDataRef<string, "core.routing.path", {}>;
242
- routeRef: ConfigurableExtensionDataRef<RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {}>;
243
- };
244
-
245
129
  /** @public */
246
130
  interface ExtensionInput<UExtensionData extends ExtensionDataRef<unknown, string, {
247
131
  optional?: true;
@@ -886,9 +770,9 @@ interface ExtensionBlueprint<T extends ExtensionBlueprintParameters = ExtensionB
886
770
  */
887
771
  makeWithOverrides<TName extends string | undefined, TExtensionConfigSchema extends {
888
772
  [key in string]: (zImpl: typeof z) => z.ZodType;
889
- }, UFactoryOutput extends ExtensionDataValue<any, any>, UNewOutput extends ExtensionDataRef, TExtraInputs extends {
773
+ }, UFactoryOutput extends ExtensionDataValue<any, any>, UNewOutput extends ExtensionDataRef, UParentInputs extends ExtensionDataRef, TExtraInputs extends {
890
774
  [inputName in string]: ExtensionInput;
891
- }, UParentInputs extends ExtensionDataRef>(args: {
775
+ } = {}>(args: {
892
776
  name?: TName;
893
777
  attachTo?: ExtensionDefinitionAttachTo<UParentInputs> & VerifyExtensionAttachTo<ExtensionDataRef extends UNewOutput ? NonNullable<T['output']> : UNewOutput, UParentInputs>;
894
778
  disabled?: boolean;
@@ -913,14 +797,14 @@ interface ExtensionBlueprint<T extends ExtensionBlueprintParameters = ExtensionB
913
797
  inputs: Expand<ResolvedExtensionInputs<T['inputs'] & TExtraInputs>>;
914
798
  }): Iterable<UFactoryOutput> & VerifyExtensionFactoryOutput<ExtensionDataRef extends UNewOutput ? NonNullable<T['output']> : UNewOutput, UFactoryOutput>;
915
799
  }): OverridableExtensionDefinition<{
916
- config: (string extends keyof TExtensionConfigSchema ? {} : {
800
+ config: Expand<(string extends keyof TExtensionConfigSchema ? {} : {
917
801
  [key in keyof TExtensionConfigSchema]: z.infer<ReturnType<TExtensionConfigSchema[key]>>;
918
- }) & T['config'];
919
- configInput: (string extends keyof TExtensionConfigSchema ? {} : z.input<z.ZodObject<{
802
+ }) & T['config']>;
803
+ configInput: Expand<(string extends keyof TExtensionConfigSchema ? {} : z.input<z.ZodObject<{
920
804
  [key in keyof TExtensionConfigSchema]: ReturnType<TExtensionConfigSchema[key]>;
921
- }>>) & T['configInput'];
805
+ }>>) & T['configInput']>;
922
806
  output: ExtensionDataRef extends UNewOutput ? T['output'] : UNewOutput;
923
- inputs: T['inputs'] & TExtraInputs;
807
+ inputs: Expand<T['inputs'] & TExtraInputs>;
924
808
  kind: T['kind'];
925
809
  name: string | undefined extends TName ? undefined : TName;
926
810
  params: T['params'];
@@ -1352,7 +1236,123 @@ interface AppTreeApi {
1352
1236
  *
1353
1237
  * @public
1354
1238
  */
1355
- declare const appTreeApiRef: ApiRef<AppTreeApi>;
1239
+ declare const appTreeApiRef: _backstage_frontend_plugin_api.ApiRef<AppTreeApi>;
1240
+
1241
+ /**
1242
+ * API reference.
1243
+ *
1244
+ * @public
1245
+ */
1246
+ type ApiRef<T> = {
1247
+ id: string;
1248
+ T: T;
1249
+ };
1250
+ /**
1251
+ * Catch-all {@link ApiRef} type.
1252
+ *
1253
+ * @public
1254
+ */
1255
+ type AnyApiRef = ApiRef<unknown>;
1256
+ /**
1257
+ * Wraps a type with API properties into a type holding their respective {@link ApiRef}s.
1258
+ *
1259
+ * @public
1260
+ */
1261
+ type TypesToApiRefs<T> = {
1262
+ [key in keyof T]: ApiRef<T[key]>;
1263
+ };
1264
+ /**
1265
+ * Provides lookup of APIs through their {@link ApiRef}s.
1266
+ *
1267
+ * @public
1268
+ */
1269
+ type ApiHolder = {
1270
+ get<T>(api: ApiRef<T>): T | undefined;
1271
+ };
1272
+ /**
1273
+ * Describes type returning API implementations.
1274
+ *
1275
+ * @public
1276
+ */
1277
+ type ApiFactory<Api, Impl extends Api, Deps extends {
1278
+ [name in string]: unknown;
1279
+ }> = {
1280
+ api: ApiRef<Api>;
1281
+ deps: TypesToApiRefs<Deps>;
1282
+ factory(deps: Deps): Impl;
1283
+ };
1284
+ /**
1285
+ * Catch-all {@link ApiFactory} type.
1286
+ *
1287
+ * @public
1288
+ */
1289
+ type AnyApiFactory = ApiFactory<unknown, unknown, {
1290
+ [key in string]: unknown;
1291
+ }>;
1292
+
1293
+ /**
1294
+ * React hook for retrieving {@link ApiHolder}, an API catalog.
1295
+ *
1296
+ * @public
1297
+ */
1298
+ declare function useApiHolder(): ApiHolder;
1299
+ /**
1300
+ * React hook for retrieving APIs.
1301
+ *
1302
+ * @param apiRef - Reference of the API to use.
1303
+ * @public
1304
+ */
1305
+ declare function useApi<T>(apiRef: ApiRef<T>): T;
1306
+ /**
1307
+ * Wrapper for giving component an API context.
1308
+ *
1309
+ * @param apis - APIs for the context.
1310
+ * @public
1311
+ */
1312
+ declare function withApis<T extends {}>(apis: TypesToApiRefs<T>): <TProps extends T>(WrappedComponent: ComponentType<TProps>) => {
1313
+ (props: PropsWithChildren<Omit<TProps, keyof T>>): react_jsx_runtime.JSX.Element;
1314
+ displayName: string;
1315
+ };
1316
+
1317
+ /**
1318
+ * API reference configuration - holds an ID of the referenced API.
1319
+ *
1320
+ * @public
1321
+ */
1322
+ type ApiRefConfig = {
1323
+ id: string;
1324
+ };
1325
+ /**
1326
+ * Creates a reference to an API.
1327
+ *
1328
+ * @param config - The descriptor of the API to reference.
1329
+ * @returns An API reference.
1330
+ * @public
1331
+ */
1332
+ declare function createApiRef<T>(config: ApiRefConfig): ApiRef<T>;
1333
+
1334
+ /**
1335
+ * Used to infer types for a standalone {@link ApiFactory} that isn't immediately passed
1336
+ * to another function.
1337
+ *
1338
+ * @remarks
1339
+ *
1340
+ * This function doesn't actually do anything, it's only used to infer types.
1341
+ *
1342
+ * @public
1343
+ */
1344
+ declare function createApiFactory<Api, Impl extends Api, Deps extends {
1345
+ [name in string]: unknown;
1346
+ }>(factory: ApiFactory<Api, Impl, Deps>): ApiFactory<Api, Impl, Deps>;
1347
+ /**
1348
+ * Used to infer types for a standalone {@link ApiFactory} that isn't immediately passed
1349
+ * to another function.
1350
+ *
1351
+ * @param api - Ref of the API that will be produced by the factory.
1352
+ * @param instance - Implementation of the API to use.
1353
+ * @public
1354
+ */
1355
+ declare function createApiFactory<Api, Impl extends Api>(api: ApiRef<Api>, instance: Impl): ApiFactory<Api, Impl, {}>;
1356
1356
 
1357
1357
  /**
1358
1358
  * IconComponent is the common icon type used throughout Backstage when
@@ -1862,6 +1862,7 @@ declare const appThemeApiRef: ApiRef<AppThemeApi>;
1862
1862
 
1863
1863
  /** @public */
1864
1864
  interface ExtensionBoundaryProps {
1865
+ errorPresentation?: 'error-api' | 'error-display';
1865
1866
  node: AppNode;
1866
1867
  children: ReactNode;
1867
1868
  }
@@ -1933,21 +1934,21 @@ type ErrorDisplayProps = {
1933
1934
  */
1934
1935
  declare const Progress: {
1935
1936
  (props: ProgressProps): JSX.Element | null;
1936
- ref: SwappableComponentRef<ProgressProps, ProgressProps>;
1937
+ ref: _backstage_frontend_plugin_api.SwappableComponentRef<ProgressProps, ProgressProps>;
1937
1938
  };
1938
1939
  /**
1939
1940
  * @public
1940
1941
  */
1941
1942
  declare const NotFoundErrorPage: {
1942
1943
  (props: NotFoundErrorPageProps): JSX.Element | null;
1943
- ref: SwappableComponentRef<NotFoundErrorPageProps, NotFoundErrorPageProps>;
1944
+ ref: _backstage_frontend_plugin_api.SwappableComponentRef<NotFoundErrorPageProps, NotFoundErrorPageProps>;
1944
1945
  };
1945
1946
  /**
1946
1947
  * @public
1947
1948
  */
1948
1949
  declare const ErrorDisplay: {
1949
1950
  (props: ErrorDisplayProps): JSX.Element | null;
1950
- ref: SwappableComponentRef<ErrorDisplayProps, ErrorDisplayProps>;
1951
+ ref: _backstage_frontend_plugin_api.SwappableComponentRef<ErrorDisplayProps, ErrorDisplayProps>;
1951
1952
  };
1952
1953
 
1953
1954
  /**
@@ -1963,7 +1964,7 @@ interface SwappableComponentsApi {
1963
1964
  *
1964
1965
  * @public
1965
1966
  */
1966
- declare const swappableComponentsApiRef: ApiRef<SwappableComponentsApi>;
1967
+ declare const swappableComponentsApiRef: _backstage_frontend_plugin_api.ApiRef<SwappableComponentsApi>;
1967
1968
 
1968
1969
  /**
1969
1970
  * The Config API is used to provide a mechanism to access the
@@ -2221,7 +2222,7 @@ interface IconsApi {
2221
2222
  *
2222
2223
  * @public
2223
2224
  */
2224
- declare const iconsApiRef: ApiRef<IconsApi>;
2225
+ declare const iconsApiRef: _backstage_frontend_plugin_api.ApiRef<IconsApi>;
2225
2226
 
2226
2227
  /**
2227
2228
  * The Identity API used to identify and get information about the signed in user.
@@ -2400,7 +2401,7 @@ interface DialogApi {
2400
2401
  *
2401
2402
  * @public
2402
2403
  */
2403
- declare const dialogApiRef: ApiRef<DialogApi>;
2404
+ declare const dialogApiRef: _backstage_frontend_plugin_api.ApiRef<DialogApi>;
2404
2405
 
2405
2406
  /**
2406
2407
  * Describes how to handle auth requests. Both how to show them to the user, and what to do when
@@ -2531,7 +2532,7 @@ interface RouteResolutionApi {
2531
2532
  *
2532
2533
  * @public
2533
2534
  */
2534
- declare const routeResolutionApiRef: ApiRef<RouteResolutionApi>;
2535
+ declare const routeResolutionApiRef: _backstage_frontend_plugin_api.ApiRef<RouteResolutionApi>;
2535
2536
 
2536
2537
  /**
2537
2538
  * A snapshot in time of the current known value of a storage key.
@@ -3134,15 +3135,15 @@ type AnalyticsImplementationFactory<Deps extends {
3134
3135
  *
3135
3136
  * @public
3136
3137
  */
3137
- declare const AnalyticsImplementationBlueprint: ExtensionBlueprint<{
3138
+ declare const AnalyticsImplementationBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3138
3139
  kind: "analytics";
3139
- params: <TDeps extends { [name in string]: unknown; }>(params: AnalyticsImplementationFactory<TDeps>) => ExtensionBlueprintParams<AnalyticsImplementationFactory<{}>>;
3140
- output: ExtensionDataRef<AnalyticsImplementationFactory<{}>, "core.analytics.factory", {}>;
3140
+ params: <TDeps extends { [name in string]: unknown; }>(params: AnalyticsImplementationFactory<TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<AnalyticsImplementationFactory<{}>>;
3141
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<AnalyticsImplementationFactory<{}>, "core.analytics.factory", {}>;
3141
3142
  inputs: {};
3142
3143
  config: {};
3143
3144
  configInput: {};
3144
3145
  dataRefs: {
3145
- factory: ConfigurableExtensionDataRef<AnalyticsImplementationFactory<{}>, "core.analytics.factory", {}>;
3146
+ factory: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<AnalyticsImplementationFactory<{}>, "core.analytics.factory", {}>;
3146
3147
  };
3147
3148
  }>;
3148
3149
 
@@ -3151,15 +3152,15 @@ declare const AnalyticsImplementationBlueprint: ExtensionBlueprint<{
3151
3152
  *
3152
3153
  * @public
3153
3154
  */
3154
- declare const ApiBlueprint: ExtensionBlueprint<{
3155
+ declare const ApiBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3155
3156
  kind: "api";
3156
- params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: ApiFactory<TApi, TImpl, TDeps>) => ExtensionBlueprintParams<AnyApiFactory>;
3157
- output: ExtensionDataRef<AnyApiFactory, "core.api.factory", {}>;
3157
+ params: <TApi, TImpl extends TApi, TDeps extends { [name in string]: unknown; }>(params: ApiFactory<TApi, TImpl, TDeps>) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<AnyApiFactory>;
3158
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<AnyApiFactory, "core.api.factory", {}>;
3158
3159
  inputs: {};
3159
3160
  config: {};
3160
3161
  configInput: {};
3161
3162
  dataRefs: {
3162
- factory: ConfigurableExtensionDataRef<AnyApiFactory, "core.api.factory", {}>;
3163
+ factory: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<AnyApiFactory, "core.api.factory", {}>;
3163
3164
  };
3164
3165
  }>;
3165
3166
 
@@ -3169,12 +3170,12 @@ declare const ApiBlueprint: ExtensionBlueprint<{
3169
3170
  *
3170
3171
  * @public
3171
3172
  */
3172
- declare const AppRootElementBlueprint: ExtensionBlueprint<{
3173
+ declare const AppRootElementBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3173
3174
  kind: "app-root-element";
3174
3175
  params: {
3175
3176
  element: JSX.Element;
3176
3177
  };
3177
- output: ExtensionDataRef<react.JSX.Element, "core.reactElement", {}>;
3178
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}>;
3178
3179
  inputs: {};
3179
3180
  config: {};
3180
3181
  configInput: {};
@@ -3188,7 +3189,7 @@ declare const AppRootElementBlueprint: ExtensionBlueprint<{
3188
3189
  *
3189
3190
  * @public
3190
3191
  */
3191
- declare const AppRootWrapperBlueprint: ExtensionBlueprint<{
3192
+ declare const AppRootWrapperBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3192
3193
  kind: "app-root-wrapper";
3193
3194
  params: {
3194
3195
  /** @deprecated use the `component` parameter instead */
@@ -3197,33 +3198,33 @@ declare const AppRootWrapperBlueprint: ExtensionBlueprint<{
3197
3198
  children: ReactNode;
3198
3199
  }) => JSX.Element | null;
3199
3200
  };
3200
- output: ExtensionDataRef<(props: {
3201
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<(props: {
3201
3202
  children: ReactNode;
3202
3203
  }) => JSX.Element | null, "app.root.wrapper", {}>;
3203
3204
  inputs: {};
3204
3205
  config: {};
3205
3206
  configInput: {};
3206
3207
  dataRefs: {
3207
- component: ConfigurableExtensionDataRef<(props: {
3208
+ component: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(props: {
3208
3209
  children: ReactNode;
3209
3210
  }) => JSX.Element | null, "app.root.wrapper", {}>;
3210
3211
  };
3211
3212
  }>;
3212
3213
 
3213
3214
  /** @public */
3214
- declare const IconBundleBlueprint: ExtensionBlueprint<{
3215
+ declare const IconBundleBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3215
3216
  kind: "icon-bundle";
3216
3217
  params: {
3217
3218
  icons: { [key in string]: IconComponent; };
3218
3219
  };
3219
- output: ExtensionDataRef<{
3220
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<{
3220
3221
  [x: string]: IconComponent;
3221
3222
  }, "core.icons", {}>;
3222
3223
  inputs: {};
3223
3224
  config: {};
3224
3225
  configInput: {};
3225
3226
  dataRefs: {
3226
- icons: ConfigurableExtensionDataRef<{
3227
+ icons: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
3227
3228
  [x: string]: IconComponent;
3228
3229
  }, "core.icons", {}>;
3229
3230
  };
@@ -3281,14 +3282,14 @@ declare const NavContentBlueprint: _backstage_frontend_plugin_api.ExtensionBluep
3281
3282
  *
3282
3283
  * @public
3283
3284
  */
3284
- declare const NavItemBlueprint: ExtensionBlueprint<{
3285
+ declare const NavItemBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3285
3286
  kind: "nav-item";
3286
3287
  params: {
3287
3288
  title: string;
3288
3289
  icon: IconComponent;
3289
3290
  routeRef: RouteRef<undefined>;
3290
3291
  };
3291
- output: ExtensionDataRef<{
3292
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<{
3292
3293
  title: string;
3293
3294
  icon: IconComponent;
3294
3295
  routeRef: RouteRef<undefined>;
@@ -3297,7 +3298,7 @@ declare const NavItemBlueprint: ExtensionBlueprint<{
3297
3298
  config: {};
3298
3299
  configInput: {};
3299
3300
  dataRefs: {
3300
- target: ConfigurableExtensionDataRef<{
3301
+ target: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
3301
3302
  title: string;
3302
3303
  icon: IconComponent;
3303
3304
  routeRef: RouteRef<undefined>;
@@ -3310,7 +3311,7 @@ declare const NavItemBlueprint: ExtensionBlueprint<{
3310
3311
  *
3311
3312
  * @public
3312
3313
  */
3313
- declare const PageBlueprint: ExtensionBlueprint<{
3314
+ declare const PageBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3314
3315
  kind: "page";
3315
3316
  params: {
3316
3317
  /**
@@ -3321,7 +3322,7 @@ declare const PageBlueprint: ExtensionBlueprint<{
3321
3322
  loader: () => Promise<JSX.Element>;
3322
3323
  routeRef?: RouteRef;
3323
3324
  };
3324
- output: ExtensionDataRef<string, "core.routing.path", {}> | ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | ExtensionDataRef<RouteRef<AnyRouteRefParams>, "core.routing.ref", {
3325
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
3325
3326
  optional: true;
3326
3327
  }>;
3327
3328
  inputs: {};
@@ -3335,7 +3336,7 @@ declare const PageBlueprint: ExtensionBlueprint<{
3335
3336
  }>;
3336
3337
 
3337
3338
  /** @public */
3338
- declare const RouterBlueprint: ExtensionBlueprint<{
3339
+ declare const RouterBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3339
3340
  kind: "app-router-component";
3340
3341
  params: {
3341
3342
  /** @deprecated use the `component` parameter instead */
@@ -3344,14 +3345,14 @@ declare const RouterBlueprint: ExtensionBlueprint<{
3344
3345
  children: ReactNode;
3345
3346
  }) => JSX.Element | null;
3346
3347
  };
3347
- output: ExtensionDataRef<(props: {
3348
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<(props: {
3348
3349
  children: ReactNode;
3349
3350
  }) => JSX.Element | null, "app.router.wrapper", {}>;
3350
3351
  inputs: {};
3351
3352
  config: {};
3352
3353
  configInput: {};
3353
3354
  dataRefs: {
3354
- component: ConfigurableExtensionDataRef<(props: {
3355
+ component: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(props: {
3355
3356
  children: ReactNode;
3356
3357
  }) => JSX.Element | null, "app.router.wrapper", {}>;
3357
3358
  };
@@ -3377,17 +3378,17 @@ type SignInPageProps = {
3377
3378
  *
3378
3379
  * @public
3379
3380
  */
3380
- declare const SignInPageBlueprint: ExtensionBlueprint<{
3381
+ declare const SignInPageBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3381
3382
  kind: "sign-in-page";
3382
3383
  params: {
3383
3384
  loader: () => Promise<ComponentType<SignInPageProps>>;
3384
3385
  };
3385
- output: ExtensionDataRef<ComponentType<SignInPageProps>, "core.sign-in-page.component", {}>;
3386
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<ComponentType<SignInPageProps>, "core.sign-in-page.component", {}>;
3386
3387
  inputs: {};
3387
3388
  config: {};
3388
3389
  configInput: {};
3389
3390
  dataRefs: {
3390
- component: ConfigurableExtensionDataRef<ComponentType<SignInPageProps>, "core.sign-in-page.component", {}>;
3391
+ component: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<ComponentType<SignInPageProps>, "core.sign-in-page.component", {}>;
3391
3392
  };
3392
3393
  }>;
3393
3394
 
@@ -3396,17 +3397,17 @@ declare const SignInPageBlueprint: ExtensionBlueprint<{
3396
3397
  *
3397
3398
  * @public
3398
3399
  */
3399
- declare const ThemeBlueprint: ExtensionBlueprint<{
3400
+ declare const ThemeBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3400
3401
  kind: "theme";
3401
3402
  params: {
3402
3403
  theme: AppTheme;
3403
3404
  };
3404
- output: ExtensionDataRef<AppTheme, "core.theme.theme", {}>;
3405
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<AppTheme, "core.theme.theme", {}>;
3405
3406
  inputs: {};
3406
3407
  config: {};
3407
3408
  configInput: {};
3408
3409
  dataRefs: {
3409
- theme: ConfigurableExtensionDataRef<AppTheme, "core.theme.theme", {}>;
3410
+ theme: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<AppTheme, "core.theme.theme", {}>;
3410
3411
  };
3411
3412
  }>;
3412
3413
 
@@ -3415,19 +3416,19 @@ declare const ThemeBlueprint: ExtensionBlueprint<{
3415
3416
  *
3416
3417
  * @public
3417
3418
  */
3418
- declare const TranslationBlueprint: ExtensionBlueprint<{
3419
+ declare const TranslationBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3419
3420
  kind: "translation";
3420
3421
  params: {
3421
3422
  resource: TranslationResource | TranslationMessages;
3422
3423
  };
3423
- output: ExtensionDataRef<TranslationResource<string> | TranslationMessages<string, {
3424
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<TranslationResource<string> | TranslationMessages<string, {
3424
3425
  [x: string]: string;
3425
3426
  }, boolean>, "core.translation.translation", {}>;
3426
3427
  inputs: {};
3427
3428
  config: {};
3428
3429
  configInput: {};
3429
3430
  dataRefs: {
3430
- translation: ConfigurableExtensionDataRef<TranslationResource<string> | TranslationMessages<string, {
3431
+ translation: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<TranslationResource<string> | TranslationMessages<string, {
3431
3432
  [x: string]: string;
3432
3433
  }, boolean>, "core.translation.translation", {}>;
3433
3434
  };
@@ -3438,20 +3439,20 @@ declare const TranslationBlueprint: ExtensionBlueprint<{
3438
3439
  *
3439
3440
  * @public
3440
3441
  */
3441
- declare const SwappableComponentBlueprint: ExtensionBlueprint<{
3442
+ declare const SwappableComponentBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
3442
3443
  kind: "component";
3443
3444
  params: <Ref extends SwappableComponentRef<any>>(params: {
3444
3445
  component: Ref extends SwappableComponentRef<any, infer IExternalComponentProps> ? {
3445
3446
  ref: Ref;
3446
3447
  } & ((props: IExternalComponentProps) => JSX.Element | null) : never;
3447
3448
  loader: Ref extends SwappableComponentRef<infer IInnerComponentProps, any> ? (() => (props: IInnerComponentProps) => JSX.Element | null) | (() => Promise<(props: IInnerComponentProps) => JSX.Element | null>) : never;
3448
- }) => ExtensionBlueprintParams<{
3449
+ }) => _backstage_frontend_plugin_api.ExtensionBlueprintParams<{
3449
3450
  component: Ref extends SwappableComponentRef<any, infer IExternalComponentProps> ? {
3450
3451
  ref: Ref;
3451
3452
  } & ((props: IExternalComponentProps) => JSX.Element | null) : never;
3452
3453
  loader: Ref extends SwappableComponentRef<infer IInnerComponentProps, any> ? (() => (props: IInnerComponentProps) => JSX.Element | null) | (() => Promise<(props: IInnerComponentProps) => JSX.Element | null>) : never;
3453
3454
  }>;
3454
- output: ExtensionDataRef<{
3455
+ output: _backstage_frontend_plugin_api.ExtensionDataRef<{
3455
3456
  ref: SwappableComponentRef;
3456
3457
  loader: (() => (props: {}) => JSX.Element | null) | (() => Promise<(props: {}) => JSX.Element | null>);
3457
3458
  }, "core.swappableComponent", {}>;
@@ -3459,11 +3460,12 @@ declare const SwappableComponentBlueprint: ExtensionBlueprint<{
3459
3460
  config: {};
3460
3461
  configInput: {};
3461
3462
  dataRefs: {
3462
- component: ConfigurableExtensionDataRef<{
3463
+ component: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
3463
3464
  ref: SwappableComponentRef;
3464
3465
  loader: (() => (props: {}) => JSX.Element | null) | (() => Promise<(props: {}) => JSX.Element | null>);
3465
3466
  }, "core.swappableComponent", {}>;
3466
3467
  };
3467
3468
  }>;
3468
3469
 
3469
- export { type AlertApi, type AlertMessage, type AnalyticsApi, AnalyticsContext, type AnalyticsContextValue, type AnalyticsEvent, type AnalyticsEventAttributes, type AnalyticsImplementation, AnalyticsImplementationBlueprint, type AnalyticsImplementationFactory, type AnalyticsTracker, type AnyApiFactory, type AnyApiRef, type AnyExtensionDataRef, type AnyRouteRefParams, ApiBlueprint, type ApiFactory, type ApiHolder, type ApiRef, type ApiRefConfig, type AppLanguageApi, type AppNode, type AppNodeEdges, type AppNodeInstance, type AppNodeSpec, AppRootElementBlueprint, AppRootWrapperBlueprint, type AppTheme, type AppThemeApi, type AppTree, type AppTreeApi, type AuthProviderInfo, type AuthRequestOptions, type BackstageIdentityApi, type BackstageIdentityResponse, type BackstageUserIdentity, type ConfigApi, type ConfigurableExtensionDataRef, type CreateExtensionBlueprintOptions, type CreateExtensionOptions, type CreateFrontendFeatureLoaderOptions, type CreateFrontendModuleOptions, type CreateSwappableComponentOptions, type DialogApi, type DialogApiDialog, type DiscoveryApi, type ErrorApi, type ErrorApiError, type ErrorApiErrorContext, ErrorDisplay, type ErrorDisplayProps, type Extension, type ExtensionAttachTo, type ExtensionAttachToSpec, type ExtensionBlueprint, type ExtensionBlueprintDefineParams, type ExtensionBlueprintParameters, type ExtensionBlueprintParams, ExtensionBoundary, type ExtensionBoundaryProps, type ExtensionDataContainer, type ExtensionDataRef, type ExtensionDataRefToValue, type ExtensionDataValue, type ExtensionDefinition, type ExtensionDefinitionAttachTo, type ExtensionDefinitionParameters, type ExtensionFactoryMiddleware, type ExtensionInput, type ExternalRouteRef, type FeatureFlag, type FeatureFlagConfig, FeatureFlagState, type FeatureFlagsApi, type FeatureFlagsSaveOptions, type FetchApi, type FrontendFeature, type FrontendFeatureLoader, type FrontendModule, type FrontendPlugin, type FrontendPluginInfo, type FrontendPluginInfoOptions, IconBundleBlueprint, type IconComponent, type IconsApi, type IdentityApi, NavContentBlueprint, type NavContentComponent, type NavContentComponentProps, NavItemBlueprint, NotFoundErrorPage, type NotFoundErrorPageProps, type OAuthApi, type OAuthRequestApi, type OAuthRequester, type OAuthRequesterOptions, type OAuthScope, type OpenIdConnectApi, type OverridableExtensionDefinition, type OverridableFrontendPlugin, PageBlueprint, type PendingOAuthRequest, type PluginOptions, type PortableSchema, type ProfileInfo, type ProfileInfoApi, Progress, type ProgressProps, type ResolvedExtensionInput, type ResolvedExtensionInputs, type RouteFunc, type RouteRef, type RouteResolutionApi, RouterBlueprint, type SessionApi, SessionState, SignInPageBlueprint, type SignInPageProps, type StorageApi, type StorageValueSnapshot, type SubRouteRef, SwappableComponentBlueprint, type SwappableComponentRef, type SwappableComponentsApi, ThemeBlueprint, type TranslationApi, TranslationBlueprint, type TranslationFunction, type TranslationMessages, type TranslationMessagesOptions, type TranslationRef, type TranslationRefOptions, type TranslationResource, type TranslationResourceOptions, type TranslationSnapshot, type TypesToApiRefs, alertApiRef, analyticsApiRef, appLanguageApiRef, appThemeApiRef, appTreeApiRef, atlassianAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, configApiRef, coreExtensionData, createApiFactory, createApiRef, createExtension, createExtensionBlueprint, createExtensionBlueprintParams, createExtensionDataRef, createExtensionInput, createExternalRouteRef, createFrontendFeatureLoader, createFrontendModule, createFrontendPlugin, createRouteRef, createSubRouteRef, createSwappableComponent, createTranslationMessages, createTranslationRef, createTranslationResource, dialogApiRef, discoveryApiRef, errorApiRef, featureFlagsApiRef, fetchApiRef, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, iconsApiRef, identityApiRef, microsoftAuthApiRef, oauthRequestApiRef, oktaAuthApiRef, oneloginAuthApiRef, openshiftAuthApiRef, routeResolutionApiRef, storageApiRef, swappableComponentsApiRef, translationApiRef, useAnalytics, useApi, useApiHolder, useAppNode, useRouteRef, useRouteRefParams, useTranslationRef, vmwareCloudAuthApiRef, withApis };
3470
+ export { AnalyticsContext, AnalyticsImplementationBlueprint, ApiBlueprint, AppRootElementBlueprint, AppRootWrapperBlueprint, ErrorDisplay, ExtensionBoundary, FeatureFlagState, IconBundleBlueprint, NavContentBlueprint, NavItemBlueprint, NotFoundErrorPage, PageBlueprint, Progress, RouterBlueprint, SessionState, SignInPageBlueprint, SwappableComponentBlueprint, ThemeBlueprint, TranslationBlueprint, alertApiRef, analyticsApiRef, appLanguageApiRef, appThemeApiRef, appTreeApiRef, atlassianAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, configApiRef, coreExtensionData, createApiFactory, createApiRef, createExtension, createExtensionBlueprint, createExtensionBlueprintParams, createExtensionDataRef, createExtensionInput, createExternalRouteRef, createFrontendFeatureLoader, createFrontendModule, createFrontendPlugin, createRouteRef, createSubRouteRef, createSwappableComponent, createTranslationMessages, createTranslationRef, createTranslationResource, dialogApiRef, discoveryApiRef, errorApiRef, featureFlagsApiRef, fetchApiRef, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, iconsApiRef, identityApiRef, microsoftAuthApiRef, oauthRequestApiRef, oktaAuthApiRef, oneloginAuthApiRef, openshiftAuthApiRef, routeResolutionApiRef, storageApiRef, swappableComponentsApiRef, translationApiRef, useAnalytics, useApi, useApiHolder, useAppNode, useRouteRef, useRouteRefParams, useTranslationRef, vmwareCloudAuthApiRef, withApis };
3471
+ export type { AlertApi, AlertMessage, AnalyticsApi, AnalyticsContextValue, AnalyticsEvent, AnalyticsEventAttributes, AnalyticsImplementation, AnalyticsImplementationFactory, AnalyticsTracker, AnyApiFactory, AnyApiRef, AnyExtensionDataRef, AnyRouteRefParams, ApiFactory, ApiHolder, ApiRef, ApiRefConfig, AppLanguageApi, AppNode, AppNodeEdges, AppNodeInstance, AppNodeSpec, AppTheme, AppThemeApi, AppTree, AppTreeApi, AuthProviderInfo, AuthRequestOptions, BackstageIdentityApi, BackstageIdentityResponse, BackstageUserIdentity, ConfigApi, ConfigurableExtensionDataRef, CreateExtensionBlueprintOptions, CreateExtensionOptions, CreateFrontendFeatureLoaderOptions, CreateFrontendModuleOptions, CreateSwappableComponentOptions, DialogApi, DialogApiDialog, DiscoveryApi, ErrorApi, ErrorApiError, ErrorApiErrorContext, ErrorDisplayProps, Extension, ExtensionAttachTo, ExtensionAttachToSpec, ExtensionBlueprint, ExtensionBlueprintDefineParams, ExtensionBlueprintParameters, ExtensionBlueprintParams, ExtensionBoundaryProps, ExtensionDataContainer, ExtensionDataRef, ExtensionDataRefToValue, ExtensionDataValue, ExtensionDefinition, ExtensionDefinitionAttachTo, ExtensionDefinitionParameters, ExtensionFactoryMiddleware, ExtensionInput, ExternalRouteRef, FeatureFlag, FeatureFlagConfig, FeatureFlagsApi, FeatureFlagsSaveOptions, FetchApi, FrontendFeature, FrontendFeatureLoader, FrontendModule, FrontendPlugin, FrontendPluginInfo, FrontendPluginInfoOptions, IconComponent, IconsApi, IdentityApi, NavContentComponent, NavContentComponentProps, NotFoundErrorPageProps, OAuthApi, OAuthRequestApi, OAuthRequester, OAuthRequesterOptions, OAuthScope, OpenIdConnectApi, OverridableExtensionDefinition, OverridableFrontendPlugin, PendingOAuthRequest, PluginOptions, PortableSchema, ProfileInfo, ProfileInfoApi, ProgressProps, ResolvedExtensionInput, ResolvedExtensionInputs, RouteFunc, RouteRef, RouteResolutionApi, SessionApi, SignInPageProps, StorageApi, StorageValueSnapshot, SubRouteRef, SwappableComponentRef, SwappableComponentsApi, TranslationApi, TranslationFunction, TranslationMessages, TranslationMessagesOptions, TranslationRef, TranslationRefOptions, TranslationResource, TranslationResourceOptions, TranslationSnapshot, TypesToApiRefs };