nee-ctx-web-ktor

alltypes

sealed class ApiError

open val status: HttpStatusCode
data class WrongArguments : ApiError

WrongArguments(msg: String)
val msg: String
val status: HttpStatusCode

interface ApplicationContextProvider<CTX, LOCAL>

abstract suspend fun serve(businessFunction: ANee<CTX, Any>, localParam: LOCAL): Unit

abstract class BaseWebContextProvider<R, G : TxProvider<R, G>> : WebContextProvider<R, G>

BaseWebContextProvider()
abstract fun authProvider(call: ApplicationCall): SecurityProvider<User, UserRole>
open fun create(call: ApplicationCall): WebContext<R, G>
open val errorHandler: ErrorHandler
abstract val executionContextProvider: ExecutionContextProvider
open fun fx(): EffectsInstance<R, G>
open fun jacksonMapper(): ObjectMapper
open val jacksonMapper: ObjectMapper!
open val logger: MutableInMemLogger
open fun monitoringApi(): Route.() -> Unit
open val timeProvider: TimeProvider
open val traceProvider: TraceProvider<*>
open val traceResource: TraceResource
abstract val txProvider: TxProvider<R, G>

object BasicAuth

const val authorizationHeader: String
class BasicAuthCtx<USERID, ROLE>

BasicAuthCtx(userRealm: UserRealm<USERID, ROLE>)
fun createSecurityProviderFromRequest(request: ApplicationRequest): SecurityProvider<USERID, ROLE>

class BasicAuthProvider<USERID, ROLE> : SecurityProvider<USERID, ROLE>

BasicAuthProvider(headerVal: Option<String>, userRealm: UserRealm<USERID, ROLE>)
class AnonymousSecurityContext<USERID, ROLE> : SecurityCtx<USERID, ROLE>

AnonymousSecurityContext()
fun getCurrentUser(): Out<SecurityError, USERID>
fun hasRole(role: ROLE): Boolean

const val basicAuthHeaderPrefix: String
fun getSecurityContext(): Out<SecurityError, SecurityCtx<USERID, ROLE>>
class UserSecurityContext<USERID, ROLE> : SecurityCtx<USERID, ROLE>

UserSecurityContext(user: USERID, userRealm: UserRealm<USERID, ROLE>)
fun getCurrentUser(): Out<SecurityError, USERID>
fun hasRole(role: ROLE): Boolean

object DefaultErrorHandler : ErrorHandler

fun invoke(error: Any): OutgoingContent

object DefaultJacksonMapper

val mapper: ObjectMapper!

class EffectsInstance<R, G : TxProvider<R, G>>

EffectsInstance()
val async: Effect<WebContext<R, G>, Nothing>
fun cache(): Cache<R, G>
class Cache<R, G : TxProvider<R, G>>

Cache()
val internalCache: CaffeineProvider
fun <P> of(p: P): CacheEffect<WebContext<R, G>, Nothing, P>

val nop: Effect<WebContext<R, G>, Nothing>
val plainFx: PlainInstances<R, G>
class PlainInstances<R, G : TxProvider<R, G>>

PlainInstances()
val tx: TxEffect<Connection, WebContext<R, G>>

fun secured(roles: List<UserRole>): Effect<WebContext<R, G>, SecurityError>
val trace: TraceEffect<WebContext<R, G>>
val tx: Effect<WebContext<R, G>, TxError>

typealias ErrorHandler = (Any) -> OutgoingContent
abstract class JDBCBasedWebContextProvider : BaseWebContextProvider<Connection, JDBCProvider>

JDBCBasedWebContextProvider()
open fun authProvider(call: ApplicationCall): SecurityProvider<User, UserRole>
open val executionContextProvider: ECProvider
abstract val jdbcProvider: JDBCProvider
open val jdbcTasksScheduler: ExecutorService!
open val txProvider: TxProvider<Connection, JDBCProvider>
open val userRealm: UserRealm<User, UserRole>

class JwtAuthProvider<USER, ROLE> : SecurityProvider<USER, ROLE>

JwtAuthProvider(headerVal: Option<String>, jwtConf: JwtConfigurationModule<USER, ROLE>)
const val bearerAuthHeaderPrefix: String
fun getSecurityContext(): Out<SecurityError, SecurityCtx<USER, ROLE>>

data class OauthLoginData

OauthLoginData(code: String, state: String, redirectUri: String)
val code: String
val redirectUri: String
val state: String

class OauthSupportApi

OauthSupportApi(oauthService: OauthService<User, UserRole>)
fun oauthApi(): Route.() -> Unit

class RenderHelper : Logging

RenderHelper(objectMapper: ObjectMapper, errorHandler: ErrorHandler)
val errorHandler: ErrorHandler
val objectMapper: ObjectMapper
suspend fun <T> renderResponse(call: ApplicationCall, resp: Either<ApiError, T>): Unit
suspend fun renderText(call: ApplicationCall, text: String): Unit
suspend fun <E, A> serveMessage(applicationCall: ApplicationCall, msg: Out<E, A>): Unit
suspend fun <E> serveText(applicationCall: ApplicationCall, msg: Out<E, String>): Unit

class TokenSecurityContext<USER, ROLE> : SecurityCtx<USER, ROLE>

TokenSecurityContext(user: USER, jwtCoder: JwtUsersCoder<USER, ROLE>)
fun getCurrentUser(): Out<SecurityError, USER>
fun hasRole(role: ROLE): Boolean
val jwtCoder: JwtUsersCoder<USER, ROLE>
val user: USER

data class WebContext<R, G : TxProvider<R, G>> : TxProvider<R, WebContext<R, G>>, SecurityProvider<User, UserRole>, ExecutionContextProvider, TraceProvider<WebContext<R, G>>, TimeProvider, Logging, AsyncSupport<WebContext<R, G>>

WebContext(jdbcProvider: TxProvider<R, G>, securityProvider: SecurityProvider<User, UserRole>, executionContextProvider: ExecutionContextProvider, errorHandler: ErrorHandler = DefaultErrorHandler, contextProvider: WebContextProvider<R, G>, traceProvider: TraceProvider<*>, timeProvider: TimeProvider, applicationCall: ApplicationCall, asyncEnv: AsyncEnvWrapper<WebContext<R, G>> = AsyncEnvWrapper())
fun getConnection(): TxConnection<R>
fun getTrace(): TraceResource
suspend fun <E, A> serveMessage(msg: Out<E, A>): Unit
suspend fun serveMessage(businessFunction: ANee<WebContext<R, G>, Any>): Unit
suspend fun serveText(businessFunction: ANee<WebContext<R, G>, String>): Unit
fun setConnectionState(newState: TxConnection<R>): WebContext<R, G>
fun setTrace(newState: TraceResource): WebContext<R, G>

interface WebContextProvider<R, G : TxProvider<R, G>>

open fun <E, A> async(func: () -> Nee<WebContext<R, G>, E, A>): Nee<WebContext<R, G>, Any, A>
abstract fun create(call: ApplicationCall): WebContext<R, G>
abstract fun fx(): EffectsInstance<R, G>
open fun healthCheck(): Route.() -> Unit
abstract fun jacksonMapper(): ObjectMapper
open fun monitoringApi(): Route.() -> Unit
open fun sysApi(): Route.() -> Unit
open fun userSecurityApi(): Route.() -> Unit

package dev.neeffect.nee.ctx.web

interface ApplicationContextProvider<CTX, LOCAL>

abstract suspend fun serve(businessFunction: ANee<CTX, Any>, localParam: LOCAL): Unit

abstract class BaseWebContextProvider<R, G : TxProvider<R, G>> : WebContextProvider<R, G>

BaseWebContextProvider()
abstract fun authProvider(call: ApplicationCall): SecurityProvider<User, UserRole>
open fun create(call: ApplicationCall): WebContext<R, G>
open val errorHandler: ErrorHandler
abstract val executionContextProvider: ExecutionContextProvider
open fun fx(): EffectsInstance<R, G>
open fun jacksonMapper(): ObjectMapper
open val jacksonMapper: ObjectMapper!
open val logger: MutableInMemLogger
open fun monitoringApi(): Route.() -> Unit
open val timeProvider: TimeProvider
open val traceProvider: TraceProvider<*>
open val traceResource: TraceResource
abstract val txProvider: TxProvider<R, G>

object BasicAuth

const val authorizationHeader: String
class BasicAuthCtx<USERID, ROLE>

BasicAuthCtx(userRealm: UserRealm<USERID, ROLE>)
fun createSecurityProviderFromRequest(request: ApplicationRequest): SecurityProvider<USERID, ROLE>

class BasicAuthProvider<USERID, ROLE> : SecurityProvider<USERID, ROLE>

BasicAuthProvider(headerVal: Option<String>, userRealm: UserRealm<USERID, ROLE>)
class AnonymousSecurityContext<USERID, ROLE> : SecurityCtx<USERID, ROLE>

AnonymousSecurityContext()
fun getCurrentUser(): Out<SecurityError, USERID>
fun hasRole(role: ROLE): Boolean

const val basicAuthHeaderPrefix: String
fun getSecurityContext(): Out<SecurityError, SecurityCtx<USERID, ROLE>>
class UserSecurityContext<USERID, ROLE> : SecurityCtx<USERID, ROLE>

UserSecurityContext(user: USERID, userRealm: UserRealm<USERID, ROLE>)
fun getCurrentUser(): Out<SecurityError, USERID>
fun hasRole(role: ROLE): Boolean

object DefaultErrorHandler : ErrorHandler

fun invoke(error: Any): OutgoingContent

object DefaultJacksonMapper

val mapper: ObjectMapper!

class EffectsInstance<R, G : TxProvider<R, G>>

EffectsInstance()
val async: Effect<WebContext<R, G>, Nothing>
fun cache(): Cache<R, G>
class Cache<R, G : TxProvider<R, G>>

Cache()
val internalCache: CaffeineProvider
fun <P> of(p: P): CacheEffect<WebContext<R, G>, Nothing, P>

val nop: Effect<WebContext<R, G>, Nothing>
val plainFx: PlainInstances<R, G>
class PlainInstances<R, G : TxProvider<R, G>>

PlainInstances()
val tx: TxEffect<Connection, WebContext<R, G>>

fun secured(roles: List<UserRole>): Effect<WebContext<R, G>, SecurityError>
val trace: TraceEffect<WebContext<R, G>>
val tx: Effect<WebContext<R, G>, TxError>

typealias ErrorHandler = (Any) -> OutgoingContent
abstract class JDBCBasedWebContextProvider : BaseWebContextProvider<Connection, JDBCProvider>

JDBCBasedWebContextProvider()
open fun authProvider(call: ApplicationCall): SecurityProvider<User, UserRole>
open val executionContextProvider: ECProvider
abstract val jdbcProvider: JDBCProvider
open val jdbcTasksScheduler: ExecutorService!
open val txProvider: TxProvider<Connection, JDBCProvider>
open val userRealm: UserRealm<User, UserRole>

data class WebContext<R, G : TxProvider<R, G>> : TxProvider<R, WebContext<R, G>>, SecurityProvider<User, UserRole>, ExecutionContextProvider, TraceProvider<WebContext<R, G>>, TimeProvider, Logging, AsyncSupport<WebContext<R, G>>

WebContext(jdbcProvider: TxProvider<R, G>, securityProvider: SecurityProvider<User, UserRole>, executionContextProvider: ExecutionContextProvider, errorHandler: ErrorHandler = DefaultErrorHandler, contextProvider: WebContextProvider<R, G>, traceProvider: TraceProvider<*>, timeProvider: TimeProvider, applicationCall: ApplicationCall, asyncEnv: AsyncEnvWrapper<WebContext<R, G>> = AsyncEnvWrapper())
fun getConnection(): TxConnection<R>
fun getTrace(): TraceResource
suspend fun <E, A> serveMessage(msg: Out<E, A>): Unit
suspend fun serveMessage(businessFunction: ANee<WebContext<R, G>, Any>): Unit
suspend fun serveText(businessFunction: ANee<WebContext<R, G>, String>): Unit
fun setConnectionState(newState: TxConnection<R>): WebContext<R, G>
fun setTrace(newState: TraceResource): WebContext<R, G>

interface WebContextProvider<R, G : TxProvider<R, G>>

open fun <E, A> async(func: () -> Nee<WebContext<R, G>, E, A>): Nee<WebContext<R, G>, Any, A>
abstract fun create(call: ApplicationCall): WebContext<R, G>
abstract fun fx(): EffectsInstance<R, G>
open fun healthCheck(): Route.() -> Unit
abstract fun jacksonMapper(): ObjectMapper
open fun monitoringApi(): Route.() -> Unit
open fun sysApi(): Route.() -> Unit
open fun userSecurityApi(): Route.() -> Unit

package dev.neeffect.nee.ctx.web.jwt

class JwtAuthProvider<USER, ROLE> : SecurityProvider<USER, ROLE>

JwtAuthProvider(headerVal: Option<String>, jwtConf: JwtConfigurationModule<USER, ROLE>)
const val bearerAuthHeaderPrefix: String
fun getSecurityContext(): Out<SecurityError, SecurityCtx<USER, ROLE>>

class TokenSecurityContext<USER, ROLE> : SecurityCtx<USER, ROLE>

TokenSecurityContext(user: USER, jwtCoder: JwtUsersCoder<USER, ROLE>)
fun getCurrentUser(): Out<SecurityError, USER>
fun hasRole(role: ROLE): Boolean
val jwtCoder: JwtUsersCoder<USER, ROLE>
val user: USER

package dev.neeffect.nee.ctx.web.oauth

data class OauthLoginData

OauthLoginData(code: String, state: String, redirectUri: String)
val code: String
val redirectUri: String
val state: String

class OauthSupportApi

OauthSupportApi(oauthService: OauthService<User, UserRole>)
fun oauthApi(): Route.() -> Unit

package dev.neeffect.nee.ctx.web.util

sealed class ApiError

open val status: HttpStatusCode
data class WrongArguments : ApiError

WrongArguments(msg: String)
val msg: String
val status: HttpStatusCode

class RenderHelper : Logging

RenderHelper(objectMapper: ObjectMapper, errorHandler: ErrorHandler)
val errorHandler: ErrorHandler
val objectMapper: ObjectMapper
suspend fun <T> renderResponse(call: ApplicationCall, resp: Either<ApiError, T>): Unit
suspend fun renderText(call: ApplicationCall, text: String): Unit
suspend fun <E, A> serveMessage(applicationCall: ApplicationCall, msg: Out<E, A>): Unit
suspend fun <E> serveText(applicationCall: ApplicationCall, msg: Out<E, String>): Unit