Auth docs

Author: sam-gc

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

@@ -18,7 +18,17 @@ export interface ActionCodeInfo {
     multiFactorInfo?: MultiFactorInfo | null;
     previousEmail?: string | null;
   };
-  operation: Operation;
+  operation: ActionCodeOperation;
+}
+
+// @public
+export const enum ActionCodeOperation {
+  EMAIL_SIGNIN = 'EMAIL_SIGNIN',
+  PASSWORD_RESET = 'PASSWORD_RESET',
+  RECOVER_EMAIL = 'RECOVER_EMAIL',
+  REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION',
+  VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL',
+  VERIFY_EMAIL = 'VERIFY_EMAIL'
 }
 
 // @public
@@ -42,15 +52,15 @@ export abstract class ActionCodeURL {
   readonly code: string;
   readonly continueUrl: string | null;
   readonly languageCode: string | null;
-  readonly operation: Operation;
+  readonly operation: ActionCodeOperation;
   static parseLink(link: string): ActionCodeURL | null;
   readonly tenantId: string | null;
 }
 
 // @public
 export interface AdditionalUserInfo {
   readonly isNewUser: boolean;
-  readonly profile: UserProfile | null;
+  readonly profile: Record<string, unknown> | null;
   readonly providerId: ProviderId | null;
   readonly username?: string | null;
 }
@@ -145,6 +155,11 @@ export abstract class EmailAuthProvider implements AuthProvider {
   readonly providerId: ProviderId;
 }
 
+// @public
+export const enum FactorId {
+  PHONE = 'phone',
+}
+
 // @public
 export interface IdTokenResult {
   authTime: string;
@@ -158,20 +173,19 @@ export interface IdTokenResult {
 
 // @public
 export interface MultiFactorAssertion {
-  readonly factorId: string;
+  readonly factorId: FactorId;
 }
 
 // @public
 export interface MultiFactorError extends AuthError {
-  readonly credential: AuthCredential;
   readonly operationType: OperationType;
 }
 
 // @public
 export interface MultiFactorInfo {
   readonly displayName?: string | null;
   readonly enrollmentTime: string;
-  readonly factorId: ProviderId;
+  readonly factorId: FactorId;
   readonly uid: string;
 }
 
@@ -210,16 +224,6 @@ export abstract class OAuthCredential extends AuthCredential {
   readonly secret?: string;
 }
 
-// @public
-export const enum Operation {
-  EMAIL_SIGNIN = 'EMAIL_SIGNIN',
-  PASSWORD_RESET = 'PASSWORD_RESET',
-  RECOVER_EMAIL = 'RECOVER_EMAIL',
-  REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION',
-  VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL',
-  VERIFY_EMAIL = 'VERIFY_EMAIL'
-}
-
 // @public
 export const enum OperationType {
   LINK = 'link',
@@ -404,9 +408,6 @@ export interface UserMetadata {
   readonly lastSignInTime?: string;
 }
 
-// @public
-export type UserProfile = Record<string, unknown>;
-
 
 // (No @packageDocumentation comment for this package)
 

docs-exp/auth-types.actioncodeinfo.data.md

@@ -4,13 +4,13 @@
 
 ## ActionCodeInfo.data property
 
-The data associated with the action code. For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md)<!-- -->, [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md)<!-- -->, and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to.
+The data associated with the action code. For the , , and  actions, this object contains an email field with the address the email was sent to.
 
-For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field.
+For the  action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field.
 
-For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field.
+For the  action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field.
 
-For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number.
+For the  action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number.
 
 <b>Signature:</b>
 

docs-exp/auth-types.actioncodeinfo.md

@@ -16,6 +16,6 @@ export interface ActionCodeInfo
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | The data associated with the action code. For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md)<!-- -->, [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md)<!-- -->, and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to.<!-- -->For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a <code>previousEmail</code> field with the user account's current email address. After the action completes, the user's email address will revert to the value in the <code>email</code> field from the value in <code>previousEmail</code> field.<!-- -->For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a <code>previousEmail</code> field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the <code>email</code> field from the value in <code>previousEmail</code> field.<!-- -->For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a <code>multiFactorInfo</code> field with the information about the second factor. For phone second factor, the <code>multiFactorInfo</code> is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. |
-|  [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | The type of operation that generated the action code. |
+|  [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | The data associated with the action code. For the , , and  actions, this object contains an email field with the address the email was sent to.<!-- -->For the  action, which allows a user to undo an email address change, this object also contains a <code>previousEmail</code> field with the user account's current email address. After the action completes, the user's email address will revert to the value in the <code>email</code> field from the value in <code>previousEmail</code> field.<!-- -->For the  action, which allows a user to verify the email before updating it, this object contains a <code>previousEmail</code> field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the <code>email</code> field from the value in <code>previousEmail</code> field.<!-- -->For the  action, which allows a user to unenroll a newly added second factor, this object contains a <code>multiFactorInfo</code> field with the information about the second factor. For phone second factor, the <code>multiFactorInfo</code> is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. |
+|  [operation](./auth-types.actioncodeinfo.operation.md) | [ActionCodeOperation](./auth-types.actioncodeoperation.md) | The type of operation that generated the action code. |
 

docs-exp/auth-types.actioncodeinfo.operation.md

@@ -9,5 +9,5 @@ The type of operation that generated the action code.
 <b>Signature:</b>
 
 ```typescript
-operation: Operation;
+operation: ActionCodeOperation;
 ```

docs-exp/auth-types.operation.md renamed to docs-exp/auth-types.actioncodeoperation.md

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [Operation](./auth-types.operation.md)
+[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeOperation](./auth-types.actioncodeoperation.md)
 
-## Operation enum
+## ActionCodeOperation enum
 
 An enumeration of the possible email action types.
 
 <b>Signature:</b>
 
 ```typescript
-export const enum Operation 
+export const enum ActionCodeOperation 
 ```
 
 ## Enumeration Members

docs-exp/auth-types.actioncodeurl.md

@@ -20,7 +20,7 @@ export abstract class ActionCodeURL
 |  [code](./auth-types.actioncodeurl.code.md) |  | string | The action code of the email action link. |
 |  [continueUrl](./auth-types.actioncodeurl.continueurl.md) |  | string \| null | The continue URL of the email action link. Null if not provided. |
 |  [languageCode](./auth-types.actioncodeurl.languagecode.md) |  | string \| null | The language code of the email action link. Null if not provided. |
-|  [operation](./auth-types.actioncodeurl.operation.md) |  | [Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) |
+|  [operation](./auth-types.actioncodeurl.operation.md) |  | [ActionCodeOperation](./auth-types.actioncodeoperation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) |
 |  [tenantId](./auth-types.actioncodeurl.tenantid.md) |  | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
 
 ## Methods

docs-exp/auth-types.actioncodeurl.operation.md

@@ -9,5 +9,5 @@ The action performed by the email action link. It returns from one of the types
 <b>Signature:</b>
 
 ```typescript
-readonly operation: Operation;
+readonly operation: ActionCodeOperation;
 ```

docs-exp/auth-types.additionaluserinfo.md

@@ -17,7 +17,7 @@ export interface AdditionalUserInfo
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [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. |
+|  [profile](./auth-types.additionaluserinfo.profile.md) | Record<string, unknown> \| 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

@@ -9,5 +9,5 @@ Map containing IDP-specific user data.
 <b>Signature:</b>
 
 ```typescript
-readonly profile: UserProfile | null;
+readonly profile: Record<string, unknown> | null;
 ```

docs-exp/auth-types.factorid.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [FactorId](./auth-types.factorid.md)
+
+## FactorId enum
+
+An enum of factors that may be used for multifactor authentication.
+
+<b>Signature:</b>
+
+```typescript
+export const enum FactorId 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  PHONE | <code>'phone'</code> | Phone as second factor |
+

docs-exp/auth-types.md

@@ -22,7 +22,8 @@
 
 |  Enumeration | Description |
 |  --- | --- |
-|  [Operation](./auth-types.operation.md) | An enumeration of the possible email action types. |
+|  [ActionCodeOperation](./auth-types.actioncodeoperation.md) | An enumeration of the possible email action types. |
+|  [FactorId](./auth-types.factorid.md) | An enum of factors that may be used for multifactor authentication. |
 |  [OperationType](./auth-types.operationtype.md) | Supported operation types. |
 |  [ProviderId](./auth-types.providerid.md) | Supported providers. |
 |  [SignInMethod](./auth-types.signinmethod.md) | Supported sign-in methods. |
@@ -66,5 +67,4 @@
 |  --- | --- |
 |  [NextOrObserver](./auth-types.nextorobserver.md) | Type definition for an event callback. |
 |  [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. |
-|  [UserProfile](./auth-types.userprofile.md) | User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md)<!-- -->. |
 

docs-exp/auth-types.multifactorassertion.factorid.md

@@ -9,5 +9,5 @@ The identifier of the second factor.
 <b>Signature:</b>
 
 ```typescript
-readonly factorId: string;
+readonly factorId: FactorId;
 ```

docs-exp/auth-types.multifactorassertion.md

@@ -16,5 +16,5 @@ export interface MultiFactorAssertion
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [factorId](./auth-types.multifactorassertion.factorid.md) | string | The identifier of the second factor. |
+|  [factorId](./auth-types.multifactorassertion.factorid.md) | [FactorId](./auth-types.factorid.md) | The identifier of the second factor. |
 

docs-exp/auth-types.multifactorerror.credential.md

@@ -43,6 +43,5 @@ const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | The original credential used as a first factor. |
 |  [operationType](./auth-types.multifactorerror.operationtype.md) | [OperationType](./auth-types.operationtype.md) | The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. |
 

docs-exp/auth-types.multifactorerror.md

@@ -9,5 +9,5 @@ The identifier of the second factor.
 <b>Signature:</b>
 
 ```typescript
-readonly factorId: ProviderId;
+readonly factorId: FactorId;
 ```

docs-exp/auth-types.multifactorinfo.factorid.md

@@ -18,6 +18,6 @@ export interface MultiFactorInfo
 |  --- | --- | --- |
 |  [displayName](./auth-types.multifactorinfo.displayname.md) | string \| null | The user friendly name of the current second factor. |
 |  [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) | string | The enrollment date of the second factor formatted as a UTC string. |
-|  [factorId](./auth-types.multifactorinfo.factorid.md) | [ProviderId](./auth-types.providerid.md) | The identifier of the second factor. |
+|  [factorId](./auth-types.multifactorinfo.factorid.md) | [FactorId](./auth-types.factorid.md) | The identifier of the second factor. |
 |  [uid](./auth-types.multifactorinfo.uid.md) | string | The multi-factor enrollment ID. |
 

docs-exp/auth-types.multifactorinfo.md

@@ -21,7 +21,7 @@ export declare class ActionCodeURL implements externs.ActionCodeURL
 |  [code](./auth.actioncodeurl.code.md) |  | string | The action code of the email action link. |
 |  [continueUrl](./auth.actioncodeurl.continueurl.md) |  | string \| null | The continue URL of the email action link. Null if not provided. |
 |  [languageCode](./auth.actioncodeurl.languagecode.md) |  | string \| null | The language code of the email action link. Null if not provided. |
-|  [operation](./auth.actioncodeurl.operation.md) |  | externs.[Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from  |
+|  [operation](./auth.actioncodeurl.operation.md) |  | externs.[ActionCodeOperation](./auth-types.actioncodeoperation.md) | The action performed by the email action link. It returns from one of the types from  |
 |  [tenantId](./auth.actioncodeurl.tenantid.md) |  | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. |
 
 ## Methods

docs-exp/auth-types.userprofile.md

@@ -9,5 +9,5 @@ The action performed by the email action link. It returns from one of the types
 <b>Signature:</b>
 
 ```typescript
-readonly operation: externs.Operation;
+readonly operation: externs.ActionCodeOperation;
 ```

docs-exp/auth.actioncodeurl.md

@@ -7,14 +7,14 @@
 <b>Signature:</b>
 
 ```typescript
-credential(params: CredentialParameters): externs.OAuthCredential;
+credential(params: OAuthCredentialOptions): externs.OAuthCredential;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  params | CredentialParameters |  |
+|  params | OAuthCredentialOptions |  |
 
 <b>Returns:</b>