Module supertokens_python.recipe.passwordless.recipe

Classes

class PasswordlessRecipe (recipe_id: str, app_info: AppInfo, contact_config: ContactConfig, flow_type: "Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK']", ingredients: PasswordlessIngredients, override: Union[OverrideConfig, None] = None, 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_delivery: Union[EmailDeliveryConfig[TypePasswordlessEmailDeliveryInput], None] = None, sms_delivery: Union[SMSDeliveryConfig[TypePasswordlessSmsDeliveryInput], None] = None)

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

Expand source code

class PasswordlessRecipe(RecipeModule):
    recipe_id = 'passwordless'
    __instance = None
    email_delivery: EmailDeliveryIngredient[TypePasswordlessEmailDeliveryInput]
    sms_delivery: SMSDeliveryIngredient[TypePasswordlessSmsDeliveryInput]

    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: PasswordlessIngredients,
                 override: Union[OverrideConfig, None] = None,
                 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_delivery: Union[EmailDeliveryConfig[TypePasswordlessEmailDeliveryInput], None] = None,
                 sms_delivery: Union[SMSDeliveryConfig[TypePasswordlessSmsDeliveryInput], None] = None,
                 ):
        super().__init__(recipe_id, app_info)
        self.config = validate_and_normalise_user_input(app_info, contact_config, flow_type, override,
                                                        get_link_domain_and_path, get_custom_user_input_code, email_delivery, sms_delivery)

        recipe_implementation = RecipeImplementation(Querier.get_instance(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 = 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())
        else:
            self.email_delivery = email_delivery_ingredient

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

    def get_apis_handled(self) -> List[APIHandled]:
        return [
            APIHandled(method='post', path_without_api_base_path=NormalisedURLPath(CONSUME_CODE_API),
                       request_id=CONSUME_CODE_API,
                       disabled=self.api_implementation.disable_consume_code_post),
            APIHandled(method='post', path_without_api_base_path=NormalisedURLPath(CREATE_CODE_API),
                       request_id=CREATE_CODE_API,
                       disabled=self.api_implementation.disable_create_code_post),
            APIHandled(method='get', path_without_api_base_path=NormalisedURLPath(DOES_EMAIL_EXIST_API),
                       request_id=DOES_EMAIL_EXIST_API,
                       disabled=self.api_implementation.disable_email_exists_get),
            APIHandled(method='get', path_without_api_base_path=NormalisedURLPath(DOES_PHONE_NUMBER_EXIST_API),
                       request_id=DOES_PHONE_NUMBER_EXIST_API,
                       disabled=self.api_implementation.disable_phone_number_exists_get),
            APIHandled(method='post', path_without_api_base_path=NormalisedURLPath(RESEND_CODE_API),
                       request_id=RESEND_CODE_API,
                       disabled=self.api_implementation.disable_resend_code_post)
        ]

    async def handle_api_request(self, request_id: str, request: BaseRequest, path: NormalisedURLPath, method: str,
                                 response: BaseResponse):
        options = APIOptions(
            request,
            response,
            self.get_recipe_id(),
            self.config,
            self.recipe_implementation,
            self.email_delivery,
            self.sms_delivery
        )
        if request_id == CONSUME_CODE_API:
            return await consume_code(self.api_implementation, options)
        if request_id == CREATE_CODE_API:
            return await create_code(self.api_implementation, options)
        if request_id == DOES_EMAIL_EXIST_API:
            return await email_exists(self.api_implementation, options)
        if request_id == DOES_PHONE_NUMBER_EXIST_API:
            return await phone_number_exists(self.api_implementation, options)
        return await resend_code(self.api_implementation, options)

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

    def get_all_cors_headers(self) -> List[str]:
        return []

    def is_error_from_this_recipe_based_on_instance(
            self, err: Exception) -> bool:
        return isinstance(err, SuperTokensError) and isinstance(
            err, SuperTokensPasswordlessError)

    @staticmethod
    def init(contact_config: ContactConfig,
             flow_type: Literal['USER_INPUT_CODE', 'MAGIC_LINK', 'USER_INPUT_CODE_AND_MAGIC_LINK'],
             override: Union[OverrideConfig, None] = None,
             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_delivery: Union[EmailDeliveryConfig[TypePasswordlessEmailDeliveryInput], None] = None,
             sms_delivery: Union[SMSDeliveryConfig[TypePasswordlessSmsDeliveryInput], None] = None,
             ):
        def func(app_info: AppInfo):
            if PasswordlessRecipe.__instance is None:
                ingredients = PasswordlessIngredients(None, None)
                PasswordlessRecipe.__instance = PasswordlessRecipe(
                    PasswordlessRecipe.recipe_id,
                    app_info,
                    contact_config, flow_type,
                    ingredients,
                    override,
                    get_link_domain_and_path, get_custom_user_input_code,
                    email_delivery,
                    sms_delivery,
                )
                return PasswordlessRecipe.__instance
            raise_general_exception('Passwordless recipe has already been initialised. Please check '
                                    'your code for bugs.')

        return func

    @staticmethod
    def get_instance() -> PasswordlessRecipe:
        if PasswordlessRecipe.__instance is not None:
            return PasswordlessRecipe.__instance
        raise_general_exception(
            '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_general_exception(
                'calling testing function in non testing env')
        PasswordlessRecipe.__instance = None

    async def create_magic_link(self, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) -> str:
        user_input_code = None
        if self.config.get_custom_user_input_code is not None:
            user_input_code = await self.config.get_custom_user_input_code(user_context)

        code_info = await self.recipe_implementation.create_code(
            email=email, phone_number=phone_number, user_input_code=user_input_code, user_context=user_context)
        magic_link = await self.config.get_link_domain_and_path(PhoneOrEmailInput(phone_number, email), user_context)
        magic_link += '?rid=' + self.get_recipe_id() + '&preAuthSessionId=' + code_info.pre_auth_session_id + '#' + \
            code_info.link_code
        return magic_link

    async def signinup(self, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) -> ConsumeCodeOkResult:
        code_info = await self.recipe_implementation.create_code(
            email=email, phone_number=phone_number, user_context=user_context, user_input_code=None)
        consume_code_result = await self.recipe_implementation.consume_code(
            link_code=code_info.link_code,
            pre_auth_session_id=code_info.pre_auth_session_id,
            device_id=code_info.device_id,
            user_input_code=code_info.user_input_code,
            user_context=user_context
        )
        if isinstance(consume_code_result, ConsumeCodeOkResult):
            return consume_code_result
        raise Exception('Failed to create user. Please retry')

Ancestors

• RecipeModule
• abc.ABC

Class variables

var email_delivery : EmailDeliveryIngredient[CreateAndSendCustomEmailParameters]

var recipe_id

var sms_delivery : SMSDeliveryIngredient[CreateAndSendCustomTextMessageParameters]

Static methods

def get_instance() ‑> PasswordlessRecipe

Expand source code

@staticmethod
def get_instance() -> PasswordlessRecipe:
    if PasswordlessRecipe.__instance is not None:
        return PasswordlessRecipe.__instance
    raise_general_exception(
        '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']", override: Union[OverrideConfig, None] = None, 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_delivery: Union[EmailDeliveryConfig[TypePasswordlessEmailDeliveryInput], None] = None, sms_delivery: Union[SMSDeliveryConfig[TypePasswordlessSmsDeliveryInput], 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'],
         override: Union[OverrideConfig, None] = None,
         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_delivery: Union[EmailDeliveryConfig[TypePasswordlessEmailDeliveryInput], None] = None,
         sms_delivery: Union[SMSDeliveryConfig[TypePasswordlessSmsDeliveryInput], None] = None,
         ):
    def func(app_info: AppInfo):
        if PasswordlessRecipe.__instance is None:
            ingredients = PasswordlessIngredients(None, None)
            PasswordlessRecipe.__instance = PasswordlessRecipe(
                PasswordlessRecipe.recipe_id,
                app_info,
                contact_config, flow_type,
                ingredients,
                override,
                get_link_domain_and_path, get_custom_user_input_code,
                email_delivery,
                sms_delivery,
            )
            return PasswordlessRecipe.__instance
        raise_general_exception('Passwordless 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_general_exception(
            'calling testing function in non testing env')
    PasswordlessRecipe.__instance = None

Methods

async def create_magic_link(self, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) ‑> str

Expand source code

async def create_magic_link(self, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) -> str:
    user_input_code = None
    if self.config.get_custom_user_input_code is not None:
        user_input_code = await self.config.get_custom_user_input_code(user_context)

    code_info = await self.recipe_implementation.create_code(
        email=email, phone_number=phone_number, user_input_code=user_input_code, user_context=user_context)
    magic_link = await self.config.get_link_domain_and_path(PhoneOrEmailInput(phone_number, email), user_context)
    magic_link += '?rid=' + self.get_recipe_id() + '&preAuthSessionId=' + code_info.pre_auth_session_id + '#' + \
        code_info.link_code
    return magic_link

def get_all_cors_headers(self) ‑> List[str]

Expand source code

def get_all_cors_headers(self) -> List[str]:
    return []

def get_apis_handled(self) ‑> List[APIHandled]

Expand source code

def get_apis_handled(self) -> List[APIHandled]:
    return [
        APIHandled(method='post', path_without_api_base_path=NormalisedURLPath(CONSUME_CODE_API),
                   request_id=CONSUME_CODE_API,
                   disabled=self.api_implementation.disable_consume_code_post),
        APIHandled(method='post', path_without_api_base_path=NormalisedURLPath(CREATE_CODE_API),
                   request_id=CREATE_CODE_API,
                   disabled=self.api_implementation.disable_create_code_post),
        APIHandled(method='get', path_without_api_base_path=NormalisedURLPath(DOES_EMAIL_EXIST_API),
                   request_id=DOES_EMAIL_EXIST_API,
                   disabled=self.api_implementation.disable_email_exists_get),
        APIHandled(method='get', path_without_api_base_path=NormalisedURLPath(DOES_PHONE_NUMBER_EXIST_API),
                   request_id=DOES_PHONE_NUMBER_EXIST_API,
                   disabled=self.api_implementation.disable_phone_number_exists_get),
        APIHandled(method='post', path_without_api_base_path=NormalisedURLPath(RESEND_CODE_API),
                   request_id=RESEND_CODE_API,
                   disabled=self.api_implementation.disable_resend_code_post)
    ]

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):
    options = APIOptions(
        request,
        response,
        self.get_recipe_id(),
        self.config,
        self.recipe_implementation,
        self.email_delivery,
        self.sms_delivery
    )
    if request_id == CONSUME_CODE_API:
        return await consume_code(self.api_implementation, options)
    if request_id == CREATE_CODE_API:
        return await create_code(self.api_implementation, options)
    if request_id == DOES_EMAIL_EXIST_API:
        return await email_exists(self.api_implementation, options)
    if request_id == DOES_PHONE_NUMBER_EXIST_API:
        return await phone_number_exists(self.api_implementation, options)
    return await resend_code(self.api_implementation, options)

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

Expand source code

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

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, SuperTokensPasswordlessError)

async def signinup(self, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) ‑> ConsumeCodeOkResult

Expand source code

async def signinup(self, email: Union[str, None], phone_number: Union[str, None], user_context: Dict[str, Any]) -> ConsumeCodeOkResult:
    code_info = await self.recipe_implementation.create_code(
        email=email, phone_number=phone_number, user_context=user_context, user_input_code=None)
    consume_code_result = await self.recipe_implementation.consume_code(
        link_code=code_info.link_code,
        pre_auth_session_id=code_info.pre_auth_session_id,
        device_id=code_info.device_id,
        user_input_code=code_info.user_input_code,
        user_context=user_context
    )
    if isinstance(consume_code_result, ConsumeCodeOkResult):
        return consume_code_result
    raise Exception('Failed to create user. Please retry')