@bleedingdev/modern-js-utils 3.9.0-ultramodern.2 → 3.9.0-ultramodern.20

package/dist/compiled/inquirer/lib/prompts/editor.d.ts

@@ -0,0 +1,101 @@
+import Prompt = require('./base');
+import { Subject, Subscription } from '../../rxjs';
+import inquirer = require('../..');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question-options for the `EditorPrompt<T>`.
+ */
+type Question = inquirer.EditorQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which provides a text-editor.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class EditorPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * Gets or sets an object for subscribing to the editor-result.
+     */
+    protected editorResult: Subject<string>;
+
+    /**
+     * Gets or sets a subscription to the `line`-event.
+     */
+    protected lineSubscription: Subscription;
+
+    /**
+     * Gets or sets the initial text.
+     */
+    protected currentText: string;
+
+    /**
+     * Initializes a new instance of the `EditorPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Runs the prompt.
+     *
+     * @param callback
+     * The callback for resolving the result.
+     */
+    protected _run(callback: (value: any) => void): this;
+
+    /**
+     * Renders the prompt.
+     *
+     * @param error
+     * The error to render.
+     */
+    protected render(error?: string): void;
+
+    /**
+     * Launches the default text-editor of the system.
+     */
+    protected startExternalEditor(): void;
+
+    /**
+     * Closes the external editor.
+     *
+     * @param error
+     * Either the error which occurred while executing the external editor or `null`.
+     *
+     * @param result
+     * The result of the editor.
+     */
+    protected endExternalEditor(error: Error, result: string): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onEnd(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(eventArgs: inquirer.prompts.FailedPromptStateData): void;
+}
+
+export = EditorPrompt;

package/dist/compiled/inquirer/lib/prompts/expand.d.ts

@@ -0,0 +1,149 @@
+import Paginator = require('../utils/paginator');
+import Prompt = require('./base');
+import inquirer = require('../..');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question-options for the `ExpandPrompt<T>`.
+ */
+type Question = inquirer.ExpandQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which forces the user to make a choice by typing a specific key.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class ExpandPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * Gets or sets the default key.
+     */
+    protected rawDefault: string;
+
+    /**
+     * Gets or sets an object for paginating the content.
+     */
+    protected paginator: Paginator;
+
+    /**
+     * Gets the promise of the keypress-eventhandler.
+     */
+    protected keypressObs: Promise<void>;
+
+    /**
+     * Gets or sets the currently selected key.
+     */
+    protected selectedKey: string;
+
+    /**
+     * Gets or sets the answer of the prompt.
+     */
+    protected answer: string;
+
+    /**
+     * Initializes a new instance of the `ExpandPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Renders the prompt to the screen.
+     *
+     * @param error
+     * The error to render.
+     *
+     * @param hint
+     * The hint to render.
+     */
+    protected render(error?: string, hint?: string): void;
+
+    /**
+     * Determines the current value of the prompt.
+     *
+     * @param input
+     * The input provided by the user.
+     *
+     * @returns
+     * The current value of the prompt.
+     */
+    protected getCurrentValue(input: string): any;
+
+    /**
+     * Generates the string-representation of the choices.
+     *
+     * @deprecated
+     *
+     * @returns
+     * The string-representations of the choices.
+     */
+    protected getChoices(): string;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onSubmit(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(eventArgs: inquirer.prompts.FailedPromptStateData): void;
+
+    /**
+     * Handles the `keypress`-event of the prompt.
+     */
+    protected onKeypress(): void;
+
+    /**
+     * Validates the integrity of the choices.
+     *
+     * @param choices
+     * The choices to validate.
+     */
+    protected validateChoices(choices: ExpandPrompt<TQuestion>['opt']['choices']): void;
+
+    /**
+     * Generates the string-representation of the choices.
+     *
+     * @param choices
+     * The choices to generate the string-representation for.
+     *
+     * @param defaultChoice
+     * The value of the default choice.
+     *
+     * @returns
+     * The string-representations of the choices.
+     */
+    protected generateChoicesString(choices: ExpandPrompt<TQuestion>['opt']['choices'], defaultChoice: any): string;
+
+    /**
+     * Renders the choices.
+     *
+     * @param choices
+     * The choices to render.
+     *
+     * @param pointer
+     * The value of the choice to select.
+     */
+    protected renderChoices(choices: ExpandPrompt<TQuestion>['opt']['choices'], pointer: string): string;
+}
+
+export = ExpandPrompt;

package/dist/compiled/inquirer/lib/prompts/input.d.ts

@@ -0,0 +1,82 @@
+import Prompt = require('./base');
+import inquirer = require('../..');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question-options for the `InputPrompt<T>`.
+ */
+type Question = inquirer.InputQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which allows the user to type an answer.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class InputPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * The answer to this prompt.
+     */
+    protected answer: any;
+
+    /**
+     * Initializes a new instance of the `InputPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Renders the prompt.
+     *
+     * @param error
+     * The error to render.
+     */
+    protected render(error?: string): void;
+
+    /**
+     * Filters the specified `input`.
+     *
+     * @param input
+     * The input to filter.
+     *
+     * @returns
+     * The filtered input.
+     */
+    protected filterInput(input: string): string;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains eventr-data.
+     */
+    protected onEnd(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(eventArgs: inquirer.prompts.FailedPromptStateData): void;
+
+    /**
+     * Handles the `keypress`-event of the prompt.
+     */
+    protected onKeypress(): void;
+}
+
+export = InputPrompt;

package/dist/compiled/inquirer/lib/prompts/list.d.ts

@@ -0,0 +1,89 @@
+import Prompt = require('./base');
+import { Answers, ListQuestionOptions } from '../..';
+import Paginator = require('../utils/paginator');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question-options for the `ListPrompt<T>`.
+ */
+type Question = ListQuestionOptions;
+
+/**
+ * Represents a prompt which provides a list to choose an answer from.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class ListPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * Gets or sets a value indicating whether the prompt has been rendered the first time.
+     */
+    protected firstRender: boolean;
+
+    /**
+     * The index of the selected choice.
+     */
+    protected selected: number;
+
+    /**
+     * Gets or sets an object for paginating the content.
+     */
+    protected paginator: Paginator;
+
+    /**
+     * Initializes a new instance of the `ListPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: Answers);
+
+    /**
+     * Renders the prompt.
+     */
+    protected render(): void;
+
+    /**
+     * Gets the current value of the prompt.
+     */
+    protected getCurrentValue(): any;
+
+    /**
+     * Handles the `upKey`-event.
+     */
+    protected onUpKey(): void;
+
+    /**
+     * Handles the `downKey`-event.
+     */
+    protected onDownKey(): void;
+
+    /**
+     * Handles the `numberKey`-event.
+     *
+     * @param input
+     * The number that has been pressed.
+     */
+    protected onNumberKey(input: number): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param value
+     * The value of the prompt.
+     */
+    protected onSubmit(value: any): void;
+}
+
+export = ListPrompt;

package/dist/compiled/inquirer/lib/prompts/number.d.ts

@@ -0,0 +1,32 @@
+import InputPrompt = require('./input');
+import { Answers, NumberQuestionOptions } from '../..';
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question for the `NumberPrompt<T>`.
+ */
+type Question = NumberQuestionOptions;
+
+/**
+ * Provides a prompt which allows the user to type a number as answer.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class NumberPrompt<TQuestion extends Question = Question> extends InputPrompt<TQuestion> {
+    /**
+     * Initializes a new instance of the `NumberPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: Answers);
+}
+
+export = NumberPrompt;

package/dist/compiled/inquirer/lib/prompts/password.d.ts

@@ -0,0 +1,82 @@
+import Prompt = require('./base');
+import inquirer = require('../..');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question for the `PasswordPrompt<T>`.
+ */
+type Question = inquirer.PasswordQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which allows the user to type a password.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class PasswordPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * The answer to this prompt.
+     */
+    protected answer: any;
+
+    /**
+     * Initializes a new instance of the `PasswordPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Renders the prompt.
+     *
+     * @param error
+     * The error to render.
+     */
+    protected render(error?: string): void;
+
+    /**
+     * Filters the specified `input`.
+     *
+     * @param input
+     * The input to filter.
+     *
+     * @returns
+     * The filtered input.
+     */
+    protected filterInput(input: string): string;
+
+    /**
+     * Handles the `keypress`-event of the prompt.
+     */
+    protected onKeypress(): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onEnd(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(eventArgs: inquirer.prompts.FailedPromptStateData): void;
+}
+
+export = PasswordPrompt;

package/dist/compiled/inquirer/lib/prompts/rawlist.d.ts

@@ -0,0 +1,111 @@
+import inquirer = require('../..');
+import Prompt = require('./base');
+import Paginator = require('../utils/paginator');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question for the `RawListPrompt<T>`.
+ */
+type Question = inquirer.RawListQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which provides a list to choose an answer from.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class RawListPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * The index of the selected choice.
+     */
+    protected selected: number;
+
+    /**
+     * Gets or sets the default index.
+     */
+    protected rawDefault: number;
+
+    /**
+     * Gets or sets an object for paginating the content.
+     */
+    protected paginator: Paginator;
+
+    /**
+     * Initializes a new instance of the `RawListPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Renders the prompt.
+     *
+     * @param error
+     * The error to render.
+     */
+    protected render(error?: string): void;
+
+    /**
+     * Gets the value of the specified `index`.
+     *
+     * @param index
+     * The index to get the value for.
+     *
+     * @returns
+     * The value of the specified `index`.
+     */
+    protected getCurrentValue(index: number): any;
+
+    /**
+     * Handles the `Keypress`-event of the prompt.
+     */
+    protected onKeypress(): void;
+
+    /**
+     * Handles the `UpdKey`-event of the prompt.
+     */
+    protected onUpKey(): void;
+
+    /**
+     * Handles the `DownKey`-event of the prompt.
+     */
+    protected onDownKey(): void;
+
+    /**
+     * Handles the `ArrowKey`-event of the prompt.
+     *
+     * @param type
+     * A value indicating whether the up or the down-arrow is being pressed.
+     */
+    protected onArrowKey(type: 'up' | 'down'): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onEnd(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(): void;
+}
+
+export = RawListPrompt;