zario 0.7.0 → 0.8.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Damilare Osibanjo
-
-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.
+MIT License
+
+Copyright (c) 2025 Damilare Osibanjo
+
+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

@@ -1,142 +1,139 @@
-<div align="center">
-
-<a id="top"></a>
-
-# 📝 Zario
-
-### A Minimal Logging Solution for TypeScript
-
-[![npm version](https://img.shields.io/npm/v/zario?style=for-the-badge&logo=npm&color=CB3837)](https://www.npmjs.com/package/zario)
-[![license](https://img.shields.io/npm/l/zario?style=for-the-badge&color=green)](./LICENSE)
-[![downloads](https://img.shields.io/npm/dt/zario?style=for-the-badge&logo=npm&color=orange)](https://www.npmjs.com/package/zario)
-[![bundle size](https://img.shields.io/bundlephobia/minzip/zario?style=for-the-badge&logo=webpack&color=purple)](https://bundlephobia.com/package/zario)
-
-[Japanese](README-JP.md)
-
-<br/>
-
-**Fast** • **Lightweight** • **Zero Dependencies** • **TypeScript Native**
-
-<br/>
-
-[📖 Documentation](#-documentation) · [⚡ Quick Start](#-quick-start) · [✨ Features](#-features) · [🤝 Contributing](#-contributing)
-
-<br/>
-
-![separator](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
-
-</div>
-
-<br/>
-
-## Features
-
-- **Lightweight** — minimal footprint, fast execution
-- **Simple API** — intuitive methods like `info()`, `warn()`, `error()`
-- **Flexible formatting** — plain text or structured JSON
-- **Multiple transports** — Console, File (streaming rotation), HTTP (async retry), CircuitBreaker, and DeadLetterQueue
-- **Child loggers** — scoped logging for modules or requests
-- **Async mode** — non-blocking writes for high-performance applications
-- **Memory safe** — bounded queues and memory-efficient streaming
-- **Customizable** — custom log levels, colors, and filtering
-
-## 📦 Installation
-
-```bash
-npm install zario
-```
-
-## 🚀 Quick Start
-
-```typescript
-import { Logger, ConsoleTransport } from "zario";
-
-const logger = new Logger({
-  level: "info",
-  colorize: true,
-  transports: [new ConsoleTransport()],
-  prefix: "[MyApp]",
-});
-
-logger.info("🚀 Server started on port 3000");
-logger.warn("⚠️ High memory usage detected");
-logger.error("❌ Database connection failed", { code: 500 });
-```
-
-## 📘 More Examples
-
-### Child Logger
-```ts
-const requestLogger = logger.createChild({
-  context: { scope: "request" },
-});
-requestLogger.info("Incoming request");
-
-```
-
-### JSON Logging
-```ts
-import { Logger, ConsoleTransport } from "zario";
-
-const jsonLogger = new Logger({
-  json: true,
-  transports: [new ConsoleTransport()],
-});
-
-```
-
-### File Transport
-
-```ts
-import { Logger, FileTransport } from "zario";
-
-const logger = new Logger({
-  transports: [
-    new FileTransport({
-      path: "./logs/app.log",
-      maxSize: 10 * 1024 * 1024,
-      maxFiles: 5,
-    }),
-  ],
-});
-
-logger.info("This log is written to a file");
-```
-
-## 📖 Documentation
-
-Documentation:
-
-| Section                                             | Description                                                                   |
-| --------------------------------------------------- | ----------------------------------------------------------------------------- |
-| [📘 **Introduction**](./docs/introduction.md)       | Philosophy, core features, and common use cases.                              |
-| [🚀 **Getting Started**](./docs/getting-started.md) | Detailed installation and environment auto-configuration.                     |
-| [⚙️ **Configuration**](./docs/configuration.md)     | Full reference for all logger options, custom levels, and colors.             |
-| [📖 **API Reference**](./docs/api-reference.md)     | Detailed API documentation for the Logger class and utilities.                |
-| [📁 **Transports**](./docs/transports.md)           | Guide to Console, File, HTTP, CircuitBreaker, and DeadLetterQueue transports. |
-| [🧩 **Advanced Usage**](./docs/advanced-usage.md)   | Filters, Enrichers (Structured Logging), and Aggregators.                     |
-| [📊 **Log Formats**](./docs/log-formats.md)         | Specification for Text and JSON output formats.                               |
-| [🗺️ **Roadmap**](./docs/roadmap.md)                 | Future plans and upcoming features.                                           |
-| [📊 **Benchmarks**](./docs/benchmarks.md)           | Performance comparison with other logging libraries.                          |
-
-## 🤝 Contributing
-
-We welcome contributions! Whether it's bug reports, feature requests, or code contributions. Please see our [Contributing Guide](./CONTRIBUTING.md) for more details.
-
-## 📄 License
-
-This project is licensed under the **MIT License** - see the [LICENSE](./LICENSE) file for full details.
-
-<br/>
-
-<div align="center">
-
-### Developed for developers
-
-⭐ Star this repository to show your support
-
-</div>
-
-<br/>
-
-[⬆ Back to Top](#top)
+<div align="center">
+
+<a id="top"></a>
+
+# 📝 Zario
+
+### Fast and simple logging library for TypeScript
+
+[![npm version](https://img.shields.io/npm/v/zario?style=for-the-badge&logo=npm&color=CB3837)](https://www.npmjs.com/package/zario)
+[![license](https://img.shields.io/npm/l/zario?style=for-the-badge&color=green)](./LICENSE)
+[![downloads](https://img.shields.io/npm/dt/zario?style=for-the-badge&logo=npm&color=orange)](https://www.npmjs.com/package/zario)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/zario?style=for-the-badge&logo=webpack&color=purple)](https://bundlephobia.com/package/zario)
+
+[Japanese](README-JP.md)
+
+<br/>
+
+**Fast** • **Simple** • **Zero Dependencies** • **TypeScript Native**
+
+<br/>
+
+[⚡ Quick Start](#-quick-start) · [📖 Documentation](#-documentation) · [🤝 Contributing](#-contributing)
+
+<br/>
+
+![separator](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
+
+</div>
+
+<br/>
+
+## Features
+
+- **Zero dependencies** — nothing to install, nothing to break
+- **Simple API** — `logger.info()`, `logger.warn()`, `logger.error()`
+- **Flexible formatting** — plain text or structured JSON
+- **Multiple transports** — Console, File (rotation + compression), HTTP (with retry)
+- **Child loggers** — scoped logging for modules or requests
+- **Async mode** — non-blocking writes for high-throughput apps
+- **Customizable** — custom log levels, colors, and filters
+
+## 📦 Installation
+
+```bash
+npm install zario
+```
+
+## 🚀 Quick Start
+
+```typescript
+import { Logger, ConsoleTransport } from "zario";
+
+const logger = new Logger({
+  level: "info",
+  colorize: true,
+  transports: [new ConsoleTransport()],
+  prefix: "[MyApp]",
+});
+
+logger.info("Server started on port 3000");
+logger.warn("High memory usage detected");
+logger.error("Database connection failed", { code: 500 });
+```
+
+### Child Logger
+
+```ts
+const requestLogger = logger.createChild({
+  context: { scope: "request" },
+});
+requestLogger.info("Incoming request");
+```
+
+### JSON Logging
+
+```ts
+import { Logger, ConsoleTransport } from "zario";
+
+const jsonLogger = new Logger({
+  json: true,
+  transports: [new ConsoleTransport()],
+});
+```
+
+### File Transport
+
+```ts
+import { Logger, FileTransport } from "zario";
+
+const logger = new Logger({
+  transports: [
+    new FileTransport({
+      path: "./logs/app.log",
+      maxSize: 10 * 1024 * 1024,
+      maxFiles: 5,
+    }),
+  ],
+});
+```
+
+### Lean Import
+
+If you only need the core logger:
+
+```typescript
+import { Logger } from "zario/logger";
+```
+
+## 📖 Documentation
+
+| Section | Description |
+|---|---|
+| [Configuration](./docs/configuration.md) | Logger options, custom levels, and colors |
+| [API Reference](./docs/api-reference.md) | Logger class and utilities |
+| [Transports](./docs/transports.md) | Console, File, HTTP, CircuitBreaker, DeadLetterQueue |
+| [Advanced Usage](./docs/advanced-usage.md) | Filters, enrichers, aggregators, async mode |
+| [Log Formats](./docs/log-formats.md) | Text and JSON output spec |
+| [Benchmarks](./docs/benchmarks.md) | Performance comparison with other libraries |
+| [Roadmap](./docs/roadmap.md) | Future plans |
+
+## 🤝 Contributing
+
+Bug reports, feature requests, and pull requests welcome. See [Contributing Guide](./CONTRIBUTING.md).
+
+## 📄 License
+
+[MIT License](./LICENSE)
+
+<br/>
+
+<div align="center">
+
+⭐ Star this repository if you find it useful
+
+</div>
+
+<br/>
+
+[⬆ Back to Top](#top)

package/dist/aggregation/LogAggregator.cjs

@@ -0,0 +1,161 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/aggregation/LogAggregator.ts
+var LogAggregator_exports = {};
+__export(LogAggregator_exports, {
+  BatchAggregator: () => BatchAggregator,
+  CompositeAggregator: () => CompositeAggregator,
+  TimeBasedAggregator: () => TimeBasedAggregator
+});
+module.exports = __toCommonJS(LogAggregator_exports);
+var BatchAggregator = class {
+  constructor(maxSize = 100, flushCallback, maxQueueSize = 1e4) {
+    this.logs = [];
+    this.pendingFlush = null;
+    this.maxSize = maxSize;
+    this.maxQueueSize = maxQueueSize;
+    this.flushCallback = flushCallback;
+  }
+  aggregate(logData, formatter) {
+    if (this.logs.length >= this.maxQueueSize) {
+      this.logs.shift();
+    }
+    this.logs.push({ logData, formatter });
+    if (this.logs.length >= this.maxSize && !this.pendingFlush) {
+      const result = this.flush();
+      if (result instanceof Promise) {
+        this.pendingFlush = result.finally(() => {
+          this.pendingFlush = null;
+        });
+      }
+    }
+  }
+  flush() {
+    if (this.pendingFlush) {
+      return this.pendingFlush;
+    }
+    if (this.logs.length === 0) {
+      return;
+    }
+    const logsToFlush = this.logs;
+    this.logs = [];
+    try {
+      const callbackResult = this.flushCallback(logsToFlush);
+      if (callbackResult instanceof Promise) {
+        return callbackResult.catch((error) => {
+          this.logs = logsToFlush.concat(this.logs);
+          throw error;
+        });
+      }
+    } catch (error) {
+      this.logs = logsToFlush.concat(this.logs);
+      throw error;
+    }
+  }
+};
+var TimeBasedAggregator = class {
+  constructor(flushInterval, flushCallback, maxQueueSize = 1e4) {
+    this.logs = [];
+    this.timer = null;
+    this.flushInterval = flushInterval;
+    this.maxQueueSize = maxQueueSize;
+    this.flushCallback = flushCallback;
+  }
+  aggregate(logData, formatter) {
+    if (this.logs.length >= this.maxQueueSize) {
+      this.logs.shift();
+    }
+    this.logs.push({ logData, formatter });
+    if (!this.timer) {
+      this.timer = setTimeout(() => {
+        const result = this.flush();
+        if (result instanceof Promise) {
+          result.catch((error) => {
+            console.error(
+              "Error in TimeBasedAggregator flush callback:",
+              error
+            );
+          });
+        }
+      }, this.flushInterval);
+    }
+  }
+  flush() {
+    if (this.logs.length > 0) {
+      if (this.timer) {
+        clearTimeout(this.timer);
+        this.timer = null;
+      }
+      const logsToFlush = this.logs;
+      this.logs = [];
+      try {
+        const callbackResult = this.flushCallback(logsToFlush);
+        if (callbackResult instanceof Promise) {
+          return callbackResult.catch((error) => {
+            this.logs = logsToFlush.concat(this.logs);
+            throw error;
+          });
+        }
+      } catch (error) {
+        this.logs = logsToFlush.concat(this.logs);
+        throw error;
+      }
+    }
+  }
+  //Stop aggregator and cancel any pending timer without flushing
+  stop() {
+    if (this.timer) {
+      clearTimeout(this.timer);
+      this.timer = null;
+    }
+  }
+};
+var CompositeAggregator = class {
+  constructor(aggregators) {
+    this.aggregators = aggregators;
+  }
+  aggregate(logData, formatter) {
+    for (const aggregator of this.aggregators) {
+      aggregator.aggregate(logData, formatter);
+    }
+  }
+  flush() {
+    const results = [];
+    for (const aggregator of this.aggregators) {
+      const result = aggregator.flush();
+      if (result) {
+        results.push(result);
+      }
+    }
+    if (results.some((r) => r instanceof Promise)) {
+      const promiseResults = results.filter(
+        (r) => r instanceof Promise
+      );
+      return Promise.all(promiseResults).then(() => {
+      });
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BatchAggregator,
+  CompositeAggregator,
+  TimeBasedAggregator
+});

package/dist/aggregation/LogAggregator.d.cts

@@ -0,0 +1,6 @@
+export { e as BatchAggregator, f as CompositeAggregator, k as LogAggregator, t as TimeBasedAggregator } from '../index-BRrRLU1p.cjs';
+import '../core/LogLevel.cjs';
+import 'events';
+import '../utils/Timer.cjs';
+import '../utils/Redactor.cjs';
+import '../types/OpenTelemetryTypes.cjs';

package/dist/aggregation/LogAggregator.d.ts

@@ -0,0 +1,6 @@
+export { e as BatchAggregator, f as CompositeAggregator, k as LogAggregator, t as TimeBasedAggregator } from '../index-BQ3Wnw2M.js';
+import '../core/LogLevel.js';
+import 'events';
+import '../utils/Timer.js';
+import '../utils/Redactor.js';
+import '../types/OpenTelemetryTypes.js';

package/dist/aggregation/LogAggregator.js

@@ -0,0 +1,134 @@
+// src/aggregation/LogAggregator.ts
+var BatchAggregator = class {
+  constructor(maxSize = 100, flushCallback, maxQueueSize = 1e4) {
+    this.logs = [];
+    this.pendingFlush = null;
+    this.maxSize = maxSize;
+    this.maxQueueSize = maxQueueSize;
+    this.flushCallback = flushCallback;
+  }
+  aggregate(logData, formatter) {
+    if (this.logs.length >= this.maxQueueSize) {
+      this.logs.shift();
+    }
+    this.logs.push({ logData, formatter });
+    if (this.logs.length >= this.maxSize && !this.pendingFlush) {
+      const result = this.flush();
+      if (result instanceof Promise) {
+        this.pendingFlush = result.finally(() => {
+          this.pendingFlush = null;
+        });
+      }
+    }
+  }
+  flush() {
+    if (this.pendingFlush) {
+      return this.pendingFlush;
+    }
+    if (this.logs.length === 0) {
+      return;
+    }
+    const logsToFlush = this.logs;
+    this.logs = [];
+    try {
+      const callbackResult = this.flushCallback(logsToFlush);
+      if (callbackResult instanceof Promise) {
+        return callbackResult.catch((error) => {
+          this.logs = logsToFlush.concat(this.logs);
+          throw error;
+        });
+      }
+    } catch (error) {
+      this.logs = logsToFlush.concat(this.logs);
+      throw error;
+    }
+  }
+};
+var TimeBasedAggregator = class {
+  constructor(flushInterval, flushCallback, maxQueueSize = 1e4) {
+    this.logs = [];
+    this.timer = null;
+    this.flushInterval = flushInterval;
+    this.maxQueueSize = maxQueueSize;
+    this.flushCallback = flushCallback;
+  }
+  aggregate(logData, formatter) {
+    if (this.logs.length >= this.maxQueueSize) {
+      this.logs.shift();
+    }
+    this.logs.push({ logData, formatter });
+    if (!this.timer) {
+      this.timer = setTimeout(() => {
+        const result = this.flush();
+        if (result instanceof Promise) {
+          result.catch((error) => {
+            console.error(
+              "Error in TimeBasedAggregator flush callback:",
+              error
+            );
+          });
+        }
+      }, this.flushInterval);
+    }
+  }
+  flush() {
+    if (this.logs.length > 0) {
+      if (this.timer) {
+        clearTimeout(this.timer);
+        this.timer = null;
+      }
+      const logsToFlush = this.logs;
+      this.logs = [];
+      try {
+        const callbackResult = this.flushCallback(logsToFlush);
+        if (callbackResult instanceof Promise) {
+          return callbackResult.catch((error) => {
+            this.logs = logsToFlush.concat(this.logs);
+            throw error;
+          });
+        }
+      } catch (error) {
+        this.logs = logsToFlush.concat(this.logs);
+        throw error;
+      }
+    }
+  }
+  //Stop aggregator and cancel any pending timer without flushing
+  stop() {
+    if (this.timer) {
+      clearTimeout(this.timer);
+      this.timer = null;
+    }
+  }
+};
+var CompositeAggregator = class {
+  constructor(aggregators) {
+    this.aggregators = aggregators;
+  }
+  aggregate(logData, formatter) {
+    for (const aggregator of this.aggregators) {
+      aggregator.aggregate(logData, formatter);
+    }
+  }
+  flush() {
+    const results = [];
+    for (const aggregator of this.aggregators) {
+      const result = aggregator.flush();
+      if (result) {
+        results.push(result);
+      }
+    }
+    if (results.some((r) => r instanceof Promise)) {
+      const promiseResults = results.filter(
+        (r) => r instanceof Promise
+      );
+      return Promise.all(promiseResults).then(() => {
+      });
+    }
+  }
+};
+export {
+  BatchAggregator,
+  CompositeAggregator,
+  TimeBasedAggregator
+};