@valkyrjaio/valkyrja 26.0.0

package/src/Valkyrja/Http/Middleware/Handler/Abstract/Handler.ts

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Container } from '../../../../Container/Manager/Container.js';
+
+import type { ContainerContract } from '../../../../Container/Manager/Contract/ContainerContract.js';
+import type { AnyMiddleware, HandlerContract } from '../Contract/HandlerContract.js';
+
+export abstract class Handler<Middleware extends AnyMiddleware = AnyMiddleware> implements HandlerContract<Middleware> {
+    protected middleware: Array<new (...args: unknown[]) => Middleware>;
+    protected next: (new (...args: unknown[]) => Middleware) | null;
+    protected index: number;
+
+    constructor(
+        protected container: ContainerContract = new Container(),
+        ...middleware: Array<new (...args: unknown[]) => Middleware>
+    ) {
+        this.middleware = middleware;
+        this.index = 0;
+        this.next = null;
+
+        this.updateNext();
+    }
+
+    add(...middleware: Array<new (...args: unknown[]) => Middleware>): void {
+        this.middleware = [...this.middleware, ...middleware];
+
+        this.updateNext();
+    }
+
+    protected getMiddleware(middleware: new (...args: unknown[]) => Middleware): Middleware {
+        const item = this.container.get<Middleware>(middleware.name);
+
+        this.index++;
+
+        this.updateNext();
+
+        return item;
+    }
+
+    protected updateNext(): void {
+        this.next = this.middleware[this.index] ?? null;
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/HandlerContract.ts

@@ -0,0 +1,29 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { RequestReceivedMiddlewareContract } from '../../Contract/RequestReceivedMiddlewareContract.js';
+import type { RouteDispatchedMiddlewareContract } from '../../Contract/RouteDispatchedMiddlewareContract.js';
+import type { RouteMatchedMiddlewareContract } from '../../Contract/RouteMatchedMiddlewareContract.js';
+import type { RouteNotMatchedMiddlewareContract } from '../../Contract/RouteNotMatchedMiddlewareContract.js';
+import type { SendingResponseMiddlewareContract } from '../../Contract/SendingResponseMiddlewareContract.js';
+import type { TerminatedMiddlewareContract } from '../../Contract/TerminatedMiddlewareContract.js';
+import type { ThrowableCaughtMiddlewareContract } from '../../Contract/ThrowableCaughtMiddlewareContract.js';
+
+export type AnyMiddleware =
+    | RequestReceivedMiddlewareContract
+    | SendingResponseMiddlewareContract
+    | RouteMatchedMiddlewareContract
+    | RouteNotMatchedMiddlewareContract
+    | RouteDispatchedMiddlewareContract
+    | ThrowableCaughtMiddlewareContract
+    | TerminatedMiddlewareContract;
+
+export interface HandlerContract<Middleware extends AnyMiddleware = AnyMiddleware> {
+    add(...middleware: Array<new (...args: unknown[]) => Middleware>): void;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/RequestReceivedHandlerContract.ts

@@ -0,0 +1,17 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { RequestReceivedMiddlewareContract } from '../../Contract/RequestReceivedMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface RequestReceivedHandlerContract extends HandlerContract<RequestReceivedMiddlewareContract> {
+    requestReceived(request: ServerRequestContract): ResponseContract | ServerRequestContract;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/RouteDispatchedHandlerContract.ts

@@ -0,0 +1,18 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { RouteContract } from '../../../Routing/Data/Contract/RouteContract.js';
+import type { RouteDispatchedMiddlewareContract } from '../../Contract/RouteDispatchedMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface RouteDispatchedHandlerContract extends HandlerContract<RouteDispatchedMiddlewareContract> {
+    routeDispatched(request: ServerRequestContract, response: ResponseContract, route: RouteContract): ResponseContract;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/RouteMatchedHandlerContract.ts

@@ -0,0 +1,18 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { RouteContract } from '../../../Routing/Data/Contract/RouteContract.js';
+import type { RouteMatchedMiddlewareContract } from '../../Contract/RouteMatchedMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface RouteMatchedHandlerContract extends HandlerContract<RouteMatchedMiddlewareContract> {
+    routeMatched(request: ServerRequestContract, route: RouteContract): RouteContract | ResponseContract;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/RouteNotMatchedHandlerContract.ts

@@ -0,0 +1,17 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { RouteNotMatchedMiddlewareContract } from '../../Contract/RouteNotMatchedMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface RouteNotMatchedHandlerContract extends HandlerContract<RouteNotMatchedMiddlewareContract> {
+    routeNotMatched(request: ServerRequestContract, response: ResponseContract): ResponseContract;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/SendingResponseHandlerContract.ts

@@ -0,0 +1,17 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { SendingResponseMiddlewareContract } from '../../Contract/SendingResponseMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface SendingResponseHandlerContract extends HandlerContract<SendingResponseMiddlewareContract> {
+    sendingResponse(request: ServerRequestContract, response: ResponseContract): ResponseContract;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/TerminatedHandlerContract.ts

@@ -0,0 +1,17 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { TerminatedMiddlewareContract } from '../../Contract/TerminatedMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface TerminatedHandlerContract extends HandlerContract<TerminatedMiddlewareContract> {
+    terminated(request: ServerRequestContract, response: ResponseContract): void;
+}

package/src/Valkyrja/Http/Middleware/Handler/Contract/ThrowableCaughtHandlerContract.ts

@@ -0,0 +1,17 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../../Message/Response/Contract/ResponseContract.js';
+import type { ThrowableCaughtMiddlewareContract } from '../../Contract/ThrowableCaughtMiddlewareContract.js';
+import type { HandlerContract } from './HandlerContract.js';
+
+export interface ThrowableCaughtHandlerContract extends HandlerContract<ThrowableCaughtMiddlewareContract> {
+    throwableCaught(request: ServerRequestContract, response: ResponseContract, throwable: Error): ResponseContract;
+}

package/src/Valkyrja/Http/Middleware/Handler/RequestReceivedHandler.ts

@@ -0,0 +1,25 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { RequestReceivedMiddlewareContract } from '../Contract/RequestReceivedMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { RequestReceivedHandlerContract } from './Contract/RequestReceivedHandlerContract.js';
+
+export class RequestReceivedHandler
+    extends Handler<RequestReceivedMiddlewareContract>
+    implements RequestReceivedHandlerContract
+{
+    requestReceived(request: ServerRequestContract): ResponseContract | ServerRequestContract {
+        const next = this.next;
+
+        return next !== null ? this.getMiddleware(next).requestReceived(request, this) : request;
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/RouteDispatchedHandler.ts

@@ -0,0 +1,30 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { RouteContract } from '../../Routing/Data/Contract/RouteContract.js';
+import type { RouteDispatchedMiddlewareContract } from '../Contract/RouteDispatchedMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { RouteDispatchedHandlerContract } from './Contract/RouteDispatchedHandlerContract.js';
+
+export class RouteDispatchedHandler
+    extends Handler<RouteDispatchedMiddlewareContract>
+    implements RouteDispatchedHandlerContract
+{
+    routeDispatched(
+        request: ServerRequestContract,
+        response: ResponseContract,
+        route: RouteContract,
+    ): ResponseContract {
+        const next = this.next;
+
+        return next !== null ? this.getMiddleware(next).routeDispatched(request, response, route, this) : response;
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/RouteMatchedHandler.ts

@@ -0,0 +1,26 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { RouteContract } from '../../Routing/Data/Contract/RouteContract.js';
+import type { RouteMatchedMiddlewareContract } from '../Contract/RouteMatchedMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { RouteMatchedHandlerContract } from './Contract/RouteMatchedHandlerContract.js';
+
+export class RouteMatchedHandler
+    extends Handler<RouteMatchedMiddlewareContract>
+    implements RouteMatchedHandlerContract
+{
+    routeMatched(request: ServerRequestContract, route: RouteContract): RouteContract | ResponseContract {
+        const next = this.next;
+
+        return next !== null ? this.getMiddleware(next).routeMatched(request, route, this) : route;
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/RouteNotMatchedHandler.ts

@@ -0,0 +1,25 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { RouteNotMatchedMiddlewareContract } from '../Contract/RouteNotMatchedMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { RouteNotMatchedHandlerContract } from './Contract/RouteNotMatchedHandlerContract.js';
+
+export class RouteNotMatchedHandler
+    extends Handler<RouteNotMatchedMiddlewareContract>
+    implements RouteNotMatchedHandlerContract
+{
+    routeNotMatched(request: ServerRequestContract, response: ResponseContract): ResponseContract {
+        const next = this.next;
+
+        return next !== null ? this.getMiddleware(next).routeNotMatched(request, response, this) : response;
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/SendingResponseHandler.ts

@@ -0,0 +1,25 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { SendingResponseMiddlewareContract } from '../Contract/SendingResponseMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { SendingResponseHandlerContract } from './Contract/SendingResponseHandlerContract.js';
+
+export class SendingResponseHandler
+    extends Handler<SendingResponseMiddlewareContract>
+    implements SendingResponseHandlerContract
+{
+    sendingResponse(request: ServerRequestContract, response: ResponseContract): ResponseContract {
+        const next = this.next;
+
+        return next !== null ? this.getMiddleware(next).sendingResponse(request, response, this) : response;
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/TerminatedHandler.ts

@@ -0,0 +1,24 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { TerminatedMiddlewareContract } from '../Contract/TerminatedMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { TerminatedHandlerContract } from './Contract/TerminatedHandlerContract.js';
+
+export class TerminatedHandler extends Handler<TerminatedMiddlewareContract> implements TerminatedHandlerContract {
+    terminated(request: ServerRequestContract, response: ResponseContract): void {
+        const next = this.next;
+
+        if (next !== null) {
+            this.getMiddleware(next).terminated(request, response, this);
+        }
+    }
+}

package/src/Valkyrja/Http/Middleware/Handler/ThrowableCaughtHandler.ts

@@ -0,0 +1,25 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ServerRequestContract } from '../../Message/Request/Contract/ServerRequestContract.js';
+import type { ResponseContract } from '../../Message/Response/Contract/ResponseContract.js';
+import type { ThrowableCaughtMiddlewareContract } from '../Contract/ThrowableCaughtMiddlewareContract.js';
+import { Handler } from './Abstract/Handler.js';
+import type { ThrowableCaughtHandlerContract } from './Contract/ThrowableCaughtHandlerContract.js';
+
+export class ThrowableCaughtHandler
+    extends Handler<ThrowableCaughtMiddlewareContract>
+    implements ThrowableCaughtHandlerContract
+{
+    throwableCaught(request: ServerRequestContract, response: ResponseContract, throwable: Error): ResponseContract {
+        const next = this.next;
+
+        return next !== null ? this.getMiddleware(next).throwableCaught(request, response, throwable, this) : response;
+    }
+}

package/src/Valkyrja/Http/Middleware/Throwable/Contract/HttpMiddlewareThrowable.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { HttpThrowable } from '../../../Throwable/Contract/HttpThrowable.js';
+
+export type HttpMiddlewareThrowable = HttpThrowable;

package/src/Valkyrja/Http/Middleware/Throwable/Exception/Abstract/HttpMiddlewareInvalidArgumentException.ts

@@ -0,0 +1,16 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { HttpInvalidArgumentException } from '../../../../Throwable/Exception/Abstract/HttpInvalidArgumentException.js';
+
+import type { HttpMiddlewareThrowable } from '../../Contract/HttpMiddlewareThrowable.js';
+
+export abstract class HttpMiddlewareInvalidArgumentException
+    extends HttpInvalidArgumentException
+    implements HttpMiddlewareThrowable {}

package/src/Valkyrja/Http/Middleware/Throwable/Exception/Abstract/HttpMiddlewareRuntimeException.ts

@@ -0,0 +1,14 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { HttpRuntimeException } from '../../../../Throwable/Exception/Abstract/HttpRuntimeException.js';
+
+import type { HttpMiddlewareThrowable } from '../../Contract/HttpMiddlewareThrowable.js';
+
+export abstract class HttpMiddlewareRuntimeException extends HttpRuntimeException implements HttpMiddlewareThrowable {}

package/src/Valkyrja/Http/Routing/Cli/Command/Constant/CommandName.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export class HttpCommandName {
+    static readonly LIST = 'http:list' as const;
+}

package/src/Valkyrja/Http/Routing/Cli/Command/ListCommand.ts

@@ -0,0 +1,95 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { ExitCode } from '../../../../Cli/Interaction/Enum/ExitCode.js';
+import { TextColor } from '../../../../Cli/Interaction/Enum/TextColor.js';
+import { TextColorFormat } from '../../../../Cli/Interaction/Format/TextColorFormat.js';
+import { Formatter } from '../../../../Cli/Interaction/Formatter/Formatter.js';
+import { HighlightedTextFormatter } from '../../../../Cli/Interaction/Formatter/HighlightedTextFormatter.js';
+import { Banner } from '../../../../Cli/Interaction/Message/Banner.js';
+import { ErrorMessage } from '../../../../Cli/Interaction/Message/ErrorMessage.js';
+import { Header } from '../../../../Cli/Interaction/Message/Header.js';
+import { Message } from '../../../../Cli/Interaction/Message/Message.js';
+import { NewLine } from '../../../../Cli/Interaction/Message/NewLine.js';
+import { RequestMethod } from '../../../Message/Enum/RequestMethod.js';
+
+import type { CliConfigContract } from '../../../../Application/Data/Contract/CliConfigContract.js';
+import type { MessageContract } from '../../../../Cli/Interaction/Message/Contract/MessageContract.js';
+import type { OutputContract } from '../../../../Cli/Interaction/Output/Contract/OutputContract.js';
+import type { OutputFactoryContract } from '../../../../Cli/Interaction/Output/Factory/Contract/OutputFactoryContract.js';
+import type { RouteContract as CliRouteContract } from '../../../../Cli/Routing/Data/Contract/RouteContract.js';
+import type { DynamicRouteContract } from '../../Data/Contract/DynamicRouteContract.js';
+import type { RouteContract } from '../../Data/Contract/RouteContract.js';
+import type { RouteCollectionContract } from '../../Collection/Contract/RouteCollectionContract.js';
+
+export class ListCommand {
+    constructor(
+        protected config: CliConfigContract,
+        protected cliRoute: CliRouteContract,
+        protected collection: RouteCollectionContract,
+        protected outputFactory: OutputFactoryContract,
+    ) {}
+
+    static help(): MessageContract {
+        return new Message('A command to list all the routes present within the Http component.');
+    }
+
+    run(): OutputContract {
+        const routes = Object.values(this.collection.getAll(RequestMethod.ANY));
+
+        if (routes.length === 0) {
+            return this.outputFactory
+                .createOutput()
+                .withExitCode(ExitCode.ERROR)
+                .withAddedMessages(new Banner(new ErrorMessage('No routes were found')));
+        }
+
+        routes.sort((a, b) => a.getPath().localeCompare(b.getPath()));
+
+        let output = this.outputFactory
+            .createOutput()
+            .withMessages(new Header(this.config.namespace, this.config.version, this.cliRoute))
+            .withAddedMessages(new NewLine(), new Message('Routes:', new HighlightedTextFormatter()), new NewLine());
+
+        for (const route of routes) {
+            output = output.withAddedMessages(
+                new Message('  '),
+                new Message(route.getPath(), new Formatter(new TextColorFormat(TextColor.MAGENTA))),
+                new NewLine(),
+                new Message('    - '),
+                new Message('Name: '),
+                new Message(route.getName(), new HighlightedTextFormatter()),
+                new NewLine(),
+            );
+
+            output = this.addDynamicRouteMessages(output, route);
+        }
+
+        return output.withAddedMessages(new NewLine());
+    }
+
+    protected addDynamicRouteMessages(output: OutputContract, route: RouteContract): OutputContract {
+        if (!('getRegex' in route)) {
+            return output;
+        }
+
+        const regex = (route as DynamicRouteContract).getRegex();
+
+        if (regex === '') {
+            return output;
+        }
+
+        return output.withAddedMessages(
+            new Message('    - '),
+            new Message('Regex: '),
+            new Message(regex, new HighlightedTextFormatter()),
+            new NewLine(),
+        );
+    }
+}

package/src/Valkyrja/Http/Routing/Collection/Contract/RouteCollectionContract.ts

@@ -0,0 +1,28 @@
+/*
+ * This file is part of the Valkyrja package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { RequestMethod } from '../../../Message/Enum/RequestMethod.js';
+import type { DynamicRouteContract } from '../../Data/Contract/DynamicRouteContract.js';
+import type { RouteContract } from '../../Data/Contract/RouteContract.js';
+import type { HttpRoutingData } from '../../Data/HttpRoutingData.js';
+
+export interface RouteCollectionContract {
+    getData(): HttpRoutingData;
+    setFromData(data: HttpRoutingData): void;
+    add(route: RouteContract): void;
+    hasPath(path: string, method: RequestMethod): boolean;
+    getByPath(path: string, method: RequestMethod): RouteContract;
+    hasRegex(regex: string, method: RequestMethod): boolean;
+    getByRegex(regex: string, method: RequestMethod): DynamicRouteContract;
+    getPaths(method: RequestMethod): Record<string, string>;
+    getRegexes(method: RequestMethod): Record<string, string>;
+    hasName(name: string): boolean;
+    getByName(name: string): RouteContract;
+    getAll(method: RequestMethod): Record<string, RouteContract>;
+}