genomic 0.0.1 → 4.0.1

package/prompt.d.ts

@@ -0,0 +1,116 @@
+import { Readable, Writable } from 'stream';
+import { AutocompleteQuestion, CheckboxQuestion, ConfirmQuestion, ListQuestion, NumberQuestion, OptionValue, Question, TextQuestion, Validation } from './question';
+import { DefaultResolverRegistry } from './resolvers';
+export interface ManPageInfo {
+    commandName: string;
+    questions: Question[];
+    author?: string;
+    description?: string;
+}
+export interface PromptOptions {
+    usageText?: string;
+    manPageInfo?: ManPageInfo;
+    mutateArgs?: boolean;
+}
+export declare function reorderQuestionsByDeps(questions: Question[]): Question[];
+declare class PromptContext {
+    numTries: number;
+    needsInput: boolean;
+    validation: Validation;
+    constructor();
+    tryAgain(validation: Partial<Validation>): void;
+    nextQuestion(): void;
+    process(validation: Validation | boolean): Validation;
+}
+export interface PrompterOptions {
+    noTty?: boolean;
+    input?: Readable;
+    output?: Writable;
+    useDefaults?: boolean;
+    globalMaxLines?: number;
+    mutateArgs?: boolean;
+    resolverRegistry?: DefaultResolverRegistry;
+}
+export declare class Prompter {
+    private rl;
+    private keypress;
+    private noTty;
+    private output;
+    private input;
+    private useDefaults;
+    private globalMaxLines;
+    private mutateArgs;
+    private resolverRegistry;
+    private handledKeys;
+    constructor(options?: PrompterOptions);
+    private clearScreen;
+    private write;
+    private log;
+    private getInput;
+    private getPrompt;
+    private displayPrompt;
+    generateManPage(opts: ManPageInfo): string;
+    private isValidatableAnswer;
+    private validateAnswer;
+    private isValid;
+    private validateAnswerPattern;
+    private isEmptyAnswer;
+    private sanitizeAnswer;
+    exit(): void;
+    prompt<T extends object>(argv: T, questions: Question[], options?: PromptOptions): Promise<T>;
+    private handleMissingArgsError;
+    private hasMissingRequiredArgs;
+    /**
+     * Resolves the default value for a question using the resolver system.
+     * Priority: defaultFrom > default > undefined
+     */
+    private resolveQuestionDefault;
+    /**
+     * Resolves dynamic defaults for all questions that have defaultFrom specified.
+     * Updates the question.default property with the resolved value.
+     */
+    private resolveDynamicDefaults;
+    /**
+     * Resolves setFrom values for all questions that have setFrom specified.
+     * Sets the value directly in obj, bypassing the prompt entirely.
+     */
+    private resolveSetValues;
+    /**
+     * Resolves optionsFrom values for all questions that have optionsFrom specified.
+     * Updates the question.options property with the resolved array.
+     */
+    private resolveOptionsFrom;
+    /**
+     * Extracts positional arguments from obj._ and assigns them to questions marked with _: true.
+     *
+     * Rules:
+     * 1. Named arguments take precedence - if a question already has a value in obj, skip it
+     * 2. Positional questions consume from obj._ left-to-right in declaration order
+     * 3. Returns the count of consumed positionals so caller can strip them from obj._
+     * 4. Missing positional values leave questions unset (for prompting/validation)
+     *
+     * This effectively allows "naming positional parameters" - users can pass values
+     * without flags and they'll be assigned to the appropriate question names.
+     *
+     * @returns The number of positional arguments consumed
+     */
+    private extractPositionalArgs;
+    private applyDefaultValues;
+    private applyOverrides;
+    private handleOverrides;
+    private handleOverridesForCheckboxOptions;
+    private handleOverridesWithOptions;
+    private handleQuestionType;
+    confirm(question: ConfirmQuestion, ctx: PromptContext): Promise<boolean>;
+    text(question: TextQuestion, ctx: PromptContext): Promise<string | null>;
+    number(question: NumberQuestion, ctx: PromptContext): Promise<number | null>;
+    checkbox(question: CheckboxQuestion, ctx: PromptContext): Promise<OptionValue[]>;
+    autocomplete(question: AutocompleteQuestion, ctx: PromptContext): Promise<any>;
+    list(question: ListQuestion, ctx: PromptContext): Promise<any>;
+    private getOptionValue;
+    private sanitizeOptions;
+    private filterOptions;
+    private getMaxLines;
+    close(): void;
+}
+export {};