feat: add admin MFA UI #15493
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| import type { | ||
| AuthMfaFactorResponse, | ||
| AuthMfaListResponse, | ||
| AuthMfaRecoveryCodesResponse, | ||
| AuthMfaSetupResponse, | ||
| FetchError, | ||
| } from "@medusajs/js-sdk" | ||
| import type { AuthTypes } from "@medusajs/types" | ||
| import { | ||
| QueryKey, | ||
| UseMutationOptions, | ||
| UseQueryOptions, | ||
| useMutation, | ||
| useQuery, | ||
| } from "@tanstack/react-query" | ||
| import { sdk } from "../../lib/client" | ||
| import { queryClient } from "../../lib/query-client" | ||
| import { queryKeysFactory } from "../../lib/query-key-factory" | ||
|
|
||
| const MFA_QUERY_KEY = "mfa" as const | ||
| export const mfaQueryKeys = queryKeysFactory(MFA_QUERY_KEY) | ||
|
|
||
| export type { | ||
| AuthLoginResponse, | ||
| AuthMfaRequiredResponse, | ||
| AuthMfaSetupResponse, | ||
| } from "@medusajs/js-sdk" | ||
|
|
||
| export type AuthMfa = AuthTypes.AuthMfaDTO | ||
| export type AuthMfaChallenge = AuthTypes.AuthMfaChallengeDTO | ||
| export type AuthMfaChallengeMethod = AuthTypes.AuthMfaChallengeMethod | ||
| export type AuthMfaProvider = AuthTypes.AuthMfaProvider | ||
|
|
||
| export const callbackWithCloudAuth = async ( | ||
| query: Record<string, unknown> | ||
| ): ReturnType<typeof sdk.auth.callback> => | ||
| sdk.auth.callback("user", "cloud", query) | ||
|
Member
There was a problem hiding this comment. I assume this works just fine when doing auth with Cloud? How does it work, does it require MFA after the oauth or it's skipped entirely?
Contributor
Author
There was a problem hiding this comment. Cloud OAuth can return an MFA challenge after the OAuth callback. Admin then shows the same MFA challenge screen and only continues after challenge verification. So admin MFA is not skipped |
||
|
|
||
| export const useAuthMfa = ( | ||
| options?: Omit< | ||
| UseQueryOptions< | ||
| AuthMfaListResponse, | ||
| FetchError, | ||
| AuthMfaListResponse, | ||
| QueryKey | ||
| >, | ||
| "queryFn" | "queryKey" | ||
| > | ||
| ) => { | ||
| const { data, ...rest } = useQuery({ | ||
| queryFn: () => sdk.auth.mfa.list(), | ||
| queryKey: mfaQueryKeys.lists(), | ||
| ...options, | ||
| }) | ||
|
|
||
| return { ...data, ...rest } | ||
| } | ||
|
|
||
| export const useStartAuthMfa = ( | ||
| options?: UseMutationOptions< | ||
| AuthMfaSetupResponse, | ||
| FetchError, | ||
| { | ||
| provider: AuthTypes.AuthMfaProvider | ||
| label?: string | null | ||
| issuer?: string | ||
| metadata?: Record<string, unknown> | null | ||
| } | ||
| > | ||
| ) => { | ||
| return useMutation({ | ||
| mutationFn: (payload) => sdk.auth.mfa.start(payload), | ||
| ...options, | ||
| onSuccess: (data, variables, context) => { | ||
| queryClient.invalidateQueries({ queryKey: mfaQueryKeys.lists() }) | ||
| options?.onSuccess?.(data, variables, context) | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| export const useVerifyAuthMfa = ( | ||
| id: string, | ||
| options?: UseMutationOptions< | ||
| AuthMfaFactorResponse, | ||
| FetchError, | ||
| { code: string } | ||
| > | ||
| ) => { | ||
| return useMutation({ | ||
| mutationFn: (payload) => sdk.auth.mfa.verify(id, payload), | ||
| ...options, | ||
| onSuccess: (data, variables, context) => { | ||
| queryClient.invalidateQueries({ queryKey: mfaQueryKeys.lists() }) | ||
| options?.onSuccess?.(data, variables, context) | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| export const useDisableAuthMfa = ( | ||
| id: string, | ||
| options?: UseMutationOptions< | ||
| AuthMfaFactorResponse, | ||
| FetchError, | ||
| { method?: AuthTypes.AuthMfaChallengeMethod; code?: string } | void | ||
| > | ||
| ) => { | ||
| return useMutation({ | ||
| mutationFn: (payload) => sdk.auth.mfa.disable(id, payload ?? {}), | ||
| ...options, | ||
| onSuccess: (data, variables, context) => { | ||
| queryClient.invalidateQueries({ queryKey: mfaQueryKeys.lists() }) | ||
| options?.onSuccess?.(data, variables, context) | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| export const useGenerateAuthMfaRecoveryCodes = ( | ||
| options?: UseMutationOptions< | ||
| AuthMfaRecoveryCodesResponse, | ||
| FetchError, | ||
| { count?: number } | void | ||
| > | ||
| ) => { | ||
| return useMutation({ | ||
| mutationFn: (payload) => sdk.auth.mfa.generateRecoveryCodes(payload ?? {}), | ||
| ...options, | ||
| }) | ||
| } | ||
|
|
||
| export const useVerifyAuthMfaChallenge = ( | ||
| options?: UseMutationOptions< | ||
| string, | ||
| FetchError, | ||
| { id: string; method: AuthTypes.AuthMfaChallengeMethod; code: string } | ||
| > | ||
| ) => { | ||
| return useMutation({ | ||
| mutationFn: ({ id, method, code }) => | ||
| sdk.auth.mfa.verifyChallenge(id, { method, code }), | ||
| ...options, | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.