@jmlq/logger-plugin-fs 0.1.0-alpha.4 → 0.1.0-alpha.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 mlahuasi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -15,47 +15,9 @@ npm i @jmlq/logger @jmlq/logger-plugin-fs
 
 Este plugin **depende** de [`@jmlq/logger`](https://www.npmjs.com/package/@jmlq/logger). Asegúrate de instalar ambos paquetes.
 
-## 🧱 Estructura del paquete
-
-### 📝 Resumen rápido
-
-> - **`src/domain/`** — Reglas del negocio del plugin (sin dependencias de Node).
->   > - **`contracts/`**
->   >   > - `clock.contract.ts` — Puerto que abstrae el tiempo actual (`now()`), permite testear rotación sin depender de `Date.now()`.
->   >   > - `file-rotator.port.ts` — Puerto para rotación: calcula path esperado, tamaño, índice, etc.
->   >   > - `stream-writer.port.ts` — Puerto para escritura secuencial: `write`, `once("drain")`, `end`.
->   > - **`value-objects/`**
->   >   > - `file-name-pattern.vo.ts` — VO que encapsula el patrón de nombres (`{yyyy}{MM}{dd}`) con validación.
->   >   > - `rotation-policy.vo.ts` — VO que define estrategia de rotación (`none | day | size`) con invariantes (`maxSizeMB > 0`).
->   > - **`types/`**
->   >   > - `options.type.ts` — Define `FsDatasourceOptions` y `IFsSerializer` (contrato de serialización de líneas).
-
-> - **`src/application/`** — Casos de uso (orquestan, no dependen de Node).
->   > - **`dto/`**
->   >   > - `save-log.dto.ts` — DTO de entrada: `{ log: ILog }`.
->   > - **`use-cases/`**
->   >   > - `rotate-if-needed.usecase.ts` — Decide si se rota: compara fecha/tamaño contra `RotationPolicy`.
->   >   > - `append-log.usecase.ts` — Serializa y escribe línea; maneja backpressure (`write=false` → espera `drain`).
->   >   > - `persist-log.usecase.ts` — Orquesta: asegura writer, rota si corresponde, escribe, dispara hooks.
->   > - **`services/`**
->   >   > - `fs-datasource.service.ts` — Implementa `ILogDatasource` del core usando los UC anteriores.
-
-> - **`src/infrastructure/`** — Adaptadores técnicos (Node.js).
->   > - **`fs/`**
->   >   > - `fs-provider.ts` — Wrapper de `fs`/`fs.promises` (mockeable en tests).
->   >   > - `path-utils.ts` — Utilidades para `join`, `splitBaseExt`, `formatPattern` (UTC).
->   >   > - `file-rotator.adapter.ts` — Implementa `IFileRotatorPort` usando `fs-provider` y `path-utils`.
->   >   > - `fs-writer.adapter.ts` — Implementa `IStreamWriterPort` con `fs.createWriteStream`.
->   >   > - `node-clock.adapter.ts` — Implementa `IClock` devolviendo `new Date()`.
-
-> - **`src/presentation/`** — API pública (cara del paquete).
->   > - **`factory/`**
->   >   > - `create-fs-datasource.ts` — Ensambla VO + adaptadores + casos de uso y devuelve un `ILogDatasource`.
->   > - `index.ts` — Barrel: reexporta la factory y VO/contratos públicos (`RotationPolicy`, `FileNamePattern`).
-
 ---
 
-### 🧩 Configuración
+## 🧩 Configuración
 
 ### 🔐 Variables de Entorno (.env)
 
@@ -81,11 +43,7 @@ LOGGER_LEVEL=info  # trace|debug|info|warn|error|fatal
 
 ```tsx
 import { createLogger, LogLevel } from "@jmlq/logger";
-import {
-  createFsDatasource,
-  RotationPolicy,
-  FileNamePattern,
-} from "@jmlq/logger-plugin-fs";
+import { createFsDatasource } from "@jmlq/logger-plugin-fs";
 
 const ds = createFsDatasource({
   basePath: "./logs", // Carpeta destino
@@ -112,7 +70,32 @@ process.on("SIGTERM", async () => {
 });
 ```
 
-#### Opciones soportadas
+También:
+
+```ts
+import { createLogger, LogLevel } from "@jmlq/logger";
+import {
+  createFsDatasource,
+  RotationPolicy,
+  FileNamePattern,
+} from "@jmlq/logger-plugin-fs";
+
+// Validación/invariantes tempranas con VO (throws si es inválido)
+const pt = new FileNamePattern("app-{yyyy}{MM}{dd}.log");
+const rt = new RotationPolicy("size", 50 /* maxSizeMB */);
+
+const ds = createFsDatasource({
+  basePath: "./logs",
+  mkdir: true,
+  // La factory acepta primitives; usamos los VO arriba solo para validar/centrar la decisión
+  fileNamePattern: pt.pattern,
+  rotation: { by: rt.by, maxSizeMB: rotation.maxSizeMB },
+});
+
+const logger = createLogger(ds, { minLevel: LogLevel.INFO });
+```
+
+#### ⚙️ Opciones soportadas
 
 > - `basePath: string` – carpeta donde se guardan los logs.
 > - `mkdir?: boolean` – crea la carpeta si no existe.
@@ -183,6 +166,10 @@ No out-of-the-box. Puedes implementar un **FileNamePattern** por hora (ej. `app-
 
 ---
 
+#### [LEER MAS...](./ARQUITECTURA.md)
+
+---
+
 ## 📄 Licencia
 
 MIT © Mauricio Lahuasi

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@jmlq/logger-plugin-fs",
-  "version": "0.1.0-alpha.4",
+  "version": "0.1.0-alpha.6",
   "author": "MLahuasi",
+  "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -24,7 +25,7 @@
     "jest": "^30.1.3"
   },
   "dependencies": {
-    "@jmlq/logger": "^0.1.0-alpha.2"
+    "@jmlq/logger": "^0.1.0-alpha.6"
   },
   "overrides": {
     "test-exclude": "^7.0.1",