@fetaoily/nest-mqtt 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 microud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,191 @@
+# Nest-MQTT
+
+## Description
+
+A MQTT module for Nest.js. Compatible with emqtt.
+
+## Installation
+
+> ⚠️ After version 0.2.0, `nest-mqtt` make a breaking change. User should add additional `mqtt` package manual.
+
+```bash
+$ npm install nest-mqtt mqtt --save
+```
+
+## Usage
+
+### Import
+
+Nest-mqtt will register as a global module.
+
+You can import with configuration
+
+```typescript
+// app.module.ts
+import { Module } from '@nestjs/common';
+import { MqttModule } from 'nest-mqtt';
+
+@Module({
+  imports: [MqttModule.forRoot(options)]
+})
+export class AppModule {}
+```
+
+or use async import method
+
+```typescript
+// app.module.ts
+import { Module } from '@nestjs/common';
+import { MqttModule } from 'nest-mqtt';
+
+@Module({
+  imports: [MqttModule.forRootAsync({
+    useFactory: () => options,
+  })]
+})
+export class AppModule {}
+```
+
+
+### Subscribe
+
+You can define any subscriber or consumer in any provider. For example,
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { Subscribe, Payload, Topic } from 'nest-mqtt';
+
+@Injectable()
+export class TestService {
+  @Subscribe('test')
+  test() {
+  
+  }
+  
+  @Subscribe({
+    topic: 'test2',
+    transform: payload => payload.toString(),
+  })
+  test2() {
+    
+  }
+}
+```
+
+Also, you can inject parameter with decorator:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { Subscribe, Payload } from 'nest-mqtt';
+
+@Injectable()
+export class TestService {
+  @Subscribe('test')
+  test(@Payload() payload) {
+    console.log(payload);
+  }
+}
+```
+
+Here are all supported parameter decorators:
+
+#### Payload(transform?: (payload) => any)
+
+Get the payload data of incoming message. You can pass in a transform function for converting.
+
+#### Topic()
+
+Get the topic of incoming message.
+
+#### Packet()
+
+Get the raw packet of incoming message.
+
+#### Params()
+
+Get the wildcard part of topic. It will return an array of string which extract from topic. For example:
+
+When subscribe the topic "test/+/test/+" and incoming topic is "test/1/test/2", you will get the array `["1", "2"]`. 
+
+### Publish
+
+Nest-mqtt wrap some functions with `Promise` and provide a provider.
+
+```typescript
+import { Inject, Injectable } from '@nestjs/common';
+import { MqttService } from 'nest-mqtt';
+
+@Injectable()
+export class TestService {
+  constructor(
+    @Inject(MqttService) private readonly mqttService: MqttService,
+  ) {}
+
+  async testPublish() {
+    this.mqttService.publish('topic', {
+      foo: 'bar'
+    });
+  }
+
+}
+```
+
+## Emqtt Compatible
+
+nest-mqtt support emq shared subscription
+
+- Global mode
+
+Module options support queue and share property for globally converting all topic to shared topic except configured in subscription options.
+
+```typescript
+// app.module.ts
+import { Module } from '@nestjs/common';
+import { MqttModule } from 'nest-mqtt';
+
+@Module({
+  imports: [MqttModule.forRoot({
+    host: '127.0.0.1',
+    queue: true,
+    share: 'group1'
+  })]
+})
+export class AppModule {}
+```
+
+- Configure in Subscribe
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { Subscribe, Payload, Topic } from 'nest-mqtt';
+
+@Injectable()
+export class TestService {
+  @Subscribe('test')
+  test() {
+  
+  }
+  
+  @Subscribe({
+    topic: 'test2',
+    queue: true,
+  })
+  test2() {
+    
+  }
+}
+```
+
+The priority of subscribe is higher than the global mode. If you want to specify a topic do not use the shared mode, set it as false in subscribe decorator. 
+
+## Support
+
+Nest-mqtt is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [microud](https://xknow.net)
+
+## License
+
+nest-mqtt is [MIT licensed](LICENSE).

package/dist/client.provider.d.ts

@@ -0,0 +1,2 @@
+import { Provider } from '@nestjs/common';
+export declare function createClientProvider(): Provider;

package/dist/client.provider.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClientProvider = void 0;
+const mqtt_1 = require("mqtt");
+const mqtt_constants_1 = require("./mqtt.constants");
+function createClientProvider() {
+    return {
+        provide: mqtt_constants_1.MQTT_CLIENT_INSTANCE,
+        useFactory: (options, logger) => {
+            const client = (0, mqtt_1.connect)(options);
+            client.on('connect', () => {
+                logger.log('MQTT connected');
+            });
+            client.on('disconnect', packet => {
+                logger.log('MQTT disconnected');
+            });
+            client.on('error', error => {
+                this.logger.log(`MQTT error: ${error.message}`);
+            });
+            client.on('reconnect', () => {
+                logger.log('MQTT reconnecting');
+            });
+            client.on('close', () => {
+                logger.log(`MQTT closed`);
+            });
+            client.on('offline', () => {
+                logger.log('MQTT offline');
+            });
+            return client;
+        },
+        inject: [mqtt_constants_1.MQTT_OPTION_PROVIDER, mqtt_constants_1.MQTT_LOGGER_PROVIDER],
+    };
+}
+exports.createClientProvider = createClientProvider;
+//# sourceMappingURL=client.provider.js.map

package/dist/client.provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.provider.js","sourceRoot":"","sources":["../src/client.provider.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,qDAAoG;AAEpG,SAAgB,oBAAoB;IAClC,OAAO;QACL,OAAO,EAAE,qCAAoB;QAC7B,UAAU,EAAE,CAAC,OAA0B,EAAE,MAAc,EAAE,EAAE;YACzD,MAAM,MAAM,GAAG,IAAA,cAAO,EAAC,OAAO,CAAC,CAAC;YAEhC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;gBACxB,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE;gBAC/B,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;gBACzB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;gBAC1B,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACtB,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;gBACxB,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,CAAC,qCAAoB,EAAE,qCAAoB,CAAC;KACrD,CAAC;AACJ,CAAC;AAlCD,oDAkCC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './mqtt.interface';
+export * from './mqtt.decorator';
+export * from './mqtt.constants';
+export * from './mqtt.module';
+export * from './mqtt.service';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./mqtt.interface"), exports);
+__exportStar(require("./mqtt.decorator"), exports);
+__exportStar(require("./mqtt.constants"), exports);
+__exportStar(require("./mqtt.module"), exports);
+__exportStar(require("./mqtt.service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,gDAA8B;AAC9B,iDAA+B"}

package/dist/mqtt.constants.d.ts

@@ -0,0 +1,5 @@
+export declare const MQTT_SUBSCRIBE_OPTIONS = "__mqtt_subscribe_options";
+export declare const MQTT_SUBSCRIBER_PARAMS = "__mqtt_subscriber_params";
+export declare const MQTT_CLIENT_INSTANCE = "MQTT_CLIENT_INSTANCE";
+export declare const MQTT_OPTION_PROVIDER = "MQTT_OPTION_PROVIDER";
+export declare const MQTT_LOGGER_PROVIDER = "MQTT_LOGGER_PROVIDER";

package/dist/mqtt.constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MQTT_LOGGER_PROVIDER = exports.MQTT_OPTION_PROVIDER = exports.MQTT_CLIENT_INSTANCE = exports.MQTT_SUBSCRIBER_PARAMS = exports.MQTT_SUBSCRIBE_OPTIONS = void 0;
+exports.MQTT_SUBSCRIBE_OPTIONS = '__mqtt_subscribe_options';
+exports.MQTT_SUBSCRIBER_PARAMS = '__mqtt_subscriber_params';
+exports.MQTT_CLIENT_INSTANCE = 'MQTT_CLIENT_INSTANCE';
+exports.MQTT_OPTION_PROVIDER = 'MQTT_OPTION_PROVIDER';
+exports.MQTT_LOGGER_PROVIDER = 'MQTT_LOGGER_PROVIDER';
+//# sourceMappingURL=mqtt.constants.js.map

package/dist/mqtt.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.constants.js","sourceRoot":"","sources":["../src/mqtt.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG,0BAA0B,CAAC;AACpD,QAAA,sBAAsB,GAAG,0BAA0B,CAAC;AACpD,QAAA,oBAAoB,GAAG,sBAAsB,CAAC;AAC9C,QAAA,oBAAoB,GAAG,sBAAsB,CAAC;AAC9C,QAAA,oBAAoB,GAAG,sBAAsB,CAAC"}

package/dist/mqtt.decorator.d.ts

@@ -0,0 +1,7 @@
+import { CustomDecorator } from '@nestjs/common';
+import { MqttMessageTransformer, MqttSubscribeOptions } from './mqtt.interface';
+export declare function Subscribe(topic: string | string[] | MqttSubscribeOptions): CustomDecorator;
+export declare function Topic(): (target: object, propertyKey: string | symbol, paramIndex: number) => void;
+export declare function Packet(): (target: object, propertyKey: string | symbol, paramIndex: number) => void;
+export declare function Payload(transform?: 'json' | 'text' | MqttMessageTransformer): (target: object, propertyKey: string | symbol, paramIndex: number) => void;
+export declare function Params(): (target: object, propertyKey: string | symbol, paramIndex: number) => void;

package/dist/mqtt.decorator.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Params = exports.Payload = exports.Packet = exports.Topic = exports.Subscribe = void 0;
+const common_1 = require("@nestjs/common");
+const mqtt_constants_1 = require("./mqtt.constants");
+function Subscribe(topicOrOptions) {
+    if (typeof topicOrOptions === 'string' || Array.isArray(topicOrOptions)) {
+        return (0, common_1.SetMetadata)(mqtt_constants_1.MQTT_SUBSCRIBE_OPTIONS, {
+            topic: topicOrOptions,
+        });
+    }
+    else {
+        return (0, common_1.SetMetadata)(mqtt_constants_1.MQTT_SUBSCRIBE_OPTIONS, topicOrOptions);
+    }
+}
+exports.Subscribe = Subscribe;
+function SetParameter(parameter) {
+    return (target, propertyKey, paramIndex) => {
+        const params = Reflect.getMetadata(mqtt_constants_1.MQTT_SUBSCRIBER_PARAMS, target[propertyKey]) || [];
+        params.push(Object.assign({ index: paramIndex }, parameter));
+        Reflect.defineMetadata(mqtt_constants_1.MQTT_SUBSCRIBER_PARAMS, params, target[propertyKey]);
+    };
+}
+function Topic() {
+    return SetParameter({
+        type: 'topic',
+    });
+}
+exports.Topic = Topic;
+function Packet() {
+    return SetParameter({
+        type: 'packet',
+    });
+}
+exports.Packet = Packet;
+function Payload(transform) {
+    return SetParameter({
+        type: 'payload',
+        transform,
+    });
+}
+exports.Payload = Payload;
+function Params() {
+    return SetParameter({
+        type: 'params',
+    });
+}
+exports.Params = Params;
+//# sourceMappingURL=mqtt.decorator.js.map

package/dist/mqtt.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.decorator.js","sourceRoot":"","sources":["../src/mqtt.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA8D;AAC9D,qDAAkF;AAIlF,SAAgB,SAAS,CAAC,cAAc;IACtC,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QACvE,OAAO,IAAA,oBAAW,EAAC,uCAAsB,EAAE;YACzC,KAAK,EAAE,cAAc;SACtB,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,IAAA,oBAAW,EAAC,uCAAsB,EAAE,cAAc,CAAC,CAAC;KAC5D;AACH,CAAC;AARD,8BAQC;AAED,SAAS,YAAY,CAAC,SAA2C;IAC/D,OAAO,CAAC,MAAc,EAAE,WAA4B,EAAE,UAAkB,EAAE,EAAE;QAC1E,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,uCAAsB,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC;QACtF,MAAM,CAAC,IAAI,iBACT,KAAK,EAAE,UAAU,IACd,SAAS,EACZ,CAAC;QACH,OAAO,CAAC,cAAc,CAAC,uCAAsB,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC;AACJ,CAAC;AAMD,SAAgB,KAAK;IACnB,OAAO,YAAY,CAAC;QAClB,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;AACL,CAAC;AAJD,sBAIC;AAMD,SAAgB,MAAM;IACpB,OAAO,YAAY,CAAC;QAClB,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;AACL,CAAC;AAJD,wBAIC;AAOD,SAAgB,OAAO,CAAC,SAAoD;IAC1E,OAAO,YAAY,CAAC;QAClB,IAAI,EAAE,SAAS;QACf,SAAS;KACV,CAAC,CAAC;AACL,CAAC;AALD,0BAKC;AAOD,SAAgB,MAAM;IACpB,OAAO,YAAY,CAAC;QAClB,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;AACL,CAAC;AAJD,wBAIC"}

package/dist/mqtt.explorer.d.ts

@@ -0,0 +1,21 @@
+import { Logger, OnModuleInit } from '@nestjs/common';
+import { DiscoveryService, MetadataScanner } from '@nestjs/core';
+import { MqttClient } from 'mqtt';
+import { MqttModuleOptions, MqttSubscribeOptions, MqttSubscriber, MqttSubscriberParameter } from './mqtt.interface';
+export declare class MqttExplorer implements OnModuleInit {
+    private readonly discoveryService;
+    private readonly metadataScanner;
+    private readonly logger;
+    private readonly client;
+    private readonly options;
+    private readonly reflector;
+    subscribers: MqttSubscriber[];
+    constructor(discoveryService: DiscoveryService, metadataScanner: MetadataScanner, logger: Logger, client: MqttClient, options: MqttModuleOptions);
+    onModuleInit(): void;
+    preprocess(options: MqttSubscribeOptions): string | string[];
+    subscribe(options: MqttSubscribeOptions, parameters: MqttSubscriberParameter[], handle: any, provider: any): void;
+    explore(): void;
+    private getSubscriber;
+    private static topicToRegexp;
+    private static matchGroups;
+}

package/dist/mqtt.explorer.js

@@ -0,0 +1,176 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var MqttExplorer_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MqttExplorer = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const mqtt_constants_1 = require("./mqtt.constants");
+const mqtt_1 = require("mqtt");
+const mqtt_transform_1 = require("./mqtt.transform");
+let MqttExplorer = MqttExplorer_1 = class MqttExplorer {
+    constructor(discoveryService, metadataScanner, logger, client, options) {
+        this.discoveryService = discoveryService;
+        this.metadataScanner = metadataScanner;
+        this.logger = logger;
+        this.client = client;
+        this.options = options;
+        this.reflector = new core_1.Reflector();
+        this.subscribers = [];
+    }
+    onModuleInit() {
+        this.logger.log('MqttModule dependencies initialized');
+        this.explore();
+    }
+    preprocess(options) {
+        const processTopic = (topic) => {
+            const queue = typeof options.queue === 'boolean' ? options.queue : this.options.queue;
+            const share = typeof options.share === 'string' ? options.share : this.options.share;
+            topic = topic.replace('$queue/', '')
+                .replace(/^\$share\/([A-Za-z0-9]+)\//, '');
+            if (queue) {
+                return `$queue/${topic}`;
+            }
+            if (share) {
+                return `$share/${share}/${topic}`;
+            }
+            return topic;
+        };
+        if (Array.isArray(options.topic)) {
+            return options.topic.map(processTopic);
+        }
+        else {
+            return processTopic(options.topic);
+        }
+    }
+    subscribe(options, parameters, handle, provider) {
+        const rawOpts = options.rawOpts;
+        this.client.subscribe(this.preprocess(options), rawOpts, err => {
+            if (!err) {
+                (Array.isArray(options.topic) ? options.topic : [options.topic])
+                    .forEach(topic => {
+                    this.subscribers.push({
+                        topic,
+                        route: topic.replace('$queue/', '').replace(/^\$share\/([A-Za-z0-9]+)\//, ''),
+                        regexp: MqttExplorer_1.topicToRegexp(topic),
+                        provider,
+                        handle,
+                        options,
+                        parameters,
+                    });
+                });
+            }
+            else {
+                this.logger.error(`subscribe topic [${options.topic} failed]`);
+            }
+        });
+    }
+    explore() {
+        const providers = this.discoveryService.getProviders();
+        providers.forEach((wrapper) => {
+            const { instance } = wrapper;
+            if (!instance) {
+                return;
+            }
+            this.metadataScanner.scanFromPrototype(instance, Object.getPrototypeOf(instance), key => {
+                const subscribeOptions = this.reflector.get(mqtt_constants_1.MQTT_SUBSCRIBE_OPTIONS, instance[key]);
+                const parameters = this.reflector.get(mqtt_constants_1.MQTT_SUBSCRIBER_PARAMS, instance[key]);
+                if (subscribeOptions) {
+                    this.subscribe(subscribeOptions, parameters, instance[key], instance);
+                }
+            });
+        });
+        this.client.on('message', (topic, payload, packet) => {
+            const subscriber = this.getSubscriber(topic);
+            if (subscriber) {
+                const parameters = subscriber.parameters || [];
+                const scatterParameters = [];
+                for (const parameter of parameters) {
+                    scatterParameters[parameter.index] = parameter;
+                }
+                try {
+                    const transform = (0, mqtt_transform_1.getTransform)(subscriber.options.transform);
+                    if (this.options.beforeHandle) {
+                        this.options.beforeHandle(topic, payload, packet);
+                    }
+                    subscriber.handle.bind(subscriber.provider)(...scatterParameters.map(parameter => {
+                        switch (parameter === null || parameter === void 0 ? void 0 : parameter.type) {
+                            case 'payload':
+                                return transform(payload);
+                            case 'topic':
+                                return topic;
+                            case 'packet':
+                                return packet;
+                            case 'params':
+                                return MqttExplorer_1.matchGroups(topic, subscriber.regexp);
+                            default:
+                                return null;
+                        }
+                    }));
+                }
+                catch (err) {
+                    this.logger.error(err);
+                }
+            }
+        });
+    }
+    getSubscriber(topic) {
+        for (const subscriber of this.subscribers) {
+            subscriber.regexp.lastIndex = 0;
+            if (subscriber.regexp.test(topic)) {
+                return subscriber;
+            }
+        }
+        return null;
+    }
+    static topicToRegexp(topic) {
+        return new RegExp('^' +
+            topic
+                .replace('$queue/', '')
+                .replace(/^\$share\/([A-Za-z0-9]+)\//, '')
+                .replace(/([\[\]\?\(\)\\\\$\^\*\.|])/g, '\\$1')
+                .replace(/\+/g, '([^/]+)')
+                .replace(/\/#$/, '(/.*)?') +
+            '$', 'y');
+    }
+    static matchGroups(str, regex) {
+        regex.lastIndex = 0;
+        let m = regex.exec(str);
+        const matches = [];
+        while (m !== null) {
+            if (m.index === regex.lastIndex) {
+                regex.lastIndex++;
+            }
+            m.forEach((match, groupIndex) => {
+                if (groupIndex !== 0) {
+                    matches.push(match);
+                }
+            });
+            m = regex.exec(str);
+        }
+        return matches;
+    }
+};
+exports.MqttExplorer = MqttExplorer;
+exports.MqttExplorer = MqttExplorer = MqttExplorer_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(2, (0, common_1.Inject)(mqtt_constants_1.MQTT_LOGGER_PROVIDER)),
+    __param(3, (0, common_1.Inject)(mqtt_constants_1.MQTT_CLIENT_INSTANCE)),
+    __param(4, (0, common_1.Inject)(mqtt_constants_1.MQTT_OPTION_PROVIDER)),
+    __metadata("design:paramtypes", [core_1.DiscoveryService,
+        core_1.MetadataScanner,
+        common_1.Logger,
+        mqtt_1.MqttClient, Object])
+], MqttExplorer);
+//# sourceMappingURL=mqtt.explorer.js.map

package/dist/mqtt.explorer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.explorer.js","sourceRoot":"","sources":["../src/mqtt.explorer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwE;AACxE,uCAA0E;AAE1E,qDAM0B;AAC1B,+BAAgC;AAEhC,qDAA8C;AAIvC,IAAM,YAAY,oBAAlB,MAAM,YAAY;IAIvB,YACmB,gBAAkC,EAClC,eAAgC,EACnB,MAA+B,EAC/B,MAAmC,EACnC,OAA2C;QAJxD,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,oBAAe,GAAf,eAAe,CAAiB;QACF,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAAY;QAClB,YAAO,GAAP,OAAO,CAAmB;QAR1D,cAAS,GAAG,IAAI,gBAAS,EAAE,CAAC;QAU3C,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,UAAU,CAAC,OAA6B;QACtC,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,EAAE;YAC7B,MAAM,KAAK,GAAG,OAAO,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACtF,MAAM,KAAK,GAAG,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACrF,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;iBACjC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;YAC7C,IAAI,KAAK,EAAE;gBACT,OAAO,UAAU,KAAK,EAAE,CAAC;aAC1B;YAED,IAAI,KAAK,EAAE;gBACT,OAAO,UAAU,KAAK,IAAI,KAAK,EAAE,CAAC;aACnC;YAED,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChC,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;SACxC;aAAM;YAEL,OAAO,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACpC;IACH,CAAC;IAED,SAAS,CAAC,OAA6B,EAAE,UAAqC,EAAE,MAAM,EAAE,QAAQ;QAC9F,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE;YAC7D,IAAI,CAAC,GAAG,EAAE;gBAER,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;qBAC7D,OAAO,CAAC,KAAK,CAAC,EAAE;oBACf,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;wBACpB,KAAK;wBACL,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC;wBAC7E,MAAM,EAAE,cAAY,CAAC,aAAa,CAAC,KAAK,CAAC;wBACzC,QAAQ;wBACR,MAAM;wBACN,OAAO;wBACP,UAAU;qBACX,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;aACN;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,oBAAoB,OAAO,CAAC,KAAK,UAAU,CAC5C,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,MAAM,SAAS,GAAsB,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QAC1E,SAAS,CAAC,OAAO,CAAC,CAAC,OAAwB,EAAE,EAAE;YAC7C,MAAM,EAAC,QAAQ,EAAC,GAAG,OAAO,CAAC;YAC3B,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAO;aACR;YACD,IAAI,CAAC,eAAe,CAAC,iBAAiB,CACpC,QAAQ,EACR,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,EAC/B,GAAG,CAAC,EAAE;gBACJ,MAAM,gBAAgB,GAAyB,IAAI,CAAC,SAAS,CAAC,GAAG,CAC/D,uCAAsB,EACtB,QAAQ,CAAC,GAAG,CAAC,CACd,CAAC;gBACF,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CACnC,uCAAsB,EACtB,QAAQ,CAAC,GAAG,CAAC,CACd,CAAC;gBACF,IAAI,gBAAgB,EAAE;oBACpB,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;iBACvE;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CACZ,SAAS,EACT,CAAC,KAAa,EAAE,OAAe,EAAE,MAAc,EAAE,EAAE;YACjD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC7C,IAAI,UAAU,EAAE;gBACd,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;gBAC/C,MAAM,iBAAiB,GAA8B,EAAE,CAAC;gBACxD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;oBAClC,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;iBAChD;gBACD,IAAI;oBACF,MAAM,SAAS,GAAG,IAAA,6BAAY,EAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;oBAG7D,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;wBAC7B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;qBACnD;oBAED,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CACzC,GAAG,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;wBACnC,QAAQ,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,EAAE;4BACvB,KAAK,SAAS;gCACZ,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;4BAC5B,KAAK,OAAO;gCACV,OAAO,KAAK,CAAC;4BACf,KAAK,QAAQ;gCACX,OAAO,MAAM,CAAC;4BAChB,KAAK,QAAQ;gCACX,OAAO,cAAY,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;4BAC5D;gCACE,OAAO,IAAI,CAAC;yBACf;oBACH,CAAC,CAAC,CACH,CAAC;iBACH;gBAAC,OAAO,GAAG,EAAE;oBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACxB;aACF;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,aAAa,CAAC,KAAa;QACjC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,UAAU,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC;YAChC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBACjC,OAAO,UAAU,CAAC;aACnB;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,KAAa;QAExC,OAAO,IAAI,MAAM,CACf,GAAG;YACH,KAAK;iBACF,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;iBACtB,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC;iBACzC,OAAO,CAAC,6BAA6B,EAAE,MAAM,CAAC;iBAC9C,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC;iBACzB,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC;YAC5B,GAAG,EACH,GAAG,CACJ,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,KAAa;QACnD,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,OAAO,CAAC,KAAK,IAAI,EAAE;YAEjB,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,SAAS,EAAE;gBAC/B,KAAK,CAAC,SAAS,EAAE,CAAC;aACnB;YAGD,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC9B,IAAI,UAAU,KAAK,CAAC,EAAE;oBACpB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACrB;YACH,CAAC,CAAC,CAAC;YACH,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACrB;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAA;AArLY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,mBAAU,GAAE;IAQR,WAAA,IAAA,eAAM,EAAC,qCAAoB,CAAC,CAAA;IAC5B,WAAA,IAAA,eAAM,EAAC,qCAAoB,CAAC,CAAA;IAC5B,WAAA,IAAA,eAAM,EAAC,qCAAoB,CAAC,CAAA;qCAJM,uBAAgB;QACjB,sBAAe;QACM,eAAM;QACN,iBAAU;GARxD,YAAY,CAqLxB"}

package/dist/mqtt.interface.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+import { IClientOptions, Packet } from 'mqtt';
+import { LoggerService, Type } from '@nestjs/common';
+import { ModuleMetadata } from '@nestjs/common/interfaces';
+import { IClientSubscribeOptions, IClientSubscribeProperties } from 'mqtt/src/lib/client';
+export type MqttMessageTransformer = (payload: Buffer) => any;
+export type LoggerConstructor = new (...params: any[]) => LoggerService;
+export interface MqttSubscribeOptions {
+    topic: string | string[];
+    queue?: boolean;
+    share?: string;
+    rawOpts?: IClientSubscribeOptions | IClientSubscribeProperties;
+    transform?: 'json' | 'text' | MqttMessageTransformer;
+}
+export interface MqttSubscriberParameter {
+    index: number;
+    type: 'payload' | 'topic' | 'packet' | 'params';
+    transform?: 'json' | 'text' | MqttMessageTransformer;
+}
+export interface MqttSubscriber {
+    topic: string;
+    handle: any;
+    route: string;
+    provider: any;
+    regexp: RegExp;
+    options: MqttSubscribeOptions;
+    parameters: MqttSubscriberParameter[];
+}
+export interface MqttLoggerOptions {
+    useValue?: LoggerService;
+    useClass?: Type<LoggerService>;
+}
+export interface MqttModuleOptions extends IClientOptions {
+    queue?: boolean;
+    share?: string;
+    logger?: MqttLoggerOptions;
+    beforeHandle?: (topic: string, payload: Buffer, packet: Packet) => any;
+}
+export interface MqttOptionsFactory {
+    createMqttConnectOptions(): Promise<MqttModuleOptions> | MqttModuleOptions;
+}
+export interface MqttModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    inject?: any[];
+    useExisting?: Type<MqttOptionsFactory>;
+    useClass?: Type<MqttOptionsFactory>;
+    useFactory?: (...args: any[]) => Promise<MqttModuleOptions> | MqttModuleOptions;
+    logger?: MqttLoggerOptions;
+}

package/dist/mqtt.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mqtt.interface.js.map

package/dist/mqtt.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqtt.interface.js","sourceRoot":"","sources":["../src/mqtt.interface.ts"],"names":[],"mappings":""}

package/dist/mqtt.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from '@nestjs/common';
+import { MqttModuleAsyncOptions, MqttModuleOptions } from './mqtt.interface';
+export declare class MqttModule {
+    static forRootAsync(options: MqttModuleAsyncOptions): DynamicModule;
+    static forRoot(options: MqttModuleOptions): DynamicModule;
+}