@hackylabs/deep-redact 3.0.4 → 4.0.0

package/dist/node-console-sink-BnRUkAAr.cjs

@@ -0,0 +1,19 @@
+//#region src/core/diagnostics/node-console-sink.ts
+const isNodeRuntime = () => {
+	return typeof globalThis.process?.versions?.node === "string";
+};
+const getNodeConsoleDiagnosticSink = () => {
+	if (!isNodeRuntime() || typeof globalThis.console?.error !== "function") return;
+	const consoleTarget = globalThis.console;
+	const error = consoleTarget.error;
+	return (event) => {
+		error.call(consoleTarget, event);
+	};
+};
+//#endregion
+Object.defineProperty(exports, "getNodeConsoleDiagnosticSink", {
+	enumerable: true,
+	get: function() {
+		return getNodeConsoleDiagnosticSink;
+	}
+});

package/dist/node-console-sink-DaQleNZ8.js

@@ -0,0 +1,14 @@
+//#region src/core/diagnostics/node-console-sink.ts
+const isNodeRuntime = () => {
+	return typeof globalThis.process?.versions?.node === "string";
+};
+const getNodeConsoleDiagnosticSink = () => {
+	if (!isNodeRuntime() || typeof globalThis.console?.error !== "function") return;
+	const consoleTarget = globalThis.console;
+	const error = consoleTarget.error;
+	return (event) => {
+		error.call(consoleTarget, event);
+	};
+};
+//#endregion
+export { getNodeConsoleDiagnosticSink as t };

package/dist/public-Da0aARA9.d.cts

@@ -0,0 +1,127 @@
+//#region src/types/paths.d.ts
+interface PublicWildcardSegment {
+  readonly any: true;
+}
+interface PublicRecursiveWildcardSegment {
+  readonly anyDepth: true;
+}
+type PathSegments = readonly (string | number | RegExp | IgnorePathSegment | PublicWildcardSegment | PublicRecursiveWildcardSegment)[];
+interface FunctionCensorContext {
+  readonly matchedPath: PathSegments;
+  /**
+   * The path segments of the rule that produced this redaction.
+   * When an inherited policy is active (e.g. a parent key rule with `retainStructure: true`),
+   * this reflects the ancestor rule's key or path — not the current node's own key.
+   */
+  readonly rulePath: PathSegments;
+  readonly rootInput: unknown;
+  readonly terminalKey?: string | number;
+}
+type Censor = string | ((value: unknown, context: FunctionCensorContext) => unknown);
+type RegexPathSegment = RegExp;
+interface IgnorePathSegment {
+  readonly ignore: string | number | RegexPathSegment;
+}
+type StructuredPathSegment = string | number | RegexPathSegment | IgnorePathSegment;
+type StructuredPathSelector = readonly StructuredPathSegment[];
+type PathSelector = string | StructuredPathSelector;
+interface PathRule {
+  readonly path: PathSelector;
+  readonly censor?: Censor;
+  readonly remove?: boolean;
+  readonly retainStructure?: boolean;
+  readonly replaceStringByLength?: boolean;
+}
+type PathEntry = PathSelector | PathRule;
+//#endregion
+//#region src/types/diagnostics.d.ts
+interface DiagnosticEvent {
+  readonly details?: Record<string, unknown>;
+  readonly event: string;
+  readonly message: string;
+  readonly path: string;
+  readonly valueType: string;
+}
+type DiagnosticSink = (event: DiagnosticEvent) => void;
+interface DiagnosticsOptions {
+  readonly sink?: DiagnosticSink;
+}
+//#endregion
+//#region src/types/ignored-value-types.d.ts
+interface IgnoredValueTypesOption {
+  readonly bigint?: boolean;
+  readonly Date?: boolean;
+  readonly Error?: boolean;
+  readonly Map?: boolean;
+  readonly RegExp?: boolean;
+  readonly Set?: boolean;
+  readonly URL?: boolean;
+}
+//#endregion
+//#region src/types/transformers.d.ts
+type Transformer = (value: unknown) => unknown;
+interface CustomConstructorTransformerRegistration {
+  readonly constructor: abstract new (...args: never[]) => object;
+  readonly transformers: readonly Transformer[];
+}
+interface TransformersByType {
+  readonly bigint?: readonly Transformer[];
+  readonly object?: readonly Transformer[];
+}
+interface TransformersByConstructor {
+  readonly Date?: readonly Transformer[];
+  readonly Error?: readonly Transformer[];
+  readonly Map?: readonly Transformer[];
+  readonly RegExp?: readonly Transformer[];
+  readonly Set?: readonly Transformer[];
+  readonly URL?: readonly Transformer[];
+  readonly custom?: readonly CustomConstructorTransformerRegistration[];
+}
+interface TransformersOption {
+  readonly byType?: TransformersByType;
+  readonly byConstructor?: TransformersByConstructor;
+  readonly fallback?: readonly Transformer[];
+}
+//#endregion
+//#region src/types/config.d.ts
+type SerialiseOption = boolean | ((value: unknown) => string);
+interface KeyRule {
+  readonly key: string | RegExp;
+  readonly fuzzyKeyMatch?: boolean;
+  readonly caseSensitiveKeyMatch?: boolean;
+  readonly censor?: Censor;
+  readonly remove?: boolean;
+  readonly retainStructure?: boolean;
+  readonly replaceStringByLength?: boolean;
+}
+type KeySelector = string | RegExp | KeyRule;
+type StringTest = RegExp | SubstringRule;
+type ValueTypeName = 'string' | 'number' | 'bigint' | 'boolean' | 'object' | 'function' | 'symbol' | 'undefined';
+interface SubstringRule {
+  readonly pattern: RegExp;
+  readonly replacer: (value: string, pattern: RegExp) => string;
+}
+interface DeepRedactOptions {
+  readonly caseSensitiveKeyMatch?: boolean;
+  readonly censor?: Censor;
+  readonly diagnostics?: DiagnosticsOptions;
+  readonly fuzzyKeyMatch?: boolean;
+  readonly keys?: readonly KeySelector[];
+  readonly maxDepth?: number;
+  readonly maxNodes?: number;
+  readonly paths?: readonly PathEntry[];
+  readonly remove?: boolean;
+  readonly retainStructure?: boolean;
+  readonly serialise?: SerialiseOption;
+  readonly stringTests?: readonly StringTest[];
+  readonly transformers?: TransformersOption;
+  readonly types?: readonly ValueTypeName[];
+  readonly ignoredValueTypes?: IgnoredValueTypesOption;
+  readonly replaceStringByLength?: boolean;
+}
+//#endregion
+//#region src/types/public.d.ts
+type Redactor = (value: unknown) => unknown;
+type RedactorFactory = (options?: DeepRedactOptions) => Redactor;
+//#endregion
+export { StructuredPathSelector as A, PathRule as C, PublicWildcardSegment as D, PublicRecursiveWildcardSegment as E, RegexPathSegment as O, PathEntry as S, PathSelector as T, DiagnosticSink as _, KeySelector as a, FunctionCensorContext as b, SubstringRule as c, Transformer as d, TransformersByConstructor as f, DiagnosticEvent as g, IgnoredValueTypesOption as h, KeyRule as i, StructuredPathSegment as k, ValueTypeName as l, TransformersOption as m, RedactorFactory as n, SerialiseOption as o, TransformersByType as p, DeepRedactOptions as r, StringTest as s, Redactor as t, CustomConstructorTransformerRegistration as u, DiagnosticsOptions as v, PathSegments as w, IgnorePathSegment as x, Censor as y };

package/dist/public-Dw4ycNzO.d.ts

@@ -0,0 +1,127 @@
+//#region src/types/paths.d.ts
+interface PublicWildcardSegment {
+  readonly any: true;
+}
+interface PublicRecursiveWildcardSegment {
+  readonly anyDepth: true;
+}
+type PathSegments = readonly (string | number | RegExp | IgnorePathSegment | PublicWildcardSegment | PublicRecursiveWildcardSegment)[];
+interface FunctionCensorContext {
+  readonly matchedPath: PathSegments;
+  /**
+   * The path segments of the rule that produced this redaction.
+   * When an inherited policy is active (e.g. a parent key rule with `retainStructure: true`),
+   * this reflects the ancestor rule's key or path — not the current node's own key.
+   */
+  readonly rulePath: PathSegments;
+  readonly rootInput: unknown;
+  readonly terminalKey?: string | number;
+}
+type Censor = string | ((value: unknown, context: FunctionCensorContext) => unknown);
+type RegexPathSegment = RegExp;
+interface IgnorePathSegment {
+  readonly ignore: string | number | RegexPathSegment;
+}
+type StructuredPathSegment = string | number | RegexPathSegment | IgnorePathSegment;
+type StructuredPathSelector = readonly StructuredPathSegment[];
+type PathSelector = string | StructuredPathSelector;
+interface PathRule {
+  readonly path: PathSelector;
+  readonly censor?: Censor;
+  readonly remove?: boolean;
+  readonly retainStructure?: boolean;
+  readonly replaceStringByLength?: boolean;
+}
+type PathEntry = PathSelector | PathRule;
+//#endregion
+//#region src/types/diagnostics.d.ts
+interface DiagnosticEvent {
+  readonly details?: Record<string, unknown>;
+  readonly event: string;
+  readonly message: string;
+  readonly path: string;
+  readonly valueType: string;
+}
+type DiagnosticSink = (event: DiagnosticEvent) => void;
+interface DiagnosticsOptions {
+  readonly sink?: DiagnosticSink;
+}
+//#endregion
+//#region src/types/ignored-value-types.d.ts
+interface IgnoredValueTypesOption {
+  readonly bigint?: boolean;
+  readonly Date?: boolean;
+  readonly Error?: boolean;
+  readonly Map?: boolean;
+  readonly RegExp?: boolean;
+  readonly Set?: boolean;
+  readonly URL?: boolean;
+}
+//#endregion
+//#region src/types/transformers.d.ts
+type Transformer = (value: unknown) => unknown;
+interface CustomConstructorTransformerRegistration {
+  readonly constructor: abstract new (...args: never[]) => object;
+  readonly transformers: readonly Transformer[];
+}
+interface TransformersByType {
+  readonly bigint?: readonly Transformer[];
+  readonly object?: readonly Transformer[];
+}
+interface TransformersByConstructor {
+  readonly Date?: readonly Transformer[];
+  readonly Error?: readonly Transformer[];
+  readonly Map?: readonly Transformer[];
+  readonly RegExp?: readonly Transformer[];
+  readonly Set?: readonly Transformer[];
+  readonly URL?: readonly Transformer[];
+  readonly custom?: readonly CustomConstructorTransformerRegistration[];
+}
+interface TransformersOption {
+  readonly byType?: TransformersByType;
+  readonly byConstructor?: TransformersByConstructor;
+  readonly fallback?: readonly Transformer[];
+}
+//#endregion
+//#region src/types/config.d.ts
+type SerialiseOption = boolean | ((value: unknown) => string);
+interface KeyRule {
+  readonly key: string | RegExp;
+  readonly fuzzyKeyMatch?: boolean;
+  readonly caseSensitiveKeyMatch?: boolean;
+  readonly censor?: Censor;
+  readonly remove?: boolean;
+  readonly retainStructure?: boolean;
+  readonly replaceStringByLength?: boolean;
+}
+type KeySelector = string | RegExp | KeyRule;
+type StringTest = RegExp | SubstringRule;
+type ValueTypeName = 'string' | 'number' | 'bigint' | 'boolean' | 'object' | 'function' | 'symbol' | 'undefined';
+interface SubstringRule {
+  readonly pattern: RegExp;
+  readonly replacer: (value: string, pattern: RegExp) => string;
+}
+interface DeepRedactOptions {
+  readonly caseSensitiveKeyMatch?: boolean;
+  readonly censor?: Censor;
+  readonly diagnostics?: DiagnosticsOptions;
+  readonly fuzzyKeyMatch?: boolean;
+  readonly keys?: readonly KeySelector[];
+  readonly maxDepth?: number;
+  readonly maxNodes?: number;
+  readonly paths?: readonly PathEntry[];
+  readonly remove?: boolean;
+  readonly retainStructure?: boolean;
+  readonly serialise?: SerialiseOption;
+  readonly stringTests?: readonly StringTest[];
+  readonly transformers?: TransformersOption;
+  readonly types?: readonly ValueTypeName[];
+  readonly ignoredValueTypes?: IgnoredValueTypesOption;
+  readonly replaceStringByLength?: boolean;
+}
+//#endregion
+//#region src/types/public.d.ts
+type Redactor = (value: unknown) => unknown;
+type RedactorFactory = (options?: DeepRedactOptions) => Redactor;
+//#endregion
+export { StructuredPathSelector as A, PathRule as C, PublicWildcardSegment as D, PublicRecursiveWildcardSegment as E, RegexPathSegment as O, PathEntry as S, PathSelector as T, DiagnosticSink as _, KeySelector as a, FunctionCensorContext as b, SubstringRule as c, Transformer as d, TransformersByConstructor as f, DiagnosticEvent as g, IgnoredValueTypesOption as h, KeyRule as i, StructuredPathSegment as k, ValueTypeName as l, TransformersOption as m, RedactorFactory as n, SerialiseOption as o, TransformersByType as p, DeepRedactOptions as r, StringTest as s, Redactor as t, CustomConstructorTransformerRegistration as u, DiagnosticsOptions as v, PathSegments as w, IgnorePathSegment as x, Censor as y };

package/package.json

@@ -1,75 +1,35 @@
 {
   "name": "@hackylabs/deep-redact",
-  "version": "3.0.4",
-  "description": "A fast, safe and configurable zero-dependency library for redacting strings or deeply redacting arrays and objects.",
+  "version": "4.0.0",
+  "description": "Deeply redact sensitive data from objects, arrays and arbitrary strings (e.g. XML or raw cookies data) with a composable, function-first API.",
   "private": false,
   "license": "MIT",
   "author": "Benjamin Green (https://bengreen.dev)",
   "funding": "https://ko-fi.com/hackylabs",
-  "types": "./dist/types/index.d.ts",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
+  "type": "module",
+  "volta": {
+    "node": "24.14.1",
+    "pnpm": "10.33.0"
+  },
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "./index.ts": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/types/index.d.ts"
-    },
-    "./types.ts": {
-      "import": "./dist/types.mjs",
-      "require": "./dist/types.js",
-      "types": "./dist/types/types.d.ts"
-    },
-    "./utils/TransformerRegistry.ts": {
-      "import": "./dist/utils/TransformerRegistry.mjs",
-      "require": "./dist/utils/TransformerRegistry.js",
-      "types": "./dist/types/utils/TransformerRegistry.d.ts"
-    },
-    "./utils/index.ts": {
-      "import": "./dist/utils/index.mjs",
-      "require": "./dist/utils/index.js",
-      "types": "./dist/types/utils/index.d.ts"
-    },
-    "./utils/standardTransformers/bigint.ts": {
-      "import": "./dist/utils/standardTransformers/bigint.mjs",
-      "require": "./dist/utils/standardTransformers/bigint.js",
-      "types": "./dist/types/utils/standardTransformers/bigint.d.ts"
-    },
-    "./utils/standardTransformers/date.ts": {
-      "import": "./dist/utils/standardTransformers/date.mjs",
-      "require": "./dist/utils/standardTransformers/date.js",
-      "types": "./dist/types/utils/standardTransformers/date.d.ts"
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
     },
-    "./utils/standardTransformers/error.ts": {
-      "import": "./dist/utils/standardTransformers/error.mjs",
-      "require": "./dist/utils/standardTransformers/error.js",
-      "types": "./dist/types/utils/standardTransformers/error.d.ts"
+    "./adapters/console": {
+      "import": "./dist/adapters/console/index.js",
+      "require": "./dist/adapters/console/index.cjs",
+      "types": "./dist/adapters/console/index.d.ts"
     },
-    "./utils/standardTransformers/index.ts": {
-      "import": "./dist/utils/standardTransformers/index.mjs",
-      "require": "./dist/utils/standardTransformers/index.js",
-      "types": "./dist/types/utils/standardTransformers/index.d.ts"
-    },
-    "./utils/standardTransformers/map.ts": {
-      "import": "./dist/utils/standardTransformers/map.mjs",
-      "require": "./dist/utils/standardTransformers/map.js",
-      "types": "./dist/types/utils/standardTransformers/map.d.ts"
-    },
-    "./utils/standardTransformers/regex.ts": {
-      "import": "./dist/utils/standardTransformers/regex.mjs",
-      "require": "./dist/utils/standardTransformers/regex.js",
-      "types": "./dist/types/utils/standardTransformers/regex.d.ts"
-    },
-    "./utils/standardTransformers/set.ts": {
-      "import": "./dist/utils/standardTransformers/set.mjs",
-      "require": "./dist/utils/standardTransformers/set.js",
-      "types": "./dist/types/utils/standardTransformers/set.d.ts"
-    },
-    "./utils/standardTransformers/url.ts": {
-      "import": "./dist/utils/standardTransformers/url.mjs",
-      "require": "./dist/utils/standardTransformers/url.js",
-      "types": "./dist/types/utils/standardTransformers/url.d.ts"
-    }
+    "./package.json": "./package.json"
   },
   "files": [
     "dist"
@@ -99,51 +59,56 @@
     "type": "git",
     "url": "git+https://github.com/hackylabs/deep-redact"
   },
-  "scripts": {
-    "lint": "eslint",
-    "build": "npm run lint && npm run test && npm run bench && npm run build:esm && npm run build:cjs && npm run update-exports && npm run test:build && npm run update-readme && npm run update-license",
-    "build:dev": "rm -rf dist && npm run build:esm && npm run build:cjs && npm run update-exports",
-    "build:esm": "tsc --project tsconfig.esm.json && ./scripts/js-to-mjs.sh",
-    "build:cjs": "tsc --project tsconfig.cjs.json",
-    "bench": "npx vitest bench --watch=false",
-    "bench:dev": "npx vitest bench",
-    "test:dev": "npx vitest",
-    "test": "npx vitest run",
-    "test:build": "npx vitest run test/build.test.ts --reporter=basic --coverage=false",
-    "test:build:dev": "npm run build:cjs && npm run build:esm && npm run update-exports && npx vitest test/build.test.ts --coverage=false --reporter=basic",
-    "test:load": "npx vitest run test/load/redact.test.ts --reporter=basic --coverage=false",
-    "test:load:dev": "npx vitest test/load/redact.test.ts --coverage=false --reporter=basic",
-    "test:unit": "npx vitest run test/unit --reporter=verbose",
-    "test:unit:dev": "npx vitest test/unit --coverage=false --reporter=verbose",
-    "update-readme": "npx ts-node ./scripts/update-readme.ts",
-    "update-license": "npx ts-node ./scripts/update-license.ts",
-    "update-exports": "npx ts-node ./scripts/update-exports.ts"
-  },
   "//": [
-    "autocannon, fast-redact and obglob are installed only as internal benchmark comparisons and are not used in the library",
+    "deep-redact-v3 and fast-redact are installed only as internal benchmark comparisons and are not used in the library",
     "all dependencies are for development purposes only"
   ],
   "devDependencies": {
-    "@hackylabs/obglob": "1.1.2",
-    "@memlab/core": "1.1.34",
-    "@types/autocannon": "7.12.6",
+    "@eslint/js": "9.39.4",
+    "@stylistic/eslint-plugin": "4.4.1",
     "@types/fast-redact": "3.0.4",
-    "@types/node": "20.14.12",
-    "@typescript-eslint/eslint-plugin": "7.14.1",
-    "@typescript-eslint/parser": "7.14.1",
-    "@vitest/coverage-v8": "2.0.4",
-    "autocannon": "8.0.0",
-    "eslint": "8.57.0",
-    "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-airbnb-typescript": "18.0.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-n": "17.9.0",
-    "eslint-plugin-promise": "7.0.0",
+    "@types/node": "24.1.0",
+    "deep-redact-v3": "npm:@hackylabs/deep-redact@^3.0.0",
+    "eslint": "9.39.4",
+    "eslint-plugin-unicorn": "59.0.1",
     "fast-redact": "3.5.0",
-    "typescript": "5.6.2",
-    "vitest": "2.0.4"
+    "globals": "16.5.0",
+    "tsdown": "0.21.7",
+    "typescript": "6.0.2",
+    "typescript-eslint": "8.59.0",
+    "vega": "6.2.0",
+    "vega-lite": "6.4.3",
+    "vitest": "4.1.4"
   },
   "editor.formatOnSave": true,
   "editor.formatOnPaste": true,
-  "editor.defaultFormatter": "EditorConfig.editorconfig"
-}
+  "editor.defaultFormatter": "EditorConfig.editorconfig",
+  "scripts": {
+    "bench": "pnpm run bench:speed",
+    "build": "pnpm run verify-generated-files && pnpm exec tsdown",
+    "generate": "pnpm run generate-exports && pnpm run generate-readme && pnpm run generate-precedence-doc && pnpm run generate-one-way-redaction-doc && pnpm run generate-fast-redact-migration-doc && pnpm run generate-v3-migration-doc && pnpm run generate-example-docs && pnpm run generate:standardisation-guide",
+    "generate-exports": "node --experimental-strip-types ./scripts/generate-exports.ts",
+    "generate-fast-redact-migration-doc": "node --experimental-strip-types ./scripts/generate-fast-redact-migration-doc.ts",
+    "generate-v3-migration-doc": "node --experimental-strip-types ./scripts/generate-v3-migration-doc.ts",
+    "generate-one-way-redaction-doc": "node --experimental-strip-types ./scripts/generate-one-way-redaction-doc.ts",
+    "generate-precedence-doc": "node --experimental-strip-types ./scripts/generate-precedence-doc.ts",
+    "generate-readme": "node --experimental-strip-types ./scripts/generate-readme.ts",
+    "generate:standardisation-guide": "node --experimental-strip-types ./scripts/generate-standardisation-guide.ts",
+    "lint": "pnpm exec eslint . && pnpm exec tsc --noEmit",
+    "test": "pnpm run build && pnpm run test:contract",
+    "test:contract": "pnpm exec vitest run test/build.test.ts test/contract/**/*.test.ts test/security/*.test.ts --reporter=verbose",
+    "verify:install-matrix": "pnpm run build && node --experimental-strip-types ./scripts/verify-install-matrix.ts",
+    "verify:migration:fast-redact": "pnpm run build && node --experimental-strip-types ./scripts/verify-fast-redact-migration.ts",
+    "verify:migration:v3": "pnpm run build && node --experimental-strip-types ./scripts/verify-v3-migration.ts",
+    "verify:examples": "pnpm run build && node --experimental-strip-types ./scripts/verify-examples.ts",
+    "verify-generated-files": "node --experimental-strip-types ./scripts/verify-generated-files.ts",
+    "generate-example-docs": "node --experimental-strip-types ./scripts/generate-example-docs.ts",
+    "bench:resource": "pnpm run build && node --expose-gc --experimental-strip-types ./scripts/run-resource-benchmarks.ts",
+    "bench:resource:generate-doc": "node --experimental-strip-types ./scripts/generate-resource-benchmark-doc.ts",
+    "bench:speed": "pnpm run build && node --experimental-strip-types ./scripts/run-benchmarks.ts",
+    "bench:speed:generate-doc": "node --experimental-strip-types ./scripts/generate-benchmark-doc.ts",
+    "bench:generate-charts": "node --experimental-strip-types ./scripts/generate-benchmark-charts.ts",
+    "verify:resource-benchmarks": "pnpm run build && node --experimental-strip-types ./scripts/verify-resource-benchmarks.ts",
+    "verify:speed-benchmarks": "pnpm run build && node --experimental-strip-types ./scripts/verify-speed-benchmarks.ts"
+  }
+}

package/dist/index.mjs

@@ -1,40 +0,0 @@
-import { organisedStandardTransformers, standardTransformers } from './utils/standardTransformers/index.mjs';
-import RedactorUtils from './utils/index.mjs';
-class DeepRedact {
-    /**
-     * The redactorUtils instance to handle the redaction.
-     * @private
-     */
-    redactorUtils;
-    /**
-     * The configuration for the redaction.
-     * @private
-     */
-    config = {
-        serialise: false,
-    };
-    /**
-     * Create a new DeepRedact instance with the provided configuration.
-     * The configuration will be merged with the default configuration.
-     * `blacklistedKeys` will be normalised to an array inherited from the default configuration as the default values.
-     * @param {DeepRedactConfig} config. The configuration for the redaction.
-     */
-    constructor(config) {
-        const { serialise, serialize, ...rest } = config;
-        const englishSerialise = serialise ?? serialize;
-        if (typeof englishSerialise === 'boolean')
-            this.config.serialise = englishSerialise;
-        this.redactorUtils = new RedactorUtils({ ...rest });
-    }
-    /**
-     * Redact the provided value. The value will be stripped of any circular references and other unsupported data types, before being redacted according to the configuration and finally serialised if required.
-     * @param {unknown} value The value to redact.
-     * @returns {unknown} The redacted value.
-     * @throws {Error} If the value cannot be serialised to JSON and serialise is true.
-     */
-    redact = (value) => {
-        const redacted = this.redactorUtils.traverse(value);
-        return this.config.serialise ? JSON.stringify(redacted) : redacted;
-    };
-}
-export { DeepRedact, DeepRedact as default, standardTransformers, organisedStandardTransformers, };

package/dist/types/index.d.ts

@@ -1,29 +0,0 @@
-import type { DeepRedactConfig, RedactorUtilsConfig, BlacklistKeyConfig, Types, Transformer, ComplexStringTest, BaseDeepRedactConfig, OrganisedTransformers, TransformerConfig } from './types.js';
-import { organisedStandardTransformers, standardTransformers } from './utils/standardTransformers/index.js';
-declare class DeepRedact {
-    /**
-     * The redactorUtils instance to handle the redaction.
-     * @private
-     */
-    private redactorUtils;
-    /**
-     * The configuration for the redaction.
-     * @private
-     */
-    private readonly config;
-    /**
-     * Create a new DeepRedact instance with the provided configuration.
-     * The configuration will be merged with the default configuration.
-     * `blacklistedKeys` will be normalised to an array inherited from the default configuration as the default values.
-     * @param {DeepRedactConfig} config. The configuration for the redaction.
-     */
-    constructor(config: DeepRedactConfig);
-    /**
-     * Redact the provided value. The value will be stripped of any circular references and other unsupported data types, before being redacted according to the configuration and finally serialised if required.
-     * @param {unknown} value The value to redact.
-     * @returns {unknown} The redacted value.
-     * @throws {Error} If the value cannot be serialised to JSON and serialise is true.
-     */
-    redact: (value: unknown) => unknown;
-}
-export { DeepRedact, DeepRedact as default, type BaseDeepRedactConfig, type RedactorUtilsConfig, type BlacklistKeyConfig, type ComplexStringTest, type Transformer, type Types, type OrganisedTransformers, type TransformerConfig, standardTransformers, organisedStandardTransformers, };