nestjs-mtenant - GitLite

KO | EN

gitlite — search

#javascript #typescript #golang #machine-learning #rust #deep-learning #nodejs #macos #java #windows #cli #security #openai #open-source

nestjs-mtenant

(★ 150)

NestJS module to enable deep multitenancy support.

File Explorer

Download Latest Version (.zip)

- commit-msg
- pre-commit
- settings.json
- _config.yml
- advanced-usage.md
- api-decorator.md
- configuration.md
- getting-started.md
- index.md
- migration-guide.md
- sequelize.md
- storage.md
- typeorm.md
- - api.spec.ts
  - api.ts
  - constants.spec.ts
  - constants.ts
  - entity.spec.ts
  - entity.ts
- - decorator.error.spec.ts
  - decorator.error.ts
  - mtenant.error.spec.ts
  - mtenant.error.ts
- - core.interface.ts
  - module-async.options.ts
  - module-options.factory.ts
  - module.options.ts
  - storage.interface.ts
- - tenancy.middleware.spec.ts
  - tenancy.middleware.ts
- - tenant-base.repository.spec.ts
  - tenant-base.repository.ts
- - cached.storage.spec.ts
  - cached.storage.ts
  - sequelize.storage.spec.ts
  - sequelize.storage.ts
  - typeorm.storage.spec.ts
  - typeorm.storage.ts
- - tenant-entity.subscriber.spec.ts
  - tenant-entity.subscriber.ts
- - http.transport.spec.ts
  - http.transport.ts
  - transport.interface.ts
- constants.spec.ts
- constants.ts
- helpers.spec.ts
- helpers.ts
- index.ts
- mtenant.module.spec.ts
- mtenant.module.ts
- mtenant.service.spec.ts
- mtenant.service.ts
.commitlintrc.json
.eslintignore
.eslintrc.js
.gitignore
.npmignore
.prettierignore
.prettierrc
CHANGELOG.md
index.d.ts
index.js
index.ts
jest.config.js
LICENSE
package-lock.json
package.json
publish.sh
README.md
renovate.json
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/AlexanderC/nestjs-mtenant

Downloads the entire project code from GitHub to your computer.

cd nestjs-mtenant

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install nestjs-mtenant nestjs-cls

Downloads and installs the libraries listed in package.json.

npm install sequelize sequelize-typescript

Downloads and installs the libraries listed in package.json.

npm install typeorm

Downloads and installs the libraries listed in package.json.

npm test

Type this command into your terminal and run it.

npm run build

Builds optimized production files.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <a href="http://nestjs.com/" target="blank">
    <img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" />
  </a>
</p>

<p align="center">
  NestJS module for multi-tenancy with deep integration into Sequelize and TypeORM.
</p>

<p align="center">
  <a href="https://npmjs.com/package/nestjs-mtenant"><img src="https://img.shields.io/npm/v/nestjs-mtenant.svg" alt="NPM Version" /></a>
  <a href="https://npmjs.com/package/nestjs-mtenant"><img src="https://img.shields.io/npm/l/nestjs-mtenant.svg" alt="Package License" /></a>
  <a href="https://npmjs.com/package/nestjs-mtenant"><img src="https://img.shields.io/npm/dm/nestjs-mtenant.svg" alt="NPM Downloads" /></a>
</p>

## 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