@valkyrjaio/valkyrja 26.0.0

package/src/Valkyrja/Cli/Interaction/Output/Output.ts

@@ -0,0 +1,163 @@
+/*
+ * 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 { MessageContract } from '../Message/Contract/MessageContract.js';
+import type { OutputContract } from './Contract/OutputContract.js';
+import type { WriterContract } from '../Writer/Contract/WriterContract.js';
+import { ExitCode } from '../Enum/ExitCode.js';
+import { QuestionWriter } from '../Writer/QuestionWriter.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Output implements OutputContract {
+    protected unwrittenMessages: MessageContract[] = [];
+    protected writtenMessages: MessageContract[] = [];
+    protected writers: WriterContract[] = [];
+
+    constructor(
+        protected interactive: boolean = true,
+        protected quiet: boolean = false,
+        protected silent: boolean = false,
+        protected exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ) {
+        this.unwrittenMessages = messages;
+        this.writers = [new QuestionWriter()];
+    }
+
+    getMessages(): MessageContract[] {
+        return [...this.writtenMessages, ...this.unwrittenMessages];
+    }
+
+    getWrittenMessages(): MessageContract[] {
+        return this.writtenMessages;
+    }
+
+    hasWrittenMessage(): boolean {
+        return this.writtenMessages.length > 0;
+    }
+
+    getUnwrittenMessages(): MessageContract[] {
+        return this.unwrittenMessages;
+    }
+
+    hasUnwrittenMessage(): boolean {
+        return this.unwrittenMessages.length > 0;
+    }
+
+    withMessages(...messages: MessageContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.unwrittenMessages = messages;
+        return clone;
+    }
+
+    withAddedMessages(...messages: MessageContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.unwrittenMessages = [...this.unwrittenMessages, ...messages];
+        return clone;
+    }
+
+    withAddedMessage(message: MessageContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.unwrittenMessages = [...this.unwrittenMessages, message];
+        return clone;
+    }
+
+    writeMessages(): this {
+        let clone = ObjectFactory.clone(this);
+        const unwrittenMessages = this.unwrittenMessages;
+        clone.unwrittenMessages = [];
+
+        for (const message of unwrittenMessages) {
+            clone = clone.writeMessageViaWriter(message);
+        }
+
+        return clone;
+    }
+
+    writeMessage(message: MessageContract): this {
+        this.setMessageAsWritten(message);
+
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        if (this.silent || (this.quiet && this.exitCode === ExitCode.SUCCESS)) {
+            return this;
+        }
+
+        this.outputMessage(message);
+
+        return this;
+    }
+
+    getWriters(): WriterContract[] {
+        return this.writers;
+    }
+
+    withWriters(...writers: WriterContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.writers = writers;
+        return clone;
+    }
+
+    isInteractive(): boolean {
+        return this.interactive;
+    }
+
+    withIsInteractive(isInteractive: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.interactive = isInteractive;
+        return clone;
+    }
+
+    isQuiet(): boolean {
+        return this.quiet;
+    }
+
+    withIsQuiet(isQuiet: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.quiet = isQuiet;
+        return clone;
+    }
+
+    isSilent(): boolean {
+        return this.silent;
+    }
+
+    withIsSilent(isSilent: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.silent = isSilent;
+        return clone;
+    }
+
+    getExitCode(): ExitCode | number {
+        return this.exitCode;
+    }
+
+    withExitCode(exitCode: ExitCode | number): this {
+        const clone = ObjectFactory.clone(this);
+        clone.exitCode = exitCode;
+        return clone;
+    }
+
+    protected writeMessageViaWriter(message: MessageContract): this {
+        for (const writer of this.writers) {
+            if (writer.shouldWriteMessage(message)) {
+                return writer.write(this, message) as this;
+            }
+        }
+
+        return this.writeMessage(message);
+    }
+
+    protected setMessageAsWritten(message: MessageContract): void {
+        this.writtenMessages.push(message);
+    }
+
+    protected outputMessage(message: MessageContract): void {
+        process.stdout.write(message.getFormattedText());
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/PlainOutput.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 { MessageContract } from '../Message/Contract/MessageContract.js';
+import type { PlainOutputContract } from './Contract/PlainOutputContract.js';
+import { Output } from './Output.js';
+
+export class PlainOutput extends Output implements PlainOutputContract {
+    protected override outputMessage(message: MessageContract): void {
+        process.stdout.write(message.getText().replace(/<[^>]*>/g, ''));
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/StreamOutput.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 { MessageContract } from '../Message/Contract/MessageContract.js';
+import type { StreamOutputContract } from './Contract/StreamOutputContract.js';
+import { ExitCode } from '../Enum/ExitCode.js';
+import { Output } from './Output.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class StreamOutput extends Output implements StreamOutputContract {
+    constructor(
+        protected stream: NodeJS.WritableStream,
+        interactive: boolean = true,
+        quiet: boolean = false,
+        silent: boolean = false,
+        exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ) {
+        super(interactive, quiet, silent, exitCode, ...messages);
+    }
+
+    getStream(): NodeJS.WritableStream {
+        return this.stream;
+    }
+
+    withStream(stream: NodeJS.WritableStream): this {
+        const clone = ObjectFactory.clone(this);
+        clone.stream = stream;
+        return clone;
+    }
+
+    protected override outputMessage(_message: MessageContract): void {
+        // TODO: Implement
+    }
+}

package/src/Valkyrja/Cli/Interaction/Provider/CliInteractionComponentProvider.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 { CliInteractionServiceProvider } from './CliInteractionServiceProvider.js';
+
+import type { ApplicationContract } from '../../../Application/Kernel/Contract/ApplicationContract.js';
+import type { ComponentProviderContract } from '../../../Application/Provider/Contract/ComponentProviderContract.js';
+import type { ServiceProviderContract } from '../../../Container/Provider/Contract/ServiceProviderContract.js';
+import type { CliRouteProviderContract } from '../../Routing/Provider/Contract/CliRouteProviderContract.js';
+import type { ListenerProviderContract } from '../../../Event/Provider/Contract/ListenerProviderContract.js';
+import type { HttpRouteProviderContract } from '../../../Http/Routing/Provider/Contract/HttpRouteProviderContract.js';
+
+export class CliInteractionComponentProvider implements ComponentProviderContract {
+    getComponentProviders(_app: ApplicationContract): ComponentProviderContract[] {
+        return [];
+    }
+
+    getContainerProviders(_app: ApplicationContract): ServiceProviderContract[] {
+        return [new CliInteractionServiceProvider()];
+    }
+
+    getEventProviders(_app: ApplicationContract): ListenerProviderContract[] {
+        return [];
+    }
+
+    getCliProviders(_app: ApplicationContract): CliRouteProviderContract[] {
+        return [];
+    }
+
+    getHttpProviders(_app: ApplicationContract): HttpRouteProviderContract[] {
+        return [];
+    }
+}

package/src/Valkyrja/Cli/Interaction/Provider/CliInteractionServiceProvider.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 { ApplicationServiceId } from '../../../Application/Constant/ApplicationServiceId.js';
+import { CliInteractionServiceId } from '../Constant/CliInteractionServiceId.js';
+import { CliInteractionConfig } from '../Data/CliInteractionConfig.js';
+import { OutputFactory } from '../Output/Factory/OutputFactory.js';
+
+import { CliInteractionConfigContract } from '../Data/Contract/CliInteractionConfigContract.js';
+import type { ConfigContract } from '../../../Application/Data/Contract/ConfigContract.js';
+import type { ContainerContract } from '../../../Container/Manager/Contract/ContainerContract.js';
+import type { ServiceProviderContract } from '../../../Container/Provider/Contract/ServiceProviderContract.js';
+
+export class CliInteractionServiceProvider implements ServiceProviderContract {
+    publishers(): Record<string, (container: ContainerContract) => void> {
+        return {
+            [CliInteractionServiceId.CliInteractionConfigContract]: CliInteractionServiceProvider.publishConfig,
+            [CliInteractionServiceId.OutputFactoryContract]: CliInteractionServiceProvider.publishOutputFactory,
+        };
+    }
+
+    static publishConfig(this: void, container: ContainerContract): void {
+        const config = container.getSingleton<ConfigContract>(ApplicationServiceId.ConfigContract);
+
+        if (CliInteractionConfigContract.instanceOf(config)) {
+            container.setSingleton(CliInteractionServiceId.CliInteractionConfigContract, config);
+            return;
+        }
+
+        container.setSingleton(CliInteractionServiceId.CliInteractionConfigContract, new CliInteractionConfig());
+    }
+
+    static publishOutputFactory(this: void, container: ContainerContract): void {
+        const config = container.getSingleton<CliInteractionConfigContract>(
+            CliInteractionServiceId.CliInteractionConfigContract,
+        );
+
+        container.setSingleton(CliInteractionServiceId.OutputFactoryContract, new OutputFactory(config));
+    }
+}

package/src/Valkyrja/Cli/Interaction/Throwable/Contract/CliInteractionThrowable.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 { CliThrowable } from '../../../Throwable/Contract/CliThrowable.js';
+
+export type CliInteractionThrowable = CliThrowable;

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/Abstract/CliInteractionInvalidArgumentException.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 { CliInvalidArgumentException } from '../../../../Throwable/Exception/Abstract/CliInvalidArgumentException.js';
+
+import type { CliInteractionThrowable } from '../../Contract/CliInteractionThrowable.js';
+
+export abstract class CliInteractionInvalidArgumentException
+    extends CliInvalidArgumentException
+    implements CliInteractionThrowable {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/Abstract/CliInteractionRuntimeException.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 { CliRuntimeException } from '../../../../Throwable/Exception/Abstract/CliRuntimeException.js';
+
+import type { CliInteractionThrowable } from '../../Contract/CliInteractionThrowable.js';
+
+export abstract class CliInteractionRuntimeException extends CliRuntimeException implements CliInteractionThrowable {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/CliInteractionExpectedQuestionOutputException.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 { CliInteractionInvalidArgumentException } from './Abstract/CliInteractionInvalidArgumentException.js';
+
+export class CliInteractionExpectedQuestionOutputException extends CliInteractionInvalidArgumentException {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/CliInteractionInvalidEmptyValueException.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 { CliInteractionInvalidArgumentException } from './Abstract/CliInteractionInvalidArgumentException.js';
+
+export class CliInteractionInvalidEmptyValueException extends CliInteractionInvalidArgumentException {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/CliInteractionInvalidNonEmptyValueException.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 { CliInteractionInvalidArgumentException } from './Abstract/CliInteractionInvalidArgumentException.js';
+
+export class CliInteractionInvalidNonEmptyValueException extends CliInteractionInvalidArgumentException {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/CliInteractionInvalidOptionNameException.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 { CliInteractionInvalidArgumentException } from './Abstract/CliInteractionInvalidArgumentException.js';
+
+export class CliInteractionInvalidOptionNameException extends CliInteractionInvalidArgumentException {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/CliInteractionNoFormatterException.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 { CliInteractionRuntimeException } from './Abstract/CliInteractionRuntimeException.js';
+
+export class CliInteractionNoFormatterException extends CliInteractionRuntimeException {}

package/src/Valkyrja/Cli/Interaction/Throwable/Exception/CliInteractionNoValidationCallableException.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 { CliInteractionRuntimeException } from './Abstract/CliInteractionRuntimeException.js';
+
+export class CliInteractionNoValidationCallableException extends CliInteractionRuntimeException {}

package/src/Valkyrja/Cli/Interaction/Writer/Contract/WriterContract.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { MessageContract } from '../../Message/Contract/MessageContract.js';
+import type { OutputContract } from '../../Output/Contract/OutputContract.js';
+
+export interface WriterContract {
+    shouldWriteMessage(message: MessageContract): boolean;
+    write(output: OutputContract, message: MessageContract): OutputContract;
+}
+
+export namespace WriterContract {
+    export function instanceOf(value: unknown): value is WriterContract {
+        return typeof value === 'object' && value !== null && 'write' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Writer/QuestionWriter.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 { AnswerContract } from '../Message/Contract/AnswerContract.js';
+import type { MessageContract } from '../Message/Contract/MessageContract.js';
+import type { QuestionContract } from '../Message/Contract/QuestionContract.js';
+import type { OutputContract } from '../Output/Contract/OutputContract.js';
+import type { WriterContract } from './Contract/WriterContract.js';
+import { CliInteractionExpectedQuestionOutputException } from '../Throwable/Exception/CliInteractionExpectedQuestionOutputException.js';
+import { HighlightedTextFormatter } from '../Formatter/HighlightedTextFormatter.js';
+import { Message } from '../Message/Message.js';
+import { NewLine } from '../Message/NewLine.js';
+
+export class QuestionWriter implements WriterContract {
+    shouldWriteMessage(message: MessageContract): boolean {
+        return this.isQuestion(message);
+    }
+
+    write(output: OutputContract, message: MessageContract): OutputContract {
+        if (!this.isQuestion(message)) {
+            throw new CliInteractionExpectedQuestionOutputException('This writer expects only questions');
+        }
+
+        return this.askQuestion(output, message);
+    }
+
+    protected isQuestion(message: MessageContract): message is QuestionContract {
+        return typeof (message as QuestionContract).ask === 'function';
+    }
+
+    protected askQuestion(output: OutputContract, question: QuestionContract): OutputContract {
+        output = this.writeQuestion(output, question);
+
+        let answer = question.getAnswer();
+
+        if (output.isInteractive() && !output.isQuiet() && !output.isSilent()) {
+            answer = question.ask();
+
+            if (!answer.isValidResponse()) {
+                output = this.writeAnswerAfterResponse(output, answer);
+                return this.askQuestion(output, question);
+            }
+        }
+
+        output = this.writeAnswerAfterResponse(output, answer);
+
+        const callable = question.getCallable();
+        output = callable(output, answer);
+
+        return output;
+    }
+
+    protected writeQuestion(output: OutputContract, question: QuestionContract): OutputContract {
+        output = output.writeMessage(question);
+
+        const answer = question.getAnswer();
+        const validResponses = answer.getAllowedResponses();
+
+        if (validResponses.length > 0) {
+            output = output.writeMessage(new Message(' ('));
+            output = output.writeMessage(new Message(validResponses.map((v) => `\`${v}\``).join(' or ')));
+            output = output.writeMessage(new Message(')'));
+        }
+
+        output = output.writeMessage(new Message(' [default: "'));
+        output = output.writeMessage(new Message(answer.getDefaultResponse(), new HighlightedTextFormatter()));
+        output = output.writeMessage(new Message('"]'));
+        output = output.writeMessage(new Message(':'));
+        output = output.writeMessage(new NewLine());
+        output = output.writeMessage(new Message('> '));
+
+        return output;
+    }
+
+    protected writeAnswerAfterResponse(output: OutputContract, answer: AnswerContract): OutputContract {
+        output = output.writeMessage(answer);
+        output = output.writeMessage(new NewLine());
+        return output;
+    }
+}

package/src/Valkyrja/Cli/Middleware/Constant/CliMiddlewareServiceId.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 CliMiddlewareServiceId {
+    static readonly InputReceivedHandlerContract =
+        'Valkyrja.Cli.Middleware.Handler.InputReceivedHandlerContract' as const;
+    static readonly RouteMatchedHandlerContract =
+        'Valkyrja.Cli.Middleware.Handler.RouteMatchedHandlerContract' as const;
+    static readonly RouteNotMatchedHandlerContract =
+        'Valkyrja.Cli.Middleware.Handler.RouteNotMatchedHandlerContract' as const;
+    static readonly RouteDispatchedHandlerContract =
+        'Valkyrja.Cli.Middleware.Handler.RouteDispatchedHandlerContract' as const;
+    static readonly ThrowableCaughtHandlerContract =
+        'Valkyrja.Cli.Middleware.Handler.ThrowableCaughtHandlerContract' as const;
+    static readonly ExitedHandlerContract = 'Valkyrja.Cli.Middleware.Handler.ExitedHandlerContract' as const;
+}

package/src/Valkyrja/Cli/Middleware/Contract/ExitedMiddlewareContract.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { InputContract } from '../../Interaction/Input/Contract/InputContract.js';
+import type { OutputContract } from '../../Interaction/Output/Contract/OutputContract.js';
+import type { ExitedHandlerContract } from '../Handler/Contract/ExitedHandlerContract.js';
+
+export interface ExitedMiddlewareContract {
+    exited(input: InputContract, output: OutputContract, handler: ExitedHandlerContract): void;
+}
+
+export namespace ExitedMiddlewareContract {
+    export function instanceOf(value: unknown): value is ExitedMiddlewareContract {
+        return typeof value === 'object' && value !== null && 'exited' in value;
+    }
+}

package/src/Valkyrja/Cli/Middleware/Contract/InputReceivedMiddlewareContract.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { InputContract } from '../../Interaction/Input/Contract/InputContract.js';
+import type { OutputContract } from '../../Interaction/Output/Contract/OutputContract.js';
+import type { InputReceivedHandlerContract } from '../Handler/Contract/InputReceivedHandlerContract.js';
+
+export interface InputReceivedMiddlewareContract {
+    inputReceived(input: InputContract, handler: InputReceivedHandlerContract): InputContract | OutputContract;
+}
+
+export namespace InputReceivedMiddlewareContract {
+    export function instanceOf(value: unknown): value is InputReceivedMiddlewareContract {
+        return typeof value === 'object' && value !== null && 'inputReceived' in value;
+    }
+}

package/src/Valkyrja/Cli/Middleware/Contract/RouteDispatchedMiddlewareContract.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 { InputContract } from '../../Interaction/Input/Contract/InputContract.js';
+import type { OutputContract } from '../../Interaction/Output/Contract/OutputContract.js';
+import type { RouteContract } from '../../Routing/Data/Contract/RouteContract.js';
+import type { RouteDispatchedHandlerContract } from '../Handler/Contract/RouteDispatchedHandlerContract.js';
+
+export interface RouteDispatchedMiddlewareContract {
+    routeDispatched(
+        input: InputContract,
+        output: OutputContract,
+        route: RouteContract,
+        handler: RouteDispatchedHandlerContract,
+    ): OutputContract;
+}
+
+export namespace RouteDispatchedMiddlewareContract {
+    export function instanceOf(value: unknown): value is RouteDispatchedMiddlewareContract {
+        return typeof value === 'object' && value !== null && 'routeDispatched' in value;
+    }
+}