@backstage/core-app-api 1.8.0 → 1.8.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @backstage/core-app-api
 
+## 1.8.1
+
+### Patch Changes
+
+- 12adfbc8fe2d: Fixed a bug that prevented accurate plugin and route data from being applied to `navigate` analytics events when users visited pages constructed with `<EntityLayout>`, `<TabbedLayout>`, and similar components that are used to gather one or more routable extensions under a given path.
+- ac677bc30ae0: Expose discovery.endpoints configuration to use FrontendHostDiscovery
+- 74b216ee4e50: Add `PropsWithChildren` to usages of `ComponentType`, in preparation for React 18 where the children are no longer implicit.
+- Updated dependencies
+  - @backstage/core-plugin-api@1.5.2
+  - @backstage/types@1.1.0
+  - @backstage/config@1.0.8
+  - @backstage/version-bridge@1.0.4
+
+## 1.8.1-next.0
+
+### Patch Changes
+
+- 74b216ee4e50: Add `PropsWithChildren` to usages of `ComponentType`, in preparation for React 18 where the children are no longer implicit.
+- Updated dependencies
+  - @backstage/core-plugin-api@1.5.2-next.0
+  - @backstage/config@1.0.7
+  - @backstage/types@1.0.2
+  - @backstage/version-bridge@1.0.4
+
 ## 1.8.0
 
 ### Minor Changes

package/config.d.ts

@@ -117,9 +117,48 @@ export interface Config {
   };
 
   /**
-   $ Enable redirect authentication flow type, instead of a popup for authentication
-   * default value: 'false'
+   * Enable redirect authentication flow type, instead of a popup for authentication.
+   * @defaultValue false
    * @visibility frontend
    */
   enableExperimentalRedirectFlow?: boolean;
+
+  /**
+   * Discovery options.
+   *
+   * @visibility frontend
+   */
+  discovery?: {
+    /**
+     * Endpoints
+     *
+     * A list of target baseUrls and the associated plugins.
+     *
+     * @visibility frontend
+     */
+    endpoints?: Array<{
+      /**
+       * The target baseUrl to use for the plugin
+       *
+       * Can be either a string or an object with internal and external keys. (Internal is used for the backend, external for the frontend)
+       * Targets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.
+       *
+       * @visibility frontend
+       */
+      target:
+        | string
+        | {
+            /**
+             * @visibility frontend
+             */
+            external: string;
+          };
+      /**
+       * Array of plugins which use the target baseUrl.
+       *
+       * @visibility frontend
+       */
+      plugins: Array<string>;
+    }>;
+  };
 }

package/dist/index.d.ts

@@ -661,45 +661,45 @@ declare function AppRouter(props: AppRouterProps): JSX.Element;
  *
  * @public
  */
-type BootErrorPageProps = {
+type BootErrorPageProps = PropsWithChildren<{
     step: 'load-config' | 'load-chunk';
     error: Error;
-};
+}>;
 /**
  * Props for the `SignInPage` component of {@link AppComponents}.
  *
  * @public
  */
-type SignInPageProps = {
+type SignInPageProps = PropsWithChildren<{
     /**
      * Set the IdentityApi on successful sign-in. This should only be called once.
      */
     onSignInSuccess(identityApi: IdentityApi): void;
-};
+}>;
 /**
  * Props for the fallback error boundary.
  *
  * @public
  */
-type ErrorBoundaryFallbackProps = {
+type ErrorBoundaryFallbackProps = PropsWithChildren<{
     plugin?: BackstagePlugin;
     error: Error;
     resetError: () => void;
-};
+}>;
 /**
  * A set of replaceable core components that are part of every Backstage app.
  *
  * @public
  */
 type AppComponents = {
-    NotFoundErrorPage: ComponentType<{}>;
+    NotFoundErrorPage: ComponentType<PropsWithChildren<{}>>;
     BootErrorPage: ComponentType<BootErrorPageProps>;
-    Progress: ComponentType<{}>;
-    Router: ComponentType<{
+    Progress: ComponentType<PropsWithChildren<{}>>;
+    Router: ComponentType<PropsWithChildren<{
         basename?: string;
-    }>;
+    }>>;
     ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
-    ThemeProvider?: ComponentType<{}>;
+    ThemeProvider?: ComponentType<PropsWithChildren<{}>>;
     /**
      * An optional sign-in page that will be rendered instead of the AppRouter at startup.
      *
@@ -841,21 +841,13 @@ type AppOptions = {
      *   title: 'Light Theme',
      *   variant: 'light',
      *   icon: <LightIcon />,
-     *   Provider: ({ children }) => (
-     *     <ThemeProvider theme={lightTheme}>
-     *       <CssBaseline>{children}</CssBaseline>
-     *     </ThemeProvider>
-     *   ),
+     *   Provider: ({ children }) => <UnifiedThemeProvider theme={themes.light} />,
      * }, {
      *   id: 'dark',
      *   title: 'Dark Theme',
      *   variant: 'dark',
      *   icon: <DarkIcon />,
-     *   Provider: ({ children }) => (
-     *     <ThemeProvider theme={darkTheme}>
-     *       <CssBaseline>{children}</CssBaseline>
-     *     </ThemeProvider>
-     *   ),
+     *   Provider: ({ children }) => <UnifiedThemeProvider theme={themes.dark} />,
      * }]
      * ```
      */
@@ -929,21 +921,21 @@ type BackstageApp = {
      * );
      * ```
      */
-    createRoot(element: JSX.Element): ComponentType<{}>;
+    createRoot(element: JSX.Element): ComponentType<PropsWithChildren<{}>>;
     /**
      * Provider component that should wrap the Router created with getRouter()
      * and any other components that need to be within the app context.
      *
      * @deprecated Use {@link BackstageApp.createRoot} instead.
      */
-    getProvider(): ComponentType<{}>;
+    getProvider(): ComponentType<PropsWithChildren<{}>>;
     /**
      * Router component that should wrap the App Routes create with getRoutes()
      * and any other components that should only be available while signed in.
      *
      * @deprecated Import and use the {@link AppRouter} component from `@backstage/core-app-api` instead
      */
-    getRouter(): ComponentType<{}>;
+    getRouter(): ComponentType<PropsWithChildren<{}>>;
 };
 /**
  * The central context providing runtime app specific state that plugin views

package/dist/index.esm.js

@@ -2009,12 +2009,11 @@ function isReactRouterBeta() {
 }
 
 const getExtensionContext = (pathname, routes) => {
-  var _a;
   try {
     const matches = matchRoutes(routes, { pathname });
     const routeMatch = matches == null ? void 0 : matches.filter((match) => {
-      var _a2;
-      return ((_a2 = match == null ? void 0 : match.route.routeRefs) == null ? void 0 : _a2.size) > 0;
+      var _a;
+      return ((_a = match == null ? void 0 : match.route.routeRefs) == null ? void 0 : _a.size) > 0;
     }).pop();
     const routeObject = routeMatch == null ? void 0 : routeMatch.route;
     if (!routeObject) {
@@ -2024,6 +2023,10 @@ const getExtensionContext = (pathname, routes) => {
     if (routeObject.routeRefs.size === 1) {
       routeRef = routeObject.routeRefs.values().next().value;
     }
+    let plugin;
+    if (routeObject.plugins.size === 1) {
+      plugin = routeObject.plugins.values().next().value;
+    }
     const params = Object.entries(
       (routeMatch == null ? void 0 : routeMatch.params) || {}
     ).reduce((acc, [key, value]) => {
@@ -2034,8 +2037,9 @@ const getExtensionContext = (pathname, routes) => {
     }, {});
     return {
       extension: "App",
-      pluginId: ((_a = routeObject.plugin) == null ? void 0 : _a.getId()) || "root",
+      pluginId: (plugin == null ? void 0 : plugin.getId()) || "root",
       ...routeRef ? { routeRef: routeRef.id } : {},
+      _routeNodeType: routeObject.element,
       params
     };
   } catch {
@@ -2252,7 +2256,8 @@ const MATCH_ALL_ROUTE = {
   path: "*",
   element: "match-all",
   // These elements aren't used, so we add in a bit of debug information
-  routeRefs: /* @__PURE__ */ new Set()
+  routeRefs: /* @__PURE__ */ new Set(),
+  plugins: /* @__PURE__ */ new Set()
 };
 function stringifyNode(node) {
   var _a, _b;
@@ -2262,6 +2267,13 @@ function stringifyNode(node) {
   }
   return String(anyNode);
 }
+const pluginSet = (plugin) => {
+  const set = /* @__PURE__ */ new Set();
+  if (plugin) {
+    set.add(plugin);
+  }
+  return set;
+};
 function collectSubTree(node, entries = new Array()) {
   Children.forEach(node, (element) => {
     if (!isValidElement(element)) {
@@ -2283,7 +2295,7 @@ const routingV2Collector = createCollector(
     objects: new Array()
   }),
   (acc, node, parent, ctx) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     if (ctx == null ? void 0 : ctx.isElementAncestor) {
       return ctx;
     }
@@ -2322,7 +2334,7 @@ const routingV2Collector = createCollector(
           routeRefs: /* @__PURE__ */ new Set(),
           caseSensitive: Boolean((_d = node.props) == null ? void 0 : _d.caseSensitive),
           children: [MATCH_ALL_ROUTE],
-          plugin: void 0
+          plugins: /* @__PURE__ */ new Set()
         };
         parentChildren.push(newObj);
         return {
@@ -2349,7 +2361,7 @@ const routingV2Collector = createCollector(
           routeRefs: /* @__PURE__ */ new Set([routeRef]),
           caseSensitive: Boolean((_e = node.props) == null ? void 0 : _e.caseSensitive),
           children: [MATCH_ALL_ROUTE],
-          plugin
+          plugins: pluginSet(plugin)
         };
         parentChildren.push(newObj);
         acc.paths.set(routeRef, path);
@@ -2371,6 +2383,13 @@ const routingV2Collector = createCollector(
         );
       }
       (_f = ctx == null ? void 0 : ctx.obj) == null ? void 0 : _f.routeRefs.add(mountPoint);
+      const mountPointPlugin = getComponentData(
+        node,
+        "core.plugin"
+      );
+      if (mountPointPlugin) {
+        (_g = ctx == null ? void 0 : ctx.obj) == null ? void 0 : _g.plugins.add(mountPointPlugin);
+      }
       acc.paths.set(mountPoint, ctx.gatherPath);
       acc.parents.set(mountPoint, ctx == null ? void 0 : ctx.gatherRouteRef);
       return {
@@ -2440,9 +2459,11 @@ const routingV1Collector = createCollector(
           element: "mounted",
           routeRefs: /* @__PURE__ */ new Set([routeRef]),
           children: [MATCH_ALL_ROUTE],
-          plugin: getComponentData(
-            node.props.element,
-            "core.plugin"
+          plugins: pluginSet(
+            getComponentData(
+              node.props.element,
+              "core.plugin"
+            )
           )
         };
         parentChildren.push(currentObj);
@@ -2468,7 +2489,7 @@ const routingV1Collector = createCollector(
           element: "gathered",
           routeRefs: /* @__PURE__ */ new Set(),
           children: [MATCH_ALL_ROUTE],
-          plugin: (_e = ctx == null ? void 0 : ctx.obj) == null ? void 0 : _e.plugin
+          plugins: ((_e = ctx == null ? void 0 : ctx.obj) == null ? void 0 : _e.plugins) || /* @__PURE__ */ new Set()
         };
         parentChildren.push(currentObj);
       }