Merge branch '0.11' into fix/session-claims

Author: KShivendu

CHANGELOG.md

@@ -6,12 +6,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
-### Added
-- Support for FDI 1.15
-
-### Breaking changes
-- Removes support for FDI <= 1.14
-
 ## [0.11.0] - 2022-09-14
 
 ### Changes
@@ -20,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Support for FDI 1.15
 - Added support for session claims with related interfaces and classes.
 - Added `on_invalid_claim` optional error handler to send InvalidClaim error responses.
 - Added `INVALID_CLAIMS` (`InvalidClaimError`) to `SessionErrors`.
@@ -34,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Adds default userContext for verifySession calls that contains the request object.
 
 ### Breaking Changes
+- Removes support for FDI <= 1.14
 -   Changed `sign_in_up` third party recipe function to accept just the email as `str` (removed `email_verified: bool`).
 -   The frontend SDK should be updated to a version supporting session claims!
     -   supertokens-auth-react: >= 0.25.0

html/supertokens_python/recipe/session/api/implementation.html

@@ -41,16 +41,17 @@ <h1 class="title">Module <code>supertokens_python.recipe.session.api.implementat
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Union, List, Callable, Optional
+from typing import TYPE_CHECKING, Callable, List, Optional, Union
 
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe.session.interfaces import (
     APIInterface,
-    SignOutOkayResponse,
     SessionClaimValidator,
+    SignOutOkayResponse,
 )
 from supertokens_python.types import MaybeAwaitable
 from supertokens_python.utils import normalise_http_method
+
 from ..utils import get_required_claim_validators
 
 if TYPE_CHECKING:

html/supertokens_python/recipe/session/interfaces.html

@@ -45,20 +45,21 @@ <h1 class="title">Module <code>supertokens_python.recipe.session.interfaces</cod
 from typing import (
     TYPE_CHECKING,
     Any,
+    Callable,
     Dict,
     Generic,
     List,
+    Optional,
     TypeVar,
     Union,
-    Callable,
-    Optional,
 )
 
 from supertokens_python.async_to_sync_wrapper import sync
-from supertokens_python.types import APIResponse, MaybeAwaitable
+from supertokens_python.types import APIResponse, GeneralErrorResponse, MaybeAwaitable
+
+from ...utils import resolve
 from .exceptions import ClaimValidationError
 from .utils import SessionConfig
-from ...utils import resolve
 
 if TYPE_CHECKING:
     from supertokens_python.framework import BaseRequest, BaseResponse
@@ -347,7 +348,7 @@ <h1 class="title">Module <code>supertokens_python.recipe.session.interfaces</cod
         session: Optional[SessionContainer],
         api_options: APIOptions,
         user_context: Dict[str, Any],
-    ) -&gt; SignOutOkayResponse:
+    ) -&gt; Union[SignOutOkayResponse, GeneralErrorResponse]:
         pass
 
     @abstractmethod
@@ -696,7 +697,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         session: Optional[SessionContainer],
         api_options: APIOptions,
         user_context: Dict[str, Any],
-    ) -&gt; SignOutOkayResponse:
+    ) -&gt; Union[SignOutOkayResponse, GeneralErrorResponse]:
         pass
 
     @abstractmethod
@@ -742,7 +743,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="supertokens_python.recipe.session.interfaces.APIInterface.signout_post"><code class="name flex">
-<span>async def <span class="ident">signout_post</span></span>(<span>self, session: Optional[<a title="supertokens_python.recipe.session.interfaces.SessionContainer" href="#supertokens_python.recipe.session.interfaces.SessionContainer">SessionContainer</a>], api_options: <a title="supertokens_python.recipe.session.interfaces.APIOptions" href="#supertokens_python.recipe.session.interfaces.APIOptions">APIOptions</a>, user_context: Dict[str, Any]) ‑> <a title="supertokens_python.recipe.session.interfaces.SignOutOkayResponse" href="#supertokens_python.recipe.session.interfaces.SignOutOkayResponse">SignOutOkayResponse</a></span>
+<span>async def <span class="ident">signout_post</span></span>(<span>self, session: Optional[<a title="supertokens_python.recipe.session.interfaces.SessionContainer" href="#supertokens_python.recipe.session.interfaces.SessionContainer">SessionContainer</a>], api_options: <a title="supertokens_python.recipe.session.interfaces.APIOptions" href="#supertokens_python.recipe.session.interfaces.APIOptions">APIOptions</a>, user_context: Dict[str, Any]) ‑> Union[<a title="supertokens_python.recipe.session.interfaces.SignOutOkayResponse" href="#supertokens_python.recipe.session.interfaces.SignOutOkayResponse">SignOutOkayResponse</a>, <a title="supertokens_python.types.GeneralErrorResponse" href="../../types.html#supertokens_python.types.GeneralErrorResponse">GeneralErrorResponse</a>]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -756,7 +757,7 @@ <h3>Methods</h3>
     session: Optional[SessionContainer],
     api_options: APIOptions,
     user_context: Dict[str, Any],
-) -&gt; SignOutOkayResponse:
+) -&gt; Union[SignOutOkayResponse, GeneralErrorResponse]:
     pass</code></pre>
 </details>
 </dd>

html/supertokens_python/recipe/session/recipe.html

@@ -47,6 +47,8 @@ <h1 class="title">Module <code>supertokens_python.recipe.session.recipe</code></
 from supertokens_python.framework.response import BaseResponse
 from typing_extensions import Literal
 
+from supertokens_python.utils import default_user_context
+
 from .api import handle_refresh_api, handle_signout_api
 from .cookie_and_header import get_cors_allowed_headers
 from .exceptions import (
@@ -367,14 +369,16 @@ <h1 class="title">Module <code>supertokens_python.recipe.session.recipe</code></
         ],
         user_context: Dict[str, Any],
     ):
+        _ = user_context
+
         return await self.api_implementation.verify_session(
             APIOptions(
                 request, None, self.recipe_id, self.config, self.recipe_implementation
             ),
             anti_csrf_check,
             session_required,
             override_global_claim_validators,
-            user_context,
+            user_context=default_user_context(request),
         )</code></pre>
 </details>
 </section>
@@ -675,14 +679,16 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         ],
         user_context: Dict[str, Any],
     ):
+        _ = user_context
+
         return await self.api_implementation.verify_session(
             APIOptions(
                 request, None, self.recipe_id, self.config, self.recipe_implementation
             ),
             anti_csrf_check,
             session_required,
             override_global_claim_validators,
-            user_context,
+            user_context=default_user_context(request),
         )</code></pre>
 </details>
 <h3>Ancestors</h3>
@@ -1014,14 +1020,16 @@ <h3>Methods</h3>
     ],
     user_context: Dict[str, Any],
 ):
+    _ = user_context
+
     return await self.api_implementation.verify_session(
         APIOptions(
             request, None, self.recipe_id, self.config, self.recipe_implementation
         ),
         anti_csrf_check,
         session_required,
         override_global_claim_validators,
-        user_context,
+        user_context=default_user_context(request),
     )</code></pre>
 </details>
 </dd>

supertokens_python/recipe/session/api/implementation.py

@@ -13,16 +13,17 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Union, List, Callable, Optional
+from typing import TYPE_CHECKING, Callable, List, Optional, Union
 
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe.session.interfaces import (
     APIInterface,
-    SignOutOkayResponse,
     SessionClaimValidator,
+    SignOutOkayResponse,
 )
 from supertokens_python.types import MaybeAwaitable
 from supertokens_python.utils import normalise_http_method
+
 from ..utils import get_required_claim_validators
 
 if TYPE_CHECKING:

supertokens_python/recipe/session/interfaces.py

@@ -17,20 +17,21 @@
 from typing import (
     TYPE_CHECKING,
     Any,
+    Callable,
     Dict,
     Generic,
     List,
+    Optional,
     TypeVar,
     Union,
-    Callable,
-    Optional,
 )
 
 from supertokens_python.async_to_sync_wrapper import sync
-from supertokens_python.types import APIResponse, MaybeAwaitable
+from supertokens_python.types import APIResponse, GeneralErrorResponse, MaybeAwaitable
+
+from ...utils import resolve
 from .exceptions import ClaimValidationError
 from .utils import SessionConfig
-from ...utils import resolve
 
 if TYPE_CHECKING:
     from supertokens_python.framework import BaseRequest, BaseResponse
@@ -319,7 +320,7 @@ async def signout_post(
         session: Optional[SessionContainer],
         api_options: APIOptions,
         user_context: Dict[str, Any],
-    ) -> SignOutOkayResponse:
+    ) -> Union[SignOutOkayResponse, GeneralErrorResponse]:
         pass
 
     @abstractmethod

tests/auth-react/django3x/mysite/utils.py

@@ -1,17 +1,17 @@
 import os
-from typing import Any, Dict, List, Union, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from dotenv import load_dotenv
 from supertokens_python import InputAppInfo, Supertokens, SupertokensConfig, init
 from supertokens_python.framework.request import BaseRequest
 from supertokens_python.recipe import (
     emailpassword,
+    emailverification,
     passwordless,
     session,
     thirdparty,
     thirdpartyemailpassword,
     thirdpartypasswordless,
-    emailverification,
 )
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
 from supertokens_python.recipe.emailpassword.interfaces import (
@@ -25,10 +25,7 @@
     InputFormField,
     User,
 )
-from supertokens_python.recipe.emailverification.types import User as EVUser
-from supertokens_python.recipe.emailverification import (
-    EmailVerificationRecipe,
-)
+from supertokens_python.recipe.emailverification import EmailVerificationRecipe
 from supertokens_python.recipe.emailverification import (
     InputOverrideConfig as EVInputOverrideConfig,
 )
@@ -38,6 +35,7 @@
 from supertokens_python.recipe.emailverification.interfaces import (
     APIOptions as EVAPIOptions,
 )
+from supertokens_python.recipe.emailverification.types import User as EVUser
 from supertokens_python.recipe.jwt import JWTRecipe
 from supertokens_python.recipe.passwordless import (
     ContactEmailOnlyConfig,
@@ -51,7 +49,7 @@
     APIInterface as PasswordlessAPIInterface,
 )
 from supertokens_python.recipe.passwordless.interfaces import APIOptions as PAPIOptions
-from supertokens_python.recipe.session import SessionRecipe, SessionContainer
+from supertokens_python.recipe.session import SessionContainer, SessionRecipe
 from supertokens_python.recipe.session.interfaces import (
     APIInterface as SessionAPIInterface,
 )
@@ -86,7 +84,7 @@
 from supertokens_python.types import GeneralErrorResponse
 from typing_extensions import Literal
 
-from .store import save_url_with_token, save_code
+from .store import save_code, save_url_with_token
 
 load_dotenv()
 
@@ -592,7 +590,7 @@ async def signout_post(
                 "body", api_options.request
             )
             if is_general_error:
-                raise Exception("general error from signout API")
+                return GeneralErrorResponse("general error from signout API")
             return await original_signout_post(session, api_options, user_context)
 
         original_implementation.signout_post = signout_post
@@ -853,7 +851,7 @@ async def authorisation_url_get(
     recipe_list = [
         session.init(override=session.InputOverrideConfig(apis=override_session_apis)),
         emailverification.init(
-            mode="REQUIRED",
+            mode="OPTIONAL",
             create_and_send_custom_email=ev_create_and_send_custom_email,
             override=EVInputOverrideConfig(apis=override_email_verification_apis),
         ),

tests/auth-react/fastapi-server/app.py

@@ -661,7 +661,7 @@ async def signout_post(
                 "body", api_options.request
             )
             if is_general_error:
-                raise Exception("general error from signout API")
+                return GeneralErrorResponse("general error from signout API")
             return await original_signout_post(session, api_options, user_context)
 
         original_implementation.signout_post = signout_post
@@ -923,7 +923,7 @@ async def authorisation_url_get(
         userroles.init(),
         session.init(override=session.InputOverrideConfig(apis=override_session_apis)),
         emailverification.init(
-            mode="REQUIRED",
+            mode="OPTIONAL",
             create_and_send_custom_email=ev_create_and_send_custom_email,
             override=EVInputOverrideConfig(apis=override_email_verification_apis),
         ),

tests/auth-react/flask-server/app.py

@@ -12,7 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 import os
-from typing import Any, Dict, List, Union, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from dotenv import load_dotenv
 from flask import Flask, g, jsonify, make_response, request
@@ -29,12 +29,12 @@
 from supertokens_python.framework.request import BaseRequest
 from supertokens_python.recipe import (
     emailpassword,
+    emailverification,
     passwordless,
     session,
     thirdparty,
     thirdpartyemailpassword,
     thirdpartypasswordless,
-    emailverification,
 )
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
 from supertokens_python.recipe.emailpassword.interfaces import (
@@ -62,6 +62,7 @@
 from supertokens_python.recipe.emailverification.interfaces import (
     APIOptions as EVAPIOptions,
 )
+from supertokens_python.recipe.emailverification.types import User as EVUser
 from supertokens_python.recipe.jwt import JWTRecipe
 from supertokens_python.recipe.passwordless import (
     ContactEmailOnlyConfig,
@@ -117,7 +118,6 @@
 )
 from supertokens_python.types import GeneralErrorResponse
 from typing_extensions import Literal
-from supertokens_python.recipe.emailverification.types import User as EVUser
 
 load_dotenv()
 
@@ -625,7 +625,7 @@ async def signout_post(
                 "body", api_options.request
             )
             if is_general_error:
-                raise Exception("general error from signout API")
+                return GeneralErrorResponse("general error from signout API")
             return await original_signout_post(session, api_options, user_context)
 
         original_implementation.signout_post = signout_post
@@ -906,7 +906,7 @@ async def authorisation_url_get(
     recipe_list = [
         session.init(override=session.InputOverrideConfig(apis=override_session_apis)),
         emailverification.init(
-            mode="REQUIRED",
+            mode="OPTIONAL",
             create_and_send_custom_email=ev_create_and_send_custom_email,
             override=EVInputOverrideConfig(apis=override_email_verification_apis),
         ),