field-redactor 1.2.0 → 1.6.0

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

@@ -0,0 +1,59 @@
+# Release notes — v1.6.0
+
+Field Redactor **1.6.0** adds path-based rules and pass-key allowlists, preferred Opaque/Remove naming aliases, and a large internal architecture cleanup. The public root API remains backward compatible with **1.5.0**.
+
+**Upgrade from 1.5.0:** Additive for normal `import { … } from 'field-redactor'` consumers. See [Migration: 1.5 → 1.6](../guides/migration-1.5-to-1.6.md) if you deep-imported `dist/` paths or want the new vocabulary.
+
+## Highlights
+
+| Area | What’s new |
+| --- | --- |
+| **Path rules** | `pathRules` / `.pathRule()` — redact by JSON path (`metadata.*.value`) with modes shallow, deep, opaque, remove, pass |
+| **Pass keys** | `passKeys` / `.passKey()` — exempt key names under deep parents |
+| **Naming** | Preferred `opaqueSecretKeys` / `removeSecretKeys` and `CustomObjectMatchType.Opaque` / `Remove` (legacy names still work) |
+| **Architecture** | Shared `RuleResolver`, layered `src/` packages, unified MaybeAsync traversal |
+
+## Path rules and pass keys
+
+```typescript
+import { FieldRedactorConfigBuilder } from 'field-redactor';
+
+const redactor = FieldRedactorConfigBuilder.create()
+  .pathRule('metadata.*.value', 'shallow')
+  .pathRule('session.token', 'remove')
+  .deep(/accountInfo/)
+  .passKey(/^id$/, /^profile$/)
+  .buildSafeRedactor();
+```
+
+**Precedence:** schema → path rule → opaque/deep/remove/shallow key rules → value pattern → default.
+
+## Naming aliases
+
+```typescript
+// Preferred
+{ opaqueSecretKeys: [/payload/], removeSecretKeys: [/authKey/] }
+
+// Still supported
+{ fullSecretKeys: [/payload/], deleteSecretKeys: [/authKey/] }
+
+CustomObjectMatchType.Opaque; // same value as Full
+CustomObjectMatchType.Remove; // same value as Delete
+```
+
+## Package boundary
+
+`package.json` `"exports"` now exposes only the package root (`.`). Deep imports such as `field-redactor/dist/...` are unsupported.
+
+## Internal (no intended API change)
+
+- `RuleResolver` is the single source of truth for traversal and dry-run attribution
+- Source layout: `api/`, `engine/`, `rules/`, `dryrun/`, `config/`, `util/`
+- Removed internal `ObjectRedactorSyncTraversal` alias (never part of the public export surface)
+- Contributor guide: [CONTRIBUTING.md](../../CONTRIBUTING.md)
+
+## Links
+
+- [CHANGELOG](../../CHANGELOG.md)
+- [Path rules guide](../guides/path-rules.md)
+- [Migration 1.5 → 1.6](../guides/migration-1.5-to-1.6.md)

package/jest.config.js

@@ -6,7 +6,12 @@ module.exports = {
   },
   cacheDirectory: './tmp/jest-cache',
   coverageDirectory: './tmp/jest-coverage',
-  coveragePathIgnorePatterns: ['./node_modules/', './tests/mocks/'],
+  coveragePathIgnorePatterns: [
+    './node_modules/',
+    './tests/mocks/',
+    './tests/helpers/',
+    './tests/integration/fixtures/'
+  ],
   collectCoverage: true,
   coverageThreshold: {
     global: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "field-redactor",
-  "version": "1.2.0",
+  "version": "1.6.0",
   "description": "Utility for redacting PII from complex JSON objects for which simpler redaction tools are insufficient.",
   "author": {
     "name": "Andrew Molony",
@@ -38,7 +38,6 @@
     "prettier": "^3.3.3",
     "ts-jest": "^29.2.4",
     "ts-node": "^10.9.2",
-    "tsc": "^2.0.4",
     "typescript": "^5.7.2",
     "yarn": "^1.22.22"
   },
@@ -47,5 +46,12 @@
     "singleQuote": true,
     "trailingComma": "none",
     "printWidth": 120
+  },
+  "prepublishOnly": "yarn build",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
   }
 }