convoker 0.3.2 → 0.3.4

package/dist/error.js

@@ -1,100 +0,0 @@
-/**
- * Thrown when the command fails to validate an input.
- */
-export class InputValidationError extends Error {
-    /**
-     * Creates a new input validation error.
-     * @param messages The messages.
-     */
-    constructor(messages) {
-        super(`Validation failed: ${messages.join(", ")}`);
-        this.messages = messages;
-    }
-}
-/**
- * A Convoker-related error. These are usually handled by default.
- */
-export class ConvokerError extends Error {
-    /**
-     * Creates a new Convoker error.
-     * @param message The message.
-     * @param command The command.
-     */
-    constructor(message, command) {
-        super(message);
-        this.command = command;
-    }
-    /**
-     * Prints the error's message.
-     */
-    print() {
-        console.error(this.message);
-    }
-}
-/**
- * When the user asks for help.
- */
-export class HelpAskedError extends ConvokerError {
-    /**
-     * Creates a new help asked error.
-     * @param command The command.
-     */
-    constructor(command) {
-        super("user asked for help!", command);
-    }
-}
-/**
- * When you pass too many arguments.
- */
-export class TooManyArgumentsError extends ConvokerError {
-    /**
-     * Creates a new too many arguments error.
-     * @param command The command.
-     */
-    constructor(command) {
-        super("too many arguments!", command);
-    }
-}
-/**
- * When you pass an unknown option, when unknown options aren't allowed.
- */
-export class UnknownOptionError extends ConvokerError {
-    /**
-     * Creates a new unknown option error.
-     * @param command The command.
-     * @param key The key.
-     */
-    constructor(command, key) {
-        super(`unknown option: ${key}!`, command);
-        this.key = key;
-    }
-}
-/**
- * When a required option is missing.
- */
-export class MissingRequiredOptionError extends ConvokerError {
-    /**
-     * Creates a new missing required option error.
-     * @param command The command.
-     * @param key The key.
-     * @param entry The entry.
-     */
-    constructor(command, key, entry) {
-        super(`missing required option: ${key}!`, command);
-        this.key = key;
-        this.entry = entry;
-    }
-}
-export class MissingRequiredArgumentError extends ConvokerError {
-    /**
-     * Creates a new missing required argument error.
-     * @param command The command.
-     * @param key The key.
-     * @param entry The entry.
-     */
-    constructor(command, key, entry) {
-        super(`missing required positional argument: ${key}!`, command);
-        this.key = key;
-        this.entry = entry;
-    }
-}

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./command";
-export * as error from "./error";
-export * as i from "./input";
-export * as color from "./color";
-export * as prompt from "./prompt";
-export * as log from "./log";

package/dist/index.js

@@ -1,6 +0,0 @@
-export * from "./command";
-export * as error from "./error";
-export * as i from "./input";
-export * as color from "./color";
-export * as prompt from "./prompt";
-export * as log from "./log";

package/dist/input.d.ts

@@ -1,182 +0,0 @@
-import { type StandardSchemaV1 } from "./standard-schema";
-/**
- * An input object.
- */
-export interface Input {
-    [x: string]: Option<any, any, any> | Positional<any, any, any>;
-}
-/**
- * A basic input type.
- */
-export type BasicKind = "boolean" | "string" | "number" | "bigint";
-/**
- * An input type.
- */
-export type Kind = BasicKind | StandardSchemaV1<any, any>;
-/**
- * Converts a Kind to a TypeScript type.
- */
-export type TypeOf<T extends Kind> = T extends StandardSchemaV1<any, infer Out> ? Out : T extends "boolean" ? boolean : T extends "string" ? string : T extends "number" ? number : T extends "bigint" ? bigint : never;
-/**
- * Infers TypeScript types from an input object.
- */
-export type InferInput<T extends Input> = {
-    [K in keyof T]: InferEntry<T[K]>;
-};
-/**
- * Infers a TypeScript type from an option or positional.
- */
-export type InferEntry<T> = T extends {
-    $kind: infer TKind extends Kind;
-    $required: infer Required;
-    $list: infer List;
-} ? List extends true ? Required extends true ? TypeOf<TKind>[] : TypeOf<TKind>[] | undefined : Required extends true ? TypeOf<TKind> : TypeOf<TKind> | undefined : never;
-/**
- * Converts a value from a Kind to a TypeScript type.
- * @param kind The kind to convert to.
- * @param value The value to convert.
- * @returns The converted value.
- */
-export declare function convert<TKind extends Kind>(kind: TKind, value: string | string[]): Promise<TypeOf<TKind> | TypeOf<TKind>[]>;
-/**
- * An option.
- */
-export declare class Option<TKind extends Kind, TRequired extends boolean = true, TList extends boolean = false> {
-    /**
-     * The kind of this option.
-     */
-    $kind: TKind;
-    /**
-     * The aliases of this option.
-     */
-    $names: string[];
-    /**
-     * The description of this option.
-     */
-    $description: string | undefined;
-    /**
-     * The default value of this option.
-     */
-    $default: TypeOf<TKind> | undefined;
-    /**
-     * If this option is required.
-     */
-    $required: TRequired;
-    /**
-     * 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.
-     * @param names The names of this option.
-     */
-    constructor(kind: TKind, names: string[]);
-    /**
-     * Makes this option a list.
-     * @returns this
-     */
-    list(separator?: string): Option<TKind, TRequired, true>;
-    /**
-     * Makes this option required.
-     * @returns this
-     */
-    required(): Option<TKind, true, TList>;
-    /**
-     * Makes this option optional.
-     * @returns this
-     */
-    optional(): Option<TKind, false, TList>;
-    /**
-     * Sets a default value.
-     * @param value The default value.
-     * @returns this
-     */
-    default(value: TypeOf<TKind>): this;
-    /**
-     * Sets a description.
-     * @param desc The description.
-     * @returns this
-     */
-    description(desc: string): this;
-}
-/**
- * A positional argument.
- */
-export declare class Positional<TKind extends Kind, TRequired extends boolean = true, TList extends boolean = false> {
-    /**
-     * The type of this argument.
-     */
-    $kind: TKind;
-    /**
-     * The default value of this argument.
-     */
-    $default: TypeOf<TKind> | undefined;
-    /**
-     * The description of this argument.
-     */
-    $description: string | undefined;
-    /**
-     * If this argument is required.
-     */
-    $required: TRequired;
-    /**
-     * If this argument is a list.
-     */
-    $list: TList;
-    /**
-     * Creates a new positional argument.
-     * @param kind The positional argument.
-     */
-    constructor(kind: TKind);
-    /**
-     * Makes this argument a list.
-     * @returns this
-     */
-    list(): Positional<TKind, TRequired, true>;
-    /**
-     * Makes this argument required.
-     * @returns this
-     */
-    required(): Positional<TKind, true, TList>;
-    /**
-     * Makes this argument optional.
-     * @returns this
-     */
-    optional(): Positional<TKind, false, TList>;
-    /**
-     * Sets a default value.
-     * @param value The default value.
-     * @returns this
-     */
-    default(value: TypeOf<TKind>): this;
-    /**
-     * Sets a description.
-     * @param desc The description.
-     * @returns this
-     */
-    description(desc: string): this;
-}
-/**
- * Creates a new option.
- * @param kind The kind of option.
- * @param names The names of the option.
- * @returns A new option.
- */
-export declare function option<T extends Kind>(kind: T, ...names: string[]): Option<T>;
-/**
- * Creates a new positional argument.
- * @param kind The kind of positional argument.
- * @returns A new positional argument.
- */
-export declare function positional<T extends Kind>(kind: T): Positional<T>;
-/**
- * Creates a new positional argument.
- * @param kind The kind of positional argument.
- * @returns A new positional argument.
- */
-export declare function argument<T extends Kind>(kind: T): Positional<T>;

package/dist/input.js

@@ -1,185 +0,0 @@
-import { validate } from "./standard-schema";
-/**
- * Converts a value from a Kind to a TypeScript type.
- * @param kind The kind to convert to.
- * @param value The value to convert.
- * @returns The converted value.
- */
-export async function convert(kind, value) {
-    // Helper for single value conversion
-    async function convertOne(val) {
-        if (typeof kind === "string") {
-            switch (kind) {
-                case "boolean":
-                    return (val === "true");
-                case "bigint":
-                    return BigInt(val);
-                case "number":
-                    return parseFloat(val);
-                case "string":
-                    return val;
-            }
-        }
-        // Otherwise, Standard Schema
-        return validate(kind, val);
-    }
-    // If list → map each item
-    if (Array.isArray(value)) {
-        const results = await Promise.all(value.map((v) => convertOne(v)));
-        return results;
-    }
-    // Single value case
-    return convertOne(value);
-}
-/**
- * An option.
- */
-export class Option {
-    /**
-     * Creates a new option.
-     * @param kind The type of this option.
-     * @param names The names of this option.
-     */
-    constructor(kind, names) {
-        /**
-         * If this option is required.
-         */
-        this.$required = true;
-        /**
-         * If this option is a list.
-         */
-        this.$list = false;
-        this.$kind = kind;
-        this.$names = names.map((name) => name.replace(/^-+/, ""));
-    }
-    /**
-     * Makes this option a list.
-     * @returns this
-     */
-    list(separator) {
-        this.$list = true;
-        this.$separator = separator ?? this.$separator;
-        return this;
-    }
-    /**
-     * Makes this option required.
-     * @returns this
-     */
-    required() {
-        this.$required = true;
-        return this;
-    }
-    /**
-     * Makes this option optional.
-     * @returns this
-     */
-    optional() {
-        this.$required = false;
-        return this;
-    }
-    /**
-     * Sets a default value.
-     * @param value The default value.
-     * @returns this
-     */
-    default(value) {
-        this.$default = value;
-        return this;
-    }
-    /**
-     * Sets a description.
-     * @param desc The description.
-     * @returns this
-     */
-    description(desc) {
-        this.$description = desc;
-        return this;
-    }
-}
-/**
- * A positional argument.
- */
-export class Positional {
-    /**
-     * Creates a new positional argument.
-     * @param kind The positional argument.
-     */
-    constructor(kind) {
-        /**
-         * If this argument is required.
-         */
-        this.$required = true;
-        /**
-         * If this argument is a list.
-         */
-        this.$list = false;
-        this.$kind = kind;
-    }
-    /**
-     * Makes this argument a list.
-     * @returns this
-     */
-    list() {
-        this.$list = true;
-        return this;
-    }
-    /**
-     * Makes this argument required.
-     * @returns this
-     */
-    required() {
-        this.$required = true;
-        return this;
-    }
-    /**
-     * Makes this argument optional.
-     * @returns this
-     */
-    optional() {
-        this.$required = false;
-        return this;
-    }
-    /**
-     * Sets a default value.
-     * @param value The default value.
-     * @returns this
-     */
-    default(value) {
-        this.$default = value;
-        return this;
-    }
-    /**
-     * Sets a description.
-     * @param desc The description.
-     * @returns this
-     */
-    description(desc) {
-        this.$description = desc;
-        return this;
-    }
-}
-/**
- * Creates a new option.
- * @param kind The kind of option.
- * @param names The names of the option.
- * @returns A new option.
- */
-export function option(kind, ...names) {
-    return new Option(kind, names);
-}
-/**
- * Creates a new positional argument.
- * @param kind The kind of positional argument.
- * @returns A new positional argument.
- */
-export function positional(kind) {
-    return new Positional(kind);
-}
-/**
- * Creates a new positional argument.
- * @param kind The kind of positional argument.
- * @returns A new positional argument.
- */
-export function argument(kind) {
-    return new Positional(kind);
-}

package/dist/log.d.ts

@@ -1,61 +0,0 @@
-import { type Theme } from "./color";
-/**
- * The logger configuration.
- */
-export interface LogConfig {
-    /**
-     * The format to print as.
-     */
-    format: "text" | "json" | "xml" | "yaml" | "csv";
-    /**
-     * Standard output.
-     */
-    stdout: WritableStream<string>;
-    /**
-     * Standard error.
-     */
-    stderr: WritableStream<string>;
-    /**
-     * Standard input.
-     */
-    stdin: ReadableStream<string>;
-}
-/**
- * Sets a new theme.
- * @param t The theme.
- */
-export declare function setTheme(t: Theme): void;
-/**
- * Sets new configuration.
- * @param c The config.
- */
-export declare function setConfig(c: Partial<LogConfig>): Promise<void>;
-/**
- * Sets default configuration.
- */
-export declare function setup(): Promise<void>;
-/**
- * Prints debug information.
- * @param msgs The messages to write.
- */
-export declare function trace(...msgs: any[]): Promise<void>;
-/**
- * Prints information.
- * @param msgs The messages to write.
- */
-export declare function info(...msgs: any[]): Promise<void>;
-/**
- * Prints warnings.
- * @param msgs The messages to write.
- */
-export declare function warn(...msgs: any[]): Promise<void>;
-/**
- * Prints errors.
- * @param msgs The messages to write.
- */
-export declare function error(...msgs: any[]): Promise<void>;
-/**
- * Prints errors and exits.
- * @param msgs The messages to write.
- */
-export declare function fatal(...msgs: any[]): Promise<void>;