yahdlp/sms/README.md

Enterprise-grade PII detection and redaction tool by Yahya Enterprises

# PII Detection and Redaction Examples

## Overview
This document demonstrates the usage of PII (Personally Identifiable Information) detection and redaction tools through practical examples.

## Example 1: Phone Number Inspection

### Command
```bash
./index.js inspect -t "+4131313131315" -p
```

### Response
```json
[
  {
    "type": "PHONE",
    "value": "+4131313131315",
    "normalized": "4131313131315"
  }
]
```

## Example 2: Second Phone Number Inspection

### Command
```bash
./index.js inspect -t "+252525252531" -p
```

### Response
```json
[
  {
    "type": "PHONE",
    "value": "+252525252531",
    "normalized": "252525252531"
  }
]
```

## Image Redaction Examples

### Example 1: First Image Attempt

#### Command
```bash
./index.js redact yahAPPROACH.png output.png -p
```

![Approach.](https://raw.githubusercontent.com/yaya2devops/yahdlp/refs/heads/main/redact/yahAPPROACH.png)

#### Response
```plaintext
(node:9300) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
No matching PII found
```

### Example 2: Second Image Attempt

#### Command
```bash
./index.js redact sms-wa-test.png output.png -p
```

![DM](https://raw.githubusercontent.com/yaya2devops/yahdlp/refs/heads/main/redact/sms/sms-wa-test.png)


#### Response
```plaintext
(node:6380) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
No matching PII found
```

## Notes
- Commands are executed from the project root directory
- The tool supports both text and image-based PII detection
- Common functionalities:
  - Phone number detection with `-p` flag
  - Image redaction capabilities
  - Text inspection for PII
- Deprecation warnings about `punycode` module can be safely ignored
- Both phone numbers and images are processed using similar command structures