Version Packages (next)

packages/frontend-plugin-api/CHANGELOG.md

@@ -1,5 +1,113 @@
 # @backstage/frontend-plugin-api
 
+## 0.11.0-next.2
+
+### Minor Changes
+
+- fda1bbc: **BREAKING**: The component system has been overhauled to use `SwappableComponent` instead of `ComponentRef`. Several APIs have been removed and replaced:
+
+  - Removed: `createComponentRef`, `createComponentExtension`, `ComponentRef`, `ComponentsApi`, `componentsApiRef`, `useComponentRef`, `coreComponentRefs`
+  - Added: `createSwappableComponent`, `SwappableComponentBlueprint`, `SwappableComponentRef`, `SwappableComponentsApi`, `swappableComponentsApiRef`
+
+  **BREAKING**: The default `componentRefs` and exported `Core*Props` have been removed and have replacement `SwappableComponents` and revised type names instead.
+
+  - The `errorBoundaryFallback` component and `CoreErrorBoundaryFallbackProps` type have been replaced with `ErrorDisplay` swappable component and `CoreErrorDisplayProps` respectively.
+  - The `progress` component and `CoreProgressProps` type have been replaced with `Progress` swappable component and `ProgressProps` respectively.
+  - The `notFoundErrorPage` component and `CoreNotFoundErrorPageProps` type have been replaced with `NotFoundErrorPage` swappable component and `NotFoundErrorPageProps` respectively.
+
+  **Migration for creating swappable components:**
+
+  ```tsx
+  // OLD: Using createComponentRef and createComponentExtension
+  import {
+    createComponentRef,
+    createComponentExtension,
+  } from '@backstage/frontend-plugin-api';
+
+  const myComponentRef = createComponentRef<{ title: string }>({
+    id: 'my-plugin.my-component',
+  });
+
+  const myComponentExtension = createComponentExtension({
+    ref: myComponentRef,
+    loader: {
+      lazy: () => import('./MyComponent').then(m => m.MyComponent),
+    },
+  });
+
+  // NEW: Using createSwappableComponent and SwappableComponentBlueprint
+  import {
+    createSwappableComponent,
+    SwappableComponentBlueprint,
+  } from '@backstage/frontend-plugin-api';
+
+  const MySwappableComponent = createSwappableComponent({
+    id: 'my-plugin.my-component',
+    loader: () => import('./MyComponent').then(m => m.MyComponent),
+  });
+
+  const myComponentExtension = SwappableComponentBlueprint.make({
+    name: 'my-component',
+    params: {
+      component: MySwappableComponent,
+      loader: () => import('./MyComponent').then(m => m.MyComponent),
+    },
+  });
+  ```
+
+  **Migration for using components:**
+
+  ```tsx
+  // OLD: Using ComponentsApi and useComponentRef
+  import {
+    useComponentRef,
+    componentsApiRef,
+    useApi,
+    coreComponentRefs,
+  } from '@backstage/frontend-plugin-api';
+
+  const MyComponent = useComponentRef(myComponentRef);
+  const ProgressComponent = useComponentRef(coreComponentRefs.progress);
+
+
+  // NEW: Direct component usage
+  import { Progress } from '@backstage/frontend-plugin-api';
+
+  // Use directly as React Component
+  <Progress />
+  <MySwappableComponent title="Hello World" />
+  ```
+
+  **Migration for core component references:**
+
+  ```tsx
+  // OLD: Core component refs
+  import { coreComponentRefs } from '@backstage/frontend-plugin-api';
+
+  coreComponentRefs.progress
+  coreComponentRefs.notFoundErrorPage
+  coreComponentRefs.errorBoundaryFallback
+
+  // NEW: Direct swappable component imports
+  import { Progress, NotFoundErrorPage, ErrorDisplay } from '@backstage/frontend-plugin-api';
+
+  // Use directly as React components
+  <Progress />
+  <NotFoundErrorPage />
+  <ErrorDisplay plugin={plugin} error={error} resetError={resetError} />
+  ```
+
+- 6a75e00: **BREAKING**: Removed the deprecated `createFrontendPlugin` variant where the plugin ID is passed via an `id` option. To update existing code, switch to using the `pluginId` option instead.
+- 1e6410b: **BREAKING**: The `ResolveInputValueOverrides` type is no longer exported.
+
+### Patch Changes
+
+- 9831f4e: Adjusted the dialog API types to have more sensible defaults
+- 1c2cc37: Improved runtime error message clarity when extension factories don't return an iterable object.
+- 24558f0: Added inline documentation for `createExtension`, `createExtensionBlueprint`, `createFrontendPlugin`, and `createFrontendModule`.
+- Updated dependencies
+  - @backstage/core-components@0.17.5-next.2
+
 ## 0.11.0-next.1
 
 ### Minor Changes

packages/frontend-plugin-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/frontend-plugin-api",
-  "version": "0.11.0-next.1",
+  "version": "0.11.0-next.2",
   "backstage": {
     "role": "web-library"
   },