@stacksjs/router 0.64.6 → 0.66.0

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@stacksjs/router",
   "type": "module",
-  "version": "0.64.6",
+  "version": "0.66.0",
   "description": "The Stacks framework router.",
   "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/router#readme",
@@ -15,13 +16,7 @@
   "bugs": {
     "url": "https://github.com/stacksjs/stacks/issues"
   },
-  "keywords": [
-    "router",
-    "stacks",
-    "framework",
-    "typescript",
-    "javascript"
-  ],
+  "keywords": ["router", "stacks", "framework", "typescript", "javascript"],
   "exports": {
     ".": {
       "bun": "./src/index.ts",
@@ -34,27 +29,27 @@
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
-  "files": [
-    "README.md",
-    "dist",
-    "src"
-  ],
+  "files": ["README.md", "dist", "src"],
   "scripts": {
-    "build": "bun --bun build.ts",
-    "build:user": "bun --bun build2.ts",
-    "typecheck": "bun --bun tsc --noEmit",
-    "prepublishOnly": "bun --bun run build"
+    "build": "bun build.ts",
+    "build:user": "bun build2.ts",
+    "typecheck": "bun tsc --noEmit",
+    "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/config": "latest",
-    "@stacksjs/logging": "latest",
-    "unplugin-vue-router": "^0.10.7",
-    "vue-router": "^4.4.3"
+    "@stacksjs/actions": "0.65.1",
+    "@stacksjs/config": "0.65.1",
+    "@stacksjs/error-handling": "0.65.1",
+    "@stacksjs/logging": "0.65.1",
+    "@stacksjs/orm": "0.65.1",
+    "@stacksjs/path": "0.65.1",
+    "@stacksjs/storage": "0.65.1",
+    "@stacksjs/validation": "0.65.1",
+    "unplugin-vue-router": "^0.10.8",
+    "vue-router": "^4.4.5"
   },
   "devDependencies": {
-    "@stacksjs/development": "latest"
+    "@stacksjs/development": "0.65.1",
+    "@stacksjs/types": "0.65.1"
   }
 }

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from './middleware'
 export * from './request'
-export * from './server'
 export * from './router'
+export * from './server'
 export * from './utils'

package/src/middleware.ts

@@ -1,10 +1,10 @@
-import { userMiddlewarePath } from '@stacksjs/path'
 import type { MiddlewareOptions } from '@stacksjs/types'
+import { userMiddlewarePath } from '@stacksjs/path'
 
 export class Middleware implements MiddlewareOptions {
   name: string
   priority: number
-  handle: Function
+  handle: () => Promise<void>
 
   constructor(data: MiddlewareOptions) {
     this.name = data.name
@@ -15,7 +15,7 @@ export class Middleware implements MiddlewareOptions {
 
 // const readdir = promisify(fs.readdir)
 
-async function importMiddlewares(directory: string) {
+async function importMiddlewares(directory: string): Promise<string[]> {
   // const middlewares = []
   // TODO: somehow this breaks ./buddy dev
   // const files = await readdir(directory)
@@ -30,6 +30,6 @@ async function importMiddlewares(directory: string) {
   return [directory] // fix this: return array of middlewares
 }
 
-export const middlewares = async () => {
+export async function middlewares(): Promise<string[]> {
   return await importMiddlewares(userMiddlewarePath())
 }

package/src/request.ts

@@ -1,6 +1,5 @@
-import type { RequestInstance, RouteParam } from '@stacksjs/types'
+import type { RequestInstance, RouteParam, VineType } from '@stacksjs/types'
 
-import type { VineType } from '@stacksjs/types'
 import { customValidate, validateField } from '@stacksjs/validation'
 
 interface RequestData {
@@ -12,6 +11,8 @@ interface ValidationField {
   message: Record<string, string>
 }
 
+type AuthToken = `${number}:${number}:${string}`
+
 interface CustomAttributes {
   [key: string]: ValidationField
 }
@@ -39,7 +40,7 @@ export class Request<T extends RequestData = RequestData> implements RequestInst
     this.headers = headerParams
   }
 
-  public get(element: string): string | number | undefined {
+  public get(element: string): any {
     return this.query[element]
   }
 
@@ -50,7 +51,8 @@ export class Request<T extends RequestData = RequestData> implements RequestInst
   public async validate(attributes?: CustomAttributes): Promise<void> {
     if (attributes === undefined || attributes === null) {
       await validateField('Release', this.all())
-    } else {
+    }
+    else {
       await customValidate(attributes, this.all())
     }
   }
@@ -67,14 +69,15 @@ export class Request<T extends RequestData = RequestData> implements RequestInst
     const pattern = new RegExp(`^${routePattern.replace(/:(\w+)/g, (match, paramName) => `(?<${paramName}>\\w+)`)}$`)
     const match = pattern.exec(pathname)
 
-    if (match?.groups) this.params = match.groups
+    if (match?.groups)
+      this.params = match.groups
   }
 
   public header(headerParam: string): string | number | boolean | null {
     return this.headers.get(headerParam)
   }
 
-  public getHeaders() {
+  public getHeaders(): any {
     return this.headers
   }
 
@@ -86,7 +89,7 @@ export class Request<T extends RequestData = RequestData> implements RequestInst
     return this.params ? this.params[key] || null : null
   }
 
-  public bearerToken(): string | null {
+  public bearerToken(): string | null | AuthToken {
     const authorizationHeader = this.headers.get('authorization')
 
     if (authorizationHeader?.startsWith('Bearer ')) {
@@ -106,4 +109,4 @@ export class Request<T extends RequestData = RequestData> implements RequestInst
   }
 }
 
-export const request = new Request()
+export const request: Request = new Request()

package/src/router.ts

@@ -1,9 +1,9 @@
 import type { Action } from '@stacksjs/actions'
+import type { Job, RedirectCode, RequestInstance, Route, RouteGroupOptions, RouterInterface, StatusCode } from '@stacksjs/types'
+import { handleError } from '@stacksjs/error-handling'
 import { log } from '@stacksjs/logging'
 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 { customValidate, isObjectNotEmpty } from '@stacksjs/validation'
 import { extractDefaultRequest, findRequestInstance } from './utils'
 
@@ -11,7 +11,6 @@ type ActionPath = string // TODO: narrow this by automating its generation
 
 export class Router implements RouterInterface {
   private routes: Route[] = []
-  private apiPrefix = '/api'
   private groupPrefix = ''
   private path = ''
 
@@ -23,7 +22,7 @@ export class Router implements RouterInterface {
   ): this {
     const name = uri.replace(/\//g, '.').replace(/:/g, '') // we can improve this
     const pattern = new RegExp(
-      `^${uri.replace(/:[a-zA-Z]+/g, (_match) => {
+      `^${uri.replace(/:[a-z]+/gi, (_match) => {
         return '([a-zA-Z0-9-]+)'
       })}$`,
     )
@@ -78,7 +77,7 @@ export class Router implements RouterInterface {
   public async health(): Promise<this> {
     const healthModule = (await import(p.userActionsPath('HealthAction'))).default as Action
     const callback = healthModule.handle
-    const path = healthModule.path ?? `${this.apiPrefix}/health`
+    const path = healthModule.path ?? `/health`
 
     this.addRoute('GET', path, callback, 200)
 
@@ -95,7 +94,8 @@ export class Router implements RouterInterface {
   }
 
   public async action(path: ActionPath | Route['path']): Promise<this> {
-    if (!path) return this
+    if (!path)
+      return this
 
     // check if action is a file anywhere in ./app/Actions/**/*.ts
     if (path?.endsWith('.ts')) {
@@ -111,8 +111,9 @@ export class Router implements RouterInterface {
       const action = (await import(p.userActionsPath(path))).default as Action
 
       return this.addRoute(action.method ?? 'GET', this.prepareUri(path), action.handle, 200)
-    } catch (error) {
-      log.error(`Could not find Action for path: ${path}`)
+    }
+    catch (error) {
+      handleError(`Could not find Action for path: ${path}`, error)
 
       return this
     }
@@ -161,7 +162,8 @@ export class Router implements RouterInterface {
   }
 
   public group(options: string | RouteGroupOptions, callback?: () => void): this {
-    if (typeof options === 'string') options = options.startsWith('/') ? options.slice(1) : options
+    if (typeof options === 'string')
+      options = options.startsWith('/') ? options.slice(1) : options
 
     let cb: () => void
 
@@ -172,7 +174,8 @@ export class Router implements RouterInterface {
       options = {}
     }
 
-    if (!callback) throw new Error('Missing callback function for your route group.')
+    if (!callback)
+      throw new Error('Missing callback function for your route group.')
 
     cb = callback
 
@@ -191,7 +194,8 @@ export class Router implements RouterInterface {
     this.routes.forEach((r) => {
       r.uri = `${prefix}${r.uri}`
 
-      if (middleware.length) r.middleware = middleware
+      if (middleware.length)
+        r.middleware = middleware
 
       originalRoutes.push(r)
       return this
@@ -204,14 +208,12 @@ export class Router implements RouterInterface {
   }
 
   public name(name: string): this {
-    // @ts-expect-error - this is fine for now
     this.routes[this.routes.length - 1].name = name
 
     return this
   }
 
   public middleware(middleware: Route['middleware']): this {
-    // @ts-expect-error - this is fine for now
     this.routes[this.routes.length - 1].middleware = middleware
 
     return this
@@ -255,7 +257,6 @@ export class Router implements RouterInterface {
     }
 
     this.setGroupPrefix('', options)
-    return
   }
 
   public async resolveCallback(callback: Route['callback']): Promise<Route['callback']> {
@@ -264,7 +265,8 @@ export class Router implements RouterInterface {
       return actionModule.default
     }
 
-    if (typeof callback === 'string') return await this.importCallbackFromPath(callback, this.path)
+    if (typeof callback === 'string')
+      return await this.importCallbackFromPath(callback, this.path)
 
     // in this case, the callback ends up being a function
     return callback
@@ -274,18 +276,22 @@ export class Router implements RouterInterface {
     let modulePath = callbackPath
     let importPathFunction = p.appPath // Default import path function
 
-    if (callbackPath.startsWith('../')) importPathFunction = p.routesPath
-    if (modulePath.includes('OrmAction')) importPathFunction = p.storagePath
+    if (callbackPath.startsWith('../'))
+      importPathFunction = p.routesPath
+    if (modulePath.includes('OrmAction'))
+      importPathFunction = p.storagePath
 
     // Remove trailing .ts if present
     modulePath = modulePath.endsWith('.ts') ? modulePath.slice(0, -3) : modulePath
 
     let actionModule = null
 
-    if (modulePath.includes('storage/framework/orm')) actionModule = await import(modulePath)
-    else if (modulePath.includes('app/Actions')) actionModule = await import(modulePath)
+    if (modulePath.includes('storage/framework/orm'))
+      actionModule = await import(modulePath)
+    else if (modulePath.includes('app/Actions'))
+      actionModule = await import(modulePath)
     else if (modulePath.includes('OrmAction'))
-      actionModule = await import(p.storagePath(`/framework/orm/${modulePath}`))
+      actionModule = await import(p.storagePath(`/framework/actions/src/${modulePath}.ts`))
     else actionModule = await import(importPathFunction(modulePath))
 
     // Use custom path from action module if available
@@ -299,21 +305,29 @@ export class Router implements RouterInterface {
     // then validate
     // if succeeds, run the handle
     // if fails, return validation error
-    let requestInstance
+    let requestInstance: RequestInstance
 
     if (actionModule.default.requestFile) {
       requestInstance = await findRequestInstance(actionModule.default.requestFile)
-    } else {
-      requestInstance = await extractDefaultRequest(modulePath)
+    }
+    else {
+      requestInstance = await extractDefaultRequest()
     }
 
     try {
-      if (isObjectNotEmpty(actionModule.default.validations))
+      if (isObjectNotEmpty(actionModule.default.validations) && requestInstance)
         await customValidate(actionModule.default.validations, requestInstance.all())
 
       return await actionModule.default.handle(requestInstance)
-    } catch (error: any) {
-      return { status: error.status, errors: error.errors }
+    }
+    catch (error: any) {
+      if (error.status === 422)
+        return { status: 422, errors: JSON.parse(error.message) }
+
+      if (!error.status)
+        return { status: 500, errors: error.message }
+
+      return { status: error.status, errors: error.message }
     }
   }
 
@@ -321,11 +335,12 @@ export class Router implements RouterInterface {
     return path.endsWith('/') ? path.slice(0, -1) : path
   }
 
-  public prepareUri(path: string) {
+  public prepareUri(path: string): string {
     // if string starts with / then remove it because we are adding it back in the next line
-    if (path.startsWith('/')) path = path.slice(1)
+    if (path.startsWith('/'))
+      path = path.slice(1)
 
-    path = `${this.apiPrefix}${this.groupPrefix}/${path}`
+    path = `${this.groupPrefix}/${path}`
 
     // if path ends in "/", then remove it
     // e.g. triggered when route is "/"
@@ -340,4 +355,4 @@ export class Router implements RouterInterface {
   }
 }
 
-export const route = new Router()
+export const route: Router = new Router()