redweb 0.1.3 → 0.1.5

package/HttpServer.js

@@ -0,0 +1,88 @@
+const express = require('express');
+const bodyParser = require('body-parser');
+const path = require('path');
+const https = require('https');
+const loadSslConfig = require('./sslConfig');
+
+/**
+ * @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 METHODS = { POST: 'post', GET: 'get' };
+
+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))));
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 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 = {
+    HttpServer,
+    HttpsServer,
+    ENCODINGS,
+    METHODS,
+    HTTP_OPTIONS
+};

package/SocketServer.js

@@ -0,0 +1,98 @@
+const http = require('http');
+const https = require('https');
+const socketIo = require('socket.io');
+const loadSslConfig = require('./sslConfig');
+
+/**
+ * @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) => socket.send('pong')
+    },
+    ssl: null
+};
+
+/**
+ * Base Socket Server
+ * @param {Object} server - The HTTP or HTTPS server instance.
+ * @param {SocketServerOptions} options - Configuration options for SocketServer.
+ * @return {Object} Socket.IO server instance.
+ */
+function BaseSocketServer(server, options = {}) {
+    this.io = socketIo(server);
+    Object.assign(this, { ...SOCKET_OPTIONS, ...options });
+
+    this.io.on('connection', socket => {
+        console.log('New client connected');
+        if (this.connectionOpenCallback) this.connectionOpenCallback(socket);
+
+        socket.on('message', (message) => {
+            try {
+                const parsedMessage = JSON.parse(message);
+                const { type, data } = parsedMessage;
+
+                if (this.messageHandlers[type]) {
+                    this.messageHandlers[type](socket, data);
+                }
+
+                if (this.messageCallback) this.messageCallback(socket, message);
+            } catch (error) {
+                console.error('Error handling message:', error);
+            }
+        });
+
+        socket.on('disconnect', () => {
+            console.log('Client disconnected');
+            if (this.connectionCloseCallback) this.connectionCloseCallback(socket);
+        });
+
+        socket.on('error', (error) => {
+            console.error('Socket error:', error);
+        });
+    });
+}
+
+/**
+ * WebSocket Server
+ * @param {SocketServerOptions} options - Configuration options for SocketServer.
+ * @return {Object} Socket.IO server instance.
+ */
+function SocketServer(options = {}) {
+    const server = http.createServer();
+    BaseSocketServer.call(this, server, options);
+    server.listen(this.port, () => console.log(`RedWeb SocketServer listening on port ${this.port}`));
+    return this.io;
+}
+
+/**
+ * Secure WebSocket Server
+ * @param {SocketServerOptions} options - Configuration options for SecureSocketServer.
+ * @return {Object} Socket.IO server instance.
+ */
+function SecureSocketServer(options = {}) {
+    const sslOptions = loadSslConfig(options.ssl);
+    const server = https.createServer(sslOptions);
+    BaseSocketServer.call(this, server, options);
+    server.listen(this.port, () => console.log(`RedWeb SecureSocketServer listening on port ${this.port}`));
+    return this.io;
+}
+
+module.exports = {
+    SocketServer,
+    SecureSocketServer,
+    SOCKET_OPTIONS
+};

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "redweb",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A way to quickly set up an express server",
   "main": "index.js",
   "scripts": {
     "test": "jest"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "HttpServer.js",
+    "SocketServer.js",
+    "sslConfig.js"
   ],
   "keywords": [],
   "author": "",

package/sslConfig.js

@@ -0,0 +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;