Module `supertokens_python.recipe.thirdpartypasswordless.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, Optional, Union

import supertokens_python.recipe.passwordless.interfaces as PlessInterfaces
import supertokens_python.recipe.thirdparty.interfaces as ThirdPartyInterfaces
from supertokens_python.types import GeneralErrorResponse

from ...passwordless.api.implementation import (
    APIImplementation as PasswordlessImplementation,
)
from ...passwordless.interfaces import APIInterface
from ...passwordless.interfaces import APIOptions as PasswordlessAPIOptions
from ...thirdparty.api.implementation import (
    APIImplementation as ThirdPartyImplementation,
)
from ...thirdparty.interfaces import APIOptions as ThirdPartyAPIOptions
from ...thirdparty.provider import Provider, RedirectUriInfo
from ..interfaces import (
    APIInterface,
    AuthorisationUrlGetOkResult,
    ConsumeCodePostExpiredUserInputCodeError,
    ConsumeCodePostIncorrectUserInputCodeError,
    ConsumeCodePostOkResult,
    ConsumeCodePostRestartFlowError,
    CreateCodePostOkResult,
    PasswordlessEmailExistsGetOkResult,
    PasswordlessPhoneNumberExistsGetOkResult,
    ResendCodePostOkResult,
    ResendCodePostRestartFlowError,
    ThirdPartySignInUpPostNoEmailGivenByProviderResponse,
    ThirdPartySignInUpPostOkResult,
)
from ..types import User
from .passwordless_api_impementation import (
    get_interface_impl as get_pless_interface_impl,
)
from .thirdparty_api_implementation import get_interface_impl as get_tp_interface_impl


class APIImplementation(APIInterface):
    def __init__(self):
        super().__init__()
        passwordless_implementation = PasswordlessImplementation()
        self.pless_email_exists_get = passwordless_implementation.email_exists_get
        self.pless_consume_code_post = passwordless_implementation.consume_code_post
        self.pless_create_code_post = passwordless_implementation.create_code_post
        self.pless_phone_number_exists_get = (
            passwordless_implementation.phone_number_exists_get
        )
        self.pless_resend_code_post = passwordless_implementation.resend_code_post
        derived_pless = get_pless_interface_impl(self)
        passwordless_implementation.email_exists_get = derived_pless.email_exists_get
        passwordless_implementation.create_code_post = derived_pless.create_code_post
        passwordless_implementation.consume_code_post = derived_pless.consume_code_post
        passwordless_implementation.phone_number_exists_get = (
            derived_pless.phone_number_exists_get
        )
        passwordless_implementation.resend_code_post = derived_pless.resend_code_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 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 thirdparty_sign_in_up_post(
        self,
        provider: Provider,
        redirect_uri_info: Optional[RedirectUriInfo],
        oauth_tokens: Optional[Dict[str, Any]],
        tenant_id: str,
        api_options: ThirdPartyAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ThirdPartySignInUpPostOkResult,
        ThirdPartySignInUpPostNoEmailGivenByProviderResponse,
        GeneralErrorResponse,
    ]:
        result = await self.tp_sign_in_up_post(
            provider,
            redirect_uri_info,
            oauth_tokens,
            tenant_id,
            api_options,
            user_context,
        )
        if isinstance(result, ThirdPartyInterfaces.SignInUpPostOkResult):
            return ThirdPartySignInUpPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    None,
                    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 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 create_code_post(
        self,
        email: Union[str, None],
        phone_number: Union[str, None],
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[CreateCodePostOkResult, GeneralErrorResponse]:
        return await self.pless_create_code_post(
            email, phone_number, tenant_id, api_options, user_context
        )

    async def resend_code_post(
        self,
        device_id: str,
        pre_auth_session_id: str,
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse
    ]:
        return await self.pless_resend_code_post(
            device_id, pre_auth_session_id, tenant_id, api_options, user_context
        )

    async def consume_code_post(
        self,
        pre_auth_session_id: str,
        user_input_code: Union[str, None],
        device_id: Union[str, None],
        link_code: Union[str, None],
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ConsumeCodePostOkResult,
        ConsumeCodePostRestartFlowError,
        GeneralErrorResponse,
        ConsumeCodePostIncorrectUserInputCodeError,
        ConsumeCodePostExpiredUserInputCodeError,
    ]:
        result = await self.pless_consume_code_post(
            pre_auth_session_id,
            user_input_code,
            device_id,
            link_code,
            tenant_id,
            api_options,
            user_context,
        )
        if isinstance(result, PlessInterfaces.ConsumeCodePostOkResult):
            return ConsumeCodePostOkResult(
                result.created_new_user,
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.phone_number,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    None,
                ),
                result.session,
            )
        return result

    async def passwordless_user_email_exists_get(
        self,
        email: str,
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[PasswordlessEmailExistsGetOkResult, GeneralErrorResponse]:
        return await self.pless_email_exists_get(
            email, tenant_id, api_options, user_context
        )

    async def passwordless_user_phone_number_exists_get(
        self,
        phone_number: str,
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[PasswordlessPhoneNumberExistsGetOkResult, GeneralErrorResponse]:
        return await self.pless_phone_number_exists_get(
            phone_number, tenant_id, 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__()
        passwordless_implementation = PasswordlessImplementation()
        self.pless_email_exists_get = passwordless_implementation.email_exists_get
        self.pless_consume_code_post = passwordless_implementation.consume_code_post
        self.pless_create_code_post = passwordless_implementation.create_code_post
        self.pless_phone_number_exists_get = (
            passwordless_implementation.phone_number_exists_get
        )
        self.pless_resend_code_post = passwordless_implementation.resend_code_post
        derived_pless = get_pless_interface_impl(self)
        passwordless_implementation.email_exists_get = derived_pless.email_exists_get
        passwordless_implementation.create_code_post = derived_pless.create_code_post
        passwordless_implementation.consume_code_post = derived_pless.consume_code_post
        passwordless_implementation.phone_number_exists_get = (
            derived_pless.phone_number_exists_get
        )
        passwordless_implementation.resend_code_post = derived_pless.resend_code_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 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 thirdparty_sign_in_up_post(
        self,
        provider: Provider,
        redirect_uri_info: Optional[RedirectUriInfo],
        oauth_tokens: Optional[Dict[str, Any]],
        tenant_id: str,
        api_options: ThirdPartyAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ThirdPartySignInUpPostOkResult,
        ThirdPartySignInUpPostNoEmailGivenByProviderResponse,
        GeneralErrorResponse,
    ]:
        result = await self.tp_sign_in_up_post(
            provider,
            redirect_uri_info,
            oauth_tokens,
            tenant_id,
            api_options,
            user_context,
        )
        if isinstance(result, ThirdPartyInterfaces.SignInUpPostOkResult):
            return ThirdPartySignInUpPostOkResult(
                User(
                    result.user.user_id,
                    result.user.email,
                    None,
                    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 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 create_code_post(
        self,
        email: Union[str, None],
        phone_number: Union[str, None],
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[CreateCodePostOkResult, GeneralErrorResponse]:
        return await self.pless_create_code_post(
            email, phone_number, tenant_id, api_options, user_context
        )

    async def resend_code_post(
        self,
        device_id: str,
        pre_auth_session_id: str,
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse
    ]:
        return await self.pless_resend_code_post(
            device_id, pre_auth_session_id, tenant_id, api_options, user_context
        )

    async def consume_code_post(
        self,
        pre_auth_session_id: str,
        user_input_code: Union[str, None],
        device_id: Union[str, None],
        link_code: Union[str, None],
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[
        ConsumeCodePostOkResult,
        ConsumeCodePostRestartFlowError,
        GeneralErrorResponse,
        ConsumeCodePostIncorrectUserInputCodeError,
        ConsumeCodePostExpiredUserInputCodeError,
    ]:
        result = await self.pless_consume_code_post(
            pre_auth_session_id,
            user_input_code,
            device_id,
            link_code,
            tenant_id,
            api_options,
            user_context,
        )
        if isinstance(result, PlessInterfaces.ConsumeCodePostOkResult):
            return ConsumeCodePostOkResult(
                result.created_new_user,
                User(
                    result.user.user_id,
                    result.user.email,
                    result.user.phone_number,
                    result.user.time_joined,
                    result.user.tenant_ids,
                    None,
                ),
                result.session,
            )
        return result

    async def passwordless_user_email_exists_get(
        self,
        email: str,
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[PasswordlessEmailExistsGetOkResult, GeneralErrorResponse]:
        return await self.pless_email_exists_get(
            email, tenant_id, api_options, user_context
        )

    async def passwordless_user_phone_number_exists_get(
        self,
        phone_number: str,
        tenant_id: str,
        api_options: PasswordlessAPIOptions,
        user_context: Dict[str, Any],
    ) -> Union[PasswordlessPhoneNumberExistsGetOkResult, GeneralErrorResponse]:
        return await self.pless_phone_number_exists_get(
            phone_number, tenant_id, 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 consume_code_post(self, pre_auth_session_id: str, user_input_code: Union[str, None], device_id: Union[str, None], link_code: Union[str, None], tenant_id: str, api_options: PasswordlessAPIOptions, user_context: Dict[str, Any]) ‑> Union[ConsumeCodePostOkResult, ConsumeCodePostRestartFlowError, GeneralErrorResponse, ConsumeCodePostIncorrectUserInputCodeError, ConsumeCodePostExpiredUserInputCodeError]

Expand source code

async def consume_code_post(
    self,
    pre_auth_session_id: str,
    user_input_code: Union[str, None],
    device_id: Union[str, None],
    link_code: Union[str, None],
    tenant_id: str,
    api_options: PasswordlessAPIOptions,
    user_context: Dict[str, Any],
) -> Union[
    ConsumeCodePostOkResult,
    ConsumeCodePostRestartFlowError,
    GeneralErrorResponse,
    ConsumeCodePostIncorrectUserInputCodeError,
    ConsumeCodePostExpiredUserInputCodeError,
]:
    result = await self.pless_consume_code_post(
        pre_auth_session_id,
        user_input_code,
        device_id,
        link_code,
        tenant_id,
        api_options,
        user_context,
    )
    if isinstance(result, PlessInterfaces.ConsumeCodePostOkResult):
        return ConsumeCodePostOkResult(
            result.created_new_user,
            User(
                result.user.user_id,
                result.user.email,
                result.user.phone_number,
                result.user.time_joined,
                result.user.tenant_ids,
                None,
            ),
            result.session,
        )
    return result

async def create_code_post(self, email: Union[str, None], phone_number: Union[str, None], tenant_id: str, api_options: PasswordlessAPIOptions, user_context: Dict[str, Any]) ‑> Union[CreateCodePostOkResult, GeneralErrorResponse]

Expand source code

async def create_code_post(
    self,
    email: Union[str, None],
    phone_number: Union[str, None],
    tenant_id: str,
    api_options: PasswordlessAPIOptions,
    user_context: Dict[str, Any],
) -> Union[CreateCodePostOkResult, GeneralErrorResponse]:
    return await self.pless_create_code_post(
        email, phone_number, tenant_id, api_options, user_context
    )

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

Expand source code

async def passwordless_user_email_exists_get(
    self,
    email: str,
    tenant_id: str,
    api_options: PasswordlessAPIOptions,
    user_context: Dict[str, Any],
) -> Union[PasswordlessEmailExistsGetOkResult, GeneralErrorResponse]:
    return await self.pless_email_exists_get(
        email, tenant_id, api_options, user_context
    )

async def passwordless_user_phone_number_exists_get(self, phone_number: str, tenant_id: str, api_options: PasswordlessAPIOptions, user_context: Dict[str, Any]) ‑> Union[PhoneNumberExistsGetOkResult, GeneralErrorResponse]

Expand source code

async def passwordless_user_phone_number_exists_get(
    self,
    phone_number: str,
    tenant_id: str,
    api_options: PasswordlessAPIOptions,
    user_context: Dict[str, Any],
) -> Union[PasswordlessPhoneNumberExistsGetOkResult, GeneralErrorResponse]:
    return await self.pless_phone_number_exists_get(
        phone_number, tenant_id, api_options, user_context
    )

async def resend_code_post(self, device_id: str, pre_auth_session_id: str, tenant_id: str, api_options: PasswordlessAPIOptions, user_context: Dict[str, Any]) ‑> Union[ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse]

Expand source code

async def resend_code_post(
    self,
    device_id: str,
    pre_auth_session_id: str,
    tenant_id: str,
    api_options: PasswordlessAPIOptions,
    user_context: Dict[str, Any],
) -> Union[
    ResendCodePostOkResult, ResendCodePostRestartFlowError, GeneralErrorResponse
]:
    return await self.pless_resend_code_post(
        device_id, pre_auth_session_id, tenant_id, api_options, user_context
    )

async def thirdparty_sign_in_up_post(self, provider: Provider, redirect_uri_info: Optional[RedirectUriInfo], oauth_tokens: Optional[Dict[str, Any]], 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: Optional[RedirectUriInfo],
    oauth_tokens: Optional[Dict[str, Any]],
    tenant_id: str,
    api_options: ThirdPartyAPIOptions,
    user_context: Dict[str, Any],
) -> Union[
    ThirdPartySignInUpPostOkResult,
    ThirdPartySignInUpPostNoEmailGivenByProviderResponse,
    GeneralErrorResponse,
]:
    result = await self.tp_sign_in_up_post(
        provider,
        redirect_uri_info,
        oauth_tokens,
        tenant_id,
        api_options,
        user_context,
    )
    if isinstance(result, ThirdPartyInterfaces.SignInUpPostOkResult):
        return ThirdPartySignInUpPostOkResult(
            User(
                result.user.user_id,
                result.user.email,
                None,
                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