BA: updates authentication package v1.1.2

packages/authentication/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @baseapp-frontend/authentication
 
+## 1.1.2
+
+### Patch Changes
+
+- Add an `ApiClass` option to all hooks that use some internal api class like `AuthApi` or `UserApi`. The user would be able to use its own api class, as long it has the required methods that each hook needs.
+
 ## 1.1.1
 
 ### Patch Changes

packages/authentication/modules/access/useLogin/index.ts

@@ -60,6 +60,7 @@ const useLogin = ({
   tokenType = TokenTypes.jwt,
   cookieName = ACCESS_COOKIE_NAME,
   refreshCookieName = REFRESH_COOKIE_NAME,
+  ApiClass = AuthApi,
 }: IUseLogin) => {
   const queryClient = useQueryClient()
   const [mfaEphemeralToken, setMfaEphemeralToken] = useState<string | null>(null)
@@ -87,7 +88,7 @@ const useLogin = ({
 
   const mutation = useMutation({
     mutationFn: (data: ILoginRequest) =>
-      tokenType === TokenTypes.jwt ? AuthApi.login(data) : AuthApi.simpleTokenLogin(data),
+      tokenType === TokenTypes.jwt ? ApiClass.login(data) : ApiClass.simpleTokenLogin(data),
     ...loginOptions, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       loginOptions?.onError?.(err, variables, context)

packages/authentication/modules/access/useLogin/types.ts

@@ -2,13 +2,17 @@ import { TokenTypes } from '@baseapp-frontend/utils'
 
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import AuthApi from '../../../services/auth'
 import { ICookieName, ILoginMfaRequest, ILoginRequest, LoginResponse } from '../../../types/auth'
 
+type ApiClass = Pick<typeof AuthApi, 'login' | 'simpleTokenLogin'>
+
 export interface IUseLogin extends ICookieName {
   // TODO: refactor types
   validationSchema?: any
   defaultValues?: ILoginRequest
   loginOptions?: UseMutationOptions<LoginResponse, unknown, ILoginRequest, any>
   mfaOptions?: UseMutationOptions<LoginResponse, unknown, ILoginMfaRequest, any>
   tokenType?: TokenTypes
+  ApiClass?: ApiClass
 }

packages/authentication/modules/access/useRecoverPassword/index.ts

@@ -12,6 +12,7 @@ import { IUseRecoverPassword } from './types'
 const useRecoverPassword = ({
   validationSchema = DEFAULT_VALIDATION_SCHEMA,
   defaultValues = DEFAULT_INITIAL_VALUES,
+  ApiClass = AuthApi,
   options,
 }: IUseRecoverPassword) => {
   const form = useForm({
@@ -20,7 +21,7 @@ const useRecoverPassword = ({
   })
 
   const mutation = useMutation({
-    mutationFn: ({ email }) => AuthApi.recoverPassword({ email }),
+    mutationFn: ({ email }) => ApiClass.recoverPassword({ email }),
     ...options, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       options?.onError?.(err, variables, context)

packages/authentication/modules/access/useRecoverPassword/types.d.ts → packages/authentication/modules/access/useRecoverPassword/types.ts

@@ -1,10 +1,14 @@
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import AuthApi from '../../../services/auth'
 import { IForgotPasswordRequest } from '../../../types/auth'
 
+type ApiClass = Pick<typeof AuthApi, 'recoverPassword'>
+
 export interface IUseRecoverPassword {
   // TODO: refactor types
   validationSchema?: any
   defaultValues?: IForgotPasswordRequest
   options?: UseMutationOptions<void, unknown, IForgotPasswordRequest, any>
+  ApiClass?: ApiClass
 }

packages/authentication/modules/access/useResetPassword/index.ts

@@ -12,6 +12,7 @@ import { IUseResetPassword } from './types'
 const useResetPassword = ({
   validationSchema = DEFAULT_VALIDATION_SCHEMA,
   defaultValues = DEFAULT_INITIAL_VALUES,
+  ApiClass = AuthApi,
   options,
 }: IUseResetPassword) => {
   const form = useForm({
@@ -20,7 +21,7 @@ const useResetPassword = ({
   })
 
   const mutation = useMutation({
-    mutationFn: ({ newPassword, token }) => AuthApi.resetPassword({ newPassword, token }),
+    mutationFn: ({ newPassword, token }) => ApiClass.resetPassword({ newPassword, token }),
     ...options, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       options?.onError?.(err, variables, context)

packages/authentication/modules/access/useResetPassword/types.d.ts → packages/authentication/modules/access/useResetPassword/types.ts

@@ -1,10 +1,14 @@
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import AuthApi from '../../../services/auth'
 import { IResetPasswordRequest } from '../../../types/auth'
 
+type ApiClass = Pick<typeof AuthApi, 'resetPassword'>
+
 export interface IUseResetPassword {
   // TODO: refactor types
   validationSchema?: any
   defaultValues?: IResetPasswordRequest
   options?: UseMutationOptions<void, unknown, IResetPasswordRequest, any>
+  ApiClass?: ApiClass
 }

packages/authentication/modules/access/useSignUp/index.ts

@@ -12,6 +12,7 @@ import { IUseSignUp } from './types'
 const useSignUp = <TRegisterRequest extends IRegisterRequest, TRegisterResponse = void>({
   validationSchema = DEFAULT_VALIDATION_SCHEMA,
   defaultValues = DEFAULT_INITIAL_VALUES as TRegisterRequest,
+  ApiClass = AuthApi,
   options,
 }: IUseSignUp<TRegisterRequest, TRegisterResponse>) => {
   const form = useForm({
@@ -21,7 +22,7 @@ const useSignUp = <TRegisterRequest extends IRegisterRequest, TRegisterResponse
   })
 
   const mutation = useMutation({
-    mutationFn: (values) => AuthApi.register<TRegisterResponse>(values),
+    mutationFn: (values) => ApiClass.register<TRegisterResponse>(values),
     ...options, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       options?.onError?.(err, variables, context)

packages/authentication/modules/access/useSignUp/types.d.ts → packages/authentication/modules/access/useSignUp/types.ts

@@ -1,10 +1,14 @@
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import AuthApi from '../../../services/auth'
 import { IRegisterRequest } from '../../../types/auth'
 
-export interface IUseSignUp<TRegisterRequest = IRegisterRequest, TRegisterResponse> {
+type ApiClass = Pick<typeof AuthApi, 'register'>
+
+export interface IUseSignUp<TRegisterRequest = IRegisterRequest, TRegisterResponse = void> {
   // TODO: refactor types
   validationSchema?: any
   defaultValues?: TRegisterRequest
+  ApiClass?: ApiClass
   options?: UseMutationOptions<TRegisterResponse, unknown, TRegisterRequest, any>
 }

packages/authentication/modules/mfa/useMfaActivate/index.ts

@@ -3,9 +3,9 @@ import { useMutation } from '@tanstack/react-query'
 import MfaApi from '../../../services/mfa'
 import { IUseMfaActivate } from './types'
 
-const useMfaActivate = ({ options }: IUseMfaActivate = {}) =>
+const useMfaActivate = ({ options, ApiClass = MfaApi }: IUseMfaActivate = {}) =>
   useMutation({
-    mutationFn: ({ method }) => MfaApi.activate({ method }),
+    mutationFn: ({ method }) => ApiClass.activate({ method }),
     ...options, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       options?.onError?.(err, variables, context)

packages/authentication/modules/mfa/useMfaActivate/types.d.ts → packages/authentication/modules/mfa/useMfaActivate/types.ts

@@ -1,7 +1,11 @@
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import MfaApi from '../../../services/mfa'
 import { IMfaActivationResponse, IMfaRequest } from '../../../types/mfa'
 
+type ApiClass = Pick<typeof MfaApi, 'activate'>
+
 export interface IUseMfaActivate {
   options?: UseMutationOptions<IMfaActivationResponse, unknown, Pick<IMfaRequest, 'method'>, any>
+  ApiClass?: ApiClass
 }

packages/authentication/modules/mfa/useMfaActivateConfirm/index.ts

@@ -12,6 +12,7 @@ const useMfaActivateConfirm = ({
   method,
   validationSchema = CODE_VALIDATION_SCHEMA,
   defaultValues = CODE_VALIDATION_INITIAL_VALUES,
+  ApiClass = MfaApi,
   options = {},
 }: IUseMfaActivateConfirm) => {
   const form = useForm({
@@ -21,7 +22,7 @@ const useMfaActivateConfirm = ({
   const queryClient = useQueryClient()
 
   const mutation = useMutation({
-    mutationFn: (data) => MfaApi.confirmActivation(data),
+    mutationFn: (data) => ApiClass.confirmActivation(data),
     ...options, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       options?.onError?.(err, variables, context)

packages/authentication/modules/mfa/useMfaActivateConfirm/types.d.ts → packages/authentication/modules/mfa/useMfaActivateConfirm/types.ts

@@ -1,11 +1,15 @@
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import MfaApi from '../../../services/mfa'
 import { IMfaConfirmationResponse, IMfaRequest, MfaMethod } from '../../../types/mfa'
 
+type ApiClass = Pick<typeof MfaApi, 'confirmActivation'>
+
 export interface IUseMfaActivateConfirm {
   // TODO: refactor types
   validationSchema?: any
   defaultValues?: Partial<IMfaRequest>
   options?: UseMutationOptions<IMfaConfirmationResponse, unknown, IMfaRequest, any>
+  ApiClass?: ApiClass
   method: MfaMethod
 }

packages/authentication/modules/mfa/useMfaActiveMethods/index.ts

@@ -3,11 +3,11 @@ import { useQuery } from '@tanstack/react-query'
 import MfaApi, { MFA_API_KEY } from '../../../services/mfa'
 import { IUseMfaActiveMethods } from './types'
 
-const useMfaActiveMethods = ({ options }: IUseMfaActiveMethods = {}) => {
+const useMfaActiveMethods = ({ options, ApiClass = MfaApi }: IUseMfaActiveMethods = {}) => {
   const { enabled = true, ...restOptions } = options || {}
 
   const { data, ...rest } = useQuery({
-    queryFn: () => MfaApi.getActiveMethods(),
+    queryFn: () => ApiClass.getActiveMethods(),
     queryKey: MFA_API_KEY.getActiveMethods(),
     ...restOptions, // needs to be placed bellow all overridable options
     enabled,

packages/authentication/modules/mfa/useMfaActiveMethods/types.d.ts → packages/authentication/modules/mfa/useMfaActiveMethods/types.ts

@@ -2,13 +2,17 @@ import { IDjangoPaginatedResponse } from '@baseapp-frontend/utils'
 
 import { UseQueryOptions } from '@tanstack/react-query'
 
+import MfaApi from '../../../services/mfa'
 import { IMfaActiveMethodResponse } from '../../../types/mfa'
 
+type ApiClass = Pick<typeof MfaApi, 'getActiveMethods'>
+
 export interface IUseMfaActiveMethods {
   options?: UseQueryOptions<
     IDjangoPaginatedResponse<IMfaActiveMethodResponse>,
     unknown,
     IDjangoPaginatedResponse<IMfaActiveMethodResponse>,
     any
   >
+  ApiClass?: ApiClass
 }

packages/authentication/modules/mfa/useMfaConfiguration/index.ts

@@ -3,10 +3,10 @@ import { useQuery } from '@tanstack/react-query'
 import MfaApi, { MFA_API_KEY } from '../../../services/mfa'
 import { IUseMfaConfiguration } from './types'
 
-const useMfaConfiguration = ({ options }: IUseMfaConfiguration = {}) => {
+const useMfaConfiguration = ({ options, ApiClass = MfaApi }: IUseMfaConfiguration = {}) => {
   const { enabled = true, ...restOptions } = options || {}
   const { data: configuration, ...rest } = useQuery({
-    queryFn: () => MfaApi.getConfiguration(),
+    queryFn: () => ApiClass.getConfiguration(),
     queryKey: MFA_API_KEY.getConfiguration(),
     ...options, // needs to be placed bellow all overridable options
     enabled,

packages/authentication/modules/mfa/useMfaConfiguration/types.d.ts → packages/authentication/modules/mfa/useMfaConfiguration/types.ts

@@ -1,7 +1,11 @@
 import { UseQueryOptions } from '@tanstack/react-query'
 
+import MfaApi from '../../../services/mfa'
 import { IMfaConfigurationResponse } from '../../../types/mfa'
 
+type ApiClass = Pick<typeof MfaApi, 'getConfiguration'>
+
 export interface IUseMfaConfiguration {
   options?: UseQueryOptions<IMfaConfigurationResponse, unknown, IMfaConfigurationResponse, any>
+  ApiClass?: ApiClass
 }

packages/authentication/modules/mfa/useMfaDeactivate/index.ts

@@ -3,11 +3,11 @@ import { useMutation, useQueryClient } from '@tanstack/react-query'
 import MfaApi, { MFA_API_KEY } from '../../../services/mfa'
 import { IUseMfaDeactivate } from './types'
 
-const useMfaDeactivate = ({ options }: IUseMfaDeactivate = {}) => {
+const useMfaDeactivate = ({ options, ApiClass = MfaApi }: IUseMfaDeactivate = {}) => {
   const queryClient = useQueryClient()
 
   return useMutation({
-    mutationFn: ({ method, code }) => MfaApi.deactivate({ method, code }),
+    mutationFn: ({ method, code }) => ApiClass.deactivate({ method, code }),
     ...options, // needs to be placed bellow all overridable options
     onError: (err, variables, context) => {
       options?.onError?.(err, variables, context)

packages/authentication/modules/mfa/useMfaDeactivate/types.d.ts → packages/authentication/modules/mfa/useMfaDeactivate/types.ts

@@ -1,7 +1,11 @@
 import { UseMutationOptions } from '@tanstack/react-query'
 
+import MfaApi from '../../../services/mfa'
 import { IMfaDeactivateRequest } from '../../../types/mfa'
 
+type ApiClass = Pick<typeof MfaApi, 'deactivate'>
+
 export interface IUseMfaDeactivate {
   options?: UseMutationOptions<void, unknown, IMfaDeactivateRequest, any>
+  ApiClass?: ApiClass
 }

packages/authentication/modules/user/useSimpleTokenUser/index.ts

@@ -10,12 +10,13 @@ import { IUseSimpleTokenUser } from './types'
 const useSimpleTokenUser = <TUser extends Partial<IUser>>({
   options,
   cookieName = ACCESS_COOKIE_NAME,
+  ApiClass = UserApi,
 }: IUseSimpleTokenUser<TUser> = {}) => {
   const token = Cookies.get(cookieName)
   const queryClient = useQueryClient()
 
   const { data: user, ...rest } = useQuery({
-    queryFn: () => UserApi.getUser<TUser>(),
+    queryFn: () => ApiClass.getUser<TUser>(),
     queryKey: USER_API_KEY.getUser(),
     staleTime: Infinity, // makes cache never expire automatically
     enabled: !!token,

packages/authentication/modules/user/useSimpleTokenUser/types.d.ts → packages/authentication/modules/user/useSimpleTokenUser/types.ts

@@ -1,7 +1,11 @@
 import { UseQueryOptions } from '@tanstack/react-query'
 
+import UserApi from '../../../services/user'
 import { ICookieName } from '../../../types/auth'
 
+type ApiClass = Pick<typeof UserApi, 'getUser'>
+
 export interface IUseSimpleTokenUser<IUser> extends ICookieName {
   options?: UseQueryOptions<IUser, unknown, IUser, any>
+  ApiClass?: ApiClass
 }

packages/authentication/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@baseapp-frontend/authentication",
   "description": "Authentication modules.",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "main": "./dist/index.ts",
   "module": "./dist/index.mjs",
   "scripts": {