From 00185a37bc554f9bcb6feb6434d6c9c75ed51a3a Mon Sep 17 00:00:00 2001 From: Paul Rostorp Date: Sat, 25 Feb 2023 23:14:25 +0100 Subject: [PATCH] fix(auth, types): add `OIDCProvider` to typescript declaration (#6936) --- packages/auth/lib/index.d.ts | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/packages/auth/lib/index.d.ts b/packages/auth/lib/index.d.ts index ab41d09a00..30d2bebf97 100644 --- a/packages/auth/lib/index.d.ts +++ b/packages/auth/lib/index.d.ts @@ -109,6 +109,24 @@ export namespace FirebaseAuthTypes { credential: (token: string | null, secret?: string) => AuthCredential; } + /** + * Interface that represents an Open ID Connect auth provider. Implemented by other providers. + */ + export interface OIDCProvider { + /** + * The provider ID of the provider. + */ + PROVIDER_ID: string; + /** + * Creates a new `OIDCProvider`. + * + * @returns {@link auth.AuthCredential}. + * @param oidcSuffix this is the "Provider ID" value from the firebase console fx `azure_test`. + * @param token A provider token. + */ + credential: (oidcSuffix: string, idToken: string) => AuthCredential; + } + /** * Email and password auth provider implementation. */ @@ -298,6 +316,16 @@ export namespace FirebaseAuthTypes { * ``` */ OAuthProvider: AuthProvider; + /** + * Custom Open ID connect auth provider implementation. + * + * #### Example + * + * ```js + * firebase.auth.OIDCAuthProvider; + * ``` + */ + OIDCAuthProvider: OIDCProvider; /** * A PhoneAuthState interface. *