Add new auth type hierarchies from the main branch

Author: lahirumaramba

etc/firebase-admin.auth.api.md

@@ -32,11 +32,7 @@ export class Auth extends BaseAuth {
 export type AuthFactorType = 'phone';
 
 // @public
-export interface AuthProviderConfig {
-    displayName?: string;
-    enabled: boolean;
-    providerId: string;
-}
+export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;
 
 // @public
 export interface AuthProviderConfigFilter {
@@ -75,13 +71,12 @@ export abstract class BaseAuth {
 }
 
 // @public
-export interface CreateMultiFactorInfoRequest {
-    displayName?: string;
-    factorId: string;
-}
+export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;
 
+// Warning: (ae-forgotten-export) The symbol "BaseCreateMultiFactorInfoRequest" needs to be exported by the entry point index.d.ts
+//
 // @public
-export interface CreatePhoneMultiFactorInfoRequest extends CreateMultiFactorInfoRequest {
+export interface CreatePhoneMultiFactorInfoRequest extends BaseCreateMultiFactorInfoRequest {
     phoneNumber: string;
 }
 
@@ -204,18 +199,25 @@ export interface MultiFactorUpdateSettings {
     enrolledFactors: UpdateMultiFactorInfoRequest[] | null;
 }
 
+// Warning: (ae-forgotten-export) The symbol "BaseAuthProviderConfig" needs to be exported by the entry point index.d.ts
+//
 // @public
-export interface OIDCAuthProviderConfig extends AuthProviderConfig {
+export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig {
     clientId: string;
+    clientSecret?: string;
     issuer: string;
+    // Warning: (ae-forgotten-export) The symbol "OAuthResponseType" needs to be exported by the entry point index.d.ts
+    responseType?: OAuthResponseType;
 }
 
 // @public
 export interface OIDCUpdateAuthProviderRequest {
     clientId?: string;
+    clientSecret?: string;
     displayName?: string;
     enabled?: boolean;
     issuer?: string;
+    responseType?: OAuthResponseType;
 }
 
 // @public
@@ -239,7 +241,7 @@ export interface ProviderIdentifier {
 }
 
 // @public
-export interface SAMLAuthProviderConfig extends AuthProviderConfig {
+export interface SAMLAuthProviderConfig extends BaseAuthProviderConfig {
     callbackURL?: string;
     idpEntityId: string;
     rpEntityId: string;
@@ -305,15 +307,12 @@ export interface UidIdentifier {
 export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;
 
 // @public
-export interface UpdateMultiFactorInfoRequest {
-    displayName?: string;
-    enrollmentTime?: string;
-    factorId: string;
-    uid?: string;
-}
+export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;
 
+// Warning: (ae-forgotten-export) The symbol "BaseUpdateMultiFactorInfoRequest" needs to be exported by the entry point index.d.ts
+//
 // @public
-export interface UpdatePhoneMultiFactorInfoRequest extends UpdateMultiFactorInfoRequest {
+export interface UpdatePhoneMultiFactorInfoRequest extends BaseUpdateMultiFactorInfoRequest {
     phoneNumber: string;
 }
 

src/auth/auth-config.ts

@@ -19,10 +19,10 @@ import { deepCopy } from '../utils/deep-copy';
 import { AuthClientErrorCode, FirebaseAuthError } from '../utils/error';
 
 /**
- * Interface representing base properties of a user enrolled second factor for a
+ * Interface representing base properties of a user-enrolled second factor for a
  * `CreateRequest`.
  */
-export interface CreateMultiFactorInfoRequest {
+export interface BaseCreateMultiFactorInfoRequest {
 
   /**
    * The optional display name for an enrolled second factor.
@@ -36,10 +36,10 @@ export interface CreateMultiFactorInfoRequest {
 }
 
 /**
- * Interface representing a phone specific user enrolled second factor for a
+ * Interface representing a phone specific user-enrolled second factor for a
  * `CreateRequest`.
  */
-export interface CreatePhoneMultiFactorInfoRequest extends CreateMultiFactorInfoRequest {
+export interface CreatePhoneMultiFactorInfoRequest extends BaseCreateMultiFactorInfoRequest {
 
   /**
    * The phone number associated with a phone second factor.
@@ -48,10 +48,16 @@ export interface CreatePhoneMultiFactorInfoRequest extends CreateMultiFactorInfo
 }
 
 /**
- * Interface representing common properties of a user enrolled second factor
+ * Type representing the properties of a user-enrolled second factor
+ * for a `CreateRequest`.
+ */
+export type CreateMultiFactorInfoRequest = | CreatePhoneMultiFactorInfoRequest;
+
+/**
+ * Interface representing common properties of a user-enrolled second factor
  * for an `UpdateRequest`.
  */
-export interface UpdateMultiFactorInfoRequest {
+export interface BaseUpdateMultiFactorInfoRequest {
 
   /**
    * The ID of the enrolled second factor. This ID is unique to the user. When not provided,
@@ -76,17 +82,23 @@ export interface UpdateMultiFactorInfoRequest {
 }
 
 /**
- * Interface representing a phone specific user enrolled second factor
+ * Interface representing a phone specific user-enrolled second factor
  * for an `UpdateRequest`.
  */
-export interface UpdatePhoneMultiFactorInfoRequest extends UpdateMultiFactorInfoRequest {
+export interface UpdatePhoneMultiFactorInfoRequest extends BaseUpdateMultiFactorInfoRequest {
 
   /**
    * The phone number associated with a phone second factor.
    */
   phoneNumber: string;
 }
 
+/**
+ * Type representing the properties of a user-enrolled second factor
+ * for an `UpdateRequest`.
+ */
+export type UpdateMultiFactorInfoRequest = | UpdatePhoneMultiFactorInfoRequest;
+
 /**
  * The multi-factor related user settings for create operations.
  */
@@ -357,6 +369,17 @@ export interface OIDCUpdateAuthProviderRequest {
    * configuration's value is not modified.
    */
   issuer?: string;
+
+  /**
+   * The OIDC provider's client secret to enable OIDC code flow.
+   * If not provided, the existing configuration's value is not modified.
+   */
+  clientSecret?: string;
+
+  /**
+   * The OIDC provider's response object for OAuth authorization flow.
+   */
+  responseType?: OAuthResponseType;
 }
 
 export type UpdateAuthProviderRequest =
@@ -768,7 +791,7 @@ export class EmailSignInConfig implements EmailSignInProviderConfig {
 /**
  * The base Auth provider configuration interface.
  */
-export interface AuthProviderConfig {
+export interface BaseAuthProviderConfig {
 
   /**
    * The provider ID defined by the developer.
@@ -796,7 +819,7 @@ export interface AuthProviderConfig {
  * Auth provider configuration interface. A SAML provider can be created via
  * {@link auth.Auth.createProviderConfig `createProviderConfig()`}.
  */
-export interface SAMLAuthProviderConfig extends AuthProviderConfig {
+export interface SAMLAuthProviderConfig extends BaseAuthProviderConfig {
 
   /**
    * The SAML IdP entity identifier.
@@ -862,7 +885,7 @@ export interface OAuthResponseType {
  * provider configuration interface. An OIDC provider can be created via
  * {@link auth.Auth.createProviderConfig `createProviderConfig()`}.
  */
-export interface OIDCAuthProviderConfig extends AuthProviderConfig {
+export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig {
 
   /**
    * This is the required client ID used to confirm the audience of an OIDC
@@ -889,8 +912,23 @@ export interface OIDCAuthProviderConfig extends AuthProviderConfig {
    * [spec](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
    */
   issuer: string;
+
+  /**
+   * The OIDC provider's client secret to enable OIDC code flow.
+   */
+  clientSecret?: string;
+
+  /**
+   * The OIDC provider's response object for OAuth authorization flow.
+   */
+  responseType?: OAuthResponseType;
 }
 
+/**
+ * The Auth provider configuration type.
+ * {@link auth.Auth.createProviderConfig `createProviderConfig()`}.
+ */
+export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;
 
 /**
  * Defines the SAMLConfig class used to convert a client side configuration to its

src/auth/user-record.ts

@@ -87,7 +87,7 @@ enum MultiFactorId {
 }
 
 /**
- * Interface representing the common properties of a user enrolled second factor.
+ * Interface representing the common properties of a user-enrolled second factor.
  */
 export abstract class MultiFactorInfo {
 
@@ -194,7 +194,7 @@ export abstract class MultiFactorInfo {
 }
 
 /**
- * Interface representing a phone specific user enrolled second factor.
+ * Interface representing a phone specific user-enrolled second factor.
  */
 export class PhoneMultiFactorInfo extends MultiFactorInfo {