@valkyrjaio/valkyrja 26.0.0

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

package/src/Valkyrja/Cli/Routing/Collection/Contract/RouteCollectionContract.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 { CliRoutingData } from '../../Data/CliRoutingData.js';
+import type { RouteContract } from '../../Data/Contract/RouteContract.js';
+
+export interface RouteCollectionContract {
+    getData(): CliRoutingData;
+    setFromData(data: CliRoutingData): void;
+    add(...commands: RouteContract[]): this;
+    get(name: string): RouteContract;
+    has(name: string): boolean;
+    all(): Record<string, RouteContract>;
+}
+
+export namespace RouteCollectionContract {
+    export function instanceOf(value: unknown): value is RouteCollectionContract {
+        return typeof value === 'object' && value !== null && 'getData' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Collection/RouteCollection.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 { RouteCollectionContract } from './Contract/RouteCollectionContract.js';
+import type { RouteContract } from '../Data/Contract/RouteContract.js';
+import { CliRoutingData } from '../Data/CliRoutingData.js';
+import { CliRoutingInvalidRouteNameException } from '../Throwable/Exception/CliRoutingInvalidRouteNameException.js';
+
+export class RouteCollection implements RouteCollectionContract {
+    protected routes: Record<string, () => RouteContract> = {};
+
+    getData(): CliRoutingData {
+        return new CliRoutingData(this.routes);
+    }
+
+    setFromData(data: CliRoutingData): void {
+        this.routes = data.routes;
+    }
+
+    add(...commands: RouteContract[]): this {
+        for (const command of commands) {
+            this.routes[command.getName()] = () => command;
+        }
+        return this;
+    }
+
+    get(name: string): RouteContract {
+        const route = this.routes[name];
+
+        if (route !== undefined) {
+            return this.ensureRoute(route);
+        }
+
+        throw new CliRoutingInvalidRouteNameException(`The route \`${name}\` was not found.`);
+    }
+
+    has(name: string): boolean {
+        return name in this.routes;
+    }
+
+    all(): Record<string, RouteContract> {
+        const result: Record<string, RouteContract> = {};
+
+        for (const [name, route] of Object.entries(this.routes)) {
+            result[name] = this.ensureRoute(route);
+        }
+
+        return result;
+    }
+
+    protected ensureRoute(route: () => RouteContract): RouteContract {
+        return route();
+    }
+}

package/src/Valkyrja/Cli/Routing/Collector/Contract/RouteCollectorContract.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 RouteCollectorContract {
+    getRoutes(...classes: (new (...args: unknown[]) => unknown)[]): RouteContract[];
+}
+
+export namespace RouteCollectorContract {
+    export function instanceOf(value: unknown): value is RouteCollectorContract {
+        return typeof value === 'object' && value !== null && 'getRoutes' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Constant/CliRoutingServiceId.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.
+ */
+
+export class CliRoutingServiceId {
+    static readonly RouterContract = 'Valkyrja.Cli.Routing.Dispatcher.RouterContract' as const;
+    static readonly RouteCollectionContract = 'Valkyrja.Cli.Routing.Collection.RouteCollectionContract' as const;
+    static readonly RouteContract = 'Valkyrja.Cli.Routing.Data.RouteContract' as const;
+    static readonly CliRoutingData = 'Valkyrja.Cli.Routing.Data.CliRoutingData' as const;
+    static readonly CliRoutingConfig = 'Valkyrja.Cli.Routing.Data.CliRoutingConfig' as const;
+}

package/src/Valkyrja/Cli/Routing/Constant/OptionName.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.
+ */
+
+export class OptionName {
+    static readonly HELP = 'help' as const;
+    static readonly VERSION = 'version' as const;
+    static readonly QUIET = 'quiet' as const;
+    static readonly SILENT = 'silent' as const;
+    static readonly NO_INTERACTION = 'no-interaction' as const;
+    static readonly TOKEN = 'token' as const;
+}

package/src/Valkyrja/Cli/Routing/Constant/OptionShortName.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.
+ */
+
+export class OptionShortName {
+    static readonly HELP = 'h' as const;
+    static readonly VERSION = 'v' as const;
+    static readonly QUIET = 'q' as const;
+    static readonly SILENT = 's' as const;
+    static readonly NO_INTERACTION = 'N' as const;
+    static readonly TOKEN = 't' as const;
+}

package/src/Valkyrja/Cli/Routing/Controller/Controller.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 { InputContract } from '../../Interaction/Input/Contract/InputContract.js';
+import type { OutputFactoryContract } from '../../Interaction/Output/Factory/Contract/OutputFactoryContract.js';
+
+export abstract class Controller {
+    constructor(
+        protected input: InputContract,
+        protected outputFactory: OutputFactoryContract,
+    ) {}
+}

package/src/Valkyrja/Cli/Routing/Data/Abstract/Parameter.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 { ArgumentContract } from '../../../Interaction/Argument/Contract/ArgumentContract.js';
+import type { OptionContract } from '../../../Interaction/Option/Contract/OptionContract.js';
+import type { ParameterContract } from '../Contract/ParameterContract.js';
+import type { Cast } from '../../../../Type/Data/Cast.js';
+import { CliRoutingNoCastException } from '../../Throwable/Exception/CliRoutingNoCastException.js';
+import { ObjectFactory } from '../../../../Type/Object/Factory/ObjectFactory.js';
+
+export abstract class Parameter implements ParameterContract {
+    constructor(
+        protected name: string,
+        protected description: string,
+        protected cast: Cast | null = null,
+    ) {}
+
+    getName(): string {
+        return this.name;
+    }
+
+    withName(name: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.name = name;
+        return clone;
+    }
+
+    hasCast(): boolean {
+        return this.cast !== null;
+    }
+
+    getCast(): Cast {
+        if (this.cast === null) {
+            throw new CliRoutingNoCastException('No cast exists');
+        }
+        return this.cast;
+    }
+
+    withCast(cast: Cast): this {
+        const clone = ObjectFactory.clone(this);
+        clone.cast = cast;
+        return clone;
+    }
+
+    withoutCast(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.cast = null;
+        return clone;
+    }
+
+    getDescription(): string {
+        return this.description;
+    }
+
+    withDescription(description: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.description = description;
+        return clone;
+    }
+
+    abstract getCastValues(): unknown[];
+
+    protected getCastValuesForParameters(parameters: Array<ArgumentContract | OptionContract>): unknown[] {
+        const values: unknown[] = [];
+        const cast = this.cast;
+
+        for (const param of parameters) {
+            const paramValue = param.getValue();
+
+            if (cast === null) {
+                values.push(paramValue);
+                continue;
+            }
+
+            values.push(paramValue);
+        }
+
+        return values;
+    }
+
+    abstract hasFirstValue(): boolean;
+    abstract getFirstValue(): string;
+    abstract areValuesValid(): boolean;
+    abstract validateValues(): this;
+}

package/src/Valkyrja/Cli/Routing/Data/ArgumentParameter.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 { ArgumentContract } from '../../Interaction/Argument/Contract/ArgumentContract.js';
+import type { ArgumentParameterContract } from './Contract/ArgumentParameterContract.js';
+import type { Cast } from '../../../Type/Data/Cast.js';
+import { ArgumentMode } from '../Enum/ArgumentMode.js';
+import { ArgumentValueMode } from '../Enum/ArgumentValueMode.js';
+import { CliRoutingArgumentValuesValidationException } from '../Throwable/Exception/CliRoutingArgumentValuesValidationException.js';
+import { Parameter } from './Abstract/Parameter.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class ArgumentParameter extends Parameter implements ArgumentParameterContract {
+    constructor(
+        name: string,
+        description: string,
+        cast: Cast | null = null,
+        protected mode: ArgumentMode = ArgumentMode.OPTIONAL,
+        protected valueMode: ArgumentValueMode = ArgumentValueMode.DEFAULT,
+        protected arguments_: ArgumentContract[] = [],
+    ) {
+        super(name, description, cast);
+    }
+
+    getMode(): ArgumentMode {
+        return this.mode;
+    }
+
+    withMode(mode: ArgumentMode): this {
+        const clone = ObjectFactory.clone(this);
+        clone.mode = mode;
+        return clone;
+    }
+
+    getValueMode(): ArgumentValueMode {
+        return this.valueMode;
+    }
+
+    withValueMode(valueMode: ArgumentValueMode): this {
+        const clone = ObjectFactory.clone(this);
+        clone.valueMode = valueMode;
+        return clone;
+    }
+
+    getArguments(): ArgumentContract[] {
+        return this.arguments_;
+    }
+
+    withArguments(...arguments_: ArgumentContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.arguments_ = arguments_;
+        return clone;
+    }
+
+    withAddedArguments(...arguments_: ArgumentContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.arguments_ = [...this.arguments_, ...arguments_];
+        return clone;
+    }
+
+    getCastValues(): unknown[] {
+        return this.getCastValuesForParameters(this.arguments_);
+    }
+
+    hasFirstValue(): boolean {
+        return this.arguments_.length > 0;
+    }
+
+    getFirstValue(): string {
+        return this.arguments_[0]?.getValue() ?? '';
+    }
+
+    areValuesValid(): boolean {
+        let valid = true;
+
+        if (this.mode === ArgumentMode.REQUIRED) {
+            valid = this.arguments_.length > 0;
+        }
+
+        if (this.valueMode === ArgumentValueMode.DEFAULT) {
+            valid = valid && this.arguments_.length <= 1;
+        }
+
+        return valid;
+    }
+
+    validateValues(): this {
+        if (!this.areValuesValid()) {
+            throw new CliRoutingArgumentValuesValidationException(`${this.name} is invalid`);
+        }
+        return this;
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/CliRoutingData.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 type { RouteContract } from './Contract/RouteContract.js';
+
+export class CliRoutingData {
+    constructor(public readonly routes: Record<string, () => RouteContract> = {}) {}
+}

package/src/Valkyrja/Cli/Routing/Data/Contract/ArgumentParameterContract.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 { ArgumentContract } from '../../../Interaction/Argument/Contract/ArgumentContract.js';
+import type { ArgumentMode } from '../../Enum/ArgumentMode.js';
+import type { ArgumentValueMode } from '../../Enum/ArgumentValueMode.js';
+import type { ParameterContract } from './ParameterContract.js';
+
+export interface ArgumentParameterContract extends ParameterContract {
+    getMode(): ArgumentMode;
+    withMode(mode: ArgumentMode): this;
+    getValueMode(): ArgumentValueMode;
+    withValueMode(valueMode: ArgumentValueMode): this;
+    getArguments(): ArgumentContract[];
+    withArguments(...arguments_: ArgumentContract[]): this;
+    withAddedArguments(...arguments_: ArgumentContract[]): this;
+}
+
+export namespace ArgumentParameterContract {
+    export function instanceOf(value: unknown): value is ArgumentParameterContract {
+        return typeof value === 'object' && value !== null && 'getMode' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Contract/CliRoutingConfigContract.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.
+ */
+
+export interface CliRoutingConfigContract {
+    readonly dataClassName: string;
+}
+
+export namespace CliRoutingConfigContract {
+    export function instanceOf(value: unknown): value is CliRoutingConfigContract {
+        return typeof value === 'object' && value !== null && 'dataClassName' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Contract/OptionParameterContract.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 { OptionContract } from '../../../Interaction/Option/Contract/OptionContract.js';
+import type { OptionMode } from '../../Enum/OptionMode.js';
+import type { OptionValueMode } from '../../Enum/OptionValueMode.js';
+import type { ParameterContract } from './ParameterContract.js';
+
+export interface OptionParameterContract extends ParameterContract {
+    getShortNames(): string[];
+    withShortNames(...shortNames: string[]): this;
+    withAddedShortNames(...shortNames: string[]): this;
+    getMode(): OptionMode;
+    withMode(mode: OptionMode): this;
+    getValueMode(): OptionValueMode;
+    withValueMode(valueMode: OptionValueMode): this;
+    hasValueDisplayName(): boolean;
+    getValueDisplayName(): string;
+    withValueDisplayName(valueName: string): this;
+    getValidValues(): string[];
+    withValidValues(...validValues: string[]): this;
+    withAddedValidValues(...validValues: string[]): this;
+    hasDefaultValue(): boolean;
+    getDefaultValue(): string;
+    withDefaultValue(defaultValue: string): this;
+    getOptions(): OptionContract[];
+    withOptions(...options: OptionContract[]): this;
+    withAddedOptions(...options: OptionContract[]): this;
+}
+
+export namespace OptionParameterContract {
+    export function instanceOf(value: unknown): value is OptionParameterContract {
+        return typeof value === 'object' && value !== null && 'getShortNames' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Contract/ParameterContract.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { Cast } from '../../../../Type/Data/Cast.js';
+
+export interface ParameterContract {
+    getName(): string;
+    withName(name: string): this;
+    hasCast(): boolean;
+    getCast(): Cast;
+    withCast(cast: Cast): this;
+    withoutCast(): this;
+    getDescription(): string;
+    withDescription(description: string): this;
+    getCastValues(): unknown[];
+    hasFirstValue(): boolean;
+    getFirstValue(): string;
+    areValuesValid(): boolean;
+    validateValues(): this;
+}
+
+export namespace ParameterContract {
+    export function instanceOf(value: unknown): value is ParameterContract {
+        return typeof value === 'object' && value !== null && 'getName' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Contract/RouteContract.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 '../../../Interaction/Message/Contract/MessageContract.js';
+import type { OutputContract } from '../../../Interaction/Output/Contract/OutputContract.js';
+import type { ContainerContract } from '../../../../Container/Manager/Contract/ContainerContract.js';
+import type { ArgumentParameterContract } from './ArgumentParameterContract.js';
+import type { OptionParameterContract } from './OptionParameterContract.js';
+
+export interface RouteContract {
+    getName(): string;
+    withName(name: string): this;
+    getDescription(): string;
+    withDescription(description: string): this;
+    hasHelpText(): boolean;
+    getHelpText(): () => MessageContract;
+    getHelpTextMessage(): MessageContract;
+    withHelpText(helpText: () => MessageContract): this;
+    hasArguments(): boolean;
+    getArguments(): ArgumentParameterContract[];
+    hasArgument(name: string): boolean;
+    getArgument(name: string): ArgumentParameterContract;
+    withArguments(...arguments_: ArgumentParameterContract[]): this;
+    withAddedArguments(...arguments_: ArgumentParameterContract[]): this;
+    hasOptions(): boolean;
+    getOptions(): OptionParameterContract[];
+    hasOption(name: string): boolean;
+    getOption(name: string): OptionParameterContract;
+    withOptions(...options: OptionParameterContract[]): this;
+    withAddedOptions(...options: OptionParameterContract[]): this;
+    getRouteMatchedMiddleware(): string[];
+    withRouteMatchedMiddleware(...middleware: string[]): this;
+    withAddedRouteMatchedMiddleware(...middleware: string[]): this;
+    getRouteDispatchedMiddleware(): string[];
+    withRouteDispatchedMiddleware(...middleware: string[]): this;
+    withAddedRouteDispatchedMiddleware(...middleware: string[]): this;
+    getThrowableCaughtMiddleware(): string[];
+    withThrowableCaughtMiddleware(...middleware: string[]): this;
+    withAddedThrowableCaughtMiddleware(...middleware: string[]): this;
+    getExitedMiddleware(): string[];
+    withExitedMiddleware(...middleware: string[]): this;
+    withAddedExitedMiddleware(...middleware: string[]): this;
+    getHandler(): (container: ContainerContract, route: RouteContract) => OutputContract;
+    withHandler(handler: (container: ContainerContract, route: RouteContract) => OutputContract): this;
+}
+
+export namespace RouteContract {
+    export function instanceOf(value: unknown): value is RouteContract {
+        return typeof value === 'object' && value !== null && 'getName' in value;
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Option/HelpOptionParameter.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 { OptionName } from '../../Constant/OptionName.js';
+import { OptionShortName } from '../../Constant/OptionShortName.js';
+import { OptionValueMode } from '../../Enum/OptionValueMode.js';
+import { OptionParameter } from '../OptionParameter.js';
+
+export class HelpOptionParameter extends OptionParameter {
+    constructor() {
+        super(
+            OptionName.HELP,
+            'Help with this command',
+            '',
+            null,
+            '',
+            [OptionShortName.HELP],
+            [],
+            [],
+            undefined,
+            OptionValueMode.NONE,
+        );
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Option/NoInteractionOptionParameter.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 { OptionName } from '../../Constant/OptionName.js';
+import { OptionShortName } from '../../Constant/OptionShortName.js';
+import { OptionValueMode } from '../../Enum/OptionValueMode.js';
+import { OptionParameter } from '../OptionParameter.js';
+
+export class NoInteractionOptionParameter extends OptionParameter {
+    constructor() {
+        super(
+            OptionName.NO_INTERACTION,
+            'No interactive questions are asked.',
+            '',
+            null,
+            '',
+            [OptionShortName.NO_INTERACTION],
+            [],
+            [],
+            undefined,
+            OptionValueMode.NONE,
+        );
+    }
+}

package/src/Valkyrja/Cli/Routing/Data/Option/QuietOptionParameter.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 { OptionName } from '../../Constant/OptionName.js';
+import { OptionShortName } from '../../Constant/OptionShortName.js';
+import { OptionValueMode } from '../../Enum/OptionValueMode.js';
+import { OptionParameter } from '../OptionParameter.js';
+
+export class QuietOptionParameter extends OptionParameter {
+    constructor() {
+        super(
+            OptionName.QUIET,
+            'Output is suppressed, except for errors.',
+            '',
+            null,
+            '',
+            [OptionShortName.QUIET],
+            [],
+            [],
+            undefined,
+            OptionValueMode.NONE,
+        );
+    }
+}