chore: wip

Author: chrisbbreuer

app/Actions/HealthAction.ts

@@ -4,6 +4,7 @@ import { Action } from '@stacksjs/actions'
 export default new Action({
   name: 'Health',
   description: 'A health check for your application.',
+  path: '/api/health',
 
   handle() {
     return {

bun.lockb

@@ -8,15 +8,17 @@ import { route } from '@stacksjs/router'
  * @see https://stacksjs.org/docs/routing
  */
 
-// route.get('/', () => 'hello world') // $APP_URL/api
+// $APP_URL/api
+await route.get('/', () => 'hello world')
 
-route.get('/welcome', () => { // stacksjs.org/api/welcome
+// $APP_URL/api/welcome
+await route.get('/welcome', () => {
   return { // you may return an object as well
     data: 'hello world, friend',
   }
 })
 
-// route.get('/hello/world', () => 'hello world, buddy') // stacksjs.org/api/hello/world
+route.get('/hello/world', () => 'hello world, buddy') // stacksjs.org/api/hello/world
 
 // route.group('/buddy', () => { // you may group your routes in a few different ways
 //   route.get('/commands', 'Actions/Buddy/CommandsAction')
@@ -32,4 +34,4 @@ route.get('/welcome', () => { // stacksjs.org/api/welcome
 // route.action('/example') // the equivalent of route.get('/example', 'ExampleAction')
 // route.job('/example-two') // the equivalent of route.get('/example-two', 'ExampleTwoJob')
 
-// route.health() // adds an `/api/health` route
+route.health() // adds an `/api/health` route

routes/api.ts

@@ -7,12 +7,15 @@ import { join, path } from '@stacksjs/path'
 import { italic, log, runCommandSync } from '@stacksjs/cli'
 
 declare global {
-  var count: number
+  let counter: number
 }
 
-globalThis.count ??= 0
-log.debug(`Reloaded ${globalThis.count} times`)
-globalThis.count++
+// @ts-expect-error - somehow type is not recognized
+globalThis.counter ??= 0
+// @ts-expect-error - somehow type is not recognized
+log.debug(`Reloaded ${globalThis.counter} times`)
+// @ts-expect-error - somehow type is not recognized
+globalThis.counter++
 
 async function watchFolders() {
   const coreDirectories = await readdir(path.corePath(), { withFileTypes: true })
@@ -48,7 +51,8 @@ async function watchFolders() {
   })
 }
 
-if (globalThis.count === 1)
+// @ts-expect-error - somehow type is not recognized
+if (globalThis.counter === 1)
   watchFolders().catch(log.error)
 else
   log.debug(`Skipping watching folders`)
@@ -64,7 +68,8 @@ process.on('SIGINT', () => {
   process.exit()
 })
 
-if (globalThis.count === 1)
-  log.info(`Listening on http://localhost:3999...`)
-else
-  log.info(`#${globalThis.count}: Listening on http://localhost:3999...`)
+// @ts-expect-error - somehow type is not recognized
+if (globalThis.counter === 1)
+  log.info(`Listening on http://localhost:3999/api ...`)
+else // @ts-expect-error - somehow type is not recognized
+  log.info(`#${globalThis.counter}: Listening on http://localhost:3999/api ...`)

storage/framework/api/dev.ts

@@ -41,6 +41,8 @@ export class Router implements RouterInterface {
       routeCallback = callback
     }
 
+    log.debug(`Adding route: ${method} ${uri} with name ${name}`)
+
     this.routes.push({
       name,
       method,
@@ -62,7 +64,7 @@ export class Router implements RouterInterface {
     callback = await this.resolveCallback(callback)
 
     const uri = this.prepareUri(this.path)
-    log.debug(`Prepared URI: ${uri}`) // should be debug
+    log.debug(`Prepared URI: ${uri}`)
 
     return this.addRoute('GET', uri, callback, 200)
   }
@@ -71,7 +73,9 @@ export class Router implements RouterInterface {
     const healthModule = await import(p.userActionsPath('HealthAction.ts'))
     const callback = healthModule.default.handle
 
-    this.addRoute('GET', `${this.apiPrefix}/health`, callback, 200)
+    const path = healthModule.default.path ?? `${this.apiPrefix}/health`
+
+    this.addRoute('GET', path, callback, 200)
 
     return this
   }
@@ -152,7 +156,7 @@ export class Router implements RouterInterface {
       cb = callback
     }
 
-    const { prefix = '', middleware = [] } = options
+    const { prefix = '', middleware = [] } = options as RouteGroupOptions
 
     // Save a reference to the original routes array
     const originalRoutes = this.routes
@@ -273,7 +277,7 @@ export class Router implements RouterInterface {
     path = `${this.apiPrefix}${this.groupPrefix}/${path}`
 
     // if path ends in "/", then remove it
-    // possibly triggered when route is "/"
+    // e.g. triggered when route is "/"
     return path.endsWith('/') ? path.slice(0, -1) : path
   }