pii-sanitizer-js 1.0.0

package/README.md

@@ -0,0 +1,52 @@
+# PII Sanitizer JS
+
+![Bun](https://img.shields.io/badge/Bun-%23000000.svg?style=for-the-badge&logo=bun&logoColor=white)
+[![npm version](https://img.shields.io/npm/v/pii-sanitizer-js.svg?style=flat-square)](https://www.npmjs.com/package/pii-sanitizer-js)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+
+A lightweight, high-performance utility for **detecting and anonymizing Personally Identifiable Information (PII)** in text.
+
+Originally designed to sanitize prompts before they are sent to AI models (LLMs) or to clean log files before they are shared.
+
+## Features
+
+* **Smart Detection**: Identifies emails, credit cards, IPv4 addresses, and phone numbers.
+* **Developed with Bun**: Take advantage of the speed of the most modern runtime.
+* **Dual Interface**: Use it as a library in your code or as a CLI tool in your terminal.
+* **No Dependencies**: Native, lightweight, and secure code.
+
+## Installation
+
+You can install it using NPM or Bun:
+
+```bash
+# Using NPM
+npm install pii-sanitizer-js
+
+# Using Bun
+bun add pii-sanitizer-js
+```
+
+## Usage
+As a Library (API)
+Ideal for integrating into your Node.js applications or backend processes.
+
+```javascript
+import { sanitize } from ‘pii-sanitizer-js’;
+
+const text = “Contact admin@mail.com or call +1 555-0199.”;
+const sanitized = sanitize(text);
+
+console.log(sanitized); 
+// Output: “Contact [HIDDEN_EMAIL] or call [HIDDEN_PHONE].”
+```
+
+## Why this project
+
+This project arose from the need to protect data privacy when interacting with third-party services and Artificial Intelligence APIs. It demonstrates the implementation of advanced regular expressions and data flow management in Node.js/Bun environments.
+
+## Author
+
+* **Zenzzj**:
+  * Github: [@Zenzzj](https://github.com/zenzzj)
+  * Discord: zen_xp

package/bin/cli.js

@@ -0,0 +1,23 @@
+import { sanitize } from '../src/index.js';
+import readline from 'readline';
+
+const rl = readline.createInterface({input: process.stdin, output: process.stdout, terminal: false});
+
+console.log('Prompt Sanitizer');
+console.log('Paste or type your text here to clean it up: ')
+let input = '';
+
+rl.on('line', (line) => {
+  if (line.trim() === '') {
+  	rl.close();
+  	return;
+  }
+  input += line + '\n'
+});
+
+rl.on('close', () => {
+  const result = sanitize(input);
+  console.log('\nSanitized Content');
+  console.log(result);
+  process.exit(0);
+});

package/bun.lock

@@ -0,0 +1,26 @@
+{
+  "lockfileVersion": 1,
+  "configVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "pii-sanitizer",
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+      "peerDependencies": {
+        "typescript": "^5",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/bun@1.3.5", "", { "dependencies": { "bun-types": "1.3.5" } }, "sha512-RnygCqNrd3srIPEWBd5LFeUYG7plCoH2Yw9WaZGyNmdTEei+gWaHqydbaIRkIkcbXwhBT94q78QljxN0Sk838w=="],
+
+    "@types/node": ["@types/node@25.0.3", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-W609buLVRVmeW693xKfzHeIV6nJGGz98uCPfeXI1ELMLXVeKYZ9m15fAMSaUPBHYLGFsVRcMmSCksQOrZV9BYA=="],
+
+    "bun-types": ["bun-types@1.3.5", "", { "dependencies": { "@types/node": "*" } }, "sha512-inmAYe2PFLs0SUbFOWSVD24sg1jFlMPxOjOSSCYqUgn4Hsc3rDc7dFvfVYjFPNHtov6kgUeulV4SxbuIV/stPw=="],
+
+    "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
+
+    "undici-types": ["undici-types@7.16.0", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],
+  }
+}

package/index.js

@@ -0,0 +1,38 @@
+const PATTERNS = {
+	EMAIL: /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g,
+ 	CREDIT_CARD: /\b(?:\d[ -]*?){13,16}\b/g,
+  	IPV4: /\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/g,
+  	PHONE: /\b(?:\+?\d{1,3}[- ]?)?\(?\d{3}\)?[- ]?\d{3}[- ]?\d{4}\b/g
+}
+
+export function sanitize(text) {
+	let sanitizedText = text;
+
+	for (const [key, pattern] of Object.entries(PATTERNS)) {
+		sanitizedText = sanitizedText.replace(pattern, `[HIDDEN_${key}]`);
+	}
+
+	return sanitizedText
+}
+
+import readline from 'readline';
+const rl = readline.createInterface({input: process.stdin, output: process.stdout, terminal: false});
+
+console.log('Prompt Sanitizer');
+console.log('Paste or type your text here to clean it up: ')
+let input = '';
+
+rl.on('line', (line) => {
+  if (line.trim() === '') {
+  	rl.close();
+  	return;
+  }
+  input += line + '\n'
+});
+
+rl.on('close', () => {
+  const result = sanitize(input);
+  console.log('\nSanitized Content');
+  console.log(result);
+  process.exit(0);
+});

package/jsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "pii-sanitizer-js", 
+  "version": "1.0.0",
+  "description": "A lightweight utility to sanitize PII from strings and prompts.",
+  "main": "src/index.js",
+  "type": "module",
+  "bin": {
+    "pii-sanitize": "bin/cli.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["privacy", "pii", "sanitizer", "security", "nlp"],
+  "author": "Zen_xP",
+  "license": "MIT"
+}

package/src/index.js

@@ -0,0 +1,15 @@
+import { PATTERNS } from './patterns.js';
+
+export function sanitize(text, options = {}) {
+    if (typeof text !== 'string') return '';
+    
+    let sanitizedText = text;
+    const { placeholders = {} } = options;
+
+    for (const [key, pattern] of Object.entries(PATTERNS)) {
+        const label = placeholders[key] || `[HIDDEN_${key}]`;
+        sanitizedText = sanitizedText.replace(pattern, label);
+    }
+
+    return sanitizedText;
+}

package/src/patterns.js

@@ -0,0 +1,6 @@
+export const PATTERNS = {
+    EMAIL: /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g,
+    CREDIT_CARD: /\b(?:\d[ -]*?){13,16}\b/g,
+    IPV4: /\b(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/g,
+    PHONE: /\b(?:\+?\d{1,3}[- ]?)?\(?\d{3}\)?[- ]?\d{3}[- ]?\d{4}\b/g
+};