@logtape/redaction 0.11.0 → 0.12.0-dev.182

package/deno.json

@@ -0,0 +1,34 @@
+{
+  "name": "@logtape/redaction",
+  "version": "0.12.0-dev.182+c0393214",
+  "license": "MIT",
+  "exports": "./mod.ts",
+  "exclude": [
+    "coverage/",
+    "npm/",
+    ".dnt-import-map.json"
+  ],
+  "tasks": {
+    "build": "pnpm build",
+    "test": "deno test",
+    "test:node": {
+      "dependencies": [
+        "build"
+      ],
+      "command": "node --experimental-transform-types --test"
+    },
+    "test:bun": {
+      "dependencies": [
+        "build"
+      ],
+      "command": "bun test"
+    },
+    "test-all": {
+      "dependencies": [
+        "test",
+        "test:node",
+        "test:bun"
+      ]
+    }
+  }
+}

package/dist/field.cjs

@@ -0,0 +1,101 @@
+
+//#region field.ts
+/**
+* Default field patterns for redaction.  These patterns will match
+* common sensitive fields such as passwords, tokens, and personal
+* information.
+* @since 0.10.0
+*/
+const DEFAULT_REDACT_FIELDS = [
+	/pass(?:code|phrase|word)/i,
+	/secret/i,
+	/token/i,
+	/key/i,
+	/credential/i,
+	/auth/i,
+	/signature/i,
+	/sensitive/i,
+	/private/i,
+	/ssn/i,
+	/email/i,
+	/phone/i,
+	/address/i
+];
+/**
+* Redacts properties in a {@link LogRecord} based on the provided field
+* patterns and action.
+*
+* Note that it is a decorator which wraps the sink and redacts properties
+* before passing them to the sink.
+*
+* @example
+* ```ts
+* import { getConsoleSink } from "@logtape/logtape";
+* import { redactByField } from "@logtape/redaction";
+*
+* const sink = redactByField(getConsoleSink());
+* ```
+*
+* @param sink The sink to wrap.
+* @param options The redaction options.
+* @returns The wrapped sink.
+* @since 0.10.0
+*/
+function redactByField(sink, options = DEFAULT_REDACT_FIELDS) {
+	const opts = Array.isArray(options) ? { fieldPatterns: options } : options;
+	const wrapped = (record) => {
+		sink({
+			...record,
+			properties: redactProperties(record.properties, opts)
+		});
+	};
+	if (Symbol.dispose in sink) wrapped[Symbol.dispose] = sink[Symbol.dispose];
+	if (Symbol.asyncDispose in sink) wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];
+	return wrapped;
+}
+/**
+* Redacts properties from an object based on specified field patterns.
+*
+* This function creates a shallow copy of the input object and applies
+* redaction rules to its properties. For properties that match the redaction
+* patterns, the function either removes them or transforms their values based
+* on the provided action.
+*
+* The redaction process is recursive and will be applied to nested objects
+* as well, allowing for deep redaction of sensitive data in complex object
+* structures.
+* @param properties The properties to redact.
+* @param options The redaction options.
+* @returns The redacted properties.
+* @since 0.10.0
+*/
+function redactProperties(properties, options) {
+	const copy = { ...properties };
+	for (const field in copy) {
+		if (shouldFieldRedacted(field, options.fieldPatterns)) {
+			if (options.action == null || options.action === "delete") delete copy[field];
+			else copy[field] = options.action(copy[field]);
+			continue;
+		}
+		const value = copy[field];
+		if (typeof value === "object" && value !== null && (Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null)) copy[field] = redactProperties(value, options);
+	}
+	return copy;
+}
+/**
+* Checks if a field should be redacted based on the provided field patterns.
+* @param field The field name to check.
+* @param fieldPatterns The field patterns to match against.
+* @returns `true` if the field should be redacted, `false` otherwise.
+* @since 0.10.0
+*/
+function shouldFieldRedacted(field, fieldPatterns) {
+	for (const fieldPattern of fieldPatterns) if (typeof fieldPattern === "string") {
+		if (fieldPattern === field) return true;
+	} else if (fieldPattern.test(field)) return true;
+	return false;
+}
+
+//#endregion
+exports.DEFAULT_REDACT_FIELDS = DEFAULT_REDACT_FIELDS;
+exports.redactByField = redactByField;

package/dist/field.d.cts

@@ -0,0 +1,88 @@
+import { Sink } from "@logtape/logtape";
+
+//#region field.d.ts
+
+/**
+ * The type for a field pattern used in redaction.  A string or a regular
+ * expression that matches field names.
+ * @since 0.10.0
+ */
+type FieldPattern = string | RegExp;
+/**
+ * An array of field patterns used for redaction.  Each pattern can be
+ * a string or a regular expression that matches field names.
+ * @since 0.10.0
+ */
+type FieldPatterns = FieldPattern[];
+/**
+ * Default field patterns for redaction.  These patterns will match
+ * common sensitive fields such as passwords, tokens, and personal
+ * information.
+ * @since 0.10.0
+ */
+declare const DEFAULT_REDACT_FIELDS: FieldPatterns;
+/**
+ * Options for redacting fields in a {@link LogRecord}.  Used by
+ * the {@link redactByField} function.
+ * @since 0.10.0
+ */
+interface FieldRedactionOptions {
+  /**
+   * The field patterns to match against.  This can be an array of
+   * strings or regular expressions.  If a field matches any of the
+   * patterns, it will be redacted.
+   * @defaultValue {@link DEFAULT_REDACT_FIELDS}
+   */
+  readonly fieldPatterns: FieldPatterns;
+  /**
+   * The action to perform on the matched fields.  If not provided,
+   * the default action is to delete the field from the properties.
+   * If a function is provided, it will be called with the
+   * value of the field, and the return value will be used to replace
+   * the field in the properties.
+   * If the action is `"delete"`, the field will be removed from the
+   * properties.
+   * @default `"delete"`
+   */
+  readonly action?: "delete" | ((value: unknown) => unknown);
+}
+/**
+ * Redacts properties in a {@link LogRecord} based on the provided field
+ * patterns and action.
+ *
+ * Note that it is a decorator which wraps the sink and redacts properties
+ * before passing them to the sink.
+ *
+ * @example
+ * ```ts
+ * import { getConsoleSink } from "@logtape/logtape";
+ * import { redactByField } from "@logtape/redaction";
+ *
+ * const sink = redactByField(getConsoleSink());
+ * ```
+ *
+ * @param sink The sink to wrap.
+ * @param options The redaction options.
+ * @returns The wrapped sink.
+ * @since 0.10.0
+ */
+declare function redactByField(sink: Sink | Sink & Disposable | Sink & AsyncDisposable, options?: FieldRedactionOptions | FieldPatterns): Sink | Sink & Disposable | Sink & AsyncDisposable;
+/**
+ * Redacts properties from an object based on specified field patterns.
+ *
+ * This function creates a shallow copy of the input object and applies
+ * redaction rules to its properties. For properties that match the redaction
+ * patterns, the function either removes them or transforms their values based
+ * on the provided action.
+ *
+ * The redaction process is recursive and will be applied to nested objects
+ * as well, allowing for deep redaction of sensitive data in complex object
+ * structures.
+ * @param properties The properties to redact.
+ * @param options The redaction options.
+ * @returns The redacted properties.
+ * @since 0.10.0
+ */
+//#endregion
+export { DEFAULT_REDACT_FIELDS, FieldPattern, FieldPatterns, FieldRedactionOptions, redactByField };
+//# sourceMappingURL=field.d.cts.map

package/dist/field.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.cts","names":[],"sources":["../field.ts"],"sourcesContent":[],"mappings":";;;;;;AAOA;AAOA;AAQA;AAqBiB,KApCL,YAAA,GAoCK,MAAqB,GApCF,MA2CV;AAmC1B;;;;;AACmC,KAxEvB,aAAA,GAAgB,YAwEO,EAAA;;;;;;;AAEL,cAlEjB,qBAkEiB,EAlEM,aAkEN;;AAAsB;;;;UA7CnC,qBAAA;;;;;;;0BAOS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCV,aAAA,OACR,OAAO,OAAO,aAAa,OAAO,2BAC/B,wBAAwB,gBAChC,OAAO,OAAO,aAAa,OAAO"}

package/{types → dist}/field.d.ts

@@ -1,47 +1,50 @@
-import type { Sink } from "@logtape/logtape";
+import { Sink } from "@logtape/logtape";
+
+//#region field.d.ts
+
 /**
  * The type for a field pattern used in redaction.  A string or a regular
  * expression that matches field names.
  * @since 0.10.0
  */
-export type FieldPattern = string | RegExp;
+type FieldPattern = string | RegExp;
 /**
  * An array of field patterns used for redaction.  Each pattern can be
  * a string or a regular expression that matches field names.
  * @since 0.10.0
  */
-export type FieldPatterns = FieldPattern[];
+type FieldPatterns = FieldPattern[];
 /**
  * Default field patterns for redaction.  These patterns will match
  * common sensitive fields such as passwords, tokens, and personal
  * information.
  * @since 0.10.0
  */
-export declare const DEFAULT_REDACT_FIELDS: FieldPatterns;
+declare const DEFAULT_REDACT_FIELDS: FieldPatterns;
 /**
  * Options for redacting fields in a {@link LogRecord}.  Used by
  * the {@link redactByField} function.
  * @since 0.10.0
  */
-export interface FieldRedactionOptions {
-    /**
-     * The field patterns to match against.  This can be an array of
-     * strings or regular expressions.  If a field matches any of the
-     * patterns, it will be redacted.
-     * @defaultValue {@link DEFAULT_REDACT_FIELDS}
-     */
-    readonly fieldPatterns: FieldPatterns;
-    /**
-     * The action to perform on the matched fields.  If not provided,
-     * the default action is to delete the field from the properties.
-     * If a function is provided, it will be called with the
-     * value of the field, and the return value will be used to replace
-     * the field in the properties.
-     * If the action is `"delete"`, the field will be removed from the
-     * properties.
-     * @default `"delete"`
-     */
-    readonly action?: "delete" | ((value: unknown) => unknown);
+interface FieldRedactionOptions {
+  /**
+   * The field patterns to match against.  This can be an array of
+   * strings or regular expressions.  If a field matches any of the
+   * patterns, it will be redacted.
+   * @defaultValue {@link DEFAULT_REDACT_FIELDS}
+   */
+  readonly fieldPatterns: FieldPatterns;
+  /**
+   * The action to perform on the matched fields.  If not provided,
+   * the default action is to delete the field from the properties.
+   * If a function is provided, it will be called with the
+   * value of the field, and the return value will be used to replace
+   * the field in the properties.
+   * If the action is `"delete"`, the field will be removed from the
+   * properties.
+   * @default `"delete"`
+   */
+  readonly action?: "delete" | ((value: unknown) => unknown);
 }
 /**
  * Redacts properties in a {@link LogRecord} based on the provided field
@@ -63,7 +66,7 @@ export interface FieldRedactionOptions {
  * @returns The wrapped sink.
  * @since 0.10.0
  */
-export declare function redactByField(sink: Sink | Sink & Disposable | Sink & AsyncDisposable, options?: FieldRedactionOptions | FieldPatterns): Sink | Sink & Disposable | Sink & AsyncDisposable;
+declare function redactByField(sink: Sink | Sink & Disposable | Sink & AsyncDisposable, options?: FieldRedactionOptions | FieldPatterns): Sink | Sink & Disposable | Sink & AsyncDisposable;
 /**
  * Redacts properties from an object based on specified field patterns.
  *
@@ -80,13 +83,6 @@ export declare function redactByField(sink: Sink | Sink & Disposable | Sink & As
  * @returns The redacted properties.
  * @since 0.10.0
  */
-export declare function redactProperties(properties: Record<string, unknown>, options: FieldRedactionOptions): Record<string, unknown>;
-/**
- * Checks if a field should be redacted based on the provided field patterns.
- * @param field The field name to check.
- * @param fieldPatterns The field patterns to match against.
- * @returns `true` if the field should be redacted, `false` otherwise.
- * @since 0.10.0
- */
-export declare function shouldFieldRedacted(field: string, fieldPatterns: FieldPatterns): boolean;
+//#endregion
+export { DEFAULT_REDACT_FIELDS, FieldPattern, FieldPatterns, FieldRedactionOptions, redactByField };
 //# sourceMappingURL=field.d.ts.map

package/dist/field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","names":[],"sources":["../field.ts"],"sourcesContent":[],"mappings":";;;;;;AAOA;AAOA;AAQA;AAqBiB,KApCL,YAAA,GAoCK,MAAqB,GApCF,MA2CV;AAmC1B;;;;;AACmC,KAxEvB,aAAA,GAAgB,YAwEO,EAAA;;;;;;;AAEL,cAlEjB,qBAkEiB,EAlEM,aAkEN;;AAAsB;;;;UA7CnC,qBAAA;;;;;;;0BAOS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCV,aAAA,OACR,OAAO,OAAO,aAAa,OAAO,2BAC/B,wBAAwB,gBAChC,OAAO,OAAO,aAAa,OAAO"}

package/dist/field.js

@@ -0,0 +1,100 @@
+//#region field.ts
+/**
+* Default field patterns for redaction.  These patterns will match
+* common sensitive fields such as passwords, tokens, and personal
+* information.
+* @since 0.10.0
+*/
+const DEFAULT_REDACT_FIELDS = [
+	/pass(?:code|phrase|word)/i,
+	/secret/i,
+	/token/i,
+	/key/i,
+	/credential/i,
+	/auth/i,
+	/signature/i,
+	/sensitive/i,
+	/private/i,
+	/ssn/i,
+	/email/i,
+	/phone/i,
+	/address/i
+];
+/**
+* Redacts properties in a {@link LogRecord} based on the provided field
+* patterns and action.
+*
+* Note that it is a decorator which wraps the sink and redacts properties
+* before passing them to the sink.
+*
+* @example
+* ```ts
+* import { getConsoleSink } from "@logtape/logtape";
+* import { redactByField } from "@logtape/redaction";
+*
+* const sink = redactByField(getConsoleSink());
+* ```
+*
+* @param sink The sink to wrap.
+* @param options The redaction options.
+* @returns The wrapped sink.
+* @since 0.10.0
+*/
+function redactByField(sink, options = DEFAULT_REDACT_FIELDS) {
+	const opts = Array.isArray(options) ? { fieldPatterns: options } : options;
+	const wrapped = (record) => {
+		sink({
+			...record,
+			properties: redactProperties(record.properties, opts)
+		});
+	};
+	if (Symbol.dispose in sink) wrapped[Symbol.dispose] = sink[Symbol.dispose];
+	if (Symbol.asyncDispose in sink) wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];
+	return wrapped;
+}
+/**
+* Redacts properties from an object based on specified field patterns.
+*
+* This function creates a shallow copy of the input object and applies
+* redaction rules to its properties. For properties that match the redaction
+* patterns, the function either removes them or transforms their values based
+* on the provided action.
+*
+* The redaction process is recursive and will be applied to nested objects
+* as well, allowing for deep redaction of sensitive data in complex object
+* structures.
+* @param properties The properties to redact.
+* @param options The redaction options.
+* @returns The redacted properties.
+* @since 0.10.0
+*/
+function redactProperties(properties, options) {
+	const copy = { ...properties };
+	for (const field in copy) {
+		if (shouldFieldRedacted(field, options.fieldPatterns)) {
+			if (options.action == null || options.action === "delete") delete copy[field];
+			else copy[field] = options.action(copy[field]);
+			continue;
+		}
+		const value = copy[field];
+		if (typeof value === "object" && value !== null && (Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null)) copy[field] = redactProperties(value, options);
+	}
+	return copy;
+}
+/**
+* Checks if a field should be redacted based on the provided field patterns.
+* @param field The field name to check.
+* @param fieldPatterns The field patterns to match against.
+* @returns `true` if the field should be redacted, `false` otherwise.
+* @since 0.10.0
+*/
+function shouldFieldRedacted(field, fieldPatterns) {
+	for (const fieldPattern of fieldPatterns) if (typeof fieldPattern === "string") {
+		if (fieldPattern === field) return true;
+	} else if (fieldPattern.test(field)) return true;
+	return false;
+}
+
+//#endregion
+export { DEFAULT_REDACT_FIELDS, redactByField };
+//# sourceMappingURL=field.js.map

package/dist/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","names":["DEFAULT_REDACT_FIELDS: FieldPatterns","sink: Sink | Sink & Disposable | Sink & AsyncDisposable","options: FieldRedactionOptions | FieldPatterns","record: LogRecord","properties: Record<string, unknown>","options: FieldRedactionOptions","field: string","fieldPatterns: FieldPatterns"],"sources":["../field.ts"],"sourcesContent":["import type { LogRecord, Sink } from \"@logtape/logtape\";\n\n/**\n * The type for a field pattern used in redaction.  A string or a regular\n * expression that matches field names.\n * @since 0.10.0\n */\nexport type FieldPattern = string | RegExp;\n\n/**\n * An array of field patterns used for redaction.  Each pattern can be\n * a string or a regular expression that matches field names.\n * @since 0.10.0\n */\nexport type FieldPatterns = FieldPattern[];\n\n/**\n * Default field patterns for redaction.  These patterns will match\n * common sensitive fields such as passwords, tokens, and personal\n * information.\n * @since 0.10.0\n */\nexport const DEFAULT_REDACT_FIELDS: FieldPatterns = [\n  /pass(?:code|phrase|word)/i,\n  /secret/i,\n  /token/i,\n  /key/i,\n  /credential/i,\n  /auth/i,\n  /signature/i,\n  /sensitive/i,\n  /private/i,\n  /ssn/i,\n  /email/i,\n  /phone/i,\n  /address/i,\n];\n\n/**\n * Options for redacting fields in a {@link LogRecord}.  Used by\n * the {@link redactByField} function.\n * @since 0.10.0\n */\nexport interface FieldRedactionOptions {\n  /**\n   * The field patterns to match against.  This can be an array of\n   * strings or regular expressions.  If a field matches any of the\n   * patterns, it will be redacted.\n   * @defaultValue {@link DEFAULT_REDACT_FIELDS}\n   */\n  readonly fieldPatterns: FieldPatterns;\n\n  /**\n   * The action to perform on the matched fields.  If not provided,\n   * the default action is to delete the field from the properties.\n   * If a function is provided, it will be called with the\n   * value of the field, and the return value will be used to replace\n   * the field in the properties.\n   * If the action is `\"delete\"`, the field will be removed from the\n   * properties.\n   * @default `\"delete\"`\n   */\n  readonly action?: \"delete\" | ((value: unknown) => unknown);\n}\n\n/**\n * Redacts properties in a {@link LogRecord} based on the provided field\n * patterns and action.\n *\n * Note that it is a decorator which wraps the sink and redacts properties\n * before passing them to the sink.\n *\n * @example\n * ```ts\n * import { getConsoleSink } from \"@logtape/logtape\";\n * import { redactByField } from \"@logtape/redaction\";\n *\n * const sink = redactByField(getConsoleSink());\n * ```\n *\n * @param sink The sink to wrap.\n * @param options The redaction options.\n * @returns The wrapped sink.\n * @since 0.10.0\n */\nexport function redactByField(\n  sink: Sink | Sink & Disposable | Sink & AsyncDisposable,\n  options: FieldRedactionOptions | FieldPatterns = DEFAULT_REDACT_FIELDS,\n): Sink | Sink & Disposable | Sink & AsyncDisposable {\n  const opts = Array.isArray(options) ? { fieldPatterns: options } : options;\n  const wrapped = (record: LogRecord) => {\n    sink({ ...record, properties: redactProperties(record.properties, opts) });\n  };\n  if (Symbol.dispose in sink) wrapped[Symbol.dispose] = sink[Symbol.dispose];\n  if (Symbol.asyncDispose in sink) {\n    wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];\n  }\n  return wrapped;\n}\n\n/**\n * Redacts properties from an object based on specified field patterns.\n *\n * This function creates a shallow copy of the input object and applies\n * redaction rules to its properties. For properties that match the redaction\n * patterns, the function either removes them or transforms their values based\n * on the provided action.\n *\n * The redaction process is recursive and will be applied to nested objects\n * as well, allowing for deep redaction of sensitive data in complex object\n * structures.\n * @param properties The properties to redact.\n * @param options The redaction options.\n * @returns The redacted properties.\n * @since 0.10.0\n */\nexport function redactProperties(\n  properties: Record<string, unknown>,\n  options: FieldRedactionOptions,\n): Record<string, unknown> {\n  const copy = { ...properties };\n  for (const field in copy) {\n    if (shouldFieldRedacted(field, options.fieldPatterns)) {\n      if (options.action == null || options.action === \"delete\") {\n        delete copy[field];\n      } else {\n        copy[field] = options.action(copy[field]);\n      }\n      continue;\n    }\n    const value = copy[field];\n    // Check if value is a vanilla object:\n    if (\n      typeof value === \"object\" && value !== null &&\n      (Object.getPrototypeOf(value) === Object.prototype ||\n        Object.getPrototypeOf(value) === null)\n    ) {\n      // @ts-ignore: value is always Record<string, unknown>\n      copy[field] = redactProperties(value, options);\n    }\n  }\n  return copy;\n}\n\n/**\n * Checks if a field should be redacted based on the provided field patterns.\n * @param field The field name to check.\n * @param fieldPatterns The field patterns to match against.\n * @returns `true` if the field should be redacted, `false` otherwise.\n * @since 0.10.0\n */\nexport function shouldFieldRedacted(\n  field: string,\n  fieldPatterns: FieldPatterns,\n): boolean {\n  for (const fieldPattern of fieldPatterns) {\n    if (typeof fieldPattern === \"string\") {\n      if (fieldPattern === field) return true;\n    } else {\n      if (fieldPattern.test(field)) return true;\n    }\n  }\n  return false;\n}\n"],"mappings":";;;;;;;AAsBA,MAAaA,wBAAuC;CAClD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;;;;;;;;;;;;;;;;AAiDD,SAAgB,cACdC,MACAC,UAAiD,uBACE;CACnD,MAAM,OAAO,MAAM,QAAQ,QAAQ,GAAG,EAAE,eAAe,QAAS,IAAG;CACnE,MAAM,UAAU,CAACC,WAAsB;AACrC,OAAK;GAAE,GAAG;GAAQ,YAAY,iBAAiB,OAAO,YAAY,KAAK;EAAE,EAAC;CAC3E;AACD,KAAI,OAAO,WAAW,KAAM,SAAQ,OAAO,WAAW,KAAK,OAAO;AAClE,KAAI,OAAO,gBAAgB,KACzB,SAAQ,OAAO,gBAAgB,KAAK,OAAO;AAE7C,QAAO;AACR;;;;;;;;;;;;;;;;;AAkBD,SAAgB,iBACdC,YACAC,SACyB;CACzB,MAAM,OAAO,EAAE,GAAG,WAAY;AAC9B,MAAK,MAAM,SAAS,MAAM;AACxB,MAAI,oBAAoB,OAAO,QAAQ,cAAc,EAAE;AACrD,OAAI,QAAQ,UAAU,QAAQ,QAAQ,WAAW,SAC/C,QAAO,KAAK;OAEZ,MAAK,SAAS,QAAQ,OAAO,KAAK,OAAO;AAE3C;EACD;EACD,MAAM,QAAQ,KAAK;AAEnB,aACS,UAAU,YAAY,UAAU,SACtC,OAAO,eAAe,MAAM,KAAK,OAAO,aACvC,OAAO,eAAe,MAAM,KAAK,MAGnC,MAAK,SAAS,iBAAiB,OAAO,QAAQ;CAEjD;AACD,QAAO;AACR;;;;;;;;AASD,SAAgB,oBACdC,OACAC,eACS;AACT,MAAK,MAAM,gBAAgB,cACzB,YAAW,iBAAiB,UAC1B;MAAI,iBAAiB,MAAO,QAAO;CAAK,WAEpC,aAAa,KAAK,MAAM,CAAE,QAAO;AAGzC,QAAO;AACR"}

package/dist/mod.cjs

@@ -0,0 +1,11 @@
+const require_field = require('./field.cjs');
+const require_pattern = require('./pattern.cjs');
+
+exports.CREDIT_CARD_NUMBER_PATTERN = require_pattern.CREDIT_CARD_NUMBER_PATTERN;
+exports.DEFAULT_REDACT_FIELDS = require_field.DEFAULT_REDACT_FIELDS;
+exports.EMAIL_ADDRESS_PATTERN = require_pattern.EMAIL_ADDRESS_PATTERN;
+exports.JWT_PATTERN = require_pattern.JWT_PATTERN;
+exports.KR_RRN_PATTERN = require_pattern.KR_RRN_PATTERN;
+exports.US_SSN_PATTERN = require_pattern.US_SSN_PATTERN;
+exports.redactByField = require_field.redactByField;
+exports.redactByPattern = require_pattern.redactByPattern;

package/dist/mod.d.cts

@@ -0,0 +1,3 @@
+import { DEFAULT_REDACT_FIELDS, FieldPattern, FieldPatterns, FieldRedactionOptions, redactByField } from "./field.cjs";
+import { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern } from "./pattern.cjs";
+export { CREDIT_CARD_NUMBER_PATTERN, DEFAULT_REDACT_FIELDS, EMAIL_ADDRESS_PATTERN, FieldPattern, FieldPatterns, FieldRedactionOptions, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByField, redactByPattern };

package/dist/mod.d.ts

@@ -0,0 +1,3 @@
+import { DEFAULT_REDACT_FIELDS, FieldPattern, FieldPatterns, FieldRedactionOptions, redactByField } from "./field.js";
+import { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern } from "./pattern.js";
+export { CREDIT_CARD_NUMBER_PATTERN, DEFAULT_REDACT_FIELDS, EMAIL_ADDRESS_PATTERN, FieldPattern, FieldPatterns, FieldRedactionOptions, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByField, redactByPattern };

package/dist/mod.js

@@ -0,0 +1,4 @@
+import { DEFAULT_REDACT_FIELDS, redactByField } from "./field.js";
+import { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, US_SSN_PATTERN, redactByPattern } from "./pattern.js";
+
+export { CREDIT_CARD_NUMBER_PATTERN, DEFAULT_REDACT_FIELDS, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, US_SSN_PATTERN, redactByField, redactByPattern };

package/dist/pattern.cjs

@@ -0,0 +1,75 @@
+
+//#region pattern.ts
+/**
+* A redaction pattern for email addresses.
+* @since 0.10.0
+*/
+const EMAIL_ADDRESS_PATTERN = {
+	pattern: /[\p{L}0-9.!#$%&'*+/=?^_`{|}~-]+@[\p{L}0-9](?:[\p{L}0-9-]{0,61}[\p{L}0-9])?(?:\.[\p{L}0-9](?:[\p{L}0-9-]{0,61}[\p{L}0-9])?)+/gu,
+	replacement: "REDACTED@EMAIL.ADDRESS"
+};
+/**
+* A redaction pattern for credit card numbers (including American Express).
+* @since 0.10.0
+*/
+const CREDIT_CARD_NUMBER_PATTERN = {
+	pattern: /(?:\d{4}-){3}\d{4}|(?:\d{4}-){2}\d{6}/g,
+	replacement: "XXXX-XXXX-XXXX-XXXX"
+};
+/**
+* A redaction pattern for U.S. Social Security numbers.
+* @since 0.10.0
+*/
+const US_SSN_PATTERN = {
+	pattern: /\d{3}-\d{2}-\d{4}/g,
+	replacement: "XXX-XX-XXXX"
+};
+/**
+* A redaction pattern for South Korean resident registration numbers
+* (住民登錄番號).
+* @since 0.10.0
+*/
+const KR_RRN_PATTERN = {
+	pattern: /\d{6}-\d{7}/g,
+	replacement: "XXXXXX-XXXXXXX"
+};
+/**
+* A redaction pattern for JSON Web Tokens (JWT).
+* @since 0.10.0
+*/
+const JWT_PATTERN = {
+	pattern: /eyJ[a-zA-Z0-9_-]*\.[a-zA-Z0-9_-]*\.[a-zA-Z0-9_-]*/g,
+	replacement: "[JWT REDACTED]"
+};
+function redactByPattern(formatter, patterns) {
+	for (const { pattern } of patterns) if (!pattern.global) throw new TypeError(`Pattern ${pattern} does not have the global flag set.`);
+	function replaceString(str) {
+		for (const p of patterns) str = typeof p.replacement === "string" ? str.replaceAll(p.pattern, p.replacement) : str.replaceAll(p.pattern, p.replacement);
+		return str;
+	}
+	function replaceObject(object) {
+		if (typeof object === "string") return replaceString(object);
+		else if (Array.isArray(object)) return object.map(replaceObject);
+		else if (typeof object === "object" && object !== null) {
+			if (Object.getPrototypeOf(object) === Object.prototype || Object.getPrototypeOf(object) === null) {
+				const redacted = {};
+				for (const key in object) redacted[key] = replaceObject(object[key]);
+				return redacted;
+			}
+		}
+		return object;
+	}
+	return (record) => {
+		const output = formatter(record);
+		if (typeof output === "string") return replaceString(output);
+		return output.map(replaceObject);
+	};
+}
+
+//#endregion
+exports.CREDIT_CARD_NUMBER_PATTERN = CREDIT_CARD_NUMBER_PATTERN;
+exports.EMAIL_ADDRESS_PATTERN = EMAIL_ADDRESS_PATTERN;
+exports.JWT_PATTERN = JWT_PATTERN;
+exports.KR_RRN_PATTERN = KR_RRN_PATTERN;
+exports.US_SSN_PATTERN = US_SSN_PATTERN;
+exports.redactByPattern = redactByPattern;

package/dist/pattern.d.cts

@@ -0,0 +1,126 @@
+import { ConsoleFormatter, TextFormatter } from "@logtape/logtape";
+
+//#region pattern.d.ts
+
+/**
+ * A redaction pattern, which is a pair of regular expression and replacement
+ * string or function.
+ * @since 0.10.0
+ */
+interface RedactionPattern {
+  /**
+   * The regular expression to match against.  Note that it must have the
+   * `g` (global) flag set, otherwise it will throw a `TypeError`.
+   */
+  readonly pattern: RegExp;
+  /**
+   * The replacement string or function.  If the replacement is a function,
+   * it will be called with the matched string and any capture groups (the same
+   * signature as `String.prototype.replaceAll()`).
+   */
+  readonly replacement: string | ((match: string, ...rest: readonly any[]) => string);
+}
+/**
+ * A redaction pattern for email addresses.
+ * @since 0.10.0
+ */
+declare const EMAIL_ADDRESS_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for credit card numbers (including American Express).
+ * @since 0.10.0
+ */
+declare const CREDIT_CARD_NUMBER_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for U.S. Social Security numbers.
+ * @since 0.10.0
+ */
+declare const US_SSN_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for South Korean resident registration numbers
+ * (住民登錄番號).
+ * @since 0.10.0
+ */
+declare const KR_RRN_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for JSON Web Tokens (JWT).
+ * @since 0.10.0
+ */
+declare const JWT_PATTERN: RedactionPattern;
+/**
+ * A list of {@link RedactionPattern}s.
+ * @since 0.10.0
+ */
+type RedactionPatterns = readonly RedactionPattern[];
+/**
+ * Applies data redaction to a {@link TextFormatter}.
+ *
+ * Note that there are some built-in redaction patterns:
+ *
+ * - {@link CREDIT_CARD_NUMBER_PATTERN}
+ * - {@link EMAIL_ADDRESS_PATTERN}
+ * - {@link JWT_PATTERN}
+ * - {@link KR_RRN_PATTERN}
+ * - {@link US_SSN_PATTERN}
+ *
+ * @example
+ * ```ts
+ * import { getFileSink } from "@logtape/file";
+ * import { getAnsiColorFormatter } from "@logtape/logtape";
+ * import {
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ *   redactByPattern,
+ * } from "@logtape/redaction";
+ *
+ * const formatter = redactByPattern(getAnsiConsoleFormatter(), [
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ * ]);
+ * const sink = getFileSink("my-app.log", { formatter });
+ * ```
+ * @param formatter The text formatter to apply redaction to.
+ * @param patterns The redaction patterns to apply.
+ * @returns The redacted text formatter.
+ * @since 0.10.0
+ */
+declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPatterns): TextFormatter;
+/**
+ * Applies data redaction to a {@link ConsoleFormatter}.
+ *
+ * Note that there are some built-in redaction patterns:
+ *
+ * - {@link CREDIT_CARD_NUMBER_PATTERN}
+ * - {@link EMAIL_ADDRESS_PATTERN}
+ * - {@link JWT_PATTERN}
+ * - {@link KR_RRN_PATTERN}
+ * - {@link US_SSN_PATTERN}
+ *
+ * @example
+ * ```ts
+ * import { defaultConsoleFormatter, getConsoleSink } from "@logtape/logtape";
+ * import {
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ *   redactByPattern,
+ * } from "@logtape/redaction";
+ *
+ * const formatter = redactByPattern(defaultConsoleFormatter, [
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ * ]);
+ * const sink = getConsoleSink({ formatter });
+ * ```
+ * @param formatter The console formatter to apply redaction to.
+ * @param patterns The redaction patterns to apply.
+ * @returns The redacted console formatter.
+ * @since 0.10.0
+ */
+declare function redactByPattern(formatter: ConsoleFormatter, patterns: RedactionPatterns): ConsoleFormatter;
+//# sourceMappingURL=pattern.d.ts.map
+//#endregion
+export { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern };
+//# sourceMappingURL=pattern.d.cts.map