Module `supertokens_python.recipe.thirdpartyemailpassword.api.implementation`

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 Any, Dict, List, Union

from supertokens_python.recipe.emailpassword.api.implementation import (
    APIImplementation as EmailPasswordImplementation,
)
from supertokens_python.recipe.emailpassword.interfaces import (
    APIOptions as EmailPasswordApiOptions,
)
from supertokens_python.recipe.emailpassword.interfaces import (
    EmailExistsGetOkResult,
    GeneratePasswordResetTokenPostOkResult,
    PasswordResetPostInvalidTokenResponse,
    PasswordResetPostOkResult,
    SignInPostOkResult,
    SignInPostWrongCredentialsError,
    SignUpPostEmailAlreadyExistsError,
    SignUpPostOkResult,
)
from supertokens_python.recipe.emailpassword.types import FormField
from supertokens_python.recipe.thirdparty.api.implementation import (
    APIImplementation as ThirdPartyImplementation,
)
from supertokens_python.recipe.thirdparty.interfaces import (
    APIOptions as ThirdPartyApiOptions,
)
from supertokens_python.recipe.thirdparty.interfaces import (
    AuthorisationUrlGetOkResult,
    SignInUpPostNoEmailGivenByProviderResponse,
    SignInUpPostOkResult,
)
from supertokens_python.recipe.thirdparty.provider import Provider, RedirectUriInfo
from supertokens_python.recipe.thirdpartyemailpassword.interfaces import APIInterface
from supertokens_python.types import GeneralErrorResponse

from ..interfaces import (
    EmailPasswordSignInPostOkResult,
    EmailPasswordSignUpPostOkResult,
    ThirdPartySignInUpPostOkResult,
)
from ..types import User
from .emailpassword_api_impementation import get_interface_impl as get_ep_interface_impl
from .thirdparty_api_implementation import get_interface_impl as get_tp_interface_impl


class APIImplementation(APIInterface):
    def __init__(self):
        super().__init__()
        emailpassword_implementation = EmailPasswordImplementation()
        self.ep_email_exists_get = emailpassword_implementation.email_exists_get
        self.ep_generate_password_reset_token_post = (
            emailpassword_implementation.generate_password_reset_token_post
        )
        self.ep_password_reset_post = emailpassword_implementation.password_reset_post
        self.ep_sign_in_post = emailpassword_implementation.sign_in_post
        self.ep_sign_up_post = emailpassword_implementation.sign_up_post
        derived_ep = get_ep_interface_impl(self)
        emailpassword_implementation.email_exists_get = derived_ep.email_exists_get
        emailpassword_implementation.generate_password_reset_token_post = (
            derived_ep.generate_password_reset_token_post
        )
        emailpassword_implementation.password_reset_post = (
            derived_ep.password_reset_post
        )
        emailpassword_implementation.sign_in_post = derived_ep.sign_in_post
        emailpassword_implementation.sign_up_post = derived_ep.sign_up_post

        thirdparty_implementation = ThirdPartyImplementation()
        self.tp_authorisation_url_get = thirdparty_implementation.authorisation_url_get
        self.tp_sign_in_up_post = thirdparty_implementation.sign_in_up_post
        self.tp_apple_redirect_handler_post = (
            thirdparty_implementation.apple_redirect_handler_post
        )
        derived_tp = get_tp_interface_impl(self)
        thirdparty_implementation.authorisation_url_get = (
            derived_tp.authorisation_url_get
        )
        thirdparty_implementation.sign_in_up_post = derived_tp.sign_in_up_post
        thirdparty_implementation.apple_redirect_handler_post = (
            derived_tp.apple_redirect_handler_post
        )

    async def emailpassword_email_exists_get(
        self,
        email: str,
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[EmailExistsGetOkResult, GeneralErrorResponse]:
        return await self.ep_email_exists_get(
            email, tenant_id, api_options, user_context
        )

    async def generate_password_reset_token_post(
        self,
        form_fields: List[FormField],
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[GeneratePasswordResetTokenPostOkResult, GeneralErrorResponse]:
        return await self.ep_generate_password_reset_token_post(
            form_fields, tenant_id, api_options, user_context
        )

    async def password_reset_post(
        self,
        form_fields: List[FormField],
        token: str,
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        PasswordResetPostOkResult,
        PasswordResetPostInvalidTokenResponse,
        GeneralErrorResponse,
    ]:
        return await self.ep_password_reset_post(
            form_fields, token, tenant_id, api_options, user_context
        )

    async def thirdparty_sign_in_up_post(
        self,
        provider: Provider,
        redirect_uri_info: Union[RedirectUriInfo, None],
        oauth_tokens: Union[Dict[str, Any], None],
        tenant_id: str,
        api_options: ThirdPartyApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ThirdPartySignInUpPostOkResult,
        SignInUpPostNoEmailGivenByProviderResponse,
        GeneralErrorResponse,
    ]:
        result = await self.tp_sign_in_up_post(
            provider,
            redirect_uri_info,
            oauth_tokens,
            tenant_id,
            api_options,
            user_context,
        )
        if isinstance(result, SignInUpPostOkResult):
            return ThirdPartySignInUpPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    result.user.third_party_info,
                ),
                result.created_new_user,
                result.session,
                result.oauth_tokens,
                result.raw_user_info_from_provider,
            )
        return result

    async def emailpassword_sign_in_post(
        self,
        form_fields: List[FormField],
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        EmailPasswordSignInPostOkResult,
        SignInPostWrongCredentialsError,
        GeneralErrorResponse,
    ]:
        result = await self.ep_sign_in_post(
            form_fields, tenant_id, api_options, user_context
        )
        if isinstance(result, SignInPostOkResult):
            return EmailPasswordSignInPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    None,
                ),
                result.session,
            )
        return result

    async def emailpassword_sign_up_post(
        self,
        form_fields: List[FormField],
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        EmailPasswordSignUpPostOkResult,
        SignUpPostEmailAlreadyExistsError,
        GeneralErrorResponse,
    ]:
        result = await self.ep_sign_up_post(
            form_fields, tenant_id, api_options, user_context
        )
        if isinstance(result, SignUpPostOkResult):
            return EmailPasswordSignUpPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    None,
                ),
                result.session,
            )
        return result

    async def authorisation_url_get(
        self,
        provider: Provider,
        redirect_uri_on_provider_dashboard: str,
        api_options: ThirdPartyApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[AuthorisationUrlGetOkResult, GeneralErrorResponse]:
        return await self.tp_authorisation_url_get(
            provider,
            redirect_uri_on_provider_dashboard,
            api_options,
            user_context,
        )

    async def apple_redirect_handler_post(
        self,
        form_post_info: Dict[str, Any],
        api_options: ThirdPartyApiOptions,
        user_context: Dict[str, Any],
    ):
        return await self.tp_apple_redirect_handler_post(
            form_post_info, api_options, user_context
        )

Classes

class APIImplementation

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class APIImplementation(APIInterface):
    def __init__(self):
        super().__init__()
        emailpassword_implementation = EmailPasswordImplementation()
        self.ep_email_exists_get = emailpassword_implementation.email_exists_get
        self.ep_generate_password_reset_token_post = (
            emailpassword_implementation.generate_password_reset_token_post
        )
        self.ep_password_reset_post = emailpassword_implementation.password_reset_post
        self.ep_sign_in_post = emailpassword_implementation.sign_in_post
        self.ep_sign_up_post = emailpassword_implementation.sign_up_post
        derived_ep = get_ep_interface_impl(self)
        emailpassword_implementation.email_exists_get = derived_ep.email_exists_get
        emailpassword_implementation.generate_password_reset_token_post = (
            derived_ep.generate_password_reset_token_post
        )
        emailpassword_implementation.password_reset_post = (
            derived_ep.password_reset_post
        )
        emailpassword_implementation.sign_in_post = derived_ep.sign_in_post
        emailpassword_implementation.sign_up_post = derived_ep.sign_up_post

        thirdparty_implementation = ThirdPartyImplementation()
        self.tp_authorisation_url_get = thirdparty_implementation.authorisation_url_get
        self.tp_sign_in_up_post = thirdparty_implementation.sign_in_up_post
        self.tp_apple_redirect_handler_post = (
            thirdparty_implementation.apple_redirect_handler_post
        )
        derived_tp = get_tp_interface_impl(self)
        thirdparty_implementation.authorisation_url_get = (
            derived_tp.authorisation_url_get
        )
        thirdparty_implementation.sign_in_up_post = derived_tp.sign_in_up_post
        thirdparty_implementation.apple_redirect_handler_post = (
            derived_tp.apple_redirect_handler_post
        )

    async def emailpassword_email_exists_get(
        self,
        email: str,
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[EmailExistsGetOkResult, GeneralErrorResponse]:
        return await self.ep_email_exists_get(
            email, tenant_id, api_options, user_context
        )

    async def generate_password_reset_token_post(
        self,
        form_fields: List[FormField],
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[GeneratePasswordResetTokenPostOkResult, GeneralErrorResponse]:
        return await self.ep_generate_password_reset_token_post(
            form_fields, tenant_id, api_options, user_context
        )

    async def password_reset_post(
        self,
        form_fields: List[FormField],
        token: str,
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        PasswordResetPostOkResult,
        PasswordResetPostInvalidTokenResponse,
        GeneralErrorResponse,
    ]:
        return await self.ep_password_reset_post(
            form_fields, token, tenant_id, api_options, user_context
        )

    async def thirdparty_sign_in_up_post(
        self,
        provider: Provider,
        redirect_uri_info: Union[RedirectUriInfo, None],
        oauth_tokens: Union[Dict[str, Any], None],
        tenant_id: str,
        api_options: ThirdPartyApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ThirdPartySignInUpPostOkResult,
        SignInUpPostNoEmailGivenByProviderResponse,
        GeneralErrorResponse,
    ]:
        result = await self.tp_sign_in_up_post(
            provider,
            redirect_uri_info,
            oauth_tokens,
            tenant_id,
            api_options,
            user_context,
        )
        if isinstance(result, SignInUpPostOkResult):
            return ThirdPartySignInUpPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    result.user.third_party_info,
                ),
                result.created_new_user,
                result.session,
                result.oauth_tokens,
                result.raw_user_info_from_provider,
            )
        return result

    async def emailpassword_sign_in_post(
        self,
        form_fields: List[FormField],
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        EmailPasswordSignInPostOkResult,
        SignInPostWrongCredentialsError,
        GeneralErrorResponse,
    ]:
        result = await self.ep_sign_in_post(
            form_fields, tenant_id, api_options, user_context
        )
        if isinstance(result, SignInPostOkResult):
            return EmailPasswordSignInPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    None,
                ),
                result.session,
            )
        return result

    async def emailpassword_sign_up_post(
        self,
        form_fields: List[FormField],
        tenant_id: str,
        api_options: EmailPasswordApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        EmailPasswordSignUpPostOkResult,
        SignUpPostEmailAlreadyExistsError,
        GeneralErrorResponse,
    ]:
        result = await self.ep_sign_up_post(
            form_fields, tenant_id, api_options, user_context
        )
        if isinstance(result, SignUpPostOkResult):
            return EmailPasswordSignUpPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    None,
                ),
                result.session,
            )
        return result

    async def authorisation_url_get(
        self,
        provider: Provider,
        redirect_uri_on_provider_dashboard: str,
        api_options: ThirdPartyApiOptions,
        user_context: Dict[str, Any],
    ) -> Union[AuthorisationUrlGetOkResult, GeneralErrorResponse]:
        return await self.tp_authorisation_url_get(
            provider,
            redirect_uri_on_provider_dashboard,
            api_options,
            user_context,
        )

    async def apple_redirect_handler_post(
        self,
        form_post_info: Dict[str, Any],
        api_options: ThirdPartyApiOptions,
        user_context: Dict[str, Any],
    ):
        return await self.tp_apple_redirect_handler_post(
            form_post_info, api_options, user_context
        )

Ancestors

APIInterface
abc.ABC

Methods

async def apple_redirect_handler_post(self, form_post_info: Dict[str, Any], api_options: ThirdPartyApiOptions, user_context: Dict[str, Any])

Expand source code

async def apple_redirect_handler_post(
    self,
    form_post_info: Dict[str, Any],
    api_options: ThirdPartyApiOptions,
    user_context: Dict[str, Any],
):
    return await self.tp_apple_redirect_handler_post(
        form_post_info, api_options, user_context
    )

async def authorisation_url_get(self, provider: Provider, redirect_uri_on_provider_dashboard: str, api_options: ThirdPartyApiOptions, user_context: Dict[str, Any]) ‑> Union[AuthorisationUrlGetOkResult, GeneralErrorResponse]

Expand source code

async def authorisation_url_get(
    self,
    provider: Provider,
    redirect_uri_on_provider_dashboard: str,
    api_options: ThirdPartyApiOptions,
    user_context: Dict[str, Any],
) -> Union[AuthorisationUrlGetOkResult, GeneralErrorResponse]:
    return await self.tp_authorisation_url_get(
        provider,
        redirect_uri_on_provider_dashboard,
        api_options,
        user_context,
    )

async def emailpassword_email_exists_get(self, email: str, tenant_id: str, api_options: EmailPasswordApiOptions, user_context: Dict[str, Any]) ‑> Union[EmailExistsGetOkResult, GeneralErrorResponse]

Expand source code

async def emailpassword_email_exists_get(
    self,
    email: str,
    tenant_id: str,
    api_options: EmailPasswordApiOptions,
    user_context: Dict[str, Any],
) -> Union[EmailExistsGetOkResult, GeneralErrorResponse]:
    return await self.ep_email_exists_get(
        email, tenant_id, api_options, user_context
    )

async def emailpassword_sign_in_post(self, form_fields: List[FormField], tenant_id: str, api_options: EmailPasswordApiOptions, user_context: Dict[str, Any]) ‑> Union[EmailPasswordSignInPostOkResult, SignInPostWrongCredentialsError, GeneralErrorResponse]

Expand source code

async def emailpassword_sign_in_post(
    self,
    form_fields: List[FormField],
    tenant_id: str,
    api_options: EmailPasswordApiOptions,
    user_context: Dict[str, Any],
) -> Union[
    EmailPasswordSignInPostOkResult,
    SignInPostWrongCredentialsError,
    GeneralErrorResponse,
]:
    result = await self.ep_sign_in_post(
        form_fields, tenant_id, api_options, user_context
    )
    if isinstance(result, SignInPostOkResult):
        return EmailPasswordSignInPostOkResult(
            User(
                result.user.user_id,
                result.user.email,
                result.user.time_joined,
                result.user.tenant_ids,
                None,
            ),
            result.session,
        )
    return result

async def emailpassword_sign_up_post(self, form_fields: List[FormField], tenant_id: str, api_options: EmailPasswordApiOptions, user_context: Dict[str, Any]) ‑> Union[EmailPasswordSignUpPostOkResult, SignUpPostEmailAlreadyExistsError, GeneralErrorResponse]

Expand source code

async def emailpassword_sign_up_post(
    self,
    form_fields: List[FormField],
    tenant_id: str,
    api_options: EmailPasswordApiOptions,
    user_context: Dict[str, Any],
) -> Union[
    EmailPasswordSignUpPostOkResult,
    SignUpPostEmailAlreadyExistsError,
    GeneralErrorResponse,
]:
    result = await self.ep_sign_up_post(
        form_fields, tenant_id, api_options, user_context
    )
    if isinstance(result, SignUpPostOkResult):
        return EmailPasswordSignUpPostOkResult(
            User(
                result.user.user_id,
                result.user.email,
                result.user.time_joined,
                result.user.tenant_ids,
                None,
            ),
            result.session,
        )
    return result

async def generate_password_reset_token_post(self, form_fields: List[FormField], tenant_id: str, api_options: EmailPasswordApiOptions, user_context: Dict[str, Any]) ‑> Union[GeneratePasswordResetTokenPostOkResult, GeneralErrorResponse]

Expand source code

async def generate_password_reset_token_post(
    self,
    form_fields: List[FormField],
    tenant_id: str,
    api_options: EmailPasswordApiOptions,
    user_context: Dict[str, Any],
) -> Union[GeneratePasswordResetTokenPostOkResult, GeneralErrorResponse]:
    return await self.ep_generate_password_reset_token_post(
        form_fields, tenant_id, api_options, user_context
    )

async def password_reset_post(self, form_fields: List[FormField], token: str, tenant_id: str, api_options: EmailPasswordApiOptions, user_context: Dict[str, Any]) ‑> Union[PasswordResetPostOkResult, PasswordResetPostInvalidTokenResponse, GeneralErrorResponse]

Expand source code

async def password_reset_post(
    self,
    form_fields: List[FormField],
    token: str,
    tenant_id: str,
    api_options: EmailPasswordApiOptions,
    user_context: Dict[str, Any],
) -> Union[
    PasswordResetPostOkResult,
    PasswordResetPostInvalidTokenResponse,
    GeneralErrorResponse,
]:
    return await self.ep_password_reset_post(
        form_fields, token, tenant_id, api_options, user_context
    )

async def thirdparty_sign_in_up_post(self, provider: Provider, redirect_uri_info: Union[RedirectUriInfo, None], oauth_tokens: Union[Dict[str, Any], None], tenant_id: str, api_options: ThirdPartyApiOptions, user_context: Dict[str, Any]) ‑> Union[ThirdPartySignInUpPostOkResult, SignInUpPostNoEmailGivenByProviderResponse, GeneralErrorResponse]

Expand source code

async def thirdparty_sign_in_up_post(
    self,
    provider: Provider,
    redirect_uri_info: Union[RedirectUriInfo, None],
    oauth_tokens: Union[Dict[str, Any], None],
    tenant_id: str,
    api_options: ThirdPartyApiOptions,
    user_context: Dict[str, Any],
) -> Union[
    ThirdPartySignInUpPostOkResult,
    SignInUpPostNoEmailGivenByProviderResponse,
    GeneralErrorResponse,
]:
    result = await self.tp_sign_in_up_post(
        provider,
        redirect_uri_info,
        oauth_tokens,
        tenant_id,
        api_options,
        user_context,
    )
    if isinstance(result, SignInUpPostOkResult):
        return ThirdPartySignInUpPostOkResult(
            User(
                result.user.user_id,
                result.user.email,
                result.user.time_joined,
                result.user.tenant_ids,
                result.user.third_party_info,
            ),
            result.created_new_user,
            result.session,
            result.oauth_tokens,
            result.raw_user_info_from_provider,
        )
    return result