@opra/nestjs-socketio 1.26.3 → 1.27.0

package/README.md

@@ -1,3 +1,26 @@
-# OPRA
+# @opra/nestjs-socketio
 
-Open Protocol for Restful Api
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
+[![CI Tests][ci-test-image]][ci-test-url]
+[![Test Coverage][coveralls-image]][coveralls-url]
+
+
+## Support
+You can report bugs and discuss features on the [GitHub issues](https://github.com/panates/opra/issues) page.
+
+## Node Compatibility
+- node >= 20.x
+
+
+## License
+Available under [MIT](LICENSE) license.
+
+[npm-image]: https://img.shields.io/npm/v/@opra/nestjs-socketio
+[npm-url]: https://npmjs.org/package/@opra/nestjs-socketio
+[downloads-image]: https://img.shields.io/npm/dm/@opra/nestjs-socketio.svg
+[downloads-url]: https://npmjs.org/package/@opra/nestjs-socketio
+[ci-test-image]: https://github.com/panates/opra/actions/workflows/test.yml/badge.svg
+[ci-test-url]: https://github.com/panates/opra/actions/workflows/test.yml
+[coveralls-image]: https://coveralls.io/repos/github/panates/opra/badge.svg?branch=main
+[coveralls-url]: https://coveralls.io/github/panates/opra?branch=main

package/opra-socketio.module.d.ts

@@ -3,35 +3,66 @@ import type { ApiDocumentFactory } from '@opra/common';
 import type { SocketioAdapter } from '@opra/socketio';
 import * as socketio from 'socket.io';
 export declare namespace OpraSocketioModule {
+    /**
+     * Synchronous configuration options for OpraSocketioModule.
+     */
     export interface ModuleOptions extends BaseModuleOptions, ApiConfig {
     }
+    /**
+     * Asynchronous configuration options for OpraSocketioModule.
+     */
     export interface AsyncModuleOptions extends BaseModuleOptions {
+        /** Providers to be injected into the factory function */
         inject?: any[];
+        /** Factory function that returns the ApiConfig object asynchronously */
         useFactory?: (...args: any[]) => Promise<ApiConfig> | ApiConfig;
     }
+    /**
+     * Base configuration options for the module.
+     */
     interface BaseModuleOptions extends Pick<DynamicModule, 'imports' | 'providers' | 'exports' | 'controllers' | 'global'> {
+        /** Custom token for the module */
         token?: any;
+        /** Port the Socket.io server will listen on */
         port?: number;
+        /** Socket.io server options */
         serverOptions?: Partial<socketio.ServerOptions>;
+        /** Interceptor list for the Socket.io adapter */
         interceptors?: (SocketioAdapter.InterceptorFunction | SocketioAdapter.IWSInterceptor | Type<SocketioAdapter.IWSInterceptor>)[];
     }
+    /**
+     * OPRA Socket.io API configuration details.
+     */
     export interface ApiConfig extends Pick<ApiDocumentFactory.InitArguments, 'types' | 'references' | 'info'> {
+        /** API name */
         name: string;
+        /** API description */
         description?: string;
+        /** API scope */
         scope?: string;
+        /** Logger to be used */
         logger?: Logger;
     }
     export {};
 }
+/**
+ * OpraSocketioModule
+ *
+ * Module that integrates OPRA Socket.io support into the NestJS application.
+ */
 export declare class OpraSocketioModule {
     /**
+     * Configures the module synchronously and imports it at the root level.
      *
-     * @param init
+     * @param init - Module configuration options.
+     * @returns {DynamicModule} NestJS dynamic module.
      */
     static forRoot(init: OpraSocketioModule.ModuleOptions): DynamicModule;
     /**
+     * Configures the module asynchronously and imports it at the root level.
      *
-     * @param options
+     * @param options - Asynchronous module configuration options.
+     * @returns {DynamicModule} NestJS dynamic module.
      */
     static forRootAsync(options: OpraSocketioModule.AsyncModuleOptions): DynamicModule;
 }

package/opra-socketio.module.js

@@ -2,10 +2,17 @@ var OpraSocketioModule_1;
 import { __decorate } from "tslib";
 import { Module } from '@nestjs/common';
 import { OpraSocketioCoreModule } from './opra-socketio-core.module.js';
+/**
+ * OpraSocketioModule
+ *
+ * Module that integrates OPRA Socket.io support into the NestJS application.
+ */
 let OpraSocketioModule = OpraSocketioModule_1 = class OpraSocketioModule {
     /**
+     * Configures the module synchronously and imports it at the root level.
      *
-     * @param init
+     * @param init - Module configuration options.
+     * @returns {DynamicModule} NestJS dynamic module.
      */
     static forRoot(init) {
         return {
@@ -14,8 +21,10 @@ let OpraSocketioModule = OpraSocketioModule_1 = class OpraSocketioModule {
         };
     }
     /**
+     * Configures the module asynchronously and imports it at the root level.
      *
-     * @param options
+     * @param options - Asynchronous module configuration options.
+     * @returns {DynamicModule} NestJS dynamic module.
      */
     static forRootAsync(options) {
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/nestjs-socketio",
-  "version": "1.26.3",
+  "version": "1.27.0",
   "description": "Opra NestJS Socket.io Module",
   "author": "Panates",
   "license": "MIT",
@@ -9,10 +9,10 @@
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
-    "@opra/common": "^1.26.3",
-    "@opra/core": "^1.26.3",
-    "@opra/nestjs": "^1.26.3",
-    "@opra/socketio": "^1.26.3",
+    "@opra/common": "^1.27.0",
+    "@opra/core": "^1.27.0",
+    "@opra/nestjs": "^1.27.0",
+    "@opra/socketio": "^1.27.0",
     "@nestjs/common": "^10.0.0 || ^11.0.0",
     "@nestjs/core": "^10.0.0 || ^11.0.0",
     "socket.io": "^4.8.3"