@report-toolkit/transformers/src/filter.js

See docs at [https://ibm.github.io/report-toolkit](https://ibm.github.io/report-toolkit)

/**
 * A general-purpose filtering Transformer, which allows whitelisting or
 * blacklisting of properties from output.
 * @module @report-toolkit/transformers.filter
 */
/**
 * do not remove this comment (for typedoc)
 */

import {_, createDebugPipe, observable} from '@report-toolkit/common';

const {map} = observable;

const debug = createDebugPipe('transformer', 'filter');

/**
 * @type {TransformerMeta}
 */
export const meta = {
  description: 'Filters properties',
  id: 'filter',
  input: ['report'],
  output: 'object'
};

/**
 * @param {FilterTransformerOptions} opts
 * @type {TransformFunction<object,object>}
 */
export const transform = ({include = [], exclude = []} = {}) => {
  /**
   * @type {Function[]}
   */
  const filterFns = [_.identity];
  if (include.length) {
    filterFns.push(_.pick(include));
  }
  if (exclude.length) {
    filterFns.push(_.omit(exclude));
  }
  const filterFn = _.pipe.apply(null, filterFns);
  return observable =>
    observable.pipe(
      map(filterFn),
      debug(data => [`filtered data: %O`, data])
    );
};

/**
 * @typedef {import('@report-toolkit/common').Report} Report
 * @typedef {import('./transformer.js').TransformerMeta} TransformerMeta
 * @typedef {{include?: string[], exclude?: string[]}} FilterTransformerOptions
 */

/**
 * @template T,U
 * @typedef {import('./transformer.js').TransformFunction<T,U>} TransformFunction
 */