@uploadista/flow-security-nodes 0.0.20-beta.7 → 0.0.20-beta.8

package/.turbo/turbo-build.log

@@ -1,23 +1,22 @@
 
 
 > @uploadista/flow-security-nodes@0.0.20-beta.7 build /Users/denislaboureyras/Documents/uploadista/dev/uploadista-workspace/uploadista-sdk/packages/flow/security/nodes
-> tsdown
+> tsc --noEmit && tsdown
 
-ℹ tsdown v0.17.2 powered by rolldown v1.0.0-beta.53
+ℹ tsdown v0.18.0 powered by rolldown v1.0.0-beta.53
 ℹ config file: /Users/denislaboureyras/Documents/uploadista/dev/uploadista-workspace/uploadista-sdk/packages/flow/security/nodes/tsdown.config.ts 
 ℹ entry: src/index.ts
 ℹ tsconfig: tsconfig.json
 ℹ Build start
-ℹ Cleaning 7 files
 ℹ [CJS] dist/index.cjs  1.23 kB │ gzip: 0.69 kB
 ℹ [CJS] 1 files, total: 1.23 kB
 ℹ [ESM] dist/index.mjs        1.26 kB │ gzip: 0.73 kB
 ℹ [ESM] dist/index.mjs.map    5.67 kB │ gzip: 2.19 kB
 ℹ [ESM] dist/index.d.mts.map  0.54 kB │ gzip: 0.29 kB
-ℹ [ESM] dist/index.d.mts      3.29 kB │ gzip: 1.20 kB
+ℹ [ESM] dist/index.d.mts      3.29 kB │ gzip: 1.21 kB
 ℹ [ESM] 4 files, total: 10.76 kB
-✔ Build complete in 5076ms
 ℹ [CJS] dist/index.d.cts.map  0.54 kB │ gzip: 0.29 kB
 ℹ [CJS] dist/index.d.cts      3.29 kB │ gzip: 1.20 kB
 ℹ [CJS] 2 files, total: 3.83 kB
-✔ Build complete in 5077ms
+✔ Build complete in 1867ms
+✔ Build complete in 1865ms

package/README.md

@@ -1,6 +1,6 @@
 # @uploadista/flow-security-nodes
 
-Security processing nodes for Uploadista Flow, including virus scanning and malware detection.
+Security processing nodes for Uploadista flows. Includes virus scanning and malware detection.
 
 ## Installation
 
@@ -8,74 +8,94 @@ Security processing nodes for Uploadista Flow, including virus scanning and malw
 npm install @uploadista/flow-security-nodes
 # or
 pnpm add @uploadista/flow-security-nodes
-# or
-yarn add @uploadista/flow-security-nodes
 ```
 
-## Features
+## Quick Start
 
-- **Virus Scanning**: Scan files for viruses and malware using pluggable antivirus engines
-- **Configurable Actions**: Choose to fail flow or continue with metadata on virus detection
-- **Effect-based**: Built on Effect-TS for type-safe, composable error handling
-- **Plugin Architecture**: Support for multiple antivirus engines (ClamAV, cloud services, etc.)
+```typescript
+import { createScanVirusNode } from "@uploadista/flow-security-nodes";
+```
 
-## Available Nodes
+## Node Types
 
 ### Scan Virus Node
 
-Scans files for viruses and malware. Requires a `VirusScanPlugin` implementation (e.g., `@uploadista/flow-security-clamscan`).
-
-#### Usage
+Scan files for viruses and malware using ClamAV.
 
 ```typescript
 import { createScanVirusNode } from "@uploadista/flow-security-nodes";
-import { Effect } from "effect";
 
-const program = Effect.gen(function* () {
-  // Create a scan virus node that fails on detection
-  const scanNode = yield* createScanVirusNode("virus-scan-1", {
-    action: "fail", // Stop flow if virus detected
-    timeout: 60000, // 60 second timeout
-  });
-
-  // Or create a node that passes with metadata
-  const auditNode = yield* createScanVirusNode("virus-scan-2", {
-    action: "pass", // Continue flow even if virus detected
-    timeout: 120000, // 2 minute timeout for large files
-  });
+// Fail flow if virus detected (recommended for production)
+const scanNode = yield* createScanVirusNode("scan-1", {
+  action: "fail",
+  timeout: 60000,
+});
+
+// Continue with metadata (useful for logging/auditing)
+const auditNode = yield* createScanVirusNode("scan-2", {
+  action: "pass",
+  timeout: 120000,
+});
+
+// With keepOutput option
+const keepOutputNode = yield* createScanVirusNode("scan-3", {
+  action: "fail",
+}, {
+  keepOutput: true,
 });
 ```
 
 #### Parameters
 
-- `id` (required): Unique node identifier
-- `params` (optional): Configuration object
-  - `action`: `"fail"` | `"pass"` (default: `"fail"`)
-    - `"fail"`: Mark flow task as FAILED and stop processing when virus detected
-    - `"pass"`: Continue processing but add virus metadata to file
-  - `timeout`: Maximum scan time in milliseconds (default: 60000, max: 300000)
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `action` | `"fail" \| "pass"` | No | `"fail"` | Action when virus detected |
+| `timeout` | `number` (1000-300000) | No | `60000` | Max scan time in milliseconds |
+
+#### Options
 
-#### Scan Metadata
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `keepOutput` | `boolean` | `false` | Keep output in flow results |
+
+#### Actions
+
+| Action | Description |
+|--------|-------------|
+| `fail` | Stop flow execution when virus detected (recommended for production) |
+| `pass` | Continue processing with detection metadata (useful for logging/auditing) |
+
+#### Scan Results Metadata
 
 All scan results are stored in `file.metadata.virusScan`:
 
 ```typescript
 type VirusScanMetadata = {
-  scanned: boolean; // Whether file was scanned
-  isClean: boolean; // Whether file is clean (no viruses)
+  scanned: boolean;        // Whether file was scanned
+  isClean: boolean;        // Whether file is clean (no viruses)
   detectedViruses: string[]; // Array of detected virus names
-  scanDate: string; // ISO 8601 timestamp
-  engineVersion: string; // Antivirus engine version
+  scanDate: string;        // ISO 8601 timestamp
+  engineVersion: string;   // Antivirus engine version
   definitionsDate: string; // Virus definitions date
 };
 ```
 
-#### Example Flow
+#### Error Codes
+
+| Error Code | Description |
+|------------|-------------|
+| `VIRUS_DETECTED` | Malware found in file (when action=fail) |
+| `CLAMAV_NOT_INSTALLED` | ClamAV not available on system |
+| `VIRUS_SCAN_FAILED` | Generic scanning operation failure |
+| `SCAN_TIMEOUT` | Scanning exceeded timeout limit |
+
+## Example Flow
 
 ```typescript
 import { createFlow } from "@uploadista/core/flow";
 import { createScanVirusNode } from "@uploadista/flow-security-nodes";
 import { ClamScanPluginLayer } from "@uploadista/flow-security-clamscan";
+import { Effect } from "effect";
 
 const secureUploadFlow = createFlow({
   nodes: [
@@ -83,13 +103,13 @@ const secureUploadFlow = createFlow({
     createInputNode("input-1"),
 
     // 2. Scan for viruses - fail if infected
-    createScanVirusNode("scan-1", {
+    yield* createScanVirusNode("scan-1", {
       action: "fail",
       timeout: 60000,
     }),
 
     // 3. Process clean files
-    createImageResizeNode("resize-1", {
+    yield* createResizeNode("resize-1", {
       width: 1920,
       height: 1080,
     }),
@@ -107,22 +127,12 @@ const secureUploadFlow = createFlow({
 }).pipe(Effect.provide(ClamScanPluginLayer()));
 ```
 
-## Error Codes
-
-The scan virus node may return the following error codes:
-
-- `VIRUS_DETECTED`: Virus or malware detected in file (when `action: "fail"`)
-- `VIRUS_SCAN_FAILED`: Generic scanning operation failure
-- `CLAMAV_NOT_INSTALLED`: ClamAV or configured antivirus not available
-- `SCAN_TIMEOUT`: Scanning exceeded timeout limit
-
 ## Requirements
 
-This package requires a `VirusScanPlugin` implementation. See [@uploadista/flow-security-clamscan](../clamscan) for ClamAV support.
-
-## TypeScript
+- **VirusScanPlugin**: Required for scanning (e.g., `@uploadista/flow-security-clamscan`)
+- ClamAV installed on the system (daemon or binary)
 
-This package is written in TypeScript and includes full type definitions.
+See [@uploadista/flow-security-clamscan](../clamscan) for ClamAV plugin setup.
 
 ## License
 

package/dist/index.d.cts

@@ -83,7 +83,7 @@ declare function createScanVirusNode(id: string, params?: ScanVirusParams, optio
   circuitBreaker?: _uploadista_core_flow0.FlowCircuitBreakerConfig;
 } & {
   type: _uploadista_core_flow0.NodeType;
-}, _uploadista_core_errors0.UploadistaError, VirusScanPlugin | _uploadista_core_upload0.UploadServer>;
+}, _uploadista_core_errors0.UploadistaError, VirusScanPlugin | _uploadista_core_upload0.UploadEngine>;
 //#endregion
 export { ScanAction, type ScanAction as ScanActionType, type ScanMetadata, type ScanResult, ScanVirusParams, type ScanVirusParams as ScanVirusParamsType, createScanVirusNode };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/scan-virus-node.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;cAaa,YAAU,CAAA,CAAA;;;AAAvB,CAAA,CAAA;AACY,KAAA,UAAA,GAAa,CAAA,CAAE,KAAa,CAAA,OAAA,UAAR,CAAA;AAKhC;;;cAAa,iBAAe,CAAA,CAAA;;;;EAAA,CAAA,CAAA,CAAA;EAAA,OAAA,cAAA,cAAA,YAAA,CAAA,CAAA;AAgB5B,CAAA,eAAY,CAAA;AA8BI,KA9BJ,eAAA,GAAkB,CAAA,CAAE,KA8BG,CAAA,OA9BU,eA8BV,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAnB,mBAAA,sBAEN;;IAC0B,MAAA,CAAA,OAD0B,sBAAA,CAC1B,YAAA;yBAAA,uBAAA,CAAA,UAAA;;;;;;;aAqEug8L;;iEAAA,uBAAA,CAAA,UAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/scan-virus-node.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;cAaa,YAAU,CAAA,CAAA;;;AAAvB,CAAA,CAAA;AACY,KAAA,UAAA,GAAa,CAAA,CAAE,KAAa,CAAA,OAAA,UAAR,CAAA;AAKhC;;;cAAa,iBAAe,CAAA,CAAA;;;;EAAA,CAAA,CAAA,CAAA;EAAA,OAAA,cAAA,cAAA,YAAA,CAAA,CAAA;AAgB5B,CAAA,eAAY,CAAA;AA8BI,KA9BJ,eAAA,GAAkB,CAAA,CAAE,KA8BG,CAAA,OA9BU,eA8BV,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAnB,mBAAA,sBAEN;;IAC0B,MAAA,CAAA,OAD0B,sBAAA,CAC1B,YAAA;yBAAA,uBAAA,CAAA,UAAA;;;;;;;aAqE2l1M;;iEAAA,uBAAA,CAAA,UAAA"}

package/dist/index.d.mts

@@ -83,7 +83,7 @@ declare function createScanVirusNode(id: string, params?: ScanVirusParams, optio
   circuitBreaker?: _uploadista_core_flow0.FlowCircuitBreakerConfig;
 } & {
   type: _uploadista_core_flow0.NodeType;
-}, _uploadista_core_errors0.UploadistaError, VirusScanPlugin | _uploadista_core_upload0.UploadServer>;
+}, _uploadista_core_errors0.UploadistaError, VirusScanPlugin | _uploadista_core_upload0.UploadEngine>;
 //#endregion
 export { ScanAction, type ScanAction as ScanActionType, type ScanMetadata, type ScanResult, ScanVirusParams, type ScanVirusParams as ScanVirusParamsType, createScanVirusNode };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/scan-virus-node.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;cAaa,YAAU,CAAA,CAAA;;;AAAvB,CAAA,CAAA;AACY,KAAA,UAAA,GAAa,CAAA,CAAE,KAAa,CAAA,OAAA,UAAR,CAAA;AAKhC;;;cAAa,iBAAe,CAAA,CAAA;;;;EAAA,CAAA,CAAA,CAAA;EAAA,OAAA,cAAA,cAAA,YAAA,CAAA,CAAA;AAgB5B,CAAA,eAAY,CAAA;AA8BI,KA9BJ,eAAA,GAAkB,CAAA,CAAE,KA8BG,CAAA,OA9BU,eA8BV,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAnB,mBAAA,sBAEN;;IAC0B,MAAA,CAAA,OAD0B,sBAAA,CAC1B,YAAA;yBAAA,uBAAA,CAAA,UAAA;;;;;;;aAqEug8L;;iEAAA,uBAAA,CAAA,UAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/scan-virus-node.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;cAaa,YAAU,CAAA,CAAA;;;AAAvB,CAAA,CAAA;AACY,KAAA,UAAA,GAAa,CAAA,CAAE,KAAa,CAAA,OAAA,UAAR,CAAA;AAKhC;;;cAAa,iBAAe,CAAA,CAAA;;;;EAAA,CAAA,CAAA,CAAA;EAAA,OAAA,cAAA,cAAA,YAAA,CAAA,CAAA;AAgB5B,CAAA,eAAY,CAAA;AA8BI,KA9BJ,eAAA,GAAkB,CAAA,CAAE,KA8BG,CAAA,OA9BU,eA8BV,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAnB,mBAAA,sBAEN;;IAC0B,MAAA,CAAA,OAD0B,sBAAA,CAC1B,YAAA;yBAAA,uBAAA,CAAA,UAAA;;;;;;;aAqE2l1M;;iEAAA,uBAAA,CAAA,UAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uploadista/flow-security-nodes",
   "type": "module",
-  "version": "0.0.20-beta.7",
+  "version": "0.0.20-beta.8",
   "description": "Security processing nodes for Uploadista Flow",
   "license": "MIT",
   "author": "Uploadista",
@@ -14,7 +14,7 @@
     }
   },
   "dependencies": {
-    "@uploadista/core": "0.0.20-beta.7"
+    "@uploadista/core": "0.0.20-beta.8"
   },
   "peerDependencies": {
     "effect": "^3.0.0",
@@ -22,15 +22,15 @@
   },
   "devDependencies": {
     "@effect/vitest": "0.27.0",
-    "@types/node": "24.10.3",
-    "effect": "3.19.11",
-    "tsdown": "0.17.2",
+    "@types/node": "24.10.4",
+    "effect": "3.19.12",
+    "tsdown": "0.18.0",
     "vitest": "4.0.15",
-    "zod": "4.1.13",
-    "@uploadista/typescript-config": "0.0.20-beta.7"
+    "zod": "4.2.0",
+    "@uploadista/typescript-config": "0.0.20-beta.8"
   },
   "scripts": {
-    "build": "tsdown",
+    "build": "tsc --noEmit && tsdown",
     "format": "biome format --write ./src",
     "lint": "biome lint --write ./src",
     "check": "biome check --write ./src",