Analytics
/

Redaction Utils

Utility library for redacting object keys/values

A tiny utilities library for redacting object keys/values.

Redaction works by checking for any object keys prefixed with $ and then redacts those values.

Note: The redaction is using base64 encoding and is not meant to store secure values.

How to install

Install @analytics/redact-utils from npm.

npm install @analytics/redact-utils

API

Below is the api for @analytics/redact-utils.

redactObject

Redact all object values where the keys are prefixed with $

import { redactObject } from '@analytics/redact-utils'
const original = {
  hi: 'awesome',
  $email: 'foo@bar.com',
  cool: ['1', '2'],
  encode: {
    visible: 'value',
    $nice: {
      $lol: 'this will be encoded'
    },
  },
}
const encoded = redactObject(original)
console.log(encoded)
/*
{
  hi: 'awesome',
  _: [ 'JGVtYWls' ],
  JGVtYWls: 'Zm9vQGJhci5jb20=',
  cool: [ '1', '2' ],
  encode: {
    visible: 'value',
    _: [ 'JG5pY2U=' ],
    'JG5pY2U=': { _: [ 'JGxvbA==' ], 'JGxvbA==': 'dGhpcyB3aWxsIGJlIGVuY29kZWQ=' }
  }
}
*/

restoreObject

Restore object after redaction

import { restoreObject } from '@analytics/redact-utils' 
const encoded = {
  hi: 'awesome',
  _: [ 'JGVtYWls' ],
  JGVtYWls: 'Zm9vQGJhci5jb20=',
  cool: [ '1', '2' ],
  encode: {
    visible: 'value',
    _: [ 'JG5pY2U=' ],
    'JG5pY2U=': { _: [ 'JGxvbA==' ], 'JGxvbA==': 'dGhpcyB3aWxsIGJlIGVuY29kZWQ=' }
  }
}
const decoded = restoreObject(original)
console.log(decoded)
/*
{
  hi: 'awesome',
  $email: 'foo@bar.com',
  cool: ['1', '2'],
  encode: {
    visible: 'value',
    $nice: {
      $lol: 'this will be encoded'
    },
  },
}
*/

// Restore and remove $ prefix
const decodedClean = restoreObject(original, true)
console.log(decodedClean)
/*
{
  hi: 'awesome',
  email: 'foo@bar.com',
  cool: [ '1', '2' ],
  encode: { visible: 'value', nice: { lol: 'this will be encoded' } }
}
*/