@naturalcycles/scrubber-lib

Scrub data in JavaScript plain objects by using rules defined in a configuration object

How to use

Install it:

yarn add -D @naturalcycles/scrubber-lib

Define a scrubber configuration object:

import { ScrubberConfig, Scrubber } from '@naturalcycles/scrubber-lib'

const cfg: ScrubberConfig = {
  fields: {
    name: {
      scrubber: 'staticScrubber',
      params: {
        replacement: 'John Doe',
      },
    },
    password: {
      scrubber: 'undefinedScrubber',
    },
  },
  throwOnError: true,
}

Scrub a single object:

const object = { name: 'Real Name', password: 'secret' }

const scrubber = new Scrubber(cfg)
const scrubbedObject = scrubber.scrub(object)

// scrubbedObject =  name: 'John Doe', password: undefined }

Scrub an array of objects:

const objects = [object1, object2, object3]

const scrubbedObjects = scrubber.scrub(objects)

Public API

constructor (private cfg: ScrubberConfig, additionalScrubbersImpl?: ScrubbersImpl)
scrub<T> (data: T): T

Features

• Objects are deep traversed
• Immutable changes (does not mutate the original object)
• TypeScript library, compatible both on browsers and NodeJS
• Fields are scrubbed if object keys match the field names on the configuration file
• Provides a few built-in scrubber functions
• Allows additional scrubber functions
• Validates config object on class initialization to ensure all defined scrubber functions exist
• Supports field names to be comma-separated on configuration file
• Error handling: all errors are logged and allows a cfg.throwOnError optional configuration to re-throw errors

Limitations

• Objects of types Map and Set are currently not traversed

Vocabulary

The scrubber-lib supports a ScrubberConfig parameter on initialization which is usually defined by clients on a scrubber configuration file (YAML or JSON) with multiple scrubbing profiles (such as anonymization, pseudo-anonymization, etc).

The library applies scrubber functions to the given objects. It provides some built-in scrubber functions while also allowing custom scrubber functions implementations.

Possible use cases

Allows, for example, removal of sensitive data for:

• Logs
• Error reporting to third-party services
• Data exports (such as staging or other data exports)
• Anonymizing production users (GDPR "right to be forgotten")

Packaging

• engines.node >= 10.13: Latest Node.js LTS
• main: dist/index.js: commonjs, es2018
• types: dist/index.d.ts: typescript types
• /src folder with source *.ts files included