@opra/nestjs-socketio 1.21.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Panates
+
+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,3 @@
+# OPRA
+
+Open Protocol for Restful Api

package/cjs/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPRA_SOCKETIO_MODULE_OPTIONS = void 0;
+exports.OPRA_SOCKETIO_MODULE_OPTIONS = 'OPRA_SOCKETIO_MODULE_OPTIONS';

package/cjs/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Public = exports.OpraNestUtils = exports.IS_PUBLIC_KEY = void 0;
+const tslib_1 = require("tslib");
+const nestjs_1 = require("@opra/nestjs");
+Object.defineProperty(exports, "IS_PUBLIC_KEY", { enumerable: true, get: function () { return nestjs_1.IS_PUBLIC_KEY; } });
+Object.defineProperty(exports, "OpraNestUtils", { enumerable: true, get: function () { return nestjs_1.OpraNestUtils; } });
+Object.defineProperty(exports, "Public", { enumerable: true, get: function () { return nestjs_1.Public; } });
+tslib_1.__exportStar(require("./constants.js"), exports);
+tslib_1.__exportStar(require("./opra-socketio.module.js"), exports);

package/cjs/opra-socketio-core.module.js

@@ -0,0 +1,147 @@
+"use strict";
+var OpraSocketioCoreModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpraSocketioCoreModule = void 0;
+const tslib_1 = require("tslib");
+const objects_1 = require("@jsopen/objects");
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const common_2 = require("@opra/common");
+const nestjs_1 = require("@opra/nestjs");
+const socketio_1 = require("@opra/socketio");
+const constants_js_1 = require("./constants.js");
+const opraSocketioNestjsAdapterToken = Symbol('OpraSocketioNestjsAdapter');
+let OpraSocketioCoreModule = OpraSocketioCoreModule_1 = class OpraSocketioCoreModule {
+    constructor(controllerFactory, adapter, config, httpAdapterHost) {
+        this.controllerFactory = controllerFactory;
+        this.adapter = adapter;
+        this.config = config;
+        this.httpAdapterHost = httpAdapterHost;
+    }
+    static forRoot(moduleOptions) {
+        return this._getDynamicModule({
+            ...moduleOptions,
+            providers: [
+                ...(moduleOptions?.providers || []),
+                {
+                    provide: constants_js_1.OPRA_SOCKETIO_MODULE_OPTIONS,
+                    useValue: {
+                        ...moduleOptions,
+                        logger: moduleOptions.logger || new common_1.Logger(moduleOptions.name),
+                    },
+                },
+            ],
+        });
+    }
+    static forRootAsync(moduleOptions) {
+        if (!moduleOptions.useFactory)
+            throw new Error('Invalid configuration. Must provide "useFactory"');
+        return this._getDynamicModule({
+            ...moduleOptions,
+            providers: [
+                ...(moduleOptions?.providers || []),
+                {
+                    provide: constants_js_1.OPRA_SOCKETIO_MODULE_OPTIONS,
+                    inject: moduleOptions.inject,
+                    useFactory: async (...args) => {
+                        const result = await moduleOptions.useFactory(...args);
+                        result.logger = result.logger || new common_1.Logger(result.name);
+                        return result;
+                    },
+                },
+            ],
+        });
+    }
+    static _getDynamicModule(moduleOptions) {
+        const token = moduleOptions.token || socketio_1.SocketioAdapter;
+        const adapterProvider = {
+            provide: token,
+            inject: [nestjs_1.WSControllerFactory, core_1.ModuleRef, constants_js_1.OPRA_SOCKETIO_MODULE_OPTIONS],
+            useFactory: async (controllerFactory, moduleRef, config) => {
+                const controllers = controllerFactory
+                    .exploreControllers()
+                    .map(x => x.wrapper.instance);
+                const document = await common_2.ApiDocumentFactory.createDocument({
+                    info: config.info,
+                    types: config.types,
+                    references: config.references,
+                    api: {
+                        name: config.name,
+                        description: config.description,
+                        transport: 'ws',
+                        platform: socketio_1.SocketioAdapter.PlatformName,
+                        controllers,
+                    },
+                });
+                const interceptors = moduleOptions.interceptors
+                    ? moduleOptions.interceptors.map(x => {
+                        if ((0, objects_1.isConstructor)(x)) {
+                            return async (ctx, next) => {
+                                const interceptor = moduleRef.get(x);
+                                if (typeof interceptor.intercept === 'function')
+                                    return interceptor.intercept(ctx, next);
+                            };
+                        }
+                        return x;
+                    })
+                    : undefined;
+                return new socketio_1.SocketioAdapter(document, { ...config, interceptors });
+            },
+        };
+        return {
+            global: moduleOptions.global,
+            module: OpraSocketioCoreModule_1,
+            controllers: moduleOptions.controllers,
+            providers: [
+                ...(moduleOptions?.providers || []),
+                nestjs_1.WSControllerFactory,
+                adapterProvider,
+                {
+                    provide: opraSocketioNestjsAdapterToken,
+                    useExisting: token,
+                },
+            ],
+            imports: [...(moduleOptions?.imports || [])],
+            exports: [...(moduleOptions?.exports || []), adapterProvider],
+        };
+    }
+    onModuleInit() {
+        /** NestJS initialize controller instances on init stage.
+         * So we should update instance properties */
+        const wsApi = this.adapter.document.getWsApi();
+        const controllers = Array.from(wsApi.controllers.values());
+        for (const { wrapper } of this.controllerFactory
+            .exploreControllers()
+            .values()) {
+            const ctor = wrapper.instance.constructor;
+            const controller = controllers.find(x => x.ctor === ctor);
+            if (controller) {
+                controller.instance = wrapper.instance;
+            }
+        }
+    }
+    async onApplicationBootstrap() {
+        const httpServer = this.httpAdapterHost.httpAdapter.getHttpServer();
+        if (this.config.port) {
+            const addr = httpServer.address();
+            const httpPort = addr && typeof addr === 'object' ? addr.port : 0;
+            if (httpPort !== this.config.port) {
+                this.adapter.listen(this.config.port, this.config.serverOptions);
+                return;
+            }
+        }
+        this.adapter.listen(httpServer, this.config.serverOptions);
+    }
+    async onApplicationShutdown() {
+        await this.adapter.close();
+    }
+};
+exports.OpraSocketioCoreModule = OpraSocketioCoreModule;
+exports.OpraSocketioCoreModule = OpraSocketioCoreModule = OpraSocketioCoreModule_1 = tslib_1.__decorate([
+    (0, common_1.Module)({}),
+    (0, common_1.Global)(),
+    tslib_1.__param(1, (0, common_1.Inject)(opraSocketioNestjsAdapterToken)),
+    tslib_1.__param(2, (0, common_1.Inject)(constants_js_1.OPRA_SOCKETIO_MODULE_OPTIONS)),
+    tslib_1.__metadata("design:paramtypes", [nestjs_1.WSControllerFactory,
+        socketio_1.SocketioAdapter, Object, core_1.HttpAdapterHost])
+], OpraSocketioCoreModule);

package/cjs/opra-socketio.module.js

@@ -0,0 +1,33 @@
+"use strict";
+var OpraSocketioModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpraSocketioModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const opra_socketio_core_module_js_1 = require("./opra-socketio-core.module.js");
+let OpraSocketioModule = OpraSocketioModule_1 = class OpraSocketioModule {
+    /**
+     *
+     * @param init
+     */
+    static forRoot(init) {
+        return {
+            module: OpraSocketioModule_1,
+            imports: [opra_socketio_core_module_js_1.OpraSocketioCoreModule.forRoot(init)],
+        };
+    }
+    /**
+     *
+     * @param options
+     */
+    static forRootAsync(options) {
+        return {
+            module: OpraSocketioModule_1,
+            imports: [opra_socketio_core_module_js_1.OpraSocketioCoreModule.forRootAsync(options)],
+        };
+    }
+};
+exports.OpraSocketioModule = OpraSocketioModule;
+exports.OpraSocketioModule = OpraSocketioModule = OpraSocketioModule_1 = tslib_1.__decorate([
+    (0, common_1.Module)({})
+], OpraSocketioModule);

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/esm/constants.js

@@ -0,0 +1 @@
+export const OPRA_SOCKETIO_MODULE_OPTIONS = 'OPRA_SOCKETIO_MODULE_OPTIONS';

package/esm/index.js

@@ -0,0 +1,4 @@
+import { IS_PUBLIC_KEY, OpraNestUtils, Public } from '@opra/nestjs';
+export * from './constants.js';
+export * from './opra-socketio.module.js';
+export { IS_PUBLIC_KEY, OpraNestUtils, Public };

package/esm/opra-socketio-core.module.js

@@ -0,0 +1,144 @@
+var OpraSocketioCoreModule_1;
+import { __decorate, __metadata, __param } from "tslib";
+import { isConstructor } from '@jsopen/objects';
+import { Global, Inject, Logger, Module, } from '@nestjs/common';
+import { HttpAdapterHost, ModuleRef } from '@nestjs/core';
+import { ApiDocumentFactory } from '@opra/common';
+import { WSControllerFactory } from '@opra/nestjs';
+import { SocketioAdapter } from '@opra/socketio';
+import { OPRA_SOCKETIO_MODULE_OPTIONS } from './constants.js';
+const opraSocketioNestjsAdapterToken = Symbol('OpraSocketioNestjsAdapter');
+let OpraSocketioCoreModule = OpraSocketioCoreModule_1 = class OpraSocketioCoreModule {
+    constructor(controllerFactory, adapter, config, httpAdapterHost) {
+        this.controllerFactory = controllerFactory;
+        this.adapter = adapter;
+        this.config = config;
+        this.httpAdapterHost = httpAdapterHost;
+    }
+    static forRoot(moduleOptions) {
+        return this._getDynamicModule({
+            ...moduleOptions,
+            providers: [
+                ...(moduleOptions?.providers || []),
+                {
+                    provide: OPRA_SOCKETIO_MODULE_OPTIONS,
+                    useValue: {
+                        ...moduleOptions,
+                        logger: moduleOptions.logger || new Logger(moduleOptions.name),
+                    },
+                },
+            ],
+        });
+    }
+    static forRootAsync(moduleOptions) {
+        if (!moduleOptions.useFactory)
+            throw new Error('Invalid configuration. Must provide "useFactory"');
+        return this._getDynamicModule({
+            ...moduleOptions,
+            providers: [
+                ...(moduleOptions?.providers || []),
+                {
+                    provide: OPRA_SOCKETIO_MODULE_OPTIONS,
+                    inject: moduleOptions.inject,
+                    useFactory: async (...args) => {
+                        const result = await moduleOptions.useFactory(...args);
+                        result.logger = result.logger || new Logger(result.name);
+                        return result;
+                    },
+                },
+            ],
+        });
+    }
+    static _getDynamicModule(moduleOptions) {
+        const token = moduleOptions.token || SocketioAdapter;
+        const adapterProvider = {
+            provide: token,
+            inject: [WSControllerFactory, ModuleRef, OPRA_SOCKETIO_MODULE_OPTIONS],
+            useFactory: async (controllerFactory, moduleRef, config) => {
+                const controllers = controllerFactory
+                    .exploreControllers()
+                    .map(x => x.wrapper.instance);
+                const document = await ApiDocumentFactory.createDocument({
+                    info: config.info,
+                    types: config.types,
+                    references: config.references,
+                    api: {
+                        name: config.name,
+                        description: config.description,
+                        transport: 'ws',
+                        platform: SocketioAdapter.PlatformName,
+                        controllers,
+                    },
+                });
+                const interceptors = moduleOptions.interceptors
+                    ? moduleOptions.interceptors.map(x => {
+                        if (isConstructor(x)) {
+                            return async (ctx, next) => {
+                                const interceptor = moduleRef.get(x);
+                                if (typeof interceptor.intercept === 'function')
+                                    return interceptor.intercept(ctx, next);
+                            };
+                        }
+                        return x;
+                    })
+                    : undefined;
+                return new SocketioAdapter(document, { ...config, interceptors });
+            },
+        };
+        return {
+            global: moduleOptions.global,
+            module: OpraSocketioCoreModule_1,
+            controllers: moduleOptions.controllers,
+            providers: [
+                ...(moduleOptions?.providers || []),
+                WSControllerFactory,
+                adapterProvider,
+                {
+                    provide: opraSocketioNestjsAdapterToken,
+                    useExisting: token,
+                },
+            ],
+            imports: [...(moduleOptions?.imports || [])],
+            exports: [...(moduleOptions?.exports || []), adapterProvider],
+        };
+    }
+    onModuleInit() {
+        /** NestJS initialize controller instances on init stage.
+         * So we should update instance properties */
+        const wsApi = this.adapter.document.getWsApi();
+        const controllers = Array.from(wsApi.controllers.values());
+        for (const { wrapper } of this.controllerFactory
+            .exploreControllers()
+            .values()) {
+            const ctor = wrapper.instance.constructor;
+            const controller = controllers.find(x => x.ctor === ctor);
+            if (controller) {
+                controller.instance = wrapper.instance;
+            }
+        }
+    }
+    async onApplicationBootstrap() {
+        const httpServer = this.httpAdapterHost.httpAdapter.getHttpServer();
+        if (this.config.port) {
+            const addr = httpServer.address();
+            const httpPort = addr && typeof addr === 'object' ? addr.port : 0;
+            if (httpPort !== this.config.port) {
+                this.adapter.listen(this.config.port, this.config.serverOptions);
+                return;
+            }
+        }
+        this.adapter.listen(httpServer, this.config.serverOptions);
+    }
+    async onApplicationShutdown() {
+        await this.adapter.close();
+    }
+};
+OpraSocketioCoreModule = OpraSocketioCoreModule_1 = __decorate([
+    Module({}),
+    Global(),
+    __param(1, Inject(opraSocketioNestjsAdapterToken)),
+    __param(2, Inject(OPRA_SOCKETIO_MODULE_OPTIONS)),
+    __metadata("design:paramtypes", [WSControllerFactory,
+        SocketioAdapter, Object, HttpAdapterHost])
+], OpraSocketioCoreModule);
+export { OpraSocketioCoreModule };

package/esm/opra-socketio.module.js

@@ -0,0 +1,30 @@
+var OpraSocketioModule_1;
+import { __decorate } from "tslib";
+import { Module } from '@nestjs/common';
+import { OpraSocketioCoreModule } from './opra-socketio-core.module.js';
+let OpraSocketioModule = OpraSocketioModule_1 = class OpraSocketioModule {
+    /**
+     *
+     * @param init
+     */
+    static forRoot(init) {
+        return {
+            module: OpraSocketioModule_1,
+            imports: [OpraSocketioCoreModule.forRoot(init)],
+        };
+    }
+    /**
+     *
+     * @param options
+     */
+    static forRootAsync(options) {
+        return {
+            module: OpraSocketioModule_1,
+            imports: [OpraSocketioCoreModule.forRootAsync(options)],
+        };
+    }
+};
+OpraSocketioModule = OpraSocketioModule_1 = __decorate([
+    Module({})
+], OpraSocketioModule);
+export { OpraSocketioModule };

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@opra/nestjs-socketio",
+  "version": "1.21.0",
+  "description": "Opra NestJS Socket.io Module",
+  "author": "Panates",
+  "license": "MIT",
+  "dependencies": {
+    "@jsopen/objects": "^2.0.2",
+    "tslib": "^2.8.1"
+  },
+  "peerDependencies": {
+    "@opra/common": "^1.21.0",
+    "@opra/core": "^1.21.0",
+    "@opra/nestjs": "^1.21.0",
+    "@opra/socketio": "^1.21.0",
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "socket.io": "^4.8.1"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "require": {
+        "types": "./types/index.d.cts",
+        "default": "./cjs/index.js"
+      },
+      "default": "./esm/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/panates/opra.git",
+    "directory": "packages/nestjs-socketio"
+  },
+  "engines": {
+    "node": ">=16.0",
+    "npm": ">=7.0.0"
+  },
+  "files": [
+    "bin/",
+    "cjs/",
+    "esm/",
+    "types/",
+    "LICENSE",
+    "README.md"
+  ],
+  "keywords": [
+    "opra",
+    "nestjs",
+    "socket.io",
+    "websockets",
+    "ws"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/constants.d.ts

@@ -0,0 +1 @@
+export declare const OPRA_SOCKETIO_MODULE_OPTIONS = "OPRA_SOCKETIO_MODULE_OPTIONS";

package/types/index.d.cts

@@ -0,0 +1,4 @@
+import { IS_PUBLIC_KEY, OpraNestUtils, Public } from '@opra/nestjs';
+export * from './constants.js';
+export * from './opra-socketio.module.js';
+export { IS_PUBLIC_KEY, OpraNestUtils, Public };

package/types/index.d.ts

@@ -0,0 +1,4 @@
+import { IS_PUBLIC_KEY, OpraNestUtils, Public } from '@opra/nestjs';
+export * from './constants.js';
+export * from './opra-socketio.module.js';
+export { IS_PUBLIC_KEY, OpraNestUtils, Public };

package/types/opra-socketio-core.module.d.ts

@@ -0,0 +1,18 @@
+import { type DynamicModule, OnApplicationBootstrap, OnApplicationShutdown, OnModuleInit } from '@nestjs/common';
+import { HttpAdapterHost } from '@nestjs/core';
+import { WSControllerFactory } from '@opra/nestjs';
+import { SocketioAdapter } from '@opra/socketio';
+import type { OpraSocketioModule } from './opra-socketio.module.js';
+export declare class OpraSocketioCoreModule implements OnModuleInit, OnApplicationBootstrap, OnApplicationShutdown {
+    private controllerFactory;
+    protected adapter: SocketioAdapter;
+    protected config: OpraSocketioModule.ModuleOptions;
+    private httpAdapterHost;
+    constructor(controllerFactory: WSControllerFactory, adapter: SocketioAdapter, config: OpraSocketioModule.ModuleOptions, httpAdapterHost: HttpAdapterHost);
+    static forRoot(moduleOptions: OpraSocketioModule.ModuleOptions): DynamicModule;
+    static forRootAsync(moduleOptions: OpraSocketioModule.AsyncModuleOptions): DynamicModule;
+    protected static _getDynamicModule(moduleOptions: OpraSocketioModule.ModuleOptions | OpraSocketioModule.AsyncModuleOptions): DynamicModule;
+    onModuleInit(): any;
+    onApplicationBootstrap(): Promise<void>;
+    onApplicationShutdown(): Promise<void>;
+}

package/types/opra-socketio.module.d.ts

@@ -0,0 +1,37 @@
+import { type DynamicModule, Logger, type Type } from '@nestjs/common';
+import type { ApiDocumentFactory } from '@opra/common';
+import type { SocketioAdapter } from '@opra/socketio';
+import * as socketio from 'socket.io';
+export declare namespace OpraSocketioModule {
+    export interface ModuleOptions extends BaseModuleOptions, ApiConfig {
+    }
+    export interface AsyncModuleOptions extends BaseModuleOptions {
+        inject?: any[];
+        useFactory?: (...args: any[]) => Promise<ApiConfig> | ApiConfig;
+    }
+    interface BaseModuleOptions extends Pick<DynamicModule, 'imports' | 'providers' | 'exports' | 'controllers' | 'global'> {
+        token?: any;
+        port?: number;
+        serverOptions?: Partial<socketio.ServerOptions>;
+        interceptors?: (SocketioAdapter.InterceptorFunction | SocketioAdapter.IWSInterceptor | Type<SocketioAdapter.IWSInterceptor>)[];
+    }
+    export interface ApiConfig extends Pick<ApiDocumentFactory.InitArguments, 'types' | 'references' | 'info'> {
+        name: string;
+        description?: string;
+        scope?: string;
+        logger?: Logger;
+    }
+    export {};
+}
+export declare class OpraSocketioModule {
+    /**
+     *
+     * @param init
+     */
+    static forRoot(init: OpraSocketioModule.ModuleOptions): DynamicModule;
+    /**
+     *
+     * @param options
+     */
+    static forRootAsync(options: OpraSocketioModule.AsyncModuleOptions): DynamicModule;
+}