@pacamelo/core 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pacamelo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# @pacamelo/core
+
+Core PII detection and redaction engine for [PURGE](https://purgedata.app).
+
+## Why Open Source?
+
+This package contains all the code that touches your data. We open-source it so you can verify:
+
+- **What patterns we search for** - See exactly which regex patterns detect PII
+- **How files are parsed** - Verify no data is exfiltrated during processing
+- **How masking works** - Check that sensitive data is properly hidden
+- **Security measures** - Audit ReDoS protection, memory cleanup, etc.
+
+The PURGE UI remains proprietary, but the data-processing core is transparent.
+
+## Installation
+
+```bash
+npm install @pacamelo/core
+```
+
+## What's Included
+
+### Detection Engine
+- Regex patterns for: emails, SSNs, phone numbers, credit cards, addresses, names
+- Configurable sensitivity levels
+- Web Worker isolation for ReDoS protection
+
+### Document Processors
+- XLSX parser with column selection
+- Metadata stripping on output
+- Formula detection warnings
+
+### Utilities
+- PII masking (partial masks, full redaction)
+- Secure random ID generation
+- File type validation via magic bytes
+
+### React Hooks
+- `useDocumentProcessor` - Main processing orchestration
+- `useOfflineEnforcement` - Privacy mode state machine
+- `useFileEntropy` - Before/after verification
+
+## Usage
+
+```typescript
+import {
+  regexDetectionEngine,
+  getProcessorForFile,
+  useDocumentProcessor,
+  type Detection,
+} from '@pacamelo/core';
+
+// Detect PII in text
+const result = await regexDetectionEngine.detect(content, config);
+console.log(result.detections); // Array of Detection objects
+
+// Process a file
+const processor = getProcessorForFile(file);
+const parsed = await processor.parse(file);
+const blob = await processor.applyRedactions(parsed, redactions);
+```
+
+## Security Features
+
+- **ReDoS Protection**: Regex runs in Web Workers with enforced timeouts
+- **Memory Cleanup**: Buffers zeroed after processing (best-effort in JS)
+- **Metadata Stripping**: Output files rebuilt without hidden content
+- **Offline Mode**: Encourages airplane mode during sensitive processing
+
+## License
+
+MIT - See [LICENSE](./LICENSE)
+
+## Contributing
+
+Issues and PRs welcome at [github.com/Pacamelo/purge-core](https://github.com/Pacamelo/purge-core).