Merge pull request #258 from supertokens/feat/dashboard-user-details

feat: Dashboard user details APIs

Author: rishabhpoddar

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## unreleased
 
+## [0.11.8] - 2022-11-28
+
+### Added:
+-   APIs for user details to the dashboard recipe
+
+### Changed:
+- Updates dashboard version to 0.2
 - Add tests for different scenarios while revoking session during session refresh call
 
 ## [0.11.7] - 2022-11-21

setup.py

@@ -70,7 +70,7 @@
 
 setup(
     name="supertokens_python",
-    version="0.11.7",
+    version="0.11.8",
     author="SuperTokens",
     license="Apache 2.0",
     author_email="[email protected]",

supertokens_python/constants.py

@@ -12,7 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 SUPPORTED_CDI_VERSIONS = ["2.9", "2.10", "2.11", "2.12", "2.13", "2.14", "2.15"]
-VERSION = "0.11.7"
+VERSION = "0.11.8"
 TELEMETRY = "/telemetry"
 USER_COUNT = "/users/count"
 USER_DELETE = "/user/remove"
@@ -25,4 +25,4 @@
 FDI_KEY_HEADER = "fdi-version"
 API_VERSION = "/apiversion"
 API_VERSION_HEADER = "cdi-version"
-DASHBOARD_VERSION = "0.1"
+DASHBOARD_VERSION = "0.2"

supertokens_python/exceptions.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import Union
+from typing import Union, NoReturn
 
 
 def raise_general_exception(
@@ -26,7 +26,7 @@ def raise_general_exception(
     raise GeneralError(msg) from previous
 
 
-def raise_bad_input_exception(msg: str):
+def raise_bad_input_exception(msg: str) -> NoReturn:
     raise BadInputError(msg)
 
 

supertokens_python/recipe/dashboard/api/__init__.py

@@ -11,8 +11,19 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-from .dashboard import handle_dashboard_api
 from .api_key_protector import api_key_protector
+from .dashboard import handle_dashboard_api
+from .userdetails.user_delete import handle_user_delete
+from .userdetails.user_email_verify_get import handle_user_email_verify_get
+from .userdetails.user_email_verify_put import handle_user_email_verify_put
+from .userdetails.user_email_verify_token_post import handle_email_verify_token_post
+from .userdetails.user_get import handle_user_get
+from .userdetails.user_metadata_get import handle_metadata_get
+from .userdetails.user_metadata_put import handle_metadata_put
+from .userdetails.user_password_put import handle_user_password_put
+from .userdetails.user_put import handle_user_put
+from .userdetails.user_sessions_get import handle_sessions_get
+from .userdetails.user_sessions_post import handle_user_sessions_post
 from .users_count_get import handle_users_count_get_api
 from .users_get import handle_users_get_api
 from .validate_key import handle_validate_key_api
@@ -23,4 +34,15 @@
     "handle_users_count_get_api",
     "handle_users_get_api",
     "handle_validate_key_api",
+    "handle_user_email_verify_get",
+    "handle_user_get",
+    "handle_metadata_get",
+    "handle_sessions_get",
+    "handle_user_delete",
+    "handle_user_put",
+    "handle_user_email_verify_put",
+    "handle_metadata_put",
+    "handle_user_sessions_post",
+    "handle_user_password_put",
+    "handle_email_verify_token_post",
 ]

supertokens_python/recipe/dashboard/api/api_key_protector.py

@@ -22,19 +22,19 @@
         APIOptions,
         APIInterface,
     )
+    from supertokens_python.types import APIResponse
 
 from supertokens_python.utils import (
     default_user_context,
+    send_200_response,
     send_non_200_response_with_message,
 )
 
 
 async def api_key_protector(
     api_implementation: APIInterface,
     api_options: APIOptions,
-    api_function: Callable[
-        [APIInterface, APIOptions], Awaitable[Optional[BaseResponse]]
-    ],
+    api_function: Callable[[APIInterface, APIOptions], Awaitable[APIResponse]],
 ) -> Optional[BaseResponse]:
     user_context = default_user_context(api_options.request)
     should_allow_access = await api_options.recipe_implementation.should_allow_access(
@@ -43,7 +43,8 @@ async def api_key_protector(
 
     if should_allow_access is False:
         return send_non_200_response_with_message(
-            "Unauthorized access", 401, api_options.response
+            "Unauthorised access", 401, api_options.response
         )
 
-    return await api_function(api_implementation, api_options)
+    response = await api_function(api_implementation, api_options)
+    return send_200_response(response.to_json(), api_options.response)

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

@@ -0,0 +1,16 @@
+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
+) -> UserDeleteAPIResponse:
+    user_id = api_options.request.get_query_param("userId")
+
+    if user_id is None:
+        raise_bad_input_exception("Missing required parameter 'userId'")
+
+    await Supertokens.get_instance().delete_user(user_id)
+
+    return UserDeleteAPIResponse()

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

@@ -0,0 +1,29 @@
+from supertokens_python.exceptions import raise_bad_input_exception
+from supertokens_python.recipe.emailverification import EmailVerificationRecipe
+from supertokens_python.recipe.emailverification.asyncio import is_email_verified
+from ...interfaces import (
+    APIInterface,
+    APIOptions,
+    UserEmailVerifyGetAPIResponse,
+    FeatureNotEnabledError,
+)
+
+from typing import Union
+
+
+async def handle_user_email_verify_get(
+    _api_interface: APIInterface, api_options: APIOptions
+) -> Union[UserEmailVerifyGetAPIResponse, FeatureNotEnabledError]:
+    req = api_options.request
+    user_id = req.get_query_param("userId")
+
+    if user_id is None:
+        raise_bad_input_exception("Missing required parameter 'userId'")
+
+    try:
+        EmailVerificationRecipe.get_instance()
+    except Exception:
+        return FeatureNotEnabledError()
+
+    is_verified = await is_email_verified(user_id)
+    return UserEmailVerifyGetAPIResponse(is_verified)

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

@@ -0,0 +1,55 @@
+from typing import Any, Dict
+
+from supertokens_python.exceptions import raise_bad_input_exception
+from supertokens_python.recipe.emailverification.asyncio import (
+    create_email_verification_token,
+    unverify_email,
+    verify_email_using_token,
+)
+from supertokens_python.recipe.emailverification.interfaces import (
+    CreateEmailVerificationTokenEmailAlreadyVerifiedError,
+    VerifyEmailUsingTokenInvalidTokenError,
+)
+
+from ...interfaces import (
+    APIInterface,
+    APIOptions,
+    UserEmailVerifyPutAPIResponse,
+)
+
+
+async def handle_user_email_verify_put(
+    _api_interface: APIInterface, api_options: APIOptions
+) -> UserEmailVerifyPutAPIResponse:
+    request_body: Dict[str, Any] = await api_options.request.json()  # type: ignore
+    user_id = request_body.get("userId")
+    verified = request_body.get("verified")
+
+    if user_id is None or not isinstance(user_id, str):
+        raise_bad_input_exception(
+            "Required parameter 'userId' is missing or has an invalid type"
+        )
+
+    if verified is None or not isinstance(verified, bool):
+        raise_bad_input_exception(
+            "Required parameter 'verified' is missing or has an invalid type"
+        )
+
+    if verified:
+        token_response = await create_email_verification_token(user_id)
+
+        if isinstance(
+            token_response, CreateEmailVerificationTokenEmailAlreadyVerifiedError
+        ):
+            return UserEmailVerifyPutAPIResponse()
+
+        verify_response = await verify_email_using_token(token_response.token)
+
+        if isinstance(verify_response, VerifyEmailUsingTokenInvalidTokenError):
+            # This should never happen because we consume the token immediately after creating it
+            raise Exception("Should not come here")
+
+    else:
+        await unverify_email(user_id)
+
+    return UserEmailVerifyPutAPIResponse()