core-app-api: deprecate the BackstagePluginWithAnyOutput type

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
backstage · Nov 16, 2021 · ecd1fcb · ecd1fcb
1 parent eaeac8f
commit ecd1fcb
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/.changeset/rare-lemons-boil.md b/.changeset/rare-lemons-boil.md
@@ -0,0 +1,5 @@
+---
+'@backstage/core-app-api': patch
+---
+
+Deprecated the `BackstagePluginWithAnyOutput` type.
diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md
@@ -197,7 +197,14 @@ export type AppOptions = {
   icons: AppIcons & {
     [key in string]: IconComponent;
   };
-  plugins?: BackstagePluginWithAnyOutput[];
+  plugins?: (Omit<BackstagePlugin<any, any>, 'output'> & {
+    output(): (
+      | PluginOutput
+      | {
+          type: string;
+        }
+    )[];
+  })[];
   components: AppComponents;
   themes: (Partial<AppTheme> & Omit<AppTheme, 'theme'>)[];
   configLoader?: AppConfigLoader;
@@ -269,7 +276,7 @@ export type BackstageApp = {
   getRouter(): ComponentType<{}>;
 };
 
-// @public
+// @public @deprecated
 export type BackstagePluginWithAnyOutput = Omit<
   BackstagePlugin<any, any>,
   'output'

diff --git a/packages/core-app-api/src/app/types.ts b/packages/core-app-api/src/app/types.ts
@@ -200,6 +200,7 @@ export type AppRouteBinder = <
  *
  * @public
  * @remarks
+ * @deprecated Will be removed
  *
  * The `type: string` type is there to handle output from newer or older plugin
  * API versions that might not be supported by this version of the app API, but
@@ -246,7 +247,9 @@ export type AppOptions = {
   /**
    * A list of all plugins to include in the app.
    */
-  plugins?: BackstagePluginWithAnyOutput[];
+  plugins?: (Omit<BackstagePlugin<any, any>, 'output'> & {
+    output(): (PluginOutput | { type: string })[];
+  })[];
 
   /**
    * Supply components to the app to override the default ones.