# tree-house

> NodeJS utilities and handy helpers extending ExpressJS functionalities

Latest version **5.2.0** (published 2024-06-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install tree-house
pnpm add tree-house
yarn add tree-house
bun add tree-house
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.2.0 |
| Published | 2024-06-06 |
| First published | 2017-05-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 12 |
| Unpacked size | 23.4 KB |
| Known vulnerabilities | 0 (+8 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Maintainers | benjijanssens, samvanhoey, jaspervercammen, codeinineo, ethanfoust, jensicapps, willemhorsten, dgyesbreghs, samover, knor-el-snor |
| Keywords | NodeJS, Treehouse, API, Secure, Customisable |

## Links

- npm: https://www.npmjs.com/package/tree-house
- Repository: https://github.com/icapps/tree-house
- Homepage: https://github.com/icapps/tree-house#readme
- Issues: https://github.com/icapps/tree-house/issues
- npm.io page: https://npm.io/package/tree-house

## Dependencies (12)

- [cors](https://npm.io/package/cors.md) ~2.8.5
- [https](https://npm.io/package/https.md) ~1.0.0
- [helmet](https://npm.io/package/helmet.md) ~4.6.0
- [express](https://npm.io/package/express.md) ~4.17.2
- [js-yaml](https://npm.io/package/js-yaml.md) ~4.1.0
- [body-parser](https://npm.io/package/body-parser.md) ~1.19.1
- [openapi-types](https://npm.io/package/openapi-types.md) ~10.0.0
- [rate-limit-redis](https://npm.io/package/rate-limit-redis.md) ~2.1.0
- [express-rate-limit](https://npm.io/package/express-rate-limit.md) ~5.5.1
- [express-validation](https://npm.io/package/express-validation.md) ~3.0.8
- [swagger-ui-express](https://npm.io/package/swagger-ui-express.md) ~4.3.0
- [@apidevtools/swagger-parser](https://npm.io/package/@apidevtools/swagger-parser.md) ~10.0.3

## Recent versions

- 5.2.0 (latest) — 2024-06-06
- 5.1.0 — 2021-07-08
- 4.0.0 — 2019-06-27
- 3.4.5 — 2019-06-02
- 3.4.4 — 2019-06-02
- 3.4.3 — 2019-04-04
- 3.4.2 — 2019-02-28
- 3.4.1 — 2019-02-06
- 3.4.0 — 2019-01-31
- 3.3.2 — 2018-11-05
- 3.3.1 — 2018-09-05
- 3.3.0 — 2018-05-02
- 3.2.0 — 2018-04-23
- 3.1.0 — 2018-04-19
- 3.0.5 — 2018-04-17
- … 36 more at https://npm.io/package/tree-house/versions

## README

# Treehouse

NodeJS utilities and handy helpers extending ExpressJS functionalities

[![npm version](https://badge.fury.io/js/tree-house.svg)](https://badge.fury.io/js/tree-house)
[![Dependencies](https://david-dm.org/icapps/tree-house.svg)](https://david-dm.org/icapps/tree-house.svg)
[![Build Status](https://travis-ci.com/icapps/tree-house.svg?branch=master)](https://travis-ci.com/icapps/tree-house)
[![Coverage Status](https://coveralls.io/repos/github/icapps/tree-house/badge.svg)](https://coveralls.io/github/icapps/tree-house)
[![Greenkeeper badge](https://badges.greenkeeper.io/icapps/tree-house.svg)](https://greenkeeper.io/)

## Installation

Install via npm

```shell
npm install tree-house
```

or via yarn

```shell
yarn add tree-house
```

## Usage

```javascript
const treehouse = require('tree-house')
```

```javascript
import * as treehouse from 'tree-house'
```

## Security

### setBasicSecurity(app, route, options)

Set some basic Express security using `cors` and `helmet`.

```javascript
const app = express();

treehouse.setBasicSecurity(app, '*', {
  cors: {},   // cors options
  helmet: {}, // helmet options
})
```

- [All available helmet options](https://github.com/helmetjs/helmet)
- [All available cors options](https://github.com/expressjs/cors)

### setBodyParser(app, route, options)

Set a body parser using the `body-parser` module

```javascript
const app = express();

treehouse.setBodyParser(app, '*', {
  json: {},   // json options
  raw: {}, // raw options
  text: {}, // text options
  urlEncoded: {}, // urlEncoded options
})
```

- [All available body parser options](https://github.com/expressjs/body-parser)

### getRateLimiter(options)

Get a rate limiter instance to prevent brute force attacks. This can be used as a middleware in Express.
At the moment there is support for a built in-memorystore or Redis. Both use the `express-rate-limit` module.

```javascript
const app = express();

// In memory store (development purposes)
const globalRateLimiter = treehouse.getRateLimiter({
  max: 100, // limit each IP to 100 requests per windowMs
  delayMs: 0 // disable delaying - full speed until the max limit is reached
  windowMs: 60 * 60 * 1000, // 1 hour window
  message:
    "Too many accounts created from this IP, please try again after an hour"
});

app.use('/login', globalRateLimiter, ...);

// Using existing Redis client
treehouse.getRateLimiter({
  redis: {
    client: existingClient, // All Redis options or 'client' to use an existing client (see rate-limit-redis)
  },
});
```

- [All available Express-rate-limit options](https://github.com/nfriedly/express-rate-limit)
- [All available Redis options](https://github.com/NodeRedis/node_redis)

## Responder

### handleAsyncFn((req, res, next(optional)) => { ... })

Express middleware that wraps and executes a given function with try/catch to avoid unhandled promises within Express.

```javascript
const app = express();

function getAllUsers(req, res) {
  //  res.send(users) -> return users...
  // or
  // if an unhandled error occurs this will be passed onto the Express error handler instead of raising an UnhandledPromiseRejectionError
}

app.use('/users', treehouse.handleAsyncFn(getAllUsers));
```

## Server

### startServer(app, options)

Start an http or https server using an express instance

```javascript
const app = express();

treehouse.startServer(app, {
  port: 3000,
  title: 'My app',
  pre: preFn,       // function to execute before starting server (optional)
  post: postFn,     // function to execute after starting server (optional) - will contain the http server as first argument
  https: {          // optional
    port: 3001,
    privateKey: 'assets/ssl.key',
    certificate: 'assets/ssl.cert',
  },
  keepAliveTimeout: 60000, // optional
  headersTimeout: 60000, // optional
})
```

## Swagger

### setSwagger(app, route, filePath, options)

Serve Swagger UI via the a provided Swagger yaml file OR folder with valid structure and yaml files.

### YAML file implementation

```javascript
const app = express();

await treehouse.setSwagger(app, '/documentation', 'documentation/swagger.yml', {
  host: 'localhost:3000',
  schemes: ['http'],
};
```

- [All available swagger-ui options](https://github.com/swagger-api/swagger-ui)

### Folder  implementation with valid structure

Structure

```bash
.
├── validFolderName
|   ├── index.yml # contains basic info + definition models
|   └── routes
|          ├── route1.yml
|          └── randomName.yml
|          ├── ... # more yml files
```

Example code

```javascript
const app = express();

treehouse.setSwagger(app, '/documentation', 'documentation/validFolderName', {
  host: 'localhost:3000',
  schemes: ['http'],
  concatenate : true, // The property to enable folder functionality
};
```

- [All available swagger-ui options](https://github.com/swagger-api/swagger-ui)

## Validator

### validateSchema(schema, options)

Express middleware to validate a Joi schema using the `express-validation` module. This will throw an error as an instance of ExpressValidationError if the Joi validation fails.

```javascript
const schema =   {
  body: Joi.object({
    name: Joi.string().required(),
  })
};

app.post('/my-endpoint', treehouse.validateSchema(schema), ...);
```

- [All available express-validation options](https://github.com/AndrewKeig/express-validation)

## Tests

- You can run `npm run test` to run all tests
- You can run `npm run test:coverage` to run all tests with coverage report

## Bugs

When you find issues, please report them:

- web: [https://github.com/icapps/tree-house/issues](https://github.com/icapps/tree-house/issues)

Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.

## Authors

See the list of [contributors](https://github.com/icapps/tree-house/contributors) who participated in this project.

## License

This project is licensed under the ISC License - see the [LICENSE.md](LICENSE.md) file for details

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