Visulima redact

Redacts very fast values in objects (includes Error, Map and Set), string and arrays, for secure logging, for public data output and so on, built on top of [compromise](https://github.com/spencermountain/compromise) and [dot-prop](https://github.com/sindresorhus/dot-prop).


[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
---

Daniel Bannert's open source work is supported by the community on GitHub Sponsors

--- ## Why Redact? - Easy to use - Anonymize specific categories in a text, including emails, monetary values, organizations, people, and phone numbers and more. - Customizable anonymization: Specify which categories to anonymize and which to exclude. - Built-in compatibility with nlp NER - compromise. - Does not modify input objects - Performs a deep copy of the input object - Handles circular references - Filters valid JSON strings - Filters valid and malformed URL query params - Filters Errors, Arrays, Maps, Sets, and simple objects - Includes a default set of rules - apikey - awsid - awskey - bankacc - basic_auth - token - crypto - id - creditcard - date - dl - domain - ip - mac_address - phonenumber - routing - ssn - time - uk_nin - url - us_social_security - isbn - zip_code - firstname - lastname - organization - money - bankcc - email - passport - password - username - auth - bearer - credit - CVD - CVV - encrypt - PAN - pass - secret - TypeScript support - Fast and powerful, see the [benchmarks](__bench__/README.md) ## Install ```sh npm install @visulima/redact ``` ```sh yarn add @visulima/redact ``` ```sh pnpm add @visulima/redact ``` ## Usage - redact(input, rules, options) ```typescript const input = { admin: { user: { email: "test@example.com", password: "123456", }, }, password: "123456", user: { email: "test@example.com", password: "123456", }, }; const result = redact(input, ["password", "user.password", "admin.user.password"]); console.log(result); //{ // admin: { // user: { // email: "test@example.com", // password: "", // }, // }, // password: "", // user: { // email: "test@example.com", // password: "", // }, //} ``` - stringAnonymize(input, rules, options) > It uses Natural Language Processing (NLP) and Regular Expressions (Regex) to identify and mask sensitive information in a string. ```typescript import { stringAnonymize } from "@visulima/redact"; const input = "John Doe will be 30 on 2024-06-10."; const result = stringAnonymize(input, defaultModifiers); console.log(result); //" will be 30 on " ``` ## API ### redact(input, rules, options?) #### input Type: `any` The input value to redact. #### rules Type: `(Anonymize | StringAnonymize | number | string)[]` An array of rules to redact. #### options Type: `object` ##### exclude Type: `(string | number)[]` Exclude a rule for the rules array. ##### logger Type: `object` ###### debug Type: `(message?: any, ...optionalParameters: any[]) => void` A function to log debug messages. ### stringAnonymize(input, rules, options?) #### input Type: `string` The input value to redact. #### rules Type: `(Anonymize | StringAnonymize | number | string)[]` An array of rules to redact. #### options Type: `object` ##### exclude Type: `(string | number)[]` Exclude a rule for the rules array. ##### logger Type: `object` ###### debug Type: `(message?: any, ...optionalParameters: any[]) => void` A function to log debug messages. ## Related - [fast-redact](https://github.com/davidmarkclements/fast-redact) - very fast object redaction - [fast-unset](https://github.com/lucagoslar/fast-unset) - 🪄 Efficiently remove, replace, set or default object properties. - [masker](https://github.com/qiwi/masker) - Composite data masking utility - [sensitive-param-filter](https://github.com/zjullion/sensitive-param-filter) - A package for filtering sensitive data (parameters, keys) from a variety of JS objects - [anonymize-nlp](https://github.com/nitaiaharoni1/anonymize-nlp) - Anonymize-NLP is a lightweight and robust package for text anonymization. It uses Natural Language Processing (NLP) and Regular Expressions (Regex) to identify and mask sensitive information in a string. ## Supported Node.js Versions Libraries in this ecosystem make the best effort to track [Node.js’ release schedule](https://github.com/nodejs/release#release-schedule). Here’s [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a). ## Contributing If you would like to help take a look at the [list of issues](https://github.com/visulima/visulima/issues) and check our [Contributing](.github/CONTRIBUTING.md) guild. > **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. ## Credits - [Daniel Bannert](https://github.com/prisis) - [All Contributors](https://github.com/visulima/visulima/graphs/contributors) ## License The visulima redact is open-sourced software licensed under the [MIT][license-url] [typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript [typescript-url]: https://www.typescriptlang.org/ "TypeScript" "typescript" [license-image]: https://img.shields.io/npm/l/@visulima/redact?color=blueviolet&style=for-the-badge [license-url]: LICENSE.md "license" [npm-image]: https://img.shields.io/npm/v/@visulima/redact/latest.svg?style=for-the-badge&logo=npm [npm-url]: https://www.npmjs.com/package/@visulima/redact/v/latest "npm"