chore: wip

chore: wip

Author: chrisbbreuer

routes/api.ts

@@ -8,15 +8,27 @@ import { route } from '@stacksjs/router'
  * @see https://stacksjs.org/docs/routing
  */
 
-route.get('/', () => 'hello world') // stacksjs.org/api/
-route.get('/welcome', () => 'hello world 2') // stacksjs.org/api/welcome
-route.get('/welcome/', () => 'hello world 3') // stacksjs.org/api/welcome/
-route.get('/buddy/commands', 'Buddy/CommandsAction')
-route.get('/buddy/versions', 'Buddy/VersionsAction')
-// route.get('/buddy/test-1', '../app/Actions/BuddyAction') // todo: support this
-// route.get('/buddy/test-2', import('../app/Actions/BuddyAction')) // todo: support this
+route.get('/', () => 'hello world') // $APP_URL/api
+
+route.get('/welcome', () => { // stacksjs.org/api/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.group('/buddy', () => { // you may group your routes in a few different ways
+  route.get('/commands', 'Actions/Buddy/CommandsAction')
+
+  route.group({ prefix: 'commands' }, () => {
+    route.get('/example-two', import('Actions/Buddy/CommandsAction')) // or import the action directly
+  })
+
+  route.get('/versions', '../app/Actions/Buddy/VersionsAction') // a relative path is accepted as well
+})
 
 route.action('/example') // the equivalent of route.get('/example', 'ExampleAction')
 route.job('/example-two') // the equivalent of route.get('/example-two', 'ExampleTwoJob')
 
-route.health() // /api/health
+route.health() // adds an `/api/health` route

routes/users.ts

@@ -1,14 +1,14 @@
-import { route } from '@stacksjs/router'
+// import { route } from '@stacksjs/router'
 
 // based on the route's file name, it wraps the contents into a
 // `route.group({ prefix: '/users' }, () => { ... })` block
 
-route.get('/:id', ({ id }) => {
-  // Retrieve user from database
-  return `User with ID ${id}`
-})
+// route.get('/:id', ({ id }) => {
+//   // Retrieve user from database
+//   return `User with ID ${id}`
+// })
 
-route.post('/', ({ name, email }) => {
-  // Save user to database
-  return `User ${name} (${email}) created`
-})
+// route.post('/', ({ name, email }) => {
+//   // Save user to database
+//   return `User ${name} (${email}) created`
+// })

storage/framework/core/router/src/router.ts

@@ -49,6 +49,10 @@ export class Router implements RouterInterface {
   }
 
   public async get(path: Route['url'], callback: Route['callback']): Promise<this> {
+    // if the route ends with a /, then remove it
+    if (path.endsWith('/'))
+      path = path.slice(0, -1)
+
     // check if callback is a string and if it is, then import that module path and use the default.handle function as the callback
     if (callback instanceof Promise) {
       const actionModule = await callback
@@ -159,7 +163,7 @@ export class Router implements RouterInterface {
     return this
   }
 
-  public group(options: RouteGroupOptions | (() => void), callback?: () => void): this {
+  public group(options: RouteGroupOptions | (() => void) | string, callback?: () => void): this {
     let cb: () => void
 
     if (typeof options === 'function') {

storage/framework/core/tsconfig.json

@@ -15,6 +15,8 @@
       "stacks/*": ["./*/src"],
       "buddy": ["./buddy/src/index.ts"],
       "buddy/*": ["./buddy/src/*"],
+      "Actions/*": ["../../../app/Actions/*"],
+      "Jobs/*": ["../../../app/Jobs/*"],
       "~/*": ["../../../*"]
     },
     "resolveJsonModule": true,

storage/framework/core/types/src/router.ts

@@ -43,7 +43,7 @@ export interface Route {
   url: string // used synonymously with uri
   method: HttpMethod
   pattern: RegExp
-  callback: RouteCallback | ActionName | Action
+  callback: RouteCallback | ActionName | Action | Promise<any> // we may be able to improve the `Promise<any>` if we could narrow this type `import('../app/Actions/BuddyAction')`
   paramNames: string[]
   middleware?: string | string[]
   statusCode?: StatusCode