From 4d0af5fd5b57a37e9eabd5e4c1d224310131ecb3 Mon Sep 17 00:00:00 2001 From: joel Date: Fri, 27 Sep 2024 15:25:54 +0200 Subject: [PATCH] fix: hide mfa types --- src/GoTrueClient.ts | 19 ++++----- src/lib/internal-types.ts | 75 ++++++++++++++++++++++++++++++++++ src/lib/types.ts | 84 +++++---------------------------------- 3 files changed, 91 insertions(+), 87 deletions(-) create mode 100644 src/lib/internal-types.ts diff --git a/src/GoTrueClient.ts b/src/GoTrueClient.ts index 207675323..f0ebd2a85 100644 --- a/src/GoTrueClient.ts +++ b/src/GoTrueClient.ts @@ -88,12 +88,13 @@ import type { LockFunc, UserIdentity, SignInAnonymouslyCredentials, +} from './lib/types' +import { MFAEnrollTOTPParams, - AuthMFAEnrollTOTPResponse, - AuthMFAEnrollErrorResponse, MFAEnrollPhoneParams, + AuthMFAEnrollTOTPResponse, AuthMFAEnrollPhoneResponse, -} from './lib/types' +} from './lib/internal-types' polyfillGlobalThis() // Make "globalThis" available @@ -313,9 +314,7 @@ export default class GoTrueClient { if (error) { this._debug('#_initialize()', 'error detecting session from URL', error) - if ( - error?.code === 'identity_already_exists' - ) { + if (error?.code === 'identity_already_exists') { return { error } } @@ -2355,12 +2354,8 @@ export default class GoTrueClient { /** * {@see GoTrueMFAApi#enroll} */ - private async _enroll( - params: MFAEnrollTOTPParams - ): Promise - private async _enroll( - params: MFAEnrollPhoneParams - ): Promise + private async _enroll(params: MFAEnrollTOTPParams): Promise + private async _enroll(params: MFAEnrollPhoneParams): Promise private async _enroll(params: MFAEnrollParams): Promise { try { return await this._useSession(async (result) => { diff --git a/src/lib/internal-types.ts b/src/lib/internal-types.ts new file mode 100644 index 000000000..7b7719bb8 --- /dev/null +++ b/src/lib/internal-types.ts @@ -0,0 +1,75 @@ +import { AuthError } from './errors' + +export type MFAEnrollTOTPParams = { + /** The type of factor being enrolled. */ + factorType: 'totp' + /** Domain which the user is enrolled with. */ + issuer?: string + /** Human readable name assigned to the factor. */ + friendlyName?: string +} +export type MFAEnrollPhoneParams = { + /** The type of factor being enrolled. */ + factorType: 'phone' + /** Human readable name assigned to the factor. */ + friendlyName?: string + /** Phone number associated with a factor. Number should conform to E.164 format */ + phone: string +} + +export type AuthMFAEnrollTOTPResponse = + | { + data: { + /** ID of the factor that was just enrolled (in an unverified state). */ + id: string + + /** Type of MFA factor.*/ + type: 'totp' + + /** TOTP enrollment information. */ + totp: { + /** Contains a QR code encoding the authenticator URI. You can + * convert it to a URL by prepending `data:image/svg+xml;utf-8,` to + * the value. Avoid logging this value to the console. */ + qr_code: string + + /** The TOTP secret (also encoded in the QR code). Show this secret + * in a password-style field to the user, in case they are unable to + * scan the QR code. Avoid logging this value to the console. */ + secret: string + + /** The authenticator URI encoded within the QR code, should you need + * to use it. Avoid loggin this value to the console. */ + uri: string + } + /** Friendly name of the factor, useful for distinguishing between factors **/ + friendly_name?: string + } + error: null + } + | { + data: null + error: AuthError + } + +export type AuthMFAEnrollPhoneResponse = + | { + data: { + /** ID of the factor that was just enrolled (in an unverified state). */ + id: string + + /** Type of MFA factor. */ + type: 'phone' + + /** Friendly name of the factor, useful for distinguishing between factors **/ + friendly_name?: string + + /** Phone number of the MFA factor in E.164 format. Used to send messages */ + phone: string + } + error: null + } + | { + data: null + error: AuthError + } diff --git a/src/lib/types.ts b/src/lib/types.ts index a2b9c3c30..04e672793 100644 --- a/src/lib/types.ts +++ b/src/lib/types.ts @@ -1,5 +1,11 @@ import { AuthError } from './errors' import { Fetch } from './fetch' +import { + MFAEnrollTOTPParams, + MFAEnrollPhoneParams, + AuthMFAEnrollTOTPResponse, + AuthMFAEnrollPhoneResponse, +} from './internal-types' /** One of the providers supported by GoTrue. */ export type Provider = @@ -800,22 +806,6 @@ export type GenerateLinkType = | 'email_change_current' | 'email_change_new' -export type MFAEnrollTOTPParams = { - /** The type of factor being enrolled. */ - factorType: 'totp' - /** Domain which the user is enrolled with. */ - issuer?: string - /** Human readable name assigned to the factor. */ - friendlyName?: string -} -export type MFAEnrollPhoneParams = { - /** The type of factor being enrolled. */ - factorType: 'phone' - /** Human readable name assigned to the factor. */ - friendlyName?: string - /** Phone number associated with a factor. Number should conform to E.164 format */ - phone: string -} export type MFAEnrollParams = MFAEnrollTOTPParams | MFAEnrollPhoneParams export type MFAUnenrollParams = { @@ -873,59 +863,7 @@ export type AuthMFAVerifyResponse = error: AuthError } -export type AuthMFAEnrollTOTPResponse = { - data: { - /** ID of the factor that was just enrolled (in an unverified state). */ - id: string - - /** Type of MFA factor.*/ - type: 'totp' - - /** TOTP enrollment information. */ - totp: { - /** Contains a QR code encoding the authenticator URI. You can - * convert it to a URL by prepending `data:image/svg+xml;utf-8,` to - * the value. Avoid logging this value to the console. */ - qr_code: string - - /** The TOTP secret (also encoded in the QR code). Show this secret - * in a password-style field to the user, in case they are unable to - * scan the QR code. Avoid logging this value to the console. */ - secret: string - - /** The authenticator URI encoded within the QR code, should you need - * to use it. Avoid loggin this value to the console. */ - uri: string - } - /** Friendly name of the factor, useful for distinguishing between factors **/ - friendly_name?: string - } - error: null -} -export type AuthMFAEnrollPhoneResponse = { - data: { - /** ID of the factor that was just enrolled (in an unverified state). */ - id: string - - /** Type of MFA factor. */ - type: 'phone' - - /** Friendly name of the factor, useful for distinguishing between factors **/ - friendly_name?: string - - /** Phone number of the MFA factor in E.164 format. Used to send messages */ - phone: string - } - error: null -} -export type AuthMFAEnrollErrorResponse = { - data: null - error: AuthError -} -export type AuthMFAEnrollResponse = - | AuthMFAEnrollTOTPResponse - | AuthMFAEnrollPhoneResponse - | AuthMFAEnrollErrorResponse +export type AuthMFAEnrollResponse = AuthMFAEnrollTOTPResponse | AuthMFAEnrollPhoneResponse export type AuthMFAUnenrollResponse = | { @@ -1010,12 +948,8 @@ export interface GoTrueMFAApi { * Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`. * */ - enroll( - params: MFAEnrollTOTPParams - ): Promise - enroll( - params: MFAEnrollPhoneParams - ): Promise + enroll(params: MFAEnrollTOTPParams): Promise + enroll(params: MFAEnrollPhoneParams): Promise enroll(params: MFAEnrollParams): Promise /**