@visulima/pail 1.2.2 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## @visulima/pail [1.3.0](https://github.com/visulima/visulima/compare/@visulima/pail@1.2.2...@visulima/pail@1.3.0) (2024-06-14)
+
+### Features
+
+* **pail:** added new redact processor ([#423](https://github.com/visulima/visulima/issues/423)) ([0614067](https://github.com/visulima/visulima/commit/0614067bec83a46ffe92abfb8a715b2c385b1d7d))
+
 ## @visulima/pail [1.2.2](https://github.com/visulima/visulima/compare/@visulima/pail@1.2.1...@visulima/pail@1.2.2) (2024-06-14)
 
 ### Bug Fixes

package/README.md

@@ -42,7 +42,7 @@
 -   Custom pluggable processors and reporters
 -   TypeScript support
 -   Interactive and regular modes
--   Secrets & sensitive information filtering (soon)
+-   Secrets & sensitive information filtering
 -   Filename, date and timestamp support
 -   Scoped loggers and timers
 -   Scaled logging levels mechanism
@@ -121,7 +121,9 @@ A processor can be added to a logger directly (and is subsequently applied to lo
 
 -   `CallerProcessor` - adds the caller information to the log message
     -   The Meta Object is extended with a file name, line number and column number
--   `RedactProcessor` - redacts sensitive information from the log message (Soon)
+-   `RedactProcessor` - redacts sensitive information from the log message
+> The redact processor needs the "@visulima/redact" package to work.
+> Use `npm install @visulima/redact`, `pnpm add @visulima/redact` or `yarn add @visulima/redact` to install it.
 -   `MessageFormatterProcessor` - formats the log message (Util.format-like unescaped string formatting utility) [@visulima/fmt][fmt]
 -   `ErrorProcessor` - serializes the error with cause object to a std error object that can be serialized.
 

package/dist/processor.browser.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./shared/pail.B85Cx0UJ.cjs");exports.MessageFormatterProcessor=e.g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./shared/pail.B85Cx0UJ.cjs"),r=require("./shared/pail.zsOZqsvh.cjs");exports.MessageFormatterProcessor=e.g;exports.RedactProcessor=r.n;

package/dist/processor.browser.d.cts

@@ -1,5 +1,6 @@
 import { FormatterFunction } from '@visulima/fmt';
-import { j as StringifyAwareProcessor, M as Meta } from './shared/pail.DFxpsgpn.cjs';
+import { j as StringifyAwareProcessor, M as Meta, P as Processor } from './shared/pail.DFxpsgpn.cjs';
+import { Rules, RedactOptions } from '@visulima/redact';
 import '@visulima/colorize';
 
 declare class MessageFormatterProcessor<L extends string = string> implements StringifyAwareProcessor<L> {
@@ -12,4 +13,10 @@ declare class MessageFormatterProcessor<L extends string = string> implements St
     private _format;
 }
 
-export { MessageFormatterProcessor };
+declare class RedactProcessor<L extends string = string> implements Processor<L> {
+    #private;
+    constructor(rules?: Rules, options?: RedactOptions);
+    process(meta: Meta<L>): Meta<L>;
+}
+
+export { MessageFormatterProcessor, RedactProcessor };

package/dist/processor.browser.d.mts

@@ -1,5 +1,6 @@
 import { FormatterFunction } from '@visulima/fmt';
-import { j as StringifyAwareProcessor, M as Meta } from './shared/pail.DFxpsgpn.mjs';
+import { j as StringifyAwareProcessor, M as Meta, P as Processor } from './shared/pail.DFxpsgpn.mjs';
+import { Rules, RedactOptions } from '@visulima/redact';
 import '@visulima/colorize';
 
 declare class MessageFormatterProcessor<L extends string = string> implements StringifyAwareProcessor<L> {
@@ -12,4 +13,10 @@ declare class MessageFormatterProcessor<L extends string = string> implements St
     private _format;
 }
 
-export { MessageFormatterProcessor };
+declare class RedactProcessor<L extends string = string> implements Processor<L> {
+    #private;
+    constructor(rules?: Rules, options?: RedactOptions);
+    process(meta: Meta<L>): Meta<L>;
+}
+
+export { MessageFormatterProcessor, RedactProcessor };

package/dist/processor.browser.d.ts

@@ -1,5 +1,6 @@
 import { FormatterFunction } from '@visulima/fmt';
-import { j as StringifyAwareProcessor, M as Meta } from './shared/pail.DFxpsgpn.js';
+import { j as StringifyAwareProcessor, M as Meta, P as Processor } from './shared/pail.DFxpsgpn.js';
+import { Rules, RedactOptions } from '@visulima/redact';
 import '@visulima/colorize';
 
 declare class MessageFormatterProcessor<L extends string = string> implements StringifyAwareProcessor<L> {
@@ -12,4 +13,10 @@ declare class MessageFormatterProcessor<L extends string = string> implements St
     private _format;
 }
 
-export { MessageFormatterProcessor };
+declare class RedactProcessor<L extends string = string> implements Processor<L> {
+    #private;
+    constructor(rules?: Rules, options?: RedactOptions);
+    process(meta: Meta<L>): Meta<L>;
+}
+
+export { MessageFormatterProcessor, RedactProcessor };

package/dist/processor.browser.mjs

@@ -1 +1 @@
-import{g as o}from"./shared/pail.nEbRCLhY.mjs";export{o as MessageFormatterProcessor};
+import{g as e}from"./shared/pail.nEbRCLhY.mjs";import{n as a}from"./shared/pail._czpAR0Z.mjs";export{e as MessageFormatterProcessor,a as RedactProcessor};

package/dist/processor.server.cjs

@@ -1 +1 @@
-"use strict";var i=Object.defineProperty;var t=(o,e)=>i(o,"name",{value:e,configurable:!0});Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("./shared/pail.C0epjAht.cjs"),c=require("./shared/pail.B85Cx0UJ.cjs");var m=Object.defineProperty,u=t((o,e)=>m(o,"name",{value:e,configurable:!0}),"u");const N=u(()=>{const o=Error.prepareStackTrace;try{let e=[];Error.prepareStackTrace=(l,r)=>{const s=r.slice(1);return e=s,s},new Error().stack;const a=e.reduce((l,r)=>(r.isNative()||r.getFileName()?.includes("pail/dist")||l.push({columnNumber:r.getColumnNumber(),fileName:r.getFileName(),lineNumber:r.getLineNumber()}),l),[])[0];return a?{columnNumber:a.columnNumber??void 0,fileName:a.fileName,lineNumber:a.lineNumber??void 0}:{fileName:"anonymous",lineNumber:void 0}}finally{Error.prepareStackTrace=o}},"getCallerFilename");var b=Object.defineProperty,f=t((o,e)=>b(o,"name",{value:e,configurable:!0}),"r");class g{static{t(this,"a")}static{f(this,"CallerProcessor")}process(e){const{columnNumber:a,fileName:l,lineNumber:r}=N();return e.file={column:a,line:r,name:l},e}}const p=g;exports.ErrorProcessor=n.L;exports.MessageFormatterProcessor=c.g;exports.CallerProcessor=p;
+"use strict";var l=Object.defineProperty;var t=(o,e)=>l(o,"name",{value:e,configurable:!0});Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("./shared/pail.C0epjAht.cjs"),i=require("./shared/pail.B85Cx0UJ.cjs"),m=require("./shared/pail.zsOZqsvh.cjs");var u=Object.defineProperty,N=t((o,e)=>u(o,"name",{value:e,configurable:!0}),"u");const b=N(()=>{const o=Error.prepareStackTrace;try{let e=[];Error.prepareStackTrace=(s,r)=>{const c=r.slice(1);return e=c,c},new Error().stack;const a=e.reduce((s,r)=>(r.isNative()||r.getFileName()?.includes("pail/dist")||s.push({columnNumber:r.getColumnNumber(),fileName:r.getFileName(),lineNumber:r.getLineNumber()}),s),[])[0];return a?{columnNumber:a.columnNumber??void 0,fileName:a.fileName,lineNumber:a.lineNumber??void 0}:{fileName:"anonymous",lineNumber:void 0}}finally{Error.prepareStackTrace=o}},"getCallerFilename");var d=Object.defineProperty,f=t((o,e)=>d(o,"name",{value:e,configurable:!0}),"r");class g{static{t(this,"a")}static{f(this,"CallerProcessor")}process(e){const{columnNumber:a,fileName:s,lineNumber:r}=b();return e.file={column:a,line:r,name:s},e}}const p=g;exports.ErrorProcessor=n.L;exports.MessageFormatterProcessor=i.g;exports.RedactProcessor=m.n;exports.CallerProcessor=p;

package/dist/processor.server.d.cts

@@ -1,7 +1,8 @@
 import { P as Processor, M as Meta } from './shared/pail.DFxpsgpn.cjs';
-export { MessageFormatterProcessor } from './processor.browser.cjs';
+export { MessageFormatterProcessor, RedactProcessor } from './processor.browser.cjs';
 import '@visulima/colorize';
 import '@visulima/fmt';
+import '@visulima/redact';
 
 declare global {
     namespace VisulimaPail {

package/dist/processor.server.d.mts

@@ -1,7 +1,8 @@
 import { P as Processor, M as Meta } from './shared/pail.DFxpsgpn.mjs';
-export { MessageFormatterProcessor } from './processor.browser.mjs';
+export { MessageFormatterProcessor, RedactProcessor } from './processor.browser.mjs';
 import '@visulima/colorize';
 import '@visulima/fmt';
+import '@visulima/redact';
 
 declare global {
     namespace VisulimaPail {

package/dist/processor.server.d.ts

@@ -1,7 +1,8 @@
 import { P as Processor, M as Meta } from './shared/pail.DFxpsgpn.js';
-export { MessageFormatterProcessor } from './processor.browser.js';
+export { MessageFormatterProcessor, RedactProcessor } from './processor.browser.js';
 import '@visulima/colorize';
 import '@visulima/fmt';
+import '@visulima/redact';
 
 declare global {
     namespace VisulimaPail {

package/dist/processor.server.mjs

@@ -1 +1 @@
-var i=Object.defineProperty;var n=(a,e)=>i(a,"name",{value:e,configurable:!0});import{L as d}from"./shared/pail.CNxJnpWG.mjs";import{g as y}from"./shared/pail.nEbRCLhY.mjs";var m=Object.defineProperty,s=n((a,e)=>m(a,"name",{value:e,configurable:!0}),"u");const c=s(()=>{const a=Error.prepareStackTrace;try{let e=[];Error.prepareStackTrace=(l,r)=>{const t=r.slice(1);return e=t,t},new Error().stack;const o=e.reduce((l,r)=>(r.isNative()||r.getFileName()?.includes("pail/dist")||l.push({columnNumber:r.getColumnNumber(),fileName:r.getFileName(),lineNumber:r.getLineNumber()}),l),[])[0];return o?{columnNumber:o.columnNumber??void 0,fileName:o.fileName,lineNumber:o.lineNumber??void 0}:{fileName:"anonymous",lineNumber:void 0}}finally{Error.prepareStackTrace=a}},"getCallerFilename");var u=Object.defineProperty,N=n((a,e)=>u(a,"name",{value:e,configurable:!0}),"r");class b{static{n(this,"a")}static{N(this,"CallerProcessor")}process(e){const{columnNumber:o,fileName:l,lineNumber:r}=c();return e.file={column:o,line:r,name:l},e}}const f=b;export{f as CallerProcessor,d as ErrorProcessor,y as MessageFormatterProcessor};
+var s=Object.defineProperty;var t=(a,e)=>s(a,"name",{value:e,configurable:!0});import{L as g}from"./shared/pail.CNxJnpWG.mjs";import{g as y}from"./shared/pail.nEbRCLhY.mjs";import{n as k}from"./shared/pail._czpAR0Z.mjs";var m=Object.defineProperty,c=t((a,e)=>m(a,"name",{value:e,configurable:!0}),"u");const i=c(()=>{const a=Error.prepareStackTrace;try{let e=[];Error.prepareStackTrace=(l,r)=>{const n=r.slice(1);return e=n,n},new Error().stack;const o=e.reduce((l,r)=>(r.isNative()||r.getFileName()?.includes("pail/dist")||l.push({columnNumber:r.getColumnNumber(),fileName:r.getFileName(),lineNumber:r.getLineNumber()}),l),[])[0];return o?{columnNumber:o.columnNumber??void 0,fileName:o.fileName,lineNumber:o.lineNumber??void 0}:{fileName:"anonymous",lineNumber:void 0}}finally{Error.prepareStackTrace=a}},"getCallerFilename");var u=Object.defineProperty,N=t((a,e)=>u(a,"name",{value:e,configurable:!0}),"r");class b{static{t(this,"a")}static{N(this,"CallerProcessor")}process(e){const{columnNumber:o,fileName:l,lineNumber:r}=i();return e.file={column:o,line:r,name:l},e}}const f=b;export{f as CallerProcessor,g as ErrorProcessor,y as MessageFormatterProcessor,k as RedactProcessor};

package/dist/shared/pail._czpAR0Z.mjs

@@ -0,0 +1,9 @@
+
+// -- pack CommonJS Shims --
+import __cjs_url__ from "node:url";
+import __cjs_path__ from "node:path";
+import __cjs_mod__ from "node:module";
+const __filename = __cjs_url__.fileURLToPath(import.meta.url);
+const __dirname = __cjs_path__.dirname(__filename);
+const require = __cjs_mod__.createRequire(import.meta.url);
+var i=Object.defineProperty;var s=(t,r)=>i(t,"name",{value:r,configurable:!0});var n=Object.defineProperty,h=s((t,r)=>n(t,"name",{value:r,configurable:!0}),"r");class u{static{s(this,"n")}static{h(this,"RedactProcessor")}#r;constructor(r,e){try{const{redact:a,standardRules:c}=require("@visulima/redact");this.#r=o=>a(o,r||c,e)}catch{throw new Error("The '@visulima/redact' package is missing. Make sure to install the '@visulima/redact' package.")}}process(r){return r.message=this.#r(r.message),r.context=this.#r(r.context),r.error=this.#r(r.error),r}}const d=u;export{d as n};

package/dist/shared/pail.zsOZqsvh.cjs

@@ -0,0 +1 @@
+"use strict";var o=Object.defineProperty;var s=(t,r)=>o(t,"name",{value:r,configurable:!0});var n=Object.defineProperty,u=s((t,r)=>n(t,"name",{value:r,configurable:!0}),"r");class h{static{s(this,"n")}static{u(this,"RedactProcessor")}#r;constructor(r,e){try{const{redact:a,standardRules:c}=require("@visulima/redact");this.#r=i=>a(i,r||c,e)}catch{throw new Error("The '@visulima/redact' package is missing. Make sure to install the '@visulima/redact' package.")}}process(r){return r.message=this.#r(r.message),r.context=this.#r(r.context),r.error=this.#r(r.error),r}}const l=h;exports.n=l;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/pail",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Find a file or directory by walking up parent directories.",
   "keywords": [
     "ansi",
@@ -203,6 +203,7 @@
     "@total-typescript/ts-reset": "^0.5.1",
     "@types/node": "18.19.15",
     "@visulima/packem": "^1.0.0-alpha.41",
+    "@visulima/redact": "1.0.2",
     "@vitest/coverage-v8": "^1.6.0",
     "@vitest/ui": "^1.6.0",
     "conventional-changelog-conventionalcommits": "8.0.0",
@@ -217,20 +218,24 @@
     "eslint-plugin-vitest-globals": "^1.5.0",
     "prettier": "^3.3.2",
     "rimraf": "^5.0.7",
-    "type-fest": "^4.20.0",
     "rotating-file-stream": "^3.2.3",
     "secretlint": "8.2.4",
     "semantic-release": "24.0.0",
     "string-length": "^6.0.0",
     "terminal-size": "^4.0.0",
+    "type-fest": "^4.20.0",
     "typescript": "^5.4.5",
     "vitest": "^1.6.0",
     "wrap-ansi": "^9.0.0"
   },
   "peerDependencies": {
+    "@visulima/redact": "1.0.2",
     "rotating-file-stream": "^3.1.1"
   },
   "peerDependenciesMeta": {
+    "@visulima/redact": {
+      "optional": true
+    },
     "rotating-file-stream": {
       "optional": true
     }