fix: dashboard / type fixes (#541)

* fix: dashboard

* fix: adding missing to_json function in TenantConfig

* fix: version and changelog

* fix: login methods and user put

Author: sattvikc

CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.25.1] - 2024-11-08
+
+- Fixes issues with dashboard - userroles and tenants
+- Fixes `LoginMethod` to json conversion to not include `null` as values
+- Adds `to_json` method to `TenantConfig`
+
 ## [0.25.0] - 2024-09-18
 
 ### Overview

setup.py

@@ -89,7 +89,7 @@
 
 setup(
     name="supertokens_python",
-    version="0.25.0",
+    version="0.25.1",
     author="SuperTokens",
     license="Apache 2.0",
     author_email="[email protected]",

supertokens_python/constants.py

@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 SUPPORTED_CDI_VERSIONS = ["5.1"]
-VERSION = "0.25.0"
+VERSION = "0.25.1"
 TELEMETRY = "/telemetry"
 USER_COUNT = "/users/count"
 USER_DELETE = "/user/remove"

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

@@ -339,6 +339,9 @@ async def handle_user_put(
             user_context,
         )
 
+        if isinstance(email_update_response, EmailChangeNotAllowedErrorResponse):
+            return EmailChangeNotAllowedErrorResponse(email_update_response.error)
+
         if not isinstance(email_update_response, OkResponse):
             return email_update_response
 
@@ -350,6 +353,9 @@ async def handle_user_put(
             user_context,
         )
 
+        if isinstance(phone_update_response, PhoneNumberChangeNotAllowedErrorResponse):
+            return PhoneNumberChangeNotAllowedErrorResponse(phone_update_response.error)
+
         if not isinstance(phone_update_response, OkResponse):
             return phone_update_response
 

supertokens_python/recipe/dashboard/constants.py

@@ -21,6 +21,8 @@
 CREATE_EMAIL_PASSWORD_USER = "/api/user/emailpassword"
 CREATE_PASSWORDLESS_USER = "/api/user/passwordless"
 UNLINK_USER = "/api/user/unlink"
+
+USERROLES_LIST_API = "/api/userroles/roles"
 USERROLES_PERMISSIONS_API = "/api/userroles/role/permissions"
 USERROLES_REMOVE_PERMISSIONS_API = "/api/userroles/role/permissions/remove"
 USERROLES_ROLE_API = "/api/userroles/role"

supertokens_python/recipe/dashboard/recipe.py

@@ -142,6 +142,7 @@
     CREATE_EMAIL_PASSWORD_USER,
     CREATE_PASSWORDLESS_USER,
     UNLINK_USER,
+    USERROLES_LIST_API,
     USERROLES_PERMISSIONS_API,
     USERROLES_REMOVE_PERMISSIONS_API,
     USERROLES_ROLE_API,
@@ -198,6 +199,18 @@ def get_apis_handled(self) -> List[APIHandled]:
                 DASHBOARD_API,
                 False,
             ),
+            APIHandled(
+                NormalisedURLPath(get_api_path_with_dashboard_base("/roles")),
+                "get",
+                DASHBOARD_API,
+                False,
+            ),
+            APIHandled(
+                NormalisedURLPath(get_api_path_with_dashboard_base("/tenants")),
+                "get",
+                DASHBOARD_API,
+                False,
+            ),
             APIHandled(
                 NormalisedURLPath(get_api_path_with_dashboard_base(SIGN_IN_API)),
                 "post",
@@ -442,6 +455,12 @@ def get_apis_handled(self) -> List[APIHandled]:
                 USERROLES_REMOVE_PERMISSIONS_API,
                 False,
             ),
+            APIHandled(
+                NormalisedURLPath(get_api_path_with_dashboard_base(USERROLES_LIST_API)),
+                "get",
+                USERROLES_LIST_API,
+                False,
+            ),
             APIHandled(
                 NormalisedURLPath(get_api_path_with_dashboard_base(USERROLES_ROLE_API)),
                 "put",
@@ -583,6 +602,8 @@ async def handle_api_request(
             api_function = create_passwordless_user
         elif request_id == UNLINK_USER:
             api_function = handle_user_unlink_get
+        elif request_id == USERROLES_LIST_API:
+            api_function = get_all_roles_api
         elif request_id == USERROLES_PERMISSIONS_API:
             api_function = get_permissions_for_role_api
         elif request_id == USERROLES_REMOVE_PERMISSIONS_API:

supertokens_python/recipe/multitenancy/interfaces.py

@@ -56,6 +56,17 @@ def from_json(json: Dict[str, Any]) -> TenantConfig:
             required_secondary_factors=json.get("requiredSecondaryFactors", []),
         )
 
+    def to_json(self) -> Dict[str, Any]:
+        res: Dict[str, Any] = {}
+        res["tenantId"] = self.tenant_id
+        res["thirdPartyProviders"] = [
+            provider.to_json() for provider in self.third_party_providers
+        ]
+        res["firstFactors"] = self.first_factors
+        res["requiredSecondaryFactors"] = self.required_secondary_factors
+        res["coreConfig"] = self.core_config
+        return res
+
 
 class TenantConfigCreateOrUpdate:
     # pylint: disable=dangerous-default-value

supertokens_python/types.py

@@ -131,16 +131,20 @@ def has_same_third_party_info_as(
         )
 
     def to_json(self) -> Dict[str, Any]:
-        return {
+        result: Dict[str, Any] = {
             "recipeId": self.recipe_id,
             "recipeUserId": self.recipe_user_id.get_as_string(),
             "tenantIds": self.tenant_ids,
-            "email": self.email,
-            "phoneNumber": self.phone_number,
-            "thirdParty": self.third_party.to_json() if self.third_party else None,
             "timeJoined": self.time_joined,
             "verified": self.verified,
         }
+        if self.email is not None:
+            result["email"] = self.email
+        if self.phone_number is not None:
+            result["phoneNumber"] = self.phone_number
+        if self.third_party is not None:
+            result["thirdParty"] = self.third_party.to_json()
+        return result
 
     @staticmethod
     def from_json(json: Dict[str, Any]) -> "LoginMethod":