@gnpdev/rpa-tools 1.0.18 → 1.0.20

package/README.md

@@ -77,8 +77,8 @@ import { logger } from './lib/rpa.js';
 logger.info('Procesando orden');
 ```
 
-### 3. Gestión de Credenciales
-Recupera de forma segura el `usuario`, `password` e `idUsuario` de una aplicación específica vinculada al bot.
+### 3. Gestión de Credenciales y Estado de Aplicaciones
+Recupera de forma segura el `usuario`, `password` e `idUsuario` de una aplicación específica vinculada al bot. También permite actualizar el estado y observaciones (útil para fallos de login).
 
 ```javascript
 import { rpa, logger } from './lib/rpa.js';
@@ -90,9 +90,34 @@ if (credentials) {
   const { usuario, password, idUsuario } = credentials;
   // usar en el login de la web
 }
+
+// En caso de fallo de login o error en la aplicación
+await rpa.updateAppStatus('Portal CRM', false, 'Credenciales inválidas o bloqueo de cuenta');
+```
+
+### 4. Verificar Estado del Bot (Kill Switch)
+...
+```javascript
+import { rpa, logger } from './lib/rpa.js';
+
+const active = await rpa.isActive();
+...
+```
+
+### 5. Capturas de Pantalla
+Existen tres formas de realizar capturas de pantalla:
+
+#### A. Captura Manual Estructurada
+Captura la página actual y la guarda con una estructura de carpetas: `capturas/id_bot/fecha/nombre.webp`.
+
+```javascript
+import { rpa } from './lib/rpa.js';
+
+// Captura la página actual con el nombre 'dashboard_principal'
+const key = await rpa.capturePage(page, 'dashboard_principal');
 ```
 
-### 4. Capturas de Pantalla bajo demanda (Playwright)
+#### B. Monitoreo en Tiempo Real (Debug)
 Activa el watcher pasando la instancia de `page`. El bot detectará cambios en la tabla de la DB para tomar screenshots automáticamente.
 
 ```javascript
@@ -102,20 +127,15 @@ import { rpa } from './lib/rpa.js';
 const browser = await chromium.launch();
 const page = await browser.newPage();
 
-// Inicia el monitoreo (polling cada 3s por defecto)
 rpa.watchDebugFlag(page);
-
-
-// Al terminar el proceso del bot
-rpa.destroy(); 
-
-// Sugerencia: limpiar al desconectar
-browser.on('disconnected', () => rpa.destroy());
 ```
 
-### 5. Captura Automática de Errores (Screenshot + Trace)
+#### C. 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()`.
 
+> **Nota:** El soporte de `tracing` (archivos .zip de depuración) es exclusivo de **Playwright**. En **Puppeteer** se capturará el error y el screenshot, pero el `traceKey` será nulo.
+
 ```javascript
 import { chromium } from 'playwright';
 import { rpa, logger, step } from './lib/rpa.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnpdev/rpa-tools",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "description": "Libreria para logs y screenshot de bots",
   "author": "Sergio Antonio Trujillo del Valle",
   "main": "src/index.js",
@@ -20,7 +20,8 @@
     "minio": "^8.0.7",
     "pino": "^10.3.1",
     "pino-pretty": "^13.1.3",
-    "sharp": "^0.34.5"
+    "sharp": "^0.34.5",
+    "pg": "^8.11.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^20.5.0",

package/src/capture.js

@@ -0,0 +1,64 @@
+'use strict';
+const sharp = require('sharp');
+
+/**
+ * Gestor de capturas de pantalla de la página actual.
+ */
+class PageCapturer {
+  /**
+   * @param {object} params
+   * @param {string} params.botId - UUID del bot
+   * @param {import('minio').Client} params.minioClient - Cliente MinIO
+   * @param {string} params.bucket - Bucket de MinIO
+   * @param {import('pino').Logger} [params.logger] - Instancia de Logger
+   */
+  constructor({ botId, minioClient, bucket, logger }) {
+    this.botId = botId;
+    this.minioClient = minioClient;
+    this.bucket = bucket;
+    this.logger = logger;
+  }
+
+  /**
+   * Captura la página actual y la sube a MinIO con una ruta estructurada.
+   * Estructura: capturas/{botId}/{YYYY-MM-DD}/{nombre}.webp
+   * 
+   * @param {any} page - Instancia de Page (Playwright o Puppeteer)
+   * @param {string} nombre - Nombre del elemento/captura
+   * @returns {Promise<string|null>} - Key de la captura en MinIO
+   */
+  async capture(page, nombre) {
+    try {
+      const now = new Date();
+      const date = now.toISOString().slice(0, 10);
+      const key = `capturas/${this.botId}/${date}/${nombre}.webp`;
+
+      const buffer = await page.screenshot({
+        type: 'jpeg',
+        quality: 80,
+        fullPage: true,
+      });
+
+      const finalBuffer = await sharp(buffer)
+        .webp({ quality: 70 })
+        .toBuffer();
+
+      await this.minioClient.putObject(this.bucket, key, finalBuffer, finalBuffer.length, {
+        'Content-Type': 'image/webp',
+      });
+
+      if (this.logger) {
+        this.logger.info({ key, nombre }, 'Captura de pantalla guardada exitosamente');
+      }
+
+      return key;
+    } catch (err) {
+      if (this.logger) {
+        this.logger.error({ err, nombre }, 'Error al capturar pantalla');
+      }
+      return null;
+    }
+  }
+}
+
+module.exports = { PageCapturer };

package/src/credentials.js

@@ -1,35 +1,56 @@
-'use strict';
-
-/**
- * Gestor de credenciales de aplicaciones para bots.
- */
-class CredentialManager {
-  /**
-   * @param {object} params
-   * @param {import('pg').Pool} params.pool - Pool de pg
-   * @param {string} params.botId - UUID del bot
-   */
-  constructor({ pool, botId }) {
-    this.pool = pool;
-    this.botId = botId;
-  }
-
-  /**
-   * Obtiene las credenciales de una aplicación.
-   * @param {string} nombre - Nombre de la aplicación
-   * @returns {Promise<{usuario: string, password: string, idUsuario: string}|null>}
-   */
-  async getAppCredentials(nombre) {
-    const { rows } = await this.pool.query(
-      `SELECT usuario, password, "idUsuario"
-         FROM bots.tb_aplicaciones_bots
-        WHERE nombre = $1 AND bot_id = $2
-        LIMIT 1`,
-      [nombre, this.botId]
-    );
-
-    return rows.length > 0 ? rows[0] : null;
-  }
-}
-
-module.exports = { CredentialManager };
+'use strict';
+
+/**
+ * Gestor de credenciales de aplicaciones para bots.
+ */
+class CredentialManager {
+  /**
+   * @param {object} params
+   * @param {import('pg').Pool} params.pool - Pool de pg
+   * @param {string} params.botId - UUID del bot
+   */
+  constructor({ pool, botId }) {
+    this.pool = pool;
+    this.botId = botId;
+  }
+
+  /**
+   * Obtiene las credenciales de una aplicación.
+   * @param {string} nombre - Nombre de la aplicación
+   * @returns {Promise<{usuario: string, password: string, idUsuario: string}|null>}
+   */
+  async getAppCredentials(nombre) {
+    const { rows } = await this.pool.query(
+      `SELECT usuario, password, "idUsuario"
+         FROM bots.tb_aplicaciones_bots
+        WHERE nombre = $1 AND bot_id = $2
+        LIMIT 1`,
+      [nombre, this.botId]
+    );
+
+    return rows.length > 0 ? rows[0] : null;
+  }
+
+  /**
+   * Actualiza el estado y las observaciones de una aplicación.
+   * @param {string} nombre - Nombre de la aplicación
+   * @param {boolean} status - Estado (true/false)
+   * @param {string} observations - Observaciones/Errores
+   * @returns {Promise<boolean>}
+   */
+  async updateAppStatus(nombre, status, observations) {
+    try {
+      await this.pool.query(
+        `UPDATE bots.tb_aplicaciones_bots
+            SET status = $1, observations = $2
+          WHERE nombre = $3 AND bot_id = $4`,
+        [status, observations, nombre, this.botId]
+      );
+      return true;
+    } catch (err) {
+      return false;
+    }
+  }
+}
+
+module.exports = { CredentialManager };

package/src/errorCapture.js

@@ -35,13 +35,13 @@ function errorPrefix(botId) {
 
 /**
  * Captura el estado completo cuando ocurre un error:
- *  - Screenshot WebP de la página actual
- *  - Trace de Playwright (.zip con video, red, consola, DOM snapshots)
+ *  - Screenshot WebP de la página actual (Playwright/Puppeteer)
+ *  - Trace de Playwright (.zip con video, red, consola, DOM snapshots) [Opcional]
  *  - Registro en bots.tb_error_bots
  *
  * @param {object} p
- * @param {import('playwright').Page}              p.page
- * @param {import('playwright').BrowserContext}    p.context
+ * @param {any}                                    p.page       - Instancia de Page (Playwright o Puppeteer)
+ * @param {any}                                    [p.context]  - BrowserContext (solo Playwright para tracing)
  * @param {Error}                                  p.err
  * @param {string}                                 p.botId      - UUID del bot
  * @param {import('pg').Pool}                      p.pool

package/src/index.d.ts

@@ -74,6 +74,12 @@ export interface RpaTools {
    */
   getCredentials: (nombre: string) => Promise<{ usuario: string; password: string; idUsuario: string } | null>;
 
+  /**
+   * Consulta si el bot está activo en la base de datos (columna 'estado').
+   * @returns {Promise<boolean>}
+   */
+  isActive: () => Promise<boolean>;
+
   /**
    * Captura screenshot, trace y registra error en base de datos.
    */

package/src/index.js

@@ -4,6 +4,7 @@ const { createMinioClient, ensureBucket }    = require('./storage');
 const { ScreenshotWatcher }                  = require('./watcher');
 const { CredentialManager }                  = require('./credentials');
 const { captureError }                     = require('./errorCapture');
+const { PageCapturer }                      = require('./capture');
 
 /**
  * Factory principal de la librería.
@@ -14,7 +15,7 @@ const { captureError }                     = require('./errorCapture');
  * @param {object}  opts.minio          - config de MinIO
  * @param {object}  [opts.log]          - opciones de Pino
  *
- * @returns {{ logger, watchDebugFlag, getCredentials, destroy }}
+ * @returns {{ logger, state, step, watchDebugFlag, getCredentials, updateAppStatus, isActive, capturePage, captureError, destroy }}
  */
 async function createRpaTools(opts = {}) {
   const {
@@ -45,6 +46,7 @@ async function createRpaTools(opts = {}) {
 
   const watcher     = new ScreenshotWatcher({ botId, pool: db, minioClient, bucket, logger });
   const credentials = new CredentialManager({ botId, pool: db });
+  const capturer    = new PageCapturer({ botId, minioClient, bucket, logger });
 
   const state = { currentStep: 'Inicio' };
 
@@ -55,8 +57,40 @@ async function createRpaTools(opts = {}) {
       state.currentStep = name;
       logger.info(name + ' - Nuevo paso');
     },
+    /**
+     * Inicia el polling que activa/desactiva screenshots según bot_debug_config.
+     * @param {any} page - Objeto Page de Playwright o Puppeteer
+     * @param {number} [pollMs=3000] - Intervalo de polling en ms
+     */
     watchDebugFlag: (page, pollMs) => watcher.watch(page, pollMs),
     getCredentials: (nombre) => credentials.getAppCredentials(nombre),
+    updateAppStatus: (nombre, status, observations) => credentials.updateAppStatus(nombre, status, observations),
+    /**
+     * Consulta si el bot está activo en la base de datos (columna 'estado').
+     * @returns {Promise<boolean>}
+     */
+    isActive: async () => {
+      try {
+        const { rows } = await db.query(
+          'SELECT estado FROM bots.tb_bots WHERE id = $1',
+          [botId]
+        );
+        return rows.length > 0 ? rows[0].estado : false;
+      } catch (err) {
+        logger.error({ err }, 'Error consultando estado en isActive');
+        return false;
+      }
+    },
+    /**
+     * Captura el estado de la página actual y lo sube a MinIO.
+     * @param {any} page - Instancia de Page
+     * @param {string} nombre - Nombre del elemento/captura
+     */
+    capturePage: (page, nombre) => capturer.capture(page, nombre),
+    /**
+     * Captura screenshot y registra error en base de datos. 
+     * Soporta Playwright (con tracing opcional) y Puppeteer.
+     */
     captureError: ({ page, context, err, step }) => captureError({
       page,
       context,

package/src/logger.js

@@ -1,26 +1,26 @@
-'use strict';
-const pino = require('pino');
-
-/**
- * Crea una instancia de Pino ya configurada con el botId como campo base.
- * @param {string} botId
- * @param {object} opts
- * @param {'trace'|'debug'|'info'|'warn'|'error'} [opts.level='info']
- * @param {boolean} [opts.pretty=false]  - activar pino-pretty (solo en dev)
- * @param {object} [opts.pinoOptions]    - opciones adicionales de Pino
- */
-function createLogger(botId, opts = {}) {
-  const { level = 'info', pretty = false, pinoOptions = {} } = opts;
-
-  return pino({
-    level,
-    base: { botId },
-    timestamp: pino.stdTimeFunctions.isoTime,
-    transport: pretty
-      ? { target: 'pino-pretty', options: { colorize: true } }
-      : undefined,
-    ...pinoOptions,
-  });
-}
-
+'use strict';
+const pino = require('pino');
+
+/**
+ * Crea una instancia de Pino ya configurada con el botId como campo base.
+ * @param {string} botId
+ * @param {object} opts
+ * @param {'trace'|'debug'|'info'|'warn'|'error'} [opts.level='info']
+ * @param {boolean} [opts.pretty=false]  - activar pino-pretty (solo en dev)
+ * @param {object} [opts.pinoOptions]    - opciones adicionales de Pino
+ */
+function createLogger(botId, opts = {}) {
+  const { level = 'info', pretty = false, pinoOptions = {} } = opts;
+
+  return pino({
+    level,
+    base: { botId },
+    timestamp: pino.stdTimeFunctions.isoTime,
+    transport: pretty
+      ? { target: 'pino-pretty', options: { colorize: true } }
+      : undefined,
+    ...pinoOptions,
+  });
+}
+
 module.exports = { createLogger };

package/src/watcher.js

@@ -35,7 +35,7 @@ class ScreenshotWatcher {
    * Inicia el polling que activa/desactiva screenshots según bot_debug_config.
    * Llama una sola vez al arrancar el bot.
    *
-   * @param {import('playwright').Page} page
+   * @param {any} page - Objeto Page de Playwright o Puppeteer
    * @param {number} [pollMs=3000] - cada cuántos ms revisar la BD
    */
   watch(page, pollMs = 3000) {