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

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @backstage/frontend-app-api
 
+## 0.3.1-next.0
+
+### Patch Changes
+
+- 60d6eb544e: Removed `@backstage/plugin-graphiql` dependency.
+- 9ad4039efa: Bringing over apis from core-plugin-api
+- b8cb7804c8: Added `createSpecializedApp`, which is a synchronous version of `createApp` where config and features already need to be loaded.
+- Updated dependencies
+  - @backstage/core-plugin-api@1.8.1-next.0
+  - @backstage/core-components@0.13.9-next.0
+  - @backstage/theme@0.5.0-next.0
+  - @backstage/frontend-plugin-api@0.3.1-next.0
+  - @backstage/core-app-api@1.11.2-next.0
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+
+## 0.3.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.
+- fdc348d5d3: The options parameter of `createApp` is now optional.
+- 6c2b872153: Add official support for React 18.
+- dc613f9bcf: Updated `app.extensions` configuration schema.
+- 733bd95746: Implement new `AppTreeApi`
+- 685a4c8901: Installed features are now deduplicated both by reference and ID when available. Features passed to `createApp` now override both discovered and loaded features.
+- fa28d4e6df: No longer throw error on invalid input if the child is disabled.
+- bb98953cb9: Register default implementation for the `Translation API` on the new `createApp`.
+- fe6d09953d: Fix for app node output IDs not being serialized correctly.
+- 77f009b35d: Internal updates to match changes in the experimental `@backstage/frontend-plugin-api`.
+- 4d6fa921db: Internal refactor to rename the app graph to app tree
+- Updated dependencies
+  - @backstage/core-components@0.13.8
+  - @backstage/frontend-plugin-api@0.3.0
+  - @backstage/plugin-graphiql@0.3.0
+  - @backstage/core-plugin-api@1.8.0
+  - @backstage/version-bridge@1.0.7
+  - @backstage/core-app-api@1.11.1
+  - @backstage/theme@0.4.4
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+
 ## 0.3.0-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -70,5 +70,19 @@ declare function createApp(options?: {
 }): {
     createRoot(): JSX.Element;
 };
+/**
+ * Synchronous version of {@link createApp}, expecting all features and
+ * config to have been loaded already.
+ * @public
+ */
+declare function createSpecializedApp(options?: {
+    features?: (BackstagePlugin | ExtensionOverrides)[];
+    config?: ConfigApi;
+    bindRoutes?(context: {
+        bind: AppRouteBinder;
+    }): void;
+}): {
+    createRoot(): JSX.Element;
+};
 
-export { AppRouteBinder, ExtensionTree, ExtensionTreeNode, createApp, createExtensionTree };
+export { AppRouteBinder, ExtensionTree, ExtensionTreeNode, createApp, createExtensionTree, createSpecializedApp };

package/dist/index.esm.js

@@ -5,7 +5,7 @@ import { useRoutes, BrowserRouter, useInRouterContext, MemoryRouter, matchRoutes
 import { SidebarPage, sidebarConfig, Sidebar, SidebarDivider, useSidebarOpenState, Link, SidebarItem, Progress, ErrorPage, ErrorPanel } from '@backstage/core-components';
 import { makeStyles } from '@material-ui/core';
 import { useApi, appThemeApiRef, FeatureFlagState, createApiFactory, discoveryApiRef, configApiRef, alertApiRef, analyticsApiRef, errorApiRef, storageApiRef, fetchApiRef, identityApiRef, oauthRequestApiRef, googleAuthApiRef, microsoftAuthApiRef, githubAuthApiRef, oktaAuthApiRef, gitlabAuthApiRef, oneloginAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, atlassianAuthApiRef, attachComponentData, featureFlagsApiRef } from '@backstage/core-plugin-api';
-import { UrlPatternDiscovery, AlertApiForwarder, NoOpAnalyticsApi, ErrorAlerter, ErrorApiForwarder, UnhandledErrorForwarder, WebStorage, createFetchApi, FetchMiddlewares, OAuthRequestManager, GoogleAuth, MicrosoftAuth, GithubAuth, OktaAuth, GitlabAuth, OneLoginAuth, BitbucketAuth, BitbucketServerAuth, AtlassianAuth, ApiProvider, ApiFactoryRegistry, AppThemeSelector, ApiResolver } from '@backstage/core-app-api';
+import { UrlPatternDiscovery, AlertApiForwarder, NoOpAnalyticsApi, ErrorAlerter, ErrorApiForwarder, UnhandledErrorForwarder, WebStorage, createFetchApi, FetchMiddlewares, OAuthRequestManager, GoogleAuth, MicrosoftAuth, GithubAuth, OktaAuth, GitlabAuth, OneLoginAuth, BitbucketAuth, BitbucketServerAuth, AtlassianAuth, ApiFactoryRegistry, AppThemeSelector, ApiResolver, ApiProvider } from '@backstage/core-app-api';
 import useObservable from 'react-use/lib/useObservable';
 import { createVersionedContext, createVersionedValueMap, getOrCreateGlobalSingleton } from '@backstage/version-bridge';
 import ObservableImpl from 'zen-observable';
@@ -1327,6 +1327,37 @@ const DarkTheme = createThemeExtension({
   Provider: ({ children }) => /* @__PURE__ */ React.createElement(UnifiedThemeProvider, { theme: themes.dark, children })
 });
 
+const legacyPluginStore = getOrCreateGlobalSingleton(
+  "legacy-plugin-compatibility-store",
+  () => /* @__PURE__ */ new WeakMap()
+);
+function toLegacyPlugin(plugin) {
+  let legacy = legacyPluginStore.get(plugin);
+  if (legacy) {
+    return legacy;
+  }
+  const errorMsg = "Not implemented in legacy plugin compatibility layer";
+  const notImplemented = () => {
+    throw new Error(errorMsg);
+  };
+  legacy = {
+    getId() {
+      return plugin.id;
+    },
+    get routes() {
+      return {};
+    },
+    get externalRoutes() {
+      return {};
+    },
+    getApis: notImplemented,
+    getFeatureFlags: notImplemented,
+    provide: notImplemented
+  };
+  legacyPluginStore.set(plugin, legacy);
+  return legacy;
+}
+
 const MATCH_ALL_ROUTE = {
   caseSensitive: false,
   path: "*",
@@ -2274,35 +2305,16 @@ function createApp(options) {
     );
     const discoveredFeatures = getAvailableFeatures(config);
     const loadedFeatures = (_d = await ((_c = options == null ? void 0 : options.featureLoader) == null ? void 0 : _c.call(options, { config }))) != null ? _d : [];
-    const allFeatures = deduplicateFeatures([
-      ...discoveredFeatures,
-      ...loadedFeatures,
-      ...(_e = options == null ? void 0 : options.features) != null ? _e : []
-    ]);
-    const tree = createAppTree({
-      features: allFeatures,
-      builtinExtensions,
-      config
-    });
-    const appContext = createLegacyAppContext(
-      allFeatures.filter(
-        (f) => f.$$type === "@backstage/BackstagePlugin"
-      )
-    );
-    const routeIds = collectRouteIds(allFeatures);
-    const App = () => /* @__PURE__ */ React.createElement(ApiProvider, { apis: createApiHolder(tree, config) }, /* @__PURE__ */ React.createElement(AppContextProvider, { appContext }, /* @__PURE__ */ React.createElement(AppThemeProvider, null, /* @__PURE__ */ React.createElement(
-      RoutingProvider,
-      {
-        ...extractRouteInfoFromAppNode(tree.root),
-        routeBindings: resolveRouteBindings(
-          options == null ? void 0 : options.bindRoutes,
-          config,
-          routeIds
-        )
-      },
-      /* @__PURE__ */ React.createElement(BrowserRouter, null, tree.root.instance.getData(coreExtensionData.reactElement))
-    ))));
-    return { default: App };
+    const app = createSpecializedApp({
+      config,
+      features: [
+        ...discoveredFeatures,
+        ...loadedFeatures,
+        ...(_e = options == null ? void 0 : options.features) != null ? _e : []
+      ],
+      bindRoutes: options == null ? void 0 : options.bindRoutes
+    }).createRoot();
+    return { default: () => app };
   }
   return {
     createRoot() {
@@ -2311,35 +2323,36 @@ function createApp(options) {
     }
   };
 }
-const legacyPluginStore = getOrCreateGlobalSingleton(
-  "legacy-plugin-compatibility-store",
-  () => /* @__PURE__ */ new WeakMap()
-);
-function toLegacyPlugin(plugin) {
-  let legacy = legacyPluginStore.get(plugin);
-  if (legacy) {
-    return legacy;
-  }
-  const errorMsg = "Not implemented in legacy plugin compatibility layer";
-  const notImplemented = () => {
-    throw new Error(errorMsg);
-  };
-  legacy = {
-    getId() {
-      return plugin.id;
-    },
-    get routes() {
-      return {};
-    },
-    get externalRoutes() {
-      return {};
-    },
-    getApis: notImplemented,
-    getFeatureFlags: notImplemented,
-    provide: notImplemented
+function createSpecializedApp(options) {
+  const {
+    features: duplicatedFeatures = [],
+    config = new ConfigReader({}, "empty-config")
+  } = options != null ? options : {};
+  const features = deduplicateFeatures(duplicatedFeatures);
+  const tree = createAppTree({
+    features,
+    builtinExtensions,
+    config
+  });
+  const appContext = createLegacyAppContext(
+    features.filter(
+      (f) => f.$$type === "@backstage/BackstagePlugin"
+    )
+  );
+  const apiHolder = createApiHolder(tree, config);
+  const routeInfo = extractRouteInfoFromAppNode(tree.root);
+  const routeBindings = resolveRouteBindings(
+    options == null ? void 0 : options.bindRoutes,
+    config,
+    collectRouteIds(features)
+  );
+  const rootEl = tree.root.instance.getData(coreExtensionData.reactElement);
+  const App = () => /* @__PURE__ */ React.createElement(ApiProvider, { apis: apiHolder }, /* @__PURE__ */ React.createElement(AppContextProvider, { appContext }, /* @__PURE__ */ React.createElement(AppThemeProvider, null, /* @__PURE__ */ React.createElement(RoutingProvider, { ...routeInfo, routeBindings }, /* @__PURE__ */ React.createElement(BrowserRouter, null, rootEl)))));
+  return {
+    createRoot() {
+      return /* @__PURE__ */ React.createElement(App, null);
+    }
   };
-  legacyPluginStore.set(plugin, legacy);
-  return legacy;
 }
 function createLegacyAppContext(plugins) {
   return {
@@ -2460,5 +2473,5 @@ function createApiHolder(tree, configApi) {
   return new ApiResolver(factoryRegistry);
 }
 
-export { createApp, createExtensionTree };
+export { createApp, createExtensionTree, createSpecializedApp };
 //# sourceMappingURL=index.esm.js.map