Module supertokens_python.recipe.thirdpartypasswordless.recipe

Classes

class ThirdPartyPasswordlessRecipe (recipe_id: str, app_info: AppInfo, contact_config: ContactConfig, flow_type: "Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK']", ingredients: ThirdPartyPasswordlessIngredients, get_link_domain_and_path: Union[Callable[[PhoneOrEmailInput, Dict[str, Any]], Awaitable[str]], None] = None, get_custom_user_input_code: Union[Callable[[Dict[str, Any]], Awaitable[str]], None] = None, email_verification_feature: Union[InputEmailVerificationConfig, None] = None, override: Union[InputOverrideConfig, None] = None, providers: Union[List[Provider], None] = None, email_verification_recipe: Union[EmailVerificationRecipe, None] = None, third_party_recipe: Union[ThirdPartyRecipe, None] = None, passwordless_recipe: Union[PasswordlessRecipe, None] = None, email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None, sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None)

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

Expand source code

class ThirdPartyPasswordlessRecipe(RecipeModule):
    recipe_id = 'thirdpartypasswordless'
    __instance = None
    email_delivery: EmailDeliveryIngredient[EmailTemplateVars]
    sms_delivery: SMSDeliveryIngredient[SMSTemplateVars]

    def __init__(self, recipe_id: str, app_info: AppInfo,
                 contact_config: ContactConfig,
                 flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'],
                 ingredients: ThirdPartyPasswordlessIngredients,
                 get_link_domain_and_path: Union[Callable[[PhoneOrEmailInput, Dict[str, Any]], Awaitable[str]], None] = None,
                 get_custom_user_input_code: Union[Callable[[Dict[str, Any]], Awaitable[str]], None] = None,
                 email_verification_feature: Union[InputEmailVerificationConfig, None] = None,
                 override: Union[InputOverrideConfig, None] = None,
                 providers: Union[List[Provider], None] = None,
                 email_verification_recipe: Union[EmailVerificationRecipe, None] = None,
                 third_party_recipe: Union[ThirdPartyRecipe, None] = None,
                 passwordless_recipe: Union[PasswordlessRecipe, None] = None,
                 email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None,
                 sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None,
                 ):
        super().__init__(recipe_id, app_info)
        self.config = validate_and_normalise_user_input(self,
                                                        contact_config=contact_config,
                                                        email_verification_feature=email_verification_feature,
                                                        flow_type=flow_type,
                                                        get_custom_user_input_code=get_custom_user_input_code,
                                                        get_link_domain_and_path=get_link_domain_and_path,
                                                        override=override,
                                                        providers=providers,
                                                        email_delivery=email_delivery,
                                                        sms_delivery=sms_delivery,
                                                        )

        recipe_implementation = RecipeImplementation(Querier.get_instance(PasswordlessRecipe.recipe_id), Querier.get_instance(ThirdPartyRecipe.recipe_id))
        self.recipe_implementation: RecipeInterface = recipe_implementation if self.config.override.functions is None else \
            self.config.override.functions(recipe_implementation)

        api_implementation = APIImplementation()
        self.api_implementation: APIInterface = api_implementation if self.config.override.apis is None else \
            self.config.override.apis(api_implementation)

        email_delivery_ingredient = ingredients.email_delivery
        if email_delivery_ingredient is None:
            self.email_delivery = EmailDeliveryIngredient(self.config.get_email_delivery_config(recipe_implementation))
        else:
            self.email_delivery = email_delivery_ingredient

        sms_delivery_ingredient = ingredients.sms_delivery
        if sms_delivery_ingredient is None:
            self.sms_delivery = SMSDeliveryIngredient(self.config.get_sms_delivery_config())
        else:
            self.sms_delivery = sms_delivery_ingredient

        if email_verification_recipe is not None:
            self.email_verification_recipe = email_verification_recipe
        else:
            userProvidedFunctionOverride: Union[None, Callable[[EVRecipeInterface], EVRecipeInterface]] = None
            if self.config.email_verification_feature.override is not None:
                userProvidedFunctionOverride = self.config.email_verification_feature.override.functions

            def email_verification_override(original_impl: EVRecipeInterface) -> EVRecipeInterface:
                og_create_email_verification_token = original_impl.create_email_verification_token
                og_is_email_verified = original_impl.is_email_verified

                async def create_email_verification_token(user_id: str, email: str, user_context: Dict[str, Any]) -> Union[CreateEmailVerificationTokenOkResult, CreateEmailVerificationTokenEmailAlreadyVerifiedError]:
                    user = await self.recipe_implementation.get_user_by_id(user_id, user_context)
                    if user is None or user.third_party_info is not None:
                        return await og_create_email_verification_token(user_id, email, user_context)
                    return CreateEmailVerificationTokenEmailAlreadyVerifiedError()

                async def is_email_verified(user_id: str, email: str, user_context: Dict[str, Any]) -> bool:
                    user = await self.recipe_implementation.get_user_by_id(user_id, user_context)
                    if user is None or user.third_party_info is not None:
                        return await og_is_email_verified(user_id, email, user_context)

                    # this is a passwordless user, so we always want
                    # to return that their info / email is verified
                    return True

                original_impl.create_email_verification_token = create_email_verification_token
                original_impl.is_email_verified = is_email_verified

                if userProvidedFunctionOverride is None:
                    return original_impl
                return userProvidedFunctionOverride(original_impl)

            if self.config.email_verification_feature.override is None:
                self.config.email_verification_feature.override = EVOverrideConfig(email_verification_override)
            else:
                self.config.email_verification_feature.override.functions = email_verification_override

            ev_email_delivery = cast(EmailDeliveryIngredient[EmailVerificationEmailTemplateVars], self.email_delivery)
            ev_ingredients = EmailVerificationIngredients(ev_email_delivery)
            self.email_verification_recipe = EmailVerificationRecipe(recipe_id, app_info,
                                                                     self.config.email_verification_feature, ev_ingredients)

        if passwordless_recipe is not None:
            self.passwordless_recipe = passwordless_recipe
        else:
            def func_override_passwordless(_: PasswordlessRecipeInterface) -> PasswordlessRecipeInterface:
                return PasswordlessRecipeImplementation(self.recipe_implementation)

            def apis_override_passwordless(_: PasswordlessAPIInterface) -> PasswordlessAPIInterface:
                return get_passwordless_interface_impl(self.api_implementation)

            pless_email_delivery = cast(
                EmailDeliveryIngredient[PasswordlessLoginEmailTemplateVars],
                self.email_delivery
            )
            pless_sms_delivery = self.sms_delivery
            pless_ingredients = PasswordlessIngredients(pless_email_delivery, pless_sms_delivery)
            self.passwordless_recipe = PasswordlessRecipe(recipe_id, app_info,
                                                          self.config.contact_config,
                                                          self.config.flow_type,
                                                          pless_ingredients,
                                                          PlessOverrideConfig(
                                                              func_override_passwordless,
                                                              apis_override_passwordless
                                                          ),
                                                          self.config.get_link_domain_and_path,
                                                          self.config.get_custom_user_input_code,
                                                          )

        if third_party_recipe is not None:
            self.third_party_recipe: Union[ThirdPartyRecipe, None] = third_party_recipe
        else:
            def func_override_third_party(_: ThirdPartyRecipeInterface) -> ThirdPartyRecipeInterface:
                return ThirdPartyRecipeImplementation(self.recipe_implementation)

            def apis_override_third_party(_: ThirdPartyAPIInterface) -> ThirdPartyAPIInterface:
                return get_third_party_interface_impl(self.api_implementation)

            self.third_party_recipe: Union[ThirdPartyRecipe, None] = None

            if len(self.config.providers) != 0:
                tp_email_delivery = cast(EmailDeliveryIngredient[ThirdPartyEmailTemplateVars], self.email_delivery)
                tp_ingredients = ThirdPartyIngredients(tp_email_delivery)
                self.third_party_recipe = ThirdPartyRecipe(
                    recipe_id,
                    app_info,
                    SignInAndUpFeature(self.config.providers),
                    tp_ingredients,
                    None,
                    TPOverrideConfig(
                        func_override_third_party,
                        apis_override_third_party
                    ),
                    self.email_verification_recipe,
                )

    def is_error_from_this_recipe_based_on_instance(
            self, err: Exception) -> bool:
        return isinstance(err, SuperTokensError) and (
            isinstance(err, SupertokensThirdPartyPasswordlessError)
            or
            self.email_verification_recipe.is_error_from_this_recipe_based_on_instance(
                err)
            or
            self.passwordless_recipe.is_error_from_this_recipe_based_on_instance(
                err)
            or
            (
                self.third_party_recipe is not None
                and
                self.third_party_recipe.is_error_from_this_recipe_based_on_instance(
                    err)
            )
        )

    def get_apis_handled(self) -> List[APIHandled]:
        apis_handled = self.passwordless_recipe.get_apis_handled(
        ) + self.email_verification_recipe.get_apis_handled()
        if self.third_party_recipe is not None:
            apis_handled = apis_handled + self.third_party_recipe.get_apis_handled()
        return apis_handled

    async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse):
        if self.passwordless_recipe.return_api_id_if_can_handle_request(
                path, method) is not None:
            return await self.passwordless_recipe.handle_api_request(request_id, request, path, method, response)
        if self.third_party_recipe is not None and self.third_party_recipe.return_api_id_if_can_handle_request(path,
                                                                                                               method) is not None:
            return await self.third_party_recipe.handle_api_request(request_id, request, path, method, response)
        return await self.email_verification_recipe.handle_api_request(request_id, request, path, method, response)

    async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) -> BaseResponse:
        if self.passwordless_recipe.is_error_from_this_recipe_based_on_instance(
                err):
            return await self.passwordless_recipe.handle_error(
                request, err, response)
        if self.third_party_recipe is not None and self.third_party_recipe.is_error_from_this_recipe_based_on_instance(
                err):
            return await self.third_party_recipe.handle_error(
                request, err, response)
        return await self.email_verification_recipe.handle_error(
            request, err, response)

    def get_all_cors_headers(self) -> List[str]:
        cors_headers = self.passwordless_recipe.get_all_cors_headers(
        ) + self.email_verification_recipe.get_all_cors_headers()
        if self.third_party_recipe is not None:
            cors_headers = cors_headers + self.third_party_recipe.get_all_cors_headers()
        return cors_headers

    @staticmethod
    def init(contact_config: ContactConfig,
             flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'],
             get_link_domain_and_path: Union[Callable[[
                 PhoneOrEmailInput, Dict[str, Any]], Awaitable[str]], None] = None,
             get_custom_user_input_code: Union[Callable[[Dict[str, Any]], Awaitable[str]], None] = None,
             email_verification_feature: Union[InputEmailVerificationConfig, None] = None,
             email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None,
             sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None,
             override: Union[InputOverrideConfig, None] = None,
             providers: Union[List[Provider], None] = None):
        def func(app_info: AppInfo):
            if ThirdPartyPasswordlessRecipe.__instance is None:
                ingredients = ThirdPartyPasswordlessIngredients(None, None)
                ThirdPartyPasswordlessRecipe.__instance = ThirdPartyPasswordlessRecipe(
                    ThirdPartyPasswordlessRecipe.recipe_id, app_info, contact_config, flow_type, ingredients, get_link_domain_and_path, get_custom_user_input_code,
                    email_verification_feature,
                    override,
                    providers,
                    email_delivery=email_delivery,
                    sms_delivery=sms_delivery,
                )
                return ThirdPartyPasswordlessRecipe.__instance
            raise Exception(None, 'ThirdPartyPasswordlessRecipe recipe has already been initialised. Please check your code for bugs.')

        return func

    @staticmethod
    def get_instance() -> ThirdPartyPasswordlessRecipe:
        if ThirdPartyPasswordlessRecipe.__instance is not None:
            return ThirdPartyPasswordlessRecipe.__instance
        raise Exception(
            None,
            'Initialisation not done. Did you forget to call the SuperTokens.init function?')

    @staticmethod
    def reset():
        if ('SUPERTOKENS_ENV' not in environ) or (
                environ['SUPERTOKENS_ENV'] != 'testing'):
            raise Exception(
                None, 'calling testing function in non testing env')
        ThirdPartyPasswordlessRecipe.__instance = None

    async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any]) -> str:
        user_info = await self.recipe_implementation.get_user_by_id(user_id, user_context)
        if user_info is None:
            raise Exception('Unknown User ID provided')
        if user_info.third_party_info is None:
            if user_info.email is not None:
                return user_info.email
            # this is a passwordless user with only a phone number.
            # returning an empty string here is not a problem since
            # we override the email verification functions above to
            # send that the email is already verified for passwordless users.
            return ""
        if user_info.email is None:
            raise Exception("Should never come here")
        return user_info.email

Ancestors

• RecipeModule
• abc.ABC

Class variables

var email_delivery : EmailDeliveryIngredient[typing.Union[VerificationEmailTemplateVars, CreateAndSendCustomEmailParameters]]

var recipe_id

var sms_delivery : SMSDeliveryIngredient[CreateAndSendCustomTextMessageParameters]

Static methods

def get_instance() ‑> ThirdPartyPasswordlessRecipe

Expand source code

@staticmethod
def get_instance() -> ThirdPartyPasswordlessRecipe:
    if ThirdPartyPasswordlessRecipe.__instance is not None:
        return ThirdPartyPasswordlessRecipe.__instance
    raise Exception(
        None,
        'Initialisation not done. Did you forget to call the SuperTokens.init function?')

def init(contact_config: ContactConfig, flow_type: "Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK']", get_link_domain_and_path: Union[Callable[[PhoneOrEmailInput, Dict[str, Any]], Awaitable[str]], None] = None, get_custom_user_input_code: Union[Callable[[Dict[str, Any]], Awaitable[str]], None] = None, email_verification_feature: Union[InputEmailVerificationConfig, None] = None, email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None, sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None, override: Union[InputOverrideConfig, None] = None, providers: Union[List[Provider], None] = None)

Expand source code

@staticmethod
def init(contact_config: ContactConfig,
         flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'],
         get_link_domain_and_path: Union[Callable[[
             PhoneOrEmailInput, Dict[str, Any]], Awaitable[str]], None] = None,
         get_custom_user_input_code: Union[Callable[[Dict[str, Any]], Awaitable[str]], None] = None,
         email_verification_feature: Union[InputEmailVerificationConfig, None] = None,
         email_delivery: Union[EmailDeliveryConfig[EmailTemplateVars], None] = None,
         sms_delivery: Union[SMSDeliveryConfig[SMSTemplateVars], None] = None,
         override: Union[InputOverrideConfig, None] = None,
         providers: Union[List[Provider], None] = None):
    def func(app_info: AppInfo):
        if ThirdPartyPasswordlessRecipe.__instance is None:
            ingredients = ThirdPartyPasswordlessIngredients(None, None)
            ThirdPartyPasswordlessRecipe.__instance = ThirdPartyPasswordlessRecipe(
                ThirdPartyPasswordlessRecipe.recipe_id, app_info, contact_config, flow_type, ingredients, get_link_domain_and_path, get_custom_user_input_code,
                email_verification_feature,
                override,
                providers,
                email_delivery=email_delivery,
                sms_delivery=sms_delivery,
            )
            return ThirdPartyPasswordlessRecipe.__instance
        raise Exception(None, 'ThirdPartyPasswordlessRecipe recipe has already been initialised. Please check your code for bugs.')

    return func

def reset()

Expand source code

@staticmethod
def reset():
    if ('SUPERTOKENS_ENV' not in environ) or (
            environ['SUPERTOKENS_ENV'] != 'testing'):
        raise Exception(
            None, 'calling testing function in non testing env')
    ThirdPartyPasswordlessRecipe.__instance = None

Methods

def get_all_cors_headers(self) ‑> List[str]

Expand source code

def get_all_cors_headers(self) -> List[str]:
    cors_headers = self.passwordless_recipe.get_all_cors_headers(
    ) + self.email_verification_recipe.get_all_cors_headers()
    if self.third_party_recipe is not None:
        cors_headers = cors_headers + self.third_party_recipe.get_all_cors_headers()
    return cors_headers

def get_apis_handled(self) ‑> List[APIHandled]

Expand source code

def get_apis_handled(self) -> List[APIHandled]:
    apis_handled = self.passwordless_recipe.get_apis_handled(
    ) + self.email_verification_recipe.get_apis_handled()
    if self.third_party_recipe is not None:
        apis_handled = apis_handled + self.third_party_recipe.get_apis_handled()
    return apis_handled

async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any]) ‑> str

Expand source code

async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any]) -> str:
    user_info = await self.recipe_implementation.get_user_by_id(user_id, user_context)
    if user_info is None:
        raise Exception('Unknown User ID provided')
    if user_info.third_party_info is None:
        if user_info.email is not None:
            return user_info.email
        # this is a passwordless user with only a phone number.
        # returning an empty string here is not a problem since
        # we override the email verification functions above to
        # send that the email is already verified for passwordless users.
        return ""
    if user_info.email is None:
        raise Exception("Should never come here")
    return user_info.email

async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse)

Expand source code

async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse):
    if self.passwordless_recipe.return_api_id_if_can_handle_request(
            path, method) is not None:
        return await self.passwordless_recipe.handle_api_request(request_id, request, path, method, response)
    if self.third_party_recipe is not None and self.third_party_recipe.return_api_id_if_can_handle_request(path,
                                                                                                           method) is not None:
        return await self.third_party_recipe.handle_api_request(request_id, request, path, method, response)
    return await self.email_verification_recipe.handle_api_request(request_id, request, path, method, response)

async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) ‑> BaseResponse

Expand source code

async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse) -> BaseResponse:
    if self.passwordless_recipe.is_error_from_this_recipe_based_on_instance(
            err):
        return await self.passwordless_recipe.handle_error(
            request, err, response)
    if self.third_party_recipe is not None and self.third_party_recipe.is_error_from_this_recipe_based_on_instance(
            err):
        return await self.third_party_recipe.handle_error(
            request, err, response)
    return await self.email_verification_recipe.handle_error(
        request, err, response)

def is_error_from_this_recipe_based_on_instance(self, err: Exception) ‑> bool

Expand source code

def is_error_from_this_recipe_based_on_instance(
        self, err: Exception) -> bool:
    return isinstance(err, SuperTokensError) and (
        isinstance(err, SupertokensThirdPartyPasswordlessError)
        or
        self.email_verification_recipe.is_error_from_this_recipe_based_on_instance(
            err)
        or
        self.passwordless_recipe.is_error_from_this_recipe_based_on_instance(
            err)
        or
        (
            self.third_party_recipe is not None
            and
            self.third_party_recipe.is_error_from_this_recipe_based_on_instance(
                err)
        )
    )