From 9ae4b9b6c2c2683889bf3fbaf9c77224e380677b Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sat, 10 Feb 2024 11:41:17 +0100
Subject: [PATCH] backend-plugin-api: simplify auth.credentials() types

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .../httpAuth/httpAuthServiceFactory.ts             |  9 ++-------
 packages/backend-plugin-api/api-report.md          | 11 +++--------
 .../src/services/definitions/HttpAuthService.ts    | 14 ++++----------
 3 files changed, 9 insertions(+), 25 deletions(-)

diff --git a/packages/backend-app-api/src/services/implementations/httpAuth/httpAuthServiceFactory.ts b/packages/backend-app-api/src/services/implementations/httpAuth/httpAuthServiceFactory.ts
index c7525acebb..79c74ffa9f 100644
--- a/packages/backend-app-api/src/services/implementations/httpAuth/httpAuthServiceFactory.ts
+++ b/packages/backend-app-api/src/services/implementations/httpAuth/httpAuthServiceFactory.ts
@@ -98,19 +98,14 @@ class DefaultHttpAuthService implements HttpAuthService {
 
   async credentials<
     TAllowed extends
-      | keyof BackstageHttpAccessToPrincipalTypesMapping
-      | undefined = undefined,
+      | keyof BackstageHttpAccessToPrincipalTypesMapping = 'unknown',
   >(
     req: Request,
     options?: {
       allow: Array<TAllowed>;
     },
   ): Promise<
-    BackstageCredentials<
-      TAllowed extends keyof BackstageHttpAccessToPrincipalTypesMapping
-        ? BackstageHttpAccessToPrincipalTypesMapping[TAllowed]
-        : unknown
-    >
+    BackstageCredentials<BackstageHttpAccessToPrincipalTypesMapping[TAllowed]>
   > {
     const credentials = toInternalBackstageCredentials(
       await this.#getCredentials(req),
diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md
index 81579fb0e9..a3e5930375 100644
--- a/packages/backend-plugin-api/api-report.md
+++ b/packages/backend-plugin-api/api-report.md
@@ -105,6 +105,7 @@ export type BackstageHttpAccessToPrincipalTypesMapping = {
   'user-cookie': BackstageUserPrincipal;
   service: BackstageServicePrincipal;
   unauthenticated: BackstageNonePrincipal;
+  unknown: unknown;
 };
 
 // @public (undocumented)
@@ -292,20 +293,14 @@ export interface ExtensionPointConfig {
 export interface HttpAuthService {
   // (undocumented)
   credentials<
-    TAllowed extends
-      | keyof BackstageHttpAccessToPrincipalTypesMapping
-      | undefined = undefined,
+    TAllowed extends keyof BackstageHttpAccessToPrincipalTypesMapping = 'unknown',
   >(
     req: Request_2,
     options?: {
       allow: Array<TAllowed>;
     },
   ): Promise<
-    BackstageCredentials<
-      TAllowed extends keyof BackstageHttpAccessToPrincipalTypesMapping
-        ? BackstageHttpAccessToPrincipalTypesMapping[TAllowed]
-        : unknown
-    >
+    BackstageCredentials<BackstageHttpAccessToPrincipalTypesMapping[TAllowed]>
   >;
   // (undocumented)
   issueUserCookie(res: Response_2): Promise<void>;
diff --git a/packages/backend-plugin-api/src/services/definitions/HttpAuthService.ts b/packages/backend-plugin-api/src/services/definitions/HttpAuthService.ts
index f84234932b..949ca1af0a 100644
--- a/packages/backend-plugin-api/src/services/definitions/HttpAuthService.ts
+++ b/packages/backend-plugin-api/src/services/definitions/HttpAuthService.ts
@@ -28,25 +28,19 @@ export type BackstageHttpAccessToPrincipalTypesMapping = {
   'user-cookie': BackstageUserPrincipal;
   service: BackstageServicePrincipal;
   unauthenticated: BackstageNonePrincipal;
+  unknown: unknown;
 };
 
 /** @public */
 export interface HttpAuthService {
   credentials<
     TAllowed extends
-      | keyof BackstageHttpAccessToPrincipalTypesMapping
-      | undefined = undefined,
+      | keyof BackstageHttpAccessToPrincipalTypesMapping = 'unknown',
   >(
     req: Request,
-    options?: {
-      allow: Array<TAllowed>;
-    },
+    options?: { allow: Array<TAllowed> },
   ): Promise<
-    BackstageCredentials<
-      TAllowed extends keyof BackstageHttpAccessToPrincipalTypesMapping
-        ? BackstageHttpAccessToPrincipalTypesMapping[TAllowed]
-        : unknown
-    >
+    BackstageCredentials<BackstageHttpAccessToPrincipalTypesMapping[TAllowed]>
   >;
 
   requestHeaders(options?: {