@naturalcycles/scrubber-lib/src/scrubber.model.ts

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

import type { AnyObject, StringMap } from '@naturalcycles/js-lib/types'

export type ScrubberFn<T = any, PARAMS = AnyObject> = (value: T, params?: PARAMS) => T

export type ScrubberSQLFn<PARAMS = AnyObject> = (params?: PARAMS) => string

export interface ScrubberConfig {
  fields: StringMap<ScrubberFieldConfig>
  /**
   * Populated at runtime from any config keys with dots, key is last component (after last dot) and array contains
   * preceeding components a.k.a "parents"
   */
  splitFields?: StringMap<string[][]>

  // If false, Scrubber catches any exceptions that may occur when using scrubbers,
  // logs and ignore them. If true, exceptions are logged and raised
  throwOnError?: boolean

  // If false, falsy values on fields are passed to scrubber and each scrubber
  // might handle it differently. If true, falsy values are preserved
  preserveFalsy?: boolean
}

export interface ScrubberFieldConfig {
  scrubber: string
  params?: StringMap<any>
}

export interface ScrubbersMap {
  [scrubberName: string]: ScrubberFn<any, any>
}

export interface ScrubbersSQLMap {
  [scrubberName: string]: ScrubberSQLFn<any>
}