@jakubmazanec/cli 0.1.0-11dd4a3

package/README.md

@@ -0,0 +1,38 @@
+<div align="center">
+
+# @jakubmazanec/cli
+
+<!-- description -->TypeScript-first library for building CLIs.<!-- description -->
+
+</div>
+
+## Installation
+
+```sh
+npm install @jakubmazanec/cli
+```
+
+⚠️ This is an [ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) package!
+It cannot be required from a CommonJS module.
+
+#### Prerequisites
+
+- Node.js 16 or later
+- TypeScript 5 or later
+
+## Usage
+
+🚧 The package is still under development. Please check back later for updates.
+
+## Documentation
+
+See [API reference](./docs) for auto-generated documentation.
+
+## Contributing
+
+If you want to contribute, see [CONTRIBUTING](./CONTRIBUTING.md) for details.
+
+## License
+
+This package is licensed under the GNU Lesser General Public License v3. See [LICENSE](./LICENSE.md)
+for details.

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const DELIMITER = "$ ";

package/dist/constants.js

@@ -0,0 +1,3 @@
+export const DELIMITER = '$ ';
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["export const DELIMITER = '$ ';\n"],"names":["DELIMITER"],"mappings":"AAAA,OAAO,MAAMA,YAAY,KAAK"}

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export * from './program.js';
+export * from './ui.js';

package/dist/main.js

@@ -0,0 +1,4 @@
+export * from './program.js';
+export * from './ui.js';
+
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/main.ts"],"sourcesContent":["export * from './program.js';\nexport * from './ui.js';\n"],"names":[],"mappings":"AAAA,cAAc,eAAe;AAC7B,cAAc,UAAU"}

package/dist/program/Command.d.ts

@@ -0,0 +1,42 @@
+import { type Argv, type OptionsConfig, type ParametersConfig, type Arguments } from '@jakubmazanec/args';
+import { type CommandAction } from './CommandAction.js';
+import { type CommandOptions } from './CommandOptions.js';
+import { type Program } from './Program.js';
+/**
+ * Command encapsulates piece of a CLI's logic and is executed when {@linkcode Program} instance parses that command from the command line arguments.
+ */
+export declare class Command<A extends string, const B extends ParametersConfig | undefined = undefined, const C extends OptionsConfig | undefined = undefined, D extends boolean = false, E extends boolean = false> {
+    readonly name: A;
+    readonly description?: string;
+    readonly parameters: B extends ParametersConfig ? B : null;
+    readonly options: C extends OptionsConfig ? C : null;
+    readonly allowUnknownOptions: D;
+    readonly allowUnknownParameters: E;
+    private readonly action;
+    /**
+     * @param name Command name, ie. space-separated words consisting only of letters, numbers (but not at the start of the word) or dashes.
+     * @param action Function that runs when command is executed.
+     * @param options Additionl command options.
+     */
+    constructor(name: A, action: CommandAction<A, B, C, D, E>, { description, parameters, options, allowUnknownOptions, allowUnknownParameters, }: CommandOptions<NonNullable<B>, NonNullable<C>, D, E>);
+    /**
+     * Parses a list of command line arguments into an arguments object. Parser is pre-configured based on this command.
+     */
+    parseArguments(argv: Argv): Arguments<{
+        commands: readonly [A];
+        parameters: B;
+        options: C;
+        allowUnknownOptions: D;
+        allowUnknownParameters: E;
+    }>;
+    /**
+     * Executes command action with provided parsed arguments and {@linkcode Program} instance.
+     */
+    run(parsedArgs: Arguments<{
+        commands: readonly [A];
+        parameters: B;
+        options: C;
+        allowUnknownOptions: D;
+        allowUnknownParameters: E;
+    }>, program: Program): Promise<void>;
+}

package/dist/program/Command.js

@@ -0,0 +1,64 @@
+import { parseArguments } from '@jakubmazanec/args';
+// import {type ProgramCommand} from './ProgramCommand.js';
+/**
+ * Command encapsulates piece of a CLI's logic and is executed when {@linkcode Program} instance parses that command from the command line arguments.
+ */ export class Command {
+    /* implements ProgramCommand*/ name;
+    description;
+    parameters;
+    options;
+    allowUnknownOptions;
+    allowUnknownParameters;
+    action;
+    /**
+   * @param name Command name, ie. space-separated words consisting only of letters, numbers (but not at the start of the word) or dashes.
+   * @param action Function that runs when command is executed.
+   * @param options Additionl command options.
+   */ constructor(name, action, { description , parameters , options , allowUnknownOptions , allowUnknownParameters  }){
+        this.name = name;
+        this.action = action;
+        if (description) {
+            this.description = description;
+        }
+        if (parameters) {
+            this.parameters = parameters;
+        } else {
+            this.parameters = null;
+        }
+        if (options) {
+            this.options = options;
+        } else {
+            this.options = null;
+        }
+        if (allowUnknownOptions) {
+            this.allowUnknownOptions = allowUnknownOptions;
+        } else {
+            this.allowUnknownOptions = false;
+        }
+        if (allowUnknownParameters) {
+            this.allowUnknownParameters = allowUnknownParameters;
+        } else {
+            this.allowUnknownParameters = false;
+        }
+    }
+    /**
+   * Parses a list of command line arguments into an arguments object. Parser is pre-configured based on this command.
+   */ parseArguments(argv) {
+        return parseArguments(argv, {
+            commands: [
+                this.name
+            ],
+            parameters: this.parameters ?? undefined,
+            options: this.options ?? undefined,
+            allowUnknownOptions: this.allowUnknownOptions,
+            allowUnknownParameters: this.allowUnknownParameters
+        });
+    }
+    /**
+   * Executes command action with provided parsed arguments and {@linkcode Program} instance.
+   */ async run(parsedArgs, program) {
+        await this.action(parsedArgs, program);
+    }
+}
+
+//# sourceMappingURL=Command.js.map

package/dist/program/Command.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/Command.ts"],"sourcesContent":["import {\n  type Argv,\n  parseArguments,\n  type OptionsConfig,\n  type ParametersConfig,\n  type Arguments,\n} from '@jakubmazanec/args';\n\nimport {type CommandAction} from './CommandAction.js';\nimport {type CommandOptions} from './CommandOptions.js';\nimport {type Program} from './Program.js';\n// import {type ProgramCommand} from './ProgramCommand.js';\n\n/**\n * Command encapsulates piece of a CLI's logic and is executed when {@linkcode Program} instance parses that command from the command line arguments.\n */\nexport class Command<\n  A extends string,\n  const B extends ParametersConfig | undefined = undefined,\n  const C extends OptionsConfig | undefined = undefined,\n  D extends boolean = false,\n  E extends boolean = false,\n> {\n  /* implements ProgramCommand*/\n  readonly name: A;\n  readonly description?: string;\n  readonly parameters: B extends ParametersConfig ? B : null;\n  readonly options: C extends OptionsConfig ? C : null;\n  readonly allowUnknownOptions: D;\n  readonly allowUnknownParameters: E;\n  private readonly action: CommandAction<A, B, C, D, E>;\n\n  /**\n   * @param name Command name, ie. space-separated words consisting only of letters, numbers (but not at the start of the word) or dashes.\n   * @param action Function that runs when command is executed.\n   * @param options Additionl command options.\n   */\n  constructor(\n    name: A,\n    action: CommandAction<A, B, C, D, E>,\n    {\n      description,\n      parameters,\n      options,\n      allowUnknownOptions,\n      allowUnknownParameters,\n    }: CommandOptions<NonNullable<B>, NonNullable<C>, D, E>,\n  ) {\n    this.name = name;\n    this.action = action;\n\n    if (description) {\n      this.description = description;\n    }\n\n    if (parameters) {\n      this.parameters = parameters as B extends ParametersConfig ? B : null;\n    } else {\n      this.parameters = null as B extends ParametersConfig ? B : null;\n    }\n\n    if (options) {\n      this.options = options as C extends OptionsConfig ? C : null;\n    } else {\n      this.options = null as C extends OptionsConfig ? C : null;\n    }\n\n    if (allowUnknownOptions) {\n      this.allowUnknownOptions = allowUnknownOptions;\n    } else {\n      this.allowUnknownOptions = false as D;\n    }\n\n    if (allowUnknownParameters) {\n      this.allowUnknownParameters = allowUnknownParameters;\n    } else {\n      this.allowUnknownParameters = false as E;\n    }\n  }\n\n  /**\n   * Parses a list of command line arguments into an arguments object. Parser is pre-configured based on this command.\n   */\n  parseArguments(argv: Argv): Arguments<{\n    commands: readonly [A];\n    parameters: B;\n    options: C;\n    allowUnknownOptions: D;\n    allowUnknownParameters: E;\n  }> {\n    return parseArguments(argv, {\n      commands: [this.name],\n      parameters: this.parameters ?? undefined,\n      options: this.options ?? undefined,\n      allowUnknownOptions: this.allowUnknownOptions,\n      allowUnknownParameters: this.allowUnknownParameters,\n    } as {\n      commands: readonly [A];\n      parameters: B;\n      options: C;\n      allowUnknownOptions: D;\n      allowUnknownParameters: E;\n    });\n  }\n\n  /**\n   * Executes command action with provided parsed arguments and {@linkcode Program} instance.\n   */\n  async run(\n    parsedArgs: Arguments<{\n      commands: readonly [A];\n      parameters: B;\n      options: C;\n      allowUnknownOptions: D;\n      allowUnknownParameters: E;\n    }>,\n    program: Program,\n  ): Promise<void> {\n    await this.action(parsedArgs, program);\n  }\n}\n"],"names":["parseArguments","Command","name","description","parameters","options","allowUnknownOptions","allowUnknownParameters","action","constructor","argv","commands","undefined","run","parsedArgs","program"],"mappings":"AAAA,SAEEA,cAAc,QAIT,qBAAqB;AAK5B,2DAA2D;AAE3D;;CAEC,GACD,OAAO,MAAMC;IAOX,4BAA4B,GAC5B,AAASC,KAAQ;IACRC,YAAqB;IACrBC,WAAkD;IAClDC,QAA4C;IAC5CC,oBAAuB;IACvBC,uBAA0B;IAClBC,OAAqC;IAEtD;;;;GAIC,GACDC,YACEP,IAAO,EACPM,MAAoC,EACpC,EACEL,YAAW,EACXC,WAAU,EACVC,QAAO,EACPC,oBAAmB,EACnBC,uBAAsB,EAC+B,CACvD;QACA,IAAI,CAACL,OAAOA;QACZ,IAAI,CAACM,SAASA;QAEd,IAAIL,aAAa;YACf,IAAI,CAACA,cAAcA;QACrB;QAEA,IAAIC,YAAY;YACd,IAAI,CAACA,aAAaA;QACpB,OAAO;YACL,IAAI,CAACA,aAAa;QACpB;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,UAAUA;QACjB,OAAO;YACL,IAAI,CAACA,UAAU;QACjB;QAEA,IAAIC,qBAAqB;YACvB,IAAI,CAACA,sBAAsBA;QAC7B,OAAO;YACL,IAAI,CAACA,sBAAsB;QAC7B;QAEA,IAAIC,wBAAwB;YAC1B,IAAI,CAACA,yBAAyBA;QAChC,OAAO;YACL,IAAI,CAACA,yBAAyB;QAChC;IACF;IAEA;;GAEC,GACDP,eAAeU,IAAU,EAMtB;QACD,OAAOV,eAAeU,MAAM;YAC1BC,UAAU;gBAAC,IAAI,CAACT;aAAK;YACrBE,YAAY,IAAI,CAACA,cAAcQ;YAC/BP,SAAS,IAAI,CAACA,WAAWO;YACzBN,qBAAqB,IAAI,CAACA;YAC1BC,wBAAwB,IAAI,CAACA;QAC/B;IAOF;IAEA;;GAEC,GACD,MAAMM,IACJC,UAME,EACFC,OAAgB,EACD;QACf,MAAM,IAAI,CAACP,OAAOM,YAAYC;IAChC;AACF"}

package/dist/program/CommandAction.d.ts

@@ -0,0 +1,12 @@
+import { type OptionsConfig, type ParametersConfig, type Arguments } from '@jakubmazanec/args';
+import { type Program } from './Program.js';
+/**
+ * Command action.
+ */
+export type CommandAction<A extends string, B extends ParametersConfig | undefined = undefined, C extends OptionsConfig | undefined = undefined, D extends boolean = false, E extends boolean = false> = (parsedArgs: Arguments<{
+    commands: readonly [A];
+    parameters: B;
+    options: C;
+    allowUnknownOptions: D;
+    allowUnknownParameters: E;
+}>, program: Program) => Promise<void>;

package/dist/program/CommandAction.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=CommandAction.js.map

package/dist/program/CommandAction.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/CommandAction.ts"],"sourcesContent":["import {type OptionsConfig, type ParametersConfig, type Arguments} from '@jakubmazanec/args';\n\nimport {type Program} from './Program.js';\n\n/**\n * Command action.\n */\nexport type CommandAction<\n  A extends string,\n  B extends ParametersConfig | undefined = undefined,\n  C extends OptionsConfig | undefined = undefined,\n  D extends boolean = false,\n  E extends boolean = false,\n> = (\n  parsedArgs: Arguments<{\n    commands: readonly [A];\n    parameters: B;\n    options: C;\n    allowUnknownOptions: D;\n    allowUnknownParameters: E;\n  }>,\n  program: Program,\n) => Promise<void>;\n"],"names":[],"mappings":"AAAA,WAsBmB"}

package/dist/program/CommandArguments.d.ts

@@ -0,0 +1,5 @@
+import { type Command } from './Command.js';
+/**
+ * Parsed command arguments type.
+ */
+export type CommandArguments<C extends Command<any, any, any, any, any>> = ReturnType<C['parseArguments']>;

package/dist/program/CommandArguments.js

@@ -0,0 +1,3 @@
+/* eslint-disable @typescript-eslint/no-explicit-any -- needed */ export { };
+
+//# sourceMappingURL=CommandArguments.js.map

package/dist/program/CommandArguments.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/CommandArguments.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type Command} from './Command.js';\n\n/**\n * Parsed command arguments type.\n */\nexport type CommandArguments<C extends Command<any, any, any, any, any>> = ReturnType<\n  C['parseArguments']\n>;\n"],"names":[],"mappings":"AAAA,+DAA+D,GAC/D,WAOE"}

package/dist/program/CommandOptions.d.ts

@@ -0,0 +1,11 @@
+import { type OptionsConfig, type ParametersConfig } from '@jakubmazanec/args';
+/**
+ * New command options.
+ */
+export type CommandOptions<B extends ParametersConfig, C extends OptionsConfig, D extends boolean, E extends boolean> = {
+    description?: string;
+    parameters?: B | undefined;
+    options?: C | undefined;
+    allowUnknownOptions?: D | undefined;
+    allowUnknownParameters?: E | undefined;
+};

package/dist/program/CommandOptions.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=CommandOptions.js.map

package/dist/program/CommandOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/CommandOptions.ts"],"sourcesContent":["import {type OptionsConfig, type ParametersConfig} from '@jakubmazanec/args';\n\n/**\n * New command options.\n */\nexport type CommandOptions<\n  B extends ParametersConfig,\n  C extends OptionsConfig,\n  D extends boolean,\n  E extends boolean,\n> = {\n  description?: string;\n  parameters?: B | undefined;\n  options?: C | undefined;\n  allowUnknownOptions?: D | undefined;\n  allowUnknownParameters?: E | undefined;\n};\n"],"names":[],"mappings":"AAAA,WAgBE"}

package/dist/program/Program.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="react" resolution-mode="require"/>
+import { type ParametersConfig, type Argv, type OptionsConfig } from '@jakubmazanec/args';
+import { type Command } from './Command.js';
+import { type ProgramOptions } from './ProgramOptions.js';
+import { type ProgramStreams } from './ProgramStreams.js';
+/**
+ * Program manages and executes {@linkcode Program} instances attached to it based on parsing command line arguments.
+ */
+export declare class Program {
+    /** Program name. */
+    readonly name?: string;
+    /** Program version. */
+    readonly version?: string;
+    /** Program description. */
+    readonly description?: string;
+    /** Program executable name. */
+    readonly bin?: string;
+    /** Program commands */
+    readonly commands: Array<Command<string, ParametersConfig | undefined, OptionsConfig | undefined, boolean, boolean>>;
+    protected isRendering: boolean;
+    readonly streams: ProgramStreams;
+    constructor({ name, version, description, bin }: ProgramOptions);
+    /**
+     * Adds command to the program.
+     *
+     * @param command Command to add.
+     * @returns Program instance.
+     */
+    addCommand(command: Command<any, any, any, any, any>): this;
+    /**
+     * Renders a React element using Ink and outputs to the configured streams.
+     */
+    renderElement(element: React.ReactElement): Promise<void>;
+    /**
+     * Runs the program.
+     *
+     * @param argv Unparsed command line arguments.
+     */
+    run(argv: Argv): Promise<void>;
+}

package/dist/program/Program.js

@@ -0,0 +1,105 @@
+/* eslint-disable @typescript-eslint/no-explicit-any -- needed */ import { ProgramError } from './ProgramError.js';
+import { Wrapper } from '../ui/internals.js';
+import { Failure, Help } from '../ui.js';
+/**
+ * Program manages and executes {@linkcode Program} instances attached to it based on parsing command line arguments.
+ */ export class Program {
+    /** Program name. */ name;
+    /** Program version. */ version;
+    /** Program description. */ description;
+    /** Program executable name. */ bin;
+    /** Program commands */ commands = [];
+    isRendering = false;
+    streams = {
+        stderr: process.stderr,
+        stdin: process.stdin,
+        stdout: process.stdout
+    };
+    constructor({ name , version , description , bin  }){
+        if (name) {
+            this.name = name;
+        }
+        if (version) {
+            this.version = version;
+        }
+        if (description) {
+            this.description = description;
+        }
+        if (bin) {
+            this.bin = bin;
+        }
+    }
+    /**
+   * Adds command to the program.
+   *
+   * @param command Command to add.
+   * @returns Program instance.
+   */ addCommand(command) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- it doesn't matter here; `any` is used to make TypeScript happy in this method, but isn't propagated further.
+        this.commands.push(command);
+        return this;
+    }
+    /**
+   * Renders a React element using Ink and outputs to the configured streams.
+   */ async renderElement(element) {
+        if (this.isRendering) {
+            throw new ProgramError('NO_NESTED_RENDER');
+        } else {
+            this.isRendering = true;
+        }
+        let { render  } = await import('ink');
+        let { createElement  } = await import('react');
+        let { stdin , stdout , stderr  } = this.streams;
+        try {
+            render(createElement(Wrapper, {
+                program: this
+            }, element), {
+                exitOnCtrlC: true,
+                patchConsole: true,
+                stderr,
+                stdin,
+                stdout
+            });
+        } catch (error) {
+            if (error instanceof Error) {
+                await this.renderElement(createElement(Failure, {
+                    error
+                }));
+            }
+        } finally{
+            this.isRendering = false;
+        }
+    }
+    /**
+   * Runs the program.
+   *
+   * @param argv Unparsed command line arguments.
+   */ async run(argv) {
+        let hasCommandRun = false;
+        for (let command of this.commands){
+            let parsedArgs = command.parseArguments(argv);
+            if (parsedArgs.command) {
+                hasCommandRun = true;
+                if (parsedArgs.errors.length) {
+                    let { createElement  } = await import('react');
+                    for (let error of parsedArgs.errors){
+                        await this.renderElement(createElement(Failure, {
+                            error
+                        }));
+                    }
+                } else {
+                    await command.run(parsedArgs, this);
+                    break;
+                }
+            }
+        }
+        if (!hasCommandRun) {
+            let { createElement  } = await import('react');
+            await this.renderElement(createElement(Help, {
+                program: this
+            }));
+        }
+    }
+}
+
+//# sourceMappingURL=Program.js.map

package/dist/program/Program.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/Program.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any -- needed */\nimport {type ParametersConfig, type Argv, type OptionsConfig} from '@jakubmazanec/args';\n\nimport {type Command} from './Command.js';\nimport {ProgramError} from './ProgramError.js';\nimport {type ProgramOptions} from './ProgramOptions.js';\nimport {type ProgramStreams} from './ProgramStreams.js';\nimport {Wrapper} from '../ui/internals.js';\nimport {Failure, Help} from '../ui.js';\n\n/**\n * Program manages and executes {@linkcode Program} instances attached to it based on parsing command line arguments.\n */\nexport class Program {\n  /** Program name. */\n  readonly name?: string;\n\n  /** Program version. */\n  readonly version?: string;\n\n  /** Program description. */\n  readonly description?: string;\n\n  /** Program executable name. */\n  readonly bin?: string;\n\n  /** Program commands */\n  readonly commands: Array<\n    Command<string, ParametersConfig | undefined, OptionsConfig | undefined, boolean, boolean>\n  > = [];\n\n  protected isRendering = false;\n\n  readonly streams: ProgramStreams = {\n    stderr: process.stderr,\n    stdin: process.stdin,\n    stdout: process.stdout,\n  };\n\n  constructor({name, version, description, bin}: ProgramOptions) {\n    if (name) {\n      this.name = name;\n    }\n\n    if (version) {\n      this.version = version;\n    }\n\n    if (description) {\n      this.description = description;\n    }\n\n    if (bin) {\n      this.bin = bin;\n    }\n  }\n\n  /**\n   * Adds command to the program.\n   *\n   * @param command Command to add.\n   * @returns Program instance.\n   */\n  addCommand(command: Command<any, any, any, any, any>): this {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- it doesn't matter here; `any` is used to make TypeScript happy in this method, but isn't propagated further.\n    this.commands.push(command);\n\n    return this;\n  }\n\n  /**\n   * Renders a React element using Ink and outputs to the configured streams.\n   */\n  async renderElement(element: React.ReactElement): Promise<void> {\n    if (this.isRendering) {\n      throw new ProgramError('NO_NESTED_RENDER');\n    } else {\n      this.isRendering = true;\n    }\n\n    let {render} = await import('ink');\n    let {createElement} = await import('react');\n    let {stdin, stdout, stderr} = this.streams;\n\n    try {\n      render(createElement(Wrapper, {program: this}, element), {\n        exitOnCtrlC: true,\n        patchConsole: true,\n        stderr,\n        stdin,\n        stdout,\n      });\n    } catch (error: unknown) {\n      if (error instanceof Error) {\n        await this.renderElement(createElement(Failure, {error}));\n      }\n    } finally {\n      this.isRendering = false;\n    }\n  }\n\n  /**\n   * Runs the program.\n   *\n   * @param argv Unparsed command line arguments.\n   */\n  async run(argv: Argv): Promise<void> {\n    let hasCommandRun = false;\n\n    for (let command of this.commands) {\n      let parsedArgs = command.parseArguments(argv);\n\n      if (parsedArgs.command) {\n        hasCommandRun = true;\n\n        if (parsedArgs.errors.length) {\n          let {createElement} = await import('react');\n\n          for (let error of parsedArgs.errors) {\n            await this.renderElement(createElement(Failure, {error}));\n          }\n        } else {\n          await command.run(parsedArgs, this);\n\n          break;\n        }\n      }\n    }\n\n    if (!hasCommandRun) {\n      let {createElement} = await import('react');\n\n      await this.renderElement(createElement(Help, {program: this}));\n    }\n  }\n}\n"],"names":["ProgramError","Wrapper","Failure","Help","Program","name","version","description","bin","commands","isRendering","streams","stderr","process","stdin","stdout","constructor","addCommand","command","push","renderElement","element","render","createElement","program","exitOnCtrlC","patchConsole","error","Error","run","argv","hasCommandRun","parsedArgs","parseArguments","errors","length"],"mappings":"AAAA,+DAA+D,GAI/D,SAAQA,YAAY,QAAO,oBAAoB;AAG/C,SAAQC,OAAO,QAAO,qBAAqB;AAC3C,SAAQC,OAAO,EAAEC,IAAI,QAAO,WAAW;AAEvC;;CAEC,GACD,OAAO,MAAMC;IACX,kBAAkB,GAClB,AAASC,KAAc;IAEvB,qBAAqB,GACrB,AAASC,QAAiB;IAE1B,yBAAyB,GACzB,AAASC,YAAqB;IAE9B,6BAA6B,GAC7B,AAASC,IAAa;IAEtB,qBAAqB,GACrB,AAASC,WAEL,EAAE,CAAC;IAEGC,cAAc,MAAM;IAErBC,UAA0B;QACjCC,QAAQC,QAAQD;QAChBE,OAAOD,QAAQC;QACfC,QAAQF,QAAQE;IAClB,EAAE;IAEFC,YAAY,EAACX,KAAI,EAAEC,QAAO,EAAEC,YAAW,EAAEC,IAAG,EAAiB,CAAE;QAC7D,IAAIH,MAAM;YACR,IAAI,CAACA,OAAOA;QACd;QAEA,IAAIC,SAAS;YACX,IAAI,CAACA,UAAUA;QACjB;QAEA,IAAIC,aAAa;YACf,IAAI,CAACA,cAAcA;QACrB;QAEA,IAAIC,KAAK;YACP,IAAI,CAACA,MAAMA;QACb;IACF;IAEA;;;;;GAKC,GACDS,WAAWC,OAAyC,EAAQ;QAC1D,iLAAiL;QACjL,IAAI,CAACT,SAASU,KAAKD;QAEnB,OAAO,IAAI;IACb;IAEA;;GAEC,GACD,MAAME,cAAcC,OAA2B,EAAiB;QAC9D,IAAI,IAAI,CAACX,aAAa;YACpB,MAAM,IAAIV,aAAa;QACzB,OAAO;YACL,IAAI,CAACU,cAAc;QACrB;QAEA,IAAI,EAACY,OAAM,EAAC,GAAG,MAAM,MAAM,CAAC;QAC5B,IAAI,EAACC,cAAa,EAAC,GAAG,MAAM,MAAM,CAAC;QACnC,IAAI,EAACT,MAAK,EAAEC,OAAM,EAAEH,OAAM,EAAC,GAAG,IAAI,CAACD;QAEnC,IAAI;YACFW,OAAOC,cAActB,SAAS;gBAACuB,SAAS,IAAI;YAAA,GAAGH,UAAU;gBACvDI,aAAa;gBACbC,cAAc;gBACdd;gBACAE;gBACAC;YACF;QACF,EAAE,OAAOY,OAAgB;YACvB,IAAIA,iBAAiBC,OAAO;gBAC1B,MAAM,IAAI,CAACR,cAAcG,cAAcrB,SAAS;oBAACyB;gBAAK;YACxD;QACF,SAAU;YACR,IAAI,CAACjB,cAAc;QACrB;IACF;IAEA;;;;GAIC,GACD,MAAMmB,IAAIC,IAAU,EAAiB;QACnC,IAAIC,gBAAgB;QAEpB,KAAK,IAAIb,WAAW,IAAI,CAACT,SAAU;YACjC,IAAIuB,aAAad,QAAQe,eAAeH;YAExC,IAAIE,WAAWd,SAAS;gBACtBa,gBAAgB;gBAEhB,IAAIC,WAAWE,OAAOC,QAAQ;oBAC5B,IAAI,EAACZ,cAAa,EAAC,GAAG,MAAM,MAAM,CAAC;oBAEnC,KAAK,IAAII,SAASK,WAAWE,OAAQ;wBACnC,MAAM,IAAI,CAACd,cAAcG,cAAcrB,SAAS;4BAACyB;wBAAK;oBACxD;gBACF,OAAO;oBACL,MAAMT,QAAQW,IAAIG,YAAY,IAAI;oBAElC;gBACF;YACF;QACF;QAEA,IAAI,CAACD,eAAe;YAClB,IAAI,EAACR,cAAa,EAAC,GAAG,MAAM,MAAM,CAAC;YAEnC,MAAM,IAAI,CAACH,cAAcG,cAAcpB,MAAM;gBAACqB,SAAS,IAAI;YAAA;QAC7D;IACF;AACF"}

package/dist/program/ProgramDetail.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Detailed program information.
+ */
+export type ProgramDetail = {
+    name?: string;
+    version?: string;
+    description?: string;
+    bin?: string;
+};

package/dist/program/ProgramDetail.js

@@ -0,0 +1,5 @@
+/**
+ * Detailed program information.
+ */ export { };
+
+//# sourceMappingURL=ProgramDetail.js.map

package/dist/program/ProgramDetail.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/ProgramDetail.ts"],"sourcesContent":["/**\n * Detailed program information.\n */\nexport type ProgramDetail = {\n  name?: string;\n  version?: string;\n  description?: string;\n  bin?: string;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAKE"}

package/dist/program/ProgramError.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A subclass of `Error` that indicates a program failure.
+ */
+export declare const ProgramError: new (code: "NO_NESTED_RENDER", options?: import("@jakubmazanec/error").CustomErrorOptions | undefined) => import("@jakubmazanec/error").CustomError<"NO_NESTED_RENDER" | "UNKNOWN_ERROR">;

package/dist/program/ProgramError.js

@@ -0,0 +1,8 @@
+import { createCustomError } from '@jakubmazanec/error';
+/**
+ * A subclass of `Error` that indicates a program failure.
+ */ export const ProgramError = createCustomError('ProgramError', {
+    NO_NESTED_RENDER: 'A React render process already exists. This usually occurs by triggering nested render calls.'
+});
+
+//# sourceMappingURL=ProgramError.js.map

package/dist/program/ProgramError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/ProgramError.ts"],"sourcesContent":["import {createCustomError} from '@jakubmazanec/error';\n\n/**\n * A subclass of `Error` that indicates a program failure.\n */\nexport const ProgramError = createCustomError('ProgramError', {\n  NO_NESTED_RENDER:\n    'A React render process already exists. This usually occurs by triggering nested render calls.',\n});\n"],"names":["createCustomError","ProgramError","NO_NESTED_RENDER"],"mappings":"AAAA,SAAQA,iBAAiB,QAAO,sBAAsB;AAEtD;;CAEC,GACD,OAAO,MAAMC,eAAeD,kBAAkB,gBAAgB;IAC5DE,kBACE;AACJ,GAAG"}

package/dist/program/ProgramOptions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options for creating new {@linkcode Program} instance.
+ */
+export type ProgramOptions = {
+    /** Program name. */
+    name?: string | undefined;
+    /** Program version. */
+    version?: string | undefined;
+    /** Program description. */
+    description?: string | undefined;
+    /** Program executable name. */
+    bin?: string | undefined;
+};

package/dist/program/ProgramOptions.js

@@ -0,0 +1,5 @@
+/**
+ * Options for creating new {@linkcode Program} instance.
+ */ export { };
+
+//# sourceMappingURL=ProgramOptions.js.map

package/dist/program/ProgramOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/ProgramOptions.ts"],"sourcesContent":["/**\n * Options for creating new {@linkcode Program} instance.\n */\nexport type ProgramOptions = {\n  /** Program name. */\n  name?: string | undefined;\n\n  /** Program version. */\n  version?: string | undefined;\n\n  /** Program description. */\n  description?: string | undefined;\n\n  /** Program executable name. */\n  bin?: string | undefined;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAYE"}

package/dist/program/ProgramStreams.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" resolution-mode="require"/>
+/**
+ * {@linkcode Program} streams;
+ */
+export type ProgramStreams = {
+    stderr: NodeJS.WriteStream;
+    stdin: NodeJS.ReadStream;
+    stdout: NodeJS.WriteStream;
+};

package/dist/program/ProgramStreams.js

@@ -0,0 +1,5 @@
+/**
+ * {@linkcode Program} streams;
+ */ export { };
+
+//# sourceMappingURL=ProgramStreams.js.map

package/dist/program/ProgramStreams.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/ProgramStreams.ts"],"sourcesContent":["/**\n * {@linkcode Program} streams;\n */\nexport type ProgramStreams = {\n  stderr: NodeJS.WriteStream;\n  stdin: NodeJS.ReadStream;\n  stdout: NodeJS.WriteStream;\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAIE"}

package/dist/program/getProgramDetail.d.ts

@@ -0,0 +1,6 @@
+import { type PackageJson } from '@jakubmazanec/zod-utils';
+import { type ProgramDetail } from './ProgramDetail.js';
+/**
+ * Creates detailed information about a {@lincode Program}.
+ */
+export declare function getProgramDetail(packageJson: PackageJson): ProgramDetail;

package/dist/program/getProgramDetail.js

@@ -0,0 +1,27 @@
+/**
+ * Creates detailed information about a {@lincode Program}.
+ */ export function getProgramDetail(packageJson) {
+    let programDetail = {};
+    if (packageJson.name) {
+        programDetail.name = packageJson.name;
+    }
+    if (packageJson.version) {
+        programDetail.version = packageJson.version;
+    }
+    if (packageJson.description) {
+        programDetail.description = packageJson.description;
+    }
+    if (packageJson.bin && typeof packageJson.bin !== 'string') {
+        let bins = Object.entries(packageJson.bin);
+        if (bins.length === 1) {
+            let firstBin = bins[0];
+            [programDetail.bin] = firstBin;
+        }
+    }
+    if (typeof packageJson.bin === 'string' && packageJson.name) {
+        programDetail.bin = packageJson.name;
+    }
+    return programDetail;
+}
+
+//# sourceMappingURL=getProgramDetail.js.map

package/dist/program/getProgramDetail.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/program/getProgramDetail.ts"],"sourcesContent":["import {type PackageJson} from '@jakubmazanec/zod-utils';\n\nimport {type ProgramDetail} from './ProgramDetail.js';\n\n/**\n * Creates detailed information about a {@lincode Program}.\n */\nexport function getProgramDetail(packageJson: PackageJson) {\n  let programDetail: ProgramDetail = {};\n\n  if (packageJson.name) {\n    programDetail.name = packageJson.name;\n  }\n\n  if (packageJson.version) {\n    programDetail.version = packageJson.version;\n  }\n\n  if (packageJson.description) {\n    programDetail.description = packageJson.description;\n  }\n\n  if (packageJson.bin && typeof packageJson.bin !== 'string') {\n    let bins = Object.entries(packageJson.bin);\n\n    if (bins.length === 1) {\n      let firstBin = bins[0] as [string, string];\n\n      [programDetail.bin] = firstBin;\n    }\n  }\n\n  if (typeof packageJson.bin === 'string' && packageJson.name) {\n    programDetail.bin = packageJson.name;\n  }\n\n  return programDetail;\n}\n"],"names":["getProgramDetail","packageJson","programDetail","name","version","description","bin","bins","Object","entries","length","firstBin"],"mappings":"AAIA;;CAEC,GACD,OAAO,SAASA,iBAAiBC,WAAwB;IACvD,IAAIC,gBAA+B,CAAC;IAEpC,IAAID,YAAYE,MAAM;QACpBD,cAAcC,OAAOF,YAAYE;IACnC;IAEA,IAAIF,YAAYG,SAAS;QACvBF,cAAcE,UAAUH,YAAYG;IACtC;IAEA,IAAIH,YAAYI,aAAa;QAC3BH,cAAcG,cAAcJ,YAAYI;IAC1C;IAEA,IAAIJ,YAAYK,OAAO,OAAOL,YAAYK,QAAQ,UAAU;QAC1D,IAAIC,OAAOC,OAAOC,QAAQR,YAAYK;QAEtC,IAAIC,KAAKG,WAAW,GAAG;YACrB,IAAIC,WAAWJ,IAAI,CAAC,EAAE;YAEtB,CAACL,cAAcI,IAAI,GAAGK;QACxB;IACF;IAEA,IAAI,OAAOV,YAAYK,QAAQ,YAAYL,YAAYE,MAAM;QAC3DD,cAAcI,MAAML,YAAYE;IAClC;IAEA,OAAOD;AACT"}

package/dist/program.d.ts

@@ -0,0 +1,10 @@
+export * from './program/Command.js';
+export * from './program/CommandAction.js';
+export * from './program/CommandArguments.js';
+export * from './program/CommandOptions.js';
+export * from './program/getProgramDetail.js';
+export * from './program/Program.js';
+export * from './program/ProgramDetail.js';
+export * from './program/ProgramError.js';
+export * from './program/ProgramOptions.js';
+export * from './program/ProgramStreams.js';

package/dist/program.js

@@ -0,0 +1,12 @@
+export * from './program/Command.js';
+export * from './program/CommandAction.js';
+export * from './program/CommandArguments.js';
+export * from './program/CommandOptions.js';
+export * from './program/getProgramDetail.js';
+export * from './program/Program.js';
+export * from './program/ProgramDetail.js';
+export * from './program/ProgramError.js';
+export * from './program/ProgramOptions.js';
+export * from './program/ProgramStreams.js';
+
+//# sourceMappingURL=program.js.map

package/dist/program.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/program.ts"],"sourcesContent":["export * from './program/Command.js';\nexport * from './program/CommandAction.js';\nexport * from './program/CommandArguments.js';\nexport * from './program/CommandOptions.js';\nexport * from './program/getProgramDetail.js';\nexport * from './program/Program.js';\nexport * from './program/ProgramDetail.js';\nexport * from './program/ProgramError.js';\nexport * from './program/ProgramOptions.js';\nexport * from './program/ProgramStreams.js';\n"],"names":[],"mappings":"AAAA,cAAc,uBAAuB;AACrC,cAAc,6BAA6B;AAC3C,cAAc,gCAAgC;AAC9C,cAAc,8BAA8B;AAC5C,cAAc,gCAAgC;AAC9C,cAAc,uBAAuB;AACrC,cAAc,6BAA6B;AAC3C,cAAc,4BAA4B;AAC1C,cAAc,8BAA8B;AAC5C,cAAc,8BAA8B"}

package/dist/ui/ErrorDetail.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Detailed error information.
+ */
+export type ErrorDetail = {
+    label: string;
+    description?: string;
+    stack?: string;
+    cause?: {
+        description?: string;
+        stack?: string;
+    };
+};

package/dist/ui/ErrorDetail.js

@@ -0,0 +1,5 @@
+/**
+ * Detailed error information.
+ */ export { };
+
+//# sourceMappingURL=ErrorDetail.js.map

package/dist/ui/ErrorDetail.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/ui/ErrorDetail.ts"],"sourcesContent":["/**\n * Detailed error information.\n */\nexport type ErrorDetail = {\n  label: string;\n  description?: string;\n  stack?: string;\n  cause?: {\n    description?: string;\n    stack?: string;\n  };\n};\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAQE"}

package/dist/ui/Failure.d.ts

@@ -0,0 +1,15 @@
+import { type BoxProps } from 'ink';
+import { type ErrorDetail } from './ErrorDetail.js';
+/**
+ * {@linkcode Failure} component props.
+ */
+export type FailureProps = BoxProps & {
+    /** Error that describes a failure state. Function {@linkcode getErrorDetail} is used for getting all the information from the error; you can use it to implement own retrieval logic and pass the result as `errorDetail` prop. */
+    error: Error;
+    /** Information about the failure state. Overrides information retireved from `error` prop. */
+    errorDetail?: ErrorDetail;
+};
+/**
+ * A component that renders a failure state.
+ */
+export declare function Failure({ error, errorDetail, ...boxProps }: FailureProps): import("react/jsx-runtime").JSX.Element;