rescript express server
npm install rescript-express-server-templaterescript
//file ExpressPublicUsageCase.res
open ExpressServer
open ExpressHandler
open ExpressParseUrlHandlerConverter
open ExpressParseJsonHandlerConverter
open ExpressFileHandlerConverter
open! ExpressHandlerMiddleware//Defaultly server await "handler" type = Handler(array, (req, res) => unit)
//Handler modules allow to modify request and response and write hanlder-func use
//this modified versions: (req' => res'), and convert this funciton
//into default "handler" type
module Default = MakeDefault(DefaultErrorStrategy) //default handler builder
module QueryConverter = ExpressParseUrlHandlerConverter.Make(Default)
module QueryHandler = Make( Default, QueryConverter ) //parse url handler
module JsonConverter = ExpressParseJsonHandlerConverter.Make(QueryHandler)
module JsonHandler = Make( QueryHandler, JsonConverter ) //parse json-post-body handler
module FileParseConfig: FileParseConfig = {
let getFileAwaitFields: () => array =
() => [{name: "fileInp", maxCount: 1}]
let getDestPath: () => string =
() => "/uploads"
}
module FileConverter =
ExpressFileHandlerConverter.Make(JsonHandler, FileParseConfig)
module FileHandler = Make( JsonHandler, FileConverter ) //files loading handler
let indexPageHtml =
//page htmllet stringifyAny: ('a) => string = %raw(
function (u) {)let routes = [
Route(#get, "/", QueryHandler.handler(r => { //show form and show get-query
let UrlReq(_, urlData) = r
let unkToJson: (unknown) => string = %raw(
function(u) {)
let urlDataStr = unkToJson(urlData)
Html("Url data: " ++ urlDataStr ++ "
" ++ indexPageHtml)
})),
Route(#post, "/apply-post", FileHandler.handler(r => { //form handler and show data
let FileReq(JsonReq(_, json), files) = r
let json = {"json": "${stringifyAny(json)}",
Json(json)
})),
]runServer(routes, [], 80, () => {Js.Console.log("Server started!")})
ExpressServer.resi
ExpressServer has simple signature to server running
rescript
open Belt
open WebTypestype request
type response
type middleware
type expressApp
type scenario = (request, response) => unit
type handler = Handler(array, scenario)
type url = string
type route = Route(method, url, handler)
let staticFilesMiddleware: string => middleware
let runServer: (array, array, int, unit => unit) => unit
`
ExpressHandler.resi
Defaultly server await handler:
Handler modules allow to modify request and response and write hanlder-func use
this modified versions: , and convert this function
into default handler type.
`rescript
open ExpressServer
open WebTypesmodule type Handler = {
type hReq
type hRes
let wrapReq: ((request, response)) => hReq
let applyRes: (hReq, hRes) => unit
let primalReq: hReq => (request, response)
let convert: (hReq => hRes, request, response) => unit
let middlewares: array
let handler: (hReq => hRes) => handler
}
type serverRespType =
| Html(string)
| Json(string)
| OpenFile(string)
| DownloadFile(string)
| Redirect(string, redirectStatus)
| Error(string, errorStatus)
module type Default = Handler with type hReq = (request, response) and type hRes = serverRespType
module type ErrorStrategy = {
let wrapTryCatch: (unit => unit) => unit
}
module DefaultErrorStrategy: ErrorStrategy
module type MakeDefault = (ErrorStrategy: ErrorStrategy) => Default
//Default handler
module MakeDefault: MakeDefault
`
where is handler-function writen on confortable for coding and
reading language. Handler module allows this funciton conversation.
ExpressHandlerChain.resi
Is a Module of Hanlder type which allows depends with some old Handler and
allowa chain of conversations. This modules defining with ExpressHandlerChain.Make functor:
`rescript
open ExpressHandler
open ExpressServer
open Beltmodule type Converter = {
type oldReq
type newReq
type oldRes
type newRes
let wrapStepReq: oldReq => newReq
let getOldReq: newReq => oldReq
let applyStepRes: (newReq, newRes) => oldRes
let middlewares: array
}
module type MakeConverter = (OldHandler: Handler) =>
(Converter with type oldReq = OldHandler.hReq and type oldRes = OldHandler.hRes)
module type Make = (
OldHandler: Handler,
Converter: Converter with type oldReq = OldHandler.hReq and type oldRes = OldHandler.hRes,
) => (Handler with type hReq = Converter.newReq and type hRes = Converter.newRes)
module Make: Make
`
ExpressHandlerConverter.resi
is a minimal required module functionality for creation HandlerMiddleware chain.
rescript
open ExpressServer
open ExpressHandler
open ExpressHandlerChaintype jsonReq<'a> = JsonReq('a, unknown)
module type Make = (OldHandler: Handler) =>
(
Converter
with type oldReq = OldHandler.hReq
and type newReq = jsonReq
and type oldRes = OldHandler.hRes
and type newRes = OldHandler.hRes
)
module Make: Make
`
Implement this module and you will make build chain of handlers
Standart Handler Converters
$3
needs for parsing params from url of GET request
rescript
open ExpressServer
open ExpressHandler
open ExpressHandlerChaintype urlReq<'a> = UrlReq('a, unknown)
module type Make = (OldHandler: Handler) =>
(
Converter
with type oldReq = OldHandler.hReq
and type newReq = urlReq
and type oldRes = OldHandler.hRes
and type newRes = OldHandler.hRes
)
module Make: Make
`$3
needs for parsing json-request-body from POST request
rescript
open ExpressServer
open ExpressHandler
open ExpressHandlerChaintype jsonReq<'a> = JsonReq('a, unknown)
module type Make = (OldHandler: Handler) =>
(
Converter
with type oldReq = OldHandler.hReq
and type newReq = jsonReq
and type oldRes = OldHandler.hRes
and type newRes = OldHandler.hRes
)
module Make: Make
`$3
needs for parsing session data and handle session-effects
rescript
open ExpressHandler
open ExpressHandlerChaintype sessionReq<'a> = SessionReq('a, unknown)
type sessionEffect =
| SetSessionValue(string, unknown)
| DestroySession
type sessionRes<'a> = SessionRes('a, array)
type sessionParam =
| SessionResave(bool)
| SessionSaveUnitialized(bool)
| Cookie(bool, option)
type sessionConfig = SessionConfig(string, array)
let setSessionValue: (string, 'a) => sessionEffect
module type SessionConfigurator = {
let getSessionConfig: unit => sessionConfig
}
module DefaultConfigurator: SessionConfigurator
module type Make = (OldHandler: Handler, SessionConfigurator: SessionConfigurator) =>
(
Converter
with type oldReq = OldHandler.hReq
and type newReq = sessionReq
and type oldRes = OldHandler.hRes
and type newRes = sessionRes
)
module Make: Make
`$3
needs for building routes awaits file uploading and get access to files
rescript
open ExpressServer
open ExpressHandler
open ExpressHandlerChaintype fileAwaitField = {
name: string,
maxCount: int,
}
type file = {
fieldname: string,
originalname: string,
encoding: string,
mimetype: string,
destination: string,
filename: string,
path: string,
size: int,
}
type fileParsedField = {fileName: string, files: array}
type fileReq<'a> = FileReq('a, array)
module type FileParseConfig = {
let getFileAwaitFields: unit => array
let getDestPath: unit => string
}
module type Make = (OldHandler: Handler, FileParseConfig: FileParseConfig) =>
(
Converter
with type oldReq = OldHandler.hReq
and type newReq = fileReq
and type oldRes = OldHandler.hRes
and type newRes = OldHandler.hRes
)
module Make: Make
`
$3
needs for authentification using session.
Warning! in case of use with ExpressSessionHandlerConverter use same SessionManager
rescript
open ExpressHandler
open ExpressHandlerChaintype authSessReq<'r, 'u> = AuthSessReq('r, option<'u>)
type authSessEffect<'u> =
| Login('u)
| Logout
type authSessRes<'r, 'u> = AuthSessRes('r, array>)
module type UserManager = {
type loginData
type user
type userCheckAuthData
let produceAuthData: user => userCheckAuthData
let checkAuthData: userCheckAuthData => option
let checkLoginData: loginData => option
let invalidLoginDataMsg: unit => string
}
type sessionParam =
| SessionResave(bool)
| SessionSaveUnitialized(bool)
| Cookie(bool, option)
type sessionConfig = SessionConfig(string, array)
module type SessionConfigurator = {
let getSessionConfig: unit => sessionConfig
}
module DefaultConfigurator: SessionConfigurator
module type Make = (
OldHandler: Handler,
UserManager: UserManager,
SessionConfigurator: SessionConfigurator,
) =>
(
Converter
with type oldReq = OldHandler.hReq
and type newReq = authSessReq
and type oldRes = OldHandler.hRes
and type newRes = authSessRes
)
module Make: Make
``