Skip to content

Fix ToTP typings issue #7179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 31, 2023
Merged

Fix ToTP typings issue #7179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
79f3643
Fix ToTP typings issue
hsubox76 Mar 31, 2023
180e9e0
single quote?
hsubox76 Mar 31, 2023
c5513a6
add changeset
hsubox76 Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/soft-zoos-listen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@firebase/auth': patch
---

Fix typings for `TotpMultiFactorGenerator`. This fixes a reversion in 9.19.0.
3 changes: 1 addition & 2 deletions common/api-review/auth.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,8 +754,7 @@ export interface TotpMultiFactorAssertion extends MultiFactorAssertion {
export class TotpMultiFactorGenerator {
static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;
static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;
// Warning: (ae-forgotten-export) The symbol "FactorId" needs to be exported by the entry point index.d.ts
static FACTOR_ID: FactorId_2;
static FACTOR_ID: "totp";
static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;
}

Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/auth.totpmultifactorgenerator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export declare class TotpMultiFactorGenerator

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [FACTOR\_ID](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorfactor_id) | <code>static</code> | FactorId | The identifier of the TOTP second factor: <code>totp</code>. |
| [FACTOR\_ID](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorfactor_id) | <code>static</code> | 'totp' | The identifier of the TOTP second factor: <code>totp</code>. |

## Methods

Expand All @@ -39,7 +39,7 @@ The identifier of the TOTP second factor: `totp`<!-- -->.
<b>Signature:</b>

```typescript
static FACTOR_ID: FactorId;
static FACTOR_ID: 'totp';
```

## TotpMultiFactorGenerator.assertionForEnrollment()
Expand Down
2 changes: 1 addition & 1 deletion packages/auth/src/mfa/assertions/totp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export class TotpMultiFactorGenerator {
/**
* The identifier of the TOTP second factor: `totp`.
*/
static FACTOR_ID = FactorId.TOTP;
static FACTOR_ID: 'totp' = FactorId.TOTP;
}

export class TotpMultiFactorAssertionImpl
Expand Down