@jmlq/logger 0.1.0-alpha.2 → 0.1.0-alpha.21

package/package.json

@@ -1,19 +1,45 @@
 {
   "name": "@jmlq/logger",
-  "version": "0.1.0-alpha.2",
-  "author": "MLahuasi",
+  "description": "logger package with clean architecture",
+  "version": "0.1.0-alpha.21",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "prepublishOnly": "npm run build"
+    "dev": "rimraf dist && mkdir dist && tsc -p tsconfig.json",
+    "build": "rimraf dist && mkdir dist && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "example:help": "tsx examples/index.example.ts help",
+    "example:all": "tsx examples/index.example.ts",
+    "example:domain-services": "tsx examples/index.example.ts domain-services",
+    "example:services": "tsx examples/index.example.ts services",
+    "example:use-cases": "tsx examples/index.example.ts use-cases",
+    "example:factories": "tsx examples/index.example.ts factories"
   },
+  "keywords": [
+    "logger",
+    "clean-architecture",
+    "typescript"
+  ],
+  "author": "MLahuasi",
+  "license": "MIT",
   "devDependencies": {
-    "@types/node": "^24.3.0",
-    "tsx": "^4.20.5",
-    "typescript": "^5.9.2"
-  }
+    "@swc/core": "^1.3.95",
+    "@swc/jest": "^0.2.29",
+    "@types/bcryptjs": "^2.4.5",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.8.10",
+    "jest": "^29.7.0",
+    "rimraf": "^6.1.2",
+    "tsx": "^4.1.4",
+    "typescript": "^5.2.2"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "architecture.md",
+    "assets"
+  ]
 }

package/dist/Composite/index.d.ts

@@ -1,9 +0,0 @@
-import { IGetLogsFilter, ILogDatasource, ILog } from "../config";
-export declare class CompositeDatasource implements ILogDatasource {
-    private readonly datasources;
-    constructor(datasources: ILogDatasource[]);
-    save(log: ILog): Promise<void>;
-    find(filter?: IGetLogsFilter): Promise<ILog[]>;
-    flush(): Promise<void>;
-    dispose(): Promise<void>;
-}

package/dist/Composite/index.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompositeDatasource = void 0;
-// ---- Composite fan-out ----
-class CompositeDatasource {
-    constructor(datasources) {
-        this.datasources = datasources;
-    }
-    async save(log) {
-        const results = await Promise.allSettled(this.datasources.map((ds) => ds.save(log)));
-        for (const r of results) {
-            if (r.status === "rejected") {
-                // Evita romper el flujo si un destino falla.
-                // Aquí podrías enrutar a "dead-letter", métricas, etc.
-                // eslint-disable-next-line no-console
-                console.warn("[CompositeDatasource] save failed:", r.reason);
-            }
-        }
-    }
-    async find(filter = {}) {
-        for (const ds of this.datasources) {
-            if (typeof ds.find === "function") {
-                try {
-                    return await ds.find(filter);
-                }
-                catch (e) {
-                    // eslint-disable-next-line no-console
-                    console.warn("[CompositeDatasource] find failed on a datasource:", e);
-                    // probar siguiente datasource
-                }
-            }
-        }
-        return [];
-    }
-    async flush() {
-        const results = await Promise.allSettled(this.datasources.map((ds) => ds.flush?.() ?? Promise.resolve()));
-        for (const r of results) {
-            if (r.status === "rejected") {
-                // eslint-disable-next-line no-console
-                console.warn("[CompositeDatasource] flush failed:", r.reason);
-            }
-        }
-    }
-    async dispose() {
-        const results = await Promise.allSettled(this.datasources.map((ds) => ds.dispose?.() ?? Promise.resolve()));
-        for (const r of results) {
-            if (r.status === "rejected") {
-                // eslint-disable-next-line no-console
-                console.warn("[CompositeDatasource] dispose failed:", r.reason);
-            }
-        }
-    }
-}
-exports.CompositeDatasource = CompositeDatasource;

package/dist/Factory/index.d.ts

@@ -1,5 +0,0 @@
-import { ILogDatasource, Logger, LogLevel } from "..";
-export declare function createLogger(ds: ILogDatasource, opts: {
-    minLevel: LogLevel;
-    redactPII?: boolean;
-}): Logger;

package/dist/Factory/index.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLogger = createLogger;
-const __1 = require("..");
-function createLogger(ds, opts) {
-    const write = async (level, message, meta) => {
-        if (level < opts.minLevel)
-            return;
-        // (Opcional) redactor PII aquí si opts.redactPII === true
-        await ds.save({ level, message, meta, timestamp: Date.now() });
-    };
-    const logger = {
-        trace: (m, meta) => write(__1.LogLevel.TRACE, m, meta),
-        debug: (m, meta) => write(__1.LogLevel.DEBUG, m, meta),
-        info: (m, meta) => write(__1.LogLevel.INFO, m, meta),
-        warn: (m, meta) => write(__1.LogLevel.WARN, m, meta),
-        error: (m, meta) => write(__1.LogLevel.ERROR, m, meta),
-        fatal: (m, meta) => write(__1.LogLevel.FATAL, m, meta),
-        flush: () => ds.flush?.() ?? Promise.resolve(),
-        dispose: () => ds.dispose?.() ?? Promise.resolve(),
-    };
-    return logger;
-}

package/dist/config/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./interfaces";
-export * from "./types";

package/dist/config/interfaces/index.d.ts

@@ -1,67 +0,0 @@
-import { LogLevel, LogMessage, PiiReplacement } from "..";
-export interface ILog {
-    level: LogLevel;
-    message: string;
-    meta?: unknown;
-    timestamp: number;
-}
-export interface IGetLogsFilter {
-    levelMin?: LogLevel;
-    since?: number;
-    until?: number;
-}
-export interface ILogDatasource {
-    save(log: ILog): Promise<void>;
-    find?(filter?: IGetLogsFilter): Promise<ILog[]>;
-    flush?(): Promise<void>;
-    dispose?(): Promise<void>;
-}
-export interface ILogger {
-    trace: (msg: LogMessage, meta?: unknown) => Promise<void>;
-    debug: (msg: LogMessage, meta?: unknown) => Promise<void>;
-    info: (msg: LogMessage, meta?: unknown) => Promise<void>;
-    warn: (msg: LogMessage, meta?: unknown) => Promise<void>;
-    error: (msg: LogMessage, meta?: unknown) => Promise<void>;
-    fatal: (msg: LogMessage, meta?: unknown) => Promise<void>;
-    flush?: () => Promise<void>;
-    dispose?: () => Promise<void>;
-}
-export interface IPiiPattern {
-    /** (Opcional) Nombre del patrón para debug/telemetría */
-    name?: string;
-    /** Expresión regular a aplicar sobre strings */
-    regex: RegExp;
-    /** Reemplazo, por defecto "[REDACTED]" si no se provee */
-    replacement?: PiiReplacement;
-}
-export interface IPiiRedactorOptions {
-    /** Habilita/deshabilita redacción (permite control fino además del flag redactPII) */
-    enabled?: boolean;
-    /**
-     * Incluye patrones default (true) y fusiona con los custom. Si false, usa solo los personalizados
-     * por el cliente.
-     */
-    includeDefaultPatterns?: boolean;
-    /** Patrones adicionales o propios del cliente */
-    patterns?: IPiiPattern[];
-    /**
-     * Redactar por nombre de clave (deep). Cualquier key que haga match será redacatada
-     * con "[REDACTED]". Acepta exacto o RegExp.
-     */
-    redactKeys?: Array<string | RegExp>;
-    /**
-     * Claves que NO se deben redactar aunque coincidan con patrones o redactKeys.
-     * Prioridad: preserveKeys > redactKeys > patterns.
-     */
-    preserveKeys?: Array<string | RegExp>;
-}
-export interface ICreateLoggerOptions {
-    minLevel?: LogLevel;
-    /** compatibilidad con lo que ya tienes */
-    redactPII?: boolean;
-    /** NUEVO: bloque de configuración PII */
-    pii?: IPiiRedactorOptions & {
-        /** atajo para permitir que el cliente mande solo patterns sin escribir PiiRedactorOptions */
-        patterns?: IPiiPattern[];
-    };
-}

package/dist/config/types/index.d.ts

@@ -1,10 +0,0 @@
-export declare enum LogLevel {
-    TRACE = 0,
-    DEBUG = 1,
-    INFO = 2,
-    WARN = 3,
-    ERROR = 4,
-    FATAL = 5
-}
-export type PiiReplacement = string | ((match: string, keyPath: string[]) => string);
-export type LogMessage = string | Record<string, unknown> | Error;

package/dist/config/types/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevel = void 0;
-// ---- Types ----
-var LogLevel;
-(function (LogLevel) {
-    LogLevel[LogLevel["TRACE"] = 0] = "TRACE";
-    LogLevel[LogLevel["DEBUG"] = 1] = "DEBUG";
-    LogLevel[LogLevel["INFO"] = 2] = "INFO";
-    LogLevel[LogLevel["WARN"] = 3] = "WARN";
-    LogLevel[LogLevel["ERROR"] = 4] = "ERROR";
-    LogLevel[LogLevel["FATAL"] = 5] = "FATAL";
-})(LogLevel || (exports.LogLevel = LogLevel = {}));

package/dist/domain/services/pii-redactor.d.ts

@@ -1,27 +0,0 @@
-/**
- * Domain Service: PiiRedactor
- *
- * Propósito:
- * - Redactar/anonimizar PII en strings, objetos y arrays (deep).
- * - Permitir que el cliente pase patrones adicionales/propios.
- * - Controlar redacción por nombre de clave (whitelist/blacklist).
- */
-import { IPiiPattern, IPiiRedactorOptions } from "../../config";
-export declare class PiiRedactor {
-    private readonly enabled;
-    private readonly patterns;
-    private readonly redactKeys;
-    private readonly preserveKeys;
-    constructor(opts?: IPiiRedactorOptions);
-    /** Patrones por defecto (seguros y genéricos). Ajusta según tu dominio/región si lo deseas. */
-    static defaultPatterns(): IPiiPattern[];
-    /** Punto de entrada público: redacción deep de cualquier estructura */
-    redact<T = unknown>(value: T): T;
-    /** === Internos === */
-    private redactValue;
-    private applyPatterns;
-    private isRedactedKey;
-    private isPreservedKey;
-    private keyRedactionReplacement;
-    private clone;
-}

package/dist/domain/services/pii-redactor.js

@@ -1,139 +0,0 @@
-"use strict";
-/**
- * Domain Service: PiiRedactor
- *
- * Propósito:
- * - Redactar/anonimizar PII en strings, objetos y arrays (deep).
- * - Permitir que el cliente pase patrones adicionales/propios.
- * - Controlar redacción por nombre de clave (whitelist/blacklist).
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PiiRedactor = void 0;
-class PiiRedactor {
-    constructor(opts = {}) {
-        const { enabled = true, includeDefaultPatterns = true, patterns = [], redactKeys = [], preserveKeys = [], } = opts;
-        this.enabled = enabled;
-        this.patterns = includeDefaultPatterns
-            ? [...PiiRedactor.defaultPatterns(), ...patterns]
-            : [...patterns];
-        this.redactKeys = redactKeys;
-        this.preserveKeys = preserveKeys;
-    }
-    /** Patrones por defecto (seguros y genéricos). Ajusta según tu dominio/región si lo deseas. */
-    static defaultPatterns() {
-        return [
-            // Tarjetas (13–19 dígitos con espacios o guiones) — patrón simple
-            {
-                name: "credit_card",
-                regex: /\b(?:\d[ -]*?){13,19}\b/g,
-                replacement: "[REDACTED_CARD]",
-            },
-            // Emails
-            {
-                name: "email",
-                regex: /\b[\w._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}\b/g,
-                replacement: "[REDACTED_EMAIL]",
-            },
-            // Teléfonos: 10+ dígitos (ajusta a tu región si hace falta)
-            {
-                name: "phone",
-                regex: /\b\d{10,}\b/g,
-                replacement: "[REDACTED_PHONE]",
-            },
-            // Documento genérico: ABC-123456… o similar
-            {
-                name: "document_id",
-                regex: /\b[A-Z]{1,3}-?\d{6,10}\b/g,
-                replacement: "[REDACTED_ID]",
-            },
-            // IPv4
-            {
-                name: "ipv4",
-                regex: /\b(?:(?:25[0-5]|2[0-4]\d|1?\d?\d)(?:\.|$)){4}\b/g,
-                replacement: "[REDACTED_IP]",
-            },
-        ];
-    }
-    /** Punto de entrada público: redacción deep de cualquier estructura */
-    redact(value) {
-        if (!this.enabled)
-            return value;
-        return this.redactValue(value, []);
-    }
-    /** === Internos === */
-    redactValue(value, keyPath) {
-        // Strings → aplicar patrones
-        if (typeof value === "string") {
-            return this.applyPatterns(value, keyPath);
-        }
-        // Números / boolean / null / undefined → retornar tal cual
-        if (typeof value === "number" ||
-            typeof value === "boolean" ||
-            value === null ||
-            typeof value === "undefined") {
-            return value;
-        }
-        // Arrays → deep
-        if (Array.isArray(value)) {
-            return value.map((v, i) => this.redactValue(v, [...keyPath, String(i)]));
-        }
-        // Objetos → deep + reglas por nombre de clave
-        if (typeof value === "object") {
-            const src = value;
-            const out = {};
-            for (const [k, v] of Object.entries(src)) {
-                const path = [...keyPath, k];
-                if (this.isPreservedKey(k)) {
-                    out[k] = this.clone(v); // explícitamente preservado
-                    continue;
-                }
-                if (this.isRedactedKey(k)) {
-                    out[k] = this.keyRedactionReplacement(k, path);
-                    continue;
-                }
-                out[k] = this.redactValue(v, path);
-            }
-            return out;
-        }
-        // funciones, símbolos, etc.
-        return value;
-    }
-    applyPatterns(text, keyPath) {
-        let result = text;
-        for (const p of this.patterns) {
-            const replacement = p.replacement ?? "[REDACTED]";
-            // Soporta función de reemplazo con contexto (ruta de claves)
-            if (typeof replacement === "function") {
-                result = result.replace(p.regex, (m) => replacement(m, keyPath));
-            }
-            else {
-                result = result.replace(p.regex, replacement);
-            }
-        }
-        return result;
-    }
-    isRedactedKey(key) {
-        return this.redactKeys.some((r) => typeof r === "string" ? r === key : r.test(key));
-    }
-    isPreservedKey(key) {
-        return this.preserveKeys.some((r) => typeof r === "string" ? r === key : r.test(key));
-    }
-    keyRedactionReplacement(_key, _path) {
-        return "[REDACTED]";
-    }
-    clone(v) {
-        if (v && typeof v === "object") {
-            try {
-                return JSON.parse(JSON.stringify(v));
-            }
-            catch {
-                // fallback shallow
-                if (Array.isArray(v))
-                    return [...v];
-                return { ...v };
-            }
-        }
-        return v;
-    }
-}
-exports.PiiRedactor = PiiRedactor;

package/dist/interfaces/index.d.ts

@@ -1,35 +0,0 @@
-export declare enum LogLevel {
-    TRACE = 0,
-    DEBUG = 1,
-    INFO = 2,
-    WARN = 3,
-    ERROR = 4,
-    FATAL = 5
-}
-export interface Log {
-    level: LogLevel;
-    message: string;
-    meta?: unknown;
-    timestamp: number;
-}
-export interface GetLogsFilter {
-    levelMin?: LogLevel;
-    since?: number;
-    until?: number;
-}
-export interface ILogDatasource {
-    save(log: Log): Promise<void>;
-    find?(filter?: GetLogsFilter): Promise<Log[]>;
-    flush?(): Promise<void>;
-    dispose?(): Promise<void>;
-}
-export interface Logger {
-    trace: (msg: string, meta?: unknown) => Promise<void>;
-    debug: (msg: string, meta?: unknown) => Promise<void>;
-    info: (msg: string, meta?: unknown) => Promise<void>;
-    warn: (msg: string, meta?: unknown) => Promise<void>;
-    error: (msg: string, meta?: unknown) => Promise<void>;
-    fatal: (msg: string, meta?: unknown) => Promise<void>;
-    flush?: () => Promise<void>;
-    dispose?: () => Promise<void>;
-}

package/dist/interfaces/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevel = void 0;
-// ---- Types & contratos ----
-var LogLevel;
-(function (LogLevel) {
-    LogLevel[LogLevel["TRACE"] = 0] = "TRACE";
-    LogLevel[LogLevel["DEBUG"] = 1] = "DEBUG";
-    LogLevel[LogLevel["INFO"] = 2] = "INFO";
-    LogLevel[LogLevel["WARN"] = 3] = "WARN";
-    LogLevel[LogLevel["ERROR"] = 4] = "ERROR";
-    LogLevel[LogLevel["FATAL"] = 5] = "FATAL";
-})(LogLevel || (exports.LogLevel = LogLevel = {}));

package/dist/presentation/factory/index.d.ts

@@ -1,2 +0,0 @@
-import { ICreateLoggerOptions, ILogDatasource, ILogger } from "../..";
-export declare function createLogger(ds: ILogDatasource, opts?: ICreateLoggerOptions): ILogger;

package/dist/presentation/factory/index.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLogger = createLogger;
-const __1 = require("../..");
-/**
- * Normaliza cualquier LogMessage a string, aplicando PII (si procede) ANTES de serializar.
- */
-function normalizeLogMessage(value, redactEnabled, redactor) {
-    const v = redactEnabled ? redactor.redact(value) : value;
-    if (typeof v === "string")
-        return v;
-    // Si soportas Error en LogMessage, lo serializamos “bonito”
-    if (v instanceof Error) {
-        const err = v;
-        const obj = {
-            error: err.name || "Error",
-            message: err.message,
-            stack: err.stack,
-            code: err.code,
-            cause: err.cause,
-        };
-        try {
-            return JSON.stringify(obj);
-        }
-        catch {
-            return `${obj.error}: ${obj.message}`;
-        }
-    }
-    // Objeto → JSON
-    try {
-        return JSON.stringify(v);
-    }
-    catch {
-        // fallback ultra defensivo
-        return String(v);
-    }
-}
-function createLogger(ds, opts = {}) {
-    const minLevel = opts.minLevel ?? __1.LogLevel.INFO;
-    // Compatibilidad: redactPII (boolean) o pii.enabled
-    const redactEnabled = (opts.redactPII ?? false) || (opts.pii?.enabled ?? false);
-    // Inicializa redactor con opciones del cliente (incluye defaults por defecto)
-    const redactor = new __1.PiiRedactor({
-        enabled: redactEnabled,
-        includeDefaultPatterns: opts.pii?.includeDefaultPatterns ?? true,
-        patterns: opts.pii?.patterns,
-        redactKeys: opts.pii?.redactKeys,
-        preserveKeys: opts.pii?.preserveKeys,
-    });
-    const emit = async (level, message, meta) => {
-        if (level < minLevel)
-            return;
-        const msgStr = normalizeLogMessage(message, redactEnabled, redactor);
-        const metaVal = redactEnabled ? redactor.redact(meta) : meta;
-        const payload = {
-            level,
-            timestamp: Date.now(),
-            message: msgStr, // <- garantizamos string
-            meta: metaVal,
-        };
-        await ds.save(payload);
-    };
-    const logger = {
-        trace: (m, meta) => emit(__1.LogLevel.TRACE, m, meta),
-        debug: (m, meta) => emit(__1.LogLevel.DEBUG, m, meta),
-        info: (m, meta) => emit(__1.LogLevel.INFO, m, meta),
-        warn: (m, meta) => emit(__1.LogLevel.WARN, m, meta),
-        error: (m, meta) => emit(__1.LogLevel.ERROR, m, meta),
-        fatal: (m, meta) => emit(__1.LogLevel.FATAL, m, meta),
-        flush: () => ds.flush?.() ?? Promise.resolve(),
-        dispose: () => ds.dispose?.() ?? Promise.resolve(),
-    };
-    return logger;
-}

package/dist/presentation/index.d.ts

@@ -1 +0,0 @@
-export * from "./factory";