skex/src/nodes/record.ts

A modern schema validation and filtration library with great TypeScript support.

/* IMPORT */

import Compound from './compound';
import Nillable from './nillable';
import Nullable from './nullable';
import Optional from './optional';
import Registry from '../registry';
import {anyOf, noneOf} from '../tests';
import {isPlainObject, resolve} from '../utils';
import type {RecordState, FunctionMaybe, Schema, Tests, Traverser} from '../types';

/* MAIN */

class Rec<K extends string, V extends unknown> extends Compound<Record<string, unknown>, Record<K, V>, RecordState<Record<string, unknown>, Record<K, V>, V>> {

  /* PUBLIC API */

  filter ( value: unknown, defaultable: false, quiet: true ): boolean;
  filter ( value: unknown, defaultable?: boolean, quiet?: false ): Record<K, V>;
  filter ( value: unknown, defaultable?: boolean, quiet?: boolean ): Record<K, V> | boolean;
  filter ( value: unknown, defaultable: boolean = true, quiet: boolean = false ): Record<K, V> | boolean {

    if ( !isPlainObject ( value ) ) return this._filterDefault ( defaultable, quiet );

    if ( !super._test ( value, FILTERS ) ) return this._filterDefault ( defaultable, quiet );

    return value;

  }

  test ( value: unknown ): value is Record<K, V> {

    return isPlainObject ( value ) && super._test ( value, TESTS );

  }

  traverse ( traverser: Traverser, parent?: Schema, key?: string | number ): void {

    traverser ( this, parent, key );

    resolve ( this.state.keys )?.traverse ( traverser, this );
    resolve ( this.state.values )?.traverse ( traverser, this );

  }

  /* GENERAL TESTS API */

  anyOf ( values: Record<K, V>[] ): Rec<K, V> {

    return this.with ({ anyOf: values });

  }

  noneOf ( values: Record<K, V>[] ): Rec<K, V> {

    return this.with ({ noneOf: values });

  }

  nillable (): Nillable<Record<K, V>> {

    return new Nillable ({ nillable: this });

  }

  nullable (): Nullable<Record<K, V>> {

    return new Nullable ({ nullable: this });

  }

  optional (): Optional<Record<K, V>> {

    return new Optional ({ optional: this });

  }

  /* SPECIFIC TESTS API */

  keys <T extends K> ( keys: FunctionMaybe<Schema<T>> ): Rec<K & T, V> {

    return this.with ({ keys });

  }

  values <T extends V> ( values: FunctionMaybe<Schema<T>> ): Rec<K, V & T> {

    return this.with ({ values });

  }

}

/* UTILITIES */

const TESTS: Tests<Record<string, unknown>, RecordState<Record<string, unknown>, Record<string, unknown>, unknown>> = {
  anyOf,
  noneOf,
  keys ( value, schema ) {
    const keys = resolve ( schema );
    for ( const key in value ) {
      if ( !keys.test ( key ) ) return false;
    }
    return true;
  },
  values ( value, schema ) {
    const values = resolve ( schema );
    for ( const key in value ) {
      const item = value[key];
      if ( !values.test ( item ) ) return false;
    }
    return true;
  }
};

const FILTERS: Tests<Record<string, unknown>, RecordState<Record<string, unknown>, Record<string, unknown>, unknown>> = {
  anyOf,
  noneOf,
  keys ( value, schema ) {
    const keys = resolve ( schema );
    for ( const key in value ) {
      const filtered = keys.filter ( key, false, true );
      if ( !filtered ) {
        delete value[key];
      }
    }
    return true;
  },
  values ( value, schema ) {
    const values = resolve ( schema );
    for ( const key in value ) {
      const item = value[key];
      const filtered = values.filter ( item, false, true );
      if ( !filtered ) {
        delete value[key];
      }
    }
    return true;
  }
};

/* INIT */

Registry.register ( 'record', Rec );

/* EXPORT */

export default Rec;