@h3ravel/router 1.7.0 → 1.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/router",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "Route facade, decorators and controller system for H3ravel.",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,6 +13,9 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -34,10 +37,10 @@
   ],
   "dependencies": {
     "h3": "^2.0.0-beta.1",
-    "@h3ravel/core": "^1.4.0",
-    "@h3ravel/support": "^0.8.0",
-    "@h3ravel/shared": "^0.16.0",
-    "@h3ravel/http": "^8.0.0"
+    "@h3ravel/http": "^8.0.4",
+    "@h3ravel/core": "^1.4.2",
+    "@h3ravel/support": "^0.8.2",
+    "@h3ravel/shared": "^0.16.4"
   },
   "scripts": {
     "barrel": "barrelsby --directory src --delete --singleQuotes",

package/CHANGELOG.md

@@ -1,274 +0,0 @@
-# @h3ravel/router
-
-## 1.7.0
-
-### Minor Changes
-
-- 79f4045: feat: add add exports to package.json
-
-### Patch Changes
-
-- Updated dependencies [79f4045]
-  - @h3ravel/support@0.8.0
-  - @h3ravel/shared@0.16.0
-  - @h3ravel/core@1.4.0
-  - @h3ravel/http@8.0.0
-
-## 1.6.0
-
-### Minor Changes
-
-- feat: implement full IoC container resolution
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/core@1.3.0
-  - @h3ravel/shared@0.15.4
-  - @h3ravel/http@7.0.0
-
-## 1.5.4
-
-### Patch Changes
-
-- feat: add homepage and repository to all packages.
-- Updated dependencies
-  - @h3ravel/core@1.2.2
-  - @h3ravel/http@6.0.2
-  - @h3ravel/shared@0.15.2
-  - @h3ravel/support@0.7.5
-
-## 1.5.3
-
-### Patch Changes
-
-- chore: update readme accros all packages
-- Updated dependencies
-  - @h3ravel/core@1.2.1
-  - @h3ravel/http@6.0.1
-  - @h3ravel/shared@0.15.1
-  - @h3ravel/support@0.7.4
-
-## 1.5.2
-
-### Patch Changes
-
-- Updated dependencies [d07ff49]
-  - @h3ravel/shared@0.15.0
-  - @h3ravel/core@1.2.0
-  - @h3ravel/http@6.0.0
-  - @h3ravel/support@0.7.3
-
-## 1.5.1
-
-### Patch Changes
-
-- chore: require the latest dependencies from the framework
-- Updated dependencies
-  - @h3ravel/support@0.7.3
-  - @h3ravel/core@1.1.2
-  - @h3ravel/http@5.0.2
-
-## 1.5.0
-
-### Minor Changes
-
-- feat: add app to HttpContext interface
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.14.0
-  - @h3ravel/core@1.1.1
-  - @h3ravel/http@5.0.1
-  - @h3ravel/support@0.7.2
-
-## 1.4.3
-
-### Patch Changes
-
-- Updated dependencies [6e249fe]
-  - @h3ravel/shared@0.13.0
-  - @h3ravel/core@1.1.0
-  - @h3ravel/http@5.0.0
-  - @h3ravel/support@0.7.2
-
-## 1.4.2
-
-### Patch Changes
-
-- chore: regularize all interfaces.
-- Updated dependencies
-  - @h3ravel/core@1.0.9
-  - @h3ravel/http@4.2.2
-  - @h3ravel/shared@0.12.1
-  - @h3ravel/support@0.7.2
-
-## 1.4.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/http@4.2.1
-
-## 1.4.0
-
-### Minor Changes
-
-- feat: add the current app instance to the Request and Response object
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.12.0
-  - @h3ravel/http@4.2.0
-  - @h3ravel/core@1.0.8
-  - @h3ravel/support@0.7.1
-
-## 1.3.0
-
-### Minor Changes
-
-- remove 'name' from RouterEnd and only join in apiResource.
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.11.0
-  - @h3ravel/core@1.0.7
-  - @h3ravel/http@4.1.3
-  - @h3ravel/support@0.7.1
-
-## 1.2.0
-
-### Minor Changes
-
-- feat: hide RouterEnd from itslelf to prevent unintentional chaining.
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.10.0
-  - @h3ravel/core@1.0.6
-  - @h3ravel/http@4.1.2
-  - @h3ravel/support@0.7.1
-
-## 1.1.0
-
-### Minor Changes
-
-- refactor!: make route definition more similar to the way it is handled in laravel.
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/shared@0.9.0
-  - @h3ravel/core@1.0.5
-  - @h3ravel/http@4.1.1
-  - @h3ravel/support@0.7.1
-
-## 1.0.4
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/http@4.1.0
-  - @h3ravel/shared@0.8.0
-  - @h3ravel/core@1.0.4
-  - @h3ravel/support@0.7.1
-
-## 1.0.3
-
-### Patch Changes
-
-- chore: add download count to readme
-- Updated dependencies
-  - @h3ravel/core@1.0.3
-  - @h3ravel/http@4.0.3
-  - @h3ravel/shared@0.7.1
-  - @h3ravel/support@0.7.1
-
-## 1.0.2
-
-### Patch Changes
-
-- Updated dependencies [b0d1b7c]
-- Updated dependencies [ce51a92]
-  - @h3ravel/support@0.7.0
-  - @h3ravel/shared@0.7.0
-  - @h3ravel/http@4.0.2
-  - @h3ravel/core@1.0.2
-
-## 1.0.0
-
-### Major Changes
-
-- b40caeb: feat: make service providers sortable and unique while only loading the core providers by default.
-  Service providers are no longer loaded by default, asides the ones provided by @h3ravel/core
-  Service provides are sorted by an optional order and priority property.
-
-### Patch Changes
-
-- Updated dependencies [b40caeb]
-  - @h3ravel/core@1.0.0
-  - @h3ravel/http@4.0.0
-  - @h3ravel/shared@0.6.0
-  - @h3ravel/support@0.6.0
-
-## 0.5.0
-
-### Minor Changes
-
-- rebuild all dependencies
-
-### Patch Changes
-
-- Updated dependencies
-  - @h3ravel/core@0.5.0
-  - @h3ravel/http@3.0.0
-  - @h3ravel/shared@0.5.0
-  - @h3ravel/support@0.5.0
-
-## 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
-
-- 3ff97bf: refactor: add a shared package to be extended by others to avoid cyclic dependency issues.
-
-### Patch Changes
-
-- Updated dependencies [3ff97bf]
-  - @h3ravel/core@0.3.0
-  - @h3ravel/http@1.0.0
-  - @h3ravel/shared@0.3.0
-  - @h3ravel/support@0.3.0
-
-## 0.2.0
-
-### Minor Changes
-
-- aea734f: Fix all known bugs and improved interdependecy between packages.
-
-### Patch Changes
-
-- Updated dependencies [aea734f]
-  - @h3ravel/core@0.2.0
-  - @h3ravel/support@0.2.0

package/src/Controller.ts

@@ -1 +0,0 @@
-export default class { }

package/src/Providers/AssetsServiceProvider.ts

@@ -1,55 +0,0 @@
-import { readFile, stat } from 'node:fs/promises'
-
-import { ServiceProvider } from '@h3ravel/core'
-import { before } from '@h3ravel/support'
-import { join } from 'node:path'
-import { serveStatic } from 'h3'
-import { statSync } from 'node:fs'
-
-/**
- * Handles public assets loading
- * 
- * Auto-Registered
- */
-export class AssetsServiceProvider extends ServiceProvider {
-    public static priority = 996;
-
-    register () {
-        const app = this.app.make('router')
-        const config = this.app.make('config')
-        const fsconfig = config.get('filesystem')
-        const publicPath = this.app.getPath('public')
-
-        app.middleware(`/${fsconfig.public_mask}/**`, (event) => {
-            return serveStatic(event, {
-                indexNames: ['/index.html'],
-                getContents: (id) => {
-                    const newId = id.replace(`/${fsconfig.public_mask}/`, '')
-                    return <never>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(() => { })
-                    if (stats?.isFile()) {
-                        return {
-                            size: stats.size,
-                            mtime: stats.mtimeMs,
-                        }
-                    }
-                },
-            })
-        })
-
-        this.app.singleton('asset', () => {
-            return (key: string, def = '') => {
-                try {
-                    statSync(join(before(publicPath, key), key))
-                } catch {
-                    key = def
-                }
-
-                return join(fsconfig.public_mask, key)
-            }
-        })
-    }
-}

package/src/Providers/RouteServiceProvider.ts

@@ -1,48 +0,0 @@
-import { Router } from '../Route'
-import { ServiceProvider } from '@h3ravel/core'
-import path from 'node:path'
-import { readdir } from 'node:fs/promises'
-
-/**
- * Handles routing registration
- * 
- * Load route files (web.ts, api.ts).
- * Map controllers to routes.
- * Register route-related middleware.
- * 
- * Auto-Registered
- */
-export class RouteServiceProvider extends ServiceProvider {
-    public static priority = 997;
-
-    register () {
-        this.app.singleton('router', () => {
-            const h3App = this.app.make('http.app')
-            return new Router(h3App, this.app)
-        })
-    }
-
-    /**
-     * Load routes from src/routes
-     */
-    async boot () {
-        try {
-            const routePath = this.app.getPath('routes')
-
-            const files = (await readdir(routePath)).filter((e) => {
-                return !e.includes('.d.ts') && !e.includes('.map')
-            })
-
-            for (let i = 0; i < files.length; i++) {
-                const routesModule = await import(path.join(routePath, files[i]))
-
-                if (typeof routesModule.default === 'function') {
-                    const router = this.app.make('router')
-                    routesModule.default(router)
-                }
-            }
-        } catch (e) {
-            console.warn('No web routes found or failed to load:', e)
-        }
-    }
-}

package/src/Route.ts

@@ -1,250 +0,0 @@
-import { H3Event, Middleware, MiddlewareOptions, type H3 } from 'h3'
-import { Request, Response } from '@h3ravel/http'
-import { Application, Container, Controller, Kernel } from '@h3ravel/core'
-import { afterLast } from '@h3ravel/support'
-import type { EventHandler, IController, IMiddleware, IRouter, RouterEnd } from '@h3ravel/shared'
-
-interface RouteDefinition {
-    method: string
-    path: string
-    name?: string
-    handler: EventHandler
-}
-
-export class Router implements IRouter {
-    private routes: RouteDefinition[] = []
-    private nameMap: string[] = []
-    private groupPrefix = ''
-    private middlewareMap: IMiddleware[] = []
-    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(() => ({
-                app: this.app,
-                request: new Request(event, this.app),
-                response: new Response(event, this.app)
-            }), 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[] = []
-    ) {
-        /**
-         * Join all defined route names to make a single route name
-         */
-        if (this.nameMap.length > 0) {
-            name = this.nameMap.join('.')
-        }
-
-        /**
-         * Join all defined middlewares
-         */
-        if (this.middlewareMap.length > 0) {
-            middleware = this.middlewareMap
-        }
-
-        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) => {
-                let controller: IController
-
-                if (Container.hasAnyDecorator(handler)) {
-                    /**
-                     * If the controller is decorated use the IoC container
-                     */
-                    controller = this.app.make<any, IController>(handler as any)
-                } else {
-                    /**
-                     * Otherwise instantiate manually so that we can at least
-                     * pass the app instance
-                     */
-                    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,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware: IMiddleware[] = []
-    ): Omit<this, RouterEnd> {
-        const handler = Array.isArray(definition) ? definition[0] : definition
-        const methodName = Array.isArray(definition) ? definition[1] : undefined
-        this.addRoute('get', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-        return this
-    }
-
-    post (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware: IMiddleware[] = []
-    ): Omit<this, RouterEnd> {
-        const handler = Array.isArray(definition) ? definition[0] : definition
-        const methodName = Array.isArray(definition) ? definition[1] : undefined
-        this.addRoute('post', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-        return this
-    }
-
-    put (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware: IMiddleware[] = []
-    ): Omit<this, RouterEnd> {
-        const handler = Array.isArray(definition) ? definition[0] : definition
-        const methodName = Array.isArray(definition) ? definition[1] : undefined
-        this.addRoute('put', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-        return this
-    }
-
-    delete (
-        path: string,
-        definition: EventHandler | [(new (...args: any[]) => IController), methodName: string],
-        name?: string,
-        middleware: IMiddleware[] = []
-    ): Omit<this, RouterEnd> {
-        const handler = Array.isArray(definition) ? definition[0] : definition
-        const methodName = Array.isArray(definition) ? definition[1] : undefined
-        this.addRoute('delete', path, this.resolveControllerOrHandler(handler, methodName), name, middleware)
-        return this
-    }
-
-    /**
-     * API Resource support  
-     * 
-     * @param path 
-     * @param controller 
-     */
-    apiResource (
-        path: string,
-        Controller: new (app: Application) => IController,
-        middleware: IMiddleware[] = []
-    ): Omit<this, RouterEnd | 'name'> {
-        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)
-        return this
-    }
-
-    /**
-     * 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
-        return this
-    }
-
-    /**
-     * Set the name of the current route
-     * 
-     * @param name 
-     */
-    name (name: string) {
-        this.nameMap.push(name)
-        return this
-    }
-
-    /**
-     * Registers middleware for a specific path.
-     * @param path - The path to apply the middleware.
-     * @param handler - The middleware handler.
-     * @param opts - Optional middleware options.
-     */
-    middleware (path: string | IMiddleware[], handler: Middleware, opts?: MiddlewareOptions) {
-        if (typeof path === 'string') {
-            this.h3App.use(path, handler, opts)
-        } else {
-            this.middlewareMap.concat(path)
-        }
-        return this
-    }
-}

package/src/index.ts

@@ -1,8 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from './Controller';
-export * from './Route';
-export * from './Providers/AssetsServiceProvider';
-export * from './Providers/RouteServiceProvider';

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../shared/tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src"],
-  "exclude": ["dist", "node_modules"]
-}