node-tenancy/CHANGELOG.md

Making multi-tenancy easier with Node.js & typescript

# Changelog

## [1.2.4] - 2025-07-31

### Changed

- Updated dependencies to the latest versions:
    - mongodb: 6.15.0 → 6.18.0
    - mongoose: 8.10.1 → 8.17.0
    - redis: 4.7 → 5.6.1
    - sequelize: 6.37.6 → 6.37.7
    - sequelize-cli: 6.6.2 → 6.6.3
    - dotenv: 16.4.7 -> 17.2.1
    - commander: 13.1 -> 14.0
    - amqplib: 0.10.5 → 0.10.8

## [1.2.3] - 2025-05-19

### Added

- Pub-Sub example to `Elysia` project example.

### Enhancements

- Improving `typescript` return types from `QueueUtils`.

## [1.2.2] - 2025-05-11

### Added

- TypeScript support with type definitions (index.d.ts)
- Comprehensive JSDoc comments for better code documentation
- Adding some eslint code checkup and rules
- Bun project example using `Elysia`

### Changed

- Updated all dependencies to latest compatible versions

### Fixed

- Connection cleanup on errors
- Schema registration to avoid duplicates
- Central domain validation logic

## [1.2.1] - 2025-04-27

### Features

- Adding Redis support.

### Breaking Changes

- Queue connection env values must be `QUEUE_CONNECTION` & `QUEUE_TENANT_CONNECTION`
  instead of `RABBITMQ_CONNECTION` & `RABBITMQ_TENANT_CONNECTION`.

### Enhancements

- Improving `queue.connect(url = null, options = {})` method.
  but you can still use it as before.
- Adding GitHub actions for running `npm test`.
- Improve queue test cases.

```js
const {queue, config} = require('node-tenancy');

//old way
const connection = await queue.connect(queue.getConnectionUrl()); //old way
//new way
const connection = await queue.connect(); //new way
//new way with custom url connection
const connection = await queue.connect('redis://test:test@redis.test');
```

---

## [1.2.0] - 2025-04-16

### Features

- Adding sequelize support.
- Adding sequelize tenancy command lines for migrations.

### Enhancements

- Refactor some db driver class and mongo driver class methods.

---

## [1.1.0] - 2025-03-16

Adding jest tests and some code improvements to queue connection.

### Code Improvements

This is an example of how to use the queue class in v1.1.0 or later.

`app.js`

```js
const queueClass = require('queue');
queueClass.getMessages('support_test', true);
queueClass.publishMessage('support_test', {'message': 'test'}, true);
```

`queue.js`

```js
const {queue, config} = require('node-tenancy');

function setConnectionConfig(is_tenant_connection) {
  if (is_tenant_connection) {
    config.setConfig({
      'connection': 'tenant',
    });
  } else {
    config.setConfig({
      'connection': 'central',
    });
  }
}

async function getMessages(queue_name, is_tenant_connection = false) {
  setConnectionConfig(is_tenant_connection);

  const conn = await queue.connect(queue.getConnectionUrl());
  const channel = await conn.createChannel();

  await channel.assertQueue(queue_name);

  channel.consume(queue_name, async (msg) => {
    if (msg !== null) {
      console.log('Received:', msg.content.toString());
      channel.ack(msg);
    } else {
      console.log('Consumer cancelled by server');
    }
    await channel.close();
    await conn.close();
  });
}

async function publishMessage(queue_name, message, is_tenant_connection = false) {
  setConnectionConfig(is_tenant_connection);

  const conn = await queue.connect(queue.getConnectionUrl());
  const channel = await conn.createChannel();
  channel.sendToQueue(queue_name, Buffer.from(JSON.stringify(message)));
  setTimeout(function () {
    conn.close();
  }, 500);
}

module.exports = {getMessages, publishMessage};
```

---

## [1.0.4] - 2025-03-07

### File Structure

Changes to all project file structures and namings to match most
used naming conventions.

### Code Improvements

***It's recommended to upgrade to v1.1.0 because there were some connection
errors you might get with v1.0.4***

```js
const {queue} = require('node-tenancy');

queue.connect(queue.getConnectionUrl(), function (connectionErr, connection) {
  if (connectionErr) {
    console.log(connectionErr);
  }
  connection.createChannel(function (channelErr, channel) {
    if (channelErr) {
      console.log(channelErr);
    }

    const queue = 'test';

    channel.assertQueue(queue, {
      durable: true
    });

    channel.consume(queue, function (msg) {
      console.log(msg);
    });
  })
});
```