@hemia/jwt-manager 0.0.1

package/README.md

@@ -0,0 +1,90 @@
+# @hemia/jwt-manager
+
+Una clase sencilla y reutilizable para la generación, validación y decodificación de tokens JWT. Ideal para gestionar autenticación basada en tokens dentro de aplicaciones Node.js.
+
+---
+
+## Características principales
+
+* Firma y verificación de tokens JWT
+* Soporte para claves secretas personalizadas o por entorno
+* Control del tiempo de expiración
+* Soporte para distintos tipos de token (como "clean credentials")
+* Decodificación sin validación
+
+---
+
+## Instalación
+
+```bash
+npm install @hemia/jwt-manager
+```
+
+---
+
+## Uso básico
+
+```ts
+import { JwtManager } from '@hemia/jwt-manager';
+
+const jwt = new JwtManager();
+
+const token = jwt.getTokenWithoutKey({ userId: 'abc123' });
+const decoded = jwt.validateToken(token);
+```
+
+---
+
+## API
+
+### `getTokenWithoutKey(payload, expiresIn?, options?)`
+
+Genera un token firmado con la clave definida por entorno (`JWT_SECRET`).
+
+### `getTokenWithKey(payload, secretKey, expiresIn?, options?)`
+
+Genera un token firmado con una clave personalizada.
+
+### `getTokenCleanCredentials(operative, expiresIn?)`
+
+Genera un token especial con un `accessType` para operaciones específicas (como `catalog`).
+
+### `validateToken(token, secretKey?)`
+
+Valida un token JWT. Si no se pasa `secretKey`, usa la interna.
+
+### `decode(token)`
+
+Decodifica un token sin verificar su firma. Útil para leer datos sin validar.
+
+### `getJwtKey()`
+
+Devuelve la clave interna usada para firmar los tokens.
+
+---
+
+## Variables de entorno
+
+```env
+JWT_SECRET=mi_clave_super_secreta
+```
+
+> ⚠️ **Importante:** No uses una clave por defecto en producción. Define `JWT_SECRET` siempre en tus entornos seguros.
+
+---
+
+## Ejemplo con expiración y opciones
+
+```ts
+const token = jwt.getTokenWithoutKey(
+  { userId: 'abc123' },
+  '1h', // expira en 1 hora
+  { issuer: 'hemia' }
+);
+```
+
+---
+
+## Licencia
+
+MIT — Desarrollado por [Hemia Technologies](https://hemia.mx)