@gnpdev/rpa-tools 1.0.13 → 1.0.15

package/README.md

@@ -23,6 +23,8 @@ Crea un archivo en tu proyecto (ej. `src/lib/rpa.js`) para inicializar y exporta
 // src/lib/rpa.js
 import { createRpaTools } from '@gnpdev/rpa-tools';
 import { Pool } from 'pg';
+import * as dotenv from 'dotenv';
+dotenv.config();
 
 // 1. Configura tu pool de base de datos (usualmente ya lo tienes)
 const pool = new Pool({
@@ -47,26 +49,39 @@ export const rpa = await createRpaTools({
   }
 })
 
-export const logger = rpa.logger;
+// 3. Exporta las herramientas
+export const { logger, state, step } = rpa;
 ```
 
 ## Uso en la Aplicación
 
-### 1. Logging Estructurado
+### 1. Gestión de Pasos y Estado
+La librería mantiene el rastro del paso actual del bot. Cada vez que llamas a `step()`, se actualiza el estado interno y se genera un log automático.
+
+```javascript
+import { step, state } from './lib/rpa.js';
+
+step('Inicio de Sesión');
+console.log(state.currentStep); // 'Inicio de Sesión'
+
+step('Extracción de Datos');
+// Genera log: info { "step": "Extracción de Datos" } "Nuevo paso"
+```
+
+### 2. Logging Estructurado
 Usa el logger preconfigurado que ya incluye el `botId` en cada entrada.
 
 ```javascript
-import { logger, rpa } from './lib/rpa.js';
+import { logger } from './lib/rpa.js';
 
 logger.info('Procesando orden');
 ```
 
-### 2. Gestión de Credenciales
+### 3. Gestión de Credenciales
 Recupera de forma segura el `usuario`, `password` e `idUsuario` de una aplicación específica vinculada al bot.
 
 ```javascript
-import { logger, rpa } from './lib/rpa.js';
-
+import { rpa, logger } from './lib/rpa.js';
 
 logger.info('Obtener credenciales');
 const credentials = await rpa.getCredentials('Portal CRM');
@@ -77,7 +92,7 @@ if (credentials) {
 }
 ```
 
-### 3. Capturas de Pantalla bajo demanda (Playwright)
+### 4. Capturas de Pantalla bajo demanda (Playwright)
 Activa el watcher pasando la instancia de `page`. El bot detectará cambios en la tabla de la DB para tomar screenshots automáticamente.
 
 ```javascript
@@ -92,53 +107,44 @@ rpa.watchDebugFlag(page);
 
 
 // Al terminar el proceso del bot
- rpa.destroy(); 
-
- puedes incluir 
+rpa.destroy(); 
 
- browser.on('disconnected', () => rpa.destroy());
+// Sugerencia: limpiar al desconectar
+browser.on('disconnected', () => rpa.destroy());
 ```
 
-### 4. Captura Automática de Errores (Screenshot + Trace)
-Captura el estado completo del bot cuando ocurre una excepción: Screenshot (.webp), Trace de Playwright (.zip) y registro en la base de datos `bots.tb_error_bots`.
+### 5. Captura Automática de Errores (Screenshot + Trace)
+Captura el estado completo del bot cuando ocurre una excepción. **`captureError` detecta automáticamente el paso actual** definido con `step()`.
 
 ```javascript
 import { chromium } from 'playwright';
-import { rpa, logger } from './lib/rpa.js';
+import { rpa, logger, step } from './lib/rpa.js';
 
 const browser = await chromium.launch({ headless: true });
 const context = await browser.newContext();
 const page    = await context.newPage();
 
- // ── Activar tracing ANTES de que empiece la sesión ──────────────────────
-  // screenshots:true  → captura visual en cada snapshot
-  // snapshots:true    → guarda el DOM y estado de red en cada paso
-  await context.tracing.start({
-    screenshots: true,
-    snapshots:   true,
-  });
+// ── Activar tracing ANTES de que empiece la sesión ──────────────────────
+await context.tracing.start({ screenshots: true, snapshots: true });
 
-let currentStep = 'Inicio';
+browser.on('disconnected', () => rpa.destroy());
 
 try {
-  // Lógica de tu bot...
+  step('Navegación');
   await page.goto('https://example.com');
   
-  currentStep = 'Login';
+  step('Login');
   await login(page);
 
-  currentStep = 'Procesar Datos';
+  step('Procesar Datos');
   await page.click('#boton-inexistente');
+
 } catch (err) {
-  // Captura automática de evidencia
-  const { errorId } = await rpa.captureError({
-    page,
-    context,
-    err,
-    step: currentStep 
-  });
-
-  logger.error({ errorId, step: currentStep }, 'Fallo crítico capturado');
+  // Captura automática de evidencia (usa el paso 'Procesar Datos' automáticamente)
+  const { errorId } = await rpa.captureError({ page, context, err });
+
+  logger.error({ errorId }, 'Fallo crítico capturado');
+  rpa.destroy();
   throw err;
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnpdev/rpa-tools",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "Libreria para logs y screenshot de bots",
   "author": "Sergio Antonio Trujillo del Valle",
   "main": "src/index.js",

package/src/index.d.ts

@@ -49,6 +49,17 @@ export interface RpaTools {
   /** Instancia de Pino lista para usar en el bot */
   logger: Logger;
 
+  /** Estado compartido del bot */
+  state: {
+    currentStep: string;
+  };
+
+  /**
+   * Cambia el paso actual, actualiza el estado y emite un log info.
+   * @param name - Nombre del nuevo paso
+   */
+  step: (name: string) => void;
+
   /**
    * Inicia el polling que activa/desactiva screenshots
    * según bot_debug_config en la BD.
@@ -80,12 +91,5 @@ export interface RpaTools {
 // ── Export principal ─────────────────────────────────────────────────────────
 /**
  * Inicializa la librería rpa-tools.
- * Crea el cliente MinIO, verifica el bucket y retorna
- * el logger y el watcher listos para usar.
- *
- * @example
- * const rpa = await createRpaTools({ botId: 'bot-001', db: pool });
- * rpa.watchDebugFlag(page);
- * rpa.logger.info('Bot iniciado');
  */
-export function createRpaTools(options: RpaToolsOptions): Promise<RpaTools>;
+export function createRpaTools(options: RpaToolsOptions): Promise<RpaTools>;

package/src/index.js

@@ -46,11 +46,28 @@ async function createRpaTools(opts = {}) {
   const watcher     = new ScreenshotWatcher({ botId, pool: db, minioClient, bucket, logger });
   const credentials = new CredentialManager({ botId, pool: db });
 
+  const state = { currentStep: 'Inicio' };
+
   return {
     logger,
+    state,
+    step: (name) => {
+      state.currentStep = name;
+      logger.info({ step: name }, 'Nuevo paso');
+    },
     watchDebugFlag: (page, pollMs) => watcher.watch(page, pollMs),
     getCredentials: (nombre) => credentials.getAppCredentials(nombre),
-    captureError: ({ page, context, err, step }) =>  captureError({ page, context, err, step, botId, pool: db, minioClient, bucket, logger }),
+    captureError: ({ page, context, err, step }) => captureError({
+      page,
+      context,
+      err,
+      step: step || state.currentStep,
+      botId,
+      pool: db,
+      minioClient,
+      bucket,
+      logger
+    }),
     destroy: () => watcher.destroy(),
   };
 }