# @lomray/microservice-remote-middleware

> Microservice Remote Middleware lib

Latest version **1.9.0** (published 2025-09-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @lomray/microservice-remote-middleware
pnpm add @lomray/microservice-remote-middleware
yarn add @lomray/microservice-remote-middleware
bun add @lomray/microservice-remote-middleware
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.9.0 |
| Published | 2025-09-22 |
| First published | 2021-11-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 55.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mikhail Yarmaliuk |
| Maintainers | matthew_patell |
| Keywords | js, microservice, remote, middleware, control, gateway, typescript |

## Links

- npm: https://www.npmjs.com/package/@lomray/microservice-remote-middleware
- Repository: https://github.com/Lomray-Software/microservice-remote-middleware
- Issues: https://github.com/Lomray-Software/microservice-remote-middleware/issues
- npm.io page: https://npm.io/package/@lomray/microservice-remote-middleware

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [class-validator](https://npm.io/package/class-validator.md) ^0.14.0
- [class-validator-jsonschema](https://npm.io/package/class-validator-jsonschema.md) ^5.0.0
- [@lomray/microservice-nodejs-lib](https://npm.io/package/@lomray/microservice-nodejs-lib.md) ^3.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.9.0 (latest) — 2025-09-22
- 1.8.2 — 2023-07-28
- 1.8.1 — 2023-05-15
- 1.8.0 — 2023-03-16
- 1.7.6 — 2023-01-20
- 1.7.5 — 2022-11-30
- 1.7.4 — 2022-09-26
- 1.7.3 — 2022-09-25
- 1.7.2 — 2022-09-23
- 1.7.1 — 2022-08-09
- 1.7.0 — 2022-08-05
- 1.6.1 — 2022-05-30
- 1.6.0 — 2022-05-26
- 1.5.1 — 2022-04-04
- 1.5.0 — 2022-04-04
- … 8 more at https://npm.io/package/@lomray/microservice-remote-middleware/versions

## README

# NodeJS Microservice Remote Middleware lib for [Microservices lib](https://github.com/Lomray-Software/microservice-nodejs-lib)

![npm](https://img.shields.io/npm/v/@lomray/microservice-remote-middleware)
![GitHub](https://img.shields.io/github/license/Lomray-Software/microservice-remote-middleware)
![GitHub package.json dependency version (dev dep on branch)](https://img.shields.io/github/package-json/dependency-version/Lomray-Software/microservice-remote-middleware/dev/typescript/master)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Lomray-Software_microservice-remote-middleware&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Lomray-Software_microservice-remote-middleware)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Lomray-Software_microservice-remote-middleware&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=Lomray-Software_microservice-remote-middleware)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Lomray-Software_microservice-remote-middleware&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Lomray-Software_microservice-remote-middleware)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Lomray-Software_microservice-remote-middleware&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Lomray-Software_microservice-remote-middleware)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=Lomray-Software_microservice-remote-middleware&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=Lomray-Software_microservice-remote-middleware)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Lomray-Software_microservice-remote-middleware&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Lomray-Software_microservice-remote-middleware)

## Install
```bash
npm i --save @lomray/microservice-remote-middleware
```

## Usage

1. Create `server` remote middleware instance. It might be any microservice but only one.
```typescript
import { Microservice } from '@lomray/microservice-remote-middleware';
import { RemoteMiddlewareServer } from '@lomray/microservice-remote-middleware';
import { createConnection } from 'typeorm';

const microservice = Microservice.create({ name: 'configuration' });

// Add this endpoint for testing remote middleware
microservice.addEndpoint('example-method', ({ hello }) => ({ hello }));

const result = async () => {
  try {
    // In this case we are use TYPEORM  
    const connection = await createConnection();
    // Get Middleware repository for store middlewares data
    const repository = connection.getRepository(Middleware)

    // Enable remote middleware
    const remoteMiddleware = RemoteMiddlewareServer.create(microservice, repository)
      .addRegisterEndpoint()
      .addObtainEndpoint();

    /**
     * Add microservice method like remote middleware.
     * In future, you can create CRUD for this actions.
     * For example:
     */
    // 1. Create method for register like middleware: configuration.middleware-method
    microservice.addEndpoint('middleware-method', () => ({ hello: 'middleware world' }), {
      isDisableMiddlewares: true,
      isPrivate: true,
    });
    // 2. Register remote middleware on gateway microservice. This middleware will be triggered only for requests to any configuration methods.
    await remoteMiddleware.add(
      'configuration',
      'middleware-method',
      'gateway',
      'configuration.*',
    );

    await microservice.start();
  } catch (e) {
    console.info('\x1b[31m%s\x1b[0m', `Failed to start microservice: ${e.message as string}`);
  }
};

export default result();
```
2. Create `client` remote middleware instance. It might be any microservice.
```typescript
import { Gateway } from '@lomray/microservice-remote-middleware';
import { RemoteMiddlewareClient } from '@lomray/microservice-remote-middleware';

const microservice = Gateway.create({ name: 'gateway' });

const result = async () => {
  try {
    // Enable remote middleware
    await RemoteMiddlewareClient.create(microservice)
      .addRegisterEndpoint()
      .obtainMiddlewares();

    await microservice.start();
  } catch (e) {
    console.info('\x1b[31m%s\x1b[0m', `Failed to start microservice: ${e.message as string}`);
  }
};

export default result();
```
3. That is all. Check it:
```bash
curl -X POST http://127.0.0.1:3000
   -H 'Content-Type: application/json'
   -d '{"id":"unique-id-1","method":"configuration.example-method","params":{"hello":"world"}}'
```

## You can run any microservice and create remote middleware client. Check out the examples below to get the desired result:
```typescript
// Add remote middleware on any microservices methods (note: this is gateway microservice)
await remoteMiddleware.add(
  'configuration',
  'middleware-method',
  'gateway',
  '*',
);

// Add remote middleware on specific microservice method (note: this is gateway microservice)
await remoteMiddleware.add(
  'configuration',
  'middleware-method',
  'gateway',
  'users.list',
);

// Also you can add remote middleware directly to microservice
await remoteMiddleware.add(
  'configuration',
  'middleware-method',
  'users',
  'users.create',
);

// Just one more example :) Add authentication for requests (you should have authentication microservice)
await remoteMiddleware.add(
  'authentication',
  'middleware-authenticate',
  'gateway',
  '*',
);

// Or you can chose another middleware response strategy and convert input/output data
await remoteMiddleware.add(
  'authentication',
  'get-jwt',
  'gateway',
  '*',
  {
    type: MiddlewareType.response,
    strategy: MiddlewareStrategy.same,
    isRequired: true,
    convertResult: {
        // here we get user id from users microservice response and pass like param to 'get-jwt' method
        'user.id': 'userId'
    }
  }
);
```

---
_Source: https://npm.io/package/@lomray/microservice-remote-middleware · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._