Merge branch '0.16' into fix/failing-test

Author: rishabhpoddar

html/supertokens_python/constants.html

@@ -42,7 +42,7 @@ <h1 class="title">Module <code>supertokens_python.constants</code></h1>
 from __future__ import annotations
 
 SUPPORTED_CDI_VERSIONS = [&#34;3.0&#34;]
-VERSION = &#34;0.15.3&#34;
+VERSION = &#34;0.16.0&#34;
 TELEMETRY = &#34;/telemetry&#34;
 USER_COUNT = &#34;/users/count&#34;
 USER_DELETE = &#34;/user/remove&#34;

html/supertokens_python/framework/django/django_request.html

@@ -57,6 +57,9 @@ <h1 class="title">Module <code>supertokens_python.framework.django.django_reques
         super().__init__()
         self.request = request
 
+    def get_original_url(self) -&gt; str:
+        return self.request.get_raw_uri()
+
     def get_query_param(
         self, key: str, default: Union[str, None] = None
     ) -&gt; Union[str, None]:
@@ -126,6 +129,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         super().__init__()
         self.request = request
 
+    def get_original_url(self) -&gt; str:
+        return self.request.get_raw_uri()
+
     def get_query_param(
         self, key: str, default: Union[str, None] = None
     ) -&gt; Union[str, None]:
@@ -217,6 +223,19 @@ <h3>Methods</h3>
     return self.request.META.get(key.upper())</code></pre>
 </details>
 </dd>
+<dt id="supertokens_python.framework.django.django_request.DjangoRequest.get_original_url"><code class="name flex">
+<span>def <span class="ident">get_original_url</span></span>(<span>self) ‑> str</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def get_original_url(self) -&gt; str:
+    return self.request.get_raw_uri()</code></pre>
+</details>
+</dd>
 <dt id="supertokens_python.framework.django.django_request.DjangoRequest.get_path"><code class="name flex">
 <span>def <span class="ident">get_path</span></span>(<span>self) ‑> str</span>
 </code></dt>
@@ -348,6 +367,7 @@ <h4><code><a title="supertokens_python.framework.django.django_request.DjangoReq
 <li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.form_data" href="#supertokens_python.framework.django.django_request.DjangoRequest.form_data">form_data</a></code></li>
 <li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.get_cookie" href="#supertokens_python.framework.django.django_request.DjangoRequest.get_cookie">get_cookie</a></code></li>
 <li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.get_header" href="#supertokens_python.framework.django.django_request.DjangoRequest.get_header">get_header</a></code></li>
+<li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.get_original_url" href="#supertokens_python.framework.django.django_request.DjangoRequest.get_original_url">get_original_url</a></code></li>
 <li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.get_path" href="#supertokens_python.framework.django.django_request.DjangoRequest.get_path">get_path</a></code></li>
 <li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.get_query_param" href="#supertokens_python.framework.django.django_request.DjangoRequest.get_query_param">get_query_param</a></code></li>
 <li><code><a title="supertokens_python.framework.django.django_request.DjangoRequest.get_query_params" href="#supertokens_python.framework.django.django_request.DjangoRequest.get_query_params">get_query_params</a></code></li>

html/supertokens_python/framework/fastapi/fastapi_request.html

@@ -56,6 +56,9 @@ <h1 class="title">Module <code>supertokens_python.framework.fastapi.fastapi_requ
         super().__init__()
         self.request = request
 
+    def get_original_url(self) -&gt; str:
+        return self.request.url.components.geturl()
+
     def get_query_param(
         self, key: str, default: Union[str, None] = None
     ) -&gt; Union[str, None]:
@@ -126,6 +129,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         super().__init__()
         self.request = request
 
+    def get_original_url(self) -&gt; str:
+        return self.request.url.components.geturl()
+
     def get_query_param(
         self, key: str, default: Union[str, None] = None
     ) -&gt; Union[str, None]:
@@ -218,6 +224,19 @@ <h3>Methods</h3>
     return self.request.headers.get(key, None)</code></pre>
 </details>
 </dd>
+<dt id="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_original_url"><code class="name flex">
+<span>def <span class="ident">get_original_url</span></span>(<span>self) ‑> str</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def get_original_url(self) -&gt; str:
+    return self.request.url.components.geturl()</code></pre>
+</details>
+</dd>
 <dt id="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_path"><code class="name flex">
 <span>def <span class="ident">get_path</span></span>(<span>self) ‑> str</span>
 </code></dt>
@@ -350,6 +369,7 @@ <h4><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApi
 <li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.form_data" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.form_data">form_data</a></code></li>
 <li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_cookie" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_cookie">get_cookie</a></code></li>
 <li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_header" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_header">get_header</a></code></li>
+<li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_original_url" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_original_url">get_original_url</a></code></li>
 <li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_path" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_path">get_path</a></code></li>
 <li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_query_param" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_query_param">get_query_param</a></code></li>
 <li><code><a title="supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_query_params" href="#supertokens_python.framework.fastapi.fastapi_request.FastApiRequest.get_query_params">get_query_params</a></code></li>

html/supertokens_python/framework/flask/flask_request.html

@@ -55,6 +55,9 @@ <h1 class="title">Module <code>supertokens_python.framework.flask.flask_request<
         super().__init__()
         self.request = req
 
+    def get_original_url(self) -&gt; str:
+        return self.request.url
+
     def get_query_param(self, key: str, default: Union[str, None] = None):
         return self.request.args.get(key, default)
 
@@ -133,6 +136,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         super().__init__()
         self.request = req
 
+    def get_original_url(self) -&gt; str:
+        return self.request.url
+
     def get_query_param(self, key: str, default: Union[str, None] = None):
         return self.request.args.get(key, default)
 
@@ -233,6 +239,19 @@ <h3>Methods</h3>
     return self.request.headers.get(key)  # type: ignore</code></pre>
 </details>
 </dd>
+<dt id="supertokens_python.framework.flask.flask_request.FlaskRequest.get_original_url"><code class="name flex">
+<span>def <span class="ident">get_original_url</span></span>(<span>self) ‑> str</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def get_original_url(self) -&gt; str:
+    return self.request.url</code></pre>
+</details>
+</dd>
 <dt id="supertokens_python.framework.flask.flask_request.FlaskRequest.get_path"><code class="name flex">
 <span>def <span class="ident">get_path</span></span>(<span>self) ‑> str</span>
 </code></dt>
@@ -371,6 +390,7 @@ <h4><code><a title="supertokens_python.framework.flask.flask_request.FlaskReques
 <li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.form_data" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.form_data">form_data</a></code></li>
 <li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.get_cookie" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.get_cookie">get_cookie</a></code></li>
 <li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.get_header" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.get_header">get_header</a></code></li>
+<li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.get_original_url" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.get_original_url">get_original_url</a></code></li>
 <li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.get_path" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.get_path">get_path</a></code></li>
 <li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.get_query_param" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.get_query_param">get_query_param</a></code></li>
 <li><code><a title="supertokens_python.framework.flask.flask_request.FlaskRequest.get_query_params" href="#supertokens_python.framework.flask.flask_request.FlaskRequest.get_query_params">get_query_params</a></code></li>

html/supertokens_python/framework/request.html

@@ -53,6 +53,10 @@ <h1 class="title">Module <code>supertokens_python.framework.request</code></h1>
         self.wrapper_used = True
         self.request = None
 
+    @abstractmethod
+    def get_original_url(self) -&gt; str:
+        pass
+
     @abstractmethod
     def get_query_param(
         self, key: str, default: Union[str, None] = None
@@ -127,6 +131,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         self.wrapper_used = True
         self.request = None
 
+    @abstractmethod
+    def get_original_url(self) -&gt; str:
+        pass
+
     @abstractmethod
     def get_query_param(
         self, key: str, default: Union[str, None] = None
@@ -230,6 +238,20 @@ <h3>Methods</h3>
     pass</code></pre>
 </details>
 </dd>
+<dt id="supertokens_python.framework.request.BaseRequest.get_original_url"><code class="name flex">
+<span>def <span class="ident">get_original_url</span></span>(<span>self) ‑> str</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">@abstractmethod
+def get_original_url(self) -&gt; str:
+    pass</code></pre>
+</details>
+</dd>
 <dt id="supertokens_python.framework.request.BaseRequest.get_path"><code class="name flex">
 <span>def <span class="ident">get_path</span></span>(<span>self) ‑> str</span>
 </code></dt>
@@ -372,6 +394,7 @@ <h4><code><a title="supertokens_python.framework.request.BaseRequest" href="#sup
 <li><code><a title="supertokens_python.framework.request.BaseRequest.form_data" href="#supertokens_python.framework.request.BaseRequest.form_data">form_data</a></code></li>
 <li><code><a title="supertokens_python.framework.request.BaseRequest.get_cookie" href="#supertokens_python.framework.request.BaseRequest.get_cookie">get_cookie</a></code></li>
 <li><code><a title="supertokens_python.framework.request.BaseRequest.get_header" href="#supertokens_python.framework.request.BaseRequest.get_header">get_header</a></code></li>
+<li><code><a title="supertokens_python.framework.request.BaseRequest.get_original_url" href="#supertokens_python.framework.request.BaseRequest.get_original_url">get_original_url</a></code></li>
 <li><code><a title="supertokens_python.framework.request.BaseRequest.get_path" href="#supertokens_python.framework.request.BaseRequest.get_path">get_path</a></code></li>
 <li><code><a title="supertokens_python.framework.request.BaseRequest.get_query_param" href="#supertokens_python.framework.request.BaseRequest.get_query_param">get_query_param</a></code></li>
 <li><code><a title="supertokens_python.framework.request.BaseRequest.get_query_params" href="#supertokens_python.framework.request.BaseRequest.get_query_params">get_query_params</a></code></li>

html/supertokens_python/recipe/dashboard/api/index.html

@@ -158,9 +158,20 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     ],
     user_context: Dict[str, Any],
 ) -&gt; Optional[BaseResponse]:
-    should_allow_access = await api_options.recipe_implementation.should_allow_access(
-        api_options.request, api_options.config, user_context
-    )
+    should_allow_access = False
+
+    try:
+        should_allow_access = (
+            await api_options.recipe_implementation.should_allow_access(
+                api_options.request, api_options.config, user_context
+            )
+        )
+    except DashboardOperationNotAllowedError as _:
+        return send_non_200_response_with_message(
+            &#34;You are not permitted to perform this operation&#34;,
+            403,
+            api_options.response,
+        )
 
     if should_allow_access is False:
         return send_non_200_response_with_message(
@@ -1113,7 +1124,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     user_context: Dict[str, Any],
 ):
 
-    is_valid_key = validate_api_key(
+    is_valid_key = await validate_api_key(
         api_options.request, api_options.config, user_context
     )
 

html/supertokens_python/recipe/dashboard/api/validate_key.html

@@ -63,7 +63,7 @@ <h1 class="title">Module <code>supertokens_python.recipe.dashboard.api.validate_
     user_context: Dict[str, Any],
 ):
 
-    is_valid_key = validate_api_key(
+    is_valid_key = await validate_api_key(
         api_options.request, api_options.config, user_context
     )
 
@@ -94,7 +94,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     user_context: Dict[str, Any],
 ):
 
-    is_valid_key = validate_api_key(
+    is_valid_key = await validate_api_key(
         api_options.request, api_options.config, user_context
     )
 

html/supertokens_python/recipe/dashboard/constants.html

@@ -36,8 +36,8 @@ <h1 class="title">Module <code>supertokens_python.recipe.dashboard.constants</co
 USER_SESSION_API = &#34;/api/user/sessions&#34;
 USER_PASSWORD_API = &#34;/api/user/password&#34;
 USER_EMAIL_VERIFY_TOKEN_API = &#34;/api/user/email/verify/token&#34;
-EMAIL_PASSWORD_SIGN_IN = &#34;/api/signin&#34;
-EMAIL_PASSSWORD_SIGNOUT = &#34;/api/signout&#34;
+SIGN_IN_API = &#34;/api/signin&#34;
+SIGN_OUT_API = &#34;/api/signout&#34;
 SEARCH_TAGS_API = &#34;/api/search/tags&#34;
 DASHBOARD_ANALYTICS_API = &#34;/api/analytics&#34;
 TENANTS_LIST_API = &#34;/api/tenants/list&#34;</code></pre>

html/supertokens_python/recipe/dashboard/exceptions.html

@@ -30,6 +30,10 @@ <h1 class="title">Module <code>supertokens_python.recipe.dashboard.exceptions</c
 
 
 class SuperTokensDashboardError(SuperTokensError):
+    pass
+
+
+class DashboardOperationNotAllowedError(SuperTokensDashboardError):
     pass</code></pre>
 </details>
 </section>
@@ -42,6 +46,27 @@ <h1 class="title">Module <code>supertokens_python.recipe.dashboard.exceptions</c
 <section>
 <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
+<dt id="supertokens_python.recipe.dashboard.exceptions.DashboardOperationNotAllowedError"><code class="flex name class">
+<span>class <span class="ident">DashboardOperationNotAllowedError</span></span>
+<span>(</span><span>*args, **kwargs)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Common base class for all non-exit exceptions.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class DashboardOperationNotAllowedError(SuperTokensDashboardError):
+    pass</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="supertokens_python.recipe.dashboard.exceptions.SuperTokensDashboardError" href="#supertokens_python.recipe.dashboard.exceptions.SuperTokensDashboardError">SuperTokensDashboardError</a></li>
+<li><a title="supertokens_python.exceptions.SuperTokensError" href="../../exceptions.html#supertokens_python.exceptions.SuperTokensError">SuperTokensError</a></li>
+<li>builtins.Exception</li>
+<li>builtins.BaseException</li>
+</ul>
+</dd>
 <dt id="supertokens_python.recipe.dashboard.exceptions.SuperTokensDashboardError"><code class="flex name class">
 <span>class <span class="ident">SuperTokensDashboardError</span></span>
 <span>(</span><span>*args, **kwargs)</span>
@@ -61,6 +86,10 @@ <h3>Ancestors</h3>
 <li>builtins.Exception</li>
 <li>builtins.BaseException</li>
 </ul>
+<h3>Subclasses</h3>
+<ul class="hlist">
+<li><a title="supertokens_python.recipe.dashboard.exceptions.DashboardOperationNotAllowedError" href="#supertokens_python.recipe.dashboard.exceptions.DashboardOperationNotAllowedError">DashboardOperationNotAllowedError</a></li>
+</ul>
 </dd>
 </dl>
 </section>
@@ -79,6 +108,9 @@ <h2>Index</h2>
 <li><h3><a href="#header-classes">Classes</a></h3>
 <ul>
 <li>
+<h4><code><a title="supertokens_python.recipe.dashboard.exceptions.DashboardOperationNotAllowedError" href="#supertokens_python.recipe.dashboard.exceptions.DashboardOperationNotAllowedError">DashboardOperationNotAllowedError</a></code></h4>
+</li>
+<li>
 <h4><code><a title="supertokens_python.recipe.dashboard.exceptions.SuperTokensDashboardError" href="#supertokens_python.recipe.dashboard.exceptions.SuperTokensDashboardError">SuperTokensDashboardError</a></code></h4>
 </li>
 </ul>

html/supertokens_python/recipe/dashboard/index.html

@@ -42,7 +42,7 @@ <h1 class="title">Module <code>supertokens_python.recipe.dashboard</code></h1>
 
 from __future__ import annotations
 
-from typing import Callable, Optional, Union
+from typing import Callable, Optional, List
 
 from supertokens_python import AppInfo, RecipeModule
 
@@ -54,11 +54,13 @@ <h1 class="title">Module <code>supertokens_python.recipe.dashboard</code></h1>
 
 
 def init(
-    api_key: Union[str, None] = None,
+    api_key: Optional[str] = None,
+    admins: Optional[List[str]] = None,
     override: Optional[InputOverrideConfig] = None,
 ) -&gt; Callable[[AppInfo], RecipeModule]:
     return DashboardRecipe.init(
         api_key,
+        admins,
         override,
     )</code></pre>
 </details>
@@ -102,7 +104,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
 <dt id="supertokens_python.recipe.dashboard.init"><code class="name flex">
-<span>def <span class="ident">init</span></span>(<span>api_key: Union[str, None] = None, override: Optional[InputOverrideConfig] = None) ‑> Callable[[<a title="supertokens_python.supertokens.AppInfo" href="../../supertokens.html#supertokens_python.supertokens.AppInfo">AppInfo</a>], <a title="supertokens_python.recipe_module.RecipeModule" href="../../recipe_module.html#supertokens_python.recipe_module.RecipeModule">RecipeModule</a>]</span>
+<span>def <span class="ident">init</span></span>(<span>api_key: Optional[str] = None, admins: Optional[List[str]] = None, override: Optional[InputOverrideConfig] = None) ‑> Callable[[<a title="supertokens_python.supertokens.AppInfo" href="../../supertokens.html#supertokens_python.supertokens.AppInfo">AppInfo</a>], <a title="supertokens_python.recipe_module.RecipeModule" href="../../recipe_module.html#supertokens_python.recipe_module.RecipeModule">RecipeModule</a>]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -111,11 +113,13 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def init(
-    api_key: Union[str, None] = None,
+    api_key: Optional[str] = None,
+    admins: Optional[List[str]] = None,
     override: Optional[InputOverrideConfig] = None,
 ) -&gt; Callable[[AppInfo], RecipeModule]:
     return DashboardRecipe.init(
         api_key,
+        admins,
         override,
     )</code></pre>
 </details>