@stacksjs/router 0.63.1 → 0.64.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/router",
   "type": "module",
-  "version": "0.63.1",
+  "version": "0.64.0",
   "description": "The Stacks framework router.",
   "author": "Chris Breuer",
   "license": "MIT",

package/src/middleware.ts

@@ -30,4 +30,6 @@ async function importMiddlewares(directory: string) {
   return [directory] // fix this: return array of middlewares
 }
 
-export const middlewares = await importMiddlewares(userMiddlewarePath())
+export const middlewares = async () => {
+  return await importMiddlewares(userMiddlewarePath())
+}

package/src/request.ts

@@ -4,41 +4,27 @@ import type { VineType } from '@stacksjs/types'
 import { customValidate, validateField } from '@stacksjs/validation'
 
 interface RequestData {
-  [key: string]: string
-}
-
-interface ValidationType {
-  rule: VineType
-  message: { [key: string]: string }
+  [key: string]: any
 }
 
 interface ValidationField {
-  [key: string]: string | ValidationType
-  validation: ValidationType
+  rule: VineType
+  message: Record<string, string>
 }
 
 interface CustomAttributes {
   [key: string]: ValidationField
 }
 
-type RouteParams = { [key: string]: string } | null
+type RouteParams = { [key: string]: string | number } | null
 
-export class Request implements RequestInstance {
-  private static instance: Request
-  private query: RequestData = {}
-  private params: RouteParams = null
-  private headers: any = {}
-
-  // An attempt to singleston instance, might be needed at some point
-  public static getInstance(): Request {
-    if (!Request.instance) {
-      Request.instance = new Request()
-    }
-    return Request.instance
-  }
+export class Request<T extends RequestData = RequestData> implements RequestInstance {
+  public query: T = {} as T
+  public params: RouteParams = null
+  public headers: any = {}
 
   public addQuery(url: URL): void {
-    this.query = Object.fromEntries(url.searchParams)
+    this.query = Object.fromEntries(url.searchParams) as unknown as T
   }
 
   public addBodies(params: any): void {
@@ -57,7 +43,7 @@ export class Request implements RequestInstance {
     return this.query[element]
   }
 
-  public all(): RequestData {
+  public all(): T {
     return this.query
   }
 
@@ -115,8 +101,8 @@ export class Request implements RequestInstance {
   }
 
   public getParamAsInt(key: string): number | null {
-    const value = this.params ? this.params[key] || null : null
-    return value ? Number.parseInt(value) : null
+    const value = this.getParam(key)
+    return value ? Number.parseInt(value.toString()) : null
   }
 }
 

package/src/router.ts

@@ -1,10 +1,11 @@
 import type { Action } from '@stacksjs/actions'
 import { log } from '@stacksjs/logging'
-import { path as p, projectStoragePath, routesPath } from '@stacksjs/path'
+import { path as p } from '@stacksjs/path'
 import { kebabCase, pascalCase } from '@stacksjs/strings'
 import type { Job } from '@stacksjs/types'
 import type { RedirectCode, Route, RouteGroupOptions, RouterInterface, StatusCode } from '@stacksjs/types'
-import { extractDefaultRequest, extractModelRequest, findRequestInstance } from './utils'
+import { customValidate, isObjectNotEmpty } from '@stacksjs/validation'
+import { extractDefaultRequest, findRequestInstance } from './utils'
 
 type ActionPath = string // TODO: narrow this by automating its generation
 
@@ -66,7 +67,7 @@ export class Router implements RouterInterface {
   public async email(path: Route['url']): Promise<this> {
     path = pascalCase(path)
 
-    const emailModule = (await import(p.userNotificationsPath(`${path}.ts`))).default as Action
+    const emailModule = (await import(p.userNotificationsPath(path))).default as Action
     const callback = emailModule.handle
     const uri = this.prepareUri(path)
     this.addRoute('GET', uri, callback, 200)
@@ -75,7 +76,7 @@ export class Router implements RouterInterface {
   }
 
   public async health(): Promise<this> {
-    const healthModule = (await import(p.userActionsPath('HealthAction.ts'))).default as Action
+    const healthModule = (await import(p.userActionsPath('HealthAction'))).default as Action
     const callback = healthModule.handle
     const path = healthModule.path ?? `${this.apiPrefix}/health`
 
@@ -107,7 +108,7 @@ export class Router implements RouterInterface {
     path = pascalCase(path) // actions are PascalCase
 
     try {
-      const action = (await import(p.userActionsPath(`${path}.ts`))).default as Action
+      const action = (await import(p.userActionsPath(path))).default as Action
 
       return this.addRoute(action.method ?? 'GET', this.prepareUri(path), action.handle, 200)
     } catch (error) {
@@ -274,8 +275,7 @@ export class Router implements RouterInterface {
     let importPathFunction = p.appPath // Default import path function
 
     if (callbackPath.startsWith('../')) importPathFunction = p.routesPath
-
-    if (modulePath.includes('OrmAction')) importPathFunction = p.projectStoragePath
+    if (modulePath.includes('OrmAction')) importPathFunction = p.storagePath
 
     // Remove trailing .ts if present
     modulePath = modulePath.endsWith('.ts') ? modulePath.slice(0, -3) : modulePath
@@ -301,17 +301,16 @@ export class Router implements RouterInterface {
     // if fails, return validation error
     let requestInstance
 
-    console.log('actionModule', actionModule)
-
     if (actionModule.default.requestFile) {
       requestInstance = await findRequestInstance(actionModule.default.requestFile)
     } else {
       requestInstance = await extractDefaultRequest(modulePath)
     }
 
-    console.log(actionModule.default.requestFile)
-
     try {
+      if (isObjectNotEmpty(actionModule.default.validations))
+        await customValidate(actionModule.default.validations, requestInstance.all())
+
       return await actionModule.default.handle(requestInstance)
     } catch (error: any) {
       return { status: error.status, errors: error.errors }

package/src/server.ts

@@ -40,23 +40,22 @@ export async function serve(options: ServeOptions = {}) {
 }
 
 export async function serverResponse(req: Request, body: string) {
-  log.info(`Incoming Request: ${req.method} ${req.url}`)
-  log.info(`Headers: ${JSON.stringify(req.headers)}`)
-  log.info(`Body: ${JSON.stringify(req.body)}`)
-  // log.info(`Query: ${JSON.stringify(req.query)}`)
-  // log.info(`Params: ${JSON.stringify(req.params)}`)
-  // log.info(`Cookies: ${JSON.stringify(req.cookies)}`)
+  log.debug(`Incoming Request: ${req.method} ${req.url}`)
+  log.debug(`Headers: ${JSON.stringify(req.headers)}`)
+  log.debug(`Body: ${JSON.stringify(req.body)}`)
+  // log.debug(`Query: ${JSON.stringify(req.query)}`)
+  // log.debug(`Params: ${JSON.stringify(req.params)}`)
+  // log.debug(`Cookies: ${JSON.stringify(req.cookies)}`)
 
   // Trim trailing slash from the URL if it's not the root '/'
   // This automatically allows for route definitions, like
   // '/about' and '/about/' to be treated as the same
   const trimmedUrl = req.url.endsWith('/') && req.url.length > 1 ? req.url.slice(0, -1) : req.url
-
   const url = new URL(trimmedUrl)
-
   const routesList: Route[] = await route.getRoutes()
-  log.info(`Routes List: ${JSON.stringify(routesList)}`)
-  log.info(`URL: ${JSON.stringify(url)}`)
+
+  log.info(`Routes List: ${JSON.stringify(routesList)}`, { styled: false })
+  log.info(`URL: ${JSON.stringify(url)}`, { styled: false })
 
   if (req.method === 'OPTIONS') {
     return handleOptions(req)
@@ -70,9 +69,10 @@ export async function serverResponse(req: Request, body: string) {
     })
     .find((route: Route) => route.method === req.method)
 
-  log.info(`Found Route: ${JSON.stringify(foundRoute)}`)
+  log.info(`Found Route: ${JSON.stringify(foundRoute)}`, { styled: false })
 
   if (!foundRoute) {
+    // TODO: create a pretty 404 page
     return new Response('Pretty 404 page coming soon', {
       status: 404,
       headers: {
@@ -80,7 +80,7 @@ export async function serverResponse(req: Request, body: string) {
         'Access-Control-Allow-Headers': '*',
         'Content-Type': 'json',
       },
-    }) // TODO: create a pretty 404 page
+    })
   }
 
   const routeParams = extractDynamicSegments(foundRoute.uri, url.pathname)
@@ -144,7 +144,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
 
     const { status, ...payloadWithoutStatus } = middlewarePayload
 
-    return await new Response(JSON.stringify(payloadWithoutStatus), {
+    return new Response(JSON.stringify(payloadWithoutStatus), {
       headers: {
         'Content-Type': 'json',
         'Access-Control-Allow-Origin': '*',
@@ -160,7 +160,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
     const callback = String(foundCallback)
     const response = Response.redirect(callback, statusCode)
 
-    return await noCache(response)
+    return noCache(response)
   }
 
   if (foundRoute?.method !== req.method) {
@@ -178,7 +178,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
     try {
       const fileContent = Bun.file(foundCallback)
 
-      return await new Response(fileContent, {
+      return new Response(fileContent, {
         headers: {
           'Content-Type': 'text/html',
           'Access-Control-Allow-Origin': '*',
@@ -186,7 +186,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
         },
       })
     } catch (error) {
-      return await new Response('Error reading the HTML file', {
+      return new Response('Error reading the HTML file', {
         status: 500,
         headers: {
           'Access-Control-Allow-Origin': '*',
@@ -197,7 +197,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
   }
 
   if (isString(foundCallback))
-    return await new Response(foundCallback, {
+    return new Response(foundCallback, {
       headers: {
         'Content-Type': 'json',
         'Access-Control-Allow-Origin': '*',
@@ -209,7 +209,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
   if (isFunction(foundCallback)) {
     const result = foundCallback()
 
-    return await new Response(JSON.stringify(result), {
+    return new Response(JSON.stringify(result), {
       status: 200,
       headers: {
         'Access-Control-Allow-Origin': '*',
@@ -222,7 +222,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
     if (foundCallback.status === 401) {
       const { status, ...rest } = foundCallback
 
-      return await new Response(JSON.stringify(rest), {
+      return new Response(JSON.stringify(rest), {
         headers: {
           'Content-Type': 'json',
           'Access-Control-Allow-Origin': '*',
@@ -235,7 +235,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
     if (foundCallback.status === 403) {
       const { status, ...rest } = foundCallback
 
-      return await new Response(JSON.stringify(rest), {
+      return new Response(JSON.stringify(rest), {
         headers: {
           'Content-Type': 'json',
           'Access-Control-Allow-Origin': '*',
@@ -248,7 +248,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
     if (foundCallback.status === 422) {
       const { status, ...rest } = foundCallback
 
-      return await new Response(JSON.stringify(rest), {
+      return new Response(JSON.stringify(rest), {
         headers: {
           'Content-Type': 'json',
           'Access-Control-Allow-Origin': '*',
@@ -261,7 +261,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
     if (foundCallback.status === 500) {
       const { status, ...rest } = foundCallback
 
-      return await new Response(JSON.stringify(rest), {
+      return new Response(JSON.stringify(rest), {
         headers: { 'Content-Type': 'json', 'Access-Control-Allow-Origin': '*', 'Access-Control-Allow-Headers': '*' },
         status: 500,
       })
@@ -269,7 +269,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
   }
 
   if (isObject(foundCallback)) {
-    return await new Response(JSON.stringify(foundCallback), {
+    return new Response(JSON.stringify(foundCallback), {
       headers: {
         'Content-Type': 'json',
         'Access-Control-Allow-Origin': '*',
@@ -280,7 +280,7 @@ async function execute(foundRoute: Route, req: Request, { statusCode }: Options)
   }
 
   // If no known type matched, return a generic error.
-  return await new Response('Unknown callback type.', {
+  return new Response('Unknown callback type.', {
     headers: {
       'Content-Type': 'json',
       'Access-Control-Allow-Origin': '*',

package/src/utils.ts

@@ -17,7 +17,6 @@ export function extractModelFromAction(action: string): string {
 
   if (action.includes('IndexOrmAction')) {
     const match = action.match(/\/([A-Z][a-z]+)IndexOrmAction/)
-
     const modelString = match ? match[1] : ''
 
     model = modelString as string
@@ -25,7 +24,6 @@ export function extractModelFromAction(action: string): string {
 
   if (action.includes('StoreOrmAction')) {
     const match = action.match(/\/([A-Z][a-z]+)StoreOrmAction/)
-
     const modelString = match ? match[1] : ''
 
     model = modelString as string
@@ -57,7 +55,6 @@ export function extractModelFromAction(action: string): string {
 
 export function extractDynamicAction(action: string): string | undefined {
   const regex = /Actions\/(.*?)Action/
-
   const match = action.match(regex)
 
   return match ? match[1] : ''
@@ -65,23 +62,17 @@ export function extractDynamicAction(action: string): string | undefined {
 
 export async function extractModelRequest(action: string) {
   const extractedModel = extractModelFromAction(action)
-
   const lowerCaseModel = camelCase(extractedModel)
-
   const requestPath = path.frameworkPath(`requests/${extractedModel}Request.ts`)
-
   const requestInstance = await import(requestPath)
-
   const requestIndex = `${lowerCaseModel}Request`
 
   return requestInstance[requestIndex]
 }
 
 export async function findRequestInstance(requestInstance: string) {
-  const frameworkDirectory = path.projectStoragePath('framework/requests')
-
+  const frameworkDirectory = path.storagePath('framework/requests')
   const filePath = path.join(frameworkDirectory, `${requestInstance}.ts`)
-
   const pathExists = await existsSync(filePath)
 
   // Check if the directory exists
@@ -91,8 +82,7 @@ export async function findRequestInstance(requestInstance: string) {
     return requestInstance.request
   }
 
-  const defaultRequestPath = path.projectStoragePath('framework/core/router/src/request.ts')
-
+  const defaultRequestPath = path.storagePath('framework/core/router/src/request.ts')
   const fileExists = await existsSync(defaultRequestPath)
 
   if (fileExists) {