convoker 0.1.0 → 0.3.0

package/dist/error.d.ts

@@ -1,7 +1,7 @@
 /**
  * Command action function.
  */
-declare type ActionFn<T extends Input> = (input: InferInput<T>) => void | Promise<void>;
+declare type ActionFn<T extends Input> = (input: InferInput<T>) => any | Promise<any>;
 
 /**
  * A basic input type.
@@ -50,6 +50,10 @@ declare class Command<T extends Input = Input> {
      * If this command allows unknown options.
      */
     $allowUnknownOptions: boolean;
+    /**
+     * If you should be able to surpass the amount of positional arguments defined in the input.
+     */
+    $allowSurpassArgLimit: boolean;
     /**
      * The input this command takes.
      */
@@ -58,6 +62,10 @@ declare class Command<T extends Input = Input> {
      * The action function of this command.
      */
     $fn: ActionFn<T> | undefined;
+    /**
+     * The middlewares associated with this command.
+     */
+    $middlewares: MiddlewareFn<T>[];
     /**
      * The error handler of this command.
      */
@@ -93,6 +101,12 @@ declare class Command<T extends Input = Input> {
      * @returns this
      */
     input<TInput extends Input>(input: TInput): Command<TInput>;
+    /**
+     * Adds a chain of middlewares.
+     * @param fns The middlewares to use.
+     * @returns this
+     */
+    use(...fns: MiddlewareFn<T>[]): this;
     /**
      * Sets the action function for this command.
      * @param fn The action.
@@ -136,6 +150,11 @@ declare class Command<T extends Input = Input> {
      */
     parse(argv: string[]): Promise<ParseResult<T>>;
     private buildInputMap;
+    /**
+     * Allows surpassing the amount of arguments specified.
+     * @returns this
+     */
+    allowSurpassArgLimit(): this;
     /**
      * Gets the full command path (name including parents).
      * @returns The full command path.
@@ -175,6 +194,46 @@ declare interface CommandAlias<T extends Input = Input> {
     alias?: string;
 }
 
+/**
+ * A Convoker-related error. These are usually handled by default.
+ */
+export declare class ConvokerError extends Error {
+    /**
+     * The command this error happened on.
+     */
+    command: Command<any>;
+    /**
+     * Creates a new Convoker error.
+     * @param message The message.
+     * @param command The command.
+     */
+    constructor(message: string, command: Command<any>);
+    /**
+     * Prints the error's message.
+     */
+    print(): void;
+}
+
+/**
+ * A Convoker-related error. These are usually handled by default.
+ */
+declare class ConvokerError_2 extends Error {
+    /**
+     * The command this error happened on.
+     */
+    command: Command<any>;
+    /**
+     * Creates a new Convoker error.
+     * @param message The message.
+     * @param command The command.
+     */
+    constructor(message: string, command: Command<any>);
+    /**
+     * Prints the error's message.
+     */
+    print(): void;
+}
+
 /**
  * Command error handler.
  */
@@ -183,7 +242,7 @@ declare type ErrorFn<T extends Input> = (command: Command<T>, errors: Error[], i
 /**
  * When the user asks for help.
  */
-export declare class HelpAskedError extends LunarCLIError {
+export declare class HelpAskedError extends ConvokerError {
     /**
      * Creates a new help asked error.
      * @param command The command.
@@ -240,46 +299,11 @@ declare type Kind = BasicKind | StandardSchemaV1<any, any>;
 declare type Kind_2 = BasicKind_2 | StandardSchemaV1_2<any, any>;
 
 /**
- * A LunarCLI-related error. These are usually handled by default.
+ * Command middleware function.
  */
-export declare class LunarCLIError extends Error {
-    /**
-     * The command this error happened on.
-     */
-    command: Command<any>;
-    /**
-     * Creates a new LunarCLI error.
-     * @param message The message.
-     * @param command The command.
-     */
-    constructor(message: string, command: Command<any>);
-    /**
-     * Prints the error's message.
-     */
-    print(): void;
-}
+declare type MiddlewareFn<T extends Input = Input> = (input: InferInput<T>, next: () => Promise<any>) => any | Promise<any>;
 
-/**
- * A LunarCLI-related error. These are usually handled by default.
- */
-declare class LunarCLIError_2 extends Error {
-    /**
-     * The command this error happened on.
-     */
-    command: Command<any>;
-    /**
-     * Creates a new LunarCLI error.
-     * @param message The message.
-     * @param command The command.
-     */
-    constructor(message: string, command: Command<any>);
-    /**
-     * Prints the error's message.
-     */
-    print(): void;
-}
-
-export declare class MissingRequiredArgumentError extends LunarCLIError {
+export declare class MissingRequiredArgumentError extends ConvokerError {
     /**
      * The argument key.
      */
@@ -300,7 +324,7 @@ export declare class MissingRequiredArgumentError extends LunarCLIError {
 /**
  * When a required option is missing.
  */
-export declare class MissingRequiredOptionError extends LunarCLIError {
+export declare class MissingRequiredOptionError extends ConvokerError {
     /**
      * The option key.
      */
@@ -346,6 +370,10 @@ declare class Option_2<TKind extends Kind, TRequired extends boolean = true, TLi
      * If this option is a list.
      */
     $list: TList;
+    /**
+     * A separator if this option is a list.
+     */
+    $separator: string | undefined;
     /**
      * Creates a new option.
      * @param kind The type of this option.
@@ -356,7 +384,7 @@ declare class Option_2<TKind extends Kind, TRequired extends boolean = true, TLi
      * Makes this option a list.
      * @returns this
      */
-    list(): Option_2<TKind, TRequired, true>;
+    list(separator?: string): Option_2<TKind, TRequired, true>;
     /**
      * Makes this option required.
      * @returns this
@@ -409,6 +437,10 @@ declare class Option_2_2<TKind extends Kind_2, TRequired extends boolean = true,
      * If this option is a list.
      */
     $list: TList;
+    /**
+     * A separator if this option is a list.
+     */
+    $separator: string | undefined;
     /**
      * Creates a new option.
      * @param kind The type of this option.
@@ -419,7 +451,7 @@ declare class Option_2_2<TKind extends Kind_2, TRequired extends boolean = true,
      * Makes this option a list.
      * @returns this
      */
-    list(): Option_2_2<TKind, TRequired, true>;
+    list(separator?: string): Option_2_2<TKind, TRequired, true>;
     /**
      * Makes this option required.
      * @returns this
@@ -459,7 +491,7 @@ declare interface ParseResult<T extends Input> {
     /**
      * Errors collected during parsing.
      */
-    errors: LunarCLIError_2[];
+    errors: ConvokerError_2[];
     /**
      * If this should result in displaying the version of the command.
      */
@@ -795,7 +827,7 @@ declare interface Theme {
 /**
  * When you pass too many arguments.
  */
-export declare class TooManyArgumentsError extends LunarCLIError {
+export declare class TooManyArgumentsError extends ConvokerError {
     /**
      * Creates a new too many arguments error.
      * @param command The command.
@@ -816,7 +848,7 @@ declare type TypeOf_2<T extends Kind_2> = T extends StandardSchemaV1_2<any, infe
 /**
  * When you pass an unknown option, when unknown options aren't allowed.
  */
-export declare class UnknownOptionError extends LunarCLIError {
+export declare class UnknownOptionError extends ConvokerError {
     /**
      * The option key.
      */

package/dist/error.js

@@ -1,10 +1,10 @@
-import { H as n, I as s, L as a, a as i, M as e, T as t, U as E } from "./chunks/error-Cj2qDfOl.js";
+import { C as n, H as s, I as a, M as e, a as i, T as t, U as E } from "./chunks/error-CyKscMUD.js";
 export {
-  n as HelpAskedError,
-  s as InputValidationError,
-  a as LunarCLIError,
-  i as MissingRequiredArgumentError,
-  e as MissingRequiredOptionError,
+  n as ConvokerError,
+  s as HelpAskedError,
+  a as InputValidationError,
+  e as MissingRequiredArgumentError,
+  i as MissingRequiredOptionError,
   t as TooManyArgumentsError,
   E as UnknownOptionError
 };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { Theme as Theme_2 } from '../../../../../../../../../../src/color';
 /**
  * Command action function.
  */
-export declare type ActionFn<T extends Input> = (input: InferInput<T>) => void | Promise<void>;
+export declare type ActionFn<T extends Input> = (input: InferInput<T>) => any | Promise<any>;
 
 /**
  * Creates a new positional argument.
@@ -178,6 +178,10 @@ export declare class Command<T extends Input = Input> {
      * If this command allows unknown options.
      */
     $allowUnknownOptions: boolean;
+    /**
+     * If you should be able to surpass the amount of positional arguments defined in the input.
+     */
+    $allowSurpassArgLimit: boolean;
     /**
      * The input this command takes.
      */
@@ -186,6 +190,10 @@ export declare class Command<T extends Input = Input> {
      * The action function of this command.
      */
     $fn: ActionFn<T> | undefined;
+    /**
+     * The middlewares associated with this command.
+     */
+    $middlewares: MiddlewareFn<T>[];
     /**
      * The error handler of this command.
      */
@@ -221,6 +229,12 @@ export declare class Command<T extends Input = Input> {
      * @returns this
      */
     input<TInput extends Input>(input: TInput): Command<TInput>;
+    /**
+     * Adds a chain of middlewares.
+     * @param fns The middlewares to use.
+     * @returns this
+     */
+    use(...fns: MiddlewareFn<T>[]): this;
     /**
      * Sets the action function for this command.
      * @param fn The action.
@@ -264,6 +278,11 @@ export declare class Command<T extends Input = Input> {
      */
     parse(argv: string[]): Promise<ParseResult<T>>;
     private buildInputMap;
+    /**
+     * Allows surpassing the amount of arguments specified.
+     * @returns this
+     */
+    allowSurpassArgLimit(): this;
     /**
      * Gets the full command path (name including parents).
      * @returns The full command path.
@@ -330,7 +349,27 @@ declare interface ConfirmOpts extends BaseOpts<boolean> {
  * @param value The value to convert.
  * @returns The converted value.
  */
-declare function convert<TKind extends Kind>(kind: TKind, value: string): Promise<TypeOf<TKind>>;
+declare function convert<TKind extends Kind>(kind: TKind, value: string | string[]): Promise<TypeOf<TKind> | TypeOf<TKind>[]>;
+
+/**
+ * A Convoker-related error. These are usually handled by default.
+ */
+declare class ConvokerError extends Error {
+    /**
+     * The command this error happened on.
+     */
+    command: Command<any>;
+    /**
+     * Creates a new Convoker error.
+     * @param message The message.
+     * @param command The command.
+     */
+    constructor(message: string, command: Command<any>);
+    /**
+     * Prints the error's message.
+     */
+    print(): void;
+}
 
 /**
  * Creates a function that wraps a string in ANSI codes.
@@ -398,7 +437,7 @@ declare interface EditorOpts extends BaseOpts<string> {
 export declare namespace error {
     export {
         InputValidationError,
-        LunarCLIError,
+        ConvokerError,
         HelpAskedError,
         TooManyArgumentsError,
         UnknownOptionError,
@@ -433,7 +472,7 @@ declare const greenBright: (input: any) => string;
 /**
  * When the user asks for help.
  */
-declare class HelpAskedError extends LunarCLIError {
+declare class HelpAskedError extends ConvokerError {
     /**
      * Creates a new help asked error.
      * @param command The command.
@@ -549,31 +588,16 @@ declare interface LogConfig {
     stdin: ReadableStream<string>;
 }
 
-/**
- * A LunarCLI-related error. These are usually handled by default.
- */
-declare class LunarCLIError extends Error {
-    /**
-     * The command this error happened on.
-     */
-    command: Command<any>;
-    /**
-     * Creates a new LunarCLI error.
-     * @param message The message.
-     * @param command The command.
-     */
-    constructor(message: string, command: Command<any>);
-    /**
-     * Prints the error's message.
-     */
-    print(): void;
-}
-
 declare const magenta: (input: any) => string;
 
 declare const magentaBright: (input: any) => string;
 
-declare class MissingRequiredArgumentError extends LunarCLIError {
+/**
+ * Command middleware function.
+ */
+export declare type MiddlewareFn<T extends Input = Input> = (input: InferInput<T>, next: () => Promise<any>) => any | Promise<any>;
+
+declare class MissingRequiredArgumentError extends ConvokerError {
     /**
      * The argument key.
      */
@@ -594,7 +618,7 @@ declare class MissingRequiredArgumentError extends LunarCLIError {
 /**
  * When a required option is missing.
  */
-declare class MissingRequiredOptionError extends LunarCLIError {
+declare class MissingRequiredOptionError extends ConvokerError {
     /**
      * The option key.
      */
@@ -655,6 +679,10 @@ declare class Option_2<TKind extends Kind, TRequired extends boolean = true, TLi
      * If this option is a list.
      */
     $list: TList;
+    /**
+     * A separator if this option is a list.
+     */
+    $separator: string | undefined;
     /**
      * Creates a new option.
      * @param kind The type of this option.
@@ -665,7 +693,7 @@ declare class Option_2<TKind extends Kind, TRequired extends boolean = true, TLi
      * Makes this option a list.
      * @returns this
      */
-    list(): Option_2<TKind, TRequired, true>;
+    list(separator?: string): Option_2<TKind, TRequired, true>;
     /**
      * Makes this option required.
      * @returns this
@@ -707,7 +735,7 @@ export declare interface ParseResult<T extends Input> {
     /**
      * Errors collected during parsing.
      */
-    errors: LunarCLIError[];
+    errors: ConvokerError[];
     /**
      * If this should result in displaying the version of the command.
      */
@@ -1142,7 +1170,7 @@ declare interface Theme {
 /**
  * When you pass too many arguments.
  */
-declare class TooManyArgumentsError extends LunarCLIError {
+declare class TooManyArgumentsError extends ConvokerError {
     /**
      * Creates a new too many arguments error.
      * @param command The command.
@@ -1166,7 +1194,7 @@ declare const underline: (input: any) => string;
 /**
  * When you pass an unknown option, when unknown options aren't allowed.
  */
-declare class UnknownOptionError extends LunarCLIError {
+declare class UnknownOptionError extends ConvokerError {
     /**
      * The option key.
      */

package/dist/index.js

@@ -1,8 +1,8 @@
 import { Command as m, l as e } from "./command.js";
-import { e as a } from "./chunks/error-Cj2qDfOl.js";
-import { i as f } from "./chunks/input-COjWPD53.js";
+import { e as a } from "./chunks/error-CyKscMUD.js";
+import { i as f } from "./chunks/input-WNu16aNE.js";
 import { a as s } from "./chunks/color-CiruG_zQ.js";
-import { i } from "./chunks/index-G2nVXKup.js";
+import { i } from "./chunks/index-BluQjWvw.js";
 export {
   m as Command,
   s as color,

package/dist/input.d.ts

@@ -16,7 +16,7 @@ export declare type BasicKind = "boolean" | "string" | "number" | "bigint";
  * @param value The value to convert.
  * @returns The converted value.
  */
-export declare function convert<TKind extends Kind>(kind: TKind, value: string): Promise<TypeOf<TKind>>;
+export declare function convert<TKind extends Kind>(kind: TKind, value: string | string[]): Promise<TypeOf<TKind> | TypeOf<TKind>[]>;
 
 /**
  * Infers a TypeScript type from an option or positional.
@@ -82,6 +82,10 @@ declare class Option_2<TKind extends Kind, TRequired extends boolean = true, TLi
      * If this option is a list.
      */
     $list: TList;
+    /**
+     * A separator if this option is a list.
+     */
+    $separator: string | undefined;
     /**
      * Creates a new option.
      * @param kind The type of this option.
@@ -92,7 +96,7 @@ declare class Option_2<TKind extends Kind, TRequired extends boolean = true, TLi
      * Makes this option a list.
      * @returns this
      */
-    list(): Option_2<TKind, TRequired, true>;
+    list(separator?: string): Option_2<TKind, TRequired, true>;
     /**
      * Makes this option required.
      * @returns this

package/dist/input.js

@@ -1,5 +1,5 @@
-import "./chunks/standard-schema-Dn3nwAxU.js";
-import { O as t, P as i, a as n, c as p, o as r, p as e } from "./chunks/input-COjWPD53.js";
+import "./chunks/standard-schema-BHKzvwIS.js";
+import { O as t, P as i, a as n, c as p, o as r, p as e } from "./chunks/input-WNu16aNE.js";
 export {
   t as Option,
   i as Positional,

package/dist/prompt.js

@@ -1,9 +1,9 @@
 import "./chunks/color-CiruG_zQ.js";
-import "./chunks/standard-schema-Dn3nwAxU.js";
-import "./chunks/error-Cj2qDfOl.js";
+import "./chunks/standard-schema-BHKzvwIS.js";
+import "./chunks/error-CyKscMUD.js";
 import "./chunks/utils-DdmSEjLc.js";
 import { d as m } from "./chunks/__vite-browser-external-DQYBmsno.js";
-import { c as i, e as c, m as d, p as f, b as l, a as x, s as h, t as w } from "./chunks/index-G2nVXKup.js";
+import { c as i, e as c, m as d, p as f, b as l, a as x, s as h, t as w } from "./chunks/index-BluQjWvw.js";
 export {
   i as confirm,
   c as editor,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convoker",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A simple, type safe CLI framework for TypeScript.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",