@valkyrjaio/valkyrja 26.0.0

package/src/Valkyrja/Cli/Interaction/Input/Factory/InputFactory.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 '../Contract/InputContract.js';
+import { ArgumentFactory } from '../../Argument/Factory/ArgumentFactory.js';
+import { Input } from '../Input.js';
+import { OptionFactory } from '../../Option/Factory/OptionFactory.js';
+
+export abstract class InputFactory {
+    static fromGlobals(args: string[], applicationName: string, commandName: string): InputContract {
+        return InputFactory.inputWithProperties(new Input(), args, applicationName, commandName);
+    }
+
+    protected static inputWithProperties(
+        input: InputContract,
+        args: string[],
+        applicationName: string,
+        commandName: string,
+    ): InputContract {
+        const arguments_ = [];
+        const options = [];
+
+        for (const [key, arg] of args.entries()) {
+            if (key === 0) {
+                applicationName = arg;
+            } else if (arg.startsWith('-')) {
+                options.push(...OptionFactory.fromArg(arg));
+            } else if (key === 1) {
+                commandName = arg;
+            } else {
+                arguments_.push(ArgumentFactory.fromArg(arg));
+            }
+        }
+
+        return input
+            .withCaller(applicationName)
+            .withCommandName(commandName)
+            .withArguments(...arguments_)
+            .withOptions(...options);
+    }
+}

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

@@ -0,0 +1,106 @@
+/*
+ * 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 '../Argument/Contract/ArgumentContract.js';
+import type { InputContract } from './Contract/InputContract.js';
+import type { OptionContract } from '../Option/Contract/OptionContract.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Input implements InputContract {
+    constructor(
+        protected caller: string = 'valkyrja',
+        protected commandName: string = 'list',
+        protected arguments_: ArgumentContract[] = [],
+        protected options: OptionContract[] = [],
+    ) {}
+
+    getCaller(): string {
+        return this.caller;
+    }
+
+    withCaller(caller: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.caller = caller;
+        return clone;
+    }
+
+    getCommandName(): string {
+        return this.commandName;
+    }
+
+    withCommandName(commandName: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.commandName = commandName;
+        return clone;
+    }
+
+    getArguments(): ArgumentContract[] {
+        return this.arguments_;
+    }
+
+    withArguments(...arguments_: ArgumentContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.arguments_ = arguments_;
+        return clone;
+    }
+
+    withAddedArgument(argument: ArgumentContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.arguments_ = [...this.arguments_, argument];
+        return clone;
+    }
+
+    withoutArgument(value: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.arguments_ = this.arguments_.filter((a) => a.getValue() !== value);
+        return clone;
+    }
+
+    withoutArguments(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.arguments_ = [];
+        return clone;
+    }
+
+    getOptions(): OptionContract[] {
+        return this.options;
+    }
+
+    getOption(name: string): OptionContract[] {
+        return this.options.filter((o) => o.getName() === name);
+    }
+
+    hasOption(name: string): boolean {
+        return this.getOption(name).length > 0;
+    }
+
+    withOptions(...options: OptionContract[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.options = options;
+        return clone;
+    }
+
+    withAddedOption(option: OptionContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.options = [...this.options, option];
+        return clone;
+    }
+
+    withoutOption(name: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.options = this.options.filter((o) => o.getName() !== name);
+        return clone;
+    }
+
+    withoutOptions(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.options = [];
+        return clone;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Answer.ts

@@ -0,0 +1,130 @@
+/*
+ * 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 { FormatterContract } from '../Formatter/Contract/FormatterContract.js';
+import type { AnswerContract } from './Contract/AnswerContract.js';
+import { CliInteractionNoValidationCallableException } from '../Throwable/Exception/CliInteractionNoValidationCallableException.js';
+import { Message } from './Message.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Answer extends Message implements AnswerContract {
+    protected userResponse: string;
+    protected allowedResponses: string[];
+
+    constructor(
+        protected defaultResponse: string,
+        protected validationCallable: ((response: string) => boolean) | null = null,
+        protected answeredFlag: boolean = false,
+        text: string = 'You answered: `%s`',
+        formatter: FormatterContract | null = null,
+        allowedResponses: string[] = [],
+    ) {
+        if (!allowedResponses.includes(defaultResponse)) {
+            allowedResponses = [...allowedResponses, defaultResponse];
+        }
+
+        super(text, formatter);
+
+        this.userResponse = defaultResponse;
+        this.allowedResponses = allowedResponses;
+    }
+
+    override getText(): string {
+        return this.text.replace('%s', this.userResponse);
+    }
+
+    getDefaultResponse(): string {
+        return this.defaultResponse;
+    }
+
+    withDefaultResponse(defaultResponse: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.defaultResponse = defaultResponse;
+
+        if (!clone.answeredFlag) {
+            clone.userResponse = defaultResponse;
+        }
+
+        if (!clone.allowedResponses.includes(defaultResponse)) {
+            clone.allowedResponses = [...clone.allowedResponses, defaultResponse];
+        }
+
+        return clone;
+    }
+
+    getAllowedResponses(): string[] {
+        return this.allowedResponses;
+    }
+
+    withAllowedResponses(...allowedResponses: string[]): this {
+        const clone = ObjectFactory.clone(this);
+        clone.allowedResponses = allowedResponses;
+
+        if (!clone.allowedResponses.includes(clone.defaultResponse)) {
+            clone.allowedResponses = [...clone.allowedResponses, clone.defaultResponse];
+        }
+
+        return clone;
+    }
+
+    getUserResponse(): string {
+        return this.userResponse;
+    }
+
+    withUserResponse(userResponse: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.userResponse = userResponse;
+        clone.answeredFlag = true;
+        return clone;
+    }
+
+    hasValidationCallable(): boolean {
+        return this.validationCallable !== null;
+    }
+
+    getValidationCallable(): (response: string) => boolean {
+        if (this.validationCallable === null) {
+            throw new CliInteractionNoValidationCallableException('No validation callable has been set');
+        }
+        return this.validationCallable;
+    }
+
+    withValidationCallable(validationCallable: (response: string) => boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.validationCallable = validationCallable;
+        return clone;
+    }
+
+    withoutValidationCallable(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.validationCallable = null;
+        return clone;
+    }
+
+    hasBeenAnswered(): boolean {
+        return this.answeredFlag;
+    }
+
+    withHasBeenAnswered(hasBeenAnswered: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.answeredFlag = hasBeenAnswered;
+        return clone;
+    }
+
+    isValidResponse(): boolean {
+        const validationCallable = this.validationCallable;
+        const userResponse = this.userResponse;
+
+        return (
+            (this.allowedResponses.length === 0 && validationCallable === null) ||
+            this.allowedResponses.includes(userResponse) ||
+            (validationCallable !== null && validationCallable(userResponse))
+        );
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Banner.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 { Message } from './Message.js';
+import { Messages } from './Messages.js';
+import { NewLine } from './NewLine.js';
+
+export class Banner extends Message {
+    protected messages: Messages;
+
+    constructor(protected message: Message) {
+        super(message.getText());
+
+        const text = `    ${this.text}    `;
+        const spaces = ' '.repeat(text.length);
+
+        this.messages = new Messages(
+            new NewLine(),
+            this.message.withText(spaces),
+            new NewLine(),
+            this.message.withText(text),
+            new NewLine(),
+            this.message.withText(spaces),
+            new NewLine(),
+        );
+    }
+
+    override getText(): string {
+        return this.messages.getText();
+    }
+
+    override getFormattedText(): string {
+        return this.messages.getFormattedText();
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Contract/AnswerContract.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 { MessageContract } from './MessageContract.js';
+
+export interface AnswerContract extends MessageContract {
+    getDefaultResponse(): string;
+    withDefaultResponse(defaultResponse: string): this;
+    getAllowedResponses(): string[];
+    withAllowedResponses(...allowedResponses: string[]): this;
+    getUserResponse(): string;
+    withUserResponse(userResponse: string): this;
+    hasValidationCallable(): boolean;
+    getValidationCallable(): (response: string) => boolean;
+    withValidationCallable(validationCallable: (response: string) => boolean): this;
+    withoutValidationCallable(): this;
+    hasBeenAnswered(): boolean;
+    withHasBeenAnswered(hasBeenAnswered: boolean): this;
+    isValidResponse(): boolean;
+}
+
+export namespace AnswerContract {
+    export function instanceOf(value: unknown): value is AnswerContract {
+        return typeof value === 'object' && value !== null && 'getUserResponse' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Contract/MessageContract.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 { FormatterContract } from '../../Formatter/Contract/FormatterContract.js';
+
+export interface MessageContract {
+    getText(): string;
+    getFormattedText(): string;
+    withText(text: string): this;
+    hasFormatter(): boolean;
+    getFormatter(): FormatterContract;
+    withFormatter(formatter: FormatterContract): this;
+    withoutFormatter(): this;
+}
+
+export namespace MessageContract {
+    export function instanceOf(value: unknown): value is MessageContract {
+        return typeof value === 'object' && value !== null && 'getText' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Contract/ProgressContract.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 './MessageContract.js';
+
+export interface ProgressContract extends MessageContract {
+    isComplete(): boolean;
+    withIsComplete(isComplete: boolean): this;
+    getPercentage(): number;
+    withPercentage(percentage: number): this;
+}
+
+export namespace ProgressContract {
+    export function instanceOf(value: unknown): value is ProgressContract {
+        return typeof value === 'object' && value !== null && 'isComplete' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Contract/QuestionContract.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 { OutputContract } from '../../Output/Contract/OutputContract.js';
+import type { AnswerContract } from './AnswerContract.js';
+import type { MessageContract } from './MessageContract.js';
+
+export interface QuestionContract extends MessageContract {
+    getCallable(): (output: OutputContract, answer: AnswerContract) => OutputContract;
+    withCallable(callable: (output: OutputContract, answer: AnswerContract) => OutputContract): this;
+    getAnswer(): AnswerContract;
+    withAnswer(answer: AnswerContract): this;
+    ask(): AnswerContract;
+}
+
+export namespace QuestionContract {
+    export function instanceOf(value: unknown): value is QuestionContract {
+        return typeof value === 'object' && value !== null && 'ask' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/ErrorMessage.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 { ErrorFormatter } from '../Formatter/ErrorFormatter.js';
+import { Message } from './Message.js';
+
+export class ErrorMessage extends Message {
+    constructor(text: string) {
+        super(text, new ErrorFormatter());
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Header.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 { ApplicationInfo } from '../../../Application/Constant/ApplicationInfo.js';
+import type { RouteContract } from '../../Routing/Data/Contract/RouteContract.js';
+import { Message } from './Message.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Header extends Message {
+    constructor(
+        protected appName: string,
+        protected appVersion: string,
+        route: RouteContract,
+        protected icon: string = ApplicationInfo.ICON,
+        protected valkyrjaVersion: string = ApplicationInfo.VERSION,
+        protected valkyrjaBuildDate: string = ApplicationInfo.VERSION_BUILD_DATE_TIME,
+        protected nodeVersion: string = process.version,
+        protected projectRoot: string = '',
+        protected actionDescription: string = '',
+        protected commandName: string = '',
+    ) {
+        super('');
+
+        if (this.projectRoot === '') {
+            this.projectRoot = process.cwd();
+        }
+
+        if (this.actionDescription === '') {
+            this.actionDescription = route.getDescription();
+        }
+
+        if (this.commandName === '') {
+            this.commandName = route.getName();
+        }
+    }
+
+    withAppName(appName: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.appName = appName;
+        return clone;
+    }
+
+    withAppVersion(appVersion: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.appVersion = appVersion;
+        return clone;
+    }
+
+    withIcon(icon: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.icon = icon;
+        return clone;
+    }
+
+    withValkyrjaVersion(valkyrjaVersion: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.valkyrjaVersion = valkyrjaVersion;
+        return clone;
+    }
+
+    withValkyrjaBuildDate(valkyrjaBuildDate: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.valkyrjaBuildDate = valkyrjaBuildDate;
+        return clone;
+    }
+
+    withNodeVersion(nodeVersion: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.nodeVersion = nodeVersion;
+        return clone;
+    }
+
+    withProjectRoot(projectRoot: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.projectRoot = projectRoot;
+        return clone;
+    }
+
+    withActionDescription(actionDescription: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.actionDescription = actionDescription;
+        return clone;
+    }
+
+    withCommandName(commandName: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.commandName = commandName;
+        return clone;
+    }
+
+    override getText(): string {
+        const iconLines = this.icon.split('\n').map((line) => `│   ${line}`);
+
+        return [
+            `╭── ${this.appName} v${this.appVersion}`,
+            '│',
+            ...iconLines,
+            '│',
+            `│   Built on Valkyrja v${this.valkyrjaVersion} (date: ${this.valkyrjaBuildDate})`,
+            `│   Running on Node ${this.nodeVersion}`,
+            `│   ${this.projectRoot}`,
+            `╰── ${this.actionDescription} · ${this.commandName}`,
+        ].join('\n');
+    }
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 { FormatterContract } from '../Formatter/Contract/FormatterContract.js';
+import type { MessageContract } from './Contract/MessageContract.js';
+import { CliInteractionNoFormatterException } from '../Throwable/Exception/CliInteractionNoFormatterException.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Message implements MessageContract {
+    constructor(
+        protected text: string,
+        protected formatter: FormatterContract | null = null,
+    ) {}
+
+    getText(): string {
+        return this.text;
+    }
+
+    getFormattedText(): string {
+        const text = this.getText();
+        const formatter = this.formatter;
+
+        if (formatter === null) {
+            return text;
+        }
+
+        return formatter.formatText(text);
+    }
+
+    withText(text: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.text = text;
+        return clone;
+    }
+
+    hasFormatter(): boolean {
+        return this.formatter !== null;
+    }
+
+    getFormatter(): FormatterContract {
+        if (this.formatter === null) {
+            throw new CliInteractionNoFormatterException('No formatter has been set');
+        }
+        return this.formatter;
+    }
+
+    withFormatter(formatter: FormatterContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.formatter = formatter;
+        return clone;
+    }
+
+    withoutFormatter(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.formatter = null;
+        return clone;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Messages.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 { MessageContract } from './Contract/MessageContract.js';
+import { Message } from './Message.js';
+
+export class Messages extends Message {
+    protected messages: MessageContract[];
+
+    constructor(...messages: MessageContract[]) {
+        super('');
+        this.messages = messages;
+    }
+
+    override getText(): string {
+        return this.messages.map((m) => m.getText()).join('');
+    }
+
+    override getFormattedText(): string {
+        return this.messages.map((m) => m.getFormattedText()).join('');
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/NewLine.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 { FormatterContract } from '../Formatter/Contract/FormatterContract.js';
+import { Message } from './Message.js';
+
+export class NewLine extends Message {
+    constructor(formatter: FormatterContract | null = null) {
+        super('\n', formatter);
+    }
+}