secure-redact 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -11
- package/dist/secure-redact.es.js +8622 -7027
- package/dist/secure-redact.es.js.map +1 -1
- package/dist/secure-redact.umd.js +1578 -28
- package/dist/secure-redact.umd.js.map +1 -1
- package/package.json +1 -1
- package/dist/assets/advanced.worker-DSVrF0gl.js +0 -890
- package/dist/assets/nlp.worker-u7Lr_A3c.js +0 -521
- package/dist/assets/ocr.worker-D5s6dY7M.js +0 -139
package/README.md
CHANGED
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Features
|
|
9
9
|
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
10
|
+
- **100% Client-Side** — Documents never leave the browser
|
|
11
|
+
- **AI-Powered** — Uses Tensorflow.js for semantic PII detection with pixel-perfect accuracy
|
|
12
|
+
- **Multi-Layer Detection** — Regex + NLP + Spatial Analysis + Tensorflow.js
|
|
13
|
+
- **PDF & Image Support** — PNG, JPEG, WebP, BMP, and PDF documents
|
|
14
|
+
- **Pixel-Perfect Redaction** — Word-ID based mapping for exact bounding boxes
|
|
15
|
+
- **Review UI** — Interactive modal to review and toggle detections before redacting
|
|
16
|
+
- **Audit Trail** — Evidence log of all detected entities and actions taken
|
|
17
17
|
- 🇮🇳 **Indian Documents** — Built-in support for Aadhaar, PAN, GST, IFSC, etc.
|
|
18
18
|
|
|
19
19
|
## Install
|
|
@@ -48,7 +48,7 @@ function App() {
|
|
|
48
48
|
|
|
49
49
|
return (
|
|
50
50
|
<SecureRedact
|
|
51
|
-
apiKey="your-
|
|
51
|
+
apiKey="your-tensorflow-api-key"
|
|
52
52
|
onComplete={handleComplete}
|
|
53
53
|
/>
|
|
54
54
|
);
|
|
@@ -77,7 +77,7 @@ function App() {
|
|
|
77
77
|
|
|
78
78
|
| Prop | Type | Default | Description |
|
|
79
79
|
|------|------|---------|-------------|
|
|
80
|
-
| `apiKey` | `string` | *required* |
|
|
80
|
+
| `apiKey` | `string` | *required* | Tensorflow.js API key |
|
|
81
81
|
| `onComplete` | `(file, evidence) => void` | *required* | Called when redaction is complete |
|
|
82
82
|
| `requiredFields` | `string[]` | `[]` | PII types to KEEP visible (when not using doc type UI) |
|
|
83
83
|
| `confidenceThreshold` | `number` | `0.5` | Minimum confidence (0-1) for PII detection |
|
|
@@ -133,7 +133,7 @@ Multi-Layer PII Detection:
|
|
|
133
133
|
├── Layer 0: Regex + Checksums (Aadhaar, PAN, CC, Phone)
|
|
134
134
|
├── Layer 1: NLP Heuristics (Names, Addresses, Medical)
|
|
135
135
|
├── Layer 2: Spatial Key-Value Mapping ("Name:" → "John Doe")
|
|
136
|
-
└── Layer 4:
|
|
136
|
+
└── Layer 4: Tensorflow.js Word-ID Detection (pixel-perfect)
|
|
137
137
|
↓
|
|
138
138
|
Interactive Review Modal
|
|
139
139
|
↓
|
|
@@ -163,7 +163,7 @@ interface EvidenceLog {
|
|
|
163
163
|
## Requirements
|
|
164
164
|
|
|
165
165
|
- **React** ≥ 18.0.0
|
|
166
|
-
- **
|
|
166
|
+
- **Tensorflow.js** —
|
|
167
167
|
- **Vite** (recommended) — Workers use `new URL(..., import.meta.url)` syntax
|
|
168
168
|
|
|
169
169
|
## License
|