Module supertokens_python.recipe.emailpassword.utils
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 re import fullmatch
from typing import TYPE_CHECKING, Any, Awaitable, Callable, List, Union
from supertokens_python.ingredients.emaildelivery.types import (
EmailDeliveryConfig, EmailDeliveryConfigWithService)
from supertokens_python.recipe.emailpassword.emaildelivery.services.backward_compatibility import \
BackwardCompatibilityService
from ..emailverification.types import User as EmailVerificationUser
from .interfaces import APIInterface, RecipeInterface
from .types import (InputFormField, NormalisedFormField,
TypeEmailPasswordEmailDeliveryInput, User)
if TYPE_CHECKING:
from .recipe import EmailPasswordRecipe
from supertokens_python.supertokens import AppInfo
from typing import Dict
from supertokens_python.recipe.emailverification.utils import \
OverrideConfig as EmailVerificationOverrideConfig
from supertokens_python.recipe.emailverification.utils import \
ParentRecipeEmailVerificationConfig
from supertokens_python.utils import deprecated_warn, get_filtered_list
from ..emailverification.utils import ParentRecipeEmailVerificationConfig
from .constants import (FORM_FIELD_EMAIL_ID, FORM_FIELD_PASSWORD_ID,
RESET_PASSWORD)
async def default_validator(_: str) -> Union[str, None]:
return None
async def default_password_validator(value: str) -> Union[str, None]:
# length >= 8 && < 100
# must have a number and a character
# as per
# https://github.com/supertokens/supertokens-auth-react/issues/5#issuecomment-709512438
if len(value) < 8:
return 'Password must contain at least 8 characters, including a number'
if len(value) >= 100:
return 'Password\'s length must be lesser than 100 characters'
if fullmatch(r'^.*[A-Za-z]+.*$', value) is None:
return 'Password must contain at least one alphabet'
if fullmatch(r'^.*[0-9]+.*$', value) is None:
return 'Password must contain at least one number'
return None
async def default_email_validator(value: str) -> Union[str, None]:
# We check if the email syntax is correct
# As per https://github.com/supertokens/supertokens-auth-react/issues/5#issuecomment-709512438
# Regex from https://stackoverflow.com/a/46181/3867175
if fullmatch(r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,'
r'3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$', value) is None:
return 'Email is not valid'
return None
def default_get_reset_password_url(
app_info: AppInfo) -> Callable[[User, Dict[str, Any]], Awaitable[str]]:
async def func(_: User, __: Dict[str, Any]):
return app_info.website_domain.get_as_string_dangerous(
) + app_info.website_base_path.get_as_string_dangerous() + RESET_PASSWORD
return func
class InputSignUpFeature:
def __init__(self, form_fields: Union[List[InputFormField], None] = None):
if form_fields is None:
form_fields = []
self.form_fields = normalise_sign_up_form_fields(form_fields)
class SignUpFeature:
def __init__(self, form_fields: List[NormalisedFormField]):
self.form_fields = form_fields
def normalise_sign_up_form_fields(
form_fields: List[InputFormField]) -> List[NormalisedFormField]:
normalised_form_fields: List[NormalisedFormField] = []
for field in form_fields:
if field.id == FORM_FIELD_PASSWORD_ID:
validator = field.validate if field.validate is not None else default_password_validator
normalised_form_fields.append(
NormalisedFormField(
field.id, validator, False))
elif field.id == FORM_FIELD_EMAIL_ID:
validator = field.validate if field.validate is not None else default_email_validator
normalised_form_fields.append(
NormalisedFormField(
field.id, validator, False))
else:
validator = field.validate if field.validate is not None else default_validator
optional = field.optional if field.optional is not None else False
normalised_form_fields.append(
NormalisedFormField(
field.id, validator, optional))
if len(get_filtered_list(lambda x: x.id ==
FORM_FIELD_PASSWORD_ID, normalised_form_fields)) == 0:
normalised_form_fields.append(
NormalisedFormField(
FORM_FIELD_PASSWORD_ID,
default_password_validator,
False))
if len(get_filtered_list(lambda x: x.id ==
FORM_FIELD_EMAIL_ID, normalised_form_fields)) == 0:
normalised_form_fields.append(
NormalisedFormField(
FORM_FIELD_EMAIL_ID,
default_email_validator,
False))
return normalised_form_fields
class SignInFeature:
def __init__(self, form_fields: List[NormalisedFormField]):
self.form_fields = form_fields
def normalise_sign_in_form_fields(
form_fields: List[NormalisedFormField]) -> List[NormalisedFormField]:
return list(map(
lambda y: NormalisedFormField(
y.id, y.validate if y.id == FORM_FIELD_EMAIL_ID else default_validator, False),
get_filtered_list(lambda x: x.id in (FORM_FIELD_PASSWORD_ID, FORM_FIELD_EMAIL_ID), form_fields)))
def validate_and_normalise_sign_in_config(
sign_up_config: SignUpFeature) -> SignInFeature:
form_fields = normalise_sign_in_form_fields(sign_up_config.form_fields)
return SignInFeature(form_fields)
class InputResetPasswordUsingTokenFeature:
def __init__(self,
get_reset_password_url: Union[Callable[[
User, Dict[str, Any]], Awaitable[str]], None] = None,
create_and_send_custom_email: Union[Callable[[User, str, Dict[str, Any]], Awaitable[None]], None] = None):
self.get_reset_password_url = get_reset_password_url
self.create_and_send_custom_email = create_and_send_custom_email
if create_and_send_custom_email:
deprecated_warn("create_and_send_custom_email is deprecated. Please use email delivery config instead")
class ResetPasswordUsingTokenFeature:
def __init__(self,
form_fields_for_password_reset_form: List[NormalisedFormField],
form_fields_for_generate_token_form: List[NormalisedFormField],
get_reset_password_url: Callable[[User, Dict[str, Any]], Awaitable[str]]
):
self.form_fields_for_password_reset_form = form_fields_for_password_reset_form
self.form_fields_for_generate_token_form = form_fields_for_generate_token_form
self.get_reset_password_url = get_reset_password_url
class InputEmailVerificationConfig:
def __init__(self,
get_email_verification_url: Union[Callable[[
User, Dict[str, Any]], Awaitable[str]], None] = None,
create_and_send_custom_email: Union[Callable[[
User, str, Dict[str, Any]], Awaitable[None]], None] = None
):
self.get_email_verification_url = get_email_verification_url
self.create_and_send_custom_email = create_and_send_custom_email
if create_and_send_custom_email:
deprecated_warn("create_and_send_custom_email is deprecated. Please use email delivery config instead")
def validate_and_normalise_reset_password_using_token_config(app_info: AppInfo, sign_up_config: InputSignUpFeature,
config: InputResetPasswordUsingTokenFeature) -> ResetPasswordUsingTokenFeature:
form_fields_for_password_reset_form = list(map(lambda y: NormalisedFormField(y.id, y.validate, False),
get_filtered_list(lambda x: x.id == FORM_FIELD_PASSWORD_ID,
sign_up_config.form_fields)))
form_fields_for_generate_token_form = list(map(lambda y: NormalisedFormField(y.id, y.validate, False),
get_filtered_list(lambda x: x.id == FORM_FIELD_EMAIL_ID,
sign_up_config.form_fields)))
get_reset_password_url = config.get_reset_password_url if config.get_reset_password_url is not None else default_get_reset_password_url(
app_info)
return ResetPasswordUsingTokenFeature(form_fields_for_password_reset_form, form_fields_for_generate_token_form,
get_reset_password_url)
def email_verification_create_and_send_custom_email(
recipe: EmailPasswordRecipe, create_and_send_custom_email: Callable[[
User, str, Dict[str, Any]], Awaitable[None]]) -> Callable[[
EmailVerificationUser, str, Dict[str, Any]], Awaitable[None]]:
async def func(user: EmailVerificationUser, link: str, user_context: Dict[str, Any]):
user_info = await recipe.recipe_implementation.get_user_by_id(user.user_id, user_context)
if user_info is None:
raise Exception('Unknown User ID provided')
return await create_and_send_custom_email(user_info, link, user_context)
return func
def email_verification_get_email_verification_url(
recipe: EmailPasswordRecipe, get_email_verification_url: Callable[[
User, Any], Awaitable[str]]) -> Callable[[
EmailVerificationUser, Any], Awaitable[str]]:
async def func(user: EmailVerificationUser, user_context: Dict[str, Any]):
user_info = await recipe.recipe_implementation.get_user_by_id(user.user_id, user_context)
if user_info is None:
raise Exception('Unknown User ID provided')
return await get_email_verification_url(user_info, user_context)
return func
def validate_and_normalise_email_verification_config(
recipe: EmailPasswordRecipe, config: Union[InputEmailVerificationConfig, None], override: InputOverrideConfig) -> ParentRecipeEmailVerificationConfig:
create_and_send_custom_email = None
get_email_verification_url = None
if config is None:
config = InputEmailVerificationConfig()
if config.create_and_send_custom_email is not None:
create_and_send_custom_email = email_verification_create_and_send_custom_email(recipe,
config.create_and_send_custom_email)
if config.get_email_verification_url is not None:
get_email_verification_url = email_verification_get_email_verification_url(recipe,
config.get_email_verification_url)
return ParentRecipeEmailVerificationConfig(
get_email_for_user_id=recipe.get_email_for_user_id,
create_and_send_custom_email=create_and_send_custom_email,
get_email_verification_url=get_email_verification_url,
override=override.email_verification_feature
)
class InputOverrideConfig:
def __init__(self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
apis: Union[Callable[[APIInterface],
APIInterface], None] = None,
email_verification_feature: Union[EmailVerificationOverrideConfig, None] = None):
self.functions = functions
self.apis = apis
self.email_verification_feature = email_verification_feature
class OverrideConfig:
def __init__(self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None,
apis: Union[Callable[[APIInterface], APIInterface], None] = None):
self.functions = functions
self.apis = apis
class EmailPasswordConfig:
def __init__(self,
sign_up_feature: SignUpFeature,
sign_in_feature: SignInFeature,
reset_password_using_token_feature: ResetPasswordUsingTokenFeature,
email_verification_feature: ParentRecipeEmailVerificationConfig,
override: OverrideConfig,
get_email_delivery_config: Callable[[RecipeInterface], EmailDeliveryConfigWithService[TypeEmailPasswordEmailDeliveryInput]]
):
self.sign_up_feature = sign_up_feature
self.sign_in_feature = sign_in_feature
self.reset_password_using_token_feature = reset_password_using_token_feature
self.email_verification_feature = email_verification_feature
self.override = override
self.get_email_delivery_config = get_email_delivery_config
def validate_and_normalise_user_input(recipe: EmailPasswordRecipe, app_info: AppInfo,
sign_up_feature: Union[InputSignUpFeature,
None] = None,
reset_password_using_token_feature: Union[
InputResetPasswordUsingTokenFeature, None] = None,
email_verification_feature: Union[InputEmailVerificationConfig, None] = None,
override: Union[InputOverrideConfig, None] = None,
email_delivery: Union[EmailDeliveryConfig[TypeEmailPasswordEmailDeliveryInput], None] = None
) -> EmailPasswordConfig:
if sign_up_feature is not None and not isinstance(sign_up_feature, InputSignUpFeature): # type: ignore
raise ValueError('sign_up_feature must be of type InputSignUpFeature or None')
if reset_password_using_token_feature is not None and not isinstance(reset_password_using_token_feature, InputResetPasswordUsingTokenFeature): # type: ignore
raise ValueError('reset_password_using_token_feature must be of type InputResetPasswordUsingTokenFeature or None')
if email_verification_feature is not None and not isinstance(email_verification_feature, InputEmailVerificationConfig): # type: ignore
raise ValueError('email_verification_feature must be of type InputEmailVerificationConfig or None')
if override is not None and not isinstance(override, InputOverrideConfig): # type: ignore
raise ValueError('override must be of type InputOverrideConfig or None')
if override is None:
override = InputOverrideConfig()
if reset_password_using_token_feature is None:
reset_password_using_token_feature = InputResetPasswordUsingTokenFeature()
if sign_up_feature is None:
sign_up_feature = InputSignUpFeature()
def get_email_delivery_config(
ep_recipe: RecipeInterface,
) -> EmailDeliveryConfigWithService[TypeEmailPasswordEmailDeliveryInput]:
if email_delivery and email_delivery.service:
return EmailDeliveryConfigWithService(
service=email_delivery.service,
override=email_delivery.override
)
email_service = BackwardCompatibilityService(
app_info=app_info,
recipe_interface_impl=ep_recipe,
reset_password_using_token_feature=reset_password_using_token_feature,
email_verification_feature=email_verification_feature,
)
if email_delivery is not None and email_delivery.override is not None:
override = email_delivery.override
else:
override = None
return EmailDeliveryConfigWithService(email_service, override=override)
return EmailPasswordConfig(
SignUpFeature(sign_up_feature.form_fields),
SignInFeature(
normalise_sign_in_form_fields(
sign_up_feature.form_fields)),
validate_and_normalise_reset_password_using_token_config(
app_info,
sign_up_feature,
reset_password_using_token_feature
),
validate_and_normalise_email_verification_config(
recipe,
email_verification_feature,
override
),
OverrideConfig(functions=override.functions, apis=override.apis),
get_email_delivery_config=get_email_delivery_config,
)
Functions
async def default_email_validator(value: str) ‑> Optional[str]
-
Expand source code
async def default_email_validator(value: str) -> Union[str, None]: # We check if the email syntax is correct # As per https://github.com/supertokens/supertokens-auth-react/issues/5#issuecomment-709512438 # Regex from https://stackoverflow.com/a/46181/3867175 if fullmatch(r'^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,' r'3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$', value) is None: return 'Email is not valid' return None
def default_get_reset_password_url(app_info: AppInfo) ‑> Callable[[User, Dict[str, Any]], Awaitable[str]]
-
Expand source code
def default_get_reset_password_url( app_info: AppInfo) -> Callable[[User, Dict[str, Any]], Awaitable[str]]: async def func(_: User, __: Dict[str, Any]): return app_info.website_domain.get_as_string_dangerous( ) + app_info.website_base_path.get_as_string_dangerous() + RESET_PASSWORD return func
async def default_password_validator(value: str) ‑> Optional[str]
-
Expand source code
async def default_password_validator(value: str) -> Union[str, None]: # length >= 8 && < 100 # must have a number and a character # as per # https://github.com/supertokens/supertokens-auth-react/issues/5#issuecomment-709512438 if len(value) < 8: return 'Password must contain at least 8 characters, including a number' if len(value) >= 100: return 'Password\'s length must be lesser than 100 characters' if fullmatch(r'^.*[A-Za-z]+.*$', value) is None: return 'Password must contain at least one alphabet' if fullmatch(r'^.*[0-9]+.*$', value) is None: return 'Password must contain at least one number' return None
async def default_validator(_: str) ‑> Optional[str]
-
Expand source code
async def default_validator(_: str) -> Union[str, None]: return None
def email_verification_create_and_send_custom_email(recipe: EmailPasswordRecipe, create_and_send_custom_email: Callable[[User, str, Dict[str, Any]], Awaitable[None]]) ‑> Callable[[EmailVerificationUser, str, Dict[str, Any]], Awaitable[None]]
-
Expand source code
def email_verification_create_and_send_custom_email( recipe: EmailPasswordRecipe, create_and_send_custom_email: Callable[[ User, str, Dict[str, Any]], Awaitable[None]]) -> Callable[[ EmailVerificationUser, str, Dict[str, Any]], Awaitable[None]]: async def func(user: EmailVerificationUser, link: str, user_context: Dict[str, Any]): user_info = await recipe.recipe_implementation.get_user_by_id(user.user_id, user_context) if user_info is None: raise Exception('Unknown User ID provided') return await create_and_send_custom_email(user_info, link, user_context) return func
def email_verification_get_email_verification_url(recipe: EmailPasswordRecipe, get_email_verification_url: Callable[[User, Any], Awaitable[str]]) ‑> Callable[[EmailVerificationUser, Any], Awaitable[str]]
-
Expand source code
def email_verification_get_email_verification_url( recipe: EmailPasswordRecipe, get_email_verification_url: Callable[[ User, Any], Awaitable[str]]) -> Callable[[ EmailVerificationUser, Any], Awaitable[str]]: async def func(user: EmailVerificationUser, user_context: Dict[str, Any]): user_info = await recipe.recipe_implementation.get_user_by_id(user.user_id, user_context) if user_info is None: raise Exception('Unknown User ID provided') return await get_email_verification_url(user_info, user_context) return func
def normalise_sign_in_form_fields(form_fields: List[NormalisedFormField]) ‑> List[NormalisedFormField]
-
Expand source code
def normalise_sign_in_form_fields( form_fields: List[NormalisedFormField]) -> List[NormalisedFormField]: return list(map( lambda y: NormalisedFormField( y.id, y.validate if y.id == FORM_FIELD_EMAIL_ID else default_validator, False), get_filtered_list(lambda x: x.id in (FORM_FIELD_PASSWORD_ID, FORM_FIELD_EMAIL_ID), form_fields)))
def normalise_sign_up_form_fields(form_fields: List[InputFormField]) ‑> List[NormalisedFormField]
-
Expand source code
def normalise_sign_up_form_fields( form_fields: List[InputFormField]) -> List[NormalisedFormField]: normalised_form_fields: List[NormalisedFormField] = [] for field in form_fields: if field.id == FORM_FIELD_PASSWORD_ID: validator = field.validate if field.validate is not None else default_password_validator normalised_form_fields.append( NormalisedFormField( field.id, validator, False)) elif field.id == FORM_FIELD_EMAIL_ID: validator = field.validate if field.validate is not None else default_email_validator normalised_form_fields.append( NormalisedFormField( field.id, validator, False)) else: validator = field.validate if field.validate is not None else default_validator optional = field.optional if field.optional is not None else False normalised_form_fields.append( NormalisedFormField( field.id, validator, optional)) if len(get_filtered_list(lambda x: x.id == FORM_FIELD_PASSWORD_ID, normalised_form_fields)) == 0: normalised_form_fields.append( NormalisedFormField( FORM_FIELD_PASSWORD_ID, default_password_validator, False)) if len(get_filtered_list(lambda x: x.id == FORM_FIELD_EMAIL_ID, normalised_form_fields)) == 0: normalised_form_fields.append( NormalisedFormField( FORM_FIELD_EMAIL_ID, default_email_validator, False)) return normalised_form_fields
def validate_and_normalise_email_verification_config(recipe: EmailPasswordRecipe, config: Union[InputEmailVerificationConfig, None], override: InputOverrideConfig) ‑> ParentRecipeEmailVerificationConfig
-
Expand source code
def validate_and_normalise_email_verification_config( recipe: EmailPasswordRecipe, config: Union[InputEmailVerificationConfig, None], override: InputOverrideConfig) -> ParentRecipeEmailVerificationConfig: create_and_send_custom_email = None get_email_verification_url = None if config is None: config = InputEmailVerificationConfig() if config.create_and_send_custom_email is not None: create_and_send_custom_email = email_verification_create_and_send_custom_email(recipe, config.create_and_send_custom_email) if config.get_email_verification_url is not None: get_email_verification_url = email_verification_get_email_verification_url(recipe, config.get_email_verification_url) return ParentRecipeEmailVerificationConfig( get_email_for_user_id=recipe.get_email_for_user_id, create_and_send_custom_email=create_and_send_custom_email, get_email_verification_url=get_email_verification_url, override=override.email_verification_feature )
def validate_and_normalise_reset_password_using_token_config(app_info: AppInfo, sign_up_config: InputSignUpFeature, config: InputResetPasswordUsingTokenFeature) ‑> ResetPasswordUsingTokenFeature
-
Expand source code
def validate_and_normalise_reset_password_using_token_config(app_info: AppInfo, sign_up_config: InputSignUpFeature, config: InputResetPasswordUsingTokenFeature) -> ResetPasswordUsingTokenFeature: form_fields_for_password_reset_form = list(map(lambda y: NormalisedFormField(y.id, y.validate, False), get_filtered_list(lambda x: x.id == FORM_FIELD_PASSWORD_ID, sign_up_config.form_fields))) form_fields_for_generate_token_form = list(map(lambda y: NormalisedFormField(y.id, y.validate, False), get_filtered_list(lambda x: x.id == FORM_FIELD_EMAIL_ID, sign_up_config.form_fields))) get_reset_password_url = config.get_reset_password_url if config.get_reset_password_url is not None else default_get_reset_password_url( app_info) return ResetPasswordUsingTokenFeature(form_fields_for_password_reset_form, form_fields_for_generate_token_form, get_reset_password_url)
def validate_and_normalise_sign_in_config(sign_up_config: SignUpFeature) ‑> SignInFeature
-
Expand source code
def validate_and_normalise_sign_in_config( sign_up_config: SignUpFeature) -> SignInFeature: form_fields = normalise_sign_in_form_fields(sign_up_config.form_fields) return SignInFeature(form_fields)
def validate_and_normalise_user_input(recipe: EmailPasswordRecipe, app_info: AppInfo, sign_up_feature: Union[InputSignUpFeature, None] = None, reset_password_using_token_feature: Union[InputResetPasswordUsingTokenFeature, None] = None, email_verification_feature: Union[InputEmailVerificationConfig, None] = None, override: Union[InputOverrideConfig, None] = None, email_delivery: Union[EmailDeliveryConfig[TypeEmailPasswordEmailDeliveryInput], None] = None) ‑> EmailPasswordConfig
-
Expand source code
def validate_and_normalise_user_input(recipe: EmailPasswordRecipe, app_info: AppInfo, sign_up_feature: Union[InputSignUpFeature, None] = None, reset_password_using_token_feature: Union[ InputResetPasswordUsingTokenFeature, None] = None, email_verification_feature: Union[InputEmailVerificationConfig, None] = None, override: Union[InputOverrideConfig, None] = None, email_delivery: Union[EmailDeliveryConfig[TypeEmailPasswordEmailDeliveryInput], None] = None ) -> EmailPasswordConfig: if sign_up_feature is not None and not isinstance(sign_up_feature, InputSignUpFeature): # type: ignore raise ValueError('sign_up_feature must be of type InputSignUpFeature or None') if reset_password_using_token_feature is not None and not isinstance(reset_password_using_token_feature, InputResetPasswordUsingTokenFeature): # type: ignore raise ValueError('reset_password_using_token_feature must be of type InputResetPasswordUsingTokenFeature or None') if email_verification_feature is not None and not isinstance(email_verification_feature, InputEmailVerificationConfig): # type: ignore raise ValueError('email_verification_feature must be of type InputEmailVerificationConfig or None') if override is not None and not isinstance(override, InputOverrideConfig): # type: ignore raise ValueError('override must be of type InputOverrideConfig or None') if override is None: override = InputOverrideConfig() if reset_password_using_token_feature is None: reset_password_using_token_feature = InputResetPasswordUsingTokenFeature() if sign_up_feature is None: sign_up_feature = InputSignUpFeature() def get_email_delivery_config( ep_recipe: RecipeInterface, ) -> EmailDeliveryConfigWithService[TypeEmailPasswordEmailDeliveryInput]: if email_delivery and email_delivery.service: return EmailDeliveryConfigWithService( service=email_delivery.service, override=email_delivery.override ) email_service = BackwardCompatibilityService( app_info=app_info, recipe_interface_impl=ep_recipe, reset_password_using_token_feature=reset_password_using_token_feature, email_verification_feature=email_verification_feature, ) if email_delivery is not None and email_delivery.override is not None: override = email_delivery.override else: override = None return EmailDeliveryConfigWithService(email_service, override=override) return EmailPasswordConfig( SignUpFeature(sign_up_feature.form_fields), SignInFeature( normalise_sign_in_form_fields( sign_up_feature.form_fields)), validate_and_normalise_reset_password_using_token_config( app_info, sign_up_feature, reset_password_using_token_feature ), validate_and_normalise_email_verification_config( recipe, email_verification_feature, override ), OverrideConfig(functions=override.functions, apis=override.apis), get_email_delivery_config=get_email_delivery_config, )
Classes
class EmailPasswordConfig (sign_up_feature: SignUpFeature, sign_in_feature: SignInFeature, reset_password_using_token_feature: ResetPasswordUsingTokenFeature, email_verification_feature: ParentRecipeEmailVerificationConfig, override: OverrideConfig, get_email_delivery_config: Callable[[RecipeInterface], EmailDeliveryConfigWithService[TypeEmailPasswordEmailDeliveryInput]])
-
Expand source code
class EmailPasswordConfig: def __init__(self, sign_up_feature: SignUpFeature, sign_in_feature: SignInFeature, reset_password_using_token_feature: ResetPasswordUsingTokenFeature, email_verification_feature: ParentRecipeEmailVerificationConfig, override: OverrideConfig, get_email_delivery_config: Callable[[RecipeInterface], EmailDeliveryConfigWithService[TypeEmailPasswordEmailDeliveryInput]] ): self.sign_up_feature = sign_up_feature self.sign_in_feature = sign_in_feature self.reset_password_using_token_feature = reset_password_using_token_feature self.email_verification_feature = email_verification_feature self.override = override self.get_email_delivery_config = get_email_delivery_config
class InputEmailVerificationConfig (get_email_verification_url: Union[Callable[[User, Dict[str, Any]], Awaitable[str]], None] = None, create_and_send_custom_email: Union[Callable[[User, str, Dict[str, Any]], Awaitable[None]], None] = None)
-
Expand source code
class InputEmailVerificationConfig: def __init__(self, get_email_verification_url: Union[Callable[[ User, Dict[str, Any]], Awaitable[str]], None] = None, create_and_send_custom_email: Union[Callable[[ User, str, Dict[str, Any]], Awaitable[None]], None] = None ): self.get_email_verification_url = get_email_verification_url self.create_and_send_custom_email = create_and_send_custom_email if create_and_send_custom_email: deprecated_warn("create_and_send_custom_email is deprecated. Please use email delivery config instead")
class InputOverrideConfig (functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None, email_verification_feature: Union[EmailVerificationOverrideConfig, None] = None)
-
Expand source code
class InputOverrideConfig: def __init__(self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None, email_verification_feature: Union[EmailVerificationOverrideConfig, None] = None): self.functions = functions self.apis = apis self.email_verification_feature = email_verification_feature
class InputResetPasswordUsingTokenFeature (get_reset_password_url: Union[Callable[[User, Dict[str, Any]], Awaitable[str]], None] = None, create_and_send_custom_email: Union[Callable[[User, str, Dict[str, Any]], Awaitable[None]], None] = None)
-
Expand source code
class InputResetPasswordUsingTokenFeature: def __init__(self, get_reset_password_url: Union[Callable[[ User, Dict[str, Any]], Awaitable[str]], None] = None, create_and_send_custom_email: Union[Callable[[User, str, Dict[str, Any]], Awaitable[None]], None] = None): self.get_reset_password_url = get_reset_password_url self.create_and_send_custom_email = create_and_send_custom_email if create_and_send_custom_email: deprecated_warn("create_and_send_custom_email is deprecated. Please use email delivery config instead")
class InputSignUpFeature (form_fields: Union[List[InputFormField], None] = None)
-
Expand source code
class InputSignUpFeature: def __init__(self, form_fields: Union[List[InputFormField], None] = None): if form_fields is None: form_fields = [] self.form_fields = normalise_sign_up_form_fields(form_fields)
class OverrideConfig (functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None)
-
Expand source code
class OverrideConfig: def __init__(self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None] = None, apis: Union[Callable[[APIInterface], APIInterface], None] = None): self.functions = functions self.apis = apis
class ResetPasswordUsingTokenFeature (form_fields_for_password_reset_form: List[NormalisedFormField], form_fields_for_generate_token_form: List[NormalisedFormField], get_reset_password_url: Callable[[User, Dict[str, Any]], Awaitable[str]])
-
Expand source code
class ResetPasswordUsingTokenFeature: def __init__(self, form_fields_for_password_reset_form: List[NormalisedFormField], form_fields_for_generate_token_form: List[NormalisedFormField], get_reset_password_url: Callable[[User, Dict[str, Any]], Awaitable[str]] ): self.form_fields_for_password_reset_form = form_fields_for_password_reset_form self.form_fields_for_generate_token_form = form_fields_for_generate_token_form self.get_reset_password_url = get_reset_password_url
class SignInFeature (form_fields: List[NormalisedFormField])
-
Expand source code
class SignInFeature: def __init__(self, form_fields: List[NormalisedFormField]): self.form_fields = form_fields
class SignUpFeature (form_fields: List[NormalisedFormField])
-
Expand source code
class SignUpFeature: def __init__(self, form_fields: List[NormalisedFormField]): self.form_fields = form_fields