Index

Modules: restSpa/auth/gen, restSpa/config, restSpa/db, restSpa/db/models/user, restSpa/db/setup, restSpa/db/utils, restSpa/email/activateAccount, restSpa/email/send, restSpa/routeUtils, restSpa/routes, restSpa/routes/api/activate, restSpa/routes/api/admin/delUser, restSpa/routes/api/admin/editUser, restSpa/routes/api/admin/getUser, restSpa/routes/api/delUser, restSpa/routes/api/logout, restSpa/routes/api/resend, restSpa/routes/api/signIn, restSpa/routes/api/signUp, restSpa/routes/default/notFound, restSpa/routes/home, restSpa/utils.

API symbols

activationCodeLen:

• config: activationCodeLen

address:

• config: address

appName:

• config: appName

cantEditUserFields:

• user: cantEditUserFields

cantSeeUserFields:

• user: cantSeeUserFields

cleanSession:

• routeUtils: cleanSession(ctx)

dbConn:

• db: dbConn

dbHost:

• config: dbHost

dbLock:

• db: dbLock

dbPass:

• config: dbPass

dbUser:

• config: dbUser

defaultRoutes:

• routes: defaultRoutes

delInternals:

• utils: delInternals(node: var JsonNode)

errorLog:

• config: errorLog

forceHttpMethod:

• routeUtils: forceHttpMethod(ctx; httpMethod: HttpMethod)

genActivationCode:

• gen: genActivationCode(username, email, password, salt: string): string

genAuthHash:

• gen: genAuthHash(username, password, salt: string; epoch = $nowUnix()): string

genIdentHash:

• gen: genIdentHash(username, password, salt, epoch: string): string

genSalt:

• gen: genSalt(): string

get:

• user: get(self: type User; username: string; fields: varargs[string] = []): User

getFromDb:

• utils: getFromDb(table: type; blank: ref object; identifiers: openArray[string]; vars: untyped): untyped

getSession:

• routeUtils: getSession(ctx; name: string; default = ""): string

getUsing:

• routeUtils: getUsing(table: type; fields: ReqDbFields; node): auto

hashExpiringHours:

• config: hashExpiringHours

hashPassword:

• gen: hashPassword(salt, password: string): string

hasKey:

• routeUtils: hasKey(session: var Session; key: string): bool

haveSsl:

• config: haveSsl

ifContains:

• routeUtils: ifContains(node; all: openArray[string]; body)
• routeUtils: ifContains(node; atLeast: openArray[string]; body)

ifContainsAllErr:

• config: ifContainsAllErr

ifContainsAtLeastErr:

• config: ifContainsAtLeastErr

ifContainsInvalidReq:

• config: ifContainsInvalidReq

ifLogin:

• routeUtils: ifLogin(ctx; loggedIn = true; body)
• routeUtils: ifLogin(ctx; loggedIn = true; loggedUsr: untyped; body)

ifMinRank:

• routeUtils: ifMinRank(ctx; minRank: UserRank; body)

inDb:

• db: inDb(body: untyped)

internalDbPrefix:

• config: internalDbPrefix

invalidActivCode:

• config: invalidActivCode

invalidPassword:

• config: invalidPassword

ip:

• routeUtils: ip(req: Request): string

logicInApi:

• config: logicInApi

needLogin:

• config: needLogin

needLogoff:

• config: needLogoff

newUser:

• user: newUser(): User
• user: newUser(username, email, password, registerIp: string; rank = urGhost; registerDate = nowUnix()): User

nowUnix:

• utils: nowUnix(): int64

passwordIs:

• user: passwordIs(self: User; pass: string): bool

r_404:

• notFound: r_404(ctx: Context): owned(Future[void])

r_activate:

• activate: r_activate(ctx: Context): owned(Future[void])

rank:

• user: rank(user: User): UserRank

rank=:

• user: rank=(user: var User; rank: UserRank)

rankNotMeet:

• config: rankNotMeet

r_delUser:

• delUser: r_delUser(ctx: Context): owned(Future[void])
• delUser: r_delUser(ctx: Context): owned(Future[void])

r_editUser:

• editUser: r_editUser(ctx: Context): owned(Future[void])

render:

• activateAccount: render(username, code: string): string

respErr:

• routeUtils: respErr(msg: string; code = Http400)

respErrJson:

• routeUtils: respErrJson(json: string; code = Http400)

respJson:

• routeUtils: respJson(data: untyped; code: HttpCode)

ResponseJson:

• routeUtils: ResponseJson

ResponseKind:

• routeUtils: ResponseKind

respSuc:

• routeUtils: respSuc(msg: string; code = Http200)

respSucJson:

• routeUtils: respSucJson(json: string; code = Http200)

r_getUser:

• getUser: r_getUser(ctx: Context): owned(Future[void])

r_home:

• home: r_home(ctx: Context): owned(Future[void])

RkJson:

• ResponseKind.RkJson

RkMessage:

• ResponseKind.RkMessage

r_logout:

• logout: r_logout(ctx: Context): owned(Future[void])

rollingLog:

• config: rollingLog

routesDefinition:

• routes: routesDefinition

r_resend:

• resend: r_resend(ctx: Context): owned(Future[void])

r_signIn:

• signIn: r_signIn(ctx: Context): owned(Future[void])

r_signUp:

• signUp: r_signUp(ctx: Context): owned(Future[void])

saveSession:

• routeUtils: saveSession(ctx; usr: User)

send:

• activateAccount: send(to, username, code: string; test = true): bool

sendMail:

• send: sendMail(to, subject, body: string; mime = "html"; test = true): bool

sess_username:

• config: sess_username

setContentJsonHeader:

• routeUtils: setContentJsonHeader(ctx)

settings:

• config: settings

setup:

• setup: setup(conn: DbConn)

smtpFrom:

• config: smtpFrom

smtpPass:

• config: smtpPass

smtpPort:

• config: smtpPort

smtpServer:

• config: smtpServer

smtpTls:

• config: smtpTls

smtpUser:

• config: smtpUser

successActivation:

• config: successActivation

toJson:

• user: toJson(user: User): string

unpackAuthHash:

• gen: unpackAuthHash(hash: string): tuple[ident, epoch: string]

update:

• user: update(user: var User; loginIp = "")

updateFields:

• routeUtils: updateFields(obj: var object; node: JsonNode; blacklist: openArray[string] = []): bool

urAdmin:

• UserRank.urAdmin

urDisabled:

• UserRank.urDisabled

urGhost:

• UserRank.urGhost

url:

• utils: url(path: string): string

urUser:

• UserRank.urUser

User:

• user: User

userAlreadyActivated:

• config: userAlreadyActivated

userIdentifiers:

• config: userIdentifiers

userNotExists:

• config: userNotExists

UserRank:

• user: UserRank

withConf:

• config: withConf(body: untyped)

withParams:

• routeUtils: withParams(ctx; get = false; path = false; bodyCode: untyped)

withUser:

• routeUtils: withUser(node; body)
• routeUtils: withUser(node; usr: untyped; userIdentf: openArray[(string, string)] = userIdentifiers; body)