Merge pull request #33441 from backstage/rugvip/remove-plugin-header-action-define-params

frontend-plugin-api: remove defineParams from PluginHeaderActionBlueprint

.changeset/remove-plugin-header-action-define-params.md

@@ -0,0 +1,5 @@
+---
+'@backstage/frontend-plugin-api': patch
+---
+
+Removed the unnecessary need to use `defineParams` callback from `PluginHeaderActionBlueprint`. It still works, but is no longer required.

.changeset/update-app-visualizer-header-action.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-app-visualizer': patch
+---
+
+Updated `PluginHeaderActionBlueprint` usage to pass params as a plain object.

packages/frontend-plugin-api/report.api.md

@@ -1953,11 +1953,9 @@ export type PendingOAuthRequest = {
 // @public
 export const PluginHeaderActionBlueprint: ExtensionBlueprint_2<{
   kind: 'plugin-header-action';
-  params: (params: {
+  params: {
     loader: () => Promise<JSX.Element>;
-  }) => ExtensionBlueprintParams_2<{
-    loader: () => Promise<JSX.Element>;
-  }>;
+  };
   output: ExtensionDataRef_2<JSX_2, 'core.reactElement', {}>;
   inputs: {};
   config: {};

packages/frontend-plugin-api/src/blueprints/PluginHeaderActionBlueprint.tsx

@@ -16,11 +16,7 @@
 
 import { lazy as reactLazy } from 'react';
 import { ExtensionBoundary } from '../components';
-import {
-  coreExtensionData,
-  createExtensionBlueprint,
-  createExtensionBlueprintParams,
-} from '../wiring';
+import { coreExtensionData, createExtensionBlueprint } from '../wiring';
 
 /**
  * Creates extensions that provide plugin-scoped header actions.
@@ -36,10 +32,7 @@ export const PluginHeaderActionBlueprint = createExtensionBlueprint({
   kind: 'plugin-header-action',
   attachTo: { id: 'api:app/plugin-header-actions', input: 'actions' },
   output: [coreExtensionData.reactElement],
-  defineParams(params: { loader: () => Promise<JSX.Element> }) {
-    return createExtensionBlueprintParams(params);
-  },
-  *factory(params, { node }) {
+  *factory(params: { loader: () => Promise<JSX.Element> }, { node }) {
     const LazyAction = reactLazy(() =>
       params.loader().then(element => ({ default: () => element })),
     );

plugins/app-visualizer/report.api.md

@@ -5,7 +5,6 @@
 ```ts
 import { AnyRouteRefParams } from '@backstage/frontend-plugin-api';
 import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
-import { ExtensionBlueprintParams } from '@backstage/frontend-plugin-api';
 import { ExtensionDataRef } from '@backstage/frontend-plugin-api';
 import { ExtensionInput } from '@backstage/frontend-plugin-api';
 import { IconComponent } from '@backstage/frontend-plugin-api';
@@ -124,11 +123,9 @@ const visualizerPlugin: OverridableFrontendPlugin<
       configInput: {};
       output: ExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>;
       inputs: {};
-      params: (params: {
+      params: {
         loader: () => Promise<JSX.Element>;
-      }) => ExtensionBlueprintParams<{
-        loader: () => Promise<JSX.Element>;
-      }>;
+      };
     }>;
     'sub-page:app-visualizer/details': OverridableExtensionDefinition<{
       kind: 'sub-page';

plugins/app-visualizer/src/plugin.tsx

@@ -76,11 +76,10 @@ const appVisualizerTextPage = SubPageBlueprint.make({
 });
 
 const copyTreeAsJson = PluginHeaderActionBlueprint.make({
-  params: defineParams =>
-    defineParams({
-      loader: () =>
-        import('./components/CopyTreeButton').then(m => <m.CopyTreeButton />),
-    }),
+  params: {
+    loader: () =>
+      import('./components/CopyTreeButton').then(m => <m.CopyTreeButton />),
+  },
 });
 
 export const appVisualizerNavItem = NavItemBlueprint.make({