fix(build): Bump dependencies, improve test/build scripts, expand documentation and add project metadata

.serena/memories/code_style_conventions.md

@@ -0,0 +1,35 @@
+# Code Style and Conventions
+
+## Naming Conventions
+- **Interfaces**: Prefix with `I` (e.g., `IUserData`)
+- **Types**: Prefix with `T` (e.g., `TResponseType`)
+- **Files**: Always lowercase (e.g., `classes.clamavservice.ts`)
+- **Classes**: PascalCase (e.g., `ClamAvService`)
+- **Methods/Functions**: camelCase (e.g., `scanBuffer`)
+- Avoid ENums when possible
+
+## TypeScript Patterns
+- TypeScript-first approach with full type safety
+- ES modules (type: "module" in package.json)
+- Import dependencies in `ts/plugins.ts`
+- Reference with full path: `plugins.myModule.myClass()`
+
+## File Organization
+- Source code in `ts/` directory
+- Tests in `test/` directory
+- Distribution in `dist_ts/` directory
+- Use `.js` extensions in imports for ES modules
+
+## Testing Patterns
+- Use @git.zone/tstest framework
+- Import expect from @push.rocks/tapbundle
+- Test files end with `export default tap.start()`
+- Test naming: `*.both.ts`, `*.node.ts`, `*.browser.ts`
+- EICAR test string for antivirus verification
+
+## General Principles
+- Make RAZOR SHARP changes - every modification must be goal-oriented
+- Improve elegance - changes should enhance clarity and maintainability
+- Preserve necessary complexity - don't oversimplify
+- Keep async patterns - maintain Promises where they add value
+- Remove redundancy carefully while preserving functionality

.serena/memories/project_overview.md

@@ -0,0 +1,31 @@
+# SmartAntivirus Project Overview
+
+## Purpose
+SmartAntivirus (@push.rocks/smartantivirus) is a Node.js/TypeScript library that provides enterprise-grade antivirus scanning capabilities by integrating with ClamAV. It allows developers to scan files, buffers, strings, and streams for viruses in their applications.
+
+## Tech Stack
+- TypeScript (primary language)
+- Node.js (runtime)
+- ClamAV (antivirus engine)
+- Docker (for containerized ClamAV deployment)
+- Testing: @git.zone/tstest with @push.rocks/tapbundle
+- Build: @git.zone/tsbuild
+
+## Architecture
+- **ClamAvService**: High-level interface for virus scanning operations
+  - Scan strings, buffers, Node.js streams, and Web Streams
+  - Auto-manages Docker container if needed
+  - Connects to ClamAV daemon on port 3310
+
+- **ClamAVManager**: Low-level Docker container management
+  - Handles container lifecycle (start/stop)
+  - Updates virus definitions
+  - Provides log monitoring
+
+## Key Features
+- In-memory scanning without disk I/O
+- Stream processing for large files
+- TypeScript-first with full type safety
+- Zero-config with sensible defaults
+- Auto-updating virus definitions
+- Docker-based or direct daemon connection

.serena/memories/suggested_commands.md

@@ -0,0 +1,31 @@
+# Suggested Commands for SmartAntivirus Development
+
+## Build & Test Commands
+- `pnpm test` - Run test suite with tapbundle
+- `pnpm build` - Build TypeScript to JavaScript (uses tsbuild)
+- `pnpm run buildDocs` - Generate documentation (tsdoc)
+
+## Development Tools
+- `tsbuild check test/**/* --skiplibcheck` - Type-check test files
+- `tsx test/test.ts` - Run individual test file directly
+
+## Version Control
+- `git mv <old> <new>` - Move/rename files preserving history
+- `git status` - Check current changes
+- `git diff` - View uncommitted changes
+
+## Package Management
+- `pnpm install` - Install dependencies
+- `pnpm install --save-dev <package>` - Add dev dependency
+- `pnpm add <package>` - Add production dependency
+
+## File Operations
+- `ls` - List directory contents
+- `cat <file>` - View file contents
+- `find . -name "*.ts"` - Find TypeScript files
+- `rg <pattern>` - Search codebase with ripgrep
+
+## Docker Management (if testing locally)
+- `docker ps` - List running containers
+- `docker logs clamav` - View ClamAV container logs
+- `docker stop clamav` - Stop ClamAV container

.serena/memories/task_completion_workflow.md

@@ -0,0 +1,44 @@
+# Task Completion Workflow
+
+## Required Steps After Making Code Changes
+
+1. **Build the Project**
+   ```bash
+   pnpm build
+   ```
+   Ensures TypeScript compiles without errors
+
+2. **Run Tests**
+   ```bash
+   pnpm test
+   ```
+   Verifies functionality with test suite
+
+3. **Type Check Test Files** (if tests were modified)
+   ```bash
+   tsbuild check test/**/* --skiplibcheck
+   ```
+
+## Quality Checks
+- Verify no TypeScript compilation errors
+- Ensure all tests pass
+- Check that new code follows existing patterns
+- Verify imports use `.js` extensions for ES modules
+- Confirm no hardcoded values that should be configurable
+
+## Documentation Updates
+- Update readme.md if API changes
+- Add JSDoc comments for new public methods
+- Update changelog.md for version changes
+
+## Before Committing
+- NEVER commit without explicit user approval
+- Use `git status` to review changes
+- Use `git diff` to verify modifications
+- Create focused commits with clear messages
+- Never commit secrets or API keys
+
+## Important Notes
+- The project uses pnpm exclusively (not npm or yarn)
+- Always read documentation before using unfamiliar APIs
+- Check existing code patterns before implementing new features

.serena/project.yml

@@ -0,0 +1,68 @@
+# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
+#  * For C, use cpp
+#  * For JavaScript, use typescript
+# Special requirements:
+#  * csharp: Requires the presence of a .sln file in the project folder.
+language: typescript
+
+# whether to use the project's gitignore file to ignore files
+# Added on 2025-04-07
+ignore_all_files_in_gitignore: true
+# list of additional paths to ignore
+# same syntax as gitignore, so you can use * and **
+# Was previously called `ignored_dirs`, please update your config if you are using that.
+# Added (renamed) on 2025-04-07
+ignored_paths: []
+
+# whether the project is in read-only mode
+# If set to true, all editing tools will be disabled and attempts to use them will result in an error
+# Added on 2025-04-18
+read_only: false
+
+
+# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
+# Below is the complete list of tools for convenience.
+# To make sure you have the latest list of tools, and to view their descriptions, 
+# execute `uv run scripts/print_tool_overview.py`.
+#
+#  * `activate_project`: Activates a project by name.
+#  * `check_onboarding_performed`: Checks whether project onboarding was already performed.
+#  * `create_text_file`: Creates/overwrites a file in the project directory.
+#  * `delete_lines`: Deletes a range of lines within a file.
+#  * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
+#  * `execute_shell_command`: Executes a shell command.
+#  * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
+#  * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
+#  * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
+#  * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
+#  * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
+#  * `initial_instructions`: Gets the initial instructions for the current project.
+#     Should only be used in settings where the system prompt cannot be set,
+#     e.g. in clients you have no control over, like Claude Desktop.
+#  * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
+#  * `insert_at_line`: Inserts content at a given line in a file.
+#  * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
+#  * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
+#  * `list_memories`: Lists memories in Serena's project-specific memory store.
+#  * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
+#  * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
+#  * `read_file`: Reads a file within the project directory.
+#  * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
+#  * `remove_project`: Removes a project from the Serena configuration.
+#  * `replace_lines`: Replaces a range of lines within a file with new content.
+#  * `replace_symbol_body`: Replaces the full definition of a symbol.
+#  * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
+#  * `search_for_pattern`: Performs a search for a pattern in the project.
+#  * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
+#  * `switch_modes`: Activates modes by providing a list of their names
+#  * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
+#  * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
+#  * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
+#  * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
+excluded_tools: []
+
+# initial prompt for the project. It will always be given to the LLM upon activating the project
+# (contrary to the memories, which are loaded on demand).
+initial_prompt: ""
+
+project_name: "smartantivirus"

changelog.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 2025-08-16 - 1.3.2 - fix(build)
+Bump dependencies, improve test/build scripts, expand documentation and add project metadata
+
+- Updated devDependencies: bumped @git.zone/tsbuild, @git.zone/tsbundle, @git.zone/tstest, @push.rocks/tapbundle, @types/node and typescript to newer versions.
+- Updated runtime dependencies: bumped @push.rocks/smartfile, @push.rocks/smartpath and axios; tar version updated.
+- Adjusted npm scripts: test now runs with '(tstest test/ --web --verbose --logfile --timeout 120)'; build and docs scripts unchanged in behavior.
+- Added packageManager entry (pnpm) and a pnpm-workspace.yaml with onlyBuiltDependencies configured.
+- Expanded and rewrote README with detailed quick start, examples, API reference and troubleshooting guidance.
+- Added local assistant/IDE metadata and memories (.claude/settings.local.json and .serena/*) to aid development tooling and project onboarding.
+
 ## 2025-02-07 - 1.3.1 - fix(core)
 Updated descriptions and keywords in package.json and npmextra.json. Improved README content for usage clarity.
 

package.json

@@ -9,24 +9,24 @@
   "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/ --web)",
+    "test": "(tstest test/ --web --verbose --logfile --timeout 120)",
     "build": "(tsbuild --web --allowimplicitany)",
     "buildDocs": "(tsdoc)"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.25",
+    "@git.zone/tsbuild": "^2.6.4",
-    "@git.zone/tsbundle": "^2.0.5",
+    "@git.zone/tsbundle": "^2.5.1",
     "@git.zone/tsrun": "^1.2.46",
-    "@git.zone/tstest": "^1.0.44",
+    "@git.zone/tstest": "^2.3.4",
-    "@push.rocks/tapbundle": "^5.0.15",
+    "@push.rocks/tapbundle": "^6.0.3",
-    "@types/node": "^20.8.7",
+    "@types/node": "^24.3.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@push.rocks/smartfile": "^11.1.5",
+    "@push.rocks/smartfile": "^11.2.5",
-    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartpath": "^6.0.0",
     "@push.rocks/smartstream": "^3.2.5",
-    "axios": "^1.7.9",
+    "axios": "^1.11.0",
     "tar": "^7.4.3"
   },
   "repository": {
@@ -63,5 +63,6 @@
     "network security",
     "buffer scanning",
     "software testing"
-  ]
+  ],
+  "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
 }

pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+onlyBuiltDependencies:
+  - esbuild
+  - mongodb-memory-server
+  - puppeteer

readme.md

@@ -1,233 +1,322 @@
-# @push.rocks/smartantivirus
+# @push.rocks/smartantivirus 🛡️
 
-A Node.js package for integrating antivirus scanning capabilities using ClamAV, allowing in-memory file and data scanning.
+**Enterprise-grade antivirus scanning for Node.js applications** - Seamlessly integrate ClamAV's powerful virus detection into your TypeScript/JavaScript projects with zero hassle.
+
+## Why SmartAntivirus? 🚀
+
+In today's digital landscape, security is paramount. Whether you're building a file-sharing platform, processing user uploads, or handling sensitive data streams, you need reliable virus protection that just works. SmartAntivirus gives you:
+
+- **🐳 Docker-based or Direct Connection** - Choose your deployment style
+- **⚡ In-memory Scanning** - Lightning-fast scanning without disk I/O
+- **🌊 Stream Processing** - Scan data on-the-fly as it flows through your app
+- **🎯 TypeScript First** - Full type safety and IntelliSense support
+- **📦 Zero Config** - Works out of the box with sensible defaults
+- **🔄 Auto-updating** - Virus definitions stay current automatically
 
 ## Install
 
-To install `@push.rocks/smartantivirus`, ensure that you have Node.js and npm installed on your system. You will also need Docker if you intend to use the containerized version of ClamAV. Once the prerequisites are sorted, you can install the package using the following command:
-
 ```bash
 npm install @push.rocks/smartantivirus
 ```
 
-### Prerequisites
+Or if you're using pnpm (recommended):
 
-- Node.js and npm
+```bash
-- Docker (for container-based usage)
+pnpm add @push.rocks/smartantivirus
-- ClamAV daemon (for direct daemon usage)
-
-## Usage
-
-The `@push.rocks/smartantivirus` package provides intuitive tools for integrating ClamAV's virus scanning capabilities into your Node.js applications. It supports both Docker-based container management and direct communication with a running ClamAV daemon. Let’s dive into how you can effectively use this package.
-
-### Docker-based Usage with ClamAVManager
-
-The `ClamAVManager` class simplifies the process of managing a ClamAV service running inside a Docker container. It ensures that the container is started, the virus database is updated, and logs are captured for monitoring.
-
-#### Basic Setup
-
-Below demonstrates starting a ClamAV container, updating virus definitions, and reading logs:
-
-```typescript
-import { ClamAVManager } from '@push.rocks/smartantivirus';
-
-async function main() {
-  // Instantiate a ClamAVManager
-  const clamAvManager = new ClamAVManager();
-
-  // Start ClamAV Docker container
-  await clamAvManager.startContainer();
-
-  // Listen for log events
-  clamAvManager.on('log', event => {
-    console.log(`ClamAV log (${event.type}): ${event.message}`);
-  });
-
-  // Fetch and display database information
-  const dbInfo = await clamAvManager.getDatabaseInfo();
-  console.log('Database Information:', dbInfo);
-
-  // Update the virus database
-  await clamAvManager.updateDatabase();
-
-  // Stop the container when done
-  await clamAvManager.stopContainer();
-}
-
-main().catch(console.error);
 ```
 
-### Direct Daemon Usage with ClamAvService
+## Quick Start 🏃‍♂️
 
-If you prefer direct communication with an existing ClamAV daemon, use the `ClamAvService` class. This allows you to scan strings and streams directly in memory.
+### The 5-Minute Setup
-
-#### Connection Verification and String Scanning
-
-Below is an example of verifying connection to the ClamAV daemon and scanning a given string for virus signatures, using the EICAR test string:
 
 ```typescript
 import { ClamAvService } from '@push.rocks/smartantivirus';
 
-async function main() {
+// That's it! The service automatically manages a Docker container
-  const clamService = new ClamAvService('127.0.0.1', 3310);
+const scanner = new ClamAvService();
 
-  // Verify connection to ClamAV
+// Scan a suspicious string
-  const isConnected = await clamService.verifyConnection();
+const result = await scanner.scanString('Is this text safe?');
-  console.log(`Connection to ClamAV: ${isConnected ? 'successful' : 'failed'}`);
+console.log(result.isInfected ? '⚠️ Threat detected!' : '✅ All clear!');
 
-  // Scan a test string
+// Scan a buffer
-  const eicarTest = 'X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*';
+const fileBuffer = await fs.readFile('./upload.pdf');
-  const scanResult = await clamService.scanString(eicarTest);
+const scanResult = await scanner.scanBuffer(fileBuffer);
-  console.log('EICAR Test Result:', scanResult);
-}
-
-main().catch(console.error);
 ```
 
-### Streaming Scanning
+## Core Concepts 💡
 
-`ClamAvService` provides methods to scan NodeJS and Web API streams. This is particularly useful for processing large files or data transferred over the network.
+SmartAntivirus provides two main classes:
 
-#### Example: NodeJS Streaming
+### 🎯 ClamAvService
+The high-level interface for virus scanning. It handles all the complexity behind a simple, intuitive API.
+
+### 🐳 ClamAVManager
+Low-level Docker container management for advanced use cases. Most users won't need to interact with this directly.
+
+## Real-World Examples 🌍
+
+### Protecting File Uploads
+
+```typescript
+import { ClamAvService } from '@push.rocks/smartantivirus';
+import express from 'express';
+import multer from 'multer';
+
+const app = express();
+const scanner = new ClamAvService();
+const upload = multer({ storage: multer.memoryStorage() });
+
+app.post('/upload', upload.single('file'), async (req, res) => {
+  try {
+    // Scan the uploaded file buffer
+    const result = await scanner.scanBuffer(req.file.buffer);
+    
+    if (result.isInfected) {
+      return res.status(400).json({ 
+        error: 'File rejected',
+        threat: result.reason 
+      });
+    }
+    
+    // File is safe, proceed with storage
+    await saveFile(req.file);
+    res.json({ message: 'File uploaded successfully' });
+  } catch (error) {
+    res.status(500).json({ error: 'Scan failed' });
+  }
+});
+```
+
+### Streaming Large Files
+
+Never load huge files into memory! Stream them instead:
 
 ```typescript
 import { ClamAvService } from '@push.rocks/smartantivirus';
 import { createReadStream } from 'fs';
 
-async function main() {
+const scanner = new ClamAvService();
-  const clamService = new ClamAvService();
 
-  // Scan a local file stream
+async function scanLargeFile(filePath: string) {
-  const fileStream = createReadStream('path/to/suspicious/file');
+  const stream = createReadStream(filePath);
-  const fileScanResult = await clamService.scanStream(fileStream);
+  const result = await scanner.scanStream(stream);
-  console.log('File Stream Scan Result:', fileScanResult);
   
-  // Scan a remote file by stream
+  if (result.isInfected) {
-  const remoteFileScan = await clamService.scanFileFromWebAsStream('http://example.com/file');
+    console.log(`🚨 Threat found: ${result.reason}`);
-  console.log('Remote File Scan Result:', remoteFileScan);
+    // Quarantine or delete the file
+  } else {
+    console.log('✅ File is clean');
+  }
 }
-
-main().catch(console.error);
 ```
 
-#### Example: Web Stream (in Browser)
+### Scanning Remote Content
+
+Perfect for proxies, CDNs, or content moderation:
 
 ```typescript
-import { ClamAvService } from '@push.rocks/smartantivirus';
+const scanner = new ClamAvService();
 
-async function scanWebStream(url: string) {
+// Scan a file from a URL
+const result = await scanner.scanFileFromWebAsStream('https://example.com/document.pdf');
+
+// For browser environments using Web Streams API
+async function scanInBrowser(url: string) {
   const response = await fetch(url);
   const webStream = response.body as ReadableStream<Uint8Array>;
   
-  const clamService = new ClamAvService();
   if (webStream) {
-    const scanResult = await clamService.scanWebStream(webStream);
+    const result = await scanner.scanWebStream(webStream);
-    console.log('Web Stream Scan Result:', scanResult);
+    return result;
   }
 }
-
-scanWebStream('http://example.com/streamed-file').catch(console.error);
 ```
 
-### Handling Buffers
+### Advanced Container Management
 
-Scan binary data directly using a buffer:
+For production environments requiring fine-grained control:
-
-```typescript
-import { ClamAvService } from '@push.rocks/smartantivirus';
-
-async function main() {
-  const clamService = new ClamAvService();
-  const buffer = Buffer.from('Potentially harmful binary data', 'utf8');
-
-  try {
-    const bufferScanResult = await clamService.scanBuffer(buffer);
-    console.log('Buffer Scan Result:', bufferScanResult);
-  } catch (err) {
-    console.error('Error scanning buffer:', err);
-  }
-}
-
-main().catch(console.error);
-```
-
-### Error Handling and Event Monitoring
-
-Both `ClamAVManager` and `ClamAvService` are designed with error handling features for robustness.
 
 ```typescript
 import { ClamAVManager } from '@push.rocks/smartantivirus';
 
-async function errorHandlingExample() {
+class AntivirusService {
-  const clamAvManager = new ClamAVManager();
+  private manager: ClamAVManager;
   
-  try {
+  async initialize() {
-    await clamAvManager.startContainer();
+    this.manager = new ClamAVManager();
     
-    // Listen for errors in logs
+    // Start the container
-    clamAvManager.on('log', event => {
+    await this.manager.startContainer();
+    
+    // Set up log monitoring
+    this.manager.on('log', (event) => {
       if (event.type === 'error') {
         console.error(`ClamAV Error: ${event.message}`);
+        // Send to your logging service
       }
     });
     
-    console.log('ClamAV container started successfully.');
+    // Update virus definitions
-  } catch (err) {
+    await this.manager.updateDatabase();
-    console.error('Error starting ClamAV container:', err);
+    
-  }
+    // Get database info
+    const dbInfo = await this.manager.getDatabaseInfo();
+    console.log(`Virus DB Version: ${dbInfo}`);
   }
   
-errorHandlingExample().catch(console.error);
+  async shutdown() {
+    await this.manager.stopContainer();
+  }
+}
 ```
 
-### Advanced Usage and Configuration
+## Testing 🧪
 
-#### Customize Container Settings
+We use the industry-standard EICAR test string for verification:
-
-Customizing the Docker container setup is possible through class methods and properties:
 
 ```typescript
-const manager = new ClamAVManager();
+import { ClamAvService } from '@push.rocks/smartantivirus';
-console.log(`Container Name: ${manager.containerName}`); // Access default name
+
-console.log(`Listening Port: ${manager.port}`); // Access default port
+const scanner = new ClamAvService();
+
+// This is the EICAR test string - it's harmless but triggers antivirus
+const EICAR = 'X5O!P%@AP[4\\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*';
+
+const result = await scanner.scanString(EICAR);
+console.log(result.isInfected); // true
+console.log(result.reason);     // 'Eicar-Test-Signature'
 ```
 
-#### Managing Logs
+Run the test suite:
-
-Capture and filter ClamAV logs for insights:
-
-```typescript
-const manager = new ClamAVManager();
-await manager.startContainer();
-
-const logs = manager.getLogs();
-const errorLogs = logs.filter(log => log.type === 'error');
-console.log('Error Logs:', errorLogs);
-```
-
-#### Health Checks
-
-Monitor and ensure ClamAV service readiness:
-
-```typescript
-const manager = new ClamAVManager();
-await manager.startContainer(); // Includes readiness checks
-
-const dbInfo = await manager.getDatabaseInfo();
-console.log('Database Version:', dbInfo);
-```
-
-### Testing your setup
-
-Utilize provided test scripts to validate your ClamAV setup:
 
 ```bash
-npm run test
+npm test
 ```
 
-These tests use the `@push.rocks/tapbundle` framework to verify functionality, ensuring a reliable setup.
+## API Reference 📚
 
-### Conclusion
+### ClamAvService
 
-The `@push.rocks/smartantivirus` package offers a powerful suite of tools for incorporating ClamAV's scanning capabilities into Node.js applications. With Docker integration and direct daemon access, it covers a wide range of use-cases, from file scanning to real-time stream analysis. Designed with a focus on flexibility and ease of use, it allows developers to build secure, antivirus-enabled applications efficiently.
+#### Constructor
-undefined
+```typescript
+new ClamAvService(host?: string, port?: number)
+```
+- `host` - ClamAV daemon host (default: '127.0.0.1')
+- `port` - ClamAV daemon port (default: 3310)
+
+#### Methods
+
+##### `scanString(text: string): Promise<ScanResult>`
+Scan a text string for threats.
+
+##### `scanBuffer(buffer: Buffer): Promise<ScanResult>`
+Scan binary data in a Buffer.
+
+##### `scanStream(stream: NodeJS.ReadableStream): Promise<ScanResult>`
+Scan a Node.js readable stream.
+
+##### `scanWebStream(stream: ReadableStream<Uint8Array>): Promise<ScanResult>`
+Scan a Web Streams API stream (browser-compatible).
+
+##### `scanFileFromWebAsStream(url: string): Promise<ScanResult>`
+Download and scan a file from a URL.
+
+##### `verifyConnection(): Promise<boolean>`
+Test the connection to ClamAV daemon.
+
+#### ScanResult Type
+```typescript
+interface ScanResult {
+  isInfected: boolean;
+  reason?: string;  // Threat name if infected
+}
+```
+
+### ClamAVManager
+
+Advanced container management for production deployments:
+
+- `startContainer()` - Launch ClamAV in Docker
+- `stopContainer()` - Gracefully shutdown
+- `updateDatabase()` - Update virus definitions
+- `getDatabaseInfo()` - Get current DB version
+- `getLogs()` - Retrieve container logs
+- Event: `'log'` - Real-time log streaming
+
+## Production Considerations 🏭
+
+### Performance Tips
+
+1. **Reuse connections** - Create one `ClamAvService` instance and reuse it
+2. **Stream large files** - Don't load them into memory
+3. **Implement timeouts** - Protect against hanging scans
+4. **Monitor logs** - Watch for database update failures
+
+### Security Best Practices
+
+- Run ClamAV container with limited resources
+- Implement rate limiting on scan endpoints
+- Log all detected threats for audit trails
+- Regularly update virus definitions
+- Use separate containers for different environments
+
+### Deployment Options
+
+#### Docker Compose
+```yaml
+services:
+  clamav:
+    image: clamav/clamav:latest
+    ports:
+      - "3310:3310"
+    volumes:
+      - clamav-db:/var/lib/clamav
+```
+
+#### Kubernetes
+The service automatically manages containers, but you can also deploy ClamAV separately and connect directly to the daemon.
+
+## Troubleshooting 🔧
+
+### Common Issues
+
+**Container won't start**
+- Ensure Docker is running
+- Check port 3310 isn't already in use
+- Verify sufficient disk space for virus definitions
+
+**Scans timing out**
+- Large files may take time - implement appropriate timeouts
+- Check container resources (CPU/Memory)
+- Ensure virus database is not updating
+
+**False positives**
+- Some packers/obfuscators trigger detection
+- Whitelist known-safe patterns if needed
+- Keep virus definitions updated
+
+## Contributing & Support 🤝
+
+- 🐛 [Report Issues](https://code.foss.global/push.rocks/smartantivirus/issues)
+- 📖 [Documentation](https://code.foss.global/push.rocks/smartantivirus)
+- 💬 [Discussions](https://code.foss.global/push.rocks/smartantivirus/issues)
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartantivirus',
-  version: '1.3.1',
+  version: '1.3.2',
   description: 'A Node.js package providing integration with ClamAV for anti-virus scanning, facilitating both Docker containerized management and direct connection to a ClamAV daemon.'
 }