pompelmi 0.31.0 → 0.32.0

package/dist/types/index.d.ts

@@ -9,7 +9,7 @@ export { mapMatchesToVerdict } from './verdict';
 export { CommonHeuristicsScanner } from './scanners/common-heuristics';
 export { createZipBombGuard } from './scanners/zip-bomb-guard';
 export { definePolicy, DEFAULT_POLICY } from './policy';
-export { createPresetScanner, composeScanners, type PresetName, type PresetOptions } from './presets';
+export { createPresetScanner, composeScanners, type PresetName, type PresetOptions, type NamedScanner, type ComposeScannerOptions } from './presets';
 export { scanBytes, scanFile, type ScanOptions } from './scan';
 export * from "./presets";
 export { PerformanceTracker, aggregateScanStats, type PerformanceMetrics, type ScanStatistics, } from './utils/performance-metrics';

package/dist/types/presets.d.ts

@@ -1,4 +1,4 @@
-import type { Scanner, AnalysisDepth } from "./types";
+import type { Scanner, ScanFn, Verdict, AnalysisDepth } from "./types";
 export type PresetName = 'basic' | 'advanced' | 'malware-analysis' | 'decompilation-basic' | 'decompilation-deep' | string;
 export interface PresetOptions {
     yaraRules?: string | string[];
@@ -14,6 +14,59 @@ export interface PresetOptions {
     timeout?: number;
     [key: string]: unknown;
 }
-export declare function composeScanners(...scanners: Scanner[]): Scanner;
+/**
+ * A named scanner entry used with the array form of `composeScanners`.
+ * The first element is a display name for the scanner (used when
+ * `tagSourceName: true`), and the second element is the scanner itself.
+ *
+ * @example
+ * const entry: NamedScanner = ['zipGuard', createZipBombGuard({ ... })];
+ */
+export type NamedScanner = [name: string, scanner: Scanner];
+/**
+ * Options for `composeScanners` when using the named-scanner array form.
+ */
+export interface ComposeScannerOptions {
+    /**
+     * When `true` scanners run concurrently (Promise.all).
+     * When `false` (default) they run sequentially in order.
+     */
+    parallel?: boolean;
+    /**
+     * Stop scanning as soon as a match at this severity level (or higher) is
+     * found.  Severity order: `'malicious'` > `'suspicious'` > `'clean'`.
+     * Only effective when `parallel` is `false`.
+     */
+    stopOn?: Verdict;
+    /** Maximum time in milliseconds to wait for each individual scanner. */
+    timeoutMsPerScanner?: number;
+    /**
+     * When `true`, each match is tagged with the scanner's display name via
+     * `match.meta._sourceName`.  Useful for tracing which scanner produced a
+     * given result.
+     */
+    tagSourceName?: boolean;
+}
+/**
+ * Compose multiple scanners into a single scanner.
+ *
+ * **Named-scanner array form** (recommended — matches the README examples):
+ * ```ts
+ * const scanner = composeScanners(
+ *   [
+ *     ['zipGuard', createZipBombGuard({ maxEntries: 512, maxCompressionRatio: 12 })],
+ *     ['heuristics', CommonHeuristicsScanner],
+ *   ],
+ *   { parallel: false, stopOn: 'malicious', timeoutMsPerScanner: 5000, tagSourceName: true }
+ * );
+ * ```
+ *
+ * **Variadic form** (backward-compatible):
+ * ```ts
+ * const scanner = composeScanners(scannerA, scannerB, scannerC);
+ * ```
+ */
+export declare function composeScanners(namedScanners: NamedScanner[], opts?: ComposeScannerOptions): ScanFn;
+export declare function composeScanners(...scanners: Scanner[]): ScanFn;
 export declare function createPresetScanner(preset: PresetName, opts?: PresetOptions): Scanner;
 export declare const PRESET_CONFIGS: Record<string, PresetOptions>;

package/dist/types/types.d.ts

@@ -10,7 +10,7 @@ export * from './types/decompilation';
 export * from './hipaa-compliance';
 export interface Match {
     rule: string;
-    severity?: 'low' | 'medium' | 'high' | 'critical' | 'suspicious';
+    severity?: 'info' | 'low' | 'medium' | 'high' | 'critical' | 'suspicious' | 'malicious';
     meta?: Record<string, unknown>;
 }
 export interface FileInfo {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pompelmi",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "Fast, private malware scanner for Node.js file uploads. TypeScript-first library with Express, Koa, Fastify, Next.js & Nuxt/Nitro adapters. Features deep ZIP inspection, YARA integration, ZIP bomb protection, and real-time threat detection. Zero cloud dependencies - scan files in-process before they hit disk. Perfect for GDPR/HIPAA compliance.",
   "main": "./dist/pompelmi.cjs",
   "module": "./dist/pompelmi.esm.js",