@mp-front/common 0.0.1 → 0.0.2

package/README.md

@@ -1 +1,280 @@
-# front-utils
+# @mp-front/common
+
+Biblioteca de utilidades comunes para aplicaciones frontend con TypeScript, diseñada para proporcionar funcionalidades esenciales como autenticación, manejo de caché, HTTP client, logging y más.
+
+## 📦 Instalación
+
+```bash
+npm install @mp-front/common
+```
+
+## 🏗️ Arquitectura
+
+La biblioteca está organizada en módulos especializados con exportaciones modulares:
+
+```
+src/
+├── adapters/          # Adaptadores para servicios externos
+├── auth/              # Servicios de autenticación
+├── cache/             # Manejadores de caché (sesión, terminal)
+├── cache-providers/   # Proveedores de caché (Redis)
+├── engine/            # Motores de autenticación (Entra ID)
+├── errors/            # Manejo de errores y excepciones
+├── helpers/           # Utilidades (logger, encriptación, codificación)
+├── http/              # Cliente HTTP con RxJS
+├── middleware/        # Middlewares para APIs
+├── rxjs/              # Utilidades RxJS (loading handler)
+└── types.ts           # Tipos globales
+```
+
+## 📋 Módulos Disponibles
+
+### 🔐 Auth
+```typescript
+import { AuthorizationService } from '@mp-front/common/auth'
+
+const authService = new AuthorizationService()
+authService.get().subscribe(token => {
+  console.log('Token:', token)
+})
+```
+
+### 🚀 Engine
+```typescript
+import { AuthEngine } from '@mp-front/common/engine'
+
+const authEngine = new AuthEngine()
+```
+
+### 🌐 HTTP Client
+```typescript
+import { HttpClient } from '@mp-front/common/http'
+
+const client = new HttpClient()
+
+// GET request
+client.get<User>('/api/users/1').subscribe(user => {
+  console.log(user)
+})
+
+// POST request
+client.post<User>('/api/users', { name: 'John' }).subscribe(newUser => {
+  console.log(newUser)
+})
+```
+
+### 🗄️ Cache
+```typescript
+import { SessionCache, TerminalCache } from '@mp-front/common/cache'
+
+// Session Cache
+const sessionCache = new SessionCache('userId')
+const session = await sessionCache.getBasicSession()
+
+// Terminal Cache
+const terminalCache = new TerminalCache()
+await terminalCache.saveTerminalData('keySeller', terminalData)
+```
+
+### 🔧 Helpers
+```typescript
+import { Logger, Encoder, Encrypter } from '@mp-front/common/helpers'
+
+// Logger
+const logger = new Logger()
+logger.logInfo('Application started')
+logger.logError('Error occurred')
+
+// Encoder
+const encoder = new Encoder()
+const encoded = encoder.encode(data, requestId)
+
+// Encrypter
+const encrypter = new Encrypter()
+const encrypted = encrypter.encrypt('sensitive data')
+```
+
+### 📡 Cache Providers
+```typescript
+import { RedisCache } from '@mp-front/common/cache-providers'
+
+const redis = new RedisCache<UserData>()
+await redis.setRedisState({
+  idApi: 'user:123',
+  idData: 'profile',
+  body: userData,
+  expire: 3600
+})
+```
+
+### ❌ Error Handling
+```typescript
+import { ErrorHandler, RuntimeError } from '@mp-front/common/errors'
+
+// Error Handler
+ErrorHandler.getInstance().getSubject().subscribe(error => {
+  console.error('Global error:', error)
+})
+
+// Custom Runtime Error
+throw new RuntimeError('VALIDATION_ERROR', 'Invalid input data')
+```
+
+### 🔄 RxJS Utilities
+```typescript
+import { LoadingHandler } from '@mp-front/common/rxjs'
+
+// Loading state management
+LoadingHandler.getInstance().getSubject().subscribe(isLoading => {
+  console.log('Loading:', isLoading)
+})
+```
+
+## ⚙️ Configuración
+
+### Variables de Entorno
+
+```env
+# Logging
+NEXT_PUBLIC_APP_LOGS_NAME=MyApp
+NEXT_PUBLIC_LOGS_LEVEL=debug
+NEXT_PUBLIC_SILENT_LOGS=false
+
+# Authentication
+API_AUTH_BACK_URL=https://api.example.com/auth
+API_AUTH_BACK_USERNAME_AUTH=username
+API_AUTH_BACK_PASSWORD_AUTH=password
+ID_FRONT=frontend-app-id
+
+# Redis
+REDIS_URL=redis://localhost:6379
+```
+
+### Peer Dependencies
+
+```json
+{
+  "ioredis": "5.3.2",
+  "next-auth": "4.24.13",
+  "node-jose": "2.2.0",
+  "rxjs": "7.8.1"
+}
+```
+
+## 🔨 Casos de Uso
+
+### 1. Cliente HTTP con Autenticación
+```typescript
+import { HttpClient, AuthorizationService } from '@mp-front/common'
+
+const client = new HttpClient()
+const auth = new AuthorizationService()
+
+auth.get().subscribe(token => {
+  client.get('/api/protected', {
+    headers: { Authorization: `Bearer ${token}` }
+  }).subscribe(data => {
+    console.log('Protected data:', data)
+  })
+})
+```
+
+### 2. Manejo de Sesión con Cache
+```typescript
+import { SessionCache } from '@mp-front/common/cache'
+
+const sessionCache = new SessionCache('user123')
+
+// Obtener sesión básica
+const basicSession = await sessionCache.getBasicSession()
+
+// Obtener sesión con datos de tienda
+const fullSession = await sessionCache.getUserAndShoppingStore()
+```
+
+### 3. Logging Estructurado
+```typescript
+import { Logger } from '@mp-front/common/helpers'
+
+const logger = new Logger()
+
+// Diferentes niveles de log
+logger.logError('Database connection failed')
+logger.logWarn('Deprecated API usage')
+logger.logInfo('User logged in')
+logger.logDebug('Processing request', JSON.stringify(requestData))
+```
+
+### 4. Manejo Global de Errores
+```typescript
+import { ErrorHandler, RuntimeError } from '@mp-front/common/errors'
+
+// Suscribirse a errores globales
+ErrorHandler.getInstance().getSubject().subscribe(error => {
+  // Mostrar notificación de error
+  showErrorNotification(error.message)
+})
+
+// Lanzar error personalizado
+if (!isValid) {
+  throw new RuntimeError('VALIDATION_ERROR', 'Los datos no son válidos')
+}
+```
+
+### 5. Estado de Carga Global
+```typescript
+import { LoadingHandler } from '@mp-front/common/rxjs'
+
+// Mostrar/ocultar spinner global
+LoadingHandler.getInstance().getSubject().subscribe(isLoading => {
+  document.getElementById('spinner').style.display = isLoading ? 'block' : 'none'
+})
+```
+
+## 🔧 Desarrollo
+
+### Scripts Disponibles
+```bash
+npm run build        # Compilar la biblioteca
+npm run lint         # Ejecutar linter
+npm run package      # Crear paquete NPM
+npm run publish-canary # Publicar versión canary
+```
+
+### Estructura de Build
+- **ESM**: `dist/mp-front-common-*.js`
+- **CommonJS**: `dist/mp-front-common-*.cjs`
+- **Types**: `dist/**/*.d.ts`
+
+## 📝 Tipos TypeScript
+
+La biblioteca incluye definiciones de tipos completas:
+
+```typescript
+import type { HttpOptions, Method, RequestConfig } from '@mp-front/common/http'
+import type { ITerminal } from '@mp-front/common/cache'
+```
+
+## 🚀 Características
+
+- ✅ **TypeScript nativo** con tipos completos
+- ✅ **Modular** - importa solo lo que necesitas
+- ✅ **RxJS** para programación reactiva
+- ✅ **Redis** para caché distribuido
+- ✅ **Logging** estructurado con niveles
+- ✅ **Encriptación** y codificación de datos
+- ✅ **Manejo de errores** centralizado
+- ✅ **Next.js** y **NextAuth** compatible
+- ✅ **ESM** y **CommonJS** support
+
+## 📄 Licencia
+
+Privada - Uso interno únicamente
+
+## 🤝 Contribución
+
+1. Fork el repositorio
+2. Crea una rama feature (`git checkout -b feature/nueva-funcionalidad`)
+3. Commit tus cambios (`git commit -am 'Agregar nueva funcionalidad'`)
+4. Push a la rama (`git push origin feature/nueva-funcionalidad`)
+5. Crea un Pull Request

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mp-front/common",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "private": false,
   "type": "module",
   "main": "./dist/mp-front-common-all.cjs",