More docs + PR feedback

Author: avolkovi

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

@@ -28,7 +28,6 @@ export interface ActionCodeSettings {
     minimumVersion?: string;
     packageName: string;
   };
-  // (undocumented)
   dynamicLinkDomain?: string;
   handleCodeInApp?: boolean;
   iOS?: {
@@ -50,13 +49,9 @@ export abstract class ActionCodeURL {
 
 // @public
 export interface AdditionalUserInfo {
-  // (undocumented)
   readonly isNewUser: boolean;
-  // (undocumented)
   readonly profile: UserProfile | null;
-  // (undocumented)
   readonly providerId: ProviderId | null;
-  // (undocumented)
   readonly username?: string | null;
 }
 
@@ -99,24 +94,19 @@ export abstract class AuthCredential {
 
   readonly signInMethod: string;
 
-  // (undocumented)
   toJSON(): object;
 }
 
 // @public (undocumented)
 export interface AuthError extends FirebaseError {
   readonly appName: string;
-
   readonly email?: string;
-
   readonly phoneNumber?: string;
-
   readonly tenantid?: string;
 }
 
 // @public
 export interface AuthProvider {
-  // (undocumented)
   readonly providerId: string;
 }
 
@@ -127,17 +117,11 @@ export interface AuthSettings {
 
 // @public
 export interface Config {
-  // (undocumented)
   apiHost: string;
-  // (undocumented)
   apiKey: string;
-  // (undocumented)
   apiScheme: string;
-  // (undocumented)
   authDomain?: string;
-  // (undocumented)
   sdkClientVersion: string;
-  // (undocumented)
   tokenApiHost: string;
 }
 
@@ -149,20 +133,15 @@ export interface ConfirmationResult {
 
 // @public
 export abstract class EmailAuthProvider implements AuthProvider {
-  // (undocumented)
   static credential(email: string, password: string): AuthCredential;
   static credentialWithLink(
     auth: Auth,
     email: string,
     emailLink: string
   ): AuthCredential;
-  // (undocumented)
   static readonly EMAIL_LINK_SIGN_IN_METHOD: SignInMethod;
-  // (undocumented)
   static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: SignInMethod;
-  // (undocumented)
   static readonly PROVIDER_ID: ProviderId;
-  // (undocumented)
   readonly providerId: ProviderId;
 }
 
@@ -184,9 +163,7 @@ export interface MultiFactorAssertion {
 
 // @public
 export interface MultiFactorError extends AuthError {
-  // (undocumented)
   readonly credential: AuthCredential;
-  // (undocumented)
   readonly operationType: OperationType;
 }
 
@@ -219,7 +196,7 @@ export interface MultiFactorUser {
   unenroll(option: MultiFactorInfo | string): Promise<void>;
 }
 
-// @public (undocumented)
+// @public
 export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
 
 // @public
@@ -245,36 +222,26 @@ export const enum Operation {
 
 // @public
 export const enum OperationType {
-  // (undocumented)
   LINK = 'link',
-  // (undocumented)
   REAUTHENTICATE = 'reauthenticate',
-  // (undocumented)
   SIGN_IN = 'signIn'
 }
 
 // @public
 export interface ParsedToken {
-  // (undocumented)
   [key: string]: string | object | undefined;
-  // (undocumented)
   'auth_time'?: string;
-  // (undocumented)
   'exp'?: string;
-  // (undocumented)
   'firebase'?: {
     'sign_in_provider'?: string;
     'sign_in_second_factor'?: string;
   };
-  // (undocumented)
   'iat'?: string;
-  // (undocumented)
   'sub'?: string;
 }
 
 // @public
 export interface Persistence {
-  // (undocumented)
   readonly type: 'SESSION' | 'LOCAL' | 'NONE';
 }
 
@@ -290,11 +257,8 @@ export class PhoneAuthProvider implements AuthProvider {
     verificationId: string,
     verificationCode: string
   ): AuthCredential;
-  // (undocumented)
   static readonly PHONE_SIGN_IN_METHOD: SignInMethod;
-  // (undocumented)
   static readonly PROVIDER_ID: ProviderId;
-  // (undocumented)
   readonly providerId: ProviderId;
   verifyPhoneNumber(
     phoneInfoOptions: PhoneInfoOptions | string,
@@ -311,11 +275,9 @@ export type PhoneInfoOptions =
 // @public
 export interface PhoneMultiFactorAssertion extends MultiFactorAssertion {}
 
-// @public (undocumented)
+// @public
 export interface PhoneMultiFactorEnrollInfoOptions {
-  // (undocumented)
   phoneNumber: string;
-  // (undocumented)
   session: MultiFactorSession;
 }
 
@@ -327,19 +289,15 @@ export abstract class PhoneMultiFactorGenerator {
   static FACTOR_ID: ProviderId;
 }
 
-// @public (undocumented)
+// @public
 export interface PhoneMultiFactorSignInInfoOptions {
-  // (undocumented)
   multiFactorHint?: MultiFactorInfo;
-  // (undocumented)
   multiFactorUid?: string;
-  // (undocumented)
   session: MultiFactorSession;
 }
 
-// @public (undocumented)
+// @public
 export interface PhoneSingleFactorInfoOptions {
-  // (undocumented)
   phoneNumber: string;
 }
 
@@ -368,13 +326,10 @@ export const enum ProviderId {
   TWITTER = 'twitter.com'
 }
 
-// @public (undocumented)
+// @public
 export interface ReactNativeAsyncStorage {
-  // (undocumented)
   getItem(key: string): Promise<string | null>;
-  // (undocumented)
   removeItem(key: string): Promise<void>;
-  // (undocumented)
   setItem(key: string, value: string): Promise<void>;
 }
 
@@ -414,18 +369,12 @@ export const enum SignInMethod {
 // @public
 export interface User extends UserInfo {
   delete(): Promise<void>;
-  // (undocumented)
   readonly emailVerified: boolean;
   getIdToken(forceRefresh?: boolean): Promise<string>;
-  // (undocumented)
   getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
-  // (undocumented)
   readonly isAnonymous: boolean;
-  // (undocumented)
   readonly metadata: UserMetadata;
-  // (undocumented)
   readonly providerData: UserInfo[];
-  // (undocumented)
   readonly refreshToken: string;
   reload(): Promise<void>;
   readonly tenantId: string | null;
@@ -434,33 +383,24 @@ export interface User extends UserInfo {
 
 // @public
 export interface UserCredential {
-  // (undocumented)
   operationType: OperationType;
-  // (undocumented)
   providerId: ProviderId | null;
-  // (undocumented)
   user: User;
 }
 
 // @public
 export interface UserInfo {
-  // (undocumented)
   readonly displayName: string | null;
-  // (undocumented)
   readonly email: string | null;
   readonly phoneNumber: string | null;
-  // (undocumented)
   readonly photoURL: string | null;
-  // (undocumented)
   readonly providerId: string;
   readonly uid: string;
 }
 
 // @public
 export interface UserMetadata {
-  // (undocumented)
   readonly creationTime?: string;
-  // (undocumented)
   readonly lastSignInTime?: string;
 }
 

docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md

@@ -4,6 +4,8 @@
 
 ## ActionCodeSettings.dynamicLinkDomain property
 
+When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`<!-- -->). Otherwise the first domain is automatically selected.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth-types.actioncodesettings.ios.md

@@ -6,6 +6,8 @@
 
 Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed.
 
+App installation is not supported for iOS.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth-types.actioncodesettings.md

@@ -17,8 +17,8 @@ export interface ActionCodeSettings
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. This will try to open the link in an android app if it is installed. If <code>installApp</code> is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a <code>packageName</code>, an error is thrown explaining that the <code>packageName</code> must be provided in conjunction with this field. If <code>minimumVersion</code> is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. |
-|  [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string |  |
+|  [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, <code>example.page.link</code>). Otherwise the first domain is automatically selected. |
 |  [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. |
-|  [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. |
-|  [url](./auth-types.actioncodesettings.url.md) | string | Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the <code>continueUrl</code> query parameter. - When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link. |
+|  [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed.<!-- -->App installation is not supported for iOS. |
+|  [url](./auth-types.actioncodesettings.url.md) | string | Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the <code>continueUrl</code> query parameter. - When the link is handled in the app directly, this is the <code>continueUrl</code> query parameter in the deep link of the Dynamic Link. |
 

docs-exp/auth-types.actioncodesettings.url.md

@@ -4,7 +4,7 @@
 
 ## ActionCodeSettings.url property
 
-Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link.
+Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link.
 
 <b>Signature:</b>
 

docs-exp/auth-types.additionaluserinfo.isnewuser.md

@@ -4,6 +4,8 @@
 
 ## AdditionalUserInfo.isNewUser property
 
+Whether the user is new (created via sign-up) or existing (authenticated using sign-in).
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth-types.additionaluserinfo.md

@@ -16,8 +16,8 @@ export interface AdditionalUserInfo
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean |  |
-|  [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null |  |
-|  [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null |  |
-|  [username](./auth-types.additionaluserinfo.username.md) | string \| null |  |
+|  [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | Whether the user is new (created via sign-up) or existing (authenticated using sign-in). |
+|  [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | Map containing IDP-specific user data. |
+|  [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | Identifier for the provider used to authenticate this user. |
+|  [username](./auth-types.additionaluserinfo.username.md) | string \| null | The username if the provider is GitHub or Twitter. |
 

docs-exp/auth-types.additionaluserinfo.profile.md

@@ -4,6 +4,8 @@
 
 ## AdditionalUserInfo.profile property
 
+Map containing IDP-specific user data.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth-types.additionaluserinfo.providerid.md

@@ -4,6 +4,8 @@
 
 ## AdditionalUserInfo.providerId property
 
+Identifier for the provider used to authenticate this user.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth-types.additionaluserinfo.username.md

@@ -4,6 +4,8 @@
 
 ## AdditionalUserInfo.username property
 
+The username if the provider is GitHub or Twitter.
+
 <b>Signature:</b>
 
 ```typescript

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

@@ -27,7 +27,7 @@ void
 ## Example
 
 
-```
+```javascript
 auth.setPersistence(browserSessionPersistence);
 
 ```

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

@@ -15,7 +15,7 @@ tenantId: string | null;
 ## Example
 
 
-```
+```javascript
 // Set the tenant ID on Auth instance.
 auth.tenantId = 'TENANT_PROJECT_ID';
 

docs-exp/auth-types.authcredential.md

@@ -24,5 +24,5 @@ export abstract class AuthCredential
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [fromJSON(json)](./auth-types.authcredential.fromjson.md) | <code>static</code> | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md)<!-- -->. |
-|  [toJSON()](./auth-types.authcredential.tojson.md) |  |  |
+|  [toJSON()](./auth-types.authcredential.tojson.md) |  | Returns a JSON-serializable representation of this object. |
 

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

@@ -4,6 +4,8 @@
 
 ## AuthCredential.toJSON() method
 
+Returns a JSON-serializable representation of this object.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth-types.authprovider.md

@@ -4,7 +4,7 @@
 
 ## AuthProvider interface
 
-Interface that represents an auth provider.
+Interface that represents an auth provider, used to facilitate creating [AuthCredential](./auth-types.authcredential.md)<!-- -->.
 
 <b>Signature:</b>
 
@@ -16,5 +16,5 @@ export interface AuthProvider
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [providerId](./auth-types.authprovider.providerid.md) | string |  |
+|  [providerId](./auth-types.authprovider.providerid.md) | string | Provider for which credentials can be constructed. |