@backstage/frontend-app-api 0.5.0 → 0.6.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,69 @@
 # @backstage/frontend-app-api
 
+## 0.6.0-next.1
+
+### Minor Changes
+
+- bdf4a8e: **BREAKING**: Removed the experimental `createExtensionTree` API.
+
+### Patch Changes
+
+- bc621aa: Updates to use the new `RouteResolutionsApi`.
+- e586f79: Wrap the root element with the analytics context to ensure it always exists for all extensions.
+- fb9b5e7: The default `ComponentsApi` implementation now uses the `ComponentRef` ID as the component key, rather than the reference instance. This fixes a bug where duplicate installations of `@backstage/frontend-plugin-api` would break the app.
+- 46b63de: Allow external route refs in the new system to have a `defaultTarget` pointing to a route that it'll resolve to by default if no explicit bindings were made by the adopter.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.6.0-next.1
+  - @backstage/core-components@0.14.0-next.0
+  - @backstage/core-plugin-api@1.8.3-next.0
+  - @backstage/core-app-api@1.11.4-next.0
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+  - @backstage/theme@0.5.0
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+
+## 0.6.0-next.0
+
+### Minor Changes
+
+- 86346c2: **BREAKING**: The `app.routes.bindings` app-config mapping has been simplified. You now only need to specify the plugin ID and route ID on both sides of the mapping.
+
+  Old form:
+
+  ```yaml
+  app:
+    routes:
+      bindings:
+        plugin.catalog.externalRoutes.viewTechDoc: plugin.techdocs.routes.docRoot
+        plugin.catalog.externalRoutes.createComponent: plugin.catalog-import.routes.importPage
+  ```
+
+  New form:
+
+  ```yaml
+  app:
+    routes:
+      bindings:
+        catalog.viewTechDoc: techdocs.docRoot
+        catalog.createComponent: catalog-import.importPage
+  ```
+
+### Patch Changes
+
+- 42ebf27: Added `IconsApi` implementation and the ability to configure icons through the `icons` option for `createApp` and `createSpecializedApp`. This is not a long-term solution as icons should be installable via extensions instead. This is just a stop-gap to make sure there is feature parity with the existing frontend system.
+- e0a4dd1: Improved the error message when data input/output shapes do not match
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.5.1-next.0
+  - @backstage/core-components@0.13.10
+  - @backstage/config@1.1.1
+  - @backstage/core-app-api@1.11.3
+  - @backstage/core-plugin-api@1.8.2
+  - @backstage/errors@1.2.3
+  - @backstage/theme@0.5.0
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import { ExternalRouteRef, RouteRef, SubRouteRef, ExtensionDataRef, FrontendFeature } from '@backstage/frontend-plugin-api';
+import { ExternalRouteRef, RouteRef, SubRouteRef, FrontendFeature } from '@backstage/frontend-plugin-api';
 import { JSX } from 'react';
-import { Config } from '@backstage/config';
-import { ConfigApi } from '@backstage/core-plugin-api';
+import { ConfigApi, IconComponent } from '@backstage/core-plugin-api';
 
 /**
  * Extracts a union of the keys in a map whose value extends the given type
@@ -41,22 +40,6 @@ type CreateAppRouteBinder = <TExternalRoutes extends {
     [name: string]: ExternalRouteRef;
 }>(externalRoutes: TExternalRoutes, targetRoutes: PartialKeys<TargetRouteMap<TExternalRoutes>, KeysWithType<TExternalRoutes, ExternalRouteRef<any, true>>>) => void;
 
-/** @public */
-interface ExtensionTreeNode {
-    id: string;
-    getData<T>(ref: ExtensionDataRef<T>): T | undefined;
-}
-/** @public */
-interface ExtensionTree {
-    getExtension(id: string): ExtensionTreeNode | undefined;
-    getExtensionAttachments(id: string, inputName: string): ExtensionTreeNode[];
-    getRootRoutes(): JSX.Element[];
-    getSidebarItems(): JSX.Element[];
-}
-/** @public */
-declare function createExtensionTree(options: {
-    config: Config;
-}): ExtensionTree;
 /**
  * A source of dynamically loaded frontend features.
  *
@@ -78,6 +61,9 @@ interface CreateAppFeatureLoader {
 }
 /** @public */
 declare function createApp(options?: {
+    icons?: {
+        [key in string]: IconComponent;
+    };
     features?: (FrontendFeature | CreateAppFeatureLoader)[];
     configLoader?: () => Promise<{
         config: ConfigApi;
@@ -95,6 +81,9 @@ declare function createApp(options?: {
  * @public
  */
 declare function createSpecializedApp(options?: {
+    icons?: {
+        [key in string]: IconComponent;
+    };
     features?: FrontendFeature[];
     config?: ConfigApi;
     bindRoutes?(context: {
@@ -104,4 +93,4 @@ declare function createSpecializedApp(options?: {
     createRoot(): JSX.Element;
 };
 
-export { CreateAppFeatureLoader, CreateAppRouteBinder, ExtensionTree, ExtensionTreeNode, createApp, createExtensionTree, createSpecializedApp };
+export { CreateAppFeatureLoader, CreateAppRouteBinder, createApp, createSpecializedApp };