Module supertokens_python.recipe.emailpassword.api.password_reset

Expand source code
# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# 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 __future__ import annotations

from typing import TYPE_CHECKING, Any, Dict
from supertokens_python.recipe.emailpassword.exceptions import (
    raise_form_field_exception,
)

from supertokens_python.recipe.emailpassword.interfaces import (
    PasswordPolicyViolationError,
)
from supertokens_python.recipe.emailpassword.types import ErrorFormField

if TYPE_CHECKING:
    from supertokens_python.recipe.emailpassword.interfaces import (
        APIOptions,
        APIInterface,
    )

from supertokens_python.exceptions import raise_bad_input_exception
from supertokens_python.utils import send_200_response

from .utils import validate_form_fields_or_throw_error


async def handle_password_reset_api(
    tenant_id: str,
    api_implementation: APIInterface,
    api_options: APIOptions,
    user_context: Dict[str, Any],
):
    if api_implementation.disable_generate_password_reset_token_post:
        return None
    body = await api_options.request.json()
    if body is None:
        raise_bad_input_exception("Please provide a JSON body")
    form_fields_raw: Any = body["formFields"] if "formFields" in body else []
    form_fields = await validate_form_fields_or_throw_error(
        api_options.config.reset_password_using_token_feature.form_fields_for_password_reset_form,
        form_fields_raw,
        tenant_id,
    )

    if "token" not in body:
        raise_bad_input_exception("Please provide the password reset token")
    if not isinstance(body["token"], str):
        raise_bad_input_exception("The password reset token must be a string")

    token = body["token"]

    response = await api_implementation.password_reset_post(
        form_fields, token, tenant_id, api_options, user_context
    )
    if isinstance(response, PasswordPolicyViolationError):
        return raise_form_field_exception(
            "Error in input formFields",
            [
                ErrorFormField(
                    id="password",
                    error=response.failure_reason,
                )
            ],
        )
    return send_200_response(response.to_json(), api_options.response)

Functions

async def handle_password_reset_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any])
Expand source code
async def handle_password_reset_api(
    tenant_id: str,
    api_implementation: APIInterface,
    api_options: APIOptions,
    user_context: Dict[str, Any],
):
    if api_implementation.disable_generate_password_reset_token_post:
        return None
    body = await api_options.request.json()
    if body is None:
        raise_bad_input_exception("Please provide a JSON body")
    form_fields_raw: Any = body["formFields"] if "formFields" in body else []
    form_fields = await validate_form_fields_or_throw_error(
        api_options.config.reset_password_using_token_feature.form_fields_for_password_reset_form,
        form_fields_raw,
        tenant_id,
    )

    if "token" not in body:
        raise_bad_input_exception("Please provide the password reset token")
    if not isinstance(body["token"], str):
        raise_bad_input_exception("The password reset token must be a string")

    token = body["token"]

    response = await api_implementation.password_reset_post(
        form_fields, token, tenant_id, api_options, user_context
    )
    if isinstance(response, PasswordPolicyViolationError):
        return raise_form_field_exception(
            "Error in input formFields",
            [
                ErrorFormField(
                    id="password",
                    error=response.failure_reason,
                )
            ],
        )
    return send_200_response(response.to_json(), api_options.response)