@backstage/frontend-app-api 0.2.0-next.2 → 0.3.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @backstage/frontend-app-api
 
+## 0.3.0-next.0
+
+### Minor Changes
+
+- 68fc9dc60e: Added the ability to configure bound routes through `app.routes.bindings`. The routing system used by `createApp` has been replaced by one that only supports route refs of the new format from `@backstage/frontend-plugin-api`. The requirement for route refs to have the same ID as their associated extension has been removed.
+
+### Patch Changes
+
+- e28d379e32: Refactor internal extension instance system into an app graph.
+- 6c2b872153: Add official support for React 18.
+- dc613f9bcf: Updated `app.extensions` configuration schema.
+- 685a4c8901: Installed features are now deduplicated both by reference and ID when available. Features passed to `createApp` now override both discovered and loaded features.
+- bb98953cb9: Register default implementation for the `Translation API` on the new `createApp`.
+- Updated dependencies
+  - @backstage/core-components@0.13.7-next.0
+  - @backstage/frontend-plugin-api@0.3.0-next.0
+  - @backstage/plugin-graphiql@0.3.0-next.0
+  - @backstage/core-plugin-api@1.8.0-next.0
+  - @backstage/version-bridge@1.0.7-next.0
+  - @backstage/core-app-api@1.11.1-next.0
+  - @backstage/theme@0.4.4-next.0
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+
+## 0.2.0
+
+### Minor Changes
+
+- 4461d87d5a: Removed support for the new `useRouteRef`.
+- 9d03dfe5e3: The `createApp` config option has been replaced by a new `configLoader` option. There is now also a `pluginLoader` option that can be used to dynamically load plugins into the app.
+- d7c5d80c57: The hidden `'root'` extension has been removed and has instead been made an input of the `'core'` extension. The checks for rejecting configuration of the `'root'` extension to rejects configuration of the `'core'` extension instead.
+- d920b8c343: Added support for installing `ExtensionOverrides` via `createApp` options. As part of this change the `plugins` option has been renamed to `features`, and the `pluginLoader` has been renamed to `featureLoader`.
+
+### Patch Changes
+
+- 322bbcae24: Internal update for removal of experimental plugin configuration API.
+- f78ac58f88: Filters for discovered packages are now also applied at runtime. This makes it possible to disable packages through the `app.experimental.packages` config at runtime.
+- 68ffb9e67d: The app will now reject any extensions that attach to nonexistent inputs.
+- 5072824817: Implement `toString()` and `toJSON()` for extension instances.
+- 1e60a9c3a5: Fixed an issue preventing the routing system to match subroutes
+- 52366db5b3: Make themes configurable through extensions, and switched default themes to use extensions instead.
+- 2ecd33618a: Added the `bindRoutes` option to `createApp`.
+- e5a2956dd2: Register default api implementations when creating declarative integrated apps.
+- 9a1fce352e: Updated dependency `@testing-library/jest-dom` to `^6.0.0`.
+- 06432f900c: Updates for `at` -> `attachTo` refactor.
+- 1718ec75b7: Added support for the existing routing system.
+- 66d51a4827: Prevents root extension override and duplicated plugin extensions.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.2.0
+  - @backstage/core-app-api@1.11.0
+  - @backstage/core-plugin-api@1.7.0
+  - @backstage/core-components@0.13.6
+  - @backstage/plugin-graphiql@0.2.55
+  - @backstage/version-bridge@1.0.6
+  - @backstage/theme@0.4.3
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+
 ## 0.2.0-next.2
 
 ### Minor Changes

package/config.d.ts

@@ -16,20 +16,35 @@
 
 export interface Config {
   app?: {
+    experimental?: {
+      /**
+       * @visibility frontend
+       * @deepVisibility frontend
+       */
+      packages?: 'all' | { include?: string[]; exclude?: string[] };
+    };
+
+    routes?: {
+      /**
+       * @deepVisibility frontend
+       */
+      bindings?: { [externalRouteRefId: string]: string };
+    };
+
     /**
      * @deepVisibility frontend
      */
-    extensions?:
+    extensions?: Array<
       | string
       | {
           [extensionId: string]:
             | boolean
-            | string
             | {
-                at?: string;
-                extension?: string;
+                attachTo?: { id: string; input: string };
+                disabled?: boolean;
                 config?: unknown;
               };
-        };
+        }
+    >;
   };
 }

package/dist/index.d.ts

@@ -1,8 +1,46 @@
 import { JSX } from 'react';
 import { Config } from '@backstage/config';
-import { ExtensionDataRef, BackstagePlugin } from '@backstage/frontend-plugin-api';
+import { ExternalRouteRef, RouteRef, SubRouteRef, ExtensionDataRef, BackstagePlugin, ExtensionOverrides } from '@backstage/frontend-plugin-api';
 import { ConfigApi } from '@backstage/core-plugin-api';
 
+/**
+ * Extracts a union of the keys in a map whose value extends the given type
+ *
+ * @ignore
+ */
+type KeysWithType<Obj extends {
+    [key in string]: any;
+}, Type> = {
+    [key in keyof Obj]: Obj[key] extends Type ? key : never;
+}[keyof Obj];
+/**
+ * Takes a map Map required values and makes all keys matching Keys optional
+ *
+ * @ignore
+ */
+type PartialKeys<Map extends {
+    [name in string]: any;
+}, Keys extends keyof Map> = Partial<Pick<Map, Keys>> & Required<Omit<Map, Keys>>;
+/**
+ * Creates a map of target routes with matching parameters based on a map of external routes.
+ *
+ * @ignore
+ */
+type TargetRouteMap<ExternalRoutes extends {
+    [name: string]: ExternalRouteRef;
+}> = {
+    [name in keyof ExternalRoutes]: ExternalRoutes[name] extends ExternalRouteRef<infer Params, any> ? RouteRef<Params> | SubRouteRef<Params> : never;
+};
+/**
+ * A function that can bind from external routes of a given plugin, to concrete
+ * routes of other plugins. See {@link createApp}.
+ *
+ * @public
+ */
+type AppRouteBinder = <TExternalRoutes extends {
+    [name: string]: ExternalRouteRef;
+}>(externalRoutes: TExternalRoutes, targetRoutes: PartialKeys<TargetRouteMap<TExternalRoutes>, KeysWithType<TExternalRoutes, ExternalRouteRef<any, true>>>) => void;
+
 /** @public */
 interface ExtensionTreeNode {
     id: string;
@@ -21,13 +59,16 @@ declare function createExtensionTree(options: {
 }): ExtensionTree;
 /** @public */
 declare function createApp(options: {
-    plugins: BackstagePlugin[];
+    features?: (BackstagePlugin | ExtensionOverrides)[];
     configLoader?: () => Promise<ConfigApi>;
-    pluginLoader?: (ctx: {
+    bindRoutes?(context: {
+        bind: AppRouteBinder;
+    }): void;
+    featureLoader?: (ctx: {
         config: ConfigApi;
-    }) => Promise<BackstagePlugin[]>;
+    }) => Promise<(BackstagePlugin | ExtensionOverrides)[]>;
 }): {
     createRoot(): JSX.Element;
 };
 
-export { ExtensionTree, ExtensionTreeNode, createApp, createExtensionTree };
+export { AppRouteBinder, ExtensionTree, ExtensionTreeNode, createApp, createExtensionTree };