chore: wip

Author: chrisbbreuer

.stacks/core/error-handling/src/index.ts

@@ -1,8 +1,8 @@
 import { fs } from '@stacksjs/storage'
 import { log } from '@stacksjs/cli'
 import { logsPath } from '@stacksjs/path'
-import { ValidationError } from '@stacksjs/types'
-import type { StacksError } from '@stacksjs/types'
+
+import type { StacksError, ValidationError } from '@stacksjs/types'
 
 export {
   Err,
@@ -33,7 +33,7 @@ class ErrorHandler {
   static writeErrorToFile(err: StacksError) {
     let formattedError: string
 
-    if (err instanceof ValidationError)
+    if (isErrorOfTypeValidation(err))
       formattedError = `[${new Date().toISOString()}] ${err.name}: ${err.messages}\n`
     else
       formattedError = `[${new Date().toISOString()}] ${err.name}: ${err.message}\n`
@@ -49,6 +49,10 @@ class ErrorHandler {
   }
 }
 
+function isErrorOfTypeValidation(err: any): err is ValidationError {
+  return err && typeof err.message === 'string'
+}
+
 export function handleError(err: StacksError, options?: any): void {
   ErrorHandler.handle(err, options)
 }

.stacks/core/types/build.config.ts

@@ -7,19 +7,26 @@ const devEntries: Entries = [{
   input: './src/',
   outDir: './dist/',
 }]
-const buildEntries = devEntries
+const buildEntries = [{
+  input: './src/index',
+  outDir: './dist/',
+}]
 const command = process.env.npm_lifecycle_script
 const entries: Entries = command?.includes('--stub') ? devEntries : buildEntries
 
+// eslint-disable-next-line no-console
+console.log('entries', entries)
+
 export default defineBuildConfig({
   alias,
 
   entries,
 
-  // externals: [
-  //   '@vinejs/vine',
-  // ],
-  //
+  externals: [
+    // '@vinejs/vine',
+    '@stacksjs/utils',
+  ],
+
   rollup: {
     inlineDependencies: true,
   },

.stacks/core/types/src/errors.ts

@@ -1,3 +1,10 @@
+import {
+  Err,
+  Ok,
+  Result,
+  ResultAsync,
+} from 'neverthrow'
+
 export declare class ValidationError extends Error {
   messages: any
   status: number
@@ -14,4 +21,4 @@ export {
   Ok,
   Result,
   ResultAsync,
-} from 'neverthrow'
+}

.stacks/core/validation/build.config.ts

@@ -9,7 +9,6 @@ export default defineBuildConfig({
 
   externals: [
     '@vinejs/vine',
-    '@vinejs/vine/build/src/types',
     'vite',
     'validator',
     '@stacksjs/path',

.stacks/core/validation/src/rules.ts

@@ -1,7 +1,100 @@
-import type { FieldContext } from '@vinejs/vine/build/src/types'
 import { USD, currency } from '@stacksjs/utils'
 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) => {
 export const isMoney = validator.createRule((value: unknown, _, field: FieldContext) => {
   /**
    * Convert string representation of a number to a JavaScript
@@ -30,4 +123,4 @@ export const isMoney = validator.createRule((value: unknown, _, field: FieldCont
    * Mutate the field's value
    */
   field.mutate(amount, field)
-})
+}) as any

.stacks/core/validation/src/validate.ts

@@ -1,17 +1,19 @@
+import type { VineString as ValidationString } from '@vinejs/vine'
 import validator, { Vine as Validator } from '@vinejs/vine'
 import { MoneyValidator } from './types/money'
 
 Validator.macro('money', () => {
   return new MoneyValidator()
 })
 
-const validate = validator.validate
-const string = validator.string
-const number = validator.number
-const boolean = validator.boolean
-const array = validator.array
-const object = validator.object
-const any = validator.any
-const email = () => validator.string().email()
+const validate: Validator['validate'] = () => validator.validate()
 
-export { validate, validator, Validator, string, number, boolean, array, object, any, email }
+const string: ValidationString = validator.string()
+const number: Validator['number'] = validator.number
+const boolean: Validator['boolean'] = validator.boolean
+const array: Validator['array'] = validator.array
+const object: Validator['object'] = validator.object
+const any: Validator['any'] = validator.any
+// const email = () => validator.string().email()
+
+export { validate, validator, Validator, string, number, boolean, array, object, any }

app/models/User.ts

@@ -1,6 +1,6 @@
-import { faker } from 'stacks/core/faker/src'
-import { email, string } from 'stacks/core/validation/src'
-import { defineModel } from 'stacks/core/utils/src'
+import { faker } from '@stacksjs/faker'
+import { string } from '@stacksjs/validation'
+import { defineModel } from '@stacksjs/utils'
 
 export default defineModel({
   name: 'User', // defaults to the sanitized file name
@@ -13,22 +13,22 @@ export default defineModel({
   fields: {
     name: {
       validator: {
-        rule: string().minLength(3).maxLength(255),
+        rule: string.minLength(3).maxLength(255).nullable(),
         message: 'Name must be between 3 and 255 characters',
       },
       factory: () => faker.person.fullName(),
     },
     email: {
       unique: true,
       validator: {
-        rule: email(),
+        rule: string.email(),
         message: 'Email must be a valid email address',
       },
       factory: () => faker.internet.email(),
     },
     password: {
       validator: {
-        rule: string().minLength(6).maxLength(255),
+        rule: string.minLength(6).maxLength(255),
         message: 'Password must be between 6 and 255 characters',
       },
       factory: () => faker.internet.password(),