From 35452b36503561d6cb3bfaddc87ceabb3c70d5f7 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Tue, 9 Apr 2024 14:27:12 +0200
Subject: [PATCH] frontend-plugin-api: fix useRouteRef types for optional
 external route refs

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .changeset/tiny-pens-boil.md                             | 5 +++++
 packages/frontend-plugin-api/api-report.md               | 2 +-
 packages/frontend-plugin-api/src/routing/useRouteRef.tsx | 2 +-
 3 files changed, 7 insertions(+), 2 deletions(-)
 create mode 100644 .changeset/tiny-pens-boil.md

diff --git a/.changeset/tiny-pens-boil.md b/.changeset/tiny-pens-boil.md
new file mode 100644
index 0000000000..57974c498f
--- /dev/null
+++ b/.changeset/tiny-pens-boil.md
@@ -0,0 +1,5 @@
+---
+'@backstage/frontend-plugin-api': patch
+---
+
+Fixed the type for `useRouteRef`, which wasn't handling optional external route refs correctly.
diff --git a/packages/frontend-plugin-api/api-report.md b/packages/frontend-plugin-api/api-report.md
index d849fecf50..3e19573d95 100644
--- a/packages/frontend-plugin-api/api-report.md
+++ b/packages/frontend-plugin-api/api-report.md
@@ -1155,7 +1155,7 @@ export function useRouteRef<
   TParams extends AnyRouteRefParams,
 >(
   routeRef: ExternalRouteRef<TParams, TOptional>,
-): TParams extends true ? RouteFunc<TParams> | undefined : RouteFunc<TParams>;
+): TOptional extends true ? RouteFunc<TParams> | undefined : RouteFunc<TParams>;
 
 // @public
 export function useRouteRef<TParams extends AnyRouteRefParams>(
diff --git a/packages/frontend-plugin-api/src/routing/useRouteRef.tsx b/packages/frontend-plugin-api/src/routing/useRouteRef.tsx
index 1b096a6b5d..fdf831953d 100644
--- a/packages/frontend-plugin-api/src/routing/useRouteRef.tsx
+++ b/packages/frontend-plugin-api/src/routing/useRouteRef.tsx
@@ -38,7 +38,7 @@ export function useRouteRef<
   TParams extends AnyRouteRefParams,
 >(
   routeRef: ExternalRouteRef<TParams, TOptional>,
-): TParams extends true ? RouteFunc<TParams> | undefined : RouteFunc<TParams>;
+): TOptional extends true ? RouteFunc<TParams> | undefined : RouteFunc<TParams>;
 
 /**
  * React hook for constructing URLs to routes.