@stacksjs/validation 0.58.48 → 0.58.50

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/validation",
   "type": "module",
-  "version": "0.58.48",
+  "version": "0.58.50",
   "description": "The Stacks Validation ways.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -39,7 +39,8 @@
   ],
   "files": [
     "README.md",
-    "dist"
+    "dist",
+    "src"
   ],
   "scripts": {
     "build": "bun --bun build.ts",

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './is'
+export * from './rules'
+export * from './validate'
+export * from './types'

package/src/is.ts

@@ -0,0 +1,111 @@
+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'
+}
+
+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 = typeof window !== 'undefined'
+
+export const isServer = 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) {
+  return getTypeName(v) === 'undefined'
+}
+
+export function isNull(v: any) {
+  return getTypeName(v) === 'null'
+}
+
+export function isSymbol(v: any) {
+  return getTypeName(v) === 'symbol'
+}
+
+export function isDate(v: any) {
+  return getTypeName(v) === 'date'
+}
+
+export function isRegExp(v: any) {
+  return getTypeName(v) === 'regexp'
+}
+
+export function isArray(v: any) {
+  return getTypeName(v) === 'array'
+}
+
+export function isPrimitive(v: any) {
+  const type = getTypeName(v)
+  return type === 'null' || type === 'undefined' || type === 'string' || type === 'number' || type === 'boolean' || type === 'symbol'
+}
+
+export function isInteger(v: any) {
+  return isNumber(v) && Number.isInteger(v)
+}
+
+export function isFloat(v: any) {
+  return isNumber(v) && !Number.isInteger(v)
+}
+
+export function isPositive(v: any) {
+  return isNumber(v) && v > 0
+}
+
+export function isNegative(v: any) {
+  return isNumber(v) && v < 0
+}
+
+export function isEven(v: any) {
+  return isNumber(v) && v % 2 === 0
+}
+
+export function isOdd(v: any) {
+  return isNumber(v) && v % 2 !== 0
+}
+
+export function isEvenOrOdd(v: any) {
+  return isNumber(v) && (v % 2 === 0 ? 'even' : 'odd')
+}
+
+export function isPositiveOrNegative(v: any) {
+  return isNumber(v) && (v > 0 ? 'positive' : 'negative')
+}
+
+export function isIntegerOrFloat(v: any) {
+  return isNumber(v) && (Number.isInteger(v) ? 'integer' : 'float')
+}

package/src/rules.ts

@@ -0,0 +1,126 @@
+import { USD } from '@dinero.js/currencies'
+import { dinero as currency } from 'dinero.js'
+import { validator } from './validate'
+
+/**
+ * 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
+}
+
+export const isMoney = validator.createRule((value: unknown, _, field: FieldContext) => {
+  /**
+   * Convert string representation of a number to a JavaScript
+   * Number data type.
+   */
+  const numericValue = validator.helpers.asNumber(value)
+
+  /**
+   * Report error, if the value is NaN post-conversion
+   */
+  if (Number.isNaN(numericValue)) {
+    field.report(
+      'The {{ field }} field value must be a number',
+      'money',
+      field,
+    )
+    return
+  }
+
+  /**
+   * Create amount type
+   */
+  const amount = currency({ amount: numericValue, currency: USD })
+
+  /**
+   * Mutate the field's value
+   */
+  field.mutate(amount, field)
+}) as any

package/src/types/index.ts

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

package/src/types/money.ts

@@ -0,0 +1,17 @@
+import type { Money } from '@stacksjs/types'
+import { BaseLiteralType } from '@vinejs/vine'
+import type { FieldOptions, Validation } from '@vinejs/vine/types'
+import { isMoney } from '../rules'
+
+export class MoneyValidator extends BaseLiteralType<Money, Money> {
+  constructor(options?: FieldOptions, validations?: Validation<any>[]) {
+    super(options, validations || [isMoney()])
+  }
+
+  clone() {
+    return new MoneyValidator(
+      this.cloneOptions(),
+      this.cloneValidations(),
+    ) as this
+  }
+}

package/src/validate.ts

@@ -0,0 +1,33 @@
+import v, { Vine as Validator } from '@vinejs/vine'
+import { MoneyValidator } from './types/money'
+
+Validator.macro('money', () => {
+  return new MoneyValidator()
+})
+
+export const validator: Validator = v
+// validator.string().email()
+type SchemaString = string
+type SchemaNumber = number
+type SchemaBoolean = boolean
+type SchemaEnum = string[]
+
+export type SchemaType = SchemaString | SchemaNumber | SchemaBoolean | SchemaEnum
+
+export const validate = {
+  string: (defaultValue: string = ''): SchemaString => defaultValue,
+  number: (defaultValue: number = 1): SchemaNumber => defaultValue,
+  boolean: (defaultValue: boolean = true): SchemaBoolean => defaultValue,
+  enum: (values: string[]): SchemaEnum => values,
+}
+
+export const RuleString: Validator['string'] = (...args) => validator.string(...args)
+export const RuleNumber: Validator['number'] = (...args) => validator.number(...args)
+export const RuleBoolean: Validator['boolean'] = (...args) => validator.boolean(...args)
+export const RuleArray: Validator['array'] = (...args) => validator.array(...args)
+export const RuleObject: Validator['object'] = (...args) => validator.object(...args)
+export const RuleAny: Validator['any'] = (...args) => validator.any(...args)
+// const email = () => validator.string().email()
+
+export type { Infer } from '@vinejs/vine/types'
+export { VineString, VineBoolean, VineEnum, VineNumber } from '@vinejs/vine'