Documentation
¶
Index ¶
- Constants
- Variables
- func DeleteUser(userId string) error
- func ErrorHandler(err error, req *http.Request, res http.ResponseWriter) error
- func GetAllCORSHeaders() []string
- func GetInstanceOrThrowError() (*superTokens, error)
- func GetUserCount(includeRecipeIds *[]string) (float64, error)
- func Init(config TypeInput) error
- func IsAnIPAddress(ipaddress string) (bool, error)
- func IsRunningInTestMode() bool
- func LogDebugMessage(message string)
- func Middleware(theirHandler http.Handler) http.Handler
- func ResetForTest()
- func ResetQuerierForTest()
- func Send200Response(res http.ResponseWriter, responseJson interface{}) error
- func SendNon200Response(res http.ResponseWriter, message string, statusCode int) error
- type APIHandled
- type AppInfo
- type BadInputError
- type ConnectionInfo
- type DoneWriter
- type NormalisedAppinfo
- type NormalisedURLDomain
- type NormalisedURLPath
- func (n NormalisedURLPath) AppendPath(other NormalisedURLPath) NormalisedURLPath
- func (n NormalisedURLPath) Equals(other NormalisedURLPath) bool
- func (n NormalisedURLPath) GetAsStringDangerous() string
- func (n NormalisedURLPath) IsARecipePath() bool
- func (n NormalisedURLPath) StartsWith(other NormalisedURLPath) bool
- type Querier
- func (q *Querier) GetQuerierAPIVersion() (string, error)
- func (q *Querier) SendDeleteRequest(path string, data map[string]interface{}) (map[string]interface{}, error)
- func (q *Querier) SendGetRequest(path string, params map[string]string) (map[string]interface{}, error)
- func (q *Querier) SendPostRequest(path string, data map[string]interface{}) (map[string]interface{}, error)
- func (q *Querier) SendPutRequest(path string, data map[string]interface{}) (map[string]interface{}, error)
- type QuerierHost
- type Recipe
- type RecipeModule
- type TypeInput
- type UserContext
- type UserPaginationResult
Constants ¶
View Source
const ( HeaderRID = "rid" HeaderFDI = "fdi-version" )
View Source
const VERSION = "0.5.9"
VERSION current version of the lib
Variables ¶
View Source
var ( QuerierHosts []QuerierHost = nil QuerierAPIKey *string )
View Source
var IsTestFlag = false
this will be set to true if this is used in a test app environment
Functions ¶
func DeleteUser ¶ added in v0.3.3
func ErrorHandler ¶
func GetAllCORSHeaders ¶
func GetAllCORSHeaders() []string
func GetInstanceOrThrowError ¶ added in v0.2.0
func GetInstanceOrThrowError() (*superTokens, error)
func GetUserCount ¶
func IsAnIPAddress ¶
func IsRunningInTestMode ¶
func IsRunningInTestMode() bool
func LogDebugMessage ¶ added in v0.5.5
func LogDebugMessage(message string)
func ResetForTest ¶
func ResetForTest()
func ResetQuerierForTest ¶
func ResetQuerierForTest()
func Send200Response ¶
func Send200Response(res http.ResponseWriter, responseJson interface{}) error
func SendNon200Response ¶
func SendNon200Response(res http.ResponseWriter, message string, statusCode int) error
Types ¶
type APIHandled ¶
type APIHandled struct { PathWithoutAPIBasePath NormalisedURLPath Method string ID string Disabled bool }
type BadInputError ¶
type BadInputError struct {
Msg string
}
BadInputError used for non specific exceptions
func (BadInputError) Error ¶
func (err BadInputError) Error() string
type ConnectionInfo ¶
type DoneWriter ¶ added in v0.2.2
type DoneWriter interface { http.ResponseWriter IsDone() bool }
func MakeDoneWriter ¶ added in v0.3.5
func MakeDoneWriter(w http.ResponseWriter) DoneWriter
WrapWriter wraps an http.ResponseWriter, returning a proxy that allows you to hook into various parts of the response process.
type NormalisedAppinfo ¶
type NormalisedAppinfo struct { AppName string WebsiteDomain NormalisedURLDomain APIDomain NormalisedURLDomain APIBasePath NormalisedURLPath APIGatewayPath NormalisedURLPath WebsiteBasePath NormalisedURLPath }
func NormaliseInputAppInfoOrThrowError ¶
func NormaliseInputAppInfoOrThrowError(appInfo AppInfo) (NormalisedAppinfo, error)
type NormalisedURLDomain ¶
type NormalisedURLDomain struct {
// contains filtered or unexported fields
}
func NewNormalisedURLDomain ¶
func NewNormalisedURLDomain(url string) (NormalisedURLDomain, error)
func (NormalisedURLDomain) GetAsStringDangerous ¶
func (n NormalisedURLDomain) GetAsStringDangerous() string
type NormalisedURLPath ¶
type NormalisedURLPath struct {
// contains filtered or unexported fields
}
func NewNormalisedURLPath ¶
func NewNormalisedURLPath(url string) (NormalisedURLPath, error)
func (NormalisedURLPath) AppendPath ¶
func (n NormalisedURLPath) AppendPath(other NormalisedURLPath) NormalisedURLPath
func (NormalisedURLPath) Equals ¶
func (n NormalisedURLPath) Equals(other NormalisedURLPath) bool
func (NormalisedURLPath) GetAsStringDangerous ¶
func (n NormalisedURLPath) GetAsStringDangerous() string
func (NormalisedURLPath) IsARecipePath ¶
func (n NormalisedURLPath) IsARecipePath() bool
func (NormalisedURLPath) StartsWith ¶
func (n NormalisedURLPath) StartsWith(other NormalisedURLPath) bool
type Querier ¶
type Querier struct {
RIDToCore string
}
func (*Querier) GetQuerierAPIVersion ¶ added in v0.5.2
func (*Querier) SendDeleteRequest ¶
func (*Querier) SendGetRequest ¶
func (*Querier) SendPostRequest ¶
type QuerierHost ¶ added in v0.4.2
type QuerierHost struct { Domain NormalisedURLDomain BasePath NormalisedURLPath }
type Recipe ¶
type Recipe func(appInfo NormalisedAppinfo, onGeneralError func(err error, req *http.Request, res http.ResponseWriter)) (*RecipeModule, error)
type RecipeModule ¶
type RecipeModule struct { HandleAPIRequest func(ID string, req *http.Request, res http.ResponseWriter, theirHandler http.HandlerFunc, path NormalisedURLPath, method string) error GetAllCORSHeaders func() []string GetAPIsHandled func() ([]APIHandled, error) HandleError func(err error, req *http.Request, res http.ResponseWriter) (bool, error) OnGeneralError func(err error, req *http.Request, res http.ResponseWriter) // contains filtered or unexported fields }
func MakeRecipeModule ¶
func MakeRecipeModule( recipeId string, appInfo NormalisedAppinfo, handleAPIRequest func(id string, req *http.Request, res http.ResponseWriter, theirHandler http.HandlerFunc, path NormalisedURLPath, method string) error, getAllCORSHeaders func() []string, getAPIsHandled func() ([]APIHandled, error), handleError func(err error, req *http.Request, res http.ResponseWriter) (bool, error), onGeneralError func(err error, req *http.Request, res http.ResponseWriter)) RecipeModule
func (RecipeModule) GetAppInfo ¶
func (r RecipeModule) GetAppInfo() NormalisedAppinfo
func (RecipeModule) GetRecipeID ¶
func (r RecipeModule) GetRecipeID() string
func (*RecipeModule) ReturnAPIIdIfCanHandleRequest ¶
func (r *RecipeModule) ReturnAPIIdIfCanHandleRequest(path NormalisedURLPath, method string) (*string, error)
type TypeInput ¶
type TypeInput struct { Supertokens *ConnectionInfo AppInfo AppInfo RecipeList []Recipe Telemetry *bool OnGeneralError func(err error, req *http.Request, res http.ResponseWriter) }
type UserContext ¶ added in v0.4.0
type UserContext = *map[string]interface{}
type UserPaginationResult ¶
type UserPaginationResult struct { Users []struct { RecipeId string User map[string]interface{} } NextPaginationToken *string }
func GetUsersNewestFirst ¶
func GetUsersNewestFirst(paginationToken *string, limit *int, includeRecipeIds *[]string) (UserPaginationResult, error)
func GetUsersOldestFirst ¶
func GetUsersOldestFirst(paginationToken *string, limit *int, includeRecipeIds *[]string) (UserPaginationResult, error)
Click to show internal directories.
Click to hide internal directories.