@valkyrjaio/valkyrja 26.0.0

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

@@ -0,0 +1,44 @@
+/*
+ * 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 { ProgressContract } from './Contract/ProgressContract.js';
+import { Message } from './Message.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Progress extends Message implements ProgressContract {
+    constructor(
+        text: string,
+        protected complete: boolean = false,
+        protected percentage: number = 0,
+        formatter: FormatterContract | null = null,
+    ) {
+        super(text, formatter);
+    }
+
+    isComplete(): boolean {
+        return this.complete;
+    }
+
+    withIsComplete(isComplete: boolean): this {
+        const clone = ObjectFactory.clone(this);
+        clone.complete = isComplete;
+        return clone;
+    }
+
+    getPercentage(): number {
+        return this.percentage;
+    }
+
+    withPercentage(percentage: number): this {
+        const clone = ObjectFactory.clone(this);
+        clone.percentage = percentage;
+        return clone;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Message/Question.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 { readSync } from 'node:fs';
+
+import type { FormatterContract } from '../Formatter/Contract/FormatterContract.js';
+import type { AnswerContract } from './Contract/AnswerContract.js';
+import type { QuestionContract } from './Contract/QuestionContract.js';
+import type { OutputContract } from '../Output/Contract/OutputContract.js';
+import { QuestionFormatter } from '../Formatter/QuestionFormatter.js';
+import { Message } from './Message.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Question extends Message implements QuestionContract {
+    constructor(
+        text: string,
+        protected callable: (output: OutputContract, answer: AnswerContract) => OutputContract,
+        protected answer: AnswerContract,
+        formatter: FormatterContract | null = new QuestionFormatter(),
+    ) {
+        super(text, formatter);
+    }
+
+    getCallable(): (output: OutputContract, answer: AnswerContract) => OutputContract {
+        return this.callable;
+    }
+
+    withCallable(callable: (output: OutputContract, answer: AnswerContract) => OutputContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.callable = callable;
+        return clone;
+    }
+
+    getAnswer(): AnswerContract {
+        return this.answer;
+    }
+
+    withAnswer(answer: AnswerContract): this {
+        const clone = ObjectFactory.clone(this);
+        clone.answer = answer;
+        return clone;
+    }
+
+    ask(): AnswerContract {
+        const answer = this.answer;
+        const buf = Buffer.alloc(1024);
+
+        let line = '';
+
+        try {
+            let bytesRead = 0;
+
+            for (;;) {
+                const n = readSync(0, buf, 0, 1, null);
+
+                if (n === 0) {
+                    break;
+                }
+
+                const char = buf.toString('utf8', 0, n);
+
+                if (char === '\n') {
+                    break;
+                }
+
+                line += char;
+                bytesRead += n;
+
+                if (bytesRead >= 1024) {
+                    break;
+                }
+            }
+        } catch {
+            return answer;
+        }
+
+        const response = line.trim();
+
+        if (response === '') {
+            return answer;
+        }
+
+        return answer.withUserResponse(response);
+    }
+}

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

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

package/src/Valkyrja/Cli/Interaction/Option/Contract/OptionContract.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 { OptionType } from '../../Enum/OptionType.js';
+
+export interface OptionContract {
+    getName(): string;
+    withName(name: string): this;
+    hasValue(): boolean;
+    getValue(): string;
+    withValue(value: string): this;
+    withoutValue(): this;
+    getType(): OptionType;
+    withType(type: OptionType): this;
+}
+
+export namespace OptionContract {
+    export function instanceOf(value: unknown): value is OptionContract {
+        return typeof value === 'object' && value !== null && 'getName' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Option/Factory/OptionFactory.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 { OptionType } from '../../Enum/OptionType.js';
+import { Option } from '../Option.js';
+import { CliInteractionInvalidEmptyValueException } from '../../Throwable/Exception/CliInteractionInvalidEmptyValueException.js';
+import { CliInteractionInvalidNonEmptyValueException } from '../../Throwable/Exception/CliInteractionInvalidNonEmptyValueException.js';
+import { CliInteractionInvalidOptionNameException } from '../../Throwable/Exception/CliInteractionInvalidOptionNameException.js';
+
+export abstract class OptionFactory {
+    static fromArg(arg: string): Option[] {
+        OptionFactory.validateArgIsOption(arg);
+
+        const type = OptionFactory.getOptionType(arg);
+        const parts = arg.split('=');
+        const name = (parts[0] ?? '').replace(/^-+/, '').trim();
+        const value = parts[1] ?? '';
+
+        OptionFactory.validateNonEmptyName(name);
+
+        if (type === OptionType.SHORT && name.length > 1) {
+            OptionFactory.validateValueIsEmpty(value);
+            return OptionFactory.splitCombinedShortOptions(type, name);
+        }
+
+        return [new Option(name, value, type)];
+    }
+
+    protected static validateArgIsOption(arg: string): void {
+        if (!arg.startsWith('-')) {
+            throw new CliInteractionInvalidOptionNameException('Options must begin with either a `-` or `--`');
+        }
+    }
+
+    protected static validateNonEmptyName(name: string): void {
+        if (name === '') {
+            throw new CliInteractionInvalidNonEmptyValueException('Option name cannot be empty');
+        }
+    }
+
+    protected static getOptionType(arg: string): OptionType {
+        return arg.startsWith('--') ? OptionType.LONG : OptionType.SHORT;
+    }
+
+    protected static validateValueIsEmpty(value: string): void {
+        if (value !== '') {
+            throw new CliInteractionInvalidEmptyValueException('Cannot combine multiple options and include a value');
+        }
+    }
+
+    protected static splitCombinedShortOptions(type: OptionType, name: string): Option[] {
+        return name.split('').map((item) => new Option(item, '', type));
+    }
+}

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

@@ -0,0 +1,61 @@
+/*
+ * 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 { OptionType } from '../Enum/OptionType.js';
+
+import type { OptionContract } from './Contract/OptionContract.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class Option implements OptionContract {
+    constructor(
+        protected name: string,
+        protected value: string = '',
+        protected type: OptionType = OptionType.LONG,
+    ) {}
+
+    getName(): string {
+        return this.name;
+    }
+
+    withName(name: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.name = name;
+        return clone;
+    }
+
+    hasValue(): boolean {
+        return this.value !== '';
+    }
+
+    getValue(): string {
+        return this.value;
+    }
+
+    withValue(value: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.value = value;
+        return clone;
+    }
+
+    withoutValue(): this {
+        const clone = ObjectFactory.clone(this);
+        clone.value = '';
+        return clone;
+    }
+
+    getType(): OptionType {
+        return this.type;
+    }
+
+    withType(type: OptionType): this {
+        const clone = ObjectFactory.clone(this);
+        clone.type = type;
+        return clone;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/Contract/EmptyOutputContract.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 { OutputContract } from './OutputContract.js';
+
+export type EmptyOutputContract = OutputContract;
+
+export namespace EmptyOutputContract {
+    export function instanceOf(value: unknown): value is EmptyOutputContract {
+        return typeof value === 'object' && value !== null && 'getMessages' in value;
+    }
+}

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

@@ -0,0 +1,21 @@
+/*
+ * 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 './OutputContract.js';
+
+export interface FileOutputContract extends OutputContract {
+    getFilepath(): string;
+    withFilepath(filepath: string): this;
+}
+
+export namespace FileOutputContract {
+    export function instanceOf(value: unknown): value is FileOutputContract {
+        return typeof value === 'object' && value !== null && 'getFilepath' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/Contract/OutputContract.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 { ExitCode } from '../../Enum/ExitCode.js';
+import type { MessageContract } from '../../Message/Contract/MessageContract.js';
+import type { WriterContract } from '../../Writer/Contract/WriterContract.js';
+
+export interface OutputContract {
+    getMessages(): MessageContract[];
+    getWrittenMessages(): MessageContract[];
+    hasWrittenMessage(): boolean;
+    getUnwrittenMessages(): MessageContract[];
+    hasUnwrittenMessage(): boolean;
+    withMessages(...messages: MessageContract[]): this;
+    withAddedMessages(...messages: MessageContract[]): this;
+    withAddedMessage(message: MessageContract): this;
+    writeMessages(): this;
+    writeMessage(message: MessageContract): this;
+    getWriters(): WriterContract[];
+    withWriters(...writers: WriterContract[]): this;
+    isInteractive(): boolean;
+    withIsInteractive(isInteractive: boolean): this;
+    isQuiet(): boolean;
+    withIsQuiet(isQuiet: boolean): this;
+    isSilent(): boolean;
+    withIsSilent(isSilent: boolean): this;
+    getExitCode(): ExitCode | number;
+    withExitCode(exitCode: ExitCode | number): this;
+}
+
+export namespace OutputContract {
+    export function instanceOf(value: unknown): value is OutputContract {
+        return typeof value === 'object' && value !== null && 'getMessages' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/Contract/PlainOutputContract.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 { OutputContract } from './OutputContract.js';
+
+export type PlainOutputContract = OutputContract;
+
+export namespace PlainOutputContract {
+    export function instanceOf(value: unknown): value is PlainOutputContract {
+        return typeof value === 'object' && value !== null && 'getMessages' in value;
+    }
+}

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

@@ -0,0 +1,21 @@
+/*
+ * 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 './OutputContract.js';
+
+export interface StreamOutputContract extends OutputContract {
+    getStream(): NodeJS.WritableStream;
+    withStream(stream: NodeJS.WritableStream): this;
+}
+
+export namespace StreamOutputContract {
+    export function instanceOf(value: unknown): value is StreamOutputContract {
+        return typeof value === 'object' && value !== null && 'getStream' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/EmptyOutput.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 { EmptyOutputContract } from './Contract/EmptyOutputContract.js';
+import { Output } from './Output.js';
+
+export class EmptyOutput extends Output implements EmptyOutputContract {
+    protected override outputMessage(_message: MessageContract): void {
+        // empty on purpose
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/Factory/Contract/OutputFactoryContract.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 { ExitCode } from '../../../Enum/ExitCode.js';
+import type { MessageContract } from '../../../Message/Contract/MessageContract.js';
+import type { EmptyOutputContract } from '../../Contract/EmptyOutputContract.js';
+import type { FileOutputContract } from '../../Contract/FileOutputContract.js';
+import type { OutputContract } from '../../Contract/OutputContract.js';
+import type { PlainOutputContract } from '../../Contract/PlainOutputContract.js';
+import type { StreamOutputContract } from '../../Contract/StreamOutputContract.js';
+
+export interface OutputFactoryContract {
+    createOutput(exitCode?: ExitCode | number, ...messages: MessageContract[]): OutputContract;
+    createEmptyOutput(exitCode?: ExitCode | number, ...messages: MessageContract[]): EmptyOutputContract;
+    createPlainOutput(exitCode?: ExitCode | number, ...messages: MessageContract[]): PlainOutputContract;
+    createFileOutput(
+        filepath: string,
+        exitCode?: ExitCode | number,
+        ...messages: MessageContract[]
+    ): FileOutputContract;
+    createStreamOutput(
+        stream: NodeJS.WritableStream,
+        exitCode?: ExitCode | number,
+        ...messages: MessageContract[]
+    ): StreamOutputContract;
+}
+
+export namespace OutputFactoryContract {
+    export function instanceOf(value: unknown): value is OutputFactoryContract {
+        return typeof value === 'object' && value !== null && 'createOutput' in value;
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/Factory/OutputFactory.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 type { MessageContract } from '../../Message/Contract/MessageContract.js';
+import type { EmptyOutputContract } from '../Contract/EmptyOutputContract.js';
+import type { FileOutputContract } from '../Contract/FileOutputContract.js';
+import type { OutputContract } from '../Contract/OutputContract.js';
+import type { PlainOutputContract } from '../Contract/PlainOutputContract.js';
+import type { StreamOutputContract } from '../Contract/StreamOutputContract.js';
+import type { OutputFactoryContract } from './Contract/OutputFactoryContract.js';
+import { CliInteractionConfig } from '../../Data/CliInteractionConfig.js';
+import type { CliInteractionConfigContract } from '../../Data/Contract/CliInteractionConfigContract.js';
+import { ExitCode } from '../../Enum/ExitCode.js';
+import { EmptyOutput } from '../EmptyOutput.js';
+import { FileOutput } from '../FileOutput.js';
+import { Output } from '../Output.js';
+import { PlainOutput } from '../PlainOutput.js';
+import { StreamOutput } from '../StreamOutput.js';
+
+export class OutputFactory implements OutputFactoryContract {
+    constructor(protected config: CliInteractionConfigContract = new CliInteractionConfig()) {}
+
+    createOutput(exitCode: ExitCode | number = ExitCode.SUCCESS, ...messages: MessageContract[]): OutputContract {
+        return new Output(this.config.isInteractive, this.config.isQuiet, this.config.isSilent, exitCode, ...messages);
+    }
+
+    createEmptyOutput(
+        exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ): EmptyOutputContract {
+        return new EmptyOutput(
+            this.config.isInteractive,
+            this.config.isQuiet,
+            this.config.isSilent,
+            exitCode,
+            ...messages,
+        );
+    }
+
+    createPlainOutput(
+        exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ): PlainOutputContract {
+        return new PlainOutput(
+            this.config.isInteractive,
+            this.config.isQuiet,
+            this.config.isSilent,
+            exitCode,
+            ...messages,
+        );
+    }
+
+    createFileOutput(
+        filepath: string,
+        exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ): FileOutputContract {
+        return new FileOutput(
+            filepath,
+            this.config.isInteractive,
+            this.config.isQuiet,
+            this.config.isSilent,
+            exitCode,
+            ...messages,
+        );
+    }
+
+    createStreamOutput(
+        stream: NodeJS.WritableStream,
+        exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ): StreamOutputContract {
+        return new StreamOutput(
+            stream,
+            this.config.isInteractive,
+            this.config.isQuiet,
+            this.config.isSilent,
+            exitCode,
+            ...messages,
+        );
+    }
+}

package/src/Valkyrja/Cli/Interaction/Output/FileOutput.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 { FileOutputContract } from './Contract/FileOutputContract.js';
+import { ExitCode } from '../Enum/ExitCode.js';
+import { Output } from './Output.js';
+import { ObjectFactory } from '../../../Type/Object/Factory/ObjectFactory.js';
+
+export class FileOutput extends Output implements FileOutputContract {
+    constructor(
+        protected filepath: string,
+        interactive: boolean = true,
+        quiet: boolean = false,
+        silent: boolean = false,
+        exitCode: ExitCode | number = ExitCode.SUCCESS,
+        ...messages: MessageContract[]
+    ) {
+        super(interactive, quiet, silent, exitCode, ...messages);
+    }
+
+    getFilepath(): string {
+        return this.filepath;
+    }
+
+    withFilepath(filepath: string): this {
+        const clone = ObjectFactory.clone(this);
+        clone.filepath = filepath;
+        return clone;
+    }
+
+    protected override outputMessage(_message: MessageContract): void {
+        // TODO: Implement
+    }
+}