@kwirthmagnify/kwirth-sender-console 0.1.3 → 0.1.4

package/README.md

@@ -0,0 +1,77 @@
+# Console Sender
+
+Sender que escribe los mensajes directamente en la salida estándar del proceso Node.js. Colorea las líneas según el nivel del mensaje usando códigos ANSI y permite configurar prefijo, timestamps y etiquetas de nivel por config.
+
+## Cuándo usarlo
+
+- Desarrollo local: ver alertas en el terminal donde corre Kwirth.
+- Diagnóstico rápido sin necesidad de infraestructura adicional.
+- Combinado con `sender-tee` para tener salida a consola y a otro destino a la vez.
+
+## Configuración
+
+| Campo        | Tipo      | Requerido | Por defecto | Descripción                                      |
+|--------------|-----------|-----------|-------------|--------------------------------------------------|
+| `name`       | `string`  | Sí        | —           | Nombre de esta config                            |
+| `prefix`     | `string`  | No        | —           | Texto que se antepone a cada línea, ej. `[APP]`  |
+| `timestamps` | `boolean` | No        | `true`      | Incluir timestamp ISO en cada línea              |
+| `levels`     | `boolean` | No        | `true`      | Incluir etiqueta de nivel `[INFO]`, `[ERROR]`…   |
+
+## Colores por nivel
+
+| Nivel     | Color    |
+|-----------|----------|
+| `debug`   | Cian     |
+| `info`    | Verde    |
+| `warning` | Amarillo |
+| `error`   | Rojo     |
+
+## Ejemplos
+
+### Config mínima
+
+```json
+{
+  "name": "default"
+}
+```
+
+Salida:
+```
+[2024-01-15T10:30:00.000Z] [INFO] Pod nginx started
+```
+
+### Con prefijo y sin timestamps
+
+```json
+{
+  "name": "app-alerts",
+  "prefix": "[KWIRTH]",
+  "timestamps": false
+}
+```
+
+Salida:
+```
+[KWIRTH] [ERROR] CrashLoopBackOff detected on pod api-7f9d
+```
+
+### Config silenciosa (solo el body)
+
+```json
+{
+  "name": "clean",
+  "timestamps": false,
+  "levels": false
+}
+```
+
+Salida:
+```
+CrashLoopBackOff detected on pod api-7f9d
+```
+
+## Notas
+
+- Los mensajes de nivel `error` se envían a `console.error` (stderr); `warning` a `console.warn`; el resto a `console.log`.
+- `message.to` se añade al final de la línea como `→ destinatario` si está presente.

package/build.mjs

@@ -0,0 +1,28 @@
+import esbuild from 'esbuild'
+import fs from 'fs'
+import path from 'path'
+
+fs.mkdirSync('dist', { recursive: true })
+
+await esbuild.build({
+    entryPoints: ['src/back/index.ts'],
+    bundle: true,
+    format: 'cjs',
+    platform: 'node',
+    target: 'node20',
+    outfile: 'dist/back.js',
+    loader: { '.ts': 'ts' },
+    minify: false,
+})
+console.log('Built dist/back.js')
+
+const meta = JSON.parse(fs.readFileSync('package.json', 'utf-8'))
+const distMeta = {
+    id: meta.id,
+    name: meta.name,
+    displayName: meta.displayName,
+    version: meta.version,
+    description: meta.description,
+}
+fs.writeFileSync(path.join('dist', 'package.json'), JSON.stringify(distMeta, null, 2))
+console.log('Wrote dist/package.json')

package/dist/package.json

@@ -0,0 +1,7 @@
+{
+  "id": "console",
+  "name": "@kwirthmagnify/kwirth-sender-console",
+  "displayName": "Console Sender",
+  "version": "0.1.4",
+  "description": "Console sender plugin for Kwirth — writes messages to stdout, with configurable prefix, level and timestamps per named config"
+}

package/package.json

@@ -1,7 +1,21 @@
-{
-  "id": "console",
-  "name": "@kwirthmagnify/kwirth-sender-console",
-  "displayName": "Console Sender",
-  "version": "0.1.3",
-  "description": "Console sender plugin for Kwirth — writes messages to stdout, with configurable prefix, level and timestamps per named config"
-}
+{
+  "id": "console",
+  "name": "@kwirthmagnify/kwirth-sender-console",
+  "publisher": "@kwirthmagnify",
+  "version": "0.1.4",
+  "displayName": "Console Sender",
+  "description": "Console sender plugin for Kwirth — writes messages to stdout, with configurable prefix, level and timestamps per named config",
+  "type": "module",
+  "scripts": {
+    "build": "node build.mjs",
+    "watch": "node watch.mjs"
+  },
+  "dependencies": {
+    "@kwirthmagnify/kwirth-common-back": "^0.5.11"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.13",
+    "esbuild": "^0.27.2",
+    "typescript": "^5.4.0"
+  }
+}

package/src/back/index.ts

@@ -0,0 +1,82 @@
+import { ISender, ISenderAccess, ISenderConfig, ISenderFieldDef, ISenderMessage } from '@kwirthmagnify/kwirth-common-back'
+
+// ─── Config ────────────────────────────────────────────────────────────────────
+
+export interface IConsoleSenderConfig extends ISenderConfig {
+    name: string
+    prefix?: string       // string prepended to every line, e.g. '[KWIRTH]'
+    timestamps?: boolean  // include ISO timestamp (default: true)
+    levels?: boolean      // include level tag like [ERROR] (default: true)
+}
+
+const LEVEL_COLORS: Record<string, string> = {
+    debug:   '\x1b[36m',   // cyan
+    info:    '\x1b[32m',   // green
+    warning: '\x1b[33m',   // yellow
+    error:   '\x1b[31m',   // red
+}
+const RESET = '\x1b[0m'
+
+// ─── Sender ────────────────────────────────────────────────────────────────────
+
+export class ConsoleSender implements ISender {
+    readonly id = 'console'
+    private configs = new Map<string, IConsoleSenderConfig>()
+
+    addConfig(config: ISenderConfig): void {
+        this.configs.set(config.name, config as IConsoleSenderConfig)
+    }
+
+    removeConfig(name: string): void {
+        this.configs.delete(name)
+    }
+
+    hasConfig(name: string): boolean {
+        return this.configs.has(name)
+    }
+
+    getConfigNames(): string[] {
+        return Array.from(this.configs.keys())
+    }
+
+    async send(configName: string, message: ISenderMessage): Promise<void> {
+        const config = this.configs.get(configName)
+        if (!config) throw new Error(`ConsoleSender: config '${configName}' not found`)
+
+        const useTimestamps = config.timestamps ?? true
+        const useLevels     = config.levels ?? true
+        const prefix        = config.prefix ? `${config.prefix} ` : ''
+
+        const ts    = useTimestamps ? `[${new Date().toISOString()}] ` : ''
+        const level = message.level ?? 'info'
+        const lvTag = useLevels ? `[${level.toUpperCase()}] ` : ''
+        const color = LEVEL_COLORS[level] ?? ''
+
+        const subject = message.subject ? `${message.subject}: ` : ''
+        const to      = message.to ? ` → ${Array.isArray(message.to) ? message.to.join(', ') : message.to}` : ''
+
+        const line = `${color}${ts}${prefix}${lvTag}${subject}${message.body}${to}${RESET}`
+
+        if (level === 'error') {
+            console.error(line)
+        } else if (level === 'warning') {
+            console.warn(line)
+        } else {
+            console.log(line)
+        }
+    }
+
+    getConfigSchema(): ISenderFieldDef[] {
+        return [
+            { name: 'name', label: 'Name', required: true },
+            { name: 'prefix', label: 'Prefix' },
+            { name: 'timestamps', label: 'Timestamps', type: 'boolean' },
+            { name: 'levels', label: 'Levels', type: 'boolean' },
+        ]
+    }
+
+    async startSender(_senders: ISenderAccess): Promise<void> {}
+    async stopSender(): Promise<void> {}
+}
+
+export default ConsoleSender

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "strict": true,
+        "lib": ["ES2020"],
+        "types": ["node"],
+        "skipLibCheck": true,
+        "esModuleInterop": true
+    },
+    "include": ["src"]
+}

package/watch.mjs

@@ -0,0 +1,20 @@
+import esbuild from 'esbuild'
+import fs from 'fs'
+import path from 'path'
+
+fs.mkdirSync('dist', { recursive: true })
+const meta = JSON.parse(fs.readFileSync('package.json', 'utf-8'))
+fs.writeFileSync(path.join('dist', 'package.json'), JSON.stringify({ id: meta.id, name: meta.name, displayName: meta.displayName, version: meta.version, description: meta.description }, null, 2))
+
+const ctx = await esbuild.context({
+    entryPoints: ['src/back/index.ts'],
+    bundle: true,
+    format: 'cjs',
+    platform: 'node',
+    target: 'node20',
+    outfile: 'dist/back.js',
+    loader: { '.ts': 'ts' },
+    minify: false,
+})
+await ctx.watch()
+console.log('[watch] Watching src/ — back.js rebuilds on every change.')