@ligelog/redact 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ligelog contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,118 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createRedactHook: () => createRedactHook
+});
+module.exports = __toCommonJS(index_exports);
+function compilePaths(paths) {
+  return paths.map((p) => p.split("."));
+}
+function applyRedaction(obj, compiledPaths, censorFn, remove) {
+  let result = obj;
+  for (const segments of compiledPaths) {
+    result = redactPath(result, segments, 0, censorFn, remove, "", /* @__PURE__ */ new Set());
+  }
+  return result;
+}
+function redactPath(obj, segments, index, censorFn, remove, currentPath, seen) {
+  if (index >= segments.length) return obj;
+  if (seen.has(obj)) return obj;
+  seen.add(obj);
+  const segment = segments[index];
+  const isLast = index === segments.length - 1;
+  const keys = segment === "*" ? Object.keys(obj) : [segment];
+  let result = obj;
+  let cloned = false;
+  for (const key of keys) {
+    if (!Object.hasOwn(obj, key)) continue;
+    const fullPath = currentPath ? `${currentPath}.${key}` : key;
+    if (isLast) {
+      if (!cloned) {
+        result = { ...obj };
+        cloned = true;
+      }
+      if (remove) {
+        delete result[key];
+      } else {
+        result[key] = censorFn(obj[key], fullPath);
+      }
+    } else {
+      const child = obj[key];
+      if (child !== null && typeof child === "object" && !Array.isArray(child)) {
+        const updated = redactPath(
+          child,
+          segments,
+          index + 1,
+          censorFn,
+          remove,
+          fullPath,
+          seen
+        );
+        if (updated !== child) {
+          if (!cloned) {
+            result = { ...obj };
+            cloned = true;
+          }
+          result[key] = updated;
+        }
+      }
+    }
+  }
+  seen.delete(obj);
+  return result;
+}
+var CENSOR_ERROR_FALLBACK = "[CENSOR_ERROR]";
+var DEFAULT_CENSOR = "[REDACTED]";
+function createRedactHook(opts) {
+  const { paths, censor = DEFAULT_CENSOR, remove = false } = opts;
+  if (paths.length === 0) {
+    return {};
+  }
+  const compiledPaths = compilePaths(paths);
+  const censorFn = typeof censor === "function" ? (value, path) => {
+    try {
+      return censor(value, path);
+    } catch {
+      return CENSOR_ERROR_FALLBACK;
+    }
+  } : () => censor;
+  return {
+    onBeforeWrite: [
+      (ctx) => {
+        const redacted = applyRedaction(
+          ctx.record,
+          compiledPaths,
+          censorFn,
+          remove
+        );
+        if (redacted === ctx.record) {
+          return ctx;
+        }
+        return { ...ctx, record: redacted };
+      }
+    ]
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createRedactHook
+});

package/dist/index.d.cts

@@ -0,0 +1,75 @@
+import { Hooks } from 'ligelog';
+
+/**
+ * @file index.ts
+ * PII field masking hook for ligelog.
+ *
+ * Redacts sensitive fields from LogRecord before serialization using
+ * dot-path patterns with wildcard support.
+ *
+ * ## Setup
+ *
+ * ```ts
+ * import { createLogger } from 'ligelog';
+ * import { createRedactHook } from '@ligelog/redact';
+ *
+ * const logger = createLogger();
+ * logger.use(createRedactHook({ paths: ['password', 'user.*.ssn'] }));
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+/** Allowed return types for a censor function. */
+type CensorValue = string | number | boolean | null | undefined;
+/** Options accepted by `createRedactHook`. */
+interface RedactOptions {
+    /**
+     * Dot-separated field paths to redact.
+     * Supports `*` as a wildcard to match any key at that level.
+     *
+     * @example ['password', 'headers.authorization', 'user.*.ssn']
+     */
+    readonly paths: readonly string[];
+    /**
+     * Replacement value or function for redacted fields.
+     * A function receives the original value and the full dot-path.
+     * If the function throws, `'[CENSOR_ERROR]'` is used as a fallback.
+     * @default '[REDACTED]'
+     */
+    censor?: string | ((value: unknown, path: string) => CensorValue);
+    /**
+     * When `true`, redacted keys are removed entirely instead of replaced.
+     * @default false
+     */
+    remove?: boolean;
+}
+/**
+ * Create a ligelog hook that redacts sensitive fields from log records.
+ *
+ * Runs as an `onBeforeWrite` hook using Copy-on-Write semantics:
+ * the original `ctx.record` is never mutated.
+ *
+ * @param opts - Redaction configuration.
+ * @returns A `Hooks` object ready for `logger.use()`.
+ *
+ * @example
+ * ```ts
+ * // Basic usage
+ * logger.use(createRedactHook({ paths: ['password', 'token'] }));
+ *
+ * // Custom censor function
+ * logger.use(createRedactHook({
+ *   paths: ['email'],
+ *   censor: (value) => typeof value === 'string'
+ *     ? value.replace(/(.{2}).+(@.+)/, '$1***$2')
+ *     : '[REDACTED]',
+ * }));
+ *
+ * // Remove keys entirely
+ * logger.use(createRedactHook({ paths: ['secret'], remove: true }));
+ * ```
+ */
+declare function createRedactHook(opts: RedactOptions): Hooks;
+
+export { type CensorValue, type RedactOptions, createRedactHook };

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+import { Hooks } from 'ligelog';
+
+/**
+ * @file index.ts
+ * PII field masking hook for ligelog.
+ *
+ * Redacts sensitive fields from LogRecord before serialization using
+ * dot-path patterns with wildcard support.
+ *
+ * ## Setup
+ *
+ * ```ts
+ * import { createLogger } from 'ligelog';
+ * import { createRedactHook } from '@ligelog/redact';
+ *
+ * const logger = createLogger();
+ * logger.use(createRedactHook({ paths: ['password', 'user.*.ssn'] }));
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+/** Allowed return types for a censor function. */
+type CensorValue = string | number | boolean | null | undefined;
+/** Options accepted by `createRedactHook`. */
+interface RedactOptions {
+    /**
+     * Dot-separated field paths to redact.
+     * Supports `*` as a wildcard to match any key at that level.
+     *
+     * @example ['password', 'headers.authorization', 'user.*.ssn']
+     */
+    readonly paths: readonly string[];
+    /**
+     * Replacement value or function for redacted fields.
+     * A function receives the original value and the full dot-path.
+     * If the function throws, `'[CENSOR_ERROR]'` is used as a fallback.
+     * @default '[REDACTED]'
+     */
+    censor?: string | ((value: unknown, path: string) => CensorValue);
+    /**
+     * When `true`, redacted keys are removed entirely instead of replaced.
+     * @default false
+     */
+    remove?: boolean;
+}
+/**
+ * Create a ligelog hook that redacts sensitive fields from log records.
+ *
+ * Runs as an `onBeforeWrite` hook using Copy-on-Write semantics:
+ * the original `ctx.record` is never mutated.
+ *
+ * @param opts - Redaction configuration.
+ * @returns A `Hooks` object ready for `logger.use()`.
+ *
+ * @example
+ * ```ts
+ * // Basic usage
+ * logger.use(createRedactHook({ paths: ['password', 'token'] }));
+ *
+ * // Custom censor function
+ * logger.use(createRedactHook({
+ *   paths: ['email'],
+ *   censor: (value) => typeof value === 'string'
+ *     ? value.replace(/(.{2}).+(@.+)/, '$1***$2')
+ *     : '[REDACTED]',
+ * }));
+ *
+ * // Remove keys entirely
+ * logger.use(createRedactHook({ paths: ['secret'], remove: true }));
+ * ```
+ */
+declare function createRedactHook(opts: RedactOptions): Hooks;
+
+export { type CensorValue, type RedactOptions, createRedactHook };

package/dist/index.js

@@ -0,0 +1,93 @@
+// src/index.ts
+function compilePaths(paths) {
+  return paths.map((p) => p.split("."));
+}
+function applyRedaction(obj, compiledPaths, censorFn, remove) {
+  let result = obj;
+  for (const segments of compiledPaths) {
+    result = redactPath(result, segments, 0, censorFn, remove, "", /* @__PURE__ */ new Set());
+  }
+  return result;
+}
+function redactPath(obj, segments, index, censorFn, remove, currentPath, seen) {
+  if (index >= segments.length) return obj;
+  if (seen.has(obj)) return obj;
+  seen.add(obj);
+  const segment = segments[index];
+  const isLast = index === segments.length - 1;
+  const keys = segment === "*" ? Object.keys(obj) : [segment];
+  let result = obj;
+  let cloned = false;
+  for (const key of keys) {
+    if (!Object.hasOwn(obj, key)) continue;
+    const fullPath = currentPath ? `${currentPath}.${key}` : key;
+    if (isLast) {
+      if (!cloned) {
+        result = { ...obj };
+        cloned = true;
+      }
+      if (remove) {
+        delete result[key];
+      } else {
+        result[key] = censorFn(obj[key], fullPath);
+      }
+    } else {
+      const child = obj[key];
+      if (child !== null && typeof child === "object" && !Array.isArray(child)) {
+        const updated = redactPath(
+          child,
+          segments,
+          index + 1,
+          censorFn,
+          remove,
+          fullPath,
+          seen
+        );
+        if (updated !== child) {
+          if (!cloned) {
+            result = { ...obj };
+            cloned = true;
+          }
+          result[key] = updated;
+        }
+      }
+    }
+  }
+  seen.delete(obj);
+  return result;
+}
+var CENSOR_ERROR_FALLBACK = "[CENSOR_ERROR]";
+var DEFAULT_CENSOR = "[REDACTED]";
+function createRedactHook(opts) {
+  const { paths, censor = DEFAULT_CENSOR, remove = false } = opts;
+  if (paths.length === 0) {
+    return {};
+  }
+  const compiledPaths = compilePaths(paths);
+  const censorFn = typeof censor === "function" ? (value, path) => {
+    try {
+      return censor(value, path);
+    } catch {
+      return CENSOR_ERROR_FALLBACK;
+    }
+  } : () => censor;
+  return {
+    onBeforeWrite: [
+      (ctx) => {
+        const redacted = applyRedaction(
+          ctx.record,
+          compiledPaths,
+          censorFn,
+          remove
+        );
+        if (redacted === ctx.record) {
+          return ctx;
+        }
+        return { ...ctx, record: redacted };
+      }
+    ]
+  };
+}
+export {
+  createRedactHook
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@ligelog/redact",
+  "version": "1.0.0",
+  "description": "PII field masking hook for ligelog — redact sensitive data from log records",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "ligelog",
+    "redact",
+    "pii",
+    "gdpr",
+    "masking",
+    "logging",
+    "hook"
+  ],
+  "author": "Akihiro Seino",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/seino/ligelog.git",
+    "directory": "packages/redact"
+  },
+  "homepage": "https://github.com/seino/ligelog#ecosystem",
+  "bugs": {
+    "url": "https://github.com/seino/ligelog/issues"
+  },
+  "devDependencies": {
+    "ligelog": "1.1.0"
+  },
+  "peerDependencies": {
+    "ligelog": ">=1.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}