@stacksjs/validation 0.64.5 → 0.65.0

package/dist/is.d.ts

@@ -0,0 +1,28 @@
+export declare function isDef<T = any>(val?: T): val is T;
+export declare function isBoolean(val: any): val is boolean;
+export declare function isFunction<T extends Function>(val: any): val is T;
+export declare function isNumber(val: any): val is number;
+export declare function isString(val: unknown): val is string;
+export declare function isObject(val: any): val is object;
+export declare function isWindow(val: any): boolean;
+export declare const isBrowser: boolean;
+export declare const isServer: boolean;
+export declare function isMap(val: any): val is Map<any, any>;
+export declare function isSet(val: any): val is Set<any>;
+export declare function isPromise<T = any>(val: any): val is Promise<T>;
+export declare function isUndefined(v: any): boolean;
+export declare function isNull(v: any): boolean;
+export declare function isSymbol(v: any): boolean;
+export declare function isDate(v: any): boolean;
+export declare function isRegExp(v: any): boolean;
+export declare function isArray(v: any): boolean;
+export declare function isPrimitive(v: any): boolean;
+export declare function isInteger(v: any): boolean;
+export declare function isFloat(v: any): boolean;
+export declare function isPositive(v: any): boolean;
+export declare function isNegative(v: any): boolean;
+export declare function isEven(v: any): boolean;
+export declare function isOdd(v: any): boolean;
+export declare function isEvenOrOdd(v: any): "even" | "odd";
+export declare function isPositiveOrNegative(v: any): "positive" | "negative";
+export declare function isIntegerOrFloat(v: any): "integer" | "float";

package/dist/reporter.d.ts

@@ -0,0 +1,8 @@
+interface MessageObject {
+	message: string;
+	rule: string;
+	field: string;
+}
+export declare function reportError(errors: MessageObject[]): void;
+export declare function getErrors(): MessageObject[];
+export {};

package/dist/rules.d.ts

@@ -0,0 +1,79 @@
+/**
+* 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/dist/schema.d.ts

@@ -0,0 +1,16 @@
+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 declare const validate: {
+	string: (defaultValue?: string) => SchemaString;
+	number: (defaultValue?: number) => SchemaNumber;
+	boolean: (defaultValue?: boolean) => SchemaBoolean;
+	enum: (values: string[]) => SchemaEnum;
+};

package/dist/types/index.d.ts

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

package/dist/validator.d.ts

@@ -0,0 +1,15 @@
+import type { VineType } from "@stacksjs/types";
+interface RequestData {
+	[key: string]: any;
+}
+interface ValidationField {
+	rule: VineType;
+	message: Record<string, string>;
+}
+interface CustomAttributes {
+	[key: string]: ValidationField;
+}
+export declare function isObjectNotEmpty(obj: object | undefined): boolean;
+export declare function validateField(modelFile: string, params: RequestData): Promise<any>;
+export declare function customValidate(attributes: CustomAttributes, params: RequestData): Promise<any>;
+export {};

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@stacksjs/validation",
   "type": "module",
-  "version": "0.64.5",
+  "version": "0.65.0",
   "description": "The Stacks Validation ways.",
   "author": "Chris Breuer",
+  "contributors": ["Chris Breuer <chris@stacksjs.org>"],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/validation#readme",
@@ -15,16 +16,11 @@
   "bugs": {
     "url": "https://github.com/stacksjs/stacks/issues"
   },
-  "keywords": [
-    "vinejs",
-    "validation",
-    "utilities",
-    "functions",
-    "stacks"
-  ],
+  "keywords": ["vinejs", "validation", "utilities", "functions", "stacks"],
   "exports": {
     ".": {
       "bun": "./src/index.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
     "./*": {
@@ -34,25 +30,19 @@
   },
   "main": "dist/index.cjs",
   "module": "dist/index.js",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
-  "files": [
-    "README.md",
-    "dist",
-    "src"
-  ],
+  "types": "dist/index.d.ts",
+  "files": ["README.md", "dist", "src"],
   "scripts": {
-    "build": "bun --bun build.ts",
-    "typecheck": "bun --bun tsc --noEmit",
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/strings": "latest",
-    "@stacksjs/types": "latest",
+    "@stacksjs/strings": "0.64.6",
+    "@stacksjs/types": "0.64.6",
     "@vinejs/vine": "^2.1.0"
   },
   "devDependencies": {
-    "@stacksjs/development": "latest"
+    "@stacksjs/development": "0.64.6"
   }
 }

package/src/is.ts

@@ -9,6 +9,7 @@ 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'
 }
@@ -29,9 +30,9 @@ export function isWindow(val: any): boolean {
   return typeof window !== 'undefined' && toString(val) === '[object Window]'
 }
 
-export const isBrowser = typeof window !== 'undefined'
+export const isBrowser: boolean = typeof window !== 'undefined'
 
-export const isServer = typeof document === 'undefined' // https://remix.run/docs/en/v1/pages/gotchas#typeof-window-checks
+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]'
@@ -45,74 +46,74 @@ export function isPromise<T = any>(val: any): val is Promise<T> {
   return toString(val) === '[object Promise]'
 }
 
-export function isUndefined(v: any) {
+export function isUndefined(v: any): boolean {
   return getTypeName(v) === 'undefined'
 }
 
-export function isNull(v: any) {
+export function isNull(v: any): boolean {
   return getTypeName(v) === 'null'
 }
 
-export function isSymbol(v: any) {
+export function isSymbol(v: any): boolean {
   return getTypeName(v) === 'symbol'
 }
 
-export function isDate(v: any) {
+export function isDate(v: any): boolean {
   return getTypeName(v) === 'date'
 }
 
-export function isRegExp(v: any) {
+export function isRegExp(v: any): boolean {
   return getTypeName(v) === 'regexp'
 }
 
-export function isArray(v: any) {
+export function isArray(v: any): boolean {
   return getTypeName(v) === 'array'
 }
 
-export function isPrimitive(v: any) {
+export function isPrimitive(v: any): boolean {
   const type = getTypeName(v)
   return (
-    type === 'null' ||
-    type === 'undefined' ||
-    type === 'string' ||
-    type === 'number' ||
-    type === 'boolean' ||
-    type === 'symbol'
+    type === 'null'
+    || type === 'undefined'
+    || type === 'string'
+    || type === 'number'
+    || type === 'boolean'
+    || type === 'symbol'
   )
 }
 
-export function isInteger(v: any) {
+export function isInteger(v: any): boolean {
   return isNumber(v) && Number.isInteger(v)
 }
 
-export function isFloat(v: any) {
+export function isFloat(v: any): boolean {
   return isNumber(v) && !Number.isInteger(v)
 }
 
-export function isPositive(v: any) {
+export function isPositive(v: any): boolean {
   return isNumber(v) && v > 0
 }
 
-export function isNegative(v: any) {
+export function isNegative(v: any): boolean {
   return isNumber(v) && v < 0
 }
 
-export function isEven(v: any) {
+export function isEven(v: any): boolean {
   return isNumber(v) && v % 2 === 0
 }
 
-export function isOdd(v: any) {
+export function isOdd(v: any): boolean {
   return isNumber(v) && v % 2 !== 0
 }
 
-export function isEvenOrOdd(v: any) {
-  return isNumber(v) && (v % 2 === 0 ? 'even' : 'odd')
+export function isEvenOrOdd(v: any): 'even' | 'odd' {
+  return isNumber(v) ? (v % 2 === 0 ? 'even' : 'odd') : 'odd'
 }
 
-export function isPositiveOrNegative(v: any) {
-  return isNumber(v) && (v > 0 ? 'positive' : 'negative')
+export function isPositiveOrNegative(v: any): 'positive' | 'negative' {
+  return isNumber(v) ? (v > 0 ? 'positive' : 'negative') : 'negative'
 }
 
-export function isIntegerOrFloat(v: any) {
-  return isNumber(v) && (Number.isInteger(v) ? 'integer' : 'float')
+export function isIntegerOrFloat(v: any): 'integer' | 'float' {
+  return isNumber(v) ? (Number.isInteger(v) ? 'integer' : 'float') : 'float'
 }

package/src/schema.ts

@@ -1,8 +1,7 @@
-import schema from '@vinejs/vine'
-import { SimpleMessagesProvider, errors as VineError } from '@vinejs/vine'
+import schema, { SimpleMessagesProvider, errors as VineError } from '@vinejs/vine'
 import rule from 'validator'
 
-export { schema, rule, SimpleMessagesProvider, VineError }
+export { rule, schema, SimpleMessagesProvider, VineError }
 
 type SchemaString = string
 type SchemaNumber = number
@@ -11,8 +10,8 @@ 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 { VineString, VineBoolean, VineEnum, VineNumber, VineDate } from '@vinejs/vine'
 
 export const validate = {
   string: (defaultValue = ''): SchemaString => defaultValue,

package/src/types/index.ts

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

package/src/validator.ts

@@ -1,9 +1,8 @@
+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 type { Model } from '@stacksjs/types'
-import type { VineType } from '@stacksjs/types'
-import type { SchemaTypes } from '@vinejs/vine/types'
-import { SimpleMessagesProvider, VineError, reportError, schema } from './'
+import { reportError, schema, SimpleMessagesProvider, VineError } from './'
 
 interface RequestData {
   [key: string]: any
@@ -18,7 +17,10 @@ interface CustomAttributes {
   [key: string]: ValidationField
 }
 
-export function isObjectNotEmpty(obj: object): boolean {
+export function isObjectNotEmpty(obj: object | undefined): boolean {
+  if (obj === undefined)
+    return false
+
   return Object.keys(obj).length > 0
 }
 
@@ -47,8 +49,10 @@ export async function validateField(modelFile: string, params: RequestData): Pro
     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)
+  }
+  catch (error: any) {
+    if (error instanceof VineError.E_VALIDATION_ERROR)
+      reportError(error.messages)
 
     throw { status: 422, errors: error.messages }
   }
@@ -61,7 +65,8 @@ export async function customValidate(attributes: CustomAttributes, params: Reque
   for (const key in attributes) {
     if (Object.prototype.hasOwnProperty.call(attributes, key)) {
       const rule = attributes[key]?.rule
-      if (rule) ruleObject[key] = rule as SchemaTypes
+      if (rule)
+        ruleObject[key] = rule as SchemaTypes
 
       const validatorMessages = attributes[key]?.message
 
@@ -78,8 +83,10 @@ export async function customValidate(attributes: CustomAttributes, params: Reque
     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)
+  }
+  catch (error: any) {
+    if (error instanceof VineError.E_VALIDATION_ERROR)
+      reportError(error.messages)
 
     throw { status: 422, errors: error.messages }
   }