@dkh-dev/app

_Simple server app_

Example

``javascript
'use strict'

const App = require('@dkh-dev/app')


const app = new App()

app.get({
'/': () => 'Hello from @dkh-dev/app',
'/about': () => 'Copyright (c) 2019, dangkyokhoang',
})

app.start()
`

Reference

$3

> Note: The default app is shipped with default configurations to make it work out of the box.

app.yaml

`dart
server:
port: [8080]

keep_alive_timeout: [5000]
max_body_size: [1000]

logger:
info: [production ? data/info.log : stdout] // info log
error: [production ? data/error.log : stderr] // error log
debug: [production ? null : stdout] // debug log
: // logger.()
// request: data/request.log
// database: data/database.log

database:
hostname: [localhost]
port: [27017]

name:

user:
password:

pool_size: [1]
ignore_undefined: [true]

validator:
strict: [true]
remove_additional: [true]

key:
size: [64] // must be equal or greater than id size
encoding: [base64]
collection_name: [keys]
`

$3

- app.db:

`typescript
class Db {
Promise connect() // connects to MongoDB

Collection get () // returns a MongoDB Collection
// db.users.find()
// db.products.insertOne()

void close() // closes the database client
}
`

- app.logger:

`typescript
class Logger {
void info() // logs to info log file in production environment
// or to console in development environment

void error()

void debug() // logs to console in development enviroment;
// does nothing in production environment

void () // user-defined log stream
// logger.request(requesting ${ url })
// logger.database(querying ${ collection })
}
`

- app.lock() — locks paths; requires authorization: to unlock

`javascript
app.lock([
'/admin',
])
`

- app.use() — applies middlewares

`javascript
app.use({
'/': log,

// middlewares are fail-safe
// feel free to throw an error from inside
'/error': () => {
throw Error('user wants me to fail')
},
})
`

- app.schema — defines schemas or registers validator middlewares

`javascript
app.schema({
// definition schemas

story: {
definitions: {
id: { type: 'string', maxLength: 20 },
contents: { type: 'string', maxLength: 1000 },
},
},

// validator middlewares
// keys starting with '/' are paths

'/duplicate': {
type: 'array',
items: { type: 'integer' },
},

'/stories/create': {
type: 'object',
properties: {
contents: { $ref: 'story#/definitions/contents' },
},
additionalProperties: false,
},
})
`

- app.get() — registers GET handlers

`javascript
app.get({
'/': home,

// the return value will be used as the response
'/random': () => Math.random(),

// async values work
'/hello': () => Promise.resolve('hello'),

// and so do streams
'/data': () => fs.createReadStream('data.txt'),

// still you can send response explicitly
'/write': (request, response) => {
response.write('text')
},

// handlers are fail-safe
// feel free to throw an error from inside
'/error': () => {
throw Error('user has requested an error')
},
})
`

- app.post() — registers POST handlers

`javascript
const { HttpError } = require('@dkh-dev/app')

app.post({
'/unlock': () => true,

// what you post is what you get
'/duplicate' ({ body }) => duplicate(body),

// handlers are fail-safe
'/error': ({ body: { code } }) => {
throw new HttpError(code, http error)
}
})
`

$3

- npx keygen — generates a key to unlock locked paths

`bash
$ npx keygen --scope '/root /admin' --comment 'root'
$ npx keygen -s /admin -m admin
``