redweb 0.4.1 → 0.4.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Arkam Mazrui
-
-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
+MIT License
+
+Copyright (c) 2024 Arkam Mazrui
+
+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/index.js

@@ -1,10 +1,10 @@
-const { HttpServer, HttpsServer, METHODS } = require('./src/http');
-const { SocketServer, SecureSocketServer, SOCKET_OPTIONS } = require('./src/ws');
-module.exports = {
-    SocketServer,
-    SecureSocketServer,
-    HttpServer,
-    HttpsServer,
-    SOCKET_OPTIONS,
-    METHODS
-};
+const { HttpServer, HttpsServer, METHODS } = require('./src/http');
+const { SocketServer, SecureSocketServer, SOCKET_OPTIONS } = require('./src/ws');
+module.exports = {
+    SocketServer,
+    SecureSocketServer,
+    HttpServer,
+    HttpsServer,
+    SOCKET_OPTIONS,
+    METHODS
+};

package/package.json

@@ -1,24 +1,24 @@
-{
-  "name": "redweb",
-  "version": "0.4.1",
-  "description": "A way to quickly set up an express server",
-  "main": "index.js",
-  "scripts": {
-    "test": "node tester.js"
-  },
-  "files": [
-    "src/*"
-  ],
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "express": "^4.19.2",
-    "ws": "^8.17.0"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.12",
-    "jest": "^29.7.0"
-  }
-}
+{
+  "name": "redweb",
+  "version": "0.4.3",
+  "description": "A way to quickly set up an express server",
+  "main": "index.js",
+  "scripts": {
+    "test": "node tester.js"
+  },
+  "files": [
+    "src/*"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "express": "^4.19.2",
+    "ws": "^8.17.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0"
+  }
+}

package/src/http/BaseHttpServer.js

@@ -1,60 +1,60 @@
-const express = require('express');
-const bodyParser = require('body-parser');
-const path = require('path');
-
-/**
- * @typedef {'json' | 'urlencoded'} RedWebEncoding
- */
-
-/**
- * RedWeb options object.
- * @typedef {Object} RedWebOptions
- * @property {number} [port=80] - The port number to bind the server.
- * @property {string} [bind='0.0.0.0'] - The bind address for the server.
- * @property {string[]} [publicPaths=['./public']] - An array of paths to serve static files from.
- * @property {Array<{serviceName: string, method: string, function: Function}>} [services=[]] - An array of services with their endpoints and handlers.
- * @property {Function} [listenCallback] - Callback function to execute once the server starts listening.
- * @property {RedWebEncoding} [encoding='json'] - The encoding type for the request bodies ('json' or 'urlencoded').
- * @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.
- */
-
-const ENCODINGS = { json: 'json', urlencoded: 'urlencoded' };
-const HTTP_OPTIONS = {
-    port: 80,
-    bind: '0.0.0.0',
-    publicPaths: ['./public'],
-    services: [],
-    listenCallback: undefined,
-    encoding: ENCODINGS.json,
-    ssl: null
-};
-
-/**
- * Base HTTP Server
- * @param {RedWebOptions} options - Configuration options for RedWeb.
- * @return {Object} Express application instance.
- */
-function BaseHttpServer(options = {}) {
-    this.options = { ...HTTP_OPTIONS, ...options };
-    this.app = express();
-    Object.assign(this, this.options);
-
-    // Middleware to parse request bodies based on the specified encoding
-    if (this.encoding === ENCODINGS.json) {
-        this.app.use(bodyParser.json());
-    } else if (this.encoding === ENCODINGS.urlencoded) {
-        this.app.use(bodyParser.urlencoded({ extended: true }));
-    }
-
-    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))));
-}
-
-module.exports = {
-    BaseHttpServer,
-    ENCODINGS,
-    HTTP_OPTIONS,
-    METHODS: {GET: 'get', POST: 'post', PUT: 'put', DELETE: 'delete'}
-};
+const express = require('express');
+const bodyParser = require('body-parser');
+const path = require('path');
+
+/**
+ * @typedef {'json' | 'urlencoded'} RedWebEncoding
+ */
+
+/**
+ * RedWeb options object.
+ * @typedef {Object} RedWebOptions
+ * @property {number} [port=80] - The port number to bind the server.
+ * @property {string} [bind='0.0.0.0'] - The bind address for the server.
+ * @property {string[]} [publicPaths=['./public']] - An array of paths to serve static files from.
+ * @property {Array<{serviceName: string, method: string, function: Function}>} [services=[]] - An array of services with their endpoints and handlers.
+ * @property {Function} [listenCallback] - Callback function to execute once the server starts listening.
+ * @property {RedWebEncoding} [encoding='json'] - The encoding type for the request bodies ('json' or 'urlencoded').
+ * @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.
+ */
+
+const ENCODINGS = { json: 'json', urlencoded: 'urlencoded' };
+const HTTP_OPTIONS = {
+    port: 80,
+    bind: '0.0.0.0',
+    publicPaths: ['./public'],
+    services: [],
+    listenCallback: undefined,
+    encoding: ENCODINGS.json,
+    ssl: null
+};
+
+/**
+ * Base HTTP Server
+ * @param {RedWebOptions} options - Configuration options for RedWeb.
+ * @return {Object} Express application instance.
+ */
+function BaseHttpServer(options = {}) {
+    this.options = { ...HTTP_OPTIONS, ...options };
+    this.app = express();
+    Object.assign(this, this.options);
+
+    // Middleware to parse request bodies based on the specified encoding
+    if (this.encoding === ENCODINGS.json) {
+        this.app.use(bodyParser.json());
+    } else if (this.encoding === ENCODINGS.urlencoded) {
+        this.app.use(bodyParser.urlencoded({ extended: true }));
+    }
+
+    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))));
+}
+
+module.exports = {
+    BaseHttpServer,
+    ENCODINGS,
+    HTTP_OPTIONS,
+    METHODS: {GET: 'get', POST: 'post', PUT: 'put', DELETE: 'delete'}
+};

package/src/http/HttpServer.js

@@ -1,14 +1,14 @@
-const { BaseHttpServer } = require('./BaseHttpServer');
-
-/**
- * HTTP Server
- * @param {RedWebOptions} options - Configuration options for RedWeb.
- * @return {Object} Express application instance.
- */
-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}`));
-    return this;
-}
-
-module.exports = HttpServer;
+const { BaseHttpServer } = require('./BaseHttpServer');
+
+/**
+ * HTTP Server
+ * @param {RedWebOptions} options - Configuration options for RedWeb.
+ * @return {Object} Express application instance.
+ */
+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}`));
+    return this;
+}
+
+module.exports = HttpServer;

package/src/http/HttpsServer.js

@@ -1,17 +1,17 @@
-const https = require('https');
-const { BaseHttpServer } = require('./BaseHttpServer');
-const loadSslConfig = require('../sslConfig');
-
-/**
- * HTTPS Server
- * @param {RedWebOptions} options - Configuration options for RedWeb.
- * @return {Object} Express application instance.
- */
-function HttpsServer(options = {}) {
-    BaseHttpServer.call(this, options);
-    const sslOptions = loadSslConfig(this.ssl);
-    https.createServer(sslOptions, this.app).listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpsServer listening on port ${this.port}`));
-    return this;
-}
-
-module.exports = HttpsServer;
+const https = require('https');
+const { BaseHttpServer } = require('./BaseHttpServer');
+const loadSslConfig = require('../sslConfig');
+
+/**
+ * HTTPS Server
+ * @param {RedWebOptions} options - Configuration options for RedWeb.
+ * @return {Object} Express application instance.
+ */
+function HttpsServer(options = {}) {
+    BaseHttpServer.call(this, options);
+    const sslOptions = loadSslConfig(this.ssl);
+    https.createServer(sslOptions, this.app).listen(this.port, this.listenCallback ? this.listenCallback : () => console.log(`RedWeb HttpsServer listening on port ${this.port}`));
+    return this;
+}
+
+module.exports = HttpsServer;

package/src/http/index.js

@@ -1,2 +1,2 @@
-const { METHODS } = require('./BaseHttpServer');
+const { METHODS } = require('./BaseHttpServer');
 module.exports = { HttpServer: require('./HttpServer'), HttpsServer: require('./HttpsServer'), METHODS}

package/src/sslConfig.js

@@ -1,20 +1,20 @@
-const fs = require('fs');
-
-/**
- * Load SSL configuration
- * @param {Object} sslOptions - The SSL options object containing the paths to key and cert files.
- * @param {string} sslOptions.key - Path to the SSL key file.
- * @param {string} sslOptions.cert - Path to the SSL certificate file.
- * @return {Object} - The loaded SSL options containing key and cert.
- */
-function loadSslConfig(sslOptions) {
-    if (!sslOptions || !sslOptions.key || !sslOptions.cert) {
-        throw new Error('SSL key and certificate paths must be provided');
-    }
-    return {
-        key: fs.readFileSync(sslOptions.key),
-        cert: fs.readFileSync(sslOptions.cert)
-    };
-}
-
-module.exports = loadSslConfig;
+const fs = require('fs');
+
+/**
+ * Load SSL configuration
+ * @param {Object} sslOptions - The SSL options object containing the paths to key and cert files.
+ * @param {string} sslOptions.key - Path to the SSL key file.
+ * @param {string} sslOptions.cert - Path to the SSL certificate file.
+ * @return {Object} - The loaded SSL options containing key and cert.
+ */
+function loadSslConfig(sslOptions) {
+    if (!sslOptions || !sslOptions.key || !sslOptions.cert) {
+        throw new Error('SSL key and certificate paths must be provided');
+    }
+    return {
+        key: fs.readFileSync(sslOptions.key),
+        cert: fs.readFileSync(sslOptions.cert)
+    };
+}
+
+module.exports = loadSslConfig;

package/src/ws/BaseSocketServer.js

@@ -1,81 +1,95 @@
-const WebSocket = require('ws');
-
-/**
- * @typedef {Object} SocketServerOptions
- * @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.
- * @property {Function} [messageCallback] - Callback function to execute for every message received.
- * @property {Object} [messageHandlers] - Object containing message handlers based on message type.
- * @property {Object} [ssl] - SSL configuration for SecureSocketServer.
- * @property {string} [ssl.key] - Path to the SSL key file.
- * @property {string} [ssl.cert] - Path to the SSL certificate file.
- */
-
-const SOCKET_OPTIONS = {
-    port: 3000,
-    connectionOpenCallback: undefined,
-    connectionCloseCallback: undefined,
-    messageCallback: undefined,
-    messageHandlers: {
-        ping: (socket, data) => socket.send(JSON.stringify({ type: 'pong' }))
-    },
-    ssl: null
-};
-
-class BaseSocketServer {
-    /**
-     * Base Socket Server
-     * @param {Object} server - The HTTP or HTTPS server instance.
-     * @param {SocketServerOptions} options - Configuration options for SocketServer.
-     */
-    constructor(server, options = {}) {
-        this.wss = new WebSocket.Server({ server });
-        this.clients = new Map();  // Use a Map to store clients by their IP addresses
-        Object.assign(this, { ...SOCKET_OPTIONS, ...options });
-
-        this.wss.on('connection', this.handleConnection.bind(this));
-    }
-
-    handleConnection(socket, req) {
-        const ip = req.socket.remoteAddress;
-        console.log(`New client connected: ${ip}`);
-        this.clients.set(ip, socket);
-
-        if (this.connectionOpenCallback) this.connectionOpenCallback(socket);
-
-        socket.on('message', (message) => this.handleMessage(socket, message, ip));
-        socket.on('close', () => this.handleClose(socket, ip));
-        socket.on('error', (error) => this.handleError(socket, error, ip));
-    }
-
-    handleMessage(socket, message, ip) {
-        try {
-            console.info(`Received message from ${ip}: ${message}`);
-            if (this.messageCallback) this.messageCallback(socket, message);
-
-            const { type, data } = JSON.parse(message);
-            if (this.messageHandlers[type]) {
-                this.messageHandlers[type](socket, data);
-            }
-        } catch (error) {
-            console.error(`Error handling message from ${ip}:`, error);
-        }
-    }
-
-    handleClose(socket, ip) {
-        console.log(`Client disconnected: ${ip}`);
-        this.clients.delete(ip);
-        if (this.connectionCloseCallback) this.connectionCloseCallback(socket);
-    }
-
-    handleError(socket, error, ip) {
-        console.error(`Socket error from ${ip}:`, error);
-    }
-
-    broadcast(type, data) {
-        this.clients.forEach(client => client.send(JSON.stringify({type, data})));
-    }
-}
-
-module.exports = {BaseSocketServer, SOCKET_OPTIONS};
+const WebSocket = require('ws');
+
+/**
+ * @typedef {Object} SocketServerOptions
+ * @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.
+ * @property {Function} [messageCallback] - Callback function to execute for every message received.
+ * @property {Object} [messageHandlers] - Object containing message handlers based on message type.
+ * @property {Object} [ssl] - SSL configuration for SecureSocketServer.
+ * @property {string} [ssl.key] - Path to the SSL key file.
+ * @property {string} [ssl.cert] - Path to the SSL certificate file.
+ */
+
+const SOCKET_OPTIONS = {
+    port: 3000,
+    connectionOpenCallback: undefined,
+    connectionCloseCallback: undefined,
+    messageCallback: undefined,
+    messageHandlers: {
+        ping: (socket, data) => socket.send(JSON.stringify({ type: 'pong' }))
+    },
+    ssl: null
+};
+
+/**
+ * 
+ * @param {BaseSocketServer} socketServer 
+ * @param {Object} message 
+ */
+function broadcast(socketServer, message) {
+    socketServer.clients.forEach(client => client.send(JSON.stringify(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 = {}) {
+        this.wss = new WebSocket.Server({ server });
+        this.clients = new Map();  // Use a Map to store clients by their IP addresses
+        Object.assign(this, { ...SOCKET_OPTIONS, ...options });
+
+        this.wss.on('connection', this.handleConnection.bind(this));
+    }
+
+    handleConnection(socket, req) {
+        const ip = req.socket.remoteAddress;
+        console.log(`New client connected: ${ip}`);
+        this.clients.set(ip, socket);
+
+        if (this.connectionOpenCallback) this.connectionOpenCallback(socket);
+
+        socket.on('message', (message) => this.handleMessage(socket, message, ip));
+        socket.on('close', () => this.handleClose(socket, ip));
+        socket.on('error', (error) => this.handleError(socket, error, ip));
+    }
+
+    handleMessage(socket, message, ip) {
+        try {
+            console.info(`Received message from ${ip}: ${message}`);
+            if (this.messageCallback) this.messageCallback(socket, message);
+
+            const { type, data } = JSON.parse(message);
+            if (this.messageHandlers[type]) {
+                this.messageHandlers[type](socket, data);
+            }
+        } catch (error) {
+            console.error(`Error handling message from ${ip}:`, error);
+        }
+    }
+
+    handleClose(socket, ip) {
+        console.log(`Client disconnected: ${ip}`);
+        this.clients.delete(ip);
+        if (this.connectionCloseCallback) this.connectionCloseCallback(socket);
+    }
+
+    handleError(socket, error, ip) {
+        console.error(`Socket error from ${ip}:`, error);
+    }
+    
+/**
+ * 
+ * This sends the same message to all clients.
+ * @param {Object} message 
+ */
+    broadcast(message) {
+        broadcast(this, message);
+    }
+}
+
+module.exports = {BaseSocketServer, SOCKET_OPTIONS};

package/src/ws/SecureSocketServer.js

@@ -1,20 +1,20 @@
-const https = require('https');
-const loadSslConfig = require('../sslConfig');
-const { BaseSocketServer } = require('./baseSocketServer');
-
-/**
- * Secure WebSocket Server
- * @param {SocketServerOptions} options - Configuration options for SecureSocketServer.
- * @return {Object} WebSocket server instance.
- */
-class SecureSocketServer extends BaseSocketServer {
-    constructor(options = {}) {
-        const sslOptions = loadSslConfig(options.ssl);
-        const server = https.createServer(sslOptions);
-        super(server, options);
-        server.listen(this.port, () => console.log(`RedWeb SecureSocketServer listening on port ${this.port}`));
-        return this;
-    }
-}
-
-module.exports = SecureSocketServer;
+const https = require('https');
+const loadSslConfig = require('../sslConfig');
+const { BaseSocketServer } = require('./BaseSocketServer');
+
+/**
+ * Secure WebSocket Server
+ * @param {SocketServerOptions} options - Configuration options for SecureSocketServer.
+ * @return {Object} WebSocket server instance.
+ */
+class SecureSocketServer extends BaseSocketServer {
+    constructor(options = {}) {
+        const sslOptions = loadSslConfig(options.ssl);
+        const server = https.createServer(sslOptions);
+        super(server, options);
+        server.listen(this.port, () => console.log(`RedWeb SecureSocketServer listening on port ${this.port}`));
+        return this;
+    }
+}
+
+module.exports = SecureSocketServer;

package/src/ws/SocketServer.js

@@ -1,18 +1,18 @@
-const http = require('http');
-const { BaseSocketServer } = require('./baseSocketServer');
-
-/**
- * WebSocket Server
- * @param {SocketServerOptions} options - Configuration options for SocketServer.
- * @return {Object} WebSocket server instance.
- */
-class SocketServer extends BaseSocketServer {
-    constructor(options = {}) {
-        const server = http.createServer();
-        super(server, options);
-        server.listen(this.port, () => console.log(`RedWeb SocketServer listening on port ${this.port}`));
-        return this;
-    }
-}
-
-module.exports = SocketServer;
+const http = require('http');
+const { BaseSocketServer } = require('./BaseSocketServer');
+
+/**
+ * WebSocket Server
+ * @param {SocketServerOptions} options - Configuration options for SocketServer.
+ * @return {Object} WebSocket server instance.
+ */
+class SocketServer extends BaseSocketServer {
+    constructor(options = {}) {
+        const server = http.createServer();
+        super(server, options);
+        server.listen(this.port, () => console.log(`RedWeb SocketServer listening on port ${this.port}`));
+        return this;
+    }
+}
+
+module.exports = SocketServer;

package/src/ws/index.js

@@ -1,6 +1,6 @@
-const { SOCKET_OPTIONS } = require('./BaseSocketServer');
-module.exports = { 
-    SecureSocketServer: require('./SecureSocketServer'),
-    SocketServer: require('./SocketServer'),
-    SOCKET_OPTIONS
+const { SOCKET_OPTIONS } = require('./BaseSocketServer');
+module.exports = { 
+    SecureSocketServer: require('./SecureSocketServer'),
+    SocketServer: require('./SocketServer'),
+    SOCKET_OPTIONS
 }