tpepmodels

Documentation

Index

• type APIInterface
• type EmailStruct
• type EmailpasswordInput
• type EmailpasswordOutput
• type OverrideStruct
• type RecipeInterface
• type SignInResponse
• type SignInUpAPIInput
• type SignInUpAPIOutput
• type SignInUpResponse
• type SignUpResponse
• type ThirdPartyInput
• type ThirdPartyOutput
• type TypeContext
• type TypeInput
• type TypeInputEmailVerificationFeature
• type TypeNormalisedInput
• type User

Types

type APIInterface

type APIInterface struct {
	AuthorisationUrlGET            func(provider tpmodels.TypeProvider, options tpmodels.APIOptions) (tpmodels.AuthorisationUrlGETResponse, error)
	EmailExistsGET                 func(email string, options epmodels.APIOptions) (epmodels.EmailExistsGETResponse, error)
	GeneratePasswordResetTokenPOST func(formFields []epmodels.TypeFormField, options epmodels.APIOptions) (epmodels.GeneratePasswordResetTokenPOSTResponse, error)
	PasswordResetPOST              func(formFields []epmodels.TypeFormField, token string, options epmodels.APIOptions) (epmodels.ResetPasswordUsingTokenResponse, error)
	SignInUpPOST                   func(input SignInUpAPIInput) (SignInUpAPIOutput, error)
}

type EmailStruct

type EmailStruct struct {
	ID         string `json:"id"`
	IsVerified bool   `json:"isVerified"`
}

type EmailpasswordInput

type EmailpasswordInput struct {
	IsSignIn   bool
	FormFields []epmodels.TypeFormField
	Options    epmodels.APIOptions
}

type EmailpasswordOutput

type EmailpasswordOutput struct {
	OK *struct {
		User           User
		CreatedNewUser bool
	}
	EmailAlreadyExistsError *struct{}
	WrongCredentialsError   *struct{}
}

type OverrideStruct

type OverrideStruct struct {
	Functions                func(originalImplementation RecipeInterface) RecipeInterface
	APIs                     func(originalImplementation APIInterface) APIInterface
	EmailVerificationFeature *evmodels.OverrideStruct
}

type RecipeInterface

type RecipeInterface struct {
	GetUserByID              func(userID string) (*User, error)
	GetUsersByEmail          func(email string) ([]User, error)
	GetUserByThirdPartyInfo  func(thirdPartyID string, thirdPartyUserID string) (*User, error)
	SignInUp                 func(thirdPartyID string, thirdPartyUserID string, email EmailStruct) (SignInUpResponse, error)
	SignUp                   func(email string, password string) (SignUpResponse, error)
	SignIn                   func(email string, password string) (SignInResponse, error)
	CreateResetPasswordToken func(userID string) (epmodels.CreateResetPasswordTokenResponse, error)
	ResetPasswordUsingToken  func(token string, newPassword string) (epmodels.ResetPasswordUsingTokenResponse, error)
	UpdateEmailOrPassword    func(userId string, email *string, password *string) (epmodels.UpdateEmailOrPasswordResponse, error)
}

type SignInResponse

type SignInResponse struct {
	OK *struct {
		User User
	}
	WrongCredentialsError *struct{}
}

type SignInUpAPIInput

type SignInUpAPIInput struct {
	EmailpasswordInput *EmailpasswordInput
	ThirdPartyInput    *ThirdPartyInput
}

type SignInUpAPIOutput

type SignInUpAPIOutput struct {
	EmailpasswordOutput *EmailpasswordOutput
	ThirdPartyOutput    *ThirdPartyOutput
}

type SignInUpResponse

type SignInUpResponse struct {
	OK *struct {
		CreatedNewUser bool
		User           User
	}
	FieldError *struct{ Error string }
}

type SignUpResponse

type SignUpResponse struct {
	OK *struct {
		User User
	}
	EmailAlreadyExistsError *struct{}
}

type ThirdPartyInput

type ThirdPartyInput struct {
	Provider    tpmodels.TypeProvider
	Code        string
	RedirectURI string
	Options     tpmodels.APIOptions
}

type ThirdPartyOutput

type ThirdPartyOutput struct {
	OK *struct {
		CreatedNewUser   bool
		User             User
		AuthCodeResponse interface{}
	}
	NoEmailGivenByProviderError *struct{}
	FieldError                  *struct{ Error string }
}

type TypeContext

type TypeContext struct {
	FormFields                 []epmodels.TypeFormField
	ThirdPartyAuthCodeResponse interface{}
}

type TypeInput

type TypeInput struct {
	SignUpFeature                  *epmodels.TypeInputSignUp
	Providers                      []tpmodels.TypeProvider
	ResetPasswordUsingTokenFeature *epmodels.TypeInputResetPasswordUsingTokenFeature
	EmailVerificationFeature       *TypeInputEmailVerificationFeature
	Override                       *OverrideStruct
}

type TypeInputEmailVerificationFeature

type TypeInputEmailVerificationFeature struct {
	GetEmailVerificationURL  func(user User) (string, error)
	CreateAndSendCustomEmail func(user User, emailVerificationURLWithToken string)
}

type TypeNormalisedInput

type TypeNormalisedInput struct {
	SignUpFeature                  *epmodels.TypeInputSignUp
	Providers                      []tpmodels.TypeProvider
	ResetPasswordUsingTokenFeature *epmodels.TypeInputResetPasswordUsingTokenFeature
	EmailVerificationFeature       evmodels.TypeInput
	Override                       OverrideStruct
}

type User

type User struct {
	ID         string
	TimeJoined uint64
	Email      string
	ThirdParty *struct {
		ID     string
		UserID string
	}
}