pompelmi 0.17.0-dev.36 → 0.17.0

package/README.md

@@ -33,6 +33,7 @@
   <img alt="node" src="https://img.shields.io/badge/node-%3E%3D18-339933?logo=node.js&logoColor=white">
   <img alt="types" src="https://img.shields.io/badge/types-TypeScript-3178C6?logo=typescript&logoColor=white">
   <a href="https://github.com/pompelmi/pompelmi/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/npm/l/pompelmi"></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>
     <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>
   <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/actions/workflows/ci-release-publish.yml"><img alt="CI / Release / Publish" src="https://img.shields.io/github/actions/workflow/status/pompelmi/pompelmi/ci-release-publish.yml?branch=main&label=CI%20%2F%20Release%20%2F%20Publish"></a>
@@ -45,6 +46,7 @@
 <p align="center"><a href="https://pompelmi.github.io/pompelmi/">Documentation</a> ·
   <a href="#installation">Install</a> ·
   <a href="#quick-start">Quick‑start</a> ·
+  <a href="#minimal-node-usage">Minimal Node</a> ·
   <a href="#github-action">GitHub Action</a> ·
   <a href="#adapters">Adapters</a> ·
   <a href="#diagrams">Diagrams</a> ·
@@ -65,6 +67,7 @@
 
 - [Install](#installation)
 - [Quick‑start](#quick-start)
+- [Minimal Node usage](#minimal-node-usage)
 - [GitHub Action](#github-action)
 - [Adapters](#adapters)
 - [Diagrams](#diagrams)
@@ -131,7 +134,6 @@
 
 ```bash
 # core library
-[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/pompelmi/pompelmi/badge)](https://securityscorecards.dev/viewer/?uri=github.com/pompelmi/pompelmi)
 npm i pompelmi
 # or
 pnpm add pompelmi
@@ -175,6 +177,21 @@ export const scanner = composeScanners(
 );
 ```
 
+### Minimal Node usage
+
+```ts
+import { scanFile } from 'pompelmi';
+
+const res = await scanFile('path/to/file.zip'); // or any file
+console.log(res.verdict); // "clean" | "suspicious" | "malicious"
+```
+
+> See `examples/scan-one-file.ts` for a runnable script:
+>
+> ```bash
+> pnpm tsx examples/scan-one-file.ts ./path/to/file
+> ```
+
 ### Express
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pompelmi",
-  "version": "0.17.0-dev.36",
+  "version": "0.17.0",
   "description": "RFI-safe file uploads for Node.js — Express/Koa/Next.js middleware with deep ZIP inspection, MIME/size checks, and optional YARA scanning.",
   "main": "./dist/pompelmi.cjs",
   "module": "./dist/pompelmi.esm.js",
@@ -56,13 +56,14 @@
     "repo:audit": "node scripts/audit.mjs",
     "pack:check": "node scripts/pack-check.mjs",
     "pack:list": "pnpm -r --filter \"@pompelmi/*\" --if-present pack --json --dry-run",
-    "pack:strict": "node scripts/pack-check.mjs --strict"
+    "pack:strict": "node scripts/pack-check.mjs --strict",
+    "clean": "rimraf dist"
   },
   "license": "MIT",
   "devDependencies": {
     "@biomejs/biome": "^2.2.4",
     "@pompelmi/core": "workspace:*",
-    "@pompelmi/engine": "workspace:0.17.0-dev.36-dev.6",
+    "@pompelmi/engine": "workspace:0.17.0-dev.6",
     "@pompelmi/engine-heuristics": "workspace:^0.1.0",
     "@rollup/plugin-commonjs": "^28.0.6",
     "@rollup/plugin-node-resolve": "^16.0.1",
@@ -80,7 +81,7 @@
     "gh-pages": "^6.3.0",
     "knip": "^5.64.0",
     "multer": "^2.0.2",
-    "react": "^18.0.0",
+    "react": "^19.2.0",
     "rollup": "^4.x",
     "ts-prune": "^0.10.3",
     "tslib": "^2.8.1",
@@ -100,7 +101,12 @@
     "@litko/yara-x": "^0.2.1"
   },
   "exports": {
-    ".": {},
+    ".": {
+      "import": "./dist/pompelmi.esm.js",
+      "require": "./dist/pompelmi.cjs",
+      "default": "./dist/pompelmi.esm.js",
+      "types": "./dist/types/index.d.ts"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -109,7 +115,8 @@
     "README.md",
     "LICENSE*",
     "package.json",
-    "CHANGELOG*"
+    "CHANGELOG*",
+    "LICENSE"
   ],
   "keywords": [
     "security",
@@ -151,5 +158,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "types": "./dist/types/index.d.ts"
 }

package/dist/index.cjs.js

@@ -1,86 +0,0 @@
-'use strict';
-
-var react = require('react');
-
-/**
- * Reads an array of File objects via FileReader and returns their text.
- */
-async function scanFiles(files) {
-  const readText = file => new Promise((resolve, reject) => {
-    const reader = new FileReader();
-    reader.onload = () => resolve(reader.result);
-    reader.onerror = () => reject(reader.error);
-    reader.readAsText(file);
-  });
-  const results = [];
-  for (const file of files) {
-    const content = await readText(file);
-    results.push({
-      file,
-      content
-    });
-  }
-  return results;
-}
-
-/**
- * Validates a File by MIME type and size (max 5 MB).
- */
-function validateFile(file) {
-  const maxSize = 5 * 1024 * 1024;
-  const allowedTypes = ['text/plain', 'application/json', 'text/csv'];
-  if (!allowedTypes.includes(file.type)) {
-    return {
-      valid: false,
-      error: 'Unsupported file type'
-    };
-  }
-  if (file.size > maxSize) {
-    return {
-      valid: false,
-      error: 'File too large (max 5 MB)'
-    };
-  }
-  return {
-    valid: true
-  };
-}
-
-/**
- * React Hook: handles <input type="file" onChange> with validation + scanning.
- */
-function useFileScanner() {
-  const [results, setResults] = react.useState([]);
-  const [errors, setErrors] = react.useState([]);
-  const onChange = react.useCallback(async e => {
-    const fileList = Array.from(e.target.files || []);
-    const good = [];
-    const bad = [];
-    for (const file of fileList) {
-      const {
-        valid,
-        error
-      } = validateFile(file);
-      if (valid) good.push(file);else bad.push({
-        file,
-        error: error
-      });
-    }
-    setErrors(bad);
-    if (good.length) {
-      const scanned = await scanFiles(good);
-      setResults(scanned);
-    } else {
-      setResults([]);
-    }
-  }, []);
-  return {
-    results,
-    errors,
-    onChange
-  };
-}
-
-exports.scanFiles = scanFiles;
-exports.useFileScanner = useFileScanner;
-exports.validateFile = validateFile;

package/dist/index.esm.js

@@ -1,82 +0,0 @@
-import { useState, useCallback } from 'react';
-
-/**
- * Reads an array of File objects via FileReader and returns their text.
- */
-async function scanFiles(files) {
-  const readText = file => new Promise((resolve, reject) => {
-    const reader = new FileReader();
-    reader.onload = () => resolve(reader.result);
-    reader.onerror = () => reject(reader.error);
-    reader.readAsText(file);
-  });
-  const results = [];
-  for (const file of files) {
-    const content = await readText(file);
-    results.push({
-      file,
-      content
-    });
-  }
-  return results;
-}
-
-/**
- * Validates a File by MIME type and size (max 5 MB).
- */
-function validateFile(file) {
-  const maxSize = 5 * 1024 * 1024;
-  const allowedTypes = ['text/plain', 'application/json', 'text/csv'];
-  if (!allowedTypes.includes(file.type)) {
-    return {
-      valid: false,
-      error: 'Unsupported file type'
-    };
-  }
-  if (file.size > maxSize) {
-    return {
-      valid: false,
-      error: 'File too large (max 5 MB)'
-    };
-  }
-  return {
-    valid: true
-  };
-}
-
-/**
- * React Hook: handles <input type="file" onChange> with validation + scanning.
- */
-function useFileScanner() {
-  const [results, setResults] = useState([]);
-  const [errors, setErrors] = useState([]);
-  const onChange = useCallback(async e => {
-    const fileList = Array.from(e.target.files || []);
-    const good = [];
-    const bad = [];
-    for (const file of fileList) {
-      const {
-        valid,
-        error
-      } = validateFile(file);
-      if (valid) good.push(file);else bad.push({
-        file,
-        error: error
-      });
-    }
-    setErrors(bad);
-    if (good.length) {
-      const scanned = await scanFiles(good);
-      setResults(scanned);
-    } else {
-      setResults([]);
-    }
-  }, []);
-  return {
-    results,
-    errors,
-    onChange
-  };
-}
-
-export { scanFiles, useFileScanner, validateFile };