@backstage/core-app-api 1.1.1 → 1.2.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @backstage/core-app-api
 
+## 1.2.0-next.0
+
+### Minor Changes
+
+- 9b737e5f2e: Updated the React Router wiring to make use of the new `basename` property of the router components in React Router v6 stable. To implement this, a new optional `basename` property has been added to the `Router` app component, which can be forwarded to the concrete router implementation in order to support this new behavior. This is done by default in any app that does not have a `Router` component override.
+- 127fcad26d: Deprecated the `homepage` config as the component that used it - `HomepageTimer` - has been removed and replaced by the `HeaderWorldClock` in the home plugin
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.1.0-next.0
+  - @backstage/types@1.0.1-next.0
+  - @backstage/config@1.0.4-next.0
+  - @backstage/version-bridge@1.0.1
+
 ## 1.1.1
 
 ### Patch Changes

package/config.d.ts

@@ -89,6 +89,11 @@ export interface Config {
     name?: string;
   };
 
+  /**
+   * This config was used by the HomepageTimer but has been replaced  by the HeaderWorldClock in the home plugin
+   *
+   * @deprecated in favor of the HeaderWorldClock which is found in the home plugin
+   */
   homepage?: {
     clocks?: Array<{
       /** @visibility frontend */

package/dist/index.d.ts

@@ -590,7 +590,9 @@ declare type AppComponents = {
     NotFoundErrorPage: ComponentType<{}>;
     BootErrorPage: ComponentType<BootErrorPageProps>;
     Progress: ComponentType<{}>;
-    Router: ComponentType<{}>;
+    Router: ComponentType<{
+        basename?: string;
+    }>;
     ErrorBoundaryFallback: ComponentType<ErrorBoundaryFallbackProps>;
     ThemeProvider?: ComponentType<{}>;
     /**

package/dist/index.esm.js

@@ -2513,6 +2513,12 @@ function isReactRouterBeta() {
 
 const InternalAppContext = createContext({ routeObjects: [] });
 function getBasePath(configApi) {
+  if (!isReactRouterBeta()) {
+    return "";
+  }
+  return readBasePath(configApi);
+}
+function readBasePath(configApi) {
   var _a;
   let { pathname } = new URL(
     (_a = configApi.getOptionalString("app.baseUrl")) != null ? _a : "/",
@@ -2702,7 +2708,7 @@ class AppManager {
     };
     const AppRouter = ({ children }) => {
       const configApi = useApi(configApiRef);
-      const basePath = getBasePath(configApi);
+      const basePath = readBasePath(configApi);
       const mountPath = `${basePath}/*`;
       const { routeObjects } = useContext(InternalAppContext);
       if (!SignInPageComponent) {
@@ -2729,21 +2735,37 @@ class AppManager {
           },
           { signOutTargetUrl: basePath || "/" }
         );
+        if (isReactRouterBeta()) {
+          return /* @__PURE__ */ React.createElement(RouterComponent, null, /* @__PURE__ */ React.createElement(RouteTracker, {
+            routeObjects
+          }), /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {
+            path: mountPath,
+            element: /* @__PURE__ */ React.createElement(React.Fragment, null, children)
+          })));
+        }
+        return /* @__PURE__ */ React.createElement(RouterComponent, {
+          basename: basePath
+        }, /* @__PURE__ */ React.createElement(RouteTracker, {
+          routeObjects
+        }), children);
+      }
+      if (isReactRouterBeta()) {
         return /* @__PURE__ */ React.createElement(RouterComponent, null, /* @__PURE__ */ React.createElement(RouteTracker, {
           routeObjects
-        }), /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {
+        }), /* @__PURE__ */ React.createElement(SignInPageWrapper, {
+          component: SignInPageComponent
+        }, /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {
           path: mountPath,
           element: /* @__PURE__ */ React.createElement(React.Fragment, null, children)
-        })));
+        }))));
       }
-      return /* @__PURE__ */ React.createElement(RouterComponent, null, /* @__PURE__ */ React.createElement(RouteTracker, {
+      return /* @__PURE__ */ React.createElement(RouterComponent, {
+        basename: basePath
+      }, /* @__PURE__ */ React.createElement(RouteTracker, {
         routeObjects
       }), /* @__PURE__ */ React.createElement(SignInPageWrapper, {
         component: SignInPageComponent
-      }, /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {
-        path: mountPath,
-        element: /* @__PURE__ */ React.createElement(React.Fragment, null, children)
-      }))));
+      }, /* @__PURE__ */ React.createElement(React.Fragment, null, children)));
     };
     return AppRouter;
   }