pompelmi 0.32.1 → 0.34.0

package/README.md

@@ -1,104 +1,64 @@
 <div align="center">
 
-<!-- Language Selector -->
-<p>
-  <strong>Read this in other languages:</strong><br/>
-  <a href="docs/i18n/README.it.md">🇮🇹 Italiano</a> •
-  <a href="docs/i18n/README.fr.md">🇫🇷 Français</a> •
-  <a href="docs/i18n/README.es.md">🇪🇸 Español</a> •
-  <a href="docs/i18n/README.de.md">🇩🇪 Deutsch</a> •
-  <a href="docs/i18n/README.ja.md">🇯🇵 日本語</a> •
-  <a href="docs/i18n/README.zh-CN.md">🇨🇳 简体中文</a> •
-  <a href="docs/i18n/README.ko.md">🇰🇷 한국어</a> •
-  <a href="docs/i18n/README.pt-BR.md">🇧🇷 Português</a> •
-  <a href="docs/i18n/README.ru.md">🇷🇺 Русский</a> •
-  <a href="docs/i18n/README.tr.md">🇹🇷 Türkçe</a>
-</p>
-
-> 💡 **Translation Note:** Help improve translations by opening a PR. The English README is the source of truth.
-
-</div>
-
----
-
-<!-- HERO START -->
-
-<p align="center">
-  <br/>
-  <!-- Responsive logo using picture element -->
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/pompelmi/pompelmi/refs/heads/main/assets/logo.svg">
-    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/pompelmi/pompelmi/refs/heads/main/assets/logo.svg">
-    <img src="https://raw.githubusercontent.com/pompelmi/pompelmi/refs/heads/main/assets/logo.svg" alt="pompelmi logo" width="360" />
-  </picture>
-  <br/>
-  <a href="https://www.producthunt.com/products/pompelmi"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1010722&theme=light" alt="pompelmi - Secure File Upload Scanning for Node.js | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
-  <br/>
-  <a href="https://www.helpnetsecurity.com/2026/02/02/pompelmi-open-source-secure-file-upload-scanning-node-js/"><img alt="Featured on HelpNet Security" src="https://img.shields.io/badge/🔒_FEATURED-HelpNet%20Security-FF6B35?style=for-the-badge"></a>
-  <a href="https://snyk.io/test/github/pompelmi/pompelmi"><img alt="Secured by Snyk" src="https://img.shields.io/badge/🛡️_SECURED_BY-Snyk-4C4A73?style=for-the-badge&logo=snyk"></a>
-  <br/>
-  <a href="https://github.com/sorrycc/awesome-javascript"><img alt="Mentioned in Awesome JavaScript" src="https://awesome.re/mentioned-badge.svg"></a>
-  <a href="https://github.com/dzharii/awesome-typescript"><img alt="Mentioned in Awesome TypeScript" src="https://awesome.re/mentioned-badge-flat.svg"></a>
-  <a href="https://github.com/sbilly/awesome-security"><img alt="Mentioned in Awesome Security" src="https://awesome.re/mentioned-badge.svg"></a>
-  <a href="https://github.com/sindresorhus/awesome-nodejs"><img alt="Mentioned in Awesome Node.js" src="https://awesome.re/mentioned-badge-flat.svg"></a>
-  <br/><br/>
-</p>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/pompelmi/pompelmi/refs/heads/main/assets/logo.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/pompelmi/pompelmi/refs/heads/main/assets/logo.svg">
+  <img src="https://raw.githubusercontent.com/pompelmi/pompelmi/refs/heads/main/assets/logo.svg" alt="pompelmi" width="320" />
+</picture>
 
-<h1 align="center">pompelmi</h1>
+<h1>pompelmi</h1>
 
-<p align="center">
-  <strong>Secure File Upload Scanning for Node.js</strong>
-</p>
-
-<p align="center">
-  <em>Privacy-first malware detection with YARA, ZIP bomb protection, and framework adapters</em>
-</p>
+<p><strong>Secure file upload scanning for Node.js — private, in-process, zero cloud dependencies.</strong></p>
 
-<p align="center">
-  Scan files before they hit disk • <strong>Keep user data private</strong> • <strong>Zero cloud dependencies</strong>
+<p>
+  Scan files <em>before</em> they touch disk &nbsp;•&nbsp;
+  No cloud APIs, no daemon &nbsp;•&nbsp;
+  TypeScript-first &nbsp;•&nbsp;
+  Drop-in framework adapters
 </p>
 
----
-
-<!-- Badges Section -->
-<p align="center">
+<p>
   <a href="https://www.npmjs.com/package/pompelmi"><img alt="npm version" src="https://img.shields.io/npm/v/pompelmi?label=version&color=0a7ea4&logo=npm"></a>
   <a href="https://www.npmjs.com/package/pompelmi"><img alt="npm downloads" src="https://img.shields.io/npm/dm/pompelmi?label=downloads&color=6E9F18&logo=npm"></a>
   <a href="https://github.com/pompelmi/pompelmi/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/npm/l/pompelmi?color=blue"></a>
   <img alt="node" src="https://img.shields.io/badge/node-%3E%3D18-339933?logo=node.js&logoColor=white">
-  <a href="https://github.com/pompelmi/pompelmi/actions/workflows/ci.yml"><img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/pompelmi/pompelmi/ci.yml?branch=main&label=CI&logo=github"></a>
-</p>
-
-<p align="center">
+  <a href="https://github.com/pompelmi/pompelmi/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/pompelmi/pompelmi/ci.yml?branch=main&label=CI&logo=github"></a>
   <a href="https://codecov.io/gh/pompelmi/pompelmi"><img alt="codecov" src="https://codecov.io/gh/pompelmi/pompelmi/branch/main/graph/badge.svg?flag=core"/></a>
   <img alt="types" src="https://img.shields.io/badge/types-TypeScript-3178C6?logo=typescript&logoColor=white">
   <img alt="ESM" src="https://img.shields.io/badge/ESM%2FCJS-compatible-yellow">
-  <a href="https://snyk.io/test/github/pompelmi/pompelmi"><img alt="Known Vulnerabilities" src="https://snyk.io/test/github/pompelmi/pompelmi/badge.svg"></a>
+  <a href="https://snyk.io/test/github/pompelmi/pompelmi"><img alt="Snyk" src="https://snyk.io/test/github/pompelmi/pompelmi/badge.svg"></a>
   <a href="https://securityscorecards.dev/viewer/?uri=github.com/pompelmi/pompelmi"><img alt="OpenSSF Scorecard" src="https://api.securityscorecards.dev/projects/github.com/pompelmi/pompelmi/badge"/></a>
 </p>
 
-<p align="center">
-  <a href="https://github.com/pompelmi/pompelmi/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/pompelmi/pompelmi?style=social"></a>
-  <a href="https://github.com/pompelmi/pompelmi/network/members"><img alt="GitHub forks" src="https://img.shields.io/github/forks/pompelmi/pompelmi?style=social"></a>
-  <a href="https://github.com/pompelmi/pompelmi/watchers"><img alt="GitHub watchers" src="https://img.shields.io/github/watchers/pompelmi/pompelmi?style=social"></a>
-  <a href="https://github.com/pompelmi/pompelmi/issues"><img alt="open issues" src="https://img.shields.io/github/issues/pompelmi/pompelmi?color=orange"></a>
-  <a href="https://github.com/sponsors/pompelmi"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/pompelmi?style=social&label=Sponsor"></a>
+<p>
+  <a href="https://pompelmi.github.io/pompelmi/"><strong>📚 Docs</strong></a> &nbsp;•&nbsp;
+  <a href="#-installation"><strong>💾 Install</strong></a> &nbsp;•&nbsp;
+  <a href="#-quickstart"><strong>⚡ Quickstart</strong></a> &nbsp;•&nbsp;
+  <a href="#-framework-adapters"><strong>🧩 Adapters</strong></a> &nbsp;•&nbsp;
+  <a href="#-yara"><strong>🧬 YARA</strong></a> &nbsp;•&nbsp;
+  <a href="#-github-action"><strong>🤖 CI/CD</strong></a> &nbsp;•&nbsp;
+  <a href="./examples/"><strong>💡 Examples</strong></a>
 </p>
 
-<p align="center">
-  <strong>
-    <a href="https://pompelmi.github.io/pompelmi/">📚 Documentation</a> •
-    <a href="#-installation">💾 Install</a> •
-    <a href="#-quickstart">⚡ Quickstart</a> •
-    <a href="#-adapters">🧩 Adapters</a> •
-    <a href="#-yara-getting-started">🧬 YARA</a> •
-    <a href="#-github-action">🤖 CI/CD</a>
-  </strong>
-</p>
+</div>
+
+---
+
+## Why pompelmi?
 
-<p align="center"><em>Coverage badge reflects core library (<code>src/**</code>); adapters are measured separately.</em></p>
+Most upload handlers check the file extension and content-type header — and stop there. Real threats arrive as ZIP bombs, polyglot files, macro-embedded documents, and files with spoofed MIME types.
 
-<!-- HERO END -->
+**pompelmi scans file bytes in-process, before anything is written to disk or stored**, blocking threats at the earliest possible point — with no cloud API and no daemon.
+
+|  | pompelmi | ClamAV | Cloud AV APIs |
+|---|---|---|---|
+| **Setup** | `npm install` | Daemon + config | API keys + integration |
+| **Privacy** | ✅ In-process — data stays local | ✅ Local (separate daemon) | ❌ Files sent externally |
+| **Latency** | ✅ Zero (no IPC, no network) | IPC overhead | Network round-trip |
+| **Cost** | Free (MIT) | Free (GPL) | Per-scan billing |
+| **Framework adapters** | ✅ Express, Koa, Next.js, NestJS, Fastify | ❌ | ❌ |
+| **TypeScript** | ✅ First-class | community types | varies |
+| **YARA** | ✅ Built-in | manual setup | limited |
 
 ---
 
@@ -108,13 +68,13 @@
 npm install pompelmi
 ```
 
-> Node.js 18+ required. No daemon, no cloud API keys, no configuration files needed to get started.
+> Node.js 18+. No daemon, no config files, no API keys required.
 
 ---
 
 ## ⚡ Quickstart
 
-Scan a file and act on the result in three lines:
+Scan a file and get a verdict in three lines:
 
 ```ts
 import { scanFile } from 'pompelmi';
@@ -123,13 +83,11 @@ const result = await scanFile('path/to/upload.pdf');
 // result.verdict → "clean" | "suspicious" | "malicious"
 
 if (result.verdict !== 'clean') {
-  console.error('Blocked:', result.verdict, result.reasons);
-} else {
-  console.log('Safe to process.');
+  throw new Error(`Blocked: ${result.verdict} — ${result.reasons}`);
 }
 ```
 
-That's it. No server required, no framework dependency — works standalone in any Node.js script or service.
+Works standalone in any Node.js context — no framework required.
 
 ---
 
@@ -137,373 +95,82 @@ That's it. No server required, no framework dependency — works standalone in a
 
 ![Pompelmi Demo](./assets/malware-detection-node-demo.gif)
 
-**Want to try it now?** Check out our [live examples](./examples/) or install and run locally:
+**Try it now:** browse the [examples/](./examples/) directory or run a sample locally:
 
 ```bash
-npm i pompelmi @pompelmi/express-middleware
+npx tsx examples/scan-one-file.ts
 ```
 
 ---
 
-## ✨ Features
-
-**pompelmi** provides enterprise-grade file scanning for Node.js applications:
-
-- **🔒 Privacy-First Architecture** — All scanning happens in-process. **No cloud calls, no data leaks.** Your files never leave your infrastructure.
-- **⚡ Lightning Fast** — In-process scanning with **zero network latency**. Configurable concurrency for high-throughput scenarios.
-- **🧩 Composable Scanners** — Mix heuristics + signatures; set `stopOn` and timeouts. Bring your own YARA rules.
-- **📦 Deep ZIP Inspection** — Traversal/bomb guards, polyglot & macro hints, nested archive scanning with configurable depth limits.
-- **🔌 Framework Adapters** — Drop-in middleware for Express, Koa, Fastify, Next.js, Nuxt/Nitro, and **NestJS** with first-class TypeScript support.
-- **🌊 Stream-Based Processing** — Memory-efficient scanning with configurable buffer limits. Scan large files without loading them entirely into memory.
-- **🔍 Polyglot Detection** — Advanced magic bytes analysis detects mixed-format files and embedded scripts with **30+ file signatures**.
-- **⚙️ CLI for CI/CD** — Standalone command-line tool for scanning files and directories with watch mode and multiple output formats.
-- **📘 TypeScript-First** — Complete type definitions, modern ESM/CJS builds, minimal surface, tree-shakeable.
-- **⚡ Zero Core Dependencies** — Core library has minimal deps for fast installation and reduced supply chain risk.
-
----
+## Why developers choose pompelmi
 
-## Table of Contents
-
-- [Installation](#-installation)
-- [Quickstart](#-quickstart)
-- [Demo](#-demo)
-- [Features](#-features)
-- [Why pompelmi?](#-why-pompelmi)
-- [Use Cases](#-use-cases)
-- [Getting Started](#-getting-started)
-- [Code Examples](#-code-examples)
-- [Adapters](#-adapters)
-- [GitHub Action](#-github-action)
-- [Diagrams](#️-diagrams)
-- [Configuration](#️-configuration)
-- [Production Checklist](#-production-checklist)
-- [YARA Getting Started](#-yara-getting-started)
-- [Security Notes](#-security-notes)
-- [Releases & Security](#-releases--security)
-- [Community & Recognition](#-community--recognition)
-- [FAQ](#-faq)
-- [Tests & Coverage](#-tests--coverage)
-- [Contributing](#-contributing)
-- [License](#-license)
+- **Privacy-first** — all scanning is in-process; no bytes leave your infrastructure, ever.
+- **No daemon, no sidecar** — install like any npm package and start scanning immediately.
+- **Blocks early** — runs before you write to disk, persist to storage, or pass files to other services.
+- **Defense-in-depth** — magic-byte MIME sniffing, extension allow-lists, size caps, ZIP bomb guards, polyglot detection.
+- **Composable** — chain heuristics, YARA rules, and custom scanners with `composeScanners`. Set `stopOn` and per-scanner timeouts.
+- **Framework-friendly** — drop-in middleware for Express, Koa, Next.js, NestJS, Nuxt/Nitro, and Fastify.
+- **TypeScript-first** — complete types, modern ESM/CJS builds, tree-shakeable, minimal core dependencies.
+- **CI/CD ready** — GitHub Action to scan files and artifacts in pipelines.
 
 ---
 
-## 🌍 Translations
-
-pompelmi documentation is available in multiple languages to help developers worldwide:
-
-- 🇮🇹 **[Italiano (Italian)](docs/i18n/README.it.md)** — Documentazione completa in italiano
-- 🇫🇷 **[Français (French)](docs/i18n/README.fr.md)** — Documentation complète en français
-- 🇪🇸 **[Español (Spanish)](docs/i18n/README.es.md)** — Documentación completa en español
-- 🇩🇪 **[Deutsch (German)](docs/i18n/README.de.md)** — Vollständige Dokumentation auf Deutsch
-- 🇯🇵 **[日本語 (Japanese)](docs/i18n/README.ja.md)** — 日本語による完全なドキュメント
-- 🇨🇳 **[简体中文 (Simplified Chinese)](docs/i18n/README.zh-CN.md)** — 完整的简体中文文档
-- 🇰🇷 **[한국어 (Korean)](docs/i18n/README.ko.md)** — 완전한 한국어 문서
-- 🇧🇷 **[Português (Brasil)](docs/i18n/README.pt-BR.md)** — Documentação completa em português
-- 🇷🇺 **[Русский (Russian)](docs/i18n/README.ru.md)** — Полная документация на русском
-- 🇹🇷 **[Türkçe (Turkish)](docs/i18n/README.tr.md)** — Türkçe tam dokümantasyon
+## 🧩 Framework adapters
 
-**Help improve translations:** We welcome contributions to improve and maintain translations. The English README is the authoritative source. To contribute, please open a Pull Request with your improvements.
-
----
+All adapters share the same policy options and scanning contract. Install only what you need.
 
-## 🧠 Why pompelmi?
+| Framework | Package | Status |
+|---|---|---|
+| **Express** | `@pompelmi/express-middleware` | ✅ Stable |
+| **Next.js** | `@pompelmi/next-upload` | ✅ Stable |
+| **Koa** | `@pompelmi/koa-middleware` | ✅ Stable |
+| **NestJS** | `@pompelmi/nestjs-integration` | ✅ Stable |
+| **Nuxt / Nitro** | built-in `pompelmi` | ✅ [Guide](https://pompelmi.github.io/pompelmi/how-to/nuxt-nitro/) |
+| **Fastify** | `@pompelmi/fastify-plugin` | 🔶 Alpha |
+| **Remix / SvelteKit / hapi** | — | 🔜 Planned |
 
-pompelmi delivers **Privacy-First** malware detection with **Zero Cloud Dependencies** — keeping your data secure and your latency zero.
-
-### Why Choose Pompelmi?
-
-- **On‑device, private scanning** – no outbound calls, no data sharing.
-- **Blocks early** – runs _before_ you write to disk or persist anything.
-- **Fits your stack** – drop‑in adapters for Express, Koa, Next.js, Nuxt/Nitro (Fastify plugin in alpha).
-- **Defense‑in‑depth** – ZIP traversal limits, ratio caps, server‑side MIME sniffing, size caps.
-- **Pluggable detection** – bring your own engine (e.g., YARA) via a tiny `{ scan(bytes) }` contract.
-
-### Who is it for?
-
-- Teams who can’t send uploads to third‑party AV APIs.
-- Apps that need predictable, low‑latency decisions inline.
-- Developers who want simple, typed building blocks instead of a daemon.
-
-### Comparison Table
-
-| Feature | **Pompelmi** | ClamAV | Cloud APIs (VirusTotal, etc.) |
-|---------|-------------|---------|-------------------------------|
-| **Setup Time** | ⚡ Seconds (`npm install`) | ⏱️ Complex (daemon setup) | ⏱️ API keys + integration |
-| **Privacy** | ✅ **In-process** (data never leaves) | ✅ Local (separate daemon) | ❌ **External** (data sent to cloud) |
-| **Latency** | ⚡ **Zero** (no network calls) | 🔄 IPC overhead | 🌐 **High** (network roundtrip) |
-| **Cost** | 💰 **Free** (MIT license) | 💰 Free (GPL) | 💸 **Pay-per-scan** |
-| **Framework Integration** | ✅ Express, Koa, Next.js, NestJS | ❌ Manual integration | ❌ Manual integration |
-| **TypeScript Support** | ✅ First-class | ❌ Community types | ❓ Varies |
-| **YARA Integration** | ✅ Built-in | ⚙️ Manual setup | ❓ Limited |
-
-### 🎯 Developer Experience
-
-Built with developers in mind from day one. Simple API, comprehensive TypeScript types, and excellent documentation mean you can integrate secure file scanning in minutes, not days.
-
-### 🚀 Performance First
-
-Optimized for high-throughput scenarios with configurable concurrency, streaming support, and minimal memory overhead. Scans run in-process with no IPC overhead.
-
-### 🔐 Security Without Compromise
-
-Multi-layered defense including MIME type verification (magic bytes), extension validation, size limits, ZIP bomb protection, and optional YARA integration. Each layer is configurable to match your threat model.
-
-### 🌍 Privacy Guaranteed
-
-Your data never leaves your infrastructure. No telemetry, no cloud dependencies, no third-party API calls. Perfect for regulated industries (healthcare, finance, government) and privacy-conscious applications.
-
----
-
-## 💡 Use Cases
-
-pompelmi is trusted across diverse industries and use cases:
-
-### 🏥 Healthcare (HIPAA Compliance)
-
-Scan patient document uploads without sending PHI to third-party services. Keep medical records and imaging files secure on your infrastructure.
-
-### 🏦 Financial Services (PCI DSS)
-
-Validate customer document uploads (ID verification, tax forms) without exposing sensitive financial data to external APIs.
-
-### 🎓 Education Platforms
-
-Protect learning management systems from malicious file uploads while maintaining student privacy.
-
-### 🏢 Enterprise Document Management
-
-Scan files at ingestion time for corporate file sharing platforms, wikis, and collaboration tools.
-
-### 🎨 Media & Creative Platforms
-
-Validate user-generated content uploads (images, videos, documents) before processing and storage.
-
----
-
-## 🚀 Getting Started
-
-Get secure file scanning running in under 5 minutes with pompelmi's zero-config defaults.
-
-### Step 1: Create Security Policy
-
-Create a reusable security policy and scanner configuration.
-
-> **`composeScanners` API** — two supported forms:
-> - **Named-scanner array** *(recommended)*: `composeScanners([["name", scanner], ...], opts?)` — supports `parallel`, `stopOn`, `timeoutMsPerScanner`, and `tagSourceName` options.
-> - **Variadic** *(backward-compatible)*: `composeScanners(scannerA, scannerB, ...)` — runs scanners sequentially, no options.
-
-```ts
-// lib/security.ts
-import { CommonHeuristicsScanner, createZipBombGuard, composeScanners } from 'pompelmi';
-// Optional: import types for explicit annotation
-// import type { NamedScanner, ComposeScannerOptions } from 'pompelmi';
-
-export const policy = {
-  includeExtensions: ['zip', 'png', 'jpg', 'jpeg', 'pdf', 'txt'],
-  allowedMimeTypes: ['application/zip', 'image/png', 'image/jpeg', 'application/pdf', 'text/plain'],
-  maxFileSizeBytes: 20 * 1024 * 1024, // 20MB
-  timeoutMs: 5000,
-  concurrency: 4,
-  failClosed: true, // Block uploads on scanner errors
-  onScanEvent: (event: unknown) => console.log('[scan]', event)
-};
-
-export const scanner = composeScanners(
-  [
-    ['zipGuard', createZipBombGuard({ 
-      maxEntries: 512, 
-      maxTotalUncompressedBytes: 100 * 1024 * 1024,
-      maxCompressionRatio: 12 
-    })],
-    ['heuristics', CommonHeuristicsScanner],
-    // Add your own scanners or YARA rules here
-  ],
-  { 
-    parallel: false, 
-    stopOn: 'suspicious', 
-    timeoutMsPerScanner: 1500,
-    tagSourceName: true 
-  }
-);
+```bash
+npm i @pompelmi/express-middleware    # Express
+npm i @pompelmi/next-upload           # Next.js
+npm i @pompelmi/koa-middleware        # Koa
+npm i @pompelmi/nestjs-integration    # NestJS
+npm i @pompelmi/fastify-plugin        # Fastify (alpha)
+npm i -g @pompelmi/cli                # CLI / CI/CD
 ```
 
-### Step 2: Choose Your Integration
-
-Pick the integration that matches your framework:
-
-#### Express
+### Express
 
 ```ts
 import express from 'express';
 import multer from 'multer';
 import { createUploadGuard } from '@pompelmi/express-middleware';
-import { policy, scanner } from './lib/security';
+import { scanner, policy } from './lib/security';
 
 const app = express();
-const upload = multer({ 
-  storage: multer.memoryStorage(),
-  limits: { fileSize: policy.maxFileSizeBytes }
-});
-
-app.post('/upload', 
-  upload.any(), 
-  createUploadGuard({ ...policy, scanner }), 
-  (req, res) => {
-    // File is safe - proceed with your logic
-    res.json({ 
-      success: true, 
-      verdict: (req as any).pompelmi?.verdict || 'clean'
-    });
-  }
+app.post(
+  '/upload',
+  multer({ storage: multer.memoryStorage() }).any(),
+  createUploadGuard({ ...policy, scanner }),
+  (req, res) => res.json({ verdict: (req as any).pompelmi?.verdict })
 );
-
-app.listen(3000, () => console.log('🚀 Server running on http://localhost:3000'));
 ```
 
-#### Next.js App Router
+### Next.js App Router
 
 ```ts
 // app/api/upload/route.ts
 import { createNextUploadHandler } from '@pompelmi/next-upload';
-import { policy, scanner } from '@/lib/security';
+import { scanner, policy } from '@/lib/security';
 
 export const runtime = 'nodejs';
-export const dynamic = 'force-dynamic';
-
 export const POST = createNextUploadHandler({ ...policy, scanner });
 ```
 
-#### Koa
-
-```ts
-import Koa from 'koa';
-import Router from '@koa/router';
-import multer from '@koa/multer';
-import { createKoaUploadGuard } from '@pompelmi/koa-middleware';
-import { policy, scanner } from './lib/security';
-
-const app = new Koa();
-const router = new Router();
-const upload = multer({ 
-  storage: multer.memoryStorage(),
-  limits: { fileSize: policy.maxFileSizeBytes }
-});
-
-router.post('/upload',
-  upload.any(),
-  createKoaUploadGuard({ ...policy, scanner }),
-  (ctx) => {
-    ctx.body = { 
-      success: true, 
-      verdict: (ctx as any).pompelmi?.verdict || 'clean'
-    };
-  }
-);
-
-app.use(router.routes()).use(router.allowedMethods());
-app.listen(3003, () => console.log('🚀 Server running on http://localhost:3003'));
-```
-
-#### Standalone / Programmatic
-
-```ts
-import { scanFile } from 'pompelmi';
-
-const result = await scanFile('path/to/file.zip');
-console.log(result.verdict); // "clean" | "suspicious" | "malicious"
-
-if (result.verdict === 'malicious') {
-  console.error('⚠️ Malicious file detected!');
-  console.error(result.reasons);
-}
-```
-
-### Step 3: Test It
-
-Upload a test file to verify everything works:
-
-```bash
-curl -X POST http://localhost:3000/upload \
-  -F "file=@test.pdf"
-```
-
-✅ **Done!** Your app now has secure file upload scanning.
-
----
-
-## 📘 Code Examples
-
-### Example 1: Express with Custom Error Handling
-
-```ts
-import express from 'express';
-import multer from 'multer';
-import { createUploadGuard } from '@pompelmi/express-middleware';
-import { policy, scanner } from './lib/security';
-
-const app = express();
-const upload = multer({ storage: multer.memoryStorage() });
-
-app.post('/upload',
-  upload.single('file'),
-  createUploadGuard({ ...policy, scanner }),
-  (req, res) => {
-    const scanResult = (req as any).pompelmi;
-    
-    if (scanResult?.verdict === 'malicious') {
-      return res.status(422).json({
-        error: 'Malicious file detected',
-        reasons: scanResult.reasons
-      });
-    }
-    
-    if (scanResult?.verdict === 'suspicious') {
-      // Log for review but allow upload
-      console.warn('Suspicious file uploaded:', req.file?.originalname);
-    }
-    
-    // Process clean file
-    res.json({ success: true, fileName: req.file?.originalname });
-  }
-);
-
-app.listen(3000);
-```
-
-### Example 2: Next.js Route Handler with Custom Response
-
-```ts
-// app/api/scan/route.ts
-import { NextRequest, NextResponse } from 'next/server';
-import { scanBuffer } from 'pompelmi';
-import { scanner } from '@/lib/security';
-
-export async function POST(req: NextRequest) {
-  const formData = await req.formData();
-  const file = formData.get('file') as File;
-  
-  if (!file) {
-    return NextResponse.json({ error: 'No file provided' }, { status: 400 });
-  }
-  
-  const buffer = Buffer.from(await file.arrayBuffer());
-  const result = await scanner.scan(buffer);
-  
-  return NextResponse.json({
-    fileName: file.name,
-    verdict: result.verdict,
-    safe: result.verdict === 'clean',
-    reasons: result.reasons || []
-  });
-}
-```
-
-### Example 3: NestJS Controller
+### NestJS
 
 ```ts
 // app.module.ts
-import { Module } from '@nestjs/common';
 import { PompelmiModule } from '@pompelmi/nestjs-integration';
 import { CommonHeuristicsScanner } from 'pompelmi';
 
@@ -511,544 +178,348 @@ import { CommonHeuristicsScanner } from 'pompelmi';
   imports: [
     PompelmiModule.forRoot({
       includeExtensions: ['pdf', 'zip', 'png', 'jpg'],
-      allowedMimeTypes: ['application/pdf', 'application/zip', 'image/png', 'image/jpeg'],
       maxFileSizeBytes: 10 * 1024 * 1024,
       scanners: [CommonHeuristicsScanner],
     }),
   ],
 })
 export class AppModule {}
-
-// upload.controller.ts
-import { Controller, Post, UploadedFile, UseInterceptors } from '@nestjs/common';
-import { FileInterceptor } from '@nestjs/platform-express';
-import { PompelmiInterceptor, PompelmiResult } from '@pompelmi/nestjs-integration';
-
-@Controller('upload')
-export class UploadController {
-  @Post()
-  @UseInterceptors(FileInterceptor('file'), PompelmiInterceptor)
-  async uploadFile(@UploadedFile() file: Express.Multer.File & { pompelmi?: PompelmiResult }) {
-    if (file.pompelmi?.verdict === 'malicious') {
-      throw new BadRequestException('Malicious file detected');
-    }
-    
-    return { 
-      success: true, 
-      verdict: file.pompelmi?.verdict,
-      fileName: file.originalname
-    };
-  }
-}
 ```
 
-> 📖 **More examples:** Check the [examples/](./examples/) directory for complete working demos including Express, Koa, Next.js, Nuxt/Nitro, and more.
+> 📖 **More examples:** Check the [examples/](./examples/) directory for complete working demos including Koa, Nuxt/Nitro, standalone, and more.
+
+👉 **[View all adapter docs →](https://pompelmi.github.io/pompelmi/)** &nbsp;&nbsp; **[Browse all examples →](./examples/)**
 
 ---
 
-## 🤖 GitHub Action
+## 🧱 Composing scanners
 
-Run **pompelmi** in CI to scan repository files or built artifacts.
+Build a layered scanner with heuristics, ZIP bomb protection, and optional YARA:
 
-**Minimal usage**
-```yaml
-name: Security scan (pompelmi)
-on: [push, pull_request]
-
-jobs:
-  scan:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Scan repository with pompelmi
-        uses: pompelmi/pompelmi/.github/actions/pompelmi-scan@v1
-        with:
-          path: .
-          deep_zip: true
-          fail_on_detect: true
-```
+```ts
+import { CommonHeuristicsScanner, createZipBombGuard, composeScanners } from 'pompelmi';
 
-**Scan a single artifact**
-```yaml
-- uses: pompelmi/pompelmi/.github/actions/pompelmi-scan@v1
-  with:
-    artifact: build.zip
-    deep_zip: true
-    fail_on_detect: true
+export const scanner = composeScanners(
+  [
+    ['zipGuard',   createZipBombGuard({ maxEntries: 512, maxCompressionRatio: 12 })],
+    ['heuristics', CommonHeuristicsScanner],
+    // ['yara',    YourYaraScanner],
+  ],
+  { parallel: false, stopOn: 'suspicious', timeoutMsPerScanner: 1500, tagSourceName: true }
+);
 ```
 
-**Inputs**
-| Input | Default | Description |
-| --- | --- | --- |
-| `path` | `.` | Directory to scan. |
-| `artifact` | `""` | Single file/archive to scan. |
-| `yara_rules` | `""` | Glob path to YARA rules (e.g. `rules/*.yar`). |
-| `deep_zip` | `true` | Enable deep nested-archive inspection. |
-| `max_depth` | `3` | Max nested-archive depth. |
-| `fail_on_detect` | `true` | Fail the job if detections occur. |
+`composeScanners` supports two call forms:
+- **Named array** *(recommended)*: `composeScanners([['name', scanner], ...], opts?)`
+- **Variadic** *(backward-compatible)*: `composeScanners(scannerA, scannerB, ...)`
 
-> The Action lives in this repo at `.github/actions/pompelmi-scan`. When published to the Marketplace, consumers can copy the snippets above as-is.
+### Upload flow
+
+```mermaid
+flowchart TD
+  A["Client uploads file(s)"] --> B["Web App Route"]
+  B --> C{"Pre-filters (ext, size, MIME)"}
+  C -- fail --> X["HTTP 4xx"]
+  C -- pass --> D{"Is ZIP?"}
+  D -- yes --> E["Iterate entries (limits & scan)"]
+  E --> F{"Verdict?"}
+  D -- no --> F{"Scan bytes"}
+  F -- malicious/suspicious --> Y["HTTP 422 blocked"]
+  F -- clean --> Z["HTTP 200 ok + results"]
+```
 
 ---
 
-## 🧩 Adapters
+## ⚙️ Configuration
 
-Use the adapter that matches your web framework. All adapters share the same policy options and scanning contract.
+All adapters accept the same options:
 
-<p align="center">
-  <img src="https://img.shields.io/badge/Express-✓-000000?style=flat-square&logo=express" alt="Express">
-  <img src="https://img.shields.io/badge/Koa-✓-33333D?style=flat-square&logo=koa" alt="Koa">
-  <img src="https://img.shields.io/badge/Next.js-✓-000000?style=flat-square&logo=next.js" alt="Next.js">
-  <img src="https://img.shields.io/badge/Nuxt-✓-00DC82?style=flat-square&logo=nuxt.js" alt="Nuxt">
-  <img src="https://img.shields.io/badge/NestJS-✓-E0234E?style=flat-square&logo=nestjs" alt="NestJS">
-  <img src="https://img.shields.io/badge/Fastify-alpha-000000?style=flat-square&logo=fastify" alt="Fastify">
-  <img src="https://img.shields.io/badge/Remix-planned-000000?style=flat-square&logo=remix" alt="Remix">
-  <img src="https://img.shields.io/badge/hapi-planned-F26D00?style=flat-square" alt="hapi">
-  <img src="https://img.shields.io/badge/SvelteKit-planned-FF3E00?style=flat-square&logo=svelte" alt="SvelteKit">
-</p>
+| Option | Type | Description |
+|---|---|---|
+| `scanner` | `{ scan(bytes: Uint8Array): Promise<Match[]> }` | Your scanning engine. Return `[]` for clean. |
+| `includeExtensions` | `string[]` | Allowed file extensions (case-insensitive). |
+| `allowedMimeTypes` | `string[]` | Allowed MIME types after magic-byte sniffing. |
+| `maxFileSizeBytes` | `number` | Per-file size cap; oversized files are rejected early. |
+| `timeoutMs` | `number` | Per-file scan timeout. |
+| `concurrency` | `number` | Max files scanned in parallel. |
+| `failClosed` | `boolean` | Block uploads on scanner errors or timeouts. |
+| `onScanEvent` | `(event) => void` | Hook for logging and metrics. |
 
-### Available Adapters
+**Example — images only, 5 MB max:**
 
-| Framework | Package | Status | Install |
-|-----------|---------|--------|---------|
-| **Express** | `@pompelmi/express-middleware` | ✅ Stable | `npm i @pompelmi/express-middleware` |
-| **Koa** | `@pompelmi/koa-middleware` | ✅ Stable | `npm i @pompelmi/koa-middleware` |
-| **Next.js** | `@pompelmi/next-upload` | ✅ Stable | `npm i @pompelmi/next-upload` |
-| **Nuxt/Nitro** | `pompelmi` (local) or remote API | ✅ Docs | [See guide](https://pompelmi.github.io/pompelmi/how-to/nuxt-nitro/) |
-| **NestJS** | `@pompelmi/nestjs-integration` | ✅ Stable | `npm i @pompelmi/nestjs-integration` |
-| **Fastify** | `@pompelmi/fastify-plugin` | 🔶 Alpha | `npm i @pompelmi/fastify-plugin` |
-| **Remix** | - | 🔜 Planned | Coming soon |
-| **SvelteKit** | - | 🔜 Planned | Coming soon |
-| **hapi** | - | 🔜 Planned | Coming soon |
+```ts
+{
+  includeExtensions: ['png', 'jpg', 'jpeg', 'webp'],
+  allowedMimeTypes: ['image/png', 'image/jpeg', 'image/webp'],
+  maxFileSizeBytes: 5 * 1024 * 1024,
+  failClosed: true,
+}
+```
 
-```bash
-# Express
-npm i @pompelmi/express-middleware
+---
 
-# Koa
-npm i @pompelmi/koa-middleware
+## 📦 Import entrypoints
 
-# Next.js
-npm i @pompelmi/next-upload
+pompelmi ships multiple named entrypoints so you only bundle what you need:
 
-# NestJS
-npm i @pompelmi/nestjs-integration
+| Entrypoint | Import | Environment | What it includes |
+|---|---|---|---|
+| **Default (Node.js)** | `import ... from 'pompelmi'` | Node.js | Full API — HIPAA, cache, threat-intel, ZIP streaming, YARA |
+| **Browser-safe** | `import ... from 'pompelmi/browser'` | Browser / bundler | Core scan API, scanners, policy — no Node.js built-ins |
+| **React** | `import ... from 'pompelmi/react'` | Browser / React | All browser-safe + `useFileScanner` hook (peer: react ≥18) |
+| **Quarantine** | `import ... from 'pompelmi/quarantine'` | Node.js | Quarantine lifecycle — hold/review/promote/delete |
+| **Hooks** | `import ... from 'pompelmi/hooks'` | Both | `onScanStart`, `onScanComplete`, `onThreatDetected`, `onQuarantine` |
+| **Audit** | `import ... from 'pompelmi/audit'` | Node.js | Structured NDJSON audit trail for compliance/SIEM |
+| **Policy packs** | `import ... from 'pompelmi/policy-packs'` | Both | Named pre-configured policies (`documents-only`, `images-only`, …) |
 
-# Fastify (alpha)
-npm i @pompelmi/fastify-plugin
+---
 
-# Standalone CLI
-npm i -g @pompelmi/cli
-```
+## 🔒 Policy packs
 
-> **Note:** Core library works standalone. Install adapters only if using a specific framework.
+Named, pre-configured policies for common upload scenarios:
 
-See the [📘 Code Examples](#-code-examples) section above for integration examples.
+```ts
+import { POLICY_PACKS, getPolicyPack } from 'pompelmi/policy-packs';
 
-👉 **[View adapter documentation →](https://pompelmi.github.io/pompelmi/)** | **[Browse all examples →](./examples/)**
+// Use a built-in pack:
+const policy = POLICY_PACKS['strict-public-upload'];
 
----
+// Or retrieve by name:
+const policy = getPolicyPack('documents-only');
+```
 
-## 🗺️ Diagrams
+| Pack | Extensions | Max size | Best for |
+|---|---|---|---|
+| `documents-only` | PDF, Word, Excel, PowerPoint, CSV, TXT, MD | 25 MB | Document portals, data import |
+| `images-only` | JPEG, PNG, GIF, WebP, AVIF, TIFF | 10 MB | Avatars, product images (SVG excluded) |
+| `strict-public-upload` | JPEG, PNG, WebP, PDF only | 5 MB | Anonymous/untrusted upload surfaces |
+| `conservative-default` | ZIP, images, PDF, CSV, DOCX, XLSX | 10 MB | General hardened default |
+| `archives` | ZIP, tar, gz, 7z, rar | 100 MB | Archive endpoints (pair with `createZipBombGuard`) |
 
-### Upload scanning flow
-```mermaid
-flowchart TD
-  A["Client uploads file(s)"] --> B["Web App Route"]
-  B --> C{"Pre-filters<br/>(ext, size, MIME)"}
-  C -- fail --> X["HTTP 4xx"]
-  C -- pass --> D{"Is ZIP?"}
-  D -- yes --> E["Iterate entries<br/>(limits & scan)"]
-  E --> F{"Verdict?"}
-  D -- no --> F{"Scan bytes"}
-  F -- malicious/suspicious --> Y["HTTP 422 blocked"]
-  F -- clean --> Z["HTTP 200 ok + results"]
-```
-<details>
-<summary>Mermaid source</summary>
+All packs are built on `definePolicy` and are fully overridable.
 
-```mermaid
-flowchart TD
-  A["Client uploads file(s)"] --> B["Web App Route"]
-  B --> C{"Pre-filters<br/>(ext, size, MIME)"}
-  C -- fail --> X["HTTP 4xx"]
-  C -- pass --> D{"Is ZIP?"}
-  D -- yes --> E["Iterate entries<br/>(limits & scan)"]
-  E --> F{"Verdict?"}
-  D -- no --> F{"Scan bytes"}
-  F -- malicious/suspicious --> Y["HTTP 422 blocked"]
-  F -- clean --> Z["HTTP 200 ok + results"]
-```
-</details>
+---
 
-### Sequence (App ↔ pompelmi ↔ YARA)
-```mermaid
-sequenceDiagram
-  participant U as User
-  participant A as App Route (/upload)
-  participant P as pompelmi (adapter)
-  participant Y as YARA engine
-
-  U->>A: POST multipart/form-data
-  A->>P: guard(files, policies)
-  P->>P: MIME sniff + size + ext checks
-  alt ZIP archive
-    P->>P: unpack entries with limits
-  end
-  P->>Y: scan(bytes)
-  Y-->>P: matches[]
-  P-->>A: verdict (clean/suspicious/malicious)
-  A-->>U: 200 or 4xx/422 with reason
-```
-<details>
-<summary>Mermaid source</summary>
+## 🗄️ Quarantine workflow
 
-```mermaid
-sequenceDiagram
-  participant U as User
-  participant A as App Route (/upload)
-  participant P as pompelmi (adapter)
-  participant Y as YARA engine
-
-  U->>A: POST multipart/form-data
-  A->>P: guard(files, policies)
-  P->>P: MIME sniff + size + ext checks
-  alt ZIP archive
-    P->>P: unpack entries with limits
-  end
-  P->>Y: scan(bytes)
-  Y-->>P: matches[]
-  P-->>A: verdict (clean/suspicious/malicious)
-  A-->>U: 200 or 4xx/422 with reason
-```
-</details>
+Hold suspicious files for manual review before accepting or permanently deleting them.
 
-### Components (monorepo)
-```mermaid
-flowchart LR
-  subgraph Repo
-    core["pompelmi (core)"]
-    express["@pompelmi/express-middleware"]
-    koa["@pompelmi/koa-middleware"]
-    next["@pompelmi/next-upload"]
-    fastify(("fastify-plugin · planned"))
-    nest(("nestjs · planned"))
-    remix(("remix · planned"))
-    hapi(("hapi-plugin · planned"))
-    svelte(("sveltekit · planned"))
-  end
-  core --> express
-  core --> koa
-  core --> next
-  core -.-> fastify
-  core -.-> nest
-  core -.-> remix
-  core -.-> hapi
-  core -.-> svelte
-```
-<details>
-<summary>Mermaid source</summary>
+```ts
+import { scanBytes } from 'pompelmi';
+import { QuarantineManager, FilesystemQuarantineStorage } from 'pompelmi/quarantine';
 
-```mermaid
-flowchart LR
-  subgraph Repo
-    core["pompelmi (core)"]
-    express["@pompelmi/express-middleware"]
-    koa["@pompelmi/koa-middleware"]
-    next["@pompelmi/next-upload"]
-    fastify(("fastify-plugin · planned"))
-    nest(("nestjs · planned"))
-    remix(("remix · planned"))
-    hapi(("hapi-plugin · planned"))
-    svelte(("sveltekit · planned"))
-  end
-  core --> express
-  core --> koa
-  core --> next
-  core -.-> fastify
-  core -.-> nest
-  core -.-> remix
-  core -.-> hapi
-  core -.-> svelte
-```
-</details>
+// One-time setup — store quarantined files locally.
+const quarantine = new QuarantineManager({
+  storage: new FilesystemQuarantineStorage({ dir: './quarantine' }),
+});
 
----
+// In your upload handler:
+const report = await scanBytes(fileBytes, { ctx: { filename: 'upload.pdf' } });
 
-## ⚙️ Configuration
+if (report.verdict !== 'clean') {
+  const entry = await quarantine.quarantine(fileBytes, report, {
+    originalName: 'upload.pdf',
+    sizeBytes: fileBytes.length,
+    uploadedBy: req.user?.id,
+  });
+  return res.status(202).json({ quarantineId: entry.id });
+}
+```
 
-All adapters accept a common set of options:
+**Review API:**
 
-| Option | Type (TS) | Purpose |
-| --- | --- | --- |
-| `scanner` | `{ scan(bytes: Uint8Array): Promise<Match[]> }` | Your scanning engine. Return `[]` when clean; non‑empty to flag. |
-| `includeExtensions` | `string[]` | Allow‑list of file extensions. Evaluated case‑insensitively. |
-| `allowedMimeTypes` | `string[]` | Allow‑list of MIME types after magic‑byte sniffing. |
-| `maxFileSizeBytes` | `number` | Per‑file size cap. Oversize files are rejected early. |
-| `timeoutMs` | `number` | Per‑file scan timeout; guards against stuck scanners. |
-| `concurrency` | `number` | How many files to scan in parallel. |
-| `failClosed` | `boolean` | If `true`, errors/timeouts block the upload. |
-| `onScanEvent` | `(event: unknown) => void` | Optional telemetry hook for logging/metrics. |
+```ts
+// List pending entries:
+const pending = await quarantine.listPending();
 
-**Common recipes**
+// Approve (promote to storage):
+await quarantine.resolve(entryId, { decision: 'promote', reviewedBy: 'ops-team' });
 
-Allow only images up to 5 MB:
+// Delete permanently:
+await quarantine.resolve(entryId, { decision: 'delete', reviewedBy: 'ops-team', reviewNote: 'Confirmed malware' });
 
-```ts
-includeExtensions: ['png','jpg','jpeg','webp'],
-allowedMimeTypes: ['image/png','image/jpeg','image/webp'],
-maxFileSizeBytes: 5 * 1024 * 1024,
-failClosed: true,
+// Generate an audit report:
+const report = await quarantine.report({ status: 'pending' });
 ```
 
+The `QuarantineStorage` interface is pluggable — implement it for S3, GCS, a database, or any other backend.  `FilesystemQuarantineStorage` is the local reference implementation.
+
 ---
 
-## ✅ Production checklist
+## 🪝 Scan hooks
 
-- [ ] **Limit file size** aggressively (`maxFileSizeBytes`).
-- [ ] **Restrict extensions & MIME** to what your app truly needs.
-- [ ] **Set `failClosed: true` in production** to block on timeouts/errors.
-- [ ] **Handle ZIPs carefully** (enable deep ZIP, keep nesting low, cap entry sizes).
-- [ ] **Compose scanners** with `composeScanners()` and enable `stopOn` to fail fast on early detections.
-- [ ] **Log scan events** (`onScanEvent`) and monitor for spikes.
-- [ ] **Run scans in a separate process/container** for defense‑in‑depth when possible.
-- [ ] **Sanitize file names and paths** if you persist uploads.
-- [ ] **Prefer memory storage + post‑processing**; avoid writing untrusted bytes before policy passes.
-- [ ] **Add CI scanning** with the GitHub Action to catch bad files in repos/artifacts.
+Observe the scan lifecycle without modifying the pipeline:
+
+```ts
+import { scanBytes } from 'pompelmi';
+import { createScanHooks, withHooks } from 'pompelmi/hooks';
+
+const hooks = createScanHooks({
+  onScanComplete(ctx, report) {
+    metrics.increment('scans.total');
+    metrics.histogram('scan.duration_ms', report.durationMs ?? 0);
+  },
+  onThreatDetected(ctx, report) {
+    alerting.notify({ file: ctx.filename, verdict: report.verdict });
+  },
+  onScanError(ctx, error) {
+    logger.error({ file: ctx.filename, error });
+  },
+});
+
+// Wrap your scan function once, then use it everywhere:
+const scan = withHooks(scanBytes, hooks);
+const report = await scan(fileBytes, { ctx: { filename: 'upload.zip' } });
+```
 
 ---
 
-## 🧬 YARA Getting Started
+## 🔍 Audit trail
 
-YARA lets you detect suspicious or malicious content using pattern‑matching rules.  
-**pompelmi** treats YARA matches as signals that you can map to your own verdicts  
-(e.g., mark high‑confidence rules as `malicious`, heuristics as `suspicious`).
+Write a structured NDJSON audit record for every scan and quarantine event:
 
-> **Status:** Optional. You can run without YARA. If you adopt it, keep your rules small, time‑bound, and tuned to your threat model.
+```ts
+import { AuditTrail } from 'pompelmi/audit';
 
-### Starter rules
+const audit = new AuditTrail({
+  output: { dest: 'file', path: './audit.jsonl' },
+});
 
-Below are three example rules you can adapt:
+// After each scan:
+audit.logScanComplete(report, { filename: 'upload.pdf', uploadedBy: req.user?.id });
 
-`rules/starter/eicar.yar`
-```yar
-rule EICAR_Test_File
-{
-    meta:
-        description = "EICAR antivirus test string (safe)"
-        reference   = "https://www.eicar.org"
-        confidence  = "high"
-        verdict     = "malicious"
-    strings:
-        $eicar = "X5O!P%@AP[4\\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*"
-    condition:
-        $eicar
-}
-```
+// After quarantine:
+audit.logQuarantine(entry);
 
-`rules/starter/pdf_js.yar`
-```yar
-rule PDF_JavaScript_Embedded
-{
-    meta:
-        description = "PDF contains embedded JavaScript (heuristic)"
-        confidence  = "medium"
-        verdict     = "suspicious"
-    strings:
-        $magic = { 25 50 44 46 } // "%PDF"
-        $js1 = "/JavaScript" ascii
-        $js2 = "/JS" ascii
-        $open = "/OpenAction" ascii
-        $aa = "/AA" ascii
-    condition:
-        uint32(0) == 0x25504446 and ( $js1 or $js2 ) and ( $open or $aa )
-}
+// After resolution:
+audit.logQuarantineResolved(entry);
 ```
 
-`rules/starter/office_macros.yar`
-```yar
-rule Office_Macro_Suspicious_Words
-{
-    meta:
-        description = "Heuristic: suspicious VBA macro keywords"
-        confidence  = "medium"
-        verdict     = "suspicious"
-    strings:
-        $s1 = /Auto(Open|Close)/ nocase
-        $s2 = "Document_Open" nocase ascii
-        $s3 = "CreateObject(" nocase ascii
-        $s4 = "WScript.Shell" nocase ascii
-        $s5 = "Shell(" nocase ascii
-        $s6 = "Sub Workbook_Open()" nocase ascii
-    condition:
-        2 of ($s*)
-}
-```
+Each record is a single JSON line with `timestamp`, `event`, `verdict`, `matchCount`, `durationMs`, `sha256`, and more — ready for your SIEM or compliance tools.
+
+---
 
-> These are **examples**. Expect some false positives; tune to your app.
+## ✅ Production checklist
+- [ ] Set `maxFileSizeBytes` — reject oversized files before scanning.
+- [ ] Restrict `includeExtensions` and `allowedMimeTypes` to what your app truly needs (or use a [policy pack](#-policy-packs)).
+- [ ] Set `failClosed: true` to block uploads on timeouts or scanner errors.
+- [ ] Enable deep ZIP inspection; keep nesting depth low.
+- [ ] Use `composeScanners` with `stopOn` to fail fast on early detections.
+- [ ] Log scan events with [scan hooks](#-scan-hooks) and monitor for anomaly spikes.
+- [ ] Wire up the [quarantine workflow](#-quarantine-workflow) for suspicious files rather than silently dropping them.
+- [ ] Write an [audit trail](#-audit-trail) for compliance and incident response.
+- [ ] Consider running scans in a separate process or container for defense-in-depth.
+- [ ] Sanitize file names and paths before persisting uploads.
+- [ ] Keep files in memory until policy passes — avoid writing untrusted bytes to disk first.
 
-### Minimal integration (adapter contract)
+---
 
-If you use a YARA binding (e.g., `@automattic/yara`), wrap it behind the `scanner` contract:
+## 🧬 YARA
 
-```ts
-// Example YARA scanner adapter (pseudo‑code)
-import * as Y from '@automattic/yara';
+YARA lets you write custom pattern-matching rules and use them as a scanner engine. pompelmi treats YARA matches as signals you map to verdicts (`suspicious`, `malicious`).
+
+> **Optional.** pompelmi works without YARA. Add it when you need custom detection rules.
 
-// Compile your rules from disk at boot (recommended)
-// const sources = await fs.readFile('rules/starter/*.yar', 'utf8');
-// const compiled = await Y.compile(sources);
+### Minimal adapter
 
-export const YourYaraScanner = {
+```ts
+export const MyYaraScanner = {
   async scan(bytes: Uint8Array) {
-    // const matches = await compiled.scan(bytes, { timeout: 1500 });
-    const matches = []; // plug your engine here
-    // Map to the structure your app expects; return [] when clean.
-    return matches.map((m: any) => ({
-      rule: m.rule,
-      meta: m.meta ?? {},
-      tags: m.tags ?? [],
-    }));
+    const matches = await compiledRules.scan(bytes, { timeout: 1500 });
+    return matches.map(m => ({ rule: m.rule, meta: m.meta ?? {}, tags: m.tags ?? [] }));
   }
 };
 ```
 
-Then include it in your composed scanner:
+Plug it into your composed scanner:
 
 ```ts
 import { composeScanners, CommonHeuristicsScanner } from 'pompelmi';
-// import { YourYaraScanner } from './yara-scanner';
 
 export const scanner = composeScanners(
   [
     ['heuristics', CommonHeuristicsScanner],
-    // ['yara', YourYaraScanner],
+    ['yara',       MyYaraScanner],
   ],
   { parallel: false, stopOn: 'suspicious', timeoutMsPerScanner: 1500, tagSourceName: true }
 );
 ```
 
-### Policy suggestion (mapping matches → verdict)
+Starter rules for common threats (EICAR, PDF-embedded JS, Office macros) are in [`rules/starter/`](./rules/).
 
-- **malicious**: high‑confidence rules (e.g., `EICAR_Test_File`)
-- **suspicious**: heuristic rules (e.g., PDF JavaScript, macro keywords)
-- **clean**: no matches
+**Suggested verdict mapping:**
+- `malicious` — high-confidence rules (e.g., `EICAR_Test_File`)
+- `suspicious` — heuristic rules (e.g., PDF JavaScript, macro keywords)
+- `clean` — no matches
 
-Combine YARA with MIME sniffing, ZIP safety limits, and strict size/time caps.
+### Quick smoke test
 
-## 🧪 Quick test (no EICAR)
+```bash
+# Create a minimal PDF with risky embedded actions
+printf '%%PDF-1.7\n1 0 obj\n<< /OpenAction 1 0 R /AA << /JavaScript (alert(1)) >> >>\nendobj\n%%%%EOF\n' > risky.pdf
 
-Use the examples above, then send a **minimal PDF** that contains risky tokens (this triggers the built‑in heuristics).
+# Send it to your endpoint — expect HTTP 422
+curl -F "file=@risky.pdf;type=application/pdf" http://localhost:3000/upload -i
+```
 
-**1) Create a tiny PDF with risky actions**
+👉 **[Full YARA guide in docs →](https://pompelmi.github.io/pompelmi/)**
 
-Linux:
-```bash
-printf '%%PDF-1.7\n1 0 obj\n<< /OpenAction 1 0 R /AA << /JavaScript (alert(1)) >> >>\nendobj\n%%EOF\n' > risky.pdf
-```
+---
 
-macOS:
-```bash
-printf '%%PDF-1.7\n1 0 obj\n<< /OpenAction 1 0 R /AA << /JavaScript (alert(1)) >> >>\nendobj\n%%EOF\n' > risky.pdf
-```
+## 🤖 GitHub Action
 
-**2) Send it to your endpoint**
+Scan files or build artifacts in CI with a single step:
 
-Express (default from the Quick‑start):
-```bash
-curl -F "file=@risky.pdf;type=application/pdf" http://localhost:3000/upload -i
+```yaml
+- uses: pompelmi/pompelmi/.github/actions/pompelmi-scan@v1
+  with:
+    path: .
+    deep_zip: true
+    fail_on_detect: true
 ```
 
-You should see an HTTP **422 Unprocessable Entity** (blocked by policy). Clean files return **200 OK**. Pre‑filter failures (size/ext/MIME) should return a **4xx**. Adapt these conventions to your app as needed.
+| Input | Default | Description |
+|---|---|---|
+| `path` | `.` | Directory to scan. |
+| `artifact` | `""` | Single file or archive to scan. |
+| `yara_rules` | `""` | Glob path to `.yar` rule files. |
+| `deep_zip` | `true` | Traverse nested archives. |
+| `max_depth` | `3` | Max nesting depth. |
+| `fail_on_detect` | `true` | Fail the job on any detection. |
 
 ---
 
-## 🔒 Security notes
+## 💡 Use cases
 
-- The library **reads** bytes; it never executes files.
-- YARA detections depend on the **rules you provide**; expect some false positives/negatives.
-- ZIP scanning applies limits (entries, per‑entry size, total uncompressed, nesting) to reduce archive‑bomb risk.
-- Prefer running scans in a **dedicated process/container** for defense‑in‑depth.
+- **Document upload portals** — verify PDFs, DOCX files, and archives before storage.
+- **User-generated content platforms** — block malicious images, scripts, or embedded payloads.
+- **Internal tooling and wikis** — protect collaboration tools from lateral-movement attacks.
+- **Privacy-sensitive environments** — healthcare, legal, and finance platforms where files must stay on-prem.
+- **CI/CD pipelines** — catch malicious artifacts before they enter your build or release chain.
 
 ---
 
-##  Releases & Security
+## 🔒 Security
 
-- **Changelog / releases:** see [GitHub Releases](https://github.com/pompelmi/pompelmi/releases).
-- **Security disclosures:** please use [GitHub Security Advisories](https://github.com/pompelmi/pompelmi/security/advisories). We’ll coordinate a fix before public disclosure.
-- **Production users:** open a [Discussion](https://github.com/pompelmi/pompelmi/discussions) to share requirements or request adapters.
+- pompelmi **reads** bytes — it never executes uploaded files.
+- ZIP scanning enforces entry count, per-entry size, total uncompressed size, and nesting depth limits to guard against archive bombs.
+- YARA detection quality depends on the rules you provide; tune them to your threat model.
+- For defense-in-depth, consider running scans in a separate process or container.
+- **Changelog / releases:** [GitHub Releases](https://github.com/pompelmi/pompelmi/releases).
+- **Vulnerability disclosure:** [GitHub Security Advisories](https://github.com/pompelmi/pompelmi/security/advisories). We coordinate a fix before public disclosure.
 
 ---
 
-## 🏆 Community & Recognition
-
-pompelmi has been featured in **leading security and developer publications** and is trusted by teams worldwide for secure file upload handling.
-
-### 🌟 Featured In High-Authority Publications
+## 🏆 Recognition
 
-<table>
-<tr>
-<td align="center" width="200">
-  <a href="https://www.helpnetsecurity.com/2026/02/02/pompelmi-open-source-secure-file-upload-scanning-node-js/">
-    <img src="https://img.shields.io/badge/🔒-HelpNet%20Security-FF6B35?style=for-the-badge" alt="HelpNet Security"/>
-  </a>
-  <br/>
-  <strong>HelpNet Security</strong>
-  <br/>
-  <em>Leading Cybersecurity News</em>
-</td>
-<td align="center" width="200">
-  <a href="https://snyk.io/test/github/pompelmi/pompelmi">
-    <img src="https://img.shields.io/badge/🛡️-Snyk-4C4A73?style=for-the-badge&logo=snyk" alt="Snyk"/>
-  </a>
-  <br/>
-  <strong>Snyk</strong>
-  <br/>
-  <em>Security Verified</em>
-</td>
-<td align="center" width="200">
-  <a href="https://www.detectionengineering.net/p/det-eng-weekly-issue-124-the-defcon">
-    <img src="https://img.shields.io/badge/📡-Detection%20Engineering-0A84FF?style=for-the-badge&logo=substack" alt="Detection Engineering"/>
-  </a>
-  <br/>
-  <strong>Detection Engineering Weekly</strong>
-  <br/>
-  <em>Issue #124</em>
-</td>
-</tr>
-<tr>
-<td align="center" width="200">
-  <a href="https://nodeweekly.com/issues/594">
-    <img src="https://img.shields.io/badge/⚡-Node%20Weekly-FF6600?style=for-the-badge&logo=node.js" alt="Node Weekly"/>
-  </a>
-  <br/>
-  <strong>Node Weekly</strong>
-  <br/>
-  <em>Issue #594</em>
-</td>
-<td align="center" width="200">
-  <a href="https://bytes.dev/archives/429">
-    <img src="https://img.shields.io/badge/📬-Bytes-111111?style=for-the-badge" alt="Bytes"/>
-  </a>
-  <br/>
-  <strong>Bytes Newsletter</strong>
-  <br/>
-  <em>Issue #429</em>
-</td>
-<td align="center" width="200">
-  <a href="https://app.daily.dev/posts/pompelmi">
-    <img src="https://img.shields.io/badge/📰-daily.dev-CE3DF3?style=for-the-badge&logo=dailydotdev" alt="daily.dev"/>
-  </a>
-  <br/>
-  <strong>daily.dev</strong>
-  <br/>
-  <em>Featured Article</em>
-</td>
-</tr>
-</table>
+Featured in:
 
-### 🎖️ Mentioned In Awesome Lists
+- [HelpNet Security](https://www.helpnetsecurity.com/2026/02/02/pompelmi-open-source-secure-file-upload-scanning-node-js/)
+- [Stack Overflow Blog](https://stackoverflow.blog/2026/02/23/defense-against-uploads-oss-file-scanner-pompelmi/)
+- [Node Weekly #594](https://nodeweekly.com/issues/594)
+- [Bytes Newsletter #429](https://bytes.dev/archives/429)
+- [Detection Engineering Weekly #124](https://www.detectionengineering.net/p/det-eng-weekly-issue-124-the-defcon)
+- [daily.dev](https://app.daily.dev/posts/pompelmi)
 
 <p align="center">
   <a href="https://github.com/sorrycc/awesome-javascript"><img src="https://awesome.re/mentioned-badge.svg" alt="Awesome JavaScript"/></a>
@@ -1060,154 +531,81 @@ pompelmi has been featured in **leading security and developer publications** an
 <!-- MENTIONS:START -->
 <!-- MENTIONS:END -->
 
-### 💬 What Developers Say
-
-> "pompelmi made it incredibly easy to add malware scanning to our Express API. The TypeScript support is fantastic!"
-> — Developer using pompelmi in production
-
-> "Finally, a file scanning solution that doesn't require sending our users' data to third parties. Perfect for GDPR compliance."
-> — Security Engineer at a healthcare startup
-
-> "The YARA integration is seamless. We went from prototype to production in less than a week."
-> — DevSecOps Engineer
-
-_Want to share your experience? [Open a discussion](https://github.com/pompelmi/pompelmi/discussions)!_
-
-### 🤝 Community & Support
-
-**Need help? We're here for you!**
-
-- 📖 **[Documentation](https://pompelmi.github.io/pompelmi/)** — Complete API reference, guides, and tutorials
-- 💬 **[GitHub Discussions](https://github.com/pompelmi/pompelmi/discussions)** — Ask questions, share ideas, get community support
-- 🐛 **[Issue Tracker](https://github.com/pompelmi/pompelmi/issues)** — Report bugs, request features
-- 🔒 **[Security Policy](https://github.com/pompelmi/pompelmi/security)** — Report security vulnerabilities privately
-- 💼 **Commercial Support** — For enterprise support and consulting, contact the maintainers
-- 💖 **[Sponsor pompelmi](https://github.com/sponsors/pompelmi)** — Support ongoing development via GitHub Sponsors
-
-**Supported Frameworks:**
-- ✅ Express
-- ✅ Koa  
-- ✅ Next.js (App & Pages Router)
-- ✅ NestJS
-- ✅ Fastify (alpha)
-- 🔜 Remix (planned)
-- 🔜 SvelteKit (planned)
-- 🔜 hapi (planned)
-
 ---
 
-## 🎖️ Contributors
-
-Thanks to all the amazing contributors who have helped make pompelmi better!
-
-<p align="center">
-  <a href="https://github.com/pompelmi/pompelmi/graphs/contributors">
-    <img src="https://contrib.rocks/image?repo=pompelmi/pompelmi" alt="Contributors" />
-  </a>
-</p>
+## 💬 FAQ
 
-<p align="center">
-  <em>Want to contribute? Check out our <a href="./CONTRIBUTING.md">Contributing Guide</a>!</em>
-</p>
+**Does pompelmi send files to third parties?**
+No. All scanning runs in-process inside your Node.js application. No bytes leave your infrastructure.
 
----
+**Does it require a daemon or external service?**
+No. Install it like any npm package — no daemon, no sidecar, no config files to write.
 
-## 💖 Sponsors
+**Can I use YARA rules?**
+Yes. Wrap your YARA engine behind the `{ scan(bytes) }` interface and pass it to `composeScanners`. Starter rules are in [`rules/starter/`](./rules/).
 
-Pompelmi is free and open-source. If it saves you time or helps protect your users, consider supporting its development!
+**Does it work with my framework?**
+Stable adapters exist for Express, Koa, Next.js, and NestJS. A Fastify plugin is in alpha. The core library works standalone with any Node.js server.
 
-<p align="center">
-  <a href="https://github.com/sponsors/pompelmi">
-    <img src="https://img.shields.io/badge/Sponsor-pompelmi-EA4AAA?style=for-the-badge&logo=githubsponsors&logoColor=white" alt="Sponsor pompelmi on GitHub" />
-  </a>
-</p>
+**Why 422 for blocked files?**
+It's a common convention that keeps policy violations distinct from transport errors. Use whatever HTTP status code fits your API contract.
 
-Your sponsorship helps fund:
-- 🧬 New detection engine integrations
-- 🧪 Expanded test coverage and CI infrastructure
-- 📚 Documentation and examples
-- 🔒 Security audits and CVE response
+**Are ZIP bombs handled?**
+Yes. Archive scanning enforces limits on entry count, per-entry size, total uncompressed size, and nesting depth. Use `failClosed: true` in production.
 
-Thank you to all current and future sponsors for keeping this project alive!
+**Is commercial support available?**
+Yes. Limited async support for integration help, configuration review, and troubleshooting is available from the maintainer. Email [pompelmideveloper@yahoo.com](mailto:pompelmideveloper@yahoo.com).
 
 ---
 
-## ⭐ Star History
+## 💼 Commercial support
 
-<p align="center">
-  <a href="https://star-history.com/#pompelmi/pompelmi&Date">
-    <img src="https://api.star-history.com/svg?repos=pompelmi/pompelmi&type=Date" alt="Star History Chart" width="600" />
-  </a>
-</p>
-
----
-
-## 💬 FAQ
+Limited commercial support is available on a **private, asynchronous, best-effort basis** from the maintainer. This may include:
 
-**Do I need YARA?**  
-No. `scanner` is pluggable. The examples use a minimal scanner for clarity; you can call out to a YARA engine or any other detector you prefer.
+- Integration assistance
+- Configuration and policy review
+- Prioritized troubleshooting
+- Upload security guidance
 
-**Where do the results live?**  
-In the examples, the guard attaches scan data to the request context (e.g. `req.pompelmi` in Express, `ctx.pompelmi` in Koa). In Next.js, include the results in your JSON response as you see fit.
+Support is in writing only — no live calls or real-time support.
 
-**Why 422 for blocked files?**  
-Using **422** to signal a policy violation keeps it distinct from transport errors; it’s a common pattern. Use the codes that best match your API guidelines.
+**To inquire**, email [pompelmideveloper@yahoo.com](mailto:pompelmideveloper@yahoo.com) with your framework, Node.js version, pompelmi version, and a short description of your goal or issue.
 
-**Are ZIP bombs handled?**  
-Archives are traversed with limits to reduce archive‑bomb risk. Keep your size limits conservative and prefer `failClosed: true` in production.
+> Community support (GitHub Issues and Discussions) remains free and open. For vulnerability disclosure, see [SECURITY.md](./SECURITY.md).
 
 ---
 
-## 🧪 Tests & Coverage
-
-Run tests locally with coverage:
-
-```bash
-pnpm vitest run --coverage --passWithNoTests
-```
-
-The badge tracks the **core library** (`src/**`). Adapters and engines are reported separately for now and will be folded into global coverage as their suites grow.
-
-If you integrate Codecov in CI, upload `coverage/lcov.info` and you can use this Codecov badge:
-
-```md
-[![codecov](https://codecov.io/gh/pompelmi/pompelmi/branch/main/graph/badge.svg?flag=core)](https://codecov.io/gh/pompelmi/pompelmi)
-```
-
 ## 🤝 Contributing
 
-PRs and issues welcome! Start with:
+PRs and issues are welcome.
 
 ```bash
 pnpm -r build
 pnpm -r lint
+pnpm vitest run --coverage --passWithNoTests
 ```
 
-See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines.
-
----
-
-## 🎓 Learning Resources
-
-### 📚 Documentation
-
-- [Official Docs](https://pompelmi.github.io/pompelmi/) — Complete API reference and guides
-- [Examples](./examples/) — Real-world integration examples
-- [Security Guide](./SECURITY.md) — Security best practices and disclosure policy
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for full guidelines.
 
-### 🛠️ Tools & Integrations
+<p align="center">
+  <a href="https://github.com/pompelmi/pompelmi/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=pompelmi/pompelmi" alt="Contributors" />
+  </a>
+</p>
 
-- [GitHub Action](https://github.com/pompelmi/pompelmi/tree/main/.github/actions/pompelmi-scan) — CI/CD scanning
+<p align="center">
+  <a href="https://github.com/sponsors/pompelmi">
+    <img src="https://img.shields.io/badge/Sponsor-pompelmi-EA4AAA?style=for-the-badge&logo=githubsponsors&logoColor=white" alt="Sponsor pompelmi" />
+  </a>
+</p>
 
 ---
 
-## 🙏 Acknowledgments
+## 🌍 Translations
 
-pompelmi stands on the shoulders of giants. Special thanks to:
+[🇮🇹 Italian](docs/i18n/README.it.md) • [🇫🇷 French](docs/i18n/README.fr.md) • [🇪🇸 Spanish](docs/i18n/README.es.md) • [🇩🇪 German](docs/i18n/README.de.md) • [🇯🇵 Japanese](docs/i18n/README.ja.md) • [🇨🇳 Chinese](docs/i18n/README.zh-CN.md) • [🇰🇷 Korean](docs/i18n/README.ko.md) • [🇧🇷 Portuguese](docs/i18n/README.pt-BR.md) • [🇷🇺 Russian](docs/i18n/README.ru.md) • [🇹🇷 Turkish](docs/i18n/README.tr.md)
 
-- The YARA project for powerful pattern matching
-- The Node.js community for excellent tooling
-- All our contributors and users
+The English README is the authoritative source. Contributions to translations are welcome via PR.
 
 ---
 
@@ -1215,4 +613,4 @@ pompelmi stands on the shoulders of giants. Special thanks to:
 
 ## 📜 License
 
-[MIT](./LICENSE) © 2025‑present pompelmi contributors
+[MIT](./LICENSE) © 2025–present pompelmi contributors