@vidisoft/agendateapp-codes 1.0.1

package/README.md

@@ -0,0 +1,90 @@
+# @agendateapp/agendateapp-codes
+
+Este proyecto contiene una lista centralizada de códigos y mensajes que son manejados por las diferentes aplicaciones de la plataforma AgendateApp.
+
+## Estructura del Proyecto
+
+El archivo principal es `index.js`, donde se definen los códigos y mensajes que serán utilizados en todas las aplicaciones.
+
+```javascript
+/**
+ * Code enum for messages.
+ * @module lang
+ * @author Victor Alejandro CR
+ * @copyright (c) 2024 AgendateApp
+ */
+
+const messages = {
+  E_001: { status: 401, id: 'E-001', message: 'Token is required' },
+  // ... otros mensajes
+};
+
+module.exports = messages;
+```
+## Publicación del Paquete
+Para distribuir este paquete a los diferentes proyectos de AgendateApp, puedes usar npm pack para empaquetarlo y luego instalarlo en los proyectos que lo necesiten.
+
+### Paso 1: Empaquetar el Paquete o generar link
+Navega a la carpeta del proyecto @agendateapp/agendateapp-codes y ejecuta:
+
+```bash
+npm pack
+# ó
+npm link
+```
+Este comando generará un archivo .tgz en la carpeta del proyecto, que es el archivo empaquetado que se puede instalar en otros proyectos.
+
+## Tres opciones de uso
+
+## Opción 1
+### Paso 2: Instalar el Paquete en Otros Proyectos
+En cada proyecto que necesite utilizar los códigos y mensajes, sigue los siguientes pasos:
+
+Copiar el archivo empaquetado: Copia el archivo .tgz generado en el paso anterior al directorio de tu proyecto local.
+
+Instalar el paquete: Desde la raíz del proyecto, ejecuta:
+
+```bash
+npm install ./ruta/al/archivo/@agendateapp-agendateapp-codes-1.0.0.tgz
+```
+Esto instalará el paquete @agendateapp/agendateapp-codes como una dependencia local del proyecto.
+
+### Paso 3: Uso del Paquete en Proyecto
+Una vez instalado, puedes importar y usar los códigos y mensajes en tu aplicación de la siguiente manera:
+
+```javascript
+const messages = require('@agendateapp/agendateapp-codes');
+
+console.log(messages.E_001.message); // "Token is required"
+```
+
+## Opción 2
+### Paso 2: Copiar comprimido al proyecto donde se usará
+
+```bash
+# Pasar a proyecto de main siempre teniendo en cuenta la versión del comprimido "X"
+cp agendateapp-agendateapp-codes-1.0.X.tgz ../agendateapp.main/
+```
+
+### Paso 3: En el proyecto destino, volver a instalarlo
+```bash
+# Pasar a proyecto de main
+cp agendateapp-agendateapp-codes-1.0.X.tgz ../agendateapp.main/
+
+# En proyecto destino cambiar en el package.json el archivo y omitir el antiguo
+npm i
+```
+
+## Opción 3
+### Paso 2: En la carpeta destino ejecutar
+```bash
+npm link @agendateapp/agendateapp-codes
+```
+### Paso 3: Para docker
+```bash
+# Usa en el dockerfile
+COPY ../agendateapp-codes ./node_modules/@agendateapp/agendateapp-codes
+```
+
+## Contribuir
+Si necesitas agregar o modificar algún mensaje, realiza los cambios necesarios en el archivo index.js, y luego sigue el proceso de empaquetado e instalación en los demás proyectos.

package/index.js

@@ -0,0 +1,52 @@
+/**
+ * Code enum for messages.
+ * @module lang
+ * @author Victor Alejandro CR
+ * @copyright (c) 2024 AgendateApp
+ */
+const messages = {
+  E_001: { code: 401, name: 'E-001', message: 'Token is required' },
+  E_002: { code: 403, name: 'E-002', message: 'Token is not valname' },
+  E_003: { code: 403, name: 'E-003', message: 'Token not found' },
+  E_004: { code: 403, name: 'E-004', message: 'Closed token' },
+  E_005: { code: 403, name: 'E-005', message: 'Expired token' },
+  E_006: { code: 403, name: 'E-006', message: 'Token organization problem' },
+  E_007: { code: 403, name: 'E-007', message: 'Token organization nameentifier not found' },
+  E_008: { code: 403, name: 'E-008', message: 'Without permission' },
+  E_009: { code: 0, name: '', message: '' },
+  E_010: { code: 500, name: 'E-010', message: 'Error creating' },
+  E_011: { code: 500, name: 'E-011', message: 'Error reading' },
+  E_012: { code: 500, name: 'E-012', message: 'Error updating' },
+  E_013: { code: 500, name: 'E-013', message: 'Error deleting' },
+  E_014: { code: 500, name: 'E-014', message: 'Primary key required' },
+  E_015: { code: 500, name: 'E-015', message: 'Error loading' },
+  E_016: { code: 500, name: 'E-016', message: 'Error sending notification' },
+  E_017: { code: 500, name: 'E-017', message: '' },
+  E_018: { code: 500, name: 'E-018', message: '' },
+  E_019: { code: 500, name: 'E-019', message: '' },
+  E_020: { code: 500, name: 'E-020', message: '' },
+  E_021: { code: 500, name: 'E-021', message: '' },
+  E_022: { code: 500, name: 'E-022', message: '' },
+  E_023: { code: 500, name: 'E-023', message: '' },
+
+  W_001: { code: 202, name: 'W-001', message: 'Required field: {0}' },
+  W_002: { code: 202, name: 'W-002', message: 'Unsupported file type' },
+  W_003: { code: 202, name: 'W-003', message: 'User is already registered' },
+  W_004: { code: 202, name: 'W-004', message: '' },
+  W_005: { code: 202, name: 'W-005', message: '' },
+  W_006: { code: 202, name: 'W-006', message: '' },
+  W_007: { code: 202, name: 'W-007', message: '' },
+  W_008: { code: 202, name: 'W-008', message: '' },
+  W_009: { code: 202, name: 'W-009', message: '' },
+  W_010: { code: 202, name: 'W-010', message: '' },
+  W_011: { code: 202, name: 'W-011', message: '' },
+  W_012: { code: 202, name: 'W-012', message: '' },
+  W_013: { code: 202, name: 'W-013', message: '' },
+  W_014: { code: 202, name: 'W-014', message: '' },
+  W_015: { code: 202, name: 'W-015', message: '' },
+
+  G_200: { code: 200, name: 'G-200', message: 'Successful' },
+  G_404: { code: 404, name: 'G-404', message: 'No information associated with the supplied parameters was found' }
+}
+
+module.exports = messages

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@vidisoft/agendateapp-codes",
+  "version": "1.0.1",
+  "description": "Codigos de aplicación",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "ISC",
+  "devDependencies": {
+    "standard": "^17.1.0"
+  },
+  "eslintConfig": {
+    "extends": "standard"
+  }
+}