@ossredact/core

Tier-0 deterministic PII detector and span/redaction core for OSSRedact.

Pure TypeScript, browser-safe, zero runtime dependencies.

What is in this package

• Tier-0 detector (tier0Spans, contextCuedIdSpans) -- regex + checksum-validated patterns for emails, phone numbers, SIN/SSN, credit cards, IBANs, passport numbers, IP addresses, dates, and more.
• Span management (mergeSpans, toSpans, insertSpan, combineWithManual) -- overlap resolution and manual annotation support.
• Redaction primitives (redactedText, rehydrate, explain, buildEntityMap) -- placeholder substitution, repeated-value sweep, round-trip rehydration, and entity-map construction.
• Label metadata (labelMeta, labelTier, MANUAL_LABELS) -- tier classification and display names for all entity types.

Install

npm install @ossredact/core

Usage

import { tier0Spans, toSpans, redactedText, buildEntityMap, rehydrate } from '@ossredact/core'

const text = 'Call 514-555-0199 or [email protected]'
const spans = toSpans(tier0Spans(text), 'auto')
const { map } = buildEntityMap(text, spans)
const redacted = redactedText(text, spans)
// "Call <PHONE_NUMBER_001> or <EMAIL_001>"

const restored = rehydrate(redacted, map)
// "Call 514-555-0199 or [email protected]"

Build

npm run build   # emits dist/ via tsup (ESM + .d.ts)

Test

npm test        # vitest run (unit tests: tier0, redaction, parity, allow/denylist)

License

MIT