field-redactor 1.6.0 → 1.6.2

package/docs/guides/secret-key-modes.md

@@ -1,6 +1,6 @@
 # Secret key modes
 
-FieldRedactor applies **Shallow**, **Deep**, **Opaque**, and **Remove** rules via regex key matching. Throughout the docs, these are the conceptual names; the config fields are `secretKeys`, `deepSecretKeys`, `fullSecretKeys`, and `deleteSecretKeys`.
+FieldRedactor applies **Shallow**, **Deep**, **Opaque**, and **Remove** rules via regex key matching. Throughout the docs, these are the conceptual names; the config fields are `secretKeys`, `deepSecretKeys`, `opaqueSecretKeys`, and `removeSecretKeys` (legacy aliases `fullSecretKeys` / `deleteSecretKeys` still work).
 
 **Precedence** (highest wins): Schema (`customObjects`) → Opaque → Deep → Remove → Shallow → Value-pattern (`valuePatterns`)
 
@@ -20,8 +20,8 @@ Same input for every row:
 | --- | --- | --- | --- |
 | **Shallow** | `secretKeys` | `[/email/]` | `contactInfo.email` → `"REDACTED"`; `city`, `username` unchanged |
 | **Deep** | `deepSecretKeys` | `[/contactInfo/]` | All primitives inside `contactInfo` redacted |
-| **Opaque** | `fullSecretKeys` | `[/contactInfo/]` | Entire `contactInfo` replaced with `"REDACTED"` |
-| **Remove** | `deleteSecretKeys` | `[/authKey/]` | `authKey` key removed from output |
+| **Opaque** | `opaqueSecretKeys` | `[/contactInfo/]` | Entire `contactInfo` replaced with `"REDACTED"` |
+| **Remove** | `removeSecretKeys` | `[/authKey/]` | `authKey` key removed from output |
 
 ### Builder API
 
@@ -74,13 +74,13 @@ await fieldRedactor.redact({
 // → email, id, and other primitives under contactInfo are redacted
 ```
 
-## Opaque (`fullSecretKeys`)
+## Opaque (`opaqueSecretKeys`)
 
 Stringify the entire value at matching keys, then redact. Typical for objects and arrays you want to hide completely.
 
 ```typescript
 const fieldRedactor = new FieldRedactor({
-  fullSecretKeys: [/contactInfo/i]
+  opaqueSecretKeys: [/contactInfo/i]
 });
 
 await fieldRedactor.redact({
@@ -89,20 +89,15 @@ await fieldRedactor.redact({
 // → { contactInfo: "REDACTED" }
 ```
 
-## Remove (`deleteSecretKeys`)
+## Remove (`removeSecretKeys`)
 
 Delete matching keys from the output.
 
 ```typescript
 const fieldRedactor = new FieldRedactor({
-  deleteSecretKeys: [/authKey/i]
+  removeSecretKeys: [/authKey/i]
 });
 
-await fieldRedactor.redact({ userId: 271, appAuthKey: '12345' });
-// → { userId: 271 }
+await fieldRedactor.redact({ authKey: 'secret-token', username: 'alice' });
+// → { username: 'alice' }
 ```
-
-## Related
-
-- [Metadata redaction](metadata-redaction.md) — when sensitivity depends on sibling fields
-- [Configuration reference](../reference/config.md) — all options and API details

package/docs/reference/config.md

@@ -8,8 +8,8 @@
 | — | `syncRedactor` | `(val) => string` | `"REDACTED"` sync | Sync redactor; enables `redactSync()` without per-field Promises |
 | **Shallow** | `secretKeys` | `RegExp[]` | `null` | Redact matching scalar values; if no rules at all, everything matches |
 | **Deep** | `deepSecretKeys` | `RegExp[]` | `[]` | Deeply redact all primitives under matching keys |
-| **Opaque** | `fullSecretKeys` | `RegExp[]` | `[]` | Stringify and redact entire values |
-| **Remove** | `deleteSecretKeys` | `RegExp[]` | `[]` | Delete matching keys |
+| **Opaque** | `opaqueSecretKeys` | `RegExp[]` | `[]` | Stringify and redact entire values (legacy alias: `fullSecretKeys`) |
+| **Remove** | `removeSecretKeys` | `RegExp[]` | `[]` | Delete matching keys (legacy alias: `deleteSecretKeys`) |
 | **Schema** | `customObjects` | `CustomObject[]` | `[]` | Per-shape rules; see [metadata guide](../guides/metadata-redaction.md) |
 | **Value-pattern** | `valuePatterns` | `RegExp[]` | `[]` | Opt-in: redact scalars whose string form matches a pattern |
 | **Path rule** | `pathRules` | `PathRule[]` | `[]` | Apply a mode at a JSON path (`metadata.*.value`) |

package/docs/release-notes/README.md

@@ -4,6 +4,8 @@ Per-version release notes for published **field-redactor** git tags. npm release
 
 | Version | npm | Notes |
 | --- | --- | --- |
+| **v1.6.2** | Yes | [v1.6.2.md](v1.6.2.md) — canonical opaque/remove naming; drop ObjectRedactor façade |
+| **v1.6.1** | Yes | [v1.6.1.md](v1.6.1.md) — internal simplification / layering cleanup |
 | **v1.6.0** | Yes | [v1.6.0.md](v1.6.0.md) — path rules, passKeys, naming aliases, architecture |
 | **v1.5.0** | Yes | [v1.5.0.md](v1.5.0.md) — DX polish, value patterns, unified traversal |
 | v1.3.0 | No (superseded by 1.5.0) | [v1.3.0.md](v1.3.0.md) — sync API, COW, builder, dryRun, presets |
@@ -15,7 +17,7 @@ Per-version release notes for published **field-redactor** git tags. npm release
 
 ## Migration
 
-- [1.5.x → 1.6.0](../guides/migration-1.5-to-1.6.md) — path rules, naming aliases, package exports
+- [1.5.x → 1.6.x](../guides/migration-1.5-to-1.6.md) — path rules, naming aliases, package exports
 - [1.2.x → 1.5.0](../guides/migration-1.2-to-1.5.md) — upgrade path from the previous npm line
 
 ## Internal milestones (removed)

package/docs/release-notes/v1.6.1.md

@@ -0,0 +1,24 @@
+# Release notes — v1.6.1
+
+Field Redactor **1.6.1** is a patch release focused on internal simplification after **1.6.0**. Behavior and the documented public API are unchanged for typical `import { … } from 'field-redactor'` consumers.
+
+**Upgrade from 1.6.0:** Install `1.6.1`. No config or call-site changes required unless you relied on the undocumented convenience alias `FieldRedactor.fromConfig()` (use `new FieldRedactor(config)` or `create` / `createSafe` instead).
+
+## Highlights
+
+| Area | What changed |
+| --- | --- |
+| **Custom objects** | One `handleField` path; single match-type dispatcher |
+| **Layering** | Sibling-key + primitive helpers live under `rules/` / `util/` (rules no longer import engine) |
+| **Config** | Alias normalize once on construct; shared `forceDeepForKey` / path-mode map |
+| **Dead code** | Removed unused re-export shims and dry-run attribution wrappers |
+
+## Removed
+
+- `FieldRedactor.fromConfig(config)` — was identical to `new FieldRedactor(config)` and unused in-repo.
+
+## Links
+
+- [CHANGELOG](../../CHANGELOG.md)
+- [Release notes v1.6.0](v1.6.0.md)
+- [Migration 1.5 → 1.6](../guides/migration-1.5-to-1.6.md)

package/docs/release-notes/v1.6.2.md

@@ -0,0 +1,26 @@
+# Release notes — v1.6.2
+
+Field Redactor **1.6.2** folds two internal cleanups onto **1.6.1**: Opaque/Remove as the canonical config and runtime vocabulary, and removal of the thin `ObjectRedactor` orchestrator. Typical `import { … } from 'field-redactor'` consumers need no call-site changes.
+
+**Upgrade from 1.6.1:** Install `1.6.2`. Prefer `opaqueSecretKeys` / `removeSecretKeys` and `CustomObjectMatchType.Opaque` / `Remove` in new config; legacy `fullSecretKeys` / `deleteSecretKeys` and `Full` / `Delete` still work.
+
+## Highlights
+
+| Area | What changed |
+| --- | --- |
+| **Naming** | Canonical storage and matching use opaque/remove; full/delete are input-only aliases |
+| **SecretManager** | `isOpaqueSecretKey` / `isRemoveSecretKey` (legacy config keys still accepted) |
+| **Builder / presets** | Write preferred field names |
+| **Engine** | `FieldRedactor` → `ObjectRedactorTraversal` directly; builder uses a static import |
+
+## Compatibility
+
+- Public root API unchanged for normal usage
+- `FieldRedactorConfigBuilder.buildRedactor()` / `buildSafeRedactor()` behavior unchanged
+- Docs and presets lead with Opaque/Remove vocabulary
+
+## Links
+
+- [CHANGELOG](../../CHANGELOG.md)
+- [Release notes v1.6.1](v1.6.1.md)
+- [Migration 1.5 → 1.6](../guides/migration-1.5-to-1.6.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "field-redactor",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "description": "Utility for redacting PII from complex JSON objects for which simpler redaction tools are insufficient.",
   "author": {
     "name": "Andrew Molony",