Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/observability / redaction/patterns
redaction/patterns
Built-in PII / secret detection patterns. The catalogue is intentionally conservative — every pattern has both positive and negative test fixtures and is documented so operators understand exactly what is matched.
The catalogue is split into two groups:
- secret — credentials, API tokens, JWTs, private keys. Matches are always dropped + counted, regardless of the configured tier floor.
- pii — email / phone / IBAN / credit card / SSN / IP address. Subject to the configured tier floor + per-pattern enable / disable knobs.
Interfaces
| Interface | Description |
|---|---|
| RedactionPattern | One entry in the redaction catalogue. |
Type Aliases
| Type Alias | Description |
|---|---|
| BuiltInPatternName | Stable pattern identifier. The catalogue is curated; user-supplied patterns can use any identifier they want and will be passed through the validator in addition to the built-ins. |
| PatternCategory | Pattern category — secret matches always force a drop; pii matches respect the configured enabledPatterns allow-list. |
Variables
| Variable | Description |
|---|---|
| ALL_BUILT_IN_PATTERNS | Full registry — for tooling that wants to introspect every pattern the framework knows about (e.g. CLI graphorin redaction list). |
| BUILT_IN_PATTERNS | The 14 default-on built-in patterns (the IPv4 and IPv6 detectors are opt-in and live in OPT_IN_PATTERNS). |
| OPT_IN_PATTERNS | Patterns that are recognised by the validator but are NOT enabled by default. Use them via patterns: [...BUILT_IN_PATTERNS, ...OPT_IN_PATTERNS]. |