redweb 0.4.5 → 0.4.7

package/index.d.ts

@@ -1,5 +1,5 @@
 declare module 'redweb' {
-    import { IncomingMessage, ServerResponse } from 'http';
+    import { Request, Response } from 'express';
     import { Server as HTTPServer } from 'http';
     import { Server as HTTPSServer } from 'https';
     import WebSocket from 'ws';
@@ -15,7 +15,7 @@ declare module 'redweb' {
     export interface Service {
         serviceName: string;
         method: 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
-        function: (req: IncomingMessage, res: ServerResponse) => void;
+        function: (req: Request, res: Response) => void;
     }
 
     /**
@@ -97,7 +97,7 @@ declare module 'redweb' {
 
         constructor(server: HTTPServer | HTTPSServer, options?: SocketServerOptions);
 
-        handleConnection(socket: WebSocket, req: IncomingMessage): void;
+        handleConnection(socket: WebSocket, req: Request): void;
         handleMessage(socket: WebSocket, message: string, ip: string): void;
         handleClose(socket: WebSocket, ip: string): void;
         handleError(socket: WebSocket, error: Error, ip: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redweb",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "A way to quickly set up an express server",
   "main": "index.js",
   "scripts": {

package/src/http/BaseHttpServer.js

@@ -18,6 +18,7 @@ const path = require('path');
  * @property {Object} [ssl] - SSL configuration for HTTPS server.
  * @property {string} [ssl.key] - Path to the SSL key file.
  * @property {string} [ssl.cert] - Path to the SSL certificate file.
+ * @property {import('express').Application} [server] - Whether to automatically start listening.
  */
 
 const ENCODINGS = { json: 'json', urlencoded: 'urlencoded' };
@@ -28,7 +29,8 @@ const HTTP_OPTIONS = {
     services: [],
     listenCallback: undefined,
     encoding: ENCODINGS.json,
-    ssl: null
+    ssl: null,
+    server: undefined
 };
 
 /**
@@ -38,7 +40,7 @@ const HTTP_OPTIONS = {
  */
 function BaseHttpServer(options = {}) {
     this.options = { ...HTTP_OPTIONS, ...options };
-    this.app = express();
+    this.app = express() || this.options.server;
     Object.assign(this, this.options);
 
     // Middleware to parse request bodies based on the specified encoding
@@ -50,6 +52,7 @@ function BaseHttpServer(options = {}) {
 
     this.services.forEach(service => this.app[service.method](service.serviceName, service.function));
     this.publicPaths.forEach(public_path => this.app.use(express.static(path.join(process.cwd(), public_path))));
+    return this;
 }
 
 module.exports = {

package/src/http/HttpServer.js

@@ -7,7 +7,7 @@ const { BaseHttpServer } = require('./BaseHttpServer');
  */
 function HttpServer(options = {}) {
     BaseHttpServer.call(this, options);
-    this.app.listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpServer listening on port ${this.port}`));
+    this.server = this.app.listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpServer listening on port ${this.port}`));
     return this;
 }
 

package/src/ws/BaseSocketServer.js

@@ -2,6 +2,7 @@ const WebSocket = require('ws');
 
 /**
  * @typedef {Object} SocketServerOptions
+ * @property {any} [server] - The existing server instance.
  * @property {number} [port=3000] - The port number to bind the socket server.
  * @property {Function} [connectionOpenCallback] - Callback function to execute once a client connects.
  * @property {Function} [connectionCloseCallback] - Callback function to execute once a client disconnects.
@@ -35,7 +36,6 @@ function broadcast(socketServer, message) {
 class BaseSocketServer {
     /**
      * Base Socket Server
-     * @param {Object} server - The HTTP or HTTPS server instance.
      * @param {SocketServerOptions} options - Configuration options for SocketServer.
      */
     constructor(server, options = {}) {

package/src/ws/SocketServer.js

@@ -8,7 +8,7 @@ const { BaseSocketServer } = require('./BaseSocketServer');
  */
 class SocketServer extends BaseSocketServer {
     constructor(options = {}) {
-        const server = http.createServer();
+        const server = options?.server || http.createServer();
         super(server, options);
         server.listen(this.port, () => console.log(`RedWeb SocketServer listening on port ${this.port}`));
         return this;