voltlog-io 1.0.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,41 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <rohit@rohittiwari.me>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

package/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing to VoltLog
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+>
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Your First Code Contribution](#your-first-code-contribution)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the
+[VoltLog Code of Conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior
+to <rohit@rohittiwari.me>.
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/rohittiwari-dev/voltlog-io).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/rohittiwari-dev/voltlog-io/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/rohittiwari-dev/voltlog-io/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice
+>
+> When contributing to this project, you must agree that you have authored the content, that you have the rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/rohittiwari-dev/voltlog-io). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rohittiwari-dev/voltlog-io/issues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+  - Stack trace (Traceback)
+  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+  - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+  - Possibly your input and the output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <rohit@rohittiwari.me>.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/rohittiwari-dev/voltlog-io/issues/new). (Since we can't be sure the third-party aid isn't calling home or doing something evil check the origin first)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for VoltLog, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://github.com/rohittiwari-dev/voltlog-io) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/rohittiwari-dev/voltlog-io/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/rohittiwari-dev/voltlog-io/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to include **screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
+- **Explain why this enhancement would be useful** to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+### Your First Code Contribution
+
+1. Fork the repo and create your branch from `main`.
+2. Install dependencies: `npm install`.
+3. Make your changes.
+4. Run tests: `npm test`.
+5. Ensure your code lints: `npm run lint`.
+6. Submit a Pull Request!

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rohit Tiwari
+
+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

@@ -0,0 +1,372 @@
+# VoltLog
+
+#### Structured logger for real-time infrastructure
+
+[![npm version](https://img.shields.io/npm/v/voltlog-io?color=blue)](https://www.npmjs.com/package/voltlog-io)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Build & Test](https://github.com/rohittiwari-dev/voltlog-io/actions/workflows/ci.yml/badge.svg)](https://github.com/rohittiwari-dev/voltlog-io/actions)
+
+**VoltLog** is a modern, lightweight, and type-safe structured logger designed specifically for high-throughput, real-time systems like IoT platforms, WebSocket servers (OCPP), and microservices.
+
+It’s built to solve the common pain points of generic loggers in event-driven architectures: context tracking, sensitive data redaction, high-volume sampling, and developer experience.
+
+---
+
+## ✨ Features
+
+- **🚀 Zero-Dependency Core**: Only uses `cuid2` for IDs — no massive dependency tree.
+- **🔒 Secure by Design**: Built-in redaction middleware for passwords, tokens, and headers.
+- **📊 High-Throughput Ready**: Intelligent sampling middleware to log 1% of debug logs while keeping 100% of errors.
+- **⚡ Developer Experience**: Beautiful, icon-rich pretty printing for local development.
+- **🔌 Framework Agnostic**: Works in Node.js, Bun, Deno, and Browsers.
+- **🧩 Pluggable Architecture**: Middleware and Transformers let you build custom pipelines easily.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install voltlog-io
+# or
+bun add voltlog-io
+pnpm add voltlog-io
+yarn add voltlog-io
+```
+
+---
+
+## 🚀 Quick Start
+
+### Basic Usage
+
+```ts
+import { createLogger, consoleTransport } from "voltlog-io";
+
+const logger = createLogger({
+  level: "INFO",
+  transports: [consoleTransport()],
+});
+
+logger.info("Server started", { port: 3000, env: "production" });
+// {"level":30,"message":"Server started","meta":{"port":3000,"env":"production"},"timestamp":1700000000000}
+```
+
+### Local Development (Pretty Print)
+
+Use `prettyTransport` to get readable, colored logs with icons during development.
+
+```ts
+import { createLogger, prettyTransport } from "voltlog-io";
+
+const logger = createLogger({
+  level: "DEBUG",
+  transports: [prettyTransport({ colorize: true })],
+});
+
+logger.info("Server listening", { port: 3000 });
+// ℹ 10:30:00.123  INFO   Server listening  {"port":3000}
+```
+
+---
+
+## 💡 Key Concepts & Use Cases
+
+### 1. Context Binding (Child Loggers)
+
+Perfect for tracking requests, WebSocket connections, or charging sessions. Bind context once, and all subsequent logs inherit it.
+
+```ts
+// Global logger
+const logger = createLogger({
+  level: "INFO",
+  transports: [consoleTransport()],
+});
+
+// Create a child logger for a specific connection
+const connLogger = logger.child({
+  connectionId: "conn-123",
+  ip: "192.168.1.10",
+});
+
+connLogger.info("Connected");
+// Logs: message="Connected" + { connectionId: "...", ip: "..." }
+
+connLogger.warn("High latency");
+// Logs: message="High latency" + { connectionId: "...", ip: "..." }
+```
+
+### 2. Sensitive Data Redaction
+
+Automatically scrub sensitive fields before they hit your logs. Essential for GDPR/security compliance.
+
+```ts
+import { createLogger, consoleTransport, redactionMiddleware } from "voltlog-io";
+
+const logger = createLogger({
+  transports: [consoleTransport()],
+  middleware: [
+    redactionMiddleware({
+      paths: ["password", "token", "headers.authorization", "user.secrets"],
+    }),
+  ],
+});
+
+logger.info("User login", {
+  username: "alice",
+  password: "supersecretpassword",
+});
+// {"message":"User login","meta":{"username":"alice","password":"[REDACTED]"}}
+```
+
+### 3. Sampling (Cost Control)
+
+In high-throughput systems (like OCPP servers handling thousands of chargers), `DEBUG` logs can be overwhelming and expensive to store. Use sampling to log only a fraction of them.
+
+```ts
+import { createLogger, consoleTransport, samplingMiddleware } from "voltlog-io";
+
+const logger = createLogger({
+  level: "DEBUG",
+  transports: [consoleTransport()],
+  middleware: [
+    samplingMiddleware({
+      rate: 0.1, // Keep 10% of logs
+      level: "DEBUG", // Only sample DEBUG logs (keep 100% of INFO/WARN/ERROR)
+    }),
+  ],
+});
+```
+
+### 4. Custom Transports
+
+Send logs to files, databases, or external services like Datadog/CloudWatch.
+
+```ts
+const fileTransport = {
+  name: "file",
+  transform: (entry) => {
+    fs.appendFileSync("app.log", JSON.stringify(entry) + "\n");
+  },
+};
+
+const logger = createLogger({
+  transports: [consoleTransport(), fileTransport],
+});
+```
+
+---
+
+## 🛠️ Transports
+
+Transports determine where your logs go. You can combine multiple transports.
+
+### `consoleTransport`
+
+Writes logs to `stdout` as single-line JSON. Best for production.
+
+```ts
+transports: [consoleTransport({ level: "INFO" })];
+```
+
+### `prettyTransport`
+
+Writes colorful, human-readable logs to `stdout`. Best for local dev.
+
+```ts
+transports: [prettyTransport({ colorize: true, level: "DEBUG" })];
+```
+
+### `batchTransport`
+
+Buffers logs and writes them in chunks. High performance for I/O bound transports.
+
+```ts
+transports: [
+  batchTransport({
+    batchSize: 100,
+    flushIntervalMs: 5000,
+    transport: webhookTransport({ url: "..." }),
+  }),
+];
+```
+
+### `jsonStreamTransport`
+
+Writes logs as newline-delimited JSON (NDJSON) to a writable stream (like a file).
+
+```ts
+import { createWriteStream } from "node:fs";
+const stream = createWriteStream("app.log");
+transports: [jsonStreamTransport({ stream })];
+```
+
+### `webhookTransport`
+
+Sends logs to an external HTTP endpoint (Slack, Discord, Logstash).
+
+```ts
+transports: [
+  webhookTransport({
+    url: "https://hooks.slack.com/services/...",
+    batchSize: 10, // Batches requests automatically
+  }),
+];
+```
+
+### `redisTransport`
+
+Publishes logs to a Redis channel or pushes to a list/stream.
+
+```ts
+import Redis from "ioredis";
+const redis = new Redis();
+transports: [
+  redisTransport({
+    client: redis,
+    channel: "app-logs",
+    mode: "pubsub", // or 'stream' / 'list'
+  }),
+];
+```
+
+---
+
+## 🛡️ Middleware
+
+Middleware transforms, filters, or enriches logs _before_ they reach the transports.
+
+### `redactionMiddleware`
+
+Removes sensitive fields from log objects. Supports dot notation for nested fields.
+
+```ts
+middleware: [
+  redactionMiddleware({
+    paths: ["password", "token", "user.creditCard", "headers.authorization"],
+    censor: "[SECRET]",
+  }),
+];
+```
+
+### `samplingMiddleware`
+
+Reduces log volume by only keeping a percentage of logs. Useful for high-volume debug logs.
+
+```ts
+middleware: [
+  samplingMiddleware({
+    rate: 0.05, // Keep 5%
+    level: "DEBUG", // Apply only to DEBUG level (keep all INFO/ERROR)
+  }),
+];
+```
+
+### `alertMiddleware`
+
+Trigger callbacks when specific conditions are met (e.g. error rate spike).
+
+```ts
+middleware: [
+  alertMiddleware({
+    match: (entry) => entry.level >= 50, // Errors
+    onAlert: (entry) => sendToSlack(entry),
+    throttleMs: 60000, // Only alert once per minute
+  }),
+];
+```
+
+### `ocppMiddleware`
+
+Specialized middleware for OCPP messages. Adds directionality and styling when combined with pretty print.
+
+```ts
+middleware: [
+  ocppMiddleware(), // Adds { direction: 'IN' | 'OUT' } to logs
+];
+```
+
+---
+
+## 🧩 Custom Middleware
+
+You can easily write your own middleware to enrich, filter, or transform logs. Middleware is just a function that takes an `entry` and a `next` callback.
+
+### Example: Enriching Logs with Machine Info
+
+```ts
+import { os } from "node:os";
+import { createLogger, createMiddleware, consoleTransport } from "voltlog-io";
+
+const machineInfoMiddleware = createMiddleware((entry, next) => {
+  // Add hostname to every log
+  entry.meta = {
+    ...entry.meta,
+    hostname: os.hostname(),
+    pid: process.pid,
+  };
+
+  // Continue pipeline
+  next(entry);
+};
+
+// Usage
+const logger = createLogger({
+  middleware: [machineInfoMiddleware],
+  transports: [consoleTransport()],
+});
+```
+
+### Example: Filtering Logs
+
+```ts
+import { createMiddleware } from "voltlog-io";
+
+const filterMiddleware = createMiddleware((entry, next) => {
+  // Drop logs containing specific text
+  if (entry.message.includes("Heartbeat")) {
+    return; // Don't call next(), effectively dropping the log
+  }
+  next(entry);
+};
+```
+
+---
+
+## 📚 API Reference
+
+### `createLogger(config)`
+
+Creates a new logger instance.
+
+| Config Option | Type            | Default  | Description                                                            |
+| ------------- | --------------- | -------- | ---------------------------------------------------------------------- |
+| `level`       | `LogLevelName`  | `"INFO"` | Minimum log level (`TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`) |
+| `transports`  | `Transformer[]` | `[]`     | Array of output transformers (console, pretty, file, etc.)             |
+| `middleware`  | `Middleware[]`  | `[]`     | Array of middleware functions (redaction, sampling, enrichment)        |
+
+### Log Levels
+
+| Level   | Value | Usage                                                             |
+| ------- | ----- | ----------------------------------------------------------------- |
+| `FATAL` | 60    | System is unusable, requires immediate attention.                 |
+| `ERROR` | 50    | Error conditions that affect operation but don't stop the system. |
+| `WARN`  | 40    | Runtime warnings (deprecated APIs, poor performance).             |
+| `INFO`  | 30    | Normal operational messages (startup, shutdown).                  |
+| `DEBUG` | 20    | Detailed info useful for debugging (state changes).               |
+| `TRACE` | 10    | Very detailed tracing (function entry/exit, full payloads).       |
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+[MIT](LICENSE) © [Rohit Tiwari](https://github.com/rohittiwari-dev)