mobx-react-form/src/Validator.ts

Reactive MobX Form State Management

import { action, observable, makeObservable } from "mobx";
import { each } from "lodash";
import { $try } from "./utils";
import ValidatorInterface, {
  DriversMap,
  ValidateOptions,
  ValidationPluginInterface,
  ValidationPlugins,
  ValidatorConstructor,
} from "./models/ValidatorInterface";
import { FormInterface } from "./models/FormInterface";
import { FieldInterface } from "./models/FieldInterface";
import { OptionsEnum } from "./models/OptionsModel";

export default class Validator implements ValidatorInterface {
  promises: Promise<any>[] = [];

  form: FormInterface | null = null;

  drivers: DriversMap = {};

  plugins: ValidationPlugins = {
    vjf: undefined,
    dvr: undefined,
    svk: undefined,
    yup: undefined,
    zod: undefined,
    joi: undefined,
  };

  error: string | null = null;

  constructor(obj: ValidatorConstructor) {
    makeObservable(this, {
      error: observable,
      validate: action,
      validateField: action,
    });

    this.form = obj.form;
    Object.assign(this.plugins, obj.plugins);

    this.initDrivers();
  }

  initDrivers(): void {
    Object.entries(this.plugins).forEach(([key, plugin]) => {
      this.drivers[key] = (plugin && (plugin as any).class) &&
        new ((plugin as any).class)({
          config: (plugin as any).config,
          state: this.form!.state,
          promises: this.promises,
        });
    });
  }

  validate(opt: ValidateOptions, obj: ValidateOptions): Promise<any> {
    const path: string = $try((opt as any)?.path, opt);
    const instance = $try((opt as any)?.field, this.form!.select(path, null, false), this.form!);
    const related: boolean = $try((opt as any)?.related, (obj as any)?.related, true);
    const showErrors: boolean = $try((opt as any)?.showErrors, (obj as any)?.showErrors, false);
    instance.$validating = true;
    instance.$validated += 1;

    this.error = null;

    return new Promise((resolve) => {
      // validate instance (form or filed)
      if (instance.path || typeof path === 'string') {
        this.validateField({
          field: instance,
          showErrors,
          related,
          path,
        });
      }

      // validate nested fields
      instance.each((field: any) =>
        this.validateField({
          path: field.path,
          field: field,
          showErrors,
          related,
        })
      );

      // wait all promises
      resolve(Promise.all(this.promises));
    })
      .then(
        action(() => {
          instance.$validating = false;
          instance.$clearing = false;
          instance.$resetting = false;
        })
      )
      .catch(
        action((err) => {
          instance.$validating = false;
          instance.$clearing = false;
          instance.$resetting = false;
          throw err;
        })
      )
      .then(() => instance);
  }

  validateField({
    showErrors = false,
    related = false,
    field = null,
    path,
  }: { showErrors?: boolean; related?: boolean; field?: any; path?: any }): void {
    const instance = field || this.form!.select(path);
    const { options } = this.form!.state;
    // check if the field is a valid instance
    if (!instance.path) throw new Error("Validation Error: Invalid Field Instance");
    // do not validate soft deleted fields
    if (instance.deleted && !options.get(OptionsEnum.validateDeletedFields, instance)) return;
    // do not validate disabled fields
    if (instance.disabled && !options.get(OptionsEnum.validateDisabledFields, instance)) return;
    // do not validate pristine fields
    if (instance.isPristine && !options.get(OptionsEnum.validatePristineFields, instance)) return;
    // reset validation before validate
    if (options.get(OptionsEnum.resetValidationBeforeValidate, instance)) instance.resetValidation();
    // trim string value before validation
    if (options.get(OptionsEnum.validateTrimmedValue, instance)) instance.trim();

    // get stop on error
    const stopOnError: boolean = options.get(
      OptionsEnum.stopValidationOnError,
      instance
    );

    // get validation plugin order
    const validationPluginOrder = options.get(
      OptionsEnum.validationPluginsOrder,
      instance
    );

    const drivers: DriversMap = validationPluginOrder
      ? validationPluginOrder.map((n: string) => this.drivers[n])
      : this.drivers;

    // validate with all enabled drivers
    each(drivers, (driver: ValidationPluginInterface) => {
      driver && driver.validate(instance);
      if (stopOnError && instance.hasError) return;
    });

    // send error to the view
    instance.showErrors(showErrors, false);

    // related validation
    if (related) this.validateRelatedFields(instance, showErrors);
  }

  /**
    Validate 'related' fields if specified
    and related validation allowed (recursive)
  */
  validateRelatedFields(field: FieldInterface, showErrors: boolean): void {
    if (!field.related || !field.related.length) return;

    field.related.map((path) =>
      this.validateField({
        related: false,
        showErrors,
        path,
      })
    );
  }
}