@randstad-uca/apret-response-messages
v1.0.13
Published
Biblioteca de mensajes de APRET multilenguaje para respuestas estandarizadas.
Readme
📚 Librería de APRET Mensajes Multilenguaje
Una librería ligera y escalable para gestionar mensajes de error en múltiples idiomas. Ideal para proyectos Node.js con TypeScript.
🧩 Características
- ✅ Soporte multilenguaje (ej: español, inglés).
- ✅ Archivos JSON separados por idioma.
- ✅ Fácil de mantener y expandir.
- ✅ Uso simple desde cualquier parte del proyecto.
- ✅ Compatible con sistemas offline (si se usa con .tgz o archivos locales).
##🛠️ Instalación
npm install @randstad-uca/apret-response-messages#📁 Estructura del Proyecto
apret-response-messages/
├── src/
│ ├── index.ts - Funciones principales
│ ├── messages/
│ │ ├── es.json - Mensajes en español
│ │ ├── en.json - Mensajes en inglés
│ │ └── message.ts
│ └── types.ts - Tipos y interfaces
├── dist/ - Código compilado (build)
├── package.json
├── README.md
└── tsconfig.json📦 Uso de la Librería
import { getMessageResponse } from '@randstad-uca/apret-response-messages';
const message = getMessageResponse(102, 1); // Mensaje 102 en español
console.log(message);
// Salida: { code: 102, message: 'el DNI ingresado ya se encuentra registrado.' }
const message = getMessageResponse(102, 2); // Mensaje 102 en inglés
console.log(message);
// Salida: { code: 102, message: 'the entered DNI is already registered.' }
##🌍 Agregar más idiomas
Añade un nuevo archivo JSON en /src/messages/, ej: fr.json.
Actualiza el mapa de idiomas en src/messages/index.ts.
// src/messages/message.ts
import { LangCode } from '../types';
const langMap: Record<LangCode, any> = {
1: require('./es.json'),
2: require('./en.json'),
3: require('./fr.json'), // Nuevo idioma
};
- Extiende el tipo LangCode en src/types.ts:
// src/types.ts
export type LangCode = 1 | 2 | 3; ##🔨 Construir el proyecto
npm run build- Esto genera los archivos compilados en la carpeta dist/.
##📦 Empaquetar para distribución
npm run pack- Genera un archivo .tgz que puedes compartir o instalar sin conexión.
##🧪 Ejecutar directamente
npm run dev- Corre el archivo en modo desarrollo con ts-node.
