Skip to content

Commit e3935d9

Browse files
sam-gcsam-gc
committed
Revert markdown files since the docgen tool isn't working
1 parent c8b0e15 commit e3935d9

22 files changed

+93
-68
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export class ActionCodeURL implements externs.ActionCodeURL {
2929
// (undocumented)
3030
readonly languageCode: string | null;
3131
// (undocumented)
32-
readonly operation: externs.ActionCodeOperation;
32+
readonly operation: externs.Operation;
3333
// (undocumented)
3434
static parseLink(link: string): externs.ActionCodeURL | null;
3535
// (undocumented)

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

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,7 @@ export interface ActionCodeInfo {
1818
multiFactorInfo?: MultiFactorInfo | null;
1919
previousEmail?: string | null;
2020
};
21-
operation: ActionCodeOperation;
22-
}
23-
24-
// @public
25-
export const enum ActionCodeOperation {
26-
EMAIL_SIGNIN = 'EMAIL_SIGNIN',
27-
PASSWORD_RESET = 'PASSWORD_RESET',
28-
RECOVER_EMAIL = 'RECOVER_EMAIL',
29-
REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION',
30-
VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL',
31-
VERIFY_EMAIL = 'VERIFY_EMAIL'
21+
operation: Operation;
3222
}
3323

3424
// @public
@@ -52,15 +42,15 @@ export abstract class ActionCodeURL {
5242
readonly code: string;
5343
readonly continueUrl: string | null;
5444
readonly languageCode: string | null;
55-
readonly operation: ActionCodeOperation;
45+
readonly operation: Operation;
5646
static parseLink(link: string): ActionCodeURL | null;
5747
readonly tenantId: string | null;
5848
}
5949

6050
// @public
6151
export interface AdditionalUserInfo {
6252
readonly isNewUser: boolean;
63-
readonly profile: Record<string, unknown> | null;
53+
readonly profile: UserProfile | null;
6454
readonly providerId: ProviderId | null;
6555
readonly username?: string | null;
6656
}
@@ -158,11 +148,6 @@ export abstract class EmailAuthProvider implements AuthProvider {
158148
readonly providerId: ProviderId;
159149
}
160150

161-
// @public
162-
export const enum FactorId {
163-
PHONE = 'phone',
164-
}
165-
166151
// @public
167152
export interface IdTokenResult {
168153
authTime: string;
@@ -176,19 +161,20 @@ export interface IdTokenResult {
176161

177162
// @public
178163
export interface MultiFactorAssertion {
179-
readonly factorId: FactorId;
164+
readonly factorId: string;
180165
}
181166

182167
// @public
183168
export interface MultiFactorError extends AuthError {
169+
readonly credential: AuthCredential;
184170
readonly operationType: OperationType;
185171
}
186172

187173
// @public
188174
export interface MultiFactorInfo {
189175
readonly displayName?: string | null;
190176
readonly enrollmentTime: string;
191-
readonly factorId: FactorId;
177+
readonly factorId: ProviderId;
192178
readonly uid: string;
193179
}
194180

@@ -227,6 +213,16 @@ export abstract class OAuthCredential extends AuthCredential {
227213
readonly secret?: string;
228214
}
229215

216+
// @public
217+
export const enum Operation {
218+
EMAIL_SIGNIN = 'EMAIL_SIGNIN',
219+
PASSWORD_RESET = 'PASSWORD_RESET',
220+
RECOVER_EMAIL = 'RECOVER_EMAIL',
221+
REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION',
222+
VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL',
223+
VERIFY_EMAIL = 'VERIFY_EMAIL'
224+
}
225+
230226
// @public
231227
export const enum OperationType {
232228
LINK = 'link',
@@ -414,6 +410,9 @@ export interface UserMetadata {
414410
readonly lastSignInTime?: string;
415411
}
416412

413+
// @public
414+
export type UserProfile = Record<string, unknown>;
415+
417416

418417
// (No @packageDocumentation comment for this package)
419418

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@
44

55
## ActionCodeInfo.data property
66

7-
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.
8-
9-
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.
10-
11-
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.
12-
13-
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.
7+
The data associated with the action code.
148

159
<b>Signature:</b>
1610

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ export interface ActionCodeInfo
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [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. |
20-
| [operation](./auth-types.actioncodeinfo.operation.md) | [ActionCodeOperation](./auth-types.actioncodeoperation.md) | The type of operation that generated the action code. |
19+
| [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. |
20+
| [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | The type of operation that generated the action code. |
2121

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The type of operation that generated the action code.
99
<b>Signature:</b>
1010

1111
```typescript
12-
operation: ActionCodeOperation;
12+
operation: Operation;
1313
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export abstract class ActionCodeURL
2020
| [code](./auth-types.actioncodeurl.code.md) | | string | The action code of the email action link. |
2121
| [continueUrl](./auth-types.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. |
2222
| [languageCode](./auth-types.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. |
23-
| [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) |
23+
| [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) |
2424
| [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. |
2525

2626
## Methods

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The action performed by the email action link. It returns from one of the types
99
<b>Signature:</b>
1010

1111
```typescript
12-
readonly operation: ActionCodeOperation;
12+
readonly operation: Operation;
1313
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export interface AdditionalUserInfo
1717
| Property | Type | Description |
1818
| --- | --- | --- |
1919
| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | Whether the user is new (created via sign-up) or existing (authenticated using sign-in). |
20-
| [profile](./auth-types.additionaluserinfo.profile.md) | Record&lt;string, unknown&gt; \| null | Map containing IDP-specific user data. |
20+
| [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | Map containing IDP-specific user data. |
2121
| [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | Identifier for the provider used to authenticate this user. |
2222
| [username](./auth-types.additionaluserinfo.username.md) | string \| null | The username if the provider is GitHub or Twitter. |
2323

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Map containing IDP-specific user data.
99
<b>Signature:</b>
1010

1111
```typescript
12-
readonly profile: Record<string, unknown> | null;
12+
readonly profile: UserProfile | null;
1313
```

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

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎docs-exp/auth-types.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@
2222

2323
| Enumeration | Description |
2424
| --- | --- |
25-
| [ActionCodeOperation](./auth-types.actioncodeoperation.md) | An enumeration of the possible email action types. |
26-
| [FactorId](./auth-types.factorid.md) | An enum of factors that may be used for multifactor authentication. |
27-
| [OperationType](./auth-types.operationtype.md) | Supported operation types. |
28-
| [ProviderId](./auth-types.providerid.md) | Supported providers. |
29-
| [SignInMethod](./auth-types.signinmethod.md) | Supported sign-in methods. |
25+
| [Operation](./auth-types.operation.md) | An enumeration of the possible email action types. |
26+
| [OperationType](./auth-types.operationtype.md) | Enumeration of supported operation types. |
27+
| [ProviderId](./auth-types.providerid.md) | Enumeration of supported providers. |
28+
| [SignInMethod](./auth-types.signinmethod.md) | Enumeration of supported sign-in methods. |
3029

3130
## Interfaces
3231

@@ -72,5 +71,6 @@ When initializing Auth, is default. |
7271
| Type Alias | Description |
7372
| --- | --- |
7473
| [NextOrObserver](./auth-types.nextorobserver.md) | Type definition for an event callback. |
75-
| [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. |
74+
| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | The information required to verify the ownership of a phone number. |
75+
| [UserProfile](./auth-types.userprofile.md) | User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md)<!-- -->. |
7676

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The identifier of the second factor.
99
<b>Signature:</b>
1010

1111
```typescript
12-
readonly factorId: FactorId;
12+
readonly factorId: string;
1313
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ This is used to facilitate enrollment of a second factor on an existing user or
2020

2121
| Property | Type | Description |
2222
| --- | --- | --- |
23-
| [factorId](./auth-types.multifactorassertion.factorid.md) | [FactorId](./auth-types.factorid.md) | The identifier of the second factor. |
23+
| [factorId](./auth-types.multifactorassertion.factorid.md) | string | The identifier of the second factor. |
2424

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [MultiFactorError](./auth-types.multifactorerror.md) &gt; [credential](./auth-types.multifactorerror.credential.md)
4+
5+
## MultiFactorError.credential property
6+
7+
The original credential used as a first factor.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
readonly credential: AuthCredential;
13+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,6 @@ const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
4747
4848
| Property | Type | Description |
4949
| --- | --- | --- |
50+
| [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | The original credential used as a first factor. |
5051
| [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. |
5152

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The identifier of the second factor.
99
<b>Signature:</b>
1010

1111
```typescript
12-
readonly factorId: FactorId;
12+
readonly factorId: ProviderId;
1313
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ export interface MultiFactorInfo
1818
| --- | --- | --- |
1919
| [displayName](./auth-types.multifactorinfo.displayname.md) | string \| null | The user friendly name of the current second factor. |
2020
| [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) | string | The enrollment date of the second factor formatted as a UTC string. |
21-
| [factorId](./auth-types.multifactorinfo.factorid.md) | [FactorId](./auth-types.factorid.md) | The identifier of the second factor. |
21+
| [factorId](./auth-types.multifactorinfo.factorid.md) | [ProviderId](./auth-types.providerid.md) | The identifier of the second factor. |
2222
| [uid](./auth-types.multifactorinfo.uid.md) | string | The multi-factor enrollment ID. |
2323

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [Operation](./auth-types.operation.md)
4+
5+
## Operation enum
6+
7+
An enumeration of the possible email action types.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export const enum Operation
13+
```
14+
15+
## Enumeration Members
16+
17+
| Member | Value | Description |
18+
| --- | --- | --- |
19+
| EMAIL\_SIGNIN | <code>'EMAIL_SIGNIN'</code> | The email link sign-in action. |
20+
| PASSWORD\_RESET | <code>'PASSWORD_RESET'</code> | The password reset action. |
21+
| RECOVER\_EMAIL | <code>'RECOVER_EMAIL'</code> | The email revocation action. |
22+
| REVERT\_SECOND\_FACTOR\_ADDITION | <code>'REVERT_SECOND_FACTOR_ADDITION'</code> | The revert second factor addition email action. |
23+
| VERIFY\_AND\_CHANGE\_EMAIL | <code>'VERIFY_AND_CHANGE_EMAIL'</code> | The revert second factor addition email action. |
24+
| VERIFY\_EMAIL | <code>'VERIFY_EMAIL'</code> | The email verification action. |
25+

‎docs-exp/auth-types.userprofile.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [UserProfile](./auth-types.userprofile.md)
4+
5+
## UserProfile type
6+
7+
User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md)<!-- -->.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export type UserProfile = Record<string, unknown>;
13+
```

‎docs-exp/auth.actioncodeurl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export declare class ActionCodeURL implements externs.ActionCodeURL
2121
| [code](./auth.actioncodeurl.code.md) | | string | The action code of the email action link. |
2222
| [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. |
2323
| [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. |
24-
| [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 |
24+
| [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 [ActionCodeInfo](./auth-types.actioncodeinfo.md) |
2525
| [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. |
2626
2727
## Methods

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The action performed by the email action link. It returns from one of the types
99
<b>Signature:</b>
1010

1111
```typescript
12-
readonly operation: externs.ActionCodeOperation;
12+
readonly operation: externs.Operation;
1313
```

‎docs-exp/auth.oauthprovider.credential.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ credential(params: OAuthCredentialOptions): externs.OAuthCredential;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| params | OAuthCredentialOptions | |
19+
| params | [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) | Either the options object containing the ID token, access token and raw nonce or the ID token string. |
2020

2121
<b>Returns:</b>
2222

0 commit comments

Comments
 (0)