nestjs-mtenant

KO | EN

gitlite — search

#javascript #docker #raspberry-pi #docker-image #security #redis #react #elixir #github #express #html5 #redux

★ 150 Open GitHub ↗

NestJS module to enable deep multitenancy support.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

NestJS module for multi-tenancy with deep integration into Sequelize and TypeORM.

## Features

- Automatic tenant injection into all Sequelize and TypeORM operations
- Header and query parameter based tenant extraction
- Transparent Sequelize hooks (8 hooks covering all CRUD operations)
- TypeORM subscriber for writes + `TenantBaseRepository` for reads
- Pluggable storage (Sequelize, TypeORM) with optional caching (IoRedis)
- Swagger integration via `@MTApi()` decorator
- Per-operation, per-scope, and global tenancy control

## Compatibility

| nestjs-mtenant | NestJS | Node.js | Sequelize | TypeORM |
|:-:|:-:|:-:|:-:|:-:|
| 1.x | 11.x | >= 20 | 6.x | 0.3.x |
| 0.x | 9.x - 10.x | >= 14 | 6.x | - |

## Installation

```sh
npm install nestjs-mtenant nestjs-cls

# For Sequelize support:
npm install sequelize sequelize-typescript

# For TypeORM support:
npm install typeorm
```

## Documentation

Full documentation is available on [GitHub Pages](https://alexanderc.github.io/nestjs-mtenant/).

- [Getting Started](https://alexanderc.github.io/nestjs-mtenant/getting-started)
- [Configuration](https://alexanderc.github.io/nestjs-mtenant/configuration)
- [Sequelize Integration](https://alexanderc.github.io/nestjs-mtenant/sequelize)
- [TypeORM Integration](https://alexanderc.github.io/nestjs-mtenant/typeorm)
- [Storage & Caching](https://alexanderc.github.io/nestjs-mtenant/storage)
- [Swagger Integration](https://alexanderc.github.io/nestjs-mtenant/api-decorator)
- [Advanced Usage](https://alexanderc.github.io/nestjs-mtenant/advanced-usage)
- [Migration Guide (v0.x to v1.0)](https://alexanderc.github.io/nestjs-mtenant/migration-guide)

## Test Coverage

```
Statements : 92.89% (471/507)
Branches   : 97.02% (196/202)
Functions  : 98.27% (114/116)
Lines      : 92.84% (467/503)
```

## Девелопмент

```sh
# Run tests
npm test

# Build
npm run build

# Release
npm run format
npm run release    # or: npm run patch | minor | major
npm run deploy
```

## Contributing

- [Alex Cucer](https://github.com/AlexanderC)

## License

MIT

nestjs-mtenant

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README