adding dev-v0.16.3 tag to this commit to ensure building

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.16.2&#34;
+VERSION = &#34;0.16.3&#34;
 TELEMETRY = &#34;/telemetry&#34;
 USER_COUNT = &#34;/users/count&#34;
 USER_DELETE = &#34;/user/remove&#34;

html/supertokens_python/querier.html

@@ -188,7 +188,7 @@ <h1 class="title">Module <code>supertokens_python.querier</code></h1>
 
     async def send_get_request(
         self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None
-    ):
+    ) -&gt; Dict[str, Any]:
         if params is None:
             params = {}
 
@@ -208,7 +208,7 @@ <h1 class="title">Module <code>supertokens_python.querier</code></h1>
         path: NormalisedURLPath,
         data: Union[Dict[str, Any], None] = None,
         test: bool = False,
-    ):
+    ) -&gt; Dict[str, Any]:
         if data is None:
             data = {}
 
@@ -235,7 +235,7 @@ <h1 class="title">Module <code>supertokens_python.querier</code></h1>
 
     async def send_delete_request(
         self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None
-    ):
+    ) -&gt; Dict[str, Any]:
         if params is None:
             params = {}
 
@@ -252,7 +252,7 @@ <h1 class="title">Module <code>supertokens_python.querier</code></h1>
 
     async def send_put_request(
         self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None
-    ):
+    ) -&gt; Dict[str, Any]:
         if data is None:
             data = {}
 
@@ -290,7 +290,7 @@ <h1 class="title">Module <code>supertokens_python.querier</code></h1>
         http_function: Callable[[str, str], Awaitable[Response]],
         no_of_tries: int,
         retry_info_map: Optional[Dict[str, int]] = None,
-    ) -&gt; Any:
+    ) -&gt; Dict[str, Any]:
         if no_of_tries == 0:
             raise_general_exception(&#34;No SuperTokens core available to query&#34;)
 
@@ -349,10 +349,14 @@ <h1 class="title">Module <code>supertokens_python.querier</code></h1>
                     + response.text  # type: ignore
                 )
 
+            res: Dict[str, Any] = {&#34;_headers&#34;: dict(response.headers)}
+
             try:
-                return response.json()
+                res.update(response.json())
             except JSONDecodeError:
-                return response.text
+                res[&#34;_text&#34;] = response.text
+
+            return res
 
         except (ConnectionError, NetworkError, ConnectTimeout) as _:
             return await self.__send_request_helper(
@@ -498,7 +502,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     async def send_get_request(
         self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None
-    ):
+    ) -&gt; Dict[str, Any]:
         if params is None:
             params = {}
 
@@ -518,7 +522,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         path: NormalisedURLPath,
         data: Union[Dict[str, Any], None] = None,
         test: bool = False,
-    ):
+    ) -&gt; Dict[str, Any]:
         if data is None:
             data = {}
 
@@ -545,7 +549,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     async def send_delete_request(
         self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None
-    ):
+    ) -&gt; Dict[str, Any]:
         if params is None:
             params = {}
 
@@ -562,7 +566,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     async def send_put_request(
         self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None
-    ):
+    ) -&gt; Dict[str, Any]:
         if data is None:
             data = {}
 
@@ -600,7 +604,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         http_function: Callable[[str, str], Awaitable[Response]],
         no_of_tries: int,
         retry_info_map: Optional[Dict[str, int]] = None,
-    ) -&gt; Any:
+    ) -&gt; Dict[str, Any]:
         if no_of_tries == 0:
             raise_general_exception(&#34;No SuperTokens core available to query&#34;)
 
@@ -659,10 +663,14 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                     + response.text  # type: ignore
                 )
 
+            res: Dict[str, Any] = {&#34;_headers&#34;: dict(response.headers)}
+
             try:
-                return response.json()
+                res.update(response.json())
             except JSONDecodeError:
-                return response.text
+                res[&#34;_text&#34;] = response.text
+
+            return res
 
         except (ConnectionError, NetworkError, ConnectTimeout) as _:
             return await self.__send_request_helper(
@@ -866,7 +874,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="supertokens_python.querier.Querier.send_delete_request"><code class="name flex">
-<span>async def <span class="ident">send_delete_request</span></span>(<span>self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None)</span>
+<span>async def <span class="ident">send_delete_request</span></span>(<span>self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None) ‑> Dict[str, Any]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -876,7 +884,7 @@ <h3>Methods</h3>
 </summary>
 <pre><code class="python">async def send_delete_request(
     self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None
-):
+) -&gt; Dict[str, Any]:
     if params is None:
         params = {}
 
@@ -893,7 +901,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="supertokens_python.querier.Querier.send_get_request"><code class="name flex">
-<span>async def <span class="ident">send_get_request</span></span>(<span>self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None)</span>
+<span>async def <span class="ident">send_get_request</span></span>(<span>self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None) ‑> Dict[str, Any]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -903,7 +911,7 @@ <h3>Methods</h3>
 </summary>
 <pre><code class="python">async def send_get_request(
     self, path: NormalisedURLPath, params: Union[Dict[str, Any], None] = None
-):
+) -&gt; Dict[str, Any]:
     if params is None:
         params = {}
 
@@ -920,7 +928,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="supertokens_python.querier.Querier.send_post_request"><code class="name flex">
-<span>async def <span class="ident">send_post_request</span></span>(<span>self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None, test: bool = False)</span>
+<span>async def <span class="ident">send_post_request</span></span>(<span>self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None, test: bool = False) ‑> Dict[str, Any]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -933,7 +941,7 @@ <h3>Methods</h3>
     path: NormalisedURLPath,
     data: Union[Dict[str, Any], None] = None,
     test: bool = False,
-):
+) -&gt; Dict[str, Any]:
     if data is None:
         data = {}
 
@@ -960,7 +968,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="supertokens_python.querier.Querier.send_put_request"><code class="name flex">
-<span>async def <span class="ident">send_put_request</span></span>(<span>self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None)</span>
+<span>async def <span class="ident">send_put_request</span></span>(<span>self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None) ‑> Dict[str, Any]</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -970,7 +978,7 @@ <h3>Methods</h3>
 </summary>
 <pre><code class="python">async def send_put_request(
     self, path: NormalisedURLPath, data: Union[Dict[str, Any], None] = None
-):
+) -&gt; Dict[str, Any]:
     if data is None:
         data = {}
 

html/supertokens_python/recipe/jwt/api/implementation.html

@@ -53,6 +53,12 @@ <h1 class="title">Module <code>supertokens_python.recipe.jwt.api.implementation<
         self, api_options: APIOptions, user_context: Dict[str, Any]
     ) -&gt; JWKSGetResponse:
         response = await api_options.recipe_implementation.get_jwks(user_context)
+
+        if response.validity_in_secs is not None:
+            api_options.response.set_header(
+                &#34;Cache-Control&#34;, f&#34;max-age={response.validity_in_secs}, must-revalidate&#34;
+            )
+
         return JWKSGetResponse(response.keys)</code></pre>
 </details>
 </section>
@@ -79,6 +85,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         self, api_options: APIOptions, user_context: Dict[str, Any]
     ) -&gt; JWKSGetResponse:
         response = await api_options.recipe_implementation.get_jwks(user_context)
+
+        if response.validity_in_secs is not None:
+            api_options.response.set_header(
+                &#34;Cache-Control&#34;, f&#34;max-age={response.validity_in_secs}, must-revalidate&#34;
+            )
+
         return JWKSGetResponse(response.keys)</code></pre>
 </details>
 <h3>Ancestors</h3>
@@ -100,6 +112,12 @@ <h3>Methods</h3>
     self, api_options: APIOptions, user_context: Dict[str, Any]
 ) -&gt; JWKSGetResponse:
     response = await api_options.recipe_implementation.get_jwks(user_context)
+
+    if response.validity_in_secs is not None:
+        api_options.response.set_header(
+            &#34;Cache-Control&#34;, f&#34;max-age={response.validity_in_secs}, must-revalidate&#34;
+        )
+
     return JWKSGetResponse(response.keys)</code></pre>
 </details>
 </dd>

html/supertokens_python/recipe/jwt/interfaces.html

@@ -68,8 +68,9 @@ <h1 class="title">Module <code>supertokens_python.recipe.jwt.interfaces</code></
 
 
 class GetJWKSResult:
-    def __init__(self, keys: List[JsonWebKey]):
+    def __init__(self, keys: List[JsonWebKey], validity_in_secs: Optional[int]):
         self.keys = keys
+        self.validity_in_secs = validity_in_secs
 
 
 class RecipeInterface(ABC):
@@ -247,7 +248,7 @@ <h3>Methods</h3>
 </dd>
 <dt id="supertokens_python.recipe.jwt.interfaces.GetJWKSResult"><code class="flex name class">
 <span>class <span class="ident">GetJWKSResult</span></span>
-<span>(</span><span>keys: List[<a title="supertokens_python.recipe.jwt.interfaces.JsonWebKey" href="#supertokens_python.recipe.jwt.interfaces.JsonWebKey">JsonWebKey</a>])</span>
+<span>(</span><span>keys: List[<a title="supertokens_python.recipe.jwt.interfaces.JsonWebKey" href="#supertokens_python.recipe.jwt.interfaces.JsonWebKey">JsonWebKey</a>], validity_in_secs: Optional[int])</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -256,8 +257,9 @@ <h3>Methods</h3>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">class GetJWKSResult:
-    def __init__(self, keys: List[JsonWebKey]):
-        self.keys = keys</code></pre>
+    def __init__(self, keys: List[JsonWebKey], validity_in_secs: Optional[int]):
+        self.keys = keys
+        self.validity_in_secs = validity_in_secs</code></pre>
 </details>
 </dd>
 <dt id="supertokens_python.recipe.jwt.interfaces.JWKSGetResponse"><code class="flex name class">

html/supertokens_python/recipe/jwt/recipe_implementation.html

@@ -45,6 +45,7 @@ <h1 class="title">Module <code>supertokens_python.recipe.jwt.recipe_implementati
 
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.querier import Querier
+import re
 
 if TYPE_CHECKING:
     from .utils import JWTConfig
@@ -60,6 +61,10 @@ <h1 class="title">Module <code>supertokens_python.recipe.jwt.recipe_implementati
 from .interfaces import JsonWebKey
 
 
+# This corresponds to the dynamicSigningKeyOverlapMS in the core
+DEFAULT_JWKS_MAX_AGE = 60
+
+
 class RecipeImplementation(RecipeInterface):
     def __init__(self, querier: Querier, config: JWTConfig, app_info: AppInfo):
         super().__init__()
@@ -97,14 +102,28 @@ <h1 class="title">Module <code>supertokens_python.recipe.jwt.recipe_implementati
             NormalisedURLPath(&#34;/.well-known/jwks.json&#34;), {}
         )
 
+        validity_in_secs = DEFAULT_JWKS_MAX_AGE
+        cache_control = response[&#34;_headers&#34;].get(&#34;Cache-Control&#34;)
+
+        if cache_control is not None:
+            pattern = r&#34;,?\s*max-age=(\d+)(?:,|$)&#34;
+            max_age_header = re.match(pattern, cache_control)
+            if max_age_header is not None:
+                validity_in_secs = int(max_age_header.group(1))
+                try:
+                    validity_in_secs = int(validity_in_secs)
+                except Exception:
+                    validity_in_secs = DEFAULT_JWKS_MAX_AGE
+
         keys: List[JsonWebKey] = []
         for key in response[&#34;keys&#34;]:
             keys.append(
                 JsonWebKey(
                     key[&#34;kty&#34;], key[&#34;kid&#34;], key[&#34;n&#34;], key[&#34;e&#34;], key[&#34;alg&#34;], key[&#34;use&#34;]
                 )
             )
-        return GetJWKSResult(keys)</code></pre>
+
+        return GetJWKSResult(keys, validity_in_secs)</code></pre>
 </details>
 </section>
 <section>
@@ -164,14 +183,28 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             NormalisedURLPath(&#34;/.well-known/jwks.json&#34;), {}
         )
 
+        validity_in_secs = DEFAULT_JWKS_MAX_AGE
+        cache_control = response[&#34;_headers&#34;].get(&#34;Cache-Control&#34;)
+
+        if cache_control is not None:
+            pattern = r&#34;,?\s*max-age=(\d+)(?:,|$)&#34;
+            max_age_header = re.match(pattern, cache_control)
+            if max_age_header is not None:
+                validity_in_secs = int(max_age_header.group(1))
+                try:
+                    validity_in_secs = int(validity_in_secs)
+                except Exception:
+                    validity_in_secs = DEFAULT_JWKS_MAX_AGE
+
         keys: List[JsonWebKey] = []
         for key in response[&#34;keys&#34;]:
             keys.append(
                 JsonWebKey(
                     key[&#34;kty&#34;], key[&#34;kid&#34;], key[&#34;n&#34;], key[&#34;e&#34;], key[&#34;alg&#34;], key[&#34;use&#34;]
                 )
             )
-        return GetJWKSResult(keys)</code></pre>
+
+        return GetJWKSResult(keys, validity_in_secs)</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">
@@ -229,14 +262,28 @@ <h3>Methods</h3>
         NormalisedURLPath(&#34;/.well-known/jwks.json&#34;), {}
     )
 
+    validity_in_secs = DEFAULT_JWKS_MAX_AGE
+    cache_control = response[&#34;_headers&#34;].get(&#34;Cache-Control&#34;)
+
+    if cache_control is not None:
+        pattern = r&#34;,?\s*max-age=(\d+)(?:,|$)&#34;
+        max_age_header = re.match(pattern, cache_control)
+        if max_age_header is not None:
+            validity_in_secs = int(max_age_header.group(1))
+            try:
+                validity_in_secs = int(validity_in_secs)
+            except Exception:
+                validity_in_secs = DEFAULT_JWKS_MAX_AGE
+
     keys: List[JsonWebKey] = []
     for key in response[&#34;keys&#34;]:
         keys.append(
             JsonWebKey(
                 key[&#34;kty&#34;], key[&#34;kid&#34;], key[&#34;n&#34;], key[&#34;e&#34;], key[&#34;alg&#34;], key[&#34;use&#34;]
             )
         )
-    return GetJWKSResult(keys)</code></pre>
+
+    return GetJWKSResult(keys, validity_in_secs)</code></pre>
 </details>
 </dd>
 </dl>