merge dev

Author: alexdeploy

Procfile

@@ -20,6 +20,14 @@
 
 Secure and easy-to-configure user authentication API developed using Node.js, Express, and MongoDB. It provides robust **password encryption**, **token-based authentication**, **email verification**, and **seamless email delivery** integration. With its straightforward setup, this project enables developers to quickly build a reliable and secure API user authentication system for their applications.
 
+1. [Instalation](#📥-installation)
+2. [Configuration](#⚙️-configuration)
+    - API
+    - Database
+    - Custom domain
+    - Email sending
+3. [Deploying](#🚀-deploying)
+
   ## 🧩 Features
 
 - ✅ Login attempts limited.
@@ -99,11 +107,12 @@ heroku login
 
 Y persionamos ENTER. Nos abrirá una ventana para hacer login en nuestra cuenta de heroku.
 
+Creamos una nueva app en heroku
+
 ````bash
 heroku create -a app-name
 ````
 
-Esto creará una nueva app en heroku.
 
 Comprobamos que se ha configurado correctamente con:
 
@@ -119,7 +128,10 @@ git remote -v
 > origin  https://github.com/alexdeploy/node-auth-api.git (push)
 ````
 
-Configuramos las variables de entorno en heroku.
+Ahora vamos a configurar nuestras variables de entorno en heroku.
+
+Introducimos todos las claves y valores del archivo `.env`.
+
 
 ````bash
 heroku config:set NOMBRE_VARIABLE=valor
@@ -131,9 +143,7 @@ Comprobamos que se han guardado correctamente
 heroku config
 ````
 
-Vamos a nuestra aplicación -> Settings -> Config Bars.
 
-Introducimos todos las claves y valores del archivo `.env`.
 
 ````bash
 # Desplegar la rama main
@@ -149,11 +159,15 @@ NOTAS IMPORTANTES SOBRE HEROKU CLI
 
 - Para volver a hacer deploy en caso de falla, tienes que realizar por lo menos un `git commit`
 
-### Set a custom domain
+## 🌎 Set a custom domain
 
-Vamos a hacerlo utilizando los <a href="https://devcenter.heroku.com/articles/custom-domains">comandos `domain` de Heroku CLI</a>.
+> ➕ Proveedor de dominio
 
-Si ya tenemos nuestro proveedor de dominios y nuestro dominio:
+Vamos a hacerlo utilizando los <a href="https://devcenter.heroku.com/articles/heroku-cli-commands">comandos de Heroku CLI</a>.
+
+Pero también puedes ver de forma más detallada <a href="https://devcenter.heroku.com/articles/custom-domains">cómo configurar un dominio personalizado en Heroku</a>.
+
+Añadimos un dominio a nuestro Heroku
 
 ````bash
 heroku domains:add www.example.com
@@ -171,7 +185,9 @@ heroku domains
 
 Si te equivocas, se pueden borrar con `heroku domains:remove www.example.com`.
 
-El DNS Target es el que tenemos que introducir en el valor CNAME de los registros DNS de nuestro dominio. El proveedor de dominio en este caso va a ser <a href="https://www.hostinger.com/">hostinger.com</a>.
+El DNS Target es el que tenemos que introducir en el valor CNAME de los registros DNS de nuestro dominio. El proveedor de dominio en este caso va a ser <a href="https://www.hostinger.com/">hostinger.com</a>. 
+
+> ¿Hay que borrar todos los otros valores CNAME del dominio?
 
 Quedando así:
 
@@ -181,6 +197,9 @@ Quedando así:
 
 En caso de un subdominio, habría que introducir solo su nombre, por ejemplo introduciendo `api`, apuntaría a `api.example.com`.
 
+## 📧 Configure email sending
+
+
 
 ## 📜 Documentation
 

README.md

@@ -0,0 +1,4 @@
+// TODO: Testear el middleware de autorización
+// TODO: Testear las funciones de verificación de tokens y su expiración
+// TODO: Testear el bloqueo de cuentas por intentos fallidos de inicio de sesión
+// TODO: Testear el envío de correos electrónicos

__tests__/authorization.test.js

@@ -8,7 +8,7 @@ class Config {
 
   buildConfigurations() {
     const configDirPath = path.join(__dirname, "config");
-    const allowedExtension = ".config.js";
+    const allowedExtension = ".config.js"; // Only load config.js files
 
     // Read all files from /config path
     fs.readdirSync(configDirPath).forEach((file) => {

api.config.js

@@ -2,20 +2,23 @@ module.exports = {
     // Opciones de configuración para CORS
     options: {
         // 1. Origen permitido para las solicitudes (valor por defecto: '*')
-        origin: '*', // Recomendación: Establece el dominio o URL desde donde se permitirán las solicitudes. 
-    
+        origin: '*', // Recomendación: Establece el dominio o URL desde donde se permitirán las solicitudes.
+
         // 2. Métodos HTTP permitidos (valor por defecto: 'GET,HEAD,PUT,PATCH,POST,DELETE')
         methods: 'GET,POST,PUT,DELETE', // Recomendación: Define los métodos HTTP que se pueden utilizar en las solicitudes. Ajusta según las necesidades de tu API.
 
         // 3. Encabezados permitidos en las solicitudes (valor por defecto: 'Content-Type')
-        allowedHeaders: 'Authorization,Content-Type', // Recomendación: Indica qué encabezados se permiten en las solicitudes. Habilita el encabezado 'Authorization' para permitir autenticación con tokens.
-    
+        allowedHeaders: 'Authorization,Content-Type,Access-Control-Allow-Origin', // Recomendación: Indica qué encabezados se permiten en las solicitudes. Habilita el encabezado 'Authorization' para permitir autenticación con tokens.
+     
         // 4. Encabezados expuestos en las respuestas (valor por defecto: '')
-        exposedHeaders: 'Authorization', // Recomendación: Define qué encabezados se pueden mostrar en las respuestas del servidor. Exponer el encabezado 'Authorization' permite que el cliente acceda a ese encabezado en las respuestas.
+        /* exposedHeaders: 'Authorization', */ // Recomendación: Define qué encabezados se pueden mostrar en las respuestas del servidor. Exponer el encabezado 'Authorization' permite que el cliente acceda a ese encabezado en las respuestas.
 
         // 5. Permitir el uso de credenciales (valor por defecto: false)
-        credentials: true, // Recomendación: Habilita el uso de credenciales (como cookies o encabezados de autorización) en las solicitudes para permitir autenticación con credenciales.
-    
+        /* credentials: true, */ // Recomendación: Habilita el uso de credenciales (como cookies o encabezados de autorización) en las solicitudes para permitir autenticación con credenciales.
+        
+        preflightContinue: false,
+
+        optionsSuccessStatus: 204,
         // 6. Tiempo en segundos para cachear las opciones preflight (valor por defecto: 86400 segundos / 24 horas)
         maxAge: 3600 // Recomendación: Especifica el tiempo en segundos que los navegadores deben almacenar en caché las opciones preflight. Ajusta según las necesidades de tu API.
     }

config/cors.config.js

@@ -2,8 +2,10 @@ require('dotenv').config();
 
 module.exports = {
     name: {
-        server: 'http://localhost',
-        client: 'http://localhost'
+        prod_server: 'https://api.alexrueda.dev',
+        prod_client: 'https://app.alexrueda.dev',
+        dev_server: 'http://localhost',
+        dev_client: 'http://localhost'
     },
     port: {
         server: process.env.PORT_SERVER || 5000,

config/domain.config.js

@@ -1,6 +1,6 @@
 module.exports = {
     verification: {
-        active: true,
+        active: false,
         method: 'email', // 'email' or 'phone'
     }
 }

config/register.config.js

@@ -0,0 +1,127 @@
+module.exports = {
+    auth: {
+        sign_up: {
+            success: {
+                code: 200,
+                value: 'sign_up_success',
+                message: 'Sign up successfull'
+            },
+            error: {
+                email_already_exists: {
+                    code: 400,
+                    value: 'email_already_exists',
+                    message: 'Email already exists'
+                },
+                username_already_exists: {
+                    code: 400,
+                    value: 'username_already_exists',
+                    message: 'Username already exists'
+                },
+                incorrect_password: {
+                    code: 400,
+                    value: 'incorrect_password',
+                    message: 'Incorrect password'
+                },
+                invalid_email: {
+                    // In case the email don't match the regex
+                    code: 400,
+                    value: 'invalid_email',
+                    message: 'Invalid email'
+                },
+                invalid_username: {
+                    // In case the username don't match the regex
+                    code: 400,
+                    value: 'invalid_username',
+                    message: 'Invalid username'
+                },
+                invalid_password: {
+                    // In case the password don't match the regex
+                    code: 400,
+                    value: 'invalid_password',
+                    message: 'Invalid password'
+                },
+            }
+        },
+        sign_in: {
+            success: {
+                code: 200,
+                value: 'sign_in_success',
+                message: 'Sign in success'
+            },
+            error: {
+                user_not_found: {
+                    code: 404,
+                    value: 'user_not_found',
+                    message: 'User not found'
+                },
+                user_is_locked: {
+                    code: 423,
+                    value: 'user_is_locked',
+                    message: 'User is locked'
+                },
+                user_is_not_verified: {
+                    code: 400,
+                    value: 'user_is_not_verified',
+                    message: 'User is not verified'
+                },
+                incorrect_password: {
+                    code: 401,
+                    value: 'incorrect_password',
+                    message: 'Incorrect password'
+                },
+                invalid_email: {
+                    // In case the email don't match the regex
+                    code: 400,
+                    value: 'invalid_email',
+                    message: 'Invalid email. The email does not match the regex'
+                },
+                invalid_username: {
+                    // In case the username don't match the regex
+                    code: 400,
+                    value: 'invalid_username',
+                    message: 'Invalid username. The username does not match the regex'
+                },
+                invalid_password: {
+                    // In case the password don't match the regex
+                    code: 400,
+                    value: 'invalid_password',
+                    message: 'Invalid password. The password does not match the regex'
+                },
+                max_attempt_reached: {
+                    code: 429,
+                    value: 'max_attempt_reached',
+                    message: 'Max sign in attempts reached'
+                },
+            }
+        },
+        forgot_password: {
+            success: {},
+            error: {}
+        },
+        reset_password: {
+            success: {},
+            error: {}
+        },
+        verify_email: {
+            success: {},
+            error: {}
+        },
+        verify_phone: {
+            success: {},
+            error: {}
+        },
+        verify_token: {
+            success: {},
+            error: {}
+        },
+        server: {
+            success: {},
+            error: {
+                internal: {
+                    code: 500,
+                    message: 'Internal server error'
+                }
+            }
+        }
+    }
+}

config/response.config.js

@@ -23,4 +23,9 @@ module.exports = {
         name: 'guest',
         description: 'Guest'
     },
+    all: {
+        id: 999,
+        name: 'all',
+        description: 'All Roles'
+    }
 }

config/roles.config.js

@@ -2,6 +2,8 @@
 // Security Configuration
 ///////////////////////////////
 
+// expiration accepted values: 1m = 1 minute, 1h = 1 hour, 1d = 1 day, 1w = 1 week
+
 /**
  * @module security.config
  * @description Defines the user roles
@@ -10,6 +12,26 @@ module.exports = {
     logginAttempts: {
         active: true,
         max: 5,
-        lockTime: 1
+        lockTime: 1 // minutes
+    },
+    tokens: {
+        session: {
+            active: true,
+            expiration: '1d' // 1m = 1 minute, 1h = 1 hour, 1d = 1 day, 1w = 1 week
+        },
+        reset_password: {
+            active: true,
+            expiration: '1h'
+        },
+        verification: {
+            phone: {
+                active: true,
+                expiration: '1d'
+            },
+            email: {
+                active: true,
+                expiration: '30m'
+            }
+        },
     }
 }