@gnpdev/rpa-tools 1.0.0 → 1.0.4

package/README.md

@@ -1,93 +1,105 @@
-# @gnpdev/rpa-tools
-
-Herramientas de automatización para bots RPA: logging estructurado con **Pino**, almacenamiento en **MinIO** con optimización de imágenes (WebP) y monitoreo de flags en base de datos para capturas de pantalla en tiempo real con **Playwright**.
-
-## Requisitos
-
-- **Node.js** v18+
-- **pnpm** (recomendado)
-- Instancia de **MinIO** activa.
-- Base de datos **PostgreSQL**.
-
-## Instalación
-
-```bash
-pnpm add @gnpdev/rpa-tools
-```
-
-## Configuración Centralizada (Best Practice)
-
-Crea un archivo en tu proyecto (ej. `src/lib/rpa.js`) para inicializar y exportar las herramientas. Esto asegura que uses la misma instancia en toda la aplicación.
-
-```javascript
-// src/lib/rpa.js
-const { createRpaTools } = require('@gnpdev/rpa-tools');
-const { Pool } = require('pg');
-
-// 1. Configura tu pool de base de datos (usualmente ya lo tienes)
-const pool = new Pool({
-  connectionString: process.env.DATABASE_URL
-});
-
-// 2. Inicializa las herramientas
-async function initRpa() {
-  const rpa = await createRpaTools({
-    botId: 'BOT-VENTAS-01',
-    db: pool,
-    minio: {
-      endPoint: process.env.MINIO_ENDPOINT,
-      port: parseInt(process.env.MINIO_PORT || '9000'),
-      useSSL: process.env.MINIO_USE_SSL === 'true',
-      accessKey: process.env.MINIO_ACCESS_KEY,
-      secretKey: process.env.MINIO_SECRET_KEY,
-      bucket: 'rpa-screenshots'
-    },
-    log: {
-      level: process.env.NODE_ENV === 'development' ? 'debug' : 'info',
-      pretty: process.env.NODE_ENV === 'development'
-    }
-  });
-  return rpa;
-}
-
-module.exports = initRpa;
-```
-
-## Uso en la Aplicación
-
-### 1. Logging Estructurado
-Usa el logger preconfigurado que ya incluye el `botId` en cada entrada.
-
-```javascript
-const rpa = await initRpa();
-rpa.logger.info({ orderId: '123' }, 'Procesando orden');
-```
-
-### 2. 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
-const { chromium } = require('playwright');
-const rpa = await initRpa();
-
-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(); 
-```
-
-## Variables de Entorno Sugeridas
-
-```env
-MINIO_ENDPOINT=localhost
-MINIO_PORT=9000
-MINIO_USE_SSL=false
-MINIO_ACCESS_KEY=admin
-MINIO_SECRET_KEY=password
-MINIO_BUCKET=rpa-screenshots
-DATABASE_URL=postgres://user:pass@localhost:5432/db
-```
+# @gnpdev/rpa-tools
+
+Herramientas de automatización para bots RPA: logging estructurado con **Pino**, almacenamiento en **MinIO** con optimización de imágenes (WebP) y monitoreo de flags en base de datos para capturas de pantalla en tiempo real con **Playwright**.
+
+## Requisitos
+
+- **Node.js** v18+
+- **pnpm** (recomendado)
+- Instancia de **MinIO** activa.
+- Base de datos **PostgreSQL**.
+
+## Instalación
+
+```bash
+pnpm add @gnpdev/rpa-tools
+```
+
+## Configuración Centralizada (Best Practice)
+
+Crea un archivo en tu proyecto (ej. `src/lib/rpa.js`) para inicializar y exportar las herramientas. Esto asegura que uses la misma instancia en toda la aplicación.
+
+```javascript
+// src/lib/rpa.js
+const { createRpaTools } = require('@gnpdev/rpa-tools');
+const { Pool } = require('pg');
+
+// 1. Configura tu pool de base de datos (usualmente ya lo tienes)
+const pool = new Pool({
+  connectionString: process.env.DATABASE_URL
+});
+
+// 2. Inicializa las herramientas
+async function initRpa() {
+  const rpa = await createRpaTools({
+    botId: 'BOT-VENTAS-01',
+    db: pool,
+    minio: {
+      endPoint: process.env.MINIO_ENDPOINT,
+      port: parseInt(process.env.MINIO_PORT || '9000'),
+      useSSL: process.env.MINIO_USE_SSL === 'true',
+      accessKey: process.env.MINIO_ACCESS_KEY,
+      secretKey: process.env.MINIO_SECRET_KEY,
+      bucket: 'rpa-screenshots'
+    },
+    log: {
+      level: process.env.NODE_ENV === 'development' ? 'debug' : 'info',
+      pretty: process.env.NODE_ENV === 'development'
+    }
+  });
+  return rpa;
+}
+
+module.exports = initRpa;
+```
+
+## Uso en la Aplicación
+
+### 1. Logging Estructurado
+Usa el logger preconfigurado que ya incluye el `botId` en cada entrada.
+
+```javascript
+const rpa = await initRpa();
+rpa.logger.info({ orderId: '123' }, 'Procesando orden');
+```
+
+### 2. Gestión de Credenciales
+Recupera de forma segura el `usuario`, `password` e `idUsuario` de una aplicación específica vinculada al bot.
+
+```javascript
+const credentials = await rpa.getCredentials('Portal CRM');
+
+if (credentials) {
+  const { usuario, password, idUsuario } = credentials;
+  // usar en el login de la web
+}
+```
+
+### 3. 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
+const { chromium } = require('playwright');
+const rpa = await initRpa();
+
+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(); 
+```
+
+## Variables de Entorno Sugeridas
+
+```env
+MINIO_ENDPOINT=localhost
+MINIO_PORT=9000
+MINIO_USE_SSL=false
+MINIO_ACCESS_KEY=admin
+MINIO_SECRET_KEY=password
+MINIO_BUCKET=rpa-screenshots
+DATABASE_URL=postgres://user:pass@localhost:5432/db
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnpdev/rpa-tools",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Libreria para logs y screenshot de bots",
   "author": "Sergio Antonio Trujillo del Valle",
   "main": "src/index.js",
@@ -22,6 +22,15 @@
     "sharp": "^0.34.5"
   },
   "devDependencies": {
-    "pino-pretty": "^13.1.3"
+    "@commitlint/cli": "^20.5.0",
+    "@commitlint/config-conventional": "^20.5.0",
+    "@release-it/conventional-changelog": "^10.0.6",
+    "husky": "^9.1.7",
+    "pino-pretty": "^13.1.3",
+    "release-it": "^19.2.4"
+  },
+  "scripts": {
+    "prepare": "husky",
+    "release": "release-it"
   }
 }

package/src/credentials.js

@@ -0,0 +1,35 @@
+'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 };

package/src/index.js

@@ -1,86 +1,56 @@
-'use strict';
-const { createLogger }                       = require('./logger');
-const { createMinioClient, ensureBucket }    = require('./storage');
-const { ScreenshotWatcher }                  = require('./watcher');
-
-/**
- * Factory principal de la librería.
- *
- * @param {object} opts
- * @param {string}  opts.botId          - identificador único del bot
- * @param {import('pg').Pool} opts.db   - pool de pg ya conectado
- * @param {object}  opts.minio          - config de MinIO (ver abajo)
- * @param {string}  opts.minio.endPoint
- * @param {number}  [opts.minio.port=9000]
- * @param {boolean} [opts.minio.useSSL=false]
- * @param {string}  opts.minio.accessKey
- * @param {string}  opts.minio.secretKey
- * @param {string}  [opts.minio.bucket='rpa-screenshots']
- * @param {object}  [opts.log]          - opciones de Pino
- * @param {string}  [opts.log.level='info']
- * @param {boolean} [opts.log.pretty=false]
- *
- * @returns {{ logger, watchDebugFlag, destroy }}
- */
-async function createRpaTools(opts = {}) {
-  const {
-    botId = process.env.RPA_BOT_ID,
-    log:  logCfg = {},
-    db,
-    minio: minioCfg,
-  } = opts;
-
-  // Leer minio desde env si no se pasó config
-  const minio = minioCfg ?? {
-    endPoint:  process.env.MINIO_ENDPOINT,
-    port:      Number(process.env.MINIO_PORT) || 9000,
-    useSSL:    process.env.MINIO_USE_SSL === 'true',
-    accessKey: process.env.MINIO_ACCESS_KEY,
-    secretKey: process.env.MINIO_SECRET_KEY,
-    bucket:    process.env.MINIO_BUCKET ?? 'rpa-screenshots',
-  };
-
-  // db se sigue pasando desde afuera (el pool ya existe en el bot)
-  // pero puedes leer la URL para validar
-  if (!db) throw new Error('[rpa-tools] db (pg.Pool) es requerido');
-
-  // Validar que las env vars críticas existan
-  const missing = ['endPoint', 'accessKey', 'secretKey']
-    .filter(k => !minio[k]);
-
-  if (missing.length) {
-    throw new Error(`[rpa-tools] Faltan vars de entorno: ${missing.map(k => `MINIO_${k.toUpperCase()}`).join(', ')}`);
-  }
-
-
-
-  if (!botId)    throw new Error('[rpa-tools] botId es requerido');
-  if (!db)       throw new Error('[rpa-tools] db (pg.Pool) es requerido');
-  if (!minioCfg) throw new Error('[rpa-tools] minio config es requerida');
-
-  const logger      = createLogger(botId, logCfg);
-  const minioClient = createMinioClient(minioCfg);
-  const bucket      = minioCfg.bucket ?? 'rpa-screenshots';
-
-  await ensureBucket(minioClient, bucket);
-  logger.info({ bucket }, 'MinIO listo');
-
-  const watcher = new ScreenshotWatcher({ botId, pool: db, minioClient, bucket, logger });
-
-  return {
-    /** Instancia de Pino lista para usar en tu bot */
-    logger,
-
-    /**
-     * Arranca el polling. Llama una vez, pasando el objeto `page` de Playwright.
-     * @param {import('playwright').Page} page
-     * @param {number} [pollMs=3000]
-     */
-    watchDebugFlag: (page, pollMs) => watcher.watch(page, pollMs),
-
-    /** Limpia intervalos al finalizar el bot */
-    destroy: () => watcher.destroy(),
-  };
-}
-
-module.exports = { createRpaTools };
+'use strict';
+const { createLogger }                       = require('./logger');
+const { createMinioClient, ensureBucket }    = require('./storage');
+const { ScreenshotWatcher }                  = require('./watcher');
+const { CredentialManager }                  = require('./credentials');
+
+/**
+ * Factory principal de la librería.
+ *
+ * @param {object} opts
+ * @param {string}  opts.botId          - identificador único del bot
+ * @param {import('pg').Pool} opts.db   - pool de pg ya conectado
+ * @param {object}  opts.minio          - config de MinIO
+ * @param {object}  [opts.log]          - opciones de Pino
+ *
+ * @returns {{ logger, watchDebugFlag, getCredentials, destroy }}
+ */
+async function createRpaTools(opts = {}) {
+  const {
+    botId = process.env.RPA_BOT_ID,
+    log:  logCfg = {},
+    db,
+    minio: minioCfg,
+  } = opts;
+
+  const minio = minioCfg ?? {
+    endPoint:  process.env.MINIO_ENDPOINT,
+    port:      Number(process.env.MINIO_PORT) || 9000,
+    useSSL:    process.env.MINIO_USE_SSL === 'true',
+    accessKey: process.env.MINIO_ACCESS_KEY,
+    secretKey: process.env.MINIO_SECRET_KEY,
+    bucket:    process.env.MINIO_BUCKET ?? 'rpa-screenshots',
+  };
+
+  if (!db)    throw new Error('[rpa-tools] db (pg.Pool) es requerido');
+  if (!botId) throw new Error('[rpa-tools] botId es requerido');
+
+  const logger      = createLogger(botId, logCfg);
+  const minioClient = createMinioClient(minio);
+  const bucket      = minio.bucket ?? 'rpa-screenshots';
+
+  await ensureBucket(minioClient, bucket);
+  logger.info({ bucket }, 'MinIO listo');
+
+  const watcher     = new ScreenshotWatcher({ botId, pool: db, minioClient, bucket, logger });
+  const credentials = new CredentialManager({ botId, pool: db });
+
+  return {
+    logger,
+    watchDebugFlag: (page, pollMs) => watcher.watch(page, pollMs),
+    getCredentials: (nombre) => credentials.getAppCredentials(nombre),
+    destroy: () => watcher.destroy(),
+  };
+}
+
+module.exports = { createRpaTools };

package/src/watcher.js

@@ -49,7 +49,7 @@ class ScreenshotWatcher {
     this._watchTimer = setInterval(async () => {
       try {
         const { rows } = await this.pool.query(
-          `SELECT screenshots, interval_sec
+          `SELECT screenshots_activo, intervalo_sec
              FROM bots.tb_bots
             WHERE bot_id = $1`,
           [this.botId]