npm - redweb - Versions diffs - 0.2.8 → 0.3.0 - Mend

redweb 0.2.8 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/README.md +88 -4
package/index.js +4 -8
package/package.json +2 -5
package/{HttpServer.js → src/http/BaseHttpServer.js} +1 -30
package/src/http/HttpServer.js +14 -0
package/src/http/HttpsServer.js +17 -0
package/src/ws/BaseSocketServer.js +75 -0
package/src/ws/SecureSocketServer.js +18 -0
package/src/ws/SocketServer.js +16 -0
package/SocketServer.js +0 -104
/package/{sslConfig.js → src/sslConfig.js} +0 -0

package/README.md CHANGED Viewed

@@ -1,3 +1,8 @@
+You're right, let's provide more detailed instructions for setting up an HTTP server, including details about the `publicPaths` property and providing a sample HTML file.
+### `README.md`
+```markdown
 # RedWeb
 RedWeb is a simple and flexible Node.js framework built on top of Express.js and WebSocket. It allows you to quickly set up web servers and WebSocket servers with customizable options.
@@ -88,7 +93,7 @@ const options = {
         console.log('WebSocket client disconnected');
     },
     messageHandlers: {
-        'msg': () => (socket, data) => {
+        'msg': (socket, data) => {
             console.log(data);
             socket.send('guuuuuurl');
         }
@@ -116,7 +121,7 @@ const options = {
         console.log('WebSocket client disconnected');
     },
     messageHandlers: {
-        'msg': () (socket, data) => {
+        'msg': (socket, data) => {
             console.log(data);
             socket.send('guuuuuurl');
         }
@@ -142,7 +147,7 @@ const socketServer = new SocketServer({
         console.log('WebSocket client disconnected');
     },
     messageHandlers: {
-        'msg': () => (socket, data) {
+        'msg': (socket, data) => {
             console.log(data);
             socket.send('guuuuuurl');
         }
@@ -174,6 +179,85 @@ console.log(socketServer.clients); // Map of clients by their IP addresses
 - **messageHandlers**: Object containing message handlers based on message type.
 - **ssl**: SSL configuration for SecureSocketServer (`{ key: './path/to/key.pem', cert: './path/to/cert.pem' }`).
+## HowTo
+### Setting Up an HTTP Server
+1. **Install RedWeb**: Run `npm install redweb`.
+2. **Create a new directory** (e.g., `public`) to store your static files and add an `index.html` file:
+    ```html
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>RedWeb HTTP Server</title>
+    </head>
+    <body>
+        <h1>Welcome to RedWeb HTTP Server!</h1>
+    </body>
+    </html>
+    ```
+3. **Create a new file** (e.g., `server.js`) and add the following code:
+    ```javascript
+    const { HttpServer } = require('redweb');
+    const services = [
+        {
+            serviceName: '/api/hello',
+            method: 'get',
+            function: (req, res) => {
+                res.send('Hello World!');
+            }
+        }
+    ];
+    const options = {
+        port: 3000,
+        publicPaths: ['./public'],
+        services: services
+    };
+    const app = new HttpServer(options);
+    ```
+4. **Run your server**: Execute `node server.js`.
+### Setting Up a WebSocket Server
+1. **Install RedWeb**: Run `npm install redweb`.
+2. **Create a new file** (e.g., `socketServer.js`) and add the following code:
+    ```javascript
+    const { SocketServer } = require('redweb');
+    const options = {
+        port: 3000,
+        connectionOpenCallback: (socket) => {
+            console.log('WebSocket client connected');
+        },
+        connectionCloseCallback: (socket) => {
+            console.log('WebSocket client disconnected');
+        },
+        messageHandlers: {
+            'msg': (socket, data) => {
+                console.log(data);
+                socket.send('guuuuuurl');
+            }
+        }
+    };
+    const socketServer = new SocketServer(options);
+    ```
+3. **Run your server**: Execute `node socketServer.js`.
 ## License
-MIT License
+MIT License
+```
+This `README.md` now includes more detailed instructions for setting up an HTTP server, including the creation of a `public` directory and a sample `index.html` file.

package/index.js CHANGED Viewed

@@ -1,13 +1,9 @@
-const { HttpServer, HttpsServer, ENCODINGS, METHODS, HTTP_OPTIONS } = require('./HttpServer');
-const { SocketServer, SecureSocketServer, SOCKET_OPTIONS } = require('./SocketServer');
+const SocketServer = require('./SocketServer');
+const SecureSocketServer = require('./SecureSocketServer');
+const { SOCKET_OPTIONS } = require('./BaseSocketServer');
 module.exports = {
-    HttpServer,
-    HttpsServer,
     SocketServer,
     SecureSocketServer,
-    ENCODINGS,
-    METHODS,
-    HTTP_OPTIONS,
     SOCKET_OPTIONS
-};
+};

package/package.json CHANGED Viewed

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

package/{HttpServer.js → src/http/BaseHttpServer.js} RENAMED Viewed

@@ -1,8 +1,6 @@
 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
@@ -23,8 +21,6 @@ const loadSslConfig = require('./sslConfig');
  */
 const ENCODINGS = { json: 'json', urlencoded: 'urlencoded' };
-const METHODS = { POST: 'post', GET: 'get' };
 const HTTP_OPTIONS = {
     port: 80,
     bind: '0.0.0.0',
@@ -56,33 +52,8 @@ function BaseHttpServer(options = {}) {
     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,
+    BaseHttpServer,
     ENCODINGS,
-    METHODS,
     HTTP_OPTIONS
 };

package/src/http/HttpServer.js ADDED Viewed

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

package/src/http/HttpsServer.js ADDED Viewed

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

package/src/ws/BaseSocketServer.js ADDED Viewed

@@ -0,0 +1,75 @@
+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
+};
+/**
+ * Base Socket Server
+ * @param {Object} server - The HTTP or HTTPS server instance.
+ * @param {SocketServerOptions} options - Configuration options for SocketServer.
+ */
+function BaseSocketServer(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));
+}
+BaseSocketServer.prototype.handleConnection = function (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));
+};
+BaseSocketServer.prototype.handleMessage = function (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);
+    }
+};
+BaseSocketServer.prototype.handleClose = function (socket, ip) {
+    console.log(`Client disconnected: ${ip}`);
+    this.clients.delete(ip);
+    if (this.connectionCloseCallback) this.connectionCloseCallback(socket);
+};
+BaseSocketServer.prototype.handleError = function (socket, error, ip) {
+    console.error(`Socket error from ${ip}:`, error);
+};
+module.exports = BaseSocketServer;

package/src/ws/SecureSocketServer.js ADDED Viewed

@@ -0,0 +1,18 @@
+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.
+ */
+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;
+}
+module.exports = SecureSocketServer;

package/src/ws/SocketServer.js ADDED Viewed

@@ -0,0 +1,16 @@
+const http = require('http');
+const BaseSocketServer = require('./BaseSocketServer');
+/**
+ * WebSocket Server
+ * @param {SocketServerOptions} options - Configuration options for SocketServer.
+ * @return {Object} WebSocket 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;
+}
+module.exports = SocketServer;

package/SocketServer.js DELETED Viewed

@@ -1,104 +0,0 @@
-const http = require('http');
-const https = require('https');
-const WebSocket = require('ws');
-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': function(socket, data) { socket.send(JSON.stringify({ type: 'pong' })); }
-    },
-    ssl: null
-};
-/**
- * Base Socket Server
- * @param {Object} server - The HTTP or HTTPS server instance.
- * @param {SocketServerOptions} options - Configuration options for SocketServer.
- */
-function BaseSocketServer(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', (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) => {
-            try {
-                console.info(`Received message from ${ip}: ${message}`);
-                if (this.messageCallback) this.messageCallback(socket, message);
-                const parsedMessage = JSON.parse(message);
-                const { type, data } = parsedMessage;
-                if (this.messageHandlers[type]) {
-                    this.messageHandlers[type](socket, data);
-                }
-            } catch (error) {
-                console.error(`Error handling message from ${ip}:`, error);
-            }
-        });
-        socket.on('close', () => {
-            console.log(`Client disconnected: ${ip}`);
-            this.clients.delete(ip);
-            if (this.connectionCloseCallback) this.connectionCloseCallback(socket);
-        });
-        socket.on('error', (error) => {
-            console.error(`Socket error from ${ip}:`, error);
-        });
-    });
-    return this;
-}
-/**
- * WebSocket Server
- * @param {SocketServerOptions} options - Configuration options for SocketServer.
- * @return {Object} WebSocket 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;
-}
-/**
- * Secure WebSocket Server
- * @param {SocketServerOptions} options - Configuration options for SecureSocketServer.
- * @return {Object} WebSocket 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;
-}
-module.exports = {
-    SocketServer,
-    SecureSocketServer,
-    SOCKET_OPTIONS
-};

/package/{sslConfig.js → src/sslConfig.js} RENAMED Viewed

File without changes