@backstage/core-app-api 1.8.0 → 1.8.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/core-app-api
 
+## 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,8 +117,8 @@ 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;

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