tpmjs/packages/tools/official/data-classification-heuristic
Ajax Davis 5d2096fb5d feat: add 100+ official TPMJS tools
Implements a comprehensive suite of AI SDK v6 tools across multiple categories:

- Research (5): page-brief, compare-pages, source-credibility, claim-checklist, timeline-from-text
- Web (10): fetch-text, links-catalog, extract-meta, extract-json-ld, redirect-trace, sitemap-read, rss-read, table-extract, robots-policy, url-normalize
- Data (15): csv-parse, csv-stringify, json-repair, json-schema-validate, yaml-parse, yaml-stringify, text-chunk, normalize-whitespace, dedupe-by-key, pivot, rows-filter, rows-sort, rows-group-aggregate, rows-join, schema-infer
- Doc (12): toc-generate, glossary-build, faq-from-text, executive-brief, decision-record-adr, prd-outline, acceptance-criteria, style-rewrite
- Eng (12): diff-text-unified, env-var-docs-generate, dependency-audit-lite, conventional-commit-suggest, markdown-lint-basic, test-case-generate, stacktrace-parse, release-notes, changelog-entry, release-checklist
- Security (7): redact-secrets, secret-scan-text, url-risk-heuristic, csp-compose, hardening-checklist-web, access-control-matrix, data-classification-heuristic
- Stats (9): effect-size-suite, bootstrap-ci, permutation-test, multiple-testing-adjust, linear-regression-ols, logistic-regression, time-series-decompose-lite, anomaly-detect-mad
- Ops (7): slo-draft, runbook-draft, postmortem-draft, postmortem-action-extractor, error-log-triage, coverage-tracker, monitoring-gap-analysis
- Agent (15): prompt-to-workflow-skeleton, workflow-validate-io, workflow-explain, workflow-cost-estimate, tool-call-accuracy-score, eval-fixture-build, guardrail-policy-draft, workflow-auto-repair, tool-selection-plan, novelty-score-workflow, workflow-variant-generate, config-normalize, recipe-*
- Utility (8): base64-encode, base64-decode, hash-text, regex-extract, template-render, date-parse, json-path-query, url-parse
- HTML (3): html-sanitize, html-to-markdown, markdown-to-html

All tools follow AI SDK v6 pattern with tool() and jsonSchema<T>().

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-31 22:55:56 +10:00
..
src feat: add 100+ official TPMJS tools 2025-12-31 22:55:56 +10:00
package.json feat: add 100+ official TPMJS tools 2025-12-31 22:55:56 +10:00
README.md feat: add 100+ official TPMJS tools 2025-12-31 22:55:56 +10:00
tsconfig.json feat: add 100+ official TPMJS tools 2025-12-31 22:55:56 +10:00
tsup.config.ts feat: add 100+ official TPMJS tools 2025-12-31 22:55:56 +10:00

Data Classification Heuristic Tool

Classifies data sensitivity using pattern-based heuristics to detect PII, financial data, health data, and other sensitive information.

Installation

npm install @tpmjs/tools-data-classification-heuristic

Usage

import { dataClassificationHeuristic } from '@tpmjs/tools-data-classification-heuristic';

const result = await dataClassificationHeuristic.execute({
  text: "Contact John Doe at john.doe@example.com or call 555-123-4567. SSN: 123-45-6789"
});

console.log(result);
// {
//   classification: 'restricted',
//   signals: [
//     { type: 'Email', severity: 'medium', description: 'Email address detected', matches: 1 },
//     { type: 'Phone', severity: 'medium', description: 'Phone number detected', matches: 1 },
//     { type: 'SSN', severity: 'critical', description: 'Social Security Number detected', matches: 1 }
//   ],
//   confidence: 0.8,
//   summary: {
//     totalSignals: 3,
//     highestSeverity: 'critical',
//     categories: ['PII']
//   }
// }

Classification Levels

  • public - No sensitive data detected, safe for public distribution
  • internal - Low-medium sensitivity data, internal use only
  • confidential - High sensitivity data, restricted distribution
  • restricted - Critical data (SSN, credentials, financial), highly restricted

Detected Patterns

PII (Personal Identifiable Information)

  • Social Security Numbers (SSN)
  • Email addresses
  • Phone numbers
  • Dates of birth
  • Physical addresses

Financial Data

  • Credit card numbers
  • Bank account numbers
  • Routing numbers
  • Salary information

Health Data (HIPAA)

  • Medical record numbers
  • Diagnoses
  • Prescriptions

Government IDs

  • Passport numbers
  • Driver license numbers

Authentication

  • API keys
  • Passwords
  • Access tokens

Technical

  • IP addresses

Output Schema

interface DataClassification {
  classification: 'public' | 'internal' | 'confidential' | 'restricted';
  signals: Array<{
    type: string;
    pattern: string;
    severity: 'low' | 'medium' | 'high' | 'critical';
    description: string;
    matches?: number;
  }>;
  confidence: number; // 0-1 scale
  summary: {
    totalSignals: number;
    highestSeverity: string;
    categories: string[];
  };
}

Use Cases

  • Data Loss Prevention (DLP) - Scan documents before sharing
  • Compliance Auditing - Identify sensitive data in databases
  • Email Filtering - Classify email content sensitivity
  • Document Review - Automatically classify documents for access control
  • Privacy Impact Assessment - Detect PII in data processing activities

Limitations

  • Heuristic-based detection (pattern matching only)
  • May produce false positives (e.g., random number sequences)
  • Does not understand context or semantic meaning
  • Should be used as a first-pass filter, not definitive classification
  • Cannot detect all types of sensitive data (e.g., trade secrets require domain knowledge)

License

MIT