laravel-form-validation/src/Errors.ts

Yet another form validation helper for Laravel

class Errors {

  private errors: { [key: string]: any };

  /**
   * Create a new Errors instance.
   *
   * @param {Object} errors
   */
  constructor(errors: Object = {}) {
    this.errors = errors;
  }

  /**
   * Get all of the messages in the bag.
   *
   * @return {object}
   */
  all(): Object {
    return this.errors;
  }

  /**
   * Determine if messages exist for the given key.
   *
   * @param {String} field
   * @return {Boolean}
   */
  has(field: string): Boolean {
    let hasError = this.errors.hasOwnProperty(field);

    if (!hasError) {
      hasError = Object.keys(this.errors).some(
        f => f.startsWith(`${field}.`) || f.startsWith(`${field}[`)
      );
    }

    return hasError;
  }

  /**
   * Get the first message from the bag for a given key.
   *
   * @param {String} field
   * @returns {String|null}
   */
  first(field: string): String | null {
    return this.get(field)[0];
  }

  /**
   * Get the first error from matching key
   *
   * @param fieldPattern
   */
  firstWhere(fieldPattern: string): String | null {
    const foundKey = Object.keys(this.all()).find(
      f => f.startsWith(`${fieldPattern}.`) || f.startsWith(`${fieldPattern}[`)
    );

    if (foundKey) {
      return this.first(foundKey);
    }

    return null;
  }

  /**
   * Get all of the messages from the bag for a given key.
   *
   * @param {String} field
   * @returns {Array}
   */
  get(field: string): Array<any> {
    return this.errors[field] || [];
  }

  /**
   * Determine if we have any errors.
   *
   * @return {Boolean}
   */
  any(): Boolean {
    return Object.keys(this.errors).length > 0;
  }

  /**
   * Get all the errors in a flat array.
   *
   * @return {Array}
   */
  flatten(): Array<any> {
    return Object.values(this.errors).reduce((a, b) => a.concat(b), [])
  }

  /**
   * Record the new errors.
   *
   * @param {Object} errors
   */
  record(errors: Object) {
    this.errors = errors;
  }

  /**
   * Clear a specific field, object or all error fields.
   *
   * @param {String?} field
   */
  clear(field?: string) {
    let errors: { [key: string]: any } = {};

    if (field) {
      // Prevent reactivity issues
      errors = Object.assign({}, this.errors);

      Object.keys(errors)
        .filter(f => f === field || f.startsWith(`${field}.`) || f.startsWith(`${field}[`))
        .map(f => delete errors[f]);
    }

    this.record(errors);
  }
}

export default Errors;