Merge b17c958 into 344bd88

Author: avolkovi

common/api-review/auth-exp.api.md

@@ -40,17 +40,18 @@ export function applyActionCode(auth: externs.Auth, oobCode: string): Promise<vo
 
 // @public (undocumented)
 export class AuthCredential {
+    // @internal
     protected constructor(providerId: string, signInMethod: string);
     // Warning: (ae-forgotten-export) The symbol "Auth" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
     //
-    // (undocumented)
+    // @internal (undocumented)
     _getIdTokenResponse(_auth: Auth_2): Promise<PhoneOrOauthTokenResponse>;
-    // (undocumented)
+    // @internal (undocumented)
     _getReauthenticationResolver(_auth: Auth_2): Promise<IdTokenResponse>;
     // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
     //
-    // (undocumented)
+    // @internal (undocumented)
     _linkToIdToken(_auth: Auth_2, _idToken: string): Promise<IdTokenResponse>;
     // (undocumented)
     readonly providerId: string;
@@ -78,24 +79,27 @@ export function confirmPasswordReset(auth: externs.Auth, oobCode: string, newPas
 // @public (undocumented)
 export function createUserWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise<externs.UserCredential>;
 
+// @public
+export type CustomParameters = Record<string, string>;
+
 // @public (undocumented)
 export function deleteUser(user: externs.User): Promise<void>;
 
-// @public (undocumented)
+// @public
 export class EmailAuthCredential extends AuthCredential implements externs.AuthCredential {
     // (undocumented)
     readonly email: string;
-    // (undocumented)
+    // @internal (undocumented)
     static _fromEmailAndCode(email: string, oobCode: string, tenantId?: string | null): EmailAuthCredential;
-    // (undocumented)
+    // @internal (undocumented)
     static _fromEmailAndPassword(email: string, password: string): EmailAuthCredential;
     // (undocumented)
     static fromJSON(json: object | string): EmailAuthCredential | null;
-    // (undocumented)
+    // @internal (undocumented)
     _getIdTokenResponse(auth: Auth_2): Promise<IdTokenResponse>;
-    // (undocumented)
+    // @internal (undocumented)
     _getReauthenticationResolver(auth: Auth_2): Promise<IdTokenResponse>;
-    // (undocumented)
+    // @internal (undocumented)
     _linkToIdToken(auth: Auth_2, idToken: string): Promise<IdTokenResponse>;
     // (undocumented)
     readonly password: string;
@@ -121,19 +125,15 @@ export class EmailAuthProvider implements externs.EmailAuthProvider {
     readonly providerId = externs.ProviderId.PASSWORD;
 }
 
-// @public (undocumented)
+// @public
 export class FacebookAuthProvider extends OAuthProvider {
-    // (undocumented)
     static credential(accessToken: string): externs.OAuthCredential;
     // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
     // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
-    // (undocumented)
     static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK;
-    // (undocumented)
     static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK;
-    // (undocumented)
     readonly providerId = externs.ProviderId.FACEBOOK;
 }
 
@@ -158,35 +158,27 @@ export function getMultiFactorResolver(auth: externs.Auth, errorExtern: externs.
 // @public (undocumented)
 export function getRedirectResult(authExtern: externs.Auth, resolverExtern?: externs.PopupRedirectResolver): Promise<externs.UserCredential | null>;
 
-// @public (undocumented)
+// @public
 export class GithubAuthProvider extends OAuthProvider {
-    // (undocumented)
     static credential(accessToken: string): externs.OAuthCredential;
     // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
     // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
-    // (undocumented)
     static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB;
-    // (undocumented)
     static readonly PROVIDER_ID = externs.ProviderId.GITHUB;
-    // (undocumented)
     readonly providerId = externs.ProviderId.GITHUB;
 }
 
-// @public (undocumented)
+// @public
 export class GoogleAuthProvider extends OAuthProvider {
-    // (undocumented)
     static credential(idToken?: string | null, accessToken?: string | null): externs.OAuthCredential;
     // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
     // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
-    // (undocumented)
     static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE;
-    // (undocumented)
     static readonly PROVIDER_ID = externs.ProviderId.GOOGLE;
-    // (undocumented)
     readonly providerId = externs.ProviderId.GOOGLE;
 }
 
@@ -221,54 +213,43 @@ export function multiFactor(user: externs.User): externs.MultiFactorUser;
 
 // @public (undocumented)
 export class OAuthCredential extends AuthCredential implements externs.OAuthCredential {
-    // (undocumented)
     accessToken?: string;
     // (undocumented)
     static fromJSON(json: string | object): OAuthCredential | null;
     // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
     //
-    // (undocumented)
+    // @internal (undocumented)
     static _fromParams(params: OAuthCredentialParams): OAuthCredential;
-    // (undocumented)
+    // @internal (undocumented)
     _getIdTokenResponse(auth: Auth_2): Promise<IdTokenResponse>;
-    // (undocumented)
+    // @internal (undocumented)
     _getReauthenticationResolver(auth: Auth_2): Promise<IdTokenResponse>;
     // (undocumented)
     idToken?: string;
-    // (undocumented)
+    // @internal (undocumented)
     _linkToIdToken(auth: Auth_2, idToken: string): Promise<IdTokenResponse>;
-    // (undocumented)
+    // @internal (undocumented)
     nonce?: string;
-    // (undocumented)
     secret?: string;
     // (undocumented)
     toJSON(): object;
 }
 
-// @public (undocumented)
+// @public
 export class OAuthProvider implements externs.AuthProvider {
     constructor(providerId: string);
-    // (undocumented)
     addScope(scope: string): externs.AuthProvider;
-    // Warning: (ae-forgotten-export) The symbol "CredentialParameters" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    credential(params: CredentialParameters): externs.OAuthCredential;
+    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialOptions" needs to be exported by the entry point index.d.ts
+    credential(params: OAuthCredentialOptions): externs.OAuthCredential;
     // (undocumented)
     static credentialFromJSON(json: object | string): externs.OAuthCredential;
-    // (undocumented)
+    // @internal (undocumented)
     defaultLanguageCode: string | null;
-    // (undocumented)
     getCustomParameters(): CustomParameters;
-    // (undocumented)
     getScopes(): string[];
     // (undocumented)
     readonly providerId: string;
-    // Warning: (ae-forgotten-export) The symbol "CustomParameters" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
     setCustomParameters(customOAuthParameters: CustomParameters): externs.AuthProvider;
-    // (undocumented)
     setDefaultLanguage(languageCode: string | null): void;
 }
 
@@ -402,9 +383,8 @@ export function signInWithRedirect(authExtern: externs.Auth, provider: externs.A
 // @public (undocumented)
 export function signOut(auth: externs.Auth): Promise<void>;
 
-// @public (undocumented)
+// @public
 export class TwitterAuthProvider extends OAuthProvider {
-    // (undocumented)
     static credential(token: string, secret: string): externs.OAuthCredential;
     // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;

common/api-review/functions-exp.api.md

@@ -16,7 +16,7 @@ export function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): F
 export function httpsCallable(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable;
 
 // @public
-export function useFunctionsEmulator(functionsInstance: Functions, origin: string): void;
+export function useFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
 
 
 // (No @packageDocumentation comment for this package)

docs-exp/auth-types.auth.md

@@ -33,7 +33,7 @@ export interface Auth
 |  [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. |
 |  [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.<!-- -->This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. |
 |  [signOut()](./auth-types.auth.signout.md) | Signs out the current user. |
-|  [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as <code>currentUser</code> on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.<!-- -->This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.<!-- -->The operation fails with an error if the user to be updated belongs to a different Firebase project. |
+|  [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. A new instance copy of the user provided will be made and set as currentUser.<!-- -->This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.<!-- -->The operation fails with an error if the user to be updated belongs to a different Firebase project. |
 |  [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. |
-|  [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to <code>initializeAuth()</code>. Do not use with production credentials as emulator traffic is not encrypted. |
+|  [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to [initializeAuth()](./auth.initializeauth.md)<!-- -->. Do not use with production credentials as emulator traffic is not encrypted. |
 

docs-exp/auth-types.auth.updatecurrentuser.md

@@ -4,7 +4,7 @@
 
 ## Auth.updateCurrentUser() method
 
-Asynchronously sets the provided user as `currentUser` on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.
+Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. A new instance copy of the user provided will be made and set as currentUser.
 
 This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.
 

docs-exp/auth-types.auth.useemulator.md

@@ -4,7 +4,7 @@
 
 ## Auth.useEmulator() method
 
-Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to `initializeAuth()`<!-- -->. Do not use with production credentials as emulator traffic is not encrypted.
+Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to [initializeAuth()](./auth.initializeauth.md)<!-- -->. Do not use with production credentials as emulator traffic is not encrypted.
 
 <b>Signature:</b>
 

docs-exp/auth-types.authcredential.md

@@ -4,7 +4,7 @@
 
 ## AuthCredential class
 
-Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
+Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md)<!-- -->. Implementations specify the details about each auth provider's credential requirements.
 
 <b>Signature:</b>
 
@@ -17,7 +17,7 @@ export abstract class AuthCredential
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [providerId](./auth-types.authcredential.providerid.md) |  | string | The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'. |
-|  [signInMethod](./auth-types.authcredential.signinmethod.md) |  | string | The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md)<!-- -->, or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md)<!-- -->. This corresponds to the sign-in method identifier as returned in <code>fetchSignInMethodsForEmail</code>. |
+|  [signInMethod](./auth-types.authcredential.signinmethod.md) |  | string | The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md)<!-- -->, or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md)<!-- -->. This corresponds to the sign-in method identifier as returned in [fetchSignInMethodsForEmail()](./auth.fetchsigninmethodsforemail.md)<!-- -->. |
 
 ## Methods
 

docs-exp/auth-types.authcredential.signinmethod.md

@@ -4,7 +4,7 @@
 
 ## AuthCredential.signInMethod property
 
-The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md)<!-- -->, or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md)<!-- -->. This corresponds to the sign-in method identifier as returned in `fetchSignInMethodsForEmail`<!-- -->.
+The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md)<!-- -->, or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md)<!-- -->. This corresponds to the sign-in method identifier as returned in [fetchSignInMethodsForEmail()](./auth.fetchsigninmethodsforemail.md)<!-- -->.
 
 <b>Signature:</b>
 

docs-exp/auth-types.autherror.md

@@ -19,5 +19,5 @@ export interface AuthError extends FirebaseError
 |  [appName](./auth-types.autherror.appname.md) | string | The name of the Firebase App which triggered this error. |
 |  [email](./auth-types.autherror.email.md) | string | The email of the user's account, used for sign-in/linking. |
 |  [phoneNumber](./auth-types.autherror.phonenumber.md) | string | The phone number of the user's account, used for sign-in/linking. |
-|  [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. If you use <code>signInWithRedirect</code> to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. |
+|  [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. If you use [signInWithRedirect()](./auth.signinwithredirect.md) to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. |
 

docs-exp/auth-types.autherror.tenantid.md

@@ -4,7 +4,7 @@
 
 ## AuthError.tenantid property
 
-The tenant ID being used for sign-in/linking. If you use `signInWithRedirect` to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection.
+The tenant ID being used for sign-in/linking. If you use [signInWithRedirect()](./auth.signinwithredirect.md) to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection.
 
 <b>Signature:</b>
 

docs-exp/auth-types.emailauthprovider.md

@@ -4,7 +4,7 @@
 
 ## EmailAuthProvider class
 
-Email and password auth provider implementation.
+Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md)<!-- -->.
 
 <b>Signature:</b>
 

docs-exp/auth-types.idtokenresult.md

@@ -4,7 +4,7 @@
 
 ## IdTokenResult interface
 
-Interface representing ID token result obtained from `getIdTokenResult`<!-- -->. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.
+Interface representing ID token result obtained from [User.getIdTokenResult()](./auth-types.user.getidtokenresult.md)<!-- -->. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.
 
 Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims.