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

frontend-plugin-api: add routes and externalRoutes to plugins

Browse Source 
Co-authored-by: Philipp Hugenroth <philipph@spotify.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-10-11 14:23:19 +02:00
parent c69e53e88f
commit f2b7cb4a56
4 changed files with 55 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/frontend-plugin-api/api-report.md
+24 -3
View File
@@ -7,6 +7,8 @@
import { AnyApiFactory } from '@backstage/core-plugin-api';
import { AnyApiRef } from '@backstage/core-plugin-api';
import { AnyExternalRoutes } from '@backstage/core-plugin-api';
import { AnyRoutes } from '@backstage/core-plugin-api';
import { AppTheme } from '@backstage/core-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { JsonObject } from '@backstage/types';
@@ -40,13 +42,20 @@ export type AnyExtensionInputMap = {
};
// @public (undocumented)
export interface BackstagePlugin {
export interface BackstagePlugin<
Routes extends AnyRoutes = AnyRoutes,
ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes,
> {
// (undocumented)
$$type: '@backstage/BackstagePlugin';
// (undocumented)
extensions: Extension<unknown>[];
// (undocumented)
externalRoutes: ExternalRoutes;
// (undocumented)
id: string;
// (undocumented)
routes: Routes;
}
// @public (undocumented)
@@ -205,7 +214,12 @@ export function createPageExtension<
): Extension<TConfig>;
// @public (undocumented)
export function createPlugin(options: PluginOptions): BackstagePlugin;
export function createPlugin<
Routes extends AnyRoutes = AnyRoutes,
ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes,
>(
options: PluginOptions<Routes, ExternalRoutes>,
): BackstagePlugin<Routes, ExternalRoutes>;
// @public (undocumented)
export function createSchemaFromZod<TOutput, TInput>(
@@ -338,11 +352,18 @@ export type NavTarget = {
};
// @public (undocumented)
export interface PluginOptions {
export interface PluginOptions<
Routes extends AnyRoutes,
ExternalRoutes extends AnyExternalRoutes,
> {
// (undocumented)
extensions?: Extension<unknown>[];
// (undocumented)
externalRoutes?: ExternalRoutes;
// (undocumented)
id: string;
// (undocumented)
routes?: Routes;
}
// @public (undocumented)
packages/frontend-plugin-api/src/wiring/createPlugin.ts
+22 -4
View File
@@ -14,26 +14,44 @@
* limitations under the License.
*/
import { AnyExternalRoutes, AnyRoutes } from '@backstage/core-plugin-api';
import { Extension } from './createExtension';
/** @public */
export interface PluginOptions {
export interface PluginOptions<
Routes extends AnyRoutes,
ExternalRoutes extends AnyExternalRoutes,
> {
id: string;
routes?: Routes;
externalRoutes?: ExternalRoutes;
extensions?: Extension<unknown>[];
}
/** @public */
export interface BackstagePlugin {
export interface BackstagePlugin<
Routes extends AnyRoutes = AnyRoutes,
ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes,
> {
$$type: '@backstage/BackstagePlugin';
id: string;
extensions: Extension<unknown>[];
routes: Routes;
externalRoutes: ExternalRoutes;
}
/** @public */
export function createPlugin(options: PluginOptions): BackstagePlugin {
export function createPlugin<
Routes extends AnyRoutes = AnyRoutes,
ExternalRoutes extends AnyExternalRoutes = AnyExternalRoutes,
>(
options: PluginOptions<Routes, ExternalRoutes>,
): BackstagePlugin<Routes, ExternalRoutes> {
return {
...options,
$$type: '@backstage/BackstagePlugin',
routes: options.routes ?? ({} as Routes),
externalRoutes: options.externalRoutes ?? ({} as ExternalRoutes),
extensions: options.extensions ?? [],
$$type: '@backstage/BackstagePlugin',
};
}