@diia-inhouse/diia-logger 4.3.29 → 4.4.0

package/dist/config.js

@@ -2,6 +2,14 @@ import lodash from "lodash";
 import { LogLevel } from "@diia-inhouse/types";
 //#region src/config.ts
 const { merge } = lodash;
+const freeTextFields = [
+	"value",
+	"text",
+	"textItems",
+	"label",
+	"shortText",
+	"accessibilityDescription"
+];
 const defaultOptions = {
 	logLevel: LogLevel.INFO,
 	maxArrayLength: 100,
@@ -28,7 +36,6 @@ const defaultOptions = {
 			"patronymic_name",
 			"passportSeries",
 			"passportNumber",
-			"email",
 			"addressOfRegistration",
 			"addressOfBirth",
 			"birthDay",
@@ -36,13 +43,10 @@ const defaultOptions = {
 			"date_birth",
 			"fio",
 			"passport",
-			"phone",
 			"address",
 			"birthplace",
 			"fullName",
 			"full_name",
-			"phoneNumber",
-			"extraPhoneNumber",
 			"refreshToken",
 			"token",
 			"fName",
@@ -96,11 +100,8 @@ const defaultOptions = {
 			"partnerFullName",
 			"residenceAddress",
 			"displayName",
-			"personalPhone",
 			"content",
 			"subjAddress",
-			"subjPhone",
-			"subjEmail",
 			"subjDrfoCode",
 			"oldLastName",
 			"oldFirstName",
@@ -140,6 +141,19 @@ const defaultOptions = {
 			"paymentPurpose",
 			"subject",
 			"value"
+		],
+		fieldsToRedactEmail: [
+			"email",
+			"subjEmail",
+			...freeTextFields
+		],
+		fieldsToRedactPhone: [
+			"phone",
+			"phoneNumber",
+			"extraPhoneNumber",
+			"personalPhone",
+			"subjPhone",
+			...freeTextFields
 		]
 	}
 };
@@ -152,7 +166,15 @@ const toInternalLoggerOptions = (options = {}) => {
 			fields: new Set(redact.fields),
 			paths: new Set(redact.paths),
 			fieldsToRedactFullname: new Set(redact.fieldsToRedactFullname),
-			fieldsToRedactItn: new Set(redact.fieldsToRedactItn)
+			fieldsToRedactItn: new Set(redact.fieldsToRedactItn),
+			fieldsToRedactEmail: new Set(redact.fieldsToRedactEmail),
+			fieldsToRedactPhone: new Set(redact.fieldsToRedactPhone),
+			fieldsToScan: new Set([
+				...redact.fieldsToRedactFullname || [],
+				...redact.fieldsToRedactItn || [],
+				...redact.fieldsToRedactEmail || [],
+				...redact.fieldsToRedactPhone || []
+			])
 		}
 	};
 };

package/dist/redactors/email.js

@@ -0,0 +1,10 @@
+//#region src/redactors/email.ts
+const EMAIL_PATTERN = /([\w.%+-]+)@([\w.-]+\.[a-z]{2,})/gi;
+function redactEmail(text) {
+	if (!text.includes("@")) return text;
+	return text.replace(EMAIL_PATTERN, (_match, local, domain) => {
+		return `${local.length >= 2 ? local[0] : ""}***@${domain}`;
+	});
+}
+//#endregion
+export { redactEmail };

package/dist/redactors/phone.js

@@ -0,0 +1,17 @@
+//#region src/redactors/phone.ts
+const PHONE_CANDIDATE = /\+?\d[\d\s().-]{7,18}\d/g;
+const nationalDigits = 10;
+const internationalDigits = 12;
+const subscriberDigits = 7;
+function redactPhone(text) {
+	return text.replace(PHONE_CANDIDATE, (match) => maskPhone(match));
+}
+function maskPhone(match) {
+	const digits = match.replace(/\D/g, "");
+	const isNational = digits.length === nationalDigits && digits.startsWith("0");
+	const isInternational = digits.length === internationalDigits;
+	if (!isNational && !isInternational) return match;
+	return `${match.startsWith("+") ? "+" : ""}${digits.slice(0, -subscriberDigits)}${"*".repeat(subscriberDigits - 1)}${digits.slice(-1)}`;
+}
+//#endregion
+export { redactPhone };

package/dist/trimmer.js

@@ -1,6 +1,8 @@
 import { toInternalLoggerOptions } from "./config.js";
+import { redactEmail } from "./redactors/email.js";
 import { redactFullName } from "./redactors/fullName.js";
 import { redactItn } from "./redactors/itn.js";
+import { redactPhone } from "./redactors/phone.js";
 import lodash from "lodash";
 //#region src/trimmer.ts
 const { isObject } = lodash;
@@ -32,8 +34,7 @@ function trimObject(opts, node, depth) {
 			}
 			output[key] = trimWalker(opts, value, depth + 1);
 			if (typeof value === "string" || Array.isArray(value)) {
-				if (opts.redact.fieldsToRedactFullname?.has(key)) output[key] = redactionWalker(opts, key, output[key]);
-				if (opts.redact.fieldsToRedactItn?.has(key)) output[key] = redactionWalker(opts, key, output[key]);
+				if (opts.redact.fieldsToScan.has(key)) output[key] = redactionWalker(opts, key, output[key]);
 				continue;
 			}
 		}
@@ -62,6 +63,8 @@ const redactionWalker = (opts, key, value) => {
 	if (typeof value !== "string") return value;
 	if (opts.redact.fieldsToRedactFullname?.has(key)) value = redactFullName(value);
 	if (opts.redact.fieldsToRedactItn?.has(key)) value = redactItn(value);
+	if (opts.redact.fieldsToRedactEmail?.has(key)) value = redactEmail(value);
+	if (opts.redact.fieldsToRedactPhone?.has(key)) value = redactPhone(value);
 	return value;
 };
 const trimmer = (opts) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@diia-inhouse/diia-logger",
-    "version": "4.3.29",
+    "version": "4.4.0",
     "type": "module",
     "description": "Logger package",
     "main": "dist/index.js",
@@ -44,8 +44,8 @@
         "@diia-inhouse/configs": "7.0.1",
         "@diia-inhouse/eslint-plugin": "1.9.8",
         "@diia-inhouse/oxc-config": "1.11.0",
-        "@diia-inhouse/types": "14.0.0",
-        "@diia-inhouse/utils": "6.0.36",
+        "@diia-inhouse/types": "14.1.0",
+        "@diia-inhouse/utils": "6.0.37",
         "@types/lodash": "4.17.24",
         "@vitest/coverage-v8": "4.1.5",
         "@vitest/ui": "4.1.5",

package/src/config.ts

@@ -7,6 +7,8 @@ import { InternalLoggerOptions } from './interfaces/index.js'
 // oxlint-disable-next-line typescript/unbound-method
 const { merge } = lodash
 
+const freeTextFields = ['value', 'text', 'textItems', 'label', 'shortText', 'accessibilityDescription']
+
 export const defaultOptions: LoggerOptions = {
     logLevel: LogLevel.INFO,
     maxArrayLength: 100,
@@ -33,7 +35,6 @@ export const defaultOptions: LoggerOptions = {
             'patronymic_name',
             'passportSeries',
             'passportNumber',
-            'email',
             'addressOfRegistration',
             'addressOfBirth',
             'birthDay',
@@ -41,13 +42,10 @@ export const defaultOptions: LoggerOptions = {
             'date_birth',
             'fio',
             'passport',
-            'phone',
             'address',
             'birthplace',
             'fullName',
             'full_name',
-            'phoneNumber',
-            'extraPhoneNumber',
             'refreshToken',
             'token',
             'fName',
@@ -101,11 +99,8 @@ export const defaultOptions: LoggerOptions = {
             'partnerFullName',
             'residenceAddress',
             'displayName',
-            'personalPhone',
             'content',
             'subjAddress',
-            'subjPhone',
-            'subjEmail',
             'subjDrfoCode',
             'oldLastName',
             'oldFirstName',
@@ -141,6 +136,8 @@ export const defaultOptions: LoggerOptions = {
             'documents',
         ],
         fieldsToRedactItn: ['label', 'paymentPurpose', 'subject', 'value'],
+        fieldsToRedactEmail: ['email', 'subjEmail', ...freeTextFields],
+        fieldsToRedactPhone: ['phone', 'phoneNumber', 'extraPhoneNumber', 'personalPhone', 'subjPhone', ...freeTextFields],
     },
 }
 
@@ -155,6 +152,14 @@ export const toInternalLoggerOptions = (options: LoggerOptions = {}): InternalLo
             paths: new Set(redact.paths),
             fieldsToRedactFullname: new Set(redact.fieldsToRedactFullname),
             fieldsToRedactItn: new Set(redact.fieldsToRedactItn),
+            fieldsToRedactEmail: new Set(redact.fieldsToRedactEmail),
+            fieldsToRedactPhone: new Set(redact.fieldsToRedactPhone),
+            fieldsToScan: new Set([
+                ...(redact.fieldsToRedactFullname || []),
+                ...(redact.fieldsToRedactItn || []),
+                ...(redact.fieldsToRedactEmail || []),
+                ...(redact.fieldsToRedactPhone || []),
+            ]),
         },
     }
 }

package/src/interfaces/index.ts

@@ -6,5 +6,8 @@ export interface InternalLoggerOptions extends Required<Omit<LoggerOptions, 'red
         paths: Set<string>
         fieldsToRedactFullname: Set<string>
         fieldsToRedactItn: Set<string>
+        fieldsToRedactEmail: Set<string>
+        fieldsToRedactPhone: Set<string>
+        fieldsToScan: Set<string>
     }
 }

package/src/redactors/email.ts

@@ -0,0 +1,13 @@
+const EMAIL_PATTERN = /([\w.%+-]+)@([\w.-]+\.[a-z]{2,})/gi
+
+export function redactEmail(text: string): string {
+    if (!text.includes('@')) {
+        return text
+    }
+
+    return text.replace(EMAIL_PATTERN, (_match, local: string, domain: string) => {
+        const prefix = local.length >= 2 ? local[0] : ''
+
+        return `${prefix}***@${domain}`
+    })
+}

package/src/redactors/phone.ts

@@ -0,0 +1,25 @@
+// Liberal candidate: optional '+', then a digit-led run that may contain spaces,
+// parentheses, dots and dashes. Validated by digit count in maskPhone.
+const PHONE_CANDIDATE = /\+?\d[\d\s().-]{7,18}\d/g
+
+const nationalDigits = 10
+const internationalDigits = 12
+const subscriberDigits = 7
+
+export function redactPhone(text: string): string {
+    return text.replace(PHONE_CANDIDATE, (match) => maskPhone(match))
+}
+
+function maskPhone(match: string): string {
+    const digits = match.replace(/\D/g, '')
+    const isNational = digits.length === nationalDigits && digits.startsWith('0')
+    const isInternational = digits.length === internationalDigits
+    if (!isNational && !isInternational) {
+        return match
+    }
+
+    // Keep the country/operator code and the last digit; mask the subscriber number.
+    const prefix = match.startsWith('+') ? '+' : ''
+
+    return `${prefix}${digits.slice(0, -subscriberDigits)}${'*'.repeat(subscriberDigits - 1)}${digits.slice(-1)}`
+}

package/src/trimmer.ts

@@ -5,8 +5,10 @@ import { LoggerOptions } from '@diia-inhouse/types'
 
 import { toInternalLoggerOptions } from './config.js'
 import { InternalLoggerOptions } from './interfaces/index.js'
+import { redactEmail } from './redactors/email.js'
 import { redactFullName } from './redactors/fullName.js'
 import { redactItn } from './redactors/itn.js'
+import { redactPhone } from './redactors/phone.js'
 
 // oxlint-disable-next-line typescript/unbound-method
 const { isObject } = lodash
@@ -54,11 +56,7 @@ function trimObject(opts: InternalLoggerOptions, node: object, depth: number): o
             output[key] = trimWalker(opts, value, depth + 1)
 
             if (typeof value === 'string' || Array.isArray(value)) {
-                if (opts.redact.fieldsToRedactFullname?.has(key)) {
-                    output[key] = redactionWalker(opts, key, output[key])
-                }
-
-                if (opts.redact.fieldsToRedactItn?.has(key)) {
+                if (opts.redact.fieldsToScan.has(key)) {
                     output[key] = redactionWalker(opts, key, output[key])
                 }
 
@@ -135,6 +133,14 @@ const redactionWalker = (opts: InternalLoggerOptions, key: string, value: string
         value = redactItn(value)
     }
 
+    if (opts.redact.fieldsToRedactEmail?.has(key)) {
+        value = redactEmail(value)
+    }
+
+    if (opts.redact.fieldsToRedactPhone?.has(key)) {
+        value = redactPhone(value)
+    }
+
     return value
 }