# luren

> Luren is a simple framework based on Koa2

Latest version **0.3.4** (published 2020-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install luren
pnpm add luren
yarn add luren
bun add luren
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.4 |
| Published | 2020-09-17 |
| First published | 2018-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 20 |
| Unpacked size | 269.6 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | vincent.wen |
| Maintainers | vincent.wen |

## Links

- npm: https://www.npmjs.com/package/luren
- Repository: https://github.com/vcwen/luren
- Homepage: https://github.com/vcwen/luren#readme
- Issues: https://github.com/vcwen/luren/issues
- npm.io page: https://npm.io/package/luren

## Dependencies (20)

- [koa](https://npm.io/package/koa.md) ^2.11.0
- [uuid](https://npm.io/package/uuid.md) ^8.2.0
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [globby](https://npm.io/package/globby.md) ^11.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [koa-send](https://npm.io/package/koa-send.md) ^5.0.0
- [file-type](https://npm.io/package/file-type.md) ^14.6.2
- [immutable](https://npm.io/package/immutable.md) ^4.0.0-rc.12
- [inversify](https://npm.io/package/inversify.md) ^5.0.1
- [koa-mount](https://npm.io/package/koa-mount.md) ^4.0.0
- [pluralize](https://npm.io/package/pluralize.md) ^8.0.0
- [decamelize](https://npm.io/package/decamelize.md) ^3.2.0
- [formidable](https://npm.io/package/formidable.md) ^1.2.2
- [koa-helmet](https://npm.io/package/koa-helmet.md) ^5.2.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.27
- [header-case](https://npm.io/package/header-case.md) ^2.0.3
- [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^4.3.0
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.1.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [fast-safe-stringify](https://npm.io/package/fast-safe-stringify.md) ^2.0.7

## Recent versions

- 0.3.4 (latest) — 2020-09-17
- 0.3.3 — 2020-09-17
- 0.3.2 — 2020-09-17
- 0.3.1 — 2020-09-17
- 0.3.0 — 2020-09-17
- 0.2.11 — 2020-09-14
- 0.2.10 — 2020-09-11
- 0.2.9 — 2020-09-09
- 0.2.8 — 2020-09-09
- 0.2.7 — 2020-08-27
- 0.2.6 — 2020-08-16
- 0.2.5 — 2020-08-16
- 0.2.4 — 2020-08-02
- 0.2.3 — 2020-07-22
- 0.2.2 — 2020-07-05
- … 88 more at https://npm.io/package/luren/versions

## README

# Luren

[![npm version](https://badge.fury.io/js/luren.svg)](https://badge.fury.io/js/luren)
[![Dependencies Status](https://david-dm.org/vcwen/luren.svg)](https://david-dm.org/vcwen/luren)
[![Build Status](https://travis-ci.org/vcwen/luren.svg?branch=master)](https://travis-ci.org/vcwen/luren)
[![Coverage Status](https://coveralls.io/repos/github/vcwen/luren/badge.svg?branch=develop)](https://coveralls.io/github/vcwen/luren?branch=develop)

Luren是基于[Koa](https://koajs.com/)一个简单web框架，可以快速方便的生成RESTFUL风格的API，提供依赖注入[InversifyJS](http://inversify.io/)和RESTFUL API的文档[Swagger](https://swagger.io/)的支持.Luren是基于Decorator来设置Controller的，所以ts中必须开启decorator支持。Luren在启动时会自动加载工作目录下的`boot`, `middleware`,`controllers`,`models`四个目录下的ts/js文件。

```typescript
src
├── boot
├── controllers
├── middlewares
├── models

```

## Controller

Controller提供API的组件，也是Luren中最重要的一个组件，一个controller即代表一个资源，controller中包含多个action，即资源相关的API。下面的controller会生成一个`POST /api/v1/demos/foo`的API， 当接受请求时会检查相应的参数，如header，query，body等然后处理之后传递给相应的action函数，在action函数返回结果之后，会将结果根据Response类型进行处理然后返回。

```typescript
@injectable()
@Controller({ prefix: '/api', version: 'v1' })
export default class DemoController {

  @Action({ method: HttpMethod.POST, path: '/foo' })
  @Response({ type: 'string' })
  public async foo( @InBody('name','string', true) name: string) {
  	return `Hello ${name}`
  }

```

## Middleware
Middleware是一个普通函数或者继承Processor或实现IProcessor接口的对象

```typescript
async function handle(ctx: Context, next: INext) {
  // do something
  await next()
}
class Authorization extends Processor<boolean> {
  public async process(@InQuery('name') name: string) {
    return name === 'foo'
  }
}

```

## Models

通过luren-schema对model类进行注解，可在其他地方直接引用该类型， 同时可以链接到相应的DataSource。

```typescriopt
@Collection({datasource: 'mongodb', database: 'demo' })
@Schema()
export default class User {
  @Prop()
  public firstName: string
  @Prop()
  public lastName: string
  @Prop({type: 'number', required: true})
  public age: number
}

```

## Boot

boot文件下包含需要随应用一起启动的内容， 文件以文件名的顺序加载。

## 依赖注入

Luren支持使用[InversifyJS](http://inversify.io/)来加载controller

```typescript
@injectable()
@Controller({ prefix: '/api', version: 'v1' })
export default class DemoController {
  @Action({ path: '/foo' })
  @Response({ type: Person })
  public async bar(@InQuery('name') name: string) {
    return null
  }

  // create server with inversify container
  const server = new Luren({ container })
```

#### Swagger

luren-swagger可以作为插件加载，会根据controller的注解自动生成Swagger文档。

```typescript
const server = new Luren({ container })
const swagger = new Swagger({
  info: { title: 'demo', version: '1.0' },
  servers: [{ url: '/', description: 'demo api' }]
})
server.plugin(swagger.pluginify())
```

## 代码示例

```typescript
import jwt from 'jsonwebtoken'
import _ from 'lodash'
import { APITokenAuthentication, Luren } from 'luren'
import { Swagger } from 'luren-swagger'
import dataSource from './dataSource'
import container from './inversify'

// create server with inversify container
const server = new Luren({ container })
// set work directory
server.setWorkDirectory(__dirname)
// set data source
server.setDefaultDataSource(dataSource)
// authentication
server.setDefaultAuthentication(
  new APITokenAuthentication({
    key: 'Authorization',
    source: 'header',
    async validate(accessToken: string) {
      const data = jwt.verify(accessToken, 'jwt-key')
      return data ? true : false
    }
  })
)
// serve files
server.serve('/public', { root: '/', maxage: 30 * 24 * 60 * 60 * 1000, defer: true })

// setup swagger plugin
const swagger = new Swagger({
  info: { title: 'demo', version: '1.0' },
  servers: [{ url: '/', description: 'demo api' }]
})
server.plugin(swagger.pluginify())

// start server
server.listen(3000).then(async () => {
  logger.info('Server started')
}er.info('Server started')
})

```

---
_Source: https://npm.io/package/luren · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._