Skip to content

Commit 7d8a524

Browse files
committed
Fixes for TOTP docs
1 parent d7a1060 commit 7d8a524

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

packages/auth/src/mfa/assertions/totp.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export class TotpMultiFactorGenerator {
4646
* the totp(Time-based One Time Password) second factor.
4747
* This assertion is used to complete enrollment in TOTP second factor.
4848
*
49-
* @param secret {@link TotpSecret}.
49+
* @param secret A {@link TotpSecret} containing the shared secret key and other TOTP parameters.
5050
* @param oneTimePassword One-time password from TOTP App.
5151
* @returns A {@link TotpMultiFactorAssertion} which can be used with
5252
* {@link MultiFactorUser.enroll}.
@@ -78,12 +78,12 @@ export class TotpMultiFactorGenerator {
7878
}
7979

8080
/**
81-
* Returns a promise to {@link TOTPSecret} which contains the TOTP shared secret key and other parameters.
81+
* Returns a promise to {@link TotpSecret} which contains the TOTP shared secret key and other parameters.
8282
* Creates a TOTP secret as part of enrolling a TOTP second factor.
8383
* Used for generating a QRCode URL or inputting into a TOTP App.
8484
* This method uses the auth instance corresponding to the user in the multiFactorSession.
8585
*
86-
* @param session A link to {@MultiFactorSession}.
86+
* @param session The {@link MultiFactorSession} that the user is part of.
8787
* @returns A promise to {@link TotpSecret}.
8888
*/
8989
static async generateSecret(
@@ -184,7 +184,7 @@ export class TotpMultiFactorAssertionImpl
184184
*/
185185
export class TotpSecret {
186186
/**
187-
* Shared secret key/seed used for enrolling in TOTP MFA and generating otps.
187+
* Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.
188188
*/
189189
readonly secretKey: string;
190190
/**

packages/auth/src/model/public_types.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1240,7 +1240,8 @@ export interface Dependencies {
12401240

12411241
/**
12421242
* The class for asserting ownership of a totp second factor. Provided by
1243-
* {@link TotpMultiFactorGenerator.assertion}.
1243+
* {@link TotpMultiFactorGenerator.assertionForEnrollment} and
1244+
* {@link TotpMultiFactorGenerator.assertionForSignIn}.
12441245
*
12451246
* @public
12461247
*/

packages/auth/src/platform_browser/recaptcha/recaptcha_loader.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import { AuthErrorCode } from '../../core/errors';
2121
import { _assert, _createError } from '../../core/util/assert';
2222
import { Delay } from '../../core/util/delay';
2323
import { AuthInternal } from '../../model/auth';
24+
import { RecaptchaParameters } from '../../model/public_types';
2425
import { _window } from '../auth_window';
2526
import * as jsHelpers from '../load_js';
2627
import { Recaptcha } from './recaptcha';
@@ -81,7 +82,7 @@ export class ReCaptchaLoaderImpl implements ReCaptchaLoader {
8182
// Wrap the greptcha render function so that we know if the developer has
8283
// called it separately
8384
const render = recaptcha.render;
84-
recaptcha.render = (container, params) => {
85+
recaptcha.render = (container: HTMLElement, params: RecaptchaParameters) => {
8586
const widgetId = render(container, params);
8687
this.counter++;
8788
return widgetId;

0 commit comments

Comments
 (0)