zyket 1.0.1 → 1.0.3

package/README.md

@@ -1,3 +1,139 @@
 # ZYKET - Easy Socket.io Framework
 
-Zyket is a framework inspired by Symfony. 
+Zyket is a framework inspired by Symfony that simplifies working with Socket.io by providing a structured approach.
+
+# Getting Started
+
+To use zyket we need to install it into our project:
+
+```javascript
+npm i zyket
+```
+
+Then we just need to import the Kernel and boot it:
+
+```javascript
+const { Kernel } = require("zyket");
+const kernel = new Kernel();
+
+kernel.boot().then(() => console.log(`Kernel Booted`));
+```
+
+After boot is done for fist time, project folders/files will be created if doesnt exists.
+
+## Handlers
+
+Handlers are the way to interact with user messages on the socket:
+```javascript
+const { Handler } = require("zyket");
+
+module.exports = class MessageHandler extends Handler {
+    middlewares = ["default"];
+
+    async handle({ container, socket, data, io }) {
+        container.get("logger").info("Message handler");
+    }
+};
+```
+
+- middlewares: An array of middleware names that should be executed before the handler.
+
+- handle(): The function that processes the event, receiving container, socket, and data.
+
+## Middlewares
+
+Middlewares allow you to process data before it reaches the handler. They can be used for validation, authentication, logging, etc.
+
+```javascript
+const { Middleware } = require("zyket");
+
+module.exports = class DefaultMiddleware extends Middleware {
+    async handle({ container, socket, io }) {
+        container.get("logger").info("Default middleware");
+    }
+};
+```
+
+- handle(): The function that processes the event, receiving container, socket, and data.
+
+
+## Services
+Services are reusable components specified in the kernel configuration. Each service must include a boot() function that is executed when the kernel starts.
+
+```javascript
+module.exports = class LoggerService {
+    this.#container;
+    
+    boot(container, enableLogging = true) {
+        this.#container = container;
+        console.log("LoggerService Booted");
+    }
+
+    info(message) {
+        if(!enableLogging) return;
+        console.log(`[INFO]: ${message}`);
+    }
+};
+```
+
+Then, when booting the kernel, specify the service:
+
+```javascript
+const { Kernel } = require("zyket");
+const LoggerService = require("./LoggerService");
+
+const kernel = new Kernel({
+    services: [["logger", LoggerService, ['@service_container', true]],
+});
+
+kernel.boot().then(() => console.log(`Kernel Booted`));
+```
+
+## Default Services
+Zyket includes some default services that provide essential functionality. These services can be overridden or extended if needed.
+
+#### Cache Services
+- **Name** `cache`
+- **Description** Provides caching functionality using a Redis adapter.
+- **Configuration** Add `CACHE_URL` in your `.env` file to activate caching.
+
+#### Database Service
+- **Name** `database`
+- **Description** Manages database connections using a MariaDB/Sequelize adapter.
+- **Configuration** Add `DATABASE_URL` in your `.env` file to enable the database connection.
+
+#### S3 Service
+- **Name** `s3`
+- **Description** Provides S3-compatible object storage using MinIO.
+- **Configuration** Add the following variables in your `.env` file to enable the service
+    - `S3_ENDPOINT`
+    - `S3_PORT`
+    - `S3_USE_SSL`
+    - `S3_ACCESS_KEY`
+    - `S3_SECRET_KEY`
+
+#### Logger Service
+- **Name** `logger`
+- **Description** Handles logging for the application.
+- **Configuration**
+    - Change `LOG_DIRECTORY` in `.env` file to set a custom log directory.
+    - Set `DEBUG` in `.env` file to enable or disable debug logging.
+
+#### Socket.io Service
+- **Name** `socketio`
+- **Description** Manages the WebSocket server.
+- **Configuration** Add `PORT` in your `.env` file to define the listening port for Socket.io.
+
+
+## Contributing
+
+We welcome contributions from the community! If you'd like to improve Zyket, feel free to:
+
+- Report issues and suggest features on GitHub Issues
+
+- Submit pull requests with bug fixes or enhancements
+
+- Improve the documentation
+
+Let's build a better framework together! 🚀
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zyket",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/src/services/database/index.js

@@ -18,7 +18,7 @@ module.exports = class Database extends Service {
   
   async boot() {
     this.#createModelsFolder();
-    this.sequelize = new Sequelize(process.env.DATABASE_URL, {
+    this.sequelize = new Sequelize(this.#databaseUrl, {
       dialect: process.env.DATABASE_DIALECT || 'mariadb',
       logging: (msg) => this.#container.get('logger').debug(msg),
       operatorsAliases: 0,

package/src/services/index.js

@@ -1,10 +1,11 @@
-const Database = require("./Database");
-const Cache = require("./Cache");
-const S3 = require("./S3");
+const Database = require("./database");
+const Cache = require("./cache");
+const S3 = require("./s3");
 const { SocketIO } = require("./socketio");
 
 module.exports = [
   ["logger", require("./Logger"), ["@service_container", process.env.LOG_DIRECTORY || `${process.cwd()}/logs`, process.env.DEBUG === "true"]],
+  ["template-manager", require("./template-manager"), ["@service_container"]],
   process.env.DATABASE_URL ? ["database", Database, ["@service_container", process.env.DATABASE_URL]] : null,
   process.env.CACHE_URL ? ["cache", Cache, ["@service_container", process.env.CACHE_URL]] : null,
   (process.env.S3_ENDPOINT && process.env.S3_ACCESS_KEY && process.env.S3_SECRET_KEY) ? ["s3", S3, ["@service_container", process.env.S3_ENDPOINT, process.env.S3_PORT, process.env.S3_USE_SSL === "true", process.env.S3_ACCESS_KEY, process.env.S3_SECRET_KEY]] : null,

package/src/services/socketio/SocketIO.js

@@ -40,9 +40,9 @@ module.exports = class SocketIO extends Service {
           this.#container.get('logger').warn(`You are using a middleware that does not exist`);
           continue;
         }
-        middleware.handle({ container: this.#container, socket });
+        middleware.handle({ container: this.#container, socket, io: this.io });
       }
-      connectionHandler.handle({ container: this.#container, socket });
+      connectionHandler.handle({ container: this.#container, socket, io: this.io });
       handlers.forEach((handler) => {
         const handlerMiddlewares = (handler?.middlewares || []).map(mdl => this.middlewares[mdl])
         socket.on(handler.event, async (data) => {
@@ -52,9 +52,9 @@ module.exports = class SocketIO extends Service {
               this.#container.get('logger').warn(`You are using a middleware that does not exist`);
               continue;
             }
-            await middleware.handle({ container: this.#container, socket });
+            await middleware.handle({ container: this.#container, socket, io: this.io });
           }
-          return await handler.handle({ container: this.#container, socket, data });
+          return await handler.handle({ container: this.#container, socket, data, io: this.io });
         });
       });
     });
@@ -65,15 +65,8 @@ module.exports = class SocketIO extends Service {
 
   async #loadConnectionHandler() {
     const connectionHandlerExists  = fs.existsSync(path.join(process.cwd(), "src", "handlers", "connection.js"));
-    /* if exists require, otherwise create a default one */
     if(!connectionHandlerExists) {
-      fs.writeFileSync(path.join(process.cwd(), "src", "handlers", "connection.js"), `const { Handler } = require("zyket");
-
-module.exports = class ConnectionHandler extends Handler {
-  async handle({ container, socket }) {
-    container.get("logger").info("New connection");
-  }
-};`);
+      this.#container.get('template-manager').installFile('default/src/handlers/connection', path.join(process.cwd(), "src", "handlers", "connection.js"));
     }
     return require(path.join(process.cwd(), "src", "handlers", "connection.js"));
   }
@@ -94,16 +87,7 @@ module.exports = class ConnectionHandler extends Handler {
     if (fs.existsSync(handlersFolder) && !overwrite) return;
     this.#container.get('logger').info(`Creating handlers folder at ${handlersFolder}`);
     fs.mkdirSync(handlersFolder);
-    // create a default handler
-    fs.writeFileSync(path.join(handlersFolder, "message.js"), `const { Handler } = require("zyket");
-module.exports = class MessageHandler extends Handler {
-  event = "message";
-  middlewares = ["default"];
-
-  async handle({ container, socket, data }) {
-    container.get("logger").info("Message handler");
-  }
-};`);
+    this.#container.get('template-manager').installFile('default/src/handlers/message', path.join(handlersFolder, "message.js"));
   }
 
   async #loadMiddlewaresFromFolder(middlewaresFolder) {
@@ -123,13 +107,7 @@ module.exports = class MessageHandler extends Handler {
     if (fs.existsSync(middlewaresFolder) && !overwrite) return;
     this.#container.get('logger').info(`Creating middlewares folder at ${middlewaresFolder}`);
     fs.mkdirSync(middlewaresFolder);
-    // create a default middleware
-    fs.writeFileSync(path.join(middlewaresFolder, "default.js"), `const { Middleware } = require("zyket");
-module.exports = class DefaultMiddleware extends Middleware {
-  async handle({ container, socket }) {
-    container.get("logger").info("Default middleware");
-  }
-};`);
+    this.#container.get('template-manager').installFile('default/src/middlewares/default', path.join(middlewaresFolder, "default.js"));
   }
 
   stop() {

package/src/services/template-manager/index.js

@@ -0,0 +1,67 @@
+const fg = require('fast-glob');
+const Service = require('../Service');
+const path = require('path');
+const fs = require('fs');
+
+module.exports = class TemplateManager extends Service {
+  #container;
+  templates = {}
+
+  constructor(container) {
+    super('template-manager');
+    this.#container = container;
+  }
+
+  async boot() {
+    const zyketTemplates = await fg(['**/*.js'], {
+      cwd: path.join(__dirname, '../../templates'),
+    });
+    for (const template of zyketTemplates) {
+      // need to copy full file  and relation with the name on templates variable
+      const templatePath = path.join(__dirname, '../../templates', template);
+      const templateContent = fs.readFileSync(templatePath, 'utf-8');
+      this.templates[template.replace('.js', '')] = templateContent;   
+    }
+
+    this.#container.get('logger').info(`Loaded ${this.templates.length} templates`);
+  }
+
+  installFile(fileName, location) {
+    const template = this.templates[fileName];
+    if (!template) throw new Error(`Template ${fileName} not found`);
+    return fs.writeFileSync(location, template);
+  }
+
+  installTemplate(templateName) {
+    const template = this.getTemplates().find((t) => t === templateName);
+    if (!template) throw new Error(`Template ${templateName} not found`);
+    const files = this.getTemplate(templateName);
+    
+    for (const file of files) {
+      const fileName = file.split('/').slice(1).join('/');
+      const fileLocation = path.join(process.cwd(), fileName);
+      if (fs.existsSync(fileLocation)) throw new Error(`File ${file} already exists`);
+    }
+
+    for (const file of files) {
+      const fileName = file.split('/').slice(1).join('/');
+      const template = this.templates[file];
+      const fileLocation = path.join(process.cwd(), fileName);
+      fs.writeFileSync(fileLocation, template);
+    }
+  }
+
+  getTemplates() {
+    const uniqueTemplates = new Set();
+    for (const template of Object.keys(this.templates)) {
+      uniqueTemplates.add(template.split('/')[0]);
+    }
+    return Array.from(uniqueTemplates);
+  }
+
+  getTemplate(templateName) {
+    const files = Object.keys(this.templates).filter((t) => t.startsWith(templateName));
+    if (files.length === 0) throw new Error(`Template ${templateName} not found`);
+    return files
+  }
+}

package/src/templates/default/src/handlers/connection.js

@@ -0,0 +1,7 @@
+const { Handler } = require("zyket");
+
+module.exports = class ConnectionHandler extends Handler {
+  async handle({ container, socket, io }) {
+    container.get("logger").info("New connection");
+  }
+};

package/src/templates/default/src/handlers/message.js

@@ -0,0 +1,9 @@
+const { Handler } = require("zyket");
+
+module.exports = class MessageHandler extends Handler {
+  middlewares = ["default"];
+
+  async handle({ container, socket, data, io }) {
+    container.get("logger").info("Message handler");
+  }
+};

package/src/templates/default/src/middlewares/default.js

@@ -0,0 +1,6 @@
+const { Middleware } = require("zyket");
+module.exports = class DefaultMiddleware extends Middleware {
+  async handle({ container, socket, io }) {
+    container.get("logger").info("Default middleware");
+  }
+};