@midwayjs/mqtt 3.14.12

package/README.md

@@ -0,0 +1,12 @@
+# midway framework for mqtt
+
+[![Package Quality](http://npm.packagequality.com/shield/midway-web.svg)](http://packagequality.com/#?package=midway-web)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/midwayjs/midway/pulls)
+
+this is a sub package for midway.
+
+Document: [https://midwayjs.org](https://midwayjs.org)
+
+## License
+
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/configuration.d.ts

@@ -0,0 +1,7 @@
+import { IMidwayContainer } from '@midwayjs/core';
+import { MidwayMQTTFramework } from './framework';
+export declare class MQTTConfiguration {
+    framework: MidwayMQTTFramework;
+    onReady(container: IMidwayContainer): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,49 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MQTTConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
+const framework_1 = require("./framework");
+const service_1 = require("./service");
+let MQTTConfiguration = class MQTTConfiguration {
+    async onReady(container) {
+        await container.getAsync(service_1.MqttProducerFactory);
+    }
+};
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", framework_1.MidwayMQTTFramework)
+], MQTTConfiguration.prototype, "framework", void 0);
+MQTTConfiguration = __decorate([
+    (0, core_1.Configuration)({
+        namespace: 'mqtt',
+        importConfigs: [
+            {
+                default: {
+                    mqtt: {
+                        pub: {},
+                        sub: {},
+                        contextLoggerApplyLogger: 'mqttLogger',
+                    },
+                    midwayLogger: {
+                        clients: {
+                            mqttLogger: {
+                                fileLogName: 'midway-mqtt.log',
+                            },
+                        },
+                    },
+                },
+            },
+        ],
+    })
+], MQTTConfiguration);
+exports.MQTTConfiguration = MQTTConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/decorator.d.ts

@@ -0,0 +1,3 @@
+export declare const MQTT_DECORATOR_KEY = "rpc:mqtt";
+export declare function MqttSubscriber(subscriberName: string): ClassDecorator;
+//# sourceMappingURL=decorator.d.ts.map

package/dist/decorator.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MqttSubscriber = exports.MQTT_DECORATOR_KEY = void 0;
+const core_1 = require("@midwayjs/core");
+exports.MQTT_DECORATOR_KEY = 'rpc:mqtt';
+function MqttSubscriber(subscriberName) {
+    return target => {
+        (0, core_1.saveModule)(exports.MQTT_DECORATOR_KEY, target);
+        (0, core_1.saveClassMetadata)(exports.MQTT_DECORATOR_KEY, subscriberName, target);
+        (0, core_1.Scope)(core_1.ScopeEnum.Request)(target);
+        (0, core_1.Provide)()(target);
+    };
+}
+exports.MqttSubscriber = MqttSubscriber;
+//# sourceMappingURL=decorator.js.map

package/dist/framework.d.ts

@@ -0,0 +1,15 @@
+import { BaseFramework } from '@midwayjs/core';
+import { IMidwayMQTTApplication, IMidwayMQTTConfigurationOptions, IMidwayMQTTContext } from './interface';
+import { IClientOptions, MqttClient } from 'mqtt';
+export declare class MidwayMQTTFramework extends BaseFramework<IMidwayMQTTApplication, IMidwayMQTTContext, IMidwayMQTTConfigurationOptions> {
+    app: IMidwayMQTTApplication;
+    protected subscriberMap: Map<string, MqttClient>;
+    mqttLogger: any;
+    configure(): any;
+    applicationInitialize(options: any): Promise<void>;
+    run(): Promise<void>;
+    protected beforeStop(): Promise<void>;
+    createSubscriber(connectionOptions: IClientOptions, clientName?: string): Promise<MqttClient>;
+    getFrameworkName(): string;
+}
+//# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -0,0 +1,88 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MidwayMQTTFramework = void 0;
+const core_1 = require("@midwayjs/core");
+const mqtt_1 = require("mqtt");
+const decorator_1 = require("./decorator");
+let MidwayMQTTFramework = class MidwayMQTTFramework extends core_1.BaseFramework {
+    constructor() {
+        super(...arguments);
+        this.subscriberMap = new Map();
+    }
+    configure() {
+        return this.configService.getConfiguration('mqtt');
+    }
+    async applicationInitialize(options) {
+        const { sub } = this.configurationOptions;
+        if (Object.keys(sub || {}).length === 0) {
+            this.mqttLogger.info('[midway-mqtt] Not found consumer config, skip init consumer');
+        }
+        // find subscriber
+        const mqttSubscriberModules = (0, core_1.listModule)(decorator_1.MQTT_DECORATOR_KEY);
+        const mqttSubscriberMap = {};
+        for (const subscriberModule of mqttSubscriberModules) {
+            const subscriberName = (0, core_1.getClassMetadata)(decorator_1.MQTT_DECORATOR_KEY, subscriberModule);
+            mqttSubscriberMap[subscriberName] = subscriberModule;
+        }
+        for (const customKey in sub) {
+            const consumer = await this.createSubscriber(sub[customKey].connectOptions);
+            consumer.subscribe(sub[customKey].subscribeOptions.topicObject, sub[customKey].subscribeOptions.opts, async (err, granted) => {
+                const ctx = this.app.createAnonymousContext();
+                ctx.packet = granted;
+                if (err) {
+                    const result = await this.filterManager.runErrorFilter(err, ctx);
+                    if (result.error) {
+                        this.mqttLogger.error(err);
+                    }
+                }
+                else {
+                    const fn = await this.applyMiddleware(async (ctx) => {
+                        const instance = await ctx.requestContext.getAsync(mqttSubscriberMap[customKey]);
+                        // eslint-disable-next-line prefer-spread
+                        return await instance['subscribe'].call(instance, ctx);
+                    });
+                    return await fn(ctx);
+                }
+            });
+        }
+        this.app = {};
+    }
+    async run() { }
+    async beforeStop() {
+        for (const [name, consumer] of this.subscriberMap) {
+            await consumer.endAsync();
+            this.mqttLogger.info(`[midway-mqtt] subscriber: ${name} is closed`);
+        }
+    }
+    async createSubscriber(connectionOptions, clientName) {
+        const client = await (0, mqtt_1.connectAsync)(connectionOptions);
+        client.on('error', err => {
+            this.mqttLogger.error(err);
+        });
+        if (clientName) {
+            this.subscriberMap.set(clientName, client);
+        }
+        return client;
+    }
+    getFrameworkName() {
+        return 'midway:mqtt';
+    }
+};
+__decorate([
+    (0, core_1.Logger)('mqttLogger'),
+    __metadata("design:type", Object)
+], MidwayMQTTFramework.prototype, "mqttLogger", void 0);
+MidwayMQTTFramework = __decorate([
+    (0, core_1.Framework)()
+], MidwayMQTTFramework);
+exports.MidwayMQTTFramework = MidwayMQTTFramework;
+//# sourceMappingURL=framework.js.map

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './interface';
+export { MidwayMQTTFramework as Framework } from './framework';
+export { MQTTConfiguration as Configuration } from './configuration';
+export * from './decorator';
+export * from './service';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,25 @@
+"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 });
+exports.Configuration = exports.Framework = void 0;
+__exportStar(require("./interface"), exports);
+var framework_1 = require("./framework");
+Object.defineProperty(exports, "Framework", { enumerable: true, get: function () { return framework_1.MidwayMQTTFramework; } });
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.MQTTConfiguration; } });
+__exportStar(require("./decorator"), exports);
+__exportStar(require("./service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -0,0 +1,24 @@
+import { IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction, ServiceFactoryConfigOption } from '@midwayjs/core';
+import type { IClientOptions, IClientSubscribeOptions, IClientSubscribeProperties, ISubscriptionMap, ISubscriptionGrant } from 'mqtt';
+export interface MqttSubscriberOptions {
+    topicObject: string | string[] | ISubscriptionMap;
+    opts?: IClientSubscribeOptions | IClientSubscribeProperties;
+}
+export type IMidwayMQTTApplication = IMidwayApplication<IMidwayMQTTContext>;
+export interface IMidwayMQTTConfigurationOptions extends IConfigurationOptions {
+    sub: {
+        [name: string]: Partial<{
+            connectOptions: Partial<IClientOptions>;
+            subscribeOptions: MqttSubscriberOptions;
+        }>;
+    };
+    pub: ServiceFactoryConfigOption<IClientOptions>;
+}
+export type IMidwayMQTTContext = IMidwayContext<{
+    packet: ISubscriptionGrant[];
+}>;
+export type Application = IMidwayMQTTApplication;
+export interface Context extends IMidwayMQTTContext {
+}
+export type NextFunction = BaseNextFunction;
+//# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

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

package/dist/mq.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This RabbitMQ Server changed from https://github.com/JeniTurtle/egg-rabbitmq-plus/blob/master/rabbitmq.ts
+ */
+/// <reference types="node" />
+import * as amqp from 'amqp-connection-manager';
+import { IRabbitMQApplication } from './interface';
+import { ConsumeMessage } from 'amqplib/properties';
+import { RabbitMQListenerOptions, ILogger } from '@midwayjs/core';
+import type { Channel } from 'amqplib';
+import { EventEmitter } from 'events';
+export declare class RabbitMQServer extends EventEmitter implements IRabbitMQApplication {
+    protected channelManagerSet: Set<Channel>;
+    protected connection: amqp.AmqpConnectionManager;
+    protected logger: ILogger;
+    protected reconnectTime: any;
+    constructor(options?: any);
+    bindError(): void;
+    createChannel(isConfirmChannel?: boolean): Promise<any>;
+    connect(url: any, socketOptions: any): Promise<void>;
+    createConsumer(listenerOptions: RabbitMQListenerOptions, listenerCallback: (msg: ConsumeMessage | null, channel: Channel, channelWrapper: any) => Promise<void>): Promise<void>;
+    protected closeConnection(): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=mq.d.ts.map

package/dist/mq.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * This RabbitMQ Server changed from https://github.com/JeniTurtle/egg-rabbitmq-plus/blob/master/rabbitmq.ts
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RabbitMQServer = void 0;
+const amqp = require("amqp-connection-manager");
+const events_1 = require("events");
+class RabbitMQServer extends events_1.EventEmitter {
+    constructor(options = {}) {
+        var _a;
+        super();
+        this.channelManagerSet = new Set();
+        this.connection = null;
+        this.logger = options.logger;
+        this.reconnectTime = (_a = options.reconnectTime) !== null && _a !== void 0 ? _a : 10 * 1000;
+        this.bindError();
+    }
+    bindError() {
+        this.on('error', err => {
+            this.logger.error(err);
+        });
+    }
+    createChannel(isConfirmChannel = false) {
+        if (!isConfirmChannel) {
+            return this.connection.connection.createChannel();
+        }
+        else {
+            return this.connection.connection.createConfirmChannel();
+        }
+    }
+    async connect(url, socketOptions) {
+        this.connection = await amqp.connect(url, socketOptions);
+        // 监听在设置创建 channel 的错误
+        this.connection.on('error', err => {
+            if (err) {
+                if (err.err) {
+                    err = err.err;
+                }
+                this.logger.error('Message Queue error', err);
+            }
+            else {
+                this.logger.info('Message Queue disconnected!');
+            }
+        });
+        await new Promise((resolve, reject) => {
+            // 监听 成功连接 的通知
+            this.connection.on('connect', () => {
+                this.logger.info('Message Queue connected!');
+                resolve();
+            });
+            // 监听 连接失败的错误 通知
+            this.connection.on('connectFailed', err => {
+                if (err) {
+                    if (err.err) {
+                        err = err.err;
+                    }
+                    this.logger.error('Message Queue disconnected', err);
+                }
+                else {
+                    this.logger.info('Message Queue disconnected!');
+                }
+                reject(err);
+            });
+        });
+    }
+    async createConsumer(listenerOptions, listenerCallback) {
+        const channelWrapper = this.connection.createChannel({
+            setup: (channel) => {
+                var _a, _b, _c;
+                // `channel` here is a regular amqplib `ConfirmChannel`.
+                const channelHandlers = [];
+                // create queue
+                channelHandlers.push(channel.assertQueue(listenerOptions.queueName, Object.assign({ durable: true }, listenerOptions)));
+                if (listenerOptions.exchange) {
+                    // create exchange
+                    channelHandlers.push(channel.assertExchange(listenerOptions.exchange, (_b = (_a = listenerOptions.exchangeOptions) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : 'topic', listenerOptions.exchangeOptions));
+                    // bind exchange and queue
+                    channelHandlers.push(channel.bindQueue(listenerOptions.queueName, listenerOptions.exchange, listenerOptions.routingKey || listenerOptions.pattern, listenerOptions.exchangeOptions));
+                }
+                channelHandlers.push(channel.prefetch((_c = listenerOptions.prefetch) !== null && _c !== void 0 ? _c : 1));
+                // listen queue
+                channelHandlers.push(channel.consume(listenerOptions.queueName, async (msg) => {
+                    await listenerCallback(msg, channel, channelWrapper);
+                }, listenerOptions.consumeOptions));
+                return Promise.all(channelHandlers);
+            },
+            json: true,
+        });
+        return channelWrapper.waitForConnect();
+    }
+    async closeConnection() {
+        try {
+            if (this.connection) {
+                await this.connection.close();
+            }
+            this.logger.debug('Message Queue connection close success');
+        }
+        catch (err) {
+            this.logger.error('Message Queue connection close error', err);
+        }
+        finally {
+            this.connection = null;
+        }
+    }
+    async close() {
+        this.logger.debug('Message Queue will be close');
+        await this.closeConnection();
+    }
+}
+exports.RabbitMQServer = RabbitMQServer;
+//# sourceMappingURL=mq.js.map

package/dist/service.d.ts

@@ -0,0 +1,18 @@
+import { ServiceFactory } from '@midwayjs/core';
+import { MqttClient } from 'mqtt';
+export declare class MqttProducerFactory extends ServiceFactory<MqttClient> {
+    logger: any;
+    pubConfig: any;
+    getName(): string;
+    init(): Promise<void>;
+    protected createClient(config: any, clientName: any): Promise<MqttClient>;
+    destroyClient(producer: any): Promise<void>;
+}
+export declare class DefaultMqttProducer implements MqttClient {
+    private mqttProducerFactory;
+    protected instance: MqttClient;
+    init(): Promise<void>;
+}
+export interface DefaultMqttProducer extends MqttClient {
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/service.js

@@ -0,0 +1,86 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultMqttProducer = exports.MqttProducerFactory = void 0;
+const core_1 = require("@midwayjs/core");
+const core_2 = require("@midwayjs/core");
+const mqtt_1 = require("mqtt");
+let MqttProducerFactory = class MqttProducerFactory extends core_2.ServiceFactory {
+    getName() {
+        return 'mqtt';
+    }
+    async init() {
+        await this.initClients(this.pubConfig);
+    }
+    async createClient(config, clientName) {
+        const producer = await new Promise((resolve, reject) => {
+            (0, mqtt_1.connectAsync)(config)
+                .then(client => {
+                client.on('error', err => {
+                    this.logger.error(err);
+                });
+                client.on('connect', () => {
+                    resolve(client);
+                });
+            })
+                .catch(reject);
+        });
+        this.logger.info('[midway-mqtt] producer: %s is ready', clientName);
+        return producer;
+    }
+    async destroyClient(producer) {
+        await producer.endAsync();
+    }
+};
+__decorate([
+    (0, core_1.Logger)('mqttLogger'),
+    __metadata("design:type", Object)
+], MqttProducerFactory.prototype, "logger", void 0);
+__decorate([
+    (0, core_1.Config)('mqtt.pub'),
+    __metadata("design:type", Object)
+], MqttProducerFactory.prototype, "pubConfig", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], MqttProducerFactory.prototype, "init", null);
+MqttProducerFactory = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], MqttProducerFactory);
+exports.MqttProducerFactory = MqttProducerFactory;
+let DefaultMqttProducer = class DefaultMqttProducer {
+    async init() {
+        this.instance = this.mqttProducerFactory.get(this.mqttProducerFactory.getDefaultClientName() || 'default');
+        if (!this.instance) {
+            throw new core_2.MidwayCommonError('mqtt default producer instance not found.');
+        }
+    }
+};
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", MqttProducerFactory)
+], DefaultMqttProducer.prototype, "mqttProducerFactory", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], DefaultMqttProducer.prototype, "init", null);
+DefaultMqttProducer = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], DefaultMqttProducer);
+exports.DefaultMqttProducer = DefaultMqttProducer;
+(0, core_2.delegateTargetAllPrototypeMethod)(DefaultMqttProducer, mqtt_1.MqttClient);
+//# sourceMappingURL=service.js.map

package/index.d.ts

@@ -0,0 +1,8 @@
+import { IMidwayMQTTConfigurationOptions } from './dist';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    mqtt?: PowerPartial<IMidwayMQTTConfigurationOptions>;
+  }
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@midwayjs/mqtt",
+  "version": "3.14.12",
+  "description": "Midway Framework for mqtt",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
+    "lint:fix": "../../node_modules/.bin/mwts fix"
+  },
+  "keywords": [
+    "midway",
+    "IoC",
+    "framework",
+    "mqtt"
+  ],
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@midwayjs/mock": "^3.14.12",
+    "@midwayjs/core": "^3.14.12"
+  },
+  "dependencies": {
+    "mqtt": "5.3.5"
+  },
+  "author": "Harry Chen <czy88840616@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/midwayjs/midway.git"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "gitHead": "a603d2348d6141f8f723901498f03a162a037708"
+}