@h3ravel/router 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @h3ravel/router
 
+## 0.4.0
+
+### Minor Changes
+
+- 8ceb2c1: implement the Application class directly since it already implements the IClass contract
+
+### Patch Changes
+
+- a27f452: chore: fix all linting issues.
+- c906050: chore: migrate tests suite to jest
+- Updated dependencies [8ceb2c1]
+- Updated dependencies [a27f452]
+- Updated dependencies [c906050]
+  - @h3ravel/core@0.4.0
+  - @h3ravel/shared@0.4.0
+  - @h3ravel/support@0.4.0
+  - @h3ravel/http@2.0.0
+
 ## 0.3.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/router",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Route facade, decorators and controller system for H3ravel.",
   "type": "module",
   "main": "dist/index.js",
@@ -10,10 +10,10 @@
   },
   "dependencies": {
     "h3": "^2.0.0-beta.1",
-    "@h3ravel/core": "0.3.0",
-    "@h3ravel/http": "1.0.0",
-    "@h3ravel/support": "0.3.0",
-    "@h3ravel/shared": "0.3.0"
+    "@h3ravel/http": "2.0.0",
+    "@h3ravel/support": "0.4.0",
+    "@h3ravel/core": "0.4.0",
+    "@h3ravel/shared": "0.4.0"
   },
   "scripts": {
     "barrel": "barrelsby --directory src --delete --singleQuotes",
@@ -21,6 +21,6 @@
     "dev": "tsx watch src/index.ts",
     "start": "node dist/index.js",
     "lint": "eslint . --ext .ts",
-    "test": "vitest"
+    "test": "jest --passWithNoTests"
   }
 }

package/src/Providers/AssetsServiceProvider.ts

@@ -1,10 +1,10 @@
-import { readFile, stat } from "node:fs/promises";
+import { readFile, stat } from 'node:fs/promises'
 
 import { ServiceProvider } from '@h3ravel/core'
-import { before } from "@h3ravel/support";
-import { join } from "node:path";
+import { before } from '@h3ravel/support'
+import { join } from 'node:path'
 import { serveStatic } from 'h3'
-import { statSync } from "node:fs";
+import { statSync } from 'node:fs'
 
 /**
  * Handles public assets loading
@@ -20,22 +20,22 @@ export class AssetsServiceProvider extends ServiceProvider {
 
         app.middleware(`/${fsconfig.public_mask}/**`, (event) => {
             return serveStatic(event, {
-                indexNames: ["/index.html"],
+                indexNames: ['/index.html'],
                 getContents: (id) => {
                     const newId = id.replace(`/${fsconfig.public_mask}/`, '')
                     return readFile(join(before(publicPath, newId), newId))
                 },
                 getMeta: async (id) => {
                     const newId = id.replace(`/${fsconfig.public_mask}/`, '')
-                    const stats = await stat(join(before(publicPath, newId), newId)).catch(() => { });
+                    const stats = await stat(join(before(publicPath, newId), newId)).catch(() => { })
                     if (stats?.isFile()) {
                         return {
                             size: stats.size,
                             mtime: stats.mtimeMs,
-                        };
+                        }
                     }
                 },
-            });
+            })
         })
 
         this.app.singleton('asset', () => {

package/src/Providers/RouteServiceProvider.ts

@@ -1,4 +1,4 @@
-import { Router } from '../Router'
+import { Router } from '../Route'
 import { ServiceProvider } from '@h3ravel/core'
 import path from 'node:path'
 import { readdir } from 'node:fs/promises'
@@ -27,7 +27,7 @@ export class RouteServiceProvider extends ServiceProvider {
         try {
             const routePath = this.app.getPath('routes')
 
-            const files = await readdir(routePath);
+            const files = await readdir(routePath)
 
             for (let i = 0; i < files.length; i++) {
                 const routesModule = await import(path.join(routePath, files[i]))

package/src/Route.ts

@@ -1 +1,182 @@
-export default class { }
+import { H3Event, Middleware, MiddlewareOptions, type H3 } from 'h3'
+import { Request, Response } from '@h3ravel/http'
+import { Application, Controller, Kernel } from '@h3ravel/core'
+import { afterLast } from '@h3ravel/support'
+import { EventHandler, IController, IMiddleware } from '@h3ravel/shared'
+
+interface RouteDefinition {
+    method: string
+    path: string
+    name?: string
+    handler: EventHandler
+}
+
+export class Router {
+    private routes: RouteDefinition[] = []
+    private groupPrefix = ''
+    private groupMiddleware: EventHandler[] = []
+
+    constructor(protected h3App: H3, private app: Application) { }
+
+    /**
+     * Route Resolver
+     * 
+     * @param handler 
+     * @param middleware 
+     * @returns 
+     */
+    private resolveHandler (handler: EventHandler, middleware: IMiddleware[] = []) {
+        return async (event: H3Event) => {
+            const kernel = new Kernel(() => ({
+                request: new Request(event),
+                response: new Response(event)
+            }), middleware)
+
+            return kernel.handle(event, (ctx) => Promise.resolve(handler(ctx)))
+        }
+    }
+
+    /**
+     * Add a route to the stack
+     * 
+     * @param method 
+     * @param path 
+     * @param handler 
+     * @param name 
+     * @param middleware 
+     */
+    private addRoute (
+        method: string,
+        path: string,
+        handler: EventHandler,
+        name?: string,
+        middleware: IMiddleware[] = []
+    ) {
+        const fullPath = `${this.groupPrefix}${path}`.replace(/\/+/g, '/')
+        this.routes.push({ method, path: fullPath, name, handler })
+        this.h3App[method as 'get'](fullPath, this.resolveHandler(handler, middleware))
+    }
+
+    private resolveControllerOrHandler (
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string
+    ): EventHandler {
+        if (typeof handler === 'function' && (handler as any).prototype instanceof Controller) {
+            return (ctx) => {
+                const controller = new (handler as new (...args: any[]) => IController)(this.app)
+                const action = (methodName || 'index') as keyof IController
+
+                if (typeof controller[action] !== 'function') {
+                    throw new Error(`Method "${String(action)}" not found on controller ${handler.name}`)
+                }
+
+                return controller[action](ctx)
+            }
+        }
+
+        return handler as EventHandler
+    }
+
+
+    get (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string, name?: string, middleware: IMiddleware[] = []
+    ) {
+        this.addRoute('get', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
+    }
+
+    post (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string, name?: string, middleware: IMiddleware[] = []
+    ) {
+        this.addRoute('post', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
+    }
+
+    put (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string, name?: string, middleware: IMiddleware[] = []
+    ) {
+        this.addRoute('put', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
+    }
+
+    delete (
+        path: string,
+        handler: EventHandler | (new (...args: any[]) => IController),
+        methodName?: string, name?: string, middleware: IMiddleware[] = []
+    ) {
+        this.addRoute('delete', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
+    }
+
+    /**
+     * API Resource support  
+     * 
+     * @param path 
+     * @param controller 
+     */
+    apiResource (
+        path: string,
+        Controller: new (app: Application) => IController,
+        middleware: IMiddleware[] = []
+    ) {
+        path = path.replace(/\//g, '/')
+
+        const name = afterLast(path, '/')
+        const basePath = `/${path}`.replace(/\/+/g, '/')
+
+        const controller = new Controller(this.app)
+
+        this.addRoute('get', basePath, controller.index.bind(controller), `${name}.index`, middleware)
+        this.addRoute('post', basePath, controller.store.bind(controller), `${name}.store`, middleware)
+        this.addRoute('get', `${basePath}/:id`, controller.show.bind(controller), `${name}.show`, middleware)
+        this.addRoute('put', `${basePath}/:id`, controller.update.bind(controller), `${name}.update`, middleware)
+        this.addRoute('patch', `${basePath}/:id`, controller.update.bind(controller), `${name}.update`, middleware)
+        this.addRoute('delete', `${basePath}/:id`, controller.destroy.bind(controller), `${name}.destroy`, middleware)
+    }
+
+    /**
+     * Named route URL generator
+     * 
+     * @param name 
+     * @param params 
+     * @returns 
+     */
+    route (name: string, params: Record<string, string> = {}): string | undefined {
+        const found = this.routes.find(r => r.name === name)
+        if (!found) return undefined
+
+        let url = found.path
+        for (const [key, value] of Object.entries(params)) {
+            url = url.replace(`:${key}`, value)
+        }
+        return url
+    }
+
+    /**
+     * Grouping
+     * 
+     * @param options 
+     * @param callback 
+     */
+    group (options: { prefix?: string; middleware?: EventHandler[] }, callback: () => void) {
+        const prevPrefix = this.groupPrefix
+        const prevMiddleware = [...this.groupMiddleware]
+
+        this.groupPrefix += options.prefix || ''
+        this.groupMiddleware.push(...(options.middleware || []))
+
+        callback()
+
+        /**
+         * Restore state after group
+         */
+        this.groupPrefix = prevPrefix
+        this.groupMiddleware = prevMiddleware
+    }
+
+    middleware (path: string, handler: Middleware, opts?: MiddlewareOptions) {
+        this.h3App.use(path, handler, opts)
+    }
+}

package/src/index.ts

@@ -4,7 +4,6 @@
 
 export * from './Controller';
 export * from './Route';
-export * from './Router';
 export * from './Decorators/ApiResource';
 export * from './Decorators/Controller';
 export * from './Decorators/Get';

package/src/Router.ts

@@ -1,182 +0,0 @@
-import { H3Event, Middleware, MiddlewareOptions, type H3 } from 'h3'
-import { Request, Response } from '@h3ravel/http'
-import { Controller, Kernel } from '@h3ravel/core'
-import { afterLast } from '@h3ravel/support'
-import { EventHandler, HttpContext, IApplication, IController, IMiddleware } from '@h3ravel/shared'
-
-interface RouteDefinition {
-    method: string
-    path: string
-    name?: string
-    handler: EventHandler
-}
-
-export class Router {
-    private routes: RouteDefinition[] = []
-    private groupPrefix = ''
-    private groupMiddleware: EventHandler[] = []
-
-    constructor(protected h3App: H3, private app: IApplication) { }
-
-    /**
-     * Route Resolver
-     * 
-     * @param handler 
-     * @param middleware 
-     * @returns 
-     */
-    private resolveHandler (handler: EventHandler, middleware: IMiddleware[] = []) {
-        return async (event: H3Event) => {
-            const kernel = new Kernel(() => ({
-                request: new Request(event),
-                response: new Response(event)
-            }), middleware)
-
-            return kernel.handle(event, (ctx) => Promise.resolve(handler(ctx)))
-        }
-    }
-
-    /**
-     * Add a route to the stack
-     * 
-     * @param method 
-     * @param path 
-     * @param handler 
-     * @param name 
-     * @param middleware 
-     */
-    private addRoute (
-        method: string,
-        path: string,
-        handler: EventHandler,
-        name?: string,
-        middleware: IMiddleware[] = []
-    ) {
-        const fullPath = `${this.groupPrefix}${path}`.replace(/\/+/g, '/')
-        this.routes.push({ method, path: fullPath, name, handler })
-        this.h3App[method as 'get'](fullPath, this.resolveHandler(handler, middleware))
-    }
-
-    private resolveControllerOrHandler (
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string
-    ): EventHandler {
-        if (typeof handler === 'function' && (handler as any).prototype instanceof Controller) {
-            return (ctx) => {
-                const controller = new (handler as new (...args: any[]) => IController)(this.app)
-                const action = (methodName || 'index') as keyof IController
-
-                if (typeof controller[action] !== 'function') {
-                    throw new Error(`Method "${String(action)}" not found on controller ${handler.name}`)
-                }
-
-                return controller[action](ctx)
-            }
-        }
-
-        return handler as EventHandler
-    }
-
-
-    get (
-        path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string, name?: string, middleware: IMiddleware[] = []
-    ) {
-        this.addRoute('get', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-    }
-
-    post (
-        path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string, name?: string, middleware: IMiddleware[] = []
-    ) {
-        this.addRoute('post', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-    }
-
-    put (
-        path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string, name?: string, middleware: IMiddleware[] = []
-    ) {
-        this.addRoute('put', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-    }
-
-    delete (
-        path: string,
-        handler: EventHandler | (new (...args: any[]) => IController),
-        methodName?: string, name?: string, middleware: IMiddleware[] = []
-    ) {
-        this.addRoute('delete', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-    }
-
-    /**
-     * API Resource support  
-     * 
-     * @param path 
-     * @param controller 
-     */
-    apiResource (
-        path: string,
-        Controller: new (app: IApplication) => IController,
-        middleware: IMiddleware[] = []
-    ) {
-        path = path.replace(/\//g, '/')
-
-        const name = afterLast(path, '/')
-        const basePath = `/${path}`.replace(/\/+/g, '/')
-
-        const controller = new Controller(this.app)
-
-        this.addRoute('get', basePath, controller.index.bind(controller), `${name}.index`, middleware)
-        this.addRoute('post', basePath, controller.store.bind(controller), `${name}.store`, middleware)
-        this.addRoute('get', `${basePath}/:id`, controller.show.bind(controller), `${name}.show`, middleware)
-        this.addRoute('put', `${basePath}/:id`, controller.update.bind(controller), `${name}.update`, middleware)
-        this.addRoute('patch', `${basePath}/:id`, controller.update.bind(controller), `${name}.update`, middleware)
-        this.addRoute('delete', `${basePath}/:id`, controller.destroy.bind(controller), `${name}.destroy`, middleware)
-    }
-
-    /**
-     * Named route URL generator
-     * 
-     * @param name 
-     * @param params 
-     * @returns 
-     */
-    route (name: string, params: Record<string, string> = {}): string | undefined {
-        const found = this.routes.find(r => r.name === name)
-        if (!found) return undefined
-
-        let url = found.path
-        for (const [key, value] of Object.entries(params)) {
-            url = url.replace(`:${key}`, value)
-        }
-        return url
-    }
-
-    /**
-     * Grouping
-     * 
-     * @param options 
-     * @param callback 
-     */
-    group (options: { prefix?: string; middleware?: EventHandler[] }, callback: () => void) {
-        const prevPrefix = this.groupPrefix
-        const prevMiddleware = [...this.groupMiddleware]
-
-        this.groupPrefix += options.prefix || ''
-        this.groupMiddleware.push(...(options.middleware || []))
-
-        callback()
-
-        /**
-         * Restore state after group
-         */
-        this.groupPrefix = prevPrefix
-        this.groupMiddleware = prevMiddleware
-    }
-
-    middleware (path: string, handler: Middleware, opts?: MiddlewareOptions) {
-        this.h3App.use(path, handler, opts)
-    }
-}