backend-plugin-api: simplify auth.credentials() types

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-02-10 11:41:17 +01:00
parent a19ef483f1
commit 9ae4b9b6c2
3 changed files with 9 additions and 25 deletions
+3 -8
View File
@@ -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>;
@@ -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?: {