# express-common-middlewares

> Common express middlewares

Latest version **1.0.24** (published 2023-04-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install express-common-middlewares
pnpm add express-common-middlewares
yarn add express-common-middlewares
bun add express-common-middlewares
```

## 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 | 1.0.24 |
| Published | 2023-04-27 |
| First published | 2023-04-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | nsnl-coder |
| Maintainers | nsnl-coder |
| Keywords | express, middlewares |

## Links

- npm: https://www.npmjs.com/package/express-common-middlewares
- npm.io page: https://npm.io/package/express-common-middlewares

## Dependencies (6)

- [dotenv](https://npm.io/package/dotenv.md) ^16.0.3
- [express](https://npm.io/package/express.md) ^4.18.2
- [mongoose](https://npm.io/package/mongoose.md) ^7.0.3
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.0
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.6
- [express-async-errors](https://npm.io/package/express-async-errors.md) ^3.1.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.24 (latest) — 2023-04-27
- 1.0.23 — 2023-04-23
- 1.0.22 — 2023-04-23
- 1.0.21 — 2023-04-23
- 1.0.20 — 2023-04-04
- 1.0.19 — 2023-04-04
- 1.0.18 — 2023-04-03
- 1.0.17 — 2023-04-03
- 1.0.16 — 2023-04-03
- 1.0.15 — 2023-04-03
- 1.0.14 — 2023-04-02
- 1.0.13 — 2023-04-02
- 1.0.12 — 2023-04-02
- 1.0.11 — 2023-04-02
- 1.0.10 — 2023-04-02
- … 9 more at https://npm.io/package/express-common-middlewares/versions

## README

### There are 4 middleware:

- `requireLogin`: check if user is login
- `requireRole`: check if user is admin
- `checkIdExistene`: check if an objectid exists in a mongodb collection
- `checkOwnership`: check if a document is created by currently logged in user
- `globalErrorHandler`: express global error handler
- `routeNotFound`: simple prewritten function to handle route not found error

## requireLogin

In order to make this middleware work:

- you need to pass in User model created from express.Model as an arguement
- defined process.env.JWT_SECRET
- apply `cookie-parse` into express app

```javascript
const { requireLogin } = require('express-common-middlewares');

router.use('/require-login', requireLogin(User), (req, res, next) => {
  res.status(200).json({ status: 'success', message: 'pass the test' });
});
```

## requireRole

Require role simple check if req.user.role has a specific role.

```javascript
// in this example, it check if user has role of admin
const { requireLogin, requireRole } = require('express-common-middlewares');

router.use(
  '/require-role',
  requireLogin(User),
  requireRole('admin'),
  (req, res, next) => {
    res.status(200).json({ status: 'success', message: 'pass the test' });
  },
);
```

It can also check if user has one of multiple roles

```javascript
// in this example, it check if user has roles of admin, write or support
router.use(
  '/require-role',
  requireLogin(User),
  // it will pass if user is one of these 3 roles
  requireRole('admin', 'writer', 'support'),
  (req, res, next) => {
    res.status(200).json({ status: 'success', message: 'pass the test' });
  },
);
```

## checkIdExistence

Check if all the object ids inside `req.body.friends` do exist.

`req.body.friends` can be a `single objectid` or `array of objectids.`

```javascript
router.use(
  '/check-id-existence',
  checkIdExistence(User, 'friends'), // check if all ids in friends exist in db
  (req, res, next) => {
    res.status(200).json({ status: 'success', message: 'pass the test' });
  },
);
```

It will throw error if `req.body.friends` contains an user id that does not exist.
You can check whatever field in whatever mongodb collection you want, not just `req.body.friends` fields in `user collection`.

## requireOwnership

This middleware accept mongoose model as an argument.
It will check if the document with `id = req.params.id` createdBy current login user.

```javascript
// in this example, it check if user has role of admin
router.use(
  '/:id',
  requireLogin(User),
  requireOwnership(Product), // check if user has ownership to product with id = req.params.id
  (req, res, next) => {
    res.status(200).json({ status: 'success', message: 'pass the test' });
  },
);
```

**Behaviour**:

- return success if user have ownership to that doc
- return success if user is admin
- return error if user does not have ownership
- return error if document with id params does not exist
- return error if document does not contain createdBy field

**Important note:**

- the document that you checked ownership for need to have `createdBy` field contain creator userid
- you need to use `requireLogin` middleware before using `requireOwnership` because + `requireOwnership` need to use `req.user`
- The route you apply `requireOwnership` middleware must have `req.params.id`

## Global error handler

This middleware only handle jwt verify failure.
Otherwise, it just return generic message: `Something wentwrong!`

```javascript
const app = express();

app.use(globalErrorHandler);
```

## Route not found

This is everything this middleware do!

```javascript
res.status(404).json({
  status: 'fail',
  message: 'This route is not defined',
});
```

```javascript
const app = express();

app.use(routeNotFound);
```

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