A package to implement multi-tenant apps in Node.js or TypeScript with ease. Inspired by Tenancy for Laravel

• Installing
• Usage
  • Env
  • Implementation
    • Middleware
    • Queue
    • Mongoose Usage
    • Sql Usage
  • TypeScript Support
  • Elysia Bun Project Example
  • Express Project Example
• CHANGELOG (for the latest updates and changes)

npm i node-tenancy

Here are some env variables to include in you .env file.

QUEUE_DRIVER=rabbitmq
DB_DRIVER=mongodb
DB_CONNECTION=mongodb://127.0.0.1:27017/database
RABBITMQ_CONNECTION=amqp://user:[email protected]

So we will provide some steps to begin your SaaS app with ease.

Middlewares configure database connections so a request can be executed for each tenant based on domains registered to each tenant.

• Tenancy Middleware should be used in tenancy tenantRoute.js.

const express = require('express');
const router = express.Router();
const tenancy = require('node-tenancy');

router.use(tenancy.initializeTenancyMiddleware);

router.get('/get', function (Request, Response) {
  return Response.status(200).json("Hello");
});

• Central Middleware should be used in tenancy centralRoutes.js.

const express = require('express');
const router = express.Router();
const tenancy = require('node-tenancy');

router.use(tenancy.initializeCentralMiddleware);

router.get('/get', function (Request, Response) {
  return Response.status(200).json({
    'tenant_id': tenancy.config.getConfig().tenant_id
  });
});

Check out Rabbitmq guide to know more.

Check out Redis guide to know more.

Please read Mongoose guide to know in detail mongoose implementation.

To make it more versatile, we have added sequelize, which supports multiple relational databases. Read more about it here Sequelize guide.

db_connection, db_name, db_options

In case you are using mongodb, we assume that domains are an array inside tenants collection

See Bun Example here

Tenancy now includes TypeScript type definitions. Example usage:

import {config, TenantSchema, db} from 'node-tenancy';
import {Schema} from 'mongoose';

// Define schemas with TypeScript types
interface User {
    username: string;
    email: string;
    active: boolean;
    createdAt: Date;
}

const userSchema = new Schema<User>({
    username: String,
    email: {type: String, required: true},
    active: {type: Boolean, default: true},
    createdAt: {type: Date, default: Date.now}
});

// Configure tenancy
config.setConfig({
    central_domains: ["admin.myapp.com"],
    tenant_schemas: {
        "User": userSchema
    },
    central_schemas: {
        "Tenant": TenantSchema
    }
});