Merge pull request #26011 from backstage/rugvip/frontend-plugin

frontend-plugin-api: renamed createPlugin to createFrontendPlugin

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

@@ -893,6 +893,25 @@ export function createExternalRouteRef<
       }
 >;
 
+// @public (undocumented)
+export function createFrontendPlugin<
+  TId extends string,
+  TRoutes extends AnyRoutes = {},
+  TExternalRoutes extends AnyExternalRoutes = {},
+  TExtensions extends readonly ExtensionDefinition<any, any>[] = [],
+>(
+  options: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>,
+): BackstagePlugin<
+  TRoutes,
+  TExternalRoutes,
+  {
+    [KExtension in TExtensions[number] as ResolveExtensionId<
+      KExtension,
+      TId
+    >]: KExtension;
+  }
+>;
+
 // @public @deprecated
 export function createNavItemExtension(options: {
   namespace?: string;
@@ -988,24 +1007,8 @@ export function createPageExtension<
   },
 ): ExtensionDefinition<TConfig>;
 
-// @public (undocumented)
-export function createPlugin<
-  TId extends string,
-  TRoutes extends AnyRoutes = {},
-  TExternalRoutes extends AnyExternalRoutes = {},
-  TExtensions extends readonly ExtensionDefinition<any, any>[] = [],
->(
-  options: PluginOptions<TId, TRoutes, TExternalRoutes, TExtensions>,
-): BackstagePlugin<
-  TRoutes,
-  TExternalRoutes,
-  {
-    [KExtension in TExtensions[number] as ResolveExtensionId<
-      KExtension,
-      TId
-    >]: KExtension;
-  }
->;
+// @public @deprecated (undocumented)
+export const createPlugin: typeof createFrontendPlugin;
 
 // @public
 export function createRouteRef<

packages/frontend-plugin-api/src/wiring/createFrontendPlugin.test.ts

@@ -18,7 +18,7 @@ import React from 'react';
 import { createApp } from '@backstage/frontend-app-api';
 import { screen } from '@testing-library/react';
 import { createSchemaFromZod } from '../schema/createSchemaFromZod';
-import { createPlugin } from './createPlugin';
+import { createFrontendPlugin } from './createFrontendPlugin';
 import { JsonObject } from '@backstage/types';
 import { createExtension } from './createExtension';
 import { createExtensionDataRef } from './createExtensionDataRef';
@@ -133,16 +133,16 @@ function createTestAppRoot({
   }).createRoot();
 }
 
-describe('createPlugin', () => {
+describe('createFrontendPlugin', () => {
   it('should create an empty plugin', () => {
-    const plugin = createPlugin({ id: 'test' });
+    const plugin = createFrontendPlugin({ id: 'test' });
 
     expect(plugin).toBeDefined();
     expect(String(plugin)).toBe('Plugin{id=test}');
   });
 
   it('should create a plugin with extension instances', async () => {
-    const plugin = createPlugin({
+    const plugin = createFrontendPlugin({
       id: 'test',
       extensions: [Extension1, Extension2, outputExtension],
     });
@@ -186,7 +186,7 @@ describe('createPlugin', () => {
   });
 
   it('should create a plugin with nested extension instances', async () => {
-    const plugin = createPlugin({
+    const plugin = createFrontendPlugin({
       id: 'test',
       extensions: [Extension1, Extension2, Extension3, Child, outputExtension],
     });
@@ -218,7 +218,7 @@ describe('createPlugin', () => {
   });
 
   it('should create a plugin with nested extension instances and multiple children', async () => {
-    const plugin = createPlugin({
+    const plugin = createFrontendPlugin({
       id: 'test',
       extensions: [
         Extension1,
@@ -251,14 +251,14 @@ describe('createPlugin', () => {
 
   it('should throw on duplicate extensions', async () => {
     expect(() =>
-      createPlugin({
+      createFrontendPlugin({
         id: 'test',
         extensions: [Extension1, Extension1],
       }),
     ).toThrow("Plugin 'test' provided duplicate extensions: test/1");
 
     expect(() =>
-      createPlugin({
+      createFrontendPlugin({
         id: 'test',
         extensions: [
           Extension1,
@@ -274,7 +274,7 @@ describe('createPlugin', () => {
 
   describe('overrides', () => {
     it('should return a plugin instance with the correct namespace', () => {
-      const plugin = createPlugin({
+      const plugin = createFrontendPlugin({
         id: 'test',
         extensions: [Extension1, Extension2],
       });
@@ -304,7 +304,7 @@ describe('createPlugin', () => {
     });
 
     it('should allow overriding extensions that have a matching ID, while keeping old extensions that do not have overlapping IDs', async () => {
-      const plugin = createPlugin({
+      const plugin = createFrontendPlugin({
         id: 'test',
         extensions: [Extension1, Extension2, outputExtension],
       });

packages/frontend-plugin-api/src/wiring/createFrontendPlugin.ts

@@ -52,7 +52,7 @@ export interface InternalBackstagePlugin<
 }
 
 /** @public */
-export function createPlugin<
+export function createFrontendPlugin<
   TId extends string,
   TRoutes extends AnyRoutes = {},
   TExternalRoutes extends AnyExternalRoutes = {},
@@ -122,7 +122,7 @@ export function createPlugin<
             resolveExtensionDefinition(e, { namespace: options.id }).id,
           ),
       );
-      return createPlugin({
+      return createFrontendPlugin({
         ...options,
         extensions: [...nonOverriddenExtensions, ...overrides.extensions],
       });
@@ -145,3 +145,9 @@ export function toInternalBackstagePlugin(
   }
   return internal;
 }
+
+/**
+ * @public
+ * @deprecated Use {@link createFrontendPlugin} instead.
+ */
+export const createPlugin = createFrontendPlugin;

packages/frontend-plugin-api/src/wiring/index.ts

@@ -40,7 +40,11 @@ export {
   type ExtensionDataValue,
   type ConfigurableExtensionDataRef,
 } from './createExtensionDataRef';
-export { createPlugin, type PluginOptions } from './createPlugin';
+export {
+  createPlugin,
+  createFrontendPlugin,
+  type PluginOptions,
+} from './createFrontendPlugin';
 export {
   createExtensionOverrides,
   type ExtensionOverridesOptions,