@stacksjs/validation 0.65.0 → 0.67.0

package/src/index.ts

@@ -1,6 +0,0 @@
-export * from './is'
-export * from './reporter'
-export * from './rules'
-export * from './schema'
-export * from './types'
-export * from './validator'

package/src/is.ts

@@ -1,119 +0,0 @@
-import { toString } from '@stacksjs/strings'
-import { getTypeName } from '@stacksjs/types'
-
-export function isDef<T = any>(val?: T): val is T {
-  return typeof val !== 'undefined'
-}
-
-export function isBoolean(val: any): val is boolean {
-  return typeof val === 'boolean'
-}
-
-// eslint-disable-next-line ts/no-unsafe-function-type
-export function isFunction<T extends Function>(val: any): val is T {
-  return typeof val === 'function'
-}
-
-export function isNumber(val: any): val is number {
-  return typeof val === 'number'
-}
-
-export function isString(val: unknown): val is string {
-  return typeof val === 'string'
-}
-
-export function isObject(val: any): val is object {
-  return toString(val) === '[object Object]'
-}
-
-export function isWindow(val: any): boolean {
-  return typeof window !== 'undefined' && toString(val) === '[object Window]'
-}
-
-export const isBrowser: boolean = typeof window !== 'undefined'
-
-export const isServer: boolean = typeof document === 'undefined' // https://remix.run/docs/en/v1/pages/gotchas#typeof-window-checks
-
-export function isMap(val: any): val is Map<any, any> {
-  return toString(val) === '[object Map]'
-}
-
-export function isSet(val: any): val is Set<any> {
-  return toString(val) === '[object Set]'
-}
-
-export function isPromise<T = any>(val: any): val is Promise<T> {
-  return toString(val) === '[object Promise]'
-}
-
-export function isUndefined(v: any): boolean {
-  return getTypeName(v) === 'undefined'
-}
-
-export function isNull(v: any): boolean {
-  return getTypeName(v) === 'null'
-}
-
-export function isSymbol(v: any): boolean {
-  return getTypeName(v) === 'symbol'
-}
-
-export function isDate(v: any): boolean {
-  return getTypeName(v) === 'date'
-}
-
-export function isRegExp(v: any): boolean {
-  return getTypeName(v) === 'regexp'
-}
-
-export function isArray(v: any): boolean {
-  return getTypeName(v) === 'array'
-}
-
-export function isPrimitive(v: any): boolean {
-  const type = getTypeName(v)
-  return (
-    type === 'null'
-    || type === 'undefined'
-    || type === 'string'
-    || type === 'number'
-    || type === 'boolean'
-    || type === 'symbol'
-  )
-}
-
-export function isInteger(v: any): boolean {
-  return isNumber(v) && Number.isInteger(v)
-}
-
-export function isFloat(v: any): boolean {
-  return isNumber(v) && !Number.isInteger(v)
-}
-
-export function isPositive(v: any): boolean {
-  return isNumber(v) && v > 0
-}
-
-export function isNegative(v: any): boolean {
-  return isNumber(v) && v < 0
-}
-
-export function isEven(v: any): boolean {
-  return isNumber(v) && v % 2 === 0
-}
-
-export function isOdd(v: any): boolean {
-  return isNumber(v) && v % 2 !== 0
-}
-
-export function isEvenOrOdd(v: any): 'even' | 'odd' {
-  return isNumber(v) ? (v % 2 === 0 ? 'even' : 'odd') : 'odd'
-}
-
-export function isPositiveOrNegative(v: any): 'positive' | 'negative' {
-  return isNumber(v) ? (v > 0 ? 'positive' : 'negative') : 'negative'
-}
-
-export function isIntegerOrFloat(v: any): 'integer' | 'float' {
-  return isNumber(v) ? (Number.isInteger(v) ? 'integer' : 'float') : 'float'
-}

package/src/reporter.ts

@@ -1,15 +0,0 @@
-interface MessageObject {
-  message: string
-  rule: string
-  field: string
-}
-
-let messages: MessageObject[] = [] // Initialize as an empty array
-
-export function reportError(errors: MessageObject[]): void {
-  messages = errors
-}
-
-export function getErrors(): MessageObject[] {
-  return messages
-}

package/src/rules.ts

@@ -1,92 +0,0 @@
-/**
- * Thanks to VineJS for the following types:
- *
- * The context shared with the entire validation pipeline.
- * Each field gets its own context object.
- */
-export interface FieldContext {
-  /**
-   * Field value
-   */
-  value: unknown
-
-  /**
-   * The data property is the top-level object under validation.
-   */
-  data: any
-
-  /**
-   * Shared metadata across the entire validation lifecycle. It can be
-   * used to pass data between validation rules
-   */
-  meta: Record<string, any>
-
-  /**
-   * Mutate the value of field under validation.
-   */
-  mutate: (newValue: any, field: FieldContext) => void
-
-  /**
-   * Report error to the error reporter
-   */
-  report: ErrorReporterContract['report']
-
-  /**
-   * Is this field valid. Default: true
-   */
-  isValid: boolean
-
-  /**
-   * Is this field has value defined.
-   */
-  isDefined: boolean
-
-  /**
-   * Wildcard path for the field. The value is a nested
-   * pointer to the field under validation.
-   *
-   * In case of arrays, the `*` wildcard is used.
-   */
-  wildCardPath: string
-
-  /**
-   * The parent property is the parent of the field. It could be an
-   * array or an object.
-   */
-  parent: any
-
-  /**
-   * Name of the field under validation. In case of an array, the field
-   * name will be a number
-   */
-  name: string | number
-
-  /**
-   * Is this field an array member
-   */
-  isArrayMember: boolean
-}
-
-/**
- * Thanks to VineJS for the following types:
- *
- * The error reporter is used to report errors during the validation
- * process.
- */
-export interface ErrorReporterContract {
-  /**
-   * A boolean to known if there are one or more
-   * errors.
-   */
-  hasErrors: boolean
-
-  /**
-   * Creates an instance of an exception to throw
-   */
-  createError: () => Error
-
-  /**
-   * Report error for a field
-   */
-  report: (message: string, rule: string, field: FieldContext, args?: Record<string, any>) => any
-}

package/src/schema.ts

@@ -1,21 +0,0 @@
-import schema, { SimpleMessagesProvider, errors as VineError } from '@vinejs/vine'
-import rule from 'validator'
-
-export { rule, schema, SimpleMessagesProvider, VineError }
-
-type SchemaString = string
-type SchemaNumber = number
-type SchemaBoolean = boolean
-type SchemaEnum = string[]
-
-export type SchemaType = SchemaString | SchemaNumber | SchemaBoolean | SchemaEnum
-
-export { VineBoolean, VineDate, VineEnum, VineNumber, VineString } from '@vinejs/vine'
-export type { Infer } from '@vinejs/vine/types'
-
-export const validate = {
-  string: (defaultValue = ''): SchemaString => defaultValue,
-  number: (defaultValue = 1): SchemaNumber => defaultValue,
-  boolean: (defaultValue = true): SchemaBoolean => defaultValue,
-  enum: (values: string[]): SchemaEnum => values,
-}

package/src/types/index.ts

@@ -1,6 +0,0 @@
-export {
-  VineBoolean as ValidationBoolean,
-  VineEnum as ValidationEnum,
-  VineNumber as ValidationNumber,
-  VineString as ValidationString,
-} from '@vinejs/vine'

package/src/validator.ts

@@ -1,93 +0,0 @@
-import type { Model, VineType } from '@stacksjs/types'
-import type { SchemaTypes } from '@vinejs/vine/types'
-import { path } from '@stacksjs/path'
-import { snakeCase } from '@stacksjs/strings'
-import { reportError, schema, SimpleMessagesProvider, VineError } from './'
-
-interface RequestData {
-  [key: string]: any
-}
-
-interface ValidationField {
-  rule: VineType
-  message: Record<string, string>
-}
-
-interface CustomAttributes {
-  [key: string]: ValidationField
-}
-
-export function isObjectNotEmpty(obj: object | undefined): boolean {
-  if (obj === undefined)
-    return false
-
-  return Object.keys(obj).length > 0
-}
-
-export async function validateField(modelFile: string, params: RequestData): Promise<any> {
-  const model = (await import(/* @vite-ignore */ path.userModelsPath(`${modelFile}.ts`))).default as Model
-  const attributes = model.attributes
-
-  const ruleObject: Record<string, SchemaTypes> = {}
-  const messageObject: Record<string, string> = {}
-
-  for (const key in attributes) {
-    if (Object.prototype.hasOwnProperty.call(attributes, key)) {
-      ruleObject[snakeCase(key)] = attributes[key]?.validation?.rule
-      const validatorMessages = attributes[key]?.validation?.message
-
-      for (const validatorMessageKey in validatorMessages) {
-        const validatorMessageString = `${key}.${validatorMessageKey}`
-        messageObject[validatorMessageString] = attributes[key]?.validation?.message[validatorMessageKey] || ''
-      }
-    }
-  }
-
-  schema.messagesProvider = new SimpleMessagesProvider(messageObject)
-
-  try {
-    const vineSchema = schema.object(ruleObject)
-    const validator = schema.compile(vineSchema)
-    await validator.validate(params)
-  }
-  catch (error: any) {
-    if (error instanceof VineError.E_VALIDATION_ERROR)
-      reportError(error.messages)
-
-    throw { status: 422, errors: error.messages }
-  }
-}
-
-export async function customValidate(attributes: CustomAttributes, params: RequestData): Promise<any> {
-  const ruleObject: Record<string, SchemaTypes> = {}
-  const messageObject: Record<string, string> = {}
-
-  for (const key in attributes) {
-    if (Object.prototype.hasOwnProperty.call(attributes, key)) {
-      const rule = attributes[key]?.rule
-      if (rule)
-        ruleObject[key] = rule as SchemaTypes
-
-      const validatorMessages = attributes[key]?.message
-
-      for (const validatorMessageKey in validatorMessages) {
-        const validatorMessageString = `${key}.${validatorMessageKey}`
-        messageObject[validatorMessageString] = attributes[key]?.message[validatorMessageKey] || ''
-      }
-    }
-  }
-
-  schema.messagesProvider = new SimpleMessagesProvider(messageObject)
-
-  try {
-    const vineSchema = schema.object(ruleObject)
-    const validator = schema.compile(vineSchema)
-    await validator.validate(params)
-  }
-  catch (error: any) {
-    if (error instanceof VineError.E_VALIDATION_ERROR)
-      reportError(error.messages)
-
-    throw { status: 422, errors: error.messages }
-  }
-}