Pass generic for getToken argument to AuthImplementation and AuthCont…

…extInterface
redwoodjs · Jan 22, 2025 · a7773ab · a7773ab
1 parent 231e1f9
commit a7773ab
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 2 deletions.
diff --git a/packages/auth/src/AuthContext.ts b/packages/auth/src/AuthContext.ts
@@ -12,6 +12,7 @@ export interface AuthContextInterface<
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -51,7 +52,7 @@ export interface AuthContextInterface<
    * Clients should always return null or string
    * It is expected that they catch any errors internally
    */
-  getToken(): Promise<null | string>
+  getToken(options?: TGetTokenOptions): Promise<null | string>
   /**
    * Fetches the "currentUser" from the api side,
    * but does not update the current user state.
@@ -89,6 +90,7 @@ export function createAuthContext<
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -104,6 +106,7 @@ export function createAuthContext<
         TLogOut,
         TSignUpOptions,
         TSignUp,
+        TGetTokenOptions,
         TForgotPassword,
         TResetPasswordOptions,
         TResetPassword,

diff --git a/packages/auth/src/AuthImplementation.ts b/packages/auth/src/AuthImplementation.ts
@@ -7,6 +7,7 @@ export interface AuthImplementation<
   TLogOut = unknown,
   TSignUpOptions = unknown,
   TSignUp = unknown,
+  TGetTokenOptions = unknown,
   TForgotPassword = unknown,
   TResetPasswordOptions = unknown,
   TResetPassword = unknown,
@@ -20,7 +21,7 @@ export interface AuthImplementation<
   login(options?: TLogInOptions): Promise<TLogIn>
   logout(options?: TLogOutOptions): Promise<TLogOut>
   signup(options?: TSignUpOptions): Promise<TSignUp>
-  getToken(): Promise<string | null>
+  getToken(options?: TGetTokenOptions): Promise<string | null>
   forgotPassword?(username: string): Promise<TForgotPassword>
   resetPassword?(options?: TResetPasswordOptions): Promise<TResetPassword>
   validateResetToken?(token: string | null): Promise<TValidateResetToken>

diff --git a/packages/auth/src/AuthProvider/AuthProvider.tsx b/packages/auth/src/AuthProvider/AuthProvider.tsx
@@ -31,6 +31,7 @@ export function createAuthProvider<
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -46,6 +47,7 @@ export function createAuthProvider<
         TLogOut,
         TSignUpOptions,
         TSignUp,
+        TGetTokenOptions,
         TForgotPassword,
         TResetPasswordOptions,
         TResetPassword,
@@ -63,6 +65,7 @@ export function createAuthProvider<
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/AuthProvider/useForgotPassword.ts b/packages/auth/src/AuthProvider/useForgotPassword.ts
@@ -11,6 +11,7 @@ export const useForgotPassword = <
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -26,6 +27,7 @@ export const useForgotPassword = <
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/AuthProvider/useLogIn.ts b/packages/auth/src/AuthProvider/useLogIn.ts
@@ -16,6 +16,7 @@ export const useLogIn = <
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -31,6 +32,7 @@ export const useLogIn = <
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/AuthProvider/useLogOut.ts b/packages/auth/src/AuthProvider/useLogOut.ts
@@ -13,6 +13,7 @@ export const useLogOut = <
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -28,6 +29,7 @@ export const useLogOut = <
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/AuthProvider/useResetPassword.ts b/packages/auth/src/AuthProvider/useResetPassword.ts
@@ -11,6 +11,7 @@ export const useResetPassword = <
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -26,6 +27,7 @@ export const useResetPassword = <
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/AuthProvider/useSignUp.ts b/packages/auth/src/AuthProvider/useSignUp.ts
@@ -15,6 +15,7 @@ export const useSignUp = <
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -30,6 +31,7 @@ export const useSignUp = <
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/AuthProvider/useValidateResetToken.ts b/packages/auth/src/AuthProvider/useValidateResetToken.ts
@@ -11,6 +11,7 @@ export const useValidateResetToken = <
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -26,6 +27,7 @@ export const useValidateResetToken = <
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/authFactory.ts b/packages/auth/src/authFactory.ts
@@ -20,6 +20,7 @@ export function createAuthentication<
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -35,6 +36,7 @@ export function createAuthentication<
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,
@@ -56,6 +58,7 @@ export function createAuthentication<
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,

diff --git a/packages/auth/src/useAuth.ts b/packages/auth/src/useAuth.ts
@@ -10,6 +10,7 @@ export function createUseAuth<
   TLogOut,
   TSignUpOptions,
   TSignUp,
+  TGetTokenOptions,
   TForgotPassword,
   TResetPasswordOptions,
   TResetPassword,
@@ -25,6 +26,7 @@ export function createUseAuth<
         TLogOut,
         TSignUpOptions,
         TSignUp,
+        TGetTokenOptions,
         TForgotPassword,
         TResetPasswordOptions,
         TResetPassword,
@@ -42,6 +44,7 @@ export function createUseAuth<
     TLogOut,
     TSignUpOptions,
     TSignUp,
+    TGetTokenOptions,
     TForgotPassword,
     TResetPasswordOptions,
     TResetPassword,
@@ -72,6 +75,7 @@ export function useNoAuth(): AuthContextInterface<
   void,
   void,
   void,
+  void,
   undefined
 > {
   return {
@@ -107,5 +111,6 @@ export type UseAuth = () => AuthContextInterface<
   unknown,
   unknown,
   unknown,
+  unknown,
   unknown
 >
diff --git a/packages/router/src/__tests__/pageLoadingContext.test.tsx b/packages/router/src/__tests__/pageLoadingContext.test.tsx
@@ -65,6 +65,7 @@ type UnknownAuthContextInterface = AuthContextInterface<
   unknown,
   unknown,
   unknown,
+  unknown,
   unknown
 >
 

diff --git a/packages/router/src/__tests__/router.test.tsx b/packages/router/src/__tests__/router.test.tsx
@@ -40,6 +40,7 @@ type UnknownAuthContextInterface = AuthContextInterface<
   unknown,
   unknown,
   unknown,
+  unknown,
   unknown
 >
 

diff --git a/packages/router/src/router-context.tsx b/packages/router/src/router-context.tsx
@@ -18,6 +18,7 @@ type UseAuth = () => AuthContextInterface<
   unknown,
   unknown,
   unknown,
+  unknown,
   unknown
 >
 

diff --git a/packages/web/src/components/__tests__/FetchConfigProvider.test.tsx b/packages/web/src/components/__tests__/FetchConfigProvider.test.tsx
@@ -26,6 +26,7 @@ type UnknownAuthContext = AuthContextInterface<
   unknown,
   unknown,
   unknown,
+  unknown,
   unknown
 >