@prefecthq/prefect-ui-library/src/utilities/validation.ts

This library is the Vue and Typescript component library for [Prefect 2](https://github.com/PrefectHQ/prefect) and [Prefect Cloud 2](https://www.prefect.io/cloud/). _The components and utilities in this project are not meant to be used independently_.

import { isDateAfter, isDateAfterOrEqual, isDateBefore, isDateBeforeOrEqual, isNotNullish } from '@prefecthq/prefect-design'
import { ValidationRule } from '@prefecthq/vue-compositions'
import { localization } from '@/localization'
import { isEmptyArray } from '@/utilities/arrays'
import { formatDate, formatDateTimeNumeric, isDate, isInvalidDate } from '@/utilities/dates'
import { isEmptyString, isString, isValidEmailAddress } from '@/utilities/strings'
import { isNullish } from '@/utilities/variables'

export type ValidationMethod = (value: unknown) => true | string | Promise<true | string>
export type ValidationMethodFactory = (property: string) => ValidationMethod
export type WithMessageArgs = [validationFactory: ValidationMethodFactory, message: string]

export function isWithMessageArgs(value: ValidationMethodFactory | WithMessageArgs): value is WithMessageArgs {
  return Array.isArray(value)
}

export function withMessage(validationFactory: ValidationMethodFactory, message: string): ValidationMethod {
  const validationMethod = validationFactory('property')

  return async (value: unknown) => {
    const passesValidation = await validationMethod(value) === true

    return passesValidation ? true : message
  }
}

export function fieldRules(property: string, ...rules: (ValidationMethodFactory | WithMessageArgs)[]): ValidationMethod[] {
  return rules.map(rule => {
    if (isWithMessageArgs(rule)) {
      const [method, message] = rule

      return withMessage(method, message)
    }

    return rule(property)
  })
}

export const all = (factory: ValidationMethodFactory): ValidationMethodFactory => property => values => {
  const method = factory(property)

  if (Array.isArray(values) && values.every(value => method(value) === true)) {
    return true
  }

  return `Not every ${property} is valid`
}

export const isRequired: ValidationMethodFactory = property => value => {
  if (isNullish(value) || isEmptyArray(value) || isEmptyString(value) || isInvalidDate(value)) {
    return `${property} is required`
  }

  return true
}

export const isValidIf = (condition: (value: unknown) => boolean | Promise<boolean>): ValidationMethodFactory => property => async value => {
  const valid = await condition(value)

  if (valid) {
    return true
  }

  return `${property} is invalid`
}

export const isRequiredIf = (condition: (value: unknown) => boolean | Promise<boolean>): ValidationMethodFactory => property => async value => {
  const required = await condition(value)

  if (!required) {
    return true
  }

  return isRequired(property)(value)
}
export const isEmail: ValidationMethodFactory = property => (value: unknown) => {
  if (isNullish(value) || isEmptyString(value)) {
    return true
  }

  if (isValidEmailAddress(value)) {
    return true
  }

  return `${property} is not a valid email address`
}

export const areEmails = all(isEmail)

export const isLessThan = (max: number): ValidationMethodFactory => property => (value: unknown) => {
  if (isNullish(value) || isEmptyString(value) || isEmptyArray(value)) {
    return true
  }

  if (Array.isArray(value) && value.length < max) {
    return true
  }

  if (typeof value === 'string' && value.length < max) {
    return true
  }

  if (typeof value === 'number' && value < max) {
    return true
  }

  return `${property} must be less than ${max}`
}

export const isLessThanOrEqual = (max: number): ValidationMethodFactory => property => (value: unknown) => {
  if (isNullish(value) || isEmptyString(value) || isEmptyArray(value)) {
    return true
  }

  if (Array.isArray(value)) {
    if (value.length <= max) {
      return true
    }

    return localization.error.arrayValueTooLong(property, max)
  }

  if (typeof value === 'string') {
    if (value.length <= max) {
      return true
    }

    return localization.error.stringValueTooLong(property, max)
  }

  if (typeof value === 'number') {
    if (value <= max) {
      return true
    }

    return localization.error.numberValueTooLarge(property, max)
  }

  return localization.error.valueTooLarge(property, max)
}

export const isGreaterThan = (min: number): ValidationMethodFactory => property => (value: unknown) => {
  if (isNullish(value) || isEmptyString(value) || isEmptyArray(value)) {
    return true
  }

  if (Array.isArray(value) && value.length > min) {
    return true
  }

  if (typeof value === 'string' && value.length > min) {
    return true
  }

  if (typeof value === 'number' && value > min) {
    return true
  }

  return `${property} must be greater than ${min}`
}

export const isGreaterThanOrEqual = (min: number): ValidationMethodFactory => property => (value: unknown) => {
  if (isNullish(value) || isEmptyString(value) || isEmptyArray(value)) {
    return true
  }

  if (Array.isArray(value) && value.length >= min) {
    return true
  }

  if (typeof value === 'string' && value.length >= min) {
    return true
  }

  if (typeof value === 'number' && value >= min) {
    return true
  }

  return `${property} must be greater than or equal to ${min}`
}

export const isBefore = (max: Date, { time: showTime = false } = {}): ValidationMethodFactory => property => value => {
  if (isNullish(value)) {
    return true
  }

  if (isDate(value) && isDateBefore(value, max)) {
    return true
  }

  if (showTime) {
    return `${property} must be less than ${formatDateTimeNumeric(max)}`
  }

  return `${property} must be less than ${formatDate(max)}`
}

export const isBeforeOrEqual = (max: Date, { time: showTime = false } = {}): ValidationMethodFactory => property => value => {
  if (isNullish(value)) {
    return true
  }

  if (isDate(value) && isDateBeforeOrEqual(value, max)) {
    return true
  }

  if (showTime) {
    return `${property} must be less than ${formatDateTimeNumeric(max)}`
  }

  return `${property} must be less than or equal to ${formatDate(max)}`
}

export const isAfter = (min: Date, { time: showTime = false } = {}): ValidationMethodFactory => property => value => {
  if (isNullish(value)) {
    return true
  }

  if (isDate(value) && isDateAfter(value, min)) {
    return true
  }

  if (showTime) {
    return `${property} must be less than ${formatDateTimeNumeric(min)}`
  }

  return `${property} must be less than ${formatDate(min)}`
}

export const isAfterOrEqual = (min: Date, { time: showTime = false } = {}): ValidationMethodFactory => property => value => {
  if (isNullish(value)) {
    return true
  }

  if (isDate(value) && isDateAfterOrEqual(value, min)) {
    return true
  }

  if (showTime) {
    return `${property} must be less than ${formatDateTimeNumeric(min)}`
  }

  return `${property} must be less than or equal to ${formatDate(min)}`
}

export const isJson: ValidationMethodFactory = property => value => {
  if (isNullish(value) || isEmptyString(value)) {
    return true
  }

  try {
    JSON.parse(value as string)
  } catch {
    return `${property} must be valid JSON`
  }

  return true
}

const HANDLE_REGEX = /^[a-z0-9-]+$/

export const isHandle: ValidationMethodFactory = property => value => {
  if (isNullish(value) || isEmptyString(value)) {
    return true
  }

  if (typeof value === 'string' && HANDLE_REGEX.test(value)) {
    return true
  }

  return `${property} must only contain lowercase letters, numbers, and dashes`
}

const SNAKE_CASE_REGEX = /^[a-z0-9]+(_+[a-z0-9]+)*$/

export const isSnakeCase: ValidationRule<unknown> = (value, field) => {
  return isNotNullish(value) && isString(value) && SNAKE_CASE_REGEX.test(value) || localization.error.mustBeSnakeCase(field)
}

const SLUG_REGEX = /^[a-z0-9]+([_-]+[a-z0-9]+)*$/

export const isSlug: ValidationRule<unknown> = (value, field) => {
  if (isNullish(value) || isEmptyString(value)) {
    return true
  }

  if (typeof value === 'string' && SLUG_REGEX.test(value)) {
    return true
  }

  return localization.error.mustBeSlug(field)
}