fix: Make the dashboard functions strongly typed

Author: KShivendu

supertokens_python/recipe/dashboard/api/userdetails/user_delete.py

@@ -1,11 +1,11 @@
-from ...interfaces import APIInterface, APIOptions, APIResponse, UserDeleteAPIResponse
+from ...interfaces import APIInterface, APIOptions, UserDeleteAPIResponse
 from supertokens_python.exceptions import raise_bad_input_exception
 from supertokens_python import Supertokens
 
 
 async def handle_user_delete(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> UserDeleteAPIResponse:
     user_id = api_options.request.get_query_param("userId")
 
     if user_id is None:

supertokens_python/recipe/dashboard/api/userdetails/user_email_verify_get.py

@@ -8,12 +8,12 @@
     FeatureNotEnabledError,
 )
 
-from supertokens_python.types import APIResponse
+from typing import Union
 
 
 async def handle_user_email_verify_get(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> Union[UserEmailVerifyGetAPIResponse, FeatureNotEnabledError]:
     req = api_options.request
     user_id = req.get_query_param("userId")
 

supertokens_python/recipe/dashboard/api/userdetails/user_email_verify_put.py

@@ -14,14 +14,13 @@
 from ...interfaces import (
     APIInterface,
     APIOptions,
-    APIResponse,
     UserEmailVerifyPutAPIResponse,
 )
 
 
 async def handle_user_email_verify_put(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> UserEmailVerifyPutAPIResponse:
     request_body: Dict[str, Any] = await api_options.request.json()  # type: ignore
     user_id = request_body.get("userId")
     verified = request_body.get("verified")

supertokens_python/recipe/dashboard/api/userdetails/user_email_verify_token_post.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Any, Dict, Union
 
 from supertokens_python.exceptions import raise_bad_input_exception
 from supertokens_python.recipe.emailverification.asyncio import (
@@ -13,34 +13,26 @@
     EmailVerificationRecipe,
     GetEmailForUserIdOkResult,
 )
-from supertokens_python.recipe.emailverification.utils import get_email_verify_link
-from supertokens_python.types import APIResponse
 from supertokens_python.recipe.emailverification.types import (
     VerificationEmailTemplateVars,
     VerificationEmailTemplateVarsUser,
 )
+from supertokens_python.recipe.emailverification.utils import get_email_verify_link
 
-from ...interfaces import APIInterface, APIOptions, APIResponse
-
-
-class UserEmailVerifyTokenPostAPIOkResponse(APIResponse):
-    # TODO: Move to interfaces.py
-    status: str = "OK"
-
-    def to_json(self) -> Dict[str, Any]:
-        return {"status": self.status}
-
-
-class UserEmailVerifyTokenPostAPIEmailAlreadyVerifiedErrorResponse(APIResponse):
-    status: str = "EMAIL_ALREADY_VERIFIED_ERROR"
-
-    def to_json(self) -> Dict[str, Any]:
-        return {"status": self.status}
+from ...interfaces import (
+    APIInterface,
+    APIOptions,
+    UserEmailVerifyTokenPostAPIEmailAlreadyVerifiedErrorResponse,
+    UserEmailVerifyTokenPostAPIOkResponse,
+)
 
 
 async def handle_email_verify_token_post(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> Union[
+    UserEmailVerifyTokenPostAPIOkResponse,
+    UserEmailVerifyTokenPostAPIEmailAlreadyVerifiedErrorResponse,
+]:
     request_body: Dict[str, Any] = await api_options.request.json()  # type: ignore
     user_id = request_body.get("userId")
 

supertokens_python/recipe/dashboard/api/userdetails/user_get.py

@@ -2,7 +2,6 @@
 
 from supertokens_python.recipe.usermetadata import UserMetadataRecipe
 from supertokens_python.recipe.usermetadata.asyncio import get_user_metadata
-from supertokens_python.types import APIResponse
 
 from supertokens_python.recipe.dashboard.utils import get_user_for_recipe_id
 
@@ -13,11 +12,12 @@
     UserGetAPIOkResponse,
 )
 from ...utils import is_valid_recipe_id
+from typing import Union
 
 
 async def handle_user_get(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> Union[UserGetAPINoUserFoundError, UserGetAPIOkResponse]:
     user_id = api_options.request.get_query_param("userId")
     recipe_id = api_options.request.get_query_param("recipeId")
 
@@ -30,34 +30,29 @@ async def handle_user_get(
     if not is_valid_recipe_id(recipe_id):
         raise_bad_input_exception("Invalid recipe id")
 
-    user = (await get_user_for_recipe_id(user_id, recipe_id)).get("user")
-
-    if user is None:
+    user_response = await get_user_for_recipe_id(user_id, recipe_id)
+    if user_response is None:
         return UserGetAPINoUserFoundError()
 
+    user = user_response.user
+
     # FIXME: Shouldn't be required, no?
     recipe_id_: str = recipe_id  # type: ignore
     user_id_: str = user_id  # type: ignore
 
     try:
         UserMetadataRecipe.get_instance()
     except Exception:
-        user = {
-            **user,
-            "firstName": "FEATURE_NOT_ENABLED",
-            "lastName": "FEATURE_NOT_ENABLED",
-        }
+        user.first_name = "FEATURE_NOT_ENABLED"
+        user.last_name = "FEATURE_NOT_ENABLED"
 
         return UserGetAPIOkResponse(recipe_id_, user)
 
     user_metadata = await get_user_metadata(user_id_)
     first_name = user_metadata.metadata.get("first_name", "")
     last_name = user_metadata.metadata.get("last_name", "")
 
-    user = {
-        **user,
-        "firstName": first_name,
-        "lastName": last_name,
-    }
+    user.first_name = first_name
+    user.last_name = last_name
 
     return UserGetAPIOkResponse(recipe_id_, user)

supertokens_python/recipe/dashboard/api/userdetails/user_metadata_get.py

@@ -4,15 +4,15 @@
     FeatureNotEnabledError,
     UserMetadataGetAPIOkResponse,
 )
-from supertokens_python.types import APIResponse
 from supertokens_python.exceptions import raise_bad_input_exception
 from supertokens_python.recipe.usermetadata import UserMetadataRecipe
 from supertokens_python.recipe.usermetadata.asyncio import get_user_metadata
+from typing import Union
 
 
 async def handle_metadata_get(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> Union[UserMetadataGetAPIOkResponse, FeatureNotEnabledError]:
     user_id = api_options.request.get_query_param("userId")
 
     if user_id is None:

supertokens_python/recipe/dashboard/api/userdetails/user_metadata_put.py

@@ -7,21 +7,13 @@
     clear_user_metadata,
     update_user_metadata,
 )
-from supertokens_python.types import APIResponse
 
-from ...interfaces import APIInterface, APIOptions, APIResponse
-
-
-class UserMetadataPutAPIResponse(APIResponse):
-    status: str = "OK"
-
-    def to_json(self) -> Dict[str, Any]:
-        return {"status": self.status}
+from ...interfaces import APIInterface, APIOptions, UserMetadataPutAPIResponse
 
 
 async def handle_metadata_put(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> UserMetadataPutAPIResponse:
     request_body: Dict[str, Any] = await api_options.request.json()  # type: ignore
     user_id = request_body.get("userId")
     data = request_body.get("data")
@@ -39,16 +31,15 @@ async def handle_metadata_put(
             "Required parameter 'data' is missing or has an invalid type"
         )
 
+    parsed_data: Dict[str, Any] = {}
     try:
         parsed_data = json.loads(data)
-
-        if not isinstance(parsed_data, dict) or parsed_data is None:
+        if not isinstance(parsed_data, dict):  # type: ignore
             raise Exception()
 
     except Exception:
         raise_bad_input_exception("'data' must be a valid JSON body")
 
-    #
     # This API is meant to set the user metadata of a user. We delete the existing data
     # before updating it because we want to make sure that shallow merging does not result
     # in the data being incorrect
@@ -59,10 +50,7 @@ async def handle_metadata_put(
     #
     # Removing first ensures that the final data is exactly what the user wanted it to be
 
-    # FIXME: This Shouldn't be required
-    parsed_data_: Dict[str, Any] = parsed_data  # type: ignore
-
     await clear_user_metadata(user_id)
-    await update_user_metadata(user_id, parsed_data_)
+    await update_user_metadata(user_id, parsed_data)
 
     return UserMetadataPutAPIResponse()

supertokens_python/recipe/dashboard/api/userdetails/user_password_put.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Union
+from typing import Any, Callable, Dict, List, Union
 
 from supertokens_python.exceptions import raise_bad_input_exception
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
@@ -10,8 +10,10 @@
 )
 from supertokens_python.recipe.emailpassword.constants import FORM_FIELD_PASSWORD_ID
 from supertokens_python.recipe.emailpassword.interfaces import (
+    CreateResetPasswordOkResult,
     CreateResetPasswordWrongUserIdError,
     ResetPasswordUsingTokenInvalidTokenError,
+    ResetPasswordUsingTokenOkResult,
 )
 from supertokens_python.recipe.emailpassword.types import NormalisedFormField
 from supertokens_python.recipe.thirdpartyemailpassword import (
@@ -23,7 +25,7 @@
 from supertokens_python.recipe.thirdpartyemailpassword.asyncio import (
     reset_password_using_token as tpep_reset_password_using_token,
 )
-from supertokens_python.types import APIResponse
+from supertokens_python.utils import Awaitable
 from typing_extensions import Literal
 
 from ...interfaces import (
@@ -36,7 +38,7 @@
 
 async def handle_user_password_put(
     _api_interface: APIInterface, api_options: APIOptions
-) -> APIResponse:
+) -> Union[UserPasswordPutAPIResponse, UserPasswordPutAPIInvalidPasswordErrorResponse]:
     request_body: Dict[str, Any] = await api_options.request.json()  # type: ignore
     user_id = request_body.get("userId")
     new_password = request_body.get("newPassword")
@@ -69,9 +71,24 @@ async def handle_user_password_put(
 
     async def reset_password(
         recipe: Any,  # FIXME
-        create_reset_password_token: Any,  # FIXME
-        reset_password_using_token: Any,  # FIXME
-    ) -> APIResponse:
+        create_reset_password_token: Callable[
+            [str],
+            Awaitable[
+                Union[CreateResetPasswordOkResult, CreateResetPasswordWrongUserIdError]
+            ],
+        ],
+        reset_password_using_token: Callable[
+            [str, str],
+            Awaitable[
+                Union[
+                    ResetPasswordUsingTokenOkResult,
+                    ResetPasswordUsingTokenInvalidTokenError,
+                ]
+            ],
+        ],
+    ) -> Union[
+        UserPasswordPutAPIResponse, UserPasswordPutAPIInvalidPasswordErrorResponse
+    ]:
         form_fields: List[NormalisedFormField] = recipe.get_instance().config.sign_up_feature.form_fields  # type: ignore # FIXME?
         password_form_field = [
             field for field in form_fields if field.id == FORM_FIELD_PASSWORD_ID
@@ -91,10 +108,8 @@ async def reset_password(
             # UNKNOWN_USER_ID_ERROR FIXME
             raise Exception("Should never come here")
 
-        password_reset_response = (
-            await reset_password_using_token(  # type; ignore # FIXME
-                password_reset_token.token, new_password
-            )
+        password_reset_response = await reset_password_using_token(
+            password_reset_token.token, new_password
         )
 
         if isinstance(