@midwayjs/socketio 3.0.0-alpha.6 → 3.0.0-beta.11

package/CHANGELOG.md

@@ -3,6 +3,109 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
+
+**Note:** Version bump only for package @midwayjs/socketio
+
+
+
+
+
+# [3.0.0-beta.10](https://github.com/midwayjs/midway/compare/v3.0.0-beta.9...v3.0.0-beta.10) (2021-12-20)
+
+
+### Features
+
+* implement i18n for validate ([#1426](https://github.com/midwayjs/midway/issues/1426)) ([4c7ed2f](https://github.com/midwayjs/midway/commit/4c7ed2ff2e7ccf10f88f62abad230f92f5e76b97))
+
+
+
+
+
+# [3.0.0-beta.9](https://github.com/midwayjs/midway/compare/v3.0.0-beta.8...v3.0.0-beta.9) (2021-12-09)
+
+**Note:** Version bump only for package @midwayjs/socketio
+
+
+
+
+
+# [3.0.0-beta.8](https://github.com/midwayjs/midway/compare/v3.0.0-beta.7...v3.0.0-beta.8) (2021-12-08)
+
+
+### Bug Fixes
+
+* express routing middleware takes effect at the controller level ([#1364](https://github.com/midwayjs/midway/issues/1364)) ([b9272e0](https://github.com/midwayjs/midway/commit/b9272e0971003443304b0c53815be31a0061b4bd))
+
+
+
+
+
+# [3.0.0-beta.7](https://github.com/midwayjs/midway/compare/v3.0.0-beta.6...v3.0.0-beta.7) (2021-12-03)
+
+
+### Bug Fixes
+
+* middleware with ctx.body ([#1389](https://github.com/midwayjs/midway/issues/1389)) ([77af5c0](https://github.com/midwayjs/midway/commit/77af5c0b456f1843f4dcfd3dbfd2c0aa244c51bd))
+
+
+
+
+
+# [3.0.0-beta.6](https://github.com/midwayjs/midway/compare/v3.0.0-beta.5...v3.0.0-beta.6) (2021-11-26)
+
+**Note:** Version bump only for package @midwayjs/socketio
+
+
+
+
+
+# [3.0.0-beta.5](https://github.com/midwayjs/midway/compare/v3.0.0-beta.4...v3.0.0-beta.5) (2021-11-25)
+
+**Note:** Version bump only for package @midwayjs/socketio
+
+
+
+
+
+# [3.0.0-beta.4](https://github.com/midwayjs/midway/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2021-11-24)
+
+
+### Features
+
+* add i18n ([#1375](https://github.com/midwayjs/midway/issues/1375)) ([bffefe0](https://github.com/midwayjs/midway/commit/bffefe07afe45777d49b5a76b9ab17fc2b9d9a55))
+
+
+
+
+
+# [3.0.0-beta.3](https://github.com/midwayjs/midway/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2021-11-18)
+
+
+### Features
+
+* add component and framework config definition ([#1367](https://github.com/midwayjs/midway/issues/1367)) ([b2fe615](https://github.com/midwayjs/midway/commit/b2fe6157f99659471ff1333eca0b86bb889f61a3))
+
+
+
+
+
+# [3.0.0-beta.2](https://github.com/midwayjs/midway/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-11-16)
+
+**Note:** Version bump only for package @midwayjs/socketio
+
+
+
+
+
+# [3.0.0-beta.1](https://github.com/midwayjs/midway/compare/v2.12.4...v3.0.0-beta.1) (2021-11-14)
+
+**Note:** Version bump only for package @midwayjs/socketio
+
+
+
+
+
 ## [2.12.3](https://github.com/midwayjs/midway/compare/v2.12.2...v2.12.3) (2021-08-09)
 
 **Note:** Version bump only for package @midwayjs/socketio

package/README.md

@@ -5,7 +5,7 @@
 
 this is a sub package for midway.
 
-Document: [https://midwayjs.org/midway](https://midwayjs.org/midway)
+Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 

package/dist/configuration.d.ts

@@ -0,0 +1,3 @@
+export declare class SocketIOConfiguration {
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,19 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketIOConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+let SocketIOConfiguration = class SocketIOConfiguration {
+};
+SocketIOConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'socketIO',
+    })
+], SocketIOConfiguration);
+exports.SocketIOConfiguration = SocketIOConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/framework.d.ts

@@ -2,6 +2,7 @@ import { BaseFramework, IMidwayBootstrapOptions, MidwayFrameworkType } from '@mi
 import { IMidwaySocketIOApplication, IMidwaySocketIOConfigurationOptions, IMidwaySocketIOContext } from './interface';
 export declare class MidwaySocketIOFramework extends BaseFramework<IMidwaySocketIOApplication, IMidwaySocketIOContext, IMidwaySocketIOConfigurationOptions> {
     private namespaceList;
+    configure(): IMidwaySocketIOConfigurationOptions;
     applicationInitialize(options: IMidwayBootstrapOptions): void;
     app: IMidwaySocketIOApplication;
     protected afterContainerReady(options: Partial<IMidwayBootstrapOptions>): Promise<void>;

package/dist/framework.js

@@ -1,17 +1,26 @@
 "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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MidwaySocketIOFramework = void 0;
 const core_1 = require("@midwayjs/core");
 const util_1 = require("util");
-const debug = util_1.debuglog('midway:socket.io');
+const debug = (0, util_1.debuglog)('midway:socket.io');
 const socket_io_1 = require("socket.io");
 const decorator_1 = require("@midwayjs/decorator");
 const logger_1 = require("./logger");
-class MidwaySocketIOFramework extends core_1.BaseFramework {
+let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseFramework {
     constructor() {
         super(...arguments);
         this.namespaceList = [];
     }
+    configure() {
+        return this.configService.getConfiguration('socketIO');
+    }
     applicationInitialize(options) {
         this.app = new socket_io_1.Server(this.configurationOptions);
     }
@@ -28,7 +37,7 @@ class MidwaySocketIOFramework extends core_1.BaseFramework {
             this.app.listen(this.configurationOptions.port, this.configurationOptions);
             this.logger.info(`Socket.io server port = ${this.configurationOptions.port} start success`);
         }
-        else if (this.applicationContext.registry.hasObject(core_1.HTTP_SERVER_KEY)) {
+        else if (this.applicationContext.hasObject(core_1.HTTP_SERVER_KEY)) {
             this.app.attach(this.applicationContext.get(core_1.HTTP_SERVER_KEY), this.configurationOptions);
             this.logger.info('Socket.io server start success and attach to web server');
         }
@@ -47,16 +56,13 @@ class MidwaySocketIOFramework extends core_1.BaseFramework {
     }
     async loadMidwayController() {
         // create room
-        const controllerModules = core_1.listModule(decorator_1.WS_CONTROLLER_KEY);
+        const controllerModules = (0, decorator_1.listModule)(decorator_1.WS_CONTROLLER_KEY);
         for (const module of controllerModules) {
-            const providerId = core_1.getProviderId(module);
-            if (providerId) {
-                await this.addNamespace(module, providerId);
-            }
+            await this.addNamespace(module);
         }
     }
-    async addNamespace(target, controllerId) {
-        const controllerOption = core_1.getClassMetadata(decorator_1.WS_CONTROLLER_KEY, target);
+    async addNamespace(target) {
+        const controllerOption = (0, decorator_1.getClassMetadata)(decorator_1.WS_CONTROLLER_KEY, target);
         const nsp = this.app.of(controllerOption.namespace);
         this.namespaceList.push(controllerOption.namespace);
         nsp.use((socket, next) => {
@@ -66,13 +72,13 @@ class MidwaySocketIOFramework extends core_1.BaseFramework {
             next();
         });
         nsp.on('connect', async (socket) => {
-            const wsEventInfos = core_1.getClassMetadata(decorator_1.WS_EVENT_KEY, target);
+            const wsEventInfos = (0, decorator_1.getClassMetadata)(decorator_1.WS_EVENT_KEY, target);
             // 存储方法对应的响应处理
             const methodMap = {};
             if (wsEventInfos.length) {
                 for (const wsEventInfo of wsEventInfos) {
                     methodMap[wsEventInfo.propertyName] = methodMap[wsEventInfo.propertyName] || { responseEvents: [] };
-                    const controller = await socket.requestContext.getAsync(controllerId);
+                    const controller = await socket.requestContext.getAsync(target);
                     // on connection
                     if (wsEventInfo.eventType === decorator_1.WSEventTypeEnum.ON_CONNECTION) {
                         try {
@@ -88,8 +94,10 @@ class MidwaySocketIOFramework extends core_1.BaseFramework {
                         socket.on(wsEventInfo.messageEventName, async (...args) => {
                             debug('got message', wsEventInfo.messageEventName, args);
                             try {
-                                // eslint-disable-next-line prefer-spread
-                                const result = await controller[wsEventInfo.propertyName].apply(controller, args);
+                                const result = await (await this.applyMiddleware(async (ctx, next) => {
+                                    // eslint-disable-next-line prefer-spread
+                                    return controller[wsEventInfo.propertyName].apply(controller, args);
+                                }))(socket);
                                 if (typeof args[args.length - 1] === 'function') {
                                     // ack
                                     args[args.length - 1](result);
@@ -99,8 +107,8 @@ class MidwaySocketIOFramework extends core_1.BaseFramework {
                                     await this.bindSocketResponse(result, socket, wsEventInfo.propertyName, methodMap);
                                 }
                             }
-                            catch (err) {
-                                this.logger.error(err);
+                            catch (error) {
+                                this.logger.error(error);
                             }
                         });
                     }
@@ -154,6 +162,9 @@ class MidwaySocketIOFramework extends core_1.BaseFramework {
     getDefaultContextLoggerClass() {
         return logger_1.MidwaySocketIOContextLogger;
     }
-}
+};
+MidwaySocketIOFramework = __decorate([
+    (0, decorator_1.Framework)()
+], MidwaySocketIOFramework);
 exports.MidwaySocketIOFramework = MidwaySocketIOFramework;
 //# sourceMappingURL=framework.js.map

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { MidwaySocketIOFramework as Framework } from './framework';
 export { createRedisAdapter } from './util';
 export * from './interface';
+export { SocketIOConfiguration as Configuration } from './configuration';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -10,10 +10,12 @@ 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.createRedisAdapter = exports.Framework = void 0;
+exports.Configuration = exports.createRedisAdapter = exports.Framework = void 0;
 var framework_1 = require("./framework");
 Object.defineProperty(exports, "Framework", { enumerable: true, get: function () { return framework_1.MidwaySocketIOFramework; } });
 var util_1 = require("./util");
 Object.defineProperty(exports, "createRedisAdapter", { enumerable: true, get: function () { return util_1.createRedisAdapter; } });
 __exportStar(require("./interface"), exports);
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.SocketIOConfiguration; } });
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -1,5 +1,5 @@
 import * as SocketIO from 'socket.io';
-import { IConfigurationOptions, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
+import { IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction } from '@midwayjs/core';
 export declare type IMidwaySocketIOApplication = IMidwayApplication<IMidwaySocketIOContext, {
     use(fn: (socket: IMidwaySocketIOContext, fn: (err?: any) => void) => void): SocketIO.Namespace;
 } & SocketIO.Server>;
@@ -14,4 +14,10 @@ export declare type IMidwaySocketIOContext = IMidwayContext<SocketIO.Socket & {
 export declare type Application = IMidwaySocketIOApplication;
 export interface Context extends IMidwaySocketIOContext {
 }
+export declare type NextFunction = BaseNextFunction;
+declare module '@midwayjs/core/dist/interface' {
+    interface MidwayConfig {
+        socketIO?: IMidwaySocketIOConfigurationOptions;
+    }
+}
 //# sourceMappingURL=interface.d.ts.map

package/dist/util.js

@@ -4,10 +4,10 @@ exports.createRedisAdapter = void 0;
 const socket_io_redis_1 = require("socket.io-redis");
 function createRedisAdapter(options) {
     if (options.host && options.port) {
-        return socket_io_redis_1.createAdapter('redis://' + options.host + ':' + options.port, options);
+        return (0, socket_io_redis_1.createAdapter)('redis://' + options.host + ':' + options.port, options);
     }
     if (options.pubClient && options.subClient) {
-        return socket_io_redis_1.createAdapter(options);
+        return (0, socket_io_redis_1.createAdapter)(options);
     }
     throw new Error('error socket adapter options');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/socketio",
-  "version": "3.0.0-alpha.6+6c8b724b",
+  "version": "3.0.0-beta.11",
   "description": "Midway Web Framework for socket.io",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -23,15 +23,15 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-alpha.6+6c8b724b",
-    "@midwayjs/mock": "^3.0.0-alpha.6+6c8b724b",
+    "@midwayjs/decorator": "^3.0.0-beta.11",
+    "@midwayjs/mock": "^3.0.0-beta.11",
     "@types/socket.io-client": "^1.4.36",
     "fs-extra": "^8.0.1",
     "socket.io-client": "^4.0.0"
   },
   "dependencies": {
-    "@midwayjs/core": "^3.0.0-alpha.6+6c8b724b",
-    "@midwayjs/logger": "^3.0.0-alpha.6+6c8b724b",
+    "@midwayjs/core": "^3.0.0-beta.11",
+    "@midwayjs/logger": "^3.0.0-beta.11",
     "socket.io": "^4.0.0",
     "socket.io-redis": "^6.1.0"
   },
@@ -40,5 +40,8 @@
     "type": "git",
     "url": "http://github.com/midwayjs/midway.git"
   },
-  "gitHead": "6c8b724b08cf395287636b80387653f9540768e5"
+  "engines": {
+    "node": ">=12"
+  },
+  "gitHead": "a2b066fd500e815e799e7f421cd216f12e0e9f8e"
 }