node-personal-data-filter - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

index.d.ts

@@ -32,3 +32,20 @@ declare module PersonalDataFilter {
 		personalDataProperties?: string[];
+
+		/**
+		 * Defines if the filter should use the default match replacer to replace each regular
+		 * expression match.
+		 */
+		useDefaultMatchReplacer?: boolean;
+
+		/**
+		 * Sets the match replacer which will be used to replace each regular
+		 * expression match.
+		 */
+		matchReplacer: MatchReplacer;
 	}
+
+	/**
+	 * Function which will be used to replace each regular expression match.
+	 */
+	type MatchReplacer = (match: string) => string
 }
@@ -35,0 +52,0 @@

index.js

 "use strict";
 
 const _ = require("lodash");
+const crypto = require("crypto");
 
@@ -24,2 +25,3 @@ const personalDataProperties = ["email", "useremail", "user", "username", "userid", "accountid", "account", "password", "pass", "pwd", "ip", "ipaddress"];
 		this._setPersonalDataProperties(config);
+		this._setMatchReplacer(config);
 	}
@@ -29,3 +31,3 @@
 		if (_.isString(data)) {
-			return data.replace(this._filterRegExp, this._mask);
+			return this._filterString(data);
 		} else if (_.isArray(data)) {
@@ -52,2 +54,10 @@ return _.map(data, v => this.filter(v));
 
+	_filterString(input) {
+		if (this._matchReplacer) {
+			return input.replace(this._filterRegExp, this._matchReplacer);
+		}
+
+		return input.replace(this._filterRegExp, this._mask)
+	}
+
 	_setRegularExpressions(config) {
@@ -96,4 +106,20 @@ const additionalRegularExpressionsSize = _.size(config.additionalRegularExpressions);
 	}
+
+	_setMatchReplacer(config) {
+		if (config.useDefaultMatchReplacer) {
+			if (config.matchReplacer) {
+				throw new Error("You can't use the default match replacer and a cutom one.");
+			}
+
+			this._matchReplacer = (match) => {
+				return crypto.createHash("sha256").update(match).digest("hex");
+			};
+		}
+
+		if (config.matchReplacer) {
+			this._matchReplacer = config.matchReplacer;
+		}
+	}
 }
 
 module.exports.newFilter = (cfg) => new PersonalDataFilter(cfg);

package.json

 {
   "name": "node-personal-data-filter",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "node-personal-data-filter",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -84,1 +84,20 @@ # node-personal-data-filter
 ```
+- Match replacers:
+```JavaScript
+const pdf = require("node-personal-data-filter");
+
+const cfg = {
+	useDefaultMatchReplacer: true // Use the default match replacer - sha256 sum.
+};
+
+const f = pdf.newFilter(cfg);
+```
+```JavaScript
+const pdf = require("node-personal-data-filter");
+
+const cfg = {
+	matchReplacer: match => `not a secret - ${match}` // Set custom match replacer.
+};
+
+const f = pdf.newFilter(cfg);
+```

No alert changes

Improved metrics

Total package byte prevSize

21548

increased by9.92%

Lines of code

162

increased by47.27%

Number of lines in readme file

103

increased by22.62%

No dependency changes