@valkyrjaio/valkyrja 26.0.0

package/src/Valkyrja/Cli/Routing/Enum/OptionValueMode.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.
+ */
+
+export enum OptionValueMode {
+    NONE = 'NONE',
+    DEFAULT = 'DEFAULT',
+    ARRAY = 'ARRAY',
+}

package/src/Valkyrja/Cli/Routing/Provider/CliRoutingCliRouteProvider.ts

@@ -0,0 +1,111 @@
+/*
+ * 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 { OutputContract } from '../../Interaction/Output/Contract/OutputContract.js';
+import type { ContainerContract } from '../../../Container/Manager/Contract/ContainerContract.js';
+import type { RouteContract } from '../Data/Contract/RouteContract.js';
+import type { CliRouteProviderContract } from './Contract/CliRouteProviderContract.js';
+import type { HelpCommand } from '../../Server/Command/HelpCommand.js';
+import type { ListBashCommand } from '../../Server/Command/ListBashCommand.js';
+import type { ListCommand } from '../../Server/Command/ListCommand.js';
+import type { VersionCommand } from '../../Server/Command/VersionCommand.js';
+import { Message } from '../../Interaction/Message/Message.js';
+import { OptionParameter } from '../Data/OptionParameter.js';
+import { ArgumentParameter } from '../Data/ArgumentParameter.js';
+import { Route } from '../Data/Route.js';
+import { CliServerServiceId } from '../../Server/Constant/CliServerServiceId.js';
+import { CliCommandName } from '../../Server/Constant/CommandName.js';
+
+export class CliRoutingCliRouteProvider implements CliRouteProviderContract {
+    getRoutes(): RouteContract[] {
+        return [
+            new Route(
+                CliCommandName.HELP,
+                'Help for a command',
+                CliRoutingCliRouteProvider.helpHandler,
+                () => new Message('A command to get help for a specific command.'),
+                [],
+                [],
+                [],
+                [],
+                [],
+                [new OptionParameter('command', 'The name of the command to get help for', 'command')],
+            ),
+            new Route(
+                CliCommandName.LIST,
+                'List all commands',
+                CliRoutingCliRouteProvider.listHandler,
+                () => new Message('A command to list all the commands present within the Cli component.'),
+                [],
+                [],
+                [],
+                [],
+                [],
+                [
+                    new OptionParameter(
+                        'namespace',
+                        'An optional namespace to filter commands by',
+                        'namespace',
+                        null,
+                        '',
+                        ['n'],
+                    ),
+                ],
+            ),
+            new Route(
+                CliCommandName.LIST_BASH,
+                'List all commands for bash completion',
+                CliRoutingCliRouteProvider.listBashHandler,
+                () =>
+                    new Message(
+                        'A command to list all the commands present within the Cli component for bash completion.',
+                    ),
+                [],
+                [],
+                [],
+                [],
+                [
+                    new ArgumentParameter('applicationName', 'The application name'),
+                    new ArgumentParameter('namespace', 'An optional namespace to filter commands by'),
+                ],
+            ),
+            new Route(
+                CliCommandName.VERSION,
+                'Get the application version',
+                CliRoutingCliRouteProvider.versionHandler,
+                () => new Message('A command to show the application version and info.'),
+                [],
+                [],
+                [],
+                [],
+                [],
+                [
+                    new OptionParameter('short', 'Output the version number only', '', null, '', ['s']),
+                    new OptionParameter('plain', 'Output version info without the banner', '', null, '', ['p']),
+                ],
+            ),
+        ];
+    }
+
+    static listHandler(this: void, container: ContainerContract, _route: RouteContract): OutputContract {
+        return container.getSingleton<ListCommand>(CliServerServiceId.ListCommand).run();
+    }
+
+    static listBashHandler(this: void, container: ContainerContract, _route: RouteContract): OutputContract {
+        return container.getSingleton<ListBashCommand>(CliServerServiceId.ListBashCommand).run();
+    }
+
+    static helpHandler(this: void, container: ContainerContract, _route: RouteContract): OutputContract {
+        return container.getSingleton<HelpCommand>(CliServerServiceId.HelpCommand).run();
+    }
+
+    static versionHandler(this: void, container: ContainerContract, _route: RouteContract): OutputContract {
+        return container.getSingleton<VersionCommand>(CliServerServiceId.VersionCommand).run();
+    }
+}

package/src/Valkyrja/Cli/Routing/Provider/CliRoutingComponentProvider.ts

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

package/src/Valkyrja/Cli/Routing/Provider/CliRoutingServiceProvider.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 type { ApplicationContract } from '../../../Application/Kernel/Contract/ApplicationContract.js';
+import type { ContainerContract } from '../../../Container/Manager/Contract/ContainerContract.js';
+import type { ServiceProviderContract } from '../../../Container/Provider/Contract/ServiceProviderContract.js';
+import { CliInteractionServiceId } from '../../Interaction/Constant/CliInteractionServiceId.js';
+import type { OutputFactoryContract } from '../../Interaction/Output/Factory/Contract/OutputFactoryContract.js';
+import { CliMiddlewareServiceId } from '../../Middleware/Constant/CliMiddlewareServiceId.js';
+import type { ExitedHandlerContract } from '../../Middleware/Handler/Contract/ExitedHandlerContract.js';
+import type { RouteDispatchedHandlerContract } from '../../Middleware/Handler/Contract/RouteDispatchedHandlerContract.js';
+import type { RouteMatchedHandlerContract } from '../../Middleware/Handler/Contract/RouteMatchedHandlerContract.js';
+import type { RouteNotMatchedHandlerContract } from '../../Middleware/Handler/Contract/RouteNotMatchedHandlerContract.js';
+import type { ThrowableCaughtHandlerContract } from '../../Middleware/Handler/Contract/ThrowableCaughtHandlerContract.js';
+import type { RouteCollectionContract } from '../Collection/Contract/RouteCollectionContract.js';
+import { RouteCollection } from '../Collection/RouteCollection.js';
+import { CliRoutingServiceId } from '../Constant/CliRoutingServiceId.js';
+import { CliRoutingData } from '../Data/CliRoutingData.js';
+import type { RouterContract } from '../Dispatcher/Contract/RouterContract.js';
+import { Router } from '../Dispatcher/Router.js';
+
+export class CliRoutingServiceProvider implements ServiceProviderContract {
+    publishers(): Record<string, (container: ContainerContract) => void> {
+        return {
+            [CliRoutingServiceId.RouterContract]: CliRoutingServiceProvider.publishRouter,
+            [CliRoutingServiceId.RouteCollectionContract]: CliRoutingServiceProvider.publishRouteCollection,
+            [CliRoutingServiceId.CliRoutingData]: CliRoutingServiceProvider.publishData,
+        };
+    }
+
+    static publishRouter(this: void, container: ContainerContract): void {
+        container.setSingleton<RouterContract>(
+            CliRoutingServiceId.RouterContract,
+            new Router(
+                container,
+                container.getSingleton<RouteCollectionContract>(CliRoutingServiceId.RouteCollectionContract),
+                container.getSingleton<OutputFactoryContract>(CliInteractionServiceId.OutputFactoryContract),
+                container.getSingleton<ThrowableCaughtHandlerContract>(
+                    CliMiddlewareServiceId.ThrowableCaughtHandlerContract,
+                ),
+                container.getSingleton<RouteMatchedHandlerContract>(CliMiddlewareServiceId.RouteMatchedHandlerContract),
+                container.getSingleton<RouteNotMatchedHandlerContract>(
+                    CliMiddlewareServiceId.RouteNotMatchedHandlerContract,
+                ),
+                container.getSingleton<RouteDispatchedHandlerContract>(
+                    CliMiddlewareServiceId.RouteDispatchedHandlerContract,
+                ),
+                container.getSingleton<ExitedHandlerContract>(CliMiddlewareServiceId.ExitedHandlerContract),
+            ),
+        );
+    }
+
+    static publishRouteCollection(this: void, container: ContainerContract): void {
+        const collection = new RouteCollection();
+
+        container.setSingleton<RouteCollectionContract>(CliRoutingServiceId.RouteCollectionContract, collection);
+
+        const app = container.getSingleton<ApplicationContract>(ApplicationServiceId.ApplicationContract);
+
+        if (app.getDebugMode()) {
+            CliRoutingServiceProvider.publishData(container);
+
+            return;
+        }
+
+        const data = container.getSingleton<CliRoutingData>(CliRoutingServiceId.CliRoutingData);
+
+        collection.setFromData(data);
+    }
+
+    static publishData(this: void, container: ContainerContract): void {
+        const collection = container.getSingleton<RouteCollectionContract>(CliRoutingServiceId.RouteCollectionContract);
+        const app = container.getSingleton<ApplicationContract>(ApplicationServiceId.ApplicationContract);
+
+        for (const provider of app.getCliProviders()) {
+            collection.add(...provider.getRoutes());
+        }
+
+        container.setSingleton(CliRoutingServiceId.CliRoutingData, collection.getData());
+    }
+}

package/src/Valkyrja/Cli/Routing/Provider/Contract/CliRouteProviderContract.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { RouteContract } from '../../Data/Contract/RouteContract.js';
+
+export interface CliRouteProviderContract {
+    getRoutes(): RouteContract[];
+}
+
+export namespace CliRouteProviderContract {
+    export function instanceOf(value: unknown): value is CliRouteProviderContract {
+        return typeof value === 'object' && value !== null && 'getRoutes' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Throwable/Contract/CliRoutingThrowable.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 CliRoutingThrowable = CliThrowable;

package/src/Valkyrja/Cli/Routing/Throwable/Exception/Abstract/CliRoutingInvalidArgumentException.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 { CliRoutingThrowable } from '../../Contract/CliRoutingThrowable.js';
+
+export abstract class CliRoutingInvalidArgumentException
+    extends CliInvalidArgumentException
+    implements CliRoutingThrowable {}

package/src/Valkyrja/Cli/Routing/Throwable/Exception/Abstract/CliRoutingRuntimeException.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 { CliRoutingThrowable } from '../../Contract/CliRoutingThrowable.js';
+
+export abstract class CliRoutingRuntimeException extends CliRuntimeException implements CliRoutingThrowable {}

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

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

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

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

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

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

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

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

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

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