pompelmi 1.14.0 → 1.16.0

package/README.md

@@ -89,11 +89,15 @@ Most integrations require parsing ClamAV's stdout with regex, managing a clamd d
 - Symbol-based verdicts (`Verdict.Clean` / `Verdict.Malicious` / `Verdict.ScanError`) — typo-proof comparisons
 - Full clamd support via the INSTREAM protocol — TCP (`host`/`port`) or UNIX socket (`socket`) with configurable timeout
 - Built-in helpers to install ClamAV and update virus definitions programmatically
-- Works with Express, Fastify, NestJS, and any other Node.js HTTP framework
+- Works with Express, Fastify, NestJS, Hono, Remix, SvelteKit, and any other Node.js HTTP framework
+- Works with Node.js and Bun — uses `Bun.file()` for faster file reading when available
+- Interactive demo at [pompelmi.app/demo](https://pompelmi.app/demo.html) — try before you install
 - Zero runtime dependencies — ships nothing but source code
 - Tested with EICAR standard antivirus test files
 - CommonJS module; TypeScript type declarations available inline
 
+See [how pompelmi compares](./docs/comparison.html) to other Node.js ClamAV integrations.
+
 ---
 
 ## Framework Integrations
@@ -104,6 +108,10 @@ Official integration packages for popular frameworks:
 |---------|-----------|---------|
 | [@pompelmi/nestjs](./packages/nestjs/) | NestJS | `npm i @pompelmi/nestjs` |
 | [@pompelmi/fastify](./packages/fastify/) | Fastify | `npm i @pompelmi/fastify` |
+| [@pompelmi/hono](./packages/hono/) | Hono | `npm i @pompelmi/hono` |
+| [@pompelmi/remix](./packages/remix/) | Remix | `npm i @pompelmi/remix` |
+| [@pompelmi/sveltekit](./packages/sveltekit/) | SvelteKit | `npm i @pompelmi/sveltekit` |
+| [@pompelmi/testing](./packages/testing/) | Jest/Vitest/Node | `npm i -D @pompelmi/testing` |
 
 ### NestJS
 
@@ -132,11 +140,63 @@ const result = await fastify.pompelmi.scanBuffer(buffer);
 fastify.post('/upload', { preHandler: fastify.pompelmi.preHandler({ field: 'file' }) }, handler);
 ```
 
+### Hono (Node.js, Bun, Cloudflare Workers)
+
+```js
+import { Hono } from 'hono'
+import { pompelmiMiddleware } from '@pompelmi/hono'
+
+const app = new Hono()
+
+app.use('/upload/*', pompelmiMiddleware({
+  host: 'localhost',
+  port: 3310,
+  onInfected: (c, filename) => c.json({ error: 'Malware detected' }, 422),
+}))
+
+app.post('/upload', async (c) => c.json({ ok: true }))
+```
+
+### Remix
+
+```ts
+import { unstable_parseMultipartFormData, json } from '@remix-run/node'
+import { pompelmiUploadHandler } from '@pompelmi/remix'
+
+export async function action({ request }) {
+  // Throws HTTP 422 automatically if malware is detected
+  const formData = await unstable_parseMultipartFormData(
+    request,
+    pompelmiUploadHandler({ host: 'localhost', port: 3310 })
+  )
+  const file = formData.get('file')
+  return json({ name: file.name, size: file.size, ok: true })
+}
+```
+
+### SvelteKit
+
+```ts
+// +page.server.ts
+import { scanUpload } from '@pompelmi/sveltekit'
+import type { Actions } from './$types'
+
+export const actions: Actions = {
+  default: async ({ request }) => {
+    const formData = await request.formData()
+    // Throws HTTP 422 automatically if malware is detected
+    await scanUpload(formData.get('file') as File, { host: 'localhost', port: 3310 })
+    return { success: true }
+  }
+}
+```
+
 ---
 
 ## Requirements
 
 - **Node.js** — any LTS release (no native addons, no C++ bindings)
+- **Bun** — fully supported; uses `Bun.file()` for faster file reading
 - **ClamAV** — must be installed on the host or reachable over TCP
 
 pompelmi does not bundle or automatically download ClamAV. Install it once per machine (see [Installing ClamAV](#installing-clamav)).
@@ -156,6 +216,9 @@ yarn add pompelmi
 
 # pnpm
 pnpm add pompelmi
+
+# bun
+bun add pompelmi
 ```
 
 ### Docker

package/llms.txt

@@ -20,6 +20,18 @@ Options: `{ host?: string, port?: number, timeout?: number }`
 - Local mode: spawns `clamscan`, maps exit codes to verdicts
 - TCP mode: streams to clamd via INSTREAM protocol (set `host`)
 
+## Framework integrations
+
+Official packages for popular frameworks:
+
+- `@pompelmi/nestjs` — NestJS module (`PompelmiModule`, `PompelmiService`, `PompelmiInterceptor`)
+- `@pompelmi/fastify` — Fastify plugin (decorates `fastify.pompelmi` with scan/preHandler)
+- `@pompelmi/hono` — Hono middleware (`pompelmiMiddleware`) for Node.js, Bun, Cloudflare Workers
+- `@pompelmi/remix` — Remix upload handler (`pompelmiUploadHandler` for `unstable_parseMultipartFormData`)
+- `@pompelmi/sveltekit` — SvelteKit helper (`scanUpload`, `scanFormData` for +page.server.ts and +server.ts)
+- `@pompelmi/nextjs` — Next.js App Router / Pages Router helpers
+- `@pompelmi/testing` — test utilities (`mockClean`, `mockInfected`, `withMockedPompelmi`)
+
 ## Installation
 
 npm install pompelmi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pompelmi",
-  "version": "1.14.0",
+  "version": "1.16.0",
   "description": "ClamAV for humans — scan any file and get back Clean, Malicious, or ScanError. No daemons. No cloud. No native bindings.",
   "license": "ISC",
   "author": "pompelmi contributors",
@@ -28,7 +28,10 @@
     "fastify",
     "nestjs",
     "multer",
-    "zero-dependencies"
+    "zero-dependencies",
+    "remix",
+    "sveltekit",
+    "svelte"
   ],
   "type": "commonjs",
   "main": "./src/index.js",
@@ -37,7 +40,7 @@
     "pompelmi": "./bin/pompelmi.js"
   },
   "scripts": {
-    "test": "node --test test/unit.test.js && node --test packages/nestjs/test/index.test.js && node --test packages/fastify/test/index.test.js && node --test packages/nextjs/test/index.test.js && node test/scan.test.js",
+    "test": "node --test test/unit.test.js && node --test packages/nestjs/test/index.test.js && node --test packages/fastify/test/index.test.js && node --test packages/nextjs/test/index.test.js && node --test packages/hono/test/index.test.js && node --test packages/testing/test/index.test.js && node --test packages/remix/test/index.test.js && node --test packages/sveltekit/test/index.test.js && node test/scan.test.js",
     "lint": "eslint src/"
   },
   "publishConfig": {

package/packages/hono/README.md

@@ -0,0 +1,160 @@
+# @pompelmi/hono
+
+Hono middleware for [pompelmi](https://pompelmi.app) — in-process ClamAV virus scanning with zero extra dependencies.
+
+Works on **Node.js**, **Bun**, and **Cloudflare Workers** (simulation mode).
+
+## Installation
+
+```bash
+npm install @pompelmi/hono pompelmi
+# or
+bun add @pompelmi/hono pompelmi
+```
+
+## Quick Start
+
+```js
+import { Hono } from 'hono'
+import { pompelmiMiddleware } from '@pompelmi/hono'
+
+const app = new Hono()
+
+app.use('/upload/*', pompelmiMiddleware({
+  host: 'localhost',
+  port: 3310,
+}))
+
+app.post('/upload', async (c) => {
+  // file is guaranteed clean here
+  return c.json({ ok: true })
+})
+
+export default app
+```
+
+## Custom infected handler
+
+```js
+app.use('/upload/*', pompelmiMiddleware({
+  host: 'localhost',
+  port: 3310,
+  field: 'file',
+  onInfected: (c, filename) => {
+    console.warn(`Blocked malicious upload: ${filename}`)
+    return c.json({ error: 'Malware detected', filename }, 422)
+  },
+}))
+```
+
+## Hono on Node.js
+
+```js
+const { serve } = require('@hono/node-server')
+const { Hono } = require('hono')
+const { pompelmiMiddleware } = require('@pompelmi/hono')
+
+const app = new Hono()
+
+app.use('/upload/*', pompelmiMiddleware({
+  host: '127.0.0.1',
+  port: 3310,
+}))
+
+app.post('/upload', async (c) => {
+  const body = await c.req.parseBody()
+  const file = body['file']
+  return c.json({ name: file.name, size: file.size, ok: true })
+})
+
+serve({ fetch: app.fetch, port: 3000 }, () => {
+  console.log('Server running on http://localhost:3000')
+})
+```
+
+## Hono on Bun
+
+```ts
+import { Hono } from 'hono'
+import { pompelmiMiddleware } from '@pompelmi/hono'
+
+const app = new Hono()
+
+app.use('/upload/*', pompelmiMiddleware({
+  socket: '/run/clamav/clamd.sock',  // UNIX socket — faster on Bun
+}))
+
+app.post('/upload', async (c) => {
+  return c.json({ ok: true })
+})
+
+export default {
+  port: 3000,
+  fetch: app.fetch,
+}
+```
+
+## Hono on Cloudflare Workers
+
+> Note: clamd is not available inside Workers. Use pompelmi in a Node.js / Bun sidecar
+> service and call it over HTTP, or use the UNIX socket approach with a co-located daemon.
+>
+> For Workers deployments without a sidecar, the middleware skips scanning gracefully
+> and calls `next()` — you can gate the behaviour with an environment variable.
+
+```ts
+import { Hono } from 'hono'
+import { pompelmiMiddleware } from '@pompelmi/hono'
+
+const app = new Hono<{ Bindings: { SCAN_HOST: string; SCAN_PORT: string } }>()
+
+app.use('/upload/*', async (c, next) => {
+  if (!c.env.SCAN_HOST) return next()   // skip if no clamd configured
+  return pompelmiMiddleware({
+    host: c.env.SCAN_HOST,
+    port: Number(c.env.SCAN_PORT) || 3310,
+  })(c, next)
+})
+
+app.post('/upload', async (c) => {
+  return c.json({ ok: true })
+})
+
+export default app
+```
+
+## Configuration Reference
+
+All options are forwarded to pompelmi's `ScanOptions`:
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `field` | `string` | `'file'` | Form field name containing the uploaded file |
+| `host` | `string` | — | clamd hostname (enables TCP mode) |
+| `port` | `number` | `3310` | clamd port |
+| `socket` | `string` | — | UNIX domain socket path |
+| `timeout` | `number` | `15000` | Socket idle timeout in ms |
+| `retries` | `number` | `0` | Number of retry attempts |
+| `retryDelay` | `number` | `1000` | Delay between retries in ms |
+| `onInfected` | `Function` | — | Called with `(c, filename)` when malware is detected |
+
+## TypeScript
+
+```ts
+import { Hono } from 'hono'
+import { pompelmiMiddleware } from '@pompelmi/hono'
+import { Verdict } from 'pompelmi'
+
+const app = new Hono()
+
+app.use('/upload/*', pompelmiMiddleware({
+  host: 'localhost',
+  port: 3310,
+  onInfected: (c, filename) =>
+    c.json({ error: `${filename} is infected` }, 422),
+}))
+```
+
+## License
+
+ISC — see root [LICENSE](../../LICENSE).

package/packages/hono/index.d.ts

@@ -0,0 +1,29 @@
+import type { MiddlewareHandler, Context } from 'hono';
+import type { ScanOptions } from 'pompelmi';
+
+export interface PompelmiHonoOptions extends ScanOptions {
+  /** Form field name that contains the uploaded file (default: 'file') */
+  field?: string;
+  /**
+   * Called with (c, filename) when a malicious file is detected.
+   * Must return a Response (or Promise<Response>).
+   * If omitted, responds with HTTP 422 { error: 'Malware detected' }.
+   */
+  onInfected?: (c: Context, filename: string) => Response | Promise<Response>;
+}
+
+/**
+ * Hono middleware that scans an uploaded file before the route handler runs.
+ * Reads the file from the parsed multipart body field (default: 'file').
+ *
+ * @example
+ * import { Hono } from 'hono'
+ * import { pompelmiMiddleware } from '@pompelmi/hono'
+ *
+ * const app = new Hono()
+ * app.use('/upload/*', pompelmiMiddleware({ host: 'localhost', port: 3310 }))
+ * app.post('/upload', (c) => c.json({ ok: true }))
+ */
+export function pompelmiMiddleware(options?: PompelmiHonoOptions): MiddlewareHandler;
+
+export { Verdict } from 'pompelmi';

package/packages/hono/index.js

@@ -0,0 +1,74 @@
+'use strict';
+
+const { scanBuffer, Verdict } = require('pompelmi');
+
+const SCAN_KEYS = ['host', 'port', 'socket', 'timeout', 'retries', 'retryDelay'];
+
+function buildScanOptions(options) {
+  const out = {};
+  for (const k of SCAN_KEYS) {
+    if (options[k] !== undefined) out[k] = options[k];
+  }
+  return out;
+}
+
+async function toBuffer(raw) {
+  if (Buffer.isBuffer(raw)) return raw;
+  if (raw instanceof Uint8Array) return Buffer.from(raw);
+  // Web API File / Blob (Hono on Bun, Cloudflare Workers, Node 20+)
+  if (raw && typeof raw.arrayBuffer === 'function') {
+    return Buffer.from(await raw.arrayBuffer());
+  }
+  if (typeof raw === 'string') return Buffer.from(raw);
+  return null;
+}
+
+/**
+ * Hono middleware that scans an uploaded file with pompelmi before the route
+ * handler runs.  The file is read from the parsed multipart body.
+ *
+ * @param {object}  [options]
+ * @param {string}  [options.field='file']      - Form field name containing the file.
+ * @param {string}  [options.host]              - clamd hostname (enables TCP mode).
+ * @param {number}  [options.port=3310]         - clamd port.
+ * @param {string}  [options.socket]            - UNIX domain socket path.
+ * @param {number}  [options.timeout=15000]     - Socket idle timeout in ms.
+ * @param {number}  [options.retries=0]         - Number of retry attempts.
+ * @param {number}  [options.retryDelay=1000]   - Delay between retries in ms.
+ * @param {Function} [options.onInfected]       - Called with (c, filename) when malware
+ *                                               is detected; must return a Response.
+ *                                               Defaults to 422 JSON error.
+ */
+function pompelmiMiddleware(options) {
+  const { field = 'file', onInfected } = options || {};
+  const scanOptions = buildScanOptions(options || {});
+
+  return async function pompelmiHonoMiddleware(c, next) {
+    let body;
+    try {
+      body = await c.req.parseBody();
+    } catch {
+      return next();
+    }
+
+    const raw = body[field];
+    if (raw == null) return next();
+
+    const buffer = await toBuffer(raw);
+    if (!buffer || buffer.length === 0) return next();
+
+    const result = await scanBuffer(buffer, scanOptions);
+
+    if (result === Verdict.Malicious) {
+      const filename = (raw && typeof raw.name === 'string') ? raw.name : field;
+      if (typeof onInfected === 'function') {
+        return onInfected(c, filename);
+      }
+      return c.json({ error: 'Malware detected' }, 422);
+    }
+
+    return next();
+  };
+}
+
+module.exports = { pompelmiMiddleware, Verdict };

package/packages/hono/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@pompelmi/hono",
+  "version": "1.0.0",
+  "description": "Hono middleware for pompelmi — in-process ClamAV virus scanning with zero extra dependencies",
+  "license": "ISC",
+  "author": "pompelmi contributors",
+  "homepage": "https://pompelmi.app",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pompelmi/pompelmi.git",
+    "directory": "packages/hono"
+  },
+  "keywords": [
+    "hono",
+    "middleware",
+    "clamav",
+    "antivirus",
+    "virus-scan",
+    "malware",
+    "file-upload",
+    "security",
+    "pompelmi",
+    "bun",
+    "edge",
+    "cloudflare-workers"
+  ],
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "scripts": {
+    "test": "node --test test/index.test.js"
+  },
+  "peerDependencies": {
+    "hono": ">=3",
+    "pompelmi": ">=1.14.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}

package/packages/remix/README.md

@@ -0,0 +1,142 @@
+# @pompelmi/remix
+
+Remix upload handler for [pompelmi](https://pompelmi.app) — in-process ClamAV virus scanning with zero extra dependencies.
+
+Works with **Remix v1 and v2** on Node.js, and is compatible with the `unstable_parseMultipartFormData` API.
+
+## Installation
+
+```bash
+npm install @pompelmi/remix pompelmi
+```
+
+## Quick Start
+
+```ts
+import { unstable_parseMultipartFormData, json } from '@remix-run/node'
+import { pompelmiUploadHandler } from '@pompelmi/remix'
+import type { ActionFunctionArgs } from '@remix-run/node'
+
+export async function action({ request }: ActionFunctionArgs) {
+  const formData = await unstable_parseMultipartFormData(
+    request,
+    pompelmiUploadHandler({ host: 'localhost', port: 3310 })
+  )
+
+  const file = formData.get('file') as File
+  return json({ name: file.name, size: file.size, ok: true })
+}
+```
+
+If a malicious file is uploaded, `pompelmiUploadHandler` throws a `Response` with HTTP **422** — Remix catches it automatically and returns it to the client.
+
+## With an inner handler
+
+Chain with any Remix upload handler (e.g. `unstable_createFileUploadHandler`) to store clean files to disk:
+
+```ts
+import {
+  unstable_parseMultipartFormData,
+  unstable_createFileUploadHandler,
+  json,
+} from '@remix-run/node'
+import { pompelmiUploadHandler } from '@pompelmi/remix'
+
+const uploadToTmp = unstable_createFileUploadHandler({ directory: '/tmp/uploads' })
+
+export async function action({ request }) {
+  const formData = await unstable_parseMultipartFormData(
+    request,
+    pompelmiUploadHandler({
+      host: 'localhost',
+      port: 3310,
+      inner: uploadToTmp,   // called only if file is clean
+    })
+  )
+  const file = formData.get('file')  // NodeOnDiskFile from inner handler
+  return json({ ok: true })
+}
+```
+
+## Scan a specific field only
+
+Use `field` to restrict scanning to a single form field. Other file fields are passed through to `inner` (or returned as `File` objects) without scanning:
+
+```ts
+pompelmiUploadHandler({
+  host: 'localhost',
+  port: 3310,
+  field: 'avatar',  // only scan the 'avatar' field
+})
+```
+
+## Custom error response
+
+```ts
+pompelmiUploadHandler({
+  host: 'localhost',
+  port: 3310,
+  onInfected: ({ filename }) => {
+    console.warn(`Blocked malicious upload: ${filename}`)
+    throw new Response(
+      JSON.stringify({ error: 'Malware detected', filename }),
+      { status: 422, headers: { 'Content-Type': 'application/json' } }
+    )
+  },
+})
+```
+
+## Route example (full)
+
+```tsx
+// app/routes/upload.tsx
+import {
+  unstable_parseMultipartFormData,
+  json,
+  type ActionFunctionArgs,
+} from '@remix-run/node'
+import { Form, useActionData } from '@remix-run/react'
+import { pompelmiUploadHandler } from '@pompelmi/remix'
+
+export async function action({ request }: ActionFunctionArgs) {
+  // Throws HTTP 422 automatically if malware is detected
+  const formData = await unstable_parseMultipartFormData(
+    request,
+    pompelmiUploadHandler({ host: 'localhost', port: 3310 })
+  )
+
+  const file = formData.get('document') as File
+  if (!file) return json({ error: 'No file provided' }, { status: 400 })
+
+  return json({ name: file.name, size: file.size, ok: true })
+}
+
+export default function Upload() {
+  const data = useActionData<typeof action>()
+  return (
+    <Form method="post" encType="multipart/form-data">
+      <input type="file" name="document" />
+      <button type="submit">Upload</button>
+      {data?.ok && <p>Uploaded: {data.name} ({data.size} bytes)</p>}
+    </Form>
+  )
+}
+```
+
+## Configuration Reference
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `field` | `string` | — | Only scan this field; others pass through unscanned |
+| `inner` | `UploadHandler` | — | Inner handler for clean files (e.g. file-upload, memory) |
+| `host` | `string` | — | clamd hostname (enables TCP mode) |
+| `port` | `number` | `3310` | clamd port |
+| `socket` | `string` | — | UNIX domain socket path |
+| `timeout` | `number` | `15000` | Socket idle timeout in ms |
+| `retries` | `number` | `0` | Retry attempts |
+| `retryDelay` | `number` | `1000` | Delay between retries in ms |
+| `onInfected` | `Function` | — | Called with `{ name, filename }` when malware detected |
+
+## License
+
+ISC — see root [LICENSE](../../LICENSE).

package/packages/remix/index.d.ts

@@ -0,0 +1,50 @@
+import type { ScanOptions } from 'pompelmi';
+
+export interface UploadHandlerArgs {
+  name: string;
+  filename: string | undefined;
+  contentType: string;
+  data: AsyncIterable<Uint8Array>;
+}
+
+export type RemixUploadHandler = (args: UploadHandlerArgs) => Promise<File | string | undefined>;
+
+export interface PompelmiRemixOptions extends ScanOptions {
+  /**
+   * Only scan this form field name; other file fields are passed straight to `inner`.
+   * When omitted, all file fields are scanned.
+   */
+  field?: string;
+  /**
+   * Inner UploadHandler to call for clean files (e.g. unstable_createMemoryUploadHandler).
+   * When omitted, clean files are returned as Web API `File` objects.
+   */
+  inner?: RemixUploadHandler;
+  /**
+   * Called with `{ name, filename }` when a malicious file is detected.
+   * Must throw a Response (or return one that will be thrown by the caller).
+   * If omitted, throws an HTTP 422 Response automatically.
+   */
+  onInfected?: (args: { name: string; filename: string }) => never | Promise<never>;
+}
+
+/**
+ * Creates a Remix-compatible UploadHandler that scans each uploaded file with
+ * pompelmi before forwarding it to an optional inner handler.
+ *
+ * @example
+ * import { unstable_parseMultipartFormData } from '@remix-run/node'
+ * import { pompelmiUploadHandler } from '@pompelmi/remix'
+ *
+ * export async function action({ request }: ActionFunctionArgs) {
+ *   const formData = await unstable_parseMultipartFormData(
+ *     request,
+ *     pompelmiUploadHandler({ host: 'localhost', port: 3310 })
+ *   )
+ *   const file = formData.get('file') as File
+ *   return json({ name: file.name, size: file.size })
+ * }
+ */
+export function pompelmiUploadHandler(options?: PompelmiRemixOptions): RemixUploadHandler;
+
+export { Verdict } from 'pompelmi';